tor-commits September 2018

tor-commits@lists.torproject.org

17 participants
3230 discussions

[sbws/master] Include full legal text of the license
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 12481e8f27ce7596c302915f588030812fe78167 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:48:29 2018 +0000 Include full legal text of the license --- LICENSE.md | 52 +++++++++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 67867ae..b823bcc 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,33 +1,39 @@ -As a work of the United States Government, this project is in the -public domain within the United States. +CC0 1.0 Universal +================== -Additionally, we waive copyright and related rights in the work -worldwide through the CC0 1.0 Universal public domain dedication. +Statement of Purpose +--------------------- -# CC0 1.0 Universal Summary +The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). -This is a human-readable summary of the -[Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode). +Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. -## No Copyright +For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. -The person who associated a work with this deed has dedicated the work to the -public domain by waiving all of his or her rights to the work worldwide under -copyright law, including all related and neighboring rights, to the extent -allowed by law. +1. Copyright and Related Rights. +-------------------------------- +A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: -You can copy, modify, distribute and perform the work, even for commercial -purposes, all without asking permission. See **Other Information** below. +i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; +ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; +iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; +v. rights protecting the extraction, dissemination, use and reuse of data in a Work; +vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and +vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. -## Other Information +2. Waiver. +----------- +To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equ itable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. -- In no way are the patent or trademark rights of any person affected by CC0, - nor are the rights that other persons may have in the work or in how the work - is used, such as publicity or privacy rights. +3. Public License Fallback. +---------------------------- +Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. -- Unless expressly stated otherwise, the person who associated a work with this - deed makes no warranties about the work, and disclaims liability for all uses - of the work, to the fullest extent permitted by applicable law. +4. Limitations and Disclaimers. +-------------------------------- -- When using or citing the work, you should not imply endorsement by the author - or the affirmer. +a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. +b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. +c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. +d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.

1 0

[sbws/master] Remove versioning from README
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 2aa8266fc5a6bf1f60d1c1386dac4f0b41315ca2 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 16:48:46 2018 +0000 Remove versioning from README it is usually found in CONTRIBUTING --- README.md | 41 ----------------------------------------- 1 file changed, 41 deletions(-) diff --git a/README.md b/README.md index f0fe0ae..4c1f1b0 100644 --- a/README.md +++ b/README.md @@ -38,47 +38,6 @@ also online at https://sbws.readthedocs.io and - `tests/integration/` more complex tests and/or tests that require Tor to be running - `tests/testnets/` scripts and code for running mini Tor networks locally -## Boring things - -### Versioning - -This project follows [semantic versioning][] and thus every major version has -the potential for breaking changes. You can find information about what those -are at the following places. - -- In the CHANGELOG - -[semantic versioning]: https://semver.org/ - -In addition to the overall semantic version for sbws as a whole, there is a -simple integer version for the format in which results are stored. -Incrementing this integer requires a major version change for sbws. (Note that -the reverse is **not** true: a major sbws version change does not require the -integer version for the result format to change) - -**Note**: In semantic versioning, "3.4.1-dev" comes **before** "3.4.1". With -this in mind and assuming the current version is "3.4.1-dev": in the last few -commits leading up to a new release, the version will be updated to - -- "3.4.1" if only bug fixes -- "3.5.0" if bug fixes and/or backwards-compatible additions/changes -- "4.0.0" if bug fixes and/or backwards-compatible additions/changes and/or - backwards-**in**compatible additions/changes - -Say the version is updated to "3.5.0". The commit **immediately** after the -tagged release should update the version to "3.5.1-dev". - -**Note**: Before version 1.0.0, we will make an effort to follow semver with a -prepended "0.". For example, "0.2.3" to "0.3.0" probably had a major breaking -change. However, we don't promise this will be followed well. Only trust the -semantic meaning of version numbers when they have reached 1.0.0. Don't worry, -we'll be 1.0.0 before we expect a full deployment on the real Tor network. -(Oh god please don't make me eat my words). - -To the best of my knowledge, everything said in this section except our -conventions regarding version bump commit timing is standard semantic -versioning and spelled out in the [link above][semantic versioning]. - ### The public API for sbws As required by semantic versioning, the public API for sbws will not change

1 0

