doc/Tor.txt

   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 assumes you have a Tor proxy running on port 9050. Many distributions
   7 default to having a SOCKS proxy listening on port 9050, but others may not.
   8 In particular, the Tor Browser Bundle defaults to listening on a random port. See
   9 https://www.torproject.org/docs/faq.html.en#TBBSocksPort for how to properly
  10 configure Tor.
  11
  12
  13 1. Run bitcoin behind a Tor proxy
  14 ---------------------------------
  15
  16 The first step is running Bitcoin behind a Tor proxy. This will already make all
  17 outgoing connections be anonimized, but more is possible.
  18
  19 -socks=5        SOCKS5 supports connecting-to-hostname, which can be used instead
  20                 of doing a (leaking) local DNS lookup. SOCKS5 is the default,
  21                 but SOCKS4 does not support this. (SOCKS4a does, but isn't
  22                 implemented).
  23
  24 -proxy=ip:port  Set the proxy server. If SOCKS5 is selected (default), this proxy
  25                 server will be used to try to reach .onion addresses as well.
  26
  27 -tor=ip:port    Set the proxy server to use for tor hidden services. You do not
  28                 need to set this if it's the same as -proxy. You can use -notor
  29                 to explicitly disable access to hidden service.
  30
  31 -listen         When using -proxy, listening is disabled by default. If you want
  32                 to run a hidden service (see next section), you'll need to enable
  33                 it explicitly.
  34
  35 -connect=X      When behind a Tor proxy, you can specify .onion addresses instead
  36 -addnode=X      of IP addresses or hostnames in these parameters. It requires
  37 -seednode=X     SOCKS5. In Tor mode, such addresses can also be exchanged with
  38                 other P2P nodes.
  39
  40 In a typical situation, this suffices to run behind a Tor proxy:
  41
  42   ./bitcoin -proxy=127.0.0.1:9050
  43
  44
  45 2. Run a bitcoin hidden server
  46 ------------------------------
  47
  48 If you configure your Tor system accordingly, it is possible to make your node also
  49 reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent
  50 config file):
  51
  52   HiddenServiceDir /var/lib/tor/bitcoin-service/
  53   HiddenServicePort 8333 127.0.0.1:8333
  54
  55 The directory can be different of course, but (both) port numbers should be equal to
  56 your bitcoind's P2P listen port (8333 by default).
  57
  58 -externalip=X   You can tell bitcoin about its publicly reachable address using
  59                 this option, and this can be a .onion address. Given the above
  60                 configuration, you can find your onion address in
  61                 /var/lib/tor/bitcoin-service/hostname. Onion addresses are given
  62                 preference for your node to advertize itself with, for connections
  63                 coming from unroutable addresses (such as 127.0.0.1, where the
  64                 Tor proxy typically runs).
  65
  66 -listen         You'll need to enable listening for incoming connections, as this
  67                 is off by default behind a proxy.
  68
  69 -discover       When -externalip is specified, no attempt is made to discover local
  70                 IPv4 or IPv6 addresses. If you want to run a dual stack, reachable
  71                 from both Tor and IPv4 (or IPv6), you'll need to either pass your
  72                 other addresses using -externalip, or explicitly enable -discover.
  73                 Note that both addresses of a dual-stack system may be easily
  74                 linkable using traffic analysis.
  75
  76 In a typical situation, where you're only reachable via Tor, this should suffice:
  77
  78   ./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen
  79
  80 (obviously replace the Onion address with your own). If you don't care too much
  81 about hiding your node, and want to be reachable on IPv4 as well, additionally
  82 specify:
  83
  84   ./bitcoind ... -discover
  85
  86 and open port 8333 on your firewall (or use -upnp).
  87
  88 If you only want to use Tor to reach onion addresses, but not use it as a proxy
  89 for normal IPv4/IPv6 communication, use:
  90
  91   ./bitcoin -tor=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover
  92