August 2012 - tor-commits - lists.torproject.org

[torbrowser/master] Merge branch 'maint-2.2' into maint-2.3
by erinn＠torproject.org 27 Aug '12

27 Aug '12

commit 18d1057df5a2e539d9d48552da3cad4962b5959e Merge: 0aafb37 2c75280 Author: Erinn Clark <erinn(a)torproject.org> Date: Mon Aug 27 07:13:55 2012 +0100 Merge branch 'maint-2.2' into maint-2.3 README.LINUX-2.2 | 8 ++++---- README.OSX-2.2 | 8 ++++---- README.WIN-2.2 | 8 ++++---- build-scripts/linux.mk | 2 +- build-scripts/osx.mk | 2 +- build-scripts/versions.mk | 6 +++--- build-scripts/windows.mk | 2 +- changelog.… [View More]

1 0

[torbrowser/master] Merge branch 'maint-2.3'
by erinn＠torproject.org 27 Aug '12

27 Aug '12

commit 31c0e3c93b2d8b003ab30bb90c69c2f01e97f29a Merge: a1b4049 18d1057 Author: Erinn Clark <erinn(a)torproject.org> Date: Mon Aug 27 07:14:01 2012 +0100 Merge branch 'maint-2.3' README.LINUX-2.2 | 8 ++++---- README.OSX-2.2 | 8 ++++---- README.WIN-2.2 | 8 ++++---- build-scripts/linux.mk | 2 +- build-scripts/osx.mk | 2 +- build-scripts/versions.mk | 6 +++--- build-scripts/windows.mk | 2 +- changelog.linux-2.2 … [View More]

1 0

[metrics-web/master] Stop warning when Torperf data are stale.
by karsten＠torproject.org 27 Aug '12

27 Aug '12

commit 71b8d3a19108f74df286f964a59fd06b535e5ee1 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 27 06:21:11 2012 +0200 Stop warning when Torperf data are stale. That's metrics-db's job, not metrics-web's. Having 1 hourly warning mail (from metrics-db) is enough. --- .../torproject/ernie/cron/TorperfProcessor.java | 11 +---------- 1 files changed, 1 insertions(+), 10 deletions(-) diff --git a/src/org/torproject/ernie/cron/TorperfProcessor.java … [View More]

1 0

