March 2015 - tor-commits - lists.torproject.org

[bridgedb/master] Fix typos in README.rst.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit 11217eee36553e8a4ba3911bc2d1d4c125067061 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 01:24:24 2015 +0000 Fix typos in README.rst. --- README.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 155c4f2..a9a27fc 100644 --- a/README.rst +++ b/README.rst @@ -384,12 +384,13 @@ Using a BridgeDB Instance ========================= Obviously, you'll have to feed it bridge descriptor files from a -BridgeAuth. There's currently only one BridgeAuth in the entire world, but Tor -Project is, of course, very interested in adding support for multiple -BridgeAuths so that we can scale our own network, and make it easier for -individual and organisations who wish to run a lot of Tor bridge relays, and -distribute those themselves, have an easier time doing so. If you'd like to -fund our work on this, please contact tor-dev(a)lists.torproject.org! +BridgeAuthority. There's currently only one BridgeAuthority in the entire +world, but Tor Project is, of course, very interested in adding support for +multiple BridgeAuthorities so that we can scale our own network, and make it +easier for individual and organisations who wish to run a lot of Tor bridge +relays have an easier time distributing those bridges themselves (if they wish +to do so). If you'd like to fund our work on this, please contact +tor-dev(a)lists.torproject.org! ---------------------------------- Accessing the HTTPS User Interface

1 0

[bridgedb/master] Add link to leekspin in README.rst.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit a5b15094679a9898aea9868bed7f5085a584f4d2 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 01:24:08 2015 +0000 Add link to leekspin in README.rst. --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index b4472c7..155c4f2 100644 --- a/README.rst +++ b/README.rst @@ -309,8 +309,9 @@ To create a bunch of fake bridge descriptors to test BridgeDB, do:: bridgedb mock [-n NUMBER_OF_DESCRIPTORS] -Note that you will need to install ``leekspin`` in order to run the -``bridgedb mock``. See HACKING.md for details. +Note that you will need to install +`leekspin <https://pypi.python.org/pypi/leekspin>`__ in order to run the +``bridgedb mock`` command. See ``doc/HACKING.md`` for details. And finally, to run the test suites, do::

1 0

[bridgedb/master] Remove outdated section on BridgeDB SQL schema updating from README.rst.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit 051f94a3d9ddb5ce43d6ac207c15ddcab8d6d8b2 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 01:13:36 2015 +0000 Remove outdated section on BridgeDB SQL schema updating from README.rst. --- README.rst | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/README.rst b/README.rst index 47a78d7..01b4e2c 100644 --- a/README.rst +++ b/README.rst @@ -291,24 +291,6 @@ blocked bridges from the responses it gives to clients requesting bridges. ------------------------- -Updating the SQL schema: ------------------------- - -Make sure that SQLite3 is installed. (You should have installed it -already during the setup and installation stage.) To update, do:: - - sqlite3 path/to/bridgedist.db.sqlite - -Enter the following commands at the ``sqlite>`` prompt:: - - CREATE TABLE BlockedBridges ( id INTEGER PRIMARY KEY NOT NULL, hex_key, blocking_country); - CREATE INDEX BlockedBridgesBlockingCountry on BlockedBridges(hex_key); - CREATE TABLE WarnedEmails ( email PRIMARY KEY NOT NULL, when_warned); - CREATE INDEX WarnedEmailsWasWarned on WarnedEmails ( email ); - REPLACE INTO Config VALUES ( 'schema-version', 2 ); - - ================ Testing BridgeDB ================

1 0

[bridgedb/master] Make copyright year in Sphinx documentation builds automatic.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit 184f5ed56ed9283a0010fb87e9c0341192b950f6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 00:52:34 2015 +0000 Make copyright year in Sphinx documentation builds automatic. --- doc/sphinx/source/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py index 2c304fe..ac8ce2d 100644 --- a/doc/sphinx/source/conf.py +++ b/doc/sphinx/source/conf.py @@ -126,7 +126,9 @@ master_doc = 'index' # General information about the project. project = u'BridgeDB' -copyright = u'2014, The Tor Project, Inc' + +from datetime import datetime +copyright = u'%s, The Tor Project, Inc' % datetime.now().year # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the

