September 2013 - tor-commits - lists.torproject.org

[translation/liveusb-creator] Update translations for liveusb-creator
by translation＠torproject.org 16 Sep '13

16 Sep '13

commit 4a88a4a9150568e301ba5107cfda12ada21bd683 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Sep 16 02:15:49 2013 +0000 Update translations for liveusb-creator --- tr/tr.po | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/tr/tr.po b/tr/tr.po index 6b3a91b..899b396 100644 --- a/tr/tr.po +++ b/tr/tr.po @@ -4,6 +4,7 @@ # # Translators: # Bloodia <aycaom(a)hotmail.com>, 2013 +# muaz742, 2013 # volkangezer <volkangezer(a)gmail.com>, 2013 # yozel <iletisim(a)yasinozel.com.tr>, 2013 msgid "" @@ -11,8 +12,8 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2013-09-09 11:21+0200\n" -"PO-Revision-Date: 2013-09-09 09:44+0000\n" -"Last-Translator: runasand <runa.sandvik(a)gmail.com>\n" +"PO-Revision-Date: 2013-09-16 02:15+0000\n" +"Last-Translator: muaz742\n" "Language-Team: Turkish (http://www.transifex.com/projects/p/torproject/language/tr/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -132,7 +133,7 @@ msgstr "Cihaz henüz takılı değil, bu yüzden boş alan hesaplanması şu an #: ../liveusb/dialog.py:157 #, python-format msgid "Download %(distribution)s" -msgstr "" +msgstr "İndir %(distribution)s" #: ../liveusb/gui.py:750 msgid "Download complete!" @@ -158,7 +159,7 @@ msgstr "" #: ../liveusb/creator.py:1182 msgid "Error probing device" -msgstr "" +msgstr "Sürücü araştırma hatası" #: ../liveusb/gui.py:227 msgid ""

1 0

r26352: {website} update the t-shirt page with slightly more accurate instruct (website/trunk/getinvolved/en)
by Andrew Lewman 16 Sep '13

16 Sep '13

Author: phobos Date: 2013-09-16 02:04:03 +0000 (Mon, 16 Sep 2013) New Revision: 26352 Modified: website/trunk/getinvolved/en/tshirt.wml Log: update the t-shirt page with slightly more accurate instructions. Modified: website/trunk/getinvolved/en/tshirt.wml =================================================================== --- website/trunk/getinvolved/en/tshirt.wml 2013-09-12 03:47:41 UTC (rev 26351) +++ website/trunk/getinvolved/en/tshirt.wml 2013-09-16 02:04:03 UTC (rev 26352) @@ -34,9 +34,7 @@ </ol> <p> - If you qualify, send mail to donations(a)torproject.org with - a brief explanation. You will receive a unique, one-time use code - to claim your t-shirt. + The <a href="https://weather.torproject.org/">Tor Weather</a> system watches all of the relays. If you have a valid email address (lightly obfuscated is acceptable) in your ContactInfo field, we'll automatically email you when your relays earns you a free t-shirt. If you've done something else cool, email us directly donations(a)torproject.org with the details. </p> <p>

1 0

[arm/master] Revised form of getPathPrefix() called get_chroot()
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit b7d5a21ea2d583323262824b5e477e52a8179084 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 22:37:14 2013 -0700 Revised form of getPathPrefix() called get_chroot() More than just a rename, the old function was embarrasingly buggy. Revising to reflect PEP8 conventions in addition to fixing all the issues I could spot. Impressive how I screwed up the edge cases in such a tiny function... --- arm/graphing/bandwidthStats.py | 2 +- arm/logPanel.py | 2 +- arm/starter.py | 2 +- arm/util/torConfig.py | 2 +- arm/util/torTools.py | 51 +++++++++++++++++++++++----------------- armrc.sample | 3 ++- 6 files changed, 35 insertions(+), 27 deletions(-) diff --git a/arm/graphing/bandwidthStats.py b/arm/graphing/bandwidthStats.py index b6f5d5a..9d05c72 100644 --- a/arm/graphing/bandwidthStats.py +++ b/arm/graphing/bandwidthStats.py @@ -151,7 +151,7 @@ class BandwidthStats(graphPanel.GraphStats): return False # attempt to open the state file - try: stateFile = open("%s%s/state" % (torTools.getPathPrefix(), dataDir), "r") + try: stateFile = open("%s%s/state" % (torTools.get_chroot(), dataDir), "r") except IOError: msg = PREPOPULATE_FAILURE_MSG % "unable to read the state file" log.notice(msg) diff --git a/arm/logPanel.py b/arm/logPanel.py index a1b0b87..1f3067c 100644 --- a/arm/logPanel.py +++ b/arm/logPanel.py @@ -218,7 +218,7 @@ def getLogFileEntries(runlevels, readLimit = None, addLimit = None): if not loggingLocation: return [] # includes the prefix for tor paths - loggingLocation = torTools.getPathPrefix() + loggingLocation + loggingLocation = torTools.get_chroot() + loggingLocation # if the runlevels argument is a superset of the log file then we can # limit the read contents to the addLimit diff --git a/arm/starter.py b/arm/starter.py index 5c51812..20a15c6 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -221,7 +221,7 @@ def _getController(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i Custom handler for establishing a stem connection (... needs an overhaul). """ - chroot = arm.util.torTools.getPathPrefix() + chroot = arm.util.torTools.get_chroot() try: controller = Controller.from_port(controlAddr, controlPort) diff --git a/arm/util/torConfig.py b/arm/util/torConfig.py index beb88b1..955e1c5 100644 --- a/arm/util/torConfig.py +++ b/arm/util/torConfig.py @@ -343,7 +343,7 @@ def getConfigLocation(): conn = torTools.getConn() configLocation = conn.getInfo("config-file", None) - torPid, torPrefix = conn.controller.get_pid(None), torTools.getPathPrefix() + torPid, torPrefix = conn.controller.get_pid(None), torTools.get_chroot() if not configLocation: raise IOError("unable to query the torrc location") try: diff --git a/arm/util/torTools.py b/arm/util/torTools.py index e7766e3..63dc257 100644 --- a/arm/util/torTools.py +++ b/arm/util/torTools.py @@ -3,10 +3,11 @@ Helper for working with an active tor process. This both provides a wrapper for accessing stem and notifications of state changes to subscribers. """ -import os -import time import math +import os +import platform import threading +import time import stem import stem.control @@ -22,7 +23,7 @@ CONTROLLER = None # singleton Controller instance UNDEFINED = "<Undefined_ >" CONFIG = conf.config_dict("arm", { - "features.pathPrefix": "", + "tor.chroot": "", }) # events used for controller functionality: @@ -35,7 +36,7 @@ REQ_EVENTS = {"NEWDESC": "information related to descriptors will grow stale", # only done once for the duration of the application to avoid pointless # messages. -PATH_PREFIX_LOGGING = True +LOG_ABOUT_CHROOTS = True def getConn(): """ @@ -47,35 +48,41 @@ def getConn(): if CONTROLLER == None: CONTROLLER = Controller() return CONTROLLER -def getPathPrefix(): + +def get_chroot(): """ Provides the path prefix that should be used for fetching tor resources. - If undefined and Tor is inside a jail under FreeBsd then this provides the + If undefined and Tor is inside a jail under FreeBSD then this provides the jail's path. + + :returns: **str** with the path of the jail tor is running within, this is an + empty string if none can be determined """ - global PATH_PREFIX_LOGGING + global LOG_ABOUT_CHROOTS + + chroot = CONFIG["tor.chroot"].strip() + + if chroot and not os.path.exists(chroot): + if LOG_ABOUT_CHROOTS: + log.notice("The prefix path set in your config (%s) doesn't exist." % chroot) + + chroot = '' - # make sure the path prefix is valid and exists (providing a notice if not) - prefixPath = CONFIG["features.pathPrefix"].strip() + if not chroot and platform.system() == "FreeBSD": + jail_chroot = system.get_bsd_jail_path(getConn().controller.get_pid(0)) - if not prefixPath and os.uname()[0] == "FreeBSD": - prefixPath = system.get_bsd_jail_path(getConn().controller.get_pid(0)) + if jail_chroot and os.path.exists(jail_chroot): + chroot = jail_chroot - if prefixPath and PATH_PREFIX_LOGGING: - log.info("Adjusting paths to account for Tor running in a jail at: %s" % prefixPath) + if LOG_ABOUT_CHROOTS: + log.info("Adjusting paths to account for Tor running in a FreeBSD jail at: %s" % chroot) - if prefixPath: - # strips off ending slash from the path - if prefixPath.endswith("/"): prefixPath = prefixPath[:-1] + chroot = chroot.rstrip(os.path.sep) # strip off trailing slashes + LOG_ABOUT_CHROOTS = False # don't log about further calls - # avoid using paths that don't exist - if PATH_PREFIX_LOGGING and prefixPath and not os.path.exists(prefixPath): - log.notice("The prefix path set in your config (%s) doesn't exist." % prefixPath) - prefixPath = "" + return chroot - PATH_PREFIX_LOGGING = False # prevents logging if fetched again - return prefixPath class Controller: """ diff --git a/armrc.sample b/armrc.sample index 253da0d..89e3878 100644 --- a/armrc.sample +++ b/armrc.sample @@ -41,7 +41,8 @@ features.torrc.validate true # Set this if you're running in a chroot jail or other environment where tor's # resources (log, state, etc) should have a prefix in their paths. -features.pathPrefix + +tor.chroot # If set, arm appends any log messages it reports while running to the given # log file. This does not take filters into account or include prepopulated

