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

[tor/master] Emits CONF_CHANGED events whenever Tor's configuration values change.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 5a801a8c8b71c9551a80913398135809cb10cecd Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Mon Aug 8 04:38:53 2011 +0500 Emits CONF_CHANGED events whenever Tor's configuration values change. --- src/or/config.c | 35 ++++++++++++++++++++++++++++++++++- src/or/control.c | 17 ++++++++++++++++- src/or/control.h | 1 + 3 files changed, 51 insertions(+), 2 deletions(-) diff --git a/src/or/config.c b/src/or/config.c index 088617b..653e23d 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -10,6 +10,7 @@ **/ #define CONFIG_PRIVATE +#define CONTROL_PRIVATE #include "or.h" #include "circuitbuild.h" @@ -693,6 +694,10 @@ get_options(void) int set_options(or_options_t *new_val, char **msg) { + int i; + char *result; + smartlist_t *elements; + config_line_t *line; or_options_t *old_options = global_options; global_options = new_val; /* Note that we pass the *old* options below, for comparison. It @@ -707,7 +712,35 @@ set_options(or_options_t *new_val, char **msg) "Acting on config options left us in a broken state. Dying."); exit(1); } - + /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is + * just starting up then the old_options will be undefined. */ + if (old_options) { + elements = smartlist_create(); + for (i=0; options_format.vars[i].name; ++i) { + if (!option_is_same(&options_format, new_val, old_options, + options_format.vars[i].name)) { + line = get_assigned_option(&options_format, new_val, + options_format.vars[i].name, 0); + + if (line) { + for (; line; line = line->next) { + char *tmp; + tor_asprintf(&tmp, "650-%s=%s", line->key, line->value); + smartlist_add(elements, tmp); + } + } else { + char *tmp; + tor_asprintf(&tmp, "650-%s", options_format.vars[i].name); + smartlist_add(elements, tmp); + } + } + } + result = smartlist_join_strings(elements, "\r\n", 0, NULL); + control_event_conf_changed(result); + tor_free(result); + SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp)); + smartlist_free(elements); + } config_free(&options_format, old_options); return 0; diff --git a/src/or/control.c b/src/or/control.c index ad11350..0b19a25 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -74,7 +74,8 @@ #define EVENT_NEWCONSENSUS 0x0016 #define EVENT_BUILDTIMEOUT_SET 0x0017 #define EVENT_SIGNAL 0x0018 -#define _EVENT_MAX 0x0018 +#define EVENT_CONF_CHANGED 0x0019 +#define _EVENT_MAX 0x0019 /* If _EVENT_MAX ever hits 0x0020, we need to make the mask wider. */ /** Bitfield: The bit 1<<e is set if any open control @@ -946,6 +947,7 @@ static const struct control_event_t control_event_table[] = { { EVENT_NEWCONSENSUS, "NEWCONSENSUS" }, { EVENT_BUILDTIMEOUT_SET, "BUILDTIMEOUT_SET" }, { EVENT_SIGNAL, "SIGNAL" }, + { EVENT_CONF_CHANGED, "CONF_CHANGED"}, { 0, NULL }, }; @@ -3996,6 +3998,19 @@ control_event_guard(const char *nickname, const char *digest, return 0; } +/** Called when a configuration option changes. This is generally triggered + * by SETCONF requests and RELOAD/SIGHUP signals. The values are the + * keyword/value pairs for the configuration changes tor is using. */ +int +control_event_conf_changed(const char *values) +{ + if(strlen(values) > 0) { + send_control_event(EVENT_CONF_CHANGED, 0, + "650-CONF_CHANGED\r\n%s\r\n650 OK\r\n", values); + } + return 0; +} + /** Helper: Return a newly allocated string containing a path to the * file where we store our authentication cookie. */ static char * diff --git a/src/or/control.h b/src/or/control.h index 147a5af..ed83f53 100644 --- a/src/or/control.h +++ b/src/or/control.h @@ -66,6 +66,7 @@ int control_event_server_status(int severity, const char *format, ...) CHECK_PRINTF(2,3); int control_event_guard(const char *nickname, const char *digest, const char *status); +int control_event_conf_changed(const char *values); int control_event_buildtimeout_set(const circuit_build_times_t *cbt, buildtimeout_set_event_t type); int control_event_signal(uintptr_t signal);

