Struct tor_guardmgr::bridge::BridgeConfig

pub struct BridgeConfig(/* private fields */);

Available on crate feature bridge-client only.

A relay not listed on the main tor network, used for anticensorship.

This object represents a bridge as configured by the user or by software running on the user’s behalf.

Pieces of a bridge configuration.

A bridge configuration contains:

• Optionally, the name of a pluggable transport (q.v.) to use.
• Zero or more addresses at which to contact the bridge. These can either be regular IP addresses, hostnames, or arbitrary strings to be interpreted by the pluggable transport.
• One or more cryptographic identities for the bridge.
• Zero or more optional “key=value” string parameters to pass to the pluggable transport when contacting to this bridge.

String representation

Can be parsed from, and represented as, a “bridge line” string, using the FromStr and Display implementations.

The syntax supported is a sequence of words, separated by ASCII whitespace, in the following order:

• Optionally, the word Bridge (or a case variant thereof). (Bridge is not part of a bridge line, but is ignored here for convenience when copying a line out of a C Tor torrc.)

• Optionally, the name of the pluggable transport to use. If not supplied, Arti will make the connection directly, itself.

• The Host:ORPort to connect to. Host can be an IPv4 address, or an IPv6 address in brackets [ ]. When a pluggable transport is in use, Host can also be a hostname; or if the transport supports operating without a specified address. Host:ORPort can be omitted and replaced with -.

• One or more identity key fingerprints, each in one of the supported (RSA or ed25519) fingerprint formats. Currently, supplying an RSA key is required; an ed25519 key is optional.

• When a pluggable transport is in use, zero or more key=value parameters to pass to the transport (smuggled in the SOCKS handshake, as described in the Tor PT specification).

This type is cheap to clone: it is a newtype around an Arc.

Implementations

impl BridgeConfig

pub fn builder() -> BridgeConfigBuilder

Returns a fresh, default, builder

Trait Implementations

impl ChanTarget for BridgeConfig

fn display_chan_target(&self) -> DisplayChanTarget<'_, Self>

where Self: Sized,

Return a reference to this object suitable for formatting its ChanTarget-specific members.

impl Clone for BridgeConfig

fn clone(&self) -> BridgeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BridgeConfig

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

Formats the value using the given formatter.

impl Display for BridgeConfig

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

Formats the value using the given formatter.

impl FromStr for BridgeConfig

type Err = BridgeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl HasAddrs for BridgeConfig

fn addrs(&self) -> &[SocketAddr]

Return the addresses listed for this server.

impl HasChanMethod for BridgeConfig

fn chan_method(&self) -> ChannelMethod

Return the known ways to contact this

impl HasRelayIds for BridgeConfig

fn identity(&self, key_type: RelayIdType) -> Option<RelayIdRef<'_>>

Return the identity of this relay whose type is key_type, or None if the relay has no such identity.

fn identities(&self) -> RelayIdIter<'_, Self>

Return an iterator over all of the identities held by this object.

fn ed_identity(&self) -> Option<&Ed25519Identity>

Return the ed25519 identity for this relay if it has one.

fn rsa_identity(&self) -> Option<&RsaIdentity>

Return the RSA identity for this relay if it has one.

fn has_identity(&self, id: RelayIdRef<'_>) -> bool

Check whether the provided Id is a known identity of this relay.

fn has_any_identity(&self) -> bool

Return true if this object has any known identity.

fn same_relay_ids<T>(&self, other: &T) -> bool

where T: HasRelayIds + ?Sized,

Return true if this object has exactly the same relay IDs as other.

fn has_all_relay_ids_from<T>(&self, other: &T) -> bool

where T: HasRelayIds + ?Sized,

Return true if this object has every relay ID that other does.

fn has_any_relay_id_from<T>(&self, other: &T) -> bool

where T: HasRelayIds + ?Sized,

Return true if this object has any relay ID that other has.

fn cmp_by_relay_ids<T>(&self, other: &T) -> Ordering

where T: HasRelayIds + ?Sized,

Compare this object to another HasRelayIds.

fn display_relay_ids(&self) -> DisplayRelayIds<'_, Self>

Return a reference to this object suitable for formatting its HasRelayIds members.

impl Hash for BridgeConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BridgeConfig

fn eq(&self, other: &BridgeConfig) -> 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 BridgeConfig

impl StructuralPartialEq for BridgeConfig