[stem/master] Add Controller.is_feature_enabled
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 17d536657c43984665138ee131e77a6a291176d5 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Wed Aug 22 23:45:49 2012 +0530 Add Controller.is_feature_enabled Also made some minor modifications based on CR in #6417 --- stem/control.py | 41 +++++++++++++++++++++++++++---------- stem/version.py | 3 +- test/integ/control/controller.py | 8 +++++- 3 files changed, 38 insertions(+), 14 deletions(-) diff --git a/stem/… [View More]control.py b/stem/control.py index f2eb47a..8d59682 100644 --- a/stem/control.py +++ b/stem/control.py @@ -24,6 +24,7 @@ interacting at a higher level. |- set_options - sets or resets the values of multiple configuration options |- load_conf - loads configuration information as if it was in the torrc |- save_conf - saves configuration information to the torrc + |- is_feature_enabled - returns true if a given control connection feature is enabled |- enable_feature - enables control protocol features that have been disabled by default |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller @@ -489,6 +490,7 @@ class Controller(BaseController): # number of sequental 'GETINFO ip-to-country/*' lookups that have failed self._geoip_failure_count = 0 + self.enabled_features = [] def connect(self): super(Controller, self).connect() @@ -964,6 +966,28 @@ class Controller(BaseController): else: raise stem.socket.ProtocolError("SAVECONF returned unexpected response code") + def is_feature_enabled(self, feature): + """ + Checks if a control connection feature is enabled. These features can be + enabled using :func:`stem.control.Controller.enable_feature`. + + :param str feature: feature to be checked + + :returns: True if feature is enabled, False otherwise + """ + + defaulted_version = None + + if feature == "EXTENDED_EVENTS": + defaulted_version = stem.version.Requirement.EXTENDED_EVENTS_DEFAULTED + elif feature == "VERBOSE_NAMES": + defaulted_version = stem.version.Requirement.VERBOSE_NAMES_DEFAULTED + + if defaulted_version and self.get_version().meets_requirements(defaulted_version): + return True + else: + return feature in self.enabled_features + def enable_feature(self, features): """ Enables features that are disabled by default to maintain backward @@ -972,21 +996,14 @@ class Controller(BaseController): disabled. Feature names are case-insensitive. The following features are currently accepted: - * EXTENDED_EVENTS - Requests the extended event syntax. Has the same - effect as calling SETEVENTS with EXTENDED. Introduced in - 0.1.2.3-alpha, always-on since Tor 0.2.2.1-alpha - * VERBOSE_NAMES - Replaces ServerID with LongName in events and GETINFO - results. LongName provides a Fingerprint for all routers, an indication - of Named status, and a Nickname if one is known. LongName is strictly - more informative than ServerID, which only provides either a Fingerprint - or a Nickname. Introduced in 0.1.2.2-alpha, always-on since Tor - 0.2.2.1-alpha. + * EXTENDED_EVENTS - Requests the extended event syntax + * VERBOSE_NAMES - Replaces ServerID with LongName in events and GETINFO results :param str,list features: a single feature or a list of features to be enabled :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if features passed were invalid + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if features passed were invalid """ if type(features) == str: features = [features] @@ -1000,6 +1017,8 @@ class Controller(BaseController): invalid_feature = [response.message[22:response.message.find("\"", 22)]] raise stem.socket.InvalidArguments(response.code, response.message, invalid_feature) raise stem.socket.ProtocolError("USEFEATURE returned invalid response code") + + self.enabled_features = list(set(self.enabled_features).union(features)) def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/stem/version.py b/stem/version.py index e17d63b..90cc997 100644 --- a/stem/version.py +++ b/stem/version.py @@ -249,6 +249,7 @@ Requirement = stem.util.enum.Enum( ("LOADCONF", Version("0.2.1.1")), ("TORRC_CONTROL_SOCKET", Version("0.2.0.30")), ("TORRC_DISABLE_DEBUGGER_ATTACHMENT", Version("0.2.3.9")), - ("FEATURE_VERBOSENAMES", Version("0.1.2.2-alpha")), + ("VERBOSE_NAMES_DEFAULTED", Version("0.2.2.1-alpha")), + ("EXTENDED_EVENTS_DEFAULTED", Version("0.2.2.1-alpha")), ) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 88ef642..ea91c8c 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -4,9 +4,10 @@ Integration tests for the stem.control.Controller class. from __future__ import with_statement +import re +import shutil import unittest import tempfile -import shutil import stem.control import stem.socket @@ -327,8 +328,11 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() with runner.get_tor_controller() as controller: - if test.runner.require_version(self, stem.version.Requirement.FEATURE_VERBOSENAMES): + if not test.runner.require_version(self, stem.version.Version("0.1.2.2-alpha")): controller.enable_feature("VERBOSE_NAMES") + self.assertTrue(re.match("\$[0-9a-fA-F]{40}[~=].*", controller.get_info('orconn-status').split()[0])) + self.assertTrue(controller.is_feature_enabled("VERBOSE_NAMES")) + self.assertTrue("VERBOSE_NAMES" in controller.enabled_features) self.assertRaises(stem.socket.InvalidArguments, controller.enable_feature, ["NOT", "A", "FEATURE"]) try: controller.enable_feature(["NOT", "A", "FEATURE"]) [View Less]

1 0

