Struct HsDescBuilder 

pub struct HsDescBuilder<'a> { /* private fields */ }

Available on crate features hs-common and hs-service only.

Builder for HsDesc.

Implementations

impl<'a> HsDescBuilder<'a>

pub fn blinded_id(self, value: &'a HsBlindIdKey) -> Self

The blinded hidden service public key used for the first half of the “SECRET_DATA” field.

(See rend-spec v3 2.5.1.1 and 2.5.2.1.)

pub fn hs_desc_sign(self, value: &'a Keypair) -> Self

The short-term descriptor signing key (KP_hs_desc_sign, KS_hs_desc_sign).

pub fn hs_desc_sign_cert(self, value: EncodedEd25519Cert) -> Self

The descriptor signing key certificate.

This certificate can be created using create_desc_sign_key_cert.

pub fn create2_formats(self, value: &'a [HandshakeType]) -> Self

A list of recognized CREATE handshakes that this onion service supports.

pub fn auth_required(self, value: Option<SmallVec<[IntroAuthType; 2]>>) -> Self

A list of authentication types that this onion service supports.

pub fn is_single_onion_service(self, value: bool) -> Self

If true, this a “single onion service” and is not trying to keep its own location private.

pub fn intro_points(self, value: &'a [IntroPointDesc]) -> Self

One or more introduction points used to contact the onion service.

pub fn intro_auth_key_cert_expiry(self, value: SystemTime) -> Self

The expiration time of an introduction point authentication key certificate.

pub fn intro_enc_key_cert_expiry(self, value: SystemTime) -> Self

The expiration time of an introduction point encryption key certificate.

pub fn auth_clients(self, value: Option<&'a [PublicKey]>) -> Self

The list of clients authorized to discover the hidden service.

If None, restricted discovery is disabled. If Some(&[]), restricted discovery is enabled, but there will be no authorized clients.

If restricted discovery is disabled, the resulting middle document will contain a single auth-client line populated with random values.

Restricted discovery is disabled by default.

pub fn lifetime(self, value: IntegerMinutes<u16>) -> Self

The lifetime of this descriptor, in minutes.

This doesn’t actually list the starting time or the end time for the descriptor: presumably, because we didn’t want to leak the onion service’s view of the wallclock.

pub fn revision_counter(self, value: RevisionCounter) -> Self

A revision counter to tell whether this descriptor is more or less recent than another one for the same blinded ID.

pub fn subcredential(self, value: Subcredential) -> Self

The “subcredential” of the onion service.

pub fn max_generated_len(self, value: usize) -> Self

Maximum length of generated HsDesc.

If the generated descriptor is larger than this, build_sign will return an error.

Trait Implementations

impl<'a> Clone for HsDescBuilder<'a>

fn clone(&self) -> HsDescBuilder<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for HsDescBuilder<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for HsDescBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> NetdocBuilder for HsDescBuilder<'a>

fn build_sign<R: RngCore + CryptoRng>( self, rng: &mut R, ) -> Result<String, EncodeError>

Build the document into textual form.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 232 bytes