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

[bridgedb/develop] Fix the name of a unittest in test_parse_descriptors.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit cfc24e94335c27d6e9fb936510ab6cb9bbc1cd41 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 10 23:25:14 2014 +0000 Fix the name of a unittest in test_parse_descriptors. It tests the `parseServerDescriptorsFile()` function, not `parseBridgeDescriptorsFile()`. * CHANGE test_parse_descriptors_parseBridgeDescriptorsFile() to test_parse_descriptors_parseServerDescriptorsFile() in lib/bridgedb/test/test_parse_descriptors.py. --- lib/bridgedb/test/test_parse_descriptors.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/test/test_parse_descriptors.py b/lib/bridgedb/test/test_parse_descriptors.py index 47685af..38bbf99 100644 --- a/lib/bridgedb/test/test_parse_descriptors.py +++ b/lib/bridgedb/test/test_parse_descriptors.py @@ -208,8 +208,8 @@ class ParseDescriptorsTests(unittest.TestCase): fh.flush() return descFilename - def test_parse_descriptors_parseBridgeDescriptorsFile(self): - """Test for ``b.p.descriptors.parseBridgeDescriptorsFile``.""" + def test_parse_descriptors_parseServerDescriptorsFile(self): + """Test for ``b.p.descriptors.parseServerDescriptorsFile``.""" descFile = io.BytesIO(BRIDGE_SERVER_DESCRIPTOR) routers = descriptors.parseServerDescriptorsFile(descFile) self.assertIsInstance(routers, list)

1 0

