Struct tor_guardmgr::GuardMgr

pub struct GuardMgr<R: Runtime> { /* private fields */ }

A “guard manager” that selects and remembers a persistent set of guard nodes.

This is a “handle”; clones of it share state.

Implementations

impl<R: Runtime> GuardMgr<R>

pub fn new<S>( runtime: R, state_mgr: S, config: &impl GuardMgrConfig ) -> Result<Self, GuardMgrError>

where S: StateMgr + Send + Sync + 'static,

Create a new “empty” guard manager and launch its background tasks.

It won’t be able to hand out any guards until a NetDirProvider has been installed.

pub fn install_netdir_provider( &self, provider: &Arc<dyn NetDirProvider> ) -> Result<(), GuardMgrError>

Install a NetDirProvider for use by this guard manager.

It will be used to keep the guards up-to-date with changes from the network directory, and to find new guards when no NetDir is provided to select_guard().

TODO: we should eventually return some kind of a task handle from this task, even though it is not strictly speaking periodic.

The guardmgr retains only a Weak reference to provider, install_netdir_provider downgrades it on entry,

Panics

Panics if a NetDirProvider is already installed.

pub fn install_bridge_desc_provider( &self, provider: &Arc<dyn BridgeDescProvider> ) -> Result<(), GuardMgrError>

Available on crate feature bridge-client only.

Configure a new bridge::BridgeDescProvider for this GuardMgr.

It will be used to learn about changes in the set of available bridge descriptors; we’ll inform it whenever our desired set of bridge descriptors changes.

TODO: Same todo as in install_netdir_provider about task handles.

Panics

Panics if a bridge::BridgeDescProvider is already installed.

pub fn store_persistent_state(&self) -> Result<(), GuardMgrError>

Flush our current guard state to the state manager, if there is any unsaved state.

pub fn reload_persistent_state(&self) -> Result<(), GuardMgrError>

Reload state from the state manager.

We only call this method if we don’t have the lock on the state files. If we have the lock, we only want to save.

pub fn upgrade_to_owned_persistent_state(&self) -> Result<(), GuardMgrError>

Switch from having an unowned persistent state to having an owned one.

Requires that we hold the lock on the state files.

pub fn netdir_is_sufficient(&self, netdir: &NetDir) -> bool

Return true if netdir has enough information to safely become our new netdir.

pub fn mark_all_guards_retriable(&self)

Mark every guard as potentially retriable, regardless of how recently we failed to connect to it.

pub fn install_test_netdir(&self, netdir: &NetDir)

Available on crate feature testing only.

Configure this guardmgr to use a fixed NetDir instead of a provider.

This function is for testing only, and is exclusive with install_netdir_provider.

Panics

Panics if any NetDirProvider has already been installed.

pub fn reconfigure( &self, config: &impl GuardMgrConfig ) -> Result<RetireCircuits, ReconfigureError>

Replace the configuration in this GuardMgr with config.

pub fn set_filter(&self, filter: GuardFilter)

Replace the current GuardFilter used by this GuardMgr.

pub fn select_guard( &self, usage: GuardUsage ) -> Result<(FirstHop, GuardMonitor, GuardUsable), PickGuardError>

Select a guard for a given GuardUsage.

On success, we return a FirstHop object to identify which guard we have picked, a GuardMonitor object that the caller can use to report whether its attempt to use the guard succeeded or failed, and a GuardUsable future that the caller can use to decide whether a circuit built through the guard is actually safe to use.

That last point is important: It’s okay to build a circuit through the guard returned by this function, but you can’t actually use it for traffic unless the GuardUsable future yields “true”.

pub fn note_external_failure<T>( &self, identity: &T, external_failure: ExternalActivity )

where T: HasRelayIds + ?Sized,

Record that after we built a circuit with a guard, something described in external_failure went wrong with it.

pub fn note_external_success<T>( &self, identity: &T, external_activity: ExternalActivity )

where T: HasRelayIds + ?Sized,

Record that after we built a circuit with a guard, some activity described in external_activity was successful with it.

pub fn skew_events(&self) -> ClockSkewEvents

Return a stream of events about our estimated clock skew; these events are None when we don’t have enough information to make an estimate, and Some(SkewEstimate) otherwise.

Note that this stream can be lossy: if the estimate changes more than one before you read from the stream, you might only get the most recent update.

Trait Implementations

impl<R: Clone + Runtime> Clone for GuardMgr<R>

fn clone(&self) -> GuardMgr<R>

Returns a copy of the value.

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

Performs copy-assignment from source.