- tor-commits - lists.torproject.org

[stem/master] Condensing basic example a tiny bit
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit 149d1bd2932a093ffe7fb75298da9b442b3b64c7 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Mar 13 09:19:48 2012 -0700 Condensing basic example a tiny bit Combining the constructor and 'with' lines since that's probably the common case. The second example already shows a standalone constructor anyway. --- stem/descriptor/reader.py | 4 +--- test/integ/descriptor/reader.py | 3 +-- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/stem/descriptor/reader.py b/stem/descriptor/reader.py index ca987e8..8117361 100644 --- a/stem/descriptor/reader.py +++ b/stem/descriptor/reader.py @@ -8,10 +8,8 @@ descriptor data in a series of destinations. For example... "/tmp/archived_descriptors/", ] - reader = DescriptorReader(my_descriptors) - # prints the contents of all the descriptor files - with reader: + with DescriptorReader(my_descriptors) as reader: for descriptor in reader: print descriptor diff --git a/test/integ/descriptor/reader.py b/test/integ/descriptor/reader.py index 0344b99..55644b4 100644 --- a/test/integ/descriptor/reader.py +++ b/test/integ/descriptor/reader.py @@ -150,10 +150,9 @@ class TestDescriptorReader(unittest.TestCase): # running this test multiple times to flush out concurrency issues for i in xrange(15): - reader = stem.descriptor.reader.DescriptorReader([descriptor_path]) remaining_entries = list(descriptor_entries) - with reader: + with stem.descriptor.reader.DescriptorReader([descriptor_path]) as reader: for descriptor in reader: descriptor_str = str(descriptor)

1 0

[stem/master] Completely untested start for descriptor parsing
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit cb819ce76b011c4ee84fa15014c92166bca49577 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 16:19:09 2012 -0700 Completely untested start for descriptor parsing Starting on server descriptor parsing. This is gonna need some other classes and helper functions (such as an ExitPolicy and is_valid_ip_address()) but otherwise should be pretty straight forward. --- stem/descriptor/server_descriptor.py | 132 ++++++++++++++++++++++++++++++++++ 1 files changed, 132 insertions(+), 0 deletions(-) diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py new file mode 100644 index 0000000..e9782bc --- /dev/null +++ b/stem/descriptor/server_descriptor.py @@ -0,0 +1,132 @@ +""" +Parsing for Tor server descriptors, which contains the infrequently changing +information about a Tor relay (contact information, exit policy, public keys, +etc). This information is provided from a few sources... + +- control port via 'GETINFO desc/*' queries +- the 'cached-descriptors' file in tor's data directory +- tor metrics, at https://metrics.torproject.org/data.html +""" + +import re + +from stem.descriptor.descriptor import Descriptor + +ENTRY_START = "router" +ENTRY_END = "router-signature" + +KEYWORD_CHAR = "[a-zA-Z0-9-]" +WHITESPACE = "[ \t]" +KEYWORD_LINE = re.compile("^(%s+)%s*(%s*)$" % (KEYWORD_CHAR, WHITESPACE, KEYWORD_CHAR)) +SIGNATURE_START = re.compile("^-----BEGIN %s+ PUBLIC KEY-----$" % KEYWORD_CHAR) +SIGNATURE_END = re.compile("^-----END %s+ PUBLIC KEY-----$" % KEYWORD_CHAR) + +# entries must have exactly one of the following +REQUIRED_FIELDS = ( + "published", + "onion-key", + "signing-key", + "bandwidth", +) + +# optional entries that can appear at most once +SINGLE_FIELDS = ( + "contact", + "uptime", + "fingerprint", + "hibernating", + "read-history", + "write-history", + "eventdns", + "platform", + "family", +) + +def parse_server_descriptors_v2(path, descriptor_file): + """ + Iterates over the verion 2 server descriptors in a descriptor file. + """ + + pass + +class ServerDescriptorV2(Descriptor): + """ + Version 2 server descriptor, as specified in... + https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec-v2.txt + + Attributes: + nickname (str) - relay's nickname (*) + address (str) - IPv4 address of the relay (*) + or_port (int) - port used for relaying (*) + socks_port (int) - deprecated attribute, always zero (*) + dir_port (int) - deprecated port used for descriptor mirroring (*) + + * required fields + """ + + nickname = None + address = None + or_port = None + socks_port = None + dir_port = None + + def __init__(self, contents): + Descriptor.__init__(self, contents) + + # A descriptor contains a series of 'keyword lines' which are simply a + # keyword followed by an optional value. Lines can also be followed by a + # signature block. + # + # We care about the ordering of 'accept' and 'reject' entries because this + # influences the resulting exit policy, but for everything else the order + # does not matter so breaking it into key / value pairs. + + entries = {} + exit_policy_lines = [] + + for line in contents.split("\n"): + line_match = KEYWORD_LINE.match() + + if not line_match: + raise ValueError("Line contains invalid characters: %s" % line) + + keyword, value = line_match.groups() + + if keyword in ("accept", "reject"): + exit_policy_lines.append("%s %s" % (keyword, value)) + elif keyword in entries: + entries[keyword].append(value) + else: + entries[keyword] = [value] + + # validates restrictions about the entries + + for keyword in REQUIRED_FIELDS: + if not keyword in entries: + raise ValueError("Descriptor must have a '%s' entry" % keyword + + for keyword in SINGLE_FIELDS + REQUIRED_FIELDS: + if keyword in entries and len(entries[keyword]) > 1: + raise ValueError("The '%s' entry can only appear once in a descriptor" % keyword) + + # parse all the entries into our attributes + + for keyword, values in entres.items(): + if keyword == "router": + # "router" nickname address ORPort SocksPort DirPort + router_comp = values[0].split() + + if len(router_comp) != 5: + raise ValueError("Router line must have five values: router %s" % values[0] + + # TODO: also check validity of other fields + # Fingerprint = "$" 40*HEXDIG + # NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9" + # Nickname = 1*19 NicknameChar + + self.nickname = router_comp[0] + self.address = router_comp[1] + self.or_port = router_comp[2] + self.socks_port = router_comp[3] + self.dir_port = router_comp[4] +

