#socks #tor #peer-to-peer #libp2p #networking


TCP/IP (via a SOCKS5 proxy) transport protocol for libp2p

10 releases (6 breaking)

0.7.1 Jan 21, 2021
0.7.0 Jan 21, 2021
0.6.0 Dec 21, 2020
0.5.0 Nov 25, 2020
0.1.1 Jul 24, 2020

#516 in Network programming

Download history 76/week @ 2021-01-09 129/week @ 2021-01-16 114/week @ 2021-01-23 4/week @ 2021-01-30 12/week @ 2021-02-06 152/week @ 2021-02-13 10/week @ 2021-02-20 3/week @ 2021-02-27 20/week @ 2021-03-06 165/week @ 2021-03-13 40/week @ 2021-03-20 21/week @ 2021-03-27 20/week @ 2021-04-03 18/week @ 2021-04-10 17/week @ 2021-04-17 3/week @ 2021-04-24

422 downloads per month

GPL-3.0 license

434 lines

Rust-libp2p TCP/IP via a SOCKS5 proxy

Contains an implementation of the rust-libp2p Transport that can be used to redirect traffic over a SOCKS5 proxy.

Provides the Socks5TokioTcpConfig type which can be use when building a swarm.

Example transport creation:

/// Builds a libp2p transport with the following features:
/// - TCP connectivity over the Tor network
/// - DNS name resolution
/// - Authentication via secio
/// - Multiplexing via yamux or mplex
fn build_transport(
    keypair: Keypair,
    addr: Multiaddr,
) -> anyhow::Result<PingPongTransport> {
    let mut map = HashMap::new();
    map.insert(addr, LOCAL_PORT);

    let tcp = Socks5TokioTcpConfig::default().nodelay(true).onion_map(map);
    let transport = DnsConfig::new(tcp)?;

    let transport = transport
        .map(|(peer, muxer), _| (peer, StreamMuxerBox::new(muxer)))


Currently functionality is limited to using the Tor daemon as the SOCKS5 proxy (see below for reason).


See examples/ping.rs for a complete running example using Tor.

You should configure your Tor onion service to redirect traffic to some local port. The onion address and port will be needed when creating the transport as show above.

Example Tor configuration:

 HiddenServiceDir /var/lib/tor/hidden_service/
 HiddenServicePort 7

Check the hidden service data directory for a file called hostname, this contains the onion address for the service.

SOCKS5 vs Tor

This repository is named SOCKS5 instead of Tor because technically there is no reason to be Tor specific. In actuality the transport created with Socks5TokioTcpConfig will only currently work with a Tor proxy because of the address munging we do before passing the target address to the proxy. PRs welcome, please see https://github.com/comit-network/rust-libp2p-tokio-socks5/issues/1.


~276K SLoC