Struct OnionService

pub struct OnionService { /* private fields */ }

Definition of a Tor Onion service (AKA “hidden service”).

An onion service can be thought of as an encrypted load balancer, which presents itself as a virtual host in the Tor network, and which maps virtual ports on that virtual host to service ports running on your local machine. While, in practice, most onion services map a single virtual port to a service port, say, 443 to 443, you can map multiple virtual ports to a single service port, or a single virtual port to multiple service ports (in which case Tor will load balance the traffic coming in on the virtual port across the corresponding service ports).

Each onion service has the following:

• The service ID contains all the information for the public key (see TorServiceId for
• details).
• The signing, i.e, private, key for the onion service
• The mapping from the virtual port(s) to the service port(s)

Implementations

impl OnionService

pub fn new<K>(key: K, ports: &[OnionServiceMapping]) -> Self

where TorEd25519SigningKey: From<K>,

Create a new OnionService object

pub fn listen_addresses_for_onion_address( &self, onion_address: &str, ) -> Vec<TorSocketAddr>

Return all the listen addresses for a given onion address (including virtual port) onion_address should be formatted as <onion-address>:<port>, e.g. joikeok6el5h5sbrojo2h3afw63lmfm7huvwtziacl34wjrx7n62gsad.onion:443

pub fn listen_addresses_for_port(&self, service_port: u16) -> Vec<TorSocketAddr>

Return all the listen addresses for the given local service port

pub fn onion_address(&self, service_port: u16) -> Result<OnionAddress, TorError>

Return the onion address (i.e., the onion hostname and virtual port) which maps to the given local service port

pub fn onion_addresses(&self) -> Vec<OnionAddress>

Return a list of all the onion addresses for this onion service

pub fn service_id(&self) -> &TorServiceId

Return the TorServiceId for this onion service

pub fn signing_key(&self) -> &TorEd25519SigningKey

Return the Tor signing key for this onion service

pub fn ports(&self) -> Vec<OnionServiceMapping>

Return the list of virtual to service port mappings for this onion service

Trait Implementations

impl From<OnionService> for TorEd25519SigningKey

Convert an onion service to a signing key

fn from(onion_service: OnionService) -> Self

Converts to this type from the input type.