tor-commits May 2014

tor-commits@lists.torproject.org

25 participants
1732 discussions

[translation/bridgedb] Update translations for bridgedb
by translation＠torproject.org 06 May '14

06 May '14

commit e5ec2f876b6ec2c679f85fffbd81c90d4b6aa5dc Author: Translation commit bot <translation(a)torproject.org> Date: Tue May 6 06:45:03 2014 +0000 Update translations for bridgedb --- ko/LC_MESSAGES/bridgedb.po | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/ko/LC_MESSAGES/bridgedb.po b/ko/LC_MESSAGES/bridgedb.po index c052dd7..e877b87 100644 --- a/ko/LC_MESSAGES/bridgedb.po +++ b/ko/LC_MESSAGES/bridgedb.po @@ -4,6 +4,7 @@ # # Translators: # Translators: +# ilbe123 <a3057016(a)drdrb.net>, 2014 # cwt96 <cwt967(a)naver.com>, 2012 # Dr.what <javrick6(a)naver.com>, 2014 # pCsOrI <pcsori(a)gmail.com>, 2012 @@ -12,8 +13,8 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2013-03-27 21:41+0000\n" -"PO-Revision-Date: 2014-02-13 14:50+0000\n" -"Last-Translator: Dr.what <javrick6(a)naver.com>\n" +"PO-Revision-Date: 2014-05-06 06:40+0000\n" +"Last-Translator: ilbe123 <a3057016(a)drdrb.net>\n" "Language-Team: Korean (http://www.transifex.com/projects/p/torproject/language/ko/)\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -73,7 +74,7 @@ msgstr "당신의 브라우저를 파이어폭스로 업그레이드 하세요!" #: lib/bridgedb/templates/captcha.html:8 msgid "Type the two words" -msgstr "" +msgstr "두개의 단어를 입력하십시오" #: lib/bridgedb/templates/index.html:6 msgid "Step 1" @@ -82,7 +83,7 @@ msgstr "1단계" #: lib/bridgedb/templates/index.html:8 #, python-format msgid "Get %s Tor Browser Bundle %s" -msgstr "" +msgstr "Tor %s Browser Bundle %s를 입수" #: lib/bridgedb/templates/index.html:13 msgid "Step 2" @@ -91,7 +92,7 @@ msgstr "2단계" #: lib/bridgedb/templates/index.html:15 #, python-format msgid "Get %s bridges %s" -msgstr "" +msgstr "%s 브릿지 %s를 입수" #: lib/bridgedb/templates/index.html:19 msgid "Step 3" @@ -100,4 +101,4 @@ msgstr "3단계" #: lib/bridgedb/templates/index.html:21 #, python-format msgid "Now %s add the bridges to Tor %s" -msgstr "" +msgstr "곧 바로 %s Tor 브리지를 추가 %s"

1 0

[check/master] Add a user agent check for TBB
by arlo＠torproject.org 06 May '14

06 May '14

commit 9162164ad821bcebd4cf79d25bae6965128643d4 Author: Arlo Breault <arlolra(a)gmail.com> Date: Mon May 5 20:26:36 2014 -0700 Add a user agent check for TBB * Warn if it isn't a known Firefox. * This is trac 9041. --- check.pot | 3 +++ handlers.go | 18 ++++++++++++++++-- public/base.html | 2 +- public/img/tor-not.png | Bin 0 -> 9745 bytes public/index.html | 20 +++++++++++++++----- utils.go | 11 +++++++++++ 6 files changed, 46 insertions(+), 8 deletions(-) diff --git a/check.pot b/check.pot index 0b06910..ed65512 100644 --- a/check.pot +++ b/check.pot @@ -86,3 +86,6 @@ msgstr "" msgid "JavaScript is disabled." msgstr "" + +msgid "However, it does not appear to be the Tor Browser Bundle." +msgstr "" diff --git a/handlers.go b/handlers.go index db5fe0b..3b220e0 100644 --- a/handlers.go +++ b/handlers.go @@ -20,6 +20,7 @@ type Page struct { IsTor bool NotUpToDate bool Small bool + NotTBB bool Fingerprint string OnOff string Lang string @@ -55,10 +56,22 @@ func RootHandler(Layout *template.Template, Exits *Exits, domain *gettext.Domain return } + // try to determine if it's TBB + notTBB := !LikelyTBB(r.UserAgent()) + + // users shouldn't be relying on check + // to determine the TBB is up-to-date + // always return false to this param + notUpToDate := IsParamSet(r, "uptodate") + // string used for classes and such // in the template if isTor { - onOff = "on" + if notTBB || notUpToDate { + onOff = "not" + } else { + onOff = "on" + } } else { onOff = "off" } @@ -66,8 +79,9 @@ func RootHandler(Layout *template.Template, Exits *Exits, domain *gettext.Domain // instance of your page model p := Page{ isTor, - IsParamSet(r, "uptodate"), + notUpToDate, IsParamSet(r, "small"), + notTBB, fingerprint, onOff, Lang(r), diff --git a/public/base.html b/public/base.html index bd46b69..366d912 100644 --- a/public/base.html +++ b/public/base.html @@ -13,7 +13,7 @@ font-family: Helvetica, sans-serif; margin: 0; } - h1 { font-size: 2.4em; } + h1 { font-size: 2.2em; } a { text-decoration: none; } a:hover { text-decoration: underline; } ul { margin: 0; padding: 0; } diff --git a/public/img/tor-not.png b/public/img/tor-not.png new file mode 100644 index 0000000..591e7cd Binary files /dev/null and b/public/img/tor-not.png differ diff --git a/public/index.html b/public/index.html index dec740a..82360a7 100644 --- a/public/index.html +++ b/public/index.html @@ -3,6 +3,7 @@ {{ define "css" }} .on { color: green; } .off { color: red; } + .not { color: goldenrod; } .mid { margin: 3em 0; } .mid a { text-decoration: underline; @@ -77,11 +78,20 @@ {{ end }} </h1> {{ GetText .Lang "Your IP address appears to be: " }} {{ .IP }} - {{ if And .IsTor .NotUpToDate }} - - {{ GetText .Lang "There is a security update available for the Tor Browser Bundle." }} - {{ GetText .Lang "<a href=\"https://www.torproject.org/download/download-easy.html\">Click here to go to the download page</a>" | UnEscaped }} - + {{ if .IsTor }} + {{ if .NotUpToDate }} + + {{ GetText .Lang "There is a security update available for the Tor Browser Bundle." }} + {{ GetText .Lang "<a href=\"https://www.torproject.org/download/download-easy.html\">Click here to go to the download page</a>" | UnEscaped }} + + {{ else }} + {{ if .NotTBB }} + + {{ GetText .Lang "However, it does not appear to be the Tor Browser Bundle." }} + {{ GetText .Lang "<a href=\"https://www.torproject.org/download/download-easy.html\">Click here to go to the download page</a>" | UnEscaped }} + + {{ end }} + {{ end }} {{ end }} {{ if .IsTor }} diff --git a/utils.go b/utils.go index 79ba81e..8e05a07 100644 --- a/utils.go +++ b/utils.go @@ -57,6 +57,17 @@ func GetHost(r *http.Request) (host string, err error) { return } +var TBBUserAgents = map[string]bool{ + "Mozilla/5.0 (Windows NT 6.1; rv:10.0) Gecko/20100101 Firefox/10.0": true, + "Mozilla/5.0 (Windows NT 6.1; rv:17.0) Gecko/20100101 Firefox/17.0": true, + "Mozilla/5.0 (Windows NT 6.1; rv:24.0) Gecko/20100101 Firefox/24.0": true, +} + +func LikelyTBB(ua string) bool { + _, ok := TBBUserAgents[ua] + return ok +} + var HaveManual = map[string]bool{ "ar": true, "cs": true,