[stem/master] Implement use_feature wrapper method
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 9a70131cf2bf0b25f89faa89c62fb70d5e891ee1 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Tue Jul 3 01:34:46 2012 +0530 Implement use_feature wrapper method --- stem/control.py | 38 ++++++++++++++++++++++++++++++++++++++ stem/version.py | 1 + test/integ/control/controller.py | 19 +++++++++++++++++++ 3 files changed, 58 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index dd5f812..f2eb47a … [View More]100644 --- a/stem/control.py +++ b/stem/control.py @@ -24,6 +24,7 @@ interacting at a higher level. |- set_options - sets or resets the values of multiple configuration options |- load_conf - loads configuration information as if it was in the torrc |- save_conf - saves configuration information to the torrc + |- enable_feature - enables control protocol features that have been disabled by default |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -962,6 +963,43 @@ class Controller(BaseController): raise stem.socket.OperationFailed(response.code, response.message) else: raise stem.socket.ProtocolError("SAVECONF returned unexpected response code") + + def enable_feature(self, features): + """ + Enables features that are disabled by default to maintain backward + compatibility. Once enabled, a feature cannot be disabled and a new + control connection must be opened to get a connection with the feature + disabled. Feature names are case-insensitive. + + The following features are currently accepted: + * EXTENDED_EVENTS - Requests the extended event syntax. Has the same + effect as calling SETEVENTS with EXTENDED. Introduced in + 0.1.2.3-alpha, always-on since Tor 0.2.2.1-alpha + * VERBOSE_NAMES - Replaces ServerID with LongName in events and GETINFO + results. LongName provides a Fingerprint for all routers, an indication + of Named status, and a Nickname if one is known. LongName is strictly + more informative than ServerID, which only provides either a Fingerprint + or a Nickname. Introduced in 0.1.2.2-alpha, always-on since Tor + 0.2.2.1-alpha. + + :param str,list features: a single feature or a list of features to be enabled + + :raises: + :class:`stem.socket.ControllerError` if the call fails + :class:`stem.socket.InvalidArguments` if features passed were invalid + """ + + if type(features) == str: features = [features] + response = self.msg("USEFEATURE %s" % " ".join(features)) + stem.response.convert("SINGLELINE", response) + + if not response.is_ok(): + if response.code == "552": + invalid_feature = [] + if response.message.startswith("Unrecognized feature \""): + invalid_feature = [response.message[22:response.message.find("\"", 22)]] + raise stem.socket.InvalidArguments(response.code, response.message, invalid_feature) + raise stem.socket.ProtocolError("USEFEATURE returned invalid response code") def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/stem/version.py b/stem/version.py index 08f5ca2..e17d63b 100644 --- a/stem/version.py +++ b/stem/version.py @@ -249,5 +249,6 @@ Requirement = stem.util.enum.Enum( ("LOADCONF", Version("0.2.1.1")), ("TORRC_CONTROL_SOCKET", Version("0.2.0.30")), ("TORRC_DISABLE_DEBUGGER_ATTACHMENT", Version("0.2.3.9")), + ("FEATURE_VERBOSENAMES", Version("0.1.2.2-alpha")), ) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 54f2626..88ef642 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -316,4 +316,23 @@ class TestController(unittest.TestCase): finally: controller.load_conf(oldconf) controller.save_conf() + + def test_enable_feature(self): + """ + Test Controller.enable_feature with valid and invalid inputs. + """ + + if test.runner.require_control(self): return + + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + if test.runner.require_version(self, stem.version.Requirement.FEATURE_VERBOSENAMES): + controller.enable_feature("VERBOSE_NAMES") + self.assertRaises(stem.socket.InvalidArguments, controller.enable_feature, ["NOT", "A", "FEATURE"]) + try: + controller.enable_feature(["NOT", "A", "FEATURE"]) + except stem.socket.InvalidArguments, exc: + self.assertEqual(["NOT"], exc.arguments) + else: self.fail() [View Less]

1 0

