November 2018 - tor-commits - lists.torproject.org

[sbws/master] Change runtime directory when running supervised
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit ffb625ed2d3c9247ee26df107fe84b7d6c61a230 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 19:44:41 2018 +0000 Change runtime directory when running supervised Also go back to use sbws datadir as the default location for the tor temporal file sockets, because when XDG_RUNTIME_DIR is not set, the interpolation does not happen. --- sbws/config.default.ini | 3 +-- sbws/globals.py | 2 ++ sbws/util/config.py | 12 +++++++++++- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/sbws/config.default.ini b/sbws/config.default.ini index 93b3505..8abee3d 100644 --- a/sbws/config.default.ini +++ b/sbws/config.default.ini @@ -58,8 +58,7 @@ max_download_size = 1073741824 [tor] datadir = ${paths:sbws_home}/tor -# create runtime dir for data that does not need to be persistent -run_dpath = $$XDG_RUNTIME_DIR/sbws +run_dpath = ${datadir} control_socket = ${tor:run_dpath}/control pid = ${tor:run_dpath}/tor.pid # note this is a directory diff --git a/sbws/globals.py b/sbws/globals.py index 66effd5..5dd644e 100644 --- a/sbws/globals.py +++ b/sbws/globals.py @@ -28,6 +28,8 @@ DEFAULT_CONFIG_PATH = os.path.join(PKG_DIR, 'config.default.ini') DEFAULT_LOG_CONFIG_PATH = os.path.join(PKG_DIR, 'config.log.default.ini') USER_CONFIG_PATH = os.path.join(os.path.expanduser('~'), '.sbws.ini') +SUPERVISED_RUN_DPATH = "/run/sbws/tor" + SOCKET_TIMEOUT = 60 # seconds SBWS_SCALE_CONSTANT = 7500 diff --git a/sbws/util/config.py b/sbws/util/config.py index 8ba5aac..2f6fa51 100644 --- a/sbws/util/config.py +++ b/sbws/util/config.py @@ -9,7 +9,7 @@ from urllib.parse import urlparse from string import Template from tempfile import NamedTemporaryFile from sbws.globals import (DEFAULT_CONFIG_PATH, DEFAULT_LOG_CONFIG_PATH, - USER_CONFIG_PATH, fail_hard) + USER_CONFIG_PATH, SUPERVISED_RUN_DPATH, fail_hard) _ALPHANUM = 'abcdefghijklmnopqrstuvwxyz' _ALPHANUM += _ALPHANUM.upper() @@ -217,6 +217,15 @@ def _validate_general(conf): return errors +def _obtain_run_dpath(conf): + """Set runtime directory when sbws is run by a system service.""" + xdg = os.environ.get('XDG_RUNTIME_DIR') + if os.environ.get('SUPERVISED') == "1": + conf['tor']['run_dpath'] = SUPERVISED_RUN_DPATH + elif xdg is not None: + conf['tor']['run_dpath'] = os.path.join(xdg, 'sbws', 'tor') + + def _validate_paths(conf): errors = [] sec = 'paths' @@ -262,6 +271,7 @@ def _validate_scanner(conf): def _validate_tor(conf): + _obtain_run_dpath(conf) errors = [] sec = 'tor' err_tmpl = Template('$sec/$key ($val): $e')

1 0

[sbws/master] Add note about required configuration file
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit 8e44fae87e4900f128e0c065c7a30cea7e15ee33 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 20:25:31 2018 +0000 Add note about required configuration file --- docs/source/man_sbws.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index d428f74..20e7b2a 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -16,6 +16,9 @@ DESCRIPTION Tor bandwidth scanner that generates bandwidth measurements files to be read by the Directory Authorities. +The **scanner** requires a configuration file (see **sbws.ini** (5)) with a +with a '[destinations]' section. + OPTIONS -------

1 0

[sbws/master] Remove default locations in examples
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit bc763838dff19d8244389cdf2e6f572563ee67f6 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 20:38:17 2018 +0000 Remove default locations in examples --- docs/source/man_sbws.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 6835fd4..eaa99eb 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -49,22 +49,22 @@ Optional arguments Override the sbws log level (default: info). -c CONFIG, --config CONFIG - Path to the sbws configuration file (default: $HOME/.sbws.ini) + Path to a custom configuration file. EXAMPLES -------- sbws scanner - Run the scanner using the configuration file in ~/.sbws.ini + Run the scanner using **sbws** defaults. sbws -c ~/.sbwsrc scanner - Run the scanner using the configuration file in ~/.sbwsrc + Run the scanner using the configuration file in `~/.sbwsrc` sbws --log-level debug generate - Generate v3bw file in the default v3bw directory (~/.sbws/v3bw) + Generate v3bw file in the default v3bw directory. sbws cleanup - Cleanup datadir and v3bw files older than XX in the default v3bw directory (~/.sbws/) + Cleanup datadir and v3bw files older than XX in the default v3bw directory. FILES -----

1 0

[sbws/master] Add tor man to SEE ALSO
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit 72c0fc70a9e32f6558b6654b957b021d2c3726e2 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 21:20:41 2018 +0000 Add tor man to SEE ALSO --- docs/source/man_sbws.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 3303189..c9411e4 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -108,7 +108,8 @@ SEE ALSO --------- **sbws.ini** (5), https://sbws.readthedocs.org, -https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-spec.txt. +https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-spec.txt, +**tor** (1). BUGS ----

1 0

