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
MultikeyIsolatedMapindexed 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 ๐ oneshotchannel 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ยง
- HsClient
Connector - 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.