[stem/master] Fix documentation formatting
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 51a00e9a3a2f2fa10277759616582d4acd2942a3 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Aug 23 00:05:10 2012 +0530 Fix documentation formatting --- stem/control.py | 34 +++++++++++++++++----------------- 1 files changed, 17 insertions(+), 17 deletions(-) diff --git a/stem/control.py b/stem/control.py index 8d59682..84a9df1 100644 --- a/stem/control.py +++ b/stem/control.py @@ -553,8 +553,8 @@ class Controller(BaseController): * default if one … [View More]was provided and our call failed :raises: - :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response - :class:`stem.socket.InvalidArguments` if the 'param' requested was invalid + * :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response + * :class:`stem.socket.InvalidArguments` if the 'param' requested was invalid """ start_time = time.time() @@ -691,8 +691,8 @@ class Controller(BaseController): * default if one was provided and our call failed :raises: - :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response - :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid + * :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response + * :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid """ # Config options are case insensitive and don't contain whitespace. Using @@ -743,8 +743,8 @@ class Controller(BaseController): * default if one was provided and our call failed :raises: - :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response - :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid + * :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response + * :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid """ start_time = time.time() @@ -829,9 +829,9 @@ class Controller(BaseController): :param str,list value: value to set the parameter to :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if configuration options requested was invalid - :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if configuration options requested was invalid + * :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values """ self.set_options({param: value}, False) @@ -843,9 +843,9 @@ class Controller(BaseController): :param str params: configuration option to be reset :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if configuration options requested was invalid - :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if configuration options requested was invalid + * :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values """ self.set_options(dict([(entry, None) for entry in params]), True) @@ -875,9 +875,9 @@ class Controller(BaseController): :param bool reset: issues a RESETCONF, returning None values to their defaults if True :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if configuration options requested was invalid - :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if configuration options requested was invalid + * :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values """ start_time = time.time() @@ -952,8 +952,8 @@ class Controller(BaseController): Saves the current configuration options into the active torrc file. :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.OperationFailed` if the client is unable to save the configuration file + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.OperationFailed` if the client is unable to save the configuration file """ response = self.msg("SAVECONF") [View Less]

1 0

[stem/master] Collapsing SIGNAL documentation
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 4f8b48ba3a7ee34a5725c9df242a961da9e7da01 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 23 22:01:31 2012 -0700 Collapsing SIGNAL documentation Shortening the pydocs for the signal() method. Might as well list both signal aliases on the same line. --- stem/control.py | 22 +++++++++------------- 1 files changed, 9 insertions(+), 13 deletions(-) diff --git a/stem/control.py b/stem/control.py index adf1d8a..247969e 100644 --- a/stem/control.py ++… [View More]+ b/stem/control.py @@ -1033,18 +1033,13 @@ class Controller(BaseController): Sends a signal to the Tor client. :param str signal: type of signal to be sent. Must be one of the following... - * HUP - Reload configuration - * INT - If server is an OP, exit immediately. If it's an OR, close listeners and exit after ShutdownWaitLength seconds - * USR1 - Dump log information about open connections and circuits - * USR2 - Switch all open logs to loglevel debug - * TERM - Clean up and exit immediately - * RELOAD - equivalent to HUP - * SHUTDOWN - equivalent to INT - * DUMP - . equivalent to USR1 - * DEBUG - . equivalent to USR2 - * HALT - . equivalent to TERM - * NEWNYM - Switch to clean circuits, so new application requests don't share any circuits with old ones and clear the client-side dns cache - * CLEARDNSCACHE - Forget the client-side cached IPs for all hostnames + * RELOAD or HUP - reload configuration + * SHUTDOWN or INT - shut down, waiting ShutdownWaitLength first if we're a relay + * DUMP or USR1 - dump log information about open connections and circuits + * DEBUG or USR2 - switch logging to the DEBUG runlevel + * HALT or TERM - exit immediately + * NEWNYM - switch to new circuits, so new application requests don't share any circuits with old ones (this also clears our DNS cache) + * CLEARDNSCACHE - clears cached DNS results :raises: :class:`stem.socket.InvalidArguments` if signal provided wasn't recognized. """ @@ -1055,7 +1050,8 @@ class Controller(BaseController): if not response.is_ok(): if response.code == "552": raise stem.socket.InvalidArguments(response.code, response.message, [signal]) - raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code") + + raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code: %s" % response.code) def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ [View Less]

