August 2014 - tor-commits - lists.torproject.org

[bridgedb/develop] Fix old Tests.py; networkstatus.parseALine returns a string.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit d7fd62fa581a8a6dba7213e9619561c5307e5540 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Jun 11 21:35:33 2014 +0000 Fix old Tests.py; networkstatus.parseALine returns a string. * CHANGE test_regressionsNewCode_IPBridgeDistTests_testDistWithFilterIP4() and test_regressionsNewCode_IPBridgeDistTests_testDistWithFilterIP6() to convert the string returned from networkstatus.parseALine into an ipaddr.IPAddress. --- lib/bridgedb/Tests.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/Tests.py b/lib/bridgedb/Tests.py index 219802b..93ee4f2 100644 --- a/lib/bridgedb/Tests.py +++ b/lib/bridgedb/Tests.py @@ -320,7 +320,7 @@ class IPBridgeDistTests(unittest.TestCase): bridge = random.choice(bridges) bridge_line = bridge.getConfigLine(addressClass=ipaddr.IPv6Address) address, portlist = networkstatus.parseALine(bridge_line) - assert type(address) is ipaddr.IPv6Address + assert type(ipaddr.IPAddress(address)) is ipaddr.IPv6Address assert filterBridgesByIP6(random.choice(bridges)) def testDistWithFilterIP4(self): @@ -336,7 +336,7 @@ class IPBridgeDistTests(unittest.TestCase): bridge = random.choice(bridges) bridge_line = bridge.getConfigLine(addressClass=ipaddr.IPv4Address) address, portlist = networkstatus.parseALine(bridge_line) - assert type(address) is ipaddr.IPv4Address + assert type(ipaddr.IPAddress(address)) is ipaddr.IPv4Address assert filterBridgesByIP4(random.choice(bridges)) def testDistWithFilterBoth(self):

1 0

[bridgedb/develop] Merge branch 'fix/12029-refactor-Bridges' into develop
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit bebe41b6081b88f3c07e9af3a896307961facd70 Merge: 6ccf0c7 d7fd62f Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Aug 28 03:19:49 2014 +0000 Merge branch 'fix/12029-refactor-Bridges' into develop bridgedb.conf | 8 +++- lib/bridgedb/Bridges.py | 52 +++++-------------------- lib/bridgedb/Tests.py | 4 +- lib/bridgedb/bridgerequest.py | 5 ++- lib/bridgedb/interfaces.py | 19 +++++++++ lib/bridgedb/parse/addr.py | 64 ++++++++++++++++++++----------- lib/bridgedb/parse/fingerprint.py | 44 +++++++++++++++++++++ lib/bridgedb/test/deprecated.py | 33 ++++++++++++++++ lib/bridgedb/test/test_Tests.py | 6 +++ lib/bridgedb/test/test_bridgerequest.py | 4 +- 10 files changed, 167 insertions(+), 72 deletions(-)

1 0

