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

[bridgedb/develop] Update bridgedb.parse.padBase64() docstring.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit 06c2a831dcad901e7dbc94374fcedd4caad9cf99 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:14:26 2014 +0000 Update bridgedb.parse.padBase64() docstring. --- lib/bridgedb/parse/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/parse/__init__.py b/lib/bridgedb/parse/__init__.py index e8b8069..ae9b559 100644 --- a/lib/bridgedb/parse/__init__.py +++ b/lib/bridgedb/parse/__init__.py @@ -30,10 +30,10 @@ def padBase64(b64string): """Re-add any stripped equals sign character padding to a b64 string. :param string b64string: A base64-encoded string which might have had its - trailing equals sign padding removed. - :raises: :exc:`ValueError` if there was any error while manipulating the + trailing equals sign (``=``) padding removed. + :raises ValueError: if there was any error while manipulating the string. + :returns: A properly-padded (according to the base64 spec: :rfc:`4648`) string. - :returns: A properly-padded (according to base64) string. """ addchars = 0 try:

1 0

[bridgedb/develop] Update module attribute docstrings in bridgedb.parse.addr.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit 451289fa36d6ea48c55e42f66e0bd63563535f6d Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:15:41 2014 +0000 Update module attribute docstrings in bridgedb.parse.addr. --- lib/bridgedb/parse/addr.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/parse/addr.py b/lib/bridgedb/parse/addr.py index a9c62cc..26632ac 100644 --- a/lib/bridgedb/parse/addr.py +++ b/lib/bridgedb/parse/addr.py @@ -184,15 +184,17 @@ import ipaddr #: These are the special characters which RFC2822 allows within email addresses: -#ASPECIAL = '!#$%&*+-/=?^_`{|}~' + "\\\'" -#: These are the ones we're pretty sure we can handle right: +#: ASPECIAL = '!#$%&*+-/=?^_`{|}~' + "\\\'" +#: …But these are the only ones we're confident that we can handle correctly: +#: ASPECIAL = '-_+/=_~' ASPECIAL = '-_+/=_~' ACHAR = r'[\w%s]' % "".join("\\%s" % c for c in ASPECIAL) DOTATOM = r'%s+(?:\.%s+)*' % (ACHAR, ACHAR) DOMAIN = r'\w+(?:\.\w+)*' ADDRSPEC = r'(%s)\@(%s)' % (DOTATOM, DOMAIN) +# A compiled regexp which matches on any type and ammount of whitespace: SPACE_PAT = re.compile(r'\s+') -#: A compiled regex with matches RFC2822 email address strings: +# A compiled regexp which matches RFC2822 email address strings: ADDRSPEC_PAT = re.compile(ADDRSPEC)

1 0

[bridgedb/develop] Fix typo in b.p.o.BaseOptions.findRundirAndConfigFile() docstring.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit c8b2da1b4ae8bb6ffe4a053704e4fc8c2fa8d0bd Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:18:34 2014 +0000 Fix typo in b.p.o.BaseOptions.findRundirAndConfigFile() docstring. --- lib/bridgedb/parse/options.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/parse/options.py b/lib/bridgedb/parse/options.py index 3b1004d..5664460 100644 --- a/lib/bridgedb/parse/options.py +++ b/lib/bridgedb/parse/options.py @@ -174,8 +174,8 @@ class BaseOptions(usage.Options): @staticmethod def findRundirAndConfigFile(rundir=None, config=None): - """Find the abspath of the config file and runtime directory, or find - suitable defaults. + """Find the absolute path of the config file and runtime directory, or + find suitable defaults. Attempts to set the absolute path of the runtime directory. If the config path is relative, its absolute path is set relative to the

1 0

[bridgedb/develop] Merge branch 'hotfix/11522-gpg-signing' into develop
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit e1b5588e0ca71834c062cd7b7633871993fd0bf9 Merge: 77f5da5 fafbdc7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 23 01:46:38 2014 +0000 Merge branch 'hotfix/11522-gpg-signing' into develop lib/bridgedb/crypto.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)

1 0

