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

[sbws/master] Add page about tor config, removed from specification
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit ab62732b99db9efaa0ff8cb2d424317cf40df6c3 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 17:53:58 2018 +0000 Add page about tor config, removed from specification --- docs/source/config_tor.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/source/config_tor.rst b/docs/source/config_tor.rst new file mode 100644 index 0000000..1ddde81 --- /dev/null +++ b/docs/source/config_tor.rst @@ -0,0 +1,18 @@ +.. _config_tor: + +sbws scanner tor configuration +------------------------------- + +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``. + +- ``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.

1 0

[sbws/master] Add dev dependency to check unused code
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit f81b0e0aaaa22bce22fd11e668991f8cc9840a72 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 15:19:14 2018 +0000 Add dev dependency to check unused code remove included script that does that --- scripts/maint/find-dead-funcs | 81 ------------------------------------------- setup.py | 3 +- 2 files changed, 2 insertions(+), 82 deletions(-) diff --git a/scripts/maint/find-dead-funcs b/scripts/maint/find-dead-funcs deleted file mode 100755 index aa81d68..0000000 --- a/scripts/maint/find-dead-funcs +++ /dev/null @@ -1,81 +0,0 @@ -#!/usr/bin/env bash - -SOURCE_DIR=sbws -TESTS_DIR=tests - -UNUSED_LOG=unused-funcs.txt -USED_LOG=used-funcs.txt - -cat > $USED_LOG <<EOF -# This file was generated by a script on $(date). -# It is not going to be perfectly accurate. -# For example, it thinks that all @property are functions that are never called. -EOF -cp $USED_LOG $UNUSED_LOG - -function get_all_funcs { - # Finds all unique function names in $SOURCE_DIR. - # Both of the following functions 'foo' and 'bar' will be found and - # returned - # def foo(a, b='c'): - # pass - # class Something: - # def bar(self): - # pass - find "$SOURCE_DIR" -type f -name '*.py' | - xargs grep --only-matching -E 'def [A-Za-z0-9_]+\(' | - cut -d ' ' -f 2 | - cut -d '(' -f 1 | - sort -u -} - -function conditionally_print_usage_info { - # Expects a FUNC name as the only argument. - # Expects a stream of FILENAME:COUNT pairs on stdin. - # - # If a FILENAME has FUNC in it one time or less, it assumes it is unused - # and does nothing. - # - # If a FILENAME has FUNC in it more than once, then it prints FILENAME and - # goes on to print the exact lines that have the function on them. - FUNC="$1" - while read ITEM - do - FILENAME="$(echo "$ITEM" | cut -d ':' -f 1)" - COUNT="$(echo "$ITEM" | cut -d ':' -f 2)" - (( "$COUNT" <= 1 )) && continue - printf " %s\n" $ITEM - grep --line-number -E "${FUNC}\(" "$FILENAME" | - while read USAGE - do - printf " %s\n" "$USAGE" - done - done -} - -function get_func_usage_count { - # Expects a stream of function names on stdin. - # - # Finds out whether or not a function is **probably** used or not by - # calling conditionally_print_usage_info and capturing its output. If there - # is no output, then the function is assumed to be unused and put into the - # UNUSED_LOG. Otherwise put its info in the USED_LOG. - PY_FILES=( $(find "$SOURCE_DIR" "$TESTS_DIR" -type f -name '*.py') ) - while read FUNC - do - USAGE_INFO="$(grep --count -E "${FUNC}\(" "${PY_FILES[@]}" | - conditionally_print_usage_info ${FUNC})" - if [[ "$USAGE_INFO" == "" ]] - then - echo "$FUNC" >> $UNUSED_LOG - else - echo "$FUNC" >> $USED_LOG - echo "$USAGE_INFO" >> $USED_LOG - fi - done -} - -echo "Writing unused function names to $UNUSED_LOG" -echo "Writing used function names and information to $USED_LOG" - -get_all_funcs | get_func_usage_count diff --git a/setup.py b/setup.py index 9db8731..d704d92 100755 --- a/setup.py +++ b/setup.py @@ -81,7 +81,8 @@ setup( "git+https://git.torproject.org/stem.git#egg=stem-1.6.0.dev0", ], extras_require={ - 'dev': ['flake8'], + # vulture: find unused code + 'dev': ['flake8', 'vulture'], 'test': ['tox', 'pytest', 'coverage'], # recommonmark: to make sphinx render markdown 'doc': ['sphinx', 'recommonmark', 'pylint'],

1 0

[sbws/master] Add editorconfig file and note in contributing
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit ecc69751086250fa93cf6d8312c90271245aa7f1 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 18:05:43 2018 +0000 Add editorconfig file and note in contributing --- .editorconfig | 27 +++++++++++++++++++++++++++ CONTRIBUTING.rst | 3 +++ 2 files changed, 30 insertions(+) diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..696cda3 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,27 @@ +# this should work for all editors that support .editorconfig! +# +# on debian, emacs users should install elpa-editorconfig and vim +# users should install vim-editorconfig. + +root = true + +[*] +indent_style = space +# this remove EOF new line with some editors +# insert_final_newline = true +trim_trailing_whitespace = true +end_of_line = lf +charset = utf-8 +max_line_length = 79 + +[*.py] +indent_size = 4 + +[Makefile] +indent_style = tab + +[*.ini] +indent_size = 4 + +[*.yml] +indent_size = 2 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 186169b..aeeadad 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -98,6 +98,9 @@ External link: `Documentation <https://docs.python-guide.org/writing/documentati New features should add a corresponding documentation in /docs. +An editor compatible with `EditorConfig <https://editorconfig.org/>`_ will +help you to follow the general formatting code style. + Timestamps must be in UTC. It is prefered to use ``datetime`` objects or Unix timestamps. Timestamps read by the user should be always formatted in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_

