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

[arm/master] Checking if PortForwarding is available
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit ed16a0491ad55e16b8ea3fab2abaca7d65bdae46 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jul 11 10:20:44 2011 -0700 Checking if PortForwarding is available The PortForwarding was added in tor 0.2.3.1-alpha, and requires that tor-fw-helper exists in the user's path to function. Checking for both of these conditions and dropping the option if they're not met. --- src/cli/wizard.py | 42 +++++++++++++++++++++++++++++++++++++----- src/util/torTools.py | 49 ++++++++++++++++++++++++++++--------------------- 2 files changed, 65 insertions(+), 26 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index f796e41..efb6d98 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -89,6 +89,9 @@ BRACKETS = ((' ', ' '), ('{', '}'), ('|', '|')) +# version requirements for options +VERSION_REQUIREMENTS = {Options.PORTFORWARD: "0.2.3.1-alpha"} + # tor's defaults for config options, used to filter unneeded options TOR_DEFAULTS = {Options.BANDWIDTH: "5 MB", Options.REUSE: "10 minutes"} @@ -232,6 +235,18 @@ 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 + except IOError, exc: + log.log(log.INFO, "'tor --version' query failed: %s" % exc) + relayType, config = None, {} for option in Options.values(): if option == Options.DIVIDER: @@ -280,6 +295,18 @@ def showWizard(): manager = controller.getTorManager() relaySelection = RelayType.RESUME if manager.isTorrcAvailable() else RelayType.RELAY + # excludes options that are either disabled or for a future tor version + disabledOpt = list(CONFIG["wizard.disabled"]) + + for opt, optVersion in VERSION_REQUIREMENTS.items(): + if not torVersion or not torTools.isVersion(torVersion, torTools.parseVersion(optVersion)): + disabledOpt.append(opt) + + # the port forwarding option would only work if tor-fw-helper is in the path + if not Options.PORTFORWARD in disabledOpt: + if not sysTools.isAvailable("tor-fw-helper"): + disabledOpt.append(Options.PORTFORWARD) + while True: if relayType == None: selection = promptRelayType(relaySelection) @@ -292,11 +319,11 @@ def showWizard(): break else: relayType, relaySelection = selection, selection else: - selection = promptConfigOptions(relayType, config) + selection = promptConfigOptions(relayType, config, disabledOpt) if selection == BACK: relayType = None elif selection == NEXT: - generatedTorrc = getTorrc(relayType, config) + generatedTorrc = getTorrc(relayType, config, disabledOpt) torrcLocation = manager.getTorrcPath() controller.requestRedraw(True) @@ -404,14 +431,14 @@ def promptRelayType(initialSelection): finally: cli.popups.finalize() -def promptConfigOptions(relayType, config): +def promptConfigOptions(relayType, config, disabledOpt): """ Prompts the user for the configuration of an internal relay. """ topContent = _splitStr(CONFIG.get("wizard.message.%s" % relayType.lower(), ""), 54) - options = [config[opt] for opt in RelayOptions[relayType] if not opt in CONFIG["wizard.disabled"]] + options = [config[opt] for opt in RelayOptions[relayType] if not opt in disabledOpt] options.append(Options.DIVIDER) options.append(ConfigOption(BACK, "general", "(to role selection)")) options.append(ConfigOption(NEXT, "general", "(to confirm options)")) @@ -503,7 +530,7 @@ def promptConfigOptions(relayType, config): finally: cli.popups.finalize() -def getTorrc(relayType, config): +def getTorrc(relayType, config, disabledOpt): """ Provides the torrc generated for the given options. """ @@ -601,6 +628,11 @@ def getTorrc(relayType, config): templateOptions["BRIDGES"] = "\n".join(bridgeLines) + # removes disabled options + for opt in disabledOpt: + if opt.upper() in templateOptions: + del templateOptions[opt.upper()] + # removes options if they match the tor defaults for opt in TOR_DEFAULTS: if templateOptions[opt.upper()] == TOR_DEFAULTS[opt]: diff --git a/src/util/torTools.py b/src/util/torTools.py index 4a18a4f..f81e10a 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -52,9 +52,8 @@ CONTROLLER = None # singleton Controller instance CACHE_ARGS = ("version", "config-file", "exit-policy/default", "fingerprint", "config/names", "info/names", "features/names", "events/names", "nsEntry", "descEntry", "address", "bwRate", "bwBurst", - "bwObserved", "bwMeasured", "flags", "parsedVersion", "pid", - "user", "fdLimit", "pathPrefix", "startTime", "authorities", - "circuits", "hsPorts") + "bwObserved", "bwMeasured", "flags", "pid", "user", "fdLimit", + "pathPrefix", "startTime", "authorities", "circuits", "hsPorts") CACHE_GETINFO_PREFIX_ARGS = ("ip-to-country/", ) # Tor has a couple messages (in or/router.c) for when our ip address changes: @@ -301,6 +300,29 @@ def parseVersion(versionStr): 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 getConn(): """ Singleton constructor for a Controller. Be aware that this starts as being @@ -890,23 +912,10 @@ class Controller(TorCtl.PostEventListener): result = False if self.isAlive(): - myVersion = self._getRelayAttr("parsedVersion", None) + myVersion = parseVersion(self.getInfo("version", "")) - if not myVersion: - result = False - elif myVersion[:4] == minVersion[:4]: - result = 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: - result = True - break - elif myVal < minVal: - result = False - break + if not myVersion: result = False + else: result = isVersion(myVersion, minVersion) self.connLock.release() @@ -1853,8 +1862,6 @@ class Controller(TorCtl.PostEventListener): if line.startswith("s "): result = line[2:].split() break - elif key == "parsedVersion": - result = parseVersion(self.getInfo("version", "")) elif key == "pid": result = self.getInfo("process/pid")

