- tor-commits - lists.torproject.org

[stem/master] Add a Controller.get_circuits method
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 1b9ffa597408e9b7f0f8863e8c7a2f66d9922e1c Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Wed Dec 5 08:08:18 2012 +0530 Add a Controller.get_circuits method --- stem/control.py | 20 ++++++++++++++++++++ test/integ/control/controller.py | 15 +++++++++++++++ 2 files changed, 35 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index 704bb5e..fe45010 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_circuits - provides a list of active circuits |- 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 @@ -1537,6 +1538,25 @@ class Controller(BaseController): raise stem.ProtocolError("EXTENDCIRCUIT returned unexpected response code: %s" % response.code) return new_circuit + + def get_circuits(self): + """ + Provides the list of circuits Tor is currently handling. + + :returns: **list** of :class:`stem.events.CircuitEvent` objects + + :raises: :class:`stem.ControllerError` if the call fails + """ + + 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 def close_circuit(self, circuit_id, flag = ''): """ diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 86056aa..9b1f1c6 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -722,3 +722,18 @@ class TestController(unittest.TestCase): count += 1 if count > 10: break + def test_get_circuits(self): + """ + Fetches circuits via the get_circuits() method. + """ + + if test.runner.require_control(self): return + if test.runner.require_online(self): return + + runner = test.runner.get_runner() + with runner.get_tor_controller() as controller: + new_circ = controller.new_circuit() + circuits = controller.get_circuits() + self.assertTrue(new_circ in [int(circ.id) for circ in circuits]) + +

1 0

[stem/master] Implement Controller.attach_stream
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit 32a54a71f8391b5300e6cae5a3f558f190160995 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Tue Jul 3 10:35:52 2012 +0530 Implement Controller.attach_stream --- stem/control.py | 38 ++++++++++++++++++++++++++++++++++---- test/integ/control/controller.py | 34 ++++++++++++++++++++++++++++++++-- test/util.py | 23 +++++++++++++++++------ 3 files changed, 83 insertions(+), 12 deletions(-) diff --git a/stem/control.py b/stem/control.py index fe45010..4cb55e0 100644 --- a/stem/control.py +++ b/stem/control.py @@ -37,6 +37,7 @@ providing its own for interacting at a higher level. |- 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_circuits - provides a list of active circuits + |- 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 @@ -129,6 +130,7 @@ import stem.util.enum import stem.version from stem.util import log +import stem.util.tor_tools # state changes a control socket can have @@ -1538,16 +1540,16 @@ class Controller(BaseController): raise stem.ProtocolError("EXTENDCIRCUIT returned unexpected response code: %s" % response.code) return new_circuit - + def get_circuits(self): """ Provides the list of circuits Tor is currently handling. - + :returns: **list** of :class:`stem.events.CircuitEvent` objects :raises: :class:`stem.ControllerError` if the call fails """ - + circuits = [] response = self.get_info("circuit-status") @@ -1555,9 +1557,37 @@ class Controller(BaseController): 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 + def attach_stream(self, stream, circuit, hop = None): + """ + Attaches a stream to a circuit. + + Note: Tor attaches streams to circuits automatically unless the + __LeaveStreamsUnattached configuration variable is set to "1" + + :param int stream: id of the stream that must be attached + :param int circuit: 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: + * :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 %i %i%s" % (stream, circuit, hop_str)) + stem.response.convert("SINGLELINE", response) + + if not response.is_ok(): + if response.code == '552': + raise stem.InvalidRequest(response.code, response.message) + elif response.code == '551': + raise stem.OperationFailed(response.code, response.message) + else: + raise stem.ProtocolError("ATTACHSTREAM returned unexpected response code: %s" % response.code) + def close_circuit(self, circuit_id, flag = ''): """ Closes the specified circuit. diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 9b1f1c6..bced64a 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -13,6 +13,8 @@ import threading import time import unittest +from Queue import Queue + import stem.connection import stem.control import stem.descriptor.reader @@ -721,7 +723,36 @@ class TestController(unittest.TestCase): count += 1 if count > 10: break - + + def test_attachstream(self): + + if test.runner.require_control(self): return + elif test.runner.require_online(self): return + + runner = test.runner.get_runner() + + 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] + + def handle_streamcreated(stream): + if stream.status == "NEW": + controller.attach_stream(int(stream.id), int(circuit_id)) + + 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] + self.assertTrue(exit_circuit) + exit_ip = controller.get_network_status(exit_circuit[0].path[2][0]).address + + self.assertEquals(exit_ip, ip) + + controller.remove_event_listener(handle_streamcreated) + controller.reset_conf("__LeaveStreamsUnattached") + def test_get_circuits(self): """ Fetches circuits via the get_circuits() method. @@ -735,5 +766,4 @@ class TestController(unittest.TestCase): new_circ = controller.new_circuit() circuits = controller.get_circuits() self.assertTrue(new_circ in [int(circ.id) for circ in circuits]) - diff --git a/test/util.py b/test/util.py index 74b494d..b89e48f 100644 --- a/test/util.py +++ b/test/util.py @@ -18,26 +18,37 @@ Accept-Encoding: identity """ -def external_ip(sock): +def external_ip(host, port): """ Returns the externally visible IP address when using a SOCKS4a proxy. Negotiates the socks connection, connects to ipconfig.me and requests http://ifconfig.me/ip to find out the externally visible IP. - :param socket sock: socket connected to a SOCKS4a proxy server + Supports only SOCKS4a proxies. + + :param str host: hostname/IP of the proxy server + :param int port: port on which the proxy server is listening :returns: externally visible IP address, or None if it isn't able to + + :raises: :class:`stem.socket.SocketError`: unable to connect a socket to the socks server """ try: + sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + sock.connect((host, int(port))) + except Exception, exc: + raise SocketError("Failed to connect to the socks server: " + str(exc)) + + try: negotiate_socks(sock, "ifconfig.me", 80) - s.sendall(req) - response = s.recv(1000) + sock.sendall(ip_request) + response = sock.recv(1000) # everything after the blank line is the 'data' in a HTTP response # The response data for our request for request should be an IP address + '\n' return response[response.find("\r\n\r\n"):].strip() - except: + except Exception, exc: return None def negotiate_socks(sock, host, port): @@ -46,7 +57,7 @@ def negotiate_socks(sock, host, port): failure. :param socket sock: socket connected to socks4a server - :param str host: host to connect to + :param str host: hostname/IP to connect to :param int port: port to connect to :raises: :class:`stem.ProtocolError` if the socks server doesn't grant our request