[bridgedb/develop] Move Bridge backwards compat code into new base classes.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit c031cafea281f0b46d68657f3d194785b788562b Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 03:45:08 2014 +0000 Move Bridge backwards compat code into new base classes. This changes the behaviour, such that if BridgeBackwardsCompatibility is inherited from, then the compatibility methods and attributes are always available, no matter how the class was instantiated (i.e. the old method, Bridge.getID() is always available). However, the assertions and errors raised in the BridgeBackwardsCompatiblity._backwardsCompatible method are only run *if* the inherited class is instantiated *with* arguments (as was the legacy manner of doing things). * ADD bridges.BridgeBase and bridges.BridgeBackwardsCompatibility classes. --- lib/bridgedb/bridges.py | 310 ++++++++++++++++++++++++++--------------------- 1 file changed, 170 insertions(+), 140 deletions(-) diff --git a/lib/bridgedb/bridges.py b/lib/bridgedb/bridges.py index 459e86a..fae5d19 100644 --- a/lib/bridgedb/bridges.py +++ b/lib/bridgedb/bridges.py @@ -380,7 +380,173 @@ class PluggableTransport(object): self._runChecks() -class Bridge(object): +class BridgeBase(object): + """The base class for all bridge implementations.""" + + def __init__(self): + self.fingerprint = None + self.nickname = None + self.address = None + self.orPort = None + self.socksPort = 0 # Bridges should always have ``SOCKSPort`` and + self.dirPort = 0 # ``DirPort`` set to ``0`` + self.orAddresses = [] + self.transports = [] + self.flags = Flags() + + +class BridgeBackwardsCompatibility(BridgeBase): + """Backwards compatibility methods for the old Bridge class.""" + + def __init__(self, nickname=None, ip=None, orport=None, + fingerprint=None, id_digest=None, or_addresses=None): + """Create a Bridge which is backwards compatible with the old Bridge class + implementation. + + .. info: For backwards compatibility, `nickname`, `ip`, and `orport` + must be the first, second, and third arguments, respectively. The + `fingerprint` and `id_digest` were previously kwargs, and are also + provided for backwards compatibility. New calls to + :meth:`__init__` *should* avoid using these kwargs, and instead + use the methods :meth:`updateFromNetworkStatus`, + :meth:`updateFromServerDescriptor`, and + :meth:`updateFromExtraInfoDescriptor`. + """ + super(BridgeBackwardsCompatibility, self).__init__() + + self.desc_digest = None + self.ei_digest = None + self.running = False + self.stable = False + + if nickname or ip or orport or fingerprint or id_digest: + self._backwardsCompatible(nickname=nickname, address=ip, + orPort=orport, fingerprint=fingerprint, + idDigest=id_digest, + orAddresses=or_addresses) + + def _backwardsCompatible(self, nickname=None, address=None, orPort=None, + fingerprint=None, idDigest=None, + orAddresses=None): + """Functionality for maintaining backwards compatibility with the older + version of this class (see :class:`bridgedb.test.deprecated.Bridge`). + """ + if nickname: + self.nickname = nickname # XXX check nickname spec conformity? + if address: + self.address = address # XXX check validip? + if orPort: + self.orPort = orPort # XXX check validity? + + if idDigest: + if not fingerprint: + if not len(idDigest) == 20: + raise TypeError("Bridge with invalid ID") + self.fingerprint = toHex(idDigest) + elif fingerprint: + if not isValidFingerprint(fingerprint): + raise TypeError("Bridge with invalid fingerprint (%r)" + % fingerprint) + self.fingerprint = fingerprint.lower() + else: + raise TypeError("Bridge with no ID") + + if orAddresses and isinstance(orAddresses, dict): + for ip, portlist in orAddresses.items(): + validAddress = isIPAddress(ip, compressed=False) + if validAddress: + # The old code expected a `bridgedb.parse.addr.PortList`: + if isinstance(portlist, PortList): + for port in portlist.ports: + self.orAddresses.append( + (validAddress, port, validAddress.version,)) + elif isinstance(portlist, int): + self.orAddresses.append( + (validAddress, portlist, validAddress.version,)) + else: + logging.warn("Can't parse port for ORAddress %r: %r" + % (ip, portlist)) + + def getID(self): + """Get the binary encoded form of this ``Bridge``'s ``fingerprint``. + + This method is provided for backwards compatibility and should not + be relied upon. + """ + if self.fingerprint: + return fromHex(self.fingerprint) + + def setDescriptorDigest(self, digest): + """Set this ``Bridge``'s server-descriptor digest. + + This method is provided for backwards compatibility and should not + be relied upon. + """ + self.desc_digest = digest # old attribute for backwards compat + self.descriptorDigest = digest # new attribute + + def setExtraInfoDigest(self, digest): + """Set this ``Bridge``'s extrainfo digest. + + This method is provided for backwards compatibility and should not + be relied upon. + """ + self.ei_digest = digest # old attribute for backwards compat + self.extrainfoDigest = digest # new attribute + + def setStatus(self, running=None, stable=None): + """Set this ``Bridge``'s "Running" and "Stable" flags. + + This method is provided for backwards compatibility and should not + be relied upon. + """ + if running is not None: + self.running = bool(running) + self.flags.running = bool(running) + if stable is not None: + self.stable = bool(stable) + self.flags.stable = bool(running) + + def getConfigLine(self, includeFingerprint=False, addressClass=None, + request=None, transport=None): + """Get a vanilla bridge line for this ``Bridge``. + + This method is provided for backwards compatibility and should not + be relied upon. + + The old ``bridgedb.Bridges.Bridge.getConfigLine()`` method didn't know + about :class:`~bridgedb.bridgerequest.BridgeRequestBase`s, and so this + modified version is backwards compatible by creating a + :class:`~bridgedb.bridgerequest.BridgeRequestBase` for + :meth:`getBridgeLine`. The default parameters are the same as they + were in the old ``bridgedb.Bridges.Bridge`` class. + + :param bool includeFingerprint: If ``True``, include the + ``fingerprint`` of this :class:`Bridge` in the returned bridge + line. + :type addressClass: :class:`ipaddr.IPv4Address` or + :class:`ipaddr.IPv6Address`. + :param addressClass: Type of address to choose. + :param str request: A string unique to this request e.g. email-address + or ``uniformMap(ip)`` or ``'default'``. In this case, this is not + a :class:`~bridgerequest.BridgeRequestBase` (as might be expected) + but the equivalent of + :data:`bridgerequest.BridgeRequestBase.client`. + :param str transport: A pluggable transport method name. + """ + bridgeRequest = bridgerequest.BridgeRequestBase(addressClass) + bridgeRequest.client = request if request else bridgeRequest.client + bridgeRequest.isValid(True) + + if transport: + bridgeRequest.withPluggableTransportType(transport) + + bridgeRequest.generateFilters() + bridgeLine = self.getBridgeLine(bridgeRequest, includeFingerprint) + return bridgeLine + + +class Bridge(BridgeBackwardsCompatibility): """A single bridge, and all the information we have for it. :type fingerprint: str or None @@ -426,10 +592,7 @@ class Bridge(object): #: created with the ``signing-key`` contained in that descriptor. _checkServerDescriptorSignature = True - def __init__(self, - # for backwards compatibility: - nickname=None, ip=None, orport=None, - fingerprint=None, id_digest=None, or_addresses=None): + def __init__(self, *args, **kwargs): """Create a and store information for a new ``Bridge``. .. info: For backwards compatibility, `nickname`, `ip`, and `orport` @@ -441,6 +604,8 @@ class Bridge(object): :meth:`updateFromServerDescriptor`, and :meth:`updateFromExtraInfoDescriptor`. """ + super(Bridge, self).__init__(*args, **kwargs) + self.fingerprint = None self.nickname = None self.address = None @@ -481,14 +646,6 @@ class Bridge(object): self.descriptorDigest = None self.extrainfoDigest = None - # For backwards compatibility with the old, deprecated version of this - # class: - if nickname or ip or orport or fingerprint or id_digest: - self._backwardsCompatible(nickname=nickname, address=ip, - orPort=orport, fingerprint=fingerprint, - idDigest=id_digest, - orAddresses=or_addresses) - def __str__(self): """Return a pretty string representation that identifies this Bridge. @@ -519,133 +676,6 @@ class Bridge(object): return nickname + separator + fingerprint - def _backwardsCompatible(self, nickname=None, address=None, orPort=None, - fingerprint=None, idDigest=None, - orAddresses=None): - """Functionality for maintaining backwards compatibility with the older - version of this class (see :class:`bridgedb.test.deprecated.Bridge`). - """ - def getID(): - """Get the binary encoded form of this ``Bridge``'s ``fingerprint``. - - This method is provided for backwards compatibility and should not - be relied upon. - """ - if self.fingerprint: - return fromHex(self.fingerprint) - self.getID = getID - - def setDescriptorDigest(digest): - """Set this ``Bridge``'s server-descriptor digest. - - This method is provided for backwards compatibility and should not - be relied upon. - """ - self.desc_digest = digest # old attribute for backwards compat - self.descriptorDigest = digest # new attribute - self.desc_digest = None - self.setDescriptorDigest = setDescriptorDigest - - def setExtraInfoDigest(digest): - """Set this ``Bridge``'s extrainfo digest. - - This method is provided for backwards compatibility and should not - be relied upon. - """ - self.ei_digest = digest # old attribute for backwards compat - self.extrainfoDigest = digest # new attribute - self.ei_digest = None - self.setExtraInfoDigest = setExtraInfoDigest - - def setStatus(running=None, stable=None): - """Set this ``Bridge``'s "Running" and "Stable" flags. - - This method is provided for backwards compatibility and should not - be relied upon. - """ - if running is not None: - self.running = bool(running) - self.flags.running = bool(running) - if stable is not None: - self.stable = bool(stable) - self.flags.stable = bool(running) - self.running = False - self.stable = False - self.setStatus = setStatus - - def getConfigLine(includeFingerprint=False, addressClass=None, - request=None, transport=None): - """Get a vanilla bridge line for this ``Bridge``. - - This method is provided for backwards compatibility and should not - be relied upon. - - The old ``bridgedb.Bridges.Bridge.getConfigLine()`` method didn't - know about :class:`~bridgedb.bridgerequest.BridgeRequestBase`s, - and so this modified version is backwards compatible by creating a - :class:`~bridgedb.bridgerequest.BridgeRequestBase` for - :meth:`getBridgeLine`. The default parameters are the same as they - were in the old ``bridgedb.Bridges.Bridge`` class. - - :param bool includeFingerprint: If ``True``, include the - ``fingerprint`` of this :class:`Bridge` in the returned bridge - line. - :type addressClass: :class:`ipaddr.IPv4Address` or - :class:`ipaddr.IPv6Address`. - :param addressClass: Type of address to choose. - :param str request: A string unique to this request - e.g. email-address or ``uniformMap(ip)`` or ``'default'``. In - this case, this is not a - :class:`~bridgerequest.BridgeRequestBase` (as might be - expected) but the equivalent of - :data:`bridgerequest.BridgeRequestBase.client`. - :param str transport: A pluggable transport method name. - """ - bridgeRequest = bridgerequest.BridgeRequestBase(addressClass) - bridgeRequest.client = request if request else bridgeRequest.client - bridgeRequest.isValid(True) - - if transport: - bridgeRequest.withPluggableTransportType(transport) - - bridgeRequest.generateFilters() - bridgeLine = self.getBridgeLine(bridgeRequest, includeFingerprint) - return bridgeLine - self.getConfigLine = getConfigLine - - if nickname: - self.nickname = nickname # XXX check nickname spec conformity? - if address: - self.address = address # XXX check validip? - if orPort: - self.orPort = orPort # XXX check validity? - - if idDigest: - if not fingerprint: - if not len(idDigest) == 20: - raise TypeError("Bridge with invalid ID") - self.fingerprint = toHex(idDigest) - elif fingerprint: - if not isValidFingerprint(fingerprint): - raise TypeError("Bridge with invalid fingerprint (%r)" - % fingerprint) - self.fingerprint = fingerprint.lower() - else: - raise TypeError("Bridge with no ID") - - if orAddresses and isinstance(orAddresses, dict): - for ip, portlist in orAddresses.items(): - validAddress = isIPAddress(ip, compressed=False) - if validAddress: - # The old code expected a `bridgedb.parse.addr.PortList`: - if isinstance(portlist, PortList): - for port in portlist.ports: - self.orAddresses.append( - (validAddress, port, validAddress.version,)) - else: - self.orAddresses.append( - (validAddress, port, validAddress.version)) - def _checkServerDescriptor(self, descriptor): # If we're parsing the server-descriptor, require a networkstatus # document:

1 0

[bridgedb/develop] Rename b.p.d.parseBridgeExtraInfoFiles() → b.p.d.parseExtraInfoFiles().
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit 165ebecd83e33f0cdaa7adb645c2596e74cff092 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 10 23:22:26 2014 +0000 Rename b.p.d.parseBridgeExtraInfoFiles() → b.p.d.parseExtraInfoFiles(). --- lib/bridgedb/parse/descriptors.py | 2 +- lib/bridgedb/test/deprecated.py | 2 +- lib/bridgedb/test/test_parse_descriptors.py | 76 +++++++++++++-------------- 3 files changed, 40 insertions(+), 40 deletions(-) diff --git a/lib/bridgedb/parse/descriptors.py b/lib/bridgedb/parse/descriptors.py index 66a34b9..ee0cea8 100644 --- a/lib/bridgedb/parse/descriptors.py +++ b/lib/bridgedb/parse/descriptors.py @@ -204,7 +204,7 @@ def deduplicate(descriptors): return nonDuplicates -def parseBridgeExtraInfoFiles(*filenames, **kwargs): +def parseExtraInfoFiles(*filenames, **kwargs): """Parse files which contain ``@type bridge-extrainfo-descriptor``s. .. warning:: This function will *not* check that the ``router-signature`` diff --git a/lib/bridgedb/test/deprecated.py b/lib/bridgedb/test/deprecated.py index 6c7c3f1..0cf01fb 100644 --- a/lib/bridgedb/test/deprecated.py +++ b/lib/bridgedb/test/deprecated.py @@ -111,7 +111,7 @@ def is_valid_fingerprint(fp): return True @deprecate.deprecated(Version('bridgedb', 0, 2, 4), - replacement='bridgedb.parse.descriptors.parseBridgeExtraInfoFiles') + replacement='bridgedb.parse.descriptors.parseExtraInfoFiles') def parseExtraInfoFile(f): """ parses lines in Bridges extra-info documents. diff --git a/lib/bridgedb/test/test_parse_descriptors.py b/lib/bridgedb/test/test_parse_descriptors.py index d867768..47685af 100644 --- a/lib/bridgedb/test/test_parse_descriptors.py +++ b/lib/bridgedb/test/test_parse_descriptors.py @@ -308,29 +308,29 @@ class ParseDescriptorsTests(unittest.TestCase): descriptors.parseNetworkStatusFile, descFile, skipAnnotations=False) - def test_parse_descriptors_parseBridgeExtraInfoFiles_return_type(self): - """The return type of ``b.p.descriptors.parseBridgeExtraInfoFiles`` + def test_parse_descriptors_parseExtraInfoFiles_return_type(self): + """The return type of ``b.p.descriptors.parseExtraInfoFiles`` should be a dictionary (after deduplication). """ descFile = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) - routers = descriptors.parseBridgeExtraInfoFiles(descFile) + routers = descriptors.parseExtraInfoFiles(descFile) self.assertIsInstance(routers, dict) - def test_parse_descriptors_parseBridgeExtraInfoFiles_has_BridgeExtraInfoDescriptor(self): - """The return of ``b.p.descriptors.parseBridgeExtraInfoFiles`` should + def test_parse_descriptors_parseExtraInfoFiles_has_BridgeExtraInfoDescriptor(self): + """The return of ``b.p.descriptors.parseExtraInfoFiles`` should contain ``BridgeExtraInfoDescriptor``s. """ descFile = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) - routers = descriptors.parseBridgeExtraInfoFiles(descFile) + routers = descriptors.parseExtraInfoFiles(descFile) bridge = routers.values()[0] self.assertIsInstance(bridge, RelayExtraInfoDescriptor) - def test_parse_descriptors_parseBridgeExtraInfoFiles_one_file(self): - """Test for ``b.p.descriptors.parseBridgeExtraInfoFiles`` with only one + def test_parse_descriptors_parseExtraInfoFiles_one_file(self): + """Test for ``b.p.descriptors.parseExtraInfoFiles`` with only one bridge extrainfo file. """ descFile = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) - routers = descriptors.parseBridgeExtraInfoFiles(descFile) + routers = descriptors.parseExtraInfoFiles(descFile) bridge = routers.values()[0] # The number of transports we parsed should be equal to the number of @@ -347,17 +347,17 @@ class ParseDescriptorsTests(unittest.TestCase): descFileOne = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) descFileTwo = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) self.assertRaises(descriptors.DescriptorWarning, - descriptors.parseBridgeExtraInfoFiles, + descriptors.parseExtraInfoFiles, descFileOne, descFileTwo) - def test_parse_descriptors_parseBridgeExtraInfoFiles_two_files(self): - """Test for ``b.p.descriptors.parseBridgeExtraInfoFiles`` with two + def test_parse_descriptors_parseExtraInfoFiles_two_files(self): + """Test for ``b.p.descriptors.parseExtraInfoFiles`` with two bridge extrainfo files, and check that only the newest extrainfo descriptor is used. """ descFileOne = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) descFileTwo = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR_NEWER_DUPLICATE) - routers = descriptors.parseBridgeExtraInfoFiles(descFileOne, descFileTwo) + routers = descriptors.parseExtraInfoFiles(descFileOne, descFileTwo) # We shouldn't have duplicates: self.assertEqual(len(routers), 1, @@ -370,15 +370,15 @@ class ParseDescriptorsTests(unittest.TestCase): datetime.datetime.strptime("2014-11-04 08:10:25", "%Y-%m-%d %H:%M:%S"), "We should have the newest available descriptor for this router.") - def test_parse_descriptors_parseBridgeExtraInfoFiles_two_files_reverse(self): - """Test for ``b.p.descriptors.parseBridgeExtraInfoFiles`` with two bridge + def test_parse_descriptors_parseExtraInfoFiles_two_files_reverse(self): + """Test for ``b.p.descriptors.parseExtraInfoFiles`` with two bridge extrainfo files. This time, they are processed in reverse to ensure that we only keep the newer duplicates of descriptors, no matter what order they appeared in the files. """ descFileOne = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR_NEWER_DUPLICATE) descFileTwo = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) - routers = descriptors.parseBridgeExtraInfoFiles(descFileOne, descFileTwo) + routers = descriptors.parseExtraInfoFiles(descFileOne, descFileTwo) self.assertEqual(len(routers), 1, "We shouldn't have any duplicate descriptors.") @@ -389,17 +389,17 @@ class ParseDescriptorsTests(unittest.TestCase): datetime.datetime.strptime("2014-11-04 08:10:25", "%Y-%m-%d %H:%M:%S"), "We should have the newest available descriptor for this router.") - def test_parse_descriptors_parseBridgeExtraInfoFiles_three_files(self): - """Test for ``b.p.descriptors.parseBridgeExtraInfoFiles`` with three + def test_parse_descriptors_parseExtraInfoFiles_three_files(self): + """Test for ``b.p.descriptors.parseExtraInfoFiles`` with three bridge extrainfo files, and check that only the newest extrainfo descriptor is used. """ descFileOne = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR_NEWER_DUPLICATE) descFileTwo = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) descFileThree = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR_NEWEST_DUPLICATE) - routers = descriptors.parseBridgeExtraInfoFiles(descFileOne, - descFileTwo, - descFileThree) + routers = descriptors.parseExtraInfoFiles(descFileOne, + descFileTwo, + descFileThree) # We shouldn't have duplicates: self.assertEqual(len(routers), 1, @@ -412,16 +412,16 @@ class ParseDescriptorsTests(unittest.TestCase): datetime.datetime.strptime("2014-12-04 03:10:25", "%Y-%m-%d %H:%M:%S"), "We should have the newest available descriptor for this router.") - def test_parse_descriptors_parseBridgeExtraInfoFiles_no_validate(self): - """Test for ``b.p.descriptors.parseBridgeExtraInfoFiles`` with + def test_parse_descriptors_parseExtraInfoFiles_no_validate(self): + """Test for ``b.p.descriptors.parseExtraInfoFiles`` with descriptor validation disabled. """ descFileOne = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR) - routers = descriptors.parseBridgeExtraInfoFiles(descFileOne, - validate=False) + routers = descriptors.parseExtraInfoFiles(descFileOne, + validate=False) self.assertGreaterEqual(len(routers), 1) - def test_parse_descriptosrs_parseBridgeExtraInfoFiles_unparseable(self): + def test_parse_descriptors_parseExtraInfoFiles_unparseable(self): """Test parsing three extrainfo descriptors: one is a valid descriptor, one is an older duplicate, and one is unparseable (it has a bad geoip-db-digest line). There should be only one descriptor returned @@ -441,9 +441,9 @@ class ParseDescriptorsTests(unittest.TestCase): # '_io.BytesIO' object has no attribute 'rpartition'" descFileThree = self.writeTestDescriptorsToFile( "unparseable-descriptor", unparseable) - routers = descriptors.parseBridgeExtraInfoFiles(descFileOne, - descFileTwo, - descFileThree) + routers = descriptors.parseExtraInfoFiles(descFileOne, + descFileTwo, + descFileThree) self.assertIsInstance(routers, dict) self.assertEqual(len(routers), 1, ( "There were three extrainfo descriptors: one was a duplicate, " @@ -461,7 +461,7 @@ class ParseDescriptorsTests(unittest.TestCase): datetime.datetime.strptime("2014-12-04 03:10:25", "%Y-%m-%d %H:%M:%S"), "We should have the newest available descriptor for this router.") - def test_parse_descriptosrs_parseBridgeExtraInfoFiles_unparseable_and_parseable(self): + def test_parse_descriptors_parseExtraInfoFiles_unparseable_and_parseable(self): """Test parsing four extrainfo descriptors: two are valid descriptors, one is an older duplicate of one of the valid descriptors, and one is unparseable (it has a line we shouldn't recognise). There should be @@ -486,10 +486,10 @@ class ParseDescriptorsTests(unittest.TestCase): descFileThree = self.writeTestDescriptorsToFile( "unparseable-descriptor.new", unparseable) descFileFour = io.BytesIO(parseable) - routers = descriptors.parseBridgeExtraInfoFiles(descFileOne, - descFileTwo, - descFileThree, - descFileFour) + routers = descriptors.parseExtraInfoFiles(descFileOne, + descFileTwo, + descFileThree, + descFileFour) self.assertIsInstance(routers, dict) self.assertEqual(len(routers), 2, ( "There were four extrainfo descriptors: one was a duplicate, " @@ -510,7 +510,7 @@ class ParseDescriptorsTests(unittest.TestCase): self.assertIn("2B5DA67FBA13A6449DE625673B7AE9E3AA7DF75F", routers.keys(), "The 'parseable' descriptor wasn't returned by the parser.") - def test_parse_descriptosrs_parseBridgeExtraInfoFiles_unparseable_BytesIO(self): + def test_parse_descriptors_parseExtraInfoFiles_unparseable_BytesIO(self): """Test parsing three extrainfo descriptors: one is a valid descriptor, one is an older duplicate, and one is unparseable (it has a bad geoip-db-digest line). The parsing should raise an unhandled @@ -528,12 +528,12 @@ class ParseDescriptorsTests(unittest.TestCase): descFileTwo = io.BytesIO(BRIDGE_EXTRA_INFO_DESCRIPTOR_NEWEST_DUPLICATE) descFileThree = io.BytesIO(unparseable) self.assertRaises(AttributeError, - descriptors.parseBridgeExtraInfoFiles, + descriptors.parseExtraInfoFiles, descFileOne, descFileTwo, descFileThree) - def test_parse_descriptosrs_parseBridgeExtraInfoFiles_empty_file(self): + def test_parse_descriptors_parseExtraInfoFiles_empty_file(self): """Test parsing an empty extrainfo descriptors file.""" - routers = descriptors.parseBridgeExtraInfoFiles(io.BytesIO('')) + routers = descriptors.parseExtraInfoFiles(io.BytesIO('')) self.assertIsInstance(routers, dict) self.assertEqual(len(routers), 0)