1 0

[arm/master] Renaming startup.controlPassword to tor.password
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit a2f19e361120f215b4a11d953ddda8f7becdc7b4 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Sep 12 08:56:28 2013 -0700 Renaming startup.controlPassword to tor.password I'm changing us to a 'tor.*' namespace for tor parameters. This certainly fits the bill. --- arm/starter.py | 10 +++++----- armrc.sample | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 834eceb..057fb86 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -38,7 +38,7 @@ import stem.util.system LOG_DUMP_PATH = os.path.expanduser("~/.arm/log") CONFIG = stem.util.conf.config_dict("arm", { - "startup.controlPassword": None, + "tor.password": None, "startup.blindModeEnabled": False, "startup.events": "N3", "msg.help": "", @@ -296,7 +296,7 @@ def main(): chroot = arm.util.torTools.get_chroot() try: - controller.authenticate(password = CONFIG["startup.controlPassword"], chroot_path = chroot) + controller.authenticate(password = CONFIG["tor.password"], chroot_path = chroot) except (stem.connection.MissingPassword, stem.connection.IncorrectPassword) as exc: if isinstance(stem.connection.IncorrectPassword, exc): print "Password found in '%s' was incorrect" % args.config @@ -315,12 +315,12 @@ def main(): # Removing references to the controller password so the memory can be # freed. Without direct memory access this is about the best we can do. - if "startup.controlPassword" in config._contents: - del config._contents["startup.controlPassword"] + if "tor.password" in config._contents: + del config._contents["tor.password"] pwLineNum = None for i in range(len(config._raw_contents)): - if config._raw_contents[i].strip().startswith("startup.controlPassword"): + if config._raw_contents[i].strip().startswith("tor.password"): pwLineNum = i break diff --git a/armrc.sample b/armrc.sample index 89e3878..a43105f 100644 --- a/armrc.sample +++ b/armrc.sample @@ -1,5 +1,5 @@ # Startup options -startup.controlPassword +tor.password startup.blindModeEnabled false startup.events N3 startup.dataDirectory ~/.arm

1 0

