- tor-commits - lists.torproject.org

[arm/release] fix: correcting some port types and descriptions
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 17fa269873a561b7ba8f843c3030373014277b3a Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jul 1 15:57:20 2011 -0700 fix: correcting some port types and descriptions Secure mail ports were misclassified, and descriptions for the mail and web policies were missing ports. --- src/settings.cfg | 10 ++++++---- 1 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/settings.cfg b/src/settings.cfg index 076299d..7f2953f 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -435,8 +435,8 @@ wizard.description.opt Portforward => If needed, attempts NAT traversal using UP wizard.description.opt Startup => Runs Tor in the background when the system starts. wizard.description.opt Notice => Provides a disclaimer that this is an exit on port 80 (http://www.atagar.com/exitNotice) wizard.description.opt Policy => Ports allowed to exit from your relay. The default policy allows for common services while limiting the chance of getting a DMCA takedown for torrent traffic (http://www.atagar.com/exitPolicy) -wizard.description.opt Websites => General Internet browsing including HTTP (80) and HTTPS (443). -wizard.description.opt Email => Protocols for receiving, but not sending email. This includes POP3 (110), POP3S (995), IMAP (143), and IMAPS (993). +wizard.description.opt Websites => General Internet browsing including HTTP (80), HTTPS (443), common alternatives (81, 8008), and proxies (3128, 8080) +wizard.description.opt Email => Protocols for receiving, but not sending email. This includes POP3 (110), POP3S (995), IMAP (143, 220), and IMAPS (993). wizard.description.opt Im => Common instant messaging protocols including Jabber, IRC, ICQ, AIM, Yahoo, MSN, SILC, GroupWise, Gadu-Gadu, Sametime, and Zephyr. wizard.description.opt Misc => Protocols from the default policy that aren't among the above. wizard.description.opt Plaintext => When blocked the policy will exclude ports that aren't commonly encrypted. @@ -836,9 +836,9 @@ port.exit.misc 981 # SofaWare Firewall Administration port.exit.misc 989-990 # FTPS port.exit.misc 991 # NAS port.exit.misc 992 # Telnet -port.exit.misc 993 # IMAPS +port.exit.mail 993 # IMAPS port.exit.im 994 # IRC over SSL -port.exit.misc 995 # POP3S +port.exit.mail 995 # POP3S port.exit.misc 1194 # OpenVPN port.exit.misc 1220 # QuickTime port.exit.misc 1293 # PKT-KRB-IPSec @@ -895,6 +895,8 @@ port.encrypted 749 port.encrypted 981 port.encrypted 989 port.encrypted 990 +port.encrypted 993 +port.encrypted 995 port.encrypted 1194 port.encrypted 1293 port.encrypted 1723

1 0

[arm/release] Input field validation for bandwith rates
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 90fba07ce66de9e811aa762b835b769a254c438b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 3 10:39:51 2011 -0700 Input field validation for bandwith rates --- src/cli/wizard.py | 18 +++++++++++++++++- 1 files changed, 17 insertions(+), 1 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 219c6b6..43d107b 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -210,6 +210,7 @@ def showWizard(): else: config[option] = ConfigOption(option, "opt", default) # sets input validators + config[Options.BANDWIDTH].setValidator(_relayRateValidator) config[Options.BRIDGE1].setValidator(_bridgeDestinationValidator) config[Options.BRIDGE2].setValidator(_bridgeDestinationValidator) config[Options.BRIDGE3].setValidator(_bridgeDestinationValidator) @@ -391,7 +392,7 @@ def promptConfigOptions(relayType, config): if newValue: try: options[selection].setValue(newValue.strip()) except ValueError, exc: - cli.popups.showMsg(str(exc), 2) + cli.popups.showMsg(str(exc), 3) cli.controller.getController().requestRedraw(True) elif key == 27: selection, key = -1, curses.KEY_ENTER # esc - cancel finally: @@ -428,6 +429,21 @@ def _toggleEnabledAction(toggleOptions, option, value): for opt in toggleOptions: opt.setEnabled(value) +def _relayRateValidator(option, value): + if value.count(" ") != 1: + msg = "This should be a measurement followed by the rate (for instance, \"5 MB/s\")" + raise ValueError(msg) + + rate, units = value.split(" ", 1) + acceptedUnits = ("KB/s", "MB/s", "GB/s") + if not rate.isdigit(): + raise ValueError("'%s' isn't an integer" % rate) + elif not units in acceptedUnits: + msg = "'%s' is an invalid rate, options include \"%s\"" % (units, "\", \"".join(acceptedUnits)) + raise ValueError(msg) + elif (int(rate) < 20 and units == "KB/s") or int(rate) < 1: + raise ValueError("To be usable as a relay the rate must be at least 20 KB/s") + def _bridgeDestinationValidator(option, value): if value.count(":") != 1: raise ValueError("Bridges are of the form '<ip address>:<port>'")

1 0

[arm/release] Remove gobject timeout.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit ae45817503f817f7d97d41358315b516fc4222b8 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sat Jun 25 15:08:54 2011 +0500 Remove gobject timeout. Gobject timeout works well for graphs but creates issues for selecting log rows. Instead, call fill_log() in constructor of panel and then subsequently on addition of each entry. --- src/gui/logPanel.py | 5 ++--- 1 files changed, 2 insertions(+), 3 deletions(-) diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index 0a00137..6ac6418 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -62,7 +62,7 @@ class LogPanel: conn.addEventListener(TorEventObserver(self.register_event)) conn.addTorCtlListener(self._register_torctl_event) - gobject.timeout_add(1000, self.fill_log) + self.fill_log() def pack_widgets(self): liststore = self.builder.get_object('liststore_log') @@ -79,10 +79,9 @@ class LogPanel: row = (long(entry.timestamp), timeLabel, entry.type, entry.msg, entry.color) liststore.append(row) - return True - def register_event(self, event): self.msgLog.appendleft(event) + self.fill_log() def _register_arm_event(self, level, msg, eventTime): eventColor = RUNLEVEL_EVENT_COLOR[level]

1 0

[arm/release] Use locking for fixing segfaults, different colors from cli.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 6c3a0d15a346e3b4cdcc0c21fcf9d20883d03061 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sun Jun 26 02:24:19 2011 +0500 Use locking for fixing segfaults, different colors from cli. msgLog deque was being updated by events while being pushed into liststore which produced inconsistency and generated segfault. Using different colors from cli in order to be readable. Moved logPanel creation before bandwidthStats in order to let controller events reach bandwidthStats. --- src/gui/controller.py | 6 +++--- src/gui/logPanel.py | 29 +++++++++++++++++++++-------- 2 files changed, 24 insertions(+), 11 deletions(-) diff --git a/src/gui/controller.py b/src/gui/controller.py index 1c173af..5f1712c 100644 --- a/src/gui/controller.py +++ b/src/gui/controller.py @@ -18,12 +18,12 @@ class GuiController: self.builder.add_from_file(filename) self.builder.connect_signals(self) - self.bwStats = bandwidthStats.BandwidthStats(self.builder) - self.bwStats.pack_widgets() - self.logPanel = logPanel.LogPanel(self.builder) self.logPanel.pack_widgets() + self.bwStats = bandwidthStats.BandwidthStats(self.builder) + self.bwStats.pack_widgets() + def run(self): window = self.builder.get_object('window_main') diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index 6ac6418..97a01cc 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -7,6 +7,7 @@ import sys import time from collections import deque +from threading import RLock import gobject import gtk @@ -16,8 +17,10 @@ from util import log, uiTools, torTools from cli.logPanel import (expandEvents, setEventListening, getLogFileEntries, LogEntry, TorEventObserver, - DEFAULT_CONFIG, RUNLEVEL_EVENT_COLOR) + DEFAULT_CONFIG) +RUNLEVEL_EVENT_COLOR = {log.DEBUG: "#C73043", log.INFO: "#762A2A", log.NOTICE: "#222222", + log.WARN: "#AB7814", log.ERR: "#EC131F"} STARTUP_EVENTS = 'N3' class LogPanel: @@ -25,6 +28,7 @@ class LogPanel: self.builder = builder self._config = dict(DEFAULT_CONFIG) + self.lock = RLock() self.msgLog = deque() self.loggedEvents = setEventListening(expandEvents(STARTUP_EVENTS)) @@ -62,7 +66,7 @@ class LogPanel: conn.addEventListener(TorEventObserver(self.register_event)) conn.addTorCtlListener(self._register_torctl_event) - self.fill_log() + gobject.timeout_add(1000, self.fill_log) def pack_widgets(self): liststore = self.builder.get_object('liststore_log') @@ -74,14 +78,23 @@ class LogPanel: liststore = self.builder.get_object('liststore_log') liststore.clear() - for entry in self.msgLog: - timeLabel = time.strftime('%H:%M:%S', time.localtime(entry.timestamp)) - row = (long(entry.timestamp), timeLabel, entry.type, entry.msg, entry.color) - liststore.append(row) + self.lock.acquire() + try: + for entry in self.msgLog: + timeLabel = time.strftime('%H:%M:%S', time.localtime(entry.timestamp)) + row = (long(entry.timestamp), timeLabel, entry.type, entry.msg, entry.color) + liststore.append(row) + finally: + self.lock.release() + + return True def register_event(self, event): - self.msgLog.appendleft(event) - self.fill_log() + self.lock.acquire() + try: + self.msgLog.appendleft(event) + finally: + self.lock.release() def _register_arm_event(self, level, msg, eventTime): eventColor = RUNLEVEL_EVENT_COLOR[level]

