- tor-commits - lists.torproject.org

[arm/master] Dropping TorCtl connection hacks
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 7d7a9a4319e580d77e4d43246482f3b933530c33 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 19:54:13 2012 -0800 Dropping TorCtl connection hacks Over a year back I realized that waiting on Mike to merge my TorCtl patches was a bad idea, and started baking the fixes into arm. Ages later the tickets are still languishing so guess that was a good call. TorCtl usage has been dropped so I no longer need to work around these issues. --- src/util/torTools.py | 204 +------------------------------------------------- 1 files changed, 1 insertions(+), 203 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 0357b32..d2f1b0c 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -1,6 +1,6 @@ """ Helper for working with an active tor process. This both provides a wrapper for -accessing TorCtl and notifications of state changes to subscribers. +accessing stem and notifications of state changes to subscribers. """ import os @@ -74,27 +74,6 @@ IS_STARTUP_SIGNAL = True def loadConfig(config): config.update(CONFIG) -# TODO: temporary code until this is added to torctl as part of... -# https://trac.torproject.org/projects/tor/ticket/3638 -def connect_socket(socketPath="/var/run/tor/control", ConnClass=TorCtl.Connection): - """ - Connects to a unix domain socket available to controllers (set via tor's - ControlSocket option). This raises an IOError if unable to do so. - - Arguments: - socketPath - path of the socket to attach to - ConnClass - connection type to instantiate - """ - - try: - s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) - s.connect(socketPath) - conn = ConnClass(s) - conn.authenticate("") - return conn - except Exception, exc: - raise IOError(exc) - def getPid(controlPort=9051, pidFilePath=None): """ Attempts to determine the process id for a running tor process, using the @@ -283,187 +262,6 @@ def isTorRunning(): return False -# ============================================================ -# TODO: Remove when TorCtl can handle multiple auth methods -# https://trac.torproject.org/projects/tor/ticket/3958 -# -# The following is a hacked up version of the fix in that ticket. -# ============================================================ - -class FixedConnection(TorCtl.Connection): - def __init__(self, sock): - TorCtl.Connection.__init__(self, sock) - self._authTypes = [] - - def get_auth_types(self): - """ - Provides the list of authentication types used for the control port. Each - are members of the AUTH_TYPE enumeration and return results will always - have at least one result. This raises an IOError if the query to - PROTOCOLINFO fails. - """ - - if not self._authTypes: - # check PROTOCOLINFO for authentication type - try: - authInfo = self.sendAndRecv("PROTOCOLINFO\r\n")[1][1] - except Exception, exc: - if exc.message: excMsg = ": %s" % exc - else: excMsg = "" - raise IOError("Unable to query PROTOCOLINFO for the authentication type%s" % excMsg) - - # parses the METHODS and COOKIEFILE entries for details we need to - # authenticate - - authTypes, cookiePath = [], None - - for entry in authInfo.split(): - if entry.startswith("METHODS="): - # Comma separated list of our authentication types. If we have - # multiple then any of them will work. - - methodsEntry = entry[8:] - - for authEntry in methodsEntry.split(","): - if authEntry == "NULL": - authTypes.append(TorCtl.AUTH_TYPE.NONE) - elif authEntry == "HASHEDPASSWORD": - authTypes.append(TorCtl.AUTH_TYPE.PASSWORD) - elif authEntry == "COOKIE": - authTypes.append(TorCtl.AUTH_TYPE.COOKIE) - else: - # not of a recognized authentication type (new addition to the - # control-spec?) - - log.log(log.INFO, "Unrecognized authentication type: %s" % authEntry) - elif entry.startswith("COOKIEFILE=\"") and entry.endswith("\""): - # Quoted path of the authentication cookie. This only exists if we're - # using cookie auth and, of course, doesn't account for chroot. - - cookiePath = entry[12:-1] - - # There should always be a AUTH METHODS entry. If we didn't then throw a - # wobbly. - - if not authTypes: - raise IOError("PROTOCOLINFO response didn't include any authentication methods") - - self._authType = authTypes[0] - self._authTypes = authTypes - self._cookiePath = cookiePath - - return list(self._authTypes) - - def authenticate(self, secret=""): - """ - Authenticates to the control port. If an issue arises this raises either of - the following: - - IOError for failures in reading an authentication cookie or querying - PROTOCOLINFO. - - TorCtl.ErrorReply for authentication failures or if the secret is - undefined when using password authentication - """ - - # fetches authentication type and cookie path if still unloaded - if not self._authTypes: self.get_auth_types() - - # validates input - if TorCtl.AUTH_TYPE.PASSWORD in self._authTypes and secret == "": - raise TorCtl.ErrorReply("Unable to authenticate: no passphrase provided") - - # tries each of our authentication methods, throwing the last exception if - # they all fail - - raisedExc = None - for authMethod in self._authTypes: - authCookie = None - try: - if authMethod == TorCtl.AUTH_TYPE.NONE: - self.authenticate_password("") - elif authMethod == TorCtl.AUTH_TYPE.PASSWORD: - self.authenticate_password(secret) - else: - authCookie = open(self._cookiePath, "r") - self.authenticate_cookie(authCookie) - authCookie.close() - - # Did the above raise an exception? No? Cool, we're done. - return - except TorCtl.ErrorReply, exc: - if authCookie: authCookie.close() - issue = str(exc) - - # simplifies message if the wrong credentials were provided (common - # mistake) - if issue.startswith("515 Authentication failed: "): - if issue[27:].startswith("Password did not match"): - issue = "password incorrect" - elif issue[27:] == "Wrong length on authentication cookie.": - issue = "cookie value incorrect" - - raisedExc = TorCtl.ErrorReply("Unable to authenticate: %s" % issue) - except IOError, exc: - if authCookie: authCookie.close() - issue = None - - # cleaner message for common errors - if str(exc).startswith("[Errno 13] Permission denied"): - issue = "permission denied" - elif str(exc).startswith("[Errno 2] No such file or directory"): - issue = "file doesn't exist" - - # if problem's recognized give concise message, otherwise print exception - # string - if issue: raisedExc = IOError("Failed to read authentication cookie (%s): %s" % (issue, self._cookiePath)) - else: raisedExc = IOError("Failed to read authentication cookie: %s" % exc) - - # if we got to this point then we failed to authenticate and should have a - # raisedExc - - if raisedExc: raise raisedExc - -def preauth_connect_alt(controlAddr="127.0.0.1", controlPort=9051, - ConnClass=FixedConnection): - """ - Provides an uninitiated torctl connection components for the control port, - returning a tuple of the form... - (torctl connection, authTypes, authValue) - - The authValue corresponds to the cookie path if using an authentication - cookie, otherwise this is the empty string. This raises an IOError in case - of failure. - - Arguments: - controlAddr - ip address belonging to the controller - controlPort - port belonging to the controller - ConnClass - connection type to instantiate - """ - - conn = None - try: - s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) - s.connect((controlAddr, controlPort)) - conn = ConnClass(s) - authTypes, authValue = conn.get_auth_types(), "" - - if TorCtl.AUTH_TYPE.COOKIE in authTypes: - authValue = conn.get_auth_cookie_path() - - return (conn, authTypes, authValue) - except socket.error, exc: - if conn: conn.close() - - if "Connection refused" in exc.args: - # most common case - tor control port isn't available - raise IOError("Connection refused. Is the ControlPort enabled?") - - raise IOError("Failed to establish socket: %s" % exc) - except Exception, exc: - if conn: conn.close() - raise IOError(exc) - -# ============================================================ - def getConn(): """ Singleton constructor for a Controller. Be aware that this starts as being

