April 2014 - tor-commits - lists.torproject.org

[translation/tails-perl5lib] Update translations for tails-perl5lib
by translation＠torproject.org 10 Apr '14

10 Apr '14

commit 41f37a598c397f67b26c1a8ae93ceaabe79d7383 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Apr 10 21:45:55 2014 +0000 Update translations for tails-perl5lib --- hu.po | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/hu.po b/hu.po index 9780d75..723fb6a 100644 --- a/hu.po +++ b/hu.po @@ -3,13 +3,14 @@ # This file is distributed under the same license as the PACKAGE package. # # Translators: +# lajos <mrlajos(a)gmail.com>, 2014 msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: Tails developers <tails(a)boum.org>\n" "POT-Creation-Date: 2013-11-28 11:56+0100\n" -"PO-Revision-Date: 2013-12-30 04:38+0000\n" -"Last-Translator: Phoul <colin(a)torproject.org>\n" +"PO-Revision-Date: 2014-04-10 21:44+0000\n" +"Last-Translator: lajos <mrlajos(a)gmail.com>\n" "Language-Team: Hungarian (http://www.transifex.com/projects/p/torproject/language/hu/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -21,4 +22,4 @@ msgstr "" msgid "" "The device Tails is running from cannot be found. Maybe you used the `toram'" " option?" -msgstr "" +msgstr "Az eszköz amiről a Tails fut nem található. Lehetséges, hogy a \"toram\" opciót használtad?"

1 0

[translation/torcheck_completed] Update translations for torcheck_completed
by translation＠torproject.org 10 Apr '14

10 Apr '14

commit 6adc2feb6ba4f4a6fa15917778284206c4af2d23 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Apr 10 21:45:16 2014 +0000 Update translations for torcheck_completed --- hu/torcheck.po | 49 ++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 44 insertions(+), 5 deletions(-) diff --git a/hu/torcheck.po b/hu/torcheck.po index 3cfb15c..fcc6f2d 100644 --- a/hu/torcheck.po +++ b/hu/torcheck.po @@ -1,14 +1,15 @@ # TorCheck gettext template -# Copyright (C) 2008-2012 The Tor Project, Inc +# Copyright (C) 2008-2013 The Tor Project, Inc # # Translators: +# lajos <mrlajos(a)gmail.com>, 2014 # vargaviktor <viktor.varga(a)gmail.com>, 2012 msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "POT-Creation-Date: 2012-02-16 20:28+PDT\n" -"PO-Revision-Date: 2013-11-06 09:10+0000\n" -"Last-Translator: runasand <runa.sandvik(a)gmail.com>\n" +"PO-Revision-Date: 2014-04-10 21:40+0000\n" +"Last-Translator: lajos <mrlajos(a)gmail.com>\n" "Language-Team: Hungarian (http://www.transifex.com/projects/p/torproject/language/hu/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -17,8 +18,8 @@ msgstr "" "Language: hu\n" "Plural-Forms: nplurals=2; plural=(n != 1);\n" -msgid "Congratulations. Your browser is configured to use Tor." -msgstr "Gratulálunk a böngészője be van állítva Tor használatához." +msgid "Congratulations. This browser is configured to use Tor." +msgstr "Gratulálunk! A böngésző be lett konfigurálva a Tor használatához." msgid "" "Please refer to the <a href=\"https://www.torproject.org/\">Tor website</a> " @@ -54,3 +55,41 @@ msgstr "Átmeneti hálózati kimaradás nem teszi lehetővé, hogy eldöntsük, msgid "Your IP address appears to be: " msgstr "Az ön IP címe a következőnek látszik:" + +msgid "Are you using Tor?" +msgstr "Használsz Tor-t ?" + +msgid "This page is also available in the following languages:" +msgstr "Ez az oldal a következő nyelveken is elérhető:" + +msgid "For more information about this exit relay, see:" +msgstr "Tovább információ erről a exit relay itt:" + +msgid "" +"The Tor Project is a US 501(c)(3) non-profit dedicated to the research, " +"development, and education of online anonymity and privacy." +msgstr "A Tor Project egy a US 501(c)(3) szerinti non-profit, amely kutatással, fejéesztéssel és oktatással foglakozik az online anonimitás és személyes adatvédelem területén." + +msgid "Learn More »" +msgstr "Tanulj többet »" + +msgid "Go" +msgstr "Mehet" + +msgid "Short User Manual" +msgstr "Rövid felhasználói útmutató" + +msgid "Donate to Support Tor" +msgstr "Adakozás a Tor támogatására" + +msgid "Tor Q&A Site" +msgstr "Tor Kérdések és Válaszok oldal" + +msgid "Volunteer" +msgstr "Önkéntes" + +msgid "JavaScript is enabled." +msgstr "JavaScript engedélyezve." + +msgid "JavaScript is disabled." +msgstr "JavaScript letiltva."

1 0

[translation/torcheck] Update translations for torcheck
by translation＠torproject.org 10 Apr '14

10 Apr '14

commit 8028b971dd02c2ee7a5c4675057ba0911c2581cc Author: Translation commit bot <translation(a)torproject.org> Date: Thu Apr 10 21:45:10 2014 +0000 Update translations for torcheck --- hu/torcheck.po | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/hu/torcheck.po b/hu/torcheck.po index d85a679..fcc6f2d 100644 --- a/hu/torcheck.po +++ b/hu/torcheck.po @@ -2,13 +2,14 @@ # Copyright (C) 2008-2013 The Tor Project, Inc # # Translators: +# lajos <mrlajos(a)gmail.com>, 2014 # vargaviktor <viktor.varga(a)gmail.com>, 2012 msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "POT-Creation-Date: 2012-02-16 20:28+PDT\n" -"PO-Revision-Date: 2014-01-02 08:41+0000\n" -"Last-Translator: runasand <runa.sandvik(a)gmail.com>\n" +"PO-Revision-Date: 2014-04-10 21:40+0000\n" +"Last-Translator: lajos <mrlajos(a)gmail.com>\n" "Language-Team: Hungarian (http://www.transifex.com/projects/p/torproject/language/hu/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -18,7 +19,7 @@ msgstr "" "Plural-Forms: nplurals=2; plural=(n != 1);\n" msgid "Congratulations. This browser is configured to use Tor." -msgstr "" +msgstr "Gratulálunk! A böngésző be lett konfigurálva a Tor használatához." msgid "" "Please refer to the <a href=\"https://www.torproject.org/\">Tor website</a> " @@ -56,13 +57,13 @@ msgid "Your IP address appears to be: " msgstr "Az ön IP címe a következőnek látszik:" msgid "Are you using Tor?" -msgstr "" +msgstr "Használsz Tor-t ?" msgid "This page is also available in the following languages:" -msgstr "" +msgstr "Ez az oldal a következő nyelveken is elérhető:" msgid "For more information about this exit relay, see:" -msgstr "" +msgstr "Tovább információ erről a exit relay itt:" msgid "" "The Tor Project is a US 501(c)(3) non-profit dedicated to the research, " @@ -70,25 +71,25 @@ msgid "" msgstr "A Tor Project egy a US 501(c)(3) szerinti non-profit, amely kutatással, fejéesztéssel és oktatással foglakozik az online anonimitás és személyes adatvédelem területén." msgid "Learn More »" -msgstr "" +msgstr "Tanulj többet »" msgid "Go" -msgstr "" +msgstr "Mehet" msgid "Short User Manual" -msgstr "" +msgstr "Rövid felhasználói útmutató" msgid "Donate to Support Tor" -msgstr "" +msgstr "Adakozás a Tor támogatására" msgid "Tor Q&A Site" -msgstr "" +msgstr "Tor Kérdések és Válaszok oldal" msgid "Volunteer" -msgstr "" +msgstr "Önkéntes" msgid "JavaScript is enabled." -msgstr "" +msgstr "JavaScript engedélyezve." msgid "JavaScript is disabled." -msgstr "" +msgstr "JavaScript letiltva."