1 0

[arm/release] Use idle_add instead of timeout_add for work in gtk main loop.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 224a7d6ac7156815b625b82d7b48daa67173a049 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sun Jun 26 04:02:49 2011 +0500 Use idle_add instead of timeout_add for work in gtk main loop. --- src/gui/logPanel.py | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index 97a01cc..fc8e6b8 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -21,7 +21,7 @@ from cli.logPanel import (expandEvents, setEventListening, getLogFileEntries, RUNLEVEL_EVENT_COLOR = {log.DEBUG: "#C73043", log.INFO: "#762A2A", log.NOTICE: "#222222", log.WARN: "#AB7814", log.ERR: "#EC131F"} -STARTUP_EVENTS = 'N3' +STARTUP_EVENTS = 'A' class LogPanel: def __init__(self, builder): @@ -66,7 +66,7 @@ class LogPanel: conn.addEventListener(TorEventObserver(self.register_event)) conn.addTorCtlListener(self._register_torctl_event) - gobject.timeout_add(1000, self.fill_log) + gobject.idle_add(self.fill_log) def pack_widgets(self): liststore = self.builder.get_object('liststore_log') @@ -95,6 +95,7 @@ class LogPanel: self.msgLog.appendleft(event) finally: self.lock.release() + gobject.idle_add(self.fill_log) def _register_arm_event(self, level, msg, eventTime): eventColor = RUNLEVEL_EVENT_COLOR[level]

1 0

[arm/release] Fix CPU-hogging by limiting liststore update rate.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 872040aa5f084c54417375ac5016158c260a9b86 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sun Jun 26 06:03:40 2011 +0500 Fix CPU-hogging by limiting liststore update rate. --- src/gui/logPanel.py | 8 +++++++- 1 files changed, 7 insertions(+), 1 deletions(-) diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py index fc8e6b8..4e95db4 100644 --- a/src/gui/logPanel.py +++ b/src/gui/logPanel.py @@ -22,12 +22,15 @@ from cli.logPanel import (expandEvents, setEventListening, getLogFileEntries, RUNLEVEL_EVENT_COLOR = {log.DEBUG: "#C73043", log.INFO: "#762A2A", log.NOTICE: "#222222", log.WARN: "#AB7814", log.ERR: "#EC131F"} STARTUP_EVENTS = 'A' +REFRESH_RATE = 3 class LogPanel: def __init__(self, builder): self.builder = builder self._config = dict(DEFAULT_CONFIG) + self._lastUpdate = 0 + self.lock = RLock() self.msgLog = deque() self.loggedEvents = setEventListening(expandEvents(STARTUP_EVENTS)) @@ -75,6 +78,9 @@ class LogPanel: liststore.set_sort_column_id(1, gtk.SORT_DESCENDING) def fill_log(self): + if time.time() - self._lastUpdate < REFRESH_RATE: + return + liststore = self.builder.get_object('liststore_log') liststore.clear() @@ -87,7 +93,7 @@ class LogPanel: finally: self.lock.release() - return True + self._lastUpdate = time.time() def register_event(self, event): self.lock.acquire()

1 0

[arm/release] For consistency, plot bw graph even if all values are zeros.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit a110aeb39e0ec129b24ab138b08742490e55212e Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sun Jun 26 06:10:42 2011 +0500 For consistency, plot bw graph even if all values are zeros. --- src/gui/graphing/graphStats.py | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-) diff --git a/src/gui/graphing/graphStats.py b/src/gui/graphing/graphStats.py index fcd326f..0d9ac5f 100644 --- a/src/gui/graphing/graphStats.py +++ b/src/gui/graphing/graphStats.py @@ -90,10 +90,8 @@ class GraphStats(TorCtl.PostEventListener): graph = self.graphs[name] data = self.get_graph_data(name) - if self.is_graph_data_zero(name): - graph.seriess[0].data = [] - else: - graph.seriess[0].data = data + graph.seriess[0].data = data + if not self.is_graph_data_zero(name): for (index, axis) in enumerate(graph.axiss): if axis.type != 'xaxis':

1 0

[arm/release] Expanding config screen to allow arbitrary options
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 83d1e367a003ec84b54527d470dde01901da6961 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jun 26 14:04:35 2011 -0700 Expanding config screen to allow arbitrary options Preping the configuration screen of the wizard to allow for other sets of options for different relay types. --- src/cli/wizard.py | 64 +++++++++++++++++++++++++++++++++++----------------- 1 files changed, 43 insertions(+), 21 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index a3404b9..dadea16 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -14,12 +14,20 @@ from util import enum, uiTools RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") # all options that can be configured -Options = enum.Enum("NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "STARTUP") -RelayOptions = (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, Options.BANDWIDTH, Options.LIMIT, Options.STARTUP) +Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "STARTUP") +RelayOptions = {RelayType.RELAY: (Options.NICKNAME, + Options.CONTACT, + Options.NOTIFY, + Options.BANDWIDTH, + Options.DIVIDER, + Options.DIVIDER, + Options.LIMIT, + Options.STARTUP)} # other options provided in the prompts CANCEL, NEXT, BACK = "Cancel", "Next", "Back" +DESC_SIZE = 5 # height of the description field MSG_COLOR = "green" OPTION_COLOR = "yellow" @@ -97,6 +105,10 @@ def showWizard(): relayType, config = None, {} for option in Options.values(): + if option == Options.DIVIDER: + config[option] = option + continue + toggleValues = CONFIG["wizard.toggle"].get(option) default = CONFIG["wizard.default"].get(option, "") @@ -116,13 +128,10 @@ def showWizard(): if selection == CANCEL: break else: relayType = selection else: - if relayType == RelayType.RELAY: - selection = promptRelayOptions(config) - - if selection == BACK: relayType = None - elif selection == NEXT: break # TODO: implement next screen - else: - break # TODO: other catagories not yet implemented + selection = promptConfigOptions(relayType, config) + + if selection == BACK: relayType = None + elif selection == NEXT: break # TODO: implement next screen # redraws screen to clear away the dialog we just showed cli.controller.getController().requestRedraw(True) @@ -134,7 +143,7 @@ def promptRelayType(): dialog was canceled. """ - popup, _, _ = cli.popups.init(24, 58) + popup, _, _ = cli.popups.init(25, 58) if not popup: return control = cli.controller.getController() key, selection = 0, 0 @@ -181,17 +190,25 @@ def promptRelayType(): finally: cli.popups.finalize() -def promptRelayOptions(config): +def promptConfigOptions(relayType, config): """ Prompts the user for the configuration of an internal relay. """ - popup, _, _ = cli.popups.init(23, 58) - if not popup: return - control = cli.controller.getController() - options = [config[opt] for opt in RelayOptions] + # TODO: skipping section if it isn't ready yet + if not relayType in RelayOptions: return NEXT + + topContent = _splitStr(CONFIG.get("wizard.message.%s" % relayType.lower(), ""), 54) + + options = [config[opt] for opt in RelayOptions[relayType]] + options.append(Options.DIVIDER) options.append(ConfigOption(BACK, "general", "(to role selection)")) options.append(ConfigOption(NEXT, "general", "(to confirm options)")) + + popupHeight = len(topContent) + len(options) + DESC_SIZE + 5 + popup, _, _ = cli.popups.init(popupHeight, 58) + if not popup: return + control = cli.controller.getController() key, selection = 0, 0 try: @@ -202,21 +219,21 @@ def promptRelayOptions(config): popup.win.box() # provides the description for internal relays - topContent = _splitStr(CONFIG["wizard.message.relay"], 54) for i in range(len(topContent)): popup.addstr(i + 1, 2, topContent[i], curses.A_BOLD | uiTools.getColor(MSG_COLOR)) y, offset = len(topContent) + 1, 0 for i in range(len(options)): + if options[i] == Options.DIVIDER: + offset += 1 + continue + label = " %-30s%s" % (options[i].getLabel(), options[i].getDisplayValue()) optionFormat = curses.A_BOLD | uiTools.getColor(OPTION_COLOR) if i == selection: optionFormat |= curses.A_STANDOUT offset += 1 popup.addstr(y + offset, 2, uiTools.padStr(label, 54), optionFormat) - - # extra space to divide options/navigation - if i == len(options) - 3: offset += 1 # divider between the options and description offset += 2 @@ -232,8 +249,13 @@ def promptRelayOptions(config): popup.win.refresh() key = control.getScreen().getch() - if key == curses.KEY_UP: selection = (selection - 1) % len(options) - elif key == curses.KEY_DOWN: selection = (selection + 1) % len(options) + if key in (curses.KEY_UP, curses.KEY_DOWN): + posOffset = -1 if key == curses.KEY_UP else 1 + selection = (selection + posOffset) % len(options) + + # skips dividers + while options[selection] == Options.DIVIDER: + selection = (selection + posOffset) % len(options) elif uiTools.isSelectionKey(key): if selection == len(options) - 2: return BACK # selected back elif selection == len(options) - 1: return NEXT # selected next

