Struct TorClientConfig

#[non_exhaustive]
pub struct TorClientConfig {

    tor_network: NetworkConfig,
    pub(crate) storage: StorageConfig,
    download_schedule: DownloadScheduleConfig,
    directory_tolerance: DirTolerance,
    pub(crate) override_net_params: NetParams<i32>,
    pub(crate) bridges: BridgesConfig,
    pub(crate) channel: ChannelConfig,
    pub(crate) system: SystemConfig,
    path_rules: PathConfig,
    preemptive_circuits: PreemptiveCircuitConfig,
    circuit_timing: CircuitTiming,
    pub(crate) address_filter: ClientAddrConfig,
    pub(crate) stream_timeouts: StreamTimeoutConfig,
    pub(crate) vanguards: VanguardConfig,
    pub(crate) path_resolver: CfgPathResolver,
}

A configuration used to bootstrap a TorClient.

In order to connect to the Tor network, Arti needs to know a few well-known directory caches on the network, and the public keys of the network’s directory authorities. It also needs a place on disk to store persistent state and cached directory information. (See StorageConfig for default directories.)

Most users will create a TorClientConfig by running TorClientConfig::default.

If you need to override the locations where Arti stores its information, you can make a TorClientConfig with TorClientConfigBuilder::from_directories.

Finally, you can get fine-grained control over the members of a TorClientConfig using TorClientConfigBuilder.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tor_network: NetworkConfig

Information about the Tor network we want to connect to.

storage: StorageConfig

Directories for storing information on disk

download_schedule: DownloadScheduleConfig

Information about when and how often to download directory information

directory_tolerance: DirTolerance

Information about how premature or expired our directories are allowed to be.

These options help us tolerate clock skew, and help survive the case where the directory authorities are unable to reach consensus for a while.

override_net_params: NetParams<i32>

Facility to override network parameters from the values set in the consensus.

bridges: BridgesConfig

Information about bridges, pluggable transports, and so on

channel: ChannelConfig

Information about how to build paths through the network.

system: SystemConfig

Configuration for system resources used by Arti

Note that there are other settings in this section, in arti::cfg::SystemConfig - these two structs overlay here.

path_rules: PathConfig

Information about how to build paths through the network.

preemptive_circuits: PreemptiveCircuitConfig

Information about preemptive circuits.

circuit_timing: CircuitTiming

Information about how to retry and expire circuits and request for circuits.

address_filter: ClientAddrConfig

Rules about which addresses the client is willing to connect to.

stream_timeouts: StreamTimeoutConfig

Information about timing out client requests.

vanguards: VanguardConfig

Information about vanguards.

path_resolver: CfgPathResolver

Resolves paths in this configuration.

This is not reconfigurable.

Implementations

impl TorClientConfig

pub fn builder() -> TorClientConfigBuilder

Returns a fresh, default, builder

impl TorClientConfig

pub fn dir_mgr_config(&self) -> Result<DirMgrConfig, ConfigBuildError>

Try to create a DirMgrConfig corresponding to this object.

pub fn fs_mistrust(&self) -> &Mistrust

Return a reference to the [fs_mistrust::Mistrust] object that we’ll use to check permissions on files and directories by default.

Usage notes

In the future, specific files or directories may have stricter or looser permissions checks applied to them than this default. Callers shouldn’t use this [Mistrust] to predict what Arti will accept for a specific file or directory. Rather, you should use this if you have some file or directory of your own on which you’d like to enforce the same rules as Arti uses.

pub fn keystore(&self) -> ArtiKeystoreConfig

Return the keystore config

pub(crate) fn state_dir(&self) -> StdResult<(PathBuf, &Mistrust), ErrorDetail>

Get the state directory and its corresponding [Mistrust] configuration.

pub fn system_memory(&self) -> &Config

Available on crate feature testing only.

Access the tor_memquota configuration

Ad-hoc accessor for testing purposes. (ideally we’d use visibility to make fields pub, but that doesn’t work.)

Trait Implementations

impl AsRef<[BridgeConfig]> for TorClientConfig

fn as_ref(&self) -> &[BridgeConfig]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<BridgesConfig> for TorClientConfig

fn as_ref(&self) -> &BridgesConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CfgPathResolver> for TorClientConfig

fn as_ref(&self) -> &CfgPathResolver

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CircuitTiming> for TorClientConfig

fn as_ref(&self) -> &CircuitTiming

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<FallbackList> for TorClientConfig

fn as_ref(&self) -> &FallbackList

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PathConfig> for TorClientConfig

fn as_ref(&self) -> &PathConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PreemptiveCircuitConfig> for TorClientConfig

fn as_ref(&self) -> &PreemptiveCircuitConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl CircMgrConfig for TorClientConfig

fn vanguard_config(&self) -> &VanguardConfig

Available on crate features vanguards and hs-common only.

Access the field

fn path_rules(&self) -> &PathConfig

Access the field

fn circuit_timing(&self) -> &CircuitTiming

Access the field

fn preemptive_circuits(&self) -> &PreemptiveCircuitConfig

Access the field

impl Clone for TorClientConfig

fn clone(&self) -> TorClientConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TorClientConfig

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

Formats the value using the given formatter.

impl Default for TorClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl GuardMgrConfig for TorClientConfig

fn bridges_enabled(&self) -> bool

Should the bridges be used?

fn fallbacks(&self) -> &FallbackList

Access the field

fn bridges(&self) -> &[BridgeConfig]

Access the field

impl HsCircPoolConfig for TorClientConfig

Available on crate features onion-service-client or onion-service-service only.

fn vanguard_config(&self) -> &VanguardConfig

Available on crate features vanguards and hs-common only.

Access the field

impl HsClientConnectorConfig for TorClientConfig

Available on crate feature onion-service-client only.

fn circuit_timing(&self) -> &CircuitTiming

Access the field

impl PartialEq for TorClientConfig

fn eq(&self, other: &Self) -> 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 TopLevel for TorClientConfig

type Builder = TorClientConfigBuilder

The Builder which can be used to make a Self

const DEPRECATED_KEYS: &'static [&'static str] = _

Deprecated config keys, as “.”-separates strings

impl Eq for TorClientConfig