[bridgedb/develop] Add unittests for bridgedb.configure module.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit d24f778c9115c9fce54a686774211fd5f40c47ec Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Aug 27 08:37:27 2014 +0000 Add unittests for bridgedb.configure module. --- lib/bridgedb/configure.py | 2 +- lib/bridgedb/test/test_configure.py | 67 +++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/configure.py b/lib/bridgedb/configure.py index 6220fce..33cc458 100644 --- a/lib/bridgedb/configure.py +++ b/lib/bridgedb/configure.py @@ -93,7 +93,7 @@ def loadConfig(configFile=None, configCls=None): for attr in ["PROXY_LIST_FILES", "BRIDGE_FILES", "EXTRA_INFO_FILES"]: setting = getattr(config, attr, None) - if setting is None: + if setting is None: # pragma: no cover setattr(config, attr, []) # If they weren't set, make them lists else: setattr(config, attr, # If they were set, expand the paths: diff --git a/lib/bridgedb/test/test_configure.py b/lib/bridgedb/test/test_configure.py new file mode 100644 index 0000000..501ed1f --- /dev/null +++ b/lib/bridgedb/test/test_configure.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: please see the AUTHORS file for attributions +# :copyright: (c) 2013-2014, Isis Lovecruft +# (c) 2007-2014, The Tor Project, Inc. +# :license: see LICENSE for licensing information + +"""Tests for :mod:`bridgedb.configure`.""" + +from __future__ import print_function + +import os + +from twisted.trial import unittest + +from bridgedb import configure + + +class ConfigureTests(unittest.TestCase): + """Tests for miscelaneous functions in :mod:`bridgedb.configure`.""" + + def setUp(self): + """Find the config file in the top directory of this repo.""" + here = os.getcwd() + topdir = here.rstrip('_trial_temp') + self.configFilename = os.path.join(topdir, 'bridgedb.conf') + + def test_loadConfig_with_file(self): + """We should be able to load and parse the standard ``bridgedb.conf`` + file from the top directory of this repository. + """ + config = configure.loadConfig(self.configFilename) + self.assertTrue(config) + + def test_loadConfig_with_file_and_class(self): + """We should be able to reload and parse the ``bridgedb.conf`` + file, if we have a config class as well. + """ + config = configure.loadConfig(self.configFilename) + newConfig = configure.loadConfig(self.configFilename, configCls=config) + self.assertTrue(newConfig) + + def test_loadConfig_with_class(self): + """We should be able to recreate a config, given its class.""" + config = configure.loadConfig(self.configFilename) + newConfig = configure.loadConfig(configCls=config) + self.assertTrue(newConfig) + + def test_loadConfig_set_EXTRA_INFO_FILES_when_None(self): + """If certain options, like the ``EXTRA_INFO_FILES`` option in the + config file weren't set, they should be made into lists so that our + parsers don't choke on them later. + """ + config = configure.loadConfig(self.configFilename) + setattr(config, "EXTRA_INFO_FILES", None) + self.assertTrue(config.EXTRA_INFO_FILES is None) + newConfig = configure.loadConfig(configCls=config) + self.assertIsInstance(newConfig.EXTRA_INFO_FILES, list) + + def test_loadConfig_returns_Conf(self): + """After loading and parsing the ``bridgedb.conf`` file, we should have + a :class:`bridgedb.configure.Conf`. + """ + config = configure.loadConfig(self.configFilename) + self.assertIsInstance(config, configure.Conf)

1 0