1 0

[check/master] Have the uptodate url always say you're out of date
by arlo＠torproject.org 06 May '14

06 May '14

commit 74442cfbab63ae5fd7926c9f4c80361c73dcfc96 Author: Arlo Breault <arlolra(a)gmail.com> Date: Mon May 5 19:13:33 2014 -0700 Have the uptodate url always say you're out of date * If the uptodate querystring parameter is set, you're probably using an old TBB and should be warned. * This is trac 11666. --- handlers.go | 6 +++--- utils.go | 11 ++--------- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/handlers.go b/handlers.go index e806048..db5fe0b 100644 --- a/handlers.go +++ b/handlers.go @@ -50,7 +50,7 @@ func RootHandler(Layout *template.Template, Exits *Exits, domain *gettext.Domain } // short circuit for torbutton - if len(r.URL.Query().Get("TorButton")) > 0 { + if IsParamSet(r, "TorButton") { WriteHTMLBuf(w, r, Layout, domain, "torbutton.html", Page{IsTor: isTor}) return } @@ -66,8 +66,8 @@ func RootHandler(Layout *template.Template, Exits *Exits, domain *gettext.Domain // instance of your page model p := Page{ isTor, - !UpToDate(r), - Small(r), + IsParamSet(r, "uptodate"), + IsParamSet(r, "small"), fingerprint, onOff, Lang(r), diff --git a/utils.go b/utils.go index 0a642db..79ba81e 100644 --- a/utils.go +++ b/utils.go @@ -17,15 +17,8 @@ import ( "strings" ) -func UpToDate(r *http.Request) bool { - if r.URL.Query().Get("uptodate") == "0" { - return false - } - return true -} - -func Small(r *http.Request) bool { - if len(r.URL.Query().Get("small")) > 0 { +func IsParamSet(r *http.Request, param string) bool { + if len(r.URL.Query().Get(param)) > 0 { return true } return false

1 0

[check/master] Order user manuals
by arlo＠torproject.org 06 May '14

06 May '14