1 0

[stem/master] Descriptor module with common functionality
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit da4ccb0bedc122c4776048751c4de0b6cc0e010e Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Mar 14 09:55:38 2012 -0700 Descriptor module with common functionality Adding the descriptor module which has the Descriptor class (the common parent for all descriptor types) and the function for parsing descriptors from a file. This parser will later do type recognition to figure out how descriptors should be parsed. This is identical to how metrics-lib does this. Nice advantage is that we can now move all of the remaining 'TODO' notes out of the reader. It's done. :) --- stem/descriptor/__init__.py | 2 +- stem/descriptor/descriptor.py | 58 +++++++++++++++++++++++++++++++++++++++++ stem/descriptor/reader.py | 38 ++++++++++++++++---------- 3 files changed, 82 insertions(+), 16 deletions(-) diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py index fef6750..33970ef 100644 --- a/stem/descriptor/__init__.py +++ b/stem/descriptor/__init__.py @@ -2,5 +2,5 @@ Utilities for parsing and processing descriptor data. """ -__all__ = ["reader"] +__all__ = ["descriptor", "reader"] diff --git a/stem/descriptor/descriptor.py b/stem/descriptor/descriptor.py new file mode 100644 index 0000000..90d3bed --- /dev/null +++ b/stem/descriptor/descriptor.py @@ -0,0 +1,58 @@ +""" +Common functionality for descriptors. +""" + +def parse_descriptors(path, descriptor_file): + """ + Provides an iterator for the descriptors within a given file. + + Arguments: + path (str) - absolute path to the file's location on disk + descriptor_file (file) - opened file with the descriptor contents + + Returns: + iterator that parses the file's contents into descriptors + + Raises: + TypeError if we can't match the contents of the file to a descriptor type + IOError if unable to read from the descriptor_file + """ + + # TODO: implement actual descriptor type recognition and parsing + # TODO: add integ test for non-descriptor text content + yield Descriptor(path, descriptor_file.read()) + +class Descriptor: + """ + Common parent for all types of descriptors. + """ + + def __init__(self, path, raw_contents): + self._path = path + self._raw_contents = raw_contents + + def get_path(self): + """ + Provides the absolute path that we loaded this descriptor from. + + Returns: + str with the absolute path of the descriptor source + """ + + return self._path + + def get_unrecognized_lines(self): + """ + Provides a list of lines that were either ignored or had data that we did + not know how to process. This is most common due to new descriptor fields + that this library does not yet know how to process. Patches welcome! + + Returns: + list of lines of unrecognized content + """ + + return [] + + def __str__(self): + return self._raw_contents + diff --git a/stem/descriptor/reader.py b/stem/descriptor/reader.py index 8117361..3b6f5fd 100644 --- a/stem/descriptor/reader.py +++ b/stem/descriptor/reader.py @@ -70,6 +70,8 @@ import threading import mimetypes import Queue +import stem.descriptor.descriptor + # flag to indicate when the reader thread is out of descriptor files to read FINISHED = "DONE" @@ -362,25 +364,31 @@ class DescriptorReader: def _handle_descriptor_file(self, target): try: - # TODO: replace with actual descriptor parsing when we have it - target_file = open(target) - self._enqueue_descriptor(target_file.read()) - target_file.close() - - self._iter_notice.set() + with open(target) as target_file: + for desc in stem.descriptor.descriptor.parse_descriptors(target, target_file): + self._enqueue_descriptor(desc) + self._iter_notice.set() + except TypeError, exc: + self._notify_skip_listeners(target, ParsingFailure(exc)) except IOError, exc: self._notify_skip_listeners(target, ReadFailed(exc)) def _handle_archive(self, target): - with tarfile.open(target) as tar_file: - for tar_entry in tar_file: - if tar_entry.isfile(): - # TODO: replace with actual descriptor parsing when we have it - entry = tar_file.extractfile(tar_entry) - self._enqueue_descriptor(entry.read()) - entry.close() - - self._iter_notice.set() + try: + with tarfile.open(target) as tar_file: + for tar_entry in tar_file: + if tar_entry.isfile(): + entry = tar_file.extractfile(tar_entry) + + for desc in stem.descriptor.descriptor.parse_descriptors(target, entry): + self._enqueue_descriptor(desc) + self._iter_notice.set() + + entry.close() + except TypeError, exc: + self._notify_skip_listeners(target, ParsingFailure(exc)) + except IOError, exc: + self._notify_skip_listeners(target, ReadFailed(exc)) def _enqueue_descriptor(self, descriptor): # blocks until their is either room for the descriptor or we're stopped

1 0

[stem/master] Stub for identifying descriptor types
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit af1cdfcedf961b506b63c923fdd9b5a6a3edd1e5 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 15:54:15 2012 -0700 Stub for identifying descriptor types The various tor descriptor types were not made to be readily identifyable, so we'll probably need to guess their type based on their first line. Ideally that first line would explicitly say the type and version, but oh well... --- stem/descriptor/descriptor.py | 27 ++++++++++++++++++++++++--- 1 files changed, 24 insertions(+), 3 deletions(-) diff --git a/stem/descriptor/descriptor.py b/stem/descriptor/descriptor.py index 90d3bed..a89e5e5 100644 --- a/stem/descriptor/descriptor.py +++ b/stem/descriptor/descriptor.py @@ -2,6 +2,8 @@ Common functionality for descriptors. """ +import os + def parse_descriptors(path, descriptor_file): """ Provides an iterator for the descriptors within a given file. @@ -18,6 +20,22 @@ def parse_descriptors(path, descriptor_file): IOError if unable to read from the descriptor_file """ + # The tor descriptor specifications do not provide a reliable method for + # identifying a descriptor file's type and version so we need to guess + # based on its filename for resources from the data directory and contents + # for files provided by metrics. + + filename = os.path.basename(path) + + if filename == "cached-descriptors": + pass # server descriptors from tor's data directory + + first_line = descriptor_file.readline() + descriptor_file.seek(0) + + if first_line.startswith("router "): + pass # server descriptor + # TODO: implement actual descriptor type recognition and parsing # TODO: add integ test for non-descriptor text content yield Descriptor(path, descriptor_file.read()) @@ -27,9 +45,9 @@ class Descriptor: Common parent for all types of descriptors. """ - def __init__(self, path, raw_contents): - self._path = path - self._raw_contents = raw_contents + def __init__(self, contents): + self._path = None + self._raw_contents = contents def get_path(self): """ @@ -53,6 +71,9 @@ class Descriptor: return [] + def _set_path(self, path): + self._path = path + def __str__(self): return self._raw_contents

