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

[bridgedb/master] Minor PEP8 whitespace fix in bridgedb.Bridges.BridgeRing.getBridges().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit db5a0d28c9706df57c9e6cdcbd04a200f38ee87c Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Jan 12 01:20:36 2014 +0000 Minor PEP8 whitespace fix in bridgedb.Bridges.BridgeRing.getBridges(). --- 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 2d9dd11..39148a5 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -857,7 +857,7 @@ class BridgeRing(BridgeHolder): :returns: A list of :class:`~bridgedb.Bridges.Bridge`s. """ forced = [] - for _,_,count,subring in self.subrings: + for _, _, count, subring in self.subrings: if len(subring) < count: count = len(subring) forced.extend(subring._getBridgeKeysAt(pos, count))

1 0

[bridgedb/master] Add docstring for bridgedb.Bridges.BridgeRing.getBridges().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 8fe58e53919f778e099857ad52815f37a183a023 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Jan 12 01:19:50 2014 +0000 Add docstring for bridgedb.Bridges.BridgeRing.getBridges(). --- lib/bridgedb/Bridges.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 504d33b..2d9dd11 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -843,7 +843,19 @@ class BridgeRing(BridgeHolder): return r def getBridges(self, pos, N=1, countryCode=None): - """Return the N bridges appearing in the ring after position pos""" + """Return **N** bridges appearing in this hashring after a position. + + :param bytes pos: The position to jump to. Any bridges returned will + start at this position in the hashring, if there is + a bridge assigned to that position. Otherwise, + indexing will start at the first position after this + one which has a bridge assigned to it. + :param int N: The number of bridges to return. + :type countryCode: str or None + :param countryCode: DOCDOC + :rtype: list + :returns: A list of :class:`~bridgedb.Bridges.Bridge`s. + """ forced = [] for _,_,count,subring in self.subrings: if len(subring) < count:

1 0

[bridgedb/master] Update/add docstrings for bridgedb.Bridges.FilteredBridgeSplitter.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 5c646aa195364ad9d410979057d6a6879aa7d17e Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Jan 12 01:23:24 2014 +0000 Update/add docstrings for bridgedb.Bridges.FilteredBridgeSplitter. --- lib/bridgedb/Bridges.py | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 39148a5..dd0a7a9 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -1055,13 +1055,32 @@ class BridgeSplitter(BridgeHolder): ring.dumpAssignments(f, "%s %s" % (description, name)) class FilteredBridgeSplitter(BridgeHolder): - """ A configurable BridgeHolder that filters bridges - into subrings. - The set of subrings and conditions used to assign Bridges - are passed to the constructor as a list of (filterFn, ringName) + """A configurable BridgeHolder that filters bridges into subrings. + + The set of subrings and conditions used to assign :class:`Bridge`s should + be passed to :meth:`~FilteredBridgeSplitter.addRing`. """ def __init__(self, key, max_cached_rings=3): + """Create a hashring which filters bridges into sub hashrings. + + :type key: DOCDOC + :param key: An HMAC key. + :param int max_cached_rings: XXX max_cached_rings appears to not be + used anywhere. + + :ivar filterRings: A dictionary of subrings which has the form + ``{ringname: (filterFn, subring)}``, where: + - ``ringname`` is a unique string identifying the subring. + - ``filterFn`` is a callable which filters Bridges in some + manner, i.e. by whether they are IPv4 or IPv6, etc. + - ``subring`` is a :class:`BridgeHolder`. + :ivar hmac: DOCDOC + :ivar bridges: DOCDOC + :type distributorName: str + :ivar distributorName: The name of this splitter's distributor. See + :meth:`bridgedb.Dist.IPBasedDistributor.setDistributorName`. + """ self.key = key self.filterRings = {} self.hmac = get_hmac_fn(key, hex=True)

1 0