1 0

[bridgedb/develop] Change Bridge.fingerprint into a @property.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit e07d97ad594a59522f29291fbfbd5c915ed76b4c Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 03:52:02 2014 +0000 Change Bridge.fingerprint into a @property. --- lib/bridgedb/bridges.py | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/bridges.py b/lib/bridgedb/bridges.py index 48dc33a..892872f 100644 --- a/lib/bridgedb/bridges.py +++ b/lib/bridgedb/bridges.py @@ -385,7 +385,7 @@ class BridgeBase(object): """The base class for all bridge implementations.""" def __init__(self): - self.fingerprint = None + self._fingerprint = None self.nickname = None self.address = None self.orPort = None @@ -394,6 +394,35 @@ class BridgeBase(object): self.orAddresses = [] self.transports = [] self.flags = Flags() + + @property + def fingerprint(self): + """Get this Bridge's fingerprint. + + :rtype: str + :returns: A 40-character hexadecimal formatted string representation + of the SHA-1 hash digest of the public half of this Bridge's + identity key. + """ + return self._fingerprint + + @fingerprint.setter + def fingerprint(self, value): + """Set this Bridge's fingerprint to **value**. + + .. info: The purported fingerprint will be checked for specification + conformity with + :func:`~bridgedb.parse.fingerprint.isValidFingerprint`. + + :param str value: The fingerprint for this Bridge. + """ + if isValidFingerprint(value): + self._fingerprint = value + + @fingerprint.deleter + def fingerprint(self): + """Reset this Bridge's fingerprint.""" + self._fingerprint = None class BridgeBackwardsCompatibility(BridgeBase):