1 0

[tor-browser-bundle/master] Document JS option changes in changelog.
by mikeperry＠torproject.org 10 Apr '14

10 Apr '14

commit 47dba349261163d41bcd0102f1e712fa2fe43f35 Author: Mike Perry <mikeperry-git(a)torproject.org> Date: Thu Apr 10 09:49:43 2014 -0700 Document JS option changes in changelog. --- Bundle-Data/Docs/ChangeLog.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/Bundle-Data/Docs/ChangeLog.txt b/Bundle-Data/Docs/ChangeLog.txt index 9b66b5e..194ce0f 100644 --- a/Bundle-Data/Docs/ChangeLog.txt +++ b/Bundle-Data/Docs/ChangeLog.txt @@ -2,6 +2,7 @@ Tor Browser Bundle 3.6-beta-2 -- Apr 8 2014 * All Platforms * Update OpenSSL to 1.0.1g * Bug 9010: Add Turkish language support. + * Bug 9387 testing: Disable JS JIT, type inference, asmjs, and ion. * Update fte transport to 0.2.12 * Update NoScript to 2.6.8.19 * Update Torbutton to 1.6.8.0

1 0

[translation/tor-launcher-properties] Update translations for tor-launcher-properties
by translation＠torproject.org 10 Apr '14

10 Apr '14

commit eee5526139f47299068eef8a8a9cb7656b751e5a Author: Translation commit bot <translation(a)torproject.org> Date: Thu Apr 10 16:15:30 2014 +0000 Update translations for tor-launcher-properties --- vi/torlauncher.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vi/torlauncher.properties b/vi/torlauncher.properties index e57776c..e70b4c1 100644 --- a/vi/torlauncher.properties +++ b/vi/torlauncher.properties @@ -17,7 +17,7 @@ torlauncher.torrc_missing=Thiếu tập tin torrc. torlauncher.datadir_missing=Thư mục data trong Tor không tồn tại. torlauncher.password_hash_missing=Failed to get hashed password. -torlauncher.failed_to_get_settings=Unable to retrieve Tor settings.\n\n%S +torlauncher.failed_to_get_settings=Không thể nhận được cài đặt Tor. torlauncher.failed_to_save_settings=Không thể lưu lại các cài đặt của Tor. torlauncher.ensure_tor_is_running=Hãy chắc chắn rằng Tor đang chạy.

1 0

[arm/master] Using Stem's connect() method
by atagar＠torproject.org 10 Apr '14

10 Apr '14

