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

[stem/master] Fix test_repurpose_circuits to work with string ids
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 299a872c0b7ba26babec3febf8c0a8adad09f4c7 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Dec 22 17:17:47 2012 +0530 Fix test_repurpose_circuits to work with string ids --- test/integ/control/controller.py | 20 ++++++++++---------- 1 files changed, 10 insertions(+), 10 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 32cc3a2..1b2c146 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -540,16 +540,16 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() with runner.get_tor_controller() as controller: - circuit_id = controller.new_circuit() - controller.repurpose_circuit(circuit_id, "CONTROLLER") - circuit_output = controller.get_info("circuit-status") - circ = filter(re.compile("^%s " % circuit_id).match, circuit_output.splitlines())[0] - self.assertTrue("PURPOSE=CONTROLLER" in circ) + circ_id = controller.new_circuit() + controller.repurpose_circuit(circ_id, "CONTROLLER") + circuits = controller.get_circuits() + circuit = filter(lambda circ: circ.id == circ_id, circuits)[0] + self.assertTrue(circuit.purpose == "CONTROLLER") - controller.repurpose_circuit(circuit_id, "GENERAL") - circuit_output = controller.get_info("circuit-status") - circ = filter(re.compile("^%s " % circuit_id).match, circuit_output.splitlines())[0] - self.assertTrue("PURPOSE=GENERAL" in circ) + controller.repurpose_circuit(circ_id, "GENERAL") + circuits = controller.get_circuits() + circuit = filter(lambda circ: circ.id == circ_id, circuits)[0] + self.assertTrue(circuit.purpose == "GENERAL") self.assertRaises(stem.InvalidRequest, controller.repurpose_circuit, 'f934h9f3h4', "fooo") self.assertRaises(stem.InvalidRequest, controller.repurpose_circuit, '4', "fooo")

1 0

[stem/master] Make test_close_circuit use Controller.get_circuits()
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit bcd03831cace7352a7cbdf4e9f4dd651d86a48af Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Dec 22 17:25:19 2012 +0530 Make test_close_circuit use Controller.get_circuits() --- test/integ/control/controller.py | 18 ++++++++---------- 1 files changed, 8 insertions(+), 10 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 1b2c146..ef9d503 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -565,17 +565,15 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() with runner.get_tor_controller() as controller: - circuit_id = controller.new_circuit() - controller.close_circuit(circuit_id) - circuit_output = controller.get_info("circuit-status") - circ = [x.split()[0] for x in circuit_output.splitlines()] - self.assertFalse(circ_id in circ) + circ_id = controller.new_circuit() + controller.close_circuit(circ_id) + circuit_ids = [circ.id for circ in controller.get_circuits()] + self.assertFalse(circ_id in circuit_ids) - circuit_id = controller.new_circuit() - controller.close_circuit(circuit_id, "IfUnused") - circuit_output = controller.get_info("circuit-status") - circ = [x.split()[0] for x in circuit_output.splitlines()] - self.assertFalse(circ_id in circ) + circ_id = controller.new_circuit() + controller.close_circuit(circ_id, "IfUnused") + circuit_ids = [circ.id for circ in controller.get_circuits()] + self.assertFalse(circ_id in circuit_ids) circuit_id = controller.new_circuit() self.assertRaises(stem.InvalidArguments, controller.close_circuit, circuit_id + "1024")

1 0

[stem/master] Make test_extend_circuit and test_close_circuit use get_circuits
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 66af2a98e85db0442687b5a684013a41bdf50d9c Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sun Dec 23 22:55:32 2012 +0530 Make test_extend_circuit and test_close_circuit use get_circuits --- test/integ/control/controller.py | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index ef9d503..c77b7cb 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -521,9 +521,9 @@ class TestController(unittest.TestCase): with test.runner.get_runner().get_tor_controller() as controller: circuit_id = controller.extend_circuit('0') # check if our circuit was created - self.assertTrue(filter(lambda x: x.split()[0] == circuit_id, controller.get_info('circuit-status').splitlines())) + self.assertTrue(filter(lambda circ: circ.id == circuit_id, controller.get_circuits())) circuit_id = controller.new_circuit() - self.assertTrue(filter(lambda x: x.split()[0] == circuit_id, controller.get_info('circuit-status').splitlines())) + self.assertTrue(filter(lambda circ: circ.id == circuit_id, controller.get_circuits())) self.assertRaises(stem.InvalidRequest, controller.extend_circuit, "foo") self.assertRaises(stem.InvalidRequest, controller.extend_circuit, '0', "thisroutershouldntexistbecausestemexists!@##$%#") @@ -575,8 +575,8 @@ class TestController(unittest.TestCase): circuit_ids = [circ.id for circ in controller.get_circuits()] self.assertFalse(circ_id in circuit_ids) - circuit_id = controller.new_circuit() - self.assertRaises(stem.InvalidArguments, controller.close_circuit, circuit_id + "1024") + circ_id = controller.new_circuit() + self.assertRaises(stem.InvalidArguments, controller.close_circuit, str(int(circ_id) + 1024)) self.assertRaises(stem.InvalidRequest, controller.close_circuit, "") def test_mapaddress(self):

