Expand description

High-level functionality for accessing the Tor network as a client.

Overview

The arti-client crate aims to provide a safe, easy-to-use API for applications that want to use the Tor network to anonymize their traffic.

This crate is part of Arti, a project to implement Tor in Rust. It is the highest-level library crate in Arti, and the one that nearly all client-only programs should use. Most of its functionality is provided by lower-level crates in Arti.

⚠ Warnings ⚠

Note that Arti is a work in progress; although we’ve tried to write all the critical security components, you probably shouldn’t use Arti in production until it’s a bit more mature. (That said, now is a great time to try our Arti on an experimental basis, so you can tell us what we need to fix between now and the 1.0.0 release.)

Also note that the APIs for this crate are not all yet completely stable. We’ll try not to break things without good reason, and we’ll follow semantic versioning when we do, but please expect a certain amount of breakage between now and 1.0.0.

The APIs exposed by lower-level crates in Arti are even more unstable; they will break more often than those from arti-client, for less reason.

Using arti-client

The main entry point for this crate is the TorClient, an object that lets you make connections over the Tor network.

Connecting to Tor

Calling TorClient::create_bootstrapped establishes a connection to the Tor network, pulling in necessary state about network consensus as required. This state gets persisted to the locations specified in the TorClientConfig.

(This method requires you to initialize the client in an async fn. Consider using the builder method, below, if that doesn’t work for you.)

// The client configuration describes how to connect to the Tor network,
// and what directories to use for storing persistent state.
let config = TorClientConfig::default();

// Start the Arti client, and let it bootstrap a connection to the Tor network.
// (This takes a while to gather the necessary directory information.
// It uses cached information when possible.)
let tor_client = TorClient::create_bootstrapped(config).await?;

Creating a client and connecting later

You might wish to create a Tor client immediately, without waiting for it to bootstrap (or having to use an await). This can be done by making a TorClientBuilder with TorClient::builder, and calling TorClientBuilder::create_unbootstrapped.

The returned client can be made to bootstrap when it is first used (the default), or not; see BootstrapBehavior for more details.

// Specifying `BootstrapBehavior::OnDemand` means the client will automatically
// bootstrap when it is used. `Manual` exists if you'd rather have full control.
let tor_client = TorClient::builder()
    .bootstrap_behavior(BootstrapBehavior::OnDemand)
    .create_unbootstrapped()?;

Using the client

A client can then be used to make connections over Tor with TorClient::connect, which accepts anything implementing IntoTorAddr. This returns a DataStream, an anonymized TCP stream type that implements AsyncRead and AsyncWrite, as well as the Tokio versions of those traits if the tokio crate feature is enabled.

Example: making connections over Tor

// Initiate a connection over Tor to example.com, port 80.
let mut stream = tor_client.connect(("example.com", 80)).await?;

use futures::io::{AsyncReadExt, AsyncWriteExt};

// Write out an HTTP request.
stream
    .write_all(b"GET / HTTP/1.1\r\nHost: example.com\r\nConnection: close\r\n\r\n")
    .await?;

// IMPORTANT: Make sure the request was written.
// Arti buffers data, so flushing the buffer is usually required.
stream.flush().await?;

// Read and print the result.
let mut buf = Vec::new();
stream.read_to_end(&mut buf).await?;

println!("{}", String::from_utf8_lossy(&buf));

More advanced usage

This version of Arti includes basic support for “stream isolation”: the ability to ensure that different TCP connections (‘streams’) go over different Tor circuits (and thus different exit nodes, making them originate from different IP addresses).

This is useful to avoid deanonymizing users by correlation: for example, you might want a Tor connection to your bank and a Tor connection to an online forum to use different circuits, to avoid the possibility of the two identities being linked by having the same source IP.

Streams can be isolated in two ways:

Multiple runtime support

Arti uses the tor_rtcompat crate to support multiple asynchronous runtimes; currently, both Tokio and async-std are supported.

The backend Arti uses for TCP connections (tor_rtcompat::TcpProvider) and for creating TLS sessions (tor_rtcompat::TlsProvider) is also configurable using this crate. This can be used to embed Arti in custom environments where you want lots of control over how it uses the network.

View the tor_rtcompat crate documentation for more about these features.

Feature flags

Additive features

  • tokio (default) – build with Tokio support

  • native-tls (default) – build with the native-tls crate for TLS support

  • async-std – build with async-std support

  • full – Build with all features above, along with all stable additive features from other arti crates. (This does not include experimental features. It also does not include features that select a particular implementation to the exclusion of another, or those that set a build flag.)

  • rustls – build with the rustls crate for TLS support. This is not included in full, since it uses the ring crate, which uses the old (3BSD/SSLEay) OpenSSL license, which may introduce licensing compatibility issues.

Note that flags tokio, native-tls, async-std, rustls and static will enable the flags of the same name on the tor_rtcompat crate.

  • static – link with static versions of Arti’s system dependencies, like SQLite and OpenSSL (⚠ Warning ⚠: this feature will include a dependency on native-tls, even if you weren’t planning to use native-tls. If you only want to build with a static sqlite library, enable the static-sqlite feature. We’ll look for better solutions here in the future.)
  • static-sqlite – link with a static version of sqlite.
  • static-native-tls – link with a static version of native-tls. Enables native-tls.

Cryptographic acceleration features

Libraries should not enable these by default, since they replace one implementation with another.

  • accel-sha1-asm – Accelerate cryptography by using an assembly implementation of SHA1, if one is available.
  • accel-openssl – Accelerate cryptography by using openssl as a backend.

Experimental and unstable features

Note that the APIs enabled by these features are NOT covered by semantic versioning guarantees: we might break them or remove them between patch versions.

  • experimental-api – build with experimental, unstable API support.

  • error_detail – expose the arti_client::Error inner error type.

  • dirfilter – expose the DirFilter API, which lets you modify a network directory before it is used.

  • experimental – Build with all experimental features above, along with all experimental features from other arti crates.

Re-exports

pub use config::TorClientConfig;

Modules

Types and functions to configure a Tor client.

Types related to stream isolation

Code to collect and publish information about a client’s bootstrapping status.

Structs

The read half of a DataStream, implementing [futures::io::AsyncRead].

An anonymized stream over the Tor network.

The write half of a DataStream, implementing [futures::io::AsyncWrite].

Main high-level error type for the Arti Tor client

A token used to isolate unrelated streams on different circuits.

Preferences for how to route a stream over the Tor network.

An address object that you can connect to over the Tor network.

An active client session on the Tor network.

An object for constructing a TorClient.

Enums

Preferences for whether a TorClient should bootstrap on its own or not.

What level of sleep to put a Tor client into.

Represents errors that can occur while doing Tor operations.

Classification of an error arising from Arti’s Tor operations

An error created while making or using a TorAddr.

Traits

An object that can be converted to a TorAddr, but which it might be risky to get in the first place if you’re hoping for anonymity.

An object that knows how to construct some kind of DirProvider.

Errors that can be categorized as belonging to an ErrorKind

An object that can be converted to a TorAddr with a minimum of risk.

Type Definitions

Alias for the Result type corresponding to the high-level Error.