November 2013 - tor-commits - lists.torproject.org

[ooni-probe/master] Do not raise an exception on no input processor.
by art＠torproject.org 04 Nov '13

04 Nov '13

commit 77cfa98526f43919619dacf27a0f5c2644313985 Author: Arturo Filastò <art(a)fuffa.org> Date: Tue Oct 29 17:03:03 2013 +0100 Do not raise an exception on no input processor. --- ooni/nettest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index 560e039..8c2d09d 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -667,7 +667,7 @@ class NetTestCase(object): anything that gets written to the object self.report[] will be added to the final test report. """ - raise NoPostProcessor + pass def inputProcessor(self, filename): """

1 0

[ooni-probe/master] Merge branch 'master' of github.com:TheTorProject/ooni-probe
by art＠torproject.org 04 Nov '13

04 Nov '13

commit 39fc5b114969cc9f76ac56f287f3310d964714cc Merge: 77cfa98 4e1c1ca Author: Arturo Filastò <art(a)fuffa.org> Date: Mon Nov 4 09:53:59 2013 +0100 Merge branch 'master' of github.com:TheTorProject/ooni-probe * 'master' of github.com:TheTorProject/ooni-probe: Add GeoIP city data to report ooni/nettest.py | 1 + 1 file changed, 1 insertion(+)

1 0

[ooni-probe/master] Merge pull request #229 from TheTorProject/fix/add_geoip_city_data
by art＠torproject.org 04 Nov '13

04 Nov '13

commit 4e1c1cac58ee0e65cb4bd73b1b58e18d7109d94b Merge: de5dead 57a23c6 Author: Arturo Filastò <hellais(a)users.noreply.github.com> Date: Tue Oct 29 08:58:39 2013 -0700 Merge pull request #229 from TheTorProject/fix/add_geoip_city_data Add GeoIP city data to report ooni/nettest.py | 1 + 1 file changed, 1 insertion(+)

1 0

