- tor-commits - lists.torproject.org

[arm/release] Use explicit counting to remove dependency on scoping rules.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit f213ff7a9ecefe197faa91b980aa8a67819bdf4b Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Sat Jul 9 16:55:24 2011 +0500 Use explicit counting to remove dependency on scoping rules. --- src/gui/connections/connPanel.py | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/gui/connections/connPanel.py b/src/gui/connections/connPanel.py index ad57878..9df5142 100644 --- a/src/gui/connections/connPanel.py +++ b/src/gui/connections/connPanel.py @@ -44,9 +44,11 @@ class ConnectionPanel(CliConnectionPanel): treestore = self.builder.get_object('treestore_conn') # first pass checks whether we have enough entries cached to not update the treeview - for (index, line) in enumerate(self._entryLines): + index = 0 + for line in self._entryLines: local = "%s:%s" % (line.local.ipAddr, line.local.port) foreign = "%s:%s" % (line.foreign.ipAddr, line.foreign.port) + cachekey = (local, foreign) if self.cache.has_key(cachekey): timeLabel = "%d s" % (time.time() - line.startTime) @@ -54,7 +56,9 @@ class ConnectionPanel(CliConnectionPanel): else: break - if index == len(self._entryLines) - 1: + index = index + 1 + + if index == len(self._entryLines): return treestore.clear()

1 0

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

17 Jul '11

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

1 0

[arm/release] Adding menu option to start managed instance
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 30ab0618ff30c754b9a07dc25b80da4fa269e578 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 17:04:22 2011 -0700 Adding menu option to start managed instance If we've already made a custom torrc then providing a menu option to use it. --- src/cli/menu/actions.py | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/src/cli/menu/actions.py b/src/cli/menu/actions.py index db9d178..7f63b1b 100644 --- a/src/cli/menu/actions.py +++ b/src/cli/menu/actions.py @@ -50,6 +50,7 @@ def makeActionsMenu(): """ control = cli.controller.getController() + manager = control.getTorManager() conn = torTools.getConn() headerPanel = control.getPanel("header") actionsMenu = cli.menu.item.Submenu("Actions") @@ -58,6 +59,8 @@ def makeActionsMenu(): if conn.isAlive(): actionsMenu.add(cli.menu.item.MenuItem("Stop Tor", conn.shutdown)) + elif manager.isTorrcAvailable(): + actionsMenu.add(cli.menu.item.MenuItem("Start Tor", manager.startManagedInstance)) actionsMenu.add(cli.menu.item.MenuItem("Reset Tor", conn.reload)) actionsMenu.add(cli.menu.item.MenuItem("Setup Wizard", cli.wizard.showWizard))

1 0

[arm/release] fix: closing control connection on shutdown call
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 22e2e98adcd07c27510c7c21ac602f6f26b0d62a Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 17:23:38 2011 -0700 fix: closing control connection on shutdown call Making the shutdown function close the control connection right away if the signal should be shutting down tor right away. Without this it was taking around five seconds for the connection closure to be reflected in the interface. --- src/util/torTools.py | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 0fb71a8..4a18a4f 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -1480,8 +1480,12 @@ class Controller(TorCtl.PostEventListener): raisedException = None if self.isAlive(): try: + isRelay = self.getOption("ORPort") != None signal = "HALT" if force else "SHUTDOWN" self.conn.send_signal(signal) + + # shuts down control connection if we aren't making a delayed shutdown + if force or not isRelay: self.close() except Exception, exc: raisedException = IOError(str(exc))

1 0