1 0

[arm/master] Handling when tor needs root to start
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit c801be076450e0ee1c80d02c3523d91f63ef6bfa Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jul 11 12:44:37 2011 -0700 Handling when tor needs root to start When connecting to privileged ports the tor process needs root permissions to start. If the torrc needs root then I shouldn't offer to start tor with arm, and the wizard makes a startup shell script rather than making a doomed attempt to start tor. Currently the startup script is just a stub - I'll need to wait until I have a connection to fill in all the shell scripting voodoo. --- src/cli/controller.py | 59 +++++++++++++++++++++++++++++++++-------------- src/cli/headerPanel.py | 11 +++++++- src/cli/wizard.py | 37 +++++++++++++++++++---------- src/resources/startTor | 14 +++++++++++ src/util/torConfig.py | 36 +++++++++++++++++++++++++++++ 5 files changed, 124 insertions(+), 33 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index c6534b3..d4fcf2f 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -379,10 +379,10 @@ class Controller: with a slash and is created if it doesn't already exist. """ - dataDir = CONFIG["startup.dataDirectory"] + dataDir = os.path.expanduser(CONFIG["startup.dataDirectory"]) if not dataDir.endswith("/"): dataDir += "/" if not os.path.exists(dataDir): os.makedirs(dataDir) - return os.path.expanduser(dataDir) + return dataDir def getTorManager(self): """ @@ -458,10 +458,26 @@ class TorManager: def isTorrcAvailable(self): """ - True if a wizard generated torrc exists, false otherwise. + True if a wizard generated torrc exists and the user has permissions to + run it, false otherwise. """ - return os.path.exists(self.getTorrcPath()) + torrcLoc = self.getTorrcPath() + if os.path.exists(torrcLoc): + # If we aren't running as root and would be trying to bind to low ports + # then the startup will fail due to permissons. Attempts to check for + # this in the torrc. If unable to read the torrc then we probably + # wouldn't be able to use it anyway with our permissions. + + if os.getuid() != 0: + try: + return not torConfig.isRootNeeded(torrcLoc) + except IOError, exc: + log.log(log.INFO, "Failed to read torrc at '%s': %s" % (torrcLoc, exc)) + return False + else: return True + + return False def isManaged(self, conn): """ @@ -485,30 +501,37 @@ class TorManager: # attempts to connect for five seconds (tor might or might not be # immediately available) - torctlConn, authType, authValue = None, None, None - while not torctlConn and time.time() - startTime < 5: + raisedExc = None + + while time.time() - startTime < 5: try: - torctlConn, authType, authValue = TorCtl.preauth_connect(controlPort = int(CONFIG["wizard.default"]["Control"])) - except IOError: time.sleep(0.5) + self.connectManagedInstance() + return True + except IOError, exc: + raisedExc = exc + time.sleep(0.5) + + if raisedExc: log.log(log.WARN, str(raisedExc)) + return False + + def connectManagedInstance(self): + """ + Attempts to connect to a managed tor instance, raising an IOError if + 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" % torrcLoc - log.log(log.WARN, msg) - return False + raise IOError(msg) if authType == TorCtl.AUTH_TYPE.COOKIE: try: torctlConn.authenticate(authValue) torTools.getConn().init(torctlConn) - return True except Exception, exc: - msg = "Unable to connect to Tor: %s" % exc - log.log(log.WARN, msg) - return False - else: - msg = "Unable to connect to Tor, unexpected authentication type '%s'" % authType - log.log(log.WARN, msg) - return False + raise IOError("Unable to connect to Tor: %s" % exc) def shutdownDaemons(): """ diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index 5a2c1bc..f80eff8 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -22,6 +22,7 @@ import threading import TorCtl.TorCtl import cli.popups +import cli.controller from util import log, panel, sysTools, torTools, uiTools @@ -144,8 +145,14 @@ class HeaderPanel(panel.Panel, threading.Thread): log.log(log.NOTICE, "Reconnected to Tor's control port") cli.popups.showMsg("Tor reconnected", 1) except Exception, exc: - # displays notice for failed connection attempt - if exc.args: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) + # attempts to use the wizard port too + try: + cli.controller.getController().getTorManager().connectManagedInstance() + log.log(log.NOTICE, "Reconnected to Tor's control port") + cli.popups.showMsg("Tor reconnected", 1) + except: + # displays notice for the first failed connection attempt + if exc.args: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) else: isKeystrokeConsumed = False return isKeystrokeConsumed diff --git a/src/cli/wizard.py b/src/cli/wizard.py index efb6d98..be0deb4 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -341,27 +341,38 @@ def showWizard(): torrcFile.write(generatedTorrc) torrcFile.close() + dataDir = cli.controller.getController().getDataDirectory() + + pathPrefix = os.path.dirname(sys.argv[0]) + if pathPrefix and not pathPrefix.endswith("/"): + pathPrefix = pathPrefix + "/" + # copies exit notice into data directory if it's being used if Options.NOTICE in RelayOptions[relayType] and config[Options.NOTICE].getValue() and config[Options.LOWPORTS].getValue(): - dataDir = cli.controller.getController().getDataDirectory() - - pathPrefix = os.path.dirname(sys.argv[0]) - if pathPrefix and not pathPrefix.endswith("/"): - pathPrefix = pathPrefix + "/" - src = "%sresources/exitNotice" % pathPrefix dst = "%sexitNotice" % dataDir if not os.path.exists(dst): shutil.copytree(src, dst) - # If we're connected to a managed instance then just need to - # issue a sighup to pick up the new settings. Otherwise starts - # a new tor instance. - - conn = torTools.getConn() - if manager.isManaged(conn): conn.reload() - else: manager.startManagedInstance() + if manager.isTorrcAvailable(): + # If we're connected to a managed instance then just need to + # issue a sighup to pick up the new settings. Otherwise starts + # a new tor instance. + + conn = torTools.getConn() + if manager.isManaged(conn): conn.reload() + else: manager.startManagedInstance() + else: + # If we don't have permissions to run the torrc we just made then + # makes a shell script they can run as root to start tor. + + src = "%sresources/startTor" % pathPrefix + dst = "%sstartTor" % dataDir + if not os.path.exists(dst): shutil.copy(src, dst) + + msg = "Tor needs root permissions to start with this configuration (it will drop itself to a 'tor-arm' user afterward). To continue...\n- open another terminal\n- run \"sudo %s\"\n- press 'r' here to tell arm to reconnect" % dst + log.log(log.NOTICE, msg) break elif confirmationSelection == CANCEL: break diff --git a/src/resources/startTor b/src/resources/startTor new file mode 100755 index 0000000..c575c23 --- /dev/null +++ b/src/resources/startTor @@ -0,0 +1,14 @@ +#!/bin/sh +# +# When binding to privilaged ports the tor process needs to start with root +# permissions, then lower the user it's running as afterward. This script +# simply makes a "tor-arm" user if it doesn't already exist then starts the +# tor process. + +# TODO: check if the user's running as root +# TODO: check if the tor-arm user exists and if not, make it +# TODO: run arm +# TODO: bonus points: double check that the torrc in this directory has a +# "User tor-arm" entry - this would be a problem if they run the wizard +# without low ports, then use this script + diff --git a/src/util/torConfig.py b/src/util/torConfig.py index 8510c7a..2eca571 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -52,6 +52,9 @@ MAN_EX_INDENT = 15 # indentation used for man page examples PERSIST_ENTRY_DIVIDER = "-" * 80 + "\n" # splits config entries when saving to a file MULTILINE_PARAM = None # cached multiline parameters (lazily loaded) +# torrc options that bind to ports +PORT_OPT = ("SocksPort", "ORPort", "DirPort", "ControlPort", "TransPort") + def loadConfig(config): config.update(CONFIG) @@ -845,6 +848,39 @@ def _testConfigDescriptions(): print "\"%s\"" % description if i != len(sortedOptions) - 1: print "-" * 80 +def isRootNeeded(torrcPath): + """ + Returns True if the given torrc needs root permissions to be ran, False + otherwise. This raises an IOError if the torrc can't be read. + + Arguments: + torrcPath - torrc to be checked + """ + + try: + torrcFile = open(torrcPath, "r") + torrcLines = torrcFile.readlines() + torrcFile.close() + + for line in torrcLines: + line = line.strip() + + isPortOpt = False + for opt in PORT_OPT: + if line.startswith(opt): + isPortOpt = True + break + + if isPortOpt and " " in line: + arg = line.split(" ")[1] + + if arg.isdigit() and int(arg) <= 1024 and int(arg) != 0: + return True + + return False + except Exception, exc: + raise IOError(exc) + def renderTorrc(template, options, commentIndent = 30): """ Uses the given template to generate a nicely formatted torrc with the given

