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

[bridgedb/master] 5935 - FilteredBridgeSplitter dumpAssignments()
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit 8b384ade42386706906e6ea4ec6dbd80fb373fc1 Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 13 18:31:15 2012 -0700 5935 - FilteredBridgeSplitter dumpAssignments() dumpAssignments() should conform to spec in https://trac.torproject.org/projects/tor/ticket/5935 --- lib/bridgedb/Bridges.py | 38 ++++++++++++++++++++++++++++++++++---- 1 files changed, 34 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 4224fd7..5c60209 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -163,7 +163,7 @@ class Bridge: # default ip, orport should get a chance at being selected if isinstance(self.ip, addressClass): - addresses.insert(0,self.ip, PortList(self.orport)) + addresses.insert(0,(self.ip, PortList(self.orport))) if addresses: address,portlist = addresses[pos % len(addresses)] @@ -273,7 +273,7 @@ def parseDescFile(f, bridge_purpose='bridge'): purposeMatches = (purpose == bridge_purpose or bridge_purpose is None) if purposeMatches and nickname and ip and orport and fingerprint: - b = Bridge(nickname, ip, orport, fingerprint) + b = Bridge(nickname, ipaddr.IPAddress(ip), orport, fingerprint) b.assertOK() yield b nickname = ip = orport = fingerprint = purpose = None @@ -783,8 +783,38 @@ class FilteredBridgeSplitter(BridgeHolder): ring.insert(bridge) def dumpAssignments(self, f, description=""): - for n,(_,r) in self.filterRings.items(): - r.dumpAssignments(f, "%s %s" % (description, n)) + # one ring per filter set + # bridges may be present in multiple filter sets + # only one line should be dumped per bridge + + for b in self.bridges: + # gather all the filter descriptions + desc = [] + for n,(g,r) in self.filterRings.items(): + if g(b): + # ghetto. get subring flags, ports + for tp,val,_,subring in r.subrings: + if subring.getBridgeByID(b.getID()): + desc.append("%s=%s"%(tp,val)) + try: + desc.extend(g.description.split()) + except TypeError: + desc.append(g.description) + + # dedupe and group + desc = set(desc) + grouped = dict() + for kw in desc: + l,r = kw.split('=') + try: + grouped[l] = "%s,%s"%(grouped[l],r) + except KeyError: + grouped[l] = kw + + # add to assignments + desc = "%s %s" % (description.strip(), + " ".join([v for k,v in grouped.items()]).strip()) + f.write("%s %s\n"%( toHex(b.getID()), desc)) def assignmentsArePersistent(self): return False #XXX: is this right?

1 0

[bridgedb/master] 5935 - Add descriptions to filters
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit c0b05e570dd484f5e6008ec24e416b07accae48c Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 13 18:32:25 2012 -0700 5935 - Add descriptions to filters Adds the 'description' attribute to filters. This attribute is used to indicate which filters are applicable to a bridge in the assignments.log The description should be a string of format k=v, for example: filterBridgesByIP4.description is 'ip=4' --- lib/bridgedb/Filters.py | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/lib/bridgedb/Filters.py b/lib/bridgedb/Filters.py index fd79704..5654cb5 100644 --- a/lib/bridgedb/Filters.py +++ b/lib/bridgedb/Filters.py @@ -19,6 +19,7 @@ def filterAssignBridgesToRing(hmac, numRings, assignedRing): return False f.__name__ = "filterAssignBridgesToRing(%s, %s, %s)" % (hmac, numRings, assignedRing) + setattr(f, "description", "ring=%d" % assignedRing) funcs[ruleset] = f return f @@ -31,6 +32,7 @@ def filterBridgesByRules(rules): r = [f(x) for f in rules] if False in r: return False return True + setattr(g, "description", " ".join([getattr(f,'description','') for f in rules])) funcs[ruleset] = g return g @@ -44,6 +46,7 @@ def filterBridgesByIP4(bridge): if type(k) is IPv4Address: return True return False +setattr(filterBridgesByIP4, "description", "ip=4") def filterBridgesByIP6(bridge): try: @@ -55,6 +58,7 @@ def filterBridgesByIP6(bridge): if type(k) is IPv6Address: return True return False +setattr(filterBridgesByIP6, "description", "ip=6") def filterBridgesByOnlyIP4(bridge): for k in bridge.or_addresses.keys():

