- tor-commits - lists.torproject.org

[arm/master] Mirroring TorCtl connection with stem
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit f05b54f10a1c212cd4da4d31934506156cfe4cb2 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 08:43:26 2012 -0800 Mirroring TorCtl connection with stem Arm uses a wrapper for its controller usage. This abstraction is highly convenient for our migration since it means that our wrapper can connect to tor with *both* TorCtl and stem, letting us migrate calls one at a time while keeping arm functional. Changing our wrapper's init() function to require both connection types, and revising everywhere we use it. This breaks test.py and likely breaks the gui, though I'll probably simply drop both of them before the next release. The gui was an experiment, and can be resurrected if someone becomes interested in developing it. --- src/cli/controller.py | 7 +++++- src/cli/headerPanel.py | 30 ++++++++++++++++++++++++---- src/starter.py | 50 ++++++++++++++++++++++++++++++++--------------- src/util/torTools.py | 23 ++++++++++++--------- 4 files changed, 78 insertions(+), 32 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index c1be694..c72375b 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -23,6 +23,7 @@ import cli.graphing.resourceStats import cli.connections.connPanel from TorCtl import TorCtl +from stem.control import Controller from util import connections, conf, enum, hostnames, log, panel, sysTools, torConfig, torTools @@ -555,7 +556,11 @@ class TorManager: raise IOError("authentication cookie '%s' is the wrong size (%i bytes instead of 32)" % (authValue, authCookieSize)) torctlConn.authenticate(authValue) - torTools.getConn().init(torctlConn) + + controller = Controller.from_port(control_port = int(CONFIG["wizard.default"]["Control"])) + controller.authenticate() + + torTools.getConn().init(torctlConn, controller) except Exception, exc: raise IOError("Unable to connect to Tor: %s" % exc) diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index bf8dbdb..50222f1 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -20,6 +20,10 @@ import curses import threading import TorCtl.TorCtl +import stem +import stem.connection + +from stem.control import Controller import starter import cli.popups @@ -134,12 +138,19 @@ class HeaderPanel(panel.Panel, threading.Thread): if key in (ord('n'), ord('N')) and torTools.getConn().isNewnymAvailable(): self.sendNewnym() elif key in (ord('r'), ord('R')) and not self._isTorConnected: - torctlConn = None + torctlConn, controller = None, None allowPortConnection, allowSocketConnection, _ = starter.allowConnectionTypes() if os.path.exists(self._config["startup.interface.socket"]) and allowSocketConnection: - try: torctlConn = torTools.connect_socket(self._config["startup.interface.socket"]) - except IOError, exc: + try: + torctlConn = torTools.connect_socket(self._config["startup.interface.socket"]) + + # TODO: um... what about passwords? + controller = Controller.from_socket_file(self._config["startup.interface.socket"]) + controller.authenticate() + except (IOError, stem.SocketError), exc: + torctlConn, controller = None, None + if not allowPortConnection: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) elif not allowPortConnection: @@ -166,7 +177,16 @@ class HeaderPanel(panel.Panel, threading.Thread): tmpConn.authenticate(authValue) torctlConn = tmpConn + + controller = Controller.from_port(ctlAddr, ctlPort) + + try: + controller.authenticate() + except stem.connection.MissingPassword: + controller.authenticate(authValue) # already got the password above except Exception, exc: + torctlConn, controller = None, None + # attempts to use the wizard port too try: cli.controller.getController().getTorManager().connectManagedInstance() @@ -176,8 +196,8 @@ class HeaderPanel(panel.Panel, threading.Thread): # displays notice for the first failed connection attempt if exc.args: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) - if torctlConn: - torTools.getConn().init(torctlConn) + if torctlConn and controller: + torTools.getConn().init(torctlConn, controller) log.log(log.NOTICE, "Reconnected to Tor's control port") cli.popups.showMsg("Tor reconnected", 1) else: isKeystrokeConsumed = False diff --git a/src/starter.py b/src/starter.py index 40c23f7..7c51aae 100644 --- a/src/starter.py +++ b/src/starter.py @@ -28,9 +28,12 @@ import util.torConfig import util.torInterpretor import util.torTools import util.uiTools + import TorCtl.TorCtl import TorCtl.TorUtil +from stem.control import Controller + LOG_DUMP_PATH = os.path.expanduser("~/.arm/log") DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") CONFIG = {"startup.controlPassword": None, @@ -210,7 +213,7 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i Custom handler for establishing a TorCtl connection. """ - conn = None + conn, controller = None, None try: #conn, authType, authValue = TorCtl.TorCtl.preauth_connect(controlAddr, controlPort) conn, authTypes, authValue = util.torTools.preauth_connect_alt(controlAddr, controlPort) @@ -227,7 +230,7 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i if not passphrase: try: passphrase = getpass.getpass("Controller password: ") - except KeyboardInterrupt: return None + except KeyboardInterrupt: return None, None if TorCtl.TorCtl.AUTH_TYPE.COOKIE in authTypes and authValue[0] != "/": # Connecting to the control port will probably fail if it's using cookie @@ -280,9 +283,16 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i else: conn._authTypes.remove(TorCtl.TorCtl.AUTH_TYPE.COOKIE) conn.authenticate(passphrase) - return conn + + # Damn well everything above this is covered by stem. :P + + controller = Controller.from_port(controlAddr, controlPort) + controller.authenticate(password = passphrase, chroot_path = util.torTools.getConn().getPathPrefix()) + + return conn, controller except Exception, exc: if conn: conn.close() + if controller: controller.close() # attempts to connect with the default wizard address too wizardPort = CONFIG["wizard.default"].get("Control") @@ -295,9 +305,9 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i # connection failure. Otherwise, return the connection result. if controlPort != wizardPort: - connResult = _torCtlConnect(controlAddr, wizardPort) - if connResult != None: return connResult - else: return None # wizard connection attempt, don't print anything + connResult, controller = _torCtlConnect(controlAddr, wizardPort) + if connResult != None: return connResult, controller + else: return None, None # wizard connection attempt, don't print anything if passphrase and str(exc) == "Unable to authenticate: password incorrect": # provide a warning that the provided password didn't work, then try @@ -306,7 +316,8 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i return _torCtlConnect(controlAddr, controlPort) elif printError: print exc - return None + + return None, None def _dumpConfig(): """ @@ -487,24 +498,31 @@ if __name__ == '__main__': # skips attempting to connect by socket or port if the user has given # arguments for connecting to the other. - conn = None + conn, controller = None, None allowPortConnection, allowSocketConnection, allowDetachedStart = allowConnectionTypes() socketPath = param["startup.interface.socket"] if os.path.exists(socketPath) and allowSocketConnection: - try: conn = util.torTools.connect_socket(socketPath) + try: + conn = util.torTools.connect_socket(socketPath) + + # TODO: um... what about passwords? + # https://trac.torproject.org/6881 + + controller = Controller.from_socket_file(socketPath) + controller.authenticate() except IOError, exc: if not allowPortConnection: print "Unable to use socket '%s': %s" % (socketPath, exc) elif not allowPortConnection: print "Socket '%s' doesn't exist" % socketPath - if not conn and allowPortConnection: + if (not conn or not controller) and allowPortConnection: # sets up TorCtl connection, prompting for the passphrase if necessary and # sending problems to stdout if they arise authPassword = config.get("startup.controlPassword", CONFIG["startup.controlPassword"]) incorrectPasswordMsg = "Password found in '%s' was incorrect" % configPath - conn = _torCtlConnect(controlAddr, controlPort, authPassword, incorrectPasswordMsg, not allowDetachedStart) + conn, controller = _torCtlConnect(controlAddr, controlPort, authPassword, incorrectPasswordMsg, not allowDetachedStart) # removing references to the controller password so the memory can be freed # (unfortunately python does allow for direct access to the memory so this @@ -522,19 +540,19 @@ if __name__ == '__main__': if pwLineNum != None: del config.rawContents[i] - if conn == None and not allowDetachedStart: sys.exit(1) + if (conn is None or controller is None) and not allowDetachedStart: sys.exit(1) # initializing the connection may require user input (for the password) # skewing the startup time results so this isn't counted initTime = time.time() - startTime - controller = util.torTools.getConn() + controllerWrapper = util.torTools.getConn() torUser = None - if conn: - controller.init(conn) + if conn and controller: + controllerWrapper.init(conn, controller) # give a notice if tor is running with root - torUser = controller.getMyUser() + torUser = controllerWrapper.getMyUser() if torUser == "root": util.log.log(util.log.NOTICE, TOR_ROOT_NOTICE) diff --git a/src/util/torTools.py b/src/util/torTools.py index a4d49c7..7d742e4 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -579,6 +579,7 @@ class Controller(TorCtl.PostEventListener): def __init__(self): TorCtl.PostEventListener.__init__(self) self.conn = None # None if uninitialized or controller's been closed + self.controller = None self.connLock = threading.RLock() self.eventListeners = [] # instances listening for tor controller events self.torctlListeners = [] # callback functions for TorCtl events @@ -631,26 +632,25 @@ class Controller(TorCtl.PostEventListener): # tracks the number of sequential geoip lookup failures self.geoipFailureCount = 0 - def init(self, conn=None): + def init(self, conn, controller): """ Uses the given TorCtl instance for future operations, notifying listeners about the change. Arguments: - conn - TorCtl instance to be used, if None then a new instance is fetched - via the connect function + conn - TorCtl instance to be used + controller - stem based Controller instance """ - if conn == None: - conn = TorCtl.connect() - - if conn == None: raise ValueError("Unable to initialize TorCtl instance.") - - if conn.is_live() and conn != self.conn: + if conn.is_live() and controller.is_alive() and conn != self.conn: self.connLock.acquire() if self.conn: self.close() # shut down current connection self.conn = conn + + self.controller = controller + log.log(log.INFO, "Stem connected to tor version %s" % self.controller.get_version()) + self.conn.add_event_listener(self) for listener in self.eventListeners: self.conn.add_event_listener(listener) @@ -698,6 +698,9 @@ class Controller(TorCtl.PostEventListener): self.conn.close() self.conn = None + self.controller.close() + self.controller = None + self._status = State.CLOSED self._statusTime = time.time() @@ -719,7 +722,7 @@ class Controller(TorCtl.PostEventListener): result = False if self.conn: - if self.conn.is_live(): result = True + if self.conn.is_live() and self.controller.is_alive(): result = True else: self.close() self.connLock.release()