commit 3aa83a9de0056425c47d3f3695ec6a299218c4f0 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Apr 10 09:13:47 2014 -0700 Using Stem's connect() method Replacing our connection and authentication code in favor of stem's shiny new method for this. --- arm/__init__.py | 2 +- arm/arguments.py | 2 +- arm/config/strings.cfg | 38 --------------------- arm/starter.py | 21 ++++++++---- arm/util/__init__.py | 77 +++--------------------------------------- test/util/authenticate.py | 73 --------------------------------------- test/util/init_controller.py | 67 ------------------------------------ 7 files changed, 21 insertions(+), 259 deletions(-) diff --git a/arm/__init__.py b/arm/__init__.py index c203b5f..25e322f 100644 --- a/arm/__init__.py +++ b/arm/__init__.py @@ -2,7 +2,7 @@ Scripts involved in validating user input, system state, and initializing arm. """ -__all__ = ["starter", "prereq", "version", "config_panel", "controller", "header_panel", "log_panel", "popups", "torrc_panel"] +__all__ = ["starter", "arguments", "prereq", "version", "config_panel", "controller", "header_panel", "log_panel", "popups", "torrc_panel"] __version__ = '1.4.6_dev' __release_date__ = 'April 28, 2011' diff --git a/arm/arguments.py b/arm/arguments.py index 3d4a656..b527564 100644 --- a/arm/arguments.py +++ b/arm/arguments.py @@ -25,7 +25,7 @@ DEFAULT_ARGS = { 'print_help': False, } -OPT = 'i:s:c:d:bl:vh' +OPT = 'i:s:c:d:l:vh' OPT_EXPANDED = [ 'interface=', diff --git a/arm/config/strings.cfg b/arm/config/strings.cfg index 17a9cd7..3ac3b3c 100644 --- a/arm/config/strings.cfg +++ b/arm/config/strings.cfg @@ -3,7 +3,6 @@ # User facing strings. These are sorted into the following namespaces... # # * config parsing or handling configuration options -# * connect connection and authentication to tor # * debug concerns the --debug argument # * misc anything that doesn't fit into a present namespace # * setup notificaitons or issues arising while starting arm @@ -18,15 +17,6 @@ msg.config.unable_to_load_settings Unable to load arm's internal configurations: msg.config.unable_to_read_file Failed to load configuration (using defaults): "{error}" msg.config.nothing_loaded No armrc loaded, using defaults. You can customize arm by placing a configuration file at {path} (see the armrc.sample for its options). -msg.connect.general_auth_failure Unable to authenticate: {error} -msg.connect.incorrect_password Incorrect password -msg.connect.no_control_port Unable to connect to tor. Maybe it's running without a ControlPort? -msg.connect.password_prompt Tor controller password: -msg.connect.socket_doesnt_exist The socket file you specified ({path}) doesn't exist -msg.connect.tor_isnt_running Unable to connect to tor. Are you sure it's running? -msg.connect.unable_to_use_port Unable to connect to {address}:{port}: {error} -msg.connect.unable_to_use_socket Unable to connect to '{path}': {error} - msg.debug.saving_to_path Saving a debug log to {path}, please check it for sensitive information before sharing it. msg.debug.unable_to_write_file Unable to write to our debug log file ({path}): {error} @@ -53,26 +43,6 @@ msg.usage.not_a_valid_port '{port_input}' isn't a valid port number msg.usage.unrecognized_log_flags Unrecognized event flags: {flags} msg.usage.unable_to_set_color_override "{color}" isn't a valid color -msg.connect.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.connect.unreadable_cookie_file -|We were unable to read tor's authentication cookie... -| -| Path: {path} -| Issue: {issue} - -msg.connect.wrong_port_type -|Please check in your torrc that {port} is the ControlPort. Maybe you -|configured it to be the ORPort or SocksPort instead? - -msg.connect.wrong_socket_type -|Unable to connect to tor. Are you sure the interface you specified belongs to -|tor? - msg.debug.header |Arm {arm_version} Debug Dump |Stem Version: {stem_version} @@ -99,14 +69,6 @@ msg.setup.unknown_term |Either update your terminfo database or run arm using "TERM=xterm arm". | -msg.uncrcognized_auth_type -|Tor is using a type of authentication we do not recognize... -| -| {auth_methods} -| -|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.usage.help_output |Usage arm [OPTION] |Terminal status monitor for Tor relays. diff --git a/arm/starter.py b/arm/starter.py index 9493415..ba7c9af 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -22,11 +22,12 @@ import arm.util.tracker import arm.util.ui_tools import stem +import stem.connection import stem.util.conf import stem.util.log import stem.util.system -from arm.util import BASE_DIR, init_controller, authenticate, msg, trace, info, notice, warn, load_settings +from arm.util import BASE_DIR, init_controller, msg, trace, info, notice, warn, load_settings CONFIG = stem.util.conf.get_config('arm') @@ -64,13 +65,21 @@ def main(): _load_user_armrc(args.config) - try: - controller = init_controller(args) - authenticate(controller, CONFIG.get('tor.password', None), CONFIG.get('tor.chroot', '')) - except ValueError as exc: - print exc + control_port = None if args.user_provided_socket else (args.control_address, args.control_port) + control_socket = None if args.user_provided_port else args.control_socket + + controller = stem.connection.connect( + control_port = control_port, + control_socket = control_socket, + password = CONFIG.get('tor.password', None), + password_prompt = True, + chroot_path = CONFIG.get('tor.chroot', ''), + ) + + if controller is None: exit(1) + init_controller(controller) _warn_if_root(controller) _warn_if_unable_to_get_pid(controller) _setup_freebsd_chroot(controller) diff --git a/arm/util/__init__.py b/arm/util/__init__.py index d94173b..d606a43 100644 --- a/arm/util/__init__.py +++ b/arm/util/__init__.py @@ -6,7 +6,6 @@ and safely working with curses (hiding some of the gory details). __all__ = ["connections", "panel", "sysTools", "text_input", "tor_config", "tor_tools", "tracker", "ui_tools"] -import getpass import os import stem @@ -29,57 +28,15 @@ def tor_controller(): return TOR_CONTROLLER -def init_controller(args): +def init_controller(controller): """ - Provides a Controller for the endpoint specified in the given arguments. + Sets the Controller used by arm. - :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 + :param Controller controller: control connection to be used by arm """ global TOR_CONTROLLER - TOR_CONTROLLER = _get_controller(args) - return TOR_CONTROLLER - - -def authenticate(controller, password, chroot_path = ''): - """ - Authenticates to the given Controller. - - :param stem.control.Controller controller: controller to be authenticated - :param str password: password to authenticate with, **None** if nothing was - provided - :param str chroot_path: chroot tor resides within - - :raises: **ValueError** if unable to authenticate - """ - - try: - controller.authenticate(password = password, chroot_path = chroot_path) - except stem.connection.IncorrectSocketType: - control_socket = controller.get_socket() - - if isinstance(control_socket, stem.socket.ControlPort): - raise ValueError(msg('connect.wrong_port_type', port = control_socket.get_port())) - else: - raise ValueError(msg('connect.wrong_socket_type')) - except stem.connection.UnrecognizedAuthMethods as exc: - raise ValueError(msg('uncrcognized_auth_type', auth_methods = ', '.join(exc.unknown_auth_methods))) - except stem.connection.IncorrectPassword: - raise ValueError(msg('connect.incorrect_password')) - except stem.connection.MissingPassword: - if password: - raise ValueError(msg('connect.missing_password_bug')) - - password = getpass.getpass(msg('connect.password_prompt') + ' ') - return authenticate(controller, password) - except stem.connection.UnreadableCookieFile as exc: - raise ValueError(msg('connect.unreadable_cookie_file', path = exc.cookie_path, issue = str(exc))) - except stem.connection.AuthenticationFailure as exc: - raise ValueError(msg('connect.general_auth_failure', error = exc)) + TOR_CONTROLLER = controller def msg(message, **attr): @@ -155,29 +112,3 @@ def _log(runlevel, message, **attr): """ stem.util.log.log(runlevel, msg(message, **attr)) - - -def _get_controller(args): - """ - Provides a Controller for the endpoint specified in the given arguments. - """ - - if os.path.exists(args.control_socket): - try: - return stem.control.Controller.from_socket_file(args.control_socket) - except stem.SocketError as exc: - if args.user_provided_socket: - raise ValueError(msg('connect.unable_to_use_socket', path = args.control_socket, error = exc)) - elif args.user_provided_socket: - raise ValueError(msg('connect.socket_doesnt_exist', path = args.control_socket)) - - try: - return stem.control.Controller.from_port(args.control_address, args.control_port) - except stem.SocketError as exc: - if args.user_provided_port: - raise ValueError(msg('connect.unable_to_use_port', address = args.control_address, port = args.control_port, error = exc)) - - if not stem.util.system.is_running('tor'): - raise ValueError(msg('connect.tor_isnt_running')) - else: - raise ValueError(msg('connect.no_control_port')) diff --git a/test/util/authenticate.py b/test/util/authenticate.py deleted file mode 100644 index 9dae10b..0000000 --- a/test/util/authenticate.py +++ /dev/null @@ -1,73 +0,0 @@ -import unittest - -from mock import Mock, patch - -from arm.util import ( - init_controller, - authenticate, -) - -import stem -import stem.connection -import stem.socket - - -class TestAuthenticate(unittest.TestCase): - def test_success(self): - controller = Mock() - - authenticate(controller, None) - controller.authenticate.assert_called_with(password = None, chroot_path = '') - controller.authenticate.reset_mock() - - authenticate(controller, 's3krit!!!', '/my/chroot') - controller.authenticate.assert_called_with(password = 's3krit!!!', chroot_path = '/my/chroot') - - @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 = '') - - 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: - init_controller(authenticate(controller, None)) - self.fail() - except ValueError as 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)) diff --git a/test/util/init_controller.py b/test/util/init_controller.py deleted file mode 100644 index cbbeffa..0000000 --- a/test/util/init_controller.py +++ /dev/null @@ -1,67 +0,0 @@ -import unittest - -from mock import Mock, patch - -from arm.arguments import parse -from arm.util import init_controller - -import stem -import stem.connection -import stem.socket - - -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_init_controller_fails_with([], "Unable to connect to tor. Are you sure it's running?") - - is_running_mock.return_value = True - self._assert_init_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_init_controller_fails_with(['--interface', '80'], "Unable to connect to 127.0.0.1:80: failed") - self._assert_init_controller_fails_with(['--socket', '/tmp/my_socket'], "Unable to connect to '/tmp/my_socket': failed") - - path_exists_mock.return_value = False - self._assert_init_controller_fails_with(['--interface', '80'], "Unable to connect to 127.0.0.1:80: failed") - self._assert_init_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', init_controller(parse([]))) - from_port_mock.assert_called_once_with('127.0.0.1', 9051) - from_port_mock.reset_mock() - - self.assertEqual('success', init_controller(parse(['--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', init_controller(parse([]))) - from_socket_file_mock.assert_called_once_with('/var/run/tor/control') - from_socket_file_mock.reset_mock() - - self.assertEqual('success', init_controller(parse(['--socket', '/tmp/my_socket']))) - from_socket_file_mock.assert_called_once_with('/tmp/my_socket') - - def _assert_init_controller_fails_with(self, args, msg): - try: - init_controller(parse(args)) - self.fail() - except ValueError as exc: - self.assertEqual(msg, str(exc))