1 0

[stem/master] Variable naming consistency
by atagar＠torproject.org 31 Dec '12

31 Dec '12

commit e0929d2cde0b57232dea966192dd4fe954667d93 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Mon Dec 17 08:09:18 2012 +0530 Variable naming consistency --- stem/control.py | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/stem/control.py b/stem/control.py index 4cb55e0..3c5f8bf 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1560,15 +1560,15 @@ class Controller(BaseController): return circuits - def attach_stream(self, stream, circuit, hop = None): + def attach_stream(self, stream_id, circuit_id, hop = None): """ Attaches a stream to a circuit. Note: Tor attaches streams to circuits automatically unless the __LeaveStreamsUnattached configuration variable is set to "1" - :param int stream: id of the stream that must be attached - :param int circuit: id of the circuit to which it must be attached + :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 int hop: hop in the circuit that must be used as an exit node :raises: @@ -1577,7 +1577,7 @@ class Controller(BaseController): """ hop_str = " HOP=" + str(hop) if hop else "" - response = self.msg("ATTACHSTREAM %i %i%s" % (stream, circuit, hop_str)) + response = self.msg("ATTACHSTREAM %i %i%s" % (stream_id, circuit_id, hop_str)) stem.response.convert("SINGLELINE", response) if not response.is_ok():

1 0

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

31 Dec '12

commit 631b210c59fcbeadd3e75a1b1ac9e9f9a635d142 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Dec 22 14:33:26 2012 +0530 Fix test_get_circuits to work with string ids --- test/integ/control/controller.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index bced64a..32cc3a2 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -765,5 +765,5 @@ class TestController(unittest.TestCase): with runner.get_tor_controller() as controller: new_circ = controller.new_circuit() circuits = controller.get_circuits() - self.assertTrue(new_circ in [int(circ.id) for circ in circuits]) + self.assertTrue(new_circ in [circ.id for circ in circuits])

1 0

[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