[arm/release] Wizard option to use the last configuration
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 8e74e50a7adaec6d1f786248f2600658328292da Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jul 9 18:03:14 2011 -0700 Wizard option to use the last configuration --- src/cli/wizard.py | 23 ++++++++++++++++++----- src/settings.cfg | 2 ++ 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 8a5a138..e2419e8 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -20,7 +20,7 @@ from util import connections, enum, log, torConfig, torTools, uiTools TORRC_TEMPLATE = "resources/torrcTemplate.txt" # basic configuration types we can run as -RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") +RelayType = enum.Enum("RESUME", "RELAY", "EXIT", "BRIDGE", "CLIENT") # all options that can be configured Options = enum.Enum("DIVIDER", "CONTROL", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "CLIENT", "LOWPORTS", "PORTFORWARD", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT", "DISTRIBUTE", "BRIDGED", "BRIDGE1", "BRIDGE2", "BRIDGE3", "REUSE") @@ -252,15 +252,20 @@ def showWizard(): _toggleEnabledAction(bridgeEntries, useBridgeOpt, useBridgeOpt.getValue()) # remembers the last selection made on the type prompt page - relaySelection = RelayType.RELAY controller = cli.controller.getController() manager = controller.getTorManager() + relaySelection = RelayType.RESUME if manager.isTorrcAvailable() else RelayType.RELAY while True: if relayType == None: selection = promptRelayType(relaySelection) if selection == CANCEL: break + elif selection == RelayType.RESUME: + if not manager.isManaged(torTools.getConn()): + manager.startManagedInstance() + + break else: relayType, relaySelection = selection, selection else: selection = promptConfigOptions(relayType, config) @@ -310,12 +315,20 @@ def promptRelayType(initialSelection): dialog was canceled. """ - popup, _, _ = cli.popups.init(25, 58) - if not popup: return - control = cli.controller.getController() options = [ConfigOption(opt, "role", opt) for opt in RelayType.values()] options.append(ConfigOption(CANCEL, "general", CANCEL)) selection = RelayType.indexOf(initialSelection) + height = 28 + + # drops the resume option if it isn't applicable + control = cli.controller.getController() + if not control.getTorManager().isTorrcAvailable(): + options.pop(0) + height -= 3 + selection -= 1 + + popup, _, _ = cli.popups.init(height, 58) + if not popup: return try: popup.win.box() diff --git a/src/settings.cfg b/src/settings.cfg index f15aa49..4551b43 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -397,6 +397,7 @@ wizard.blankValue Bridge3 => <ip address>:<port> wizard.label.general Cancel => Cancel wizard.label.general Back => Previous wizard.label.general Next => Next +wizard.label.role Resume => Use Last Configuration wizard.label.role Relay => Internal Relay wizard.label.role Exit => Exit Relay wizard.label.role Bridge => Bridge @@ -425,6 +426,7 @@ wizard.label.opt Bridge3 => Third Bridge wizard.label.opt Reuse => Circuit Duration wizard.description.general Cancel => Close without starting Tor. +wizard.description.role Resume => Start Tor with the last configuration you made. 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 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.

1 0