[bridgedb/develop] Update Sphinx formatting in docstrings in bridgedb.parse.headers.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit bee3de9793a093cd705a276e00c6a4c31f8fe00b Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:16:47 2014 +0000 Update Sphinx formatting in docstrings in bridgedb.parse.headers. --- lib/bridgedb/parse/headers.py | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/lib/bridgedb/parse/headers.py b/lib/bridgedb/parse/headers.py index b557372..5c3597a 100644 --- a/lib/bridgedb/parse/headers.py +++ b/lib/bridgedb/parse/headers.py @@ -9,14 +9,17 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information -"""bridgedb.parse.headers -- Parsers for HTTP and Email headers. +"""Parsers for HTTP and Email headers. -** Module Overview: ** +.. py:module:: bridgedb.parse.headers + :synopsis: Parsers for HTTP and Email headers. +bridgedb.parse.headers +======================= :: parseAcceptLanguage - Parse the contents of a client 'Accept-Language' header - +.. """ def parseAcceptLanguage(header): @@ -24,15 +27,15 @@ def parseAcceptLanguage(header): Parse the header in the following manner: - 0. If ``header`` is None or an empty string, return an empty list. - 1. Split the ``header`` string on any commas. - 2. Chop of the RFC2616 quality/level suffix. We ignore these, and just - use the order of the list as the preference order, without any - parsing of quality/level assignments. - 3. Add a fallback language of the same type if it is missing. For - example, if we only got ['es-ES', 'de-DE'], add 'es' after 'es-ES' - and add 'de' after 'de-DE'. - 4. Change all hyphens to underscores. + 1. If ``header`` is None or an empty string, return an empty list. + 2. Split the ``header`` string on any commas. + 3. Chop of the RFC2616 quality/level suffix. We ignore these, and just + use the order of the list as the preference order, without any + parsing of quality/level assignments. + 4. Add a fallback language of the same type if it is missing. For + example, if we only got ['es-ES', 'de-DE'], add 'es' after 'es-ES' + and add 'de' after 'de-DE'. + 5. Change all hyphens to underscores. :param string header: The contents of an 'Accept-Language' header, i.e. as if taken from :api:`twisted.web.server.Request.getHeader`.

1 0

[bridgedb/develop] Update bridgedb.parse.addr module docstring.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit 846cb78871b1c131f6bec9d3c9a70a4938a0d535 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:15:20 2014 +0000 Update bridgedb.parse.addr module docstring. --- lib/bridgedb/parse/addr.py | 186 +++++++++++++++++++++++++------------------- 1 file changed, 107 insertions(+), 79 deletions(-) diff --git a/lib/bridgedb/parse/addr.py b/lib/bridgedb/parse/addr.py index f34f416..a9c62cc 100644 --- a/lib/bridgedb/parse/addr.py +++ b/lib/bridgedb/parse/addr.py @@ -9,136 +9,164 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information -"""Utilities for parsing IP addresses. +"""Utilities for parsing IP and email addresses. -** Module Overview: ** +.. py:module:: bridgedb.parse.addr + :synopsis: Parsers for finding and validating IP addresses, email + addresses, and port ranges. + + +bridgedb.parse.addr +=================== :: - parse - ||_ parse.addr - | | |_ extractEmailAddress - Validate a :rfc:2822 email address. - | | |_ isIPAddress - Check if an arbitrary string is an IP address. - | | |_ isIPv4 - Check if an arbitrary string is an IPv4 address. - | | |_ isIPv6 - Check if an arbitrary string is an IPv6 address. - | | \_ isValidIP - Check that an IP address is valid. - | | - | |_ :class:`PortList` - A container class for validated port ranges. + + parse.addr + | |_ extractEmailAddress() - Validate a :rfc:2822 email address. + | |_ isIPAddress() - Check if an arbitrary string is an IP address. + | |_ isIPv4() - Check if an arbitrary string is an IPv4 address. + | |_ isIPv6() - Check if an arbitrary string is an IPv6 address. + | \_ isValidIP() - Check that an IP address is valid. | - |__ :mod:`bridgedb.parse.headers` - |__ :mod:`bridgedb.parse.options` - \__ :mod:`bridgedb.parse.versions` + |_ PortList - A container class for validated port ranges. -:: +.. + + +How address validity is determined +---------------------------------- -Private IP Address Ranges: -'''''''''''''''''''''''''' +The following terms define addresses which are **not** valid. All other +addresses are taken to be valid. + + +Private IP Address Ranges +^^^^^^^^^^^^^^^^^^^^^^^^^ .. glossary:: - 10.0.0.0 - 10.255.255.255 (10.0.0.0/8 prefix) - 172.16.0.0 - 172.31.255.255 (172.16.0.0/12 prefix) - 192.168.0.0 - 192.168.255.255 (192.168.0.0/16 prefix) - These Address ranges are reserved by IANA for private intranets, and not - routable to the Internet. For additional information, see :rfc:`1918`. + Private Address + These address ranges are reserved by IANA for private intranets, and not + routable to the Internet:: + 10.0.0.0 - 10.255.255.255 (10.0.0.0/8) + 172.16.0.0 - 172.31.255.255 (172.16.0.0/12) + 192.168.0.0 - 192.168.255.255 (192.168.0.0/16) + For additional information, see :rfc:`1918`. -Reserved and Special Use Addresses: -''''''''''''''''''''''''''''''''''' + +Reserved and Special Use Addresses +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. glossary:: Unspecified Address Default Route - ex. ``0.0.0.0/8`` - ex. ``::/128`` - Current network (only valid as source address). See :rfc:`1122`. An - **Unspecified Address** in the context of firewalls means "all addresses - of the local machine". In a routing context, it is usually termed the - **Default Route**, and it means the default route (to "the rest of" the - internet). See :rfc:`1700`. + Current network (only valid as source address). See :rfc:`1122`. An + **Unspecified Address** in the context of firewalls means "all addresses + of the local machine". In a routing context, it is usually termed the + **Default Route**, and it means the default route (to "the rest of" the + internet). See :rfc:`1700`. + For example:: + 0.0.0.0/8 + ::/128 Loopback Address - ex. ``127.0.0.0`` - Reserved for loopback and IPC on the localhost. See :rfc:`1122`. + Reserved for loopback and IPC on the localhost. See :rfc:`1122`. + Example:: + 127.0.0.0 Localhost Address - ex. ``127.0.0.1 - 127.255.255.254`` (``127.0.0.0/8``) - ex. ``::1`` - Loopback IP addresses (refers to self). See :rfc:`5735`. + Loopback IP addresses (refers to self). See :rfc:`5735`. + Examples include:: + 127.0.0.1 - 127.255.255.254 (127.0.0.0/8) + ::1 Link-Local Address - ex. ``169.254.0.0/16`` - ex. ``fe80::/64`` - These are the link-local blocks, used for communication between hosts on - a single link. See :rfc:`3927`. + These are the link-local blocks, used for communication between hosts on + a single link. See :rfc:`3927`. + Examples:: + 169.254.0.0/16 + fe80::/64 Multicast Address - ex. ``224.0.0.0 - 239.255.255.255`` (``224.0.0.0/4``) - Reserved for multicast addresses. See :rfc:`3171`. + Reserved for multicast addresses. See :rfc:`3171`. + For example:: + 224.0.0.0 - 239.255.255.255 (224.0.0.0/4) Private Address - ex. ``10.0.0.0/8`` - ex. ``172.16.0.0/12`` - ex. ``192.168.0.0/16`` - Reserved for private networks. See :rfc:`1918`. + Reserved for private networks. See :rfc:`1918`. + Some examples include:: + 10.0.0.0/8 + 172.16.0.0/12 + 192.168.0.0/16 Reserved Address - ex. ``240.0.0.0 - 255.255.255.255`` (``240.0.0.0/4``) - Reserved (former Class E network). See :rfc:`1700`, :rfc:`3232`, and - :rfc:`5735`. The one exception to this rule is the :term:`Limited - Broadcast Address`, ``255.255.255.255`` for which packets at the IP - layer are not forwarded to the public internet. + Reserved (former Class E network). See :rfc:`1700`, :rfc:`3232`, and + :rfc:`5735`. The one exception to this rule is the :term:`Limited + Broadcast Address`, ``255.255.255.255`` for which packets at the IP + layer are not forwarded to the public internet. For example:: + 240.0.0.0 - 255.255.255.255 (240.0.0.0/4) Limited Broadcast Address - ex. ``255.255.255.255`` - Limited broadcast address (limited to all other nodes on the LAN). See - :rfc:`919`. For IPv4, ``255`` in any part of the IP is reserved for - broadcast addressing to the local LAN. + Limited broadcast address (limited to all other nodes on the LAN). See + :rfc:`919`. For IPv4, ``255`` in any part of the IP is reserved for + broadcast addressing to the local LAN, e.g.:: + 255.255.255.255 .. warning:: The :mod:`ipaddr` module (as of version 2.1.10) does not understand the following reserved_ addresses: - .. _reserved: https://tools.ietf.org/html/rfc5735#page-4 .. glossary:: Reserved Address (Protocol Assignments) - ex. ``192.0.0.0/24`` - Reserved for IETF protocol assignments. See :rfc:`5735`. + Reserved for IETF protocol assignments. See :rfc:`5735`. + Example:: + 192.0.0.0/24 Reserved Address (6to4 Relay Anycast) - ex. ``192.88.99.0/24`` - IPv6 to IPv4 relay. See :rfc:`3068`. + IPv6 to IPv4 relay. See :rfc:`3068`. + Example:: + 192.88.99.0/24 Reserved Address (Network Benchmark) - ex. ``198.18.0.0/15`` - Network benchmark tests. See :rfc:`2544`. + Network benchmark tests. See :rfc:`2544`. + Example:: + 198.18.0.0/15 Reserved Address (TEST-NET-1) - ex. ``192.0.2.0/24`` - Reserved for use in documentation and example code. It is often used in - conjunction with domain names ``example.com`` or ``example.net`` in - vendor and protocol documentation. See :rfc:`1166`. + Reserved for use in documentation and example code. It is often used in + conjunction with domain names ``example.com`` or ``example.net`` in + vendor and protocol documentation. See :rfc:`1166`. + For example:: + 192.0.2.0/24 Reserved Address (TEST-NET-2) - ex. ``198.51.100.0/24`` - TEST-NET-2. See :rfc:`5737`. + TEST-NET-2. See :rfc:`5737`. + Example:: + 198.51.100.0/24 Reserved Address (TEST-NET-3) - ex. ``203.0.113.0/24`` - TEST-NET-3. See :rfc:`5737`. + TEST-NET-3. See :rfc:`5737`. + Example:: + 203.0.113.0/24 Shared Address Space - ex. ``100.64.0.0/10`` - See :rfc:`6598`. + See :rfc:`6598`. + Example:: + 100.64.0.0/10 Site-Local Address Unique Local Address - ex. ``ff00::0/8`` - ex. ``fec0::/10`` (:rfc:`3513` §2.5.6) - Similar uses to :term:`Limited Broadcast Address`. For IPv6, everything - becomes convoluted_ and complicated_, and then redefined_. See - :rfc:`4193`, :rfc:`3879`, and :rfc:`3513`. The - :meth:`ipaddr.IPAddress.is_site_local` method *only* checks to see if - the address is a **Unique Local Address** vis-á-vis :rfc:`3513` §2.5.6. + Similar uses to :term:`Limited Broadcast Address`. For IPv6, everything + becomes convoluted_ and complicated_, and then redefined_. See + :rfc:`4193`, :rfc:`3879`, and :rfc:`3513`. The + :meth:`ipaddr.IPAddress.is_site_local` method *only* checks to see if + the address is a **Unique Local Address** vis-á-vis :rfc:`3513` §2.5.6, + e.g.:: + ff00::0/8 + fec0::/10 + +.. .. _convoluted: https://en.wikipedia.org/wiki/IPv6_address#Multicast_addresses .. _complicated: https://en.wikipedia.org/wiki/IPv6_address#IPv6_address_scopes

1 0

[bridgedb/develop] Add module docstring for bridgedb.parse.options.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit 6cbf20b0442206ff777cdddfb2de123e03e82ff1 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:18:02 2014 +0000 Add module docstring for bridgedb.parse.options. --- lib/bridgedb/parse/options.py | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/parse/options.py b/lib/bridgedb/parse/options.py index 0285184..3b1004d 100644 --- a/lib/bridgedb/parse/options.py +++ b/lib/bridgedb/parse/options.py @@ -8,10 +8,37 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information -"""Classes for commandline options parsing. - -** Module Overview: ** - +"""Parsers for BridgeDB commandline options. + +.. py:module:: bridgedb.parse.options + :synopsis: Parsers for BridgeDB commandline options. + + +bridgedb.parse.options +====================== +:: + + bridgedb.parse.options + |__ setConfig() + |__ getConfig() - Set/Get the config file path. + |__ setRundir() + |__ getRundir() - Set/Get the runtime directory. + |__ parseOptions() - Create the main options parser for BridgeDB. + | + \_ BaseOptions - Base options, included in all other options menus. + || + |\__ findRundirAndConfigFile() - Find the absolute path of the config + | file and runtime directory, or find + | suitable defaults. + | + |__ SIGHUPOptions - Menu to explain SIGHUP signal handling and usage. + |__ SIGUSR1Options - Menu to explain SIGUSR1 handling and usage. + | + |__ MockOptions - Suboptions for creating fake bridge descriptors for + | testing purposes. + |__ TestOptions - Suboptions for running twisted.trial based unittests. + \__ MainOptions - Main commandline options parser for BridgeDB. +.. """ from __future__ import print_function

