- tor-commits - lists.torproject.org

[arm/master] Interpretor help for MAPADDRESS
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit c3b70bef3e9f85b733d7087963374b58f73b9240 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 07:28:47 2011 -0700 Interpretor help for MAPADDRESS Basic description and the example from the control spec. --- src/util/torInterpretor.py | 6 ++++++ 1 files changed, 6 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 3726517..658b65e 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -166,6 +166,11 @@ Example: ExitPolicy reject *:* .""" +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_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -181,6 +186,7 @@ HELP_OPTIONS = { "USEFEATURE": ("USEFEATURE OPTION", HELP_USEFEATURE), "SAVECONF": ("SAVECONF", HELP_SAVECONF), "LOADCONF": ("LOADCONF", HELP_LOADCONF), + "MAPADDRESS": ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", HELP_MAPADDRESS), } class InterpretorClosed(Exception):

1 0

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

19 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

r25087: {website} updated rpms.wml to include fc15 (website/trunk/docs/en)
by Runa Sandvik 19 Sep '11

19 Sep '11

Author: runa Date: 2011-09-19 07:12:57 +0000 (Mon, 19 Sep 2011) New Revision: 25087 Modified: website/trunk/docs/en/rpms.wml Log: updated rpms.wml to include fc15 Modified: website/trunk/docs/en/rpms.wml =================================================================== --- website/trunk/docs/en/rpms.wml 2011-09-18 15:50:03 UTC (rev 25086) +++ website/trunk/docs/en/rpms.wml 2011-09-19 07:12:57 UTC (rev 25087) @@ -34,7 +34,8 @@ gpgkey=http://deb.torproject.org/torproject.org/rpm/RPM-GPG-KEY-torproject.…</pre> If you wish to track the stable releases of Tor, you should substitute - DISTRIBUTION with one of the following: centos4, centos5, fc13, fc14, suse</p> + DISTRIBUTION with one of the following: centos4, centos5, fc13, + fc14, fc15, suse</p> <p>To track experimental releases, substitute DISTRIBUTION with one of these: centos4-experimental, centos5-experimental, fc13-experimental,

1 0

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

19 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/master] Better handling for QUIT signals
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit e937fc31380a7a4a486ce0807dc1293ca8b151b9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 17 16:54:46 2011 -0700 Better handling for QUIT signals The prompt was naively assuming that the control connection was still alive when handling input, and not properly shutting down the control connection in case of '/quit'. --- src/cli/interpretorPanel.py | 5 ++++- src/util/torInterpretor.py | 24 +++++++++++++++++++++--- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index cc8b496..283c371 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -5,7 +5,7 @@ information, tab completion, and other usability features. import curses -from util import panel, textInput, torInterpretor, uiTools +from util import panel, textInput, torInterpretor, torTools, uiTools USAGE_INFO = "to use this panel press enter" PROMPT_LINE = [torInterpretor.PROMPT, (USAGE_INFO, torInterpretor.USAGE_FORMAT)] @@ -79,6 +79,9 @@ class InterpretorPanel(panel.Panel): try: inputEntry, outputEntry = self.interpretor.handleQuery(input) except torInterpretor.InterpretorClosed: + # Makes our control connection check if its been closed or not + torTools.getConn().isAlive() + isDone = True if isDone: diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 1cc66bd..6781b83 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -595,6 +595,12 @@ class ControlInterpretor: input - user input to be processed """ + conn = torTools.getConn() + + # abort if the control connection has been severed + if not conn.isAlive(): + raise InterpretorClosed("Control connection has been closed") + input = input.strip() # appends new input, cropping if too long @@ -603,7 +609,6 @@ class ControlInterpretor: if backlogCrop > 0: self.backlog = self.backlog[backlogCrop:] inputEntry, outputEntry = [PROMPT], [] - conn = torTools.getConn() # input falls into three general categories: # - interpretor command which starts with a '/' @@ -684,6 +689,9 @@ class ControlInterpretor: try: response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + if cmd == "QUIT": + raise InterpretorClosed("Closing the connection") + for entry in response: # Response entries are tuples with the response code, body, and # extra info. For instance: @@ -692,13 +700,17 @@ class ControlInterpretor: if len(entry) == 3: outputEntry.append((entry[1], OUTPUT_FORMAT)) except Exception, exc: - outputEntry.append((str(exc), ERROR_FORMAT)) + if isinstance(exc, InterpretorClosed): + raise exc + else: + outputEntry.append((str(exc), ERROR_FORMAT)) # converts to lists split on newlines inputLines = _splitOnNewlines(inputEntry) outputLines = _splitOnNewlines(outputEntry) # appends new contents, cropping if too long + # TODO: it would be nice if InterpretorClosed exceptions were added to the content too self.contents += inputLines + outputLines cropLines = len(self.contents) - CONTENT_LIMIT if cropLines > 0: self.contents = self.contents[cropLines:] @@ -745,11 +757,17 @@ def prompt(): try: input = raw_input(prompt) _, outputEntry = interpretor.handleQuery(input) - except: + except Exception, exc: + if isinstance(exc, InterpretorClosed) and str(exc): + print format(str(exc), *ERROR_FORMAT) + # moves cursor to the next line and terminates (most commonly # KeyboardInterrupt and EOFErro) print + torTools.NO_SPAWN = True + torTools.getConn().close() + # stop daemons hostnames.stop()

