- tor-commits - lists.torproject.org

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

26 Sep '11

commit 6bd40f61ae5e8155be787514da80668505f56e78 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 21:15:09 2011 -0700 Interpretor help for SETEVENTS Basic usage information and lists the event types recognized by tor. Note that this option still isn't implemented (issuing a SETEVENTS will likely screw up caching and there's currently no option for seeing the events). --- src/util/torInterpretor.py | 36 +++++++++++++++++++++++++++++++----- 1 files changed, 31 insertions(+), 5 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index c2579ae..7e96d3c 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -59,7 +59,7 @@ 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 + SETEVENTS - configures the events tor will notify us of USEFEATURE - enables custom behavior for the controller SAVECONF - writes tor's current configuration to our torrc @@ -138,6 +138,16 @@ SIGNAL_DESCRIPTIONS = ( ("NEWNYM", "clears the DNS cache and uses new circuits for future connections") ) +HELP_SETEVENTS = """Sets the events that we will receive. This turns off any events that aren't +listed so sending 'SETEVENTS' without any values will turn off all event reporting. + +For Tor versions between 0.1.1.9 and 0.2.2.1 adding 'EXTENDED' causes some +events to give us additional information. After version 0.2.2.1 this is +always on. + +Events include... +""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -149,6 +159,7 @@ HELP_OPTIONS = { "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF), "RESETCONF": ("RESETCONF PARAM[=VALUE]", HELP_RESETCONF), "SIGNAL": ("SIGNAL SIG", HELP_SIGNAL), + "SETEVENTS": ("SETEVENTS [EXTENDED] [EVENTS]", HELP_SETEVENTS), } class InterpretorClosed(Exception): @@ -233,11 +244,11 @@ class TorControlCompleter: self.commands.append("SETCONF ") self.commands.append("RESETCONF ") - # adds all of the valid SETEVENT options + # adds all of the valid SETEVENTS options eventOptions = conn.getInfo("events/names") if eventOptions: - self.commands += ["SETEVENT %s" % event for event in eventOptions.split(" ")] - else: self.commands.append("SETEVENT ") + self.commands += ["SETEVENTS %s" % event for event in eventOptions.split(" ")] + else: self.commands.append("SETEVENTS ") # adds all of the valid USEFEATURE options featureOptions = conn.getInfo("features/names") @@ -391,7 +402,7 @@ class ControlInterpretor: if confOptions: confEntries = [opt.split(" ", 1)[0] for opt in confOptions.split("\n")] - # displays four columns of 30 characters + # displays two columns of 42 characters for i in range(0, len(confEntries), 2): lineEntries = confEntries[i : i+2] @@ -407,6 +418,21 @@ class ControlInterpretor: for signal, description in SIGNAL_DESCRIPTIONS: outputEntry.append(("%-15s" % signal, OUTPUT_FORMAT + (Attr.BOLD, ))) outputEntry.append((" - %s\n" % description, OUTPUT_FORMAT)) + elif arg == "SETEVENTS": + # lists all of the event types + eventOptions = torTools.getConn().getInfo("events/names") + if eventOptions: + eventEntries = eventOptions.split() + + # displays four columns of 20 characters + for i in range(0, len(eventEntries), 4): + lineEntries = eventEntries[i : i+4] + + lineContent = "" + for entry in lineEntries: + lineContent += "%-20s" % entry + + outputEntry.append((lineContent + "\n", OUTPUT_FORMAT)) else: # check if this is a configuration option manEntry = torConfig.getConfigDescription(arg)

1 0

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

26 Sep '11

commit cf42e1c26689c569e93c4ebd41f33f95d4268de7 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 21:30:59 2011 -0700 Interpretor help for USEFEATURE This gives basic usage information and lists the options --- src/util/torInterpretor.py | 9 +++++++++ 1 files changed, 9 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 74559ba..d9f3e69 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -149,6 +149,9 @@ always on. Events include... """ +HELP_USEFEATURE = """Customizes the behavior of the control port. Options include... +""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -161,6 +164,7 @@ HELP_OPTIONS = { "RESETCONF": ("RESETCONF PARAM[=VALUE]", HELP_RESETCONF), "SIGNAL": ("SIGNAL SIG", HELP_SIGNAL), "SETEVENTS": ("SETEVENTS [EXTENDED] [EVENTS]", HELP_SETEVENTS), + "USEFEATURE": ("USEFEATURE OPTION", HELP_USEFEATURE), } class InterpretorClosed(Exception): @@ -434,6 +438,11 @@ class ControlInterpretor: lineContent += "%-20s" % entry outputEntry.append((lineContent + "\n", OUTPUT_FORMAT)) + elif arg == "USEFEATURE": + # lists the feature options + featureOptions = torTools.getConn().getInfo("features/names") + if featureOptions: + outputEntry.append((featureOptions + "\n", OUTPUT_FORMAT)) else: # check if this is a configuration option manEntry = torConfig.getConfigDescription(arg)

1 0

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

26 Sep '11

commit 58f79b5354580a956a489dd3254ef76705c23249 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 21:39:53 2011 -0700 Interpretor help for LOADCONF Provides basic usage information and an example. Multi-line controller input is not yet implemented (and probably won't be for the next release) so giving a warning. --- src/util/torInterpretor.py | 19 +++++++++++++++++++ 1 files changed, 19 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index d9f3e69..825e502 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -49,6 +49,8 @@ RESET = CSI % "0" BACKLOG_LIMIT = 100 CONTENT_LIMIT = 20000 +MULTILINE_UNIMPLEMENTED_NOTICE = "Multi-line control options like this are not yet implemented." + GENERAL_HELP = """Interpretor commands include: /help - provides information for interpretor and tor commands/config options /write - saves backlog to a given location @@ -152,6 +154,18 @@ Events include... HELP_USEFEATURE = """Customizes the behavior of the control port. Options include... """ +HELP_SAVECONF = """Writes Tor's current configuration to its torrc.""" + +HELP_LOADCONF = """Reads the given text like it belonged to our torrc. + +Example: + +LOADCONF + # sets our exit policy to just accept ports 80 and 443 + ExitPolicy accept *:80 + ExitPolicy accept *:443 + ExitPolicy reject *:* + .""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -165,6 +179,8 @@ HELP_OPTIONS = { "SIGNAL": ("SIGNAL SIG", HELP_SIGNAL), "SETEVENTS": ("SETEVENTS [EXTENDED] [EVENTS]", HELP_SETEVENTS), "USEFEATURE": ("USEFEATURE OPTION", HELP_USEFEATURE), + "SAVECONF": ("SAVECONF", HELP_SAVECONF), + "LOADCONF": ("LOADCONF", HELP_LOADCONF), } class InterpretorClosed(Exception): @@ -443,6 +459,9 @@ class ControlInterpretor: featureOptions = torTools.getConn().getInfo("features/names") if featureOptions: outputEntry.append((featureOptions + "\n", OUTPUT_FORMAT)) + elif arg in ("LOADCONF"): + # gives a warning that this option isn't yet implemented + outputEntry.append(("\n" + MULTILINE_UNIMPLEMENTED_NOTICE + "\n", ERROR_FORMAT)) else: # check if this is a configuration option manEntry = torConfig.getConfigDescription(arg)

1 0

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

26 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 26 Sep '11

26 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 26 Sep '11

26 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 26 Sep '11

26 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 26 Sep '11

26 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 26 Sep '11

26 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 26 Sep '11

26 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