mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 22:45:27 +01:00
Code Issues Projects Releases Wiki Activity

File improvements

Browse source 
Adapted for the markdown format.
Also developed in the preparation parts and each case of use has been detailed.

A doubt in the non persistent address remain:
In the original document 

> --announce-addr=autotor:<torservice_ip:port> : try to generate an temp V2 onion addr.

 this doesn't seem to work for me (several errors are produced at start up).
instead the `--addr=autotor:127.0.0.1:9051`seems to work well (at least for version 0.6).
This commit is contained in:
gabridome 2018-07-31 19:31:37 +02:00 • committed by Rusty Russell
parent 046a9c1a45
commit a92d7f1490
1 changed files with 253 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

348
doc/TOR.md
View file

@ -1,144 +1,302 @@
HOWTO USE TOR WITH C-LIGHTNING
what do we support
1 c-lightning has a public IP address and no TOR hidden service address,
but can connect to an onion address via a TOR socks 5 proxy.
2 c-lightning has a public IP address and a fixed TOR hidden service address that is persistent
so that external users can connect to this node.
3 c-lightning has a public IP address and not fixed TOR service address that (changes at each restart
and that vanish at restart of tor)
so that external users can connect to this node by TOR and IP
4 c-lightning has no public IP address, but has a fixed TOR hidden service address that is persistent
so that external users can connect to this node.
5 c-lightning has no public IP address, and has no fixed TOR hidden service address
(changes at each restart and vanish at restart of tor) to make it harder to track this node.
6 c-lightning has a public IP address and a fixed TOR V3 service address and a TOR V2 service address
that (changes at each restart and that vanish at restart of tor)
so that external users can connect to this node by TOR V2 and V3 and IP
7 c-lightning has no public IP address and a fixed TOR V3 service address and fixed TOR V2 service address
a 3rd V2 address that (changes at each restart and that vanish at restart of tor)
so that external users can connect to this node by TOR V2 and V3 and a random V2 until next tor release then also (V3 randomly)
8 c-lightning has a public IP address and no TOR hidden service address,
but can connect to any V4/6 ip address via a IPV4/6 socks 5 proxy.
# HOWTO USE TOR WITH C-LIGHTNING
to use tor you have to have tor installed an running.
i.e.
```
sudo apt install tor
/etc/init.d/tor start
```
then `/etc/init.d/tor start` or `sudo systemctl start tor` Depending
on your system configuration.
if new to tor you might not change the default setting
# The safe default with minimal harassment (See tor FAQ)
ExitPolicy reject *:* # no exits allowed
If new to tor you might not change the default setting.
this does not effect c-ln connect listen etc.
it will only prevent that you become a full exitpoint
To keep The safe default with minimal harassment (See [tor FAQ])
just check that this line is present in the file:
`ExitPolicy reject *:* # no exits allowed`
this does not affect c-lightning connect, listen, etc..
It will only prevent that you become a full exitpoint.
Only enable this if you are sure about the implications.
If we don't want to create .onion addresses this should be enough.
if you want an auto service created
edit the torconfig file /etc/tor/torrc
There are several way by which a c-lightning node can accept or make connections over TOR.
set
The node can be reached over TOR by connecting to its .onion address.
To provide the node with a .onion address is possible to:
* create a **non persistent** address with an auto service or
* create a **persistent** address with an hidden service.
#### Creation of an auto service for non persistent .onion addresses
To provide the node a Non Persistent .onion address
is necessary to access the TOR auto service. These types of addresses change
each time the TOR service is restarted.
*NOTE:If the node is required to be reachable only by **persistent** .onion addresses, this
part can be skipped and it is necessary to set up an hidden service with the steps
outlined in the next section.*
To create and use the auto service follow this steps:
Edit the tor config file `/etc/tor/torrc`
You can configure the service authenticated by cookie or by password:
##### Service authenticated by cookie
We add the following lines in the `/etc/tor/torrc` file:
````
ControlPort 9051
CookieAuthentication 1
CookieAuthFileGroupReadable 1
````
or create a password with
##### Service authenticated by password
cmdline
tor --hash-password yourepassword
In alternative to the CookieFile authentication. you can set the authentication
to the service with a password by following theses steps:
this returns an line like
16:533E3963988E038560A8C4EE6BBEE8DB106B38F9C8A7F81FE38D2A3B1F
1. Create an hash of your password with `tor --hash-password yourpassword`.
This returns a line like
put this in the /etc/tor/torrc file
`16:533E3963988E038560A8C4EE6BBEE8DB106B38F9C8A7F81FE38D2A3B1F`
i.e.
2. put these lines in the `/etc/tor/torrc` file:
```
ControlPort 9051
HashedControlPassword 16:533E3963988E038560A8C4EE6BBEE8DB106B38F9C8A7F81FE38D2A3B1F
````
Save the file.
save
and
/etc/init.d/tor restart
To activate these changes:
then you can use c-lightning with following options
`/etc/init.d/tor restart`
--tor-service-password=yourpassword (not the hash) to access the tor service at 9051
The auto service will be used by adding `--addr=autotor:127.0.0.1:9051` to the
`lightningd` command line.
--proxy=127.0.0.1:9050 : set the Tor proxy to use
In the case the auto service is authenticated through the password, it will
be necessary to add the option `--tor-service-password=yourpassword` (not the hash).
or the password for the service if cookiefile is not accessable
The created .onion address wil be shown by the `lightning-cli getinfo`command.
The others nodes will be able to `connect` to the .onion address through the
9735 port.
--announce-addr=autotor:<torservice_ip:port> : try to generate an temp V2 onion addr.
#### Creation of an hidden service for a persistent .onion address
NOTE if --always-use-proxy set all traffic will be rooted over the proxy, or if no non-TOR addresses are announced.
To have a persistent .onion address at which other nodes can connect, it
is necessary to set up a [TOR Hidden Service].
you can also set a fixed announce onion addr by option
--announce-addr=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.onion[:port] (V2 or V3 is allowed)
*NOTE:In the case only non persistent addresses are required,
you don't have to create the hidden service and you can skip this part.*
this addr can be created
in /etc/tor/torrc
To do that we will add these lines in the `/etc/tor/torrc`file:
HiddenServiceDir /var/lib/tor/bitcoin-service_v2/
HiddenServiceVersion 2
````
HiddenServiceDir /var/lib/tor/lightningd-service_v2/
HiddenServicePort 1234 127.0.0.1:9735
and in later v3 enabled tor version's you can use for V3
HiddenServiceDir /var/lib/tor/other_hidden_service_v3/
````
If we want to create a version 3 address, we will add also `HiddenServiceVersion 3` so
the whole section will be:
````
HiddenServiceDir /var/lib/tor/lightningd-service_v3/
HiddenServiceVersion 3
HiddenServicePort 1234 127.0.0.1:9735
````
The hidden lightning service will be reachable at port 1234 (global port)
of the .onion address, which will be created at the restart of the
TOR service.
Of course it is possible create a version 2 AND a version 3 address for the
same node.
Save the file and restart the TOR service. In linux:
`/etc/init.d/tor restart` or `sudo systemctl start tor` depending
on the configuration of your system.
You will find the newly created address with:
`sudo cat /var/lib/tor/var/lib/tor/lightningd-service_v2/hostname` or
`sudo cat /var/lib/tor/var/lib/tor/lightningd-service_v3/hostname` in the
case of a version 3 TOR address.
Now we are able to create:
* Non persistent version 2 .onion address via auto service (NPer.V2)
* Persistent version 2 and version 3 .onion addresseses (Per.V2 e Per.V3).
Let's see how to use them.
### What do we support
| Case # | IP Number | TOR address |
| ------- | ------------- | ------------------------- |
| 1 | Public | NO |
| 2 | Public | Pers.V2 [1] |
| 3 | Public | NPers.v2 [2] |
| 4 | Not Announced | Pers.V2 |
| 5 | Not Announced | NPers.v2 |
| 6 | Public | Pers.V3+NPers.V2 |
| 7 | Not Announced | Pers.V3+Pers.V2+NPers.V2 |
| 8 | Public | NO |
NOTE:
1. Pers.V2: The Version 2 onion address is persistent across TOR service restarts.
It is created when you create the [TOR Hidden Service]
2. NPers.V2: The Version 2 onion address changes at each restart of the TOR service.
A non persistent .onion address is generated by accessing an auto service (see above)
All the .V3 addresses referes to [.onion addresses version 3].
#### Case 1 c-lightning has a public IP address and no TOR hidden service address, but can connect to an onion address via a TOR socks 5 proxy.
Without a .onion address, the node won't be reachable through TOR by other nodes but it will
be able to connect to a TOR enabled node, passing the `connect` request through the TOR service
socks5 proxy. When the TOR service starts it creates a socks5 proxy which is by default at the address
127.0.0.1:9050.
If you launch `lightningd` with the option `--proxy=127.0.0.1:9050` you will be able to
connect to nodes with .onion address through the socks5 proxy.
If you want to `connect` to nodes ONLY via the TOR proxy, you have to add `--always-use-proxy` option.
You can announce your public IP address through the usual method:
`--bind-addr=internalIPAddress:port --announce-addr=externalIpAddress`if the node is into an
internal network
`--addr=externalIpAddress` if the node is not inside an internal network.
TIP: If you are unsure which of the two is suitable for you, find your internal
and external address and see if they match.
In linux:
Discover your external IP address with: `curl ipinfo.io/ip`
and your internal IP Address with: `p route get 1 | awk '{print $NF;exit}'`
If they match you can use the `--addr` command line option.
the addr for
the --announce-addr option
or legacy use
#### Case #2 c-lightning has a public IP address and a fixed TOR hidden service address that is persistent so that external users can connect to this node.
you find after /etc/init.d/tor restart
To have your external IP address and your .onion address announced, you use the
i.e.
in /var/lib/tor/other_hidden_service_v3/hostname
`--bind-addr=yourInternalIPAddress:port --announce-addr=yourexternalIPAddress:port --announce-addr=your.onionAddress:port` option.
to see your onion addr use
cli/lightning-cli getinfo
If you are not inside an internal network you can use `--addr=yourIPAddress:port --announce-addr=your.onionAddress:port`.
the .onion addr has not to be announced to other nodes
but you can with --announce-addr=xxxxxxxxxxxxxxxxxxxxxxx.onion[:port]
your.onionAddress is the one created with the hidden service (see above).
the port is the one indicated as the hidden service port. If the hidden service creation
line is `HiddenServicePort 1234 127.0.0.1:9735` the .onion address will be reachable at
the 1234 port (the global port).
if the < port_global: 127.0.0.1:port_local > in torrc fit with your
lightningd options
It will be possible to connect to this node with:
--bind-addr=xxx.xxx.xxx.xxx:port_local
--addr=xxx.xxx.xxx.xxx:port_local
`lightning-cli connect nodeID .onionAddress globalPort` through TOR
you can use the cli command : connect peerid xxxxxxxxxxxxxxxx.onion port_global
Where .onion address is in the form `xxxxxxxxxxxxxxxxxxxxxxxxxx.onion` Or
some examples:
`lightning-cli connect nodeID publicIPAddress Port` through clearnet.
sudo lightningd/lightningd --network=testnet --bind-addr=127.0.0.1:1234
--proxy=127.0.0.1:9050 --addr=autotor:127.0.0.1:9051 (auto binds 9735 global <--> local 1234)
this will try to generate an V2 auto hidden-service by reading the tor cookie file and
also create an not announced local ip address at port 1234
the .onion addr will show with the cli command getinfo
#### Case #3 c-lightning has a public IP address and a non persisten TOR service address
the node is accessible by connect peerid xxxxxxxxxxxxxxxx.onion 9735
or local by connect peerID 127.0.0.1 1234
In this case other nodes can connect to you via Clearnet or TOR.
lightningd/lightningd --network=testnet --bind-addr=127.0.0.1
--proxy=127.0.0.1:9050 --announce-addr=xxxxxxxxxxxxxxxxxxxxxxxxxxxx.onion:1234
To announce your IP address to the network, you add:
this will use the hidden-service V2 or V3 set by /etc/tor/torrc and use the hidden service
so the node is accessable by connect peerID xxxxxxxxxxxxxxxxxxxxxxxx.onion 1234
`--bind-addr=internalAddress:port --announce-addr=yourExternalIPAddress`
or `--addr=yourExternalIPAddress`if you are NOT on an internal network.
for connects to a tor enabled node you can use
i.e cli/lightning-cli connect peerID xxxxxxxxxxxxxxxxxxxxxxx.onion 1234
To get your non persistent TOR address you add `--addr=autotor:127.0.0.1:9051`
If the auto service is protected by password it is necessary to specify it with the option
`--tor-service-password=yourpassword` (not the hash).
You will obtain the generated non persisten .onion address by reading the results of the
`lightning-cli getinfo` command. Other nodes will be able to connect to the
.onion address through the 9735 port.
#### Case #4 c-lightning has no public IP address, but has a fixed TOR hidden service address that is persistent
Other nodes can connect to the announced .onion address created with the
hidden service (see above).
In this case In the `lightningd` command line you will specify:
`--bind-addr=yourInternalIPAddress:port --announce-addr=your.onionAddress:port`
or `--addr=your.onionAddress:port` if you are NOT on an internal network.
#### Case #5 c-lightning has no public IP address, and has no fixed TOR hidden service address
In this case it is difficult to track the node.
You specify just:
`--bind-addr=yourInternalIPAddress:port --bind-addr=autotor:127.0.0.1:9051`
In the `lightningd` command line.
Other nodes will not be able to `connect` to you unless you communicate them how to reach you.
You will find your .onion address with the command `lightning-cli getinfo` and the other nodes will
be able to connect to it through the 9735 port.
#### Case #6 c-lightning has a public IP address and a fixed TOR V3 service address and a TOR V2 service address
You will be reachable via Clearnet, via TOR to the .onion V3 address and the .onion V2 address if this
last is communicated to the node that wants to connect with our node.
Once the .onion addresses have been created with the procedures oulined above,
to make your external IP address public you add: `--bind-addr=yourInternalAddress:port --announce-addr=yourexternalIPAddress:port`
To make your external .onion addresses public you add: `--bind-addr=yourInternalIPAddress:port --announce-addr=yourexternalIPAddress:port --announce-addr=.onionAddressV2:port --announce-addr=.onionAddressV3:port`
#### Case #7 c-lightning has no public IP address and a fixed TOR V3 service address and fixed TOR V2 service address a 3rd non persisten V2 address
External users can connect to this node by TOR V2 and V3 and a random V2 until next tor release, then also (V3 randomly).
The Persistent addresses can be created with the steps outlined above.
You are not obliged to announce the non persistent V2 address but if want to do it:
`--addr=autotor:<torservice_ip:port>`
and also you must specify `--tor-service-password=yourpassword` (not the hash) to access the
tor service at 9051 If you have protected them with the password (no additional options if
they are protected with a cookie file. See above.).
To make your external .onion address (V2 and V3) public you add: `--bind-addr=yourInternalIPAddress:port --announce-addr=your.onionAddressV2:port --announce-addr=your.onionAddressV3:port`
NOTE: if you want both of them public you can repeat the --announce-addr option. If your node is NOT inside an internal network you can use `--addr=external` instead.
#### Case #8 c-lightning has a public IP address and no TOR hidden service address,
The external address is communicated by the `--announce-addr=yourexternalIPAddress:port`
but can connect to any V4/6 ip address via a IPV4/6 socks 5 proxy by specifing
`--proxy=127.0.0.1:9050 --always-use-proxy`.
References
[tor FAQ]: https://www.torproject.org/docs/faq.html.en#WhatIsTor
[TOR Hidden Service]: https://www.torproject.org/docs/onion-services.html.en
[.onion addresses version 3]: https://blog.torproject.org/we-want-you-test-next-gen-onion-services