1 0

[arm/master] fix: fixing mishandling of GETCONF/RESETCONF
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit ba0f67cc882c1d43fe963cded15c4f70b2b9367a Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 19:43:41 2011 -0700 fix: fixing mishandling of GETCONF/RESETCONF Allowing for non-quoted GETCONF values and RESETCONF values by the interpretor (I wrote the previous handling when I didn't have an internet connection so couldn't consult the specs. --- src/util/torInterpretor.py | 26 +++++++++++++++----------- src/util/torTools.py | 16 +++++++++++----- 2 files changed, 26 insertions(+), 16 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 6781b83..2424a29 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -651,8 +651,9 @@ class ControlInterpretor: outputEntry.append((response, OUTPUT_FORMAT)) except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) - elif cmd == "SETCONF": - # arguments can either be '<param>' or '<param>="<value>"' entries + elif cmd == "SETCONF" or cmd == "RESETCONF": + # arguments can either be '<param>', '<param>=<value>', or + # '<param>="<value>"' entries paramList = [] while arg: @@ -662,14 +663,21 @@ class ControlInterpretor: # echos back faithfully rather than being parsed) so leaving this # alone for now. - m = re.match(r'^(\S+)=\"([^"]+)\"', arg) + quotedMatch = re.match(r'^(\S+)=\"([^"]+)\"', arg) + nonquotedMatch = re.match(r'^(\S+)=(\S+)', arg) - if m: + if quotedMatch: # we're dealing with a '<param>="<value>"' entry - param, value = m.groups() + param, value = quotedMatch.groups() paramList.append((param, value)) arg = arg[len(param) + len(value) + 3:].strip() + elif nonquotedMatch: + # we're dealing with a '<param>=<value>' entry + param, value = nonquotedMatch.groups() + + paramList.append((param, value)) + arg = arg[len(param) + len(value) + 1:].strip() else: # starts with just a param param = arg.split()[0] @@ -677,12 +685,8 @@ class ControlInterpretor: 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()]) + isReset = cmd == "RESETCONF" + conn.setOptions(paramList, isReset) except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) else: diff --git a/src/util/torTools.py b/src/util/torTools.py index fcd8247..f6d9d86 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -728,8 +728,8 @@ class Controller(TorCtl.PostEventListener): 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 no value is provided then this resets the - configuration option. + if it fails to be set. If no value is provided then this sets the option to + 0 or NULL. Arguments: param - configuration option to be set @@ -739,16 +739,19 @@ class Controller(TorCtl.PostEventListener): self.setOptions(((param, value),)) - def setOptions(self, paramList): + def setOptions(self, paramList, isReset = False): """ 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 + - None to set the value to 0 or NULL Arguments: paramList - list of parameter/value tuple pairs + isReset - issues a RESETCONF instead of SETCONF, causing any None + mappings to revert the parameter to its default rather than + set it to 0 or NULL """ self.connLock.acquire() @@ -769,7 +772,10 @@ class Controller(TorCtl.PostEventListener): startTime, raisedExc = time.time(), None if self.isAlive(): try: - self.conn.sendAndRecv("SETCONF %s\r\n" % setConfStr) + if isReset: + self.conn.sendAndRecv("RESETCONF %s\r\n" % setConfStr) + else: + self.conn.sendAndRecv("SETCONF %s\r\n" % setConfStr) # flushing cached values (needed until we can detect SETCONF calls) for param, _ in paramList:

1 0