[arm/release] Initial commit for GUI connection listing.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 05a369b15000e76fbc4cc03bc102786ac0247225 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Tue Jul 5 15:25:27 2011 +0500 Initial commit for GUI connection listing. Currently derives from the CLI conn panel and lists rudimentary (unstructured) information about circuits for debugging. --- src/gui/arm.xml | 25 +---------------- src/gui/connections/__init__.py | 6 ++++ src/gui/connections/connPanel.py | 56 ++++++++++++++++++++++++++++++++++++++ src/gui/controller.py | 5 +++ 4 files changed, 68 insertions(+), 24 deletions(-) diff --git a/src/gui/arm.xml b/src/gui/arm.xml index 1e3681c..dca5f33 100644 --- a/src/gui/arm.xml +++ b/src/gui/arm.xml @@ -72,29 +72,6 @@  <column type="gchararray"/> </columns> - <data> - <row> - <col id="0" translatable="yes">115.167.31.237:56835</col> - <col id="1" translatable="yes">188.120.245.249:9001 (ru)</col> - <col id="2" translatable="yes">10.7m</col> - <col id="3" translatable="yes">CLIENT</col> - <col id="4" translatable="yes">blue</col> - </row> - <row> - <col id="0" translatable="yes">115.167.31.237:44940</col> - <col id="1" translatable="yes">206.217.215.183:53 (us)</col> - <col id="2" translatable="yes">28.3m</col> - <col id="3" translatable="yes">CLIENT</col> - <col id="4" translatable="yes">blue</col> - </row> - <row> - <col id="0" translatable="yes">127.0.0.1:9051</col> - <col id="1" translatable="yes">127.0.0.1:51665</col> - <col id="2" translatable="yes">30.0m</col> - <col id="3" translatable="yes">CONTROL</col> - <col id="4" translatable="yes">red</col> - </row> - </data> </object> <object class="GtkListStore" id="liststore_config"> <columns> @@ -437,7 +414,7 @@ <child> <object class="GtkLabel" id="label_conn_top"> <property name="visible">True</property> - <property name="label" translatable="yes">2 Clients, 1 Control</property> + <property name="label" translatable="yes">Connections:</property> </object> <packing> <property name="expand">False</property> diff --git a/src/gui/connections/__init__.py b/src/gui/connections/__init__.py new file mode 100644 index 0000000..3102ead --- /dev/null +++ b/src/gui/connections/__init__.py @@ -0,0 +1,6 @@ +""" +Connections. +""" + +__all__ = ["connPanel"] + diff --git a/src/gui/connections/connPanel.py b/src/gui/connections/connPanel.py new file mode 100644 index 0000000..cbabc41 --- /dev/null +++ b/src/gui/connections/connPanel.py @@ -0,0 +1,56 @@ +""" +Connections panel. +""" + +import random +import sys +import time + +from collections import deque + +import gobject +import gtk + +from cli.connections import connEntry +from cli.connections.connPanel import ConnectionPanel as CliConnectionPanel +from TorCtl import TorCtl +from util import connections, uiTools, torTools + +REFRESH_RATE = 3 + +class ConnectionPanel(CliConnectionPanel): + def __init__(self, builder): + CliConnectionPanel.__init__(self, None) + + self.builder = builder + + self.resolver = connections.getResolver('tor') + + gobject.timeout_add(3000, self._fill_entries) + + def pack_widgets(self): + pass + + def _fill_entries(self): + self.valsLock.acquire() + + label = self.builder.get_object('label_conn_top') + label.set_text(self._title) + + liststore = self.builder.get_object('liststore_conn') + liststore.clear() + + for line in self._entryLines: + if isinstance(line, connEntry.ConnectionLine) and line.isUnresolvedApp(): + self._resolveApps() + + local = "%s:%s" % (line.local.ipAddr, line.local.port) + foreign = "%s:%s" % (line.foreign.ipAddr, line.foreign.port) + timeLabel = "%d s" % (time.time() - line.startTime) + row = (local, foreign, timeLabel, line.baseType, 'black') + liststore.append(row) + + self.valsLock.release() + + return True + diff --git a/src/gui/controller.py b/src/gui/controller.py index 5f1712c..a69fdef 100644 --- a/src/gui/controller.py +++ b/src/gui/controller.py @@ -5,6 +5,7 @@ import thread import time from util import log, torTools +from connections import connPanel from gui import logPanel from gui.graphing import bandwidthStats @@ -24,6 +25,10 @@ class GuiController: self.bwStats = bandwidthStats.BandwidthStats(self.builder) self.bwStats.pack_widgets() + self.connPanel = connPanel.ConnectionPanel(self.builder) + self.connPanel.pack_widgets() + self.connPanel.start() + def run(self): window = self.builder.get_object('window_main')

1 0

[arm/release] Fixed crash caused by mismatched keyword arg.
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 30f5d6fe6cf44a786bc7f4781cd403028e172026 Author: Kamran Riaz Khan <krkhan(a)inspirated.com> Date: Tue Jul 5 03:54:54 2011 +0500 Fixed crash caused by mismatched keyword arg. --- src/util/torTools.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/src/util/torTools.py b/src/util/torTools.py index 17c54f0..7ea140b 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -1629,7 +1629,7 @@ class Controller(TorCtl.PostEventListener): if self.isAlive(): # fetch the current network status if not provided if not nsList: - try: nsList = self.conn.get_network_status(getIterator=True) + try: nsList = self.conn.get_network_status(get_iterator=True) except (socket.error, TorCtl.TorCtlClosed, TorCtl.ErrorReply): nsList = [] # construct mappings of ips to relay data

1 0