1 0

[bridgedb/develop] Move isValidRouterNickname to its own module.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit b1a9f792909e6def9abdc707f27a85854010ec9e Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 04:25:08 2014 +0000 Move isValidRouterNickname to its own module. --- lib/bridgedb/parse/networkstatus.py | 19 -------------- lib/bridgedb/parse/nickname.py | 48 +++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 19 deletions(-) diff --git a/lib/bridgedb/parse/networkstatus.py b/lib/bridgedb/parse/networkstatus.py index 8592cd3..106edd9 100644 --- a/lib/bridgedb/parse/networkstatus.py +++ b/lib/bridgedb/parse/networkstatus.py @@ -47,25 +47,6 @@ class NetworkstatusParsingError(Exception): class InvalidNetworkstatusRouterIdentity(ValueError): """The ID field of a networkstatus document 'r'-line is invalid.""" -class InvalidRouterNickname(ValueError): - """Router nickname doesn't follow tor-spec.""" - - -def isValidRouterNickname(nickname): - """Determine if a router's given nickname meets the specification. - - :param string nickname: An OR's nickname. - """ - ALPHANUMERIC = string.letters + string.digits - - if not (1 <= len(nickname) <= 19): - raise InvalidRouterNickname( - "Nicknames must be between 1 and 19 characters: %r" % nickname) - for letter in nickname: - if not letter in ALPHANUMERIC: - raise InvalidRouterNickname( - "Nicknames must only use [A-Za-z0-9]: %r" % nickname) - return True def parseRLine(line): """Parse an 'r'-line from a networkstatus document. diff --git a/lib/bridgedb/parse/nickname.py b/lib/bridgedb/parse/nickname.py new file mode 100644 index 0000000..b38bdb8 --- /dev/null +++ b/lib/bridgedb/parse/nickname.py @@ -0,0 +1,48 @@ +# -*- coding: utf-8 -*- +# +# 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) 2013 Isis Lovecruft +# (c) 2007-2014, The Tor Project, Inc. +# (c) 2007-2014, all entities within the AUTHORS file +# :license: 3-clause BSD, see included LICENSE for information + +"""Parsers for bridge nicknames. + +.. py:module:: bridgedb.parse.nickname + :synopsis: Parsers for Tor bridge nicknames. + +bridgedb.parse.nicknames +======================== +:: + + nicknames + |_ isValidRouterNickname - Determine if a nickname is according to spec +.. +""" + +import string + + +class InvalidRouterNickname(ValueError): + """Router nickname doesn't follow tor-spec.""" + + +def isValidRouterNickname(nickname): + """Determine if a router's given nickname meets the specification. + + :raises InvalidRouterNickname: if the nickname is invalid. + :param string nickname: An OR's nickname. + """ + ALPHANUMERIC = string.letters + string.digits + + if not (1 <= len(nickname) <= 19): + raise InvalidRouterNickname( + "Nicknames must be between 1 and 19 characters: %r" % nickname) + for letter in nickname: + if not letter in ALPHANUMERIC: + raise InvalidRouterNickname( + "Nicknames must only use [A-Za-z0-9]: %r" % nickname) + return True

