- tor-commits - lists.torproject.org

[arm/release] Notice that multi-line input isn't implemented
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 0b68c433fd1b58bc628eb53234a656845ff18a57 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 21:43:21 2011 -0700 Notice that multi-line input isn't implemented A couple controller options (LOADCONF and POSTDESCRIPTOR) use multi-line controller input. However, this isn't yet implemented and probably won't be for the next release (those controller options really aren't very useful for the interpretor). --- src/util/torInterpretor.py | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 825e502..3726517 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -787,6 +787,9 @@ class ControlInterpretor: conn.setOptions(paramList, isReset) except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) + elif cmd.replace("+", "") in ("LOADCONF", "POSTDESCRIPTOR"): + # provides a notice that multi-line controller input isn't yet implemented + outputEntry.append((MULTILINE_UNIMPLEMENTED_NOTICE + "\n", ERROR_FORMAT)) else: try: response = conn.getTorCtl().sendAndRecv("%s\r\n" % input)

1 0

[arm/release] Caching tab completion match results
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 3714ef4ed8b84029f2da11c639fdd9a64e8ddf1e Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 07:52:27 2011 -0700 Caching tab completion match results Thanks to the wonderfully weak pydoc explanations I'm kinda fuzzy on how the complete function is called, but this should reduce the number of extra prefix lookups that we do. --- src/util/torInterpretor.py | 13 ++++++++++--- 1 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 658b65e..d5abb88 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -236,6 +236,9 @@ class TorControlCompleter: """ def __init__(self): + self._prefix = None + self._prefixMatches = [] + self.commands = [] conn = torTools.getConn() @@ -342,9 +345,13 @@ class TorControlCompleter: the readlines set_completer function. """ - for cmd in self.getMatches(text): - if not state: return cmd - else: state -= 1 + if text != self._prefix: + self._prefix = text + self._prefixMatches = self.getMatches(text) + + if state < len(self._prefixMatches): + return self._prefixMatches[state] + else: return None class ControlInterpretor: """

1 0

[arm/release] fix: tab completion could truncated results
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 48e955db099c5295edcee19508844fbd812b5948 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 08:10:12 2011 -0700 fix: tab completion could truncated results When the tab completion matches had prefixes with multiple cases (for instance "MAPADDRESS" and "MapAddress") then tab completion would crop input to the common portion (just "M"). Instead picking the prefix with the largest set of results. This isn't perfect since it could hide some results but seems like the best option for getting around this stupid behavior. --- src/util/torInterpretor.py | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index d5abb88..593f29c 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -348,6 +348,30 @@ class TorControlCompleter: if text != self._prefix: self._prefix = text self._prefixMatches = self.getMatches(text) + + # Tab completion fills in the first common prefix which can be + # problematic if they don't all match. For instance completing "Map" will + # result in ["MAPADDRESS", "MapAddress"], which gets truncated to the + # common prefix of just "M" when the user presses tab. + + if len(self._prefixMatches) > 1: + prefixToResult = {} + + for match in self._prefixMatches: + prefix = match[:len(text)] + + if prefix in prefixToResult: + prefixToResult[prefix].append(match) + else: + prefixToResult[prefix] = [match] + + if len(prefixToResult) > 1: + # we have multiple prefixes, pick the one with the most results + self._prefixMatches = None + + for matchSet in prefixToResult.values(): + if not self._prefixMatches or len(self._prefixMatches) < len(matchSet): + self._prefixMatches = matchSet if state < len(self._prefixMatches): return self._prefixMatches[state]

1 0

[arm/release] fix: uncaught keyboard interrupt exceptions
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 5ae0195c30785e7bef1ca34e5ae8c1ac058623a8 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 08:15:51 2011 -0700 fix: uncaught keyboard interrupt exceptions KeyboardInterrupt isn't an Exception subclass (wtf?), causing a previous change to fetch the exception object to result in keyboard interrupts being uncaught. --- src/util/torInterpretor.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 593f29c..e6b2e52 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -904,7 +904,7 @@ def prompt(): try: input = raw_input(prompt) _, outputEntry = interpretor.handleQuery(input) - except Exception, exc: + except (KeyboardInterrupt, Exception), exc: if isinstance(exc, InterpretorClosed) and str(exc): print format(str(exc), *ERROR_FORMAT)

1 0

