Struct tor_interface::arti_client_tor_client::ArtiClientTorClient

pub struct ArtiClientTorClient { /* private fields */ }

The ArtiClientTorClient is an in-process arti-client-based TorProvider.

Implementations

impl ArtiClientTorClient

pub fn new( tokio_runtime: Arc<Runtime>, root_data_directory: &Path, ) -> Result<Self, Error>

Construct a new ArtiClientTorClient which uses a Tokio runtime internally for all async operations.

Trait Implementations

impl TorProvider for ArtiClientTorClient

fn update(&mut self) -> Result<Vec<TorEvent>, Error>

Process and return TorEvents handled by this TorProvider.

fn bootstrap(&mut self) -> Result<(), Error>

Begin connecting to the Tor Network.

fn add_client_auth( &mut self, service_id: &V3OnionServiceId, client_auth: &X25519PrivateKey, ) -> Result<(), Error>

Add v3 onion-service authorisation credentials, allowing this TorProvider to connect to an onion-service whose service-descriptor is encrypted using the assocciated x25519 public key.

fn remove_client_auth( &mut self, service_id: &V3OnionServiceId, ) -> Result<(), Error>

Remove a previously added client authorisation credential. This TorProvider will be unable to connect to the onion-service associated with the removed credentail.

fn connect( &mut self, target: TargetAddr, circuit: Option<CircuitToken>, ) -> Result<OnionStream, Error>

Anonymously connect to the address specified by target over the Tor Network and return the associated OnionStream.

fn listener( &mut self, private_key: &Ed25519PrivateKey, virt_port: u16, authorized_clients: Option<&[X25519PublicKey]>, ) -> Result<OnionListener, Error>

Anonymously start an onion-service and return the associated OnionListener.

fn generate_token(&mut self) -> CircuitToken

Create a new CircuitToken.

fn release_token(&mut self, _token: CircuitToken)

Releaes a previously generated CircuitToken.