1 0

[tor/master] Add changes file.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 3b85fe8a5dd0fed88163ffc3bcb4eec8bf2053bc Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Tue Aug 9 03:02:40 2011 +0500 Add changes file. --- changes/bug1692 | 5 +++++ 1 files changed, 5 insertions(+), 0 deletions(-) diff --git a/changes/bug1692 b/changes/bug1692 new file mode 100644 index 0000000..c2a71cc --- /dev/null +++ b/changes/bug1692 @@ -0,0 +1,5 @@ + o Minor features: + - CONF_CHANGED event is provided so that controllers can be notified + of any configuration changes made by other controllers/SETCONF/HUP. + Implements #1692. +

1 0

[tor/master] Refactor to do CONF_CHANGED event formatting inside control.c
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 02c62b2966083ce549fc6ba6c743d5c37f357fe6 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Mon Aug 8 19:19:06 2011 +0500 Refactor to do CONF_CHANGED event formatting inside control.c --- src/or/config.c | 17 +++++------------ src/or/control.c | 30 ++++++++++++++++++++++++++---- src/or/control.h | 2 +- 3 files changed, 32 insertions(+), 17 deletions(-) diff --git a/src/or/config.c b/src/or/config.c index 653e23d..02dc7eb 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -10,7 +10,6 @@ **/ #define CONFIG_PRIVATE -#define CONTROL_PRIVATE #include "or.h" #include "circuitbuild.h" @@ -695,7 +694,6 @@ int set_options(or_options_t *new_val, char **msg) { int i; - char *result; smartlist_t *elements; config_line_t *line; or_options_t *old_options = global_options; @@ -724,21 +722,16 @@ set_options(or_options_t *new_val, char **msg) if (line) { for (; line; line = line->next) { - char *tmp; - tor_asprintf(&tmp, "650-%s=%s", line->key, line->value); - smartlist_add(elements, tmp); + smartlist_add(elements, line->key); + smartlist_add(elements, line->value); } } else { - char *tmp; - tor_asprintf(&tmp, "650-%s", options_format.vars[i].name); - smartlist_add(elements, tmp); + smartlist_add(elements, options_format.vars[i].name); + smartlist_add(elements, NULL); } } } - result = smartlist_join_strings(elements, "\r\n", 0, NULL); - control_event_conf_changed(result); - tor_free(result); - SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp)); + control_event_conf_changed(elements); smartlist_free(elements); } config_free(&options_format, old_options); diff --git a/src/or/control.c b/src/or/control.c index 0b19a25..0579703 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -4002,12 +4002,34 @@ control_event_guard(const char *nickname, const char *digest, * by SETCONF requests and RELOAD/SIGHUP signals. The values are the * keyword/value pairs for the configuration changes tor is using. */ int -control_event_conf_changed(const char *values) +control_event_conf_changed(smartlist_t *elements) { - if(strlen(values) > 0) { - send_control_event(EVENT_CONF_CHANGED, 0, - "650-CONF_CHANGED\r\n%s\r\n650 OK\r\n", values); + int i; + char *result; + smartlist_t *lines; + if (smartlist_len(elements) == 0) { + return 0; } + lines = smartlist_create(); + for (i = 0; i < smartlist_len(elements); i += 2) { + char *k = smartlist_get(elements, i); + char *v = smartlist_get(elements, i+1); + if (v == NULL) { + char *tmp; + tor_asprintf(&tmp, "650-%s", k); + smartlist_add(lines, tmp); + } else { + char *tmp; + tor_asprintf(&tmp, "650-%s=%s", k, v); + smartlist_add(lines, tmp); + } + } + result = smartlist_join_strings(lines, "\r\n", 0, NULL); + send_control_event(EVENT_CONF_CHANGED, 0, + "650-CONF_CHANGED\r\n%s\r\n650 OK\r\n", result); + tor_free(result); + SMARTLIST_FOREACH(lines, char *, cp, tor_free(cp)); + smartlist_free(lines); return 0; } diff --git a/src/or/control.h b/src/or/control.h index ed83f53..544a9fc 100644 --- a/src/or/control.h +++ b/src/or/control.h @@ -66,7 +66,7 @@ int control_event_server_status(int severity, const char *format, ...) CHECK_PRINTF(2,3); int control_event_guard(const char *nickname, const char *digest, const char *status); -int control_event_conf_changed(const char *values); +int control_event_conf_changed(smartlist_t *elements); int control_event_buildtimeout_set(const circuit_build_times_t *cbt, buildtimeout_set_event_t type); int control_event_signal(uintptr_t signal);