[arm/release] Interpretor help for POSTDESCRIPTOR
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 59768dee3ddeb3c69b2b617ec3939fb13d0677ad Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 08:29:11 2011 -0700 Interpretor help for POSTDESCRIPTOR Just basic usage information and a warning that, like LOADCONF, this isn't yet implemented. --- src/util/torInterpretor.py | 7 +++++-- 1 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index e6b2e52..9c08f06 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -171,6 +171,8 @@ HELP_MAPADDRESS = """Replaces future requests for one address with another. Example: MAPADDRESS 0.0.0.0=torproject.org 1.2.3.4=tor.freehaven.net""" +HELP_POSTDESCRIPTOR = """Simulates getting a new relay descriptor.""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -185,8 +187,9 @@ HELP_OPTIONS = { "SETEVENTS": ("SETEVENTS [EXTENDED] [EVENTS]", HELP_SETEVENTS), "USEFEATURE": ("USEFEATURE OPTION", HELP_USEFEATURE), "SAVECONF": ("SAVECONF", HELP_SAVECONF), - "LOADCONF": ("LOADCONF", HELP_LOADCONF), + "LOADCONF": ("LOADCONF...", HELP_LOADCONF), "MAPADDRESS": ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", HELP_MAPADDRESS), + "POSTDESCRIPTOR": ("POSTDESCRIPTOR [purpose=general/controller/bridge] [cache=yes/no]...", HELP_POSTDESCRIPTOR), } class InterpretorClosed(Exception): @@ -496,7 +499,7 @@ class ControlInterpretor: featureOptions = torTools.getConn().getInfo("features/names") if featureOptions: outputEntry.append((featureOptions + "\n", OUTPUT_FORMAT)) - elif arg in ("LOADCONF"): + elif arg in ("LOADCONF", "POSTDESCRIPTOR"): # gives a warning that this option isn't yet implemented outputEntry.append(("\n" + MULTILINE_UNIMPLEMENTED_NOTICE + "\n", ERROR_FORMAT)) else:

1 0

[arm/release] Interpretor help for EXTENDCIRCUIT
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 8e416a54b760b2b3b4b3e96079e29e1b6e427729 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 08:37:11 2011 -0700 Interpretor help for EXTENDCIRCUIT Kinda guessing at what "ServerSpec" means, hopefully I'm right. --- src/util/torInterpretor.py | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 9c08f06..fd8d5d7 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -173,6 +173,10 @@ Example: HELP_POSTDESCRIPTOR = """Simulates getting a new relay descriptor.""" +HELP_EXTENDCIRCUIT = """Extends the given circuit or create a new one if the CircuitID is zero. The +PATH is a comma separated list of fingerprints. If it isn't set then this +uses Tor's normal path selection.""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -190,6 +194,7 @@ HELP_OPTIONS = { "LOADCONF": ("LOADCONF...", HELP_LOADCONF), "MAPADDRESS": ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", HELP_MAPADDRESS), "POSTDESCRIPTOR": ("POSTDESCRIPTOR [purpose=general/controller/bridge] [cache=yes/no]...", HELP_POSTDESCRIPTOR), + "EXTENDCIRCUIT": ("EXTENDCIRCUIT CircuitID [PATH] [purpose=general/controller]", HELP_EXTENDCIRCUIT), } class InterpretorClosed(Exception):

1 0

