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

[stem/master] InvalidRequest now inherits from ControllerError
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 0db367a151dc75fde8a3a90fd273bda7ad9227ab Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Jun 9 09:49:07 2012 +0530 InvalidRequest now inherits from ControllerError Moved stem.response.InvalidRequest -> stem.socket.InvalidRequest and made it a subclass of stem.socket.ControllerError --- stem/response/__init__.py | 7 +------ stem/response/getconf.py | 2 +- stem/socket.py | 4 ++++ test/unit/response/getconf.py | 2 +- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/stem/response/__init__.py b/stem/response/__init__.py index ae3af4c..a9b69a3 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -60,7 +60,7 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type - * :class:`stem.response.InvalidRequest` the request was invalid + * :class:`stem.socket.InvalidRequest` the request was invalid * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ @@ -413,8 +413,3 @@ def _get_quote_indeces(line, escaped): return tuple(indices) -class InvalidRequest(Exception): - """ - Base Exception class for invalid requests - """ - pass diff --git a/stem/response/getconf.py b/stem/response/getconf.py index 8dcd483..c1872cd 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -33,7 +33,7 @@ class GetConfResponse(stem.response.ControlMessage): pass if unrecognized_keywords: - raise stem.response.InvalidRequest("GETCONF request contained unrecognized keywords: %s\n" \ + raise stem.socket.InvalidRequest("GETCONF request contained unrecognized keywords: %s\n" \ % ', '.join(unrecognized_keywords)) else: raise stem.socket.ProtocolError("GETCONF response contained a non-OK status code:\n%s" % self) diff --git a/stem/socket.py b/stem/socket.py index 1a14c82..258a7dc 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -28,6 +28,7 @@ as instances of the :class:`stem.response.ControlMessage` class. ControllerError - Base exception raised when using the controller. |- ProtocolError - Malformed socket data. + |- InvalidRequest - Invalid request parameters. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. """ @@ -548,6 +549,9 @@ class ControllerError(Exception): class ProtocolError(ControllerError): "Malformed content from the control socket." +class InvalidRequest(ControllerError): + "Base Exception class for invalid requests" + class SocketError(ControllerError): "Error arose while communicating with the control socket." diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py index ca75130..5dd8964 100644 --- a/test/unit/response/getconf.py +++ b/test/unit/response/getconf.py @@ -73,7 +73,7 @@ class TestGetConfResponse(unittest.TestCase): """ control_message = mocking.get_message(UNRECOGNIZED_KEY_RESPONSE) - self.assertRaises(stem.response.InvalidRequest, stem.response.convert, "GETCONF", control_message) + self.assertRaises(stem.socket.InvalidRequest, stem.response.convert, "GETCONF", control_message) def test_invalid_multiline_content(self): """

1 0

[stem/master] Add integration tests for testing Controller.get_conf
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 16d392ac74996ae38a8f3a33191ebc1899a5cf8f Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Jun 9 09:56:17 2012 +0530 Add integration tests for testing Controller.get_conf --- test/integ/control/controller.py | 38 ++++++++++++++++++++++++++++++++++++++ 1 files changed, 38 insertions(+), 0 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 5c10b3d..479c75b 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -134,4 +134,42 @@ class TestController(unittest.TestCase): auth_methods.append(stem.response.protocolinfo.AuthMethod.NONE) self.assertEqual(tuple(auth_methods), protocolinfo.auth_methods) + + def test_getconf(self): + """ + Exercises GETCONF with valid and invalid queries. + """ + + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + # successful single query + + control_port = str(runner.get_tor_socket().get_port()) + torrc_path = runner.get_torrc_path() + self.assertEqual(control_port, controller.get_conf("ControlPort")) + self.assertEqual(control_port, controller.get_conf("ControlPort", "la-di-dah")) + + # succeessful batch query + + expected = {"ControlPort": control_port} + self.assertEqual(expected, controller.get_conf(["ControlPort"])) + self.assertEqual(expected, controller.get_conf(["ControlPort"], "la-di-dah")) + + getconf_params = set(["ControlPort", "DirPort", "DataDirectory"]) + self.assertEqual(getconf_params, set(controller.get_conf(["ControlPort", + "DirPort", "DataDirectory"]))) + + # non-existant option + + self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "blarg") + self.assertEqual("la-di-dah", controller.get_conf("blarg", "la-di-dah")) + + # empty input + + self.assertRaises(stem.socket.ControllerError, controller.get_conf, "") + self.assertEqual("la-di-dah", controller.get_conf("", "la-di-dah")) + + self.assertEqual({}, controller.get_conf([])) + self.assertEqual({}, controller.get_conf([], {}))

1 0

[stem/master] Add get_conf convenience method to Controller
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit f01a50e5bd1b24cb30676d869057fea3c8e04af9 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sat Jun 9 09:55:01 2012 +0530 Add get_conf convenience method to Controller --- stem/control.py | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 50 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index 9c5c515..c6bf29d 100644 --- a/stem/control.py +++ b/stem/control.py @@ -531,3 +531,53 @@ class Controller(BaseController): return stem.connection.get_protocolinfo(self) + def get_conf(self, param, default = None): + """ + Queries the control socket for the values of given configuration options. If + provided a default then that's returned as the if the GETCONF option is undefined + or if the call fails for any reason (invalid configuration option, error + response, control port closed, initiated, etc). + + :param str,list param: GETCONF option or options to be queried + :param object default: response if the query fails + + :returns: + Response depends upon how we were called as follows... + + * str with the response if our param was a str + * dict with the param => response mapping if our param was a list + * 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.InvalidRequest` if configuration option requested was invalid. + """ + + if isinstance(param, str): + is_multiple = False + param = [param] + else: + is_multiple = True + + try: + response = self.msg("GETCONF %s" % " ".join(param)) + stem.response.convert("GETCONF", response) + + # error if we got back different parameters than we requested + requested_params = set(param) + reply_params = set(response.entries.keys()) + + if requested_params != reply_params: + requested_label = ", ".join(requested_params) + reply_label = ", ".join(reply_params) + + raise stem.socket.ProtocolError("GETCONF reply doesn't match the parameters that we requested. Queried '%s' but got '%s'." % (requested_label, reply_label)) + + if is_multiple: + return response.entries + else: + return response.entries[param[0]] + except stem.socket.ControllerError, exc: + if default is None: raise exc + else: return default +

1 0

[stem/master] Minor change to GetConfResponse documentation
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit ece7f85dd675633de3b866c868bba1560fd22060 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Tue Jun 12 21:07:13 2012 +0530 Minor change to GetConfResponse documentation --- stem/control.py | 2 +- stem/response/__init__.py | 2 +- stem/response/getconf.py | 28 ++++++++++------------------ 3 files changed, 12 insertions(+), 20 deletions(-) diff --git a/stem/control.py b/stem/control.py index f0459cb..a616b5c 100644 --- a/stem/control.py +++ b/stem/control.py @@ -534,7 +534,7 @@ class Controller(BaseController): def get_conf(self, param, default = None): """ Queries the control socket for the values of given configuration options. If - provided a default then that's returned as the if the GETCONF option is undefined + provided a default then that's returned as if the GETCONF option is undefined or if the call fails for any reason (invalid configuration option, error response, control port closed, initiated, etc). diff --git a/stem/response/__init__.py b/stem/response/__init__.py index 43ecb3b..273bead 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -60,7 +60,7 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type - * :class:`stem.socket.InvalidArguments` the request's arguments are invalid + * :class:`stem.socket.InvalidArguments` Raised if the request's arguments when converting GETCONF or GETINFO responses are invalid * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ diff --git a/stem/response/getconf.py b/stem/response/getconf.py index cffbc61..41f1857 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -1,29 +1,21 @@ import stem.socket import stem.response -def _getval(dictionary, key): - try: - return dictionary[key] - except KeyError: - pass - def _split_line(line): - try: - if '=' in line: - if line[line.find("=") + 1] == "\"": - return line.pop_mapping(True) - else: - return line.split("=", 1) - else: - return (line, None) - except IndexError: - return (line[:-1], None) + if line.is_next_mapping(quoted = False): + return line.split("=", 1) # TODO: make this part of the ControlLine? + elif line.is_next_mapping(quoted = True): + return line.pop_mapping(True).items()[0] + else: + return (line.pop(), None) class GetConfResponse(stem.response.ControlMessage): """ Reply for a GETCONF query. - :var dict entries: mapping between the queried options and their values + :var dict entries: + mapping between the queried options (string) and their values (string/list + of strings) """ def _parse_message(self): @@ -54,7 +46,7 @@ class GetConfResponse(stem.response.ControlMessage): line = remaining_lines.pop(0) key, value = _split_line(line) - entry = _getval(self.entries, key) + entry = self.entries.get(key, None) if type(entry) == str and entry != value: self.entries[key] = [entry]

1 0

[stem/master] Multiple fixes to GETCONF parsing
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 3b25147b7fcaadbc7e2aec6ec89158ed1d738687 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Tue Jun 12 19:59:30 2012 +0530 Multiple fixes to GETCONF parsing * Add stem.socket.InvalidArguments and make the GETCONF parser raise it instead of stem.socket.InvalidRequest. * Fix the parser to parser to correctly parse multivalue configuration keys (such as ExitPolicy). Add tests for the same. * Fix tests to run against a Tor client using a control socket file. * Minor changes to documentation. --- stem/control.py | 2 +- stem/response/__init__.py | 2 +- stem/response/getconf.py | 49 ++++++++++++++++++++++++-------------- stem/socket.py | 21 +++++++++++++++- test/integ/control/controller.py | 20 ++++++++++----- test/unit/response/getconf.py | 33 ++++++++++++++++++++++++- 6 files changed, 97 insertions(+), 30 deletions(-) diff --git a/stem/control.py b/stem/control.py index c6bf29d..f0459cb 100644 --- a/stem/control.py +++ b/stem/control.py @@ -550,7 +550,7 @@ class Controller(BaseController): :raises: :class:`stem.socket.ControllerError` if the call fails, and we weren't provided a default response - :class:`stem.socket.InvalidRequest` if configuration option requested was invalid. + :class:`stem.socket.InvalidArguments` if configuration options requested was invalid """ if isinstance(param, str): diff --git a/stem/response/__init__.py b/stem/response/__init__.py index a9b69a3..43ecb3b 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -60,7 +60,7 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type - * :class:`stem.socket.InvalidRequest` the request was invalid + * :class:`stem.socket.InvalidArguments` the request's arguments are invalid * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ diff --git a/stem/response/getconf.py b/stem/response/getconf.py index c1872cd..cffbc61 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -1,8 +1,24 @@ -import re - import stem.socket import stem.response +def _getval(dictionary, key): + try: + return dictionary[key] + except KeyError: + pass + +def _split_line(line): + try: + if '=' in line: + if line[line.find("=") + 1] == "\"": + return line.pop_mapping(True) + else: + return line.split("=", 1) + else: + return (line, None) + except IndexError: + return (line[:-1], None) + class GetConfResponse(stem.response.ControlMessage): """ Reply for a GETCONF query. @@ -25,29 +41,26 @@ class GetConfResponse(stem.response.ControlMessage): if not self.is_ok(): unrecognized_keywords = [] for code, _, line in self.content(): - if code == '552': - try: - # to parse: 552 Unrecognized configuration key "zinc" - unrecognized_keywords.append(re.search('"([^"]+)"', line).groups()[0]) - except: - pass + if code == '552' and line.startswith("Unrecognized configuration key \"") and line.endswith("\""): + unrecognized_keywords.append(line[32:-1]) if unrecognized_keywords: - raise stem.socket.InvalidRequest("GETCONF request contained unrecognized keywords: %s\n" \ - % ', '.join(unrecognized_keywords)) + raise stem.socket.InvalidArguments("GETCONF request contained unrecognized keywords: %s\n" \ + % ', '.join(unrecognized_keywords), unrecognized_keywords) else: raise stem.socket.ProtocolError("GETCONF response contained a non-OK status code:\n%s" % self) while remaining_lines: line = remaining_lines.pop(0) - if '=' in line: - if line[line.find("=") + 1] == "\"": - key, value = line.pop_mapping(True) - else: - key, value = line.split("=", 1) + key, value = _split_line(line) + entry = _getval(self.entries, key) + + if type(entry) == str and entry != value: + self.entries[key] = [entry] + self.entries[key].append(value) + elif type(entry) == list and not value in entry: + self.entries[key].append(value) else: - key, value = (line, None) - - self.entries[key] = value + self.entries[key] = value diff --git a/stem/socket.py b/stem/socket.py index 258a7dc..b933f50 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -28,7 +28,8 @@ as instances of the :class:`stem.response.ControlMessage` class. ControllerError - Base exception raised when using the controller. |- ProtocolError - Malformed socket data. - |- InvalidRequest - Invalid request parameters. + |- InvalidRequest - Invalid request. + +- InvalidArguments - Invalid request parameters. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. """ @@ -552,6 +553,24 @@ class ProtocolError(ControllerError): class InvalidRequest(ControllerError): "Base Exception class for invalid requests" +class InvalidArguments(InvalidRequest): + """ + Exception class for invalid requests which contain invalid arguments. + + :var list arguments: a list of parameters which were invalid + """ + + def __init__(self, message, arguments): + """ + Initializes an InvalidArguments object. + + :param str message: error message + :param list arguments: a list of parameters which were invalid + + :returns: object of InvalidArguments class + """ + self.arguments = arguments + class SocketError(ControllerError): "Error arose while communicating with the control socket." diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 479c75b..2441eac 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -145,16 +145,22 @@ class TestController(unittest.TestCase): with runner.get_tor_controller() as controller: # successful single query - control_port = str(runner.get_tor_socket().get_port()) - torrc_path = runner.get_torrc_path() - self.assertEqual(control_port, controller.get_conf("ControlPort")) - self.assertEqual(control_port, controller.get_conf("ControlPort", "la-di-dah")) + socket = runner.get_tor_socket() + if isinstance(socket, stem.socket.ControlPort): + socket = str(socket.get_port()) + config_key = "ControlPort" + elif isinstance(socket, stem.socket.ControlSocketFile): + socket = str(socket.get_socket_path()) + config_key = "ControlSocket" + + self.assertEqual(socket, controller.get_conf(config_key)) + self.assertEqual(socket, controller.get_conf(config_key, "la-di-dah")) # succeessful batch query - expected = {"ControlPort": control_port} - self.assertEqual(expected, controller.get_conf(["ControlPort"])) - self.assertEqual(expected, controller.get_conf(["ControlPort"], "la-di-dah")) + expected = {config_key: socket} + self.assertEqual(expected, controller.get_conf([config_key])) + self.assertEqual(expected, controller.get_conf([config_key], "la-di-dah")) getconf_params = set(["ControlPort", "DirPort", "DataDirectory"]) self.assertEqual(getconf_params, set(controller.get_conf(["ControlPort", diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py index 5dd8964..a9f1cc8 100644 --- a/test/unit/response/getconf.py +++ b/test/unit/response/getconf.py @@ -20,6 +20,15 @@ BATCH_RESPONSE = """\ 250-DataDirectory=/tmp/fake dir 250 DirPort""" +MULTIVALUE_RESPONSE = """\ +250-ControlPort=9100 +250-ExitPolicy=accept 34.3.4.5 +250-ExitPolicy=accept 3.4.53.3 +250-ExitPolicy=reject 23.245.54.3 +250-ExitPolicy=accept 34.3.4.5 +250-ExitPolicy=accept 3.4.53.3 +250 ExitPolicy=reject 23.245.54.3""" + UNRECOGNIZED_KEY_RESPONSE = "552 Unrecognized configuration key \"yellowbrickroad\"" INVALID_RESPONSE = """\ @@ -67,15 +76,35 @@ class TestGetConfResponse(unittest.TestCase): self.assertEqual(expected, control_message.entries) + def test_multivalue_response(self): + """ + Parses a GETCONF reply containing a single key with multiple parameters. + """ + + control_message = mocking.get_message(MULTIVALUE_RESPONSE) + stem.response.convert("GETCONF", control_message) + + expected = { + "ControlPort": "9100", + "ExitPolicy": ["accept 34.3.4.5", "accept 3.4.53.3", "reject 23.245.54.3"] + } + + self.assertEqual(expected, control_message.entries) + def test_unrecognized_key_response(self): """ Parses a GETCONF reply that contains an error code with an unrecognized key. """ control_message = mocking.get_message(UNRECOGNIZED_KEY_RESPONSE) - self.assertRaises(stem.socket.InvalidRequest, stem.response.convert, "GETCONF", control_message) + self.assertRaises(stem.socket.InvalidArguments, stem.response.convert, "GETCONF", control_message) + + try: + stem.response.convert("GETCONF", control_message) + except stem.socket.InvalidArguments, exc: + self.assertEqual(exc.arguments, ["yellowbrickroad"]) - def test_invalid_multiline_content(self): + def test_invalid_content(self): """ Parses a malformed GETCONF reply that contains an invalid response code. This is a proper controller message, but malformed according to the

1 0

[stem/master] Make the GETINFO parser raise InvalidArguments instead of ProtocolError when appropriate
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 42ae08cfdda0ea2f90bccb2b3621b182ddf99e0a Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Wed Jun 13 07:38:13 2012 +0530 Make the GETINFO parser raise InvalidArguments instead of ProtocolError when appropriate --- stem/response/getinfo.py | 11 ++++++++++- test/unit/response/getinfo.py | 17 +++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletions(-) diff --git a/stem/response/getinfo.py b/stem/response/getinfo.py index 9b1fe75..3fac253 100644 --- a/stem/response/getinfo.py +++ b/stem/response/getinfo.py @@ -25,7 +25,16 @@ class GetInfoResponse(stem.response.ControlMessage): remaining_lines = list(self) if not self.is_ok() or not remaining_lines.pop() == "OK": - raise stem.socket.ProtocolError("GETINFO response didn't have an OK status:\n%s" % self) + unrecognized_keywords = [] + for code, _, line in self.content(): + if code == '552' and line.startswith("Unrecognized key \"") and line.endswith("\""): + unrecognized_keywords.append(line[18:-1]) + + if unrecognized_keywords: + raise stem.socket.InvalidArguments("GETCONF request contained unrecognized keywords: %s\n" \ + % ', '.join(unrecognized_keywords), unrecognized_keywords) + else: + raise stem.socket.ProtocolError("GETINFO response didn't have an OK status:\n%s" % self) while remaining_lines: try: diff --git a/test/unit/response/getinfo.py b/test/unit/response/getinfo.py index 5e82404..6d21faf 100644 --- a/test/unit/response/getinfo.py +++ b/test/unit/response/getinfo.py @@ -38,6 +38,10 @@ NON_KEY_VALUE_ENTRY = """\ 250-address 67.137.76.214 250 OK""" +UNRECOGNIZED_KEY_ENTRY = """\ +552 Unrecognized key "blackhole" +""" + MISSING_MULTILINE_NEWLINE = """\ 250+config-text=ControlPort 9051 DataDirectory /home/atagar/.tor @@ -109,6 +113,19 @@ class TestGetInfoResponse(unittest.TestCase): control_message = mocking.get_message(NON_KEY_VALUE_ENTRY) self.assertRaises(stem.socket.ProtocolError, stem.response.convert, "GETINFO", control_message) + def test_unrecognized_key_response(self): + """ + Parses a GETCONF reply that contains an error code with an unrecognized key. + """ + + control_message = mocking.get_message(UNRECOGNIZED_KEY_ENTRY) + self.assertRaises(stem.socket.InvalidArguments, stem.response.convert, "GETINFO", control_message) + + try: + stem.response.convert("GETINFO", control_message) + except stem.socket.InvalidArguments, exc: + self.assertEqual(exc.arguments, ["blackhole"]) + def test_invalid_multiline_content(self): """ Parses a malformed GETINFO reply with a multi-line entry missing a newline

1 0

[stem/master] Various modifications to GETCONF parsing
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit b8959dfe154180018071a07d7ad8eceb68a4c516 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sun Jun 17 18:05:54 2012 +0530 Various modifications to GETCONF parsing * Change the way entries are stored. Now only stores one value unless the caller explicitly mentions that he want to retrieve multiple values using the 'multiple' argument. * Stop checking if the received configuration options are the ones that were requested. (The HiddenService options do this) * Minor documentation fixes. --- stem/control.py | 35 +++++++++++++++------------------ stem/response/__init__.py | 5 ++- stem/response/getconf.py | 40 +++++++++++++++++++------------------- stem/response/getinfo.py | 2 +- stem/socket.py | 16 +++++++------- test/integ/control/controller.py | 12 +++++----- test/unit/response/getconf.py | 15 ++++++------- 7 files changed, 61 insertions(+), 64 deletions(-) diff --git a/stem/control.py b/stem/control.py index a616b5c..d14d723 100644 --- a/stem/control.py +++ b/stem/control.py @@ -453,7 +453,9 @@ class Controller(BaseController): * dict with the param => response mapping if our param was a list * 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 + :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 """ # TODO: add caching? @@ -530,8 +532,8 @@ class Controller(BaseController): """ return stem.connection.get_protocolinfo(self) - - def get_conf(self, param, default = None): + + def get_conf(self, param, default = UNDEFINED, multiple = False): """ Queries the control socket for the values of given configuration options. If provided a default then that's returned as if the GETCONF option is undefined @@ -540,17 +542,21 @@ class Controller(BaseController): :param str,list param: GETCONF option or options to be queried :param object default: response if the query fails + :param bool multiple: if True, the value(s) provided are lists of all returned values, + otherwise this just provides the first value :returns: Response depends upon how we were called as follows... - * str with the response if our param was a str - * dict with the param => response mapping if our param was a list + * str with the response if our param was a str and multiple was False + * dict with the param (str) => response (str) mapping if our param was a list and multiple was False + * list with the response strings if our param was a str and multiple was True + * dict with the param (str) => response (list) mapping if our param was a list and multiple was True * 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 configuration options requested was invalid + :class:`stem.socket.InvalidArguments` if the configuration options requested were invalid """ if isinstance(param, str): @@ -561,23 +567,14 @@ class Controller(BaseController): try: response = self.msg("GETCONF %s" % " ".join(param)) - stem.response.convert("GETCONF", response) - - # error if we got back different parameters than we requested - requested_params = set(param) - reply_params = set(response.entries.keys()) - - if requested_params != reply_params: - requested_label = ", ".join(requested_params) - reply_label = ", ".join(reply_params) - - raise stem.socket.ProtocolError("GETCONF reply doesn't match the parameters that we requested. Queried '%s' but got '%s'." % (requested_label, reply_label)) + stem.response.convert("GETCONF", response, multiple = multiple) if is_multiple: return response.entries else: - return response.entries[param[0]] + try: return response.entries[param[0]] + except KeyError: raise stem.socket.InvalidRequest("Received empty string") except stem.socket.ControllerError, exc: - if default is None: raise exc + if default is UNDEFINED: raise exc else: return default diff --git a/stem/response/__init__.py b/stem/response/__init__.py index 13c65b3..590e4c2 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -42,7 +42,7 @@ KEY_ARG = re.compile("^(\S+)=") CONTROL_ESCAPES = {r"\\": "\\", r"\"": "\"", r"\'": "'", r"\r": "\r", r"\n": "\n", r"\t": "\t"} -def convert(response_type, message): +def convert(response_type, message, **kwargs): """ Converts a ControlMessage into a particular kind of tor response. This does an in-place conversion of the message from being a ControlMessage to a @@ -57,6 +57,7 @@ def convert(response_type, message): :param str response_type: type of tor response to convert to :param stem.response.ControlMessage message: message to be converted + :param kwargs: optional keyword arguments to be passed to the parser method :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type @@ -84,7 +85,7 @@ def convert(response_type, message): else: raise TypeError("Unsupported response type: %s" % response_type) message.__class__ = response_class - message._parse_message() + message._parse_message(**kwargs) class ControlMessage: """ diff --git a/stem/response/getconf.py b/stem/response/getconf.py index fd2256c..9ab15c7 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -1,14 +1,6 @@ import stem.socket import stem.response -def _split_line(line): - if line.is_next_mapping(quoted = False): - return line.split("=", 1) # TODO: make this part of the ControlLine? - elif line.is_next_mapping(quoted = True): - return line.pop_mapping(True).items()[0] - else: - return (line.pop(), None) - class GetConfResponse(stem.response.ControlMessage): """ Reply for a GETCONF query. @@ -18,7 +10,12 @@ class GetConfResponse(stem.response.ControlMessage): of strings) """ - def _parse_message(self): + def _parse_message(self, multiple = False): + """ + :param bool multiple: + if True stores each value in a list, otherwise stores only the first + values as a sting + """ # Example: # 250-CookieAuthentication=0 # 250-ControlPort=9100 @@ -27,7 +24,7 @@ class GetConfResponse(stem.response.ControlMessage): self.entries = {} remaining_lines = list(self) - + if self.content() == [("250", " ", "OK")]: return if not self.is_ok(): @@ -35,7 +32,7 @@ class GetConfResponse(stem.response.ControlMessage): for code, _, line in self.content(): if code == "552" and line.startswith("Unrecognized configuration key \"") and line.endswith("\""): unrecognized_keywords.append(line[32:-1]) - + if unrecognized_keywords: raise stem.socket.InvalidArguments("552", "GETCONF request contained unrecognized keywords: %s\n" \ % ', '.join(unrecognized_keywords), unrecognized_keywords) @@ -44,15 +41,18 @@ class GetConfResponse(stem.response.ControlMessage): while remaining_lines: line = remaining_lines.pop(0) - - key, value = _split_line(line) + + if line.is_next_mapping(quoted = False): + key, value = line.split("=", 1) # TODO: make this part of the ControlLine? + elif line.is_next_mapping(quoted = True): + key, value = line.pop_mapping(True).items()[0] + else: + key, value = (line.pop(), None) + entry = self.entries.get(key, None) - - if type(entry) == str and entry != value: - self.entries[key] = [entry] - self.entries[key].append(value) - elif type(entry) == list and not value in entry: - self.entries[key].append(value) + + if multiple: + self.entries.setdefault(key, []).append(value) else: - self.entries[key] = value + self.entries.setdefault(key, value) diff --git a/stem/response/getinfo.py b/stem/response/getinfo.py index f467769..a2cce57 100644 --- a/stem/response/getinfo.py +++ b/stem/response/getinfo.py @@ -29,7 +29,7 @@ class GetInfoResponse(stem.response.ControlMessage): for code, _, line in self.content(): if code == '552' and line.startswith("Unrecognized key \"") and line.endswith("\""): unrecognized_keywords.append(line[18:-1]) - + if unrecognized_keywords: raise stem.socket.InvalidArguments("552", "GETINFO request contained unrecognized keywords: %s\n" \ % ', '.join(unrecognized_keywords), unrecognized_keywords) diff --git a/stem/socket.py b/stem/socket.py index 9e1f5b7..6972929 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -29,7 +29,7 @@ as instances of the :class:`stem.response.ControlMessage` class. ControllerError - Base exception raised when using the controller. |- ProtocolError - Malformed socket data. |- InvalidRequest - Invalid request. - +- InvalidArguments - Invalid request parameters. + | +- InvalidArguments - Invalid request parameters. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. """ @@ -553,7 +553,7 @@ class ProtocolError(ControllerError): class InvalidRequest(ControllerError): """ Base Exception class for invalid requests - + :var str code: The error code returned by Tor (if applicable) :var str message: The error message returned by Tor (if applicable) or a human readable error message @@ -562,11 +562,11 @@ class InvalidRequest(ControllerError): def __init__(self, code = None, message = None): """ Initializes an InvalidRequest object. - + :param str code: The error code returned by Tor (if applicable) :param str message: The error message returned by Tor (if applicable) or a human readable error message - + :returns: object of InvalidRequest class """ @@ -576,22 +576,22 @@ class InvalidRequest(ControllerError): class InvalidArguments(InvalidRequest): """ Exception class for invalid requests which contain invalid arguments. - + :var str code: The error code returned by Tor (if applicable) :var str message: The error message returned by Tor (if applicable) or a human readable error message :var list arguments: a list of arguments which were invalid """ - + def __init__(self, code = None, message = None, arguments = None): """ Initializes an InvalidArguments object. - + :param str code: The error code returned by Tor (if applicable) :param str message: The error message returned by Tor (if applicable) or a human readable error message :param list arguments: a list of arguments which were invalid - + :returns: object of InvalidArguments class """ diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 2441eac..db7941c 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -147,18 +147,18 @@ class TestController(unittest.TestCase): socket = runner.get_tor_socket() if isinstance(socket, stem.socket.ControlPort): - socket = str(socket.get_port()) + connection_value = str(socket.get_port()) config_key = "ControlPort" elif isinstance(socket, stem.socket.ControlSocketFile): - socket = str(socket.get_socket_path()) + connection_value = str(socket.get_socket_path()) config_key = "ControlSocket" - self.assertEqual(socket, controller.get_conf(config_key)) - self.assertEqual(socket, controller.get_conf(config_key, "la-di-dah")) + self.assertEqual(connection_value, controller.get_conf(config_key)) + self.assertEqual(connection_value, controller.get_conf(config_key, "la-di-dah")) # succeessful batch query - expected = {config_key: socket} + expected = {config_key: connection_value} self.assertEqual(expected, controller.get_conf([config_key])) self.assertEqual(expected, controller.get_conf([config_key], "la-di-dah")) @@ -173,7 +173,7 @@ class TestController(unittest.TestCase): # empty input - self.assertRaises(stem.socket.ControllerError, controller.get_conf, "") + self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "") self.assertEqual("la-di-dah", controller.get_conf("", "la-di-dah")) self.assertEqual({}, controller.get_conf([])) diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py index a9f1cc8..e0020fb 100644 --- a/test/unit/response/getconf.py +++ b/test/unit/response/getconf.py @@ -24,12 +24,11 @@ MULTIVALUE_RESPONSE = """\ 250-ControlPort=9100 250-ExitPolicy=accept 34.3.4.5 250-ExitPolicy=accept 3.4.53.3 -250-ExitPolicy=reject 23.245.54.3 -250-ExitPolicy=accept 34.3.4.5 250-ExitPolicy=accept 3.4.53.3 250 ExitPolicy=reject 23.245.54.3""" -UNRECOGNIZED_KEY_RESPONSE = "552 Unrecognized configuration key \"yellowbrickroad\"" +UNRECOGNIZED_KEY_RESPONSE = '''552-Unrecognized configuration key "brickroad" +552 Unrecognized configuration key "submarine"''' INVALID_RESPONSE = """\ 123-FOO @@ -82,11 +81,11 @@ class TestGetConfResponse(unittest.TestCase): """ control_message = mocking.get_message(MULTIVALUE_RESPONSE) - stem.response.convert("GETCONF", control_message) + stem.response.convert("GETCONF", control_message, multiple = True) expected = { - "ControlPort": "9100", - "ExitPolicy": ["accept 34.3.4.5", "accept 3.4.53.3", "reject 23.245.54.3"] + "ControlPort": ["9100"], + "ExitPolicy": ["accept 34.3.4.5", "accept 3.4.53.3", "accept 3.4.53.3", "reject 23.245.54.3"] } self.assertEqual(expected, control_message.entries) @@ -100,9 +99,9 @@ class TestGetConfResponse(unittest.TestCase): self.assertRaises(stem.socket.InvalidArguments, stem.response.convert, "GETCONF", control_message) try: - stem.response.convert("GETCONF", control_message) + stem.response.convert("GETCONF", control_message, multiple = True) except stem.socket.InvalidArguments, exc: - self.assertEqual(exc.arguments, ["yellowbrickroad"]) + self.assertEqual(exc.arguments, ["brickroad", "submarine"]) def test_invalid_content(self): """