1 0

[arm/master] Replacing TorCtl event listening with Stem
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit c5661eb247da27af7cc6736a1529a7c800150b89 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 19:19:52 2012 -0800 Replacing TorCtl event listening with Stem Dropping the TORCTL_* runlevel events in favor of stem's. I'm also blending them with arm's with reguard to selection since stem's largely supplanting the logging that arm did. --- src/cli/logPanel.py | 58 ++++++++++++++++++++++++++++++-------------------- 1 files changed, 35 insertions(+), 23 deletions(-) diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index dd22558..b015ef1 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -8,10 +8,13 @@ import re import os import time import curses +import logging import threading from TorCtl import TorCtl +import stem.util.log + import popups from version import VERSION from util import conf, log, panel, sysTools, torTools, uiTools @@ -102,8 +105,7 @@ def expandEvents(eventAbbr): A - all events X - no events DINWE - runlevel and higher - 12345 - arm runlevel and higher (ARM_DEBUG - ARM_ERR) - 67890 - torctl runlevel and higher (TORCTL_DEBUG - TORCTL_ERR) + 12345 - arm/stem runlevel and higher (ARM_DEBUG - ARM_ERR) Raises ValueError with invalid input if any part isn't recognized. Examples: @@ -120,26 +122,27 @@ def expandEvents(eventAbbr): for flag in eventAbbr: if flag == "A": armRunlevels = ["ARM_" + runlevel for runlevel in log.Runlevel.values()] - torctlRunlevels = ["TORCTL_" + runlevel for runlevel in log.Runlevel.values()] - expandedEvents = set(TOR_EVENT_TYPES.values() + armRunlevels + torctlRunlevels + ["UNKNOWN"]) + stemRunlevels = ["STEM_" + runlevel for runlevel in log.Runlevel.values()] + expandedEvents = set(TOR_EVENT_TYPES.values() + armRunlevels + stemRunlevels + ["UNKNOWN"]) break elif flag == "X": expandedEvents = set() break - elif flag in "DINWE1234567890": + elif flag in "DINWE12345": # all events for a runlevel and higher - if flag in "DINWE": typePrefix = "" - elif flag in "12345": typePrefix = "ARM_" - elif flag in "67890": typePrefix = "TORCTL_" - - if flag in "D16": runlevelIndex = 0 - elif flag in "I27": runlevelIndex = 1 - elif flag in "N38": runlevelIndex = 2 - elif flag in "W49": runlevelIndex = 3 - elif flag in "E50": runlevelIndex = 4 + if flag in "D1": runlevelIndex = 0 + elif flag in "I2": runlevelIndex = 1 + elif flag in "N3": runlevelIndex = 2 + elif flag in "W4": runlevelIndex = 3 + elif flag in "E5": runlevelIndex = 4 - runlevelSet = [typePrefix + runlevel for runlevel in log.Runlevel.values()[runlevelIndex:]] - expandedEvents = expandedEvents.union(set(runlevelSet)) + if flag in "DINWE": + runlevelSet = [runlevel for runlevel in log.Runlevel.values()[runlevelIndex:]] + expandedEvents = expandedEvents.union(set(runlevelSet)) + elif flag in "12345": + for prefix in ("ARM_", "STEM_"): + runlevelSet = [prefix + runlevel for runlevel in log.Runlevel.values()[runlevelIndex:]] + expandedEvents = expandedEvents.union(set(runlevelSet)) elif flag == "U": expandedEvents.add("UNKNOWN") elif flag in TOR_EVENT_TYPES: @@ -574,7 +577,7 @@ class TorEventObserver(TorCtl.PostEventListener): def _notify(self, event, msg, color="white"): self.callback(LogEntry(event.arrived_at, event.event_name, msg, color)) -class LogPanel(panel.Panel, threading.Thread): +class LogPanel(panel.Panel, threading.Thread, logging.Handler): """ Listens for and displays tor, arm, and torctl events. This can prepopulate from tor's log file if it exists. @@ -582,6 +585,13 @@ class LogPanel(panel.Panel, threading.Thread): def __init__(self, stdscr, loggedEvents, config=None): panel.Panel.__init__(self, stdscr, "log", 0) + logging.Handler.__init__(self, level = stem.util.log.logging_level(stem.util.log.DEBUG)) + + self.setFormatter(logging.Formatter( + fmt = '%(asctime)s [%(levelname)s] %(message)s', + datefmt = '%m/%d/%Y %H:%M:%S'), + ) + threading.Thread.__init__(self) self.setDaemon(True) @@ -659,7 +669,6 @@ class LogPanel(panel.Panel, threading.Thread): # adds listeners for tor and torctl events conn = torTools.getConn() conn.addEventListener(TorEventObserver(self.registerEvent)) - conn.addTorCtlListener(self._registerTorCtlEvent) conn.addStatusListener(self._resetListener) # opens log file if we'll be saving entries @@ -676,6 +685,13 @@ class LogPanel(panel.Panel, threading.Thread): except (IOError, OSError), exc: log.log(self._config["log.logPanel.logFileWriteFailed"], "Unable to write to log file: %s" % sysTools.getFileErrorMsg(exc)) self.logFile = None + + stem_logger = stem.util.log.get_logger() + stem_logger.addHandler(self) + + def emit(self, record): + eventColor = RUNLEVEL_EVENT_COLOR[record.levelname] + self.registerEvent(LogEntry(int(record.created), "STEM_%s" % record.levelname, record.msg, eventColor)) def reprepopulateEvents(self): """ @@ -772,10 +788,6 @@ class LogPanel(panel.Panel, threading.Thread): eventColor = RUNLEVEL_EVENT_COLOR[level] self.registerEvent(LogEntry(eventTime, "ARM_%s" % level, msg, eventColor)) - def _registerTorCtlEvent(self, level, msg): - eventColor = RUNLEVEL_EVENT_COLOR[level] - self.registerEvent(LogEntry(time.time(), "TORCTL_%s" % level, msg, eventColor)) - def setLoggedEvents(self, eventTypes): """ Sets the event types recognized by the panel. @@ -1256,7 +1268,7 @@ class LogPanel(panel.Panel, threading.Thread): # reverses runlevels and types so they're appended in the right order reversedRunlevels = log.Runlevel.values() reversedRunlevels.reverse() - for prefix in ("TORCTL_", "ARM_", ""): + for prefix in ("STEM_", "ARM_", ""): # blank ending runlevel forces the break condition to be reached at the end for runlevel in reversedRunlevels + [""]: eventType = prefix + runlevel

1 0