1 0

[arm/master] Dropping the TorCtl connection completely
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 2cea89cad359352ff2a78988e5647a728516f65f Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 19:46:49 2012 -0800 Dropping the TorCtl connection completely Removing the TorCtl connection from arm. Barring some lingering imports we should now be able to drop the library from arm. Yay! --- src/cli/controller.py | 27 +++-------- src/cli/headerPanel.py | 27 ++-------- src/starter.py | 122 ++++++++++------------------------------------- src/util/torTools.py | 29 ++++++------ 4 files changed, 53 insertions(+), 152 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 9c3a4eb..f01ef8a 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -543,26 +543,13 @@ class TorManager: unsuccessful. """ - torctlConn, authType, authValue = TorCtl.preauth_connect(controlPort = int(CONFIG["wizard.default"]["Control"])) - - if not torctlConn: - msg = "Unable to start tor, try running \"tor -f %s\" to see the error output" % self.getTorrcPath() - raise IOError(msg) - - if authType == TorCtl.AUTH_TYPE.COOKIE: - try: - authCookieSize = os.path.getsize(authValue) - if authCookieSize != 32: - raise IOError("authentication cookie '%s' is the wrong size (%i bytes instead of 32)" % (authValue, authCookieSize)) - - torctlConn.authenticate(authValue) - - 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) + try: + controller = Controller.from_port(control_port = int(CONFIG["wizard.default"]["Control"])) + controller.authenticate() + + torTools.getConn().init(controller) + except Exception, exc: + raise IOError("Unable to connect to Tor: %s" % exc) def shutdownDaemons(): """ diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index c9541c4..ce43e06 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -138,25 +138,23 @@ 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, controller = None, None + controller = 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"]) - # 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 + controller = None if not allowPortConnection: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) elif not allowPortConnection: cli.popups.showMsg("Unable to reconnect (socket '%s' doesn't exist)" % self._config["startup.interface.socket"], 3) - if not torctlConn and allowPortConnection: + if not controller and allowPortConnection: # TODO: This has diverged from starter.py's connection, for instance it # doesn't account for relative cookie paths or multiple authentication # methods. We can't use the starter.py's connection function directly @@ -165,19 +163,6 @@ class HeaderPanel(panel.Panel, threading.Thread): try: ctlAddr, ctlPort = self._config["startup.interface.ipAddress"], self._config["startup.interface.port"] - tmpConn, authType, authValue = TorCtl.TorCtl.preauth_connect(ctlAddr, ctlPort) - - if authType == TorCtl.TorCtl.AUTH_TYPE.PASSWORD: - authValue = cli.popups.inputPrompt("Controller Password: ") - if not authValue: raise IOError() # cancel reconnection - elif authType == TorCtl.TorCtl.AUTH_TYPE.COOKIE: - authCookieSize = os.path.getsize(authValue) - if authCookieSize != 32: - raise IOError("authentication cookie '%s' is the wrong size (%i bytes instead of 32)" % (authValue, authCookieSize)) - - tmpConn.authenticate(authValue) - torctlConn = tmpConn - controller = Controller.from_port(ctlAddr, ctlPort) try: @@ -185,7 +170,7 @@ class HeaderPanel(panel.Panel, threading.Thread): except stem.connection.MissingPassword: controller.authenticate(authValue) # already got the password above except Exception, exc: - torctlConn, controller = None, None + controller = None # attempts to use the wizard port too try: @@ -196,8 +181,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 and controller: - torTools.getConn().init(torctlConn, controller) + if controller: + torTools.getConn().init(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 8b2bbb3..01a6086 100644 --- a/src/starter.py +++ b/src/starter.py @@ -29,10 +29,8 @@ import util.torInterpretor import util.torTools import util.uiTools -import TorCtl.TorCtl -import TorCtl.TorUtil - from stem.control import Controller +import stem.connection LOG_DUMP_PATH = os.path.expanduser("~/.arm/log") DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") @@ -207,90 +205,27 @@ def _loadConfigurationDescriptions(pathPrefix): msg = DESC_INTERNAL_LOAD_FAILED_MSG % util.sysTools.getFileErrorMsg(exc) util.log.log(CONFIG["log.configDescriptions.internalLoadFailed"], msg) -def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, incorrectPasswordMsg="", printError=True): +def _getController(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, incorrectPasswordMsg="", printError=True): """ - Custom handler for establishing a TorCtl connection. + Custom handler for establishing a stem connection (... needs an overhaul). """ - conn, controller = None, None + controller = None try: - #conn, authType, authValue = TorCtl.TorCtl.preauth_connect(controlAddr, controlPort) - conn, authTypes, authValue = util.torTools.preauth_connect_alt(controlAddr, controlPort) - - if TorCtl.TorCtl.AUTH_TYPE.PASSWORD in authTypes: - # password authentication, promting for the password if it wasn't provided - # - # TODO: When handling multi-auth we should try to authenticate via the - # cookie first, then fall back to prompting the user for their password. - # With the stack of fixes and hacks we have here jerry-rigging that in - # without trying cookie auth twice will be a pita so leaving this alone - # for now. Stem will handle most of this transparently, letting us handle - # this much more elegantly. - - if not passphrase: - try: passphrase = getpass.getpass("Controller password: ") - 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 - # authentication and the cookie path is relative (unfortunately this is - # the case for TBB). This is discussed in: - # https://trac.torproject.org/projects/tor/ticket/1101 - # - # This is best effort. If we can't expand the path then it's still - # attempted since we might be running in tor's pwd. - - torPid = util.torTools.getPid(controlPort) - if torPid: - try: conn._cookiePath = util.sysTools.expandRelativePath(authValue, torPid) - except IOError: pass + chroot = util.torTools.getConn().getPathPrefix() + controller = Controller.from_port(controlAddr, controlPort) - # appends the path prefix if it's set - if TorCtl.TorCtl.AUTH_TYPE.COOKIE in authTypes: - pathPrefix = util.torTools.getConn().getPathPrefix() - - # The os.path.join function is kinda stupid. If given an absolute path - # with the second argument then it will swallow the prefix. Ie... - # os.path.join("/tmp", "/foo") => "/foo" - - if pathPrefix: - pathSuffix = conn._cookiePath - if pathSuffix.startswith("/"): pathSuffix = pathSuffix[1:] - - conn._cookiePath = os.path.join(pathPrefix, pathSuffix) - - # Abort if the file isn't 32 bytes long. This is to avoid exposing - # arbitrary file content to the port. - # - # Without this a malicious socket could, for instance, claim that - # '~/.bash_history' or '~/.ssh/id_rsa' was its authentication cookie to - # trick us into reading it for them with our current permissions. - # - # https://trac.torproject.org/projects/tor/ticket/4305 - + try: + controller.authenticate(password = passphrase, chroot_path = chroot) + except stem.connection.MissingPassword: try: - authCookieSize = os.path.getsize(conn._cookiePath) - if authCookieSize != 32: - raise IOError("authentication cookie '%s' is the wrong size (%i bytes instead of 32)" % (conn._cookiePath, authCookieSize)) - except Exception, exc: - # if the above fails then either... - # - raise an exception if cookie auth is the only method we have to - # authenticate - # - suppress the exception and try the other connection methods if we - # have alternatives - if len(authTypes) == 1: raise exc - else: conn._authTypes.remove(TorCtl.TorCtl.AUTH_TYPE.COOKIE) - - conn.authenticate(passphrase) - - # Damn well everything above this is covered by stem. :P + passphrase = getpass.getpass("Controller password: ") + controller.authenticate(password = passphrase, chroot_path = chroot) + except: + return None - controller = Controller.from_port(controlAddr, controlPort) - controller.authenticate(password = passphrase, chroot_path = util.torTools.getConn().getPathPrefix()) - - return conn, controller + return controller except Exception, exc: - if conn: conn.close() if controller: controller.close() # attempts to connect with the default wizard address too @@ -304,19 +239,19 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i # connection failure. Otherwise, return the connection result. if controlPort != wizardPort: - connResult, controller = _torCtlConnect(controlAddr, wizardPort) - if connResult != None: return connResult, controller - else: return None, None # wizard connection attempt, don't print anything + controller = _getController(controlAddr, wizardPort) + if controller != None: return controller + else: return 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 # again prompting for the user to enter it print incorrectPasswordMsg - return _torCtlConnect(controlAddr, controlPort) + return _getController(controlAddr, controlPort) elif printError: print exc - return None, None + return None def _dumpConfig(): """ @@ -488,21 +423,16 @@ if __name__ == '__main__': print "Unrecognized event flag: %s" % flag sys.exit() - # temporarily disables TorCtl logging to prevent issues from going to stdout while starting - TorCtl.TorUtil.loglevel = "NONE" - # By default attempts to connect using the control socket if it exists. This # skips attempting to connect by socket or port if the user has given # arguments for connecting to the other. - conn, controller = None, None + controller = None allowPortConnection, allowSocketConnection, allowDetachedStart = allowConnectionTypes() socketPath = param["startup.interface.socket"] if os.path.exists(socketPath) and allowSocketConnection: try: - conn = util.torTools.connect_socket(socketPath) - # TODO: um... what about passwords? # https://trac.torproject.org/6881 @@ -514,12 +444,12 @@ if __name__ == '__main__': elif not allowPortConnection: print "Socket '%s' doesn't exist" % socketPath - if (not conn or not controller) and allowPortConnection: - # sets up TorCtl connection, prompting for the passphrase if necessary and + if not controller and allowPortConnection: + # sets up stem 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, controller = _torCtlConnect(controlAddr, controlPort, authPassword, incorrectPasswordMsg, not allowDetachedStart) + controller = _getController(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 @@ -537,7 +467,7 @@ if __name__ == '__main__': if pwLineNum != None: del config.rawContents[i] - if (conn is None or controller is None) and not allowDetachedStart: sys.exit(1) + if 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 @@ -545,8 +475,8 @@ if __name__ == '__main__': controllerWrapper = util.torTools.getConn() torUser = None - if conn and controller: - controllerWrapper.init(conn, controller) + if controller: + controllerWrapper.init(controller) # give a notice if tor is running with root torUser = controllerWrapper.getMyUser() diff --git a/src/util/torTools.py b/src/util/torTools.py index 5ac29ea..0357b32 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -483,7 +483,6 @@ 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.statusListeners = [] # callback functions for tor's state changes @@ -522,25 +521,22 @@ class Controller(TorCtl.PostEventListener): # cached parameters for custom getters (None if unset or possibly changed) self._cachedParam = {} - def init(self, conn, controller): + def init(self, controller): """ Uses the given TorCtl instance for future operations, notifying listeners about the change. Arguments: - conn - TorCtl instance to be used controller - stem based Controller instance """ # TODO: We should reuse our controller instance so event listeners will be # re-attached. This is a point of regression until we do... :( - if conn.is_live() and controller.is_alive() and conn != self.conn: + if controller.is_alive() and controller != self.controller: self.connLock.acquire() - if self.conn: self.close() # shut down current connection - self.conn = conn - + if self.controller: self.close() # shut down current connection self.controller = controller log.log(log.INFO, "Stem connected to tor version %s" % self.controller.get_version()) @@ -583,10 +579,7 @@ class Controller(TorCtl.PostEventListener): """ self.connLock.acquire() - if self.conn: - self.conn.close() - self.conn = None - + if self.controller: self.controller.close() self.controller = None @@ -610,8 +603,8 @@ class Controller(TorCtl.PostEventListener): self.connLock.acquire() result = False - if self.conn: - if self.conn.is_live() and self.controller.is_alive(): result = True + if self.controller: + if self.controller.is_alive(): result = True else: self.close() self.connLock.release() @@ -622,7 +615,10 @@ class Controller(TorCtl.PostEventListener): Provides the time of the last registered tor message. """ - return self.controller.get_latest_heartbeat() + if self.isAlive(): + return self.controller.get_latest_heartbeat() + else: + return 0 def getInfo(self, param, default = UNDEFINED): """ @@ -912,7 +908,10 @@ class Controller(TorCtl.PostEventListener): false otherwise. """ - return self.controller.is_geoip_unavailable() + if self.isAlive(): + return self.controller.is_geoip_unavailable() + else: + return False def getMyPid(self): """

1 0

[arm/master] Dropping getTorCtl()
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 7591d4ad2350cd42de1e452c0951e8072241d1c9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 14:12:25 2012 -0800 Dropping getTorCtl() Dropping the method that allowed for raw TorCtl usage. We were only using this at a couple places: to make SAVECONF calls and for the interpretor. The interpretor still needs raw controller access (that's kinda what it's there for), so swapped it over to stem's msg() method. This also fixes a bug where raw controller commands would spew their output on a single line. For instance... >>> PROTOCOLINFO PROTOCOLINFO 1AUTH METHODS=NULLVERSION Tor="0.2.1.30"OK ... rather than... >>> PROTOCOLINFO PROTOCOLINFO 1 AUTH METHODS=NULL VERSION Tor="0.2.1.30" OK --- src/util/torConfig.py | 2 +- src/util/torInterpretor.py | 16 ++++++++-------- src/util/torTools.py | 25 ++++++++++++------------- 3 files changed, 21 insertions(+), 22 deletions(-) diff --git a/src/util/torConfig.py b/src/util/torConfig.py index fc08393..c9ae6ef 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -463,7 +463,7 @@ def saveConf(destination = None, contents = None): # attempts SAVECONF if we're updating our torrc with the current state if isSaveconf: try: - torTools.getConn().getTorCtl().save_conf() + torTools.getConn().saveConf() try: getTorrc().load() except IOError: pass diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index d88c137..674e5e2 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -9,6 +9,8 @@ import sys import version +import stem + # 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. @@ -929,18 +931,16 @@ class ControlInterpretor: outputEntry.append((MULTILINE_UNIMPLEMENTED_NOTICE + "\n", ERROR_FORMAT)) else: try: - response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + controller = conn.controller + if controller is None: raise stem.SocketClosed() + + response = controller.msg(input) if cmd == "QUIT": raise InterpretorClosed("Closing the connection") - for entry in response: - # Response entries are tuples with the response code, body, and - # extra info. For instance: - # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) - - if len(entry) == 3: - outputEntry.append((entry[1], OUTPUT_FORMAT)) + for _, _, content in response.content(): + outputEntry.append((content + '\n', OUTPUT_FORMAT)) except Exception, exc: if isinstance(exc, InterpretorClosed): raise exc diff --git a/src/util/torTools.py b/src/util/torTools.py index 5eb04ad..36cb70f 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -636,19 +636,6 @@ class Controller(TorCtl.PostEventListener): return self.lastHeartbeat - def getTorCtl(self): - """ - Provides the current TorCtl connection. If unset or closed then this - returns None. - """ - - self.connLock.acquire() - result = None - if self.isAlive(): result = self.conn - self.connLock.release() - - return result - def getInfo(self, param, default = UNDEFINED): """ Queries the control port for the given GETINFO option, providing the @@ -760,6 +747,18 @@ class Controller(TorCtl.PostEventListener): finally: self.connLock.release() + def saveConf(self): + """ + Calls tor's SAVECONF method. + """ + + self.connLock.acquire() + + if self.isAlive(): + self.controller.save_conf() + + self.connLock.release() + def sendNewnym(self): """ Sends a newnym request to Tor. These are rate limited so if it occures

1 0

[arm/master] Migrating arm from TorCtl to stem
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit ca6026cf90a4b755edd23ea112a3cd8c3b19be52 Merge: d83f1ad 37f7e95 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 20:12:56 2012 -0800 Migrating arm from TorCtl to stem Overhaul to move arm from TorCtl to stem. In general this is a very, very big improvement (my TorCtl improvements have been neglected over the years, leading arm to have quite a few hacks). No doubt this'll add some instability until we can work out the kinks. Still, it works and I'm doing a little happy dance right now. :P .gitignore | 2 +- README | 6 +- armrc.sample | 8 +- setup.py | 9 +- src/cli/configPanel.py | 2 +- src/cli/connections/connEntry.py | 12 +- src/cli/connections/connPanel.py | 4 +- src/cli/controller.py | 31 +- src/cli/graphing/bandwidthStats.py | 20 +- src/cli/graphing/graphPanel.py | 9 +- src/cli/headerPanel.py | 46 +- src/cli/logPanel.py | 243 +++---- src/cli/wizard.py | 18 +- src/gui/__init__.py | 6 - src/gui/arm.xml | 1348 ------------------------------------ src/gui/configPanel.py | 161 ----- src/gui/connections/__init__.py | 6 - src/gui/connections/circEntry.py | 36 - src/gui/connections/connEntry.py | 59 -- src/gui/connections/connPanel.py | 92 --- src/gui/controller.py | 63 -- src/gui/generalPanel.py | 124 ---- src/gui/graphing/__init__.py | 6 - src/gui/graphing/bandwidthStats.py | 60 -- src/gui/graphing/graphPanel.py | 144 ---- src/gui/logPanel.py | 126 ---- src/prereq.py | 158 +---- src/settings.cfg | 7 - src/starter.py | 138 ++--- src/test.py | 2 +- src/util/torConfig.py | 23 +- src/util/torInterpretor.py | 51 +- src/util/torTools.py | 1038 +++++----------------------- 33 files changed, 470 insertions(+), 3588 deletions(-)

1 0

[arm/master] Replacing TorCtl descriptor calls
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit a868f374dae40a5bfa8ae8951aee21ee0dc0bc01 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 19:09:04 2012 -0800 Replacing TorCtl descriptor calls Oops, missing a use of our TorCtl controller connection. This was a kinda screwy call - we were checking the 'down' attribute of a TorCtl Router class. This attribute seems to be True if... * the router lacks the Running flag * is hibernating * is Valid but lacks an observed bandwidth I'm not quite sure why I ever used this attribute. Just checking for the Running flag and calling it good. We can check for other criteria if it makes sense for the use case later. --- src/util/torTools.py | 14 ++++---------- 1 files changed, 4 insertions(+), 10 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 056c454..5ac29ea 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -1748,17 +1748,11 @@ class Controller(TorCtl.PostEventListener): for entryPort, entryFingerprint in list(potentialMatches): try: - nsCall = self.conn.get_network_status("id/%s" % entryFingerprint) - if not nsCall: raise TorCtl.ErrorReply() # network consensus couldn't be fetched - nsEntry = nsCall[0] + nsEntry = self.controller.get_network_status(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") - - isDown = TorCtl.Router.build_from_desc(descLines, nsEntry).down - if isDown: potentialMatches.remove((entryPort, entryFingerprint)) - except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed): pass + if not stem.descriptor.RUNNING in nsEntry.flags: + potentialMatches.remove((entryPort, entryFingerprint)) + except stem.ControllerError: pass if len(potentialMatches) == 1: return potentialMatches[0][1]

1 0

[arm/master] Removing the last hints of TorCtl
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 37f7e9597126392b326287bd6685d00d6627682b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 20:06:04 2012 -0800 Removing the last hints of TorCtl Dropping our TorCtl dependency and removing its last bits from the codebase. There is definitely a lot of cleanup left to do, but we now no longer have that dependency. --- README | 6 +++--- armrc.sample | 2 +- setup.py | 6 +----- src/cli/controller.py | 3 +-- src/cli/headerPanel.py | 1 - src/prereq.py | 44 +++----------------------------------------- src/test.py | 2 +- src/util/torConfig.py | 2 -- src/util/torTools.py | 36 +++++++++++------------------------- 9 files changed, 21 insertions(+), 81 deletions(-) diff --git a/README b/README index 05f18cb..e5676f7 100644 --- a/README +++ b/README @@ -20,7 +20,7 @@ An interview by Brenno Winter discussing the project is available at: Requirements: Python 2.5 -TorCtl (this is included with arm) +Stem (this is included with arm) Tor is running with an available control port. This means either... ... starting Tor with '--controlport <PORT>' ... or including 'ControlPort <PORT>' in your torrc @@ -203,7 +203,7 @@ Layout: popups.py - toolkit providing display popups wizard.py - provides the relay setup wizard - logPanel.py - (page 1) displays tor, arm, and torctl events + logPanel.py - (page 1) displays tor, arm, and stem events configPanel.py - (page 3) editor panel for the tor configuration torrcPanel.py - (page 4) displays torrc and validation interpretorPanel.py - (page 5) interpretor for control port access @@ -222,6 +222,6 @@ Layout: textInput.py - expands the capabilities of text input fields torConfig.py - functions for working with the torrc and config options torInterpretor.py - provides a shell around raw control port access - torTools.py - TorCtl wrapper, providing caching and derived information + torTools.py - Stem wrapper, providing caching and derived information uiTools.py - helper functions for presenting the user interface diff --git a/armrc.sample b/armrc.sample index 1b264f7..5fb9564 100644 --- a/armrc.sample +++ b/armrc.sample @@ -271,7 +271,7 @@ log.startTime INFO log.configEntryNotFound NONE log.configEntryUndefined NOTICE log.configEntryTypeError NOTICE -log.torCtlPortClosed NOTICE +log.stemPortClosed NOTICE log.torEventTypeUnrecognized INFO log.torPrefixPathInvalid NOTICE log.procCallMade DEBUG diff --git a/setup.py b/setup.py index c94ac1f..7d035ed 100644 --- a/setup.py +++ b/setup.py @@ -90,11 +90,7 @@ if "install" in sys.argv: except IOError, exc: print "Unable to compress man page: %s" % exc -# 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.util', 'arm.TorCtl', 'arm.stem'] -if isDebInstall: installPackages.remove('arm.TorCtl') +installPackages = ['arm', 'arm.cli', 'arm.cli.graphing', 'arm.cli.connections', 'arm.cli.menu', 'arm.util', 'arm.stem'] setup(name='arm', version=VERSION, diff --git a/src/cli/controller.py b/src/cli/controller.py index f01ef8a..de77e5a 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -22,7 +22,6 @@ import cli.graphing.connStats 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 @@ -564,7 +563,7 @@ def shutdownDaemons(): for panelImpl in control.getDaemonPanels(): panelImpl.stop() for panelImpl in control.getDaemonPanels(): panelImpl.join() - # joins on TorCtl event thread + # joins on stem threads torTools.getConn().close() # joins on utility daemon threads - this might take a moment since the diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index ce43e06..cf37ac1 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -19,7 +19,6 @@ import time import curses import threading -import TorCtl.TorCtl import stem import stem.connection diff --git a/src/prereq.py b/src/prereq.py index f8ab73d..c01dfbd 100644 --- a/src/prereq.py +++ b/src/prereq.py @@ -12,23 +12,12 @@ import tempfile # Library dependencies can be fetched on request. By default this is via # the following mirrors with their sha256 signatures checked. -TORCTL_ARCHIVE = "http://www.atagar.com/arm/resources/deps/11-06-16/torctl.tar.gz" -TORCTL_SIG = "5460adb1394c368ba492cc33d6681618b3d3062b3f5f70b2a87520fc291701c3" +#STEM_ARCHIVE = "http://www.atagar.com/arm/resources/deps/11-06-16/torctl.tar.gz" +#STEM_SIG = "5460adb1394c368ba492cc33d6681618b3d3062b3f5f70b2a87520fc291701c3" # optionally we can do an unverified fetch from the library's sources STEM_REPO = "git://git.torproject.org/stem.git" -def isTorCtlAvailable(): - """ - True if TorCtl is already available on the platform, false otherwise. - """ - - try: - import TorCtl - return True - except ImportError: - return False - def isStemAvailable(): """ True if stem is already available on the platform, false otherwise. @@ -40,30 +29,6 @@ def isStemAvailable(): except ImportError: return False -def promptTorCtlInstall(): - """ - Asks the user to install TorCtl. This returns True if it was installed and - False otherwise (if it was either declined or failed to be fetched). - """ - - userInput = raw_input("Arm requires TorCtl to run, but it's unavailable. Would you like to install it? (y/n): ") - - # if user says no then terminate - if not userInput.lower() in ("y", "yes"): return False - - # attempt to install TorCtl, printing the issue if unsuccessful - try: - fetchLibrary(TORCTL_ARCHIVE, TORCTL_SIG) - - if not isTorCtlAvailable(): - raise IOError("Unable to install TorCtl, sorry") - - print "TorCtl successfully installed" - return True - except IOError, exc: - print exc - return False - def promptStemInstall(): """ Asks the user to install stem. This returns True if it was installed and @@ -77,6 +42,7 @@ def promptStemInstall(): # attempt to install stem, printing the issue if unsuccessful try: + #fetchLibrary(STEM_ARCHIVE, STEM_SIG) installStem() if not isStemAvailable(): @@ -163,10 +129,6 @@ if __name__ == '__main__': print("arm requires python version 2.5 or greater\n") sys.exit(1) - if not isTorCtlAvailable(): - isInstalled = promptTorCtlInstall() - if not isInstalled: sys.exit(1) - if not isStemAvailable(): isInstalled = promptStemInstall() if not isInstalled: sys.exit(1) diff --git a/src/test.py b/src/test.py index af80879..7129120 100644 --- a/src/test.py +++ b/src/test.py @@ -23,7 +23,7 @@ conn = None while True: userInput = raw_input(MENU) - # initiate the TorCtl connection if the test needs it + # initiate the stem connection if the test needs it if userInput in ("1", "2", "4") and not conn: conn = torTools.getConn() conn.init() diff --git a/src/util/torConfig.py b/src/util/torConfig.py index c9ae6ef..0f6452d 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -471,8 +471,6 @@ def saveConf(destination = None, contents = None): log.log(log.DEBUG, logMsg % ("SAVECONF", time.time() - startTime)) return # if successful then we're done except: - # example error: - # TorCtl.TorCtl.ErrorReply: 551 Unable to write configuration to disk. pass # if the SAVECONF fails or this is a custom save then write contents directly diff --git a/src/util/torTools.py b/src/util/torTools.py index d2f1b0c..a5add1a 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -14,7 +14,7 @@ import Queue import stem import stem.control -from TorCtl import TorCtl +import stem.descriptor from util import connections, enum, log, procTools, sysTools, uiTools @@ -45,7 +45,7 @@ UNDEFINED = "<Undefined_ >" UNKNOWN = "UNKNOWN" # value used by cached information if undefined CONFIG = {"features.pathPrefix": "", - "log.torCtlPortClosed": log.NOTICE, + "log.stemPortClosed": log.NOTICE, "log.torPrefixPathInvalid": log.NOTICE, "log.bsdJailFound": log.INFO, "log.unknownBsdJailId": log.WARN} @@ -265,22 +265,21 @@ def isTorRunning(): def getConn(): """ Singleton constructor for a Controller. Be aware that this starts as being - uninitialized, needing a TorCtl instance before it's fully functional. + uninitialized, needing a stem Controller before it's fully functional. """ global CONTROLLER if CONTROLLER == None: CONTROLLER = Controller() return CONTROLLER -class Controller(TorCtl.PostEventListener): +class Controller: """ - TorCtl wrapper providing convenience functions, listener functionality for - tor's state, and the capability for controller connections to be restarted - if closed. + Stem wrapper providing convenience functions (mostly from the days of using + TorCtl), listener functionality for tor's state, and the capability for + controller connections to be restarted if closed. """ def __init__(self): - TorCtl.PostEventListener.__init__(self) self.controller = None self.connLock = threading.RLock() self.statusListeners = [] # callback functions for tor's state changes @@ -321,7 +320,7 @@ class Controller(TorCtl.PostEventListener): def init(self, controller): """ - Uses the given TorCtl instance for future operations, notifying listeners + Uses the given stem instance for future operations, notifying listeners about the change. Arguments: @@ -373,7 +372,7 @@ class Controller(TorCtl.PostEventListener): def close(self): """ - Closes the current TorCtl instance and notifies listeners. + Closes the current stem instance and notifies listeners. """ self.connLock.acquire() @@ -394,7 +393,7 @@ class Controller(TorCtl.PostEventListener): def isAlive(self): """ - Returns True if this has been initialized with a working TorCtl instance, + Returns True if this has been initialized with a working stem instance, False otherwise. """ @@ -1252,8 +1251,6 @@ class Controller(TorCtl.PostEventListener): self._cachedParam = {} 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... :( - # http://bugs.noreply.org/flyspray/index.php?do=details&id=1329 raisedException = IOError(str(exc)) else: try: @@ -1532,17 +1529,6 @@ class Controller(TorCtl.PostEventListener): if len(attachedMatches) == 1: return attachedMatches[0] - # Highly unlikely, but still haven't found it. Last we'll use some - # tricks from Mike's ConsensusTracker, excluding possiblities that - # have... - # - lost their Running flag - # - list a bandwidth of 0 - # - have 'opt hibernating' set - # - # This involves constructing a TorCtl Router and checking its 'down' - # flag (which is set by the three conditions above). This is the last - # resort since it involves a couple GETINFO queries. - for entryPort, entryFingerprint in list(potentialMatches): try: nsEntry = self.controller.get_network_status(entryFingerprint) @@ -1884,7 +1870,7 @@ class Controller(TorCtl.PostEventListener): # gives a notice that the control port has closed if eventType == State.CLOSED: - log.log(CONFIG["log.torCtlPortClosed"], "Tor control port closed") + log.log(CONFIG["log.stemPortClosed"], "Tor control port closed") for callback in self.statusListeners: callback(self, eventType)

1 0

[stem/master] Adding get_latest_heartbeat()
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 6bc92816dc4356a204fdde0f160ee344875143a3 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 18:50:46 2012 -0800 Adding get_latest_heartbeat() Adding a method to the BaseController to get the time that we last heard from tor. This is useful to figure out if our controller connection has stalled, but only works if we're continually using our controller (such as by listening for BW events). --- stem/control.py | 14 ++++++++++++++ test/integ/control/base_controller.py | 11 +++++++++++ 2 files changed, 25 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index a1100c1..1e5250a 100644 --- a/stem/control.py +++ b/stem/control.py @@ -49,6 +49,7 @@ providing its own for interacting at a higher level. |- connect - connects or reconnects to tor |- close - shuts down our connection to the tor process |- get_socket - provides the socket used for control communication + |- get_latest_heartbeat - timestamp for when we last heard from tor |- add_status_listener - notifies a callback of changes in our status |- remove_status_listener - prevents further notification of status changes +- __enter__ / __exit__ - manages socket connection @@ -237,6 +238,8 @@ class BaseController(object): self._socket._connect = self._connect self._socket._close = self._close + self._last_heartbeat = 0.0 # timestamp for when we last heard from tor + if self._socket.is_alive(): self._launch_threads() @@ -357,6 +360,16 @@ class BaseController(object): return self._socket + def get_latest_heartbeat(self): + """ + Provides the unix timestamp for when we last heard from tor. This is zero + if we've never received a message. + + :returns: float for the unix timestamp of when we last heard from tor + """ + + return self._last_heartbeat + def add_status_listener(self, callback, spawn = True): """ Notifies a given function when the state of our socket changes. Functions @@ -523,6 +536,7 @@ class BaseController(object): while self.is_alive(): try: control_message = self._socket.recv() + self._last_heartbeat = time.time() if control_message.content()[-1][0] == "650": # asynchronous message, adds to the event queue and wakes up its handler diff --git a/test/integ/control/base_controller.py b/test/integ/control/base_controller.py index b4bb354..8709469 100644 --- a/test/integ/control/base_controller.py +++ b/test/integ/control/base_controller.py @@ -183,6 +183,17 @@ class TestBaseController(unittest.TestCase): self.assertTrue(re.match("650 BW [0-9]+ [0-9]+\r\n", bw_event.raw_content())) self.assertEquals(("650", " "), bw_event.content()[0][:2]) + def test_get_latest_heartbeat(self): + """ + Basic check for get_latest_heartbeat(). + """ + + # makes a getinfo query, then checks that the heartbeat is close to now + with test.runner.get_runner().get_tor_socket() as control_socket: + controller = stem.control.BaseController(control_socket) + controller.msg("GETINFO version") + self.assertTrue((time.time() - controller.get_latest_heartbeat()) < 5) + def test_status_notifications(self): """ Checks basic functionality of the add_status_listener() and

1 0

[stem/master] Adding the requirement for 'PortForwarding'
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 844073f3813d496fe4d5037283413d837d1ae325 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 13:42:10 2012 -0800 Adding the requirement for 'PortForwarding' Adding in the version requirement for the 'PortForwarding' torrc option. This was hardcoded in arm. --- stem/version.py | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-) diff --git a/stem/version.py b/stem/version.py index 243fc50..7bcd289 100644 --- a/stem/version.py +++ b/stem/version.py @@ -40,6 +40,7 @@ easily parsed and compared, for instance... **LOADCONF** 'LOADCONF' requests **TAKEOWNERSHIP** 'TAKEOWNERSHIP' requests **TORRC_CONTROL_SOCKET** 'ControlSocket <path>' config option + **TORRC_PORT_FORWARDING** 'PortForwarding' config option **TORRC_DISABLE_DEBUGGER_ATTACHMENT** 'DisableDebuggerAttachment' config option **FEATURE_VERBOSE_NAMES** 'VERBOSE_NAMES' optional feature **FEATURE_EXTENDED_EVENTS** 'EXTENDED_EVENTS' optional feature @@ -255,11 +256,12 @@ safecookie_req.greater_than(Version("0.2.3.13")) Requirement = stem.util.enum.Enum( ("AUTH_SAFECOOKIE", safecookie_req), - ("GETINFO_CONFIG_TEXT", Version("0.2.2.7")), + ("GETINFO_CONFIG_TEXT", Version("0.2.2.7-alpha")), ("EXTENDCIRCUIT_PATH_OPTIONAL", Version("0.2.2.9")), ("LOADCONF", Version("0.2.1.1")), ("TAKEOWNERSHIP", Version("0.2.2.28-beta")), ("TORRC_CONTROL_SOCKET", Version("0.2.0.30")), + ("TORRC_PORT_FORWARDING", Version("0.2.3.1-alpha")), ("TORRC_DISABLE_DEBUGGER_ATTACHMENT", Version("0.2.3.9")), ("FEATURE_VERBOSE_NAMES", Version("0.2.2.1-alpha")), ("FEATURE_EXTENDED_EVENTS", Version("0.2.2.1-alpha")),

1 0

[stem/master] Revising error handling for get_conf()
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 5b45d3125c811067d7c3ba0a11e324423c88d925 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 11:03:07 2012 -0800 Revising error handling for get_conf() The Controller's get_conf() function was buggy if the configuration value was unset. It's documented as returning the default, but instead it returned None or [None] depending on if 'multiple' was set. On reflection the pydocs for these functions were pretty unfriendly, so giving them an overhaul. Functionally this changes two things... 1. When you query for an unset value it will... * provide the default value if you gave it one * provide None if multiple was False, and [] if it was True 2. The get_conf_map()'s 'default' argument is now the defaultly *mapped value* rather than the default *response*. For instance... # old behavior get_conf_map('NoOption', 'Blarg') => 'Blarg' # new behavior get_conf_map('NoOption', 'Blarg') => {'NoOption': 'Blarg'} This means that the get_conf_map() pydocs can now assure the caller that they'll always get a dict, and it also better matches the get_conf() handling for default. --- stem/control.py | 117 ++++++++++++++++++++++---------------- stem/response/getconf.py | 6 ++- test/integ/control/controller.py | 10 +++- test/unit/response/getconf.py | 2 +- 4 files changed, 81 insertions(+), 54 deletions(-) diff --git a/stem/control.py b/stem/control.py index b8bbf15..a12609f 100644 --- a/stem/control.py +++ b/stem/control.py @@ -978,24 +978,32 @@ class Controller(BaseController): def get_conf(self, param, default = UNDEFINED, multiple = False): """ - Queries the control socket for the value of a given configuration option. If - provided a default then that's returned as if the GETCONF option is undefined - or if the call fails for any reason (invalid configuration option, error - response, control port closed, initiated, etc). If the configuration key - consists of whitespace only, **None** is returned unless a default value is - given. + Queries the current value for a configuration option. Some configuration + options (like the ExitPolicy) can have multiple values. This provides a + **list** with all of the values if **multiple** is **True**. Otherwise this + will be a **str** with the first value. + + If provided with a **default** then that is provided if the configuration + option was unset or the query fails (invalid configuration option, error + response, control port closed, initiated, etc). + + If the configuration value is unset and no **default** was given then this + provides **None** if **multiple** was **False** and an empty list if it was + **True**. :param str param: configuration option to be queried - :param object default: response if the query fails - :param bool multiple: if **True**, the value(s) provided are lists of all - returned values, otherwise this just provides the first value + :param object default: response if the option is unset or the query fails + :param bool multiple: if **True** then provides a list with all of the + present values (this is an empty list if the config option is unset) :returns: Response depends upon how we were called as follows... - * **str** with the response if multiple was **False** + * **str** with the configuration value if **multiple** was **False**, + **None** if it was unset * **list** with the response strings if multiple was **True** - * default if one was provided and our call failed + * default if one was provided and the configuration option was either + unset or our call failed :raises: * :class:`stem.ControllerError` if the call fails and we weren't @@ -1017,49 +1025,45 @@ class Controller(BaseController): def get_conf_map(self, params, default = UNDEFINED, multiple = True): """ - Queries the control socket for the values of given configuration options - and provides a mapping of the keys to the values. If provided a default - then that's returned if the GETCONF option is undefined or if the call - fails for any reason (invalid configuration option, error response, control - port closed, initiated, etc). Configuration keys that are empty or contain - only whitespace are ignored. + Similar to :func:`~stem.control.Controller.get_conf` but queries multiple + configuration options, providing back a mapping of those options to their + values. - There's three use cases for GETCONF: + There are three use cases for GETCONF: - 1. a single value is provided - 2. multiple values are provided for the option queried + 1. a single value is provided (ex. **ControlPort**) + 2. multiple values are provided for the option (ex. **ExitPolicy**) 3. a set of options that weren't necessarily requested are returned (for - instance querying HiddenServiceOptions gives HiddenServiceDir, - HiddenServicePort, etc) + instance querying **HiddenServiceOptions** gives **HiddenServiceDir**, + **HiddenServicePort**, etc) The vast majority of the options fall into the first two categories, in which case calling :func:`~stem.control.Controller.get_conf` is sufficient. However, for batch queries or the special options that give a set of values this provides back the full response. As of tor version 0.2.1.25 - HiddenServiceOptions was the only option like this. - - The :func:`~stem.control.Controller.get_conf` and - :func:`~stem.control.Controller.get_conf_map` functions both try to account - for these special mappings, so queried like get_conf("HiddenServicePort") - should behave as you'd expect. This method, however, simply returns - whatever Tor provides so get_conf_map("HiddenServicePort") will give the - same response as get_conf_map("HiddenServiceOptions"). + **HiddenServiceOptions** was the only option that falls into the third + category. :param str,list params: configuration option(s) to be queried - :param object default: response if the query fails - :param bool multiple: if **True**, the value(s) provided are lists of all - returned values,otherwise this just provides the first value + :param object default: value for the mappings if the configuration option + is either undefined or the query fails + :param bool multiple: if **True** then the provided are lists with all of + the present values :returns: - Response depends upon how we were called as follows... + **dict** of the 'config key => value' mappings. The value is a... - * **dict** of 'config key => value' mappings, the value is a list if - 'multiple' is **True** and a **str** of just the first value otherwise - * default if one was provided and our call failed + * **str** if **multiple** is **False**, **None** if the configuration + option is unset + * **list** if **multiple** is **True** + * the **default** if it was set and the value was either undefined or our + lookup failed :raises: - * :class:`stem.ControllerError` if the call fails and we weren't provided a default response - * :class:`stem.InvalidArguments` if the configuration option requested was invalid + * :class:`stem.ControllerError` if the call fails and we weren't provided + a default response + * :class:`stem.InvalidArguments` if the configuration option requested + was invalid """ start_time = time.time() @@ -1086,11 +1090,7 @@ class Controller(BaseController): # if everything was cached then short circuit making the query if not lookup_params: log.trace("GETCONF %s (cache fetch)" % " ".join(reply.keys())) - - if multiple: - return reply - else: - return dict([(entry[0], entry[1][0]) for entry in reply.items()]) + return self._get_conf_dict_to_response(reply, default, multiple) try: response = self.msg("GETCONF %s" % ' '.join(lookup_params)) @@ -1120,17 +1120,34 @@ class Controller(BaseController): del reply[key] log.debug("GETCONF %s (runtime: %0.4f)" % (" ".join(lookup_params), time.time() - start_time)) - - if multiple: - return reply - else: - return dict([(entry[0], entry[1][0]) for entry in reply.items()]) + return self._get_conf_dict_to_response(reply, default, multiple) except stem.ControllerError, exc: log.debug("GETCONF %s (failed: %s)" % (" ".join(lookup_params), exc)) - if default != UNDEFINED: return default + if default != UNDEFINED: return dict((param, default) for param in params) else: raise exc + def _get_conf_dict_to_response(self, config_dict, default, multiple): + """ + Translates a dictionary of 'config key => [value1, value2...]' into the + return value of :func:`~stem.control.Controller.get_conf_map`, taking into + account what the caller requested. + """ + + return_dict = {} + + for key, values in config_dict.items(): + if values == []: + # config option was unset + if default != UNDEFINED: + return_dict[key] = default + else: + return_dict[key] = [] if multiple else None + else: + return_dict[key] = values if multiple else values[0] + + return return_dict + def set_conf(self, param, value): """ Changes the value of a tor configuration option. Our value can be any of diff --git a/stem/response/getconf.py b/stem/response/getconf.py index df1a71f..879c5c0 100644 --- a/stem/response/getconf.py +++ b/stem/response/getconf.py @@ -49,5 +49,9 @@ class GetConfResponse(stem.response.ControlMessage): else: key, value = (line.pop(), None) - self.entries.setdefault(key, []).append(value) + if not key in self.entries: + self.entries[key] = [] + + if value is not None: + self.entries[key].append(value) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 9af3cae..9efeb00 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -263,14 +263,20 @@ class TestController(unittest.TestCase): reply_params = controller.get_conf_map(request_params, multiple=False).keys() self.assertEqual(set(request_params), set(reply_params)) + # queries an option that is unset + + self.assertEqual(None, controller.get_conf("HTTPSProxy")) + self.assertEqual("la-di-dah", controller.get_conf("HTTPSProxy", "la-di-dah")) + self.assertEqual([], controller.get_conf("HTTPSProxy", [], multiple = True)) + # non-existant option(s) self.assertRaises(stem.InvalidArguments, controller.get_conf, "blarg") self.assertEqual("la-di-dah", controller.get_conf("blarg", "la-di-dah")) self.assertRaises(stem.InvalidArguments, controller.get_conf_map, "blarg") - self.assertEqual("la-di-dah", controller.get_conf_map("blarg", "la-di-dah")) + self.assertEqual({"blarg": "la-di-dah"}, controller.get_conf_map("blarg", "la-di-dah")) self.assertRaises(stem.InvalidRequest, controller.get_conf_map, ["blarg", "huadf"], multiple = True) - self.assertEqual("la-di-dah", controller.get_conf_map(["erfusdj", "afiafj"], "la-di-dah", multiple = True)) + self.assertEqual({"erfusdj": "la-di-dah", "afiafj": "la-di-dah"}, controller.get_conf_map(["erfusdj", "afiafj"], "la-di-dah", multiple = True)) # multivalue configuration keys nodefamilies = [("abc", "xyz", "pqrs"), ("mno", "tuv", "wxyz")] diff --git a/test/unit/response/getconf.py b/test/unit/response/getconf.py index 14ef974..8a3aedb 100644 --- a/test/unit/response/getconf.py +++ b/test/unit/response/getconf.py @@ -71,7 +71,7 @@ class TestGetConfResponse(unittest.TestCase): "CookieAuthentication": ["0"], "ControlPort": ["9100"], "DataDirectory": ["/tmp/fake dir"], - "DirPort": [None], + "DirPort": [], } self.assertEqual(expected, control_message.entries)

1 0

[stem/master] Making the Controller's enabled_features private
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 229a6319109372dc529106516a9fcb65f5c2eb73 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 18:35:41 2012 -0800 Making the Controller's enabled_features private The Controller's 'enabled_features' attribute wasn't documented so it was probably meant to be private. Changing its name to reflect that. --- stem/control.py | 10 +++++----- test/integ/control/controller.py | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/stem/control.py b/stem/control.py index a12609f..a1100c1 100644 --- a/stem/control.py +++ b/stem/control.py @@ -622,7 +622,7 @@ class Controller(BaseController): # number of sequential 'GETINFO ip-to-country/*' lookups that have failed self._geoip_failure_count = 0 - self.enabled_features = [] + self._enabled_features = [] def connect(self): super(Controller, self).connect() @@ -1318,7 +1318,7 @@ class Controller(BaseController): feature = feature.upper() - if feature in self.enabled_features: + if feature in self._enabled_features: return True else: # check if this feature is on by default @@ -1330,9 +1330,9 @@ class Controller(BaseController): defaulted_version = stem.version.Requirement.FEATURE_VERBOSE_NAMES if defaulted_version and self.get_version().meets_requirements(defaulted_version): - self.enabled_features.append(feature) + self._enabled_features.append(feature) - return feature in self.enabled_features + return feature in self._enabled_features def enable_feature(self, features): """ @@ -1366,7 +1366,7 @@ class Controller(BaseController): raise stem.ProtocolError("USEFEATURE provided an invalid response code: %s" % response.code) - self.enabled_features += [entry.upper() for entry in features] + self._enabled_features += [entry.upper() for entry in features] def signal(self, signal): """ diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 9efeb00..2672f5f 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -438,7 +438,7 @@ class TestController(unittest.TestCase): if orconn_output == '': if test.runner.require_online(self): return - self.assertTrue("VERBOSE_NAMES" in controller.enabled_features) + self.assertTrue("VERBOSE_NAMES" in controller._enabled_features) self.assertRaises(stem.InvalidArguments, controller.enable_feature, ["NOT", "A", "FEATURE"]) try: controller.enable_feature(["NOT", "A", "FEATURE"])

1 0