[arm/release] Wizard option for relaying over low ports
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit ca124f16b2eee34624f61a54a763562019fc8aa8 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 3 20:06:26 2011 -0700 Wizard option for relaying over low ports Option to use port 443 for relaying and 80 for directory mirroring rather than the more conventional 9001/9030. This will make a 'tor-arm' user if it doesn't already exist and use that for the torrc User entry. --- src/cli/wizard.py | 15 +++++++++++---- src/settings.cfg | 4 ++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 80d2fd1..8239487 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -9,19 +9,20 @@ import curses import cli.popups import cli.controller -from util import enum, connections, uiTools +from util import connections, enum, uiTools # basic configuration types we can run as RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") # all options that can be configured -Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "CLIENT", "PORTFORWARD", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT", "DISTRIBUTE", "BRIDGED", "BRIDGE1", "BRIDGE2", "BRIDGE3", "REUSE") +Options = enum.Enum("DIVIDER", "NICKNAME", "CONTACT", "NOTIFY", "BANDWIDTH", "LIMIT", "CLIENT", "LOWPORTS", "PORTFORWARD", "STARTUP", "NOTICE", "POLICY", "WEBSITES", "EMAIL", "IM", "MISC", "PLAINTEXT", "DISTRIBUTE", "BRIDGED", "BRIDGE1", "BRIDGE2", "BRIDGE3", "REUSE") RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.CONTACT, Options.NOTIFY, Options.BANDWIDTH, Options.LIMIT, Options.CLIENT, + Options.LOWPORTS, Options.PORTFORWARD, Options.STARTUP), RelayType.EXIT: (Options.NICKNAME, @@ -30,6 +31,7 @@ RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.BANDWIDTH, Options.LIMIT, Options.CLIENT, + Options.LOWPORTS, Options.PORTFORWARD, Options.STARTUP, Options.DIVIDER, @@ -44,9 +46,9 @@ RelayOptions = {RelayType.RELAY: (Options.NICKNAME, Options.BANDWIDTH, Options.LIMIT, Options.CLIENT, + Options.LOWPORTS, Options.PORTFORWARD, - Options.STARTUP - ), + Options.STARTUP), RelayType.CLIENT: (Options.BRIDGED, Options.BRIDGE1, Options.BRIDGE2, @@ -218,6 +220,11 @@ def showWizard(): config[Options.REUSE].setValidator(_circDurationValidator) # enables custom policies when 'custom' is selected and disables otherwise + lowPortsOpt = config[Options.LOWPORTS] + disclaimerNotice = [config[Options.NOTICE]] + lowPortsOpt.setValidator(functools.partial(_toggleEnabledAction, disclaimerNotice)) + _toggleEnabledAction(disclaimerNotice, lowPortsOpt, lowPortsOpt.getValue()) + policyOpt = config[Options.POLICY] customPolicies = [config[opt] for opt in CUSTOM_POLICIES] policyOpt.setValidator(functools.partial(_toggleEnabledAction, customPolicies)) diff --git a/src/settings.cfg b/src/settings.cfg index 7f2953f..53da315 100644 --- a/src/settings.cfg +++ b/src/settings.cfg @@ -349,6 +349,7 @@ wizard.message.client This will make use of the Tor network without contributing wizard.toggle Notify => Yes, No wizard.toggle Client => Enabled, Disabled +wizard.toggle Lowports => Yes, No wizard.toggle Portforward => Enabled, Disabled wizard.toggle Startup => Yes, No wizard.toggle Notice => Yes, No @@ -374,6 +375,7 @@ wizard.default Notify => true wizard.default Bandwidth => 5 MB/s wizard.default Startup => true wizard.default Client => false +wizard.default Lowports => true wizard.default Portforward => true wizard.default Notice => true wizard.default Policy => false @@ -404,6 +406,7 @@ 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 Lowports => Low Relaying Ports wizard.label.opt Portforward => Port Forwarding wizard.label.opt Startup => Run At Startup wizard.label.opt Notice => Disclaimer Notice @@ -431,6 +434,7 @@ 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 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 Lowports => Relays using port 443 rather than 9001. This helps some users that would otherwise be blocked, but requires that tor is started with root permissions (after that it lowers itself to those of a 'tor-arm' user). wizard.description.opt Portforward => If needed, attempts NAT traversal using UPnP and NAT-PMP. This allows for automatic port forwarding on most home routers. wizard.description.opt Startup => Runs Tor in the background when the system starts. wizard.description.opt Notice => Provides a disclaimer that this is an exit on port 80 (http://www.atagar.com/exitNotice)