[arm/release] Interpretor help for SETCIRCUITPURPOSE
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 236d7521154721258fd4d4a925b579f34200b511 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 08:42:59 2011 -0700 Interpretor help for SETCIRCUITPURPOSE Just a basic description. --- src/util/torInterpretor.py | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index fd8d5d7..3beef9d 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -177,6 +177,8 @@ HELP_EXTENDCIRCUIT = """Extends the given circuit or create a new one if the Cir PATH is a comma separated list of fingerprints. If it isn't set then this uses Tor's normal path selection.""" +HELP_SETCIRCUITPURPOSE = """Sets the purpose attribute for a circuit.""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -195,6 +197,7 @@ HELP_OPTIONS = { "MAPADDRESS": ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", HELP_MAPADDRESS), "POSTDESCRIPTOR": ("POSTDESCRIPTOR [purpose=general/controller/bridge] [cache=yes/no]...", HELP_POSTDESCRIPTOR), "EXTENDCIRCUIT": ("EXTENDCIRCUIT CircuitID [PATH] [purpose=general/controller]", HELP_EXTENDCIRCUIT), + "SETCIRCUITPURPOSE": ("SETCIRCUITPURPOSE CircuitID purpose=general/controller", HELP_SETCIRCUITPURPOSE), } class InterpretorClosed(Exception):

1 0

[arm/release] Interpretor help for SETCONF
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 07826242636f2fcb877404587a8266c94551b238 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 20:18:57 2011 -0700 Interpretor help for SETCONF Providing basic usage information and examples. --- src/util/torInterpretor.py | 15 +++++++++++++-- 1 files changed, 13 insertions(+), 2 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 2424a29..f0d0639 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -104,14 +104,25 @@ HELP_GETINFO = """Queries the tor process for information. Options are... HELP_GETCONF = """Provides the current value for a given configuration value. Options include... """ +HELP_SETCONF = """Sets the given configuration parameters. Values can be quoted or non-quoted +strings, and reverts the option to 0 or NULL if not provided. + +Example: + * Sets a contact address and resets our family to NULL + SETCONF MyFamily ContactInfo=foo(a)bar.com + + * Sets an exit policy that only includes port 80/443 + SETCONF ExitPolicy=\"accept *:80, accept *:443, reject *:*\"""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), "INFO": ("/info [relay fingerprint, nickname, or IP address]", HELP_INFO), "FIND": ("/find PATTERN", HELP_FIND), "QUIT": ("/quit", HELP_QUIT), - "GETINFO": ("GETINFO [OPTION]", HELP_GETINFO), - "GETCONF": ("GETCONF [OPTION]", HELP_GETCONF) + "GETINFO": ("GETINFO OPTION", HELP_GETINFO), + "GETCONF": ("GETCONF OPTION", HELP_GETCONF), + "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF) } class InterpretorClosed(Exception):

1 0

[arm/release] Only doing the prompt padding hack when needed
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 7769d33b56b124ee7fceba435a6040ef790b2dc9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 21:23:12 2011 -0700 Only doing the prompt padding hack when needed The color prompt bug mentioned in 'http://bugs.python.org/issue12972' only effects Python 2.6 and earlier so dropping the hack where I pad the prompt for versions that don't need it. --- src/util/torInterpretor.py | 12 +++++++++--- 1 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 7e96d3c..74559ba 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -5,6 +5,7 @@ directly, history and tab completion. """ import re +import sys import readline import version @@ -791,8 +792,8 @@ class ControlInterpretor: return (inputLines, outputLines) def prompt(): - # Cycling history via the readline module with up/down is buggy with a color - # prompt. For more information see: + # For Python 2.6 and earlier cycling history via the readline module with + # up/down is buggy with a color prompt. For more information see: # http://bugs.python.org/issue12972 # # To work around this while keeping a color prompt I'm padding the prompt @@ -805,7 +806,12 @@ def prompt(): if COLOR_PROMPT: prompt = format(">>> ", Color.GREEN, Attr.BOLD) - prompt += "\x1b[0m" * 10 + + majorVersion = sys.version_info[0] + minorVersion = sys.version_info[1] + + if majorVersion <= 2 and minorVersion <= 6: + prompt += "\x1b[0m" * 10 else: prompt = ">>> "

1 0