[arm/master] Allowing for multiple GETINFO arguments
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit 2add4d9eb8fc53166a0d62a3881620ea1dcc22cd Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 20:20:45 2011 -0700 Allowing for multiple GETINFO arguments The control spec allows for multiple GETINFO arguments so respecting this, though including a newline between results so it's actually readable (yea, it's not what the control-spec says but I'm just a crazy rebel like that). --- src/util/torInterpretor.py | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index f0d0639..963a465 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -658,8 +658,9 @@ class ControlInterpretor: if cmd == "GETINFO": try: - response = conn.getInfo(arg, suppressExc = False) - outputEntry.append((response, OUTPUT_FORMAT)) + for param in arg.split(): + response = conn.getInfo(param, suppressExc = False) + outputEntry.append((response + "\n", OUTPUT_FORMAT)) except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) elif cmd == "SETCONF" or cmd == "RESETCONF":

1 0

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

19 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/master] Interpretor help for the SIGNAL command
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit 2035fdf636b0dcaab3f261d9cde7aee8e9724ed2 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 20:59:46 2011 -0700 Interpretor help for the SIGNAL command General usage information and descriptions for all of the signals. --- src/util/torInterpretor.py | 20 ++++++++++++++++++++ 1 files changed, 20 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index ff02a8b..c2579ae 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -124,6 +124,20 @@ Examples: * Uses the default exit policy and sets our nickname to be 'Goomba' RESETCONF ExitPolicy Nickname=Goomba""" +HELP_SIGNAL = """Issues a signal that tells the tor process to reload its torrc, dump its +stats, halt, etc. +""" + +SIGNAL_DESCRIPTIONS = ( + ("RELOAD / HUP", "reload our torrc"), + ("SHUTDOWN / INT", "gracefully shut down, waiting 30 seconds if we're a relay"), + ("DUMP / USR1", "logs information about open connections and circuits"), + ("DEBUG / USR2", "makes us log at the DEBUG runlevel"), + ("HALT / TERM", "immediately shut down"), + ("CLEARDNSCACHE", "clears any cached DNS results"), + ("NEWNYM", "clears the DNS cache and uses new circuits for future connections") +) + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -134,6 +148,7 @@ HELP_OPTIONS = { "GETCONF": ("GETCONF OPTION", HELP_GETCONF), "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF), "RESETCONF": ("RESETCONF PARAM[=VALUE]", HELP_RESETCONF), + "SIGNAL": ("SIGNAL SIG", HELP_SIGNAL), } class InterpretorClosed(Exception): @@ -387,6 +402,11 @@ class ControlInterpretor: outputEntry.append((lineContent + "\n", OUTPUT_FORMAT)) outputEntry.append(("For more information use '/help [CONFIG OPTION]'.", OUTPUT_FORMAT + (Attr.BOLD, ))) + elif arg == "SIGNAL": + # lists descriptions for all of the signals + for signal, description in SIGNAL_DESCRIPTIONS: + outputEntry.append(("%-15s" % signal, OUTPUT_FORMAT + (Attr.BOLD, ))) + outputEntry.append((" - %s\n" % description, OUTPUT_FORMAT)) else: # check if this is a configuration option manEntry = torConfig.getConfigDescription(arg)

1 0

[arm/master] Interpretor help for RESETCONF
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit 1e638c14399a90234534499475d3848d5b7d9573 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 18 20:36:55 2011 -0700 Interpretor help for RESETCONF Similiar to GETCONF - basic usage 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 963a465..ff02a8b 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -107,13 +107,23 @@ HELP_GETCONF = """Provides the current value for a given configuration value. Op 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: +Examples: * 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_RESETCONF = """Reverts the given configuration options to their default values. If a value +is provided then this behaves in the same way as SETCONF. + +Examples: + * Returns both of our accounting parameters to their defaults + RESETCONF AccountingMax AccountingStart + + * Uses the default exit policy and sets our nickname to be 'Goomba' + RESETCONF ExitPolicy Nickname=Goomba""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -122,7 +132,8 @@ HELP_OPTIONS = { "QUIT": ("/quit", HELP_QUIT), "GETINFO": ("GETINFO OPTION", HELP_GETINFO), "GETCONF": ("GETCONF OPTION", HELP_GETCONF), - "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF) + "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF), + "RESETCONF": ("RESETCONF PARAM[=VALUE]", HELP_RESETCONF), } class InterpretorClosed(Exception):

1 0