1 0

[arm/master] Adding tor check for setup wizard
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit 5b60d326a68b28f925c4c1f7b2789f179ea9e582 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 10 23:56:18 2011 -0700 Adding tor check for setup wizard If tor isn't available in the PATH then gives a warning. --- src/cli/wizard.py | 7 ++++++- 1 files changed, 6 insertions(+), 1 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 0f35247..f796e41 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -16,7 +16,7 @@ import cli.controller from TorCtl import TorCtl -from util import connections, enum, log, torConfig, torTools, uiTools +from util import connections, enum, log, sysTools, torConfig, torTools, uiTools # template used to generate the torrc TORRC_TEMPLATE = "resources/torrcTemplate.txt" @@ -227,6 +227,11 @@ def showWizard(): instance. """ + if not sysTools.isAvailable("tor"): + msg = "Unable to run the setup wizard. Is tor installed?" + log.log(log.WARN, msg) + return + relayType, config = None, {} for option in Options.values(): if option == Options.DIVIDER:

1 0

[arm/master] Obscuring contact email addresses
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit 0a0bf4a2cde102bfaef5ea7ad3575156dccf39f9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 10 23:35:36 2011 -0700 Obscuring contact email addresses Trying to make address scraping a tiny bit harder. --- src/cli/wizard.py | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 71 insertions(+), 0 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index e5d6257..0f35247 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -3,8 +3,10 @@ Provides user prompts for setting up a new relay. This autogenerates a torrc that's used by arm to run its own tor instance. """ +import re import os import sys +import random import shutil import functools import curses @@ -79,6 +81,14 @@ MSG_COLOR = "green" OPTION_COLOR = "yellow" DISABLED_COLOR = "cyan" +# bracketing pairs used in email address obscuring +BRACKETS = ((' ', ' '), + ('<', '>'), + ('[', ']'), + ('(', ')'), + ('{', '}'), + ('|', '|')) + # tor's defaults for config options, used to filter unneeded options TOR_DEFAULTS = {Options.BANDWIDTH: "5 MB", Options.REUSE: "10 minutes"} @@ -517,6 +527,9 @@ def getTorrc(relayType, config): elif key == Options.NOTICE: # notice option is only applied if using low ports value &= config[Options.LOWPORTS].getValue() + elif key == Options.CONTACT and _isEmailAddress(value): + # obscures the email address + value = _obscureEmailAddress(value) templateOptions[key.upper()] = value @@ -702,6 +715,64 @@ def _splitStr(msg, width): return results +def _isEmailAddress(address): + """ + True if the input is an email address, false otherwise. + """ + + # just checks if there's an '@' and '.' in the input w/o whitespace + emailMatcher = re.compile("\S*(a)\S*\.\S*") + return emailMatcher.match(address) + +def _obscureEmailAddress(address): + """ + Makes some effort to obscure an email address while keeping it readable. + + Arguments: + address - actual email address + """ + + address = _obscureChar(address, '@', (_randomCase("at"), )) + address = _obscureChar(address, '.', (_randomCase("dot"), )) + return address + +def _randomCase(word): + """ + Provides a word back with the case of its letters randomized. + + Arguments: + word - word for which to randomize the case + """ + + result = [] + for letter in word: + result.append(random.choice((letter.lower(), letter.upper()))) + + return "".join(result) + +def _obscureChar(inputText, target, options): + """ + Obscures the given character from the input, replacing it with something + from a set of options and bracketing the selection. + + Arguments: + inputText - text to be obscured + target - character to be replaced + options - replacement options for the character + """ + + leftSpace = random.randint(0, 3) + leftFill = random.choice((' ', '_', '-', '=', '<')) + + rightSpace = random.randint(0, 3) + rightFill = random.choice((' ', '_', '-', '=', '>')) + + bracketLeft, bracketRight = random.choice(BRACKETS) + optSelection = random.choice(options) + replacement = "".join((bracketLeft, leftFill * leftSpace, optSelection, rightFill * rightSpace, bracketRight)) + + return inputText.replace(target, replacement) + def _toggleEnabledAction(toggleOptions, option, value): """ Enables or disables custom exit policy options based on our selection.