1 0

[bridgedb/master] 5935 - Tests should use a mix of IPv4 and IPv6
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit b3ce8e419cee39d2111783d1d181ce94f7b392d1 Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 13 18:36:11 2012 -0700 5935 - Tests should use a mix of IPv4 and IPv6 updated fakeBridge(), fakeBridge6() to randomly set the address class in or_addresses so that test coverage is more complete. --- lib/bridgedb/Tests.py | 10 +++++++--- 1 files changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/Tests.py b/lib/bridgedb/Tests.py index 648835a..d14bc23 100644 --- a/lib/bridgedb/Tests.py +++ b/lib/bridgedb/Tests.py @@ -58,15 +58,17 @@ def randomPortSpec(): def fakeBridge(orport=8080, running=True, stable=True, or_addresses=False): nn = "bridge-%s"%random.randrange(0,1000000) - ip = randomIP() + ip = ipaddr.IPAddress(randomIP()) fp = "".join([random.choice("0123456789ABCDEF") for _ in xrange(40)]) b = bridgedb.Bridges.Bridge(nn,ip,orport,fingerprint=fp) b.setStatus(running, stable) if or_addresses: for i in xrange(0,8): + if random.choice(xrange(2)): ip = randomIP() + else: ip = "[%s]"%randomIP6() address,portlist = bridgedb.Bridges.parseORAddressLine( - "%s:%s" % (randomIP(),randomPortSpec())) + "%s:%s" % (ip,randomPortSpec())) try: portlist.add(b.or_addresses[address]) except KeyError: @@ -77,13 +79,15 @@ def fakeBridge(orport=8080, running=True, stable=True, or_addresses=False): def fakeBridge6(orport=8080, running=True, stable=True, or_addresses=False): nn = "bridge-%s"%random.randrange(0,1000000) - ip = randomIP6() + ip = ipaddr.IPAddress(randomIP6()) fp = "".join([random.choice("0123456789ABCDEF") for _ in xrange(40)]) b = bridgedb.Bridges.Bridge(nn,ip,orport,fingerprint=fp) b.setStatus(running, stable) if or_addresses: for i in xrange(0,8): + if random.choice(xrange(2)): ip = randomIP() + else: ip = "[%s]"%randomIP6() address,portlist = bridgedb.Bridges.parseORAddressLine( "[%s]:%s" % (randomIP6(),randomPortSpec())) try:

1 0

[bridgedb/master] 5935 - Store ip as string
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit 5f65706188a39ae5a3faeb1b97f499b2fdaa9ad8 Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 13 19:17:25 2012 -0700 5935 - Store ip as string bridge.ip is stored in the database as a string but ipaddr.IPAddress everywhere else. --- lib/bridgedb/Storage.py | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/Storage.py b/lib/bridgedb/Storage.py index da64a30..91c1a3c 100644 --- a/lib/bridgedb/Storage.py +++ b/lib/bridgedb/Storage.py @@ -218,14 +218,14 @@ class Database: # Update last_seen, address, port and (possibly) distributor. cur.execute("UPDATE Bridges SET address = ?, or_port = ?, " "distributor = ?, last_seen = ? WHERE id = ?", - (bridge.ip, bridge.orport, ring, timeToStr(seenAt), i)) + (str(bridge.ip), bridge.orport, ring, timeToStr(seenAt), i)) return ring else: # Insert it. cur.execute("INSERT INTO Bridges (hex_key, address, or_port, " "distributor, first_seen, last_seen) " "VALUES (?, ?, ?, ?, ?, ?)", - (h, bridge.ip, bridge.orport, setRing, t, t)) + (h, str(bridge.ip), bridge.orport, setRing, t, t)) return setRing def cleanEmailedBridges(self, expireBefore):

