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

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

19 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/master] fix: uncaught keyboard interrupt exceptions
by atagar＠torproject.org 19 Sep '11

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

19 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/master] Event handling for the interpretor
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit b2d22453d55516c97d1ba3af8f2f218e8450c71a Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 09:59:48 2011 -0700 Event handling for the interpretor Intercepts SETEVENTS requests and provides received events via an "/events [TYPE]" option. --- src/util/torInterpretor.py | 70 ++++++++++++++++++++++++++++++++++++++++--- 1 files changed, 65 insertions(+), 5 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 1f208ba..cb2dcb7 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -10,6 +10,12 @@ import readline import version +# TODO: util should never import from the cli. This is being done as a hack to +# simplify event listening, but we should later move the TorEventObserver into +# the util. + +from cli.logPanel import TorEventObserver + from util import connections, enum, hostnames, torConfig, torTools, uiTools COLOR_PROMPT = True # provides a colored interpretor prompt @@ -47,16 +53,18 @@ RESET = CSI % "0" # limits used for cropping BACKLOG_LIMIT = 100 +EVENTS_LIMIT = 200 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 - /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 + /info - general information for a relay + /find - searches backlog for lines with the given regex + /events - prints events that we've received + /write - saves backlog to a given location + /quit - shuts down the interpretor Tor commands include: GETINFO - queries information from tor @@ -93,6 +101,10 @@ Example: 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_EVENTS = """Provides events that we've received belonging to the given event types. If +no types are specified then this provides all the messages that we've +received.""" + 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.""" @@ -205,6 +217,7 @@ before authenticating to the control port.""" HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), + "EVENTS": ("/events [types]", HELP_EVENTS), "INFO": ("/info [relay fingerprint, nickname, or IP address]", HELP_INFO), "FIND": ("/find PATTERN", HELP_FIND), "QUIT": ("/quit", HELP_QUIT), @@ -428,6 +441,21 @@ class ControlInterpretor: self.backlog = [] # prior requests the user has made self.contents = [] # (msg, format list) tuples for what's been displayed self.writePath = DEFAULT_WRITE_PATH # last location we've saved to + self.eventBuffer = [] # unread event messages + self.loggedEvents = [] # event types that we're listening for + + torTools.getConn().addEventListener(TorEventObserver(self.registerEvent)) + + def registerEvent(self, event): + """ + Adds the event to our buffer so it'll be in '/events' output. + """ + + if event.type in self.loggedEvents: + self.eventBuffer.append(event) + + eventsCrop = len(self.eventBuffer) - EVENTS_LIMIT + if eventsCrop > 0: self.eventBuffer = self.eventBuffer[eventsCrop:] def getBacklog(self): """ @@ -573,6 +601,23 @@ class ControlInterpretor: else: outputEntry.append((line + "\n", OUTPUT_FORMAT + (Attr.BOLD, ))) + def doEvents(self, arg, outputEntry): + """ + Performs the '/events' operation, dumping the events that we've received + belonging to the given types. If no types are specified then this provides + all buffered events. + """ + + bufferedEvents = self.eventBuffer + + # if we have an argument then restrict it to those event types + eventTypes = arg.upper().split() + if eventTypes: + bufferedEvents = [event for event in self.eventBuffer if event.type in eventTypes] + + for event in bufferedEvents: + outputEntry.append((event.getDisplayMessage() + "\n", OUTPUT_FORMAT)) + def doWrite(self, arg, outputEntry): """ Performs the '/write' operation, which attempts to save the backlog to a @@ -803,6 +848,7 @@ class ControlInterpretor: elif cmd == "/help": self.doHelp(arg, outputEntry) elif cmd == "/write": self.doWrite(arg, outputEntry) elif cmd == "/find": self.doFind(arg, outputEntry) + elif cmd == "/events": self.doEvents(arg, outputEntry) elif cmd == "/info": self.doInfo(arg, outputEntry) else: outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement @@ -865,6 +911,20 @@ class ControlInterpretor: conn.setOptions(paramList, isReset) except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) + elif cmd == "SETEVENTS": + self.loggedEvents = arg.split() + allEvents = torTools.getConn().setControllerEvents(self.loggedEvents) + setEvents = set(self.loggedEvents).intersection(allEvents) + + if setEvents: + outputEntry.append(("Successfully set event listening to: %s\n" % ", ".join(setEvents), OUTPUT_FORMAT)) + else: + if not self.loggedEvents: + # we purposefully disabled event listening + outputEntry.append(("Disabled event listening\n", OUTPUT_FORMAT)) + else: + # we tried to set events but they all failed + outputEntry.append(("Unable to set any of the events. Event listening disabled.\n", 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))

1 0

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

19 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/master] Remaining interpretor help options
by atagar＠torproject.org 19 Sep '11

19 Sep '11

commit b96fb574edbd3f8f8542ce04e83b88345fad6867 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 19 09:15:31 2011 -0700 Remaining interpretor help options Basic descriptions for the remaining controller options. This should complete the /help option. --- src/util/torInterpretor.py | 30 ++++++++++++++++++++++++++++++ 1 files changed, 30 insertions(+), 0 deletions(-) diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 3beef9d..1f208ba 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -179,6 +179,29 @@ uses Tor's normal path selection.""" HELP_SETCIRCUITPURPOSE = """Sets the purpose attribute for a circuit.""" +HELP_CLOSECIRCUIT = """Closes the given circuit. If "IfUnused" is included then this only closes +the circuit if it isn't currently being used.""" + +HELP_ATTACHSTREAM = """Attaches a stream with the given built circuit (tor picks one on its own if +CircuitID is zero). If HopNum is given then this hop is used to exit the +circuit, otherwise the last relay is used.""" + +HELP_REDIRECTSTREAM = """Sets the destination for a given stream. This can only be done after a +stream is created but before it's attached to a circuit.""" + +HELP_CLOSESTREAM = """Closes the given stream, the reason being an integer matching a reason as +per section 6.3 of the tor-spec.""" + +HELP_RESOLVE = """Performs IPv4 DNS resolution over tor, doing a reverse lookup instead if +"mode=reverse" is included. This request is processed in the background and +results in a ADDRMAP event with the response.""" + +HELP_TAKEOWNERSHIP = """Instructs Tor to gracefully shut down when this control connection is closed.""" + +HELP_PROTOCOLINFO = """Provides bootstrapping information that a controller might need when first +starting, like Tor's version and controller authentication. This can be done +before authenticating to the control port.""" + HELP_OPTIONS = { "HELP": ("/help [OPTION]", HELP_HELP), "WRITE": ("/write [PATH]", HELP_WRITE), @@ -198,6 +221,13 @@ HELP_OPTIONS = { "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), + "CLOSECIRCUIT": ("CLOSECIRCUIT CircuitID [IfUnused]", HELP_CLOSECIRCUIT), + "ATTACHSTREAM": ("ATTACHSTREAM StreamID CircuitID [HOP=HopNum]", HELP_ATTACHSTREAM), + "REDIRECTSTREAM": ("REDIRECTSTREAM StreamID Address [Port]", HELP_REDIRECTSTREAM), + "CLOSESTREAM": ("CLOSESTREAM StreamID Reason [Flag]", HELP_CLOSESTREAM), + "RESOLVE": ("RESOLVE [mode=reverse] address", HELP_RESOLVE), + "TAKEOWNERSHIP": ("TAKEOWNERSHIP", HELP_TAKEOWNERSHIP), + "PROTOCOLINFO": ("PROTOCOLINFO [ProtocolVersion]", HELP_PROTOCOLINFO), } class InterpretorClosed(Exception):

1 0

[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