1 0

[bridgedb/develop] Fix GPGME 'invalid argument' error while signing.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit fafbdc77a2656185740790e688ced745518c72c7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Apr 23 01:38:31 2014 +0000 Fix GPGME 'invalid argument' error while signing. * FIX error introduced in commit b2c7a2a2 in branch for #11522 fixes. The in-memory files for the message and the signature file for libgpgme need to be type io.BytesIO(buffer(message)), not io.StringIO(unicode()) like the rest of the email body files. --- lib/bridgedb/crypto.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/crypto.py b/lib/bridgedb/crypto.py index b70069d..4ce30b2 100644 --- a/lib/bridgedb/crypto.py +++ b/lib/bridgedb/crypto.py @@ -343,8 +343,7 @@ def getGPGContext(cfg): ctx.signers = (bridgedbKey,) logging.debug("Testing signature created with GnuPG key...") - testMessage = "Testing 1 2 3" - signatureText, sigs = gpgSignMessage(ctx, testMessage) + signatureText, sigs = gpgSignMessage(ctx, "Testing 1 2 3") if not len(sigs) == 1: raise PythonicGpgmeError("Testing couldn't produce a signature "\ @@ -396,8 +395,8 @@ def gpgSignMessage(gpgmeCtx, messageString, mode=None): if not mode: mode = gpgme.SIG_MODE_CLEAR - msgFile = io.StringIO(unicode(messageString)) - sigFile = io.StringIO() + msgFile = io.BytesIO(buffer(messageString)) + sigFile = io.BytesIO() sigList = gpgmeCtx.sign(msgFile, sigFile, mode) sigFile.seek(0) signature = sigFile.read()