1 0

[bridgedb/develop] Fix typo in Bridge.bandwidthObserved attribute name.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit abf0d2397220d93510a862396693f5afeb5c7262 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 03:49:06 2014 +0000 Fix typo in Bridge.bandwidthObserved attribute name. --- lib/bridgedb/bridges.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/bridges.py b/lib/bridgedb/bridges.py index fae5d19..899a091 100644 --- a/lib/bridgedb/bridges.py +++ b/lib/bridgedb/bridges.py @@ -621,7 +621,7 @@ class Bridge(BridgeBackwardsCompatibility): self.bandwidth = None self.bandwidthAverage = None self.bandwidthBurst = None - self.bandwidthObserverd = None + self.bandwidthObserved = None self.contact = None self.family = None

1 0

[bridgedb/develop] Add docstring for parameter to Bridge.updateFromServerDescriptor().
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit 910f749410e58960228b878bf45c2d775b9180cb Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 03:55:10 2014 +0000 Add docstring for parameter to Bridge.updateFromServerDescriptor(). --- lib/bridgedb/bridges.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/bridges.py b/lib/bridgedb/bridges.py index 4ae54c6..ec5aefe 100644 --- a/lib/bridgedb/bridges.py +++ b/lib/bridgedb/bridges.py @@ -1220,7 +1220,7 @@ class Bridge(BridgeBackwardsCompatibility): :type descriptor: :api:`stem.descriptor.server_descriptor.RelayDescriptor` - :param descriptor: + :param descriptor: The bridge's server descriptor to gather data from. :raises MalformedBridgeInfo: If this Bridge has no corresponding networkstatus entry, or its **descriptor** digest didn't match the expected digest (from the networkstatus entry).

