- tor-commits - lists.torproject.org

[tor/maint-0.2.2] Update documentation comment for rend_client_reextend_intro_circuit
by nickm＠torproject.org 11 Oct '11

11 Oct '11

commit 9648f034c07603a7430b08386172e7a9c0759847 Author: Robert Ransom <rransom.8774(a)gmail.com> Date: Mon Oct 10 05:33:53 2011 -0700 Update documentation comment for rend_client_reextend_intro_circuit One of its callers assumes a non-zero result indicates a permanent failure (i.e. the current attempt to connect to this HS either has failed or is doomed). The other caller only requires that this function's result never equal -2. Bug reported by Sebastian Hahn. --- src/or/rendclient.c | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/or/rendclient.c b/src/or/rendclient.c index 9c247f5..f84475a 100644 --- a/src/or/rendclient.c +++ b/src/or/rendclient.c @@ -80,8 +80,8 @@ rend_client_send_establish_rendezvous(origin_circuit_t *circ) /** Extend the introduction circuit <b>circ</b> to another valid * introduction point for the hidden service it is trying to connect * to, or mark it and launch a new circuit if we can't extend it. - * Return 0 on success. Return -1 and mark the introduction - * circuit on failure. + * Return 0 on success or possible success. Return -1 and mark the + * introduction circuit for close on permanent failure. * * On failure, the caller is responsible for marking the associated * rendezvous circuit for close. */

1 0

[tor/master] Fix a compile warning on OS X 10.6 and up
by nickm＠torproject.org 11 Oct '11

11 Oct '11