[arm/release] Batch SETCONF and SET/RESETCONF in the interpretor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 3b803423be0f7a3edb09999c1b7c99b615facc1d Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 17 16:14:39 2011 -0700 Batch SETCONF and SET/RESETCONF in the interpretor Supporting a batch SETCONF or RESETCONF in torTools, and better handling those inputs in the interpretor. --- src/util/torInterpretor.py | 43 ++++++++++++++++++++++++------- src/util/torTools.py | 60 +++++++++++++++++++++++++++++++------------ 2 files changed, 76 insertions(+), 27 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 71080c9..1cc66bd 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -75,7 +75,7 @@ Tor commands include: RESOLVE - issues an asynchronous dns or rdns request over tor TAKEOWNERSHIP - instructs tor to quit when this control connection is closed PROTOCOLINFO - queries version and controller authentication information - QUIT - disconnect control connection + QUIT - disconnect the control connection For more information use '/help [OPTION]'.""" @@ -647,16 +647,39 @@ class ControlInterpretor: except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) elif cmd == "SETCONF": - if "=" in arg: - param, value = arg.split("=", 1) + # arguments can either be '<param>' or '<param>="<value>"' entries + paramList = [] + + while arg: + # TODO: I'm a little dubious of this for LineList values (like the + # ExitPolicy) since they're parsed as a single value. However, tor + # seems to be happy to get a single comma separated string (though it + # echos back faithfully rather than being parsed) so leaving this + # alone for now. - try: - conn.setOption(param.strip(), value.strip()) - except Exception, exc: - outputEntry.append((str(exc), ERROR_FORMAT)) - else: - # TODO: resets the attribute - outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement + m = re.match(r'^(\S+)=\"([^"]+)\"', arg) + + if m: + # we're dealing with a '<param>="<value>"' entry + param, value = m.groups() + + paramList.append((param, value)) + arg = arg[len(param) + len(value) + 3:].strip() + else: + # starts with just a param + param = arg.split()[0] + paramList.append((param, None)) + arg = arg[len(param):].strip() + + try: + conn.setOptions(paramList) + except Exception, exc: + outputEntry.append((str(exc), ERROR_FORMAT)) + elif cmd == "RESETCONF": + try: + conn.setOptions([(param, None) for param in arg.split()]) + except Exception, exc: + outputEntry.append((str(exc), ERROR_FORMAT)) else: try: response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) diff --git a/src/util/torTools.py b/src/util/torTools.py index b9d9ac8..fcd8247 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -725,10 +725,11 @@ class Controller(TorCtl.PostEventListener): elif result == []: return default else: return result - def setOption(self, param, value): + def setOption(self, param, value = None): """ Issues a SETCONF to set the given option/value pair. An exeptions raised - if it fails to be set. + if it fails to be set. If no value is provided then this resets the + configuration option. Arguments: param - configuration option to be set @@ -736,27 +737,53 @@ class Controller(TorCtl.PostEventListener): list of strings) """ - isMultiple = isinstance(value, list) or isinstance(value, tuple) + self.setOptions(((param, value),)) + + def setOptions(self, paramList): + """ + Issues a SETCONF to replace a set of configuration options. This takes a + list of parameter/new value tuple pairs. Values can be... + - a string to set a single value + - a list of strings to set a series of values (for instance the ExitPolicy) + - None to reset the parameter + + Arguments: + paramList - list of parameter/value tuple pairs + """ + self.connLock.acquire() + # constructs the SETCONF string + setConfComp = [] + + for param, value in paramList: + if isinstance(value, list) or isinstance(value, tuple): + setConfComp += ["%s=\"%s\"" % (param, val.strip()) for val in value] + elif value: + setConfComp.append("%s=\"%s\"" % (param, value.strip())) + else: + setConfComp.append(param) + + setConfStr = " ".join(setConfComp) + startTime, raisedExc = time.time(), None if self.isAlive(): try: - if isMultiple: self.conn.set_options([(param, val) for val in value]) - else: self.conn.set_option(param, value) + self.conn.sendAndRecv("SETCONF %s\r\n" % setConfStr) # flushing cached values (needed until we can detect SETCONF calls) - for fetchType in ("str", "list", "map"): - entry = (param.lower(), fetchType) + for param, _ in paramList: + for fetchType in ("str", "list", "map"): + entry = (param.lower(), fetchType) + + if entry in self._cachedConf: + del self._cachedConf[entry] - if entry in self._cachedConf: - del self._cachedConf[entry] - - # special caches for the exit policy - if param.lower() == "exitpolicy": - self._exitPolicyChecker = self.getExitPolicy() - self._isExitingAllowed = self._exitPolicyChecker.isExitingAllowed() - self._exitPolicyLookupCache = {} + # special caches for the exit policy + if param.lower() == "exitpolicy": + self._exitPolicyChecker = self.getExitPolicy() + self._isExitingAllowed = self._exitPolicyChecker.isExitingAllowed() + self._exitPolicyLookupCache = {} except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed), exc: if type(exc) == TorCtl.TorCtlClosed: self.close() elif type(exc) == TorCtl.ErrorReply: @@ -777,9 +804,8 @@ class Controller(TorCtl.PostEventListener): self.connLock.release() - setCall = "%s %s" % (param, ", ".join(value) if isMultiple else value) excLabel = "failed: \"%s\", " % raisedExc if raisedExc else "" - msg = "SETCONF %s (%sruntime: %0.4f)" % (setCall.strip(), excLabel, time.time() - startTime) + msg = "SETCONF %s (%sruntime: %0.4f)" % (setConfStr, excLabel, time.time() - startTime) log.log(CONFIG["log.torSetConf"], msg) if raisedExc: raise raisedExc

1 0