Available on crate feature
hs-common
only.Expand description
Implementation for onion service descriptors.
An onion service descriptor is a document generated by an onion service and uploaded to one or more HsDir nodes for clients to later download. It tells the onion service client where to find the current introduction points for the onion service, and how to connect to them.
An onion service descriptor is more complicated than most other documentation types, because it is partially encrypted.
Modules§
Structs§
- Decryption
Error - An error that occurs when decrypting an onion service descriptor.
- Encrypted
HsDesc - An onion service after it has been parsed by the client, but not yet decrypted.
- HsDesc
- A decrypted, decoded onion service descriptor.
- HsDesc
Builder hs-service
- Builder for
HsDesc
. - HsDesc
Inner hsdesc-inner-docs
- The contents of the inner document of an onion service descriptor.
- HsDesc
Middle hsdesc-inner-docs
- A more-or-less verbatim representation of the middle document of an onion service descriptor.
- HsDesc
Outer hsdesc-inner-docs
- A more-or-less verbatim representation of the outermost plaintext document of an onion service descriptor.
- Intro
Point Desc - Information in an onion service descriptor about a single introduction point.
- Intro
Point Desc Builder - Builder for
IntroPointDesc
. - Stored
HsDesc Meta hs-dir
- Metadata about an onion service descriptor, as stored at an HsDir.
Enums§
- HsDesc
Error - An error returned by
HsDesc::parse_decrypt_validate
, indicating what kind of failure prevented us from validating an onion service descriptor. - Intro
Auth Type - A type of authentication that is required when introducing to an onion service.
- Intro
Point Desc Builder Error - Error type for IntroPointDescBuilder
Functions§
- create_
desc_ sign_ key_ cert hs-service
- Create the descriptor signing key certificate.
Type Aliases§
- Unchecked
Encrypted HsDesc - An unchecked HsDesc: parsed, but not checked for liveness or validity.
- Unchecked
Stored HsDesc Meta hs-dir
- An unchecked StoredHsDescMeta: parsed, but not checked for liveness or validity.