1 0

[bridgedb/develop] Update Sphinx formatting in docstrings in bridgedb.parse.networkstatus.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit 0ff6962764d1b5b3995e2b5efae6ffa1923a909e Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:17:27 2014 +0000 Update Sphinx formatting in docstrings in bridgedb.parse.networkstatus. --- lib/bridgedb/parse/networkstatus.py | 57 ++++++++++++++++++++--------------- 1 file changed, 32 insertions(+), 25 deletions(-) diff --git a/lib/bridgedb/parse/networkstatus.py b/lib/bridgedb/parse/networkstatus.py index 9304009..8592cd3 100644 --- a/lib/bridgedb/parse/networkstatus.py +++ b/lib/bridgedb/parse/networkstatus.py @@ -5,23 +5,27 @@ # :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> # please also see AUTHORS file # :copyright: (c) 2013 Isis Lovecruft -# (c) 2007-2013, The Tor Project, Inc. -# (c) 2007-2013, all entities within the AUTHORS file +# (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 ``@type bridge-network-status 1.0`` descriptors. +"""Parsers for bridge networkstatus descriptors. +.. py:module:: bridgedb.parse.networkstatus + :synopsis: Parsers for ``@type bridge-network-status`` descriptors_. .. _descriptors: https://metrics.torproject.org/formats.html#descriptortypes -**Module Overview:** +bridgedb.parse.networkstatus +============================ +:: + + networkstatus + |_ isValidRouterNickname - Determine if a nickname is according to spec + |_ 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 .. - parse - \_networkstatus - |_ isValidRouterNickname - Determine if a nickname is according to spec - |_ 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 """ import binascii @@ -67,25 +71,28 @@ def parseRLine(line): """Parse an 'r'-line from a networkstatus document. From torspec.git/dir-spec.txt, commit 36761c7d553d L1499-1512: + | "r" SP nickname SP identity SP digest SP publication SP IP SP ORPort + | SP DirPort NL | - |"r" SP nickname SP identity SP digest SP publication SP IP SP ORPort - | SP DirPort NL - | - | [At start, exactly once.] - | - | "Nickname" is the OR's nickname. "Identity" is a hash of its - | identity key, encoded in base64, with trailing equals sign(s) - | removed. "Digest" is a hash of its most recent descriptor as - | signed (that is, not including the signature), encoded in base64. - | "Publication" is the - | publication time of its most recent descriptor, in the form - | YYYY-MM-DD HH:MM:SS, in UTC. "IP" is its current IP address; - | ORPort is its current OR port, "DirPort" is its current directory - | port, or "0" for "none". + | [At start, exactly once.] | + | "Nickname" is the OR's nickname. "Identity" is a hash of its + | identity key, encoded in base64, with trailing equals sign(s) + | removed. "Digest" is a hash of its most recent descriptor as + | signed (that is, not including the signature), encoded in base64. + | "Publication" is the + | publication time of its most recent descriptor, in the form + | YYYY-MM-DD HH:MM:SS, in UTC. "IP" is its current IP address; + | ORPort is its current OR port, "DirPort" is its current directory + | port, or "0" for "none". :param string line: An 'r'-line from an bridge-network-status descriptor. - + :returns: + A 7-tuple of:: + (nickname, identityDigest, descriptorDigest, timestamp, + orAddress, orPort, dirport) + where each value is set according to the data parsed from the + **line**, or ``None`` if nothing suitable could be parsed. """ (nickname, ID, descDigest, timestamp, ORaddr, ORport, dirport) = (None for x in xrange(7))

