Struct OnionServiceConfig 

pub struct OnionServiceConfig {
    pub(crate) nickname: HsNickname,
    pub(crate) enabled: bool,
    pub(crate) num_intro_points: u8,
    rate_limit_at_intro: Option<TokenBucketConfig>,
    max_concurrent_streams_per_circuit: u32,
    pub(crate) enable_pow: bool,
    pub(crate) pow_rend_queue_depth: usize,
    pub(crate) restricted_discovery: RestrictedDiscoveryConfig,
    disable_pow_compilation: bool,
}

Configuration for one onion service.

Fields

nickname: HsNickname

The nickname used to look up this service’s keys, state, configuration, etc.

enabled: bool

If true, this service will be started. It should be available to commands that don’t require it to start regardless.

num_intro_points: u8

Number of intro points; defaults to 3; max 20.

rate_limit_at_intro: Option<TokenBucketConfig>

A rate-limit on the acceptable rate of introduction requests.

We send this to the introduction point to configure how many introduction requests it sends us. If this is not set, the introduction point chooses a default based on the current consensus.

We do not enforce this limit ourselves.

This configuration is sent as a DOS_PARAMS extension, as documented in https://spec.torproject.org/rend-spec/introduction-protocol.html#EST_INTRO_DOS_EXT.

max_concurrent_streams_per_circuit: u32

How many streams will we allow to be open at once for a single circuit on this service?

If a client attempts to open more than this many streams on a rendezvous circuit, the circuit will be torn down.

Equivalent to C Tor’s HiddenServiceMaxStreamsCloseCircuit option.

enable_pow: bool

If true, we will require proof-of-work when we’re under heavy load.

pow_rend_queue_depth: usize

The maximum number of entries allowed in the rendezvous request queue when PoW is enabled.

If you are seeing dropped requests, have a bursty traffic pattern, and have some memory to spare, you may want to increase this.

Each request will take a few KB, the default queue is expected to take 32MB at most.

restricted_discovery: RestrictedDiscoveryConfig

Configure restricted discovery mode.

When this is enabled, we encrypt our list of introduction point and keys so that only clients holding one of the listed keys can decrypt it.

disable_pow_compilation: bool

Whether to use the compiled backend for proof-of-work.

Implementations

impl OnionServiceConfig

pub fn builder() -> OnionServiceConfigBuilder

Return a new [OnionServiceConfig Builder] to construct an instance of this type.

impl OnionServiceConfig

pub fn nickname(&self) -> &HsNickname

Method borrowing OnionServiceConfig::nickname field. The nickname used to look up this service’s keys, state, configuration, etc.

pub fn enabled(&self) -> &bool

Method borrowing OnionServiceConfig::enabled field. If true, this service will be started. It should be available to

pub fn num_intro_points(&self) -> &u8

Method borrowing OnionServiceConfig::num_intro_points field. Number of intro points; defaults to 3; max 20.

pub fn rate_limit_at_intro(&self) -> &Option<TokenBucketConfig>

Method borrowing OnionServiceConfig::rate_limit_at_intro field. A rate-limit on the acceptable rate of introduction requests.

pub fn max_concurrent_streams_per_circuit(&self) -> &u32

Method borrowing OnionServiceConfig::max_concurrent_streams_per_circuit field. How many streams will we allow to be open at once for a single circuit on

pub fn enable_pow(&self) -> &bool

Method borrowing OnionServiceConfig::enable_pow field. If true, we will require proof-of-work when we’re under heavy load.

pub fn pow_rend_queue_depth(&self) -> &usize

Method borrowing OnionServiceConfig::pow_rend_queue_depth field. The maximum number of entries allowed in the rendezvous request queue when PoW is enabled.

pub fn restricted_discovery(&self) -> &RestrictedDiscoveryConfig

Method borrowing OnionServiceConfig::restricted_discovery field. Configure restricted discovery mode.

pub fn restricted_discovery_mut(&mut self) -> &mut RestrictedDiscoveryConfig

Method returning mutable borrow of OnionServiceConfig::restricted_discovery field. Configure restricted discovery mode.

pub fn disable_pow_compilation(&self) -> &bool

Method borrowing OnionServiceConfig::disable_pow_compilation field. Whether to use the compiled backend for proof-of-work.

impl OnionServiceConfig

pub(crate) fn for_transition_to( &self, other: OnionServiceConfig, how: Reconfigure, ) -> Result<OnionServiceConfig, ReconfigureError>

Check whether an onion service running with this configuration can switch over other according to the rules of how.

pub(crate) fn dos_extension(&self) -> Result<Option<DosParams>, FatalError>

Return the DosParams extension we should send for this configuration, if any.

pub(crate) fn filter_settings(&self) -> RequestFilter

Return a RequestFilter based on this configuration.

Trait Implementations

impl Buildable for OnionServiceConfig

type Builder = OnionServiceConfigBuilder

The type that constructs this Buildable.

fn builder() -> OnionServiceConfigBuilder

Return a new Builder for this type.

impl Clone for OnionServiceConfig

fn clone(&self) -> OnionServiceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnionServiceConfig

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

Formats the value using the given formatter.

impl From<&OnionServiceConfig> for OnionServiceConfigPublisherView

fn from(config: &OnionServiceConfig) -> OnionServiceConfigPublisherView

Converts to this type from the input type.

impl From<OnionServiceConfig> for OnionServiceConfigPublisherView

fn from(config: OnionServiceConfig) -> OnionServiceConfigPublisherView

Converts to this type from the input type.

impl PartialEq for OnionServiceConfig

fn eq(&self, other: &OnionServiceConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OnionServiceConfig

impl StructuralPartialEq for OnionServiceConfig