lnd.xprv/docs/configuring_tor.md
2018-02-09 12:16:16 -08:00

5.6 KiB

Table of Contents

  1. Overview
  2. Outbound Connections Only
  3. Tor Stream Isolation

1. Overview

lnd currently has partial support for using Lightning over Tor. Usage of Lightning over Tor is valuable as routing nodes no longer need to potentially expose their location via their advertised IP address. Additionally, leaf nodes can also protect their location by using Tor for anonymous networking to establish connections.

At the time of the writing of this documentation, lnd only supports usage of Tor for establishing outbound connections. In the near future, support for full Onion Service usage will be added as well. Support for both v2 and v3 onion services are planned. With widespread usage of Onion Services within the network, concerns about the difficulty of proper NAT traversal are alleviated, as usage of Onion Services allows nodes to accept inbound connections even if they're behind a NAT.

Before following the remainder of this documentation, you should ensure that you already have Tor installed locally. Official instructions to install the latest release of Tor can be found here.

NOTE: This documentation covers how to ensure that lnd's Lightning protocol traffic is tunnled over Tor. Users will need to take care that if they're running using a Bitcoin full-node, then that is also configured to proxy all trafic over Tor. If using the neutrino backend for lnd, then it will automatically also default to Tor usage if active within lnd.

2. Outbound Connections Only

Currenty, lnd only supports purely outbound Tor usage. In this mode, lnd won't listen at all, and will only be able to establish outbound connections. All protocol traffic will be tunneled over Tor. Additionally, we'll also force any DNS requests over Tor such that we don't leak our IP address to the clear net.

The remainder of this tutorial assumes one already has the tor daemon installed locally.

First, you'll want to run tor locally before starting up lnd. Depending on how you installed Tor, you'll find the configuration file at /usr/local/etc/tor/torrc. Here's an example configuration file that we'll be using for the remainder of the tutorial:

SOCKSPort 9050 # Default: Bind to localhost:9050 for local connections.
Log notice stdout
ControlPort 9051
CookieAuthentication 1

With the configuration file created, you'll then want to start the Tor daemon:

⛰  tor
Feb 05 17:02:06.501 [notice] Tor 0.3.1.8 (git-ad5027f7dc790624) running on Darwin with Libevent 2.1.8-stable, OpenSSL 1.0.2l, Zlib 1.2.8, Liblzma N/A, and Libzstd N/A.
Feb 05 17:02:06.502 [notice] Tor can't help you if you use it wrong! Learn how to be safe at https://www.torproject.org/download/download#warning
Feb 05 17:02:06.502 [notice] Read configuration file "/usr/local/etc/tor/torrc".
Feb 05 17:02:06.506 [notice] Opening Socks listener on 127.0.0.1:9050
Feb 05 17:02:06.506 [notice] Opening Control listener on 127.0.0.1:9051

Once the tor daemon has started and it has finished bootstrapping, you'll see this in the logs:

Feb 05 17:02:06.000 [notice] Bootstrapped 0%: Starting
Feb 05 17:02:07.000 [notice] Starting with guard context "default"
Feb 05 17:02:07.000 [notice] Bootstrapped 80%: Connecting to the Tor network
Feb 05 17:02:07.000 [notice] Bootstrapped 85%: Finishing handshake with first hop
Feb 05 17:02:08.000 [notice] Bootstrapped 90%: Establishing a Tor circuit
Feb 05 17:02:11.000 [notice] Tor has successfully opened a circuit. Looks like client functionality is working.
Feb 05 17:02:11.000 [notice] Bootstrapped 100%: Done

This indicates the daemon is fully bootstrapped and ready to proxy connections. At this point, we can now start lnd with the relevant arguments:

⛰  ./lnd -h

<snip>

Tor:
      --tor.socks=                             The port that Tor's exposed SOCKS5 proxy is listening on. Using Tor allows outbound-only connections (listening will be disabled) -- NOTE port must be between 1024 and 65535
      --tor.dns=                               The DNS server as IP:PORT that Tor will use for SRV queries - NOTE must have TCP resolution enabled

The --tor.socks argument should point to the interface that the Tor daemon is listening on to proxy connections. The --tor.dns flag is required in order to be able to properly automatically bootstrap a set of peer connections. The tor daemon doesn't currently support proxying SRV queries over Tor. So instead, we need to connect directly to the authoritative DNS server over TCP, in order query for SRV records that we can use to bootstrap our connections. As of the time this documentation was written, for Bitcoin's Testnet, clients should point to nodes.lightning.directory.

Finally, we'll start lnd with the proper arguments:

⛰  ./lnd --tor.socks=9050 --tor.dns=nodes.lightning.directory

With the above arguments, lnd will proxy all network traffic over Tor!

3. Tor Stream Isolation

Our support for Tor also has an additional privacy enhancing modified: stream isolation. Usage of this mode means that Tor will always use new circuit for each connection. This added features means that it's harder to correlate connections. As otherwise, several applications using Tor might share the same circuit.

Activating stream isolation is very straightforward, we only require the specification of an additional argument:

⛰  ./lnd --tor.socks=9050 --tor.dns=nodes.lightning.directory --tor.streamisolation