1 0

[bridgedb/develop] Update bridgedb.parse.addr.extractEmailAddress docstring.
by isis＠torproject.org 23 Apr '14

23 Apr '14

commit 17cbc0a0eb10e84401d72ddcae8bb871c16a7c13 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Apr 22 23:16:11 2014 +0000 Update bridgedb.parse.addr.extractEmailAddress docstring. --- lib/bridgedb/parse/addr.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/lib/bridgedb/parse/addr.py b/lib/bridgedb/parse/addr.py index 26632ac..a354387 100644 --- a/lib/bridgedb/parse/addr.py +++ b/lib/bridgedb/parse/addr.py @@ -242,15 +242,15 @@ def canonicalizeEmailDomain(domain, domainmap): return permitted def extractEmailAddress(emailaddr): - """Given an email address, obtained, for example, via a ``From:`` or + """Given an email address, obtained for example, via a ``From:`` or ``Sender:`` email header, try to extract and parse (according to - :rfc:2822) the username and domain portions. Returns ``(username, - domain)`` on success; raises BadEmail on failure. + :rfc:`2822`) the local and domain portions. We only allow the following form:: - ADDRSPEC := LOCAL_PART "@" DOMAIN + LOCAL_PART := DOTATOM DOMAIN := DOTATOM + ADDRSPEC := LOCAL_PART "@" DOMAIN In particular, we are disallowing: obs-local-part, obs-domain, comment, and obs-FWS. Other forms exist, but none of the incoming services we @@ -258,10 +258,9 @@ def extractEmailAddress(emailaddr): :param emailaddr: An email address to validate. :raises BadEmail: if the **emailaddr** couldn't be validated or parsed. - :rtype: tuple :returns: A tuple of the validated email address, containing the mail - username and the domain:: - (LOCALPART, DOMAIN) + local part and the domain:: + (LOCAL_PART, DOMAIN) """ orig = emailaddr

1 0