[arm/master] Using stem's get_info() method
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 4eea8d3191d5fc933bf452c0f0b4d0f41614e51d Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 19:52:40 2012 -0800 Using stem's get_info() method Stem's get_info() method is very similar to our own, the most notable difference being that it doesn't have a 'suppressExc' argument. Instead if it gets a default then exceptions are suppressed, and if it doesn't then they're raised. This is far more intuitive usage than ours, but means that our callers need to add the 'None' value we were defaulting to before. --- src/cli/configPanel.py | 2 +- src/cli/connections/connEntry.py | 2 +- src/cli/connections/connPanel.py | 2 +- src/cli/controller.py | 2 +- src/cli/graphing/bandwidthStats.py | 16 +++--- src/cli/logPanel.py | 2 +- src/starter.py | 2 +- src/util/torConfig.py | 8 +- src/util/torInterpretor.py | 20 +++--- src/util/torTools.py | 108 +++++++++++------------------------- 10 files changed, 61 insertions(+), 103 deletions(-) diff --git a/src/cli/configPanel.py b/src/cli/configPanel.py index 31118c9..a73f2a8 100644 --- a/src/cli/configPanel.py +++ b/src/cli/configPanel.py @@ -221,7 +221,7 @@ class ConfigPanel(panel.Panel): if self.configType == State.TOR: conn, configOptionLines = torTools.getConn(), [] customOptions = torConfig.getCustomOptions() - configOptionQuery = conn.getInfo("config/names") + configOptionQuery = conn.getInfo("config/names", None) if configOptionQuery: configOptionLines = configOptionQuery.strip().split("\n") diff --git a/src/cli/connections/connEntry.py b/src/cli/connections/connEntry.py index 02f7069..f7f08c3 100644 --- a/src/cli/connections/connEntry.py +++ b/src/cli/connections/connEntry.py @@ -202,7 +202,7 @@ class ConnectionLine(entries.ConnectionPanelLine): # overwrite the local fingerprint with ours conn = torTools.getConn() - self.local.fingerprintOverwrite = conn.getInfo("fingerprint") + self.local.fingerprintOverwrite = conn.getInfo("fingerprint", None) # True if the connection has matched the properties of a client/directory # connection every time we've checked. The criteria we check is... diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index cf7823a..927826b 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -77,7 +77,7 @@ class ConnectionPanel(panel.Panel, threading.Thread): # last day's clients. conn = torTools.getConn() - bridgeClients = conn.getInfo("status/clients-seen") + bridgeClients = conn.getInfo("status/clients-seen", None) if bridgeClients: # Response has a couple arguments... diff --git a/src/cli/controller.py b/src/cli/controller.py index c72375b..e79ca5a 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -510,7 +510,7 @@ class TorManager: conn - controller instance to be checked """ - return conn.getInfo("config-file") == self.getTorrcPath() + return conn.getInfo("config-file", None) == self.getTorrcPath() def startManagedInstance(self): """ diff --git a/src/cli/graphing/bandwidthStats.py b/src/cli/graphing/bandwidthStats.py index 9782d9f..390ad16 100644 --- a/src/cli/graphing/bandwidthStats.py +++ b/src/cli/graphing/bandwidthStats.py @@ -69,11 +69,11 @@ class BandwidthStats(graphPanel.GraphStats): self.initialPrimaryTotal = 0 self.initialSecondaryTotal = 0 - readTotal = conn.getInfo("traffic/read") + readTotal = conn.getInfo("traffic/read", None) if readTotal and readTotal.isdigit(): self.initialPrimaryTotal = int(readTotal) / 1024 # Bytes -> KB - writeTotal = conn.getInfo("traffic/written") + writeTotal = conn.getInfo("traffic/written", None) if writeTotal and writeTotal.isdigit(): self.initialSecondaryTotal = int(writeTotal) / 1024 # Bytes -> KB @@ -94,7 +94,7 @@ class BandwidthStats(graphPanel.GraphStats): self.new_desc_event(None) # updates title params if eventType in (torTools.State.INIT, torTools.State.RESET) and self._config["features.graph.bw.accounting.show"]: - isAccountingEnabled = conn.getInfo('accounting/enabled') == '1' + isAccountingEnabled = conn.getInfo('accounting/enabled', None) == '1' if isAccountingEnabled != self.isAccounting: self.isAccounting = isAccountingEnabled @@ -335,7 +335,7 @@ class BandwidthStats(graphPanel.GraphStats): conn = torTools.getConn() if not conn.isAlive(): return # keep old values - myFingerprint = conn.getInfo("fingerprint") + myFingerprint = conn.getInfo("fingerprint", None) if not self._titleStats or not myFingerprint or (event and myFingerprint in event.idlist): stats = [] bwRate = conn.getMyBandwidthRate() @@ -386,10 +386,10 @@ class BandwidthStats(graphPanel.GraphStats): conn = torTools.getConn() queried = dict([(arg, "") for arg in ACCOUNTING_ARGS]) - queried["status"] = conn.getInfo("accounting/hibernating") + queried["status"] = conn.getInfo("accounting/hibernating", None) # provides a nicely formatted reset time - endInterval = conn.getInfo("accounting/interval-end") + endInterval = conn.getInfo("accounting/interval-end", None) if endInterval: # converts from gmt to local with respect to DST if time.localtime()[8]: tz_offset = time.altzone @@ -408,8 +408,8 @@ class BandwidthStats(graphPanel.GraphStats): queried["resetTime"] = "%i:%02i:%02i:%02i" % (days, hours, minutes, sec) # number of bytes used and in total for the accounting period - used = conn.getInfo("accounting/bytes") - left = conn.getInfo("accounting/bytes-left") + used = conn.getInfo("accounting/bytes", None) + left = conn.getInfo("accounting/bytes-left", None) if used and left: usedComp, leftComp = used.split(" "), left.split(" ") diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index b015ef1..ee7dee1 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -160,7 +160,7 @@ def getMissingEventTypes(): if the GETINFO query fails. """ - torEventTypes = torTools.getConn().getInfo("events/names") + torEventTypes = torTools.getConn().getInfo("events/names", None) if torEventTypes: torEventTypes = torEventTypes.split(" ") diff --git a/src/starter.py b/src/starter.py index 7c51aae..1672059 100644 --- a/src/starter.py +++ b/src/starter.py @@ -346,7 +346,7 @@ def _dumpConfig(): else: armConfigEntry = "Arm Configuration: None" # dumps tor's version and configuration - torConfigEntry = "Tor (%s) Configuration:\n" % conn.getInfo("version") + torConfigEntry = "Tor (%s) Configuration:\n" % conn.getInfo("version", None) for line in conn.getInfo("config-text", "").split("\n"): if not line: continue diff --git a/src/util/torConfig.py b/src/util/torConfig.py index 851ef77..783fa84 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -182,7 +182,7 @@ def loadOptionDescriptions(loadPath = None, checkVersion = True): # Fetches all options available with this tor instance. This isn't # vital, and the validOptions are left empty if the call fails. conn, validOptions = torTools.getConn(), [] - configOptionQuery = conn.getInfo("config/names") + configOptionQuery = conn.getInfo("config/names", None) if configOptionQuery: for line in configOptionQuery.strip().split("\n"): validOptions.append(line[:line.find(" ")].lower()) @@ -341,7 +341,7 @@ def getConfigLocation(): """ conn = torTools.getConn() - configLocation = conn.getInfo("config-file") + configLocation = conn.getInfo("config-file", None) torPid, torPrefix = conn.getMyPid(), conn.getPathPrefix() if not configLocation: raise IOError("unable to query the torrc location") @@ -362,7 +362,7 @@ def getMultilineParameters(): if MULTILINE_PARAM == None: conn, multilineEntries = torTools.getConn(), [] - configOptionQuery = conn.getInfo("config/names") + configOptionQuery = conn.getInfo("config/names", None) if configOptionQuery: for line in configOptionQuery.strip().split("\n"): confOption, confType = line.strip().split(" ", 1) @@ -445,7 +445,7 @@ def saveConf(destination = None, contents = None): # double check that "GETINFO config-text" is unavailable rather than just # giving an empty result - if torTools.getConn().getInfo("config-text") == None: + if torTools.getConn().getInfo("config-text", None) == None: raise IOError("determining the torrc requires Tor version 0.2.2.7") currentLocation = None diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 4fa0dff..d88c137 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -296,7 +296,7 @@ class TorControlCompleter: conn = torTools.getConn() # adds all of the valid GETINFO options - infoOptions = conn.getInfo("info/names") + infoOptions = conn.getInfo("info/names", None) if infoOptions: for line in infoOptions.split("\n"): if " " in line: @@ -315,7 +315,7 @@ class TorControlCompleter: else: self.commands.append("GETINFO ") # adds all of the valid GETCONF / SETCONF / RESETCONF options - confOptions = conn.getInfo("config/names") + confOptions = conn.getInfo("config/names", None) if confOptions: # individual options are '<name> <type>' pairs confEntries = [opt.split(" ", 1)[0] for opt in confOptions.split("\n")] @@ -328,13 +328,13 @@ class TorControlCompleter: self.commands.append("RESETCONF ") # adds all of the valid SETEVENTS options - eventOptions = conn.getInfo("events/names") + eventOptions = conn.getInfo("events/names", None) if eventOptions: 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") + featureOptions = conn.getInfo("features/names", None) if featureOptions: self.commands += ["USEFEATURE %s" % feature for feature in featureOptions.split(" ")] else: self.commands.append("USEFEATURE ") @@ -507,7 +507,7 @@ class ControlInterpretor: if arg == "GETINFO": # if this is the GETINFO option then also list the valid options - infoOptions = torTools.getConn().getInfo("info/names") + infoOptions = torTools.getConn().getInfo("info/names", None) if infoOptions: for line in infoOptions.split("\n"): @@ -524,7 +524,7 @@ class ControlInterpretor: elif arg == "GETCONF": # lists all of the configuration options - confOptions = torTools.getConn().getInfo("config/names") + confOptions = torTools.getConn().getInfo("config/names", None) if confOptions: confEntries = [opt.split(" ", 1)[0] for opt in confOptions.split("\n")] @@ -546,7 +546,7 @@ class ControlInterpretor: outputEntry.append((" - %s\n" % description, OUTPUT_FORMAT)) elif arg == "SETEVENTS": # lists all of the event types - eventOptions = torTools.getConn().getInfo("events/names") + eventOptions = torTools.getConn().getInfo("events/names", None) if eventOptions: eventEntries = eventOptions.split() @@ -561,7 +561,7 @@ class ControlInterpretor: outputEntry.append((lineContent + "\n", OUTPUT_FORMAT)) elif arg == "USEFEATURE": # lists the feature options - featureOptions = torTools.getConn().getInfo("features/names") + featureOptions = torTools.getConn().getInfo("features/names", None) if featureOptions: outputEntry.append((featureOptions + "\n", OUTPUT_FORMAT)) elif arg in ("LOADCONF", "POSTDESCRIPTOR"): @@ -684,7 +684,7 @@ class ControlInterpretor: # if unsuccessful if not arg: # uses our fingerprint if we're a relay, otherwise gives an error - fingerprint = conn.getInfo("fingerprint") + fingerprint = conn.getInfo("fingerprint", None) if not fingerprint: outputEntry.append(("We aren't a relay, no information to provide", ERROR_FORMAT)) @@ -868,7 +868,7 @@ class ControlInterpretor: if cmd == "GETINFO": try: for param in arg.split(): - response = conn.getInfo(param, suppressExc = False) + response = conn.getInfo(param) outputEntry.append((response + "\n", OUTPUT_FORMAT)) except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) diff --git a/src/util/torTools.py b/src/util/torTools.py index 7d742e4..742ea94 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -66,6 +66,8 @@ CACHE_GETINFO_PREFIX_ARGS = ("ip-to-country/", ) # so erring on the side of inclusiveness by using the notice event instead. ADDR_CHANGED_MSG_PREFIX = ("Our IP Address has changed from", "Guessed our IP address as") +UNDEFINED = "<Undefined_ >" + UNKNOWN = "UNKNOWN" # value used by cached information if undefined CONFIG = {"torrc.map": {}, "features.pathPrefix": "", @@ -750,7 +752,7 @@ class Controller(TorCtl.PostEventListener): return result - def getInfo(self, param, default = None, suppressExc = True): + def getInfo(self, param, default = UNDEFINED): """ Queries the control port for the given GETINFO option, providing the default if the response is undefined or fails for any reason (error @@ -758,64 +760,20 @@ class Controller(TorCtl.PostEventListener): Arguments: param - GETINFO option to be queried - default - result if the query fails and exception's suppressed - suppressExc - suppresses lookup errors (returning the default) if true, - otherwise this raises the original exception + default - result if the query fails """ self.connLock.acquire() - isGeoipRequest = param.startswith("ip-to-country/") - - # checks if this is an arg caching covers - isCacheArg = param in CACHE_ARGS - - if not isCacheArg: - for prefix in CACHE_GETINFO_PREFIX_ARGS: - if param.startswith(prefix): - isCacheArg = True - break - - startTime = time.time() - result, raisedExc, isFromCache = default, None, False - if self.isAlive(): - cachedValue = self._cachedParam.get(param) - - if isCacheArg and cachedValue: - result = cachedValue - isFromCache = True - elif isGeoipRequest and self.isGeoipUnavailable(): - # the geoip database aleady looks to be unavailable - abort the request - raisedExc = TorCtl.ErrorReply("Tor geoip database is unavailable.") + try: + if default != UNDEFINED: + return self.controller.get_info(param, default) else: - try: - getInfoVal = self.conn.get_info(param)[param] - if getInfoVal != None: result = getInfoVal - if isGeoipRequest: self.geoipFailureCount = -1 - except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed), exc: - if type(exc) == TorCtl.TorCtlClosed: self.close() - raisedExc = exc - - if isGeoipRequest and not self.geoipFailureCount == -1: - self.geoipFailureCount += 1 - - if self.geoipFailureCount == GEOIP_FAILURE_THRESHOLD: - log.log(CONFIG["log.geoipUnavailable"], "Tor geoip database is unavailable.") - - if isCacheArg and result and not isFromCache: - self._cachedParam[param] = result - - if isFromCache: - msg = "GETINFO %s (cache fetch)" % param - log.log(CONFIG["log.torGetInfoCache"], msg) - else: - msg = "GETINFO %s (runtime: %0.4f)" % (param, time.time() - startTime) - log.log(CONFIG["log.torGetInfo"], msg) - - self.connLock.release() - - if not suppressExc and raisedExc: raise raisedExc - else: return result + return self.controller.get_info(param) + except stem.SocketClosed: + self.close() + finally: + self.connLock.release() def getOption(self, param, default = None, multiple = False, suppressExc = True): """ @@ -1336,7 +1294,7 @@ class Controller(TorCtl.PostEventListener): policyEntries += [policy.strip() for policy in exitPolicy.split(",")] # appends the default exit policy - defaultExitPolicy = self.getInfo("exit-policy/default") + defaultExitPolicy = self.getInfo("exit-policy/default", None) if defaultExitPolicy: policyEntries += defaultExitPolicy.split(",") @@ -1352,7 +1310,7 @@ class Controller(TorCtl.PostEventListener): isPrivateRejected = self.getOption("ExitPolicyRejectPrivate", True) if isPrivateRejected: - myAddress = self.getInfo("address") + myAddress = self.getInfo("address", None) if myAddress: result = ExitPolicy("reject %s" % myAddress, result) result = ExitPolicy("reject private", result) @@ -1378,7 +1336,7 @@ class Controller(TorCtl.PostEventListener): result = None if self.isAlive(): if not relayFingerprint in self._consensusLookupCache: - nsEntry = self.getInfo("ns/id/%s" % relayFingerprint) + nsEntry = self.getInfo("ns/id/%s" % relayFingerprint, None) self._consensusLookupCache[relayFingerprint] = nsEntry result = self._consensusLookupCache[relayFingerprint] @@ -1402,7 +1360,7 @@ class Controller(TorCtl.PostEventListener): result = None if self.isAlive(): if not relayFingerprint in self._descriptorLookupCache: - descEntry = self.getInfo("desc/id/%s" % relayFingerprint) + descEntry = self.getInfo("desc/id/%s" % relayFingerprint, None) self._descriptorLookupCache[relayFingerprint] = descEntry result = self._descriptorLookupCache[relayFingerprint] @@ -1466,7 +1424,7 @@ class Controller(TorCtl.PostEventListener): if self.isAlive(): # query the nickname if it isn't yet cached if not relayFingerprint in self._nicknameLookupCache: - if relayFingerprint == self.getInfo("fingerprint"): + if relayFingerprint == self.getInfo("fingerprint", None): # this is us, simply check the config myNickname = self.getOption("Nickname", "Unnamed") self._nicknameLookupCache[relayFingerprint] = myNickname @@ -1572,9 +1530,9 @@ class Controller(TorCtl.PostEventListener): if self.isAlive(): # query the address if it isn't yet cached if not relayFingerprint in self._addressLookupCache: - if relayFingerprint == self.getInfo("fingerprint"): + if relayFingerprint == self.getInfo("fingerprint", None): # this is us, simply check the config - myAddress = self.getInfo("address") + myAddress = self.getInfo("address", None) myOrPort = self.getOption("ORPort") if myAddress and myOrPort: @@ -1649,7 +1607,7 @@ class Controller(TorCtl.PostEventListener): # "34f7e3b7c563afe76b71b6c52d038d37729aa4da" relayFingerprint = None - consensusEntry = self.getInfo("ns/name/%s" % relayNickname) + consensusEntry = self.getInfo("ns/name/%s" % relayNickname, None) if consensusEntry: encodedFp = consensusEntry.split()[2] decodedFp = (encodedFp + "=").decode('base64').encode('hex') @@ -1757,7 +1715,7 @@ class Controller(TorCtl.PostEventListener): # initial check for event availability, using the 'events/names' GETINFO # option to detect invalid events - validEvents = self.getInfo("events/names") + validEvents = self.getInfo("events/names", None) if validEvents: validEvents = set(validEvents.split()) @@ -1940,7 +1898,7 @@ class Controller(TorCtl.PostEventListener): self._updateHeartbeat() self._consensusLookupCache = {} - myFingerprint = self.getInfo("fingerprint") + myFingerprint = self.getInfo("fingerprint", None) if myFingerprint: for ns in event.nslist: if ns.idhex == myFingerprint: @@ -1980,7 +1938,7 @@ class Controller(TorCtl.PostEventListener): self.connLock.acquire() - myFingerprint = self.getInfo("fingerprint") + myFingerprint = self.getInfo("fingerprint", None) if not myFingerprint or myFingerprint in event.idlist: self._cachedParam["descEntry"] = None self._cachedParam["bwObserved"] = None @@ -2118,9 +2076,9 @@ class Controller(TorCtl.PostEventListener): if isinstance(relayPort, str): relayPort = int(relayPort) # checks if this matches us - if relayAddress == self.getInfo("address"): + if relayAddress == self.getInfo("address", None): if not relayPort or relayPort == self.getOption("ORPort"): - return self.getInfo("fingerprint") + return self.getInfo("fingerprint", None) # if we haven't yet populated the ip -> fingerprint mappings then do so if self._fingerprintMappings == None: @@ -2154,7 +2112,7 @@ class Controller(TorCtl.PostEventListener): # orconn-status has entries of the form: # $33173252B70A50FE3928C7453077936D71E45C52=shiven CONNECTED - orconnResults = self.getInfo("orconn-status") + orconnResults = self.getInfo("orconn-status", None) if orconnResults: for line in orconnResults.split("\n"): self._fingerprintsAttachedCache.append(line[1:line.find("=")]) @@ -2189,7 +2147,7 @@ class Controller(TorCtl.PostEventListener): if not nsCall: raise TorCtl.ErrorReply() # network consensus couldn't be fetched nsEntry = nsCall[0] - descEntry = self.getInfo("desc/id/%s" % entryFingerprint) + descEntry = self.getInfo("desc/id/%s" % entryFingerprint, None) if not descEntry: raise TorCtl.ErrorReply() # relay descriptor couldn't be fetched descLines = descEntry.split("\n") @@ -2233,11 +2191,11 @@ class Controller(TorCtl.PostEventListener): if currentVal == None and (self.isAlive() or key == "pathPrefix"): # still unset - fetch value if key in ("nsEntry", "descEntry"): - myFingerprint = self.getInfo("fingerprint") + myFingerprint = self.getInfo("fingerprint", None) if myFingerprint: queryType = "ns" if key == "nsEntry" else "desc" - queryResult = self.getInfo("%s/id/%s" % (queryType, myFingerprint)) + queryResult = self.getInfo("%s/id/%s" % (queryType, myFingerprint), None) if queryResult: result = queryResult.split("\n") elif key == "bwRate": # effective relayed bandwidth is the minimum of BandwidthRate, @@ -2286,13 +2244,13 @@ class Controller(TorCtl.PostEventListener): result = line[2:].split() break elif key == "pid": - result = self.getInfo("process/pid") + result = self.getInfo("process/pid", None) if not result: result = getPid(int(self.getOption("ControlPort", 9051)), self.getOption("PidFile")) elif key == "user": # provides the empty string if the query fails - queriedUser = self.getInfo("process/user") + queriedUser = self.getInfo("process/user", None) if queriedUser != None and queriedUser != "": result = queriedUser @@ -2315,7 +2273,7 @@ class Controller(TorCtl.PostEventListener): if psResults and len(psResults) >= 2: result = psResults[1].strip() elif key == "fdLimit": # provides -1 if the query fails - queriedLimit = self.getInfo("process/descriptor-limit") + queriedLimit = self.getInfo("process/descriptor-limit", None) if queriedLimit != None and queriedLimit != "-1": result = (int(queriedLimit), False) @@ -2419,7 +2377,7 @@ class Controller(TorCtl.PostEventListener): # just "$<fingerprint>" OR <nickname>. The dolar sign can't be used in # nicknames so this can be used to differentiate. - circStatusResults = self.getInfo("circuit-status") + circStatusResults = self.getInfo("circuit-status", None) if circStatusResults == "": result = [] # we don't have any circuits

