Struct tor_interface::mock_tor_client::MockTorClient

pub struct MockTorClient { /* private fields */ }

A mock TorProvider implementation for testing.

MockTorClient implements the TorProvider trait. It creates a fake, in-process Tor Network using local socekts and listeners. No actual traffic ever leaves the local host.

Mock onion-services can be created, connected to, and communiccated with. Connecting to clearnet targets always succeeds by connecting to single local endpoint, but will never send any traffic to connecting clients.

Implementations

impl MockTorClient

pub fn new() -> MockTorClient

Construt a new MockTorClient.

Trait Implementations

impl Default for MockTorClient

fn default() -> Self

Returns the “default value” for a type.

impl Drop for MockTorClient

fn drop(&mut self)

Executes the destructor for this type.

impl TorProvider for MockTorClient

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.