[bridgedb/develop] Move config functionality to new bridgedb.configure module.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit 7205bf4b3ff9ef20c9a91f34d59d116a17c47cb4 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Aug 22 22:13:42 2014 +0000 Move config functionality to new bridgedb.configure module. * MOVE bridgedb.persistent.Conf → bridgedb.configure.Conf. * MOVE bridgedb.Main.loadConfig → bridgedb.configure.loadConfig. * CHANGE imports in bridgedb.Main and bridgedb.persistent to use class and function in bridgedb.configure. * CHANGE Sphinx documentation to point to new locations. --- lib/bridgedb/Main.py | 109 +----------------------------------- lib/bridgedb/configure.py | 132 ++++++++++++++++++++++++++++++++++++++++++++ lib/bridgedb/persistent.py | 14 +---- 3 files changed, 137 insertions(+), 118 deletions(-) diff --git a/lib/bridgedb/Main.py b/lib/bridgedb/Main.py index df46ac5..c720d05 100644 --- a/lib/bridgedb/Main.py +++ b/lib/bridgedb/Main.py @@ -25,6 +25,8 @@ from bridgedb import persistent from bridgedb import safelog from bridgedb import schedule from bridgedb import util +from bridgedb.configure import loadConfig +from bridgedb.configure import Conf from bridgedb.parse import options import bridgedb.Bridges as Bridges @@ -179,113 +181,6 @@ def load(state, splitter, clear=False): state.save() return -def loadConfig(configFile=None, configCls=None): - """Load configuration settings on top of the current settings. - - All pathnames and filenames within settings in the ``configFile`` will be - expanded, and their expanded values will be stored in the returned - :class:`config <Conf>` object. - - ** Note: ** - On the strange-looking use of - ``exec compile(open(configFile).read(), '<string>', 'exec') in dict()`` - in this function: - - The contents of the config file should be compiled first, and then - ``exec``ed -- not ``execfile``! -- in order to get the contents of the - config file to exist within the scope of the configuration dictionary. - Otherwise, Python *will* default_ to executing the config file directly - within the ``globals()`` scope. - - Additionally, it's roughly 20-30 times faster_ to use the ``compile`` - builtin on a string (the contents of the file) before ``exec``ing it, than - using ``execfile`` directly on the file. - - .. _default: http://stackoverflow.com/q/17470193 - .. _faster: http://lucumr.pocoo.org/2011/2/1/exec-in-python/ - - :ivar boolean itsSafeToUseLogging: This is called in :func:`startup` - before :func:`safelog.configureLogging`. When called from ``startup``, - the ``configCls`` parameter is not given, because that is the first - time that a :class:`Conf` is created. If a :class:`logging.Logger` is - created in this function, then logging will not be correctly - configured, therefore, if the ``configCls`` parameter is not given, - then it's the first time this function has been called and it is - therefore not safe to make calls to the logging module. - :type: configFile: string or None - :param string configFile: If given, the filename of the config file to - load. - :type configCls: :class:`bridgedb.Main.Conf` or None - :param configCls: The current configuration, if one already exists. - :rtype: :class:`Conf` - :returns: A new configuration, with the old settings as defaults, and the - settings from the config file overriding them. - """ - itsSafeToUseLogging = False - configuration = {} - - if configCls: - itsSafeToUseLogging = True - oldConfig = configCls.__dict__ - configuration.update(**oldConfig) # Load current settings - logging.info("Reloading over in-memory configurations...") - - conffile = configFile - if (configFile is None) and ('CONFIG_FILE' in configuration): - conffile = configuration['CONFIG_FILE'] - - if conffile is not None: - if itsSafeToUseLogging: - logging.info("Loading settings from config file: '%s'" % conffile) - compiled = compile(open(conffile).read(), '<string>', 'exec') - exec compiled in configuration - - if itsSafeToUseLogging: - logging.debug("New configuration settings:") - logging.debug("\n".join(["{0} = {1}".format(key, value) - for key, value in configuration.items()])) - - # Create a :class:`Conf` from the settings stored within the local scope - # of the ``configuration`` dictionary: - config = persistent.Conf(**configuration) - - # We want to set the updated/expanded paths for files on the ``config``, - # because the copy of this config, `state.config` is used later to compare - # with a new :class:`Conf` instance, to see if there were any changes. - # - # See :meth:`bridgedb.persistent.State.useUpdatedSettings`. - - for attr in ["PROXY_LIST_FILES", "BRIDGE_FILES", "EXTRA_INFO_FILES"]: - setting = getattr(config, attr, None) - if setting is None: - setattr(config, attr, []) # If they weren't set, make them lists - else: - setattr(config, attr, # If they were set, expand the paths: - [os.path.abspath(os.path.expanduser(f)) for f in setting]) - - for attr in ["DB_FILE", "DB_LOG_FILE", "MASTER_KEY_FILE", "PIDFILE", - "ASSIGNMENTS_FILE", "HTTPS_CERT_FILE", "HTTPS_KEY_FILE", - "LOG_FILE", "STATUS_FILE", "COUNTRY_BLOCK_FILE", - "GIMP_CAPTCHA_DIR", "GIMP_CAPTCHA_HMAC_KEYFILE", - "GIMP_CAPTCHA_RSA_KEYFILE"]: - setting = getattr(config, attr, None) - if setting is None: - setattr(config, attr, setting) - else: - setattr(config, attr, os.path.abspath(os.path.expanduser(setting))) - - for attr in ["FORCE_PORTS", "FORCE_FLAGS"]: - setting = getattr(config, attr, []) # Default to empty lists - setattr(config, attr, setting) - - for domain in config.EMAIL_DOMAINS: - config.EMAIL_DOMAIN_MAP[domain] = domain - - if conffile: # Store the pathname of the config file, if one was used - config.CONFIG_FILE = os.path.abspath(os.path.expanduser(conffile)) - - return config - def loadProxyList(cfg): ipset = {} for fname in cfg.PROXY_LIST_FILES: diff --git a/lib/bridgedb/configure.py b/lib/bridgedb/configure.py new file mode 100644 index 0000000..6220fce --- /dev/null +++ b/lib/bridgedb/configure.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_configure -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: please see the AUTHORS file for attributions +# :copyright: (c) 2013-2014, Isis Lovecruft +# (c) 2013-2014, Matthew Finkel +# (c) 2007-2014, Nick Mathewson +# (c) 2007-2014, The Tor Project, Inc. +# :license: see LICENSE for licensing information + +"""Utilities for dealing with configuration files for BridgeDB.""" + +import logging +import os + + +def loadConfig(configFile=None, configCls=None): + """Load configuration settings on top of the current settings. + + All pathnames and filenames within settings in the ``configFile`` will be + expanded, and their expanded values will be stored in the returned + :class:`config <Conf>` object. + + ** Note: ** + On the strange-looking use of + ``exec compile(open(configFile).read(), '<string>', 'exec') in dict()`` + in this function: + + The contents of the config file should be compiled first, and then + ``exec``ed -- not ``execfile``! -- in order to get the contents of the + config file to exist within the scope of the configuration dictionary. + Otherwise, Python *will* default_ to executing the config file directly + within the ``globals()`` scope. + + Additionally, it's roughly 20-30 times faster_ to use the ``compile`` + builtin on a string (the contents of the file) before ``exec``ing it, than + using ``execfile`` directly on the file. + + .. _default: http://stackoverflow.com/q/17470193 + .. _faster: http://lucumr.pocoo.org/2011/2/1/exec-in-python/ + + :ivar boolean itsSafeToUseLogging: This is called in :func:`startup` + before :func:`safelog.configureLogging`. When called from ``startup``, + the ``configCls`` parameter is not given, because that is the first + time that a :class:`Conf` is created. If a :class:`logging.Logger` is + created in this function, then logging will not be correctly + configured, therefore, if the ``configCls`` parameter is not given, + then it's the first time this function has been called and it is + therefore not safe to make calls to the logging module. + :type: configFile: string or None + :param string configFile: If given, the filename of the config file to + load. + :type configCls: :class:`bridgedb.Main.Conf` or None + :param configCls: The current configuration, if one already exists. + :rtype: :class:`Conf` + :returns: A new configuration, with the old settings as defaults, and the + settings from the config file overriding them. + """ + itsSafeToUseLogging = False + configuration = {} + + if configCls: + itsSafeToUseLogging = True + oldConfig = configCls.__dict__ + configuration.update(**oldConfig) # Load current settings + logging.info("Reloading over in-memory configurations...") + + conffile = configFile + if (configFile is None) and ('CONFIG_FILE' in configuration): + conffile = configuration['CONFIG_FILE'] + + if conffile is not None: + if itsSafeToUseLogging: + logging.info("Loading settings from config file: '%s'" % conffile) + compiled = compile(open(conffile).read(), '<string>', 'exec') + exec compiled in configuration + + if itsSafeToUseLogging: + logging.debug("New configuration settings:") + logging.debug("\n".join(["{0} = {1}".format(key, value) + for key, value in configuration.items()])) + + # Create a :class:`Conf` from the settings stored within the local scope + # of the ``configuration`` dictionary: + config = Conf(**configuration) + + # We want to set the updated/expanded paths for files on the ``config``, + # because the copy of this config, `state.config` is used later to compare + # with a new :class:`Conf` instance, to see if there were any changes. + # + # See :meth:`bridgedb.persistent.State.useUpdatedSettings`. + + for attr in ["PROXY_LIST_FILES", "BRIDGE_FILES", "EXTRA_INFO_FILES"]: + setting = getattr(config, attr, None) + if setting is None: + setattr(config, attr, []) # If they weren't set, make them lists + else: + setattr(config, attr, # If they were set, expand the paths: + [os.path.abspath(os.path.expanduser(f)) for f in setting]) + + for attr in ["DB_FILE", "DB_LOG_FILE", "MASTER_KEY_FILE", "PIDFILE", + "ASSIGNMENTS_FILE", "HTTPS_CERT_FILE", "HTTPS_KEY_FILE", + "LOG_FILE", "STATUS_FILE", "COUNTRY_BLOCK_FILE", + "GIMP_CAPTCHA_DIR", "GIMP_CAPTCHA_HMAC_KEYFILE", + "GIMP_CAPTCHA_RSA_KEYFILE"]: + setting = getattr(config, attr, None) + if setting is None: + setattr(config, attr, setting) + else: + setattr(config, attr, os.path.abspath(os.path.expanduser(setting))) + + for attr in ["FORCE_PORTS", "FORCE_FLAGS"]: + setting = getattr(config, attr, []) # Default to empty lists + setattr(config, attr, setting) + + for domain in config.EMAIL_DOMAINS: + config.EMAIL_DOMAIN_MAP[domain] = domain + + if conffile: # Store the pathname of the config file, if one was used + config.CONFIG_FILE = os.path.abspath(os.path.expanduser(conffile)) + + return config + + +class Conf(object): + """A configuration object. Holds unvalidated attributes.""" + def __init__(self, **attrs): + for key, value in attrs.items(): + if key == key.upper(): + if not key.startswith('__'): + self.__dict__[key] = value diff --git a/lib/bridgedb/persistent.py b/lib/bridgedb/persistent.py index 3b9803d..8c65e78 100644 --- a/lib/bridgedb/persistent.py +++ b/lib/bridgedb/persistent.py @@ -24,6 +24,7 @@ from twisted.python.reflect import safe_repr from twisted.spread import jelly from bridgedb import Filters, Bridges, Dist +from bridgedb.configure import Conf #from bridgedb.proxy import ProxySet _state = None @@ -77,15 +78,6 @@ def load(stateCls=None): return loaded -class Conf(object): - """A configuration object. Holds unvalidated attributes.""" - def __init__(self, **attrs): - for key, value in attrs.items(): - if key == key.upper(): - if not key.startswith('__'): - self.__dict__[key] = value - - class State(jelly.Jellyable): """Pickled, jellied storage container for persistent state.""" @@ -235,7 +227,7 @@ class State(jelly.Jellyable): """Take a new config, compare it to the last one, and update settings. Given a ``config`` object created from the configuration file, compare - it to the last :class:`~bridgedb.Main.Conf` that was stored, and apply + it to the last :class:`~bridgedb.configure.Conf` that was stored, and apply any settings which were changed to be attributes of the :class:`State` instance. """ @@ -249,7 +241,7 @@ class State(jelly.Jellyable): # # Be sure, when updating settings while parsing the config # file, to assign the new settings as attributes of the - # :class:`bridgedb.Main.Conf` instance. + # :class:`bridgedb.configure.Conf` instance. if value != self.config.__dict__[key]: setattr(self, key, value) updated.append(key)