1 0

[arm/master] Adding wizard option to shutdown tor with arm
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit c29f5fdf9b2da2c097b8b2be8148f6b3dc45d26f Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 10 18:56:04 2011 -0700 Adding wizard option to shutdown tor with arm This option adds a comment flag to the torrc that tells arm to shut down tor when it quits. This will also take advantage of Robert's 'ownership' feature when it's available. --- src/cli/controller.py | 23 +++++++++++++++++++++++ src/cli/wizard.py | 15 +++++++++++---- src/resources/torrcTemplate.txt | 7 +++++++ src/settings.cfg | 8 ++++++++ 4 files changed, 49 insertions(+), 4 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index e30af3f..c6534b3 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -407,6 +407,22 @@ class Controller: self._isDone = True + # check if the torrc has a "ARM_SHUTDOWN" comment flag, if so then shut + # down the instance + + isShutdownFlagPresent = False + torrcContents = torConfig.getTorrc().getContents() + + if torrcContents: + for line in torrcContents: + if "# ARM_SHUTDOWN" in line: + isShutdownFlagPresent = True + break + + if isShutdownFlagPresent: + try: torTools.getConn().shutdown() + except IOError, exc: cli.popups.showMsg(str(exc), 3, curses.A_BOLD) + if CONFIG["features.offerTorShutdownOnQuit"]: conn = torTools.getConn() @@ -551,6 +567,13 @@ def connResetListener(conn, eventType): resolver.setPaused(eventType == torTools.State.CLOSED) if eventType in (torTools.State.INIT, torTools.State.RESET): + # Reload the torrc contents. If the torrc panel is present then it will + # do this instead since it wants to do validation and redraw _after_ the + # new contents are loaded. + + if getController().getPanel("torrc") == None: + torConfig.getTorrc().load(True) + torPid = conn.getMyPid() if torPid and torPid != resolver.getPid(): diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 9b8c1d7..e5d6257 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -23,7 +23,7 @@ TORRC_TEMPLATE = "resources/torrcTemplate.txt" RelayType = enum.Enum("RESUME", "RELAY", "EXIT", "BRIDGE", "CLIENT") # all options that can be configured -Options = enum.Enum("DIVIDER", "CONTROL", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "CLIENT", "LOWPORTS", "PORTFORWARD", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT", "DISTRIBUTE", "BRIDGED", "BRIDGE1", "BRIDGE2", "BRIDGE3", "REUSE") +Options = enum.Enum("DIVIDER", "CONTROL", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "CLIENT", "LOWPORTS", "PORTFORWARD", "STARTUP", "RSHUTDOWN", "CSHUTDOWN", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT", "DISTRIBUTE", "BRIDGED", "BRIDGE1", "BRIDGE2", "BRIDGE3", "REUSE") RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, @@ -32,7 +32,8 @@ RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.CLIENT, Options.LOWPORTS, Options.PORTFORWARD, - Options.STARTUP), + Options.STARTUP, + Options.RSHUTDOWN), RelayType.EXIT: (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, @@ -42,6 +43,7 @@ RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.LOWPORTS, Options.PORTFORWARD, Options.STARTUP, + Options.RSHUTDOWN, Options.DIVIDER, Options.NOTICE, Options.POLICY, @@ -56,12 +58,14 @@ RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.CLIENT, Options.LOWPORTS, Options.PORTFORWARD, - Options.STARTUP), + Options.STARTUP, + Options.RSHUTDOWN), RelayType.CLIENT: (Options.BRIDGED, Options.BRIDGE1, Options.BRIDGE2, Options.BRIDGE3, - Options.REUSE)} + Options.REUSE, + Options.CSHUTDOWN)} # option sets CUSTOM_POLICIES = (Options.WEBSITES, Options.EMAIL, Options.IM, Options.MISC, Options.PLAINTEXT) @@ -489,6 +493,9 @@ def getTorrc(relayType, config): Provides the torrc generated for the given options. """ + # TODO: When Robert's 'ownership' feature is available take advantage of it + # for the RSHUTDOWN and CSHUTDOWN options. + pathPrefix = os.path.dirname(sys.argv[0]) if pathPrefix and not pathPrefix.endswith("/"): pathPrefix = pathPrefix + "/" diff --git a/src/resources/torrcTemplate.txt b/src/resources/torrcTemplate.txt index 072f847..c31b209 100644 --- a/src/resources/torrcTemplate.txt +++ b/src/resources/torrcTemplate.txt @@ -6,6 +6,13 @@ # # Descriptions of all of these configuraiton attibutes (and many more) are # available in the tor man page. + +[IF RSHUTDOWN | CSHUTDOWN] + [NEWLINE] + # The following flag tells arm to shut down tor when it quits. + # ARM_SHUTDOWN +[END IF] + [NEWLINE] ControlPort 9052 # port controllers can connect to CookieAuthentication 1 # method for controller authentication diff --git a/src/settings.cfg b/src/settings.cfg index 2734c4a..c6d483d 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -352,6 +352,8 @@ wizard.toggle Client => Enabled, Disabled wizard.toggle Lowports => Yes, No wizard.toggle Portforward => Enabled, Disabled wizard.toggle Startup => Yes, No +wizard.toggle Rshutdown => Yes, No +wizard.toggle Cshutdown => Yes, No wizard.toggle Notice => Yes, No wizard.toggle Policy => Custom, Default wizard.toggle Websites => Allow, Block @@ -379,6 +381,8 @@ wizard.default Control => 9052 wizard.default Notify => true wizard.default Bandwidth => 5 MB/s wizard.default Startup => true +wizard.default Rshutdown => false +wizard.default Cshutdown => true wizard.default Client => false wizard.default Lowports => true wizard.default Portforward => true @@ -415,6 +419,8 @@ wizard.label.opt Client => Client Usage wizard.label.opt Lowports => Low Relaying Ports wizard.label.opt Portforward => Port Forwarding wizard.label.opt Startup => Run At Startup +wizard.label.opt Rshutdown => Shutdown With Arm +wizard.label.opt Cshutdown => Shutdown With Arm wizard.label.opt Notice => Disclaimer Notice wizard.label.opt Policy => Exit Policy wizard.label.opt Websites => Web Browsing @@ -444,6 +450,8 @@ wizard.description.opt Client => Enable this if you would like to use Tor yourse wizard.description.opt Lowports => Relays using port 443 rather than 9001. This helps some users that would otherwise be blocked, but requires that tor is started with root permissions (after that it lowers itself to those of a 'tor-arm' user). wizard.description.opt Portforward => If needed, attempts NAT traversal using UPnP and NAT-PMP. This allows for automatic port forwarding on most home routers. wizard.description.opt Startup => Runs Tor in the background when the system starts. +wizard.description.opt Rshutdown => When you quit arm the Tor process is stopped thirty seconds later. This delay is so people using you can gracefully switch their circuits. +wizard.description.opt Cshutdown => Stops the Tor process when you quit arm. wizard.description.opt Notice => Provides a disclaimer that this is an exit on port 80 (http://www.atagar.com/exitNotice) wizard.description.opt Policy => Ports allowed to exit from your relay. The default policy allows for common services while limiting the chance of getting a DMCA takedown for torrent traffic (http://www.atagar.com/exitPolicy) wizard.description.opt Websites => General Internet browsing including HTTP (80), HTTPS (443), common alternatives (81, 8008), and proxies (3128, 8080)

