Struct arti_client::config::BridgesConfig

#[non_exhaustive]
pub struct BridgesConfig {
    pub(crate) enabled: BoolOrAuto,
    bridges: BridgeList,
    pub(crate) transports: Vec<TransportConfig>,
}

Configuration for anti-censorship features: bridges and pluggable transports.

A “bridge” is a relay that is not listed in the regular Tor network directory; clients use them to reach the network when a censor is blocking their connection to all the regular Tor relays.

A “pluggable transport” is a tool that transforms and conceals a user’s connection to a bridge; clients use them to reach the network when a censor is blocking all traffic that “looks like Tor”.

A BridgesConfig configuration has the following pieces:

• A BridgeList of [BridgeConfig]s, which describes one or more bridges.
• An enabled boolean to say whether or not to use the listed bridges.
• A list of pt::TransportConfigs.

Example

Here’s an example of building a bridge configuration, and using it in a TorClientConfig.

The bridges here are fictitious; you’ll need to use real bridges if you want a working configuration.

#[cfg(feature = "pt-client")]
use arti_client::config::{TorClientConfig, BridgeConfigBuilder, CfgPath};
// Requires that the pt-client feature is enabled.
use arti_client::config::pt::TransportConfigBuilder;

let mut builder = TorClientConfig::builder();

// Add a single bridge to the list of bridges, from a bridge line.
// This bridge line is made up for demonstration, and won't work.
const BRIDGE1_LINE : &str = "Bridge obfs4 192.0.2.55:38114 316E643333645F6D79216558614D3931657A5F5F cert=YXJlIGZyZXF1ZW50bHkgZnVsbCBvZiBsaXR0bGUgbWVzc2FnZXMgeW91IGNhbiBmaW5kLg iat-mode=0";
let bridge_1: BridgeConfigBuilder = BRIDGE1_LINE.parse()?;
// This is where we pass `BRIDGE1_LINE` into the BridgeConfigBuilder.
builder.bridges().bridges().push(bridge_1);

// Add a second bridge, built by hand.  This way is harder.
// This bridge is made up for demonstration, and won't work.
let mut bridge2_builder = BridgeConfigBuilder::default();
bridge2_builder
    .transport("obfs4")
    .push_setting("iat-mode", "1")
    .push_setting(
        "cert",
        "YnV0IHNvbWV0aW1lcyB0aGV5IGFyZSByYW5kb20u8x9aQG/0cIIcx0ItBcTqiSXotQne+Q"
    );
bridge2_builder.set_addrs(vec!["198.51.100.25:443".parse()?]);
bridge2_builder.set_ids(vec!["7DD62766BF2052432051D7B7E08A22F7E34A4543".parse()?]);
// Now insert the second bridge into our config builder.
builder.bridges().bridges().push(bridge2_builder);

// Now configure an obfs4 transport. (Requires the "pt-client" feature)
let mut transport = TransportConfigBuilder::default();
transport
    .protocols(vec!["obfs4".parse()?])
    // Specify either the name or the absolute path of pluggable transport client binary, this
    // may differ from system to system.
    .path(CfgPath::new("/usr/bin/obfs4proxy".into()))
    .run_on_startup(true);
builder.bridges().transports().push(transport);

let config = builder.build()?;
// Now you can pass `config` to TorClient::create!

You can also find an example based on snowflake in arti-client example folder.

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.

enabled: BoolOrAuto

Should we use configured bridges?

The default (Auto) is to use bridges if they are configured. false means to not use even configured bridges. true means to insist on the use of bridges; if none are configured, that’s then an error.

bridges: BridgeList

Configured list of bridges (possibly via pluggable transports)

transports: Vec<TransportConfig>

Available on crate feature pt-client only.

Configured list of pluggable transports.

Implementations

impl BridgesConfig

pub fn builder() -> BridgesConfigBuilder

Returns a fresh, default, builder

impl BridgesConfig

fn bridges_enabled(&self) -> bool

Should the bridges be used?

Trait Implementations

impl AsRef<BridgesConfig> for TorClientConfig

fn as_ref(&self) -> &BridgesConfig

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

impl Clone for BridgesConfig

fn clone(&self) -> BridgesConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BridgesConfig

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

Formats the value using the given formatter.

impl Default for BridgesConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BridgesConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for BridgesConfig

impl StructuralPartialEq for BridgesConfig