[stem/master] Adding support for CONN_BW events
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit 41274f4658772cbab5a22750e56d48b1b4478b6f Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 3 12:54:21 2013 -0800 Adding support for CONN_BW events New event type added in... https://gitweb.torproject.org/torspec.git/commitdiff/6f2919a --- docs/change_log.rst | 2 ++ stem/__init__.py | 20 +++++++++++++++++++ stem/response/events.py | 45 ++++++++++++++++++++++++++++++++++++++++++ stem/version.py | 2 ++ test/unit/response/events.py | 17 ++++++++++++++++ 5 files changed, 86 insertions(+) diff --git a/docs/change_log.rst b/docs/change_log.rst index 4184635..a55eb95 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -42,6 +42,7 @@ The following are only available within stem's `git repository * **Controller** * Added the id attribute to the :class:`~stem.response.events.ORConnEvent` (:spec:`6f2919a`) + * Added `support for CONN_BW events <api/response.html#stem.response.events.ConnectionBandwidthEvent>`_ (:spec:`6f2919a`) .. _version_1.1: @@ -64,6 +65,7 @@ and a myriad of smaller improvements and fixes. * Added :func:`~stem.control.Controller.get_pid` method to the :class:`~stem.control.Controller` * :class:`~stem.response.events.StreamEvent` didn't recognize IPv6 addresses (:trac:`9181`) * :func:`~stem.control.Controller.get_conf` mistakenly cached hidden service related options (:trac:`9792`) + * Added `support for TRANSPORT_LAUNCHED events <api/response.html#stem.response.events.TransportLaunchedEvent>`_ (:spec:`48f6dd0`) * **Descriptors** diff --git a/stem/__init__.py b/stem/__init__.py index e87bd9f..182428f 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -366,6 +366,20 @@ Library for working with the tor process. **DISCARD** throwing out timeout value from when the network was down **RESUME** resumed calculations to determine the proper timeout =============== =========== + +.. data:: ConnectionType (enum) + + Purpose for a tor connection. Tor may provide types not in this enum. + + The meaning behind these values is a bit unclear, pending :trac:`10086`. + + =============== =========== + ConnectionType Description + =============== =========== + **OR** carrying traffic within the tor network + **DIR** fetching or sending tor descriptor data + **EXIT** carrying traffic between the tor network and an external destination + =============== =========== """ __version__ = '1.1.0-dev' @@ -698,3 +712,9 @@ TimeoutSetType = stem.util.enum.UppercaseEnum( "DISCARD", "RESUME", ) + +ConnectionType = stem.util.enum.UppercaseEnum( + "OR", + "DIR", + "EXIT", +) diff --git a/stem/response/events.py b/stem/response/events.py index 742bc3d..dcdefbc 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -926,6 +926,50 @@ class TransportLaunchedEvent(Event): self.port = int(self.port) + +class ConnectionBandwidthEvent(Event): + """ + Event emitted every second with the bytes sent and received by tor on a + per-connection basis. + + The CONN_BW event was introduced in tor version 0.2.5.2-alpha. + + .. versionadded:: 1.1.0-dev + + :var str id: connection identifier + :var stem.ConnectionType type: connection type + :var long read: bytes received by tor that second + :var long written: bytes sent by tor that second + """ + + _KEYWORD_ARGS = { + "ID": "id", + "TYPE": "type", + "READ": "read", + "WRITTEN": "written", + } + + _VERSION_ADDED = stem.version.Requirement.EVENT_CONN_BW + + def _parse(self): + if not self.id: + raise stem.ProtocolError("CONN_BW event is missing its id") + elif not self.type: + raise stem.ProtocolError("CONN_BW event is missing its type") + elif not self.read: + raise stem.ProtocolError("CONN_BW event is missing its read value") + elif not self.written: + raise stem.ProtocolError("CONN_BW event is missing its written value") + elif not self.read.isdigit() or not self.written.isdigit(): + raise stem.ProtocolError("A CONN_BW event's bytes sent and received should be a positive numeric value, received: %s" % self) + elif not tor_tools.is_valid_connection_id(self.id): + raise stem.ProtocolError("Connection IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.id, self)) + + self.read = long(self.read) + self.written = long(self.written) + + self._log_if_unrecognized('type', stem.ConnectionType) + EVENT_TYPE_TO_CLASS = { "ADDRMAP": AddrMapEvent, "AUTHDIR_NEWDESCS": AuthDirNewDescEvent, @@ -952,6 +996,7 @@ EVENT_TYPE_TO_CLASS = { "STREAM": StreamEvent, "STREAM_BW": StreamBwEvent, "TRANSPORT_LAUNCHED": TransportLaunchedEvent, + "CONN_BW": ConnectionBandwidthEvent, "WARN": LogEvent, # accounting for a bug in tor 0.2.0.22 diff --git a/stem/version.py b/stem/version.py index 5efc1e0..fbc3f31 100644 --- a/stem/version.py +++ b/stem/version.py @@ -43,6 +43,7 @@ easily parsed and compared, for instance... **EVENT_STATUS** STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER events **EVENT_STREAM_BW** STREAM_BW events **EVENT_TRANSPORT_LAUNCHED** TRANSPORT_LAUNCHED events + **EVENT_CONN_BW** CONN_BW events **EXTENDCIRCUIT_PATH_OPTIONAL** EXTENDCIRCUIT queries can omit the path if the circuit is zero **FEATURE_EXTENDED_EVENTS** 'EXTENDED_EVENTS' optional feature **FEATURE_VERBOSE_NAMES** 'VERBOSE_NAMES' optional feature @@ -341,6 +342,7 @@ Requirement = stem.util.enum.Enum( ("EVENT_STATUS", Version('0.1.2.3-alpha')), ("EVENT_STREAM_BW", Version('0.1.2.8-beta')), ("EVENT_TRANSPORT_LAUNCHED", Version('0.2.5.0-alpha')), + ("EVENT_CONN_BW", Version('0.2.5.2-alpha')), ("EXTENDCIRCUIT_PATH_OPTIONAL", Version("0.2.2.9")), ("FEATURE_EXTENDED_EVENTS", Version("0.2.2.1-alpha")), ("FEATURE_VERBOSE_NAMES", Version("0.2.2.1-alpha")), diff --git a/test/unit/response/events.py b/test/unit/response/events.py index aa13b5f..071f760 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -329,6 +329,10 @@ TRANSPORT_LAUNCHED_BAD_TYPE = "650 TRANSPORT_LAUNCHED unicorn obfs1 127.0.0.1 11 TRANSPORT_LAUNCHED_BAD_ADDRESS = "650 TRANSPORT_LAUNCHED server obfs1 127.0.x.y 1111" TRANSPORT_LAUNCHED_BAD_PORT = "650 TRANSPORT_LAUNCHED server obfs1 127.0.0.1 my_port" +CONN_BW = "650 CONN_BW ID=11 TYPE=DIR READ=272 WRITTEN=817" +CONN_BW_BAD_WRITTEN_VALUE = "650 CONN_BW ID=11 TYPE=DIR READ=272 WRITTEN=817.7" +CONN_BW_BAD_MISSING_ID = "650 CONN_BW TYPE=DIR READ=272 WRITTEN=817" + def _get_event(content): controller_event = mocking.get_message(content) @@ -1190,6 +1194,19 @@ class TestEvents(unittest.TestCase): self.assertRaises(ProtocolError, _get_event, TRANSPORT_LAUNCHED_BAD_ADDRESS) self.assertRaises(ProtocolError, _get_event, TRANSPORT_LAUNCHED_BAD_PORT) + def test_conn_bw_event(self): + event = _get_event(CONN_BW) + + self.assertTrue(isinstance(event, stem.response.events.ConnectionBandwidthEvent)) + self.assertEqual(CONN_BW.lstrip("650 "), str(event)) + self.assertEqual("11", event.id) + self.assertEqual(stem.ConnectionType.DIR, event.type) + self.assertEqual(272, event.read) + self.assertEqual(817, event.written) + + self.assertRaises(ProtocolError, _get_event, CONN_BW_BAD_WRITTEN_VALUE) + self.assertRaises(ProtocolError, _get_event, CONN_BW_BAD_MISSING_ID) + def test_unrecognized_enum_logging(self): """ Checks that when event parsing gets a value that isn't recognized by stem's

1 0

[stem/master] Citing version 1.1.0 event changes
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit 118f1bb1fde1dc2740cfea1fb6871e024e036711 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 3 09:52:59 2013 -0800 Citing version 1.1.0 event changes Oops, just looked for changed function signatures (def statements). Noting a couple event changes that were made in release 1.1.0. --- stem/response/events.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/stem/response/events.py b/stem/response/events.py index d01d6db..742bc3d 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -158,6 +158,9 @@ class AddrMapEvent(Event): The ADDRMAP event was one of the first Control Protocol V1 events and was introduced in tor version 0.1.1.1-alpha. + .. versionchanged:: 1.1.0 + Added the cached attribute. + :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 @@ -898,6 +901,8 @@ class TransportLaunchedEvent(Event): The TRANSPORT_LAUNCHED event was introduced in tor version 0.2.5.0-alpha. + .. versionadded:: 1.1.0 + :var str type: 'server' or 'client' :var str name: name of the pluggable transport :var str address: IPv4 or IPv6 address where the transport is listening for

1 0

