tor-commits December 2012

tor-commits@lists.torproject.org

17 participants
1600 discussions

[arm/master] Stem calls lacked an isAlive() check
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit edc2447b4b3a2b01ef2b2314edf72478d8f7ac0c Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 11:32:12 2012 -0800 Stem calls lacked an isAlive() check When arm's controller is detached its 'conn' and 'controller' attributes are None. This means that all of our function calls need an isAlive() check before using them... atagar@morrigan:~/Desktop/arm$ ./arm Traceback (most recent call last): File "./src/starter.py", line 566, in <module> _loadConfigurationDescriptions(pathPrefix) File "./src/starter.py", line 162, in _loadConfigurationDescriptions util.torConfig.loadOptionDescriptions(descriptorPath) File "/home/atagar/Desktop/arm/src/util/torConfig.py", line 137, in loadOptionDescriptions torVersion = torTools.getConn().getInfo("version", "") File "/home/atagar/Desktop/arm/src/util/torTools.py", line 725, in getInfo return self.controller.get_info(param, default) AttributeError: 'NoneType' object has no attribute 'get_info' Ideally we'd just drop arm's controller and use stem's (which has its own locks and check for this), but that'll need to come later. --- src/util/torTools.py | 15 +++++++++++++++ 1 files changed, 15 insertions(+), 0 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 92d2cf0..79b4e70 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -721,6 +721,12 @@ class Controller(TorCtl.PostEventListener): self.connLock.acquire() try: + if not self.isAlive(): + if default != UNDEFINED: + return default + else: + raise stem.SocketClosed() + if default != UNDEFINED: return self.controller.get_info(param, default) else: @@ -748,6 +754,12 @@ class Controller(TorCtl.PostEventListener): self.connLock.acquire() try: + if not self.isAlive(): + if default != UNDEFINED: + return default + else: + raise stem.SocketClosed() + if default != UNDEFINED: return self.controller.get_conf(param, default, multiple) else: @@ -790,6 +802,9 @@ class Controller(TorCtl.PostEventListener): self.connLock.acquire() try: + if not self.isAlive(): + raise stem.SocketClosed() + # clears our exit policy chache if it's changing if "exitpolicy" in [k.lower() for (k, v) in paramList]: self._exitPolicyChecker = self.getExitPolicy()

1 0