1 0

[stem/master] Add getconf test to check for multiline configuration keys
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit f6231a9dd9ed52dae4e77e153cae13e344a4e094 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sun Jun 17 20:29:58 2012 +0530 Add getconf test to check for multiline configuration keys --- test/integ/control/controller.py | 6 ++++++ test/runner.py | 2 ++ 2 files changed, 8 insertions(+), 0 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index db7941c..9d1028b 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -171,6 +171,12 @@ class TestController(unittest.TestCase): self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "blarg") self.assertEqual("la-di-dah", controller.get_conf("blarg", "la-di-dah")) + # multivalue configuration keys + + nodefamilies = [node_family[11:].strip() for node_family in + runner.get_torrc_contents().split("\n") if node_family.startswith("NodeFamily ")] + self.assertEqual(nodefamilies, controller.get_conf("NodeFamily", multiple = True)) + # empty input self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "") diff --git a/test/runner.py b/test/runner.py index 3b696b3..571bb9d 100644 --- a/test/runner.py +++ b/test/runner.py @@ -71,6 +71,8 @@ BASE_TORRC = """# configuration for stem integration tests DataDirectory %s SocksPort 0 DownloadExtraInfo 1 +NodeFamily dummystemnodexyz1x1,dummystemnodexyz1x2,dummystemnodexyz1x3 +NodeFamily dummystemnodexyz2x1,dummystemnodexyz2x2,dummystemnodexyz2x3 """ # We make some paths relative to stem's base directory (the one above us)