1 0

[stem/master] Make test_attach_stream more robust
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit d70e98ab0c58aa5a209b24394852ecb7ae39e563 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Wed Dec 26 14:44:38 2012 +0530 Make test_attach_stream more robust --- test/integ/control/controller.py | 15 ++++++++++++--- 1 files changed, 12 insertions(+), 3 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index c77b7cb..e950ff8 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -732,14 +732,23 @@ class TestController(unittest.TestCase): with runner.get_tor_controller() as controller: controller.set_conf("__LeaveStreamsUnattached", "1") socksport = controller.get_conf("SocksPort") - circuits_3hop = [c.id for c in controller.get_circuits() if len(c.path) == 3] - self.assertTrue(len(circuits_3hop) > 0) - circuit_id = circuits_3hop[0] + circ_status, circ_status_q = "", Queue() + + def handle_circ(circuit): + circ_status_q.put(circuit) def handle_streamcreated(stream): if stream.status == "NEW": controller.attach_stream(int(stream.id), int(circuit_id)) + controller.add_event_listener(handle_circ, stem.control.EventType.CIRC) + while circ_status != "BUILT": + circuit_id = controller.new_circuit() + while not circ_status in ("BUILT", "FAILED"): + circ_event = circ_status_q.get() + if circ_event.id == circuit_id: + circ_status = circ_event.status + controller.add_event_listener(handle_streamcreated, stem.control.EventType.STREAM) ip = test.util.external_ip('127.0.0.1', socksport) exit_circuit = [c for c in controller.get_circuits() if c.id == circuit_id]

1 0

[stem/master] use SocksListenAddress instead of SocksPort
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit b01a2e9b1474f6ff858ff85f40bcdcb68b8c66ac Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sun Dec 30 23:17:13 2012 +0530 use SocksListenAddress instead of SocksPort --- test/integ/control/controller.py | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index e950ff8..74173c4 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -589,7 +589,7 @@ class TestController(unittest.TestCase): controller.map_address({'1.2.1.2': 'ifconfig.me'}) s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - s.connect(('127.0.0.1', int(controller.get_conf('SocksPort')))) + s.connect(('127.0.0.1', int(controller.get_conf('SocksListenAddress').rsplit(':', 1)[1]))) test.util.negotiate_socks(s, '1.2.1.2', 80) s.sendall(test.util.ip_request) # make the http request for the ip address response = s.recv(1000) @@ -731,7 +731,7 @@ class TestController(unittest.TestCase): with runner.get_tor_controller() as controller: controller.set_conf("__LeaveStreamsUnattached", "1") - socksport = controller.get_conf("SocksPort") + socksport = int(controller.get_conf('SocksListenAddress').rsplit(':', 1)[1]) circ_status, circ_status_q = "", Queue() def handle_circ(circuit):

1 0

