Changeset View
Changeset View
Standalone View
Standalone View
doc/tor.md
Show All 28 Lines | outgoing connections, but more is possible. | ||||
-onlynet=onion Make outgoing connections only to .onion addresses. Incoming | -onlynet=onion Make outgoing connections only to .onion addresses. Incoming | ||||
connections are not affected by this option. This option can be | connections are not affected by this option. This option can be | ||||
specified multiple times to allow multiple network types, e.g. | specified multiple times to allow multiple network types, e.g. | ||||
ipv4, ipv6, or onion. | ipv4, ipv6, or onion. | ||||
In a typical situation, this suffices to run behind a Tor proxy: | In a typical situation, this suffices to run behind a Tor proxy: | ||||
./bitcoind -proxy=127.0.0.1:9050 | ./ecashd -proxy=127.0.0.1:9050 | ||||
## 2. Run a Bitcoin ABC hidden server | ## 2. Run a Bitcoin ABC hidden server | ||||
If you configure your Tor system accordingly, it is possible to make your node also | If you configure your Tor system accordingly, it is possible to make your node also | ||||
reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent | reachable from the Tor network. Add these lines to your /etc/tor/torrc (or equivalent | ||||
config file): *Needed for Tor version 0.2.7.0 and older versions of Tor only. For newer | config file): *Needed for Tor version 0.2.7.0 and older versions of Tor only. For newer | ||||
versions of Tor see [Section 3](#3-automatically-listen-on-tor).* | versions of Tor see [Section 3](#3-automatically-listen-on-tor).* | ||||
HiddenServiceDir /var/lib/tor/bitcoin-service/ | HiddenServiceDir /var/lib/tor/bitcoin-service/ | ||||
HiddenServicePort 8333 127.0.0.1:8333 | HiddenServicePort 8333 127.0.0.1:8333 | ||||
HiddenServicePort 18333 127.0.0.1:18333 | HiddenServicePort 18333 127.0.0.1:18333 | ||||
The directory can be different of course, but (both) port numbers should be equal to | The directory can be different of course, but (both) port numbers should be equal to | ||||
your bitcoind's P2P listen port (8333 by default). | your ecashd's P2P listen port (8333 by default). | ||||
-externalip=X You can tell bitcoin about its publicly reachable address using | -externalip=X You can tell ecash about its publicly reachable address using | ||||
this option, and this can be a .onion address. Given the above | this option, and this can be a .onion address. Given the above | ||||
configuration, you can find your .onion address in | configuration, you can find your .onion address in | ||||
/var/lib/tor/bitcoin-service/hostname. For connections | /var/lib/tor/bitcoin-service/hostname. For connections | ||||
coming from unroutable addresses (such as 127.0.0.1, where the | coming from unroutable addresses (such as 127.0.0.1, where the | ||||
Tor proxy typically runs), .onion addresses are given | Tor proxy typically runs), .onion addresses are given | ||||
preference for your node to advertise itself with. | preference for your node to advertise itself with. | ||||
-listen You'll need to enable listening for incoming connections, as this | -listen You'll need to enable listening for incoming connections, as this | ||||
is off by default behind a proxy. | is off by default behind a proxy. | ||||
-discover When -externalip is specified, no attempt is made to discover local | -discover When -externalip is specified, no attempt is made to discover local | ||||
IPv4 or IPv6 addresses. If you want to run a dual stack, reachable | IPv4 or IPv6 addresses. If you want to run a dual stack, reachable | ||||
from both Tor and IPv4 (or IPv6), you'll need to either pass your | from both Tor and IPv4 (or IPv6), you'll need to either pass your | ||||
other addresses using -externalip, or explicitly enable -discover. | other addresses using -externalip, or explicitly enable -discover. | ||||
Note that both addresses of a dual-stack system may be easily | Note that both addresses of a dual-stack system may be easily | ||||
linkable using traffic analysis. | linkable using traffic analysis. | ||||
In a typical situation, where you're only reachable via Tor, this should suffice: | In a typical situation, where you're only reachable via Tor, this should suffice: | ||||
./bitcoind -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen | ./ecashd -proxy=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -listen | ||||
(obviously, replace the .onion address with your own). It should be noted that you still | (obviously, replace the .onion address with your own). It should be noted that you still | ||||
listen on all devices and another node could establish a clearnet connection, when knowing | listen on all devices and another node could establish a clearnet connection, when knowing | ||||
your address. To mitigate this, additionally bind the address of your Tor proxy: | your address. To mitigate this, additionally bind the address of your Tor proxy: | ||||
./bitcoind ... -bind=127.0.0.1 | ./ecashd ... -bind=127.0.0.1 | ||||
If you don't care too much about hiding your node, and want to be reachable on IPv4 | If you don't care too much about hiding your node, and want to be reachable on IPv4 | ||||
as well, use `discover` instead: | as well, use `discover` instead: | ||||
./bitcoind ... -discover | ./ecashd ... -discover | ||||
and open port 8333 on your firewall (or use -upnp). | and open port 8333 on your firewall (or use -upnp). | ||||
If you only want to use Tor to reach .onion addresses, but not use it as a proxy | If you only want to use Tor to reach .onion addresses, but not use it as a proxy | ||||
for normal IPv4/IPv6 communication, use: | for normal IPv4/IPv6 communication, use: | ||||
./bitcoind -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover | ./ecashd -onion=127.0.0.1:9050 -externalip=57qr3yd1nyntf5k.onion -discover | ||||
## 3. Automatically listen on Tor | ## 3. Automatically listen on Tor | ||||
Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket | Starting with Tor version 0.2.7.1 it is possible, through Tor's control socket | ||||
API, to create and destroy 'ephemeral' hidden services programmatically. | API, to create and destroy 'ephemeral' hidden services programmatically. | ||||
Bitcoin ABC has been updated to make use of this. | Bitcoin ABC has been updated to make use of this. | ||||
This means that if Tor is running (and proper authentication has been configured), | This means that if Tor is running (and proper authentication has been configured), | ||||
Bitcoin ABC automatically creates a hidden service to listen on. This will positively | Bitcoin ABC automatically creates a hidden service to listen on. This will positively | ||||
affect the number of available .onion nodes. | affect the number of available .onion nodes. | ||||
This new feature is enabled by default if Bitcoin ABC is listening (`-listen`), and | This new feature is enabled by default if Bitcoin ABC is listening (`-listen`), and | ||||
requires a Tor connection to work. It can be explicitly disabled with `-listenonion=0` | requires a Tor connection to work. It can be explicitly disabled with `-listenonion=0` | ||||
and, if not disabled, configured using the `-torcontrol` and `-torpassword` settings. | and, if not disabled, configured using the `-torcontrol` and `-torpassword` settings. | ||||
To show verbose debugging information, pass `-debug=tor`. | To show verbose debugging information, pass `-debug=tor`. | ||||
Connecting to Tor's control socket API requires one of two authentication methods to be | Connecting to Tor's control socket API requires one of two authentication methods to be | ||||
configured. It also requires the control socket to be enabled, e.g. put `ControlPort 9051` | configured. It also requires the control socket to be enabled, e.g. put `ControlPort 9051` | ||||
in `torrc` config file. For cookie authentication the user running bitcoind must have read | in `torrc` config file. For cookie authentication the user running ecashd must have read | ||||
access to the `CookieAuthFile` specified in Tor configuration. In some cases this is | access to the `CookieAuthFile` specified in Tor configuration. In some cases this is | ||||
preconfigured and the creation of a hidden service is automatic. If permission problems | preconfigured and the creation of a hidden service is automatic. If permission problems | ||||
are seen with `-debug=tor` they can be resolved by adding both the user running Tor and | are seen with `-debug=tor` they can be resolved by adding both the user running Tor and | ||||
the user running bitcoind to the same group and setting permissions appropriately. On | the user running ecashd to the same group and setting permissions appropriately. On | ||||
Debian-based systems the user running bitcoind can be added to the debian-tor group, | Debian-based systems the user running ecashd can be added to the debian-tor group, | ||||
which has the appropriate permissions. Before starting bitcoind you will need to re-login | which has the appropriate permissions. Before starting ecashd you will need to re-login | ||||
to allow debian-tor group to be applied. Otherwise you will see the following notice: "tor: | to allow debian-tor group to be applied. Otherwise you will see the following notice: "tor: | ||||
Authentication cookie /run/tor/control.authcookie could not be opened (check permissions)" | Authentication cookie /run/tor/control.authcookie could not be opened (check permissions)" | ||||
on debug.log. | on debug.log. | ||||
An alternative authentication method is the use | An alternative authentication method is the use | ||||
of the `-torpassword=password` option. The `password` is the clear text form that | of the `-torpassword=password` option. The `password` is the clear text form that | ||||
was used when generating the hashed password for the `HashedControlPassword` option | was used when generating the hashed password for the `HashedControlPassword` option | ||||
in the tor configuration file. The hashed password can be obtained with the command | in the tor configuration file. The hashed password can be obtained with the command | ||||
Show All 9 Lines |