1 0

[arm/master] Dropping duplicate geoip failure detection
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit f432d8401a8627ac0ed3d430d70b39465804f956 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 19:57:37 2012 -0800 Dropping duplicate geoip failure detection Stem provides similar detection to what we had for geoip unavailability, so using that. --- armrc.sample | 1 - src/util/torTools.py | 12 ++---------- 2 files changed, 2 insertions(+), 11 deletions(-) diff --git a/armrc.sample b/armrc.sample index c38bcfc..8447134 100644 --- a/armrc.sample +++ b/armrc.sample @@ -313,7 +313,6 @@ log.hostnameCacheTrimmed INFO log.cursesColorSupport INFO log.bsdJailFound INFO log.unknownBsdJailId WARN -log.geoipUnavailable WARN log.stats.failedProcResolution DEBUG log.stats.procResolutionFailover INFO log.stats.failedPsResolution INFO diff --git a/src/util/torTools.py b/src/util/torTools.py index 742ea94..9e9e860 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -79,8 +79,7 @@ CONFIG = {"torrc.map": {}, "log.torSetConf": log.INFO, "log.torPrefixPathInvalid": log.NOTICE, "log.bsdJailFound": log.INFO, - "log.unknownBsdJailId": log.WARN, - "log.geoipUnavailable": log.WARN} + "log.unknownBsdJailId": log.WARN} # events used for controller functionality: # NOTICE - used to detect when tor is shut down @@ -90,10 +89,6 @@ REQ_EVENTS = {"NOTICE": "this will be unable to detect when tor is shut down", "NS": "information related to the consensus will grow stale", "NEWCONSENSUS": "information related to the consensus will grow stale"} -# number of sequential attempts before we decide that the Tor geoip database -# is unavailable -GEOIP_FAILURE_THRESHOLD = 5 - # provides int -> str mappings for torctl event runlevels TORCTL_RUNLEVELS = dict([(val, key) for (key, val) in TorUtil.loglevels.items()]) @@ -630,9 +625,6 @@ class Controller(TorCtl.PostEventListener): # directs TorCtl to notify us of events TorUtil.logger = self TorUtil.loglevel = "DEBUG" - - # tracks the number of sequential geoip lookup failures - self.geoipFailureCount = 0 def init(self, conn, controller): """ @@ -1158,7 +1150,7 @@ class Controller(TorCtl.PostEventListener): false otherwise. """ - return self.geoipFailureCount == GEOIP_FAILURE_THRESHOLD + return self.controller.is_geoip_unavailable() def getMyPid(self): """