1 0

[stem/master] Implement Controller.extend_circuit
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit fea0a43ded650b78d9453c1bc2ce15fdb99e394f Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Aug 23 22:07:01 2012 -0700 Implement Controller.extend_circuit --- stem/control.py | 57 ++++++++++++++++++++++++++++++++++++++ test/integ/control/controller.py | 17 ++++++++++- 2 files changed, 73 insertions(+), 1 deletions(-) diff --git a/stem/control.py b/stem/control.py index 247969e..2f0c773 100644 --- a/stem/control.py +++ b/stem/control.py … [View More]@@ -27,6 +27,8 @@ interacting at a higher level. |- is_feature_enabled - checks if a given controller feature is enabled |- enable_feature - enables a controller feature that has been disabled by default |- signal - sends a signal to the tor client + |- new_circuit - create new circuits + |- extend_circuit - create new circuits and extend existing ones |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -1052,6 +1054,61 @@ class Controller(BaseController): raise stem.socket.InvalidArguments(response.code, response.message, [signal]) raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code: %s" % response.code) + + def new_circuit(self, relays = None, purpose = None): + """ + Requests Tor to build a new circuit. + + If the path isn't provided, one is automatically selected. If the purpose + isn't provided, "general" circuits are built. + + :param list,str relays: list of relay nicknames/longnames or a single nickname/longname + :param str purpose: "general" or "controller" + + :returns: Circuit id of the newly created circuit + """ + + return self.extend_circuit(0, relays, purpose) + + def extend_circuit(self, circuit=0, relays = None, purpose = None): + """ + Requests Tor to build a new circuit or extend an existing circuit. + + When called without any arguments, a new general purpose circuit is created. + If circuit is zero, a new circuit is created. If circuit is non-zero, Tor + extends the existing circuit with that id . If the path isn't provided, one + is automatically selected. If the purpose isn't provided, "general" circuits + are built. + + :param int circuit: id of the circuit which needs extending + :param list,str relays: list of relay nicknames/longnames or a single nickname/longname + :param str purpose: "general" or "controller" + + :returns: Circuit id of the created/extended circuit + + :raises: :class:`stem.socket.InvalidRequest` if one of the parameters were invalid + """ + + args = [str(circuit)] + if type(relays) == str: relays = [relays] + if relays: args.append(",".join(relays)) + if purpose: args.append("purpose=%s" % purpose) + + response = self.msg("EXTENDCIRCUIT %s" % " ".join(args)) + stem.response.convert("SINGLELINE", response) + + if response.is_ok(): + try: + extended, new_circuit = response.message.split(" ") + assert extended == "EXTENDED" + except: + raise stem.socket.ProtocolError("EXTENDCIRCUIT response invalid:\n%s", str(response)) + elif response.code == '552': + raise stem.socket.InvalidRequest(response.code, response.message) + else: + raise stem.socket.ProtocolError("EXTENDCIRCUIT returned unexpected response code: %s" % response.code) + + return int(new_circuit) def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 450d219..9a64d36 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -299,7 +299,6 @@ class TestController(unittest.TestCase): controller.load_conf(oldconf) def test_saveconf(self): - if test.runner.require_control(self): return runner = test.runner.get_runner() @@ -364,4 +363,20 @@ class TestController(unittest.TestCase): controller.signal("INT") self.assertRaises(stem.socket.SocketClosed, controller.msg, "GETINFO version") + + def test_extendcircuit(self): + if test.runner.require_control(self): return + + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + circ_id = controller.extend_circuit(0) + # check if our circuit was created + self.assertTrue(filter(lambda x: int(x.split()[0]) == circ_id, controller.get_info('circuit-status').splitlines())) + circ_id = controller.new_circuit() + self.assertTrue(filter(lambda x: int(x.split()[0]) == circ_id, controller.get_info('circuit-status').splitlines())) + + self.assertRaises(stem.socket.InvalidRequest, controller.extend_circuit, "foo") + self.assertRaises(stem.socket.InvalidRequest, controller.extend_circuit, 0, "thisroutershouldntexistbecausestemexists!@##$%#") + self.assertRaises(stem.socket.InvalidRequest, controller.extend_circuit, 0, "thisroutershouldntexistbecausestemexists!@##$%#", "foo") [View Less]

1 0

[stem/master] Implement wrapper method for Controller to handle SIGNAL requests
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit aeb39b813961d02509a9c3e4e3db585b4190cac1 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Aug 23 21:52:01 2012 -0700 Implement wrapper method for Controller to handle SIGNAL requests --- stem/control.py | 31 +++++++++++++++++++++++++++++++ test/integ/control/controller.py | 16 ++++++++++++++++ 2 files changed, 47 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index 7edd7bf..adf1d8a 100644 --- a/stem/… [View More]control.py +++ b/stem/control.py @@ -26,6 +26,7 @@ interacting at a higher level. |- save_conf - saves configuration information to the torrc |- is_feature_enabled - checks if a given controller feature is enabled |- enable_feature - enables a controller feature that has been disabled by default + |- signal - sends a signal to the tor client |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -1026,6 +1027,35 @@ class Controller(BaseController): raise stem.socket.ProtocolError("USEFEATURE provided an invalid response code: %s" % response.code) self.enabled_features += [entry.upper() for entry in features] + + def signal(self, signal): + """ + Sends a signal to the Tor client. + + :param str signal: type of signal to be sent. Must be one of the following... + * HUP - Reload configuration + * INT - If server is an OP, exit immediately. If it's an OR, close listeners and exit after ShutdownWaitLength seconds + * USR1 - Dump log information about open connections and circuits + * USR2 - Switch all open logs to loglevel debug + * TERM - Clean up and exit immediately + * RELOAD - equivalent to HUP + * SHUTDOWN - equivalent to INT + * DUMP - . equivalent to USR1 + * DEBUG - . equivalent to USR2 + * HALT - . equivalent to TERM + * NEWNYM - Switch to clean circuits, so new application requests don't share any circuits with old ones and clear the client-side dns cache + * CLEARDNSCACHE - Forget the client-side cached IPs for all hostnames + + :raises: :class:`stem.socket.InvalidArguments` if signal provided wasn't recognized. + """ + + response = self.msg("SIGNAL %s" % signal) + stem.response.convert("SINGLELINE", response) + + if not response.is_ok(): + if response.code == "552": + raise stem.socket.InvalidArguments(response.code, response.message, [signal]) + raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code") def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ @@ -1053,3 +1083,4 @@ def _case_insensitive_lookup(entries, key, default = UNDEFINED): if default != UNDEFINED: return default else: raise ValueError("key '%s' doesn't exist in dict: %s" % (key, entries)) + diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 2723e27..450d219 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -348,4 +348,20 @@ class TestController(unittest.TestCase): except stem.socket.InvalidArguments, exc: self.assertEqual(["NOT"], exc.arguments) else: self.fail() + + def test_signal(self): + """ + Test controller.signal with valid and invalid signals. + """ + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + # valid signal + controller.signal("CLEARDNSCACHE") + + # invalid signals + self.assertRaises(stem.socket.InvalidArguments, controller.signal, "FOOBAR") + + controller.signal("INT") + self.assertRaises(stem.socket.SocketClosed, controller.msg, "GETINFO version") [View Less]

1 0

[stem/master] Adding methods for SIGNAL and EXTENDCIRCUIT
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 3df65c080072d11d77664e2738652f3c0c08134e Merge: 4f6a16c 74ba2e9 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 24 12:51:00 2012 -0700 Adding methods for SIGNAL and EXTENDCIRCUIT Feature additions by Ravi. cr atagar (https://trac.torproject.org/6659 and https://trac.torproject.org/6666) stem/control.py | 79 ++++++++++++++++++++++++++++++++++++++ test/integ/control/controller.py | 34 +++++++++++++++- test/runner.py … [View More]

1 0