commit a509bb177efd060fe4d049f148807e2c517818fc Author: Arlo Breault <arlolra(a)gmail.com> Date: Mon May 5 18:54:56 2014 -0700 Order user manuals --- utils.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/utils.go b/utils.go index bac9d68..0a642db 100644 --- a/utils.go +++ b/utils.go @@ -66,25 +66,25 @@ func GetHost(r *http.Request) (host string, err error) { var HaveManual = map[string]bool{ "ar": true, - "zh_CN": true, "cs": true, - "nl": true, + "de": true, + "el": true, "en": true, + "es": true, "fa": true, "fr": true, - "de": true, - "el": true, "hu": true, "it": true, "ja": true, "lv": true, "nb": true, + "nl": true, "pl": true, "pt_BR": true, "ru": true, - "es": true, "sv": true, "tr": true, + "zh_CN": true, } func FuncMap(domain *gettext.Domain) template.FuncMap {

1 0

[stem/master] Unit tests didn't account for ending newlines
by atagar＠torproject.org 06 May '14

06 May '14

commit 6622eabc36b795c771afd7913c94273c3c6f1e6a Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 5 18:34:28 2014 -0700 Unit tests didn't account for ending newlines Oops, last minute change added a newline to the end of non-interpretor commands. Forgot to update the unit tests to account for this. --- test/unit/interpretor/commands.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/test/unit/interpretor/commands.py b/test/unit/interpretor/commands.py index 9ed7a92..0466e30 100644 --- a/test/unit/interpretor/commands.py +++ b/test/unit/interpretor/commands.py @@ -37,6 +37,7 @@ moria1 (9695DFC35FFEB861329B9F1AB04C46397020CE31) EXPECTED_GETCONF_RESPONSE = """\ \x1b[34;1mlog\x1b[0m\x1b[34m => notice stdout\x1b[0m \x1b[34;1maddress\x1b[0m\x1b[34m => \x1b[0m + """ FINGERPRINT = '9695DFC35FFEB861329B9F1AB04C46397020CE31' @@ -171,15 +172,15 @@ class TestInterpretorCommands(unittest.TestCase): interpretor = ControlInterpretor(controller) getinfo['version'] = '0.2.5.1-alpha-dev (git-245ecfff36c0cecc)' - self.assertEqual('\x1b[34m0.2.5.1-alpha-dev (git-245ecfff36c0cecc)\x1b[0m', interpretor.run_command('GETINFO version')) + self.assertEqual('\x1b[34m0.2.5.1-alpha-dev (git-245ecfff36c0cecc)\x1b[0m\n', interpretor.run_command('GETINFO version')) controller.get_info.assert_called_with(['version']) getinfo['process/user'] = 'atagar' - self.assertEqual('\x1b[34m0.2.5.1-alpha-dev (git-245ecfff36c0cecc)\natagar\x1b[0m', interpretor.run_command('getinfo version process/user')) + self.assertEqual('\x1b[34m0.2.5.1-alpha-dev (git-245ecfff36c0cecc)\natagar\x1b[0m\n', interpretor.run_command('getinfo version process/user')) controller.get_info.assert_called_with(['version', 'process/user']) controller.get_info.side_effect = stem.ControllerError('kaboom!') - self.assertEqual('\x1b[1;31mkaboom!\x1b[0m', interpretor.run_command('getinfo process/user')) + self.assertEqual('\x1b[1;31mkaboom!\x1b[0m\n', interpretor.run_command('getinfo process/user')) def test_getconf(self): controller, getconf = Mock(), collections.OrderedDict() @@ -197,14 +198,14 @@ class TestInterpretorCommands(unittest.TestCase): controller = Mock() interpretor = ControlInterpretor(controller) - self.assertEqual('', interpretor.run_command('SETCONF ControlPort=9051')) + self.assertEqual('\n', interpretor.run_command('SETCONF ControlPort=9051')) controller.set_options.assert_called_with([('ControlPort', '9051')], False) def test_setevents(self): controller = Mock() interpretor = ControlInterpretor(controller) - self.assertEqual('\x1b[34mListing for BW events\n\x1b[0m', interpretor.run_command('SETEVENTS BW')) + self.assertEqual('\x1b[34mListing for BW events\n\x1b[0m\n', interpretor.run_command('SETEVENTS BW')) controller.add_event_listener.assert_called_with(interpretor.register_event, 'BW') def test_raw_commands(self): @@ -212,5 +213,5 @@ class TestInterpretorCommands(unittest.TestCase): controller.msg.return_value = 'response' interpretor = ControlInterpretor(controller) - self.assertEqual('\x1b[34mresponse\x1b[0m', interpretor.run_command('NEW_COMMAND spiffyness')) + self.assertEqual('\x1b[34mresponse\x1b[0m\n', interpretor.run_command('NEW_COMMAND spiffyness')) controller.msg.assert_called_with('NEW_COMMAND spiffyness')

1 0

[stem/master] Tab completion support
by atagar＠torproject.org 06 May '14

06 May '14

commit 2ccd8797ea06933ff4c2a568c502c84378ddd80b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 6 17:54:53 2014 -0700 Tab completion support Adding support for tab completion for commands tor will accept. --- stem/interpretor/__init__.py | 6 +++ stem/interpretor/commands.py | 108 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 114 insertions(+) diff --git a/stem/interpretor/__init__.py b/stem/interpretor/__init__.py index 72711c0..72fba90 100644 --- a/stem/interpretor/__init__.py +++ b/stem/interpretor/__init__.py @@ -12,6 +12,7 @@ import sys import stem.connection import stem.interpretor.arguments +import stem.interpretor.commands import stem.prereq from stem.util.term import Attr, Color, format @@ -52,6 +53,11 @@ def main(): sys.exit(1) with controller: + tab_completer = stem.interpretor.commands.Autocomplete(controller) + readline.parse_and_bind("tab: complete") + readline.set_completer(tab_completer.complete) + readline.set_completer_delims('\n') + while True: try: user_input = raw_input(PROMPT) diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py new file mode 100644 index 0000000..3b809b4 --- /dev/null +++ b/stem/interpretor/commands.py @@ -0,0 +1,108 @@ +""" +Handles making requests and formatting the responses. +""" + +TOR_CONTROLLER_COMMANDS = [ + 'SAVECONF', + 'MAPADDRESS', + 'EXTENDCIRCUIT', + 'SETCIRCUITPURPOSE', + 'SETROUTERPURPOSE', + 'ATTACHSTREAM', + #'+POSTDESCRIPTOR', # TODO: needs multi-line support + 'REDIRECTSTREAM', + 'CLOSESTREAM', + 'CLOSECIRCUIT', + 'QUIT', + 'RESOLVE', + 'PROTOCOLINFO', + #'+LOADCONF', # TODO: needs multi-line support + 'TAKEOWNERSHIP', + 'AUTHCHALLENGE', + 'DROPGUARDS', +] + + +def _get_commands(controller): + """ + Provides commands recognized by tor. + """ + + commands = list(TOR_CONTROLLER_COMMANDS) + + # GETINFO commands + + getinfo_options = controller.get_info('info/names', None) + + if getinfo_options: + # Lines are of the form '[option] -- [description]'. This strips '*' from + # options that accept values. + + options = [line.split(' ', 1)[0].rstrip('*') for line in getinfo_options.splitlines()] + + commands += ['GETINFO %s' % opt for opt in options] + else: + commands.append('GETINFO ') + + # GETCONF, SETCONF, and RESETCONF commands + + config_options = controller.get_info('config/names', None) + + if config_options: + # individual options are '[option] [type]' pairs + + entries = [opt.split(' ', 1)[0] for opt in config_options.splitlines()] + + commands += ['GETCONF %s' % opt for opt in entries] + commands += ['SETCONF %s ' % opt for opt in entries] + commands += ['RESETCONF %s' % opt for opt in entries] + else: + commands += ['GETCONF ', 'SETCONF ', 'RESETCONF '] + + # SETEVENT commands + + events = controller.get_info('events/names', None) + + if events: + commands += ['SETEVENTS %s' % event for event in events.split(' ')] + else: + commands.append('SETEVENTS ') + + # USEFEATURE commands + + features = controller.get_info('features/names', None) + + if features: + commands += ['USEFEATURE %s' % feature for feature in features.split(' ')] + else: + commands.append('USEFEATURE ') + + # SIGNAL commands + + signals = controller.get_info('signal/names', None) + + if signals: + commands += ['SIGNAL %s' % signal for signal in signals.split(' ')] + else: + commands.append('SIGNAL ') + + return commands + + +class Autocomplete(object): + def __init__(self, controller): + self._commands = _get_commands(controller) + + def complete(self, text, state): + """ + Provides case insensetive autocompletion options, acting as a functor for + the readlines set_completer function. + """ + + lowercase_text = text.lower() + prefix_matches = [cmd for cmd in self._commands if cmd.lower().startswith(lowercase_text)] + + if state < len(prefix_matches): + return prefix_matches[state] + else: + return None

1 0

[stem/master] Handler for interpretor commands
by atagar＠torproject.org 06 May '14

06 May '14

commit 2fad86f212566b456c1f66a159ef11714ec730d3 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Apr 10 09:12:33 2014 -0700 Handler for interpretor commands Using a more sophisticated handler rather than simply run msg(). This adds '/help' and '/quit' interpretor commands as well as takes advantage of Stem's caching. --- stem/interpretor/__init__.py | 7 +- stem/interpretor/commands.py | 433 ++++++++++++++++++++++++++++++++++++++++++ stem/response/__init__.py | 1 + 3 files changed, 439 insertions(+), 2 deletions(-) diff --git a/stem/interpretor/__init__.py b/stem/interpretor/__init__.py index 9d08676..d1a5359 100644 --- a/stem/interpretor/__init__.py +++ b/stem/interpretor/__init__.py @@ -10,6 +10,7 @@ __all__ = ['arguments'] import sys +import stem import stem.connection import stem.interpretor.arguments import stem.interpretor.commands @@ -58,10 +59,12 @@ def main(): readline.set_completer(tab_completer.complete) readline.set_completer_delims('\n') + interpretor = stem.interpretor.commands.ControlInterpretor(controller) + while True: try: user_input = raw_input(PROMPT) - print controller.msg(user_input) - except (KeyboardInterrupt, EOFError) as exc: + print interpretor.run_command(user_input) + except (KeyboardInterrupt, EOFError, stem.SocketClosed) as exc: print # move cursor to the following line break diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py index 3b809b4..b326cc0 100644 --- a/stem/interpretor/commands.py +++ b/stem/interpretor/commands.py @@ -2,6 +2,16 @@ Handles making requests and formatting the responses. """ +import re + +import stem + +from stem.util.term import Attr, Color, format + +OUTPUT_FORMAT = (Color.BLUE, ) +BOLD_OUTPUT_FORMAT = (Color.BLUE, Attr.BOLD) +ERROR_FORMAT = (Attr.BOLD, Color.RED) + TOR_CONTROLLER_COMMANDS = [ 'SAVECONF', 'MAPADDRESS', @@ -22,6 +32,173 @@ TOR_CONTROLLER_COMMANDS = [ 'DROPGUARDS', ] +MULTILINE_UNIMPLEMENTED_NOTICE = "Multi-line control options like this are not yet implemented." + +GENERAL_HELP = """Interpretor commands include: + /help - provides information for interpretor and tor commands/config options + /quit - shuts down the interpretor + +Tor commands include: + GETINFO - queries information from tor + GETCONF, SETCONF, RESETCONF - show or edit a configuration option + SIGNAL - issues control signal to the process (for resetting, stopping, etc) + SETEVENTS - configures the events tor will notify us of + + USEFEATURE - enables custom behavior for the controller + SAVECONF - writes tor's current configuration to our torrc + LOADCONF - loads the given input like it was part of our torrc + MAPADDRESS - replaces requests for one address with another + POSTDESCRIPTOR - adds a relay descriptor to our cache + EXTENDCIRCUIT - create or extend a tor circuit + SETCIRCUITPURPOSE - configures the purpose associated with a circuit + CLOSECIRCUIT - closes the given circuit + ATTACHSTREAM - associates an application's stream with a tor circuit + REDIRECTSTREAM - sets a stream's destination + CLOSESTREAM - closes the given stream + RESOLVE - issues an asynchronous dns or rdns request over tor + TAKEOWNERSHIP - instructs tor to quit when this control connection is closed + PROTOCOLINFO - queries version and controller authentication information + QUIT - disconnect the control connection + +For more information use '/help [OPTION]'.""" + +HELP_HELP = """Provides usage information for the given interpretor, tor command, or tor +configuration option. + +Example: + /help GETINFO # usage information for tor's GETINFO controller option +""" + +HELP_QUIT = """Terminates the interpretor.""" + +HELP_GETINFO = """Queries the tor process for information. Options are... +""" + +HELP_GETCONF = """Provides the current value for a given configuration value. Options include... +""" + +HELP_SETCONF = """Sets the given configuration parameters. Values can be quoted or non-quoted +strings, and reverts the option to 0 or NULL if not provided. + +Examples: + * Sets a contact address and resets our family to NULL + SETCONF MyFamily ContactInfo=foo(a)bar.com + + * Sets an exit policy that only includes port 80/443 + SETCONF ExitPolicy=\"accept *:80, accept *:443, reject *:*\"\ +""" + +HELP_RESETCONF = """Reverts the given configuration options to their default values. If a value +is provided then this behaves in the same way as SETCONF. + +Examples: + * Returns both of our accounting parameters to their defaults + RESETCONF AccountingMax AccountingStart + + * Uses the default exit policy and sets our nickname to be 'Goomba' + RESETCONF ExitPolicy Nickname=Goomba""" + +HELP_SIGNAL = """Issues a signal that tells the tor process to reload its torrc, dump its +stats, halt, etc. +""" + +SIGNAL_DESCRIPTIONS = ( + ("RELOAD / HUP", "reload our torrc"), + ("SHUTDOWN / INT", "gracefully shut down, waiting 30 seconds if we're a relay"), + ("DUMP / USR1", "logs information about open connections and circuits"), + ("DEBUG / USR2", "makes us log at the DEBUG runlevel"), + ("HALT / TERM", "immediately shut down"), + ("CLEARDNSCACHE", "clears any cached DNS results"), + ("NEWNYM", "clears the DNS cache and uses new circuits for future connections") +) + +HELP_SETEVENTS = """Sets the events that we will receive. This turns off any events that aren't +listed so sending 'SETEVENTS' without any values will turn off all event reporting. + +For Tor versions between 0.1.1.9 and 0.2.2.1 adding 'EXTENDED' causes some +events to give us additional information. After version 0.2.2.1 this is +always on. + +Events include... + +""" + +HELP_USEFEATURE = """Customizes the behavior of the control port. Options include... +""" + +HELP_SAVECONF = """Writes Tor's current configuration to its torrc.""" + +HELP_LOADCONF = """Reads the given text like it belonged to our torrc. + +Example: + +LOADCONF + # sets our exit policy to just accept ports 80 and 443 + ExitPolicy accept *:80 + ExitPolicy accept *:443 + ExitPolicy reject *:* + .""" + +HELP_MAPADDRESS = """Replaces future requests for one address with another. + +Example: + MAPADDRESS 0.0.0.0=torproject.org 1.2.3.4=tor.freehaven.net""" + +HELP_POSTDESCRIPTOR = """Simulates getting a new relay descriptor.""" + +HELP_EXTENDCIRCUIT = """Extends the given circuit or create a new one if the CircuitID is zero. The +PATH is a comma separated list of fingerprints. If it isn't set then this +uses Tor's normal path selection.""" + +HELP_SETCIRCUITPURPOSE = """Sets the purpose attribute for a circuit.""" + +HELP_CLOSECIRCUIT = """Closes the given circuit. If "IfUnused" is included then this only closes +the circuit if it isn't currently being used.""" + +HELP_ATTACHSTREAM = """Attaches a stream with the given built circuit (tor picks one on its own if +CircuitID is zero). If HopNum is given then this hop is used to exit the +circuit, otherwise the last relay is used.""" + +HELP_REDIRECTSTREAM = """Sets the destination for a given stream. This can only be done after a +stream is created but before it's attached to a circuit.""" + +HELP_CLOSESTREAM = """Closes the given stream, the reason being an integer matching a reason as +per section 6.3 of the tor-spec.""" + +HELP_RESOLVE = """Performs IPv4 DNS resolution over tor, doing a reverse lookup instead if +"mode=reverse" is included. This request is processed in the background and +results in a ADDRMAP event with the response.""" + +HELP_TAKEOWNERSHIP = """Instructs Tor to gracefully shut down when this control connection is closed.""" + +HELP_PROTOCOLINFO = """Provides bootstrapping information that a controller might need when first +starting, like Tor's version and controller authentication. This can be done +before authenticating to the control port.""" + +HELP_OPTIONS = { + "HELP": ("/help [OPTION]", HELP_HELP), + "QUIT": ("/quit", HELP_QUIT), + "GETINFO": ("GETINFO OPTION", HELP_GETINFO), + "GETCONF": ("GETCONF OPTION", HELP_GETCONF), + "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF), + "RESETCONF": ("RESETCONF PARAM[=VALUE]", HELP_RESETCONF), + "SIGNAL": ("SIGNAL SIG", HELP_SIGNAL), + "SETEVENTS": ("SETEVENTS [EXTENDED] [EVENTS]", HELP_SETEVENTS), + "USEFEATURE": ("USEFEATURE OPTION", HELP_USEFEATURE), + "SAVECONF": ("SAVECONF", HELP_SAVECONF), + "LOADCONF": ("LOADCONF...", HELP_LOADCONF), + "MAPADDRESS": ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", HELP_MAPADDRESS), + "POSTDESCRIPTOR": ("POSTDESCRIPTOR [purpose=general/controller/bridge] [cache=yes/no]...", HELP_POSTDESCRIPTOR), + "EXTENDCIRCUIT": ("EXTENDCIRCUIT CircuitID [PATH] [purpose=general/controller]", HELP_EXTENDCIRCUIT), + "SETCIRCUITPURPOSE": ("SETCIRCUITPURPOSE CircuitID purpose=general/controller", HELP_SETCIRCUITPURPOSE), + "CLOSECIRCUIT": ("CLOSECIRCUIT CircuitID [IfUnused]", HELP_CLOSECIRCUIT), + "ATTACHSTREAM": ("ATTACHSTREAM StreamID CircuitID [HOP=HopNum]", HELP_ATTACHSTREAM), + "REDIRECTSTREAM": ("REDIRECTSTREAM StreamID Address [Port]", HELP_REDIRECTSTREAM), + "CLOSESTREAM": ("CLOSESTREAM StreamID Reason [Flag]", HELP_CLOSESTREAM), + "RESOLVE": ("RESOLVE [mode=reverse] address", HELP_RESOLVE), + "TAKEOWNERSHIP": ("TAKEOWNERSHIP", HELP_TAKEOWNERSHIP), + "PROTOCOLINFO": ("PROTOCOLINFO [ProtocolVersion]", HELP_PROTOCOLINFO), +} + def _get_commands(controller): """ @@ -86,6 +263,19 @@ def _get_commands(controller): else: commands.append('SIGNAL ') + # adds interpretor commands + + for cmd in HELP_OPTIONS: + if HELP_OPTIONS[cmd][0].startswith('/'): + commands.append('/' + cmd.lower()) + + # adds help options for the previous commands + + base_cmd = set([cmd.split(' ')[0].replace('+', '').replace('/', '') for cmd in commands]) + + for cmd in base_cmd: + commands.append('/help ' + cmd) + return commands @@ -106,3 +296,246 @@ class Autocomplete(object): return prefix_matches[state] else: return None + + +class ControlInterpretor(object): + """ + Handles issuing requests and providing nicely formed responses, with support + for special irc style subcommands. + """ + + def __init__(self, controller): + self.controller = controller + + def do_help(self, arg): + """ + Performs the '/help' operation, giving usage information for the given + argument or a general summary if there wasn't one. + """ + + arg = arg.upper() + + # If there's multiple arguments then just take the first. This is + # particularly likely if they're trying to query a full command (for + # instance "/help GETINFO version") + + arg = arg.split(' ')[0] + + # strip slash if someone enters an interpretor command (ex. "/help /help") + + if arg.startswith('/'): + arg = arg[1:] + + output = '' + + if not arg: + # provides the GENERAL_HELP with everything bolded except descriptions + + for line in GENERAL_HELP.splitlines(): + cmd_start = line.find(' - ') + + if cmd_start != -1: + output += format(line[:cmd_start], *BOLD_OUTPUT_FORMAT) + output += format(line[cmd_start:] + '\n', *OUTPUT_FORMAT) + else: + output += format(line + '\n', *BOLD_OUTPUT_FORMAT) + elif arg in HELP_OPTIONS: + # Provides information for the tor or interpretor argument. This bolds + # the usage information and indents the description after it. + + usage, description = HELP_OPTIONS[arg] + + output = format(usage + '\n', *BOLD_OUTPUT_FORMAT) + + for line in description.splitlines(): + output += format(' ' + line + '\n', *OUTPUT_FORMAT) + + if arg == 'GETINFO': + # if this is the GETINFO option then also list the valid options + + info_options = self.controller.get_info('info/names', None) + + if info_options: + for line in info_options.splitlines(): + line_match = re.match("^(.+) -- (.+)$", line) + + if line_match: + opt, description = line_match.groups() + + output += format("%-33s" % opt, *BOLD_OUTPUT_FORMAT) + output += format(" - %s\n" % description, *OUTPUT_FORMAT) + elif arg == 'GETCONF': + # lists all of the configuration options + # TODO: integrate tor man page output when stem supports that + + conf_options = self.controller.get_info('config/names', None) + + if conf_options: + conf_entries = [opt.split(' ', 1)[0] for opt in conf_options.split('\n')] + + # displays two columns of 42 characters + + for i in range(0, len(conf_entries), 2): + line_entries = conf_entries[i:i + 2] + + line_content = '' + + for entry in line_entries: + line_content += '%-42s' % entry + + output += format(line_content + '\n', *OUTPUT_FORMAT) + + output += format("For more information use '/help [CONFIG OPTION]'.", *BOLD_OUTPUT_FORMAT) + elif arg == 'SIGNAL': + # lists descriptions for all of the signals + + for signal, description in SIGNAL_DESCRIPTIONS: + output += format('%-15s' % signal, *BOLD_OUTPUT_FORMAT) + output += format(' - %s\n' % description, *OUTPUT_FORMAT) + elif arg == 'SETEVENTS': + # lists all of the event types + + event_options = self.controller.get_info('events/names', None) + + if event_options: + event_entries = event_options.split() + + # displays four columns of 20 characters + + for i in range(0, len(event_entries), 4): + line_entries = event_entries[i:i + 4] + + line_content = '' + + for entry in line_entries: + line_content += '%-20s' % entry + + output += format(line_content + '\n', *OUTPUT_FORMAT) + elif arg == 'USEFEATURE': + # lists the feature options + + feature_options = self.controller.get_info('features/names', None) + + if feature_options: + output += format(feature_options + '\n', *OUTPUT_FORMAT) + elif arg in ('LOADCONF', 'POSTDESCRIPTOR'): + # gives a warning that this option isn't yet implemented + output += format('\n' + MULTILINE_UNIMPLEMENTED_NOTICE + '\n', *ERROR_FORMAT) + else: + output += format("No help information available for '%s'..." % arg, *ERROR_FORMAT) + + return output + + def run_command(self, command): + """ + Runs the given command. Requests starting with a '/' are special commands + to the interpretor, and anything else is sent to the control port. + + :param stem.control.Controller controller: tor control connection + :param str command: command to be processed + + :returns: **list** out output lines, each line being a list of + (msg, format) tuples + + :raises: **stem.SocketClosed** if the control connection has been severed + """ + + if not self.controller.is_alive(): + raise stem.SocketClosed() + + command = command.strip() + + # Commands fall into three categories: + # + # * Interpretor commands. These start with a '/'. + # + # * Controller commands stem knows how to handle. We use our Controller's + # methods for these to take advantage of caching and present nicer + # output. + # + # * Other tor commands. We pass these directly on to the control port. + + if ' ' in command: + cmd, arg = command.split(' ', 1) + else: + cmd, arg = command, '' + + output = '' + + if cmd.startswith('/'): + if cmd == "/quit": + raise stem.SocketClosed() + elif cmd == "/help": + output = self.do_help(arg) + else: + output = format("'%s' isn't a recognized command" % command, *ERROR_FORMAT) + + output += '\n' # give ourselves an extra line before the next prompt + else: + cmd = cmd.upper() # makes commands uppercase to match the spec + + if cmd == 'GETINFO': + try: + response = self.controller.get_info(arg.split()) + output = format('\n'.join(response.values()), *OUTPUT_FORMAT) + except stem.ControllerError as exc: + output = format(str(exc), *ERROR_FORMAT) + elif cmd in ('SETCONF', 'RESETCONF'): + # arguments can either be '<param>', '<param>=<value>', or + # '<param>="<value>"' entries + + param_list = [] + + while arg: + # TODO: I'm a little dubious of this for LineList values (like the + # ExitPolicy) since they're parsed as a single value. However, tor + # seems to be happy to get a single comma separated string (though it + # echos back faithfully rather than being parsed) so leaving this + # alone for now. + + quoted_match = re.match(r'^(\S+)=\"([^"]+)\"', arg) + nonquoted_match = re.match(r'^(\S+)=(\S+)', arg) + + if quoted_match: + # we're dealing with a '<param>="<value>"' entry + param, value = quoted_match.groups() + + param_list.append((param, value)) + arg = arg[len(param) + len(value) + 3:].strip() + elif nonquoted_match: + # we're dealing with a '<param>=<value>' entry + param, value = nonquoted_match.groups() + + param_list.append((param, value)) + arg = arg[len(param) + len(value) + 1:].strip() + else: + # starts with just a param + param = arg.split()[0] + param_list.append((param, None)) + arg = arg[len(param):].strip() + + try: + is_reset = cmd == 'RESETCONF' + self.controller.set_options(param_list, is_reset) + except stem.ControllerError as exc: + output = format(str(exc), *ERROR_FORMAT) + elif cmd == 'SETEVENTS': + pass # TODO: implement + elif cmd.replace('+', '') in ('LOADCONF', 'POSTDESCRIPTOR'): + # provides a notice that multi-line controller input isn't yet implemented + output = format(MULTILINE_UNIMPLEMENTED_NOTICE, *ERROR_FORMAT) + else: + try: + response = self.controller.msg(command) + + if cmd == 'QUIT': + raise stem.SocketClosed() + + output = format(str(response), *OUTPUT_FORMAT) + except stem.ControllerError as exc: + if isinstance(exc, stem.SocketClosed): + raise exc + else: + output = format(str(exc), *ERROR_FORMAT) + + return output diff --git a/stem/response/__init__.py b/stem/response/__init__.py index 39e39cb..31f96e3 100644 --- a/stem/response/__init__.py +++ b/stem/response/__init__.py @@ -12,6 +12,7 @@ Parses replies from the control socket. ControlMessage - Message that's read from the control socket. |- from_str - provides a ControlMessage for the given string + |- is_ok - response had a 250 status |- content - provides the parsed message content |- raw_content - unparsed socket data |- __str__ - content stripped of protocol formatting

1 0

[stem/master] Handling EOF responses when awaiting input
by atagar＠torproject.org 06 May '14

06 May '14

commit 9d933b1717abbc5f52f74e640bcb9beabf43ec06 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Apr 7 10:16:08 2014 -0700 Handling EOF responses when awaiting input Handling for ctrl+d on the prompt. --- stem/interpretor/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stem/interpretor/__init__.py b/stem/interpretor/__init__.py index 72fba90..9d08676 100644 --- a/stem/interpretor/__init__.py +++ b/stem/interpretor/__init__.py @@ -62,6 +62,6 @@ def main(): try: user_input = raw_input(PROMPT) print controller.msg(user_input) - except KeyboardInterrupt as exc: + except (KeyboardInterrupt, EOFError) as exc: print # move cursor to the following line break

1 0

[stem/master] Invalid event types caused add_event_listener() error
by atagar＠torproject.org 06 May '14

06 May '14

commit 0d357a9d6687afedbe9ad7509ced1797d1129cdf Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Apr 15 09:45:45 2014 -0700 Invalid event types caused add_event_listener() error When presented with invalid or unrecognized event types our add_event_listener() is documented as raising a ProtocolError. However, it caused a KeyError instead... >>> SETEVENTS BW,DEBUG Traceback (most recent call last): File "./prompt", line 8, in <module> stem.interpretor.main() File "/home/atagar/Desktop/stem/stem/interpretor/__init__.py", line 67, in main print interpretor.run_command(user_input) File "/home/atagar/Desktop/stem/stem/interpretor/commands.py", line 449, in run_command self.controller.add_event_listener(self.register_event, *events) File "/home/atagar/Desktop/stem/stem/control.py", line 1920, in add_event_listener event_version = stem.response.events.EVENT_TYPE_TO_CLASS[event_type]._VERSION_ADDED KeyError: 'BW,DEBUG' Skipping the version check if we don't have a class for the event type. This both fixes invalid events, and also allows us to proper new event types that Stem doesn't recognize yet. >>> SETEVENTS BW,DEBUG SETEVENTS rejected BW,DEBUG --- stem/control.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/stem/control.py b/stem/control.py index 6630762..3064e81 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1917,10 +1917,10 @@ class Controller(BaseController): with self._event_listeners_lock: if self.is_authenticated(): for event_type in events: - event_version = stem.response.events.EVENT_TYPE_TO_CLASS[event_type]._VERSION_ADDED + event_type = stem.response.events.EVENT_TYPE_TO_CLASS.get(event_type) - if self.get_version() < event_version: - raise stem.InvalidRequest(552, "%s event requires Tor version %s or later" % (event_type, event_version)) + if event_type and (self.get_version() < event_type._VERSION_ADDED): + raise stem.InvalidRequest(552, "%s event requires Tor version %s or later" % (event_type, event_type._VERSION_ADDED)) for event_type in events: self._event_listeners.setdefault(event_type, []).append(listener)

1 0

[stem/master] Moving bulk of help output to config
by atagar＠torproject.org 06 May '14

06 May '14

commit 523d5075496a5787e8bb814ed593c6699a50e929 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 13 12:37:07 2014 -0700 Moving bulk of help output to config Moving most of the help descriptions to a configuration file rather than bundling it with the source. There's still some more bits I plan to move, but this gets the largest parts. --- stem/interpretor/commands.py | 221 ++++++++++++----------------------------- stem/interpretor/settings.cfg | 148 +++++++++++++++++++++++++++ 2 files changed, 214 insertions(+), 155 deletions(-) diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py index b326cc0..af1948c 100644 --- a/stem/interpretor/commands.py +++ b/stem/interpretor/commands.py @@ -2,9 +2,12 @@ Handles making requests and formatting the responses. """ +import os import re import stem +import stem.util.conf +import stem.util.log from stem.util.term import Attr, Color, format @@ -32,76 +35,6 @@ TOR_CONTROLLER_COMMANDS = [ 'DROPGUARDS', ] -MULTILINE_UNIMPLEMENTED_NOTICE = "Multi-line control options like this are not yet implemented." - -GENERAL_HELP = """Interpretor commands include: - /help - provides information for interpretor and tor commands/config options - /quit - shuts down the interpretor - -Tor commands include: - GETINFO - queries information from tor - GETCONF, SETCONF, RESETCONF - show or edit a configuration option - SIGNAL - issues control signal to the process (for resetting, stopping, etc) - SETEVENTS - configures the events tor will notify us of - - USEFEATURE - enables custom behavior for the controller - SAVECONF - writes tor's current configuration to our torrc - LOADCONF - loads the given input like it was part of our torrc - MAPADDRESS - replaces requests for one address with another - POSTDESCRIPTOR - adds a relay descriptor to our cache - EXTENDCIRCUIT - create or extend a tor circuit - SETCIRCUITPURPOSE - configures the purpose associated with a circuit - CLOSECIRCUIT - closes the given circuit - ATTACHSTREAM - associates an application's stream with a tor circuit - REDIRECTSTREAM - sets a stream's destination - CLOSESTREAM - closes the given stream - RESOLVE - issues an asynchronous dns or rdns request over tor - TAKEOWNERSHIP - instructs tor to quit when this control connection is closed - PROTOCOLINFO - queries version and controller authentication information - QUIT - disconnect the control connection - -For more information use '/help [OPTION]'.""" - -HELP_HELP = """Provides usage information for the given interpretor, tor command, or tor -configuration option. - -Example: - /help GETINFO # usage information for tor's GETINFO controller option -""" - -HELP_QUIT = """Terminates the interpretor.""" - -HELP_GETINFO = """Queries the tor process for information. Options are... -""" - -HELP_GETCONF = """Provides the current value for a given configuration value. Options include... -""" - -HELP_SETCONF = """Sets the given configuration parameters. Values can be quoted or non-quoted -strings, and reverts the option to 0 or NULL if not provided. - -Examples: - * Sets a contact address and resets our family to NULL - SETCONF MyFamily ContactInfo=foo(a)bar.com - - * Sets an exit policy that only includes port 80/443 - SETCONF ExitPolicy=\"accept *:80, accept *:443, reject *:*\"\ -""" - -HELP_RESETCONF = """Reverts the given configuration options to their default values. If a value -is provided then this behaves in the same way as SETCONF. - -Examples: - * Returns both of our accounting parameters to their defaults - RESETCONF AccountingMax AccountingStart - - * Uses the default exit policy and sets our nickname to be 'Goomba' - RESETCONF ExitPolicy Nickname=Goomba""" - -HELP_SIGNAL = """Issues a signal that tells the tor process to reload its torrc, dump its -stats, halt, etc. -""" - SIGNAL_DESCRIPTIONS = ( ("RELOAD / HUP", "reload our torrc"), ("SHUTDOWN / INT", "gracefully shut down, waiting 30 seconds if we're a relay"), @@ -112,92 +45,49 @@ SIGNAL_DESCRIPTIONS = ( ("NEWNYM", "clears the DNS cache and uses new circuits for future connections") ) -HELP_SETEVENTS = """Sets the events that we will receive. This turns off any events that aren't -listed so sending 'SETEVENTS' without any values will turn off all event reporting. - -For Tor versions between 0.1.1.9 and 0.2.2.1 adding 'EXTENDED' causes some -events to give us additional information. After version 0.2.2.1 this is -always on. - -Events include... - -""" - -HELP_USEFEATURE = """Customizes the behavior of the control port. Options include... -""" - -HELP_SAVECONF = """Writes Tor's current configuration to its torrc.""" - -HELP_LOADCONF = """Reads the given text like it belonged to our torrc. - -Example: - +LOADCONF - # sets our exit policy to just accept ports 80 and 443 - ExitPolicy accept *:80 - ExitPolicy accept *:443 - ExitPolicy reject *:* - .""" - -HELP_MAPADDRESS = """Replaces future requests for one address with another. - -Example: - MAPADDRESS 0.0.0.0=torproject.org 1.2.3.4=tor.freehaven.net""" - -HELP_POSTDESCRIPTOR = """Simulates getting a new relay descriptor.""" - -HELP_EXTENDCIRCUIT = """Extends the given circuit or create a new one if the CircuitID is zero. The -PATH is a comma separated list of fingerprints. If it isn't set then this -uses Tor's normal path selection.""" - -HELP_SETCIRCUITPURPOSE = """Sets the purpose attribute for a circuit.""" - -HELP_CLOSECIRCUIT = """Closes the given circuit. If "IfUnused" is included then this only closes -the circuit if it isn't currently being used.""" - -HELP_ATTACHSTREAM = """Attaches a stream with the given built circuit (tor picks one on its own if -CircuitID is zero). If HopNum is given then this hop is used to exit the -circuit, otherwise the last relay is used.""" +HELP_OPTIONS = { + 'HELP': ("/help [OPTION]", 'help.help'), + 'QUIT': ("/quit", 'help.quit'), + 'GETINFO': ("GETINFO OPTION", 'help.getinfo'), + 'GETCONF': ("GETCONF OPTION", 'help.getconf'), + 'SETCONF': ("SETCONF PARAM[=VALUE]", 'help.setconf'), + 'RESETCONF': ("RESETCONF PARAM[=VALUE]", 'help.resetconf'), + 'SIGNAL': ("SIGNAL SIG", 'help.signal'), + 'SETEVENTS': ("SETEVENTS [EXTENDED] [EVENTS]", 'help.setevents'), + 'USEFEATURE': ("USEFEATURE OPTION", 'help.usefeature'), + 'SAVECONF': ("SAVECONF", 'help.saveconf'), + 'LOADCONF': ("LOADCONF...", 'help.loadconf'), + 'MAPADDRESS': ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", 'help.mapaddress'), + 'POSTDESCRIPTOR': ("POSTDESCRIPTOR [purpose=general/controller/bridge] [cache=yes/no]...", 'help.postdescriptor'), + 'EXTENDCIRCUIT': ("EXTENDCIRCUIT CircuitID [PATH] [purpose=general/controller]", 'help.extendcircuit'), + 'SETCIRCUITPURPOSE': ("SETCIRCUITPURPOSE CircuitID purpose=general/controller", 'help.setcircuitpurpose'), + 'CLOSECIRCUIT': ("CLOSECIRCUIT CircuitID [IfUnused]", 'help.closecircuit'), + 'ATTACHSTREAM': ("ATTACHSTREAM StreamID CircuitID [HOP=HopNum]", 'help.attachstream'), + 'REDIRECTSTREAM': ("REDIRECTSTREAM StreamID Address [Port]", 'help.redirectstream'), + 'CLOSESTREAM': ("CLOSESTREAM StreamID Reason [Flag]", 'help.closestream'), + 'RESOLVE': ("RESOLVE [mode=reverse] address", 'help.resolve'), + 'TAKEOWNERSHIP': ("TAKEOWNERSHIP", 'help.takeownership'), + 'PROTOCOLINFO': ("PROTOCOLINFO [ProtocolVersion]", 'help.protocolinfo'), +} -HELP_REDIRECTSTREAM = """Sets the destination for a given stream. This can only be done after a -stream is created but before it's attached to a circuit.""" -HELP_CLOSESTREAM = """Closes the given stream, the reason being an integer matching a reason as -per section 6.3 of the tor-spec.""" +def uses_settings(func): + """ + Loads our interpretor's internal settings. This should be treated as a fatal + failure if unsuccessful. -HELP_RESOLVE = """Performs IPv4 DNS resolution over tor, doing a reverse lookup instead if -"mode=reverse" is included. This request is processed in the background and -results in a ADDRMAP event with the response.""" + :raises: **IOError** if we're unable to read or parse our internal + configurations + """ -HELP_TAKEOWNERSHIP = """Instructs Tor to gracefully shut down when this control connection is closed.""" + config = stem.util.conf.get_config('stem_interpretor') -HELP_PROTOCOLINFO = """Provides bootstrapping information that a controller might need when first -starting, like Tor's version and controller authentication. This can be done -before authenticating to the control port.""" + if not config.get('settings_loaded', False): + settings_path = os.path.join(os.path.dirname(__file__), 'settings.cfg') + config.load(settings_path) + config.set('settings_loaded', 'true') -HELP_OPTIONS = { - "HELP": ("/help [OPTION]", HELP_HELP), - "QUIT": ("/quit", HELP_QUIT), - "GETINFO": ("GETINFO OPTION", HELP_GETINFO), - "GETCONF": ("GETCONF OPTION", HELP_GETCONF), - "SETCONF": ("SETCONF PARAM[=VALUE]", HELP_SETCONF), - "RESETCONF": ("RESETCONF PARAM[=VALUE]", HELP_RESETCONF), - "SIGNAL": ("SIGNAL SIG", HELP_SIGNAL), - "SETEVENTS": ("SETEVENTS [EXTENDED] [EVENTS]", HELP_SETEVENTS), - "USEFEATURE": ("USEFEATURE OPTION", HELP_USEFEATURE), - "SAVECONF": ("SAVECONF", HELP_SAVECONF), - "LOADCONF": ("LOADCONF...", HELP_LOADCONF), - "MAPADDRESS": ("MAPADDRESS SOURCE_ADDR=DESTINATION_ADDR", HELP_MAPADDRESS), - "POSTDESCRIPTOR": ("POSTDESCRIPTOR [purpose=general/controller/bridge] [cache=yes/no]...", HELP_POSTDESCRIPTOR), - "EXTENDCIRCUIT": ("EXTENDCIRCUIT CircuitID [PATH] [purpose=general/controller]", HELP_EXTENDCIRCUIT), - "SETCIRCUITPURPOSE": ("SETCIRCUITPURPOSE CircuitID purpose=general/controller", HELP_SETCIRCUITPURPOSE), - "CLOSECIRCUIT": ("CLOSECIRCUIT CircuitID [IfUnused]", HELP_CLOSECIRCUIT), - "ATTACHSTREAM": ("ATTACHSTREAM StreamID CircuitID [HOP=HopNum]", HELP_ATTACHSTREAM), - "REDIRECTSTREAM": ("REDIRECTSTREAM StreamID Address [Port]", HELP_REDIRECTSTREAM), - "CLOSESTREAM": ("CLOSESTREAM StreamID Reason [Flag]", HELP_CLOSESTREAM), - "RESOLVE": ("RESOLVE [mode=reverse] address", HELP_RESOLVE), - "TAKEOWNERSHIP": ("TAKEOWNERSHIP", HELP_TAKEOWNERSHIP), - "PROTOCOLINFO": ("PROTOCOLINFO [ProtocolVersion]", HELP_PROTOCOLINFO), -} + return func def _get_commands(controller): @@ -329,9 +219,9 @@ class ControlInterpretor(object): output = '' if not arg: - # provides the GENERAL_HELP with everything bolded except descriptions + # provides the general help with everything bolded except descriptions - for line in GENERAL_HELP.splitlines(): + for line in msg('help.general').splitlines(): cmd_start = line.find(' - ') if cmd_start != -1: @@ -343,7 +233,8 @@ class ControlInterpretor(object): # Provides information for the tor or interpretor argument. This bolds # the usage information and indents the description after it. - usage, description = HELP_OPTIONS[arg] + usage, attr = HELP_OPTIONS[arg] + description = msg(attr) output = format(usage + '\n', *BOLD_OUTPUT_FORMAT) @@ -420,7 +311,7 @@ class ControlInterpretor(object): output += format(feature_options + '\n', *OUTPUT_FORMAT) elif arg in ('LOADCONF', 'POSTDESCRIPTOR'): # gives a warning that this option isn't yet implemented - output += format('\n' + MULTILINE_UNIMPLEMENTED_NOTICE + '\n', *ERROR_FORMAT) + output += format('\n' + msg('msg.multiline_unimplemented_notice') + '\n', *ERROR_FORMAT) else: output += format("No help information available for '%s'..." % arg, *ERROR_FORMAT) @@ -523,7 +414,7 @@ class ControlInterpretor(object): pass # TODO: implement elif cmd.replace('+', '') in ('LOADCONF', 'POSTDESCRIPTOR'): # provides a notice that multi-line controller input isn't yet implemented - output = format(MULTILINE_UNIMPLEMENTED_NOTICE, *ERROR_FORMAT) + output = format(msg('msg.multiline_unimplemented_notice'), *ERROR_FORMAT) else: try: response = self.controller.msg(command) @@ -539,3 +430,23 @@ class ControlInterpretor(object): output = format(str(exc), *ERROR_FORMAT) return output + + +@uses_settings +def msg(message, **attr): + """ + Provides the given message. + + :param str message: message handle + :param dict attr: attributes to format the message with + + :returns: **str** that was requested + """ + + config = stem.util.conf.get_config('stem_interpretor') + + try: + return config.get(message).format(**attr) + except: + stem.util.log.notice('BUG: We attempted to use an undefined string resource (%s)' % message) + return '' diff --git a/stem/interpretor/settings.cfg b/stem/interpretor/settings.cfg new file mode 100644 index 0000000..9cd2201 --- /dev/null +++ b/stem/interpretor/settings.cfg @@ -0,0 +1,148 @@ +################################################################################ +# +# Configuration data used by Stem's interpretor prompt. +# +################################################################################ + +msg.multiline_unimplemented_notice Multi-line control options like this are not yet implemented. + +help.quit Terminates the interpretor. +help.saveconf Writes Tor's current configuration to its torrc. +help.postdescriptor Simulates getting a new relay descriptor. +help.setcircuitpurpose Sets the purpose attribute for a circuit. +help.takeownership Instructs Tor to gracefully shut down when this control connection is closed. + +help.general +|Interpretor commands include: +| /help - provides information for interpretor and tor commands/config options +| /quit - shuts down the interpretor +| +|Tor commands include: +| GETINFO - queries information from tor +| GETCONF, SETCONF, RESETCONF - show or edit a configuration option +| SIGNAL - issues control signal to the process (for resetting, stopping, etc) +| SETEVENTS - configures the events tor will notify us of +| +| USEFEATURE - enables custom behavior for the controller +| SAVECONF - writes tor's current configuration to our torrc +| LOADCONF - loads the given input like it was part of our torrc +| MAPADDRESS - replaces requests for one address with another +| POSTDESCRIPTOR - adds a relay descriptor to our cache +| EXTENDCIRCUIT - create or extend a tor circuit +| SETCIRCUITPURPOSE - configures the purpose associated with a circuit +| CLOSECIRCUIT - closes the given circuit +| ATTACHSTREAM - associates an application's stream with a tor circuit +| REDIRECTSTREAM - sets a stream's destination +| CLOSESTREAM - closes the given stream +| RESOLVE - issues an asynchronous dns or rdns request over tor +| TAKEOWNERSHIP - instructs tor to quit when this control connection is closed +| PROTOCOLINFO - queries version and controller authentication information +| QUIT - disconnect the control connection +| +|For more information use '/help [OPTION]'. + +help.help +|Provides usage information for the given interpretor, tor command, or tor +|configuration option. +| +|Example: +| /help GETINFO # usage information for tor's GETINFO controller option + +help.getinfo +|Queries the tor process for information. Options are... +| + +help.getconf +|Provides the current value for a given configuration value. Options include... +| + +help.setconf +|Sets the given configuration parameters. Values can be quoted or non-quoted +|strings, and reverts the option to 0 or NULL if not provided. +| +|Examples: +| * Sets a contact address and resets our family to NULL +| SETCONF MyFamily ContactInfo=foo(a)bar.com +| +| * Sets an exit policy that only includes port 80/443 +| SETCONF ExitPolicy=\"accept *:80, accept *:443, reject *:*\"\ + +help.resetconf +|Reverts the given configuration options to their default values. If a value +|is provided then this behaves in the same way as SETCONF. +| +|Examples: +| * Returns both of our accounting parameters to their defaults +| RESETCONF AccountingMax AccountingStart +| +| * Uses the default exit policy and sets our nickname to be 'Goomba' +| RESETCONF ExitPolicy Nickname=Goomba + +help.signal +|Issues a signal that tells the tor process to reload its torrc, dump its +|stats, halt, etc. + +help.setevents +|Sets the events that we will receive. This turns off any events that aren't +|listed so sending 'SETEVENTS' without any values will turn off all event reporting. +| +|For Tor versions between 0.1.1.9 and 0.2.2.1 adding 'EXTENDED' causes some +|events to give us additional information. After version 0.2.2.1 this is +|always on. +| +|Events include... +| + +help.usefeature +|Customizes the behavior of the control port. Options include... +| + +help.loadconf +|Reads the given text like it belonged to our torrc. +| +|Example: +| +LOADCONF +| # sets our exit policy to just accept ports 80 and 443 +| ExitPolicy accept *:80 +| ExitPolicy accept *:443 +| ExitPolicy reject *:* +| . + +help.mapaddress +|Replaces future requests for one address with another. +| +|Example: +| MAPADDRESS 0.0.0.0=torproject.org 1.2.3.4=tor.freehaven.net + +help.extendcircuit +|Extends the given circuit or create a new one if the CircuitID is zero. The +|PATH is a comma separated list of fingerprints. If it isn't set then this +|uses Tor's normal path selection. + +help.closecircuit +|Closes the given circuit. If "IfUnused" is included then this only closes +|the circuit if it isn't currently being used. + +help.attachstream +|Attaches a stream with the given built circuit (tor picks one on its own if +|CircuitID is zero). If HopNum is given then this hop is used to exit the +|circuit, otherwise the last relay is used. + +help.redirectstream +|Sets the destination for a given stream. This can only be done after a +|stream is created but before it's attached to a circuit. + +help.closestream +|Closes the given stream, the reason being an integer matching a reason as +|per section 6.3 of the tor-spec. + +help.resolve +|Performs IPv4 DNS resolution over tor, doing a reverse lookup instead if +|"mode=reverse" is included. This request is processed in the background and +|results in a ADDRMAP event with the response. + +help.protocolinfo +|Provides bootstrapping information that a controller might need when first +|starting, like Tor's version and controller authentication. This can be done +|before authenticating to the control port. +

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits May 2014