1 0

[arm/release] Input field validation for circ reuse durations
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit 5e0178152ddf08b4c1a8011dc74667c65c9a750a Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jul 3 18:08:36 2011 -0700 Input field validation for circ reuse durations --- src/cli/wizard.py | 22 ++++++++++++++++++++-- 1 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 16752e7..80d2fd1 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -215,6 +215,7 @@ def showWizard(): config[Options.BRIDGE1].setValidator(_bridgeDestinationValidator) config[Options.BRIDGE2].setValidator(_bridgeDestinationValidator) config[Options.BRIDGE3].setValidator(_bridgeDestinationValidator) + config[Options.REUSE].setValidator(_circDurationValidator) # enables custom policies when 'custom' is selected and disables otherwise policyOpt = config[Options.POLICY] @@ -432,7 +433,7 @@ def _toggleEnabledAction(toggleOptions, option, value): def _relayRateValidator(option, value): if value.count(" ") != 1: - msg = "This should be a measurement followed by the rate (for instance, \"5 MB/s\")" + msg = "This should be a rate measurement (for instance, \"5 MB/s\")" raise ValueError(msg) rate, units = value.split(" ", 1) @@ -447,7 +448,7 @@ def _relayRateValidator(option, value): def _monthlyLimitValidator(option, value): if value.count(" ") != 1: - msg = "This should be a measurement followed by the units (for instance, \"5 MB\")" + msg = "This should be a traffic size (for instance, \"5 MB\")" raise ValueError(msg) rate, units = value.split(" ", 1) @@ -457,6 +458,8 @@ def _monthlyLimitValidator(option, value): elif not units in acceptedUnits: msg = "'%s' is an invalid unit, options include \"%s\"" % (units, "\", \"".join(acceptedUnits)) raise ValueError(msg) + elif (int(rate) < 50 and units == "MB") or int(rate) < 1: + raise ValueError("To be usable as a relay's monthly limit should be at least 50 MB") def _bridgeDestinationValidator(option, value): if value.count(":") != 1: @@ -468,3 +471,18 @@ def _bridgeDestinationValidator(option, value): elif not port.isdigit() or int(port) < 0 or int(port) > 65535: raise ValueError("'%s' isn't a valid port number" % port) +def _circDurationValidator(option, value): + if value.count(" ") != 1: + msg = "This should be a time measurement (for instance, \"10 minutes\")" + raise ValueError(msg) + + rate, units = value.split(" ", 1) + acceptedUnits = ("minute", "minutes", "hour", "hours") + 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 \"minutes\" or \"hours\"" + raise ValueError(msg) + elif (int(rate) < 5 and units in ("minute", "minutes")) or int(rate) < 1: + raise ValueError("This would cause high network load, don't set this to less than five minutes") +

1 0

[arm/release] Torrc generation from the wizard input
by atagar＠torproject.org 17 Jul '11

17 Jul '11

