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

[sbws/master] Clarify which section must be edited
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit abee1767b8dbcebad4edb108baae775676f8bf5f Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:54:31 2018 +0000 Clarify which section must be edited --- docs/source/man_sbws.ini.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index 01257ef..1df9639 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -6,6 +6,13 @@ DESCRIPTION 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. + + SECTIONS ---------

1 0

[sbws/master] Clarify the url format
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 7b14f473bbdc68be23d0b4753c5d86a9af3e1722 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:54:56 2018 +0000 Clarify the url format --- docs/source/man_sbws.ini.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index 1df9639..c96ec90 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -61,7 +61,8 @@ destinations destinations.STR url = STR - The url to the destination + The URL to the destination. It must include a file path. + It can use both http or https. tor datadir = STR

1 0

[sbws/master] Fix mistaken .[doc] by .[test]
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 012781f8811c46a224cb1a569aabd250f9609fa8 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:59:38 2018 +0000 Fix mistaken .[doc] by .[test] --- INSTALL.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.rst b/INSTALL.rst index 7ab7558..73d960f 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -60,7 +60,7 @@ To run the tests, extra Python depenencies are needed: To install them from ``sbws`` :: - pip install .[dev] && pip install .[doc] + pip install .[dev] && pip install .[test] To run the tests::

1 0

[sbws/master] Add valid destinations examples
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 36cf669bb5298fae499945514a676bdb8f2aa7e7 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:55:16 2018 +0000 Add valid destinations examples --- docs/source/man_sbws.ini.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/man_sbws.ini.rst b/docs/source/man_sbws.ini.rst index c96ec90..b63106b 100644 --- a/docs/source/man_sbws.ini.rst +++ b/docs/source/man_sbws.ini.rst @@ -155,6 +155,28 @@ logging Format string to use when logging to syslog. (Default: %(module)s[%(process)s]: <%(levelname)s> %(message)s) +EXAMPLES +-------- + +Example ``destinations`` section:: + + [destinations] + foo = on + bar = on + baz = off + + [destinations.foo] + # using HTTP + url = http://example.org/sbws.bin + + [destinations.bar] + # using HTTPS + url = https://example.com/data + + [destinations.baz] + # this will be ignored + url = https://example.net/ask/stan/where/the/file/is.exe + FILES -----

1 0

[sbws/master] Fix syntax
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit f0cae0f82301345eb31dd9c71acfcef61e82eacc Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 08:01:52 2018 +0000 Fix syntax --- INSTALL.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.rst b/INSTALL.rst index 67540b0..85c70b9 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -96,7 +96,7 @@ To build the documentation diagrams:: cd docs/ && make umlsvg -The generated diagrams will be in `docs/build/images/`. +The generated diagrams will be in ``docs/build/images/``. .. _virtualenv: https://virtualenv.pypa.io/en/stable/installation/ .. _Stem: https://stem.torproject.org/

1 0

