Module hsdesc

Available on crate feature hs-common only.

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

pow

Implement parsing for the pow-params line within the HsDescInner layer

test_datatesting

Test data

Structs

DecryptionError

An error that occurs when decrypting an onion service descriptor.

EncryptedHsDesc

An onion service after it has been parsed by the client, but not yet decrypted.

HsDesc

A decrypted, decoded onion service descriptor.

HsDescBuilderhs-service

Builder for HsDesc.

HsDescInnerhsdesc-inner-docs

The contents of the inner document of an onion service descriptor.

HsDescMiddlehsdesc-inner-docs

A more-or-less verbatim representation of the middle document of an onion service descriptor.

HsDescOuterhsdesc-inner-docs

A more-or-less verbatim representation of the outermost plaintext document of an onion service descriptor.

IntroPointDesc

Information in an onion service descriptor about a single introduction point.

IntroPointDescBuilder

Builder for IntroPointDesc.

StoredHsDescMetahs-dir

Metadata about an onion service descriptor, as stored at an HsDir.

Enums

HsDescError

An error returned by HsDesc::parse_decrypt_validate, indicating what kind of failure prevented us from validating an onion service descriptor.

IntroAuthType

A type of authentication that is required when introducing to an onion service.

IntroPointDescBuilderError

Error type for IntroPointDescBuilder

Functions

create_desc_sign_key_cerths-service

Create the descriptor signing key certificate.

Type Aliases

UncheckedEncryptedHsDesc

An unchecked HsDesc: parsed, but not checked for liveness or validity.

UncheckedStoredHsDescMetahs-dir

An unchecked StoredHsDescMeta: parsed, but not checked for liveness or validity.