commit b888d3657c85beed4c63d1db4e3df06f4ffeef3d Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jul 4 22:45:19 2011 -0700 Torrc generation from the wizard input This is most of the functionality needed to generate a torrc from the relay setup wizard's input (minus a few special-case fields like the exit policy and burst rate). This is done via a template that's filled in by the wizard results. The templating language just contains the simple set of control structures (if, if not, or) needed for this. --- src/cli/wizard.py | 43 +++++++++++++++- src/resources/torrcTemplate.txt | 77 ++++++++++++++++++++++++++++ src/util/torConfig.py | 106 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 224 insertions(+), 2 deletions(-) diff --git a/src/cli/wizard.py b/src/cli/wizard.py index 8239487..03cfb48 100644 --- a/src/cli/wizard.py +++ b/src/cli/wizard.py @@ -3,13 +3,18 @@ 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 os +import sys import functools import curses import cli.popups import cli.controller -from util import connections, enum, uiTools +from util import connections, enum, log, torConfig, uiTools + +# template used to generate the torrc +TORRC_TEMPLATE = "resources/torrcTemplate.txt" # basic configuration types we can run as RelayType = enum.Enum("RELAY", "EXIT", "BRIDGE", "CLIENT") @@ -249,7 +254,10 @@ def showWizard(): selection = promptConfigOptions(relayType, config) if selection == BACK: relayType = None - elif selection == NEXT: break # TODO: implement next screen + elif selection == NEXT: + generatedTorrc = getTorrc(relayType, config) + log.log(log.NOTICE, "Resulting torrc:\n%s" % generatedTorrc) + break # TODO: implement next screen # redraws screen to clear away the dialog we just showed cli.controller.getController().requestRedraw(True) @@ -407,6 +415,37 @@ def promptConfigOptions(relayType, config): finally: cli.popups.finalize() +def getTorrc(relayType, config): + """ + Provides the torrc generated for the given options. + """ + + pathPrefix = os.path.dirname(sys.argv[0]) + if pathPrefix and not pathPrefix.endswith("/"): + pathPrefix = pathPrefix + "/" + + templateFile = open("%s%s" % (pathPrefix, TORRC_TEMPLATE), "r") + template = templateFile.readlines() + templateFile.close() + + # generates the options the template expects + templateOptions = {} + + for key, value in config.items(): + if isinstance(value, ConfigOption): + value = value.getValue() + + templateOptions[key.upper()] = value + + #templateOptions = dict([(key.upper(), config[key].getValue()) for key in config]) + templateOptions[relayType.upper()] = True + templateOptions["LOW_PORTS"] = config[Options.LOWPORTS] + #templateOptions["BURST"] = config[Options.BANDWIDTH] * 2 # TODO: implement + templateOptions["NOTICE_PATH"] = "/path/to/.arm/exit-notice.html" # TODO: actually prepend the right prefix + templateOptions["EXIT_POLICY"] = "" # TODO: fill in configured policy + + return torConfig.renderTorrc(template, templateOptions) + def _splitStr(msg, width): """ Splits a string into substrings of a given length. diff --git a/src/resources/torrcTemplate.txt b/src/resources/torrcTemplate.txt new file mode 100644 index 0000000..bb4dccd --- /dev/null +++ b/src/resources/torrcTemplate.txt @@ -0,0 +1,77 @@ +# This is a tor configuration made by arm. To change the configuration by hand +# edit this file then either... +# - tell arm to reset tor by pressing 'x' +# - run 'pkill -sighup tor' +# - restart tor +# +# Descriptions of all of these configuraiton attibutes (and many more) are +# available in the tor man page. +[NEWLINE] +ControlPort 9052 # port controllers can connect to +CookieAuthentication 1 # method for controller authentication + +[IF RELAY | EXIT | BRIDGE] + RunAsDaemon 1 # runs as a background process +[END IF] +[NEWLINE] + +[IF RELAY | EXIT | BRIDGE] + [IF LOWPORTS] + ORPort 443 # port used for relaying traffic + [ELSE] + ORPort 9001 # port used for relaying traffic + [END IF] + + [IF RELAY | EXIT] + [IF LOWPORTS] + DirPort 80 # port used for mirroring directory information + [ELSE] + DirPort 9030 # port used for mirroring directory information + [END IF] + + Nickname [NICKNAME] # name for this relay + ContactInfo [CONTACT] # contact information in case there's an issue + [END IF] + + [IF BRIDGE] + BridgeRelay 1 # makes us a bridge rather than a public relay + + [IF DISTRIBUTE] + # TODO: drop this? + PublishServerDescriptor bridge # publishes to users looking for bridges + [ELSE] + PublishServerDescriptor 0 # keeps our bridge descriptor private + [END IF] + [END IF] + + RelayBandwidthRate [BANDWIDTH] # limit for the bandwidth we'll use to relay + RelayBandwidthBurst [BURST] # maximum rate when relaying bursts of traffic + AccountingMax [LIMIT] # maximum amount of traffic we'll relay per month + + [IF NOT CLIENT] + SocksPort 0 # prevents tor from being used as a client + [END IF] + + [IF PORTFORWARD] + PortForwarding 1 # negotiates UPnP and NAT-PMP if needed + [END IF] + + [IF RELAY | BRIDGE] + ExitPolicy reject *:* # prevents us from connecting to non-relays + [ELSE] + [IF NOTICE] + DirPortFrontPage [NOTICE_PATH] # disclaimer saying that this is an exit + [END IF] + + [EXIT_POLICY] + [END IF] +[ELSE] + ClientOnly 1 # prevents us from ever being used as a relay + MaxCircuitDirtiness [REUSE] # duration that circuits can be reused + + [IF BRIDGED] + UseBridges 1 # uses the following bridges to connect + [BRIDGES] + [END IF] +[END IF] + diff --git a/src/util/torConfig.py b/src/util/torConfig.py index a63eddb..e5f1cb2 100644 --- a/src/util/torConfig.py +++ b/src/util/torConfig.py @@ -845,3 +845,109 @@ def _testConfigDescriptions(): print "\"%s\"" % description if i != len(sortedOptions) - 1: print "-" * 80 +def renderTorrc(template, options, commentIndent = 30): + """ + Uses the given template to generate a nicely formatted torrc with the given + options. The tempating language this recognizes is a simple one, recognizing + the following options: + [IF <option>] # if <option> maps to true or a non-empty string + [IF NOT <option>] # logical inverse + [IF <opt1> | <opt2>] # logical or of the options + [ELSE] # if the prior conditional evaluated to false + [END IF] # ends the control block + + [<option>] # inputs the option value, omitting the line if it maps + # to a boolean or empty string + [NEWLINE] # empty line, otherwise templating white space is ignored + + Arguments: + template - torrc template lines used to generate the results + options - mapping of keywords to their given values, with values + being booleans or strings (possibly multi-line) + commentIndent - minimum column that comments align on + """ + + results = [] + templateIter = iter(template) + commentLineFormat = "%%-%is%%s" % commentIndent + + try: + while True: + line = templateIter.next().strip() + + if line.startswith("[IF ") and line.endswith("]"): + # checks if any of the conditional options are true or a non-empty string + evaluatesTrue = False + for cond in line[4:-1].split("|"): + isInverse = False + if cond.startswith("NOT "): + isInverse = True + cond = cond[4:] + + if isInverse != bool(options.get(cond.strip())): + evaluatesTrue = True + break + + if evaluatesTrue: + continue + else: + # skips lines until we come to an else or the end of the block + depth = 0 + + while depth != -1: + line = templateIter.next().strip() + + if line.startswith("[IF ") and line.endswith("]"): depth += 1 + elif line == "[END IF]": depth -= 1 + elif depth == 0 and line == "[ELSE]": depth -= 1 + elif line == "[ELSE]": + # an else block we aren't using - skip to the end of it + depth = 0 + + while depth != -1: + line = templateIter.next().strip() + + if line.startswith("[IF "): depth += 1 + elif line == "[END IF]": depth -= 1 + elif line == "[NEWLINE]": + # explicit newline + results.append("") + elif line.startswith("#"): + # comment only + results.append(line) + elif line.startswith("[") and line.endswith("]"): + # completely dynamic entry + optValue = options.get(line[1:-1]) + if optValue: results.append(optValue) + else: + # torrc option line + option, arg, comment = "", "", "" + parsedLine = line + + if "#" in parsedLine: + parsedLine, comment = parsedLine.split("#", 1) + parsedLine = parsedLine.strip() + comment = "# %s" % comment.strip() + + # parses the argument from the option + if " " in parsedLine: + option, arg = parsedLine.split(" ", 1) + option = option.strip() + else: + log.log(log.INFO, "torrc template option lacks an argument: '%s'" % line) + continue + + # inputs dynamic arguments + if arg.startswith("[") and arg.endswith("]"): + arg = options.get(arg[1:-1]) + + # skips argument if it's false or an empty string + if not arg: continue + + torrcEntry = "%s %s" % (option, arg) + if comment: results.append(commentLineFormat % (torrcEntry + " ", comment)) + else: results.append(torrcEntry) + except StopIteration: pass + + return "\n".join(results) +

1 0