[arm/master] Replacing tor version handling with stem's
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit a40adf7aabbcd063d5def876ee7c9ea46fb5ae67 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 13:49:16 2012 -0800 Replacing tor version handling with stem's Stem has really good support for parsing and comparing tor versions. Using that instead of our home brewed counterpart. --- src/cli/wizard.py | 18 ++++----- src/util/torConfig.py | 11 ++--- src/util/torTools.py | 98 ++++++------------------------------------------- 3 files changed, 24 insertions(+), 103 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 86522d1..02a1f17 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -16,6 +16,8 @@ import curses import cli.popups import cli.controller +import stem.version + from util import connections, enum, log, sysTools, torConfig, torTools, uiTools # template used to generate the torrc @@ -94,7 +96,9 @@ BRACKETS = ((' ', ' '), ('|', '|')) # version requirements for options -VERSION_REQUIREMENTS = {Options.PORTFORWARD: "0.2.3.1-alpha"} +VERSION_REQUIREMENTS = { + Options.PORTFORWARD: stem.version.Requirement.TORRC_PORT_FORWARDING, +} # tor's defaults for config options, used to filter unneeded options TOR_DEFAULTS = {Options.BANDWIDTH: "5 MB", @@ -245,16 +249,10 @@ def showWizard(): log.log(log.WARN, msg) return - # gets tor's version - torVersion = None try: - versionQuery = sysTools.call("tor --version") - - for line in versionQuery: - if line.startswith("Tor version "): - torVersion = torTools.parseVersion(line.split(" ")[2]) - break + torVersion = stem.version.get_system_tor_version() except IOError, exc: + torVersion = None log.log(log.INFO, "'tor --version' query failed: %s" % exc) relayType, config = None, {} @@ -316,7 +314,7 @@ def showWizard(): disabledOpt = list(CONFIG["wizard.disabled"]) for opt, optVersion in VERSION_REQUIREMENTS.items(): - if not torVersion or not torTools.isVersion(torVersion, torTools.parseVersion(optVersion)): + if torVersion is None or not torVersion.meets_requirements(optVersion): disabledOpt.append(opt) # the port forwarding option would only work if tor-fw-helper is in the path diff --git a/src/util/torConfig.py b/src/util/torConfig.py index 783fa84..fc08393 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -7,6 +7,8 @@ import time import socket import threading +import stem.version + from util import enum, log, sysTools, torTools, uiTools CONFIG = {"features.torrc.validate": True, @@ -791,16 +793,11 @@ class Torrc(): self.valsLock.acquire() - # The torrc validation relies on 'GETINFO config-text' which was - # introduced in tor 0.2.2.7-alpha so if we're using an earlier version - # (or configured to skip torrc validation) then this is a no-op. For more - # information see: - # https://trac.torproject.org/projects/tor/ticket/2501 - if not self.isLoaded(): returnVal = None else: + torVersion = torTools.getConn().getVersion() skipValidation = not CONFIG["features.torrc.validate"] - skipValidation |= not torTools.getConn().isVersion("0.2.2.7-alpha") + skipValidation |= (torVersion is None or not torVersion.meets_requirements(stem.version.Requirement.GETINFO_CONFIG_TEXT)) if skipValidation: log.log(log.INFO, "Skipping torrc validation (requires tor 0.2.2.7-alpha)") diff --git a/src/util/torTools.py b/src/util/torTools.py index 7657dcb..5eb04ad 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -256,64 +256,6 @@ def getBsdJailId(): log.log(CONFIG["log.unknownBsdJailId"], "Failed to figure out the FreeBSD jail id. Assuming 0.") return 0 -def parseVersion(versionStr): - """ - Parses the given version string into its expected components, for instance... - '0.2.2.13-alpha (git-feb8c1b5f67f2c6f)' - - would provide: - (0, 2, 2, 13, 'alpha') - - If the input isn't recognized then this returns None. - - Arguments: - versionStr - version string to be parsed - """ - - # crops off extra arguments, for instance: - # '0.2.2.13-alpha (git-feb8c1b5f67f2c6f)' -> '0.2.2.13-alpha' - versionStr = versionStr.split()[0] - - result = None - if versionStr.count(".") in (2, 3): - # parses the optional suffix ('alpha', 'release', etc) - if versionStr.count("-") == 1: - versionStr, versionSuffix = versionStr.split("-") - else: versionSuffix = "" - - # Parses the numeric portion of the version. This can have three or four - # entries depending on if an optional patch level was provided. - try: - versionComp = [int(entry) for entry in versionStr.split(".")] - if len(versionComp) == 3: versionComp += [0] - result = tuple(versionComp + [versionSuffix]) - except ValueError: pass - - return result - -def isVersion(myVersion, minVersion): - """ - Checks if the given version meets a given minimum. Both arguments are - expected to be version tuples. To get this from a version string use the - parseVersion function. - - Arguments: - myVersion - tor version tuple - minVersion - version tuple to be checked against - """ - - if myVersion[:4] == minVersion[:4]: - return True # versions match - else: - # compares each of the numeric portions of the version - for i in range(4): - myVal, minVal = myVersion[i], minVersion[i] - - if myVal > minVal: return True - elif myVal < minVal: return False - - return True # versions match (should have been caught above...) - def isTorRunning(): """ Simple check for if a tor process is running. If this can't be determined @@ -959,39 +901,23 @@ class Controller(TorCtl.PostEventListener): return self._getRelayAttr("flags", default) - def isVersion(self, minVersionStr): + def getVersion(self): """ - Checks if we meet the given version. Recognized versions are of the form: - <major>.<minor>.<micro>[.<patch>][-<status_tag>] - - for instance, "0.2.2.13-alpha" or "0.2.1.5". This raises a ValueError if - the input isn't recognized, and returns False if unable to fetch our - instance's version. - - According to the spec the status_tag is purely informal, so it's ignored - in comparisons. - - Arguments: - minVersionStr - version to be compared against + Provides the version of our tor instance, this is None if we don't have a + connection. """ - minVersion = parseVersion(minVersionStr) - - if minVersion == None: - raise ValueError("unrecognized version: %s" % minVersionStr) - self.connLock.acquire() - result = False - if self.isAlive(): - myVersion = parseVersion(self.getInfo("version", "")) - - if not myVersion: result = False - else: result = isVersion(myVersion, minVersion) - - self.connLock.release() - - return result + try: + return self.controller.get_version() + except stem.SocketClosed, exc: + self.close() + return None + except: + return None + finally: + self.connLock.release() def isGeoipUnavailable(self): """

1 0

[arm/master] Using stem's event handling
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 7f295fe63f60c221bce6a9fa28ff6b713ea656c7 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 18:32:15 2012 -0800 Using stem's event handling Replacing TorCtl event handling with stem's. This includes a few changes... * Dropped some of the custom messaging for event types. On the down side those messages might have been a tad more user friendly. On the up side we'll now provide the full event message content rather than hiding things that we don't recognize. Personally I consider this to be a net good thing. We can add a user friendly str() for Events if we want a better rendering. * We no longer support listener reattachment. This is because stem itself provides reattachment but we've broken it by misusing the Controller class. We're constructing fresh Controller instances rather than reusing the one we made priorly - when this is fixed we'll have reattachment again. * The interpretor panel no longer supports SETEVENTS nor event listening. It took some pretty ugly hacks to make it work in the first place, and I'm not very inclined to redo these hacks with stem. Besides, we'll probably be splintering the interpretor panel into its own application for ticket #6439. --- src/cli/graphing/graphPanel.py | 9 +- src/cli/logPanel.py | 185 ++++++++++++++------------------------ src/util/torInterpretor.py | 17 ++-- src/util/torTools.py | 196 +++++++++------------------------------- 4 files changed, 120 insertions(+), 287 deletions(-) diff --git a/src/cli/graphing/graphPanel.py b/src/cli/graphing/graphPanel.py index 76221ff..d03d1bd 100644 --- a/src/cli/graphing/graphPanel.py +++ b/src/cli/graphing/graphPanel.py @@ -18,11 +18,12 @@ Downloaded (0.0 B/sec): Uploaded (0.0 B/sec): import copy import curses -from TorCtl import TorCtl import cli.popups import cli.controller +import stem.control + from util import enum, panel, torTools, uiTools # time intervals at which graphs can be updated @@ -56,7 +57,7 @@ def loadConfig(config): "features.graph.interval": (0, len(UPDATE_INTERVALS) - 1), "features.graph.bound": (0, 2)}) -class GraphStats(TorCtl.PostEventListener): +class GraphStats: """ Module that's expected to update dynamically and provide attributes to be graphed. Up to two graphs (a 'primary' and 'secondary') can be displayed at a @@ -68,8 +69,6 @@ class GraphStats(TorCtl.PostEventListener): Initializes parameters needed to present a graph. """ - TorCtl.PostEventListener.__init__(self) - # panel to be redrawn when updated (set when added to GraphPanel) self._graphPanel = None self.isSelected = False @@ -96,7 +95,7 @@ class GraphStats(TorCtl.PostEventListener): self.secondaryCounts[i] = (self.maxCol + 1) * [0] # tracks BW events - torTools.getConn().addEventListener(self) + torTools.getConn().addEventListener(self.bandwidth_event, stem.control.EventType.BW) def clone(self, newCopy=None): """ diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py index ee7dee1..b866c62 100644 --- a/src/cli/logPanel.py +++ b/src/cli/logPanel.py @@ -11,9 +11,8 @@ import curses import logging import threading -from TorCtl import TorCtl - import stem.util.log +from stem.response import events import popups from version import VERSION @@ -35,7 +34,7 @@ EVENT_LISTING = """ d DEBUG a ADDRMAP k DESCCHANGED s ST j CLIENTS_SEEN q ORCONN DINWE tor runlevel+ A All Events 12345 arm runlevel+ X No Events - 67890 torctl runlevel+ U Unknown Events""" + U Unknown Events""" RUNLEVEL_EVENT_COLOR = {log.DEBUG: "magenta", log.INFO: "blue", log.NOTICE: "green", log.WARN: "yellow", log.ERR: "red"} @@ -155,7 +154,7 @@ def expandEvents(eventAbbr): def getMissingEventTypes(): """ - Provides the event types the current torctl connection supports but arm + Provides the event types the current tor connection supports but arm doesn't. This provides an empty list if no event types are missing, and None if the GETINFO query fails. """ @@ -168,28 +167,6 @@ def getMissingEventTypes(): return [event for event in torEventTypes if not event in armEventTypes] else: return None # GETINFO call failed -def setEventListening(events): - """ - Configures the events Tor listens for, filtering non-tor events from what we - request from the controller. This returns a sorted list of the events we - successfully set. - - Arguments: - events - event types to attempt to set - """ - - events = set(events) # drops duplicates - torEvents = events.intersection(set(TOR_EVENT_TYPES.values())) - - # adds events unrecognized by arm if we're listening to the 'UNKNOWN' type - if "UNKNOWN" in events: - torEvents.update(set(getMissingEventTypes())) - - setEvents = torTools.getConn().setControllerEvents(list(torEvents)) - - # provides back the input set minus events we failed to set - return sorted(events.difference(torTools.FAILED_EVENTS)) - def loadLogMessages(): """ Fetches a mapping of common log messages to their runlevels from the config. @@ -491,95 +468,9 @@ class LogEntry(): return self._displayMessage -class TorEventObserver(TorCtl.PostEventListener): - """ - Listens for all types of events provided by TorCtl, providing an LogEntry - instance to the given callback function. - """ - - def __init__(self, callback): - """ - Tor event listener with the purpose of translating events to nicely - formatted calls of a callback function. - - Arguments: - callback - function accepting a LogEntry, called when an event of these - types occur - """ - - TorCtl.PostEventListener.__init__(self) - self.callback = callback - - def circ_status_event(self, event): - msg = "ID: %-3s STATUS: %-10s PATH: %s" % (event.circ_id, event.status, ", ".join(event.path)) - if event.purpose: msg += " PURPOSE: %s" % event.purpose - if event.reason: msg += " REASON: %s" % event.reason - if event.remote_reason: msg += " REMOTE_REASON: %s" % event.remote_reason - self._notify(event, msg, "yellow") - - def buildtimeout_set_event(self, event): - self._notify(event, "SET_TYPE: %s, TOTAL_TIMES: %s, TIMEOUT_MS: %s, XM: %s, ALPHA: %s, CUTOFF_QUANTILE: %s" % (event.set_type, event.total_times, event.timeout_ms, event.xm, event.alpha, event.cutoff_quantile)) - - def stream_status_event(self, event): - self._notify(event, "ID: %s STATUS: %s CIRC_ID: %s TARGET: %s:%s REASON: %s REMOTE_REASON: %s SOURCE: %s SOURCE_ADDR: %s PURPOSE: %s" % (event.strm_id, event.status, event.circ_id, event.target_host, event.target_port, event.reason, event.remote_reason, event.source, event.source_addr, event.purpose)) - - def or_conn_status_event(self, event): - msg = "STATUS: %-10s ENDPOINT: %-20s" % (event.status, event.endpoint) - if event.reason: msg += " REASON: %-6s" % event.reason - if event.ncircs: msg += " NCIRCS: %i" % event.ncircs - self._notify(event, msg) - - def stream_bw_event(self, event): - self._notify(event, "ID: %s READ: %s WRITTEN: %s" % (event.strm_id, event.bytes_read, event.bytes_written)) - - def bandwidth_event(self, event): - self._notify(event, "READ: %i, WRITTEN: %i" % (event.read, event.written), "cyan") - - def msg_event(self, event): - self._notify(event, event.msg, RUNLEVEL_EVENT_COLOR[event.level]) - - def new_desc_event(self, event): - idlistStr = [str(item) for item in event.idlist] - self._notify(event, ", ".join(idlistStr)) - - def address_mapped_event(self, event): - whenLabel, gmtExpiryLabel = "", "" - - if event.when: - whenLabel = time.strftime("%H:%M %m/%d/%Y", event.when) - - # TODO: torctl is getting an 'error' and 'gmt_expiry' attribute so display - # those when they become available - # - #if event.gmt_expiry: - # gmtExpiryLabel = time.strftime("%H:%M %m/%d/%Y", event.gmt_expiry) - - self._notify(event, "%s, %s -> %s" % (whenLabel, event.from_addr, event.to_addr)) - - def ns_event(self, event): - # NetworkStatus params: nickname, idhash, orhash, ip, orport (int), - # dirport (int), flags, idhex, bandwidth, updated (datetime) - msg = ", ".join(["%s (%s)" % (ns.idhex, ns.nickname) for ns in event.nslist]) - self._notify(event, "Listed (%i): %s" % (len(event.nslist), msg), "blue") - - def new_consensus_event(self, event): - msg = ", ".join(["%s (%s)" % (ns.idhex, ns.nickname) for ns in event.nslist]) - self._notify(event, "Listed (%i): %s" % (len(event.nslist), msg), "magenta") - - def guard_event(self, event): - msg = "%s (%s), STATUS: %s" % (event.idhex, event.nick, event.status) - self._notify(event, msg, "yellow") - - def unknown_event(self, event): - msg = "(%s) %s" % (event.event_name, event.event_string) - self.callback(LogEntry(event.arrived_at, "UNKNOWN", msg, "red")) - - def _notify(self, event, msg, color="white"): - self.callback(LogEntry(event.arrived_at, event.event_name, msg, color)) - class LogPanel(panel.Panel, threading.Thread, logging.Handler): """ - Listens for and displays tor, arm, and torctl events. This can prepopulate + Listens for and displays tor, arm, and stem events. This can prepopulate from tor's log file if it exists. """ @@ -626,13 +517,14 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): # collapses duplicate log entries if false, showing only the most recent self.showDuplicates = self._config["features.log.showDuplicateEntries"] + self.loggedEvents = [] # needs to be set before we receive any events + # restricts the input to the set of events we can listen to, and # configures the controller to liten to them - loggedEvents = setEventListening(loggedEvents) + self.loggedEvents = self.setEventListening(loggedEvents) self.setPauseAttr("msgLog") # tracks the message log when we're paused self.msgLog = [] # log entries, sorted by the timestamp - self.loggedEvents = loggedEvents # events we're listening to self.regexFilter = None # filter for presented log events (no filtering if None) self.lastContentHeight = 0 # height of the rendered content when last drawn self.logFile = None # file log messages are saved to (skipped if None) @@ -666,9 +558,8 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): # leaving lastContentHeight as being too low causes initialization problems self.lastContentHeight = len(self.msgLog) - # adds listeners for tor and torctl events + # adds listeners for tor and stem events conn = torTools.getConn() - conn.addEventListener(TorEventObserver(self.registerEvent)) conn.addStatusListener(self._resetListener) # opens log file if we'll be saving entries @@ -750,6 +641,33 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): self.showDuplicates = isVisible + def registerTorEvent(self, event): + """ + Translates a stem.response.event.Event instance into a LogEvent, and calls + registerEvent(). + """ + + msg, color = ' '.join(str(event).split(' ')[1:]), "white" + + if isinstance(event, events.CircuitEvent): + color = "yellow" + elif isinstance(event, events.BandwidthEvent): + color = "cyan" + msg = "READ: %i, WRITTEN: %i" % (event.read, event.written) + elif isinstance(event, events.LogEvent): + color = RUNLEVEL_EVENT_COLOR[event.runlevel] + msg = event.message + elif isinstance(event, events.NetworkStatusEvent): + color = "blue" + elif isinstance(event, events.NewConsensusEvent): + color = "magenta" + elif isinstance(event, events.GuardEvent): + color = "yellow" + elif not event.type in TOR_EVENT_TYPES.values(): + color = "red" # unknown event type + + self.registerEvent(LogEntry(event.arrived_at, event.type, msg, color)) + def registerEvent(self, event): """ Notes event and redraws log. If paused it's held in a temporary buffer. @@ -801,7 +719,7 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): # configures the controller to listen for these tor events, and provides # back a subset without anything we're failing to listen to - setTypes = setEventListening(eventTypes) + setTypes = self.setEventListening(eventTypes) self.loggedEvents = setTypes self.redraw(True) self.valsLock.release() @@ -1217,6 +1135,35 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): self._cond.notifyAll() self._cond.release() + def setEventListening(self, events): + """ + Configures the events Tor listens for, filtering non-tor events from what we + request from the controller. This returns a sorted list of the events we + successfully set. + + Arguments: + events - event types to attempt to set + """ + + events = set(events) # drops duplicates + torEvents = events.intersection(set(TOR_EVENT_TYPES.values())) + + # adds events unrecognized by arm if we're listening to the 'UNKNOWN' type + if "UNKNOWN" in events: + torEvents.update(set(getMissingEventTypes())) + + torConn = torTools.getConn() + torConn.removeEventListener(self.registerTorEvent) + + for eventType in list(torEvents): + try: + torConn.addEventListener(self.registerTorEvent, eventType) + except stem.ProtocolError: + torEvents.remove(eventType) + + # provides back the input set minus events we failed to set + return sorted(torEvents) + def _resetListener(self, _, eventType): # if we're attaching to a new tor instance then clears the log and # prepopulates it with the content belonging to this instance @@ -1257,7 +1204,7 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): labelPattern = uiTools.cropStr(currentPattern, width - 18) panelLabel = "Events (filter: %s):" % labelPattern else: - # does the following with all runlevel types (tor, arm, and torctl): + # does the following with all runlevel types (tor, arm, and stem): # - pulls to the start of the list # - condenses range if there's three or more in a row (ex. "ARM_INFO - WARN") # - condense further if there's identical runlevel ranges for multiple diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 674e5e2..5023045 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -11,12 +11,6 @@ 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. - -from cli.logPanel import TorEventObserver - from util import connections, enum, hostnames, torConfig, torTools, uiTools COLOR_PROMPT = True # provides a colored interpretor prompt @@ -445,7 +439,12 @@ class ControlInterpretor: self.eventBuffer = [] # unread event messages self.loggedEvents = [] # event types that we're listening for - torTools.getConn().addEventListener(TorEventObserver(self.registerEvent)) + # TODO: Dropping event listening since... + # a. it was a complete hack + # b. said hack isn't worth porting to stem + # c. I'm likely about to separate the interpretor from arm anyway + + #torTools.getConn().addEventListener(TorEventObserver(self.registerEvent)) def registerEvent(self, event): """ @@ -913,8 +912,10 @@ class ControlInterpretor: except Exception, exc: outputEntry.append((str(exc), ERROR_FORMAT)) elif cmd == "SETEVENTS": + return ([], []) # dropping support, see the comment for the event listener above for why + self.loggedEvents = arg.split() - allEvents = torTools.getConn().setControllerEvents(self.loggedEvents) + #allEvents = torTools.getConn().setControllerEvents(self.loggedEvents) setEvents = set(self.loggedEvents).intersection(allEvents) if setEvents: diff --git a/src/util/torTools.py b/src/util/torTools.py index 36cb70f..d261bb0 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -38,14 +38,6 @@ DIR_SERVERS = [("86.59.21.38", "80"), # tor26 # message logged by default when a controller can't set an event type DEFAULT_FAILED_EVENT_MSG = "Unsupported event type: %s" -# TODO: check version when reattaching to controller and if version changes, flush? -# Skips attempting to set events we've failed to set before. This avoids -# logging duplicate warnings but can be problematic if controllers belonging -# to multiple versions of tor are attached, making this unreflective of the -# controller's capabilites. However, this is a pretty bizarre edge case. -DROP_FAILED_EVENTS = True -FAILED_EVENTS = set() - CONTROLLER = None # singleton Controller instance UNDEFINED = "<Undefined_ >" @@ -493,7 +485,6 @@ class Controller(TorCtl.PostEventListener): 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.statusListeners = [] # callback functions for tor's state changes self.controllerEvents = [] # list of successfully set controller events self._fingerprintMappings = None # mappings of ip -> [(port, fingerprint), ...] @@ -541,6 +532,9 @@ class Controller(TorCtl.PostEventListener): 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: self.connLock.acquire() @@ -550,8 +544,11 @@ class Controller(TorCtl.PostEventListener): 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) + self.controller.add_event_listener(self.msg_event, stem.control.EventType.NOTICE) + self.controller.add_event_listener(self.ns_event, stem.control.EventType.NS) + self.controller.add_event_listener(self.new_consensus_event, stem.control.EventType.NEWCONSENSUS) + self.controller.add_event_listener(self.new_desc_event, stem.control.EventType.NEWDESC) + self.controller.add_event_listener(self.circ_status_event, stem.control.EventType.CIRC) # registers this as our first heartbeat self._updateHeartbeat() @@ -570,10 +567,6 @@ class Controller(TorCtl.PostEventListener): self._isExitingAllowed = self._exitPolicyChecker.isExitingAllowed() self._exitPolicyLookupCache = {} - # sets the events listened for by the new controller (incompatible events - # are dropped with a logged warning) - self.setControllerEvents(self.controllerEvents) - self._status = State.INIT self._statusTime = time.time() @@ -1387,19 +1380,24 @@ class Controller(TorCtl.PostEventListener): return result - def addEventListener(self, listener): + def addEventListener(self, listener, *eventTypes): """ Directs further tor controller events to callback functions of the listener. If a new control connection is initialized then this listener is reattached. + """ - Arguments: - listener - TorCtl.PostEventListener instance listening for events + self.connLock.acquire() + if self.isAlive(): self.controller.add_event_listener(listener, *eventTypes) + self.connLock.release() + + def removeEventListener(self, listener): + """ + Stops the given event listener from being notified of further events. """ self.connLock.acquire() - self.eventListeners.append(listener) - if self.isAlive(): self.conn.add_event_listener(listener) + if self.isAlive(): self.controller.remove_event_listener(listener) self.connLock.release() def addStatusListener(self, callback): @@ -1435,92 +1433,6 @@ class Controller(TorCtl.PostEventListener): return list(self.controllerEvents) - def setControllerEvents(self, events): - """ - Sets the events being requested from any attached tor instance, logging - warnings for event types that aren't supported (possibly due to version - issues). Events in REQ_EVENTS will also be included, logging at the error - level with an additional description in case of failure. - - This remembers the successfully set events and tries to request them from - any tor instance it attaches to in the future too (again logging and - dropping unsuccessful event types). - - This returns the listing of event types that were successfully set. If not - currently attached to a tor instance then all events are assumed to be ok, - then attempted when next attached to a control port. - - Arguments: - events - listing of events to be set - """ - - self.connLock.acquire() - - returnVal = [] - if self.isAlive(): - events = set(events) - events = events.union(set(REQ_EVENTS.keys())) - unavailableEvents = set() - - # removes anything we've already failed to set - if DROP_FAILED_EVENTS: - unavailableEvents.update(events.intersection(FAILED_EVENTS)) - events.difference_update(FAILED_EVENTS) - - # initial check for event availability, using the 'events/names' GETINFO - # option to detect invalid events - validEvents = self.getInfo("events/names", None) - - if validEvents: - validEvents = set(validEvents.split()) - unavailableEvents.update(events.difference(validEvents)) - events.intersection_update(validEvents) - - # attempt to set events via trial and error - isEventsSet, isAbandoned = False, False - - while not isEventsSet and not isAbandoned: - try: - self.conn.set_events(list(events)) - isEventsSet = True - except TorCtl.ErrorReply, exc: - msg = str(exc) - - if "Unrecognized event" in msg: - # figure out type of event we failed to listen for - start = msg.find("event \"") + 7 - end = msg.rfind("\"") - failedType = msg[start:end] - - unavailableEvents.add(failedType) - events.discard(failedType) - else: - # unexpected error, abandon attempt - isAbandoned = True - except TorCtl.TorCtlClosed: - self.close() - isAbandoned = True - - FAILED_EVENTS.update(unavailableEvents) - if not isAbandoned: - # logs warnings or errors for failed events - for eventType in unavailableEvents: - defaultMsg = DEFAULT_FAILED_EVENT_MSG % eventType - if eventType in REQ_EVENTS: - log.log(log.ERR, defaultMsg + " (%s)" % REQ_EVENTS[eventType]) - else: - log.log(log.WARN, defaultMsg) - - self.controllerEvents = list(events) - returnVal = list(events) - else: - # attempts to set the events when next attached to a control port - self.controllerEvents = list(events) - returnVal = list(events) - - self.connLock.release() - return returnVal - def reload(self, issueSighup = False): """ This resets tor (sending a RELOAD signal to the control port) causing tor's @@ -1631,7 +1543,7 @@ class Controller(TorCtl.PostEventListener): causing the torrc and internal state to be reset. """ - if event.level == "NOTICE" and event.msg.startswith("Received reload signal (hup)"): + if event.runlevel == "NOTICE" and event.message.startswith("Received reload signal (hup)"): self.connLock.acquire() if self.isAlive(): @@ -1652,8 +1564,8 @@ class Controller(TorCtl.PostEventListener): myFingerprint = self.getInfo("fingerprint", None) if myFingerprint: - for ns in event.nslist: - if ns.idhex == myFingerprint: + for desc in event.desc: + if desc.fingerprint == myFingerprint: self._cachedParam["nsEntry"] = None self._cachedParam["flags"] = None self._cachedParam["bwMeasured"] = None @@ -1681,7 +1593,7 @@ class Controller(TorCtl.PostEventListener): self._consensusLookupCache = {} if self._fingerprintMappings != None: - self._fingerprintMappings = self._getFingerprintMappings(event.nslist) + self._fingerprintMappings = self._getFingerprintMappings(event.desc) self.connLock.release() @@ -1691,7 +1603,9 @@ class Controller(TorCtl.PostEventListener): self.connLock.acquire() myFingerprint = self.getInfo("fingerprint", None) - if not myFingerprint or myFingerprint in event.idlist: + desc_fingerprints = [fingerprint for (fingerprint, nickname) in event.relays] + + if not myFingerprint or myFingerprint in desc_fingerprints: self._cachedParam["descEntry"] = None self._cachedParam["bwObserved"] = None @@ -1702,32 +1616,26 @@ class Controller(TorCtl.PostEventListener): self._descriptorLookupCache = {} if self._fingerprintMappings != None: - for fingerprint in event.idlist: + for fingerprint in desc_fingerprints: # gets consensus data for the new descriptor - try: nsLookup = self.conn.get_network_status("id/%s" % fingerprint) - except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed): continue - - if len(nsLookup) > 1: - # multiple records for fingerprint (shouldn't happen) - log.log(log.WARN, "Multiple consensus entries for fingerprint: %s" % fingerprint) - continue + try: desc = self.controller.get_network_status(fingerprint) + except stem.ControllerError: continue # updates fingerprintMappings with new data - newRelay = nsLookup[0] - if newRelay.ip in self._fingerprintMappings: + if desc.address in self._fingerprintMappings: # if entry already exists with the same orport, remove it orportMatch = None - for entryPort, entryFingerprint in self._fingerprintMappings[newRelay.ip]: - if entryPort == newRelay.orport: + for entryPort, entryFingerprint in self._fingerprintMappings[desc.address]: + if entryPort == desc.or_port: orportMatch = (entryPort, entryFingerprint) break - if orportMatch: self._fingerprintMappings[newRelay.ip].remove(orportMatch) + if orportMatch: self._fingerprintMappings[desc.address].remove(orportMatch) # add the new entry - self._fingerprintMappings[newRelay.ip].append((newRelay.orport, newRelay.idhex)) + self._fingerprintMappings[desc.address].append((desc.or_port, desc.fingerprint)) else: - self._fingerprintMappings[newRelay.ip] = [(newRelay.orport, newRelay.idhex)] + self._fingerprintMappings[desc.address] = [(desc.or_port, desc.fingerprint)] self.connLock.release() @@ -1742,27 +1650,6 @@ class Controller(TorCtl.PostEventListener): self._cachedParam["circuits"] = None - def buildtimeout_set_event(self, event): - self._updateHeartbeat() - - def stream_status_event(self, event): - self._updateHeartbeat() - - def or_conn_status_event(self, event): - self._updateHeartbeat() - - def stream_bw_event(self, event): - self._updateHeartbeat() - - def bandwidth_event(self, event): - self._updateHeartbeat() - - def address_mapped_event(self, event): - self._updateHeartbeat() - - def unknown_event(self, event): - self._updateHeartbeat() - def _updateHeartbeat(self): """ Called on any event occurance to note the time it occured. @@ -1771,26 +1658,25 @@ class Controller(TorCtl.PostEventListener): # alternative is to use the event's timestamp (via event.arrived_at) self.lastHeartbeat = time.time() - def _getFingerprintMappings(self, nsList = None): + def _getFingerprintMappings(self, descriptors = None): """ Provides IP address to (port, fingerprint) tuple mappings for all of the currently cached relays. Arguments: - nsList - network status listing (fetched if not provided) + descriptors - router status entries (fetched if not provided) """ results = {} if self.isAlive(): # fetch the current network status if not provided - if not nsList: - try: nsList = self.conn.get_network_status(get_iterator=True) - except (socket.error, TorCtl.TorCtlClosed, TorCtl.ErrorReply): nsList = [] + if not descriptors: + try: descriptors = self.controller.get_network_statuses() + except stem.ControllerError: descriptors = [] # construct mappings of ips to relay data - for relay in nsList: - if relay.ip in results: results[relay.ip].append((relay.orport, relay.idhex)) - else: results[relay.ip] = [(relay.orport, relay.idhex)] + for desc in descriptors: + results.setdefault(desc.address, []).append((desc.or_port, desc.fingerprint)) return results

1 0

[arm/master] Using stem to send remaining signals
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 0c1ee97cd1edeed9141ce9c78c6a5db953bf242e Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 18:56:31 2012 -0800 Using stem to send remaining signals On first look this is the last of our TorCtl connection usage. Hazaa! --- src/util/torTools.py | 10 +++++++--- 1 files changed, 7 insertions(+), 3 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 0875a05..056c454 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -13,6 +13,7 @@ import threading import Queue import stem +import stem.control from TorCtl import TorCtl from util import connections, enum, log, procTools, sysTools, uiTools @@ -1450,7 +1451,7 @@ class Controller(TorCtl.PostEventListener): if self.isAlive(): if not issueSighup: try: - self.conn.send_signal("RELOAD") + self.controller.signal(stem.Signal.RELOAD) self._cachedParam = {} except Exception, exc: # new torrc parameters caused an error (tor's likely shut down) @@ -1519,8 +1520,11 @@ class Controller(TorCtl.PostEventListener): if self.isAlive(): try: isRelay = self.getOption("ORPort", None) != None - signal = "HALT" if force else "SHUTDOWN" - self.conn.send_signal(signal) + + if force: + stem.controller.signal(stem.Signal.HALT) + else: + stem.controller.signal(stem.Signal.SHUTDOWN) # shuts down control connection if we aren't making a delayed shutdown if force or not isRelay: self.close()

1 0

[arm/master] Using stem to track the connection's heartbeat
by atagar＠torproject.org 17 Dec '12

17 Dec '12

commit 1e16e9cb75846798a864952ff2829f71f65a6d5a Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Dec 16 18:54:16 2012 -0800 Using stem to track the connection's heartbeat Dropping our heartbeat tracking with stem's. --- src/util/torTools.py | 25 ++----------------------- 1 files changed, 2 insertions(+), 23 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index d261bb0..0875a05 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -499,7 +499,6 @@ class Controller(TorCtl.PostEventListener): self._status = State.CLOSED # current status of the attached control port self._statusTime = 0 # unix time-stamp for the duration of the status self._lastNewnym = 0 # time we last sent a NEWNYM signal - self.lastHeartbeat = 0 # time of the last tor event # Status signaling for when tor starts, stops, or is reset is done via # enquing the signal then spawning a handler thread. This is to provide @@ -550,9 +549,6 @@ class Controller(TorCtl.PostEventListener): self.controller.add_event_listener(self.new_desc_event, stem.control.EventType.NEWDESC) self.controller.add_event_listener(self.circ_status_event, stem.control.EventType.CIRC) - # registers this as our first heartbeat - self._updateHeartbeat() - # reset caches for ip -> fingerprint lookups self._fingerprintMappings = None self._fingerprintLookupCache = {} @@ -622,12 +618,10 @@ class Controller(TorCtl.PostEventListener): def getHeartbeat(self): """ - Provides the time of the last registered tor event (if listening for BW - events then this should occure every second if relay's still responsive). - This returns zero if this has never received an event. + Provides the time of the last registered tor message. """ - return self.lastHeartbeat + return self.controller.get_latest_heartbeat() def getInfo(self, param, default = UNDEFINED): """ @@ -1559,7 +1553,6 @@ class Controller(TorCtl.PostEventListener): self.connLock.release() def ns_event(self, event): - self._updateHeartbeat() self._consensusLookupCache = {} myFingerprint = self.getInfo("fingerprint", None) @@ -1576,8 +1569,6 @@ class Controller(TorCtl.PostEventListener): self._cachedParam["bwMeasured"] = None def new_consensus_event(self, event): - self._updateHeartbeat() - self.connLock.acquire() self._cachedParam["nsEntry"] = None @@ -1598,8 +1589,6 @@ class Controller(TorCtl.PostEventListener): self.connLock.release() def new_desc_event(self, event): - self._updateHeartbeat() - self.connLock.acquire() myFingerprint = self.getInfo("fingerprint", None) @@ -1640,8 +1629,6 @@ class Controller(TorCtl.PostEventListener): self.connLock.release() def circ_status_event(self, event): - self._updateHeartbeat() - # CIRC events aren't required, but if one's received then flush this cache # since it uses circuit-status results. self.connLock.acquire() @@ -1650,14 +1637,6 @@ class Controller(TorCtl.PostEventListener): self._cachedParam["circuits"] = None - def _updateHeartbeat(self): - """ - Called on any event occurance to note the time it occured. - """ - - # alternative is to use the event's timestamp (via event.arrived_at) - self.lastHeartbeat = time.time() - def _getFingerprintMappings(self, descriptors = None): """ Provides IP address to (port, fingerprint) tuple mappings for all of the

1 0

[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

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits December 2012