[bridgedb/master] Separate HTML response generation logic out of getBridgeRequestAnswer().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 7de5929d5a9995ebd73580d9dc302065168f09b3 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Jan 12 01:32:29 2014 +0000 Separate HTML response generation logic out of getBridgeRequestAnswer(). * MOVE logic for generating HTML responses out of bridgedb.HTTPServer.WebResource.getBridgeRequestAnswer() and into a new method, bridgedb.HTTPServer.WebResource.renderAnswer(). This allows other methods to generate responses, even if the request was malformed. --- lib/bridgedb/HTTPServer.py | 45 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/lib/bridgedb/HTTPServer.py b/lib/bridgedb/HTTPServer.py index 8083bf1..856a753 100644 --- a/lib/bridgedb/HTTPServer.py +++ b/lib/bridgedb/HTTPServer.py @@ -160,6 +160,8 @@ class WebResource(twisted.web.resource.Resource): :type request: :api:`twisted.web.http.Request` :param request: A ``Request`` object containing the HTTP method, full URI, and any URL/POST arguments and headers present. + :rtype: str + :returns: A plaintext or HTML response to serve. """ interval = self.schedule.getInterval(time.time()) bridges = ( ) @@ -177,9 +179,12 @@ class WebResource(twisted.web.resource.Resource): if geoip: countryCode = geoip.country_code_by_addr(ip) + if countryCode: + logging.debug("Client request from GeoIP CC: %s" % countryCode) - # set locale rtl = usingRTLLang(request) + if rtl: + logging.debug("Rendering RTL response.") format = request.args.get("format", None) if format and len(format): format = format[0] # choose the first arg @@ -203,7 +208,11 @@ class WebResource(twisted.web.resource.Resource): except (TypeError, IndexError, AttributeError): unblocked = False + logging.info("Replying to web request from %s. Parameters were %r" + % (Util.logSafely(ip), request.args)) + rules = [] + bridges = None if ip: if ipv6: @@ -228,8 +237,35 @@ class WebResource(twisted.web.resource.Resource): countryCode, bridgeFilterRules=rules) + answer = self.renderAnswer(request, ip, bridges, rtl, format) + return answer + + def renderAnswer(self, request, ip=None, bridges=None, + rtl=False, format=None): + """Generate a response for a client which includes **bridges**. + + The generated response can be plaintext or HTML. + + :type request: :api:`twisted.web.http.Request` + :param request: A ``Request`` object containing the HTTP method, full + URI, and any URL/POST arguments and headers present. + :type ip: str or None + :param ip: The IP address of the client we're responding to. + :type bridges: list or None + :param bridges: A list of :class:`~bridgedb.Bridges.Bridge`s. + :param bool rtl: If ``True``, the language used for the response to + the client should be rendered right-to-left. + :type format: str or None + :param format: If ``'plain'``, return a plaintext response. Otherwise, + use the :file:`bridgedb/templates/bridges.html` + template to render an HTML response page which includes + the **bridges**. + :rtype: str + :returns: A plaintext or HTML response to serve. + """ answer = None - if bridges: + + if bridges and ip: answer = "".join(" %s\n" % b.getConfigLine( includeFingerprint=self.includeFingerprints, addressClass=addressClass, @@ -237,14 +273,13 @@ class WebResource(twisted.web.resource.Resource): request=bridgedb.Dist.uniformMap(ip) ) for b in bridges) - logging.info("Replying to web request from %s. Parameters were %r", - Util.logSafely(ip), request.args) if format == 'plain': request.setHeader("Content-Type", "text/plain") return answer else: request.setHeader("Content-Type", "text/html; charset=utf-8") - return lookup.get_template('bridges.html').render(answer=answer, rtl=rtl) + return lookup.get_template('bridges.html').render(answer=answer, + rtl=rtl) class WebRoot(twisted.web.resource.Resource): isLeaf = True

1 0

[bridgedb/master] Add unittests for bridgedb.parse.networkstatus.parseSLine().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit a1536800674ac587d22d0a6e4de9af053e5958cd Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Dec 7 12:55:34 2013 +0000 Add unittests for bridgedb.parse.networkstatus.parseSLine(). --- lib/bridgedb/test/test_parse_networkstatus.py | 28 +++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/lib/bridgedb/test/test_parse_networkstatus.py b/lib/bridgedb/test/test_parse_networkstatus.py index 31fb1e2..bbae59c 100644 --- a/lib/bridgedb/test/test_parse_networkstatus.py +++ b/lib/bridgedb/test/test_parse_networkstatus.py @@ -320,3 +320,31 @@ class ParseNetworkStatusALineTests(unittest.TestCase): this(ip).should.be.a(basestring) this(port).should.be.ok this(port).should.be.a(networkstatus.addr.PortList) + + +class ParseNetworkStatusSLineTests(unittest.TestCase): + """Tests for :func:`bridgedb.parse.networkstatus.parseSLine`.""" + + def tearDown(self): + """Automatically called after each test_* method to run cleanups.""" + self.line = '' + + def test_missingPrefix(self): + self.line = 'Stable' + running, stable = networkstatus.parseSLine(self.line) + self.assertFalse(running) + self.assertFalse(stable) + + def test_makeBelieveFlag(self): + """Test that 's'-parser should ignore a 'MakeBelieve' flag.""" + self.line = 's Stable Running MakeBelieve BadExit' + running, stable = networkstatus.parseSLine(self.line) + self.assertTrue(running) + self.assertTrue(stable) + + def test_noFlags(self): + """Test that an 's'-line with no flags returns False for everything.""" + self.line = '' + running, stable = networkstatus.parseSLine(self.line) + self.assertFalse(running) + self.assertFalse(stable)

