doc/tor.md

   1 TOR SUPPORT IN BITCOIN
   2 ======================
   3
   4 It is possible to run Bitcoin as a Tor hidden service, and connect to such services.
   5
   6 The following directions assume you have a Tor proxy running on port 9050. Many distributions default to having a SOCKS proxy listening on port 9050, but others may not. In particular, the Tor Browser Bundle defaults to listening on port 9150. See [Tor Project FAQ:TBBSocksPort](https://www.torproject.org/docs/faq.html.en#TBBSocksPort) for how to properly
   7 configure Tor.
   8
   9
  10 1. Run bitcoin behind a Tor proxy
  11 ---------------------------------
  12
  13 The first step is running Bitcoin behind a Tor proxy. This will already make all
  14 outgoing connections be anonymized, but more is possible.
  15
  16         -proxy=ip:port  Set the proxy server. If SOCKS5 is selected (default), this proxy
  17                         server will be used to try to reach .onion addresses as well.
  18
  19         -onion=ip:port  Set the proxy server to use for tor hidden services. You do not
  20                         need to set this if it's the same as -proxy. You can use -noonion
  21                         to explicitly disable access to hidden service.
  22
  23         -listen         When using -proxy, listening is disabled by default. If you want
  24                         to run a hidden service (see next section), you'll need to enable
  25                         it explicitly.
  26
  27         -connect=X      When behind a Tor proxy, you can specify .onion addresses instead
  28         -addnode=X      of IP addresses or hostnames in these parameters. It requires
  29         -seednode=X     SOCKS5. In Tor mode, such addresses can also be exchanged with
  30                         other P2P nodes.
  31
  32 In a typical situation, this suffices to run behind a Tor proxy:
  33
  34         ./bitcoin -proxy=127.0.0.1:9050
  35
  36
  37 2. Run a bitcoin hidden server
  38 ------------------------------
  39
  40 If you configure your Tor system accordingly, it is possible to make your node also
  41 reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent
  42 config file):
  43
  44         HiddenServiceDir /var/lib/tor/bitcoin-service/
  45         HiddenServicePort 8333 127.0.0.1:8333
  46         HiddenServicePort 18333 127.0.0.1:18333
  47
  48 The directory can be different of course, but (both) port numbers should be equal to
  49 your bitcoind's P2P listen port (8333 by default).
  50
  51         -externalip=X   You can tell bitcoin about its publicly reachable address using
  52                         this option, and this can be a .onion address. Given the above
  53                         configuration, you can find your onion address in
  54                         /var/lib/tor/bitcoin-service/hostname. Onion addresses are given
  55                         preference for your node to advertise itself with, for connections
  56                         coming from unroutable addresses (such as 127.0.0.1, where the
  57                         Tor proxy typically runs).
  58
  59         -listen         You'll need to enable listening for incoming connections, as this
  60                         is off by default behind a proxy.
  61
  62         -discover       When -externalip is specified, no attempt is made to discover local
  63                         IPv4 or IPv6 addresses. If you want to run a dual stack, reachable
  64                         from both Tor and IPv4 (or IPv6), you'll need to either pass your
  65                         other addresses using -externalip, or explicitly enable -discover.
  66                         Note that both addresses of a dual-stack system may be easily
  67                         linkable using traffic analysis.
  68
  69 In a typical situation, where you're only reachable via Tor, this should suffice:
  70
  71         ./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen
  72
  73 (obviously, replace the Onion address with your own). It should be noted that you still
  74 listen on all devices and another node could establish a clearnet connection, when knowing
  75 your address. To mitigate this, additionally bind the address of your Tor proxy:
  76
  77         ./bitcoind ... -bind=127.0.0.1
  78
  79 If you don't care too much about hiding your node, and want to be reachable on IPv4
  80 as well, use `discover` instead:
  81
  82         ./bitcoind ... -discover
  83
  84 and open port 8333 on your firewall (or use -upnp).
  85
  86 If you only want to use Tor to reach onion addresses, but not use it as a proxy
  87 for normal IPv4/IPv6 communication, use:
  88
  89         ./bitcoin -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover
  90
  91 3. Automatically listen on Tor
  92 --------------------------------
  93
  94 Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket
  95 API, to create and destroy 'ephemeral' hidden services programmatically.
  96 Bitcoin Core has been updated to make use of this.
  97
  98 This means that if Tor is running (and proper authentication has been configured),
  99 Bitcoin Core automatically creates a hidden service to listen on. This will positively
 100 affect the number of available .onion nodes.
 101
 102 This new feature is enabled by default if Bitcoin Core is listening (`-listen`), and
 103 requires a Tor connection to work. It can be explicitly disabled with `-listenonion=0`
 104 and, if not disabled, configured using the `-torcontrol` and `-torpassword` settings.
 105 To show verbose debugging information, pass `-debug=tor`.
 106
 107 Connecting to Tor's control socket API requires one of two authentication methods to be
 108 configured. For cookie authentication the user running bitcoind must have write access
 109 to the `CookieAuthFile` specified in Tor configuration. In some cases this is
 110 preconfigured and the creation of a hidden service is automatic. If permission problems
 111 are seen with `-debug=tor` they can be resolved by adding both the user running tor and
 112 the user running bitcoind to the same group and setting permissions appropriately. On
 113 Debian-based systems the user running bitcoind can be added to the debian-tor group,
 114 which has the appropriate permissions. An alternative authentication method is the use
 115 of the `-torpassword` flag and a `hash-password` which can be enabled and specified in
 116 Tor configuration.
 117
 118 4. Privacy recommendations
 119 ---------------------------
 120
 121 - Do not add anything but bitcoin ports to the hidden service created in section 2.
 122   If you run a web service too, create a new hidden service for that.
 123   Otherwise it is trivial to link them, which may reduce privacy. Hidden
 124   services created automatically (as in section 3) always have only one port
 125   open.