1 0

[bridgedb/master] 5948 - Update usage of getConfigLine()
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit 57755d16f27a45a41a4f92191f597a34dae9f2b3 Author: aagbsn <aagbsn(a)extc.org> Date: Fri Jun 8 22:41:16 2012 -0700 5948 - Update usage of getConfigLine() The 'needsIPv4' and 'needsIPv6' arguments are replaced with 'addressClass'. --- lib/bridgedb/Server.py | 18 +++++++++++++++--- lib/bridgedb/Tests.py | 8 ++++---- 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/lib/bridgedb/Server.py b/lib/bridgedb/Server.py index 5dfe888..e6a63e1 100644 --- a/lib/bridgedb/Server.py +++ b/lib/bridgedb/Server.py @@ -161,8 +161,10 @@ class WebResource(twisted.web.resource.Resource): if ip: if ipv6: rules.append(filterBridgesByIP6) + addressClass = IPv6Address else: rules.append(filterBridgesByIP4) + addressClass = IPv4Address bridges = self.distributor.getBridgesForIP(ip, interval, self.nBridgesToGive, @@ -171,7 +173,11 @@ class WebResource(twisted.web.resource.Resource): if bridges: answer = "".join("%s %s\n" % ( - b.getConfigLine(self.includeFingerprints,needIPv6=ipv6), + b.getConfigLine( + includeFingerprint=self.includeFingerprints, + addressClass=addressClass, + request=bridgedb.Dist.uniformMap(ip) + ), (I18n.BRIDGEDB_TEXT[16] if b.isBlocked(countryCode) else "") ) for b in bridges) else: @@ -401,13 +407,16 @@ def getMailResponse(lines, ctx): # read subject, see if they want ipv6 ipv6 = False bridgeFilterRules = [] + addressClass = None for ln in lines: if "ipv6" in ln.strip().lower(): ipv6 = True bridgeFilterRules.append(filterBridgesByIP6) + addressClass = IPv6Address break else: bridgeFilterRules.append(filterBridgesByIP4) + addressClass = IPv4Address try: interval = ctx.schedule.getInterval(time.time()) @@ -464,8 +473,11 @@ def getMailResponse(lines, ctx): if bridges: with_fp = ctx.cfg.EMAIL_INCLUDE_FINGERPRINTS - answer = "".join(" %s\n" %b.getConfigLine(with_fp, - needIPv6=ipv6) for b in bridges) + answer = "".join(" %s\n" %b.getConfigLine( + includeFingerprint=with_fp, + addressClass=addressClass, + request=clientAddr + ) for b in bridges) else: answer = "(no bridges currently available)" diff --git a/lib/bridgedb/Tests.py b/lib/bridgedb/Tests.py index 59536ce..648835a 100644 --- a/lib/bridgedb/Tests.py +++ b/lib/bridgedb/Tests.py @@ -218,7 +218,7 @@ class IPBridgeDistTests(unittest.TestCase): for i in xrange(500): b = d.getBridgesForIP(randomIP(), "x", 1, bridgeFilterRules=[filterBridgesByIP6]) address, portlist = bridgedb.Bridges.parseORAddressLine( - random.choice(b).getConfigLine(needIPv6=True)[7:]) + random.choice(b).getConfigLine(addressClass=ipaddr.IPv6Address)[7:]) assert type(address) is ipaddr.IPv6Address assert filterBridgesByIP6(random.choice(b)) @@ -231,7 +231,7 @@ class IPBridgeDistTests(unittest.TestCase): for i in xrange(500): b = d.getBridgesForIP(randomIP(), "x", 1, bridgeFilterRules=[filterBridgesByIP4]) address, portlist = bridgedb.Bridges.parseORAddressLine( - random.choice(b).getConfigLine(needIPv4=True)[7:]) + random.choice(b).getConfigLine(addressClass=ipaddr.IPv4Address)[7:]) assert type(address) is ipaddr.IPv4Address assert filterBridgesByIP4(random.choice(b)) @@ -250,10 +250,10 @@ class IPBridgeDistTests(unittest.TestCase): assert filterBridgesByIP4(t) assert filterBridgesByIP6(t) address, portlist = bridgedb.Bridges.parseORAddressLine( - t.getConfigLine(needIPv4=True)[7:]) + t.getConfigLine(addressClass=ipaddr.IPv4Address)[7:]) assert type(address) is ipaddr.IPv4Address address, portlist = bridgedb.Bridges.parseORAddressLine( - t.getConfigLine(needIPv6=True)[7:]) + t.getConfigLine(addressClass=ipaddr.IPv6Address)[7:]) assert type(address) is ipaddr.IPv6Address

1 0

[bridgedb/master] 4568 - Add option EXTRA_INFO_FILE to bridgedb.conf
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit 2257559aa25d33c5176dc4a30ae4855decdd256b Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 6 01:07:57 2012 -0700 4568 - Add option EXTRA_INFO_FILE to bridgedb.conf Adds a configuration option 'EXTRA_INFO_FILE' to specify the location of extra-info descriptors. --- bridgedb.conf | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/bridgedb.conf b/bridgedb.conf index 81a2688..f044ee6 100644 --- a/bridgedb.conf +++ b/bridgedb.conf @@ -29,6 +29,10 @@ STATUS_FILE = "networkstatus-bridges" # Either a file that contains blocked bridges list or None #COUNTRY_BLOCK_FILE = "./blocked-bridges" +# File from which we read extra-info entries, for learning pluggable +# transports +EXTRA_INFO_FILE = "extra-infos" + # Only consider routers whose purpose matches this string. BRIDGE_PURPOSE = "bridge" # File to store persistent info in.

1 0

[bridgedb/master] 4568 - Add class PluggableTransport to Bridges
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit 4300329a30f3b6aa3e390b140193dd50faa6e03f Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 20 04:40:16 2012 -0700 4568 - Add class PluggableTransport to Bridges Adds a class PluggableTransport and function parseExtraInfoFile() to read pluggable transports from bridge extra-info descriptors. Also adds transport support in FilteredBridgeSplitter.dumpAssignments --- lib/bridgedb/Bridges.py | 133 +++++++++++++++++++++++++++++++++++++++++++++-- 1 files changed, 129 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 5a3949a..3d72d37 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -105,7 +105,7 @@ class Bridge: ## running,stable -- DOCDOC ## blockingCountries -- list of country codes blocking this bridge def __init__(self, nickname, ip, orport, fingerprint=None, id_digest=None, - or_addresses=None): + or_addresses=None, transports=None): """Create a new Bridge. One of fingerprint and id_digest must be set.""" self.nickname = nickname @@ -113,8 +113,11 @@ class Bridge: self.orport = orport if not or_addresses: or_addresses = {} self.or_addresses = or_addresses + if not transports: transports = [] + self.transports = transports self.running = self.stable = None self.blockingCountries = None + if id_digest is not None: assert fingerprint is None if len(id_digest) != DIGEST_LEN: @@ -142,13 +145,14 @@ class Bridge: self.nickname, self.ip, self.orport, self.fingerprint) def getConfigLine(self, includeFingerprint=False, addressClass=None, - request=None): + request=None, transport=None): """Returns a valid bridge line for inclusion in a torrc""" #arguments: # includeFingerprint # addressClass - type of address to choose # request - a string unique to this request # e.g. email-address or uniformMap(ip) + # transport - a pluggable transport method name if not request: request = 'default' digest = get_hmac_fn('Order-Or-Addresses')(request) @@ -157,6 +161,18 @@ class Bridge: # default address type if not addressClass: addressClass = ipaddr.IPv4Address + # pluggable transports + if transport: + # filter by 'methodname' + transports = filter(lambda x: transport == x.methodname, + self.transports) + # filter by 'addressClass' + transports = filter(lambda x: isinstance(x.address, addressClass), + transports) + if transports: + pt = transports[pos % len(transports)] + return pt.getTransportLine(includeFingerprint) + # filter addresses by address class addresses = filter(lambda x: isinstance(x[0], addressClass), self.or_addresses.items()) @@ -179,8 +195,6 @@ class Bridge: def getAllConfigLines(self,includeFingerprint=False): """Generator. Iterate over all valid config lines for this bridge.""" - # warning: a bridge with large port ranges may generate thousands - # of lines of output for address,portlist in self.or_addresses.items(): if type(address) is ipaddr.IPv6Address: ip = "[%s]" % address @@ -192,6 +206,9 @@ class Bridge: yield "bridge %s:%d %s" % (ip,orport,self.fingerprint) else: yield "bridge %s:%d" % (ip,orport) + for pt in self.transports: + yield pt.getTransportLine(includeFingerprints) + def assertOK(self): assert is_valid_ip(self.ip) @@ -352,6 +369,108 @@ def parseORAddressLine(line): if address and portlist and len(portlist): return address,portlist raise ParseORAddressError +class PluggableTransport: + """ + an object that represents a pluggable-transport method + and a reference to the relevant bridge + """ + def __init__(self, bridge, methodname, address, port, argdict=None): + + #XXX: assert are disabled with python -O + assert isinstance(bridge, Bridge) + assert type(address) in (ipaddr.IPv4Address, ipaddr.IPv6Address) + assert type(port) is int + assert (0 < port < 65536) + assert type(methodname) is str + + self.bridge = bridge + self.address = address + self.port = port + self.methodname = methodname + if type(argdict) is dict: + self.argdict = argdict + else: self.argdict = {} + + def getTransportLine(self, includeFingerprint=False): + """ + returns a torrc bridge line for this transport + """ + if isinstance(self.address,ipaddr.IPv6Address): + address = "[%s]" % self.address + else: address = self.address + host = "bridge %s %s:%d" % (self.methodname, address, self.port) + fp = '' + if includeFingerprint: fp = "keyid=%s" % self.bridge.fingerprint + args = " ".join(["%s=%s"%(k,v) for k,v in self.argdict.items()]).strip() + return "%s %s %s" % (host, fp, args) + +def parseExtraInfoFile(f): + """ + parses lines in Bridges extra-info documents. + returns an object whose type corresponds to the + relevant set of extra-info lines. + + presently supported lines and the accompanying type are: + + { 'transport': PluggableTransport, } + + 'transport' lines (torspec.git/proposals/180-pluggable-transport.txt) + + Bridges put the 'transport' lines in their extra-info documents. + the format is: + + transport SP <methodname> SP <address:port> [SP arglist] NL + """ + + ID = None + for line in f: + line = line.strip() + + argdict = {} + + # do we need to skip 'opt' here? + # if line.startswith("opt "): + # line = line[4:] + + # get the bridge ID ? + if line.startswith("extra-info "): #XXX: get the router ID + line = line[11:] + (nickname, ID) = line.split() + if is_valid_fingerprint(ID): + ID = fromHex(ID) + + # get the transport line + if ID and line.startswith("transport "): + fields = line[10:].split() + # [ arglist ] field, optional + if len(fields) >= 3: + arglist = fields[2:] + # parse arglist [k=v,...k=v] as argdict {k:v,...,k:v} + argdict = {} + for arg in arglist: + try: k,v = arg.split('=') + except ValueError: continue + argdict[k] = v + + # get the required fields, method name and address + if len(fields) >= 2: + # get the method name + # Method names must be C identifiers + for regex in [re_ipv4, re_ipv6]: + try: + method_name = re.match('[_a-zA-Z][_a-zA-Z0-9]*',fields[0]).group() + m = regex.match(fields[1]) + address = ipaddr.IPAddress(m.group(1)) + port = int(m.group(2)) + yield ID, method_name, address, port, argdict + except (IndexError, ValueError, AttributeError): + # skip this line + continue + + # end of descriptor is defined how? + if ID and line.startswith("router-signature"): + ID = None + def parseStatusFile(f): """DOCDOC""" ID = None @@ -760,7 +879,9 @@ class FilteredBridgeSplitter(BridgeHolder): logging.debug("insert bridge into %s" % n) #XXX db.insertBridgeAndGetRing ?? + # already 'assigned' by the FixedBridgeSplitter #XXX persisent mapping? + # the filters rebuild def addRing(self, ring, ringname, filterFn, populate_from=None): """Add a ring to this splitter. @@ -804,6 +925,10 @@ class FilteredBridgeSplitter(BridgeHolder): except TypeError: desc.append(g.description) + # add transports + for transport in b.transports: + desc.append("transport=%s"%(transport.methodname)) + # dedupe and group desc = set(desc) grouped = dict()

1 0

[bridgedb/master] 5935 - Use bridge.ip when logging r.insert(bridge)
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit d6605fa9c739b4499bd20d28e3dc2c63d1cc7086 Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 13 20:34:24 2012 -0700 5935 - Use bridge.ip when logging r.insert(bridge) BridgeRing.insert() logging.debug now uses the primary bridge address (bridge.ip) to avoid the case where a bridge has no IPv4 addresses, when running python setup.py tests, for example. --- lib/bridgedb/Bridges.py | 5 ++++- 1 files changed, 4 insertions(+), 1 deletions(-) diff --git a/lib/bridgedb/Bridges.py b/lib/bridgedb/Bridges.py index 5c60209..5a3949a 100644 --- a/lib/bridgedb/Bridges.py +++ b/lib/bridgedb/Bridges.py @@ -504,7 +504,10 @@ class BridgeRing(BridgeHolder): self.isSorted = False self.bridges[pos] = bridge self.bridgesByID[ident] = bridge - logging.debug("Adding %s to %s", bridge.getConfigLine(True), self.name) + #XXX: just use bridge.ip + if isinstance(bridge.ip, ipaddr.IPv6Address): ip = "[%s]" % bridge.ip + else: ip = bridge.ip + logging.debug("Adding %s to %s", ip, self.name) def _sort(self): """Helper: put the keys in sorted order."""

1 0

[bridgedb/master] 4568 - Add filter for bridges with transports
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit c8c12c79556d8e4e16029f04672b20ffcf6ff07b Author: aagbsn <aagbsn(a)extc.org> Date: Wed Jun 6 01:08:59 2012 -0700 4568 - Add filter for bridges with transports Adds a filter to select bridges with transport specified by name. --- lib/bridgedb/Filters.py | 18 ++++++++++++++++++ 1 files changed, 18 insertions(+), 0 deletions(-) diff --git a/lib/bridgedb/Filters.py b/lib/bridgedb/Filters.py index 5654cb5..435845a 100644 --- a/lib/bridgedb/Filters.py +++ b/lib/bridgedb/Filters.py @@ -75,3 +75,21 @@ def filterBridgesByOnlyIP6(bridge): if type(k) is IPv6Address: return True return False + +def filterBridgesByTransport(methodname, addressClass): + assert (addressClass) in (IPv4Address, IPv6Address) + ruleset = frozenset([methodname, addressClass]) + try: + return funcs[ruleset] + except KeyError: + def f(bridge): + for transport in bridge.transports: + # ignore method name case + if isinstance(transport.address, addressClass) and \ + transport.methodname.lower() == methodname.lower(): return True + return False + f.__name__ = "filterBridgesByTransport(%s,%s)" % (methodname, + type(addressClass)) + setattr(f, "description", "transport=%s"%methodname) + funcs[ruleset] = f + return f

1 0

[bridgedb/master] 4568 - Update email responses
by aagbsn＠torproject.org 16 Mar '13

16 Mar '13

commit 4078f236caefff20441a759722e8474522c7fc1d Author: aagbsn <aagbsn(a)extc.org> Date: Fri Jun 15 16:33:23 2012 -0700 4568 - Update email responses Add new strings for email response template that provide instructions for requesting ipv6 or transports Also move email composition into a separate function and remove code duplication. --- lib/bridgedb/I18n.py | 13 +++++++-- lib/bridgedb/Server.py | 71 ++++++++++++++++++++--------------------------- 2 files changed, 40 insertions(+), 44 deletions(-) diff --git a/lib/bridgedb/I18n.py b/lib/bridgedb/I18n.py index 24629f1..1e90348 100644 --- a/lib/bridgedb/I18n.py +++ b/lib/bridgedb/I18n.py @@ -53,8 +53,8 @@ bridge addresses."""), # BRIDGEDB_TEXT[9] _("""To receive your bridge relays, please prove you are human"""), # BRIDGEDB_TEXT[10] - _("""You have exceeded the rate limit. Please slow down, the minimum time between -emails is: """), + _("""You have exceeded the rate limit. Please slow down, the minimum time +between emails is: """), # BRIDGEDB_TEXT[11] _("""hours"""), # BRIDGEDB_TEXT[12] @@ -66,5 +66,12 @@ emails is: """), # BRIDGEDB_TEXT[15] _("""Upgrade your browser to Firefox"""), # BRIDGEDB_TEXT[16] - _("""(Might be blocked)""") + _("""(Might be blocked)"""), + # BRIDGEDB_TEXT[17] + _("""The following commands are also supported:"""), + # BRIDGEDB_TEXT[18] + _(""" ipv6 : request ipv6 bridges """), + # bridgedb_text[19] + _(""" transport TRANSPORT_NAME : request bridges with transport +TRANSPORT_NAME, such as obfs3.""") ] diff --git a/lib/bridgedb/Server.py b/lib/bridgedb/Server.py index de5e545..172a0ba 100644 --- a/lib/bridgedb/Server.py +++ b/lib/bridgedb/Server.py @@ -161,7 +161,6 @@ class WebResource(twisted.web.resource.Resource): try: # validate method name - logging.debug("trans: %s" % request.args.get("transport")[0]) transport = re.match('[_a-zA-Z][_a-zA-Z0-9]*', request.args.get("transport")[0]).group() except (TypeError, IndexError): @@ -430,7 +429,7 @@ def getMailResponse(lines, ctx): ipv6 = True if "transport" in ln.strip().lower(): transport = re.search("transport ([_a-zA-Z][_a-zA-Z0-9]*)", ln).group(1).strip() - logging.debug("transport %s" % transport) + logging.debug("Got request for transport: %s" % transport) if ipv6: bridgeFilterRules.append(filterBridgesByIP6) @@ -448,29 +447,16 @@ def getMailResponse(lines, ctx): interval, ctx.N, countryCode=None, bridgeFilterRules=bridgeFilterRules) + # Handle rate limited email except TooSoonEmail, e: logging.info("Got a mail too frequently; warning %r: %s.", clientAddr, e) # Compose a warning email - f = StringIO() - w = MimeWriter.MimeWriter(f) - w.addheader("From", ctx.fromAddr) - w.addheader("To", clientAddr) - w.addheader("Message-ID", twisted.mail.smtp.messageid()) - if not subject.startswith("Re:"): subject = "Re: %s"%subject - w.addheader("Subject", subject) - if msgID: - w.addheader("In-Reply-To", msgID) - w.addheader("Date", twisted.mail.smtp.rfc822date()) - body = w.startbody("text/plain") - # MAX_EMAIL_RATE is in seconds, convert to hours - EMAIL_MESSAGE_RATELIMIT = buildSpamWarningTemplate(t) - body.write(EMAIL_MESSAGE_RATELIMIT % (bridgedb.Dist.MAX_EMAIL_RATE / 3600)) - f.seek(0) - return clientAddr, f + body = buildSpamWarningTemplate(t) % (bridgedb.Dist.MAX_EMAIL_RATE / 3600) + return composeEmail(ctx.fromAddr, clientAddr, subject, body, msgID) except IgnoreEmail, e: logging.info("Got a mail too frequently; ignoring %r: %s.", @@ -482,19 +468,6 @@ def getMailResponse(lines, ctx): clientAddr, e) return None, None - # Generate the message. - f = StringIO() - w = MimeWriter.MimeWriter(f) - w.addheader("From", ctx.fromAddr) - w.addheader("To", clientAddr) - w.addheader("Message-ID", twisted.mail.smtp.messageid()) - if not subject.startswith("Re:"): subject = "Re: %s"%subject - w.addheader("Subject", subject) - if msgID: - w.addheader("In-Reply-To", msgID) - w.addheader("Date", twisted.mail.smtp.rfc822date()) - body = w.startbody("text/plain") - if bridges: with_fp = ctx.cfg.EMAIL_INCLUDE_FINGERPRINTS answer = "".join(" %s\n" %b.getConfigLine( @@ -506,15 +479,9 @@ def getMailResponse(lines, ctx): else: answer = "(no bridges currently available)" - EMAIL_MESSAGE_TEMPLATE = buildMessageTemplate(t) - body.write(EMAIL_MESSAGE_TEMPLATE % answer) - - #XXX debug - f.seek(0) - logging.debug(f.readlines()) - f.seek(0) - logging.info("Email looks good; we should send an answer.") - return clientAddr, f + body = buildMessageTemplate(t) % answer + # Generate the message. + return composeEmail(ctx.fromAddr, clientAddr, subject, body, msgID) def buildMessageTemplate(t): msg_template = t.gettext(I18n.BRIDGEDB_TEXT[5]) + "\n\n" \ @@ -523,8 +490,10 @@ def buildMessageTemplate(t): + t.gettext(I18n.BRIDGEDB_TEXT[1]) + "\n\n" \ + t.gettext(I18n.BRIDGEDB_TEXT[2]) + "\n\n" \ + t.gettext(I18n.BRIDGEDB_TEXT[3]) + "\n\n" \ + + t.gettext(I18n.BRIDGEDB_TEXT[17])+ "\n\n" \ + + t.gettext(I18n.BRIDGEDB_TEXT[18])+ "\n\n" \ + + t.gettext(I18n.BRIDGEDB_TEXT[19])+ "\n\n" \ + t.gettext(I18n.BRIDGEDB_TEXT[6]) + "\n\n" - return msg_template def buildSpamWarningTemplate(t): @@ -718,3 +687,23 @@ def getCCFromRequest(request): if len(path) == 2: return path.lower() return None + +def composeEmail(fromAddr, clientAddr, subject, body, msgID=False): + f = StringIO() + w = MimeWriter.MimeWriter(f) + w.addheader("From", fromAddr) + w.addheader("To", clientAddr) + w.addheader("Message-ID", twisted.mail.smtp.messageid()) + if not subject.startswith("Re:"): subject = "Re: %s"%subject + w.addheader("Subject", subject) + if msgID: + w.addheader("In-Reply-To", msgID) + w.addheader("Date", twisted.mail.smtp.rfc822date()) + mailbody = w.startbody("text/plain") + mailbody.write(body) + + f.seek(0) + logging.debug(f.readlines()) + f.seek(0) + logging.info("Email looks good; we should send an answer.") + return clientAddr, f

1 0