[sbws/master] Fix syntax and default value
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit 2c06a32a68b429fceec7e71deb5e52a2f7c1b4d7 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 20:32:08 2018 +0000 Fix syntax and default value --- docs/source/man_sbws.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 13e7a3e..6835fd4 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -43,10 +43,10 @@ Optional arguments Show help message and exit. --version - sbws version + Show **sbws** version and exit. --log-level {debug,info,warning,error,critical} - Override the sbws log level (default: None) + Override the sbws log level (default: info). -c CONFIG, --config CONFIG Path to the sbws configuration file (default: $HOME/.sbws.ini)

1 0

[sbws/master] Add new lines
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit c7f7a84e782d5ad86a4ac080c1bde7e18c026473 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 21:21:34 2018 +0000 Add new lines --- docs/source/man_sbws.ini.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index b63106b..1403024 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -8,7 +8,9 @@ Tor bandwidth scanner configuration file. **sbws** (1) ``scanner`` command requires a configuration file with a "[destinations]" section. + It is the only section that does not have a default value. + It is recommended, but not required to configure "nickname" in the "[scanner]" section.

1 0

[sbws/master] Add where to find the default file locations
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit bc9c529b44aadb2f947c92bfa2025e3a134ccc24 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 20:31:17 2018 +0000 Add where to find the default file locations --- docs/source/man_sbws.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 20e7b2a..13e7a3e 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -19,6 +19,12 @@ the Directory Authorities. The **scanner** requires a configuration file (see **sbws.ini** (5)) with a with a '[destinations]' section. +**sbws** can be run a python script or a system service. +The later is recommended. +The default locations of the files that **sbws** reads or generate depend on +on how it is run. +See the section **FILES** to know which are the default locations. + OPTIONS -------

1 0

[sbws/master] Add locations when running sbws as a system service
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit 1c95755ea86c7e4ddb95d3336de7b6a3521e4321 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 21:27:50 2018 +0000 Add locations when running sbws as a system service --- docs/source/man_sbws.ini.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index 1403024..0ea98b5 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -34,6 +34,10 @@ general NOT implemented for IPv6. paths + + When **sbws** is run as a system service, `~/.sbws` is changed to + `/var/lib/sbws`. + sbws_home = STR sbws home directory. (Default: ~/.sbws) datadir = STR @@ -67,13 +71,17 @@ destinations.STR It can use both http or https. tor + + When **sbws** is run as a system service `~/.sbws/tor` is replaced by + `/run/sbws/tor`. + datadir = STR sbws' owned tor directory. (Default: ~/.sbws/tor) control_socket = STR sbws's owned tor control socket file. - (Default: $XDG_RUNTIME_DIR/sbws/control) + (Default: ~/.sbws/tor/sbws/control) pid = STR - sbws's owned tor pid file. (Default: $XDG_RUNTIME_DIR/sbws/tor.pid) + sbws's owned tor pid file. (Default: ~/.sbws/tor/sbws/tor.pid) log = STR sbws's owned tor directory log files. (Default: ~/.sbws/tor/log) extra_lines =

1 0

[sbws/master] Add system default location in FILES
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit 096d0ec7671a7c2434dd5a5365d2f68b53766e54 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 21:18:17 2018 +0000 Add system default location in FILES And rephrase existing paragraphs. --- docs/source/man_sbws.rst | 47 +++++++++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 20 deletions(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index eaa99eb..78578bd 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -69,32 +69,39 @@ sbws cleanup FILES ----- -$HOME/.sbws.ini - Default location for the sbws user configuration file. +In the following list, the first path is the default location when running +**sbws** as an script, the second path is the default location when running +**sbws** as a system service. -$HOME/.sbws - Default sbws home, where it stores measurement data files, - bandwidth list files and tor process data. +**$HOME/.sbws.ini** or **/etc/sbws/sbws.ini** + Location where **sbws** searchs for a custom configuration file, when the + option **--config** is not provided. -$HOME/.sbws/datadir - Default location for the raw results generated by the ``sbws scanner``. - Other commands (such as ``generate`` and ``stats``) read results from the - files in this directory. +**$HOME/.sbws** or **/var/lib/sbws** + Location where **sbws** writes/reads measurement data files, + bandwidth list files and **tor** process data. -$HOME/.sbws/log - Default location for the logs files generated by all ``sbws`` commands, - when logging to a file is configured (see **sbws.ini**). + Under this directory, **sbws** creates the following subdirectories: -$HOME/.sbws/v3bw - Default location for the bandwidth files generated by the command - ``sbws generate``. These are the files read by the Tor directory - authorities. + datadir + Raw results generated by the ``sbws scanner``. + Other commands (such as ``generate`` and ``stats``) read results from + this directory. -$HOME/.sbws/state.dat - A file for storing state needed between ``sbws`` commands. + log + Log files generated by ``sbws``, when logging to a file is configured + (see **sbws.ini**). -$XDG_RUNTIME_DIR/sbws - Runtime directory for the tor process launched by ``sbws scanner``. + v3bw + Bandwidth files generated by ``sbws generate``. These are the files + read by the Tor directory authorities. + + tor + Data generated by the **tor** process launched by **sbws**. + +**$HOME/.sbws/tor** or **/run/sbws/tor** + Location where the **tor** process launched by ``sbws scanner`` stores + temporal files, like Unix domain sockets. SEE ALSO ---------

1 0

[sbws/master] Add entry about default directories
by juga＠torproject.org 01 Nov '18

01 Nov '18

commit c78d8638f6d0fb05766109b66a76911a362e6be0 Author: juga0 <juga(a)riseup.net> Date: Wed Oct 31 21:46:44 2018 +0000 Add entry about default directories --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e83678b..802aeb1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +### Changed + +- Change default directories when sbws is run from a system service (#28268). + ## [1.0.0] - 2018-10-29 **Important changes**:

1 0