1 0

[tor/master] Minor comment fix.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 23ef12462adab98d5d63bc9579892dbc6f1dea6f Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Mon Aug 8 19:58:43 2011 +0500 Minor comment fix. --- src/or/control.c | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/or/control.c b/src/or/control.c index 0579703..f679493 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -3999,8 +3999,9 @@ control_event_guard(const char *nickname, const char *digest, } /** Called when a configuration option changes. This is generally triggered - * by SETCONF requests and RELOAD/SIGHUP signals. The values are the - * keyword/value pairs for the configuration changes tor is using. */ + * by SETCONF requests and RELOAD/SIGHUP signals. The elements is + * a smartlist_t containing (key, value, ...) pairs in sequence. + * value can be NULL. */ int control_event_conf_changed(smartlist_t *elements) {

1 0

[tor/master] Minor code readability fix.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 5f624805e71d3f160ed7de28b17ecad892827758 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Tue Aug 9 03:17:21 2011 +0500 Minor code readability fix. --- src/or/control.c | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/or/control.c b/src/or/control.c index f679493..3943aff 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -4015,15 +4015,13 @@ control_event_conf_changed(smartlist_t *elements) for (i = 0; i < smartlist_len(elements); i += 2) { char *k = smartlist_get(elements, i); char *v = smartlist_get(elements, i+1); + char *tmp; if (v == NULL) { - char *tmp; tor_asprintf(&tmp, "650-%s", k); - smartlist_add(lines, tmp); } else { - char *tmp; tor_asprintf(&tmp, "650-%s=%s", k, v); - smartlist_add(lines, tmp); } + smartlist_add(lines, tmp); } result = smartlist_join_strings(lines, "\r\n", 0, NULL); send_control_event(EVENT_CONF_CHANGED, 0,

1 0

[tor/master] Use smartlist_asprintf_add() to improve readability.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 86f68ed6953620e14c7f9894e01ab2eafea250e7 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Tue Aug 9 15:18:57 2011 +0500 Use smartlist_asprintf_add() to improve readability. --- src/or/control.c | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/or/control.c b/src/or/control.c index 3943aff..706d871 100644 --- a/src/or/control.c +++ b/src/or/control.c @@ -4015,13 +4015,11 @@ control_event_conf_changed(smartlist_t *elements) for (i = 0; i < smartlist_len(elements); i += 2) { char *k = smartlist_get(elements, i); char *v = smartlist_get(elements, i+1); - char *tmp; if (v == NULL) { - tor_asprintf(&tmp, "650-%s", k); + smartlist_asprintf_add(lines, "650-%s", k); } else { - tor_asprintf(&tmp, "650-%s=%s", k, v); + smartlist_asprintf_add(lines, "650-%s=%s", k, v); } - smartlist_add(lines, tmp); } result = smartlist_join_strings(lines, "\r\n", 0, NULL); send_control_event(EVENT_CONF_CHANGED, 0,

1 0

[tor/master] Add smartlist_[v]asprintf_add
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit e42a74e56351a41c0a68999ed5fce48ab03166d7 Author: Robert Ransom <rransom.8774(a)gmail.com> Date: Wed Aug 3 15:49:39 2011 -0700 Add smartlist_[v]asprintf_add I should have added this before implementing #2411. --- src/common/util.c | 24 ++++++++++++++++++++++++ src/common/util.h | 5 +++++ 2 files changed, 29 insertions(+), 0 deletions(-) diff --git a/src/common/util.c b/src/common/util.c index 601f2be..1e5e454 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -2679,6 +2679,30 @@ tor_sscanf(const char *buf, const char *pattern, ...) return r; } +/** Append the string produced by tor_asprintf(pattern, ...) + * to sl. */ +void +smartlist_asprintf_add(struct smartlist_t *sl, const char *pattern, ...) +{ + va_list ap; + va_start(ap, pattern); + smartlist_vasprintf_add(sl, pattern, ap); + va_end(ap); +} + +/** va_list-based backend of smartlist_asprintf_add. */ +void +smartlist_vasprintf_add(struct smartlist_t *sl, const char *pattern, + va_list args) +{ + char *str = NULL; + + tor_vasprintf(&str, pattern, args); + tor_assert(str != NULL); + + smartlist_add(sl, str); +} + /** Return a new list containing the filenames in the directory dirname. * Return NULL on error or if dirname is not a directory. */ diff --git a/src/common/util.h b/src/common/util.h index 9935587..a1def6c 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -220,6 +220,11 @@ int tor_sscanf(const char *buf, const char *pattern, ...) #endif ; +void smartlist_asprintf_add(struct smartlist_t *sl, const char *pattern, ...) + CHECK_PRINTF(2, 3); +void smartlist_vasprintf_add(struct smartlist_t *sl, const char *pattern, + va_list args); + int hex_decode_digit(char c); void base16_encode(char *dest, size_t destlen, const char *src, size_t srclen); int base16_decode(char *dest, size_t destlen, const char *src, size_t srclen);

1 0

[torspec/master] Clarify control port authentication.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 043051b79f929b39d77eb1520b4fc65a721e85ae Author: Mike Perry <mikeperry-git(a)fscked.org> Date: Wed Aug 10 09:58:42 2011 -0700 Clarify control port authentication. Encoded hex strings are useful, but the previous revision conflated them with how the tor implementations stores them on disk. --- control-spec.txt | 10 +++++++--- 1 files changed, 7 insertions(+), 3 deletions(-) diff --git a/control-spec.txt b/control-spec.txt index 160adf4..4aba1fa 100644 --- a/control-spec.txt +++ b/control-spec.txt @@ -293,14 +293,18 @@ 3.5. AUTHENTICATE Sent from the client to the server. The syntax is: - "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF + "AUTHENTICATE" [ SP N*HEXDIG / QuotedString ] CRLF The server responds with "250 OK" on success or "515 Bad authentication" if the authentication cookie is incorrect. Tor closes the connection on an authentication failure. - The format of the 'cookie' is implementation-dependent; see 5.1 below for - information on how the standard Tor implementation handles it. + The authentication token can be specified as either a quoted ASCII string, + or as an unquoted hexadecimal encoding of that same string (to avoid escaping + issues). + + For information on how the implementation securely stores authentication + information on disk, see section 5.1. Before the client has authenticated, no command other than PROTOCOLINFO, AUTHENTICATE, or QUIT is valid. If the controller sends any other command,

1 0

[torspec/master] DIAF RFC2234.
by nickm＠torproject.org 10 Aug '11

10 Aug '11

commit 7b8a7fbf9bf19c69c2e02feee5153fcf0c9622c8 Author: Mike Perry <mikeperry-git(a)fscked.org> Date: Wed Aug 10 10:07:25 2011 -0700 DIAF RFC2234. You suck at life and nobody will ever understand you. --- control-spec.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/control-spec.txt b/control-spec.txt index 4aba1fa..e4b259a 100644 --- a/control-spec.txt +++ b/control-spec.txt @@ -293,7 +293,7 @@ 3.5. AUTHENTICATE Sent from the client to the server. The syntax is: - "AUTHENTICATE" [ SP N*HEXDIG / QuotedString ] CRLF + "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF The server responds with "250 OK" on success or "515 Bad authentication" if the authentication cookie is incorrect. Tor closes the connection on an

1 0

[arm/master] Adding tor control socket support
by atagar＠torproject.org 10 Aug '11

10 Aug '11

commit cca2aae001bab0e6bb09e81a4e9df11bec2bc2bb Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 10 09:55:13 2011 -0700 Adding tor control socket support This adds support for connecting via a tor control socket. Connection behavior is as follows... - if an argument or armrc option for the control port or socket path are provided then just use that connection method - if neither or both args are provided then the default behavior is... - try connecting to the control socket (defaulting to /var/lib/tor/control) - try connecting to the control ports (defaulting to 9051 and 9052) - fall back to starting arm without a tor instance and show setup wizard Control socket support is a feature request by Dererk on... https://trac.torproject.org/projects/tor/ticket/3638 --- armrc.sample | 5 ++- src/cli/headerPanel.py | 55 +++++++++++++++++--------- src/starter.py | 100 +++++++++++++++++++++++++++++++++++------------- src/util/torTools.py | 22 ++++++++++ 4 files changed, 135 insertions(+), 47 deletions(-) diff --git a/armrc.sample b/armrc.sample index d547b6c..22fb903 100644 --- a/armrc.sample +++ b/armrc.sample @@ -2,6 +2,7 @@ startup.controlPassword startup.interface.ipAddress 127.0.0.1 startup.interface.port 9051 +startup.interface.socket /var/lib/tor/control startup.blindModeEnabled false startup.events N3 startup.dataDirectory ~/.arm @@ -66,7 +67,9 @@ features.refreshRate 5 features.confirmQuit true # Allows arm to start when there's no running tor instance if true, otherwise -# we terminate right away. +# we terminate right away. This is ignored if the user provides an option +# specifying how to connect to tor (ie, a 'startup.interface.*' option or +# startup argument). features.allowDetachedStartup true # Paremters for the log panel diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index 4e78f6c..d5ce332 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -21,6 +21,7 @@ import threading import TorCtl.TorCtl +import starter import cli.popups import cli.controller @@ -40,6 +41,7 @@ VERSION_STATUS_COLORS = {"new": "blue", "new in series": "blue", "obsolete": "re DEFAULT_CONFIG = {"startup.interface.ipAddress": "127.0.0.1", "startup.interface.port": 9051, + "startup.interface.socket": "/var/lib/tor/control", "features.showFdUsage": False, "log.fdUsageSixtyPercent": log.NOTICE, "log.fdUsageNinetyPercent": log.WARN} @@ -132,27 +134,42 @@ class HeaderPanel(panel.Panel, threading.Thread): if key in (ord('n'), ord('N')) and torTools.getConn().isNewnymAvailable(): self.sendNewnym() elif key in (ord('r'), ord('R')) and not self._isTorConnected: - try: - ctlAddr, ctlPort = self._config["startup.interface.ipAddress"], self._config["startup.interface.port"] - tmpConn, authType, authValue = TorCtl.TorCtl.preauth_connect(ctlAddr, ctlPort) - - if authType == TorCtl.TorCtl.AUTH_TYPE.PASSWORD: - authValue = cli.popups.inputPrompt("Controller Password: ") - if not authValue: raise IOError() # cancel reconnection - - tmpConn.authenticate(authValue) - torTools.getConn().init(tmpConn) + torctlConn = None + allowPortConnection, allowSocketConnection, _ = starter.allowConnectionTypes() + + if os.path.exists(self._config["startup.interface.socket"]) and allowSocketConnection: + try: torctlConn = torTools.connect_socket(self._config["startup.interface.socket"]) + except IOError, exc: + if not allowPortConnection: + cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) + elif not allowPortConnection: + cli.popups.showMsg("Unable to reconnect (socket '%s' doesn't exist)" % self._config["startup.interface.socket"], 3) + + if not torctlConn and allowPortConnection: + try: + ctlAddr, ctlPort = self._config["startup.interface.ipAddress"], self._config["startup.interface.port"] + tmpConn, authType, authValue = TorCtl.TorCtl.preauth_connect(ctlAddr, ctlPort) + + if authType == TorCtl.TorCtl.AUTH_TYPE.PASSWORD: + authValue = cli.popups.inputPrompt("Controller Password: ") + if not authValue: raise IOError() # cancel reconnection + + tmpConn.authenticate(authValue) + torctlConn = tmpConn + except Exception, exc: + # attempts to use the wizard port too + try: + cli.controller.getController().getTorManager().connectManagedInstance() + log.log(log.NOTICE, "Reconnected to Tor's control port") + cli.popups.showMsg("Tor reconnected", 1) + except: + # displays notice for the first failed connection attempt + if exc.args: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) + + if torctlConn: + torTools.getConn().init(torctlConn) log.log(log.NOTICE, "Reconnected to Tor's control port") cli.popups.showMsg("Tor reconnected", 1) - except Exception, exc: - # attempts to use the wizard port too - try: - cli.controller.getController().getTorManager().connectManagedInstance() - log.log(log.NOTICE, "Reconnected to Tor's control port") - cli.popups.showMsg("Tor reconnected", 1) - except: - # displays notice for the first failed connection attempt - if exc.args: cli.popups.showMsg("Unable to reconnect (%s)" % exc, 3) else: isKeystrokeConsumed = False return isKeystrokeConsumed diff --git a/src/starter.py b/src/starter.py index 01acf24..a148947 100644 --- a/src/starter.py +++ b/src/starter.py @@ -35,6 +35,7 @@ DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") CONFIG = {"startup.controlPassword": None, "startup.interface.ipAddress": "127.0.0.1", "startup.interface.port": 9051, + "startup.interface.socket": "/var/lib/tor/control", "startup.blindModeEnabled": False, "startup.events": "N3", "startup.dataDirectory": "~/.arm", @@ -52,14 +53,16 @@ CONFIG = {"startup.controlPassword": None, "log.configDescriptions.persistance.saveFailed": util.log.NOTICE, "log.savingDebugLog": util.log.NOTICE} -OPT = "gi:c:dbe:vh" -OPT_EXPANDED = ["gui", "interface=", "config=", "debug", "blind", "event=", "version", "help"] +OPT = "gi:s:c:dbe:vh" +OPT_EXPANDED = ["gui", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] HELP_MSG = """Usage arm [OPTION] Terminal status monitor for Tor relays. -g, --gui launch the Gtk+ interface -i, --interface [ADDRESS:]PORT change control interface from %s:%i + -s, --socket SOCKET_PATH attach using unix domain socket if present, + SOCKET_PATH defaults to: %s -c, --config CONFIG_PATH loaded configuration options, CONFIG_PATH defaults to: %s -d, --debug writes all arm logs to %s @@ -72,7 +75,7 @@ Terminal status monitor for Tor relays. Example: 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 -""" % (CONFIG["startup.interface.ipAddress"], CONFIG["startup.interface.port"], DEFAULT_CONFIG, LOG_DUMP_PATH, CONFIG["startup.events"], cli.logPanel.EVENT_LISTING) +""" % (CONFIG["startup.interface.ipAddress"], CONFIG["startup.interface.port"], CONFIG["startup.interface.socket"], DEFAULT_CONFIG, LOG_DUMP_PATH, CONFIG["startup.events"], cli.logPanel.EVENT_LISTING) # filename used for cached tor config descriptions CONFIG_DESC_FILENAME = "torConfigDesc.txt" @@ -94,6 +97,29 @@ STANDARD_CFG_NOT_FOUND_MSG = "No configuration found at '%s', using defaults" # torrc entries that are scrubbed when dumping PRIVATE_TORRC_ENTRIES = ["HashedControlPassword", "Bridge", "HiddenServiceDir"] +def allowConnectionTypes(): + """ + This provides a tuple with booleans indicating if we should or shouldn't + attempt to connect by various methods... + (allowPortConnection, allowSocketConnection, allowDetachedStart) + """ + + confKeys = util.conf.getConfig("arm").getKeys() + + isPortArgPresent = "startup.interface.ipAddress" in confKeys or "startup.interface.port" in confKeys + isSocketArgPresent = "startup.interface.socket" in confKeys + + skipPortConnection = isSocketArgPresent and not isPortArgPresent + skipSocketConnection = isPortArgPresent and not isSocketArgPresent + + # Flag to indicate if we'll start arm reguardless of being unable to connect + # to Tor. This is the default behavior if the user hasn't provided a port or + # socket to connect to, so we can show the relay setup wizard. + + allowDetachedStart = CONFIG["features.allowDetachedStartup"] and not isPortArgPresent and not isSocketArgPresent + + return (not skipPortConnection, not skipSocketConnection, allowDetachedStart) + def _loadConfigurationDescriptions(pathPrefix): """ Attempts to load descriptions for tor's configuration options, fetching them @@ -168,7 +194,7 @@ def _loadConfigurationDescriptions(pathPrefix): msg = DESC_INTERNAL_LOAD_FAILED_MSG % util.sysTools.getFileErrorMsg(exc) util.log.log(CONFIG["log.configDescriptions.internalLoadFailed"], msg) -def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, incorrectPasswordMsg=""): +def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, incorrectPasswordMsg="", printError=True): """ Custom handler for establishing a TorCtl connection. """ @@ -222,7 +248,7 @@ def _torCtlConnect(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i # again prompting for the user to enter it print incorrectPasswordMsg return _torCtlConnect(controlAddr, controlPort) - elif not CONFIG["features.allowDetachedStartup"]: + elif printError: print exc return None @@ -300,6 +326,8 @@ if __name__ == '__main__': param["startup.interface.ipAddress"] = controlAddr param["startup.interface.port"] = controlPort + elif opt in ("-s", "--socket"): + param["startup.interface.socket"] = arg elif opt in ("-g", "--gui"): launchGui = True elif opt in ("-c", "--config"): configPath = arg # sets path of user's config elif opt in ("-d", "--debug"): isDebugMode = True # dumps all logs @@ -361,7 +389,7 @@ if __name__ == '__main__': for utilModule in (util.conf, util.connections, util.hostnames, util.log, util.panel, util.procTools, util.sysTools, util.torConfig, util.torTools, util.uiTools): utilModule.loadConfig(config) - # snycs config and parameters, saving changed config options and overwriting + # syncs config and parameters, saving changed config options and overwriting # undefined parameters with defaults for key in param.keys(): if param[key] == None: param[key] = CONFIG[key] @@ -389,28 +417,46 @@ if __name__ == '__main__': # temporarily disables TorCtl logging to prevent issues from going to stdout while starting TorCtl.TorUtil.loglevel = "NONE" - # sets up TorCtl connection, prompting for the passphrase if necessary and - # sending problems to stdout if they arise - authPassword = config.get("startup.controlPassword", CONFIG["startup.controlPassword"]) - incorrectPasswordMsg = "Password found in '%s' was incorrect" % configPath - conn = _torCtlConnect(controlAddr, controlPort, authPassword, incorrectPasswordMsg) - if conn == None and not CONFIG["features.allowDetachedStartup"]: sys.exit(1) - - # 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.rawContents)): - if config.rawContents[i].strip().startswith("startup.controlPassword"): - pwLineNum = i - break + # By default attempts to connect using the control socket if it exists. This + # skips attempting to connect by socket or port if the user has given + # arguments for connecting to the other. + + conn = None + allowPortConnection, allowSocketConnection, allowDetachedStart = allowConnectionTypes() + + socketPath = param["startup.interface.socket"] + if os.path.exists(socketPath) and allowSocketConnection: + try: conn = util.torTools.connect_socket(socketPath) + except IOError, exc: + if not allowPortConnection: + print "Unable to use socket '%s': %s" % (socketPath, exc) + elif not allowPortConnection: + print "Socket '%s' doesn't exist" % socketPath + + if not conn and allowPortConnection: + # sets up TorCtl connection, prompting for the passphrase if necessary and + # sending problems to stdout if they arise + authPassword = config.get("startup.controlPassword", CONFIG["startup.controlPassword"]) + incorrectPasswordMsg = "Password found in '%s' was incorrect" % configPath + conn = _torCtlConnect(controlAddr, controlPort, authPassword, incorrectPasswordMsg, not allowDetachedStart) - if pwLineNum != None: - del config.rawContents[i] + # 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.rawContents)): + if config.rawContents[i].strip().startswith("startup.controlPassword"): + pwLineNum = i + break + + if pwLineNum != None: + del config.rawContents[i] + + if conn == None and not allowDetachedStart: sys.exit(1) # initializing the connection may require user input (for the password) # skewing the startup time results so this isn't counted diff --git a/src/util/torTools.py b/src/util/torTools.py index f81e10a..366deb0 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -111,6 +111,28 @@ IS_STARTUP_SIGNAL = True def loadConfig(config): config.update(CONFIG) +# TODO: temporary code until this is added to torctl as part of... +# https://trac.torproject.org/projects/tor/ticket/3638 +def connect_socket(socketPath="/var/lib/tor/control", ConnClass=TorCtl.Connection): + """ + Connects to a unix domain socket available to controllers (set via tor's + ControlSocket option). This raises an IOError if unable to do so. + + Arguments: + socketPath - path of the socket to attach to + ConnClass - connection type to instantiate + """ + + import socket + try: + s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) + s.connect(socketPath) + conn = ConnClass(s) + conn.authenticate("") + return conn + except Exception, exc: + raise IOError(exc) + def getPid(controlPort=9051, pidFilePath=None): """ Attempts to determine the process id for a running tor process, using the

1 0