1 0

[stem/master] Making connect()'s password prompt opt-in
by atagar＠torproject.org 10 Apr '14

10 Apr '14

commit be37a4f8a7c388970518e1502ef6d6194743a9d1 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Apr 7 09:58:02 2014 -0700 Making connect()'s password prompt opt-in Making use of stdin opt-in allows the connect() function to be used more safely in quick and dirty scripts. Users can then allow a password prompt if waiting on stdin is safe. --- stem/connection.py | 30 ++++++++++++++++++++---------- test/unit/connection/connect.py | 8 ++++---- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/stem/connection.py b/stem/connection.py index 35524d7..c49ff85 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -186,6 +186,7 @@ CONNECT_MESSAGES = { 'incorrect_password': "Incorrect password", 'no_control_port': "Unable to connect to tor. Maybe it's running without a ControlPort?", 'password_prompt': "Tor controller password:", + 'needs_password': "Tor requires a password to authenticate", 'socket_doesnt_exist': "The socket file you specified ({path}) doesn't exist", 'tor_isnt_running': "Unable to connect to tor. Are you sure it's running?", 'unable_to_use_port': "Unable to connect to {address}:{port}: {error}", @@ -198,7 +199,7 @@ CONNECT_MESSAGES = { } -def connect(control_port = ('127.0.0.1', 9051), control_socket = '/var/run/tor/control', password = None, chroot_path = None, controller = stem.control.Controller): +def connect(control_port = ('127.0.0.1', 9051), control_socket = '/var/run/tor/control', password = None, password_prompt = False, chroot_path = None, controller = stem.control.Controller): """ Convenience function for quickly getting a control connection. This is very handy for debugging or CLI setup, handling setup and prompting for a password @@ -216,6 +217,8 @@ def connect(control_port = ('127.0.0.1', 9051), control_socket = '/var/run/tor/c :param tuple contol_port: address and port tuple, for instance **('127.0.0.1', 9051)** :param str path: path where the control socket is located :param str password: passphrase to authenticate to the socket + :param bool password_prompt: prompt for the controller password if it wasn't + supplied :param str chroot_path: path prefix if in a chroot environment :param Class controller: :class:`~stem.control.BaseController` subclass to be returned, this provides a :class:`~stem.socket.ControlSocket` if **None** @@ -271,7 +274,7 @@ def connect(control_port = ('127.0.0.1', 9051), control_socket = '/var/run/tor/c print error_msg return None - return _connect_auth(control_connection, password, chroot_path, controller) + return _connect_auth(control_connection, password, password_prompt, chroot_path, controller) def connect_port(address = "127.0.0.1", port = 9051, password = None, chroot_path = None, controller = stem.control.Controller): @@ -300,7 +303,7 @@ def connect_port(address = "127.0.0.1", port = 9051, password = None, chroot_pat print exc return None - return _connect_auth(control_port, password, chroot_path, controller) + return _connect_auth(control_port, password, True, chroot_path, controller) def connect_socket_file(path = "/var/run/tor/control", password = None, chroot_path = None, controller = stem.control.Controller): @@ -330,16 +333,18 @@ def connect_socket_file(path = "/var/run/tor/control", password = None, chroot_p print exc return None - return _connect_auth(control_socket, password, chroot_path, controller) + return _connect_auth(control_socket, password, True, chroot_path, controller) -def _connect_auth(control_socket, password, chroot_path, controller): +def _connect_auth(control_socket, password, password_prompt, chroot_path, controller): """ Helper for the connect_* functions that authenticates the socket and constructs the controller. :param stem.socket.ControlSocket control_socket: socket being authenticated to :param str password: passphrase to authenticate to the socket + :param bool password_prompt: prompt for the controller password if it wasn't + supplied :param str chroot_path: path prefix if in a chroot environment :param Class controller: :class:`~stem.control.BaseController` subclass to be returned, this provides a :class:`~stem.socket.ControlSocket` if **None** @@ -375,13 +380,18 @@ def _connect_auth(control_socket, password, chroot_path, controller): control_socket.close() raise ValueError(CONNECT_MESSAGES['missing_password_bug']) - try: - password = getpass.getpass(CONNECT_MESSAGES['password_prompt'] + ' ') - except KeyboardInterrupt: + if password_prompt: + try: + password = getpass.getpass(CONNECT_MESSAGES['password_prompt'] + ' ') + except KeyboardInterrupt: + control_socket.close() + return None + + return _connect_auth(control_socket, password, password_prompt, chroot_path, controller) + else: + print CONNECT_MESSAGES['needs_password'] control_socket.close() return None - - return _connect_auth(control_socket, password, chroot_path, controller) except UnreadableCookieFile as exc: print CONNECT_MESSAGES['unreadable_cookie_file'].format(path = exc.cookie_path, issue = str(exc)) control_socket.close() diff --git a/test/unit/connection/connect.py b/test/unit/connection/connect.py index 52039f2..9265a5a 100644 --- a/test/unit/connection/connect.py +++ b/test/unit/connection/connect.py @@ -77,11 +77,11 @@ class TestConnect(unittest.TestCase): def test_auth_success(self, authenticate_mock): control_socket = Mock() - stem.connection._connect_auth(control_socket, None, None, None) + stem.connection._connect_auth(control_socket, None, False, None, None) authenticate_mock.assert_called_with(control_socket, None, None) authenticate_mock.reset_mock() - stem.connection._connect_auth(control_socket, 's3krit!!!', '/my/chroot', None) + stem.connection._connect_auth(control_socket, 's3krit!!!', False, '/my/chroot', None) authenticate_mock.assert_called_with(control_socket, 's3krit!!!', '/my/chroot') @patch('getpass.getpass') @@ -100,7 +100,7 @@ class TestConnect(unittest.TestCase): authenticate_mock.side_effect = authenticate_mock_func getpass_mock.return_value = 'my_password' - stem.connection._connect_auth(control_socket, None, None, None) + stem.connection._connect_auth(control_socket, None, True, None, None) authenticate_mock.assert_any_call(control_socket, None, None) authenticate_mock.assert_any_call(control_socket, 'my_password', None) @@ -129,7 +129,7 @@ class TestConnect(unittest.TestCase): self._assert_authenticate_fails_with(control_socket, stdout_mock, 'Unable to authenticate: crazy failure') def _assert_authenticate_fails_with(self, control_socket, stdout_mock, msg): - result = stem.connection._connect_auth(control_socket, None, None, None) + result = stem.connection._connect_auth(control_socket, None, False, None, None) if result is not None: self.fail() # _connect_auth() was successful

1 0

[stem/master] Unit tests for the connect() function
by atagar＠torproject.org 10 Apr '14

10 Apr '14

commit 0efd180327c96a75d25744374e72bf11b5a5b586 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Apr 5 21:07:51 2014 -0700 Unit tests for the connect() function One really neat thing about stealing arm's code is that I'd actually written a lot of good unit tests, so we can now move those to stem! Our connect* methods previously only had integ coverage, so this is a really nice improvement. This also uncovered a few bugs from porting the function. --- stem/connection.py | 52 +++++++++++++-- test/settings.cfg | 1 + test/unit/connection/connect.py | 141 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 188 insertions(+), 6 deletions(-) diff --git a/stem/connection.py b/stem/connection.py index 1304357..35524d7 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -147,6 +147,40 @@ AuthMethod = stem.util.enum.Enum("NONE", "PASSWORD", "COOKIE", "SAFECOOKIE", "UN CLIENT_HASH_CONSTANT = b"Tor safe cookie authentication controller-to-server hash" SERVER_HASH_CONSTANT = b"Tor safe cookie authentication server-to-controller hash" +MISSING_PASSWORD_BUG_MSG = """ +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 +""" + +UNRECOGNIZED_AUTH_TYPE_MSG = """ +Tor is using a type of authentication we do not recognize... + + {auth_methods} + +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! +""" + + +UNREADABLE_COOKIE_FILE_MSG = """ +We were unable to read tor's authentication cookie... + + Path: {path} + Issue: {issue} +""" + +WRONG_PORT_TYPE_MSG = """ +Please check in your torrc that {port} is the ControlPort. Maybe you +configured it to be the ORPort or SocksPort instead? +""" + +WRONG_SOCKET_TYPE_MSG = """ +Unable to connect to tor. Are you sure the interface you specified belongs to +tor? +""" + CONNECT_MESSAGES = { 'general_auth_failure': "Unable to authenticate: {error}", 'incorrect_password': "Incorrect password", @@ -156,6 +190,11 @@ CONNECT_MESSAGES = { 'tor_isnt_running': "Unable to connect to tor. Are you sure it's running?", 'unable_to_use_port': "Unable to connect to {address}:{port}: {error}", 'unable_to_use_socket': "Unable to connect to '{path}': {error}", + 'missing_password_bug': MISSING_PASSWORD_BUG_MSG.strip(), + 'uncrcognized_auth_type': UNRECOGNIZED_AUTH_TYPE_MSG.strip(), + 'unreadable_cookie_file': UNREADABLE_COOKIE_FILE_MSG.strip(), + 'wrong_port_type': WRONG_PORT_TYPE_MSG.strip(), + 'wrong_socket_type': WRONG_SOCKET_TYPE_MSG.strip(), } @@ -232,7 +271,7 @@ def connect(control_port = ('127.0.0.1', 9051), control_socket = '/var/run/tor/c print error_msg return None - return _connect(control_connection, password, chroot_path, controller) + return _connect_auth(control_connection, password, chroot_path, controller) def connect_port(address = "127.0.0.1", port = 9051, password = None, chroot_path = None, controller = stem.control.Controller): @@ -261,7 +300,7 @@ def connect_port(address = "127.0.0.1", port = 9051, password = None, chroot_pat print exc return None - return _connect(control_port, password, chroot_path, controller) + return _connect_auth(control_port, password, chroot_path, controller) def connect_socket_file(path = "/var/run/tor/control", password = None, chroot_path = None, controller = stem.control.Controller): @@ -291,12 +330,13 @@ def connect_socket_file(path = "/var/run/tor/control", password = None, chroot_p print exc return None - return _connect(control_socket, password, chroot_path, controller) + return _connect_auth(control_socket, password, chroot_path, controller) -def _connect(control_socket, password, chroot_path, controller): +def _connect_auth(control_socket, password, chroot_path, controller): """ - Common implementation for the connect_* functions. + Helper for the connect_* functions that authenticates the socket and + constructs the controller. :param stem.socket.ControlSocket control_socket: socket being authenticated to :param str password: passphrase to authenticate to the socket @@ -341,7 +381,7 @@ def _connect(control_socket, password, chroot_path, controller): control_socket.close() return None - return _connect(control_socket, password, chroot_path, controller) + return _connect_auth(control_socket, password, chroot_path, controller) except UnreadableCookieFile as exc: print CONNECT_MESSAGES['unreadable_cookie_file'].format(path = exc.cookie_path, issue = str(exc)) control_socket.close() diff --git a/test/settings.cfg b/test/settings.cfg index f12311d..f0eb758 100644 --- a/test/settings.cfg +++ b/test/settings.cfg @@ -181,6 +181,7 @@ test.unit_tests |test.unit.response.protocolinfo.TestProtocolInfoResponse |test.unit.response.mapaddress.TestMapAddressResponse |test.unit.connection.authentication.TestAuthenticate +|test.unit.connection.connect.TestConnect |test.unit.control.controller.TestControl |test.unit.doctest.TestDocumentation diff --git a/test/unit/connection/connect.py b/test/unit/connection/connect.py new file mode 100644 index 0000000..52039f2 --- /dev/null +++ b/test/unit/connection/connect.py @@ -0,0 +1,141 @@ +""" +Unit tests for the stem.connection.connect function. +""" + +import StringIO +import unittest + +from mock import Mock, patch + +import stem +import stem.connection +import stem.socket + + +class TestConnect(unittest.TestCase): + @patch('sys.stdout', new_callable = StringIO.StringIO) + @patch('stem.util.system.is_running') + @patch('os.path.exists', Mock(return_value = True)) + @patch('stem.socket.ControlSocketFile', Mock(side_effect = stem.SocketError('failed'))) + @patch('stem.socket.ControlPort', Mock(side_effect = stem.SocketError('failed'))) + @patch('stem.connection._connect_auth', Mock()) + def test_failue_with_the_default_endpoint(self, is_running_mock, stdout_mock): + is_running_mock.return_value = False + self._assert_connect_fails_with({}, stdout_mock, "Unable to connect to tor. Are you sure it's running?") + + is_running_mock.return_value = True + self._assert_connect_fails_with({}, stdout_mock, "Unable to connect to tor. Maybe it's running without a ControlPort?") + + @patch('sys.stdout', new_callable = StringIO.StringIO) + @patch('os.path.exists') + @patch('stem.util.system.is_running', Mock(return_value = True)) + @patch('stem.socket.ControlSocketFile', Mock(side_effect = stem.SocketError('failed'))) + @patch('stem.socket.ControlPort', Mock(side_effect = stem.SocketError('failed'))) + @patch('stem.connection._connect_auth', Mock()) + def test_failure_with_a_custom_endpoint(self, path_exists_mock, stdout_mock): + path_exists_mock.return_value = True + self._assert_connect_fails_with({'control_port': ('127.0.0.1', 80), 'control_socket': None}, stdout_mock, "Unable to connect to 127.0.0.1:80: failed") + self._assert_connect_fails_with({'control_port': None, 'control_socket': '/tmp/my_socket'}, stdout_mock, "Unable to connect to '/tmp/my_socket': failed") + + path_exists_mock.return_value = False + self._assert_connect_fails_with({'control_port': ('127.0.0.1', 80), 'control_socket': None}, stdout_mock, "Unable to connect to 127.0.0.1:80: failed") + self._assert_connect_fails_with({'control_port': None, 'control_socket': '/tmp/my_socket'}, stdout_mock, "The socket file you specified (/tmp/my_socket) doesn't exist") + + @patch('stem.socket.ControlPort') + @patch('os.path.exists', Mock(return_value = False)) + @patch('stem.connection._connect_auth', Mock()) + def test_getting_a_control_port(self, port_mock): + stem.connection.connect() + port_mock.assert_called_once_with('127.0.0.1', 9051) + port_mock.reset_mock() + + stem.connection.connect(control_port = ('255.0.0.10', 80), control_socket = None) + port_mock.assert_called_once_with('255.0.0.10', 80) + + @patch('stem.socket.ControlSocketFile') + @patch('os.path.exists', Mock(return_value = True)) + @patch('stem.connection._connect_auth', Mock()) + def test_getting_a_control_socket(self, socket_mock): + stem.connection.connect() + socket_mock.assert_called_once_with('/var/run/tor/control') + socket_mock.reset_mock() + + stem.connection.connect(control_port = None, control_socket = '/tmp/my_socket') + socket_mock.assert_called_once_with('/tmp/my_socket') + + def _assert_connect_fails_with(self, args, stdout_mock, msg): + result = stem.connection.connect(**args) + + if result is not None: + self.fail() + + stdout_output = stdout_mock.getvalue() + stdout_mock.truncate(0) + self.assertEqual(msg, stdout_output.strip()) + + @patch('stem.connection.authenticate') + def test_auth_success(self, authenticate_mock): + control_socket = Mock() + + stem.connection._connect_auth(control_socket, None, None, None) + authenticate_mock.assert_called_with(control_socket, None, None) + authenticate_mock.reset_mock() + + stem.connection._connect_auth(control_socket, 's3krit!!!', '/my/chroot', None) + authenticate_mock.assert_called_with(control_socket, 's3krit!!!', '/my/chroot') + + @patch('getpass.getpass') + @patch('stem.connection.authenticate') + def test_auth_success_with_password_prompt(self, authenticate_mock, getpass_mock): + control_socket = Mock() + + def authenticate_mock_func(controller, password, *args): + 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) + + authenticate_mock.side_effect = authenticate_mock_func + getpass_mock.return_value = 'my_password' + + stem.connection._connect_auth(control_socket, None, None, None) + authenticate_mock.assert_any_call(control_socket, None, None) + authenticate_mock.assert_any_call(control_socket, 'my_password', None) + + @patch('sys.stdout', new_callable = StringIO.StringIO) + @patch('stem.connection.authenticate') + def test_auth_failure(self, authenticate_mock, stdout_mock): + control_socket = stem.socket.ControlPort(connect = False) + + authenticate_mock.side_effect = stem.connection.IncorrectSocketType('unable to connect to socket') + self._assert_authenticate_fails_with(control_socket, stdout_mock, 'Please check in your torrc that 9051 is the ControlPort.') + + control_socket = stem.socket.ControlSocketFile(connect = False) + + self._assert_authenticate_fails_with(control_socket, stdout_mock, 'Are you sure the interface you specified belongs to') + + authenticate_mock.side_effect = stem.connection.UnrecognizedAuthMethods('unable to connect', ['telepathy']) + self._assert_authenticate_fails_with(control_socket, stdout_mock, 'Tor is using a type of authentication we do not recognize...\n\n telepathy') + + authenticate_mock.side_effect = stem.connection.IncorrectPassword('password rejected') + self._assert_authenticate_fails_with(control_socket, stdout_mock, 'Incorrect password') + + authenticate_mock.side_effect = stem.connection.UnreadableCookieFile('permission denied', '/tmp/my_cookie', False) + self._assert_authenticate_fails_with(control_socket, stdout_mock, "We were unable to read tor's authentication cookie...\n\n Path: /tmp/my_cookie\n Issue: permission denied") + + authenticate_mock.side_effect = stem.connection.OpenAuthRejected('crazy failure') + self._assert_authenticate_fails_with(control_socket, stdout_mock, 'Unable to authenticate: crazy failure') + + def _assert_authenticate_fails_with(self, control_socket, stdout_mock, msg): + result = stem.connection._connect_auth(control_socket, None, None, None) + + if result is not None: + self.fail() # _connect_auth() was successful + + stdout_output = stdout_mock.getvalue() + stdout_mock.truncate(0) + + if not msg in stdout_output: + self.fail("Expected...\n\n%s\n\n... which couldn't be found in...\n\n%s" % (msg, stdout_output))

1 0

[stem/master] Better connect() function for easily getting a Controller
by atagar＠torproject.org 10 Apr '14

10 Apr '14

commit 69433bdacc27d3db968b8fc414f1ee598ad54013 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Apr 5 15:48:48 2014 -0700 Better connect() function for easily getting a Controller Stem provided a couple high level functions for getting a Controller with minimal fuss: connect_port() and connect_socket_file(). These interacted directly with stdin and stdout making them undesirable for sophisticated use cases, but for commandline scripts provided a one-line method of geting an authenticated Controller. Personally I never used these myself. Not because I didn't need this, but because I had done better in arm. In arm's connection helper it... * Provided better, more useful error output upon authentication failure. * Attempted to connect to both a control port and socket, then was smart about the message it presented if both failed. On reflection the first belongs in Stem (hell, why not provide better error output?!?). As for the second I realized that having separate control_port() and control_sockeet_file() functions was a mistake. This deprecates the old connect_* functions in favor of a single new connect() that does essentially exactly what we do in arm: try to get a tor connection, and give nice advice if we can't. --- docs/change_log.rst | 1 + docs/faq.rst | 7 +- stem/connection.py | 141 ++++++++++++++++++++++++++++++++++---- stem/socket.py | 2 +- test/integ/connection/connect.py | 19 +++++ 5 files changed, 153 insertions(+), 17 deletions(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index a02750c..624f730 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -50,6 +50,7 @@ The following are only available within Stem's `git repository * Added `support for TB_EMPTY events <api/response.html#stem.response.events.TokenBucketEmptyEvent>`_ (:spec:`6f2919a`) * Added `support for HS_DESC events <api/response.html#stem.response.events.HSDescEvent>`_ (:spec:`a67ac4d`, :trac:`10807`) * Changed :func:`~stem.control.Controller.get_network_status` and :func:`~stem.control.Controller.get_network_statuses` to provide :class:`~stem.descriptor.router_status_entry.RouterStatusEntryMicroV3` if Tor is using microdescriptors (:trac:`7646`) + * Deprecated :func:`~stem.connection.connect_port` and :func:`~stem.connection.connect_socket_file` in favor of a new, better :func:`~stem.connection.connect` function * **Utilities** diff --git a/docs/faq.rst b/docs/faq.rst index 51aa527..a30601e 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -273,12 +273,11 @@ Once you have Tor running and `properly configured <tutorials/the_little_relay_t #. `Connection Module <api/connection.html>`_ - Writing a commandline script? Then the :func:`~stem.connection.connect_port` - and :func:`~stem.connection.connect_socket_file` functions provide you the - quickest and most hassle free method for getting a + Writing a commandline script? Then the :func:`~stem.connection.connect` + function provide you the quickest and most hassle free method for getting a :class:`~stem.control.Controller`. - These functions connect and authenticate to the given port or socket, + This function connects and authenticates to the given port or socket, providing you a one-line method of getting a :class:`~stem.control.Controller` that's ready to use. If Tor requires a password then the user will be prompted for it. When the connection cannot diff --git a/stem/connection.py b/stem/connection.py index 769f432..1304357 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -4,8 +4,7 @@ """ Functions for connecting and authenticating to the tor process. -The :func:`~stem.connection.connect_port` and -:func:`~stem.connection.connect_socket_file` functions give an easy, one line +The :func:`~stem.connection.connect` function give an easy, one line method for getting an authenticated control connection. This is handy for CLI applications and the python interactive interpreter, but does several things that makes it undesirable for applications (uses stdin/stdout, suppresses @@ -13,12 +12,12 @@ exceptions, etc). :: - import sys + import sys - from stem.connection import connect_port + from stem.connection import connect if __name__ == '__main__': - controller = connect_port() + controller = connect() if not controller: sys.exit(1) # unable to get a connection @@ -28,14 +27,14 @@ exceptions, etc). :: - % python example.py + % python example.py Tor is running version 0.2.4.10-alpha-dev (git-8be6058d8f31e578) ... or if Tor isn't running... :: - % python example.py + % python example.py [Errno 111] Connection refused The :func:`~stem.connection.authenticate` function, however, gives easy but @@ -76,8 +75,7 @@ fine-grained control over the authentication process. For instance... :: - connect_port - Convenience method to get an authenticated control connection - connect_socket_file - Similar to connect_port, but for control socket files + connect - Simple method for getting authenticated control connection authenticate - Main method for authenticating to a control socket authenticate_none - Authenticates to an open control socket @@ -149,6 +147,93 @@ AuthMethod = stem.util.enum.Enum("NONE", "PASSWORD", "COOKIE", "SAFECOOKIE", "UN CLIENT_HASH_CONSTANT = b"Tor safe cookie authentication controller-to-server hash" SERVER_HASH_CONSTANT = b"Tor safe cookie authentication server-to-controller hash" +CONNECT_MESSAGES = { + 'general_auth_failure': "Unable to authenticate: {error}", + 'incorrect_password': "Incorrect password", + 'no_control_port': "Unable to connect to tor. Maybe it's running without a ControlPort?", + 'password_prompt': "Tor controller password:", + 'socket_doesnt_exist': "The socket file you specified ({path}) doesn't exist", + 'tor_isnt_running': "Unable to connect to tor. Are you sure it's running?", + 'unable_to_use_port': "Unable to connect to {address}:{port}: {error}", + 'unable_to_use_socket': "Unable to connect to '{path}': {error}", +} + + +def connect(control_port = ('127.0.0.1', 9051), control_socket = '/var/run/tor/control', password = None, chroot_path = None, controller = stem.control.Controller): + """ + Convenience function for quickly getting a control connection. This is very + handy for debugging or CLI setup, handling setup and prompting for a password + if necessary (and none is provided). If any issues arise this prints a + description of the problem and returns **None**. + + If both a **control_port** and **control_socket** are provided then the + **control_socket** is tried first, and this provides a generic error message + if they're both unavailable. + + In much the same vein as git porcelain commands, users should not rely on + details of how this works. Messages and details of this function's behavior + could change in the future. + + :param tuple contol_port: address and port tuple, for instance **('127.0.0.1', 9051)** + :param str path: path where the control socket is located + :param str password: passphrase to authenticate to the socket + :param str chroot_path: path prefix if in a chroot environment + :param Class controller: :class:`~stem.control.BaseController` subclass to be + returned, this provides a :class:`~stem.socket.ControlSocket` if **None** + + :returns: authenticated control connection, the type based on the controller argument + + :raises: **ValueError** if given an invalid control_port, or both + **control_port** and **control_socket** are **None** + """ + + if control_port is None and control_socket is None: + raise ValueError("Neither a control port nor control socket were provided. Nothing to connect to.") + elif control_port: + if len(control_port) != 2: + raise ValueError("The control_port argument for connect() should be an (address, port) tuple.") + elif not stem.util.connection.is_valid_ipv4_address(control_port[0]): + raise ValueError("'%s' isn't a vaid IPv4 address" % control_port[0]) + elif not stem.util.connection.is_valid_port(control_port[1]): + raise ValueError("'%s' isn't a valid port" % control_port[1]) + + control_connection, error_msg = None, '' + + if control_socket: + if os.path.exists(control_socket): + try: + control_connection = stem.socket.ControlSocketFile(control_socket) + except stem.SocketError as exc: + error_msg = CONNECT_MESSAGES['unable_to_use_socket'].format(path = control_socket, error = exc) + else: + error_msg = CONNECT_MESSAGES['socket_doesnt_exist'].format(path = control_socket) + + if control_port and not control_connection: + address, port = control_port + + try: + control_connection = stem.socket.ControlPort(address, port) + except stem.SocketError as exc: + error_msg = CONNECT_MESSAGES['unable_to_use_port'].format(address = address, port = port, error = exc) + + # If unable to connect to either a control socket or port then finally fail + # out. If we only attempted to connect to one of them then provide the error + # output from that. Otherwise we provide a more generic error message. + # + # We check for a 'tor.real' process name because that's what TBB uses. + + if not control_connection: + if control_socket and control_port: + if not stem.util.system.is_running('tor') and not stem.util.system.is_running('tor.real'): + error_msg = CONNECT_MESSAGES['tor_isnt_running'] + else: + error_msg = CONNECT_MESSAGES['no_control_port'] + + print error_msg + return None + + return _connect(control_connection, password, chroot_path, controller) + def connect_port(address = "127.0.0.1", port = 9051, password = None, chroot_path = None, controller = stem.control.Controller): """ @@ -157,6 +242,9 @@ def connect_port(address = "127.0.0.1", port = 9051, password = None, chroot_pat if necessary (and none is provided). If any issues arise this prints a description of the problem and returns **None**. + .. deprecated:: 1.2.0 + Use :func:`~stem.connection.connect` instead. + :param str address: ip address of the controller :param int port: port number of the controller :param str password: passphrase to authenticate to the socket @@ -181,6 +269,13 @@ def connect_socket_file(path = "/var/run/tor/control", password = None, chroot_p Convenience function for quickly getting a control connection. For more information see the :func:`~stem.connection.connect_port` function. + In much the same vein as git porcelain commands, users should not rely on + details of how this works. Messages or details of this function's behavior + might change in the future. + + .. deprecated:: 1.2.0 + Use :func:`~stem.connection.connect` instead. + :param str path: path where the control socket is located :param str password: passphrase to authenticate to the socket :param str chroot_path: path prefix if in a chroot environment @@ -219,19 +314,41 @@ def _connect(control_socket, password, chroot_path, controller): return control_socket else: return controller(control_socket) + except IncorrectSocketType: + if isinstance(control_socket, stem.socket.ControlPort): + print CONNECT_MESSAGES['wrong_port_type'].format(port = control_socket.get_port()) + else: + print CONNECT_MESSAGES['wrong_socket_type'] + + control_socket.close() + return None + except UnrecognizedAuthMethods as exc: + print CONNECT_MESSAGES['uncrcognized_auth_type'].format(auth_methods = ', '.join(exc.unknown_auth_methods)) + control_socket.close() + return None + except IncorrectPassword: + print CONNECT_MESSAGES['incorrect_password'] + control_socket.close() + return None except MissingPassword: if password is not None: - raise ValueError("BUG: authenticate raised MissingPassword despite getting one") + control_socket.close() + raise ValueError(CONNECT_MESSAGES['missing_password_bug']) try: - password = getpass.getpass("Controller password: ") + password = getpass.getpass(CONNECT_MESSAGES['password_prompt'] + ' ') except KeyboardInterrupt: + control_socket.close() return None return _connect(control_socket, password, chroot_path, controller) + except UnreadableCookieFile as exc: + print CONNECT_MESSAGES['unreadable_cookie_file'].format(path = exc.cookie_path, issue = str(exc)) + control_socket.close() + return None except AuthenticationFailure as exc: + print CONNECT_MESSAGES['general_auth_failure'].format(error = exc) control_socket.close() - print "Unable to authenticate: %s" % exc return None diff --git a/stem/socket.py b/stem/socket.py index cb74f21..6a452c7 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -36,7 +36,7 @@ Tor... :: - % python example.py + % python example.py Issuing 'GETINFO version' query... version=0.2.4.10-alpha-dev (git-8be6058d8f31e578) diff --git a/test/integ/connection/connect.py b/test/integ/connection/connect.py index 994b777..4361c0f 100644 --- a/test/integ/connection/connect.py +++ b/test/integ/connection/connect.py @@ -19,6 +19,25 @@ class TestConnect(unittest.TestCase): def tearDown(self): sys.stdout = self.original_stdout + def test_connect(self): + """ + Basic sanity checks for the connect function. + """ + + if test.runner.require_control(self): + return + + runner = test.runner.get_runner() + + control_socket = stem.connection.connect( + control_port = ('127.0.0.1', test.runner.CONTROL_PORT), + control_socket = test.runner.CONTROL_SOCKET_PATH, + password = test.runner.CONTROL_PASSWORD, + chroot_path = runner.get_chroot(), + controller = None) + + test.runner.exercise_controller(self, control_socket) + def test_connect_port(self): """ Basic sanity checks for the connect_port function.

1 0

[stem/master] General site revisions
by atagar＠torproject.org 10 Apr '14

10 Apr '14

commit 872b1e1647cb0dc31699045b0f2b90511a3fd07e Merge: d70fa9c eee3a99 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Mar 30 20:38:32 2014 -0700 General site revisions Lots of revisions to our site, most notably around our FAQ and examples section... * Adding scripts section with neat examples that have come up in the past. * Greatly improved the readability of our FAQ by making entries more concise. * Application entry for Exit Map, and added munin-tor and exit-funding below. * Torrc syntax highlighting. docs/_static/buttons/back.png | Bin 0 -> 2774 bytes docs/_static/buttons/resources/back.xcf | Bin 0 -> 5648 bytes docs/_static/exit_map.png | Bin 0 -> 12371 bytes docs/_static/label/exit_map.png | Bin 0 -> 1540 bytes docs/_static/label/resources/exit_map.xcf | Bin 0 -> 3284 bytes docs/_static/resources/exit_map_alt.png | Bin 0 -> 12747 bytes docs/contents.rst | 5 + docs/faq.rst | 416 ++++++++------------- docs/tutorials/double_double_toil_and_trouble.rst | 48 ++- docs/tutorials/examples/compare_flags.rst | 63 ++++ docs/tutorials/examples/exit_used.rst | 76 ++++ docs/tutorials/examples/list_circuits.rst | 52 +++ docs/tutorials/examples/outdated_relays.rst | 45 +++ docs/tutorials/mirror_mirror_on_the_wall.rst | 59 +-- docs/tutorials/the_little_relay_that_could.rst | 2 +- docs/tutorials/to_russia_with_love.rst | 74 +--- docs/tutorials/tortoise_and_the_hare.rst | 3 +- stem/connection.py | 27 ++ stem/control.py | 64 +++- stem/response/events.py | 39 +- stem/socket.py | 42 ++- 21 files changed, 649 insertions(+), 366 deletions(-)

1 0