September 2011 - tor-commits - lists.torproject.org

[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

[arm/release] fix: readline buggy with a color prompt
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit e27909a69220557611c0cb8a8e98889fe64433c2 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Sep 13 08:42:56 2011 -0700 fix: readline buggy with a color prompt When providing a color prompt and history completion via the readline module the prompt can be screwed up by cycling to a command longer than the non-displayed length of the prompt string. Unfortunatley I'm not finding a workaround so removing formatting from the prompt. For more information see: http://bugs.python.org/issue12972 --- src/util/torInterpretor.py | 7 ++++++- 1 files changed, 6 insertions(+), 1 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index d6f9340..fc217f3 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -492,7 +492,12 @@ class ControlInterpretor: return (inputLines, outputLines) def prompt(): - prompt = format(">>> ", Color.GREEN, Attr.BOLD) + # Cycling history via the readline module with up/down is buggy with a color + # prompt. For more information see: + # http://bugs.python.org/issue12972 + #prompt = format(">>> ", Color.GREEN, Attr.BOLD) + + prompt = ">>> " input = "" # sets up tab autocompetion

1 0

[arm/release] Covering tor config options with /help
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit aa7fee5d5d92e33e81a169c254c4fc80a3ce0947 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Sep 14 09:56:04 2011 -0700 Covering tor config options with /help Issuing '/help [tor config option]' (for instance '/help exitpolicy') will provide usage information and the man page description for the option. --- src/util/torConfig.py | 14 +++++++------- src/util/torInterpretor.py | 24 ++++++++++++++++++++++-- 2 files changed, 29 insertions(+), 9 deletions(-) diff --git a/src/util/torConfig.py b/src/util/torConfig.py index 557dc09..b2cf345 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -77,7 +77,8 @@ class ManPageEntry: Information provided about a tor configuration option in its man page entry. """ - def __init__(self, index, category, argUsage, description): + def __init__(self, option, index, category, argUsage, description): + self.option = option self.index = index self.category = category self.argUsage = argUsage @@ -168,7 +169,7 @@ def loadOptionDescriptions(loadPath = None, checkVersion = True): if inputFileContents: loadedLine = inputFileContents.pop(0) else: break - CONFIG_DESCRIPTIONS[option.lower()] = ManPageEntry(indexArg, category, argument, description.rstrip()) + CONFIG_DESCRIPTIONS[option.lower()] = ManPageEntry(option, indexArg, category, argument, description.rstrip()) except IndexError: CONFIG_DESCRIPTIONS.clear() raise IOError("input file format is invalid") @@ -209,7 +210,7 @@ def loadOptionDescriptions(loadPath = None, checkVersion = True): # noise). strippedDescription = lastDescription.strip() if lastOption and (not validOptions or lastOption.lower() in validOptions): - CONFIG_DESCRIPTIONS[lastOption.lower()] = ManPageEntry(optionCount, lastCategory, lastArg, strippedDescription) + CONFIG_DESCRIPTIONS[lastOption.lower()] = ManPageEntry(lastOption, optionCount, lastCategory, lastArg, strippedDescription) optionCount += 1 lastDescription = "" @@ -271,9 +272,8 @@ def saveOptionDescriptions(path): torVersion = torTools.getConn().getInfo("version", "") outputFile.write("Tor Version %s\n" % torVersion) for i in range(len(sortedOptions)): - option = sortedOptions[i] - manEntry = getConfigDescription(option) - outputFile.write("%s\nindex: %i\n%s\n%s\n%s\n" % (manEntry.category, manEntry.index, option, manEntry.argUsage, manEntry.description)) + manEntry = getConfigDescription(sortedOptions[i]) + outputFile.write("%s\nindex: %i\n%s\n%s\n%s\n" % (manEntry.category, manEntry.index, manEntry.option, manEntry.argUsage, manEntry.description)) if i != len(sortedOptions) - 1: outputFile.write(PERSIST_ENTRY_DIVIDER) outputFile.close() @@ -281,7 +281,7 @@ def saveOptionDescriptions(path): def getConfigSummary(option): """ - Provides a short summary description of th configuration option. If none is + Provides a short summary description of the configuration option. If none is known then this proivdes None. Arguments: diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 3908d6e..5733f8a 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -9,7 +9,7 @@ import readline import version -from util import connections, enum, hostnames, torTools +from util import connections, enum, hostnames, torConfig, torTools, uiTools COLOR_PROMPT = True # provides a colored interpretor prompt INFO_HOSTNAMES = False # hostname lookups in /info results @@ -300,7 +300,27 @@ class ControlInterpretor: for line in description.split("\n"): outputEntry.append((" " + line + "\n", OUTPUT_FORMAT)) else: - outputEntry.append(("No help information for '%s'..." % arg, ERROR_FORMAT)) + # check if this is a configuration option + manEntry = torConfig.getConfigDescription(arg) + + if manEntry: + # provides basic usage information in bold, followed an indented + # copy of the man page description (wrapped to eighty characters) + + helpTitle = "%s %s (category: %s)\n" % (manEntry.option, manEntry.argUsage, manEntry.category) + outputEntry.append((helpTitle, OUTPUT_FORMAT + (Attr.BOLD, ))) + + descLines = manEntry.description.split("\n") + + for line in descLines: + if not line: + outputEntry.append(("\n", OUTPUT_FORMAT)) + else: + while line: + drawPortion, line = uiTools.cropStr(line, 88, 4, 4, uiTools.Ending.HYPHEN, True) + outputEntry.append((" %s\n" % drawPortion.strip(), OUTPUT_FORMAT)) + else: + outputEntry.append(("No help information for '%s'..." % arg, ERROR_FORMAT)) else: # provides the GENERAL_HELP with everything bolded except descriptions for line in GENERAL_HELP.split("\n"):

1 0

[arm/release] Adding back the color prompt, with padded prompt
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 0fb7dd674c9969d55c21fca9040f7f7bcfd09950 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Sep 13 08:58:29 2011 -0700 Adding back the color prompt, with padded prompt This is a hack to maintain a color prompt while sidestepping the 'http://bugs.python.org/issue12972' bug in *most* use cases. This pads the prompt so the original issue doesn't manifest unless the user's input exceeds around sixty characters or so. However, it introduces a new bug where tiny terminals (smaller than the padded width) get screwed up. This obviously isn't a great situation and it could be argued that a colored prompt isn't worth these issues. However, the problem use cases strike me as being fairly rare (and I much prefer the green and bolded '>>>') so going with this for now. Patches welcome if someone has a better solution. --- src/util/torInterpretor.py | 13 +++++++++++-- 1 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index fc217f3..2c4e7fa 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -495,9 +495,18 @@ def prompt(): # Cycling history via the readline module with up/down is buggy with a color # prompt. For more information see: # http://bugs.python.org/issue12972 - #prompt = format(">>> ", Color.GREEN, Attr.BOLD) + # + # To work around this while keeping a color prompt I'm padding the prompt + # with extra reset encodings so its length is non-rendered higher (around + # sixty characters). There's two ways that this can go wrong... + # - if the user uses up/down to display input longer than this non-rendered + # length then the original bug will manifest (screwed up prompt) + # - if the terminal's width is smaller than the non-rendered prompt length + # then the cursor and some movement will be displaced + + prompt = format(">>> ", Color.GREEN, Attr.BOLD) + prompt += "\x1b[0m" * 10 - prompt = ">>> " input = "" # sets up tab autocompetion

1 0

[arm/release] Implementing /help for interpretor commands
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit d40a26f6bbd69fa63436983905ed261f164b5cb9 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Sep 14 09:19:53 2011 -0700 Implementing /help for interpretor commands Beginning to implement the '/help [OPTION]' interpretor command. This will provide usage information on interpretor commands, tor controller commands, and tor configuration options. At present just the general help and interpretor commands are implemented. --- src/util/torInterpretor.py | 103 ++++++++++++++++++++++++++++++++++++++++++- 1 files changed, 100 insertions(+), 3 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index fbb33da..3908d6e 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -14,6 +14,9 @@ from util import connections, enum, hostnames, torTools COLOR_PROMPT = True # provides a colored interpretor prompt INFO_HOSTNAMES = False # hostname lookups in /info results +# initial location /write will save to when no path is specified +DEFAULT_WRITE_PATH = "/tmp/torInterpretor_output" + INIT_MSG = """Arm %s Control Interpretor Enter \"/help\" for usage information and \"/quit\" to stop. """ % version.VERSION @@ -45,6 +48,64 @@ RESET = CSI % "0" BACKLOG_LIMIT = 100 CONTENT_LIMIT = 20000 +GENERAL_HELP = """Interpretor commands include: + help - provides information for interpretor and tor commands/config options + write - saves backlog to a given location + info - general information for a relay + find - searches backlog for lines with the given regex + quit - shuts down the interpretor + +Tor commands include: + GETINFO - queries information from tor + GETCONF, SETCONF, RESETCONF - show or edit a configuration option + SIGNAL - issues control signal to the process (for resetting, stopping, etc) + SETEVENT - configures the events tor will notify us of + + USEFEATURE - enables custom behavior for the controller + SAVECONF - writes tor's current configuration to our torrc + LOADCONF - loads the given input like it was part of our torrc + MAPADDRESS - replaces requests for one address with another + POSTDESCRIPTOR - adds a relay descriptor to our cache + EXTENDCIRCUIT - create or extend a tor circuit + SETCIRCUITPURPOSE - configures the purpose associated with a circuit + CLOSECIRCUIT - closes the given circuit + ATTACHSTREAM - associates an application's stream with a tor circuit + REDIRECTSTREAM - sets a stream's destination + CLOSESTREAM - closes the given stream + 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 + +For more information use '/help [OPTION]'.""" + +HELP_HELP = """Provides usage information for the given interpretor, tor command, or tor +configuration option. + +Example: + /help info # provides a description of the '/info' option + /help GETINFO # usage information for tor's GETINFO controller option + /help ExitPolicy # description of tor's ExitPolicy configuration option""" + +HELP_WRITE = """Writes the interpretor's backlog to the given path. If no location is +specified then this saves to the last path specified (initially '%s').""" % DEFAULT_WRITE_PATH + +HELP_INFO = """Provides general information for a relay that's currently in the consensus. +If no relay is specified then this provides information on ourselves.""" + +HELP_FIND = """Searches the backlog for lines matching a given regular expression pattern. +Results are deduplicated and the matching portions bolded.""" + +HELP_QUIT = """Terminates the interpretor.""" + +INTERPRETOR_HELP = { + "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) +} + class InterpretorClosed(Exception): """ Exception raised when the interpretor should be shut down. @@ -156,7 +217,7 @@ class TorControlCompleter: self.commands.append("MAPADDRESS ") self.commands.append("EXTENDCIRCUIT ") self.commands.append("SETCIRCUITPURPOSE ") - self.commands.append("SETROUTERPURPOSE ") + #self.commands.append("SETROUTERPURPOSE ") # deprecated option self.commands.append("ATTACHSTREAM ") self.commands.append("+POSTDESCRIPTOR ") # TODO: needs to support multiline options for this (ugg) self.commands.append("REDIRECTSTREAM ") @@ -197,7 +258,7 @@ class ControlInterpretor: def __init__(self): self.backlog = [] # prior requests the user has made self.contents = [] # (msg, format list) tuples for what's been displayed - self.writePath = "/tmp/torInterpretor_output" # last location we've saved to + self.writePath = DEFAULT_WRITE_PATH # last location we've saved to def getBacklog(self): """ @@ -220,6 +281,37 @@ class ControlInterpretor: return self.contents + [appendPrompt] else: return self.contents + def doHelp(self, arg, outputEntry): + """ + Performs the '/help' operation, giving usage information for the given + argument or a general summary if there wasn't one. + """ + + arg = arg.upper() + + if arg: + if arg in INTERPRETOR_HELP: + # Provides information for the interpretor argument. This bolds the + # usage information and indents the description after it. + usage, description = INTERPRETOR_HELP[arg] + + outputEntry.append((usage + "\n", OUTPUT_FORMAT + (Attr.BOLD, ))) + + for line in description.split("\n"): + outputEntry.append((" " + line + "\n", OUTPUT_FORMAT)) + else: + outputEntry.append(("No help information for '%s'..." % arg, ERROR_FORMAT)) + else: + # provides the GENERAL_HELP with everything bolded except descriptions + for line in GENERAL_HELP.split("\n"): + cmdStart = line.find(" - ") + + if cmdStart != -1: + outputEntry.append((line[:cmdStart], OUTPUT_FORMAT + (Attr.BOLD, ))) + outputEntry.append((line[cmdStart:] + "\n", OUTPUT_FORMAT)) + else: + outputEntry.append((line + "\n", OUTPUT_FORMAT + (Attr.BOLD, ))) + def doWrite(self, arg, outputEntry): """ Performs the '/write' operation, which attempts to save the backlog to a @@ -286,7 +378,11 @@ class ControlInterpretor: # determines the fingerprint, leaving it unset and adding an error message # if unsuccessful if not arg: - outputEntry.append(("No fingerprint or nickname to look up", ERROR_FORMAT)) + # uses our fingerprint if we're a relay, otherwise gives an error + fingerprint = conn.getInfo("fingerprint") + + if not fingerprint: + outputEntry.append(("We aren't a relay, no information to provide", ERROR_FORMAT)) elif len(arg) == 40 and re.match("^[0-9a-fA-F]+$", arg): # we got a fingerprint (fourty character hex string) fingerprint = arg @@ -438,6 +534,7 @@ class ControlInterpretor: inputEntry.append((input, INPUT_INTERPRETOR_FORMAT)) if cmd == "/quit": raise InterpretorClosed() + elif cmd == "/help": self.doHelp(arg, outputEntry) elif cmd == "/write": self.doWrite(arg, outputEntry) elif cmd == "/find": self.doFind(arg, outputEntry) elif cmd == "/info": self.doInfo(arg, outputEntry)

1 0

[arm/release] Source flags for color prompt and hostname lookups
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 6e88a85a7a8c45d798e8471e9ce27295aa0b122e Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Sep 13 09:34:30 2011 -0700 Source flags for color prompt and hostname lookups Adding source flags for portions of the interpretor that include substantial tradeoffs. For color prompts there's bugs in small displays/huge input, and hostname lookups add a second or two to the runtime of /info queries (otherwise the lookup is instantanious). Defaulting the hostname lookups to be disabled for now. There's plans for having cached results with... https://trac.torproject.org/projects/tor/wiki/doc/arm#CircuitDetails though I haven't a clue if it'll ever be implemented. --- src/util/torInterpretor.py | 19 +++++++++++++++---- 1 files changed, 15 insertions(+), 4 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 2c4e7fa..fbb33da 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -11,6 +11,9 @@ import version from util import connections, enum, hostnames, torTools +COLOR_PROMPT = True # provides a colored interpretor prompt +INFO_HOSTNAMES = False # hostname lookups in /info results + INIT_MSG = """Arm %s Control Interpretor Enter \"/help\" for usage information and \"/quit\" to stop. """ % version.VERSION @@ -325,7 +328,11 @@ class ControlInterpretor: if not address or not port: return locale = conn.getInfo("ip-to-country/%s" % address, "??") - hostname = hostnames.resolve(address, 10) + + if INFO_HOSTNAMES: + hostname = hostnames.resolve(address, 10) + else: + hostname = None # TODO: Most of the following is copied from the _getDetailContent method # of cli/connections/connEntry.py - useful bits should be refactored. @@ -370,8 +377,9 @@ class ControlInterpretor: outputEntry.append(("%s (%s)\n" % (nickname, fingerprint), infoAttr)) + hostnameLabel = ", %s" % hostname if hostname else "" outputEntry.append(("address: ", headingAttr)) - outputEntry.append(("%s:%s (%s, %s)\n" % (address, port, locale, hostname), infoAttr)) + outputEntry.append(("%s:%s (%s%s)\n" % (address, port, locale, hostnameLabel), infoAttr)) outputEntry.append(("published: ", headingAttr)) outputEntry.append(("%s %s" % (pubTime, pubDate) + "\n", infoAttr)) @@ -504,8 +512,11 @@ def prompt(): # - if the terminal's width is smaller than the non-rendered prompt length # then the cursor and some movement will be displaced - prompt = format(">>> ", Color.GREEN, Attr.BOLD) - prompt += "\x1b[0m" * 10 + if COLOR_PROMPT: + prompt = format(">>> ", Color.GREEN, Attr.BOLD) + prompt += "\x1b[0m" * 10 + else: + prompt = ">>> " input = ""

1 0

[arm/release] Tab completion for interpretor and help commands
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 48c1888a715209e88c5962f756d40325a6ae28c1 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 15 08:47:31 2011 -0700 Tab completion for interpretor and help commands Minor interpretor improvements, mostly adding tab completion for the current interpretor commands and anything that will be recognized by '/help'. --- src/util/torConfig.py | 13 +++++++++++++ src/util/torInterpretor.py | 26 +++++++++++++++++++++----- 2 files changed, 34 insertions(+), 5 deletions(-) diff --git a/src/util/torConfig.py b/src/util/torConfig.py index b2cf345..1d54196 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -321,6 +321,19 @@ def getConfigDescription(option): CONFIG_DESCRIPTIONS_LOCK.release() return returnVal +def getConfigOptions(): + """ + Provides the configuration options from the loaded man page. This is an empty + list if no man page has been loaded. + """ + + CONFIG_DESCRIPTIONS_LOCK.acquire() + + returnVal = [CONFIG_DESCRIPTIONS[opt].option for opt in CONFIG_DESCRIPTIONS] + + CONFIG_DESCRIPTIONS_LOCK.release() + return returnVal + def getConfigLocation(): """ Provides the location of the torrc, raising an IOError with the reason if the diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 5733f8a..ce28e9c 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -49,11 +49,11 @@ BACKLOG_LIMIT = 100 CONTENT_LIMIT = 20000 GENERAL_HELP = """Interpretor commands include: - help - provides information for interpretor and tor commands/config options - write - saves backlog to a given location - info - general information for a relay - find - searches backlog for lines with the given regex - quit - shuts down the interpretor + /help - provides information for interpretor and tor commands/config options + /write - saves backlog to a given location + /info - general information for a relay + /find - searches backlog for lines with the given regex + /quit - shuts down the interpretor Tor commands include: GETINFO - queries information from tor @@ -228,6 +228,19 @@ class TorControlCompleter: self.commands.append("+LOADCONF") # TODO: another multiline... self.commands.append("TAKEOWNERSHIP") self.commands.append("QUIT") # TODO: give a confirmation when the user does this? + + # adds interpretor commands + for cmd in INTERPRETOR_HELP: + self.commands.append("/" + cmd.lower()) + + # adds help options for the previous commands + baseCmd = set([cmd.split(" ")[0].replace("+", "").replace("/", "") for cmd in self.commands]) + for cmd in baseCmd: + self.commands.append("/help " + cmd) + + # adds /help for tor configuration options + for opt in torConfig.getConfigOptions(): + self.commands.append("/help " + opt) def getMatches(self, text): """ @@ -289,6 +302,9 @@ class ControlInterpretor: arg = arg.upper() + # strip slash if someone enters an interpretor command (ex. "/help /help") + if arg.startswith("/"): arg = arg[1:] + if arg: if arg in INTERPRETOR_HELP: # Provides information for the interpretor argument. This bolds the

1 0

[arm/release] Help content for GETINFO
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit d3da20b9e311de1604192a28ba63593316a901ac Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 15 09:38:59 2011 -0700 Help content for GETINFO Simple help snippet followed by the 'GETINFO info/names' descriptions. --- src/util/torInterpretor.py | 46 +++++++++++++++++++++++++++++++++++-------- 1 files changed, 37 insertions(+), 9 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index ce28e9c..21603a1 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -98,12 +98,16 @@ Results are deduplicated and the matching portions bolded.""" HELP_QUIT = """Terminates the interpretor.""" -INTERPRETOR_HELP = { +HELP_GETINFO = """Queries the tor process for information. Options are... +""" + +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) + "QUIT": ("/quit", HELP_QUIT), + "GETINFO": ("GETINFO [OPTION]", HELP_GETINFO) } class InterpretorClosed(Exception): @@ -230,8 +234,9 @@ class TorControlCompleter: self.commands.append("QUIT") # TODO: give a confirmation when the user does this? # adds interpretor commands - for cmd in INTERPRETOR_HELP: - self.commands.append("/" + cmd.lower()) + for cmd in HELP_OPTIONS: + if HELP_OPTIONS[cmd][0].startswith("/"): + self.commands.append("/" + cmd.lower()) # adds help options for the previous commands baseCmd = set([cmd.split(" ")[0].replace("+", "").replace("/", "") for cmd in self.commands]) @@ -302,19 +307,42 @@ class ControlInterpretor: arg = arg.upper() + # If there's multiple arguments then just take the first. This is + # particularly likely if they're trying to query a full command (for + # instance "/help GETINFO version") + + arg = arg.split(" ")[0] + # strip slash if someone enters an interpretor command (ex. "/help /help") if arg.startswith("/"): arg = arg[1:] if arg: - if arg in INTERPRETOR_HELP: - # Provides information for the interpretor argument. This bolds the - # usage information and indents the description after it. - usage, description = INTERPRETOR_HELP[arg] + if arg in HELP_OPTIONS: + # Provides information for the tor or interpretor argument. This bolds + # the usage information and indents the description after it. + usage, description = HELP_OPTIONS[arg] outputEntry.append((usage + "\n", OUTPUT_FORMAT + (Attr.BOLD, ))) for line in description.split("\n"): outputEntry.append((" " + line + "\n", OUTPUT_FORMAT)) + + # if this is the GETINFO option then also list the valid options + if arg == "GETINFO": + infoOptions = torTools.getConn().getInfo("info/names") + + if infoOptions: + for line in infoOptions.split("\n"): + if line.startswith("config/*") or line.startswith("dir-usage"): + continue + + lineMatch = re.match("^(.+) -- (.+)$", line) + + if lineMatch: + opt, description = lineMatch.groups() + + outputEntry.append(("%-33s" % opt, OUTPUT_FORMAT + (Attr.BOLD, ))) + outputEntry.append((" - %s\n" % description, OUTPUT_FORMAT)) else: # check if this is a configuration option manEntry = torConfig.getConfigDescription(arg) @@ -336,7 +364,7 @@ class ControlInterpretor: drawPortion, line = uiTools.cropStr(line, 88, 4, 4, uiTools.Ending.HYPHEN, True) outputEntry.append((" %s\n" % drawPortion.strip(), OUTPUT_FORMAT)) else: - outputEntry.append(("No help information for '%s'..." % arg, ERROR_FORMAT)) + outputEntry.append(("No help information available for '%s'..." % arg, ERROR_FORMAT)) else: # provides the GENERAL_HELP with everything bolded except descriptions for line in GENERAL_HELP.split("\n"):

1 0