1 0

[bridgedb/develop] Merge branch 'fix/make-config.py' into develop
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit 6ccf0c7f4b421ecca5273592892ba61def71df6b Merge: bb0a743 d24f778 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Aug 27 08:45:50 2014 +0000 Merge branch 'fix/make-config.py' into develop lib/bridgedb/Main.py | 126 ++++----------------------------- lib/bridgedb/configure.py | 132 +++++++++++++++++++++++++++++++++++ lib/bridgedb/persistent.py | 14 +--- lib/bridgedb/test/test_configure.py | 67 ++++++++++++++++++ 4 files changed, 214 insertions(+), 125 deletions(-)

1 0

[bridgedb/develop] Add Bridges.is_valid_ip doctests to b.p.addr.isValidIP docstring.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit 9ac16433baa073a03396d33cb4e2c5e23ccd5b82 Author: Isis Lovecruft <isis(a)torproject.org> Date: Mon Jun 9 22:18:34 2014 +0000 Add Bridges.is_valid_ip doctests to b.p.addr.isValidIP docstring. Just to double check that they return the same expected results. --- lib/bridgedb/parse/addr.py | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/parse/addr.py b/lib/bridgedb/parse/addr.py index f4cd805..ace4c80 100644 --- a/lib/bridgedb/parse/addr.py +++ b/lib/bridgedb/parse/addr.py @@ -320,6 +320,21 @@ def isIPAddress(ip, compressed=True): def _isIPv(version, ip): """Check if **ip** is a certain **version** (IPv4 or IPv6). + >>> from bridgedb.parse.addr import isValidIP + >>> isValidIP('1.2.3.4') + True + >>> isValidIP('1.2.3.255') + True + >>> isValidIP('1.2.3.256') + False + >>> isValidIP('1') + False + >>> isValidIP('1.2.3') + False + >>> isValidIP('xyzzy') + False + + .. warning: Do *not* put any calls to the logging module in this function, or else an infinite recursion will occur when the call is made, due the the log :class:`~logging.Filter`s in :mod:`~bridgedb.safelog` @@ -329,7 +344,7 @@ def _isIPv(version, ip): :param integer version: The IPv[4|6] version to check; must be either ``4`` or ``6``. Any other value will be silently changed to ``4``. :param ip: The IP address to check. May be an any type which - :class:`ipaddr.IPAddress` will accept. + :class:`ipaddr.IPAddress` will accept. :rtype: boolean :returns: ``True``, if the address is an IPv4 address. """ @@ -383,8 +398,7 @@ def isValidIP(ip): * A :term:`Site-Local Address` or an :term:`Unique Local Address`. :type ip: An :class:`ipaddr.IPAddress`, :class:`ipaddr.IPv4Address`, or - :class:`ipaddr.IPv6Address`. - + :class:`ipaddr.IPv6Address`. :param ip: An ``ipaddr.IPAddress`` class. :rtype: boolean :returns: ``True``, if **ip** passes the checks; False otherwise.

