commit 1a1a97faef6f554c32a3d948346094a875d3704a Author: juga0 juga@riseup.net Date: Tue Feb 12 10:24:23 2019 +0000
docs: Update internal Tor configuration
and change titles. --- docs/source/config_tor.rst | 41 ++++++++++++++++++++++++++++++----------- 1 file changed, 30 insertions(+), 11 deletions(-)
diff --git a/docs/source/config_tor.rst b/docs/source/config_tor.rst index 1ddde81..175a9ff 100644 --- a/docs/source/config_tor.rst +++ b/docs/source/config_tor.rst @@ -1,18 +1,37 @@ .. _config_tor:
-sbws scanner tor configuration -------------------------------- +Internal Tor configuration for the scanner +------------------------------------------
-At the time of writing, sbws sets the following torrc options for the following -reasons when it launches Tor. You can find them in ``sbws/globals.py`` and -``sbws/util/stem.py``. +The scanner needs an specific Tor configuration. +The following options are either set when launching Tor or required when +connection to an existing Tor daemon. + +Default configuration:
- ``SocksPort auto``: To proxy requests over Tor. - ``CookieAuthentication 1``: The easiest way to authenticate to Tor. -- ``LearnCircuitBuildTimeout 0``: To keep circuit build timeouts static. -- ``CircuitBuildTimeout 10``: To give up on struggling circuits sooner. - ``UseEntryGuards 0``: To avoid path bias warnings. -- ``DataDirectory ...``: To set Tor's datadirectory to be inside sbws's. -- ``PidFile ...``: To make it easier to tell if Tor is running. -- ``ControlSocket ...``: To control Tor. -- ``Log notice ...``: To know what the heck is going on. +- ``UseMicrodescriptors 0``: Because full server descriptors are needed. +- ``SafeLogging 0``: Useful for logging, since there's no need for anonymity. +- ``LogTimeGranularity 1`` +- ``ProtocolWarnings 1`` +- ``LearnCircuitBuildTimeout 0``: To keep circuit build timeouts static. + +Configuration that depends on the user configuration file: + +- ``CircuitBuildTimeout ...``: The timeout trying to build a circuit. +- ``DataDirectory ...``: The Tor data directory path. +- ``PidFile ...``: The Tor PID file path. +- ``ControlSocket ...``: The Tor control socket path. +- ``Log notice ...``: The Tor log level and path. + +Configuration that needs to be set on runtime: + +- ``__DisablePredictedCircuits 1``: To build custom circuits. +- ``__LeaveStreamsUnattached 1`` + +Currently most of the code that sets this configuration is in :func:`sbws.util.stem.launch_tor` +and the default configuration is ``sbws/globals.py``. + +.. note:: the location of these code is being refactored. \ No newline at end of file