README.md

libp2p Tor

Tor based transport for libp2p. Connect through the Tor network to TCP listeners.

Build on top of Arti.

⚠️ Misuse warning ⚠️ - read carefully before using

Although the sound of "Tor" might convey a sense of security it is very easy to misuse this crate and leaking private information while using. Study libp2p carefully and try to make sure you fully understand it's current limits regarding privacy. I.e. using identify might already render this transport obsolete.

This transport explicitly doesn't provide any enhanced privacy if it's just used like a regular transport. Use with caution and at your own risk. Don't just blindly advertise Tor without fully understanding what you are dealing with.

Add to your dependencies

This won't work:

cargo add [email protected]

You have to choose a TLS provider and a runtime. The TLS providers are:

• rustls
• native-tls

The runtimes are:

• tokio
• async-std

	rustls	native-tls
tokio	cargo add [email protected] -F tokio,rustls	cargo add [email protected] -F tokio,native-tls
async-std	cargo add [email protected] -F async-std,rustls	cargo add [email protected] -F async-std,native-tls

Example

let address = "/dns/www.torproject.org/tcp/1000".parse()?;
let mut transport = libp2p_community_tor::AsyncStdNativeTlsTorTransport::bootstrapped().await?;
// we have achieved tor connection
let _conn = transport.dial(address)?.await?;

About

This crate originates in a PR to bring Tor support too rust-libp2p. Read more about it here: libp2p/rust-libp2p#2899

License: MIT