1 0

[bridgedb/develop] Update file header for bridgedb.Main module.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit 52d2b6537d686172e95bf75e6641c7bc137bd01e Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Aug 21 05:05:17 2014 +0000 Update file header for bridgedb.Main module. --- lib/bridgedb/Main.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/lib/bridgedb/Main.py b/lib/bridgedb/Main.py index 4f138f0..df46ac5 100644 --- a/lib/bridgedb/Main.py +++ b/lib/bridgedb/Main.py @@ -1,12 +1,15 @@ -# -*- coding: utf-8 -*- +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_Main -*- # -# BridgeDB by Nick Mathewson. -# Copyright (c) 2007-2009, The Tor Project, Inc. -# See LICENSE for licensing information - -""" -This module sets up a bridgedb and starts the servers running. -""" +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: please see the AUTHORS file for attributions +# :copyright: (c) 2013-2014, Isis Lovecruft +# (c) 2013-2014, Matthew Finkel +# (c) 2007-2014, Nick Mathewson +# (c) 2007-2014, The Tor Project, Inc. +# :license: see LICENSE for licensing information + +"""This module sets up BridgeDB and starts the servers running.""" import os import signal

1 0

[bridgedb/develop] Remove bridgedb.Bridges.HEX_DIGEST_LEN; it's completely unused.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit 7d7ce52b48a129fda18bb8c799020ab9966c4fae Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Jun 10 22:07:31 2014 +0000 Remove bridgedb.Bridges.HEX_DIGEST_LEN; it's completely unused. --- lib/bridgedb/Bridges.py | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 5b5e678..a338b40 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -37,7 +37,6 @@ except ImportError: ID_LEN = 20 -HEX_DIGEST_LEN = 40 DIGEST_LEN = 20 PORTSPEC_LEN = 16