1 0

[bridgedb/master] Add class variable docs to ParseNetworkstatusRLineTests unittests.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 504ee1d9fc45e268ba2c51f3873c60b8ce806fd6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Dec 8 00:11:58 2013 +0000 Add class variable docs to ParseNetworkstatusRLineTests unittests. * ADD documentation on default variables and how the unittest setup methods are used. --- lib/bridgedb/test/test_parse_networkstatus.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/test/test_parse_networkstatus.py b/lib/bridgedb/test/test_parse_networkstatus.py index bbae59c..b34b5a5 100644 --- a/lib/bridgedb/test/test_parse_networkstatus.py +++ b/lib/bridgedb/test/test_parse_networkstatus.py @@ -37,15 +37,33 @@ networkstatus.logging.basicConfig( class ParseNetworkStatusRLineTests(unittest.TestCase): - """Tests for :func:`bridgedb.parse.networkstatus.parseRLine`.""" + """Tests for :func:`bridgedb.parse.networkstatus.parseRLine`. + The documentation for all class variables, e.g. 'pre' or 'ident', refers + to what said value should be in a *valid* descriptor. + """ + #: The prefix for the 'r'-line. Should be an 'r', unless testing that + #: lines with unknown prefixes are dropped. pre = 'r ' + #: An OR nickname string. To be valid, it should be 1-19 alphanumeric + #: upper or lower cased characters. nick = 'Testing' + #: A base64-encoded SHA-1 digest of the DER-formatted ASN.1-encoded public + #: portion of an OR identity key, with any trailing base64 padding (any + #: '=' characters) removed. ident = 'bXw2N1K9AAKR5undPaTgNUySNxI' + #: A base64-encoded SHA-1 digest of the OR [bridge-]server-descriptor + #: document (the whole thing, up until the 'router signature' line, but not + #: included the signature thereafter). desc = 'Z6cisoPT9s6hEd4JkHFAlIWAwXQ=' + #: An ISO-8661 formatted timestamp, with a space separator (rather than a + #: 'T' character). ts = '2013-10-31 15:15:15' + #: An IPv4 address. ip = '221.251.0.42' + #: An ORPort number. port = '9001' + #: A DirPort number. dirp = '0' def makeRLine(self, *args, **kwargs):

1 0

[bridgedb/master] Add unittests for bridgedb.parse.networkstatus.parseALine().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 1b42266f1d6b2bc6cc0552319e80542d04c22dc5 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Dec 7 12:55:10 2013 +0000 Add unittests for bridgedb.parse.networkstatus.parseALine(). --- lib/bridgedb/test/test_parse_networkstatus.py | 80 +++++++++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/lib/bridgedb/test/test_parse_networkstatus.py b/lib/bridgedb/test/test_parse_networkstatus.py index 5467a85..31fb1e2 100644 --- a/lib/bridgedb/test/test_parse_networkstatus.py +++ b/lib/bridgedb/test/test_parse_networkstatus.py @@ -240,3 +240,83 @@ class ParseNetworkStatusRLineTests(unittest.TestCase): the(ts).should.be.a(float) the(ip).should.be(None) + + +class ParseNetworkStatusALineTests(unittest.TestCase): + """Tests for :func:`bridgedb.parse.networkstatus.parseALine`. + + The documentation for all class variables, e.g. 'pre' or 'oraddr', refers + to what said value should be in a *valid* descriptor. + """ + #: The prefix for the 'a'-line. Should be an 'a', unless testing that + #: lines with unknown prefixes are dropped. + pre = 'a ' + #: An ORAddress. As of tor-0.2.5.1-alpha, there is only one and it is an + #: IPv6 address. + oraddr = '[b8d:48ae:5185:dad:5c2a:4e75:8394:f5f8]' + + def tearDown(self): + self.line = '' + + def assertAllFieldsAreNone(self, fields): + """Assert that every field in the iterable ``fields`` is None.""" + for field in fields: + self.assertTrue(field is None) + + def test_missingPrefix(self): + self.line = '%s:1234' % self.oraddr + fields = networkstatus.parseALine(self.line) + self.assertAllFieldsAreNone(fields) + + def test_IPv4(self): + self.line = 'a 48.32.199.45:9001' + ip, port = networkstatus.parseALine(self.line) + ip, port = self.assertWarns( + FutureWarning, + "Got IPv4 address in networkstatus 'a'-line! "\ + "Networkstatus document format may have changed!", + networkstatus.__file__, + networkstatus.parseALine, + self.line) + this(ip).should.be.a(basestring) + this(port).should.be.ok + this(port).should.be.a(networkstatus.addr.PortList) + + def test_IPv4BadPortSeparator(self): + self.line = 'a 1.1.1.1 9001' + fields = networkstatus.parseALine(self.line) + self.assertAllFieldsAreNone(fields) + + def test_IPv6BadPortlist(self): + self.line = 'a 23.23.23.23:1111,2222,badportlist' + ip, port = networkstatus.parseALine(self.line) + this(ip).should.be.a(basestring) + this(port).should.be(None) + + def test_IPv4MissingPort(self): + self.line = 'a 1.1.1.1' + fields = networkstatus.parseALine(self.line) + self.assertAllFieldsAreNone(fields) + + def test_IPv4InvalidAddress(self): + self.line = 'a 127.0.0.1:5555' + fields = networkstatus.parseALine(self.line) + self.assertAllFieldsAreNone(fields) + + def test_IPv6BadPortSeparator(self): + self.line = 'a %s missingcolon' % self.oraddr + fields = networkstatus.parseALine(self.line) + self.assertAllFieldsAreNone(fields) + + def test_IPv6BadPortlist(self): + self.line = 'a %s:1111,2222,badportlist' % self.oraddr + ip, port = networkstatus.parseALine(self.line) + this(ip).should.be.a(basestring) + this(port).should.be(None) + + def test_IPv6(self): + self.line = 'a %s:6004' % self.oraddr + ip, port = networkstatus.parseALine(self.line) + this(ip).should.be.a(basestring) + this(port).should.be.ok + this(port).should.be.a(networkstatus.addr.PortList)

1 0

[bridgedb/master] Remove one EOL whitespace in networkstatus module docstring.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 4befe9c0cd5c8469dcae084e66b4e7c67f46c578 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Dec 8 00:23:14 2013 +0000 Remove one EOL whitespace in networkstatus module docstring. --- lib/bridgedb/parse/networkstatus.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/parse/networkstatus.py b/lib/bridgedb/parse/networkstatus.py index 9f37ba6..1683d38 100644 --- a/lib/bridgedb/parse/networkstatus.py +++ b/lib/bridgedb/parse/networkstatus.py @@ -17,7 +17,7 @@ .. parse - \_networkstatus + \_networkstatus |_ parseRLine - Parse an 'r'-line from a networkstatus document |_ parseALine - Parse an 'a'-line from a networkstatus document \_ parseSLine - Parse an 's'-line from a networkstatus document

1 0

[bridgedb/master] Document the `fingerprint` parameter in networkstatus.parseALine().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit d3bd83103a28456bde1e2616145c927c266b0d54 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Nov 22 01:13:21 2013 +0000 Document the `fingerprint` parameter in networkstatus.parseALine(). --- lib/bridgedb/parse/networkstatus.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/bridgedb/parse/networkstatus.py b/lib/bridgedb/parse/networkstatus.py index 6e2c0d6..9f37ba6 100644 --- a/lib/bridgedb/parse/networkstatus.py +++ b/lib/bridgedb/parse/networkstatus.py @@ -170,6 +170,10 @@ def parseALine(line, fingerprint=None): | consensus-method 14 or later.) :param string line: An 'a'-line from an bridge-network-status descriptor. + :type fingerprint: string or None + :param fingerprint: A string which identifies which OR the descriptor + we're parsing came from (since the 'a'-line doesn't tell us, this can + help make the log messages clearer). :raises: :exc:`NetworkstatusParsingError` :rtype: tuple :returns: A 2-tuple of a string respresenting the IP address and a

1 0

[bridgedb/master] Remove unused exception ParseORAddressError from bridgedb.Bridges.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit ad7b1b14f4056812290c49186ab0aeabc13da772 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Dec 7 13:14:37 2013 +0000 Remove unused exception ParseORAddressError from bridgedb.Bridges. --- lib/bridgedb/Bridges.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 61f3412..158c980 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -365,11 +365,6 @@ def parseDescFile(f, bridge_purpose='bridge'): nickname = ip = orport = fingerprint = purpose = None -class ParseORAddressError(Exception): - def __init__(self): - msg = "Invalid or-address line" - Exception.__init__(self, msg) - re_ipv6 = re.compile("\[([a-fA-F0-9:]+)\]:(.*$)") re_ipv4 = re.compile("((?:\d{1,3}\.?){4}):(.*$)")

1 0