1 0

[bridgedb/master] Fix maintenance translations instructions in README.rst.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit 47033b3eca2777adb864f7add0145c5d3a7ce821 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 01:12:07 2015 +0000 Fix maintenance translations instructions in README.rst. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 0007c78..e327ecb 100644 --- a/README.rst +++ b/README.rst @@ -181,7 +181,7 @@ branch. - To extract all strings from BridgeDB's source:: - python setup.py extract_messages --input-dirs ./lib/bridgedb/templates + python setup.py extract_messages A .pot file will be created in ./i18n/templates/bridgedb.pot

1 0

[bridgedb/master] Update maintenance GnuPG signing key instructions in README.rst.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit bb548771e1d0ca9e43c94793e142fa05160de385 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 01:12:26 2015 +0000 Update maintenance GnuPG signing key instructions in README.rst. --- README.rst | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index e327ecb..47a78d7 100644 --- a/README.rst +++ b/README.rst @@ -254,14 +254,27 @@ To enable using a local cache of CAPTCHAs, set the following options:: GnuPG email signing: -------------------- -Add these two options to your bridgedb.conf:: +In your ``bridgedb.conf`` file, make sure that:: - EMAIL_GPG_SIGNING_ENABLED - EMAIL_GPG_SIGNING_KEY + EMAIL_GPG_SIGNING_ENABLED = True -The former may be either True or False, and the latter must point to the -ascii-armored private key file. The keyfile must not be passphrase -protected. +and edit the following option to add the full fingerprint of the GnuPG key +that should be used to by BridgeDB to sign outgoing emails:: + + EMAIL_GPG_PRIMARY_KEY_FINGERPRINT + +The key specified by ``EMAIL_GPG_PRIMARY_KEY_FINGERPRINT`` can be a master +key, or a subkey (with or without the private portions of its corresponding +master key), but it **must** be inside the ``secring.gpg`` and ``pubring.gpg`` +keyrings inside the directory specified in the ``bridgedb.conf`` option:: + + EMAIL_GPG_HOMEDIR + +If the key has requires a passphrase for signing, you'll also need to set +either of:: + + EMAIL_GPG_PASSPHRASE + EMAIL_GPG_PASSPHRASE_FILE ----------------------------------------------------------

1 0

[bridgedb/master] Remove severely outdated TODO file.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit e1fff4834575a3a05f3682d5c5dad6e40d084272 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 00:53:30 2015 +0000 Remove severely outdated TODO file. Developers can add reStructured Text (rst) "todo" directives within class, function, or method docstrings, like this: def foo(self, bar): """Do a foo to a **bar**. .. todo: We probably also want to be able to foo both **bar**s and **baz**s at the same time. """ These "todo"s will be automatically assembled during BridgeDB's HTML documentation [0] builds, where they are all listed in the "TODO List" section of the index.html [1] page, as well as individually in their respective class/function/method documentation (e.g. [2]). [0]: https://pythonhosted.org/bridgedb/ [1]: https://pythonhosted.org/bridgedb/#todo-list [2]: https://pythonhosted.org/bridgedb/bridgedb.bridges.html#bridgedb.bridges.Br… --- TODO | 58 ---------------------------------------------------------- 1 file changed, 58 deletions(-) diff --git a/TODO b/TODO deleted file mode 100644 index d23b628..0000000 --- a/TODO +++ /dev/null @@ -1,58 +0,0 @@ - -RSN: -o Switch backend to sqlite -X Drop email->bridge mappings after N days -o Bump up epoch length a lot. -o Test DB migration code. -o Drop email persistence. -o Rate-limit email replies. -o Stop looking for "get bridges" in emails. -o Clean email backend periodically -- Write a spec. - - -Soon: -- List only one bridge per /16 per reply. -o It keeps corrupting its database, causing Roger to delete the old - database and undermine this whole give-the-same-answer-each-time - design: - https://bugs.torproject.org/flyspray/index.php?do=details&id=1098 - [SOLUTION: Switch to sqlite.] -- Keep strings in gettext file, internationalize properly with gettext -o Send back an email even if there are no bridges -o Check dkim headers for sanity. -X Make the 'magic word' for the email configurable, case-tolerant, - html-tolerant, and punctuation-tolerant - X for bonus points, make it base64-tolerant -- make all the rest of the email options configurable. -o bug: the email handler gets really upset when the email doesn't have - a message-id header in it. -o When we hit the end of a period, forget email address history. -X When sending bridges to an email address in the history, check for - liveness. -. Make bounces go to the right address. - o Make address sent in "mail from" command configurable. - - Actually configure it. -- make the bridge list you get back include at least one *non*443 - bridge. turns out sometimes 443 isn't all it's cracked up to be. -X write the ip addresses of the unallocated bridges to a local file, - so we can give them out manually as needed - [Instead, we keep them in a sqlite database. That should be good - enough to query manually.] - -Not now: -- check that incoming IP of email is sane. -- check more email headers for sanity - -Later: -- document stuff better -- better area division logic -. make all proxies get stuck in their own area. -o implement slightly nicer logging -- add captchas -o decent template for web interface -o decent template for mail interface -- implement 'help' command -- Reload configuration on sighup; not just bridges. -- Reply with locale support. -- Check host option in http

