- tor-commits - lists.torproject.org

[stem/master] Supporing DESCCHANGED events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 7f73e1c2c92bd949c29b1430200778d46be4d0cc Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Nov 21 09:05:40 2012 -0800 Supporing DESCCHANGED events Adding support for DESCCHANGED events. These are trivial since... well, they don't contain any attributes. I'm also filling in some missing EventType enum documentation and changing the API docs for events to automatically pick up new event types (there's no point in using autoclass rather than automodule in this case). --- docs/api/response.rst | 9 +-------- stem/control.py | 31 +++++++++++++++++-------------- stem/response/events.py | 9 +++++++++ test/unit/response/events.py | 22 ++++++++++++++++++++++ 4 files changed, 49 insertions(+), 22 deletions(-) diff --git a/docs/api/response.rst b/docs/api/response.rst index a73f172..b2dcda0 100644 --- a/docs/api/response.rst +++ b/docs/api/response.rst @@ -15,12 +15,5 @@ Responses Events ------ -.. autoclass:: stem.response.events.Event -.. autoclass:: stem.response.events.LogEvent -.. autoclass:: stem.response.events.AddrMapEvent -.. autoclass:: stem.response.events.BandwidthEvent -.. autoclass:: stem.response.events.CircuitEvent -.. autoclass:: stem.response.events.NewDescEvent -.. autoclass:: stem.response.events.ORConnEvent -.. autoclass:: stem.response.events.StreamEvent +.. automodule:: stem.response.events diff --git a/stem/control.py b/stem/control.py index 3e0a61c..29b77ef 100644 --- a/stem/control.py +++ b/stem/control.py @@ -69,20 +69,23 @@ providing its own for interacting at a higher level. :class:`~stem.control.Controller` can listen for. Enums are mapped to :class:`~stem.response.events.Event` subclasses as follows... - =========== =========== - EventType Event Class - =========== =========== - **DEBUG** :class:`stem.response.events.LogEvent` - **INFO** :class:`stem.response.events.LogEvent` - **NOTICE** :class:`stem.response.events.LogEvent` - **WARN** :class:`stem.response.events.LogEvent` - **ERR** :class:`stem.response.events.LogEvent` - **BW** :class:`stem.response.events.BandwidthEvent` - **CIRC** :class:`stem.response.events.CircuitEvent` - **NEWDESC** :class:`stem.response.events.NewDescEvent` - **ORCONN** :class:`stem.response.events.ORConnEvent` - **STREAM** :class:`stem.response.events.StreamEvent` - =========== =========== + ===================== =========== + EventType Event Class + ===================== =========== + **DEBUG** :class:`stem.response.events.LogEvent` + **INFO** :class:`stem.response.events.LogEvent` + **NOTICE** :class:`stem.response.events.LogEvent` + **WARN** :class:`stem.response.events.LogEvent` + **ERR** :class:`stem.response.events.LogEvent` + **ADDRMAP** :class:`stem.response.events.AddrMapEvent` + **AUTHDIR_NEWDESCS** :class:`stem.response.events.AuthDirNewDescEvent` + **BW** :class:`stem.response.events.BandwidthEvent` + **CIRC** :class:`stem.response.events.CircuitEvent` + **DESCCHANGED** :class:`stem.response.events.DescChangedEvent` + **NEWDESC** :class:`stem.response.events.NewDescEvent` + **ORCONN** :class:`stem.response.events.ORConnEvent` + **STREAM** :class:`stem.response.events.StreamEvent` + ===================== =========== """ from __future__ import with_statement diff --git a/stem/response/events.py b/stem/response/events.py index 9e13974..f6027aa 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -282,6 +282,14 @@ class CircuitEvent(Event): log_id = "event.circ.unknown_remote_reason.%s" % self.remote_reason log.log_once(log_id, log.INFO, unrecognized_msg % ('remote reason', self.remote_reason)) +class DescChangedEvent(Event): + """ + Event that indicates that our descriptor has changed. This was first added in + tor version 0.1.2.2. + """ + + pass + class LogEvent(Event): """ Tor logging event. These are the most visible kind of event since, by @@ -473,6 +481,7 @@ EVENT_TYPE_TO_CLASS = { "AUTHDIR_NEWDESCS": AuthDirNewDescEvent, "BW": BandwidthEvent, "CIRC": CircuitEvent, + "DESCCHANGED": DescChangedEvent, "NEWDESC": NewDescEvent, "ORCONN": ORConnEvent, "STREAM": StreamEvent, diff --git a/test/unit/response/events.py b/test/unit/response/events.py index c5eeb5b..c0d1fca 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -138,6 +138,17 @@ class TestEvents(unittest.TestCase): self.assertEqual(None, event.error) self.assertEqual(datetime.datetime(2012, 11, 19, 8, 50, 13), event.gmt_expiry) + def test_authdir_newdesc_event(self): + # TODO: We aren't actually parsing the event yet. Until then we can only + # check that we properly get a AuthDirNewDescEvent for it. + + event = _get_event("650 AUTHDIR_NEWDESCS") + + self.assertTrue(isinstance(event, stem.response.events.AuthDirNewDescEvent)) + self.assertEqual("AUTHDIR_NEWDESCS", str(event)) + self.assertEqual([], event.positional_args) + self.assertEqual({}, event.keyword_args) + def test_bw_event(self): event = _get_event("650 BW 15 25") @@ -255,6 +266,17 @@ class TestEvents(unittest.TestCase): self.assertEqual(None, event.reason) self.assertEqual(None, event.remote_reason) + def test_descchanged_event(self): + # all we can check for is that the event is properly parsed as a + # DescChangedEvent instance + + event = _get_event("650 DESCCHANGED") + + self.assertTrue(isinstance(event, stem.response.events.DescChangedEvent)) + self.assertEqual("DESCCHANGED", str(event)) + self.assertEqual([], event.positional_args) + self.assertEqual({}, event.keyword_args) + def test_newdesc_event(self): event = _get_event(NEWDESC_SINGLE) expected_relays = (("B3FA3110CC6F42443F039220C134CBD2FC4F0493", "Sakura"),)

1 0

[stem/master] Support for ADDRMAP events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit ab6e7a365cfa1e31b269f1df0e722ea11a2c53b1 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Nov 19 00:09:09 2012 -0800 Support for ADDRMAP events There's a special spot in hell for whoever decided to allow for quoted values in events. This implements and adds testing for ADDRMAP events. Unlike TorCtl we aren't falling back on a regex for the... er, 'wonderful' quoted stuff, but rather including quoted value support in the Event parser. Got test data by visiting a few sites in TBB... 650 ADDRMAP check.torproject.org 38.229.72.22 "2012-11-18 22:48:34" EXPIRES="2012-11-19 06:48:34" 650 ADDRMAP ocsp.digicert.com 5.63.145.124 "2012-11-18 21:53:42" EXPIRES="2012-11-19 05:53:42" 650 ADDRMAP www.atagar.com 75.119.206.243 "2012-11-19 00:50:13" EXPIRES="2012-11-19 08:50:13" --- docs/api/response.rst | 1 + stem/response/events.py | 89 ++++++++++++++++++++++++++++++++++++++---- test/unit/response/events.py | 17 ++++++++ 3 files changed, 99 insertions(+), 8 deletions(-) diff --git a/docs/api/response.rst b/docs/api/response.rst index 2f71256..a73f172 100644 --- a/docs/api/response.rst +++ b/docs/api/response.rst @@ -17,6 +17,7 @@ Events .. autoclass:: stem.response.events.Event .. autoclass:: stem.response.events.LogEvent +.. autoclass:: stem.response.events.AddrMapEvent .. autoclass:: stem.response.events.BandwidthEvent .. autoclass:: stem.response.events.CircuitEvent .. autoclass:: stem.response.events.NewDescEvent diff --git a/stem/response/events.py b/stem/response/events.py index 3df5430..941e796 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -1,4 +1,5 @@ import re +import datetime import stem import stem.control @@ -30,14 +31,13 @@ class Event(stem.response.ControlMessage): _POSITIONAL_ARGS = () _KEYWORD_ARGS = {} + _QUOTED = () def _parse_message(self, arrived_at): - fields = str(self).split() - - if not fields: + if not str(self).strip(): raise stem.ProtocolError("Received a blank tor event. Events must at the very least have a type.") - self.type = fields.pop(0) + self.type = str(self).split().pop(0) self.arrived_at = arrived_at # if we're a recognized event type then translate ourselves into that subclass @@ -45,13 +45,32 @@ class Event(stem.response.ControlMessage): if self.type in EVENT_TYPE_TO_CLASS: self.__class__ = EVENT_TYPE_TO_CLASS[self.type] + self.positional_args = [] + self.keyword_args = {} + + # Whoever decided to allow for quoted attributes in events should be + # punished. Preferably under some of those maritime laws that allow for + # flogging. Event parsing was nice until we threw this crap in... + # + # Pulling quoted keyword arguments out here. Quoted positonal arguments + # are handled later. + + content = str(self) + + for keyword in set(self._QUOTED).intersection(set(self._KEYWORD_ARGS.keys())): + match = re.match("^(.*) %s=\"(.*)\"(.*)$" % keyword, content) + + if match: + prefix, value, suffix = match.groups() + content = prefix + suffix + self.keyword_args[keyword] = value + + fields = content.split()[1:] + # Tor events contain some number of positional arguments followed by # key/value mappings. Parsing keyword arguments from the end until we hit # something that isn't a key/value mapping. The rest are positional. - self.positional_args = [] - self.keyword_args = {} - while fields: kw_match = KW_ARG.match(fields[-1]) @@ -69,7 +88,25 @@ class Event(stem.response.ControlMessage): for i in xrange(len(self._POSITIONAL_ARGS)): attr_name = self._POSITIONAL_ARGS[i] - attr_value = self.positional_args[i] if i < len(self.positional_args) else None + attr_value = None + + if self.positional_args: + if attr_name in self._QUOTED: + attr_values = [self.positional_args.pop(0)] + + if not attr_values[0].startswith('"'): + raise stem.ProtocolError("The %s value should be quoted, but didn't have a starting quote: %s" % self) + + while True: + if not self.positional_args: + raise stem.ProtocolError("The %s value should be quoted, but didn't have an ending quote: %s" % self) + + attr_values.append(self.positional_args.pop(0)) + if attr_values[-1].endswith('"'): break + + attr_value = " ".join(attr_values)[1:-1] + else: + attr_value = self.positional_args.pop(0) setattr(self, attr_name, attr_value) @@ -82,6 +119,41 @@ class Event(stem.response.ControlMessage): def _parse(self): pass +class AddrMapEvent(Event): + """ + Event that indicates a new address mapping. + + :var str hostname: address being resolved + :var str destination: destionation of the resolution, this is usually an ip, + but could be a hostname if TrackHostExits is enabled or **NONE** if the + resolution failed + :var datetime expiry: expiration time of the resolution in local time + :var str error: error code if the resolution failed + :var datetime gmt_expiry: expiration time of the resolution in gmt + """ + + # TODO: The spec for this event is a little vague. Making a couple guesses + # about it... + # + # https://trac.torproject.org/7515 + + _POSITIONAL_ARGS = ("hostname", "destination", "expiry") + _KEYWORD_ARGS = { + "error": "error", + "EXPIRES": "gmt_expiry", + } + _QUOTED = ("expiry", "EXPIRES") + + def _parse(self): + if self.destination == "<error>": + self.destination = None + + if self.expiry != None: + self.expiry = datetime.datetime.strptime(self.expiry, "%Y-%m-%d %H:%M:%S") + + if self.gmt_expiry != None: + self.gmt_expiry = datetime.datetime.strptime(self.gmt_expiry, "%Y-%m-%d %H:%M:%S") + class BandwidthEvent(Event): """ Event emitted every second with the bytes sent and received by tor. @@ -367,6 +439,7 @@ EVENT_TYPE_TO_CLASS = { "NOTICE": LogEvent, "WARN": LogEvent, "ERR": LogEvent, + "ADDRMAP": AddrMapEvent, "BW": BandwidthEvent, "CIRC": CircuitEvent, "NEWDESC": NewDescEvent, diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 733d826..c5eeb5b 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -66,6 +66,12 @@ NEWDESC_SINGLE = "650 NEWDESC $B3FA3110CC6F42443F039220C134CBD2FC4F0493=Sakura" NEWDESC_MULTIPLE = "650 NEWDESC $BE938957B2CA5F804B3AFC2C1EE6673170CDBBF8=Moonshine \ $B4BE08B22D4D2923EDC3970FD1B93D0448C6D8FF~Unnamed" +# ADDRMAP event +# TODO: it would be nice to have an example of an error event + +ADDRMAP = '650 ADDRMAP www.atagar.com 75.119.206.243 "2012-11-19 00:50:13" \ +EXPIRES="2012-11-19 08:50:13"' + def _get_event(content): controller_event = mocking.get_message(content) stem.response.convert("EVENT", controller_event, arrived_at = 25) @@ -121,6 +127,17 @@ class TestEvents(unittest.TestCase): self.assertEqual("WARN", event.runlevel) self.assertEqual("a multi-line\nwarning message", event.message) + def test_addrmap_event(self): + event = _get_event(ADDRMAP) + + self.assertTrue(isinstance(event, stem.response.events.AddrMapEvent)) + self.assertEqual(ADDRMAP.lstrip("650 "), str(event)) + self.assertEqual("www.atagar.com", event.hostname) + self.assertEqual("75.119.206.243", event.destination) + self.assertEqual(datetime.datetime(2012, 11, 19, 0, 50, 13), event.expiry) + self.assertEqual(None, event.error) + self.assertEqual(datetime.datetime(2012, 11, 19, 8, 50, 13), event.gmt_expiry) + def test_bw_event(self): event = _get_event("650 BW 15 25")

1 0

[stem/master] Reordering event tests
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 62b6f153e66a3b1a8adff3ac837c161e43576f2d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 18 14:47:27 2012 -0800 Reordering event tests We're using an alphabetical order elsewhere for the events (except logging events which are batched together at the top), so matching that in the unit tests. --- test/unit/response/events.py | 90 +++++++++++++++++++++--------------------- 1 files changed, 45 insertions(+), 45 deletions(-) diff --git a/test/unit/response/events.py b/test/unit/response/events.py index c17e84d..5836498 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -95,6 +95,51 @@ class TestEvents(unittest.TestCase): time.sleep(0.2) events_thread.join() + def test_log_events(self): + event = _get_event("650 DEBUG connection_edge_process_relay_cell(): Got an extended cell! Yay.") + + self.assertTrue(isinstance(event, stem.response.events.LogEvent)) + self.assertEqual("DEBUG", event.runlevel) + self.assertEqual("connection_edge_process_relay_cell(): Got an extended cell! Yay.", event.message) + + event = _get_event("650 INFO circuit_finish_handshake(): Finished building circuit hop:") + + self.assertTrue(isinstance(event, stem.response.events.LogEvent)) + self.assertEqual("INFO", event.runlevel) + self.assertEqual("circuit_finish_handshake(): Finished building circuit hop:", event.message) + + event = _get_event("650+WARN\na multi-line\nwarning message\n.\n650 OK\n") + + self.assertTrue(isinstance(event, stem.response.events.LogEvent)) + self.assertEqual("WARN", event.runlevel) + self.assertEqual("a multi-line\nwarning message", event.message) + + def test_bw_event(self): + event = _get_event("650 BW 15 25") + + self.assertTrue(isinstance(event, stem.response.events.BandwidthEvent)) + self.assertEqual(15, event.read) + self.assertEqual(25, event.written) + + event = _get_event("650 BW 0 0") + self.assertEqual(0, event.read) + self.assertEqual(0, event.written) + + # BW events are documented as possibly having various keywords including + # DIR, OR, EXIT, and APP in the future. This is kinda a pointless note + # since tor doesn't actually do it yet (and likely never will), but might + # as well sanity test that it'll be ok. + + event = _get_event("650 BW 10 20 OR=5 EXIT=500") + self.assertEqual(10, event.read) + self.assertEqual(20, event.written) + self.assertEqual({'OR': '5', 'EXIT': '500'}, event.keyword_args) + + self.assertRaises(ProtocolError, _get_event, "650 BW 15") + self.assertRaises(ProtocolError, _get_event, "650 BW -15 25") + self.assertRaises(ProtocolError, _get_event, "650 BW 15 -25") + self.assertRaises(ProtocolError, _get_event, "650 BW x 25") + def test_circ_event(self): event = _get_event(CIRC_LAUNCHED) @@ -321,49 +366,4 @@ class TestEvents(unittest.TestCase): self.assertEqual(None, event.source_address) self.assertEqual(None, event.source_port) self.assertEqual(None, event.purpose) - - def test_bw_event(self): - event = _get_event("650 BW 15 25") - - self.assertTrue(isinstance(event, stem.response.events.BandwidthEvent)) - self.assertEqual(15, event.read) - self.assertEqual(25, event.written) - - event = _get_event("650 BW 0 0") - self.assertEqual(0, event.read) - self.assertEqual(0, event.written) - - # BW events are documented as possibly having various keywords including - # DIR, OR, EXIT, and APP in the future. This is kinda a pointless note - # since tor doesn't actually do it yet (and likely never will), but might - # as well sanity test that it'll be ok. - - event = _get_event("650 BW 10 20 OR=5 EXIT=500") - self.assertEqual(10, event.read) - self.assertEqual(20, event.written) - self.assertEqual({'OR': '5', 'EXIT': '500'}, event.keyword_args) - - self.assertRaises(ProtocolError, _get_event, "650 BW 15") - self.assertRaises(ProtocolError, _get_event, "650 BW -15 25") - self.assertRaises(ProtocolError, _get_event, "650 BW 15 -25") - self.assertRaises(ProtocolError, _get_event, "650 BW x 25") - - def test_log_events(self): - event = _get_event("650 DEBUG connection_edge_process_relay_cell(): Got an extended cell! Yay.") - - self.assertTrue(isinstance(event, stem.response.events.LogEvent)) - self.assertEqual("DEBUG", event.runlevel) - self.assertEqual("connection_edge_process_relay_cell(): Got an extended cell! Yay.", event.message) - - event = _get_event("650 INFO circuit_finish_handshake(): Finished building circuit hop:") - - self.assertTrue(isinstance(event, stem.response.events.LogEvent)) - self.assertEqual("INFO", event.runlevel) - self.assertEqual("circuit_finish_handshake(): Finished building circuit hop:", event.message) - - event = _get_event("650+WARN\na multi-line\nwarning message\n.\n650 OK\n") - - self.assertTrue(isinstance(event, stem.response.events.LogEvent)) - self.assertEqual("WARN", event.runlevel) - self.assertEqual("a multi-line\nwarning message", event.message)

1 0

[stem/master] Stub for AUTHDIR_NEWDESCS events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 84ec250529b81cb86899897784602e6c41fb8d98 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Nov 20 09:37:54 2012 -0800 Stub for AUTHDIR_NEWDESCS events Implementing the parts that I can for AUTHDIR_NEWDESCS events. The spec doesn't provide enough detail for us to parse them (https://trac.torproject.org/7533) and I need an example of an event before I can test them (https://trac.torproject.org/7534) --- stem/__init__.py | 22 ++++++++++++++++++++++ stem/response/events.py | 35 +++++++++++++++++++++++++++++++++-- 2 files changed, 55 insertions(+), 2 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index f0fca41..c2c001a 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -230,6 +230,22 @@ Library for working with the tor process. **IOERROR** unknown **RESOURCELIMIT** unknown =================== =========== + +.. data:: AuthDescriptorAction (enum) + + Actions that directory authorities might take with relay descriptors. Tor may + provide reasons not in this enum. + + Enum descriptions are pending... + https://trac.torproject.org/7533 + + ===================== =========== + AuthDescriptorAction Description + ===================== =========== + **ACCEPTED** unknown + **DROPPED** unknown + **REJECTED** unknown + ===================== =========== """ __version__ = '0.0.1' @@ -443,3 +459,9 @@ ORClosureReason = stem.util.enum.UppercaseEnum( "RESOURCELIMIT", ) +AuthDescriptorAction = stem.util.enum.UppercaseEnum( + "ACCEPTED", + "DROPPED", + "REJECTED", +) + diff --git a/stem/response/events.py b/stem/response/events.py index 941e796..9e13974 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -32,6 +32,7 @@ class Event(stem.response.ControlMessage): _POSITIONAL_ARGS = () _KEYWORD_ARGS = {} _QUOTED = () + _SKIP_PARSING = False def _parse_message(self, arrived_at): if not str(self).strip(): @@ -48,6 +49,21 @@ class Event(stem.response.ControlMessage): self.positional_args = [] self.keyword_args = {} + if not self._SKIP_PARSING: + self._parse_standard_attr() + + self._parse() + + def _parse_standard_attr(self): + """ + Most events are of the form... + 650 *( positional_args ) *( key "=" value ) + + This parses this standard format, populating our **positional_args** and + **keyword_args** attributes and creating attributes if it's in our event's + **_POSITIONAL_ARGS** and **_KEYWORD_ARGS**. + """ + # Whoever decided to allow for quoted attributes in events should be # punished. Preferably under some of those maritime laws that allow for # flogging. Event parsing was nice until we threw this crap in... @@ -112,8 +128,6 @@ class Event(stem.response.ControlMessage): for controller_attr_name, attr_name in self._KEYWORD_ARGS.items(): setattr(self, attr_name, self.keyword_args.get(controller_attr_name)) - - self._parse() # method overwritten by our subclasses for special handling that they do def _parse(self): @@ -154,6 +168,20 @@ class AddrMapEvent(Event): if self.gmt_expiry != None: self.gmt_expiry = datetime.datetime.strptime(self.gmt_expiry, "%Y-%m-%d %H:%M:%S") +class AuthDirNewDescEvent(Event): + """ + Event specific to directory authorities, indicating that we just received new + descriptors. + + **Unimplemented, waiting on 'https://trac.torproject.org/7534'.** + + :var stem.AuthDescriptorAction action: what is being done with the descriptor + :var str message: unknown + :var stem.descriptor.Descriptor descriptor: unknown + """ + + _SKIP_PARSING = True + class BandwidthEvent(Event): """ Event emitted every second with the bytes sent and received by tor. @@ -263,6 +291,8 @@ class LogEvent(Event): :var str message: logged message """ + _SKIP_PARSING = True + def _parse(self): self.runlevel = self.type @@ -440,6 +470,7 @@ EVENT_TYPE_TO_CLASS = { "WARN": LogEvent, "ERR": LogEvent, "ADDRMAP": AddrMapEvent, + "AUTHDIR_NEWDESCS": AuthDirNewDescEvent, "BW": BandwidthEvent, "CIRC": CircuitEvent, "NEWDESC": NewDescEvent,

1 0

[stem/master] Support for NEWDESC events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 54f81be931196e92870b09119fa7e02a7a62cdbf Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 18 21:06:29 2012 -0800 Support for NEWDESC events Implementing and testing NEWDESC events. Got test data by listning for events right after starting a TBB instance... 650 NEWDESC $9C2007BE0D3785D5BAB204F0CFE07CF29F4B75EB~Unnamed 650 NEWDESC $A10C4F666D27364036B562823E5830BC448E046A=DFRI1 650 NEWDESC $A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1~tama 650 NEWDESC $A4E3D4A42E68D8302E4A3EA5D117EDCF0B157F72=tor1rufus 650 NEWDESC $B3BE230EEA146002C4A2A436B4EF7D897DE6C9B6~WombleNode01 650 NEWDESC $B3FA3110CC6F42443F039220C134CBD2FC4F0493=Sakura 650 NEWDESC $B4BE08B22D4D2923EDC3970FD1B93D0448C6D8FF~Unnamed 650 NEWDESC $B839D6CCC5438A21E547DB62043CB0192C068F51=brajah1 650 NEWDESC $B8B29766ACFADF832ABD1BCAA86497A20F54B584=stillhavenoipinfo 650 NEWDESC $BBE409F5791DAA52C2C3C9117CBA5AA55F3E2E88=Rarity 650 NEWDESC $BE938957B2CA5F804B3AFC2C1EE6673170CDBBF8=Moonshine 650 NEWDESC $C863FB2A6109C9CE2993C8855BAC59583B15475B=coinet 650 NEWDESC $CA37697301883DE9E895F642D76F3CD31E855434=Bitcoin 650 NEWDESC $CBC5F626F16052B2B987106D4845DF0B5197901D=mergeslittletornode 650 NEWDESC $CC19411EDD0BE139E8828EECE2F11E5DFE5F5C09~RadiantPickle 650 NEWDESC $CF334A712B78A84C6E8F2FF71987122E17951176=skye ... --- docs/api/response.rst | 3 +++ stem/control.py | 2 ++ stem/response/events.py | 22 +++++++++++++++++++--- test/unit/response/events.py | 23 +++++++++++++++++++++++ 4 files changed, 47 insertions(+), 3 deletions(-) diff --git a/docs/api/response.rst b/docs/api/response.rst index 043cae4..2f71256 100644 --- a/docs/api/response.rst +++ b/docs/api/response.rst @@ -19,4 +19,7 @@ Events .. autoclass:: stem.response.events.LogEvent .. autoclass:: stem.response.events.BandwidthEvent .. autoclass:: stem.response.events.CircuitEvent +.. autoclass:: stem.response.events.NewDescEvent +.. autoclass:: stem.response.events.ORConnEvent +.. autoclass:: stem.response.events.StreamEvent diff --git a/stem/control.py b/stem/control.py index 4a91129..3e0a61c 100644 --- a/stem/control.py +++ b/stem/control.py @@ -79,6 +79,8 @@ providing its own for interacting at a higher level. **ERR** :class:`stem.response.events.LogEvent` **BW** :class:`stem.response.events.BandwidthEvent` **CIRC** :class:`stem.response.events.CircuitEvent` + **NEWDESC** :class:`stem.response.events.NewDescEvent` + **ORCONN** :class:`stem.response.events.ORConnEvent` **STREAM** :class:`stem.response.events.StreamEvent` =========== =========== """ diff --git a/stem/response/events.py b/stem/response/events.py index 6a98ef6..3df5430 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -107,9 +107,9 @@ class CircuitEvent(Event): """ Event that indicates that a circuit has changed. - The fingerprint or nickname values in our path may be **None** if the - VERBOSE_NAMES feature is unavailable. The option was first introduced in tor - version 0.1.2.2. + The fingerprint or nickname values in our 'path' may be **None** if the + VERBOSE_NAMES feature isn't enabled. The option was first introduced in tor + version 0.1.2.2, and on by default after 0.2.2.1. :var str id: circuit identifier :var stem.CircStatus status: reported status for the circuit @@ -199,6 +199,21 @@ class LogEvent(Event): self.message = str(self)[len(self.runlevel) + 1:].rstrip("\nOK") +class NewDescEvent(Event): + """ + Event that indicates that a new descriptor is available. + + The fingerprint or nickname values in our 'relays' may be **None** if the + VERBOSE_NAMES feature isn't enabled. The option was first introduced in tor + version 0.1.2.2, and on by default after 0.2.2.1. + + :param tuple relays: **(fingerprint, nickname)** tuples for the relays with + new descriptors + """ + + def _parse(self): + self.relays = tuple([stem.control._parse_circ_entry(entry) for entry in str(self).split()[1:]]) + class ORConnEvent(Event): """ Event that indicates a change in a relay connection. The 'endpoint' could be @@ -354,6 +369,7 @@ EVENT_TYPE_TO_CLASS = { "ERR": LogEvent, "BW": BandwidthEvent, "CIRC": CircuitEvent, + "NEWDESC": NewDescEvent, "ORCONN": ORConnEvent, "STREAM": StreamEvent, } diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 5836498..733d826 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -59,6 +59,13 @@ STREAM_CLOSED_DONE = "650 STREAM 25 CLOSED 26 199.7.52.72:80 REASON=DONE" ORCONN_CONNECTED = "650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon CONNECTED" ORCONN_CLOSED = "650 ORCONN $A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1~tama CLOSED REASON=DONE" +# NEWDESC events. I've never actually seen multiple descriptors in an event, +# but the spec allows for it. + +NEWDESC_SINGLE = "650 NEWDESC $B3FA3110CC6F42443F039220C134CBD2FC4F0493=Sakura" +NEWDESC_MULTIPLE = "650 NEWDESC $BE938957B2CA5F804B3AFC2C1EE6673170CDBBF8=Moonshine \ +$B4BE08B22D4D2923EDC3970FD1B93D0448C6D8FF~Unnamed" + def _get_event(content): controller_event = mocking.get_message(content) stem.response.convert("EVENT", controller_event, arrived_at = 25) @@ -231,6 +238,22 @@ class TestEvents(unittest.TestCase): self.assertEqual(None, event.reason) self.assertEqual(None, event.remote_reason) + def test_newdesc_event(self): + event = _get_event(NEWDESC_SINGLE) + expected_relays = (("B3FA3110CC6F42443F039220C134CBD2FC4F0493", "Sakura"),) + + self.assertTrue(isinstance(event, stem.response.events.NewDescEvent)) + self.assertEqual(NEWDESC_SINGLE.lstrip("650 "), str(event)) + self.assertEqual(expected_relays, event.relays) + + event = _get_event(NEWDESC_MULTIPLE) + expected_relays = (("BE938957B2CA5F804B3AFC2C1EE6673170CDBBF8", "Moonshine"), + ("B4BE08B22D4D2923EDC3970FD1B93D0448C6D8FF", "Unnamed")) + + self.assertTrue(isinstance(event, stem.response.events.NewDescEvent)) + self.assertEqual(NEWDESC_MULTIPLE.lstrip("650 "), str(event)) + self.assertEqual(expected_relays, event.relays) + def test_orconn_event(self): event = _get_event(ORCONN_CONNECTED)

1 0

[stem/master] Replacing GMT refrences with UTC
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 92ab865999a3e6a4ed21311560e4b15c22ad4139 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 23 11:02:44 2012 -0800 Replacing GMT refrences with UTC Accouning for the spec change... https://gitweb.torproject.org/torspec.git/commitdiff/d581e63 --- stem/descriptor/extrainfo_descriptor.py | 2 +- stem/descriptor/server_descriptor.py | 2 +- stem/response/events.py | 8 ++++---- test/unit/response/events.py | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index ec259a8..1ad5d46 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -196,7 +196,7 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): :var str nickname: **\*** relay's nickname :var str fingerprint: **\*** identity key fingerprint - :var datetime published: **\*** time in GMT when this descriptor was made + :var datetime published: **\*** time in UTC when this descriptor was made :var str geoip_db_digest: sha1 of geoIP database file :var dict transport: **\*** mapping of transport methods to their (address, port, args) tuple, these usually appear on bridges in which case all of diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index a1d4055..584d426 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -132,7 +132,7 @@ class ServerDescriptor(stem.descriptor.Descriptor): :var str nickname: **\*** relay's nickname :var str fingerprint: identity key fingerprint - :var datetime published: **\*** time in GMT when this descriptor was made + :var datetime published: **\*** time in UTC when this descriptor was made :var str address: **\*** IPv4 address of the relay :var int or_port: **\*** port used for relaying diff --git a/stem/response/events.py b/stem/response/events.py index f6027aa..c066097 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -143,7 +143,7 @@ class AddrMapEvent(Event): resolution failed :var datetime expiry: expiration time of the resolution in local time :var str error: error code if the resolution failed - :var datetime gmt_expiry: expiration time of the resolution in gmt + :var datetime utc_expiry: expiration time of the resolution in UTC """ # TODO: The spec for this event is a little vague. Making a couple guesses @@ -154,7 +154,7 @@ class AddrMapEvent(Event): _POSITIONAL_ARGS = ("hostname", "destination", "expiry") _KEYWORD_ARGS = { "error": "error", - "EXPIRES": "gmt_expiry", + "EXPIRES": "utc_expiry", } _QUOTED = ("expiry", "EXPIRES") @@ -165,8 +165,8 @@ class AddrMapEvent(Event): if self.expiry != None: self.expiry = datetime.datetime.strptime(self.expiry, "%Y-%m-%d %H:%M:%S") - if self.gmt_expiry != None: - self.gmt_expiry = datetime.datetime.strptime(self.gmt_expiry, "%Y-%m-%d %H:%M:%S") + if self.utc_expiry != None: + self.utc_expiry = datetime.datetime.strptime(self.utc_expiry, "%Y-%m-%d %H:%M:%S") class AuthDirNewDescEvent(Event): """ diff --git a/test/unit/response/events.py b/test/unit/response/events.py index c0d1fca..ef2699e 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -136,7 +136,7 @@ class TestEvents(unittest.TestCase): self.assertEqual("75.119.206.243", event.destination) self.assertEqual(datetime.datetime(2012, 11, 19, 0, 50, 13), event.expiry) self.assertEqual(None, event.error) - self.assertEqual(datetime.datetime(2012, 11, 19, 8, 50, 13), event.gmt_expiry) + self.assertEqual(datetime.datetime(2012, 11, 19, 8, 50, 13), event.utc_expiry) def test_authdir_newdesc_event(self): # TODO: We aren't actually parsing the event yet. Until then we can only

1 0

[stem/master] Support for ORCONN events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit a1a5784d480421af4394b3e012d6f4bbb8ee6c8b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 18 14:44:05 2012 -0800 Support for ORCONN events Implementation and tests for ORCONN events. These have several holes in its documentation (https://trac.torproject.org/7513) so I'm not really sure what these events actually are. Reguardless, got some samples by connecting to TBB and issuing a NEWNYM. AUTHENTICATE 250 OK SETEVENTS ORCONN 250 OK 650 ORCONN $1D024F41EDBF3F061E1341D516543090D8A44B42=AccessNowKromyon21 CONNECTED 650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon CONNECTED 650 ORCONN $A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1~tama CLOSED REASON=DONE --- stem/__init__.py | 82 ++++++++++++++++++++++++++++++++++++---- stem/control.py | 70 ++++++++++++++++++++-------------- stem/response/events.py | 86 ++++++++++++++++++++++++++++++++++++++--- test/unit/response/events.py | 32 +++++++++++++++ 4 files changed, 227 insertions(+), 43 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 7b3f6ee..f0fca41 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -62,7 +62,7 @@ Library for working with the tor process. .. data:: CircClosureReason (enum) Reason that a circuit is being closed or failed to be established. Tor may - provide purposes not in this enum. + provide reasons not in this enum. ========================= =========== CircClosureReason Description @@ -138,7 +138,7 @@ Library for working with the tor process. .. data:: StreamClosureReason (enum) Reason that a stream is being closed or failed to be established. Tor may - provide purposes not in this enum. + provide reasons not in this enum. ===================== =========== StreamClosureReason Description @@ -163,7 +163,8 @@ Library for working with the tor process. .. data:: StreamSource (enum) - Cause of a stream being remapped to another address. + Cause of a stream being remapped to another address. Tor may provide sources + not in this enum. ============= =========== StreamSource Description @@ -177,15 +178,58 @@ Library for working with the tor process. Purpsoe of the stream. This is only provided with new streams and tor may provide purposes not in this enum. + Enum descriptions are pending... + https://trac.torproject.org/7508 + ================= =========== StreamPurpose Description ================= =========== - **DIR_FETCH** unknown (https://trac.torproject.org/7508) - **UPLOAD_DESC** unknown (https://trac.torproject.org/7508) - **DNS_REQUEST** unknown (https://trac.torproject.org/7508) - **USER** unknown (https://trac.torproject.org/7508) - **DIRPORT_TEST** unknown (https://trac.torproject.org/7508) + **DIR_FETCH** unknown + **UPLOAD_DESC** unknown + **DNS_REQUEST** unknown + **USER** unknown + **DIRPORT_TEST** unknown ================= =========== + +.. data:: ORStatus (enum) + + State that an OR connection can have. Tor may provide states not in this + enum. + + Enum descriptions are pending... + https://trac.torproject.org/7513 + + =============== =========== + ORStatus Description + =============== =========== + **NEW** unknown + **LAUNCHED** unknown + **CONNECTED** unknown + **FAILED** unknown + **CLOSED** unknown + =============== =========== + +.. data:: ORClosureReason (enum) + + Reason that an OR connection is being closed or failed to be established. Tor + may provide reasons not in this enum. + + Enum descriptions are pending... + https://trac.torproject.org/7513 + + =================== =========== + ORClosureReason Description + =================== =========== + **MISC** unknown + **DONE** unknown + **CONNECTREFUSED** unknown + **IDENTITY** unknown + **CONNECTRESET** unknown + **TIMEOUT** unknown + **NOROUTE** unknown + **IOERROR** unknown + **RESOURCELIMIT** unknown + =================== =========== """ __version__ = '0.0.1' @@ -222,6 +266,8 @@ __all__ = [ "StreamClosureReason", "StreamSource", "StreamPurpose", + "ORStatus", + "ORClosureReason", ] import stem.util.enum @@ -377,3 +423,23 @@ StreamPurpose = stem.util.enum.UppercaseEnum( "DIRPORT_TEST", ) +ORStatus = stem.util.enum.UppercaseEnum( + "NEW", + "LAUNCHED", + "CONNECTED", + "FAILED", + "CLOSED", +) + +ORClosureReason = stem.util.enum.UppercaseEnum( + "MISC", + "DONE", + "CONNECTREFUSED", + "IDENTITY", + "CONNECTRESET", + "TIMEOUT", + "NOROUTE", + "IOERROR", + "RESOURCELIMIT", +) + diff --git a/stem/control.py b/stem/control.py index d7dec9a..4a91129 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1500,36 +1500,50 @@ def _parse_circ_path(path): :raises: :class:`stem.ProtocolError` if the path is malformed """ - if not path: return [] - - circ_path = [] - - for path_component in path.split(','): - if '=' in path_component: - # common case - fingerprint, nickname = path_component.split('=') - elif '~' in path_component: - # this is allowed for by the spec, but I've never seen it used - fingerprint, nickname = path_component.split('~') - elif path_component[0] == '$': - # old style, fingerprint only - fingerprint, nickname = path_component, None - else: - # old style, nickname only - fingerprint, nickname = None, path_component - - if fingerprint != None: - if not stem.util.tor_tools.is_valid_fingerprint(fingerprint, True): - raise stem.ProtocolError("Fingerprint in the circuit path is malformed (%s): %s" % (fingerprint, path)) - - fingerprint = fingerprint[1:] # strip off the leading '$' - - if nickname != None and not stem.util.tor_tools.is_valid_nickname(nickname): - raise stem.ProtocolError("Nickname in the circuit path is malformed (%s): %s" % (fingerprint, path)) + if path: + try: + return [_parse_circ_entry(entry) for entry in path.split(',')] + except stem.ProtocolError, exc: + # include the path with the exception + raise stem.ProtocolError("%s: %s" % (exc, path)) + else: + return [] + +def _parse_circ_entry(entry): + """ + Parses a single relay's 'LongName' or 'ServerID'. See the + :func:`~_stem.control._parse_circ_path` function for more information. + + :param str entry: relay information to be parsed + + :returns: **(fingerprint, nickname)** tuple + + :raises: :class:`stem.ProtocolError` if the entry is malformed + """ + + if '=' in entry: + # common case + fingerprint, nickname = entry.split('=') + elif '~' in entry: + # this is allowed for by the spec, but I've never seen it used + fingerprint, nickname = entry.split('~') + elif entry[0] == '$': + # old style, fingerprint only + fingerprint, nickname = entry, None + else: + # old style, nickname only + fingerprint, nickname = None, entry + + if fingerprint != None: + if not stem.util.tor_tools.is_valid_fingerprint(fingerprint, True): + raise stem.ProtocolError("Fingerprint in the circuit path is malformed (%s)" % fingerprint) - circ_path.append((fingerprint, nickname)) + fingerprint = fingerprint[1:] # strip off the leading '$' + + if nickname != None and not stem.util.tor_tools.is_valid_nickname(nickname): + raise stem.ProtocolError("Nickname in the circuit path is malformed (%s)" % fingerprint) - return circ_path + return (fingerprint, nickname) def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/stem/response/events.py b/stem/response/events.py index 0e7a71e..6a98ef6 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -12,6 +12,10 @@ from stem.util import connection, log, str_tools, tor_tools KW_ARG = re.compile("([A-Za-z0-9_]+)=(.*)") +# base message for when we get attributes not covered by our enums + +UNRECOGNIZED_ATTR_MSG = "%s event had an unrecognized %%s (%%s). Maybe a new addition to the control protocol? Full Event: '%s'" + class Event(stem.response.ControlMessage): """ Base for events we receive asynchronously, as described in section 4.1 of the @@ -150,7 +154,7 @@ class CircuitEvent(Event): # log if we have an unrecognized status, build flag, purpose, hidden # service state, or closure reason - unrecognized_msg = "CIRC event had an unrecognized %%s (%%s). Maybe a new addition to the control protocol? Full Event: '%s'" % self + unrecognized_msg = UNRECOGNIZED_ATTR_MSG % ("CIRC", self) if self.status and (not self.status in stem.CircStatus): log_id = "event.circ.unknown_status.%s" % self.status @@ -195,6 +199,73 @@ class LogEvent(Event): self.message = str(self)[len(self.runlevel) + 1:].rstrip("\nOK") +class ORConnEvent(Event): + """ + Event that indicates a change in a relay connection. The 'endpoint' could be + any of several things including a... + + * fingerprint + * nickname + * 'fingerprint=nickname' pair + * address:port + + The derived 'endpoint_*' attributes are generally more useful. + + :var str endpoint: relay that the event concerns + :var str endpoint_fingerprint: endpoint's finterprint if it was provided + :var str endpoint_nickname: endpoint's nickname if it was provided + :var str endpoint_address: endpoint's address if it was provided + :var int endpoint_port: endpoint's port if it was provided + :var stem.ORStatus status: state of the connection + :var stem.ORClosureReason reason: reason for the connection to be closed + :var int circ_count: number of established and pending circuits + """ + + _POSITIONAL_ARGS = ("endpoint", "status") + _KEYWORD_ARGS = { + "REASON": "reason", + "NCIRCS": "circ_count", + } + + def _parse(self): + self.endpoint_fingerprint = None + self.endpoint_nickname = None + self.endpoint_address = None + self.endpoint_port = None + + try: + self.endpoint_fingerprint, self.endpoint_nickname = \ + stem.control._parse_circ_entry(self.endpoint) + except stem.ProtocolError: + if not ':' in self.endpoint: + raise stem.ProtocolError("ORCONN endpoint is neither a relay nor 'address:port': %s" % self) + + address, port = self.endpoint.split(':', 1) + + if not connection.is_valid_port(port): + raise stem.ProtocolError("ORCONN's endpoint location's port is invalid: %s" % self) + + self.endpoint_address = address + self.endpoint_port = int(port) + + if self.circ_count != None: + if not self.circ_count.isdigit(): + raise stem.ProtocolError("ORCONN event got a non-numeric circuit count (%s): %s" % (self.circ_count, self)) + + self.circ_count = int(self.circ_count) + + # log if we have an unrecognized status or reason + + unrecognized_msg = UNRECOGNIZED_ATTR_MSG % ("ORCONN", self) + + if self.status and (not self.status in stem.ORStatus): + log_id = "event.orconn.unknown_status.%s" % self.status + log.log_once(log_id, log.INFO, unrecognized_msg % ('status', self.status)) + + if self.reason and (not self.reason in stem.ORClosureReason): + log_id = "event.orconn.unknown_reason.%s" % self.reason + log.log_once(log_id, log.INFO, unrecognized_msg % ('reason', self.reason)) + class StreamEvent(Event): """ Event that indicates that a stream has changed. @@ -231,7 +302,7 @@ class StreamEvent(Event): if not ':' in self.target: raise stem.ProtocolError("Target location must be of the form 'address:port': %s" % self) - address, port = self.target.split(':') + address, port = self.target.split(':', 1) if not connection.is_valid_port(port): raise stem.ProtocolError("Target location's port is invalid: %s" % self) @@ -246,7 +317,7 @@ class StreamEvent(Event): if not ':' in self.source_addr: raise stem.ProtocolError("Source location must be of the form 'address:port': %s" % self) - address, port = self.source_addr.split(':') + address, port = self.source_addr.split(':', 1) if not connection.is_valid_port(port): raise stem.ProtocolError("Source location's port is invalid: %s" % self) @@ -261,7 +332,7 @@ class StreamEvent(Event): # log if we have an unrecognized closure reason or purpose - unrecognized_msg = "STREAM event had an unrecognized %%s (%%s). Maybe a new addition to the control protocol? Full Event: '%s'" % self + unrecognized_msg = UNRECOGNIZED_ATTR_MSG % ("STREAM", self) if self.reason and (not self.reason in stem.StreamClosureReason): log_id = "event.stream.reason.%s" % self.reason @@ -276,13 +347,14 @@ class StreamEvent(Event): log.log_once(log_id, log.INFO, unrecognized_msg % ('purpose', self.purpose)) EVENT_TYPE_TO_CLASS = { - "CIRC": CircuitEvent, - "STREAM": StreamEvent, - "BW": BandwidthEvent, "DEBUG": LogEvent, "INFO": LogEvent, "NOTICE": LogEvent, "WARN": LogEvent, "ERR": LogEvent, + "BW": BandwidthEvent, + "CIRC": CircuitEvent, + "ORCONN": ORConnEvent, + "STREAM": StreamEvent, } diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 3fe22de..c17e84d 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -54,6 +54,11 @@ STREAM_SUCCEEDED = "650 STREAM 18 SUCCEEDED 26 74.125.227.129:443" STREAM_CLOSED_RESET = "650 STREAM 21 CLOSED 26 74.125.227.129:443 REASON=CONNRESET" STREAM_CLOSED_DONE = "650 STREAM 25 CLOSED 26 199.7.52.72:80 REASON=DONE" +# ORCONN events from starting tor 0.2.2.39 via TBB + +ORCONN_CONNECTED = "650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon CONNECTED" +ORCONN_CLOSED = "650 ORCONN $A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1~tama CLOSED REASON=DONE" + def _get_event(content): controller_event = mocking.get_message(content) stem.response.convert("EVENT", controller_event, arrived_at = 25) @@ -181,6 +186,33 @@ class TestEvents(unittest.TestCase): self.assertEqual(None, event.reason) self.assertEqual(None, event.remote_reason) + def test_orconn_event(self): + event = _get_event(ORCONN_CONNECTED) + + self.assertTrue(isinstance(event, stem.response.events.ORConnEvent)) + self.assertEqual(ORCONN_CONNECTED.lstrip("650 "), str(event)) + self.assertEqual("$7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon", event.endpoint) + self.assertEqual("7ED90E2833EE38A75795BA9237B0A4560E51E1A0", event.endpoint_fingerprint) + self.assertEqual("GreenDragon", event.endpoint_nickname) + self.assertEqual(None, event.endpoint_address) + self.assertEqual(None, event.endpoint_port) + self.assertEqual(ORStatus.CONNECTED, event.status) + self.assertEqual(None, event.reason) + self.assertEqual(None, event.circ_count) + + event = _get_event(ORCONN_CLOSED) + + self.assertTrue(isinstance(event, stem.response.events.ORConnEvent)) + self.assertEqual(ORCONN_CLOSED.lstrip("650 "), str(event)) + self.assertEqual("$A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1~tama", event.endpoint) + self.assertEqual("A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1", event.endpoint_fingerprint) + self.assertEqual("tama", event.endpoint_nickname) + self.assertEqual(None, event.endpoint_address) + self.assertEqual(None, event.endpoint_port) + self.assertEqual(ORStatus.CLOSED, event.status) + self.assertEqual(ORClosureReason.DONE, event.reason) + self.assertEqual(None, event.circ_count) + def test_stream_event(self): event = _get_event(STREAM_NEW)

1 0

[stem/master] Documenting the StreamPurpose values
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 404025ec9a7f0614742ce35ae13a1a001e4d9f9e Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 23 11:43:13 2012 -0800 Documenting the StreamPurpose values Description for the STREAM event's PURPOSE field were added to the spec to reflecting that here. bug report: https://trac.torproject.org/7508 fix: https://gitweb.torproject.org/torspec.git/commitdiff/e23a24a --- stem/__init__.py | 17 ++++++++--------- 1 files changed, 8 insertions(+), 9 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 8b5a5c2..4ba83d7 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -178,17 +178,15 @@ Library for working with the tor process. Purpsoe of the stream. This is only provided with new streams and tor may provide purposes not in this enum. - Enum descriptions are pending... - https://trac.torproject.org/7508 - ================= =========== StreamPurpose Description ================= =========== - **DIR_FETCH** unknown - **UPLOAD_DESC** unknown - **DNS_REQUEST** unknown - **USER** unknown - **DIRPORT_TEST** unknown + **DIR_FETCH** fetching directory information (descriptors, consensus, etc) + **DIR_UPLOAD** uploading our descriptor to an authority + **UPLOAD_DESC** obsolete + **DNS_REQUEST** user initiated DNS request + **DIRPORT_TEST** checking that our directory port is reachable externally + **USER** either relaying user traffic or not one of the above categories ================= =========== .. data:: ORStatus (enum) @@ -433,10 +431,11 @@ StreamSource = stem.util.enum.UppercaseEnum( StreamPurpose = stem.util.enum.UppercaseEnum( "DIR_FETCH", + "DIR_UPLOAD", "UPLOAD_DESC", "DNS_REQUEST", - "USER", "DIRPORT_TEST", + "USER", ) ORStatus = stem.util.enum.UppercaseEnum(

1 0

[stem/master] Parsing AUTHDIR_NEWDESCS events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 0f4e52bf20ae82a8951ed910639f0e4fa41aeac8 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 23 19:54:58 2012 -0800 Parsing AUTHDIR_NEWDESCS events The specification for the AUTHDIR_NEWDESCS event type was expanded in... https://gitweb.torproject.org/torspec.git/commitdiff/a1331ca We still don't have an example of the event so no tests, but it's enough to implement the parsing. It would be nice if the event type included a field for the descriptor type, but oh well. --- stem/response/events.py | 21 ++++++++++++++++----- test/unit/response/events.py | 3 +-- 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index c066097..e571c4e 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -171,16 +171,27 @@ class AddrMapEvent(Event): class AuthDirNewDescEvent(Event): """ Event specific to directory authorities, indicating that we just received new - descriptors. - - **Unimplemented, waiting on 'https://trac.torproject.org/7534'.** + descriptors. The descriptor type contained within this event is unspecified + so the descriptor contents are left unparsed. :var stem.AuthDescriptorAction action: what is being done with the descriptor - :var str message: unknown - :var stem.descriptor.Descriptor descriptor: unknown + :var str message: explanation of why we chose this action + :var str descriptor: content of the descriptor """ _SKIP_PARSING = True + + def _parse(self): + lines = str(self).split('\n') + + if len(lines) < 5: + raise stem.ProtocolError("AUTHDIR_NEWDESCS events must contain lines for at least the type, action, message, descriptor, and terminating 'OK'") + elif not lines[-1] == "OK": + raise stem.ProtocolError("AUTHDIR_NEWDESCS doesn't end with an 'OK'") + + self.action = lines[1] + self.message = lines[2] + self.descriptor = '\n'.join(lines[3:-1]) class BandwidthEvent(Event): """ diff --git a/test/unit/response/events.py b/test/unit/response/events.py index ef2699e..0a5921f 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -142,10 +142,9 @@ class TestEvents(unittest.TestCase): # TODO: We aren't actually parsing the event yet. Until then we can only # check that we properly get a AuthDirNewDescEvent for it. - event = _get_event("650 AUTHDIR_NEWDESCS") + event = _get_event("650+AUTHDIR_NEWDESCS\nAction\nMessage\nDescriptor\n.\n650 OK\n") self.assertTrue(isinstance(event, stem.response.events.AuthDirNewDescEvent)) - self.assertEqual("AUTHDIR_NEWDESCS", str(event)) self.assertEqual([], event.positional_args) self.assertEqual({}, event.keyword_args)

1 0

[stem/master] Adding descriptions for ORStatus and ORClosureReason
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit df9a051783a94b831aa1c93c8592d6c46397a229 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 23 12:36:28 2012 -0800 Adding descriptions for ORStatus and ORClosureReason Spec has been expanded with descriptions for the ORCONN fields. I'm still not sure what these events mean nor what many of these values are actually trying to indicate, but it's enough for me to parrot the descriptions. bug report: https://trac.torproject.org/7513 fix: https://gitweb.torproject.org/torspec.git/commitdiff/036e256 --- stem/__init__.py | 36 +++++++++++++++--------------------- 1 files changed, 15 insertions(+), 21 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 4ba83d7..5dfc55f 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -194,17 +194,14 @@ Library for working with the tor process. State that an OR connection can have. Tor may provide states not in this enum. - Enum descriptions are pending... - https://trac.torproject.org/7513 - =============== =========== ORStatus Description =============== =========== - **NEW** unknown - **LAUNCHED** unknown - **CONNECTED** unknown - **FAILED** unknown - **CLOSED** unknown + **NEW** received OR connection, starting server-side handshake + **LAUNCHED** launched outbound OR connection, starting client-side handshake + **CONNECTED** OR connection has been established + **FAILED** attempt to establish OR connection failed + **CLOSED** OR connection has been closed =============== =========== .. data:: ORClosureReason (enum) @@ -212,21 +209,18 @@ Library for working with the tor process. Reason that an OR connection is being closed or failed to be established. Tor may provide reasons not in this enum. - Enum descriptions are pending... - https://trac.torproject.org/7513 - =================== =========== ORClosureReason Description =================== =========== - **MISC** unknown - **DONE** unknown - **CONNECTREFUSED** unknown - **IDENTITY** unknown - **CONNECTRESET** unknown - **TIMEOUT** unknown - **NOROUTE** unknown - **IOERROR** unknown - **RESOURCELIMIT** unknown + **DONE** OR connection shut down cleanly + **CONNECTREFUSED** got a ECONNREFUSED when connecting to the relay + **IDENTITY** identity of the relay wasn't what we expected + **CONNECTRESET** got a ECONNRESET or similar error from relay + **TIMEOUT** got a ETIMEOUT or similar error from relay + **NOROUTE** got a ENOTCONN, ENETUNREACH, ENETDOWN, EHOSTUNREACH, or similar error from relay + **IOERROR** got a different kind of error from relay + **RESOURCELIMIT** relay has insufficient resources to service the request + **MISC** connection refused for another reason =================== =========== .. data:: AuthDescriptorAction (enum) @@ -447,7 +441,6 @@ ORStatus = stem.util.enum.UppercaseEnum( ) ORClosureReason = stem.util.enum.UppercaseEnum( - "MISC", "DONE", "CONNECTREFUSED", "IDENTITY", @@ -456,6 +449,7 @@ ORClosureReason = stem.util.enum.UppercaseEnum( "NOROUTE", "IOERROR", "RESOURCELIMIT", + "MISC", ) AuthDescriptorAction = stem.util.enum.UppercaseEnum(

1 0