lnd.xprv/tor/README.md

tor
===

The tor package contains utility functions that allow for interacting with the
Tor daemon. So far, supported functions include:

* Routing all traffic over Tor's exposed SOCKS5 proxy.
* Routing DNS queries over Tor (A, AAAA, SRV).
* Limited Tor Control functionality (synchronous messages only). So far, this
includes:
  * Support for SAFECOOKIE authentication only as a sane default.
  * Creating v2 onion services.

In the future, the Tor Control functionality will be extended to support v3
onion services, asynchronous messages, etc.

## Installation and Updating

```bash
$ go get -u github.com/lightningnetwork/lnd/tor
```
tor: streamline package to better follow the Effective Go guidelines In this commit, we clean up the tor package to better follow the Effective Go guidelines. Most of the changes revolve around naming, where we'd have things like `torsvc.TorDial`. This was simplified to `tor.Dial` along with many others. 2018-04-25 19:00:50 +03:00			`tor`
			`===`

			`The tor package contains utility functions that allow for interacting with the`
tor: add inital tor controller implementation In this commit, we add our inital implementation of a Tor Controller. This commit includes the ability for the controller to automatically signal the Tor daemon to create a v2 onion service. This will be expanded later on to support creating v3 onion services. Before allowing the controller to interact with the Tor daemon, the connection must be authenticated first. This commit includes support for the SAFECOOKIE authentication method as a sane default. Co-Authored-By: Eugene <crypt-iq@users.noreply.github.com> 2018-04-26 09:44:12 +03:00			`Tor daemon. So far, supported functions include:`

			`* Routing all traffic over Tor's exposed SOCKS5 proxy.`
			`* Routing DNS queries over Tor (A, AAAA, SRV).`
			`* Limited Tor Control functionality (synchronous messages only). So far, this`
			`includes:`
			`* Support for SAFECOOKIE authentication only as a sane default.`
			`* Creating v2 onion services.`

			`In the future, the Tor Control functionality will be extended to support v3`
			`onion services, asynchronous messages, etc.`
tor: streamline package to better follow the Effective Go guidelines In this commit, we clean up the tor package to better follow the Effective Go guidelines. Most of the changes revolve around naming, where we'd have things like `torsvc.TorDial`. This was simplified to `tor.Dial` along with many others. 2018-04-25 19:00:50 +03:00
			`## Installation and Updating`

			```bash
			`$ go get -u github.com/lightningnetwork/lnd/tor`
			```