1 0

[sbws/master] Fix underline title too short
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 0e6aa33cf3bf81ed1983a4ed0d2c14f574e7f914 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 25 09:08:47 2018 +0000 Fix underline title too short --- docs/source/sbws.util.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/sbws.util.rst b/docs/source/sbws.util.rst index a1b3840..30ac43d 100644 --- a/docs/source/sbws.util.rst +++ b/docs/source/sbws.util.rst @@ -29,7 +29,7 @@ sbws.util.parser module :show-inheritance: sbws.util.state module -~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: sbws.util.state :members:

1 0

[sbws/master] Add entry in changelog about doc cleanup
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit cd9ac1881c8893524e5ec85d55331fa56568f653 Author: juga0 <juga(a)riseup.net> Date: Tue Sep 18 19:46:56 2018 +0000 Add entry in changelog about doc cleanup --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c991d1a..933b311 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,6 +41,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - refactor v3bwfile (#27386): move scaling method inside class - use custom ``install_command`` to test installation commands while ``dependency_links`` is needed until #26914 is fixed. (#27704) +- documentation cleanup (#27773) + - split, merge, simplify, extend, reorganize sections and files ## [0.7.0] - 2018-08-09

1 0

[sbws/master] Add warning: who should run sbws
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit eba04c39bc7bce3cf46d940ef348c1595ae6a603 Author: juga0 <juga(a)riseup.net> Date: Sat Sep 8 14:20:38 2018 +0000 Add warning: who should run sbws --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6febd3a..1d42bee 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,13 @@ `simple-bw-scanner` (also called `sbws`) is a Tor bandwidth scanner that produces bandwidth measurements files to be used by Directory Authorities. -It doesn't get simpler than this, folks. - The scanner builds two hop circuits consisting of the relay being measured and -a fast exit. Over these circuits it measures RTT and download performance. +a fast exit. Over these circuits it measures RTT and bandwidth. + +**WARNING**: This software is *only* intended to be run by Tor directory +authorities or researches using a test Tor network, chutney or shadow. +Please, do not run this software otherwise, since the measurements would not be +used by Tor and would only create more traffic in the Tor network. See INSTALL for install instructions. See DEPLOY for deploy instructions. See LICENSE for license information. See CONTRIBUTING for coding standards and

1 0

[sbws/master] Use link syntax that can be clicked when online
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 972f1a11a8788a21925b8d8d1151a190457b7a46 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 16:27:09 2018 +0000 Use link syntax that can be clicked when online --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1d42bee..7ef7eaa 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ authorities or researches using a test Tor network, chutney or shadow. Please, do not run this software otherwise, since the measurements would not be used by Tor and would only create more traffic in the Tor network. -See INSTALL for install instructions. See DEPLOY for deploy instructions. See -LICENSE for license information. See CONTRIBUTING for coding standards and -contribution guidelines. +See ./INSTALL.rst) for install instructions, +[./DEPLOY.rst](./DEPLOY.rst) for deploy instructions, +[./CONTRIBUTING](./CONTRIBUTING.rst) for contribution guidelines. The sbws documentation can be found at [Read the Docs](https://sbws.readthedocs.io) and

1 0

[sbws/master] Remove section about config.ini
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit b3d0e1c9490726a4fb6739215e2f6a4528036090 Author: juga0 <juga(a)riseup.net> Date: Sat Sep 8 14:12:21 2018 +0000 Remove section about config.ini since it is not anymore used --- CONTRIBUTING.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8336add..2b70c13 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -62,12 +62,6 @@ example, open an extra file into the past just in case it happens to include result lines that have timestamps that are still considered valid (of course, ignore results in the file that are no longer valid). -**Strongly prefer putting new config options in ``sbws/config.default.ini``** -instead of ``sbws/config.example.ini``. The former holds default values for -approxmiately all sbws configuration options and can be changed with an sbws -update. The latter is used as a starting point for generating a client's -``config.ini`` and changes to it only affect newly generated config files. - **Document your addition, fix, change, or whatever in the changelog**. See `keep a changelog`_ for the standard we follow. Of note, add Added, Changed, Deprecated, Removed, Fixed, and Security headings as needed in the Unreleased

1 0

[sbws/master] Add /docs dir as source of documentation
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 6278ea2a5dd5462ac88d5e52514feeaf10cf8d2b Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 16:45:56 2018 +0000 Add /docs dir as source of documentation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ef7eaa..dbca4e3 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ See ./INSTALL.rst) for install instructions, [./DEPLOY.rst](./DEPLOY.rst) for deploy instructions, [./CONTRIBUTING](./CONTRIBUTING.rst) for contribution guidelines. -The sbws documentation can be found at [Read the Docs](https://sbws.readthedocs.io) -and +More extensive documentation can be found in the ./docs directory, +also online at https://sbws.readthedocs.io and [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/) ([v2](http://sdmb3rfvp3wadu6y.onion/)).

1 0

[sbws/master] Change repo by source code dir
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 0d142777c767cb50f14889b892876fae4b60f88d Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 16:47:31 2018 +0000 Change repo by source code dir --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dbca4e3..f0fe0ae 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ also online at https://sbws.readthedocs.io and [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/) ([v2](http://sdmb3rfvp3wadu6y.onion/)). -## Layout of the sbws repo +## Layout of `sbws` source code directory - `docs/` the source of the sbws documentation website. - `sbws/` the source code for sbws.

1 0