1 0

[arm/master] Excluding tor config options if they match default
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit 0c0a54387a2c6f562b65d15820a8753f244c9b7a Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 18:14:46 2011 -0700 Excluding tor config options if they match default When the wizard is generating a torrc it's now excluding options if they match the defaults. This'll take some more work to get right. --- src/cli/wizard.py | 9 +++++++++ 1 files changed, 9 insertions(+), 0 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index e2419e8..cf544a5 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -75,6 +75,10 @@ MSG_COLOR = "green" OPTION_COLOR = "yellow" DISABLED_COLOR = "cyan" +# tor's defaults for config options, used to filter unneeded options +TOR_DEFAULTS = {Options.BANDWIDTH: "5 MB", + Options.REUSE: "10 minutes"} + CONFIG = {"wizard.message.role": "", "wizard.message.relay": "", "wizard.message.exit": "", @@ -551,6 +555,11 @@ def getTorrc(relayType, config): templateOptions["BRIDGES"] = "\n".join(bridgeLines) + # removes options if they match the tor defaults + for opt in TOR_DEFAULTS: + if templateOptions[opt.upper()] == TOR_DEFAULTS[opt]: + del templateOptions[opt.upper()] + return torConfig.renderTorrc(template, templateOptions) def showConfirmationDialog(torrcContents, torrcLocation):