[sbws/master] Remove what is now explained in man sbws.ini
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 99f516b02a6298b6e7b19ec5c741c2b0706d5931 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 07:56:16 2018 +0000 Remove what is now explained in man sbws.ini --- DEPLOY.rst | 28 ---------------------------- 1 file changed, 28 deletions(-) diff --git a/DEPLOY.rst b/DEPLOY.rst index 7a20fae..1e56924 100644 --- a/DEPLOY.rst +++ b/DEPLOY.rst @@ -32,31 +32,3 @@ They are not included by default. To configure destinations, create a configuration file according to :doc:`man_sbws.ini` - -It is not required, but it is recomended to include a custom scanner -``nickname`` in the configuration file`. - -Destination(s) configuration in more detail:: - - [destinations] - foo = on - bar = on - baz = off - - [destinations.foo] - url = http://example.org/sbws.bin - - [destinations.bar] - url = https://example.com/data - - [destinations.baz] - url = https://example.net/ask/stan/where/the/file/is.exe - -``foo`` demonstrates a typical case. - -``bar`` demonstrates a case where you want to use HTTPS and want to assume the -large file for sbws to download is at its default path (probably -``/sbws.bin``). - -``baz`` demonstrates a disabled destination that sbws will ignore. -

1 0

[sbws/master] sbws.ini.5 is not automatically build nor installed
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 48715b7ca361d7e731a08539e24ad97f94d4c47c Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 08:19:21 2018 +0000 sbws.ini.5 is not automatically build nor installed when installing sbws from git. When there will be a system package, it should be added the possibility to use man sbws.ini --- sbws/lib/destination.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sbws/lib/destination.py b/sbws/lib/destination.py index 86d76c7..a8087e2 100644 --- a/sbws/lib/destination.py +++ b/sbws/lib/destination.py @@ -235,7 +235,8 @@ class DestinationList: conf.getint('scanner', 'max_download_size'))) if len(dests) < 1: msg = 'No enabled destinations in config. Please see '\ - '"man sbws.ini" for help adding and enabling destinations' + '"docs/source/man_sbws.ini.rst" for help adding and '\ + 'enabling destinations' return None, msg return DestinationList(conf, dests, circuit_builder, relay_list, controller), ''

1 0

[sbws/master] Correct path
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 66e2bca8d70d84bdec68f3271a000995b9a99294 Author: juga0 <juga(a)riseup.net> Date: Wed Aug 29 08:02:05 2018 +0000 Correct path --- INSTALL.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.rst b/INSTALL.rst index 85c70b9..eb9773f 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -96,7 +96,7 @@ To build the documentation diagrams:: cd docs/ && make umlsvg -The generated diagrams will be in ``docs/build/images/``. +The generated diagrams will be in ``docs/build/_images/``. .. _virtualenv: https://virtualenv.pypa.io/en/stable/installation/ .. _Stem: https://stem.torproject.org/

1 0

[sbws/master] Warn when exception might be caused by no disk space
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 66189d6ffed40bac6b7e2e6d111ec68925d71af0 Author: juga0 <juga(a)riseup.net> Date: Thu Jul 12 21:32:32 2018 +0000 Warn when exception might be caused by no disk space --- sbws/lib/circuitbuilder.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sbws/lib/circuitbuilder.py b/sbws/lib/circuitbuilder.py index e3b3950..66687b0 100644 --- a/sbws/lib/circuitbuilder.py +++ b/sbws/lib/circuitbuilder.py @@ -65,7 +65,9 @@ class CircuitBuilder: pass self.built_circuits.discard(circ_id) except (ControllerError, ValueError) as e: - log.exception("Error trying to get circuit to close it: %s.", e) + log.warning("Error trying to get circuit to close it: %s.", e, + "If sbws didn't receive SIGHUP, " + "maybe this system run out of disk space.") def _build_circuit_impl(self, path): if not valid_circuit_length(path):

1 0

[sbws/master] Check disk space before running scanner
by pastly＠torproject.org 06 Sep '18

06 Sep '18

commit 1054eea6150331b1215e6871c0b04020b4ba0331 Author: juga0 <juga(a)riseup.net> Date: Sun Jul 15 20:36:42 2018 +0000 Check disk space before running scanner --- sbws/core/generate.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sbws/core/generate.py b/sbws/core/generate.py index f10ecc1..3c19ed4 100644 --- a/sbws/core/generate.py +++ b/sbws/core/generate.py @@ -5,6 +5,7 @@ from argparse import ArgumentDefaultsHelpFormatter import os import logging from sbws.util.timestamp import now_fname +from ..util.fs import is_low_space log = logging.getLogger(__name__) @@ -40,6 +41,8 @@ def gen_parser(sub): def main(args, conf): os.makedirs(conf.getpath('paths', 'v3bw_dname'), exist_ok=True) + if is_low_space(conf): + exit(1) datadir = conf.getpath('paths', 'datadir') if not os.path.isdir(datadir):

1 0