1 0

[bridgedb/develop] Rename IBridgeRequest → IRequestBridges. It's cuter.
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit 874abad3fcb734e009b58f74f4872730de7c30e4 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Jun 10 19:03:49 2014 +0000 Rename IBridgeRequest → IRequestBridges. It's cuter. --- lib/bridgedb/bridgerequest.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/bridgerequest.py b/lib/bridgedb/bridgerequest.py index 0d7fb5a..7b2bfe9 100644 --- a/lib/bridgedb/bridgerequest.py +++ b/lib/bridgedb/bridgerequest.py @@ -22,7 +22,7 @@ from zope.interface import Interface from bridgedb import Filters -class IBridgeRequest(Interface): +class IRequestBridges(Interface): """Interface specification of client options for requested bridges.""" addressClass = Attribute( @@ -69,7 +69,8 @@ class IBridgeRequest(Interface): class BridgeRequestBase(object): """A generic base class for storing options of a client bridge request.""" - implements(IBridgeRequest) + + implements(IRequestBridges) def __init__(self, addressClass=None): self.addressClass = addressClass

1 0

[bridgedb/develop] Deprecate bridgedb.Bridges.is_valid_fingerprint().
by isis＠torproject.org 28 Aug '14

28 Aug '14

commit b4a78c72dc74158b2e2f62f8fd38915cea07add0 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Jun 10 21:59:31 2014 +0000 Deprecate bridgedb.Bridges.is_valid_fingerprint(). * MOVE bridgedb.Bridges.is_valid_fingerprint() to bridgedb.test.deprecated module for regression testing. * REMOVE bridgedb.Bridges.toHex(). * REMOVE bridgedb.Bridges.fromHex(). * REMOVE bridgedb.Bridges.HEX_FP_LEN. * ADD bridgedb.parse.fingerprint module. This now contain equivalent functionality to the above removed/moved objects. * ADD monkeypatcher code for all the above removed/moved code to bridgedb.test.test_Tests suite for regression testing. --- lib/bridgedb/Bridges.py | 29 ++++++------------------ lib/bridgedb/parse/fingerprint.py | 44 +++++++++++++++++++++++++++++++++++++ lib/bridgedb/test/deprecated.py | 33 ++++++++++++++++++++++++++++ lib/bridgedb/test/test_Tests.py | 6 +++++ 4 files changed, 90 insertions(+), 22 deletions(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 2439130..5b5e678 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -10,7 +10,6 @@ them into hashrings for distributors. """ -import binascii import bisect import logging import re @@ -26,6 +25,9 @@ import bridgedb.Bucket from bridgedb.crypto import getHMACFunc from bridgedb.parse import addr from bridgedb.parse import networkstatus +from bridgedb.parse.fingerprint import toHex +from bridgedb.parse.fingerprint import fromHex +from bridgedb.parse.fingerprint import isValidFingerprint from bridgedb.safelog import logSafely try: @@ -34,7 +36,6 @@ except ImportError: from io import StringIO -HEX_FP_LEN = 40 ID_LEN = 20 HEX_DIGEST_LEN = 40 DIGEST_LEN = 20 @@ -73,22 +74,6 @@ def is_valid_ip(ip): return False return True -def is_valid_fingerprint(fp): - """Return true iff fp in the right format to be a hex fingerprint - of a Tor server. - """ - if len(fp) != HEX_FP_LEN: - return False - try: - fromHex(fp) - except TypeError: - return False - else: - return True - -toHex = binascii.b2a_hex -fromHex = binascii.a2b_hex - class Bridge(object): """Holds information for a single bridge, along with any Pluggable @@ -142,7 +127,7 @@ class Bridge(object): raise TypeError("Bridge with invalid ID") self.fingerprint = toHex(id_digest) elif fingerprint is not None: - if not is_valid_fingerprint(fingerprint): + if not isValidFingerprint(fingerprint): raise TypeError("Bridge with invalid fingerprint (%r)"% fingerprint) self.fingerprint = fingerprint.lower() @@ -248,7 +233,7 @@ class Bridge(object): def assertOK(self): assert is_valid_ip(self.ip) - assert is_valid_fingerprint(self.fingerprint) + assert isValidFingerprint(self.fingerprint) assert 1 <= self.orport <= 65535 if self.or_addresses: for address, portlist in self.or_addresses.items(): @@ -603,7 +588,7 @@ def parseExtraInfoFile(f): line = line[11:] (nickname, ID) = line.split() logging.debug(" Parsed Nickname: %s", nickname) - if is_valid_fingerprint(ID): + if isValidFingerprint(ID): logging.debug(" Parsed fingerprint: %s", ID) ID = fromHex(ID) else: @@ -720,7 +705,7 @@ def parseCountryBlockFile(f): line = line.strip() try: ID, addrspec, countries = line.split() - if is_valid_fingerprint(ID): + if isValidFingerprint(ID): ID = fromHex(ID) logging.debug("Parsed ID: %s", ID) else: diff --git a/lib/bridgedb/parse/fingerprint.py b/lib/bridgedb/parse/fingerprint.py new file mode 100644 index 0000000..17f15c3 --- /dev/null +++ b/lib/bridgedb/parse/fingerprint.py @@ -0,0 +1,44 @@ +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_parse_fingerprint ; -*- +#_____________________________________________________________________________ +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# please also see AUTHORS file +# :copyright: (c) 2007-2014, The Tor Project, Inc. +# (c) 2014, Isis Lovecruft +# :license: see LICENSE for licensing information +#_____________________________________________________________________________ + + +import binascii +import logging + + +#: The required length for hexidecimal representations of hash digest of a +#: Tor relay's public identity key (a.k.a. its fingerprint). +HEX_FINGERPRINT_LEN = 40 + + +#: (callable) Convert a value from binary to hexidecimal representation. +toHex = binascii.b2a_hex + +#: (callable) Convert a value from hexidecimal to binary representation. +fromHex = binascii.a2b_hex + +def isValidFingerprint(fingerprint): + """Determine if a Tor relay fingerprint is valid. + + :param str fingerprint: The hex-encoded hash digest of the relay's + public identity key, a.k.a. its fingerprint. + :rtype: bool + :returns: ``True`` if the **fingerprint** was valid, ``False`` otherwise. + """ + if len(fingerprint) == HEX_FINGERPRINT_LEN: + try: + fromHex(fingerprint) + except TypeError: + logging.debug("Invalid hex fingerprint: %r" % repr(fingerprint)) + else: + return True + return False diff --git a/lib/bridgedb/test/deprecated.py b/lib/bridgedb/test/deprecated.py index 8238b53..a972a52 100644 --- a/lib/bridgedb/test/deprecated.py +++ b/lib/bridgedb/test/deprecated.py @@ -48,6 +48,24 @@ deprecate.deprecatedModuleAttribute( "bridgedb.Bridges", "re_ipv6") +deprecate.deprecatedModuleAttribute( + Version('bridgedb', 0, 2, 3), + ("Removed due to 'bridgedb.Bridges.HEX_FP_LEN' being moved to " + "'bridgedb.parse.fingerprint.HEX_FINGERPRINT_LEN."), + "bridgedb.Bridges", "HEX_FP_LEN") + +deprecate.deprecatedModuleAttribute( + Version('bridgedb', 0, 2, 3), + ("Removed due to 'bridgedb.Bridges.toHex' being moved to " + "'bridgedb.parse.fingerprint.toHex."), + "bridgedb.Bridges", "toHex") + +deprecate.deprecatedModuleAttribute( + Version('bridgedb', 0, 2, 3), + ("Removed due to 'bridgedb.Bridges.fromHex' being moved to " + "'bridgedb.parse.fingerprint.fromHex."), + "bridgedb.Bridges", "fromHex") + @deprecate.deprecated( Version('bridgedb', 0, 0, 1), @@ -77,6 +95,21 @@ def parseORAddressLine(line): if address and portlist and len(portlist): return address,portlist raise ParseORAddressError(line) +(a)deprecate.deprecated(Version('bridgedb', 0, 2, 3), + replacement='bridgedb.parse.fingerprint.isValidFingerprint') +def is_valid_fingerprint(fp): + """Return true iff fp in the right format to be a hex fingerprint + of a Tor server. + """ + if len(fp) != HEX_FP_LEN: + return False + try: + fromHex(fp) + except TypeError: + return False + else: + return True + @deprecate.deprecated( Version('bridgedb', 0, 0, 1), diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 00994b5..816cd40 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -16,6 +16,7 @@ be compatible with the newer :api:`twisted.trial` unittests in this directory. from __future__ import print_function from __future__ import unicode_literals +import binascii import doctest import glob import logging @@ -88,6 +89,11 @@ def monkeypatchTests(): patcher.addPatch(Tests.bridgedb.Bridges, 'PORTSPEC_LEN', 16) patcher.addPatch(Tests.bridgedb.Bridges, 're_ipv4', deprecated.re_ipv4) patcher.addPatch(Tests.bridgedb.Bridges, 're_ipv6', deprecated.re_ipv6) + patcher.addPatch(Tests.bridgedb.Bridges, 'HEX_FP_LEN', 40) + patcher.addPatch(Tests.bridgedb.Bridges, 'toHex', binascii.b2a_hex) + patcher.addPatch(Tests.bridgedb.Bridges, 'fromHex', binascii.a2b_hex) + patcher.addPatch(Tests.bridgedb.Bridges, 'is_valid_fingerprint', + deprecated.is_valid_fingerprint) return patcher

1 0