Struct OnionService

pub struct OnionService { /* private fields */ }

A handle to an instance of an onion service, which may or may not be running.

To construct an OnionService, use OnionServiceBuilder. It will not start handling requests until you call its .launch() method.

Note: the identity key (HsId) of the service is not generated until .launch() is called.

Implementations

impl OnionService

pub fn builder() -> OnionServiceBuilder

Create an OnionServiceBuilder.

pub fn launch<R>( self, runtime: R, netdir_provider: Arc<dyn NetDirProvider>, circ_pool: Arc<HsCircPool<R>>, path_resolver: Arc<CfgPathResolver>, ) -> Result<(Arc<RunningOnionService>, impl Stream<Item = RendRequest>), StartupError>

where R: Runtime,

Tell this onion service to begin running, and return a RunningOnionService and its stream of rendezvous requests.

You can turn the resulting stream into a stream of StreamRequest using the handle_rend_requests helper function.

Once the RunningOnionService is dropped, the onion service will stop publishing, and stop accepting new introduction requests. Existing streams and rendezvous circuits will remain open.

pub fn onion_address(&self) -> Option<HsId>

Return the onion address of this service.

Clients must know the service’s onion address in order to discover or connect to it.

Returns None if the HsId of the service could not be found in any of the configured keystores.

pub fn onion_name(&self) -> Option<HsId>

👎Deprecated: Use the new onion_address method instead

Return the onion address of this service.

See onion_address

pub fn generate_identity_key( &self, selector: KeystoreSelector<'_>, ) -> Result<HsId, StartupError>

Generate an identity key (KP_hs_id) for this service.

If the keystore specified by selector contains an entry for the identity key of this service, it will be returned. Otherwise, a new key will be generated.

Most users do not need to call this function: on launch, the service will automatically generate its identity key if needed. You should only use this function if you need to know the KP_hs_id of the service before launching it.

The selector argument is used for choosing the keystore in which to generate the keypair. While most users will want to write to the Primary, if you have configured this TorClient with a non-default keystore and wish to generate the keypair in it, you can do so by calling this function with a KeystoreSelector::Id specifying the keystore ID of your keystore.