1 0

[bridgedb/develop] Fix the names of five unittests in test_parse_descriptors.py.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit f3d08e3aec1cf85a688d8d023bbca31213380db5 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 10 23:27:44 2014 +0000 Fix the names of five unittests in test_parse_descriptors.py. The function is called `parseNetworkStatusFile()`, not `parseBridgeNetworkStatusFile()`. * CHANGE test_parse_descriptors_parseBridgeNetworkStatusFile_*() to test_parse_descriptors_parseNetworkStatusFile_*() in lib/bridgedb/test/test_parse_descriptors.py. --- lib/bridgedb/test/test_parse_descriptors.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lib/bridgedb/test/test_parse_descriptors.py b/lib/bridgedb/test/test_parse_descriptors.py index 38bbf99..738360f 100644 --- a/lib/bridgedb/test/test_parse_descriptors.py +++ b/lib/bridgedb/test/test_parse_descriptors.py @@ -218,7 +218,7 @@ class ParseDescriptorsTests(unittest.TestCase): self.assertEqual(bridge.address, self.expectedIPBridge0) self.assertEqual(bridge.fingerprint, self.expectedFprBridge0) - def test_parse_descriptors_parseBridgeNetworkStatusFile_return_type(self): + def test_parse_descriptors_parseNetworkStatusFile_return_type(self): """``b.p.descriptors.parseNetworkStatusFile`` should return a dict.""" # Write the descriptor to a file for testing. This is necessary # because the function opens the networkstatus file to read it. @@ -227,7 +227,7 @@ class ParseDescriptorsTests(unittest.TestCase): routers = descriptors.parseNetworkStatusFile(descFile) self.assertIsInstance(routers, list) - def test_parse_descriptors_parseBridgeNetworkStatusFile_has_RouterStatusEntryV2(self): + def test_parse_descriptors_parseNetworkStatusFile_has_RouterStatusEntryV2(self): """The items in the dict returned from ``b.p.descriptors.parseNetworkStatusFile`` should be ``RouterStatusEntryV2``s. @@ -240,7 +240,7 @@ class ParseDescriptorsTests(unittest.TestCase): bridge = routers[0] self.assertIsInstance(bridge, RouterStatusEntryV3) - def test_parse_descriptors_parseBridgeNetworkStatusFile_one_file(self): + def test_parse_descriptors_parseNetworkStatusFile_one_file(self): """Test ``b.p.descriptors.parseNetworkStatusFile`` with one bridge networkstatus descriptor. """ @@ -253,7 +253,7 @@ class ParseDescriptorsTests(unittest.TestCase): self.assertEqual(bridge.address, self.expectedIPBridge0) self.assertEqual(bridge.fingerprint, self.expectedFprBridge0) - def test_parse_descriptors_parseBridgeNetworkStatusFile_two_files(self): + def test_parse_descriptors_parseNetworkStatusFile_two_files(self): """Test ``b.p.descriptors.parseNetworkStatusFile`` with two bridge networkstatus descriptors. """ @@ -270,7 +270,7 @@ class ParseDescriptorsTests(unittest.TestCase): self.assertIn(bridge.address, expectedIPs) self.assertEqual(bridge.fingerprint, self.expectedFprBridge0) - def test_parse_descriptors_parseBridgeNetworkStatusFile_with_annotations(self): + def test_parse_descriptors_parseNetworkStatusFile_with_annotations(self): """Test ``b.p.descriptors.parseNetworkStatusFile`` with some document headers before the first 'r'-line. """ @@ -289,7 +289,7 @@ class ParseDescriptorsTests(unittest.TestCase): self.assertIn(bridge.address, expectedIPs) self.assertEqual(bridge.fingerprint, self.expectedFprBridge0) - def test_parse_descriptors_parseBridgeNetworkStatusFile_with_annotations_no_skipping(self): + def test_parse_descriptors_parseNetworkStatusFile_with_annotations_no_skipping(self): """Test ``b.p.descriptors.parseNetworkStatusFile`` with some document headers before the first 'r'-line, but without skipping said annotations.