1 0

[stem/master] Add attributes to InvalidRequest and InvalidArguments
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit a80a784b29a91fb3ee9a6ec8a30b829b68648e41 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Jun 14 12:16:44 2012 +0530 Add attributes to InvalidRequest and InvalidArguments Adds attributes to store the error code and error message to InvalidRequest and InvalidArguments --- stem/response/__init__.py | 3 ++- stem/response/getconf.py | 4 ++-- stem/response/getinfo.py | 2 +- stem/socket.py | 38 +++++++++++++++++++++++++++++++++----- 4 files changed, 38 insertions(+), 9 deletions(-) diff --git a/stem/response/__init__.py b/stem/response/__init__.py index 273bead..13c65b3 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -60,7 +60,8 @@ def convert(response_type, message): :raises: * :class:`stem.socket.ProtocolError` the message isn't a proper response of that type - * :class:`stem.socket.InvalidArguments` Raised if the request's arguments when converting GETCONF or GETINFO responses are invalid + * :class:`stem.socket.InvalidArguments` raised if the arguments given as + input are invalid. Raised whenj converting GETINFO or GETCONF requests * TypeError if argument isn't a :class:`stem.response.ControlMessage` or response_type isn't supported """ diff --git a/stem/response/getconf.py b/stem/response/getconf.py index 41f1857..fd2256c 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -33,11 +33,11 @@ class GetConfResponse(stem.response.ControlMessage): if not self.is_ok(): unrecognized_keywords = [] for code, _, line in self.content(): - if code == '552' and line.startswith("Unrecognized configuration key \"") and line.endswith("\""): + if code == "552" and line.startswith("Unrecognized configuration key \"") and line.endswith("\""): unrecognized_keywords.append(line[32:-1]) if unrecognized_keywords: - raise stem.socket.InvalidArguments("GETCONF request contained unrecognized keywords: %s\n" \ + raise stem.socket.InvalidArguments("552", "GETCONF request contained unrecognized keywords: %s\n" \ % ', '.join(unrecognized_keywords), unrecognized_keywords) else: raise stem.socket.ProtocolError("GETCONF response contained a non-OK status code:\n%s" % self) diff --git a/stem/response/getinfo.py b/stem/response/getinfo.py index 3fac253..f467769 100644 --- a/stem/response/getinfo.py +++ b/stem/response/getinfo.py @@ -31,7 +31,7 @@ class GetInfoResponse(stem.response.ControlMessage): unrecognized_keywords.append(line[18:-1]) if unrecognized_keywords: - raise stem.socket.InvalidArguments("GETCONF request contained unrecognized keywords: %s\n" \ + raise stem.socket.InvalidArguments("552", "GETINFO request contained unrecognized keywords: %s\n" \ % ', '.join(unrecognized_keywords), unrecognized_keywords) else: raise stem.socket.ProtocolError("GETINFO response didn't have an OK status:\n%s" % self) diff --git a/stem/socket.py b/stem/socket.py index b933f50..9e1f5b7 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -551,24 +551,52 @@ class ProtocolError(ControllerError): "Malformed content from the control socket." class InvalidRequest(ControllerError): - "Base Exception class for invalid requests" + """ + Base Exception class for invalid requests + + :var str code: The error code returned by Tor (if applicable) + :var str message: The error message returned by Tor (if applicable) or a human + readable error message + """ + + def __init__(self, code = None, message = None): + """ + Initializes an InvalidRequest object. + + :param str code: The error code returned by Tor (if applicable) + :param str message: The error message returned by Tor (if applicable) or a + human readable error message + + :returns: object of InvalidRequest class + """ + + self.code = code + self.message = message class InvalidArguments(InvalidRequest): """ Exception class for invalid requests which contain invalid arguments. - :var list arguments: a list of parameters which were invalid + :var str code: The error code returned by Tor (if applicable) + :var str message: The error message returned by Tor (if applicable) or a human + readable error message + :var list arguments: a list of arguments which were invalid """ - def __init__(self, message, arguments): + def __init__(self, code = None, message = None, arguments = None): """ Initializes an InvalidArguments object. - :param str message: error message - :param list arguments: a list of parameters which were invalid + :param str code: The error code returned by Tor (if applicable) + :param str message: The error message returned by Tor (if applicable) or a + human readable error message + :param list arguments: a list of arguments which were invalid :returns: object of InvalidArguments class """ + + self.code = code + self.message = message self.arguments = arguments class SocketError(ControllerError):

1 0

[stem/master] Fix a bug where getconf parses didn't set the default correctly for multiple keys
by atagar＠torproject.org 04 Jul '12

04 Jul '12

commit 0b83af2922b5c377161626c7aef2af14a0152463 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Sun Jun 17 22:27:55 2012 +0530 Fix a bug where getconf parses didn't set the default correctly for multiple keys and write a test to check for this --- stem/control.py | 8 +++++++- test/integ/control/controller.py | 11 +++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/stem/control.py b/stem/control.py index d14d723..5ce6780 100644 --- a/stem/control.py +++ b/stem/control.py @@ -576,5 +576,11 @@ class Controller(BaseController): except KeyError: raise stem.socket.InvalidRequest("Received empty string") except stem.socket.ControllerError, exc: if default is UNDEFINED: raise exc - else: return default + elif is_multiple: + if default != UNDEFINED: + return dict([(p, default) for p in param]) + else: + return dict([(p, None) for p in param]) + else: + return default diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 9d1028b..38f6f10 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -166,13 +166,20 @@ class TestController(unittest.TestCase): self.assertEqual(getconf_params, set(controller.get_conf(["ControlPort", "DirPort", "DataDirectory"]))) - # non-existant option + # non-existant option(s) self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "blarg") self.assertEqual("la-di-dah", controller.get_conf("blarg", "la-di-dah")) + self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, "blarg") + self.assertEqual("la-di-dah", controller.get_conf("blarg", "la-di-dah")) + + self.assertRaises(stem.socket.InvalidRequest, controller.get_conf, + ["blarg", "huadf"], multiple = True) + self.assertEqual({"erfusdj": "la-di-dah", "afiafj": "la-di-dah"}, + controller.get_conf(["erfusdj", "afiafj"], "la-di-dah", multiple = True)) # multivalue configuration keys - + nodefamilies = [node_family[11:].strip() for node_family in runner.get_torrc_contents().split("\n") if node_family.startswith("NodeFamily ")] self.assertEqual(nodefamilies, controller.get_conf("NodeFamily", multiple = True))

1 0