tor-commits December 2012

tor-commits@lists.torproject.org

17 participants
1600 discussions

[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

[stem/master] Dropped StreamPurpose.UPLOAD_DESC
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit af527bdc1b87586c201ffd7fa288f40e29e33598 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 23 17:01:52 2012 -0800 Dropped StreamPurpose.UPLOAD_DESC Dropping UPLOAD_DESC, which was evidently never used... https://gitweb.torproject.org/torspec.git/commitdiff/36d7d05 --- stem/__init__.py | 2 -- 1 files changed, 0 insertions(+), 2 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 5dfc55f..3cf01b8 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -183,7 +183,6 @@ Library for working with the tor process. ================= =========== **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 @@ -426,7 +425,6 @@ StreamSource = stem.util.enum.UppercaseEnum( StreamPurpose = stem.util.enum.UppercaseEnum( "DIR_FETCH", "DIR_UPLOAD", - "UPLOAD_DESC", "DNS_REQUEST", "DIRPORT_TEST", "USER",

1 0

[stem/master] Adding CircClosureReason.MEASUREMENT_EXPIRED description
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 4ce0be17442a4c21612eefb6cbe426aebbfc722f Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 23 11:31:14 2012 -0800 Adding CircClosureReason.MEASUREMENT_EXPIRED description Spec was updated with a description so reflecting that here. bug report: https://trac.torproject.org/7506 fix: https://gitweb.torproject.org/torspec.git/commitdiff/de62160 --- stem/__init__.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index c2c001a..8b5a5c2 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -81,7 +81,7 @@ Library for working with the tor process. **DESTROYED** circuit unexpectedly closed **NOPATH** not enough relays to make a circuit **NOSUCHSERVICE** requested hidden service does not exist - **MEASUREMENT_EXPIRED** unknown (https://trac.torproject.org/7506) + **MEASUREMENT_EXPIRED** same as **TIMEOUT** except that it was left open for measurement purposes ========================= =========== .. data:: HiddenServiceState (enum)

1 0

[stem/master] Initial support for STATUS_* events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 628dd1f3246566bf4d7b4b2e2932f459bec32986 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Nov 29 18:49:50 2012 -0800 Initial support for STATUS_* events The STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER events all follow a nice, well specified format. The specific action instances for these events warrant subclasses, but to start with adding the StatusEvent class which covers the basic attributes. --- stem/__init__.py | 43 ++++++++++++++++++++++++++++ stem/control.py | 23 ++++++++++---- stem/response/events.py | 57 ++++++++++++++++++++++++++++++++---- test/unit/response/events.py | 64 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 173 insertions(+), 14 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 68bda60..c0b47fd 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -14,6 +14,20 @@ Library for working with the tor process. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. +.. data:: Runlevel (enum) + + Rating of importance used for event logging. + + =========== =========== + Runlevel Description + =========== =========== + **ERR** critical issues that impair tor's ability to function + **WARN** non-critical issues the user should be aware of + **NOTICE** information that may be helpful to the user + **INFO** high level runtime information + **DEBUG** low level runtime information + =========== =========== + .. data:: CircStatus (enum) Statuses that a circuit can be in. Tor may provide statuses not in this enum. @@ -234,6 +248,18 @@ Library for working with the tor process. **DROPPED** descriptor rejected without notifying the relay **REJECTED** relay notified that its descriptor has been rejected ===================== =========== + +.. data:: StatusType (enum) + + Sources for tor status events. Tor may provide types not in this enum. + + ============= =========== + StatusType Description + ============= =========== + **GENERAL** general tor activity, not specifically as a client or relay + **CLIENT** related to our activity as a tor client + **SERVER** related to our activity as a tor relay + ============= =========== """ __version__ = '0.0.1' @@ -261,6 +287,7 @@ __all__ = [ "InvalidArguments", "SocketError", "SocketClosed", + "Runlevel", "CircStatus", "CircBuildFlag", "CircPurpose", @@ -272,6 +299,8 @@ __all__ = [ "StreamPurpose", "ORStatus", "ORClosureReason", + "AuthDescriptorAction", + "StatusType", ] import stem.util.enum @@ -326,6 +355,14 @@ class SocketError(ControllerError): class SocketClosed(SocketError): "Control socket was closed before completing the message." +Runlevel = stem.util.enum.UppercaseEnum( + "DEBUG", + "INFO", + "NOTICE", + "WARN", + "ERR", +) + CircStatus = stem.util.enum.UppercaseEnum( "LAUNCHED", "BUILT", @@ -453,3 +490,9 @@ AuthDescriptorAction = stem.util.enum.UppercaseEnum( "REJECTED", ) +StatusType = stem.util.enum.UppercaseEnum( + "GENERAL", + "CLIENT", + "SERVER", +) + diff --git a/stem/control.py b/stem/control.py index 29b77ef..45b7df8 100644 --- a/stem/control.py +++ b/stem/control.py @@ -66,25 +66,34 @@ providing its own for interacting at a higher level. Known types of events that the :func:`~stem.control.Controller.add_event_listener` method of the - :class:`~stem.control.Controller` can listen for. Enums are mapped to - :class:`~stem.response.events.Event` subclasses as follows... + :class:`~stem.control.Controller` can listen for. + + The most frequently listened for event types tend to be the logging events + (**DEBUG**, **INFO**, **NOTICE**, **WARN**, and **ERR**), bandwidth usage + (**BW**), and circuit or stream changes (**CIRC** and **STREAM**). + + 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` **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` + **DEBUG** :class:`stem.response.events.LogEvent` **DESCCHANGED** :class:`stem.response.events.DescChangedEvent` + **ERR** :class:`stem.response.events.LogEvent` + **INFO** :class:`stem.response.events.LogEvent` **NEWDESC** :class:`stem.response.events.NewDescEvent` + **NOTICE** :class:`stem.response.events.LogEvent` **ORCONN** :class:`stem.response.events.ORConnEvent` + **STATUS_CLIENT** :class:`stem.response.events.StatusEvent` + **STATUS_GENERAL** :class:`stem.response.events.StatusEvent` + **STATUS_SERVER** :class:`stem.response.events.StatusEvent` **STREAM** :class:`stem.response.events.StreamEvent` + **WARN** :class:`stem.response.events.LogEvent` ===================== =========== """ diff --git a/stem/response/events.py b/stem/response/events.py index e571c4e..ab0e5ef 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -304,9 +304,9 @@ class DescChangedEvent(Event): class LogEvent(Event): """ Tor logging event. These are the most visible kind of event since, by - default, tor logs at the NOTICE runlevel to stdout. + default, tor logs at the NOTICE :data:`~stem.Runlevel` to stdout. - :var str runlevel: runlevel of the logged message + :var stem.Runlevel runlevel: runlevel of the logged message :var str message: logged message """ @@ -319,6 +319,14 @@ class LogEvent(Event): # multi-line message self.message = str(self)[len(self.runlevel) + 1:].rstrip("\nOK") + + # log if our runlevel isn't recognized + + unrecognized_msg = UNRECOGNIZED_ATTR_MSG % ("Logging", self) + + if not self.runlevel in stem.Runlevel: + log_id = "event.logging.unknown_runlevel.%s" % self.runlevel + log.log_once(log_id, log.INFO, unrecognized_msg % ('runlevel', self.runlevel)) class NewDescEvent(Event): """ @@ -402,6 +410,38 @@ class ORConnEvent(Event): log_id = "event.orconn.unknown_reason.%s" % self.reason log.log_once(log_id, log.INFO, unrecognized_msg % ('reason', self.reason)) +class StatusEvent(Event): + """ + Notification of a change in tor's state. These are generally triggered for + the same sort of things as log messages of the NOTICE level or higher. + However, unlike :class:`~stem.response.events.LogEvent` these contain well + formed data. + + :var stem.StatusType status_type: category of the status event + :var stem.Runlevel runlevel: runlevel of the logged message + :var str message: logged message + """ + + _POSITIONAL_ARGS = ("runlevel", "action") + + def _parse(self): + if self.type == 'STATUS_GENERAL': + self.status_type = stem.StatusType.GENERAL + elif self.type == 'STATUS_CLIENT': + self.status_type = stem.StatusType.CLIENT + elif self.type == 'STATUS_SERVER': + self.status_type = stem.StatusType.SERVER + else: + raise ValueError("BUG: Unrecognized status type (%s), likely an EVENT_TYPE_TO_CLASS addition without revising how 'status_type' is assigned." % self.type) + + # log if our runlevel isn't recognized + + unrecognized_msg = UNRECOGNIZED_ATTR_MSG % ("Status", self) + + if not self.runlevel in stem.Runlevel: + log_id = "event.status.unknown_runlevel.%s" % self.runlevel + log.log_once(log_id, log.INFO, unrecognized_msg % ('runlevel', self.runlevel)) + class StreamEvent(Event): """ Event that indicates that a stream has changed. @@ -483,18 +523,21 @@ class StreamEvent(Event): log.log_once(log_id, log.INFO, unrecognized_msg % ('purpose', self.purpose)) EVENT_TYPE_TO_CLASS = { - "DEBUG": LogEvent, - "INFO": LogEvent, - "NOTICE": LogEvent, - "WARN": LogEvent, - "ERR": LogEvent, "ADDRMAP": AddrMapEvent, "AUTHDIR_NEWDESCS": AuthDirNewDescEvent, "BW": BandwidthEvent, "CIRC": CircuitEvent, + "DEBUG": LogEvent, "DESCCHANGED": DescChangedEvent, + "ERR": LogEvent, + "INFO": LogEvent, "NEWDESC": NewDescEvent, + "NOTICE": LogEvent, "ORCONN": ORConnEvent, + "STATUS_CLIENT": StatusEvent, + "STATUS_GENERAL": StatusEvent, + "STATUS_SERVER": StatusEvent, "STREAM": StreamEvent, + "WARN": LogEvent, } diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 0a5921f..41a9d0e 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -41,6 +41,61 @@ $E57A476CD4DFBD99B4EE52A100A58610AD6E80B9,hamburgerphone" CIRC_BUILT_OLD = "650 CIRC 1 BUILT \ $E57A476CD4DFBD99B4EE52A100A58610AD6E80B9,hamburgerphone,PrivacyRepublic14" +# STATUS_* events that I was able to easily trigger. Most came from starting +# TBB, then listening while it bootstrapped. + +STATUS_CLIENT_CONSENSUS_ARRIVED = "650 STATUS_CLIENT NOTICE CONSENSUS_ARRIVED" +STATUS_CLIENT_ENOUGH_DIR_INFO = "650 STATUS_CLIENT NOTICE ENOUGH_DIR_INFO" +STATUS_CLIENT_CIRC_ESTABLISHED = "650 STATUS_CLIENT NOTICE CIRCUIT_ESTABLISHED" + +STATUS_CLIENT_BOOTSTRAP_DESCRIPTORS = '650 STATUS_CLIENT NOTICE BOOTSTRAP \ +PROGRESS=53 \ +TAG=loading_descriptors \ +SUMMARY="Loading relay descriptors"' + +STATUS_CLIENT_BOOTSTRAP_STUCK = '650 STATUS_CLIENT WARN BOOTSTRAP \ +PROGRESS=80 \ +TAG=conn_or \ +SUMMARY="Connecting to the Tor network" \ +WARNING="Network is unreachable" \ +REASON=NOROUTE \ +COUNT=5 \ +RECOMMENDATION=warn' + +STATUS_CLIENT_BOOTSTRAP_CONNECTING = '650 STATUS_CLIENT NOTICE BOOTSTRAP \ +PROGRESS=80 \ +TAG=conn_or \ +SUMMARY="Connecting to the Tor network"' + +STATUS_CLIENT_BOOTSTRAP_FIRST_HANDSHAKE = '650 STATUS_CLIENT NOTICE BOOTSTRAP \ +PROGRESS=85 \ +TAG=handshake_or \ +SUMMARY="Finishing handshake with first hop"' + +STATUS_CLIENT_BOOTSTRAP_ESTABLISHED = '650 STATUS_CLIENT NOTICE BOOTSTRAP \ +PROGRESS=90 \ +TAG=circuit_create \ +SUMMARY="Establishing a Tor circuit"' + +STATUS_CLIENT_BOOTSTRAP_DONE = '650 STATUS_CLIENT NOTICE BOOTSTRAP \ +PROGRESS=100 \ +TAG=done \ +SUMMARY="Done"' + +STATUS_SERVER_CHECK_REACHABILITY = "650 STATUS_SERVER NOTICE CHECKING_REACHABILITY \ +ORADDRESS=71.35.143.230:9050" + +STATUS_SERVER_DNS_TIMEOUT = '650 STATUS_SERVER NOTICE NAMESERVER_STATUS \ +NS=205.171.3.25 \ +STATUS=DOWN \ +ERR="request timed out."' + +STATUS_SERVER_DNS_DOWN = "650 STATUS_SERVER WARN NAMESERVER_ALL_DOWN" + +STATUS_SERVER_DNS_UP = "650 STATUS_SERVER NOTICE NAMESERVER_STATUS \ +NS=205.171.3.25 \ +STATUS=UP" + # STREAM events from tor 0.2.3.16 for visiting the google front page STREAM_NEW = "650 STREAM 18 NEW 0 \ @@ -319,6 +374,15 @@ class TestEvents(unittest.TestCase): self.assertEqual(ORClosureReason.DONE, event.reason) self.assertEqual(None, event.circ_count) + def test_status_event(self): + event = _get_event(STATUS_CLIENT_CONSENSUS_ARRIVED) + + self.assertTrue(isinstance(event, stem.response.events.StatusEvent)) + self.assertEqual(STATUS_CLIENT_CONSENSUS_ARRIVED.lstrip("650 "), str(event)) + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("CONSENSUS_ARRIVED", event.action) + def test_stream_event(self): event = _get_event(STREAM_NEW)

1 0

[stem/master] Filling in AuthDescriptorAction descriptions
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit f7cc47eae4e733872ba11687a81fc7cddb22fb1e Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Nov 27 08:48:50 2012 -0800 Filling in AuthDescriptorAction descriptions The AUTHDIR_NEWDESCS spec was clarified in 'https://trac.torproject.org/7533'. I thought that I'd fixed all the TODO notes, but guess I missed this one. --- stem/__init__.py | 9 +++------ 1 files changed, 3 insertions(+), 6 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index 3cf01b8..68bda60 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -227,15 +227,12 @@ Library for working with the tor process. 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 + **ACCEPTED** accepting the descriptor as the newest version + **DROPPED** descriptor rejected without notifying the relay + **REJECTED** relay notified that its descriptor has been rejected ===================== =========== """

1 0

[stem/master] Allowing zero Terget port in STREAM events
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 4959378f9aa83d96bc1431d72bea6fa7a1b6e2c7 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 2 11:51:34 2012 -0800 Allowing zero Terget port in STREAM events The STREAM event's target port can be zero in DNS_REQUEST requests. Caught thanks to robinson on... https://trac.torproject.org/7598 --- stem/response/events.py | 2 +- test/unit/response/events.py | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index 96764a0..598f8d1 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -497,7 +497,7 @@ class StreamEvent(Event): address, port = self.target.split(':', 1) - if not connection.is_valid_port(port): + if not connection.is_valid_port(port, allow_zero = True): raise stem.ProtocolError("Target location's port is invalid: %s" % self) self.target_address = address diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 54d4777..57a3f58 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -113,6 +113,10 @@ STREAM_DIR_FETCH = "650 STREAM 14 NEW 0 \ 176.28.51.238.$649F2D0ACF418F7CFC6539AB2257EB2D5297BAFA.exit:443 \ SOURCE_ADDR=(Tor_internal):0 PURPOSE=DIR_FETCH" +STREAM_DNS_REQUEST = "650 STREAM 1113 NEW 0 www.google.com:0 \ +SOURCE_ADDR=127.0.0.1:15297 \ +PURPOSE=DNS_REQUEST" + # ORCONN events from starting tor 0.2.2.39 via TBB ORCONN_CONNECTED = "650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon CONNECTED" @@ -670,4 +674,22 @@ class TestEvents(unittest.TestCase): self.assertEqual("(Tor_internal)", event.source_address) self.assertEqual(0, event.source_port) self.assertEqual(StreamPurpose.DIR_FETCH, event.purpose) + + event = _get_event(STREAM_DNS_REQUEST) + + self.assertTrue(isinstance(event, stem.response.events.StreamEvent)) + self.assertEqual(STREAM_DNS_REQUEST.lstrip("650 "), str(event)) + self.assertEqual("1113", event.id) + self.assertEqual(StreamStatus.NEW, event.status) + self.assertEqual(None, event.circ_id) + self.assertEqual("www.google.com:0", event.target) + self.assertEqual("www.google.com", event.target_address) + self.assertEqual(0, event.target_port) + self.assertEqual(None, event.reason) + self.assertEqual(None, event.remote_reason) + self.assertEqual(None, event.source) + self.assertEqual("127.0.0.1:15297", event.source_addr) + self.assertEqual("127.0.0.1", event.source_address) + self.assertEqual(15297, event.source_port) + self.assertEqual(StreamPurpose.DNS_REQUEST, event.purpose)

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits December 2012