1 0

[arm/master] Dropping unused GETINFO caching
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit bd5d2e202c5dc901f1e3ea65d895a261c03c0d37 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 20:02:42 2012 -0800 Dropping unused GETINFO caching Stem has its own GETINFO caching so we can now drop our own. One small difference is that stem does not cache 'GETINFO address', so we're loosing that. That said, we were listening to NOTICE level events to figure out when it was invalidated which was more than a little wrong. --- src/util/torTools.py | 34 ++++------------------------------ 1 files changed, 4 insertions(+), 30 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 9e9e860..80230bf 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -47,25 +47,6 @@ FAILED_EVENTS = set() CONTROLLER = None # singleton Controller instance -# Valid keys for the controller's getInfo cache. This includes static GETINFO -# options (unchangable, even with a SETCONF) and other useful stats -CACHE_ARGS = ("version", "config-file", "exit-policy/default", "fingerprint", - "config/names", "info/names", "features/names", "events/names", - "nsEntry", "descEntry", "address", "bwRate", "bwBurst", - "bwObserved", "bwMeasured", "flags", "pid", "user", "fdLimit", - "pathPrefix", "startTime", "authorities", "circuits", "hsPorts") -CACHE_GETINFO_PREFIX_ARGS = ("ip-to-country/", ) - -# Tor has a couple messages (in or/router.c) for when our ip address changes: -# "Our IP Address has changed from <previous> to <current>; rebuilding -# descriptor (source: <source>)." -# "Guessed our IP address as <current> (source: <source>)." -# -# It would probably be preferable to use the EXTERNAL_ADDRESS event, but I'm -# not quite sure why it's not provided by check_descriptor_ipaddress_changed -# so erring on the side of inclusiveness by using the notice event instead. -ADDR_CHANGED_MSG_PREFIX = ("Our IP Address has changed from", "Guessed our IP address as") - UNDEFINED = "<Undefined_ >" UNKNOWN = "UNKNOWN" # value used by cached information if undefined @@ -614,8 +595,7 @@ class Controller(TorCtl.PostEventListener): # messages. self._pathPrefixLogging = True - # cached parameters for GETINFO and custom getters (None if unset or - # possibly changed) + # cached parameters for custom getters (None if unset or possibly changed) self._cachedParam = {} # cached GETCONF parameters, entries consisting of: @@ -762,8 +742,9 @@ class Controller(TorCtl.PostEventListener): return self.controller.get_info(param, default) else: return self.controller.get_info(param) - except stem.SocketClosed: + except stem.SocketClosed, exc: self.close() + raise exc finally: self.connLock.release() @@ -2011,13 +1992,6 @@ class Controller(TorCtl.PostEventListener): # notifies listeners of TorCtl events for callback in self.torctlListeners: callback(TORCTL_RUNLEVELS[level], msg) - - # if the message is informing us of our ip address changing then clear - # its cached value - for prefix in ADDR_CHANGED_MSG_PREFIX: - if msg.startswith(prefix): - self._cachedParam["address"] = None - break def _updateHeartbeat(self): """ @@ -2157,7 +2131,7 @@ class Controller(TorCtl.PostEventListener): available and otherwise looking it up. Arguments: - key - parameter being queried (from CACHE_ARGS) + key - parameter being queried default - value to be returned if undefined cacheUndefined - caches when values are undefined, avoiding further lookups if true