[stem/master] Add missing import
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 4d9a71295f5f4afcfb41f3f0f75ef4ecc45b2124 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sun Dec 30 23:03:48 2012 +0530 Add missing import --- test/util.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/test/util.py b/test/util.py index b89e48f..c8c40af 100644 --- a/test/util.py +++ b/test/util.py @@ -3,7 +3,7 @@ import struct import test.runner -from stem import ProtocolError +from stem import ProtocolError, SocketError error_msgs = { 0x5a: "SOCKS4A request granted",

1 0

[stem/master] Adding a get_circuit() Controller method
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit cb9b4b605e8bdb639b22b2e58e5d2e80da9dcb56 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 30 14:52:41 2012 -0800 Adding a get_circuit() Controller method While reading through the tests I realized that we frequently wanted a method for 'gimme the circuit with id X', so adding a method for that. --- stem/control.py | 27 +++++++++++++++++++++++++++ test/integ/control/controller.py | 15 +++++++-------- 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/stem/control.py b/stem/control.py index 3c5f8bf..4d21849 100644 --- a/stem/control.py +++ b/stem/control.py @@ -36,6 +36,7 @@ providing its own for interacting at a higher level. |- close_stream - close a stream |- repurpose_circuit - change a circuit's purpose |- map_address - maps one address to another such that connections to the original are replaced with the other + |- get_circuit - provides an active circuit |- get_circuits - provides a list of active circuits |- attach_stream - attach a stream to a circuit |- get_version - convenience method to get tor version @@ -1541,6 +1542,32 @@ class Controller(BaseController): return new_circuit + def get_circuit(self, circuit_id, default = UNDEFINED): + """ + Provides a circuit presently available from tor. + + :param int circuit_id: circuit to be fetched + :param object default: response if the query fails + + :returns: :class:`stem.events.CircuitEvent` for the given circuit + + :raises: + * :class:`stem.ControllerError` if the call fails + * ValueError if the circuit doesn't exist + + An exception is only raised if we weren't provided a default response. + """ + + try: + for circ in self.get_circuits(): + if circ.id == circuit_id: + return circ + + raise ValueError("Tor presently does not have a circuit with the id of '%s'" % circuit_id) + except Exception, exc: + if default: return default + else: raise exc + def get_circuits(self): """ Provides the list of circuits Tor is currently handling. diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 74173c4..2dac687 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -520,10 +520,11 @@ class TestController(unittest.TestCase): with test.runner.get_runner().get_tor_controller() as controller: circuit_id = controller.extend_circuit('0') + # check if our circuit was created - self.assertTrue(filter(lambda circ: circ.id == circuit_id, controller.get_circuits())) + self.assertIsNotNone(controller.get_circuit(circuit_id, None)) circuit_id = controller.new_circuit() - self.assertTrue(filter(lambda circ: circ.id == circuit_id, controller.get_circuits())) + self.assertIsNotNone(controller.get_circuit(circuit_id, None)) self.assertRaises(stem.InvalidRequest, controller.extend_circuit, "foo") self.assertRaises(stem.InvalidRequest, controller.extend_circuit, '0', "thisroutershouldntexistbecausestemexists!@##$%#") @@ -542,13 +543,11 @@ class TestController(unittest.TestCase): with runner.get_tor_controller() as controller: circ_id = controller.new_circuit() controller.repurpose_circuit(circ_id, "CONTROLLER") - circuits = controller.get_circuits() - circuit = filter(lambda circ: circ.id == circ_id, circuits)[0] + circuit = controller.get_circuit(circ_id) self.assertTrue(circuit.purpose == "CONTROLLER") controller.repurpose_circuit(circ_id, "GENERAL") - circuits = controller.get_circuits() - circuit = filter(lambda circ: circ.id == circ_id, circuits)[0] + circuit = controller.get_circuit(circ_id) self.assertTrue(circuit.purpose == "GENERAL") self.assertRaises(stem.InvalidRequest, controller.repurpose_circuit, 'f934h9f3h4', "fooo") @@ -751,9 +750,9 @@ class TestController(unittest.TestCase): controller.add_event_listener(handle_streamcreated, stem.control.EventType.STREAM) ip = test.util.external_ip('127.0.0.1', socksport) - exit_circuit = [c for c in controller.get_circuits() if c.id == circuit_id] + exit_circuit = controller.get_circuit(circuit_id) self.assertTrue(exit_circuit) - exit_ip = controller.get_network_status(exit_circuit[0].path[2][0]).address + exit_ip = controller.get_network_status(exit_circuit.path[2][0]).address self.assertEquals(exit_ip, ip)

1 0

[stem/master] Adding a default arg to get_circuits()
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 22f167fa48bf51d0f66736624293050bb022a936 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 30 15:03:49 2012 -0800 Adding a default arg to get_circuits() Getter methods should have a default argument (though admittedly I've been doing a bad job of requiring this, #7832). --- stem/control.py | 36 +++++++++++++++++++++--------------- 1 files changed, 21 insertions(+), 15 deletions(-) diff --git a/stem/control.py b/stem/control.py index 4d21849..641b647 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1565,27 +1565,33 @@ class Controller(BaseController): raise ValueError("Tor presently does not have a circuit with the id of '%s'" % circuit_id) except Exception, exc: - if default: return default - else: raise exc + if default == UNDEFINED: raise exc + else: return default - def get_circuits(self): + def get_circuits(self, default = UNDEFINED): """ - Provides the list of circuits Tor is currently handling. - - :returns: **list** of :class:`stem.events.CircuitEvent` objects + Provides tor's currently available circuits. - :raises: :class:`stem.ControllerError` if the call fails - """ + :param object default: response if the query fails - circuits = [] - response = self.get_info("circuit-status") + :returns: **list** of :class:`stem.events.CircuitEvent` for our circuits - for circ in response.splitlines(): - circ_message = stem.socket.recv_message(StringIO.StringIO("650 CIRC " + circ + "\r\n")) - stem.response.convert("EVENT", circ_message, arrived_at = 0) - circuits.append(circ_message) + :raises: :class:`stem.ControllerError` if the call fails and no default was provided + """ - return circuits + try: + circuits = [] + response = self.get_info("circuit-status") + + for circ in response.splitlines(): + circ_message = stem.socket.recv_message(StringIO.StringIO("650 CIRC " + circ + "\r\n")) + stem.response.convert("EVENT", circ_message, arrived_at = 0) + circuits.append(circ_message) + + return circuits + except Exception, exc: + if default == UNDEFINED: raise exc + else: return default def attach_stream(self, stream_id, circuit_id, hop = None): """

1 0

[stem/master] Renaming attach_stream()'s hop argument
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 9401596d2d07a2baadab5c4d144566f99d16df7d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 30 16:28:17 2012 -0800 Renaming attach_stream()'s hop argument Renaming the method's 'hop' argument to 'exiting_hop' to be more descriptive. Also tweaking how we make the query a bit. --- stem/control.py | 9 +++++---- 1 files changed, 5 insertions(+), 4 deletions(-) diff --git a/stem/control.py b/stem/control.py index 73f0faf..efe1403 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1654,7 +1654,7 @@ class Controller(BaseController): else: raise stem.ProtocolError("CLOSECIRCUIT returned unexpected response code: %s" % response.code) - def attach_stream(self, stream_id, circuit_id, hop = None): + def attach_stream(self, stream_id, circuit_id, exiting_hop = None): """ Attaches a stream to a circuit. @@ -1663,15 +1663,16 @@ class Controller(BaseController): :param str stream_id: id of the stream that must be attached :param str circuit_id: id of the circuit to which it must be attached - :param int hop: hop in the circuit that must be used as an exit node + :param int exiting_hop: hop in the circuit where traffic should exit :raises: * :class:`stem.InvalidRequest` if the stream or circuit id were unrecognized * :class:`stem.OperationFailed` if the stream couldn't be attached for any other reason """ - hop_str = " HOP=" + str(hop) if hop else "" - response = self.msg("ATTACHSTREAM %s %s%s" % (stream_id, circuit_id, hop_str)) + query = "ATTACHSTREAM %s %s" % (stream_id, circuit_id) + if exiting_hop: query += " HOP=%s" % exiting_hop + response = self.msg(query) stem.response.convert("SINGLELINE", response) if not response.is_ok():

1 0

[stem/master] Uniformly providing a default argument for getters
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit ffdd61ea41ca844047ac57725639a7cf0e22d41d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 30 16:03:30 2012 -0800 Uniformly providing a default argument for getters As disussed on 'https://trac.torproject.org/7832' it's important from a usability standpoint for all of our getter methods to support a 'default' argument. It's also nice to have class-wide uniformity on this since it makes the Controller class more intuitive to use. This also reorganizes the method listing in the header to group related methods, and has a couple small bits of backward incompatability (trying to get these breakages in early before making our initial release announcement)... * renamed protocolinfo() to get_protocolinfo() to match the other getters * renamed one of the 'circuit' arguments to 'circuit_id' (we did that for all of the methods but one) --- stem/control.py | 300 +++++++++++++++++++++++-------------- test/integ/control/controller.py | 2 +- 2 files changed, 187 insertions(+), 115 deletions(-) diff --git a/stem/control.py b/stem/control.py index 641b647..fdcf332 100644 --- a/stem/control.py +++ b/stem/control.py @@ -13,39 +13,50 @@ providing its own for interacting at a higher level. | |- from_port - Provides a Controller based on a port connection. | +- from_socket_file - Provides a Controller based on a socket file connection. | - |- add_event_listener - attaches an event listener to be notified of tor events - |- remove_event_listener - removes a listener so it isn't notified of further events - |- is_caching_enabled - true if the controller has enabled caching - |- is_geoip_unavailable - true if we've discovered our geoip db to be unavailable - |- clear_cache - clears any cached results + |- authenticate - authenticates this controller with tor + | + |- get_version - convenience method to get tor version + |- get_socks_listeners - provides where tor is listening for SOCKS connections + |- get_protocolinfo - information about the controller interface + | |- get_info - issues a GETINFO query for a parameter |- get_conf - gets the value of a configuration option - |- get_conf_mapping - gets the values of multiple configuration options + |- get_conf_map - gets the values of multiple configuration options + | + |- get_server_descriptor - querying the server descriptor for a relay + |- get_server_descriptors - provides all presently available server descriptors + |- get_network_status - querying the router status entry for a relay + |- get_network_statuses - provides all preently available router status entries + | |- set_conf - sets the value of a configuration option |- reset_conf - reverts configuration options to their default values |- set_options - sets or resets the values of multiple configuration options + | + |- add_event_listener - attaches an event listener to be notified of tor events + |- remove_event_listener - removes a listener so it isn't notified of further events + | |- load_conf - loads configuration information as if it was in the torrc |- save_conf - saves configuration information to the torrc - |- get_socks_listeners - provides (address, port) where tor is listening for SOCKS connections + | + |- is_caching_enabled - true if the controller has enabled caching + |- clear_cache - clears any cached results + | |- 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_circuit - provides an active circuit + |- get_circuits - provides a list of active circuits |- new_circuit - create new circuits |- extend_circuit - create new circuits and extend existing ones - |- close_circuit - close a circuit - |- close_stream - close a stream |- repurpose_circuit - change a circuit's purpose - |- map_address - maps one address to another such that connections to the original are replaced with the other - |- get_circuit - provides an active circuit - |- get_circuits - provides a list of active circuits + |- close_circuit - close a circuit + | |- attach_stream - attach a stream to a circuit - |- get_version - convenience method to get tor version - |- get_server_descriptor - querying the server descriptor for a relay - |- get_server_descriptors - provides all presently available server descriptors - |- get_network_status - querying the router status entry for a relay - |- get_network_statuses - provides all preently available router status entries - |- authenticate - convenience method to authenticate the controller - +- protocolinfo - convenience method to get the protocol info + |- close_stream - close a stream + | + |- signal - sends a signal to the tor client + |- is_geoip_unavailable - true if we've discovered our geoip db to be unavailable + +- map_address - maps one address to another such that connections to the original are replaced with the other BaseController - Base controller class asynchronous message handling |- msg - communicates with the tor process @@ -850,34 +861,43 @@ class Controller(BaseController): if default == UNDEFINED: raise exc else: return default - def get_version(self): + def get_version(self, default = UNDEFINED): """ A convenience method to get tor version that current controller is connected to. + :param object default: response if the query fails + :returns: :class:`~stem.version.Version` of the tor instance that we're connected to :raises: * :class:`stem.ControllerError` if unable to query the version * **ValueError** if unable to parse the version + + An exception is only raised if we weren't provided a default response. """ - if not self.is_caching_enabled(): - return stem.version.Version(self.get_info("version")) - elif not "version" in self._request_cache: - version = stem.version.Version(self.get_info("version")) - self._request_cache["version"] = version - - return self._request_cache["version"] + try: + if not self.is_caching_enabled(): + return stem.version.Version(self.get_info("version")) + elif not "version" in self._request_cache: + version = stem.version.Version(self.get_info("version")) + self._request_cache["version"] = version + + return self._request_cache["version"] + except Exception, exc: + if default == UNDEFINED: raise exc + else: return default - def get_server_descriptor(self, relay): + def get_server_descriptor(self, relay, default = UNDEFINED): """ Provides the server descriptor for the relay with the given fingerprint or nickname. If the relay identifier could be either a fingerprint *or* nickname then it's queried as a fingerprint. :param str relay: fingerprint or nickname of the relay to be queried + :param object default: response if the query fails :returns: :class:`~stem.descriptor.server_descriptor.RelayDescriptor` for the given relay @@ -885,45 +905,62 @@ class Controller(BaseController): * :class:`stem.ControllerError` if unable to query the descriptor * **ValueError** if **relay** doesn't conform with the pattern for being a fingerprint or nickname + + An exception is only raised if we weren't provided a default response. """ - if stem.util.tor_tools.is_valid_fingerprint(relay): - query = "desc/id/%s" % relay - elif stem.util.tor_tools.is_valid_nickname(relay): - query = "desc/name/%s" % relay - else: - raise ValueError("'%s' isn't a valid fingerprint or nickname" % relay) - - desc_content = self.get_info(query) - return stem.descriptor.server_descriptor.RelayDescriptor(desc_content) + try: + if stem.util.tor_tools.is_valid_fingerprint(relay): + query = "desc/id/%s" % relay + elif stem.util.tor_tools.is_valid_nickname(relay): + query = "desc/name/%s" % relay + else: + raise ValueError("'%s' isn't a valid fingerprint or nickname" % relay) + + desc_content = self.get_info(query) + return stem.descriptor.server_descriptor.RelayDescriptor(desc_content) + except Exception, exc: + if default == UNDEFINED: raise exc + else: return default - def get_server_descriptors(self): + def get_server_descriptors(self, default = UNDEFINED): """ Provides an iterator for all of the server descriptors that tor presently knows about. + :param list default: items to provide if the query fails + :returns: iterates over :class:`~stem.descriptor.server_descriptor.RelayDescriptor` for relays in the tor network - :raises: :class:`stem.ControllerError` if unable to query tor + :raises: :class:`stem.ControllerError` if unable to query tor and no + default was provided """ - # TODO: We should iterate over the descriptors as they're read from the - # socket rather than reading the whole thing into memory. - - desc_content = self.get_info("desc/all-recent") - - for desc in stem.descriptor.server_descriptor.parse_file(StringIO.StringIO(desc_content)): - yield desc + try: + # TODO: We should iterate over the descriptors as they're read from the + # socket rather than reading the whole thing into memory. + + desc_content = self.get_info("desc/all-recent") + + for desc in stem.descriptor.server_descriptor.parse_file(StringIO.StringIO(desc_content)): + yield desc + except Exception, exc: + if default == UNDEFINED: raise exc + else: + if entry is not None: + for entry in default: + yield entry - def get_network_status(self, relay): + def get_network_status(self, relay, default = UNDEFINED): """ Provides the router status entry for the relay with the given fingerprint or nickname. If the relay identifier could be either a fingerprint *or* nickname then it's queried as a fingerprint. :param str relay: fingerprint or nickname of the relay to be queried + :param object default: response if the query fails :returns: :class:`~stem.descriptor.router_status_entry.RouterStatusEntryV2` for the given relay @@ -932,43 +969,59 @@ class Controller(BaseController): * :class:`stem.ControllerError` if unable to query the descriptor * **ValueError** if **relay** doesn't conform with the patter for being a fingerprint or nickname + + An exception is only raised if we weren't provided a default response. """ - if stem.util.tor_tools.is_valid_fingerprint(relay): - query = "ns/id/%s" % relay - elif stem.util.tor_tools.is_valid_nickname(relay): - query = "ns/name/%s" % relay - else: - raise ValueError("'%s' isn't a valid fingerprint or nickname" % relay) - - desc_content = self.get_info(query) - return stem.descriptor.router_status_entry.RouterStatusEntryV2(desc_content) + try: + if stem.util.tor_tools.is_valid_fingerprint(relay): + query = "ns/id/%s" % relay + elif stem.util.tor_tools.is_valid_nickname(relay): + query = "ns/name/%s" % relay + else: + raise ValueError("'%s' isn't a valid fingerprint or nickname" % relay) + + desc_content = self.get_info(query) + return stem.descriptor.router_status_entry.RouterStatusEntryV2(desc_content) + except Exception, exc: + if default == UNDEFINED: raise exc + else: return default - def get_network_statuses(self): + def get_network_statuses(self, default = UNDEFINED): """ Provides an iterator for all of the router status entries that tor presently knows about. + :param list default: items to provide if the query fails + :returns: iterates over :class:`~stem.descriptor.router_status_entry.RouterStatusEntryV2` for relays in the tor network - :raises: :class:`stem.ControllerError` if unable to query tor + :raises: :class:`stem.ControllerError` if unable to query tor and no + default was provided """ - # TODO: We should iterate over the descriptors as they're read from the - # socket rather than reading the whole thing into memeory. - - desc_content = self.get_info("ns/all") - - desc_iterator = stem.descriptor.router_status_entry.parse_file( - StringIO.StringIO(desc_content), - True, - entry_class = stem.descriptor.router_status_entry.RouterStatusEntryV2, - ) - - for desc in desc_iterator: - yield desc + try: + # TODO: We should iterate over the descriptors as they're read from the + # socket rather than reading the whole thing into memeory. + + desc_content = self.get_info("ns/all") + + desc_iterator = stem.descriptor.router_status_entry.parse_file( + StringIO.StringIO(desc_content), + True, + entry_class = stem.descriptor.router_status_entry.RouterStatusEntryV2, + ) + + for desc in desc_iterator: + yield desc + except Exception, exc: + if default == UNDEFINED: raise exc + else: + if entry is not None: + for entry in default: + yield entry def authenticate(self, *args, **kwargs): """ @@ -979,10 +1032,12 @@ class Controller(BaseController): import stem.connection stem.connection.authenticate(self, *args, **kwargs) - def protocolinfo(self): + def get_protocolinfo(self, default = UNDEFINED): """ A convenience method to get the protocol info of the controller. + :param object default: response if the query fails + :returns: :class:`~stem.response.protocolinfo.ProtocolInfoResponse` provided by tor :raises: @@ -990,10 +1045,17 @@ class Controller(BaseController): malformed * :class:`stem.SocketError` if problems arise in establishing or using the socket + + An exception is only raised if we weren't provided a default response. """ import stem.connection - return stem.connection.get_protocolinfo(self) + + try: + return stem.connection.get_protocolinfo(self) + except Exception, exc: + if default == UNDEFINED: raise exc + else: return default def get_conf(self, param, default = UNDEFINED, multiple = False): """ @@ -1325,48 +1387,55 @@ class Controller(BaseController): else: raise stem.ProtocolError("SAVECONF returned unexpected response code") - def get_socks_listeners(self): + def get_socks_listeners(self, default = UNDEFINED): """ Provides the SOCKS **(address, port)** tuples that tor has open. + :param object default: response if the query fails + :returns: list of **(address, port)** tuples for the available SOCKS listeners :raises: :class:`stem.ControllerError` if unable to determine the listeners + and no default was provided """ - proxy_addrs = [] - try: - for listener in self.get_info("net/listeners/socks").split(): - if not (listener.startswith('"') and listener.endswith('"')): - raise stem.ProtocolError("'GETINFO net/listeners/socks' responses are expected to be quoted: %s" % listener) - elif not ':' in listener: - raise stem.ProtocolError("'GETINFO net/listeners/socks' had a listener without a colon: %s" % listener) - - listener = listener[1:-1] # strip quotes - addr, port = listener.split(':') - proxy_addrs.append((addr, port)) - except stem.InvalidArguments: - # tor version is old (pre-tor-0.2.2.26-beta), use get_conf() instead - socks_port = self.get_conf('SocksPort') + proxy_addrs = [] - for listener in self.get_conf('SocksListenAddress', multiple = True): - if ':' in listener: + try: + for listener in self.get_info("net/listeners/socks").split(): + if not (listener.startswith('"') and listener.endswith('"')): + raise stem.ProtocolError("'GETINFO net/listeners/socks' responses are expected to be quoted: %s" % listener) + elif not ':' in listener: + raise stem.ProtocolError("'GETINFO net/listeners/socks' had a listener without a colon: %s" % listener) + + listener = listener[1:-1] # strip quotes addr, port = listener.split(':') proxy_addrs.append((addr, port)) - else: - proxy_addrs.append((listener, socks_port)) - - # validate that address/ports are valid, and convert ports to ints - - for addr, port in proxy_addrs: - if not stem.util.connection.is_valid_ip_address(addr): - raise stem.ProtocolError("Invalid address for a SOCKS listener: %s" % addr) - elif not stem.util.connection.is_valid_port(port): - raise stem.ProtocolError("Invalid port for a SOCKS listener: %s" % port) - - return [(addr, int(port)) for (addr, port) in proxy_addrs] + except stem.InvalidArguments: + # tor version is old (pre-tor-0.2.2.26-beta), use get_conf() instead + socks_port = self.get_conf('SocksPort') + + for listener in self.get_conf('SocksListenAddress', multiple = True): + if ':' in listener: + addr, port = listener.split(':') + proxy_addrs.append((addr, port)) + else: + proxy_addrs.append((listener, socks_port)) + + # validate that address/ports are valid, and convert ports to ints + + for addr, port in proxy_addrs: + if not stem.util.connection.is_valid_ip_address(addr): + raise stem.ProtocolError("Invalid address for a SOCKS listener: %s" % addr) + elif not stem.util.connection.is_valid_port(port): + raise stem.ProtocolError("Invalid port for a SOCKS listener: %s" % port) + + return [(addr, int(port)) for (addr, port) in proxy_addrs] + except Exception, exc: + if default == UNDEFINED: raise exc + else: return default def is_feature_enabled(self, feature): """ @@ -1391,8 +1460,11 @@ class Controller(BaseController): elif feature == "VERBOSE_NAMES": defaulted_version = stem.version.Requirement.FEATURE_VERBOSE_NAMES - if defaulted_version and self.get_version().meets_requirements(defaulted_version): - self._enabled_features.append(feature) + if defaulted_version: + our_version = self.get_version(None) + + if our_version and our_version.meets_requirements(defaulted_version): + self._enabled_features.append(feature) return feature in self._enabled_features @@ -1480,9 +1552,9 @@ class Controller(BaseController): :returns: str of the circuit id of the newly created circuit """ - return self.extend_circuit(0, path, purpose) + return self.extend_circuit('0', path, purpose) - def extend_circuit(self, circuit = "0", path = None, purpose = "general"): + def extend_circuit(self, circuit_id = "0", path = None, purpose = "general"): """ Either requests the creation of a new circuit or extends an existing one. @@ -1502,7 +1574,7 @@ class Controller(BaseController): 20 EXTENDED $718BCEA286B531757ACAFF93AE04910EA73DE617=KsmoinOK,$649F2D0ACF418F7CFC6539AB2257EB2D5297BAFA=Eskimo BUILD_FLAGS=NEED_CAPACITY PURPOSE=GENERAL TIME_CREATED=2012-12-06T13:51:11.433755 19 BUILT $718BCEA286B531757ACAFF93AE04910EA73DE617=KsmoinOK,$30BAB8EE7606CBD12F3CC269AE976E0153E7A58D=Pascal1,$2765D8A8C4BBA3F89585A9FFE0E8575615880BEB=Anthracite PURPOSE=GENERAL TIME_CREATED=2012-12-06T13:50:56.969938 - :param str circuit: id of a circuit to be extended + :param str circuit_id: id of a circuit to be extended :param list,str path: one or more relays to make a circuit through, this is required if the circuit id is non-zero :param str purpose: "general" or "controller" @@ -1513,15 +1585,15 @@ class Controller(BaseController): """ # we might accidently get integer circuit ids - circuit = str(circuit) + circuit_id = str(circuit_id) - if path is None and circuit == '0': + if path is None and circuit_id == '0': path_opt_version = stem.version.Requirement.EXTENDCIRCUIT_PATH_OPTIONAL if not self.get_version().meets_requirements(path_opt_version): raise stem.InvalidRequest(512, "EXTENDCIRCUIT requires the path prior to version %s" % path_opt_version) - args = [circuit] + args = [circuit_id] if type(path) == str: path = [path] if path: args.append(",".join(path)) if purpose: args.append("purpose=%s" % purpose) @@ -1600,8 +1672,8 @@ class Controller(BaseController): Note: Tor attaches streams to circuits automatically unless the __LeaveStreamsUnattached configuration variable is set to "1" - :param int stream_id: id of the stream that must be attached - :param int circuit_id: id of the circuit to which it must be attached + :param str stream_id: id of the stream that must be attached + :param str circuit_id: id of the circuit to which it must be attached :param int hop: hop in the circuit that must be used as an exit node :raises: @@ -1610,7 +1682,7 @@ class Controller(BaseController): """ hop_str = " HOP=" + str(hop) if hop else "" - response = self.msg("ATTACHSTREAM %i %i%s" % (stream_id, circuit_id, hop_str)) + response = self.msg("ATTACHSTREAM %s %s%s" % (stream_id, circuit_id, hop_str)) stem.response.convert("SINGLELINE", response) if not response.is_ok(): diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 2dac687..40c0f8c 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -253,7 +253,7 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() with runner.get_tor_controller(False) as controller: - protocolinfo = controller.protocolinfo() + protocolinfo = controller.get_protocolinfo() self.assertTrue(isinstance(protocolinfo, stem.response.protocolinfo.ProtocolInfoResponse)) # Doing a sanity test on the ProtocolInfoResponse instance returned.

1 0