- tor-commits - lists.torproject.org

[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

[stem/master] Handling typo in STATUS_SERVER event name
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit aeebbe762579951b4a78ddc8c68347d2d181fc49 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 2 02:05:09 2012 -0800 Handling typo in STATUS_SERVER event name Prior to tor 0.2.0.22 STATUS_SERVER events claimed to be 'STATUS_SEVER'. Accepting both names as per the spec's suggestion. --- stem/response/events.py | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index bf9db4c..d580829 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -539,5 +539,8 @@ EVENT_TYPE_TO_CLASS = { "STATUS_SERVER": StatusEvent, "STREAM": StreamEvent, "WARN": LogEvent, + + # accounting for a bug in tor 0.2.0.22 + "STATUS_SEVER": StatusEvent, }

1 0

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

03 Dec '12

commit 92af0a5c0f9c6924cfddfb6388f581f3b6014732 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 2 16:16:20 2012 -0800 Support for NS events Implementation and testing for NS events. To get test data I wiped my cached_consensus, then listened for NS events while bootstraping. The first time I did this it provided a flood of entries (probably the whole consensus), but then when I restarted tor and tried again it just proved one. --- stem/control.py | 1 + stem/response/events.py | 22 ++++++++++++++++++++++ test/unit/response/events.py | 20 ++++++++++++++++++++ 3 files changed, 43 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index c2c014d..5fd69c7 100644 --- a/stem/control.py +++ b/stem/control.py @@ -89,6 +89,7 @@ providing its own for interacting at a higher level. **INFO** :class:`stem.response.events.LogEvent` **NEWDESC** :class:`stem.response.events.NewDescEvent` **NOTICE** :class:`stem.response.events.LogEvent` + **NS** :class:`stem.response.events.NetworkStatusEvent` **ORCONN** :class:`stem.response.events.ORConnEvent` **STATUS_CLIENT** :class:`stem.response.events.StatusEvent` **STATUS_GENERAL** :class:`stem.response.events.StatusEvent` diff --git a/stem/response/events.py b/stem/response/events.py index bca9557..1bdfd02 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -1,9 +1,11 @@ import re import datetime +import StringIO import stem import stem.control import stem.response +import stem.descriptor.router_status_entry from stem.util import connection, log, str_tools, tor_tools @@ -360,6 +362,25 @@ class LogEvent(Event): log_id = "event.logging.unknown_runlevel.%s" % self.runlevel log.log_once(log_id, log.INFO, unrecognized_msg % ('runlevel', self.runlevel)) +class NetworkStatusEvent(Event): + """ + Event for when our copy of the consensus has changed. This was introduced in + tor version 0.1.2.3. + + :param list desc: :class:`~stem.descriptor.router_status_entry.RouterStatusEntryV3` for the changed descriptors + """ + + _SKIP_PARSING = True + + def _parse(self): + content = str(self).lstrip("NS\n") + + self.desc = list(stem.descriptor.router_status_entry.parse_file( + StringIO.StringIO(content), + True, + entry_class = stem.descriptor.router_status_entry.RouterStatusEntryV3, + )) + class NewDescEvent(Event): """ Event that indicates that a new descriptor is available. @@ -567,6 +588,7 @@ EVENT_TYPE_TO_CLASS = { "INFO": LogEvent, "NEWDESC": NewDescEvent, "NOTICE": LogEvent, + "NS": NetworkStatusEvent, "ORCONN": ORConnEvent, "STATUS_CLIENT": StatusEvent, "STATUS_GENERAL": StatusEvent, diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 2a64a27..84a1e7b 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -47,6 +47,15 @@ GUARD_NEW = "650 GUARD ENTRY $36B5DBA788246E8369DBAF58577C6BC044A9A374 NEW" GUARD_GOOD = "650 GUARD ENTRY $5D0034A368E0ABAF663D21847E1C9B6CFA09752A GOOD" GUARD_BAD = "650 GUARD ENTRY $5D0034A368E0ABAF663D21847E1C9B6CFA09752A BAD" +# NS event from tor v0.2.1.30. + +NS_EVENT = """650+NS +r whnetz dbBxYcJriTTrcxsuy4PUZcMRwCA VStM7KAIH/mXXoGDUpoGB1OXufg 2012-12-02 21:03:56 141.70.120.13 9001 9030 +s Fast HSDir Named Stable V2Dir Valid +. +650 OK +""" + # STATUS_* events that I was able to easily trigger. Most came from starting # TBB, then listening while it bootstrapped. @@ -380,6 +389,17 @@ class TestEvents(unittest.TestCase): self.assertEqual(NEWDESC_MULTIPLE.lstrip("650 "), str(event)) self.assertEqual(expected_relays, event.relays) + def test_ns_event(self): + expected_desc = mocking.get_router_status_entry_v3({ + "r": "whnetz dbBxYcJriTTrcxsuy4PUZcMRwCA VStM7KAIH/mXXoGDUpoGB1OXufg 2012-12-02 21:03:56 141.70.120.13 9001 9030", + "s": "Fast HSDir Named Stable V2Dir Valid", + }) + + event = _get_event(NS_EVENT) + + self.assertTrue(isinstance(event, stem.response.events.NetworkStatusEvent)) + self.assertEqual([expected_desc], event.desc) + def test_orconn_event(self): event = _get_event(ORCONN_CONNECTED)

1 0

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

03 Dec '12

commit e59de80010d1894c5eecb7d4b9d953ee195a5259 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 2 03:00:51 2012 -0800 Testing for STATUS_* events I had grand plans to have a StatusEvent subclass for each of the causes. However, on reflection that would encompass a bundle of work that's almost as large as all of the other events put together. It might still be a neat thing to do someday, but there's plenty of higher priority things to do first. Adding tests for all of the event examples that I collected earlier. This includes a bit of a hack to make quoted key/value mappings work. Previously we've only parsed quoted mappings if they belonged to the _QUOTED listing, but STATUS_* events sprinkle them all around so for forward compatability we can't simply enumerate them. --- stem/response/events.py | 31 ++++++-- test/unit/response/events.py | 159 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 182 insertions(+), 8 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index d580829..96764a0 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -34,6 +34,11 @@ class Event(stem.response.ControlMessage): _QUOTED = () _SKIP_PARSING = False + # If set then we'll parse anything that looks like a quoted key/value + # mapping, reguardless of if it shows up in _QUOTED. + + _PERMISSIVE_QUOTED_MAPPINGS = False + def _parse_message(self, arrived_at): if not str(self).strip(): raise stem.ProtocolError("Received a blank tor event. Events must at the very least have a type.") @@ -73,13 +78,24 @@ class Event(stem.response.ControlMessage): 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 + if self._PERMISSIVE_QUOTED_MAPPINGS: + while True: + match = re.match("^(.*) (\S*)=\"(.*)\"(.*)$", content) + + if match: + prefix, keyword, value, suffix = match.groups() + content = prefix + suffix + self.keyword_args[keyword] = value + else: + break + else: + 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:] @@ -423,6 +439,7 @@ class StatusEvent(Event): """ _POSITIONAL_ARGS = ("runlevel", "action") + _PERMISSIVE_QUOTED_MAPPINGS = True def _parse(self): if self.type == 'STATUS_GENERAL': diff --git a/test/unit/response/events.py b/test/unit/response/events.py index fc796a2..54d4777 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -378,7 +378,7 @@ class TestEvents(unittest.TestCase): self.assertEqual(ORClosureReason.DONE, event.reason) self.assertEqual(None, event.circ_count) - def test_status_event(self): + def test_status_event_consensus_arrived(self): event = _get_event(STATUS_CLIENT_CONSENSUS_ARRIVED) self.assertTrue(isinstance(event, stem.response.events.StatusEvent)) @@ -387,6 +387,163 @@ class TestEvents(unittest.TestCase): self.assertEqual(Runlevel.NOTICE, event.runlevel) self.assertEqual("CONSENSUS_ARRIVED", event.action) + def test_status_event_enough_dir_info(self): + event = _get_event(STATUS_CLIENT_ENOUGH_DIR_INFO) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("ENOUGH_DIR_INFO", event.action) + + def test_status_event_circuit_established(self): + event = _get_event(STATUS_CLIENT_CIRC_ESTABLISHED) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("CIRCUIT_ESTABLISHED", event.action) + + def test_status_event_bootstrap_descriptors(self): + event = _get_event(STATUS_CLIENT_BOOTSTRAP_DESCRIPTORS) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("BOOTSTRAP", event.action) + + expected_attr = { + 'PROGRESS': '53', + 'TAG': 'loading_descriptors', + 'SUMMARY': 'Loading relay descriptors', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_bootstrap_stuck(self): + event = _get_event(STATUS_CLIENT_BOOTSTRAP_STUCK) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.WARN, event.runlevel) + self.assertEqual("BOOTSTRAP", event.action) + + expected_attr = { + 'PROGRESS': '80', + 'TAG': 'conn_or', + 'SUMMARY': 'Connecting to the Tor network', + 'WARNING': 'Network is unreachable', + 'REASON': 'NOROUTE', + 'COUNT': '5', + 'RECOMMENDATION': 'warn', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_bootstrap_connecting(self): + event = _get_event(STATUS_CLIENT_BOOTSTRAP_CONNECTING) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("BOOTSTRAP", event.action) + + expected_attr = { + 'PROGRESS': '80', + 'TAG': 'conn_or', + 'SUMMARY': 'Connecting to the Tor network', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_bootstrap_first_handshake(self): + event = _get_event(STATUS_CLIENT_BOOTSTRAP_FIRST_HANDSHAKE) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("BOOTSTRAP", event.action) + + expected_attr = { + 'PROGRESS': '85', + 'TAG': 'handshake_or', + 'SUMMARY': 'Finishing handshake with first hop', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_bootstrap_established(self): + event = _get_event(STATUS_CLIENT_BOOTSTRAP_ESTABLISHED) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("BOOTSTRAP", event.action) + + expected_attr = { + 'PROGRESS': '90', + 'TAG': 'circuit_create', + 'SUMMARY': 'Establishing a Tor circuit', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_bootstrap_done(self): + event = _get_event(STATUS_CLIENT_BOOTSTRAP_DONE) + + self.assertEqual(StatusType.CLIENT, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("BOOTSTRAP", event.action) + + expected_attr = { + 'PROGRESS': '100', + 'TAG': 'done', + 'SUMMARY': 'Done', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_bootstrap_check_reachability(self): + event = _get_event(STATUS_SERVER_CHECK_REACHABILITY) + + self.assertEqual(StatusType.SERVER, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("CHECKING_REACHABILITY", event.action) + + expected_attr = { + 'ORADDRESS': '71.35.143.230:9050', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_dns_timeout(self): + event = _get_event(STATUS_SERVER_DNS_TIMEOUT) + + self.assertEqual(StatusType.SERVER, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("NAMESERVER_STATUS", event.action) + + expected_attr = { + 'NS': '205.171.3.25', + 'STATUS': 'DOWN', + 'ERR': 'request timed out.', + } + + self.assertEqual(expected_attr, event.keyword_args) + + def test_status_event_dns_down(self): + event = _get_event(STATUS_SERVER_DNS_DOWN) + + self.assertEqual(StatusType.SERVER, event.status_type) + self.assertEqual(Runlevel.WARN, event.runlevel) + self.assertEqual("NAMESERVER_ALL_DOWN", event.action) + + def test_status_event_dns_up(self): + event = _get_event(STATUS_SERVER_DNS_UP) + + self.assertEqual(StatusType.SERVER, event.status_type) + self.assertEqual(Runlevel.NOTICE, event.runlevel) + self.assertEqual("NAMESERVER_STATUS", event.action) + + expected_attr = { + 'NS': '205.171.3.25', + 'STATUS': 'UP', + } + + self.assertEqual(expected_attr, event.keyword_args) + def test_stream_event(self): event = _get_event(STREAM_NEW)

1 0

[stem/master] Support for STREAM events with a DIR_FETCH purpose
by atagar＠torproject.org 03 Dec '12

03 Dec '12

commit 1af965f1d12f5a58e921559901a2b7f0ca1e4cba Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Nov 30 23:04:07 2012 -0800 Support for STREAM events with a DIR_FETCH purpose The SOURCE_ADDR field of STREAM events can have zero as their port. Fixing this and adding a test. This was 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 ab0e5ef..bf9db4c 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -495,7 +495,7 @@ class StreamEvent(Event): address, port = self.source_addr.split(':', 1) - if not connection.is_valid_port(port): + if not connection.is_valid_port(port, allow_zero = True): raise stem.ProtocolError("Source location's port is invalid: %s" % self) self.source_address = address diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 41a9d0e..fc796a2 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -109,6 +109,10 @@ 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" +STREAM_DIR_FETCH = "650 STREAM 14 NEW 0 \ +176.28.51.238.$649F2D0ACF418F7CFC6539AB2257EB2D5297BAFA.exit:443 \ +SOURCE_ADDR=(Tor_internal):0 PURPOSE=DIR_FETCH" + # ORCONN events from starting tor 0.2.2.39 via TBB ORCONN_CONNECTED = "650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon CONNECTED" @@ -491,4 +495,22 @@ class TestEvents(unittest.TestCase): self.assertEqual(None, event.source_address) self.assertEqual(None, event.source_port) self.assertEqual(None, event.purpose) + + event = _get_event(STREAM_DIR_FETCH) + + self.assertTrue(isinstance(event, stem.response.events.StreamEvent)) + self.assertEqual(STREAM_DIR_FETCH.lstrip("650 "), str(event)) + self.assertEqual("14", event.id) + self.assertEqual(StreamStatus.NEW, event.status) + self.assertEqual(None, event.circ_id) + self.assertEqual("176.28.51.238.$649F2D0ACF418F7CFC6539AB2257EB2D5297BAFA.exit:443", event.target) + self.assertEqual("176.28.51.238.$649F2D0ACF418F7CFC6539AB2257EB2D5297BAFA.exit", event.target_address) + self.assertEqual(443, event.target_port) + self.assertEqual(None, event.reason) + self.assertEqual(None, event.remote_reason) + self.assertEqual(None, event.source) + self.assertEqual("(Tor_internal):0", event.source_addr) + self.assertEqual("(Tor_internal)", event.source_address) + self.assertEqual(0, event.source_port) + self.assertEqual(StreamPurpose.DIR_FETCH, event.purpose)

1 0

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

03 Dec '12

commit 2585969d6efbd8b1a6660d5de1ede437792dc22b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 2 14:02:21 2012 -0800 Support for GUARD events Implementation and testing for GUARD events. The spec is a little vauge, so we're missing enum descriptions and a good understanding of the 'Name' attribute... https://trac.torproject.org/7619 Got the test data by listening for GUARD events while bootstrapping... 650 GUARD ENTRY $5D0034A368E0ABAF663D21847E1C9B6CFA09752A BAD 650 GUARD ENTRY $071C2D9D0E03D75FF30DCCA850BB29CA4A4BB383 BAD 650 GUARD ENTRY $36B5DBA788246E8369DBAF58577C6BC044A9A374 NEW 650 GUARD ENTRY $071C2D9D0E03D75FF30DCCA850BB29CA4A4BB383 GOOD 650 GUARD ENTRY $5D0034A368E0ABAF663D21847E1C9B6CFA09752A GOOD --- stem/__init__.py | 46 ++++++++++++++++++++++++++++++++++++++++++ stem/control.py | 1 + stem/response/events.py | 17 +++++++++++++++ test/unit/response/events.py | 25 ++++++++++++++++++++++ 4 files changed, 89 insertions(+), 0 deletions(-) diff --git a/stem/__init__.py b/stem/__init__.py index c0b47fd..815e82c 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -260,6 +260,37 @@ Library for working with the tor process. **CLIENT** related to our activity as a tor client **SERVER** related to our activity as a tor relay ============= =========== + +.. data:: GuardType (enum) + + Use a guard relay can be for. Tor may provide types not in this enum. + + Enum descriptions are pending... + https://trac.torproject.org/7619 + + =========== =========== + GuardType Description + =========== =========== + **ENTRY** unknown + =========== =========== + +.. data:: GuardStatus (enum) + + Status a guard relay can have. Tor may provide types not in this enum. + + Enum descriptions are pending... + https://trac.torproject.org/7619 + + ============= =========== + GuardStatus Description + ============= =========== + **NEW** unknown + **UP** unknown + **DOWN** unknown + **BAD** unknown + **GOOD** unknown + **DROPPED** unknown + ============= =========== """ __version__ = '0.0.1' @@ -301,6 +332,8 @@ __all__ = [ "ORClosureReason", "AuthDescriptorAction", "StatusType", + "GuardType", + "GuardStatus", ] import stem.util.enum @@ -496,3 +529,16 @@ StatusType = stem.util.enum.UppercaseEnum( "SERVER", ) +GuardType = stem.util.enum.UppercaseEnum( + "ENTRY", +) + +GuardStatus = stem.util.enum.UppercaseEnum( + "NEW", + "UP", + "DOWN", + "BAD", + "GOOD", + "DROPPED", +) + diff --git a/stem/control.py b/stem/control.py index 45b7df8..c2c014d 100644 --- a/stem/control.py +++ b/stem/control.py @@ -85,6 +85,7 @@ providing its own for interacting at a higher level. **DEBUG** :class:`stem.response.events.LogEvent` **DESCCHANGED** :class:`stem.response.events.DescChangedEvent` **ERR** :class:`stem.response.events.LogEvent` + **GUARD** :class:`stem.response.events.GuardEvent` **INFO** :class:`stem.response.events.LogEvent` **NEWDESC** :class:`stem.response.events.NewDescEvent` **NOTICE** :class:`stem.response.events.LogEvent` diff --git a/stem/response/events.py b/stem/response/events.py index 598f8d1..bca9557 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -317,6 +317,22 @@ class DescChangedEvent(Event): pass +class GuardEvent(Event): + """ + Event that indicates that our guard relays have changed. + + :var stem.GuardType guard_type: purpose the guard relay is for + :var str name: nickname or fingerprint of the guard relay + :var stem.GuardStatus status: status of the guard relay + """ + + # TODO: We should replace the 'name' field with a fingerprint or nickname + # attribute once we know what it can be... + # + # https://trac.torproject.org/7619 + + _POSITIONAL_ARGS = ("guard_type", "name", "status") + class LogEvent(Event): """ Tor logging event. These are the most visible kind of event since, by @@ -547,6 +563,7 @@ EVENT_TYPE_TO_CLASS = { "DEBUG": LogEvent, "DESCCHANGED": DescChangedEvent, "ERR": LogEvent, + "GUARD": GuardEvent, "INFO": LogEvent, "NEWDESC": NewDescEvent, "NOTICE": LogEvent, diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 57a3f58..2a64a27 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -41,6 +41,12 @@ $E57A476CD4DFBD99B4EE52A100A58610AD6E80B9,hamburgerphone" CIRC_BUILT_OLD = "650 CIRC 1 BUILT \ $E57A476CD4DFBD99B4EE52A100A58610AD6E80B9,hamburgerphone,PrivacyRepublic14" +# GUARD events from tor v0.2.1.30. + +GUARD_NEW = "650 GUARD ENTRY $36B5DBA788246E8369DBAF58577C6BC044A9A374 NEW" +GUARD_GOOD = "650 GUARD ENTRY $5D0034A368E0ABAF663D21847E1C9B6CFA09752A GOOD" +GUARD_BAD = "650 GUARD ENTRY $5D0034A368E0ABAF663D21847E1C9B6CFA09752A BAD" + # STATUS_* events that I was able to easily trigger. Most came from starting # TBB, then listening while it bootstrapped. @@ -339,6 +345,25 @@ class TestEvents(unittest.TestCase): self.assertEqual([], event.positional_args) self.assertEqual({}, event.keyword_args) + def test_guard_event(self): + event = _get_event(GUARD_NEW) + + self.assertTrue(isinstance(event, stem.response.events.GuardEvent)) + self.assertEqual(GUARD_NEW.lstrip("650 "), str(event)) + self.assertEqual(GuardType.ENTRY, event.guard_type) + self.assertEqual("$36B5DBA788246E8369DBAF58577C6BC044A9A374", event.name) + self.assertEqual(GuardStatus.NEW, event.status) + + event = _get_event(GUARD_GOOD) + self.assertEqual(GuardType.ENTRY, event.guard_type) + self.assertEqual("$5D0034A368E0ABAF663D21847E1C9B6CFA09752A", event.name) + self.assertEqual(GuardStatus.GOOD, event.status) + + event = _get_event(GUARD_BAD) + self.assertEqual(GuardType.ENTRY, event.guard_type) + self.assertEqual("$5D0034A368E0ABAF663D21847E1C9B6CFA09752A", event.name) + self.assertEqual(GuardStatus.BAD, event.status) + def test_newdesc_event(self): event = _get_event(NEWDESC_SINGLE) expected_relays = (("B3FA3110CC6F42443F039220C134CBD2FC4F0493", "Sakura"),)

1 0