1 0

[arm/master] Dropping TorCtl event listening backend
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 95460ea527b910d95ffcbd2d038a09a324de78a8 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 20:15:11 2012 -0800 Dropping TorCtl event listening backend Removing listener support for TorCtl events now that the logging panel is no longer using it. This breaks the gui, but as mentioned before I'm planning to drop that. --- src/util/torTools.py | 31 +------------------------------ 1 files changed, 1 insertions(+), 30 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 80230bf..86b7ee9 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -12,7 +12,7 @@ import thread import threading import Queue -from TorCtl import TorCtl, TorUtil +from TorCtl import TorCtl from util import connections, enum, log, procTools, sysTools, uiTools @@ -70,9 +70,6 @@ REQ_EVENTS = {"NOTICE": "this will be unable to detect when tor is shut down", "NS": "information related to the consensus will grow stale", "NEWCONSENSUS": "information related to the consensus will grow stale"} -# provides int -> str mappings for torctl event runlevels -TORCTL_RUNLEVELS = dict([(val, key) for (key, val) in TorUtil.loglevels.items()]) - # ip address ranges substituted by the 'private' keyword PRIVATE_IP_RANGES = ("0.0.0.0/8", "169.254.0.0/16", "127.0.0.0/8", "192.168.0.0/16", "10.0.0.0/8", "172.16.0.0/12") @@ -560,7 +557,6 @@ class Controller(TorCtl.PostEventListener): self.controller = None self.connLock = threading.RLock() self.eventListeners = [] # instances listening for tor controller events - self.torctlListeners = [] # callback functions for TorCtl events self.statusListeners = [] # callback functions for tor's state changes self.controllerEvents = [] # list of successfully set controller events self._fingerprintMappings = None # mappings of ip -> [(port, fingerprint), ...] @@ -601,10 +597,6 @@ class Controller(TorCtl.PostEventListener): # cached GETCONF parameters, entries consisting of: # (option, fetch_type) => value self._cachedConf = {} - - # directs TorCtl to notify us of events - TorUtil.logger = self - TorUtil.loglevel = "DEBUG" def init(self, conn, controller): """ @@ -1609,18 +1601,6 @@ class Controller(TorCtl.PostEventListener): if self.isAlive(): self.conn.add_event_listener(listener) self.connLock.release() - def addTorCtlListener(self, callback): - """ - Directs further TorCtl events to the callback function. Events are composed - of a runlevel and message tuple. - - Arguments: - callback - functor that'll accept the events, expected to be of the form: - myFunction(runlevel, msg) - """ - - self.torctlListeners.append(callback) - def addStatusListener(self, callback): """ Directs further events related to tor's controller status to the callback @@ -1984,15 +1964,6 @@ class Controller(TorCtl.PostEventListener): def unknown_event(self, event): self._updateHeartbeat() - def log(self, level, msg, *args): - """ - Tracks TorCtl events. Ugly hack since TorCtl/TorUtil.py expects a - logging.Logger instance. - """ - - # notifies listeners of TorCtl events - for callback in self.torctlListeners: callback(TORCTL_RUNLEVELS[level], msg) - def _updateHeartbeat(self): """ Called on any event occurance to note the time it occured.

1 0

[arm/master] Adding stem to the .gitignore
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 648f4aff9ea56c02604cf8456a0a900058ae82e6 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 20:25:21 2012 -0800 Adding stem to the .gitignore --- .gitignore | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/.gitignore b/.gitignore index d72262b..180337f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ *.pyc src/TorCtl/ -src/cagraph/ +src/stem/ *.swp

1 0