[arm/master] Replacing _getController() with revised counterpart
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit 0a5cf15739a8799dd06f8095fd428a89a26eaf77 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 9 00:02:49 2013 -0700 Replacing _getController() with revised counterpart Huh. Well, that was odd. We acquired control sockets in the main loop, but then used a helper to both get and authenticate control ports. The sockets never went through non-basic authentication. Meh, whatever. Made a _get_controller() helper that... well, just gets a Controller. We then authenticate reguardless of the connection method. --- arm/starter.py | 126 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 62 insertions(+), 64 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 20a15c6..f046a31 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -216,35 +216,38 @@ def _loadConfigurationDescriptions(pathPrefix): except IOError, exc: stem.util.log.error(DESC_INTERNAL_LOAD_FAILED_MSG % arm.util.sysTools.getFileErrorMsg(exc)) -def _getController(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, incorrectPasswordMsg=""): + +def _get_controller(args): """ - Custom handler for establishing a stem connection (... needs an overhaul). + Provides a Controller for the endpoint specified in the given arguments. + + :param namedtuple args: arguments that arm was started with + + :returns: :class:`~stem.control.Controller` for the given arguments + + :raises: **ValueError** if unable to acquire a controller connection """ - chroot = arm.util.torTools.get_chroot() + if os.path.exists(args.control_socket): + try: + return Controller.from_socket_file(args.control_socket) + except stem.SocketError as exc: + if args.user_provided_socket: + raise ValueError("Unable to connect to %s: %s" % (args.control_socket, exc)) + elif args.user_provided_socket: + raise ValueError("The socket file you specified (%s) doesn't exist" % args.control_socket) try: - controller = Controller.from_port(controlAddr, controlPort) + return Controller.from_port(args.control_address, args.control_port) except stem.SocketError as exc: - print exc - return None + if args.user_provided_port: + raise ValueError("Unable to connect to %s:%i: %s" % (args.control_address, args.control_port, exc)) - try: - controller.authenticate(password = passphrase, chroot_path = chroot) - except stem.connection.MissingPassword: - try: - passphrase = getpass.getpass("Controller password: ") - controller.authenticate(password = passphrase, chroot_path = chroot) - except: - # Huh? The old version just silently failed when it got an incorrect password? - return None - except stem.connection.IncorrectPassword: - # provide a warning that the provided password didn't work, then try - # again prompting for the user to enter it - print incorrectPasswordMsg - return _getController(controlAddr, controlPort) + if not stem.util.system.is_running('tor'): + raise ValueError("Unable to connect to tor. Are you sure it's running?") + else: + raise ValueError("Unable to connect to tor. Maybe it's running without a ControlPort?") - return controller def _dumpConfig(): """ @@ -364,51 +367,46 @@ def main(): for flag in str(exc): print "Unrecognized event flag: %s" % flag sys.exit() - - # 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. - - controller = None - socketPath = args.control_socket - if os.path.exists(socketPath) and not args.user_provided_port: + try: + controller = _get_controller(args) + except ValueError as exc: + print exc + exit(1) + + chroot = arm.util.torTools.get_chroot() + + try: + controller.authenticate(password = CONFIG["startup.controlPassword"], chroot_path = chroot) + except (stem.connection.MissingPassword, stem.connection.IncorrectPassword) as exc: + if isinstance(stem.connection.IncorrectPassword, exc): + print "Password found in '%s' was incorrect" % args.config + try: - # TODO: um... what about passwords? - # https://trac.torproject.org/6881 - - controller = Controller.from_socket_file(socketPath) - controller.authenticate() - except IOError, exc: - if args.user_provided_socket: - print "Unable to use socket '%s': %s" % (socketPath, exc) - elif args.user_provided_socket: - print "Socket '%s' doesn't exist" % socketPath - - if not controller and not args.user_provided_socket: - # 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" % args.config - controller = _getController(args.control_address, args.control_port, authPassword, incorrectPasswordMsg) - - # removing references to the controller password so the memory can be freed - # (unfortunately python does allow for direct access to the memory so this - # is the best we can do) - del authPassword - if "startup.controlPassword" in config._contents: - del config._contents["startup.controlPassword"] - - pwLineNum = None - for i in range(len(config._raw_contents)): - if config._raw_contents[i].strip().startswith("startup.controlPassword"): - pwLineNum = i - break - - if pwLineNum != None: - del config._raw_contents[i] - - if controller is None: sys.exit(1) + passphrase = getpass.getpass("Controller password: ") + controller.authenticate(password = passphrase, chroot_path = chroot) + del passphrase # removing reference as early as possible to free memory + except stem.connection.IncorrectPassword: + print "Incorrect password" + sys.exit(1) + except stem.connection.AuthenticationFailure as exc: + print "Unable to authenticate: %s" % exc + sys.exit(1) + + # Removing references to the controller password so the memory can be + # freed. Without direct memory access this is about the best we can do. + + if "startup.controlPassword" in config._contents: + del config._contents["startup.controlPassword"] + + pwLineNum = None + for i in range(len(config._raw_contents)): + if config._raw_contents[i].strip().startswith("startup.controlPassword"): + pwLineNum = i + break + + if pwLineNum != None: + del config._raw_contents[i] # initializing the connection may require user input (for the password) # skewing the startup time results so this isn't counted

1 0