1 0

[arm/release] Wizard config for setting up an exit
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit e8c3836e203a3e359a9b5b9a289dc73ddc3da92c Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jun 27 08:54:07 2011 -0700 Wizard config for setting up an exit This expands the wizard to provide a config panel for setting up an exit relay. This has the same options as an internal relay plus several for DirPortFrontPage and ExitPolicy. By default this will use the reduced exit policy [1], with options like Vidalia for selecting groups of services to allow. However, unlike Vidalia it won't allow the operator to pick plaintext ports without also having their encryped counterparts. [1] https://trac.torproject.org/projects/tor/wiki/doc/ReducedExitPolicy --- src/cli/wizard.py | 155 ++++++++++++++++++++++++++++++++++++++++++++-------- src/settings.cfg | 37 ++++++++++++- 2 files changed, 167 insertions(+), 25 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index dadea16..0d47de5 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -3,6 +3,7 @@ Provides user prompts for setting up a new relay. This autogenerates a torrc that's used by arm to run its own tor instance. """ +import functools import curses import cli.popups @@ -14,15 +15,30 @@ from util import enum, uiTools RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") # all options that can be configured -Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "STARTUP") +Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT") RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, Options.BANDWIDTH, - Options.DIVIDER, - Options.DIVIDER, Options.LIMIT, - Options.STARTUP)} + Options.STARTUP), + RelayType.EXIT: (Options.NICKNAME, + Options.CONTACT, + Options.NOTIFY, + Options.BANDWIDTH, + Options.LIMIT, + Options.STARTUP, + Options.DIVIDER, + Options.NOTICE, + Options.POLICY, + Options.WEBSITES, + Options.EMAIL, + Options.IM, + Options.MISC, + Options.PLAINTEXT)} + +# custom exit policy options +CUSTOM_POLICIES = (Options.WEBSITES, Options.EMAIL, Options.IM, Options.MISC, Options.PLAINTEXT) # other options provided in the prompts CANCEL, NEXT, BACK = "Cancel", "Next", "Back" @@ -30,10 +46,13 @@ CANCEL, NEXT, BACK = "Cancel", "Next", "Back" DESC_SIZE = 5 # height of the description field MSG_COLOR = "green" OPTION_COLOR = "yellow" +DISABLED_COLOR = "cyan" CONFIG = {"wizard.message.role": "", "wizard.message.relay": "", + "wizard.message.exit": "", "wizard.toggle": {}, + "wizard.suboptions": [], "wizard.default": {}, "wizard.label.general": {}, "wizard.label.role": {}, @@ -65,6 +84,8 @@ class ConfigOption: self.descriptionCache = None self.descriptionCacheArg = None self.value = default + self.validator = None + self._isEnabled = True def getKey(self): return self.key @@ -75,7 +96,39 @@ class ConfigOption: def getDisplayValue(self): return self.value + def getDisplayAttr(self): + myColor = OPTION_COLOR if self.isEnabled() else DISABLED_COLOR + return curses.A_BOLD | uiTools.getColor(myColor) + + def isEnabled(self): + return self._isEnabled + + def setEnabled(self, isEnabled): + self._isEnabled = isEnabled + + def setValidator(self, validator): + """ + Custom function used to check that a value is valid before setting it. + This functor should accept two arguments: this option and the value we're + attempting to set. If its invalid then a ValueError with the reason is + expected. + + Arguments: + validator - functor for checking the validitiy of values we set + """ + + self.validator = validator + def setValue(self, value): + """ + Attempts to set our value. If a validator has been set then we first check + if it's alright, raising a ValueError with the reason if not. + + Arguments: + value - value we're attempting to set + """ + + if self.validator: self.validator(self, value) self.value = value def getLabel(self, prefix = ""): @@ -90,6 +143,10 @@ class ConfigOption: return [prefix + line for line in self.descriptionCache] class ToggleConfigOption(ConfigOption): + """ + Configuration option representing a boolean. + """ + def __init__(self, key, group, default, trueLabel, falseLabel): ConfigOption.__init__(self, key, group, default) self.trueLabel = trueLabel @@ -99,11 +156,20 @@ class ToggleConfigOption(ConfigOption): return self.trueLabel if self.value else self.falseLabel def toggle(self): + # This isn't really here to validate the value (after all this is a + # boolean, the options are limited!), but rather give a method for functors + # to be triggered when selected. + + if self.validator: self.validator(self, not self.value) self.value = not self.value def showWizard(): - relayType, config = None, {} + """ + Provides a series of prompts, allowing the user to spawn a customized tor + instance. + """ + relayType, config = None, {} for option in Options.values(): if option == Options.DIVIDER: config[option] = option @@ -121,12 +187,22 @@ def showWizard(): config[option] = ToggleConfigOption(option, "opt", isSet, trueLabel.strip(), falseLabel.strip()) else: config[option] = ConfigOption(option, "opt", default) + # sets input validators + + # enables custom policies when 'custom' is selected and disables otherwise + policyOpt = config[Options.POLICY] + policyOpt.setValidator(functools.partial(_exitPolicyAction, config)) + _exitPolicyAction(config, policyOpt, policyOpt.getValue()) + + # remembers the last selection made on the type prompt page + relaySelection = RelayType.RELAY + while True: if relayType == None: - selection = promptRelayType() + selection = promptRelayType(relaySelection) if selection == CANCEL: break - else: relayType = selection + else: relayType, relaySelection = selection, selection else: selection = promptConfigOptions(relayType, config) @@ -136,7 +212,7 @@ def showWizard(): # redraws screen to clear away the dialog we just showed cli.controller.getController().requestRedraw(True) -def promptRelayType(): +def promptRelayType(initialSelection): """ Provides a prompt for selecting the general role we'd like Tor to run with. This returns a RelayType enumeration for the selection, or CANCEL if the @@ -146,9 +222,9 @@ def promptRelayType(): popup, _, _ = cli.popups.init(25, 58) if not popup: return control = cli.controller.getController() - key, selection = 0, 0 options = [ConfigOption(opt, "role", opt) for opt in RelayType.values()] options.append(ConfigOption(CANCEL, "general", CANCEL)) + selection = RelayType.indexOf(initialSelection) try: popup.win.box() @@ -162,21 +238,21 @@ def promptRelayType(): while True: y, offset = len(topContent) + 1, 0 - for i in range(len(options)): + for opt in options: optionFormat = uiTools.getColor(MSG_COLOR) - if i == selection: optionFormat |= curses.A_STANDOUT + if opt == options[selection]: optionFormat |= curses.A_STANDOUT # Curses has a weird bug where there's a one-pixel alignment # difference between bold and regular text, so it looks better # to render the whitespace here as not being bold. offset += 1 - label = options[i].getLabel(" ") + label = opt.getLabel(" ") popup.addstr(y + offset, 2, label, optionFormat | curses.A_BOLD) popup.addstr(y + offset, 2 + len(label), " " * (54 - len(label)), optionFormat) offset += 1 - for line in options[i].getDescription(52, " "): + for line in opt.getDescription(52, " "): popup.addstr(y + offset, 2, uiTools.padStr(line, 54), optionFormat) offset += 1 @@ -218,22 +294,42 @@ def promptConfigOptions(relayType, config): popup.win.erase() popup.win.box() - # provides the description for internal relays + # provides the description for the relay type for i in range(len(topContent)): popup.addstr(i + 1, 2, topContent[i], curses.A_BOLD | uiTools.getColor(MSG_COLOR)) y, offset = len(topContent) + 1, 0 - for i in range(len(options)): - if options[i] == Options.DIVIDER: + for opt in options: + if opt == Options.DIVIDER: offset += 1 continue - label = " %-30s%s" % (options[i].getLabel(), options[i].getDisplayValue()) - optionFormat = curses.A_BOLD | uiTools.getColor(OPTION_COLOR) - if i == selection: optionFormat |= curses.A_STANDOUT + optionFormat = opt.getDisplayAttr() + if opt == options[selection]: optionFormat |= curses.A_STANDOUT - offset += 1 - popup.addstr(y + offset, 2, uiTools.padStr(label, 54), optionFormat) + offset, indent = offset + 1, 0 + if opt.getKey() in CONFIG["wizard.suboptions"]: + # If the next entry is also a suboption then show a 'T', otherwise + # end the bracketing. + + bracketChar, nextIndex = curses.ACS_LLCORNER, options.index(opt) + 1 + if nextIndex < len(options) and isinstance(options[nextIndex], ConfigOption): + if options[nextIndex].getKey() in CONFIG["wizard.suboptions"]: + bracketChar = curses.ACS_LTEE + + popup.addch(y + offset, 3, bracketChar, opt.getDisplayAttr()) + popup.addch(y + offset, 4, curses.ACS_HLINE, opt.getDisplayAttr()) + + indent = 3 + + labelFormat = " %%-%is%%s" % (30 - indent) + label = labelFormat % (opt.getLabel(), opt.getDisplayValue()) + popup.addstr(y + offset, 2 + indent, uiTools.padStr(label, 54 - indent), optionFormat) + + # little hack to make "Block" policies red + if opt != options[selection] and not opt.getValue() and opt.getKey() in CUSTOM_POLICIES: + optionFormat = curses.A_BOLD | uiTools.getColor("red") + popup.addstr(y + offset, 33, opt.getDisplayValue(), optionFormat) # divider between the options and description offset += 2 @@ -253,8 +349,8 @@ def promptConfigOptions(relayType, config): posOffset = -1 if key == curses.KEY_UP else 1 selection = (selection + posOffset) % len(options) - # skips dividers - while options[selection] == Options.DIVIDER: + # skips disabled options and dividers + while options[selection] == Options.DIVIDER or not options[selection].isEnabled(): selection = (selection + posOffset) % len(options) elif uiTools.isSelectionKey(key): if selection == len(options) - 2: return BACK # selected back @@ -263,7 +359,9 @@ def promptConfigOptions(relayType, config): options[selection].toggle() else: newValue = popup.getstr(y + selection + 1, 33, options[selection].getValue(), curses.A_STANDOUT | uiTools.getColor(OPTION_COLOR), 23) - if newValue: options[selection].setValue(newValue.strip()) + if newValue: + try: options[selection].setValue(newValue.strip()) + except ValueError, exc: cli.popups.showMsg(str(exc), 3) elif key == 27: selection, key = -1, curses.KEY_ENTER # esc - cancel finally: cli.popups.finalize() @@ -280,7 +378,16 @@ def _splitStr(msg, width): results = [] while msg: msgSegment, msg = uiTools.cropStr(msg, width, None, endType = None, getRemainder = True) + if not msgSegment: break # happens if the width is less than the first word results.append(msgSegment.strip()) return results +def _exitPolicyAction(config, option, value): + """ + Enables or disables custom exit policy options based on our selection. + """ + + for opt in CUSTOM_POLICIES: + config[opt].setEnabled(not value) + diff --git a/src/settings.cfg b/src/settings.cfg index 94ff9c1..135b0e2 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -343,14 +343,35 @@ msg.ARM_DEBUG Unable to query process resource usage from ps # configuration option attributes used in the relay setup wizard wizard.message.role Welcome to the Tor network! This will step you through the configuration process for becoming a part of it. To start with, what role would you like to have? wizard.message.relay Internal relays provide connections within the Tor network. Since you will only be connecting to Tor users and relays this is an easy, hassle free way of helping to make the network better. +wizard.message.exit Exits connect between the Tor network and the outside Internet. This is the most vitally important role you can take, but it also needs some forethought. Please read 'http://www.atagar.com/torExitTips/' before proceeding further to avoid any nasty surprises! wizard.toggle Notify => Yes, No wizard.toggle Startup => Yes, No +wizard.toggle Notice => Yes, No +wizard.toggle Policy => Default, Custom +wizard.toggle Websites => Allow, Block +wizard.toggle Email => Allow, Block +wizard.toggle Im => Allow, Block +wizard.toggle Misc => Allow, Block +wizard.toggle Plaintext => Allow, Block + +wizard.suboptions Websites +wizard.suboptions Email +wizard.suboptions Im +wizard.suboptions Misc +wizard.suboptions Plaintext wizard.default Nickname => Unnamed wizard.default Notify => true wizard.default Bandwidth => 5 MB/s wizard.default Startup => true +wizard.default Notice => true +wizard.default Policy => true +wizard.default Websites => true +wizard.default Email => true +wizard.default Im => true +wizard.default Misc => true +wizard.default Plaintext => true wizard.label.general Cancel => Cancel wizard.label.general Back => Previous @@ -365,10 +386,17 @@ wizard.label.opt Notify => Issue Notification wizard.label.opt Bandwidth => Relay Speed wizard.label.opt Limit => Monthly Limit wizard.label.opt Startup => Run At Startup +wizard.label.opt Notice => Disclaimer Notice +wizard.label.opt Policy => Exit Policy +wizard.label.opt Websites => Web Browsing +wizard.label.opt Email => Receiving Email +wizard.label.opt Im => Instant Messaging +wizard.label.opt Misc => Other Services +wizard.label.opt Plaintext => Unencrypted Traffic wizard.description.general Cancel => Close without starting Tor. wizard.description.role Relay => Provides interconnections with other Tor relays. This is a safe and easy of making the network better. -wizard.description.role Exit => Connects between Tor an the outside Internet. This is a vital role, but can lead to abuse complaints. +wizard.description.role Exit => Connects between Tor network and the outside Internet. This is a vital role, but can lead to abuse complaints. wizard.description.role Bridge => Non-public relay specifically for helping censored users. wizard.description.role Client => Use the network without contributing to it. wizard.description.opt Nickname => Human friendly name for your relay. If this is unique then it's used instead of your fingerprint (a forty character hex string) when pages like TorStatus refer to you. @@ -377,6 +405,13 @@ wizard.description.opt Notify => Sends automated email notifications to the abov wizard.description.opt Bandwidth => Limit for the average rate at which you relay traffic. wizard.description.opt Limit => Maximum amount of traffic to relay each month. Some ISPs, like Comcast, cap their customer's Internet usage so this is an easy way of staying below that limit. wizard.description.opt Startup => Runs Tor in the background when the system starts. +wizard.description.opt Notice => Provides a disclaimer that this is an exit on port 80 (http://www.atagar.com/exitNotice) +wizard.description.opt Policy => Ports allowed to exit from your relay. The default policy allows for common services while limiting the chance of getting a DMCA takedown for torrent traffic (http://www.atagar.com/exitPolicy) +wizard.description.opt Websites => General Internet browsing including HTTP (80) and HTTPS (443). +wizard.description.opt Email => Protocols for receiving, but not sending email. This includes POP3 (110), POP3S (995), IMAP (143), and IMAPS (993). +wizard.description.opt Im => Common instant messaging protocols including Jabber, IRC, ICQ, AIM, Yahoo, MSN, SILC, GroupWise, Gadu-Gadu, Sametime, and Zephyr. +wizard.description.opt Misc => Protocols from the default policy that aren't among the above. +wizard.description.opt Plaintext => When blocked the policy will exclude ports that aren't commonly encrypted. # some config options are fetched via special values torrc.map HiddenServiceDir => HiddenServiceOptions

1 0

[arm/release] Adding option for relaying without SOCKS port
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit fd39b3a97479694ae23b7f37bd9a8e43d13890ec Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jun 27 09:59:12 2011 -0700 Adding option for relaying without SOCKS port --- src/cli/wizard.py | 4 +++- src/settings.cfg | 4 ++++ 2 files changed, 7 insertions(+), 1 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 0d47de5..d2fb067 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -15,18 +15,20 @@ from util import enum, uiTools RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") # all options that can be configured -Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT") +Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "CLIENT", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT") RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, Options.BANDWIDTH, Options.LIMIT, + Options.CLIENT, Options.STARTUP), RelayType.EXIT: (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, Options.BANDWIDTH, Options.LIMIT, + Options.CLIENT, Options.STARTUP, Options.DIVIDER, Options.NOTICE, diff --git a/src/settings.cfg b/src/settings.cfg index 135b0e2..0ab57a2 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -346,6 +346,7 @@ wizard.message.relay Internal relays provide connections within the Tor network. wizard.message.exit Exits connect between the Tor network and the outside Internet. This is the most vitally important role you can take, but it also needs some forethought. Please read 'http://www.atagar.com/torExitTips/' before proceeding further to avoid any nasty surprises! wizard.toggle Notify => Yes, No +wizard.toggle Client => Enabled, Disabled wizard.toggle Startup => Yes, No wizard.toggle Notice => Yes, No wizard.toggle Policy => Default, Custom @@ -365,6 +366,7 @@ wizard.default Nickname => Unnamed wizard.default Notify => true wizard.default Bandwidth => 5 MB/s wizard.default Startup => true +wizard.default Client => false wizard.default Notice => true wizard.default Policy => true wizard.default Websites => true @@ -385,6 +387,7 @@ wizard.label.opt Contact => Contact Information wizard.label.opt Notify => Issue Notification wizard.label.opt Bandwidth => Relay Speed wizard.label.opt Limit => Monthly Limit +wizard.label.opt Client => Client Usage wizard.label.opt Startup => Run At Startup wizard.label.opt Notice => Disclaimer Notice wizard.label.opt Policy => Exit Policy @@ -404,6 +407,7 @@ wizard.description.opt Contact => Address we can contact you at if there's a pro wizard.description.opt Notify => Sends automated email notifications to the above address if your relay is unreachable or out of date. This service is provided by Tor Weather (https://weather.torproject.org/) and will send you a confirmation email before it's started. wizard.description.opt Bandwidth => Limit for the average rate at which you relay traffic. wizard.description.opt Limit => Maximum amount of traffic to relay each month. Some ISPs, like Comcast, cap their customer's Internet usage so this is an easy way of staying below that limit. +wizard.description.opt Client => Enable this if you would like to use Tor yourself. This opens or closes the SOCKS port used by applications for connecting to Tor. wizard.description.opt Startup => Runs Tor in the background when the system starts. wizard.description.opt Notice => Provides a disclaimer that this is an exit on port 80 (http://www.atagar.com/exitNotice) wizard.description.opt Policy => Ports allowed to exit from your relay. The default policy allows for common services while limiting the chance of getting a DMCA takedown for torrent traffic (http://www.atagar.com/exitPolicy)

1 0