[stem/master] Supporting ORCONN event's new ID attribute
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit dfa171070607c3c21667998d03dde7ad92c7625d Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Nov 2 22:43:57 2013 -0700 Supporting ORCONN event's new ID attribute New event attribute in tor version 0.2.5.2-alpha. This is from... https://gitweb.torproject.org/torspec.git/commitdiff/6f2919a --- docs/change_log.rst | 4 ++++ stem/response/events.py | 11 ++++++++++- stem/util/tor_tools.py | 12 ++++++++++++ test/unit/response/events.py | 8 +++++++- 4 files changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index 64114cb..4184635 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -39,6 +39,10 @@ Unreleased The following are only available within stem's `git repository <download.html>`_. + * **Controller** + + * Added the id attribute to the :class:`~stem.response.events.ORConnEvent` (:spec:`6f2919a`) + .. _version_1.1: Version 1.1 diff --git a/stem/response/events.py b/stem/response/events.py index 3a5cf41..d01d6db 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -670,8 +670,13 @@ class ORConnEvent(Event): The derived 'endpoint_*' attributes are generally more useful. The ORCONN event was one of the first Control Protocol V1 events and was - introduced in tor version 0.1.1.1-alpha. + introduced in tor version 0.1.1.1-alpha. Its id attribute was added in + version 0.2.5.2-alpha. + + .. versionchanged:: 1.1.0-dev + Added the id attribute. + :var str id: connection identifier :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 @@ -686,6 +691,7 @@ class ORConnEvent(Event): _KEYWORD_ARGS = { "REASON": "reason", "NCIRCS": "circ_count", + "ID": "id", } def _parse(self): @@ -715,6 +721,9 @@ class ORConnEvent(Event): self.circ_count = int(self.circ_count) + if self.id and not tor_tools.is_valid_connection_id(self.id): + raise stem.ProtocolError("Connection IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.id, self)) + self._log_if_unrecognized('status', stem.ORStatus) self._log_if_unrecognized('reason', stem.ORClosureReason) diff --git a/stem/util/tor_tools.py b/stem/util/tor_tools.py index 510bff1..e4d1e0c 100644 --- a/stem/util/tor_tools.py +++ b/stem/util/tor_tools.py @@ -15,6 +15,7 @@ future, use them at your own risk.** is_valid_nickname - checks if a string is a valid tor relay nickname is_valid_circuit_id - checks if a string is a valid tor circuit id is_valid_stream_id - checks if a string is a valid tor stream id + is_valid_connection_id - checks if a string is a valid tor connection id is_hex_digits - checks if a string is only made up of hex digits """ @@ -101,6 +102,17 @@ def is_valid_stream_id(entry): return is_valid_circuit_id(entry) +def is_valid_connection_id(entry): + """ + Checks if a string is a valid format for being a connection identifier. + Currently, this is just an alias to :func:`~stem.util.tor_tools.is_valid_circuit_id`. + + :returns: **True** if the string could be a connection id, **False** otherwise + """ + + return is_valid_circuit_id(entry) + + def is_hex_digits(entry, count): """ Checks if a string is the given number of hex digits. Digits represented by diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 281dbec..aa13b5f 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -222,12 +222,13 @@ s Fast HSDir Named Stable V2Dir Valid # ORCONN events from starting tor 0.2.2.39 via TBB ORCONN_CLOSED = "650 ORCONN $A1130635A0CDA6F60C276FBF6994EFBD4ECADAB1~tama CLOSED REASON=DONE" -ORCONN_CONNECTED = "650 ORCONN 127.0.0.1:9000 CONNECTED NCIRCS=20" +ORCONN_CONNECTED = "650 ORCONN 127.0.0.1:9000 CONNECTED NCIRCS=20 ID=18" ORCONN_LAUNCHED = "650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E51E1A0=GreenDragon LAUNCHED" ORCONN_BAD_1 = "650 ORCONN $7ED90E2833EE38A75795BA9237B0A4560E5=GreenD LAUNCHED" ORCONN_BAD_2 = "650 ORCONN 127.0.0.1:001 CONNECTED" ORCONN_BAD_3 = "650 ORCONN 127.0.0.1:9000 CONNECTED NCIRCS=too_many" +ORCONN_BAD_4 = "650 ORCONN 127.0.0.1:9000 CONNECTED NCIRCS=20 ID=30635A0CDA6F60C276FBF6994EFBD4ECADA" # STATUS_* events that I was able to easily trigger. Most came from starting # TBB, then listening while it bootstrapped. @@ -752,6 +753,7 @@ class TestEvents(unittest.TestCase): self.assertEqual(ORStatus.CLOSED, event.status) self.assertEqual(ORClosureReason.DONE, event.reason) self.assertEqual(None, event.circ_count) + self.assertEqual(None, event.id) event = _get_event(ORCONN_CONNECTED) @@ -765,6 +767,7 @@ class TestEvents(unittest.TestCase): self.assertEqual(ORStatus.CONNECTED, event.status) self.assertEqual(None, event.reason) self.assertEqual(20, event.circ_count) + self.assertEqual('18', event.id) event = _get_event(ORCONN_LAUNCHED) @@ -788,6 +791,9 @@ class TestEvents(unittest.TestCase): # non-numeric NCIRCS self.assertRaises(ProtocolError, _get_event, ORCONN_BAD_3) + # invalid connection id + self.assertRaises(ProtocolError, _get_event, ORCONN_BAD_4) + def test_signal_event(self): event = _get_event("650 SIGNAL DEBUG") self.assertTrue(isinstance(event, stem.response.events.SignalEvent))

1 0

[stem/master] Adding support for CELL_STATS events
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit 5898557b596c1e2dfbd89c44a621aefb5286955a Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 3 19:35:38 2013 -0800 Adding support for CELL_STATS events Yet another event type from... https://gitweb.torproject.org/torspec.git/commitdiff/6f2919a --- docs/change_log.rst | 1 + stem/response/events.py | 102 +++++++++++++++++++++++++++++++++++++++++- stem/version.py | 2 + test/unit/response/events.py | 59 ++++++++++++++++++++++++ 4 files changed, 162 insertions(+), 2 deletions(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index f066b9b..5c6fed2 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -44,6 +44,7 @@ The following are only available within stem's `git repository * Added the id attribute to the :class:`~stem.response.events.ORConnEvent` (:spec:`6f2919a`) * Added `support for CONN_BW events <api/response.html#stem.response.events.ConnectionBandwidthEvent>`_ (:spec:`6f2919a`) * Added `support for CIRC_BW events <api/response.html#stem.response.events.CircuitBandwidthEvent>`_ (:spec:`6f2919a`) + * Added `support for CELL_STATS events <api/response.html#stem.response.events.CellStatsEvent>`_ (:spec:`6f2919a`) .. _version_1.1: diff --git a/stem/response/events.py b/stem/response/events.py index b892649..616bbfc 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -20,6 +20,7 @@ from stem.util import connection, log, str_tools, tor_tools KW_ARG = re.compile("^(.*) ([A-Za-z0-9_]+)=(\S*)$") QUOTED_KW_ARG = re.compile("^(.*) ([A-Za-z0-9_]+)=\"(.*)\"$") +CELL_TYPE = re.compile("^[a-z0-9_]+$") class Event(stem.response.ControlMessage): @@ -1008,15 +1009,114 @@ class CircuitBandwidthEvent(Event): self.read = long(self.read) self.written = long(self.written) + +class CellStatsEvent(Event): + """ + Event emitted every second with a count of the number of cells types broken + down by the circuit. **These events are only emitted if TestingTorNetwork is + set.** + + The CELL_STATS event was introduced in tor version 0.2.5.2-alpha. + + .. versionadded:: 1.1.0-dev + + :var str id: circuit identifier + :var str inbound_queue: inbound queue identifier + :var str inbound_connection: inbound connection identifier + :var dict inbound_added: mapping of added inbound cell types to their count + :var dict inbound_removed: mapping of removed inbound cell types to their count + :var dict inbound_time: mapping of inbound cell types to the time they took to write in milliseconds + :var str outbound_queue: outbound queue identifier + :var str outbound_connection: outbound connection identifier + :var dict outbound_added: mapping of added outbound cell types to their count + :var dict outbound_removed: mapping of removed outbound cell types to their count + :var dict outbound_time: mapping of outbound cell types to the time they took to write in milliseconds + """ + + _KEYWORD_ARGS = { + "ID": "id", + "InboundQueue": "inbound_queue", + "InboundConn": "inbound_connection", + "InboundAdded": "inbound_added", + "InboundRemoved": "inbound_removed", + "InboundTime": "inbound_time", + "OutboundQueue": "outbound_queue", + "OutboundConn": "outbound_connection", + "OutboundAdded": "outbound_added", + "OutboundRemoved": "outbound_removed", + "OutboundTime": "outbound_time", + } + + _VERSION_ADDED = stem.version.Requirement.EVENT_CELL_STATS + + def _parse(self): + if self.id and not tor_tools.is_valid_circuit_id(self.id): + raise stem.ProtocolError("Circuit IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.id, self)) + elif self.inbound_queue and not tor_tools.is_valid_circuit_id(self.inbound_queue): + raise stem.ProtocolError("Queue IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.inbound_queue, self)) + elif self.inbound_connection and not tor_tools.is_valid_connection_id(self.inbound_connection): + raise stem.ProtocolError("Connection IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.inbound_connection, self)) + elif self.outbound_queue and not tor_tools.is_valid_circuit_id(self.outbound_queue): + raise stem.ProtocolError("Queue IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.outbound_queue, self)) + elif self.outbound_connection and not tor_tools.is_valid_connection_id(self.outbound_connection): + raise stem.ProtocolError("Connection IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.outbound_connection, self)) + + self.inbound_added = _parse_cell_type_mapping(self.inbound_added) + self.inbound_removed = _parse_cell_type_mapping(self.inbound_removed) + self.inbound_time = _parse_cell_type_mapping(self.inbound_time) + self.outbound_added = _parse_cell_type_mapping(self.outbound_added) + self.outbound_removed = _parse_cell_type_mapping(self.outbound_removed) + self.outbound_time = _parse_cell_type_mapping(self.outbound_time) + + +def _parse_cell_type_mapping(mapping): + """ + Parses a mapping of the form... + + key1:value1,key2:value2... + + ... in which keys are strings and values are integers. + + :param str mapping: value to be parsed + + :returns: dict of **str => int** mappings + + :rasies: **stem.ProtocolError** if unable to parse the mapping + """ + + if mapping is None: + return None + + results = {} + + for entry in mapping.split(','): + if not ':' in entry: + raise stem.ProtocolError("Mappings are expected to be of the form 'key:value', got '%s': %s" % (entry, mapping)) + + key, value = entry.split(':', 1) + + if not CELL_TYPE.match(key): + raise stem.ProtocolError("Key had invalid characters, got '%s': %s" % (key, mapping)) + elif not value.isdigit(): + raise stem.ProtocolError("Values should just be integers, got '%s': %s" % (value, mapping)) + + results[key] = int(value) + + return results + + EVENT_TYPE_TO_CLASS = { "ADDRMAP": AddrMapEvent, "AUTHDIR_NEWDESCS": AuthDirNewDescEvent, "BUILDTIMEOUT_SET": BuildTimeoutSetEvent, "BW": BandwidthEvent, + "CELL_STATS": CellStatsEvent, "CIRC": CircuitEvent, + "CIRC_BW": CircuitBandwidthEvent, "CIRC_MINOR": CircMinorEvent, "CLIENTS_SEEN": ClientsSeenEvent, "CONF_CHANGED": ConfChangedEvent, + "CONN_BW": ConnectionBandwidthEvent, "DEBUG": LogEvent, "DESCCHANGED": DescChangedEvent, "ERR": LogEvent, @@ -1034,8 +1134,6 @@ EVENT_TYPE_TO_CLASS = { "STREAM": StreamEvent, "STREAM_BW": StreamBwEvent, "TRANSPORT_LAUNCHED": TransportLaunchedEvent, - "CONN_BW": ConnectionBandwidthEvent, - "CIRC_BW": CircuitBandwidthEvent, "WARN": LogEvent, # accounting for a bug in tor 0.2.0.22 diff --git a/stem/version.py b/stem/version.py index b725ade..ef1f290 100644 --- a/stem/version.py +++ b/stem/version.py @@ -45,6 +45,7 @@ easily parsed and compared, for instance... **EVENT_TRANSPORT_LAUNCHED** TRANSPORT_LAUNCHED events **EVENT_CONN_BW** CONN_BW events **EVENT_CIRC_BW** CIRC_BW events + **EVENT_CELL_STATS** CELL_STATS events **EXTENDCIRCUIT_PATH_OPTIONAL** EXTENDCIRCUIT queries can omit the path if the circuit is zero **FEATURE_EXTENDED_EVENTS** 'EXTENDED_EVENTS' optional feature **FEATURE_VERBOSE_NAMES** 'VERBOSE_NAMES' optional feature @@ -345,6 +346,7 @@ Requirement = stem.util.enum.Enum( ("EVENT_TRANSPORT_LAUNCHED", Version('0.2.5.0-alpha')), ("EVENT_CONN_BW", Version('0.2.5.2-alpha')), ("EVENT_CIRC_BW", Version('0.2.5.2-alpha')), + ("EVENT_CELL_STATS", Version('0.2.5.2-alpha')), ("EXTENDCIRCUIT_PATH_OPTIONAL", Version("0.2.2.9")), ("FEATURE_EXTENDED_EVENTS", Version("0.2.2.1-alpha")), ("FEATURE_VERBOSE_NAMES", Version("0.2.2.1-alpha")), diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 6b7b6f1..09fca4f 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -337,6 +337,26 @@ CIRC_BW = "650 CIRC_BW ID=11 READ=272 WRITTEN=817" CIRC_BW_BAD_WRITTEN_VALUE = "650 CIRC_BW ID=11 READ=272 WRITTEN=817.7" CIRC_BW_BAD_MISSING_ID = "650 CIRC_BW READ=272 WRITTEN=817" +CELL_STATS_1 = "650 CELL_STATS ID=14 \ +OutboundQueue=19403 OutboundConn=15 \ +OutboundAdded=create_fast:1,relay_early:2 \ +OutboundRemoved=create_fast:1,relay_early:2 \ +OutboundTime=create_fast:0,relay_early:0" + +CELL_STATS_2 = "650 CELL_STATS \ +InboundQueue=19403 InboundConn=32 \ +InboundAdded=relay:1,created_fast:1 \ +InboundRemoved=relay:1,created_fast:1 \ +InboundTime=relay:0,created_fast:0 \ +OutboundQueue=6710 OutboundConn=18 \ +OutboundAdded=create:1,relay_early:1 \ +OutboundRemoved=create:1,relay_early:1 \ +OutboundTime=create:0,relay_early:0" + +CELL_STATS_BAD_1 = "650 CELL_STATS OutboundAdded=create_fast:-1,relay_early:2" +CELL_STATS_BAD_2 = "650 CELL_STATS OutboundAdded=create_fast:arg,relay_early:-2" +CELL_STATS_BAD_3 = "650 CELL_STATS OutboundAdded=create_fast!:1,relay_early:-2" + def _get_event(content): controller_event = mocking.get_message(content) @@ -1223,6 +1243,45 @@ class TestEvents(unittest.TestCase): self.assertRaises(ProtocolError, _get_event, CIRC_BW_BAD_WRITTEN_VALUE) self.assertRaises(ProtocolError, _get_event, CIRC_BW_BAD_MISSING_ID) + def test_cell_stats_event(self): + event = _get_event(CELL_STATS_1) + + self.assertTrue(isinstance(event, stem.response.events.CellStatsEvent)) + self.assertEqual(CELL_STATS_1.lstrip("650 "), str(event)) + self.assertEqual("14", event.id) + self.assertEqual(None, event.inbound_queue) + self.assertEqual(None, event.inbound_connection) + self.assertEqual(None, event.inbound_added) + self.assertEqual(None, event.inbound_removed) + self.assertEqual(None, event.inbound_time) + self.assertEqual("19403", event.outbound_queue) + self.assertEqual("15", event.outbound_connection) + self.assertEqual({'create_fast': 1, 'relay_early' :2}, event.outbound_added) + self.assertEqual({'create_fast': 1, 'relay_early': 2}, event.outbound_removed) + self.assertEqual({'create_fast': 0, 'relay_early': 0}, event.outbound_time) + + event = _get_event(CELL_STATS_2) + + self.assertTrue(isinstance(event, stem.response.events.CellStatsEvent)) + self.assertEqual(CELL_STATS_2.lstrip("650 "), str(event)) + self.assertEqual(None, event.id) + self.assertEqual("19403", event.inbound_queue) + self.assertEqual("32", event.inbound_connection) + self.assertEqual({'relay': 1, 'created_fast': 1}, event.inbound_added) + self.assertEqual({'relay': 1, 'created_fast': 1}, event.inbound_removed) + self.assertEqual({'relay': 0, 'created_fast': 0}, event.inbound_time) + self.assertEqual("6710", event.outbound_queue) + self.assertEqual("18", event.outbound_connection) + self.assertEqual({'create': 1, 'relay_early': 1}, event.outbound_added) + self.assertEqual({'create': 1, 'relay_early': 1}, event.outbound_removed) + self.assertEqual({'create': 0, 'relay_early': 0}, event.outbound_time) + + # check a few invalid mappings (bad key or value) + + self.assertRaises(ProtocolError, _get_event, CELL_STATS_BAD_1) + self.assertRaises(ProtocolError, _get_event, CELL_STATS_BAD_2) + self.assertRaises(ProtocolError, _get_event, CELL_STATS_BAD_3) + def test_unrecognized_enum_logging(self): """ Checks that when event parsing gets a value that isn't recognized by stem's

1 0

[stem/master] Adding support for CIRC_BW events
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit eb808565f5e2ea8885eabba682e6ff97873be056 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 3 13:05:12 2013 -0800 Adding support for CIRC_BW events Pretty much identical to their CONN_BW counterpart (minus a connection type). Also added in... https://gitweb.torproject.org/torspec.git/commitdiff/6f2919a --- docs/change_log.rst | 1 + stem/response/events.py | 39 +++++++++++++++++++++++++++++++++++++++ stem/version.py | 2 ++ test/unit/response/events.py | 16 ++++++++++++++++ 4 files changed, 58 insertions(+) diff --git a/docs/change_log.rst b/docs/change_log.rst index a55eb95..f066b9b 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -43,6 +43,7 @@ The following are only available within stem's `git repository * Added the id attribute to the :class:`~stem.response.events.ORConnEvent` (:spec:`6f2919a`) * Added `support for CONN_BW events <api/response.html#stem.response.events.ConnectionBandwidthEvent>`_ (:spec:`6f2919a`) + * Added `support for CIRC_BW events <api/response.html#stem.response.events.CircuitBandwidthEvent>`_ (:spec:`6f2919a`) .. _version_1.1: diff --git a/stem/response/events.py b/stem/response/events.py index dcdefbc..b892649 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -970,6 +970,44 @@ class ConnectionBandwidthEvent(Event): self._log_if_unrecognized('type', stem.ConnectionType) + +class CircuitBandwidthEvent(Event): + """ + Event emitted every second with the bytes sent and received by tor on a + per-circuit basis. + + The CIRC_BW event was introduced in tor version 0.2.5.2-alpha. + + .. versionadded:: 1.1.0-dev + + :var str id: circuit identifier + :var long read: bytes received by tor that second + :var long written: bytes sent by tor that second + """ + + _KEYWORD_ARGS = { + "ID": "id", + "READ": "read", + "WRITTEN": "written", + } + + _VERSION_ADDED = stem.version.Requirement.EVENT_CIRC_BW + + def _parse(self): + if not self.id: + raise stem.ProtocolError("CIRC_BW event is missing its id") + elif not self.read: + raise stem.ProtocolError("CIRC_BW event is missing its read value") + elif not self.written: + raise stem.ProtocolError("CIRC_BW event is missing its written value") + elif not self.read.isdigit() or not self.written.isdigit(): + raise stem.ProtocolError("A CIRC_BW event's bytes sent and received should be a positive numeric value, received: %s" % self) + elif not tor_tools.is_valid_circuit_id(self.id): + raise stem.ProtocolError("Circuit IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.id, self)) + + self.read = long(self.read) + self.written = long(self.written) + EVENT_TYPE_TO_CLASS = { "ADDRMAP": AddrMapEvent, "AUTHDIR_NEWDESCS": AuthDirNewDescEvent, @@ -997,6 +1035,7 @@ EVENT_TYPE_TO_CLASS = { "STREAM_BW": StreamBwEvent, "TRANSPORT_LAUNCHED": TransportLaunchedEvent, "CONN_BW": ConnectionBandwidthEvent, + "CIRC_BW": CircuitBandwidthEvent, "WARN": LogEvent, # accounting for a bug in tor 0.2.0.22 diff --git a/stem/version.py b/stem/version.py index fbc3f31..b725ade 100644 --- a/stem/version.py +++ b/stem/version.py @@ -44,6 +44,7 @@ easily parsed and compared, for instance... **EVENT_STREAM_BW** STREAM_BW events **EVENT_TRANSPORT_LAUNCHED** TRANSPORT_LAUNCHED events **EVENT_CONN_BW** CONN_BW events + **EVENT_CIRC_BW** CIRC_BW events **EXTENDCIRCUIT_PATH_OPTIONAL** EXTENDCIRCUIT queries can omit the path if the circuit is zero **FEATURE_EXTENDED_EVENTS** 'EXTENDED_EVENTS' optional feature **FEATURE_VERBOSE_NAMES** 'VERBOSE_NAMES' optional feature @@ -343,6 +344,7 @@ Requirement = stem.util.enum.Enum( ("EVENT_STREAM_BW", Version('0.1.2.8-beta')), ("EVENT_TRANSPORT_LAUNCHED", Version('0.2.5.0-alpha')), ("EVENT_CONN_BW", Version('0.2.5.2-alpha')), + ("EVENT_CIRC_BW", Version('0.2.5.2-alpha')), ("EXTENDCIRCUIT_PATH_OPTIONAL", Version("0.2.2.9")), ("FEATURE_EXTENDED_EVENTS", Version("0.2.2.1-alpha")), ("FEATURE_VERBOSE_NAMES", Version("0.2.2.1-alpha")), diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 071f760..6b7b6f1 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -333,6 +333,10 @@ CONN_BW = "650 CONN_BW ID=11 TYPE=DIR READ=272 WRITTEN=817" CONN_BW_BAD_WRITTEN_VALUE = "650 CONN_BW ID=11 TYPE=DIR READ=272 WRITTEN=817.7" CONN_BW_BAD_MISSING_ID = "650 CONN_BW TYPE=DIR READ=272 WRITTEN=817" +CIRC_BW = "650 CIRC_BW ID=11 READ=272 WRITTEN=817" +CIRC_BW_BAD_WRITTEN_VALUE = "650 CIRC_BW ID=11 READ=272 WRITTEN=817.7" +CIRC_BW_BAD_MISSING_ID = "650 CIRC_BW READ=272 WRITTEN=817" + def _get_event(content): controller_event = mocking.get_message(content) @@ -1207,6 +1211,18 @@ class TestEvents(unittest.TestCase): self.assertRaises(ProtocolError, _get_event, CONN_BW_BAD_WRITTEN_VALUE) self.assertRaises(ProtocolError, _get_event, CONN_BW_BAD_MISSING_ID) + def test_circ_bw_event(self): + event = _get_event(CIRC_BW) + + self.assertTrue(isinstance(event, stem.response.events.CircuitBandwidthEvent)) + self.assertEqual(CIRC_BW.lstrip("650 "), str(event)) + self.assertEqual("11", event.id) + self.assertEqual(272, event.read) + self.assertEqual(817, event.written) + + self.assertRaises(ProtocolError, _get_event, CIRC_BW_BAD_WRITTEN_VALUE) + self.assertRaises(ProtocolError, _get_event, CIRC_BW_BAD_MISSING_ID) + def test_unrecognized_enum_logging(self): """ Checks that when event parsing gets a value that isn't recognized by stem's

1 0

[stem/master] Checking constraints on the usecreatefast property
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit ae6d97837a30066264c8ed02f916e7529c5f8349 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 3 13:12:33 2013 -0800 Checking constraints on the usecreatefast property New consensus property from... https://gitweb.torproject.org/torspec.git/commitdiff/6b55759 --- stem/descriptor/networkstatus.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index b5eb5b7..b3a0cc7 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -128,6 +128,7 @@ DEFAULT_PARAMS = { "cbtmintimeout": 2000, "cbtinitialtimeout": 60000, "Support022HiddenServices": 1, + "usecreatefast": 1, } # KeyCertificate fields, tuple is of the form... @@ -824,6 +825,8 @@ class _DocumentHeader(object): minimum, maximum = 0, 1 elif key == "Support022HiddenServices": minimum, maximum = 0, 1 + elif key == "usecreatefast": + minimum, maximum = 0, 1 if value < minimum or value > maximum: raise ValueError("'%s' value on the params line must be in the range of %i - %i, was %i" % (key, minimum, maximum, value))

1 0

[stem/master] Adding support for TB_EMPTY events
by atagar＠torproject.org 04 Nov '13

04 Nov '13

commit d6a95bf778e6b90d9de9ea46aefcfce2f9103e68 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 3 23:22:32 2013 -0800 Adding support for TB_EMPTY events Last event type from... https://gitweb.torproject.org/torspec.git/commitdiff/6f2919a --- docs/change_log.rst | 1 + stem/__init__.py | 18 +++++++++++++++++ stem/response/events.py | 44 ++++++++++++++++++++++++++++++++++++++++++ stem/version.py | 2 ++ test/unit/response/events.py | 41 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 106 insertions(+) diff --git a/docs/change_log.rst b/docs/change_log.rst index 5c6fed2..7b71c47 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -45,6 +45,7 @@ The following are only available within stem's `git repository * Added `support for CONN_BW events <api/response.html#stem.response.events.ConnectionBandwidthEvent>`_ (:spec:`6f2919a`) * Added `support for CIRC_BW events <api/response.html#stem.response.events.CircuitBandwidthEvent>`_ (:spec:`6f2919a`) * Added `support for CELL_STATS events <api/response.html#stem.response.events.CellStatsEvent>`_ (:spec:`6f2919a`) + * Added `support for TB_EMPTY events <api/response.html#stem.response.events.TokenBucketEmptyEvent>`_ (:spec:`6f2919a`) .. _version_1.1: diff --git a/stem/__init__.py b/stem/__init__.py index 182428f..9710d24 100644 --- a/stem/__init__.py +++ b/stem/__init__.py @@ -380,6 +380,18 @@ Library for working with the tor process. **DIR** fetching or sending tor descriptor data **EXIT** carrying traffic between the tor network and an external destination =============== =========== + +.. data:: TokenBucket (enum) + + Bucket categories of TB_EMPTY events. + + =============== =========== + TokenBucket Description + =============== =========== + **GLOBAL** global token bucket + **RELAY** relay token bucket + **ORCONN** bucket used for OR connections + =============== =========== """ __version__ = '1.1.0-dev' @@ -718,3 +730,9 @@ ConnectionType = stem.util.enum.UppercaseEnum( "DIR", "EXIT", ) + +TokenBucket = stem.util.enum.UppercaseEnum( + "GLOBAL", + "RELAY", + "ORCONN", +) diff --git a/stem/response/events.py b/stem/response/events.py index 616bbfc..19e1680 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -1069,6 +1069,49 @@ class CellStatsEvent(Event): self.outbound_time = _parse_cell_type_mapping(self.outbound_time) +class TokenBucketEmptyEvent(Event): + """ + Event emitted when refilling an empty token bucket. **These events are only + emitted if TestingTorNetwork is set.** + + The TB_EMPTY event was introduced in tor version 0.2.5.2-alpha. + + .. versionadded:: 1.1.0-dev + + :var stem.TokenBucket bucket: bucket being refilled + :var str id: connection identifier + :var int read: time in milliseconds since the read bucket was last refilled + :var int written: time in milliseconds since the write bucket was last refilled + :var int last_refill: time in milliseconds the bucket has been empty since last refilled + """ + + _POSITIONAL_ARGS = ("bucket",) + _KEYWORD_ARGS = { + "ID": "id", + "READ": "read", + "WRITTEN": "written", + "LAST": "last_refill", + } + + _VERSION_ADDED = stem.version.Requirement.EVENT_TB_EMPTY + + def _parse(self): + if self.id and not tor_tools.is_valid_connection_id(self.id): + raise stem.ProtocolError("Connection IDs must be one to sixteen alphanumeric characters, got '%s': %s" % (self.id, self)) + elif not self.read.isdigit(): + raise stem.ProtocolError("A TB_EMPTY's READ value should be a positive numeric value, received: %s" % self) + elif not self.written.isdigit(): + raise stem.ProtocolError("A TB_EMPTY's WRITTEN value should be a positive numeric value, received: %s" % self) + elif not self.last_refill.isdigit(): + raise stem.ProtocolError("A TB_EMPTY's LAST value should be a positive numeric value, received: %s" % self) + + self.read = int(self.read) + self.written = int(self.written) + self.last_refill = int(self.last_refill) + + self._log_if_unrecognized('bucket', stem.TokenBucket) + + def _parse_cell_type_mapping(mapping): """ Parses a mapping of the form... @@ -1133,6 +1176,7 @@ EVENT_TYPE_TO_CLASS = { "STATUS_SERVER": StatusEvent, "STREAM": StreamEvent, "STREAM_BW": StreamBwEvent, + "TB_EMPTY": TokenBucketEmptyEvent, "TRANSPORT_LAUNCHED": TransportLaunchedEvent, "WARN": LogEvent, diff --git a/stem/version.py b/stem/version.py index ef1f290..b0563d5 100644 --- a/stem/version.py +++ b/stem/version.py @@ -46,6 +46,7 @@ easily parsed and compared, for instance... **EVENT_CONN_BW** CONN_BW events **EVENT_CIRC_BW** CIRC_BW events **EVENT_CELL_STATS** CELL_STATS events + **EVENT_TB_EMPTY** TB_EMPTY events **EXTENDCIRCUIT_PATH_OPTIONAL** EXTENDCIRCUIT queries can omit the path if the circuit is zero **FEATURE_EXTENDED_EVENTS** 'EXTENDED_EVENTS' optional feature **FEATURE_VERBOSE_NAMES** 'VERBOSE_NAMES' optional feature @@ -347,6 +348,7 @@ Requirement = stem.util.enum.Enum( ("EVENT_CONN_BW", Version('0.2.5.2-alpha')), ("EVENT_CIRC_BW", Version('0.2.5.2-alpha')), ("EVENT_CELL_STATS", Version('0.2.5.2-alpha')), + ("EVENT_TB_EMPTY", Version('0.2.5.2-alpha')), ("EXTENDCIRCUIT_PATH_OPTIONAL", Version("0.2.2.9")), ("FEATURE_EXTENDED_EVENTS", Version("0.2.2.1-alpha")), ("FEATURE_VERBOSE_NAMES", Version("0.2.2.1-alpha")), diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 09fca4f..c3cdf7a 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -357,6 +357,13 @@ CELL_STATS_BAD_1 = "650 CELL_STATS OutboundAdded=create_fast:-1,relay_early:2" CELL_STATS_BAD_2 = "650 CELL_STATS OutboundAdded=create_fast:arg,relay_early:-2" CELL_STATS_BAD_3 = "650 CELL_STATS OutboundAdded=create_fast!:1,relay_early:-2" +TB_EMPTY_1 = "650 TB_EMPTY ORCONN ID=16 READ=0 WRITTEN=0 LAST=100" +TB_EMPTY_2 = "650 TB_EMPTY GLOBAL READ=93 WRITTEN=93 LAST=100" +TB_EMPTY_3 = "650 TB_EMPTY RELAY READ=93 WRITTEN=93 LAST=100" + +TB_EMPTY_BAD_1 = "650 TB_EMPTY GLOBAL READ=93 WRITTEN=blarg LAST=100" +TB_EMPTY_BAD_2 = "650 TB_EMPTY GLOBAL READ=93 WRITTEN=93 LAST=-100" + def _get_event(content): controller_event = mocking.get_message(content) @@ -1282,6 +1289,40 @@ class TestEvents(unittest.TestCase): self.assertRaises(ProtocolError, _get_event, CELL_STATS_BAD_2) self.assertRaises(ProtocolError, _get_event, CELL_STATS_BAD_3) + def test_token_bucket_empty_event(self): + event = _get_event(TB_EMPTY_1) + + self.assertTrue(isinstance(event, stem.response.events.TokenBucketEmptyEvent)) + self.assertEqual(TB_EMPTY_1.lstrip("650 "), str(event)) + self.assertEqual(stem.TokenBucket.ORCONN, event.bucket) + self.assertEqual("16", event.id) + self.assertEqual(0, event.read) + self.assertEqual(0, event.written) + self.assertEqual(100, event.last_refill) + + event = _get_event(TB_EMPTY_2) + + self.assertTrue(isinstance(event, stem.response.events.TokenBucketEmptyEvent)) + self.assertEqual(TB_EMPTY_2.lstrip("650 "), str(event)) + self.assertEqual(stem.TokenBucket.GLOBAL, event.bucket) + self.assertEqual(None, event.id) + self.assertEqual(93, event.read) + self.assertEqual(93, event.written) + self.assertEqual(100, event.last_refill) + + event = _get_event(TB_EMPTY_3) + + self.assertTrue(isinstance(event, stem.response.events.TokenBucketEmptyEvent)) + self.assertEqual(TB_EMPTY_3.lstrip("650 "), str(event)) + self.assertEqual(stem.TokenBucket.RELAY, event.bucket) + self.assertEqual(None, event.id) + self.assertEqual(93, event.read) + self.assertEqual(93, event.written) + self.assertEqual(100, event.last_refill) + + self.assertRaises(ProtocolError, _get_event, TB_EMPTY_BAD_1) + self.assertRaises(ProtocolError, _get_event, TB_EMPTY_BAD_2) + def test_unrecognized_enum_logging(self): """ Checks that when event parsing gets a value that isn't recognized by stem's

1 0