[sbws/master] Remove info about .sbws since it is in the man
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit f61fed2f84a49dde4c7d7db7406b56955bc8dce5 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:09:07 2018 +0000 Remove info about .sbws since it is in the man and it is linked from INSTALL --- README.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/README.md b/README.md index f5b98a3..19c96cc 100644 --- a/README.md +++ b/README.md @@ -39,18 +39,3 @@ also online at https://sbws.readthedocs.io and - `tests/unit/` simple little tests that don't require Tor to be running - `tests/integration/` more complex tests and/or tests that require Tor to be running - `tests/testnets/` scripts and code for running mini Tor networks locally - -## The `.sbws` directory - -By default is `~/.sbws`. - -In this directory you will find - -- `datadir/` Once your sbws scanner has started gathering results, it will dump - them into this directory. Other sbws commands (such as generate and stats) - read results from the files in this directory. -- `log/` If configured, this directory stores logs generated by all the sbws - commands in rotating log files. -- `v3bw/` This directory stores the v3bw files created with `sbws generate`. -- `state.dat` A file for storing state needed between sbws commands. See its - documentation for more information.

1 0

[sbws/master] License is usually mentioned in README
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit a45c1cbdb16c1b89c7d82d3b3e3fb086a85ad19e Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:19:24 2018 +0000 License is usually mentioned in README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 19c96cc..f4547d9 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,13 @@ also online at https://sbws.readthedocs.io and - `tests/unit/` simple little tests that don't require Tor to be running - `tests/integration/` more complex tests and/or tests that require Tor to be running - `tests/testnets/` scripts and code for running mini Tor networks locally + +## License + +This work is in the public domain within the United States. + +We waive copyright and related rights in the work worldwide through the +[CC0-1.0 license](https://creativecommons.org/publicdomain/zero/1.0). + +You can find a copy of the CC0 Public Domain Dedication along with this +software in ./LICENSE.md

1 0

[sbws/master] split long line
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 2a0f14d432b8d22349fb45e4f6f37047026dcd4f Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:51:10 2018 +0000 split long line --- docs/source/man_sbws.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index 7ffb7ba..cf65d19 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -6,7 +6,9 @@ SYNOPSIS sbws [**Optional arguments**] [**Positional arguments**] -sbws [**-h**] [**--version**] [**--log-level** {**debug,info,warning,error,critical**}] [**-d** DIRECTORY] {**cleanup,scanner,generate,init,stats**} +sbws [**-h**] [**--version**] +[**--log-level** {**debug,info,warning,error,critical**}] +[**-c** CONFIG] {**cleanup,scanner,generate,init,stats**} DESCRIPTION -----------

1 0

[sbws/master] Authors is usually mentioned in README
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 6ca65f52f5c095628ea2d461dd5d5e85bf792bb1 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:19:47 2018 +0000 Authors is usually mentioned in README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index f4547d9..70ad67c 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,7 @@ We waive copyright and related rights in the work worldwide through the You can find a copy of the CC0 Public Domain Dedication along with this software in ./LICENSE.md + +## Authors + +See ./AUTHORS.md \ No newline at end of file

1 0

[sbws/master] Update authors
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 6222f81a6672a6cd93b7c909d802fde48edaf99f Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:52:25 2018 +0000 Update authors --- AUTHORS.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index ce3cd12..66a8df7 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -5,5 +5,6 @@ Thank you for helping make Tor better. * juga0 * Matt Traudt +* teor -*Last updated: 2018-04-05 on 2299e38* +*Last updated: 2018-09-14 on 27766cc*

1 0