1 0

[bridgedb/master] Merge branch 'fix/12507-automate-documentation-builds' into develop
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit b28e9a4ced012b70c6a14630fe937a83bbf3b26c Merge: 56e6b94 aa167c9 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 00:40:50 2015 +0000 Merge branch 'fix/12507-automate-documentation-builds' into develop Makefile | 6 +++++- setup.cfg | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-)

1 0

[bridgedb/master] Update Sphinx sources for documentation builds.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit e045420e61bc4c9d1436f306d3cb58f5b626afb4 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 00:32:39 2015 +0000 Update Sphinx sources for documentation builds. --- doc/sphinx/source/bridgedb.Tests.rst | 8 -------- doc/sphinx/source/bridgedb.bridges.rst | 8 ++++++++ doc/sphinx/source/bridgedb.geo.rst | 8 ++++++++ doc/sphinx/source/bridgedb.parse.rst | 4 +++- doc/sphinx/source/bridgedb.proxy.rst | 8 ++++++++ doc/sphinx/source/bridgedb.qrcodes.rst | 8 ++++++++ doc/sphinx/source/bridgedb.rst | 5 ++++- doc/sphinx/source/conf.py | 7 ++++++- 8 files changed, 45 insertions(+), 11 deletions(-) diff --git a/doc/sphinx/source/bridgedb.Tests.rst b/doc/sphinx/source/bridgedb.Tests.rst deleted file mode 100644 index 7a271ba..0000000 --- a/doc/sphinx/source/bridgedb.Tests.rst +++ /dev/null @@ -1,8 +0,0 @@ -bridgedb.Tests --------------- - -.. automodule:: bridgedb.Tests - :members: - :undoc-members: - :private-members: - :show-inheritance: diff --git a/doc/sphinx/source/bridgedb.bridges.rst b/doc/sphinx/source/bridgedb.bridges.rst new file mode 100644 index 0000000..db475ff --- /dev/null +++ b/doc/sphinx/source/bridgedb.bridges.rst @@ -0,0 +1,8 @@ +bridgedb.bridges +---------------- + +.. automodule:: bridgedb.bridges + :members: + :undoc-members: + :private-members: + :show-inheritance: diff --git a/doc/sphinx/source/bridgedb.geo.rst b/doc/sphinx/source/bridgedb.geo.rst new file mode 100644 index 0000000..9c4fafb --- /dev/null +++ b/doc/sphinx/source/bridgedb.geo.rst @@ -0,0 +1,8 @@ +bridgedb.geo +------------ + +.. automodule:: bridgedb.geo + :members: + :undoc-members: + :private-members: + :show-inheritance: diff --git a/doc/sphinx/source/bridgedb.parse.rst b/doc/sphinx/source/bridgedb.parse.rst index c458f9f..6d79398 100644 --- a/doc/sphinx/source/bridgedb.parse.rst +++ b/doc/sphinx/source/bridgedb.parse.rst @@ -8,7 +8,9 @@ bridgedb.parse .. automodule:: bridgedb.parse.__init__ .. automodule:: bridgedb.parse.addr +.. automodule:: bridgedb.parse.descriptors +.. automodule:: bridgedb.parse.fingerprint .. automodule:: bridgedb.parse.headers -.. automodule:: bridgedb.parse.networkstatus +.. automodule:: bridgedb.parse.nickname .. automodule:: bridgedb.parse.options .. automodule:: bridgedb.parse.versions diff --git a/doc/sphinx/source/bridgedb.proxy.rst b/doc/sphinx/source/bridgedb.proxy.rst new file mode 100644 index 0000000..36c7e8d --- /dev/null +++ b/doc/sphinx/source/bridgedb.proxy.rst @@ -0,0 +1,8 @@ +bridgedb.proxy +-------------- + +.. automodule:: bridgedb.proxy + :members: + :undoc-members: + :private-members: + :show-inheritance: diff --git a/doc/sphinx/source/bridgedb.qrcodes.rst b/doc/sphinx/source/bridgedb.qrcodes.rst new file mode 100644 index 0000000..314df3d --- /dev/null +++ b/doc/sphinx/source/bridgedb.qrcodes.rst @@ -0,0 +1,8 @@ +bridgedb.qrcodes +---------------- + +.. automodule:: bridgedb.qrcodes + :members: + :undoc-members: + :private-members: + :show-inheritance: diff --git a/doc/sphinx/source/bridgedb.rst b/doc/sphinx/source/bridgedb.rst index 912cb72..3f87647 100644 --- a/doc/sphinx/source/bridgedb.rst +++ b/doc/sphinx/source/bridgedb.rst @@ -7,6 +7,7 @@ BridgeDB Package and Module Documentation :toctree: bridgedb.bridgerequest + bridgedb.bridges bridgedb.Bridges bridgedb.Bucket bridgedb.captcha @@ -15,18 +16,20 @@ BridgeDB Package and Module Documentation bridgedb.Dist bridgedb.email bridgedb.Filters + bridgedb.geo bridgedb.HTTPServer bridgedb.interfaces bridgedb.Main bridgedb.parse bridgedb.persistent + bridgedb.proxy + bridgedb.qrcodes bridgedb.runner bridgedb.safelog bridgedb.schedule bridgedb.Stability bridgedb.Storage bridgedb.strings - bridgedb.Tests bridgedb.translations bridgedb.txrecaptcha bridgedb.util diff --git a/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py index 16d8225..2c304fe 100644 --- a/doc/sphinx/source/conf.py +++ b/doc/sphinx/source/conf.py @@ -27,6 +27,8 @@ sys.path.insert(0, os.path.abspath(os.path.join( import bridgedb +import bridgedb.bridgerequest +import bridgedb.bridges import bridgedb.captcha import bridgedb.Bridges import bridgedb.Bucket @@ -39,9 +41,12 @@ import bridgedb.email.request import bridgedb.email.server import bridgedb.email.templates import bridgedb.Filters +import bridgedb.geo import bridgedb.HTTPServer import bridgedb.Main import bridgedb.persistent +import bridgedb.proxy +import bridgedb.qrcodes import bridgedb.runner import bridgedb.safelog import bridgedb.schedule @@ -49,7 +54,7 @@ import bridgedb.Stability import bridgedb.Storage import bridgedb.strings import bridgedb.test -import bridgedb.Tests +import bridgedb.translations import bridgedb.txrecaptcha import bridgedb.util

1 0

[bridgedb/master] Add setup.cfg [bulid_sphinx] directive options.
by isis＠torproject.org 20 Mar '15

20 Mar '15

commit 621c2a95e2c4a53d65d3f91bbef1facb99558d1c Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Mar 21 00:36:55 2015 +0000 Add setup.cfg [bulid_sphinx] directive options. * FIXES part of #12507: https://bugs.torproject.org/12507 --- setup.cfg | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/setup.cfg b/setup.cfg index eac2290..1ce1f67 100644 --- a/setup.cfg +++ b/setup.cfg @@ -33,3 +33,7 @@ domain = bridgedb input_file = lib/bridgedb/i18n/templates/bridgedb.pot output_dir = lib/bridgedb/i18n previous = true + +[build_sphinx] +source_dir = doc/sphinx/source +project = bridgedb

1 0