commit cce85c819b4a9c20562f7860cbe2a8020123ebff Author: Sebastian Hahn <sebastian(a)torproject.org> Date: Tue Oct 11 02:25:00 2011 +0200 Fix a compile warning on OS X 10.6 and up --- src/common/util.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-) diff --git a/src/common/util.c b/src/common/util.c index 9df7a50..79e09e4 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -3894,7 +3894,9 @@ get_string_from_pipe(FILE *stream, char *buf_out, size_t count) char *retval; size_t len; - retval = fgets(buf_out, count, stream); + tor_assert(count <= INT_MAX); + + retval = fgets(buf_out, (int)count, stream); if (!retval) { if (feof(stream)) {

1 0

[tor/master] Merge remote-tracking branch 'sebastian/osxcompile'
by nickm＠torproject.org 11 Oct '11

11 Oct '11

commit b5edc838f283c50e8de378e3037a999736d9bbf4 Merge: b4bd836 cce85c8 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Oct 10 22:03:20 2011 -0400 Merge remote-tracking branch 'sebastian/osxcompile' src/common/util.c | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)

1 0

[tor/master] Consider hibernation before dropping privs
by nickm＠torproject.org 11 Oct '11

11 Oct '11

commit b4bd836f46549b6263c8c55eb3bc127884b72340 Author: Sebastian Hahn <sebastian(a)torproject.org> Date: Tue Oct 11 02:40:06 2011 +0200 Consider hibernation before dropping privs Without this patch, Tor wasn't sure whether it would be hibernating or not, so it postponed opening listeners until after the privs had been dropped. This doesn't work so well for low ports. Bug was introduced in the fix for bug 2003. Fixes bug 4217, reported by Zax and katmagic. Thanks! --- src/or/config.c | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/src/or/config.c b/src/or/config.c index 2705ba5..1304c46 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -1080,6 +1080,9 @@ options_act_reversible(const or_options_t *old_options, char **msg) if (parse_client_ports(options, 0, msg, &n_client_ports)) return -1; + /* Set the hibernation state appropriately.*/ + consider_hibernation(time(NULL)); + /* Launch the listeners. (We do this before we setuid, so we can bind to * ports under 1024.) We don't want to rebind if we're hibernating. */ if (!we_are_hibernating()) {

1 0

[torbrowser/maint-2.2] Fix for 4192.
by erinn＠torproject.org 10 Oct '11

10 Oct '11

commit dd8d5dcb03ffaf2d15747608178a9d3b2888f559 Author: Mike Perry <mikeperry-git(a)fscked.org> Date: Sun Oct 9 22:55:00 2011 -0700 Fix for 4192. It ain't pretty. It just exits if we don't have a TBB profile. --- ...owser-exit-when-not-launched-from-Vidalia.patch | 46 ++++++++++++++++++++ 1 files changed, 46 insertions(+), 0 deletions(-) diff --git a/src/current-patches/0009-Make-Tor-Browser-exit-when-not-launched-from-Vidalia.patch b/src/current-patches/0009-Make-Tor-Browser-exit-when-not-launched-from-Vidalia.patch new file mode 100644 index 0000000..6659770 --- /dev/null +++ b/src/current-patches/0009-Make-Tor-Browser-exit-when-not-launched-from-Vidalia.patch @@ -0,0 +1,46 @@ +From 369d7df54fe13dd69a069a43959bdabcc364e6e4 Mon Sep 17 00:00:00 2001 +From: Mike Perry <mikeperry-git(a)fscked.org> +Date: Sun, 9 Oct 2011 22:50:07 -0700 +Subject: [PATCH] Make Tor Browser exit when not launched from Vidalia + +Turns out the Windows 7 UI encourages users to "dock" their Tor Browser app +for easy relaunch. If they manage to do this, we should fail closed rather +than opened. Hopefully they will get the hint and dock Vidalia instead. + +This is an emergency fix for +https://trac.torproject.org/projects/tor/ticket/4192. We can do a better +localized fix w/ a translated alert menu later, if it seems like this might +actually be common. +--- + browser/base/content/browser.js | 15 +++++++++++++++ + 1 files changed, 15 insertions(+), 0 deletions(-) + +diff --git a/browser/base/content/browser.js b/browser/base/content/browser.js +index 50f6963..ed2812c 100644 +--- a/browser/base/content/browser.js ++++ b/browser/base/content/browser.js +@@ -1203,6 +1203,21 @@ function BrowserStartup() { + + prepareForStartup(); + ++ // If this is not a TBB profile, exit. ++ // Solves https://trac.torproject.org/projects/tor/ticket/4192 ++ var foundPref = false; ++ try { ++ foundPref = gPrefService.prefHasUserValue("torbrowser.version"); ++ } catch(e) { ++ //dump("No pref: "+e); ++ } ++ if(!foundPref) { ++ var appStartup = Components.classes["@mozilla.org/toolkit/app-startup;1"] ++ .getService(Components.interfaces.nsIAppStartup); ++ appStartup.quit(3); // Force all windows to close, and then quit. ++ } ++ ++ + if (uriToLoad && !isLoadingBlank) { + if (uriToLoad instanceof Ci.nsISupportsArray) { + let count = uriToLoad.Count(); +-- +1.7.3.4 +

1 0

[torbrowser/maint-2.2] Merge branch 'bug4192' into maint-2.2
by erinn＠torproject.org 10 Oct '11

10 Oct '11

commit 8b4c144be4445da48d8749c00475a48ce35a48f0 Merge: 022c82c dd8d5dc Author: Erinn Clark <erinn(a)torproject.org> Date: Mon Oct 10 17:32:55 2011 +0100 Merge branch 'bug4192' into maint-2.2 ...owser-exit-when-not-launched-from-Vidalia.patch | 46 ++++++++++++++++++++ 1 files changed, 46 insertions(+), 0 deletions(-)

1 0

r25160: {website} Attempt to fix download links on some mirrors Report by exa (website/trunk/include)
by Sebastian Hahn 10 Oct '11

10 Oct '11

Author: sebastian Date: 2011-10-10 18:49:17 +0000 (Mon, 10 Oct 2011) New Revision: 25160 Modified: website/trunk/include/versions.wmi Log: Attempt to fix download links on some mirrors Report by exa from #tor, thanks! Modified: website/trunk/include/versions.wmi =================================================================== --- website/trunk/include/versions.wmi 2011-10-09 08:09:12 UTC (rev 25159) +++ website/trunk/include/versions.wmi 2011-10-10 18:49:17 UTC (rev 25160) @@ -59,47 +59,47 @@ <define-tag version-androidbundle-libevent whitespace=delete>libevent-1.4.12-stable</define-tag> <define-tag package-androidbundle-alpha whitespace=delete>dist/android/<version-androidbundle-tor>-orbot-<version-androidbundle-orbot>.apk</define-tag> -<define-tag package-win32-stable whitespace=delete>/dist/win32/tor-<version-win32-stable>-win32.exe</define-tag> -<define-tag package-win32-alpha whitespace=delete>/dist/win32/tor-<version-win32-alpha>-win32.exe</define-tag> +<define-tag package-win32-stable whitespace=delete>../dist/win32/tor-<version-win32-stable>-win32.exe</define-tag> +<define-tag package-win32-alpha whitespace=delete>../dist/win32/tor-<version-win32-alpha>-win32.exe</define-tag> <define-tag file-win32-bundle-stable whitespace=delete>vidalia-bundle-<version-win32-bundle-stable>-0.2.14.exe</define-tag> -<define-tag package-win32-bundle-stable whitespace=delete>/dist/vidalia-bundles/<file-win32-bundle-stable></define-tag> +<define-tag package-win32-bundle-stable whitespace=delete>../dist/vidalia-bundles/<file-win32-bundle-stable></define-tag> <define-tag file-win32-bundle-alpha whitespace=delete>vidalia-bundle-<version-win32-bundle-alpha>-0.2.14.exe</define-tag> -<define-tag package-win32-bundle-alpha whitespace=delete>/dist/vidalia-bundles/<file-win32-bundle-alpha></define-tag> +<define-tag package-win32-bundle-alpha whitespace=delete>../dist/vidalia-bundles/<file-win32-bundle-alpha></define-tag> <define-tag file-win32-bridge-bundle-stable whitespace=delete>vidalia-bridge-bundle-<version-win32-bundle-stable>-0.2.14.exe</define-tag> -<define-tag package-win32-bridge-bundle-stable whitespace=delete>/dist/vidalia-bundles/<file-win32-bridge-bundle-stable></define-tag> +<define-tag package-win32-bridge-bundle-stable whitespace=delete>../dist/vidalia-bundles/<file-win32-bridge-bundle-stable></define-tag> <define-tag file-win32-bridge-bundle-alpha whitespace=delete>vidalia-bridge-bundle-<version-win32-bundle-alpha>-0.2.14.exe</define-tag> -<define-tag package-win32-bridge-bundle-alpha whitespace=delete>/dist/vidalia-bundles/<file-win32-bridge-bundle-alpha></define-tag> +<define-tag package-win32-bridge-bundle-alpha whitespace=delete>../dist/vidalia-bundles/<file-win32-bridge-bundle-alpha></define-tag> <define-tag file-win32-relay-bundle-stable whitespace=delete>vidalia-relay-bundle-<version-win32-bundle-stable>-0.2.14.exe</define-tag> -<define-tag package-win32-relay-bundle-stable whitespace=delete>/dist/vidalia-bundles/<file-win32-relay-bundle-stable></define-tag> +<define-tag package-win32-relay-bundle-stable whitespace=delete>../dist/vidalia-bundles/<file-win32-relay-bundle-stable></define-tag> <define-tag file-win32-relay-bundle-alpha whitespace=delete>vidalia-relay-bundle-<version-win32-bundle-alpha>-0.2.14.exe</define-tag> -<define-tag package-win32-relay-bundle-alpha whitespace=delete>/dist/vidalia-bundles/<file-win32-relay-bundle-alpha></define-tag> +<define-tag package-win32-relay-bundle-alpha whitespace=delete>../dist/vidalia-bundles/<file-win32-relay-bundle-alpha></define-tag> <define-tag file-win32-exit-bundle-stable whitespace=delete>vidalia-exit-bundle-<version-win32-bundle-stable>-0.2.14.exe</define-tag> -<define-tag package-win32-exit-bundle-stable whitespace=delete>/dist/vidalia-bundles/<file-win32-exit-bundle-stable></define-tag> +<define-tag package-win32-exit-bundle-stable whitespace=delete>../dist/vidalia-bundles/<file-win32-exit-bundle-stable></define-tag> <define-tag file-win32-exit-bundle-alpha whitespace=delete>vidalia-exit-bundle-<version-win32-bundle-alpha>-0.2.14.exe</define-tag> -<define-tag package-win32-exit-bundle-alpha whitespace=delete>/dist/vidalia-bundles/<file-win32-exit-bundle-alpha></define-tag> +<define-tag package-win32-exit-bundle-alpha whitespace=delete>../dist/vidalia-bundles/<file-win32-exit-bundle-alpha></define-tag> <define-tag file-osx-x86-bundle-stable whitespace=delete>vidalia-bundle-<version-osx-x86-bundle-stable>-0.2.14-i386.dmg</define-tag> -<define-tag package-osx-x86-bundle-stable whitespace=delete>/dist/vidalia-bundles/<file-osx-x86-bundle-stable></define-tag> +<define-tag package-osx-x86-bundle-stable whitespace=delete>../dist/vidalia-bundles/<file-osx-x86-bundle-stable></define-tag> <define-tag file-osx-x86-bundle-alpha whitespace=delete>vidalia-bundle-<version-osx-x86-bundle-alpha>-0.2.14-i386.dmg</define-tag> -<define-tag package-osx-x86-bundle-alpha whitespace=delete>/dist/vidalia-bundles/<file-osx-x86-bundle-alpha></define-tag> +<define-tag package-osx-x86-bundle-alpha whitespace=delete>../dist/vidalia-bundles/<file-osx-x86-bundle-alpha></define-tag> -<define-tag package-osx-ppc-bundle-stable whitespace=delete>/dist/vidalia-bundles/vidalia-bundle-<version-osx-ppc-bundle-stable>-0.2.14-ppc.dmg</define-tag> -<define-tag package-osx-ppc-bundle-alpha whitespace=delete>/dist/vidalia-bundles/vidalia-bundle-<version-osx-ppc-bundle-alpha>-0.2.14-ppc.dmg</define-tag> +<define-tag package-osx-ppc-bundle-stable whitespace=delete>../dist/vidalia-bundles/vidalia-bundle-<version-osx-ppc-bundle-stable>-0.2.14-ppc.dmg</define-tag> +<define-tag package-osx-ppc-bundle-alpha whitespace=delete>../dist/vidalia-bundles/vidalia-bundle-<version-osx-ppc-bundle-alpha>-0.2.14-ppc.dmg</define-tag> -<define-tag package-osx-x86-stable whitespace=delete>/dist/osx-x86/Tor-<version-osx-stable>-i386-Bundle.dmg</define-tag> -<define-tag package-osx-x86-alpha whitespace=delete>/dist/osx-x86/Tor-<version-osx-alpha>-i386-Bundle.dmg</define-tag> +<define-tag package-osx-x86-stable whitespace=delete>../dist/osx-x86/Tor-<version-osx-stable>-i386-Bundle.dmg</define-tag> +<define-tag package-osx-x86-alpha whitespace=delete>../dist/osx-x86/Tor-<version-osx-alpha>-i386-Bundle.dmg</define-tag> -<define-tag package-osx-ppc-stable whitespace=delete>/dist/osx-ppc/Tor-<version-osx-ppc-stable>-ppc-Bundle.dmg</define-tag> -<define-tag package-osx-ppc-alpha whitespace=delete>/dist/osx-ppc/Tor-<version-osx-ppc-alpha>-ppc-Bundle.dmg</define-tag> +<define-tag package-osx-ppc-stable whitespace=delete>../dist/osx-ppc/Tor-<version-osx-ppc-stable>-ppc-Bundle.dmg</define-tag> +<define-tag package-osx-ppc-alpha whitespace=delete>../dist/osx-ppc/Tor-<version-osx-ppc-alpha>-ppc-Bundle.dmg</define-tag> <define-tag file-source-stable whitespace=delete>tor-<version-stable>.tar.gz</define-tag> -<define-tag package-source-stable whitespace=delete>/dist/<file-source-stable></define-tag> +<define-tag package-source-stable whitespace=delete>../dist/<file-source-stable></define-tag> <define-tag file-source-alpha whitespace=delete>tor-<version-alpha>.tar.gz</define-tag> -<define-tag package-source-alpha whitespace=delete>/dist/<file-source-alpha></define-tag> +<define-tag package-source-alpha whitespace=delete>../dist/<file-source-alpha></define-tag> <define-tag version-torbutton whitespace=delete>1.4.4 (9 Oct 2011)</define-tag> <define-tag version-hash-torbutton whitespace=delete>sha1:3f352e7d8577fc576a9011d858a8b34f4fea4b09</define-tag>

1 0

[stem/master] Adding logging utility
by atagar＠torproject.org 10 Oct '11

10 Oct '11

commit 00739ee4ebf3c74d1451225c026a90ab52eed711 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Oct 8 23:23:08 2011 -0700 Adding logging utility Borrowing the logger from arm, with some refactoring to remove unneeded functions and make it conform with this project's coding conventions. --- stem/util/log.py | 147 +++++++++++++++++++++++++++++++++++++++++++++++++++++ stem/util/term.py | 2 +- 2 files changed, 148 insertions(+), 1 deletions(-) diff --git a/stem/util/log.py b/stem/util/log.py new file mode 100644 index 0000000..dae2e2a --- /dev/null +++ b/stem/util/log.py @@ -0,0 +1,147 @@ +""" +Tracks application events, both directing them to attached listeners and +keeping a record of them. A limited space is provided for old events, keeping +and trimming them on a per-runlevel basis (ie, too many DEBUG events will only +result in entries from that runlevel being dropped). All functions are thread +safe. +""" + +import time +from sys import maxint +from threading import RLock + +from stem.util import enum + +# Logging runlevels. These are *very* commonly used so including shorter +# aliases (so they can be referenced as log.DEBUG, log.WARN, etc). +Runlevel = enum.Enum(*[(v, v) for v in ("DEBUG", "INFO", "NOTICE", "WARN", "ERR")]) +DEBUG, INFO, NOTICE, WARN, ERR = Runlevel.values() + +LOG_LOCK = RLock() # provides thread safety for logging operations +MAX_LOG_SIZE = 1000 # maximum log entries per runlevel to be persisted + +# chronologically ordered records of events for each runlevel, stored as tuples +# consisting of: (time, message) +_backlog = dict([(level, []) for level in Runlevel.values()]) + +# mapping of runlevels to the listeners interested in receiving events from it +_listeners = dict([(level, []) for level in Runlevel.values()]) + +def log(level, msg, event_time = None): + """ + Registers an event, directing it to interested listeners and preserving it in + the backlog. + + Arguments: + level (Runlevel) - runlevel corresponding to the message severity + msg (str) - string associated with the message + event_time (int) - unix time at which the event occurred, current time if + undefined + """ + + if event_time == None: event_time = time.time() + + LOG_LOCK.acquire() + try: + new_event = (event_time, msg) + event_backlog = _backlog[level] + + # inserts the new event into the backlog + if not event_backlog or event_time >= event_backlog[-1][0]: + # newest event - append to end + event_backlog.append(new_event) + elif event_time <= event_backlog[0][0]: + # oldest event - insert at start + event_backlog.insert(0, new_event) + else: + # somewhere in the middle - start checking from the end + for i in range(len(event_backlog) - 1, -1, -1): + if event_backlog[i][0] <= event_time: + event_backlog.insert(i + 1, new_event) + break + + # truncates backlog if too long + to_delete = len(event_backlog) - MAX_LOG_SIZE + if to_delete > 0: del event_backlog[:to_delete] + + # notifies listeners + for callback in _listeners[level]: + callback(level, msg, event_time) + finally: + LOG_LOCK.release() + +def add_listener(levels, callback, dump_backlog = False): + """ + Directs future events to the given callback function. + + Arguments: + levels (list) - runlevels for the listener to be notified of + callback (functor) - functor to accept the events, of the form: + my_function(runlevel, msg, time) + dump_backlog (bool) - if true then this passes prior events to the callback + function (in chronological order) before returning + """ + + LOG_LOCK.acquire() + try: + for level in levels: + if not callback in _listeners[level]: + _listeners[level].append(callback) + + if dump_backlog: + for level, msg, event_time in _get_entries(levels): + callback(level, msg, event_time) + finally: + LOG_LOCK.release() + +def remove_listener(level, callback): + """ + Prevents a listener from being notified of further events. + + Arguments: + level (Runlevel) - runlevel for the listener to be removed from + callback (functor) - functor to be removed + + Returns: + True if a listener was removed, False otherwise + """ + + if callback in _listeners[level]: + _listeners[level].remove(callback) + return True + else: return False + +def _get_entries(levels): + """ + Generator for providing past events belonging to the given runlevels (in + chronological order). This should be used under the LOG_LOCK to prevent + concurrent modifications. + + Arguments: + levels (list) - runlevels for which events are provided + """ + + # drops any runlevels if there aren't entries in it + to_remove = [level for level in levels if not _backlog[level]] + for level in to_remove: levels.remove(level) + + # tracks where unprocessed entries start in the backlog + backlog_ptr = dict([(level, 0) for level in levels]) + + while levels: + earliest_level, earliest_msg, earliest_time = None, "", maxint + + # finds the earliest unprocessed event + for level in levels: + entry = _backlog[level][backlog_ptr[level]] + + if entry[0] < earliest_time: + earliest_level, earliest_msg, earliest_time = level, entry[1], entry[0] + + yield (earliest_level, earliest_msg, earliest_time) + + # removes runlevel if there aren't any more entries + backlog_ptr[earliest_level] += 1 + if len(_backlog[earliest_level]) <= backlog_ptr[earliest_level]: + levels.remove(earliest_level) + diff --git a/stem/util/term.py b/stem/util/term.py index 7f3449e..a2465a2 100644 --- a/stem/util/term.py +++ b/stem/util/term.py @@ -2,7 +2,7 @@ Utilities for working with the terminal. """ -import enum +from stem.util import enum TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE")

1 0

[stem/master] General system utilities
by atagar＠torproject.org 10 Oct '11

10 Oct '11

commit 1aff6b875213d70a05d0cb5d86a5ff9914ce6e41 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Oct 9 03:24:44 2011 -0700 General system utilities Adding some simple utility functions that I'll need later. These are rewrites of their arm counterparts, which I wrote before discovering the subprocess module. --- stem/util/__init__.py | 2 +- stem/util/system.py | 109 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 110 insertions(+), 1 deletions(-) diff --git a/stem/util/__init__.py b/stem/util/__init__.py index e079d62..b778b6f 100644 --- a/stem/util/__init__.py +++ b/stem/util/__init__.py @@ -2,5 +2,5 @@ Utility functions used by the stem library. """ -__all__ = ["enum", "term"] +__all__ = ["enum", "system", "term"] diff --git a/stem/util/system.py b/stem/util/system.py new file mode 100644 index 0000000..3c520e8 --- /dev/null +++ b/stem/util/system.py @@ -0,0 +1,109 @@ +""" +Helper functions for working with the underlying system. These are mostly os +dependent, only working on linux, osx, and bsd. +""" + +import os +import time +import subprocess + +from stem.util import log + +# Mapping of commands to if they're available or not. This isn't always +# reliable, failing for some special commands. For these the cache is +# prepopulated to skip lookups. +CMD_AVAILABLE_CACHE = {"ulimit": True} + +def is_available(command, cached=True): + """ + Checks the current PATH to see if a command is available or not. If more + than one command is present (for instance "ls -a | grep foo") then this + just checks the first. + + Arguments: + command (str) - command to search for + cached (bool) - makes use of available cached results if True + + Returns: + True if an executable we can use by that name exists in the PATH, False + otherwise + """ + + if " " in command: command = command.split(" ")[0] + + if cached and command in CMD_AVAILABLE_CACHE: + return CMD_AVAILABLE_CACHE[command] + else: + cmd_exists = False + for path in os.environ["PATH"].split(os.pathsep): + cmd_path = os.path.join(path, command) + + if os.path.exists(cmd_path) and os.access(cmd_path, os.X_OK): + cmd_exists = True + break + + CMD_AVAILABLE_CACHE[command] = cmd_exists + return cmd_exists + +def is_running(command, suppress_exc = True): + """ + Checks for if a process with a given name is running or not. + + Arguments: + command (str) - process name to be checked + suppress_exc (bool) - if True then None is returned on failure, otherwise + this raises the exception + + Returns: + True if the process is running, False otherwise + + Raises: + OSError if this can't be determined and suppress_exc is False + """ + + command_listing = call("ps -A co command") + + if command_listing: + return command in command_listing + else: + if suppress_exc: return None + else: raise OSError("Unable to check via 'ps -A co command'") + +def call(command, suppress_exc = True): + """ + Issues a command in a subprocess, blocking until completion and returning the + results. This is not actually ran in a shell so pipes and other shell syntax + aren't permitted. + + Arguments: + command (str) - command to be issued + suppress_exc (bool) - if True then None is returned on failure, otherwise + this raises the exception + + Returns: + List with the lines of output from the command, None in case of failure if + suppress_exc is True + + Raises: + OSError if this fails and suppress_exc is False + """ + + try: + start_time = time.time() + stdout, stderr = subprocess.Popen(command.split(), stdout = subprocess.PIPE, stderr = subprocess.PIPE).communicate() + stdout, stderr = stdout.strip(), stderr.strip() + runtime = time.time() - start_time + + msg = "system call: %s (runtime: %0.2f)" % (command, runtime) + if stderr: msg += "\nstderr: %s" % stderr + log.log(log.DEBUG, msg) + + if stdout: return stdout.split("\n") + else: return [] + except OSError, exc: + msg = "system call (failed): %s (error: %s)" % (command, exc) + log.log(log.INFO, msg) + + if suppress_exc: return None + else: raise exc +

1 0

[stem/master] First draft controller connection
by atagar＠torproject.org 10 Oct '11

10 Oct '11

commit 5d7688e7233a5a1f8a4bb4a1c939639031a71aa0 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Oct 10 10:05:14 2011 -0700 First draft controller connection This is a functional rewrite of the sendAndRecv TorCtl functionality. It follows a similar pattern, having a couple threads to continually pull the socket and provide event notifications. This still needs testing, better exception handling, and some more thought about the ControlMessage api. --- stem/connection.py | 280 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 280 insertions(+), 0 deletions(-) diff --git a/stem/connection.py b/stem/connection.py new file mode 100644 index 0000000..cede227 --- /dev/null +++ b/stem/connection.py @@ -0,0 +1,280 @@ +""" +Functions for connecting and authenticating to the tor process. +""" + +import Queue +import socket +import threading + +from stem.util import log + +class ProtocolError(Exception): + "Malformed content from the control socket." + pass + +class ControlMessage: + """ + Represents a complete message from the control socket. + """ + + def __init__(self, lines, raw_content): + if not lines: raise ValueError("Control messages can't be empty") + + # Parsed control message. This is a list of tuples with the form... + # (status code, divider, content) + self._lines = lines + + # String with the unparsed content read from the control port. + self._raw_content = raw_content + + def get_raw_content(self): + """ + Provides the unparsed content read from the control socket. + + Returns: + string of the socket data used to generate this message + """ + + return self._raw_content + + def get_status_code(self, line = -1): + """ + Provides the status code for a line of the message. + + Arguments: + line - line for which the status code is returned + + Returns: + string status code for the line + """ + + return self._lines[line][0] + + def __str__(self): + return "\n".join(list(self)) + + def __iter__(self): + """ + Provides the parsed content of the message, not including the status codes + and dividers. + """ + + for _, _, content in self._lines: + for content_line in content.split("\n"): + yield content_line + +class ControlConnection: + """ + Connection to a Tor control port. This is a very lightweight wrapper around + the socket, providing basic process communication and event listening. Don't + use this directly - subclasses provide frendlier controller access. + """ + + def __init__(self, control_socket): + self._is_running = True + self._control_socket = control_socket + + # File accessor for far better sending and receiving functionality. This + # uses a duplicate file descriptor so both this and the socket need to be + # closed when done. + + self._control_socket_file = self._control_socket.makefile() + + # queues where messages from the control socket are directed + self._event_queue = Queue.Queue() + self._reply_queue = Queue.Queue() + + # prevents concurrent writing to the socket + self._socket_write_cond = threading.Condition() + + # thread to pull from the _event_queue and call handle_event + self._event_cond = threading.Condition() + self._event_thread = threading.Thread(target = self._event_loop) + self._event_thread.setDaemon(True) + self._event_thread.start() + + # thread to continually pull from the control socket + self._reader_thread = threading.Thread(target = self._reader_loop) + self._reader_thread.setDaemon(True) + self._reader_thread.start() + + def is_running(self): + """ + True if we still have an open connection to the control socket, false + otherwise. + """ + + return self._is_running + + def handle_event(self, event_message): + """ + Overwritten by subclasses to provide event listening. This is notified + whenever we receive an event from the control socket. + + Arguments: + event_message (ControlMessage) - message received from the control socket + """ + + pass + + def send(self, message): + """ + Sends a message to the control socket and waits for a reply. + + Arguments: + message (str) - message to be sent to the control socket + + Returns: + ControlMessage with the response from the control socket + """ + + # makes sure that the message ends with a CRLF + message = message.rstrip("\r\n") + "\r\n" + + self._socket_write_cond.acquire() + self._control_socket_file.write(message) + self._control_socket_file.flush() + self._socket_write_cond.release() + + return self._reply_queue.get() + + def _event_loop(self): + """ + Continually pulls messages from the _event_thread and sends them to + handle_event. This is done via its own thread so subclasses with a lenghty + handle_event implementation don't block further reading from the socket. + """ + + while self.is_running(): + try: + event_message = self._event_queue.get_nowait() + self.handle_event(event_message) + except Queue.Empty: + self._event_cond.acquire() + self._event_cond.wait() + self._event_cond.release() + + def _reader_loop(self): + """ + Continually pulls from the control socket, directing the messages into + queues based on their type. Controller messages come in two varieties... + + - Responses to messages we've sent (GETINFO, SETCONF, etc). + - Asynchronous events, identified by a status code of 650. + """ + + while self.is_running(): + try: + control_message = self._read_message() + + if control_message.get_status_code() == "650": + # adds this to the event queue and wakes up the handler + + self._event_cond.acquire() + self._event_queue.put(control_message) + self._event_cond.notifyAll() + self._event_cond.release() + else: + # TODO: figure out a good method for terminating the socket thread + self._reply_queue.put(control_message) + except ProtocolError, exc: + log.log(log.ERR, "Error reading control socket message: %s" % exc) + # TODO: terminate? + + def _read_message(self): + """ + Pulls from the control socket until we either have a complete message or + encounter a problem. + + Returns: + ControlMessage read from the socket + """ + + lines, raw_content = [], "" + + while True: + line = self._control_socket_file.readline() + raw_content += line + + # Tor control lines are of the form... + # <status code><divider><content>\r\n + # + # status code - Three character code for the type of response (defined in + # section 4 of the control-spec). + # divider - Single character to indicate if this is mid-reply, data, or + # an end to the message (defined in section 2.3 of the control-spec). + # content - The following content is the actual payload of the line. + + if len(line) < 4: + raise ProtocolError("Badly formatted reply line: too short") + elif not line.endswith("\r\n"): + raise ProtocolError("All lines should end with CRLF") + + line = line[:-2] # strips off the CRLF + status_code, divider, content = line[:3], line[3], line[4:] + + if divider == "-": + # mid-reply line, keep pulling for more content + lines.append((status_code, divider, content)) + elif divider == " ": + # end of the message, return the message + lines.append((status_code, divider, content)) + return ControlMessage(lines, raw_content) + elif divider == "+": + # data entry, all of the following lines belong to the content until we + # get a line with just a period + + while True: + line = self._control_socket_file.readline() + raw_content += line + + if not line.endswith("\r\n"): + raise ProtocolError("All lines should end with CRLF") + elif line == ".\r\n": + break # data block termination + + line = line[:-2] # strips off the CRLF + + # lines starting with a pariod are escaped by a second period (as per + # section 2.4 of the control-spec) + if line.startswith(".."): line = line[1:] + + # appends to previous content, using a newline rather than CRLF + # separator (more contentional for multi-line string content outside + # the windows world) + + content += "\n" + line + + lines.append((status_code, divider, content)) + else: + raise ProtocolError("Unrecognized type '%s': %s" % (divider, line)) + + def close(self): + """ + Terminates the control connection. + """ + + self._is_running = False + + # if we haven't yet established a connection then this raises an error + # socket.error: [Errno 107] Transport endpoint is not connected + try: self._control_socket.shutdown(socket.SHUT_RDWR) + except socket.error: pass + + self._control_socket.close() + self._control_socket_file.close() + + # wake up the event thread so it can terminate + self._event_cond.acquire() + self._event_cond.notifyAll() + self._event_cond.release() + + self._event_thread.join() + self._reader_thread.join() + +# temporary function for getting a connection +def test_connection(): + s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + s.connect(("127.0.0.1", 9051)) + return ControlConnection(s) +

1 0