1 0

[bridgedb/develop] Fix two typos in attribute names of Stem's descriptors.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit 6205c5b62775899dfefd36861d01a7ca982209ed Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 03:52:26 2014 +0000 Fix two typos in attribute names of Stem's descriptors. --- lib/bridgedb/bridges.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/bridges.py b/lib/bridgedb/bridges.py index 892872f..5498758 100644 --- a/lib/bridgedb/bridges.py +++ b/lib/bridgedb/bridges.py @@ -1192,7 +1192,7 @@ class Bridge(BridgeBackwardsCompatibility): # These fields are *only* found in the networkstatus document: self.descriptorDigest = descriptor.digest self.flags.update(descriptor.flags) - self.bandwidth = descriptor.bandwith + self.bandwidth = descriptor.bandwidth # These fields are also found in the server-descriptor. We will prefer # to use the information taken later from the server-descriptor @@ -1246,7 +1246,7 @@ class Bridge(BridgeBackwardsCompatibility): self.bandwidthAverage = descriptor.average_bandwidth self.bandwidthBurst = descriptor.burst_bandwidth - self.bandwidthObserved = descriptor.bandwidth_observed + self.bandwidthObserved = descriptor.observed_bandwidth self.contact = descriptor.contact self.family = descriptor.family

1 0

[bridgedb/develop] Add MissingServerDescriptorDigest exception class.
by isis＠torproject.org 19 Feb '15

19 Feb '15

commit 2d5d42dbcd04498435eae99f9682295ac354d706 Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 11 03:43:44 2014 +0000 Add MissingServerDescriptorDigest exception class. --- lib/bridgedb/bridges.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/bridgedb/bridges.py b/lib/bridgedb/bridges.py index 6268f6d..459e86a 100644 --- a/lib/bridgedb/bridges.py +++ b/lib/bridgedb/bridges.py @@ -52,6 +52,12 @@ class MalformedPluggableTransport(MalformedBridgeInfo): class InvalidPluggableTransportIP(MalformedBridgeInfo): """Raised when a :class:`PluggableTransport` has an invalid address.""" +class MissingServerDescriptorDigest(MalformedBridgeInfo): + """Raised when the hash digest for an ``@type bridge-server-descriptor`` + (which should be in the corresponding ``@type bridge-networkstatus`` + document), was missing. + """ + class ServerDescriptorDigestMismatch(MalformedBridgeInfo): """Raised when the digest in an ``@type bridge-networkstatus`` document doesn't match the hash digest of the ``@type bridge-server-descriptor``'s

1 0