[arm/master] Setup changes to reflect stem and the gui
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit cb0c846a47eda9014c29d8e4a0cecd9241dedb76 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Dec 11 20:27:11 2012 -0800 Setup changes to reflect stem and the gui Dropping the gui and adding stem to our 'setup.py'. I didn't try a build yet - that'll come later. --- setup.py | 5 +---- 1 files changed, 1 insertions(+), 4 deletions(-) diff --git a/setup.py b/setup.py index 1f5d463..c94ac1f 100644 --- a/setup.py +++ b/setup.py @@ -6,8 +6,6 @@ import tempfile from src.version import VERSION from distutils.core import setup -INCLUDE_CAGRAPH = False - def getResources(dst, sourceDir): """ Provides a list of tuples of the form... @@ -95,9 +93,8 @@ if "install" in sys.argv: # When installing we include a bundled copy of TorCtl. However, when creating # a deb we have a dependency on the python-torctl package instead: # http://packages.debian.org/unstable/main/python-torctl -installPackages = ['arm', 'arm.cli', 'arm.cli.graphing', 'arm.cli.connections', 'arm.cli.menu', 'arm.gui', 'arm.gui.connections', 'arm.gui.graphing', 'arm.util', 'arm.TorCtl'] +installPackages = ['arm', 'arm.cli', 'arm.cli.graphing', 'arm.cli.connections', 'arm.cli.menu', 'arm.util', 'arm.TorCtl', 'arm.stem'] if isDebInstall: installPackages.remove('arm.TorCtl') -if INCLUDE_CAGRAPH: installPackages += ['arm.cagraph', 'arm.cagraph.axis', 'arm.cagraph.series'] setup(name='arm', version=VERSION,

1 0

[arm/master] Dropping getOption()'s suppressExc arg
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 62ab6da737090f9f013b00f606f28ac0f84b7e37 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Dec 12 08:50:04 2012 -0800 Dropping getOption()'s suppressExc arg Like getInfo() we're going to be doing exception suppression by the presence of a default (this is both what stem does, and a more intuitive usage). --- src/cli/connections/connEntry.py | 10 +++--- src/cli/connections/connPanel.py | 2 +- src/cli/controller.py | 2 +- src/cli/graphing/bandwidthStats.py | 4 +- src/cli/headerPanel.py | 6 ++-- src/util/torTools.py | 57 +++++++++++++++++------------------- 6 files changed, 39 insertions(+), 42 deletions(-) diff --git a/src/cli/connections/connEntry.py b/src/cli/connections/connEntry.py index f7f08c3..7650149 100644 --- a/src/cli/connections/connEntry.py +++ b/src/cli/connections/connEntry.py @@ -218,14 +218,14 @@ class ConnectionLine(entries.ConnectionPanelLine): self.appPid = None self.isAppResolving = False - myOrPort = conn.getOption("ORPort") - myDirPort = conn.getOption("DirPort") + myOrPort = conn.getOption("ORPort", None) + myDirPort = conn.getOption("DirPort", None) mySocksPort = conn.getOption("SocksPort", "9050") - myCtlPort = conn.getOption("ControlPort") + myCtlPort = conn.getOption("ControlPort", None) myHiddenServicePorts = conn.getHiddenServicePorts() # the ORListenAddress can overwrite the ORPort - listenAddr = conn.getOption("ORListenAddress") + listenAddr = conn.getOption("ORListenAddress", None) if listenAddr and ":" in listenAddr: myOrPort = listenAddr[listenAddr.find(":") + 1:] @@ -363,7 +363,7 @@ class ConnectionLine(entries.ConnectionPanelLine): # known relay then it might be client traffic conn = torTools.getConn() - if "Guard" in conn.getMyFlags([]) or conn.getOption("BridgeRelay") == "1": + if "Guard" in conn.getMyFlags([]) or conn.getOption("BridgeRelay", None) == "1": allMatches = conn.getRelayFingerprint(self.foreign.getIpAddr(), getAllMatches = True) return allMatches == [] elif myType == Category.EXIT: diff --git a/src/cli/connections/connPanel.py b/src/cli/connections/connPanel.py index 927826b..632669c 100644 --- a/src/cli/connections/connPanel.py +++ b/src/cli/connections/connPanel.py @@ -188,7 +188,7 @@ class ConnectionPanel(panel.Panel, threading.Thread): """ conn = torTools.getConn() - return "Guard" in conn.getMyFlags([]) or conn.getOption("BridgeRelay") == "1" + return "Guard" in conn.getMyFlags([]) or conn.getOption("BridgeRelay", None) == "1" def isExitsAllowed(self): """ diff --git a/src/cli/controller.py b/src/cli/controller.py index e79ca5a..9c3a4eb 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -672,7 +672,7 @@ def startTorMonitor(startTime): # functioning. It'll have circuits, but little else. If this is the case then # notify the user and tell them what they can do to fix it. - if conn.getOption("DisableDebuggerAttachment") == "1": + if conn.getOption("DisableDebuggerAttachment", None) == "1": log.log(log.NOTICE, "Tor is preventing system utilities like netstat and lsof from working. This means that arm can't provide you with connection information. You can change this by adding 'DisableDebuggerAttachment 0' to your torrc and restarting tor. For more information see...\nhttps://trac.torproject.org/3313") connections.getResolver("tor").setPaused(True) else: diff --git a/src/cli/graphing/bandwidthStats.py b/src/cli/graphing/bandwidthStats.py index 390ad16..2b60c7e 100644 --- a/src/cli/graphing/bandwidthStats.py +++ b/src/cli/graphing/bandwidthStats.py @@ -115,7 +115,7 @@ class BandwidthStats(graphPanel.GraphStats): # checks that this is a relay (if ORPort is unset, then skip) conn = torTools.getConn() - orPort = conn.getOption("ORPort") + orPort = conn.getOption("ORPort", None) if orPort == "0": return # gets the uptime (using the same parameters as the header panel to take @@ -140,7 +140,7 @@ class BandwidthStats(graphPanel.GraphStats): return False # get the user's data directory (usually '~/.tor') - dataDir = conn.getOption("DataDirectory") + dataDir = conn.getOption("DataDirectory", None) if not dataDir: msg = PREPOPULATE_FAILURE_MSG % "data directory not found" log.log(self._config["log.graph.bw.prepopulateFailure"], msg) diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index 50222f1..c9541c4 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -510,15 +510,15 @@ class HeaderPanel(panel.Panel, threading.Thread): self.vals["tor/dirPort"] = conn.getOption("DirPort", "0") self.vals["tor/controlPort"] = conn.getOption("ControlPort", "0") self.vals["tor/socketPath"] = conn.getOption("ControlSocket", "") - self.vals["tor/isAuthPassword"] = conn.getOption("HashedControlPassword") != None - self.vals["tor/isAuthCookie"] = conn.getOption("CookieAuthentication") == "1" + self.vals["tor/isAuthPassword"] = conn.getOption("HashedControlPassword", None) != None + self.vals["tor/isAuthCookie"] = conn.getOption("CookieAuthentication", None) == "1" # orport is reported as zero if unset if self.vals["tor/orPort"] == "0": self.vals["tor/orPort"] = "" # overwrite address if ORListenAddress is set (and possibly orPort too) self.vals["tor/orListenAddr"] = "" - listenAddr = conn.getOption("ORListenAddress") + listenAddr = conn.getOption("ORListenAddress", None) if listenAddr: if ":" in listenAddr: # both ip and port overwritten diff --git a/src/util/torTools.py b/src/util/torTools.py index 86b7ee9..464690f 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -723,8 +723,8 @@ class Controller(TorCtl.PostEventListener): response, control port closed, initiated, etc). Arguments: - param - GETINFO option to be queried - default - result if the query fails + param - GETINFO option to be queried + default - result if the query fails """ self.connLock.acquire() @@ -740,7 +740,7 @@ class Controller(TorCtl.PostEventListener): finally: self.connLock.release() - def getOption(self, param, default = None, multiple = False, suppressExc = True): + def getOption(self, param, default = UNDEFINED, multiple = False): """ Queries the control port for the given configuration option, providing the default if the response is undefined or fails for any reason. If multiple @@ -748,12 +748,10 @@ class Controller(TorCtl.PostEventListener): flag is set. Arguments: - param - configuration option to be queried - default - result if the query fails and exception's suppressed - multiple - provides a list with all returned values if true, otherwise - this just provides the first result - suppressExc - suppresses lookup errors (returning the default) if true, - otherwise this raises the original exception + param - configuration option to be queried + default - result if the query fails + multiple - provides a list with all returned values if true, otherwise + this just provides the first result """ fetchType = "list" if multiple else "str" @@ -762,15 +760,15 @@ class Controller(TorCtl.PostEventListener): # This is among the options fetched via a special command. The results # are a set of values that (hopefully) contain the one we were # requesting. - configMappings = self._getOption(CONFIG["torrc.map"][param], default, "map", suppressExc) + configMappings = self._getOption(CONFIG["torrc.map"][param], default, "map") if param in configMappings: if fetchType == "list": return configMappings[param] else: return configMappings[param][0] else: return default else: - return self._getOption(param, default, fetchType, suppressExc) + return self._getOption(param, default, fetchType) - def getOptionMap(self, param, default = None, suppressExc = True): + def getOptionMap(self, param, default = UNDEFINED): """ Queries the control port for the given configuration option, providing back a mapping of config options to a list of the values returned. @@ -792,17 +790,15 @@ class Controller(TorCtl.PostEventListener): single response. Arguments: - param - configuration option to be queried - default - result if the query fails and exception's suppressed - suppressExc - suppresses lookup errors (returning the default) if true, - otherwise this raises the original exception + param - configuration option to be queried + default - result if the query fails """ - return self._getOption(param, default, "map", suppressExc) + return self._getOption(param, default, "map") # TODO: cache isn't updated (or invalidated) during SETCONF events: # https://trac.torproject.org/projects/tor/ticket/1692 - def _getOption(self, param, default, fetchType, suppressExc): + def _getOption(self, param, default, fetchType): if not fetchType in ("str", "list", "map"): msg = "BUG: unrecognized fetchType in torTools._getOption (%s)" % fetchType log.log(log.ERR, msg) @@ -847,7 +843,8 @@ class Controller(TorCtl.PostEventListener): self.connLock.release() - if not suppressExc and raisedExc: raise raisedExc + if raisedExc and default == UNDEFINED: + raise raisedExc elif result == []: return default else: return result @@ -1253,7 +1250,7 @@ class Controller(TorCtl.PostEventListener): result = None if self.isAlive(): - if self.getOption("ORPort"): + if self.getOption("ORPort", None): policyEntries = [] for exitPolicy in self.getOption("ExitPolicy", [], True): policyEntries += [policy.strip() for policy in exitPolicy.split(",")] @@ -1498,7 +1495,7 @@ class Controller(TorCtl.PostEventListener): if relayFingerprint == self.getInfo("fingerprint", None): # this is us, simply check the config myAddress = self.getInfo("address", None) - myOrPort = self.getOption("ORPort") + myOrPort = self.getOption("ORPort", None) if myAddress and myOrPort: self._addressLookupCache[relayFingerprint] = (myAddress, myOrPort) @@ -1813,7 +1810,7 @@ class Controller(TorCtl.PostEventListener): raisedException = None if self.isAlive(): try: - isRelay = self.getOption("ORPort") != None + isRelay = self.getOption("ORPort", None) != None signal = "HALT" if force else "SHUTDOWN" self.conn.send_signal(signal) @@ -2014,7 +2011,7 @@ class Controller(TorCtl.PostEventListener): # checks if this matches us if relayAddress == self.getInfo("address", None): - if not relayPort or relayPort == self.getOption("ORPort"): + if not relayPort or relayPort == self.getOption("ORPort", None): return self.getInfo("fingerprint", None) # if we haven't yet populated the ip -> fingerprint mappings then do so @@ -2137,21 +2134,21 @@ class Controller(TorCtl.PostEventListener): elif key == "bwRate": # effective relayed bandwidth is the minimum of BandwidthRate, # MaxAdvertisedBandwidth, and RelayBandwidthRate (if set) - effectiveRate = int(self.getOption("BandwidthRate")) + effectiveRate = int(self.getOption("BandwidthRate", None)) - relayRate = self.getOption("RelayBandwidthRate") + relayRate = self.getOption("RelayBandwidthRate", None) if relayRate and relayRate != "0": effectiveRate = min(effectiveRate, int(relayRate)) - maxAdvertised = self.getOption("MaxAdvertisedBandwidth") + maxAdvertised = self.getOption("MaxAdvertisedBandwidth", None) if maxAdvertised: effectiveRate = min(effectiveRate, int(maxAdvertised)) result = effectiveRate elif key == "bwBurst": # effective burst (same for BandwidthBurst and RelayBandwidthBurst) - effectiveBurst = int(self.getOption("BandwidthBurst")) + effectiveBurst = int(self.getOption("BandwidthBurst", None)) - relayBurst = self.getOption("RelayBandwidthBurst") + relayBurst = self.getOption("RelayBandwidthBurst", None) if relayBurst and relayBurst != "0": effectiveBurst = min(effectiveBurst, int(relayBurst)) @@ -2184,7 +2181,7 @@ class Controller(TorCtl.PostEventListener): result = self.getInfo("process/pid", None) if not result: - result = getPid(int(self.getOption("ControlPort", 9051)), self.getOption("PidFile")) + result = getPid(int(self.getOption("ControlPort", 9051)), self.getOption("PidFile", None)) elif key == "user": # provides the empty string if the query fails queriedUser = self.getInfo("process/user", None) @@ -2356,7 +2353,7 @@ class Controller(TorCtl.PostEventListener): result.append((int(lineComp[0]), lineComp[1], lineComp[3][8:], tuple(path))) elif key == "hsPorts": result = [] - hsOptions = self.getOptionMap("HiddenServiceOptions") + hsOptions = self.getOptionMap("HiddenServiceOptions", None) if hsOptions and "HiddenServicePort" in hsOptions: for hsEntry in hsOptions["HiddenServicePort"]:

1 0

[arm/master] Using stem's get_conf()
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 7d8f2da72ff46bdfd4e814298b0d46a3c694760c Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Dec 12 09:14:59 2012 -0800 Using stem's get_conf() Dropping our GETCONF implementation in favor of stem's. It handles caching and HiddenService option mapping so this should be a drop-in replacement. --- src/settings.cfg | 7 ---- src/util/torTools.py | 95 +++++++++++--------------------------------------- 2 files changed, 21 insertions(+), 81 deletions(-) diff --git a/src/settings.cfg b/src/settings.cfg index 28c3008..606ae43 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -481,13 +481,6 @@ wizard.description.opt Bridge2 => Fallback bridge used for connecting if the fir wizard.description.opt Bridge3 => Fallback bridge used for connecting if neither of the first two are available. wizard.description.opt Reuse => Duration that circuits will be reused before replacements are made for new connections. It's good to periodically change the route you use, but making circuits takes a fair bit of work so don't set this to be too low. -# some config options are fetched via special values -torrc.map HiddenServiceDir => HiddenServiceOptions -torrc.map HiddenServicePort => HiddenServiceOptions -torrc.map HiddenServiceVersion => HiddenServiceOptions -torrc.map HiddenServiceAuthorizeClient => HiddenServiceOptions -torrc.map HiddenServiceOptions => HiddenServiceOptions - # valid torrc aliases from the _option_abbrevs struct of src/or/config.c # These couldn't be requested via GETCONF (in 0.2.1.19), but I think this has # been fixed. Discussion is in: diff --git a/src/util/torTools.py b/src/util/torTools.py index 464690f..c380679 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -50,8 +50,7 @@ CONTROLLER = None # singleton Controller instance UNDEFINED = "<Undefined_ >" UNKNOWN = "UNKNOWN" # value used by cached information if undefined -CONFIG = {"torrc.map": {}, - "features.pathPrefix": "", +CONFIG = {"features.pathPrefix": "", "log.torCtlPortClosed": log.NOTICE, "log.torGetInfo": log.DEBUG, "log.torGetInfoCache": None, @@ -593,10 +592,6 @@ class Controller(TorCtl.PostEventListener): # cached parameters for custom getters (None if unset or possibly changed) self._cachedParam = {} - - # cached GETCONF parameters, entries consisting of: - # (option, fetch_type) => value - self._cachedConf = {} def init(self, conn, controller): """ @@ -754,19 +749,18 @@ class Controller(TorCtl.PostEventListener): this just provides the first result """ - fetchType = "list" if multiple else "str" + self.connLock.acquire() - if param in CONFIG["torrc.map"]: - # This is among the options fetched via a special command. The results - # are a set of values that (hopefully) contain the one we were - # requesting. - configMappings = self._getOption(CONFIG["torrc.map"][param], default, "map") - if param in configMappings: - if fetchType == "list": return configMappings[param] - else: return configMappings[param][0] - else: return default - else: - return self._getOption(param, default, fetchType) + try: + if default != UNDEFINED: + return self.controller.get_conf(param, default, multiple) + else: + return self.controller.get_conf(param, multiple = multiple) + except stem.SocketClosed, exc: + self.close() + raise exc + finally: + self.connLock.release() def getOptionMap(self, param, default = UNDEFINED): """ @@ -794,59 +788,18 @@ class Controller(TorCtl.PostEventListener): default - result if the query fails """ - return self._getOption(param, default, "map") - - # TODO: cache isn't updated (or invalidated) during SETCONF events: - # https://trac.torproject.org/projects/tor/ticket/1692 - def _getOption(self, param, default, fetchType): - if not fetchType in ("str", "list", "map"): - msg = "BUG: unrecognized fetchType in torTools._getOption (%s)" % fetchType - log.log(log.ERR, msg) - return default - self.connLock.acquire() - startTime, raisedExc, isFromCache = time.time(), None, False - result = {} if fetchType == "map" else [] - if self.isAlive(): - if (param.lower(), fetchType) in self._cachedConf: - isFromCache = True - result = self._cachedConf[(param.lower(), fetchType)] + try: + if default != UNDEFINED: + return self.controller.get_conf_map(param, default) else: - try: - if fetchType == "str": - getConfVal = self.conn.get_option(param)[0][1] - if getConfVal != None: result = getConfVal - else: - for key, value in self.conn.get_option(param): - if value != None: - if fetchType == "list": result.append(value) - elif fetchType == "map": - if key in result: result[key].append(value) - else: result[key] = [value] - except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed), exc: - if type(exc) == TorCtl.TorCtlClosed: self.close() - result, raisedExc = default, exc - - if not isFromCache: - cacheValue = result - if fetchType == "list": cacheValue = list(result) - elif fetchType == "map": cacheValue = dict(result) - self._cachedConf[(param.lower(), fetchType)] = cacheValue - - if isFromCache: - msg = "GETCONF %s (cache fetch)" % param - log.log(CONFIG["log.torGetConfCache"], msg) - else: - msg = "GETCONF %s (runtime: %0.4f)" % (param, time.time() - startTime) - log.log(CONFIG["log.torGetConf"], msg) - - self.connLock.release() - - if raisedExc and default == UNDEFINED: - raise raisedExc - elif result == []: return default - else: return result + return self.controller.get_conf_map(param) + except stem.SocketClosed, exc: + self.close() + raise exc + finally: + self.connLock.release() def setOption(self, param, value = None): """ @@ -904,9 +857,6 @@ class Controller(TorCtl.PostEventListener): for param, _ in paramList: for fetchType in ("str", "list", "map"): entry = (param.lower(), fetchType) - - if entry in self._cachedConf: - del self._cachedConf[entry] # special caches for the exit policy if param.lower() == "exitpolicy": @@ -1742,7 +1692,6 @@ class Controller(TorCtl.PostEventListener): try: self.conn.send_signal("RELOAD") self._cachedParam = {} - self._cachedConf = {} except Exception, exc: # new torrc parameters caused an error (tor's likely shut down) # BUG: this doesn't work - torrc errors still cause TorCtl to crash... :( @@ -1787,7 +1736,6 @@ class Controller(TorCtl.PostEventListener): else: raise IOError("failed silently") self._cachedParam = {} - self._cachedConf = {} except IOError, exc: raisedException = exc @@ -2419,7 +2367,6 @@ class Controller(TorCtl.PostEventListener): if eventType: # resets cached GETINFO and GETCONF parameters self._cachedParam = {} - self._cachedConf = {} # gives a notice that the control port has closed if eventType == State.CLOSED:

1 0