[arm/master] Simplifying _getController() helper
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit 03b72fd7946f6246ea41ab9182642ce2ece863ab Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 16:44:04 2013 -0700 Simplifying _getController() helper I'm still not happy with the _getController() function, but at least now it's a tad better... --- arm/starter.py | 45 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 67fc5a6..5c51812 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -220,34 +220,31 @@ def _getController(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i """ Custom handler for establishing a stem connection (... needs an overhaul). """ - - controller = None + + chroot = arm.util.torTools.getPathPrefix() + try: - chroot = arm.util.torTools.getPathPrefix() controller = Controller.from_port(controlAddr, controlPort) - + except stem.SocketError as exc: + print exc + return None + + try: + controller.authenticate(password = passphrase, chroot_path = chroot) + except stem.connection.MissingPassword: try: + passphrase = getpass.getpass("Controller password: ") controller.authenticate(password = passphrase, chroot_path = chroot) - except stem.connection.MissingPassword: - try: - passphrase = getpass.getpass("Controller password: ") - controller.authenticate(password = passphrase, chroot_path = chroot) - except: - return None - - return controller - except Exception, exc: - if controller: controller.close() - - 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 _getController(controlAddr, controlPort) - else: - print exc - - return None + except: + # Huh? The old version just silently failed when it got an incorrect password? + return None + except stem.connection.IncorrectPassword: + # provide a warning that the provided password didn't work, then try + # again prompting for the user to enter it + print incorrectPasswordMsg + return _getController(controlAddr, controlPort) + + return controller def _dumpConfig(): """

1 0

[arm/master] Moving loadConfigurationDescriptions() to torConfig
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit f893c6d18af950c9b61bb2d3f332f2ecd31bb862 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 9 16:59:07 2013 -0700 Moving loadConfigurationDescriptions() to torConfig Huh. Haven't a clue why this is in the starter... --- arm/starter.py | 89 +++---------------------------------------------- arm/util/torConfig.py | 80 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+), 85 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 96f4f19..834eceb 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -41,24 +41,12 @@ CONFIG = stem.util.conf.config_dict("arm", { "startup.controlPassword": None, "startup.blindModeEnabled": False, "startup.events": "N3", - "startup.dataDirectory": "~/.arm", - "features.config.descriptions.enabled": True, - "features.config.descriptions.persist": True, "msg.help": "", }) -# filename used for cached tor config descriptions -CONFIG_DESC_FILENAME = "torConfigDesc.txt" - -# messages related to loading the tor configuration descriptions -DESC_LOAD_SUCCESS_MSG = "Loaded configuration descriptions from '%s' (runtime: %0.3f)" -DESC_LOAD_FAILED_MSG = "Unable to load configuration descriptions (%s)" -DESC_INTERNAL_LOAD_SUCCESS_MSG = "Falling back to descriptions for Tor %s" -DESC_INTERNAL_LOAD_FAILED_MSG = "Unable to load fallback descriptions. Categories and help for Tor's configuration options won't be available. (%s)" -DESC_READ_MAN_SUCCESS_MSG = "Read descriptions for tor's configuration options from its man page (runtime %0.3f)" -DESC_READ_MAN_FAILED_MSG = "Unable to get the descriptions of Tor's configuration options from its man page (%s)" -DESC_SAVE_SUCCESS_MSG = "Saved configuration descriptions to '%s' (runtime: %0.3f)" -DESC_SAVE_FAILED_MSG = "Unable to save configuration descriptions (%s)" +# notices given if the user is running arm or tor as root +TOR_ROOT_NOTICE = "Tor is currently running with root permissions. This is not a good idea and shouldn't be necessary. See the 'User UID' option from Tor's man page for an easy method of reducing its permissions after startup." +ARM_ROOT_NOTICE = "Arm is currently running with root permissions. This is not a good idea, and will still work perfectly well if it's run with the same user as Tor (ie, starting with \"sudo -u %s arm\")." NO_INTERNAL_CFG_MSG = "Failed to load the parsing configuration. This will be problematic for a few things like torrc validation and log duplication detection (%s)" STANDARD_CFG_LOAD_FAILED_MSG = "Failed to load configuration (using defaults): \"%s\"" @@ -67,10 +55,6 @@ STANDARD_CFG_NOT_FOUND_MSG = "No armrc loaded, using defaults. You can customize # torrc entries that are scrubbed when dumping PRIVATE_TORRC_ENTRIES = ["HashedControlPassword", "Bridge", "HiddenServiceDir"] -# notices given if the user is running arm or tor as root -TOR_ROOT_NOTICE = "Tor is currently running with root permissions. This is not a good idea and shouldn't be necessary. See the 'User UID' option from Tor's man page for an easy method of reducing its permissions after startup." -ARM_ROOT_NOTICE = "Arm is currently running with root permissions. This is not a good idea, and will still work perfectly well if it's run with the same user as Tor (ie, starting with \"sudo -u %s arm\")." - # Makes subcommands provide us with English results (this is important so we # can properly parse it). @@ -152,71 +136,6 @@ def _get_args(argv): return Args(**args) -def _loadConfigurationDescriptions(pathPrefix): - """ - Attempts to load descriptions for tor's configuration options, fetching them - from the man page and persisting them to a file to speed future startups. - """ - - # It is important that this is loaded before entering the curses context, - # otherwise the man call pegs the cpu for around a minute (I'm not sure - # why... curses must mess the terminal in a way that's important to man). - - if CONFIG["features.config.descriptions.enabled"]: - isConfigDescriptionsLoaded = False - - # determines the path where cached descriptions should be persisted (left - # undefined if caching is disabled) - descriptorPath = None - if CONFIG["features.config.descriptions.persist"]: - dataDir = CONFIG["startup.dataDirectory"] - if not dataDir.endswith("/"): dataDir += "/" - - descriptorPath = os.path.expanduser(dataDir + "cache/") + CONFIG_DESC_FILENAME - - # attempts to load configuration descriptions cached in the data directory - if descriptorPath: - try: - loadStartTime = time.time() - arm.util.torConfig.loadOptionDescriptions(descriptorPath) - isConfigDescriptionsLoaded = True - - stem.util.log.info(DESC_LOAD_SUCCESS_MSG % (descriptorPath, time.time() - loadStartTime)) - except IOError, exc: - stem.util.log.info(DESC_LOAD_FAILED_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - - # fetches configuration options from the man page - if not isConfigDescriptionsLoaded: - try: - loadStartTime = time.time() - arm.util.torConfig.loadOptionDescriptions() - isConfigDescriptionsLoaded = True - - stem.util.log.info(DESC_READ_MAN_SUCCESS_MSG % (time.time() - loadStartTime)) - except IOError, exc: - stem.util.log.notice(DESC_READ_MAN_FAILED_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - - # persists configuration descriptions - if isConfigDescriptionsLoaded and descriptorPath: - try: - loadStartTime = time.time() - arm.util.torConfig.saveOptionDescriptions(descriptorPath) - stem.util.log.info(DESC_SAVE_SUCCESS_MSG % (descriptorPath, time.time() - loadStartTime)) - except (IOError, OSError), exc: - stem.util.log.notice(DESC_SAVE_FAILED_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - - # finally fall back to the cached descriptors provided with arm (this is - # often the case for tbb and manual builds) - if not isConfigDescriptionsLoaded: - try: - loadStartTime = time.time() - loadedVersion = arm.util.torConfig.loadOptionDescriptions("%sresources/%s" % (pathPrefix, CONFIG_DESC_FILENAME), False) - isConfigDescriptionsLoaded = True - stem.util.log.notice(DESC_INTERNAL_LOAD_SUCCESS_MSG % loadedVersion) - except IOError, exc: - stem.util.log.error(DESC_INTERNAL_LOAD_FAILED_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - - def _get_controller(args): """ Provides a Controller for the endpoint specified in the given arguments. @@ -432,7 +351,7 @@ def main(): stem.util.log.notice(ARM_ROOT_NOTICE % torUserLabel) # fetches descriptions for tor's configuration options - _loadConfigurationDescriptions(pathPrefix) + arm.util.torConfig.loadConfigurationDescriptions(pathPrefix) # dump tor and arm configuration when in debug mode if args.debug: diff --git a/arm/util/torConfig.py b/arm/util/torConfig.py index 955e1c5..34fc989 100644 --- a/arm/util/torConfig.py +++ b/arm/util/torConfig.py @@ -13,6 +13,19 @@ from arm.util import sysTools, torTools, uiTools from stem.util import conf, enum, log, str_tools, system +# filename used for cached tor config descriptions +CONFIG_DESC_FILENAME = "torConfigDesc.txt" + +# messages related to loading the tor configuration descriptions +DESC_LOAD_SUCCESS_MSG = "Loaded configuration descriptions from '%s' (runtime: %0.3f)" +DESC_LOAD_FAILED_MSG = "Unable to load configuration descriptions (%s)" +DESC_INTERNAL_LOAD_SUCCESS_MSG = "Falling back to descriptions for Tor %s" +DESC_INTERNAL_LOAD_FAILED_MSG = "Unable to load fallback descriptions. Categories and help for Tor's configuration options won't be available. (%s)" +DESC_READ_MAN_SUCCESS_MSG = "Read descriptions for tor's configuration options from its man page (runtime %0.3f)" +DESC_READ_MAN_FAILED_MSG = "Unable to get the descriptions of Tor's configuration options from its man page (%s)" +DESC_SAVE_SUCCESS_MSG = "Saved configuration descriptions to '%s' (runtime: %0.3f)" +DESC_SAVE_FAILED_MSG = "Unable to save configuration descriptions (%s)" + def conf_handler(key, value): if key == "config.important": # stores lowercase entries to drop case sensitivity @@ -32,6 +45,9 @@ CONFIG = conf.config_dict("arm", { "torrc.label.time.hour": [], "torrc.label.time.day": [], "torrc.label.time.week": [], + "startup.dataDirectory": "~/.arm", + "features.config.descriptions.enabled": True, + "features.config.descriptions.persist": True, }, conf_handler) def general_conf_handler(config, key): @@ -1039,3 +1055,67 @@ def renderTorrc(template, options, commentIndent = 30): return "\n".join(results) +def loadConfigurationDescriptions(pathPrefix): + """ + Attempts to load descriptions for tor's configuration options, fetching them + from the man page and persisting them to a file to speed future startups. + """ + + # It is important that this is loaded before entering the curses context, + # otherwise the man call pegs the cpu for around a minute (I'm not sure + # why... curses must mess the terminal in a way that's important to man). + + if CONFIG["features.config.descriptions.enabled"]: + isConfigDescriptionsLoaded = False + + # determines the path where cached descriptions should be persisted (left + # undefined if caching is disabled) + descriptorPath = None + if CONFIG["features.config.descriptions.persist"]: + dataDir = CONFIG["startup.dataDirectory"] + if not dataDir.endswith("/"): dataDir += "/" + + descriptorPath = os.path.expanduser(dataDir + "cache/") + CONFIG_DESC_FILENAME + + # attempts to load configuration descriptions cached in the data directory + if descriptorPath: + try: + loadStartTime = time.time() + loadOptionDescriptions(descriptorPath) + isConfigDescriptionsLoaded = True + + log.info(DESC_LOAD_SUCCESS_MSG % (descriptorPath, time.time() - loadStartTime)) + except IOError, exc: + log.info(DESC_LOAD_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + + # fetches configuration options from the man page + if not isConfigDescriptionsLoaded: + try: + loadStartTime = time.time() + loadOptionDescriptions() + isConfigDescriptionsLoaded = True + + log.info(DESC_READ_MAN_SUCCESS_MSG % (time.time() - loadStartTime)) + except IOError, exc: + log.notice(DESC_READ_MAN_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + + # persists configuration descriptions + if isConfigDescriptionsLoaded and descriptorPath: + try: + loadStartTime = time.time() + saveOptionDescriptions(descriptorPath) + log.info(DESC_SAVE_SUCCESS_MSG % (descriptorPath, time.time() - loadStartTime)) + except (IOError, OSError), exc: + log.notice(DESC_SAVE_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + + # finally fall back to the cached descriptors provided with arm (this is + # often the case for tbb and manual builds) + if not isConfigDescriptionsLoaded: + try: + loadStartTime = time.time() + loadedVersion = loadOptionDescriptions("%sresources/%s" % (pathPrefix, CONFIG_DESC_FILENAME), False) + isConfigDescriptionsLoaded = True + log.notice(DESC_INTERNAL_LOAD_SUCCESS_MSG % loadedVersion) + except IOError, exc: + log.error(DESC_INTERNAL_LOAD_FAILED_MSG % sysTools.getFileErrorMsg(exc)) +

1 0

[arm/master] Helper function for authenticating to the tor controller
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit b86a709cdba4c57f5e5fa9418f6e795dcfa8c63b Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 14 13:15:57 2013 -0700 Helper function for authenticating to the tor controller More refactoring for arm's starter module. This moves authentication into a helper method, greatly expanding the error output for users and adds unit tests. --- arm/settings.cfg | 28 +++++++++++++++++++ arm/starter.py | 79 +++++++++++++++++++++++++++++++++++++----------------- test/starter.py | 74 +++++++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 155 insertions(+), 26 deletions(-) diff --git a/arm/settings.cfg b/arm/settings.cfg index c73a16f..368d418 100644 --- a/arm/settings.cfg +++ b/arm/settings.cfg @@ -18,6 +18,34 @@ msg.help |arm -b -i 1643 hide connection data, attaching to control port 1643 |arm -e we -c /tmp/cfg use this configuration file with 'WARN'/'ERR' events +msg.wrong_port_type +|Please check in your torrc that %i is the ControlPort. Maybe you configured +|it to be the ORPort or SocksPort instead? + +msg.wrong_socket_type +|Unable to connect to tor. Are you sure the interface you specified belongs to +|tor? + +msg.uncrcognized_auth_type +|Tor is using a type of authentication we do not recognize... +| +| %s +| +|Please check that arm is up to date and if there is an existing issue on +|'http://bugs.torproject.org'. If there isn't one then let us know! + +msg.missing_password_bug +|BUG: You provided a password but despite this stem reported that it was +|missing. This shouldn't happen - please let us know about it! +| +| http://bugs.torproject.org + +msg.unreadable_cookie_file +|We were unable to read tor's authentication cookie... +| +| Path: %s +| Issue: %s + # Important tor configuration options (shown by default) config.important BandwidthRate config.important BandwidthBurst diff --git a/arm/starter.py b/arm/starter.py index 057fb86..fa2289d 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -8,13 +8,13 @@ command line parameters. import collections import getopt +import getpass import os import sys import stem.util.connection import time -import getpass import locale import logging import platform @@ -42,6 +42,11 @@ CONFIG = stem.util.conf.config_dict("arm", { "startup.blindModeEnabled": False, "startup.events": "N3", "msg.help": "", + "msg.wrong_port_type": "", + "msg.wrong_socket_type": "", + "msg.uncrcognized_auth_type": "", + "msg.missing_password_bug": "", + "msg.unreadable_cookie_file": "", }) # notices given if the user is running arm or tor as root @@ -80,6 +85,16 @@ ARGS = { OPT = "gi:s:c:dbe:vh" OPT_EXPANDED = ["interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] +try: + pathPrefix = os.path.dirname(sys.argv[0]) + if pathPrefix and not pathPrefix.endswith("/"): + pathPrefix = pathPrefix + "/" + + config = stem.util.conf.get_config("arm") + config.load("%sarm/settings.cfg" % pathPrefix) +except IOError, exc: + stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) + def _get_args(argv): """ @@ -168,6 +183,43 @@ def _get_controller(args): raise ValueError("Unable to connect to tor. Maybe it's running without a ControlPort?") +def _authenticate(controller, password): + """ + Authenticates to the given Controller. + + :param stem.control.Controller controller: controller to be authenticated to + :param str args: password to authenticate with, **None** if nothing was provided + + :raises: **ValueError** if unable to authenticate + """ + + chroot = arm.util.torTools.get_chroot() + + try: + controller.authenticate(password = password, chroot_path = chroot) + except stem.connection.IncorrectSocketType: + control_socket = controller.get_socket() + + if isinstance(control_socket, stem.socket.ControlPort): + raise ValueError(CONFIG['msg.wrong_port_type'] % control_socket.get_port()) + else: + raise ValueError(CONFIG['msg.wrong_socket_type']) + except stem.connection.UnrecognizedAuthMethods as exc: + raise ValueError(CONFIG['msg.uncrcognized_auth_type'] % ', '.join(exc.unknown_auth_methods)) + except stem.connection.IncorrectPassword: + raise ValueError("Incorrect password") + except stem.connection.MissingPassword: + if password: + raise ValueError(CONFIG['msg.missing_password_bug']) + + password = getpass.getpass("Tor controller password: ") + return _authenticate(controller, password) + except stem.connection.UnreadableCookieFile as exc: + raise ValueError(CONFIG['msg.unreadable_cookie_file'] % (exc.cookie_path, str(exc))) + except stem.connection.AuthenticationFailure as exc: + raise ValueError("Unable to authenticate: %s" % exc) + + def _dumpConfig(): """ Dumps the current arm and tor configurations at the DEBUG runlevel. This @@ -222,11 +274,6 @@ def main(): pathPrefix = pathPrefix + "/" try: - config.load("%sarm/settings.cfg" % pathPrefix) - except IOError, exc: - stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - - try: args = _get_args(sys.argv[1:]) except getopt.GetoptError as exc: print "%s (for usage provide --help)" % exc @@ -289,29 +336,11 @@ def main(): try: controller = _get_controller(args) + _authenticate(controller, CONFIG['tor.password']) except ValueError as exc: print exc exit(1) - chroot = arm.util.torTools.get_chroot() - - try: - controller.authenticate(password = CONFIG["tor.password"], chroot_path = chroot) - except (stem.connection.MissingPassword, stem.connection.IncorrectPassword) as exc: - if isinstance(stem.connection.IncorrectPassword, exc): - print "Password found in '%s' was incorrect" % args.config - - try: - passphrase = getpass.getpass("Controller password: ") - controller.authenticate(password = passphrase, chroot_path = chroot) - del passphrase # removing reference as early as possible to free memory - except stem.connection.IncorrectPassword: - print "Incorrect password" - sys.exit(1) - except stem.connection.AuthenticationFailure as exc: - print "Unable to authenticate: %s" % exc - sys.exit(1) - # Removing references to the controller password so the memory can be # freed. Without direct memory access this is about the best we can do. diff --git a/test/starter.py b/test/starter.py index f8c4f0c..d1c90cf 100644 --- a/test/starter.py +++ b/test/starter.py @@ -7,9 +7,16 @@ import unittest from mock import Mock, patch -from arm.starter import _get_args, _get_controller, ARGS +from arm.starter import ( + _get_args, + _get_controller, + _authenticate, + ARGS, +) import stem +import stem.connection +import stem.socket class TestArgumentParsing(unittest.TestCase): def test_that_we_get_default_values(self): @@ -127,3 +134,68 @@ class TestGetController(unittest.TestCase): self.fail() except ValueError, exc: self.assertEqual(msg, str(exc)) + +class TestAuthenticate(unittest.TestCase): + @patch('arm.util.torTools.get_chroot') + def test_success(self, get_chroot_mock): + controller = Mock() + + get_chroot_mock.return_value = '' # no chroot + _authenticate(controller, None) + controller.authenticate.assert_called_with(password = None, chroot_path = '') + controller.authenticate.reset_mock() + + get_chroot_mock.return_value = '/my/chroot' + _authenticate(controller, 's3krit!!!') + controller.authenticate.assert_called_with(password = 's3krit!!!', chroot_path = '/my/chroot') + + @patch('arm.util.torTools.get_chroot', Mock(return_value = '')) + @patch('getpass.getpass') + def test_success_with_password_prompt(self, getpass_mock): + controller = Mock() + + def authenticate_mock(password, **kwargs): + if password is None: + raise stem.connection.MissingPassword('no password') + elif password == 'my_password': + return None # success + else: + raise ValueError("Unexpected authenticate_mock input: %s" % password) + + controller.authenticate.side_effect = authenticate_mock + getpass_mock.return_value = 'my_password' + + _authenticate(controller, None) + controller.authenticate.assert_any_call(password = None, chroot_path = '') + controller.authenticate.assert_any_call(password = 'my_password', chroot_path = '') + + @patch('arm.util.torTools.get_chroot', Mock(return_value = '')) + def test_failure(self): + controller = Mock() + + controller.authenticate.side_effect = stem.connection.IncorrectSocketType('unable to connect to socket') + controller.get_socket.return_value = stem.socket.ControlPort(connect = False) + self._assert_authenticate_fails_with(controller, 'Please check in your torrc that 9051 is the ControlPort.') + + controller.get_socket.return_value = stem.socket.ControlSocketFile(connect = False) + self._assert_authenticate_fails_with(controller, 'Are you sure the interface you specified belongs to') + + controller.authenticate.side_effect = stem.connection.UnrecognizedAuthMethods('unable to connect', ['telepathy']) + self._assert_authenticate_fails_with(controller, 'Tor is using a type of authentication we do not recognize...\n\n telepathy') + + controller.authenticate.side_effect = stem.connection.IncorrectPassword('password rejected') + self._assert_authenticate_fails_with(controller, 'Incorrect password') + + controller.authenticate.side_effect = stem.connection.UnreadableCookieFile('permission denied', '/tmp/my_cookie', False) + self._assert_authenticate_fails_with(controller, "We were unable to read tor's authentication cookie...\n\n Path: /tmp/my_cookie\n Issue: permission denied") + + controller.authenticate.side_effect = stem.connection.OpenAuthRejected('crazy failure') + self._assert_authenticate_fails_with(controller, 'Unable to authenticate: crazy failure') + + def _assert_authenticate_fails_with(self, controller, msg): + try: + _get_controller(_authenticate(controller, None)) + self.fail() + except ValueError, exc: + if not msg in str(exc): + self.fail("Expected...\n\n%s\n\n... which couldn't be found in...\n\n%s" % (msg, exc))

1 0

[arm/master] Removing sysTools' getFileErrorMsg() function
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit 4f78691b376b8ec228ae5d3ece46f3e330d0e0b7 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 15 11:48:12 2013 -0700 Removing sysTools' getFileErrorMsg() function The sole purpose of getFileErrorMsg() was to strip off the errno component of IOErrors from the output we print or log. On reflection however, that's exactly what the IOError's strerror attribute is so might as well use this instead. Only funcitonal difference of this change is that we no longer call lower() on the messages. --- arm/configPanel.py | 4 ++-- arm/controller.py | 2 +- arm/logPanel.py | 13 ++++++++----- arm/starter.py | 11 ++++++----- arm/util/sysTools.py | 20 -------------------- arm/util/torConfig.py | 16 +++++++++------- 6 files changed, 26 insertions(+), 40 deletions(-) diff --git a/arm/configPanel.py b/arm/configPanel.py index 8a11be4..9ae4fa8 100644 --- a/arm/configPanel.py +++ b/arm/configPanel.py @@ -9,7 +9,7 @@ import threading import arm.controller import popups -from arm.util import panel, sysTools, torConfig, torTools, uiTools +from arm.util import panel, torConfig, torTools, uiTools import stem.control @@ -474,7 +474,7 @@ class ConfigPanel(panel.Panel): torConfig.saveConf(configLocation, configLines) msg = "Saved configuration to %s" % configLocation except IOError, exc: - msg = "Unable to save configuration (%s)" % sysTools.getFileErrorMsg(exc) + msg = "Unable to save configuration (%s)" % exc.strerror popups.showMsg(msg, 2) finally: popups.finalize() diff --git a/arm/controller.py b/arm/controller.py index f6a1f6e..a72c634 100644 --- a/arm/controller.py +++ b/arm/controller.py @@ -665,7 +665,7 @@ def drawTorMonitor(stdscr, startTime): if confirmationKey in (ord('x'), ord('X')): try: torTools.getConn().reload() except IOError, exc: - log.error("Error detected when reloading tor: %s" % sysTools.getFileErrorMsg(exc)) + log.error("Error detected when reloading tor: %s" % exc.strerror) elif key == ord('h') or key == ord('H'): overrideKey = arm.popups.showHelpPopup() elif key == ord('l') - 96: diff --git a/arm/logPanel.py b/arm/logPanel.py index 1f3067c..e9b3d06 100644 --- a/arm/logPanel.py +++ b/arm/logPanel.py @@ -18,7 +18,7 @@ from stem.util import conf, log, system import arm.popups from arm import __version__ -from arm.util import panel, sysTools, torTools, uiTools +from arm.util import panel, torTools, uiTools TOR_EVENT_TYPES = { "d": "DEBUG", "a": "ADDRMAP", "k": "DESCCHANGED", "s": "STREAM", @@ -555,8 +555,11 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): self.logFile = open(logPath, "a") log.notice("arm %s opening log file (%s)" % (__version__, logPath)) - except (IOError, OSError), exc: - log.error("Unable to write to log file: %s" % sysTools.getFileErrorMsg(exc)) + except IOError, exc: + log.error("Unable to write to log file: %s" % exc.strerror) + self.logFile = None + except OSError, exc: + log.error("Unable to write to log file: %s" % exc) self.logFile = None stem_logger = log.get_logger() @@ -652,7 +655,7 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): self.logFile.write(event.getDisplayMessage(True) + "\n") self.logFile.flush() except IOError, exc: - log.error("Unable to write to log file: %s" % sysTools.getFileErrorMsg(exc)) + log.error("Unable to write to log file: %s" % exc.strerror) self.logFile = None self.valsLock.acquire() @@ -786,7 +789,7 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler): self.saveSnapshot(pathInput) popups.showMsg("Saved: %s" % pathInput, 2) except IOError, exc: - popups.showMsg("Unable to save snapshot: %s" % sysTools.getFileErrorMsg(exc), 2) + popups.showMsg("Unable to save snapshot: %s" % exc.strerror, 2) def clear(self): """ diff --git a/arm/starter.py b/arm/starter.py index 53c24ff..c804745 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -16,7 +16,6 @@ import time import arm.controller import arm.logPanel -import arm.util.sysTools import arm.util.torConfig import arm.util.torTools import arm.util.uiTools @@ -85,7 +84,7 @@ try: config = stem.util.conf.get_config("arm") config.load("%sarm/settings.cfg" % pathPrefix) except IOError, exc: - stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) + stem.util.log.warn(NO_INTERNAL_CFG_MSG % exc.strerror) def _get_args(argv): @@ -314,15 +313,17 @@ def main(): osLabel = "Platform: %s (%s)" % (platform.system(), " ".join(platform.dist())) stem.util.log.trace("%s\n%s\n%s\n%s\n" % (initMsg, pythonVersionLabel, osLabel, "-" * 80)) - except (OSError, IOError), exc: - print "Unable to write to debug log file: %s" % arm.util.sysTools.getFileErrorMsg(exc) + except OSError, exc: + print "Unable to write to debug log file: %s" % exc + except IOError, exc: + print "Unable to write to debug log file: %s" % exc.strerror # loads user's personal armrc if available if os.path.exists(args.config): try: config.load(args.config) except IOError, exc: - stem.util.log.warn(CONFIG['msg.unable_to_read_config'].format(error = arm.util.sysTools.getFileErrorMsg(exc))) + stem.util.log.warn(CONFIG['msg.unable_to_read_config'].format(error = exc.strerror)) else: # no armrc found, falling back to the defaults in the source stem.util.log.notice(CONFIG['msg.config_not_found'].format(path = args.config)) diff --git a/arm/util/sysTools.py b/arm/util/sysTools.py index 3763826..80e5c12 100644 --- a/arm/util/sysTools.py +++ b/arm/util/sysTools.py @@ -40,26 +40,6 @@ def getSysCpuUsage(): runtimeSum = sum([entry[1] for entry in RUNTIMES]) return runtimeSum / SAMPLING_PERIOD -def getFileErrorMsg(exc): - """ - Strips off the error number prefix for file related IOError messages. For - instance, instead of saying: - [Errno 2] No such file or directory - - this would return: - no such file or directory - - Arguments: - exc - file related IOError exception - """ - - excStr = str(exc) - if excStr.startswith("[Errno ") and "] " in excStr: - excStr = excStr[excStr.find("] ") + 2:].strip() - excStr = excStr[0].lower() + excStr[1:] - - return excStr - def getResourceTracker(pid, noSpawn = False): """ Provides a running singleton ResourceTracker instance for the given pid. diff --git a/arm/util/torConfig.py b/arm/util/torConfig.py index 34fc989..978f44c 100644 --- a/arm/util/torConfig.py +++ b/arm/util/torConfig.py @@ -9,7 +9,7 @@ import threading import stem.version -from arm.util import sysTools, torTools, uiTools +from arm.util import torTools, uiTools from stem.util import conf, enum, log, str_tools, system @@ -727,7 +727,7 @@ class Torrc(): configFile.close() except IOError, exc: if logFailure and not self.isLoadFailWarned: - log.warn("Unable to load torrc (%s)" % sysTools.getFileErrorMsg(exc)) + log.warn("Unable to load torrc (%s)" % exc.strerror) self.isLoadFailWarned = True self.valsLock.release() @@ -1086,7 +1086,7 @@ def loadConfigurationDescriptions(pathPrefix): log.info(DESC_LOAD_SUCCESS_MSG % (descriptorPath, time.time() - loadStartTime)) except IOError, exc: - log.info(DESC_LOAD_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + log.info(DESC_LOAD_FAILED_MSG % exc.strerror) # fetches configuration options from the man page if not isConfigDescriptionsLoaded: @@ -1097,7 +1097,7 @@ def loadConfigurationDescriptions(pathPrefix): log.info(DESC_READ_MAN_SUCCESS_MSG % (time.time() - loadStartTime)) except IOError, exc: - log.notice(DESC_READ_MAN_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + log.notice(DESC_READ_MAN_FAILED_MSG % exc.strerror) # persists configuration descriptions if isConfigDescriptionsLoaded and descriptorPath: @@ -1105,8 +1105,10 @@ def loadConfigurationDescriptions(pathPrefix): loadStartTime = time.time() saveOptionDescriptions(descriptorPath) log.info(DESC_SAVE_SUCCESS_MSG % (descriptorPath, time.time() - loadStartTime)) - except (IOError, OSError), exc: - log.notice(DESC_SAVE_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + except IOError, exc: + log.notice(DESC_SAVE_FAILED_MSG % exc.strerror) + except OSError, exc: + log.notice(DESC_SAVE_FAILED_MSG % exc) # finally fall back to the cached descriptors provided with arm (this is # often the case for tbb and manual builds) @@ -1117,5 +1119,5 @@ def loadConfigurationDescriptions(pathPrefix): isConfigDescriptionsLoaded = True log.notice(DESC_INTERNAL_LOAD_SUCCESS_MSG % loadedVersion) except IOError, exc: - log.error(DESC_INTERNAL_LOAD_FAILED_MSG % sysTools.getFileErrorMsg(exc)) + log.error(DESC_INTERNAL_LOAD_FAILED_MSG % exc.strerror)

1 0

[arm/master] Unit tests for _get_controller()
by atagar＠torproject.org 15 Sep '13

15 Sep '13

commit 5ef90b441a7f77104c835c5dc3968e6a0523b78f Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 9 13:46:13 2013 -0700 Unit tests for _get_controller() Handful of unit tests for our helper that gets an unauthenticated Controller. --- arm/starter.py | 2 +- test/starter.py | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 61 insertions(+), 2 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index f046a31..96f4f19 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -233,7 +233,7 @@ def _get_controller(args): return Controller.from_socket_file(args.control_socket) except stem.SocketError as exc: if args.user_provided_socket: - raise ValueError("Unable to connect to %s: %s" % (args.control_socket, exc)) + raise ValueError("Unable to connect to '%s': %s" % (args.control_socket, exc)) elif args.user_provided_socket: raise ValueError("The socket file you specified (%s) doesn't exist" % args.control_socket) diff --git a/test/starter.py b/test/starter.py index a4e6fdf..f8c4f0c 100644 --- a/test/starter.py +++ b/test/starter.py @@ -5,7 +5,11 @@ Unit tests for arm's initialization module. import getopt import unittest -from arm.starter import _get_args, ARGS +from mock import Mock, patch + +from arm.starter import _get_args, _get_controller, ARGS + +import stem class TestArgumentParsing(unittest.TestCase): def test_that_we_get_default_values(self): @@ -68,3 +72,58 @@ class TestArgumentParsing(unittest.TestCase): for invalid_input in invalid_inputs: self.assertRaises(ValueError, _get_args, ['--interface', invalid_input]) +class TestGetController(unittest.TestCase): + @patch('os.path.exists', Mock(return_value = True)) + @patch('stem.util.system.is_running') + @patch('stem.control.Controller.from_socket_file', Mock(side_effect = stem.SocketError('failed'))) + @patch('stem.control.Controller.from_port', Mock(side_effect = stem.SocketError('failed'))) + def test_failue_with_the_default_endpoint(self, is_running_mock): + is_running_mock.return_value = False + self._assert_get_controller_fails_with([], "Unable to connect to tor. Are you sure it's running?") + + is_running_mock.return_value = True + self._assert_get_controller_fails_with([], "Unable to connect to tor. Maybe it's running without a ControlPort?") + + @patch('os.path.exists') + @patch('stem.util.system.is_running', Mock(return_value = True)) + @patch('stem.control.Controller.from_socket_file', Mock(side_effect = stem.SocketError('failed'))) + @patch('stem.control.Controller.from_port', Mock(side_effect = stem.SocketError('failed'))) + def test_failure_with_a_custom_endpoint(self, path_exists_mock): + path_exists_mock.return_value = True + self._assert_get_controller_fails_with(['--interface', '80'], "Unable to connect to 127.0.0.1:80: failed") + self._assert_get_controller_fails_with(['--socket', '/tmp/my_socket'], "Unable to connect to '/tmp/my_socket': failed") + + path_exists_mock.return_value = False + self._assert_get_controller_fails_with(['--interface', '80'], "Unable to connect to 127.0.0.1:80: failed") + self._assert_get_controller_fails_with(['--socket', '/tmp/my_socket'], "The socket file you specified (/tmp/my_socket) doesn't exist") + + @patch('os.path.exists', Mock(return_value = False)) + @patch('stem.control.Controller.from_port') + def test_getting_a_control_port(self, from_port_mock): + from_port_mock.return_value = 'success' + + self.assertEqual('success', _get_controller(_get_args([]))) + from_port_mock.assert_called_once_with('127.0.0.1', 9051) + from_port_mock.reset_mock() + + self.assertEqual('success', _get_controller(_get_args(['--interface', '255.0.0.10:80']))) + from_port_mock.assert_called_once_with('255.0.0.10', 80) + + @patch('os.path.exists', Mock(return_value = True)) + @patch('stem.control.Controller.from_socket_file') + def test_getting_a_control_socket(self, from_socket_file_mock): + from_socket_file_mock.return_value = 'success' + + self.assertEqual('success', _get_controller(_get_args([]))) + from_socket_file_mock.assert_called_once_with('/var/run/tor/control') + from_socket_file_mock.reset_mock() + + self.assertEqual('success', _get_controller(_get_args(['--socket', '/tmp/my_socket']))) + from_socket_file_mock.assert_called_once_with('/tmp/my_socket') + + def _assert_get_controller_fails_with(self, args, msg): + try: + _get_controller(_get_args(args)) + self.fail() + except ValueError, exc: + self.assertEqual(msg, str(exc))

1 0