[sbws/master] Replace public changes by the version
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 390aa1cbe2c0cd4f05b969f568a6b7b991e4856f Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:06:14 2018 +0000 Replace public changes by the version that will be considered production ready --- README.md | 37 ++----------------------------------- 1 file changed, 2 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 4c1f1b0..f5b98a3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ used by Tor and would only create more traffic in the Tor network. See ./INSTALL.rst) for install instructions, [./DEPLOY.rst](./DEPLOY.rst) for deploy instructions, [./CONTRIBUTING](./CONTRIBUTING.rst) for contribution guidelines. +======= +`sbws` will be considered production ready when version 1.0.0 will be releases. More extensive documentation can be found in the ./docs directory, also online at https://sbws.readthedocs.io and @@ -38,41 +40,6 @@ also online at https://sbws.readthedocs.io and - `tests/integration/` more complex tests and/or tests that require Tor to be running - `tests/testnets/` scripts and code for running mini Tor networks locally -### The public API for sbws - -As required by semantic versioning, the public API for sbws will not change -without a major version bump. The public API is - -- **The available configuration options and their defaults**. New options may - be added without a major version bump, but no options will be removed, nor -will defaults be drastically changed. Examples of drastic changes to defaults -include obvious things like changing the default URL for the file to download -or a location for data storage, but also more subjective things, such as -increasing the target download time significantly (6s to 60s). Examples of an -insignificant change include changing the default client nickname. Rule of -thumb: if it is likely to affect results or sbws behavior significantly, it is -a major change. - -- **The name and function of commands**. The command you run to perform certain - actions will not change in a backward incompatible way without a major -version change. For example to generate a v3bw file you will always run `sbws -generate` unless there is a major version bump and the release notes indicate -the command has changed. - -- **The format of output**. Results (stored in `~/.sbws/datadir` by default) - will not change their format in a backward incompatible way without both a -major version bump and a bump in the result version integer. The v3bw file -generated with `sbws generate` will not change its format without a major -version bump. *Log lines and the output of `sbws stats` are exceptions to this -rule*. - -- **NOT the name, location, signature, or existance of python functions**. Sbws - is meant to be ran as a standalone program. It is not at all meant to be -treated or used like a library. Users of sbws do *not* need an understanding of -how its code is laid out. Therefore the code may change drastically without a -major version bump as long as the way users interact with it does not change in -a backward incompatible way. - ## The `.sbws` directory By default is `~/.sbws`.

1 0

[sbws/master] Replace forgotten dir arg by config
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit 8cdc3f467b4fd08982296f584530a002cb264e59 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:52:46 2018 +0000 Replace forgotten dir arg by config --- 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 cf65d19..ef6942d 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -36,8 +36,8 @@ Optional arguments --log-level {debug,info,warning,error,critical} Override the sbws log level (default: None) --d DIRECTORY, --directory DIRECTORY - Path to the sbws home directory (default: $HOME/.sbws) +-c CONFIG, --config CONFIG + Path to the sbws configuration file (default: $HOME/.sbws.ini) EXAMPLES --------

1 0

[sbws/master] Add the .sbws layout in man, removed from INSTALL
by juga＠torproject.org 25 Sep '18

25 Sep '18

commit b26a71bfb6dbb0f3cff4d76396ca68eab23ceab3 Author: juga0 <juga(a)riseup.net> Date: Fri Sep 14 17:53:28 2018 +0000 Add the .sbws layout in man, removed from INSTALL --- README.md | 16 ---------------- docs/source/man_sbws.rst | 17 +++++++++++++++++ 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 70ad67c..f0c7ec8 100644 --- a/README.md +++ b/README.md @@ -24,22 +24,6 @@ also online at https://sbws.readthedocs.io and [this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/) ([v2](http://sdmb3rfvp3wadu6y.onion/)). -## Layout of `sbws` source code directory - -- `docs/` the source of the sbws documentation website. -- `sbws/` the source code for sbws. -- `sbws/core/` each file contains code specific to a single sbws command. -- `sbws/lib/` complex data structures and classes useful to one or more sbws - commands. If you're making a new class, it probably belongs here. -- `sbws/util/` simplier, "make life easier" collections of functions. -- `scripts/maint/` scripts for **maint**aining sbws and doing administrative - things like regenerating the website or updating the AUTHORS file. -- `scripts/tools/` misc. scripts for users of sbws. - performing tests with them. -- `tests/unit/` simple little tests that don't require Tor to be running -- `tests/integration/` more complex tests and/or tests that require Tor to be running -- `tests/testnets/` scripts and code for running mini Tor networks locally - ## License This work is in the public domain within the United States. diff --git a/docs/source/man_sbws.rst b/docs/source/man_sbws.rst index ef6942d..1fccb9a 100644 --- a/docs/source/man_sbws.rst +++ b/docs/source/man_sbws.rst @@ -64,6 +64,23 @@ $HOME/.sbws Default sbws home, where it stores measurement data files, bandwidth list files and tor process data. +$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/log + Default location for the logs files generated by all ``sbws`` commands, + when logging to a file is configured (see **sbws.ini**). + +$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. + +$HOME/.sbws/state.dat + A file for storing state needed between ``sbws`` commands. + $XDG_RUNTIME_DIR/sbws Runtime directory for the tor process launched by ``sbws``.

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits September 2018