1 0

[stem/master] Funcions to check validity of nicknames and fingerprints
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit 28fb4b1d55952ec905762d4cb400d997e117a0ea Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 17:59:33 2012 -0700 Funcions to check validity of nicknames and fingerprints Couple functions to check if a string is a valid nickname or fingerprint, plus tests. I needed to guess at the definition of a HEXDIG but otherwise nothing very interesting. --- run_tests.py | 2 + stem/util/__init__.py | 2 +- stem/util/tor_tools.py | 44 ++++++++++++++++++++++++++++++++++ test/unit/util/__init__.py | 2 +- test/unit/util/tor_tools.py | 55 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 103 insertions(+), 2 deletions(-) diff --git a/run_tests.py b/run_tests.py index 4918881..e0574d3 100755 --- a/run_tests.py +++ b/run_tests.py @@ -22,6 +22,7 @@ import test.unit.util.conf import test.unit.util.connection import test.unit.util.enum import test.unit.util.system +import test.unit.util.tor_tools import test.unit.version import test.integ.connection.authentication import test.integ.connection.connect @@ -84,6 +85,7 @@ UNIT_TESTS = ( test.unit.util.connection.TestConnection, test.unit.util.conf.TestConf, test.unit.util.system.TestSystem, + test.unit.util.tor_tools.TestTorTools, test.unit.descriptor.reader.TestDescriptorReader, test.unit.version.TestVersion, test.unit.socket.control_message.TestControlMessage, diff --git a/stem/util/__init__.py b/stem/util/__init__.py index bbf4df7..5f6bb24 100644 --- a/stem/util/__init__.py +++ b/stem/util/__init__.py @@ -2,5 +2,5 @@ Utility functions used by the stem library. """ -__all__ = ["conf", "connection", "enum", "log", "proc", "system", "term"] +__all__ = ["conf", "connection", "enum", "log", "proc", "system", "term", "tor_tools"] diff --git a/stem/util/tor_tools.py b/stem/util/tor_tools.py new file mode 100644 index 0000000..5e468c3 --- /dev/null +++ b/stem/util/tor_tools.py @@ -0,0 +1,44 @@ +""" +Miscellaneous utility functions for working with tor. +""" + +import re + +# The control-spec defines the following as... +# Fingerprint = "$" 40*HEXDIG +# NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9" +# Nickname = 1*19 NicknameChar +# +# HEXDIG is defined in RFC 5234 as being uppercase and used in RFC 5987 as +# case insensitive. Tor doesn't define this in the spec so flipping a coin +# and going with case insensitive. + +FINGERPRINT_PATTERN = re.compile("^\$[0-9a-fA-F]{40}$") +NICKNAME_PATTERN = re.compile("^[a-zA-Z0-9]{1,19}$") + +def is_valid_fingerprint(entry): + """ + Checks if a string is a properly formatted relay fingerprint. + + Arguments: + entry (str) - string to be checked + + Returns: + True if the string could be a relay fingerprint, False otherwise. + """ + + return bool(FINGERPRINT_PATTERN.match(entry)) + +def is_valid_nickname(entry): + """ + Checks if a string is a valid format for being a nickname. + + Arguments: + entry (str) - string to be checked + + Returns: + True if the string could be a nickname, False otherwise. + """ + + return bool(NICKNAME_PATTERN.match(entry)) + diff --git a/test/unit/util/__init__.py b/test/unit/util/__init__.py index 74b758a..17a4deb 100644 --- a/test/unit/util/__init__.py +++ b/test/unit/util/__init__.py @@ -2,5 +2,5 @@ Unit tests for stem.util.* contents. """ -__all__ = ["conf", "connection", "enum", "system"] +__all__ = ["conf", "connection", "enum", "system", "tor_tools"] diff --git a/test/unit/util/tor_tools.py b/test/unit/util/tor_tools.py new file mode 100644 index 0000000..5dd1abb --- /dev/null +++ b/test/unit/util/tor_tools.py @@ -0,0 +1,55 @@ +""" +Unit tests for the stem.util.tor_tools functions. +""" + +import unittest +import stem.util.tor_tools + +class TestTorTools(unittest.TestCase): + def test_is_valid_fingerprint(self): + """ + Checks the is_valid_fingerprint function. + """ + + valid_fingerprints = ( + "$A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB", + "$a7569a83b5706ab1b1a9cb52eff7d2d32e4553eb", + ) + + invalid_fingerprints = ( + "", + "A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB", + "$A7569A83B5706AB1B1A9CB52EFF7D2D32E4553E", + "$A7569A83B5706AB1B1A9CB52EFF7D2D32E4553E33", + "$A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EG", + ) + + for fingerprint in valid_fingerprints: + self.assertTrue(stem.util.tor_tools.is_valid_fingerprint(fingerprint)) + + for fingerprint in invalid_fingerprints: + self.assertFalse(stem.util.tor_tools.is_valid_fingerprint(fingerprint)) + + def test_is_valid_nickname(self): + """ + Checks the is_valid_nickname function. + """ + + valid_nicknames = ( + "caerSidi", + "a", + "abcABC123", + ) + + invalid_nicknames = ( + "", + "toolongggggggggggggg", + "bad_character", + ) + + for nickname in valid_nicknames: + self.assertTrue(stem.util.tor_tools.is_valid_nickname(nickname)) + + for nickname in invalid_nicknames: + self.assertFalse(stem.util.tor_tools.is_valid_nickname(nickname)) +

1 0

[stem/master] Implementing and testing is_valid_ip_address()
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit 31cd9b9aa5ea0b5139d3d32ee3a424d9af1e26ca Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 17:07:52 2012 -0700 Implementing and testing is_valid_ip_address() Moving over an arm function for testing if a string is a valid IPv4 address. Also throwing in some unit tests and a fix for entries with leading zeros (for instance "1.2.3.01"). --- run_tests.py | 2 ++ stem/util/__init__.py | 2 +- stem/util/connection.py | 31 +++++++++++++++++++++++++++++++ test/unit/util/__init__.py | 2 +- test/unit/util/connection.py | 25 +++++++++++++++++++++++++ 5 files changed, 60 insertions(+), 2 deletions(-) diff --git a/run_tests.py b/run_tests.py index 60118af..4918881 100755 --- a/run_tests.py +++ b/run_tests.py @@ -19,6 +19,7 @@ import test.unit.socket.control_line import test.unit.socket.control_message import test.unit.descriptor.reader import test.unit.util.conf +import test.unit.util.connection import test.unit.util.enum import test.unit.util.system import test.unit.version @@ -80,6 +81,7 @@ ERROR_ATTR = (term.Color.RED, term.Attr.BOLD) UNIT_TESTS = ( test.unit.util.enum.TestEnum, + test.unit.util.connection.TestConnection, test.unit.util.conf.TestConf, test.unit.util.system.TestSystem, test.unit.descriptor.reader.TestDescriptorReader, diff --git a/stem/util/__init__.py b/stem/util/__init__.py index 2e6b479..bbf4df7 100644 --- a/stem/util/__init__.py +++ b/stem/util/__init__.py @@ -2,5 +2,5 @@ Utility functions used by the stem library. """ -__all__ = ["conf", "enum", "log", "proc", "system", "term"] +__all__ = ["conf", "connection", "enum", "log", "proc", "system", "term"] diff --git a/stem/util/connection.py b/stem/util/connection.py new file mode 100644 index 0000000..6505637 --- /dev/null +++ b/stem/util/connection.py @@ -0,0 +1,31 @@ +""" +Connection and networking based utility functions. This will likely be expanded +later to have all of arm's functions... +https://gitweb.torproject.org/arm.git/blob/HEAD:/src/util/connections.py + +but for now just moving the parts we need. +""" + +def is_valid_ip_address(address): + """ + Checks if a string is a valid IPv4 address. + + Arguments: + address (str) - string to be checked + + Returns: + True if input is a valid IPv4 address, false otherwise. + """ + + # checks if theres four period separated values + if not address.count(".") == 3: return False + + # checks that each value in the octet are decimal values between 0-255 + for entry in address.split("."): + if not entry.isdigit() or int(entry) < 0 or int(entry) > 255: + return False + elif entry[0] == "0" and len(entry) > 1: + return False # leading zeros, for instance in "1.2.3.001" + + return True + diff --git a/test/unit/util/__init__.py b/test/unit/util/__init__.py index 7c8d12b..74b758a 100644 --- a/test/unit/util/__init__.py +++ b/test/unit/util/__init__.py @@ -2,5 +2,5 @@ Unit tests for stem.util.* contents. """ -__all__ = ["conf", "enum", "system"] +__all__ = ["conf", "connection", "enum", "system"] diff --git a/test/unit/util/connection.py b/test/unit/util/connection.py new file mode 100644 index 0000000..58cedf4 --- /dev/null +++ b/test/unit/util/connection.py @@ -0,0 +1,25 @@ +""" +Unit tests for the stem.util.connection functions. +""" + +import unittest +import stem.util.connection + +class TestConnection(unittest.TestCase): + def test_is_valid_ip_address(self): + """ + Checks the is_valid_ip_address function. + """ + + self.assertTrue(stem.util.connection.is_valid_ip_address("0.0.0.0")) + self.assertTrue(stem.util.connection.is_valid_ip_address("1.2.3.4")) + self.assertTrue(stem.util.connection.is_valid_ip_address("192.168.0.1")) + self.assertTrue(stem.util.connection.is_valid_ip_address("255.255.255.255")) + + self.assertFalse(stem.util.connection.is_valid_ip_address("0.0.00.0")) + self.assertFalse(stem.util.connection.is_valid_ip_address("0.0.0")) + self.assertFalse(stem.util.connection.is_valid_ip_address("1.2.3.256")) + self.assertFalse(stem.util.connection.is_valid_ip_address("1.2.3.-1")) + self.assertFalse(stem.util.connection.is_valid_ip_address("0.0.0.a")) + self.assertFalse(stem.util.connection.is_valid_ip_address("a.b.c.d")) +

1 0

[stem/master] Function to check validity of a port
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit 8fe000d4de00a073fba060b39f42a8fa4a423077 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 18:20:30 2012 -0700 Function to check validity of a port --- stem/util/connection.py | 35 +++++++++++++++++++++++++++---- test/unit/util/connection.py | 46 ++++++++++++++++++++++++++++++++--------- 2 files changed, 66 insertions(+), 15 deletions(-) diff --git a/stem/util/connection.py b/stem/util/connection.py index 6505637..9c6ba8b 100644 --- a/stem/util/connection.py +++ b/stem/util/connection.py @@ -6,22 +6,22 @@ https://gitweb.torproject.org/arm.git/blob/HEAD:/src/util/connections.py but for now just moving the parts we need. """ -def is_valid_ip_address(address): +def is_valid_ip_address(entry): """ Checks if a string is a valid IPv4 address. Arguments: - address (str) - string to be checked + entry (str) - string to be checked Returns: - True if input is a valid IPv4 address, false otherwise. + True if input is a valid IPv4 address, False otherwise. """ # checks if theres four period separated values - if not address.count(".") == 3: return False + if not entry.count(".") == 3: return False # checks that each value in the octet are decimal values between 0-255 - for entry in address.split("."): + for entry in entry.split("."): if not entry.isdigit() or int(entry) < 0 or int(entry) > 255: return False elif entry[0] == "0" and len(entry) > 1: @@ -29,3 +29,28 @@ def is_valid_ip_address(address): return True +def is_valid_port(entry, allow_zero = False): + """ + Checks if a string or int is a valid port number. + + Arguments: + entry (str or int) - string or integer to be checked + allow_zero (bool) - accept port number of zero (reserved by defintion) + + Returns: + True if input is an integer and within the valid port range, False + otherwise. + """ + + if isinstance(entry, str): + if not entry.isdigit(): + return False + elif entry[0] == "0" and len(entry) > 1: + return False # leading zeros, ex "001" + + entry = int(entry) + + if allow_zero and entry == 0: return True + + return entry > 0 and entry < 65536 + diff --git a/test/unit/util/connection.py b/test/unit/util/connection.py index 58cedf4..01d1c92 100644 --- a/test/unit/util/connection.py +++ b/test/unit/util/connection.py @@ -11,15 +11,41 @@ class TestConnection(unittest.TestCase): Checks the is_valid_ip_address function. """ - self.assertTrue(stem.util.connection.is_valid_ip_address("0.0.0.0")) - self.assertTrue(stem.util.connection.is_valid_ip_address("1.2.3.4")) - self.assertTrue(stem.util.connection.is_valid_ip_address("192.168.0.1")) - self.assertTrue(stem.util.connection.is_valid_ip_address("255.255.255.255")) + valid_addresses = ( + "0.0.0.0", + "1.2.3.4", + "192.168.0.1", + "255.255.255.255", + ) - self.assertFalse(stem.util.connection.is_valid_ip_address("0.0.00.0")) - self.assertFalse(stem.util.connection.is_valid_ip_address("0.0.0")) - self.assertFalse(stem.util.connection.is_valid_ip_address("1.2.3.256")) - self.assertFalse(stem.util.connection.is_valid_ip_address("1.2.3.-1")) - self.assertFalse(stem.util.connection.is_valid_ip_address("0.0.0.a")) - self.assertFalse(stem.util.connection.is_valid_ip_address("a.b.c.d")) + invalid_addresses = ( + "0.0.00.0", + "0.0.0", + "1.2.3.256", + "1.2.3.-1", + "0.0.0.a", + "a.b.c.d", + ) + + for address in valid_addresses: + self.assertTrue(stem.util.connection.is_valid_ip_address(address)) + for address in invalid_addresses: + self.assertFalse(stem.util.connection.is_valid_ip_address(address)) + + def test_is_valid_port(self): + """ + Checks the is_valid_port function. + """ + + valid_ports = (1, "1", 1234, "1234", 65535, "65535") + invalid_ports = (0, "0", 65536, "65536", "abc", "*", " 15", "01") + + for port in valid_ports: + self.assertTrue(stem.util.connection.is_valid_port(port)) + + for port in invalid_ports: + self.assertFalse(stem.util.connection.is_valid_port(port)) + + self.assertTrue(stem.util.connection.is_valid_port(0, allow_zero = True)) + self.assertTrue(stem.util.connection.is_valid_port("0", allow_zero = True))

1 0

[stem/master] Handling the server descriptor's bandwidth line
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit 9342515713edbf3c8a8a2db9ac89132a98eb859c Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 18:44:28 2012 -0700 Handling the server descriptor's bandwidth line --- stem/descriptor/server_descriptor.py | 36 ++++++++++++++++++++++++--------- 1 files changed, 26 insertions(+), 10 deletions(-) diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 6f22604..97829ac 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -57,20 +57,20 @@ class ServerDescriptorV2(Descriptor): https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec-v2.txt Attributes: - nickname (str) - relay's nickname (*) - address (str) - IPv4 address of the relay (*) - or_port (int) - port used for relaying (*) - socks_port (int) - deprecated attribute, always zero (*) - dir_port (int) - deprecated port used for descriptor mirroring (*) + nickname (str) - relay's nickname (*) + address (str) - IPv4 address of the relay (*) + or_port (int) - port used for relaying (*) + socks_port (int) - deprecated attribute, always zero (*) + dir_port (int) - deprecated port used for descriptor mirroring (*) + average_bandwidth (int) - rate of traffic relay is willing to relay in bytes/s (*) + burst_bandwidth (int) - rate of traffic relay is willing to burst to in bytes/s (*) + observed_bandwidth (int) - estimated capacity of the relay based on usage in bytes/s (*) * required fields, others are left as None if undefined """ - nickname = None - address = None - or_port = None - socks_port = None - dir_port = None + nickname = address = or_port = socks_port = dir_port = None + average_bandwidth = burst_bandwidth = observed_bandwidth = None def __init__(self, contents): Descriptor.__init__(self, contents) @@ -136,4 +136,20 @@ class ServerDescriptorV2(Descriptor): self.or_port = router_comp[2] self.socks_port = router_comp[3] self.dir_port = router_comp[4] + elif keyword == "bandwidth": + # "bandwidth" bandwidth-avg bandwidth-burst bandwidth-observed + bandwidth_comp = values[0].split() + + if len(bandwidth_comp) != 3: + raise ValueError("Bandwidth line must have three values: bandwidth %s" % values[0] + elif not bandwidth_comp[0].isdigit()): + raise TypeError("Bandwidth line's average rate isn't numeric: %s" % bandwidth_comp[0]) + elif not bandwidth_comp[1].isdigit()): + raise TypeError("Bandwidth line's burst rate isn't numeric: %s" % bandwidth_comp[1]) + elif not bandwidth_comp[2].isdigit()): + raise TypeError("Bandwidth line's observed rate isn't numeric: %s" % bandwidth_comp[2]) + + average_bandwidth = int(router_comp[0]) + burst_bandwidth = int(router_comp[1]) + observed_bandwidth = int(router_comp[2])

1 0

[stem/master] Validation for server descriptor router line
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit a2aa3c21ea66a38bedb58b561d081e5367ad3982 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 18:25:44 2012 -0700 Validation for server descriptor router line Checking that there aren't any surprises from a server descriptor's router line. --- stem/descriptor/server_descriptor.py | 19 +++++++++++++------ 1 files changed, 13 insertions(+), 6 deletions(-) diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index e9782bc..6f22604 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -11,6 +11,8 @@ etc). This information is provided from a few sources... import re from stem.descriptor.descriptor import Descriptor +import stem.util.connection +import stem.util.tor_tools ENTRY_START = "router" ENTRY_END = "router-signature" @@ -61,7 +63,7 @@ class ServerDescriptorV2(Descriptor): socks_port (int) - deprecated attribute, always zero (*) dir_port (int) - deprecated port used for descriptor mirroring (*) - * required fields + * required fields, others are left as None if undefined """ nickname = None @@ -118,11 +120,16 @@ class ServerDescriptorV2(Descriptor): if len(router_comp) != 5: raise ValueError("Router line must have five values: router %s" % values[0] - - # TODO: also check validity of other fields - # Fingerprint = "$" 40*HEXDIG - # NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9" - # Nickname = 1*19 NicknameChar + elif not stem.util.tor_tools.is_valid_nickname(router_comp[0]): + raise TypeError("Router line entry isn't a valid nickname: %s" % router_comp[0]) + elif not stem.util.connection.is_valid_ip_address(router_comp[1]): + raise TypeError("Router line entry isn't a valid IPv4 address: %s" % router_comp[1]) + elif not stem.util.connection.is_valid_port(router_comp[2], allow_zero = True): + raise TypeError("Router line's ORPort is invalid: %s" % router_comp[2]) + elif router_comp[3] != "0": + raise TypeError("Router line's SocksPort should be zero: %s" % router_comp[3]) + elif not stem.util.connection.is_valid_port(router_comp[4], allow_zero = True): + raise TypeError("Router line's DirPort is invalid: %s" % router_comp[4]) self.nickname = router_comp[0] self.address = router_comp[1]

1 0

[stem/master] Handling the server descriptor's published line
by atagar＠torproject.org 26 Mar '12

26 Mar '12

commit 0ae8839cd91e658a36e7a4c9e5eeec7a75146651 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Mar 17 19:24:45 2012 -0700 Handling the server descriptor's published line Ugggg, I'm always filled with hate when I need to touch the datetime module. I'm not entirely sure if I'm supposed to be associating timezone information with this datetime object or not - and if I am how to get the f*ing thing to realize that it's GMT. --- stem/descriptor/server_descriptor.py | 13 +++++++++++-- 1 files changed, 11 insertions(+), 2 deletions(-) diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 8c1b845..d0f343c 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -9,11 +9,12 @@ etc). This information is provided from a few sources... """ import re +import datetime import stem.version -from stem.descriptor.descriptor import Descriptor import stem.util.connection import stem.util.tor_tools +from stem.descriptor.descriptor import Descriptor ENTRY_START = "router" ENTRY_END = "router-signature" @@ -68,7 +69,7 @@ class ServerDescriptorV2(Descriptor): observed_bandwidth (int) - estimated capacity of the relay based on usage in bytes/s (*) platform (str) - operating system and tor version tor_version (stem.version.Version) - version of tor - + published (datetime.datetime) - time in GMT when the descriptor was generated (*) * required fields, others are left as None if undefined """ @@ -76,6 +77,7 @@ class ServerDescriptorV2(Descriptor): nickname = address = or_port = socks_port = dir_port = None average_bandwidth = burst_bandwidth = observed_bandwidth = None platform = tor_version = None + published = None def __init__(self, contents): Descriptor.__init__(self, contents) @@ -174,4 +176,11 @@ class ServerDescriptorV2(Descriptor): try: tor_version = stem.version.Version(platform_comp[1]) except ValueError: pass + elif keyword == "published": + # "published" YYYY-MM-DD HH:MM:SS + + try: + self.published = datetime.datetime.strptime(values[0], "%Y-%m-%d %H:%M:%S") + except ValueError: + raise TypeError("Published line's time wasn't parseable: %s" % values[0])

1 0