1 0

[arm/master] Dropping "/s" when making torrc for rates
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit ec0cdb0f1499910fc85337ac20c2ab6352578cb6 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 18:25:12 2011 -0700 Dropping "/s" when making torrc for rates The wizard shows bandwidth rates (for instance "5 MB/s") but the torrc just wants the volume part. Dropping the "/s" for RelayBandwidthRate and RelayBandwidthBurst. --- src/cli/wizard.py | 11 +++++++++-- 1 files changed, 9 insertions(+), 2 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index cf544a5..8aa1a23 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -493,14 +493,21 @@ def getTorrc(relayType, config): if isinstance(value, ConfigOption): value = value.getValue() + # truncates "/s" from the rate for RelayBandwidthRate entry + if key == Options.BANDWIDTH and value.endswith("/s"): + value = value[:-2] + templateOptions[key.upper()] = value templateOptions[relayType.upper()] = True templateOptions["LOW_PORTS"] = config[Options.LOWPORTS] # uses double the relay rate for bursts - relayRateComp = config[Options.BANDWIDTH].getValue().split(" ") - templateOptions["BURST"] = "%i %s" % (int(relayRateComp[0]) * 2, " ".join(relayRateComp[1:])) + bwOpt = Options.BANDWIDTH.upper() + + if templateOptions[bwOpt] != TOR_DEFAULTS[Options.BANDWIDTH]: + relayRateComp = templateOptions[bwOpt].split(" ") + templateOptions["BURST"] = "%i %s" % (int(relayRateComp[0]) * 2, " ".join(relayRateComp[1:])) # exit notice will be in our data directory dataDir = cli.controller.getController().getDataDirectory()

