Skip to main content

Crate tor_hsclient

Crate tor_hsclient 

Source
Expand description

ยงtor-hsclient

Core implementation for onion services client.

This crate creates circuits to onion circuits, retains them for reuse, and hands them out as appropriate. It is also responsible for maintaining all relevant state about hidden services, and their descriptors and introduction points.

Re-exportsยง

pub(crate) use futures::StreamExt as _; ๐Ÿ”’
pub(crate) use tor_rtcompat::SpawnExt as _; ๐Ÿ”’
pub use err::FailedAttemptError;
pub use err::ConnError;
pub use err::DescriptorError;
pub use err::DescriptorErrorDetail;
pub use err::StartupError;
pub use keys::HsClientDescEncKeypairSpecifier;
pub use keys::HsClientSecretKeys;
pub use keys::HsClientSecretKeysBuilder;
pub use relay_info::InvalidTarget;
pub use state::HsClientConnectorConfig;
pub(crate) use err::IntroPtIndex; ๐Ÿ”’
pub(crate) use err::rend_pt_identity_for_error; ๐Ÿ”’
pub(crate) use state::Config; ๐Ÿ”’
pub(crate) use state::MockableConnectorData; ๐Ÿ”’
pub(crate) use state::Services; ๐Ÿ”’
pub(crate) use std::future::Future; ๐Ÿ”’
pub(crate) use Arc; ๐Ÿ”’
pub(crate) use Mutex; ๐Ÿ”’
pub(crate) use MutexGuard; ๐Ÿ”’
pub(crate) use futures::stream::BoxStream; ๐Ÿ”’
pub(crate) use educe::Educe; ๐Ÿ”’
pub(crate) use debug; ๐Ÿ”’
pub(crate) use instrument; ๐Ÿ”’
pub(crate) use instrument; ๐Ÿ”’
pub(crate) use tor_circmgr::ClientOnionServiceDataTunnel; ๐Ÿ”’
pub(crate) use tor_circmgr::hspool::HsCircPool; ๐Ÿ”’
pub(crate) use tor_circmgr::isolation::StreamIsolation; ๐Ÿ”’
pub(crate) use Bug; ๐Ÿ”’
pub(crate) use internal; ๐Ÿ”’
pub(crate) use tor_hscrypto::pk::HsId; ๐Ÿ”’
pub(crate) use tor_netdir::NetDir; ๐Ÿ”’
pub(crate) use tor_rtcompat::Runtime; ๐Ÿ”’

Modulesยง

caps ๐Ÿ”’
Functionality for negotiating protocol capabilities.
connect ๐Ÿ”’
Main implementation of the connection functionality
err ๐Ÿ”’
Errors relating to being a hidden service client
isol_map ๐Ÿ”’
Data structure MultikeyIsolatedMap indexed by multiple keys and an isolation
keys ๐Ÿ”’
Hidden service (onion service) client key management functionality
pow ๐Ÿ”’
Common support for proof of work denial of service mitigation on the client side
proto_oneshot ๐Ÿ”’
oneshot channel between a circuit control message handler and the main code
relay_info ๐Ÿ”’
Translate relay information from the formats used in the onion service protocol into CircTargets that we can use for building circuits.
state ๐Ÿ”’
Implement a cache for onion descriptors and the facility to remember a bit about onion service history.

Structsยง

HsClientConnector
An object that negotiates connections with onion services

Functionsยง

supported_hsclient_protocols
Return a list of the protocols supported by this crate, running as a hidden service client.