1 0

[arm/master] fix: tor startup errors caused stacktrace
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit 7bd3af6a9da4afac92ab1b72cbb315e68e0b394e Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 18:37:34 2011 -0700 fix: tor startup errors caused stacktrace Simple typo caused raised exceptions value to be left None. --- src/cli/controller.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index 5ba7f42..d4ee3e3 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -472,7 +472,7 @@ class TorManager: try: torctlConn, authType, authValue = TorCtl.preauth_connect(controlPort = int(CONFIG["wizard.default"]["Control"])) except IOError, exc: - raisedExc == exc + raisedExc = exc time.sleep(0.5) if not torctlConn: raise raisedExc

1 0

[arm/master] Giving better error output when tor startup fails
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit 000d5d9efda100758b2e8f703a13ebd76bcb457a Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 18:43:57 2011 -0700 Giving better error output when tor startup fails The error out was pointless (any startup failure reported as being unable to connect to the control port) so giving the user the command to manually start tor. I should try to capture the logged err msg but this is gonna be a little tricky... --- src/cli/controller.py | 12 ++++++------ src/cli/wizard.py | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index d4ee3e3..a04bf99 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -462,20 +462,20 @@ class TorManager: Starts a managed instance of tor, raising an IOError if unsuccessful. """ - os.system("tor --quiet -f %s&" % self.getTorrcPath()) + torrcLoc = self.getTorrcPath() + os.system("tor --quiet -f %s&" % torrcLoc) startTime = time.time() # attempts to connect for five seconds (tor might or might not be # immediately available) - torctlConn, authType, authValue, raisedExc = None, None, None, None + torctlConn, authType, authValue = None, None, None while not torctlConn and time.time() - startTime < 5: try: torctlConn, authType, authValue = TorCtl.preauth_connect(controlPort = int(CONFIG["wizard.default"]["Control"])) - except IOError, exc: - raisedExc = exc - time.sleep(0.5) + except IOError, exc: time.sleep(0.5) - if not torctlConn: raise raisedExc + if not torctlConn: + raise IOError("try running \"tor -f %s\" for error output" % torrcLoc) if authType == TorCtl.AUTH_TYPE.COOKIE: torctlConn.authenticate(authValue) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 8aa1a23..6d2e623 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -304,7 +304,7 @@ def showWizard(): if manager.isManaged(conn): conn.reset() else: manager.startManagedInstance() except IOError, exc: - log.log(log.WARN, "Unable to start tor: %s" % exc) + log.log(log.WARN, "Unable to start tor, %s" % exc) break elif confirmationSelection == CANCEL: break @@ -512,7 +512,7 @@ def getTorrc(relayType, config): # exit notice will be in our data directory dataDir = cli.controller.getController().getDataDirectory() templateOptions["NOTICE_PATH"] = dataDir + "exit-notice.html" - templateOptions["LOG_ENTRY"] = "notice file %stor-log" % dataDir + templateOptions["LOG_ENTRY"] = "notice file %stor_log" % dataDir policyCategories = [] if not config[Options.POLICY].getValue():

1 0

[arm/master] fix: uncaught exceptions when resuming borken conf
by atagar＠torproject.org 12 Jul '11

12 Jul '11

commit 1c0c1f3029fbde3441c881930b292a0176d4e02d Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 23:19:34 2011 -0700 fix: uncaught exceptions when resuming borken conf When selecting 'Use Last Configuration' in the wizard or 'Start Tor' from the menu when the last torrc was broken caused uncaught exceptions. It's actually better if the starter function did logging itself instead so passing on a success boolean instead. --- src/cli/controller.py | 23 +++++++++++++++++------ src/cli/wizard.py | 18 +++++++----------- 2 files changed, 24 insertions(+), 17 deletions(-) diff --git a/src/cli/controller.py b/src/cli/controller.py index a04bf99..e30af3f 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -459,7 +459,8 @@ class TorManager: def startManagedInstance(self): """ - Starts a managed instance of tor, raising an IOError if unsuccessful. + Starts a managed instance of tor, logging a warning if unsuccessful. This + returns True if successful and False otherwise. """ torrcLoc = self.getTorrcPath() @@ -472,16 +473,26 @@ class TorManager: while not torctlConn and time.time() - startTime < 5: try: torctlConn, authType, authValue = TorCtl.preauth_connect(controlPort = int(CONFIG["wizard.default"]["Control"])) - except IOError, exc: time.sleep(0.5) + except IOError: time.sleep(0.5) if not torctlConn: - raise IOError("try running \"tor -f %s\" for error output" % torrcLoc) + msg = "Unable to start tor, try running \"tor -f %s\" to see the error output" % torrcLoc + log.log(log.WARN, msg) + return False if authType == TorCtl.AUTH_TYPE.COOKIE: - torctlConn.authenticate(authValue) - torTools.getConn().init(torctlConn) + try: + torctlConn.authenticate(authValue) + torTools.getConn().init(torctlConn) + return True + except Exception, exc: + msg = "Unable to connect to Tor: %s" % exc + log.log(log.WARN, msg) + return False else: - raise IOError("unexpected authentication type '%s'" % authType) + msg = "Unable to connect to Tor, unexpected authentication type '%s'" % authType + log.log(log.WARN, msg) + return False def shutdownDaemons(): """ diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 6d2e623..be7ac8a 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -294,17 +294,13 @@ def showWizard(): torrcFile.write(generatedTorrc) torrcFile.close() - try: - conn = torTools.getConn() - - # If we're connected to a managed instance then just need to - # issue a sighup to pick up the new settings. Otherwise starts - # a new tor instance. - - if manager.isManaged(conn): conn.reset() - else: manager.startManagedInstance() - except IOError, exc: - log.log(log.WARN, "Unable to start tor, %s" % exc) + # If we're connected to a managed instance then just need to + # issue a sighup to pick up the new settings. Otherwise starts + # a new tor instance. + + conn = torTools.getConn() + if manager.isManaged(conn): conn.reset() + else: manager.startManagedInstance() break elif confirmationSelection == CANCEL: break

1 0