- tor-commits - lists.torproject.org

[arm/release] Interpretor panel for raw control port access
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 0016b2be0fac62ae840a1259ee65269defa3654c Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Aug 24 10:07:24 2011 -0700 Interpretor panel for raw control port access This adds a new page to the interface, providing an interactive interpretor that lets the user send/receive control commands. This includes history search and will be expanded to have other usability features (tab completion, search, etc). --- README | 1 + src/cli/__init__.py | 2 +- src/cli/controller.py | 3 + src/cli/interpretorPanel.py | 232 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 237 insertions(+), 1 deletions(-) diff --git a/README b/README index 16d0965..cbaf2f7 100644 --- a/README +++ b/README @@ -193,6 +193,7 @@ Layout: logPanel.py - (page 1) displays tor, arm, and torctl events configPanel.py - (page 3) editor panel for the tor configuration torrcPanel.py - (page 4) displays torrc and validation + interpretorPanel.py - (page 5) interpretor for control port access util/ __init__.py diff --git a/src/cli/__init__.py b/src/cli/__init__.py index b0d6bd8..fa23640 100644 --- a/src/cli/__init__.py +++ b/src/cli/__init__.py @@ -2,5 +2,5 @@ Panels, popups, and handlers comprising the arm user interface. """ -__all__ = ["configPanel", "controller", "headerPanel", "logPanel", "popups", "torrcPanel", "wizard"] +__all__ = ["configPanel", "controller", "headerPanel", "interpretorPanel", "logPanel", "popups", "torrcPanel", "wizard"] diff --git a/src/cli/controller.py b/src/cli/controller.py index d2194ca..bc69e79 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -15,6 +15,7 @@ import cli.headerPanel import cli.logPanel import cli.configPanel import cli.torrcPanel +import cli.interpretorPanel import cli.graphing.graphPanel import cli.graphing.bandwidthStats import cli.graphing.connStats @@ -97,6 +98,8 @@ def initController(stdscr, startTime): if CONFIG["features.panels.show.torrc"]: pagePanels.append([cli.torrcPanel.TorrcPanel(stdscr, cli.torrcPanel.Config.TORRC, config)]) + pagePanels.append([cli.interpretorPanel.InterpretorPanel(stdscr)]) + # initializes the controller ARM_CONTROLLER = Controller(stdscr, stickyPanels, pagePanels) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py new file mode 100644 index 0000000..b7c3fe0 --- /dev/null +++ b/src/cli/interpretorPanel.py @@ -0,0 +1,232 @@ +""" +Panel providing raw control port access with syntax hilighting, usage +information, tab completion, and other usability features. +""" + +import curses + +from util import enum, panel, textInput, torTools, uiTools + +from TorCtl import TorCtl + +Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") + +PROMPT = ">>> " +USAGE_INFO = "to use this panel press enter" + +# limits used for cropping +COMMAND_BACKLOG = 100 +LINES_BACKLOG = 2000 + +class InterpretorPanel(panel.Panel): + def __init__(self, stdscr): + panel.Panel.__init__(self, stdscr, "interpretor", 0) + self.isInputMode = False + self.scroll = 0 + self.formats = {} # lazy loaded curses formatting constants + self.previousCommands = [] # user input, newest to oldest + + # contents of the panel (oldest to newest), each line is a list of (msg, + # format enum) tuples + + self.contents = [[(PROMPT, Formats.PROMPT), (USAGE_INFO, Formats.USAGE)]] + + def prompt(self): + """ + Enables the interpretor, prompting for input until the user enters esc or + a blank line. + """ + + if not self.formats: self._initFormats() + self.isInputMode = True + + panel.CURSES_LOCK.acquire() + + while self.isInputMode: + self.redraw(True) + + # intercepts input so user can cycle through the history + validator = textInput.BasicValidator() + validator = textInput.HistoryValidator(self.previousCommands, validator) + + xOffset = len(PROMPT) + if len(self.contents) > self.maxY - 1: + xOffset += 3 # offset for scrollbar + + input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[Formats.INPUT], validator = validator) + + isDone = self.handleQuery(input) + + if isDone: + self.isInputMode = False + self.redraw(True) + + panel.CURSES_LOCK.release() + + def handleQuery(self, input): + """ + Processes the given input. Requests starting with a '/' are special + commands to the interpretor, and anything else is sent to the control port. + This returns a boolean to indicate if the interpretor should terminate or + not. + + Arguments: + input - user input to be processed + """ + + if not input or not input.strip(): return True + input = input.strip() + inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] + conn = torTools.getConn() + + # input falls into three general categories: + # - interpretor command which starts with a '/' + # - controller commands handled by torTools (this allows for caching, + # proper handling by the rest of arm, etc) + # - unrecognized controller command, this has the possability of confusing + # arm... + + if input.startswith("/"): + # interpretor command + inputEntry.append((input, Formats.INPUT_INTERPRETOR)) + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + + # TODO: add /help option + # TODO: add /write option + else: + # controller command + if " " in input: cmd, arg = input.split(" ", 1) + else: cmd, arg = input, "" + + inputEntry.append((cmd + " ", Formats.INPUT_CMD)) + if arg: inputEntry.append((arg, Formats.INPUT_ARG)) + + if cmd.upper() == "GETINFO": + try: + response = conn.getInfo(arg, suppressExc = False) + outputEntry.append((response, Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + elif cmd.upper() == "SETCONF": + if "=" in arg: + param, value = arg.split("=", 1) + + try: + conn.setOption(param.strip(), value.strip()) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + else: + # TODO: resets the attribute + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + else: + try: + response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + + for entry in response: + # Response entries are tuples with the response code, body, and + # extra info. For instance: + # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) + + if len(entry) == 3: + outputEntry.append((entry[1], Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + + self.previousCommands.insert(0, input) + self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] + + promptEntry = self.contents.pop() # removes old prompt entry + self.contents += _splitOnNewlines(inputEntry) + self.contents += _splitOnNewlines(outputEntry) + self.contents.append(promptEntry) + + # if too long then crop lines + cropLines = len(self.contents) - LINES_BACKLOG + if cropLines > 0: self.contents = self.contents[cropLines:] + + return False + + def handleKey(self, key): + # TODO: allow contents to be searched (with hilighting?) + + isKeystrokeConsumed = True + if uiTools.isSelectionKey(key): + self.prompt() + elif uiTools.isScrollKey(key) and not self.isInputMode: + pageHeight = self.getPreferredSize()[0] - 1 + newScroll = uiTools.getScrollPosition(key, self.scroll, pageHeight, len(self.contents)) + + if self.scroll != newScroll: + self.scroll = newScroll + self.redraw(True) + else: isKeystrokeConsumed = False + + return isKeystrokeConsumed + + def draw(self, width, height): + if not self.formats: self._initFormats() + + # page title + usageMsg = " (enter \"/help\" for usage or a blank line to stop)" if self.isInputMode else "" + self.addstr(0, 0, "Control Interpretor%s:" % usageMsg, curses.A_STANDOUT) + + xOffset = 0 + if len(self.contents) > height - 1: + # if we're in input mode then make sure the last line is visible + if self.isInputMode: + self.scroll = len(self.contents) - height + 1 + + xOffset = 3 + self.addScrollBar(self.scroll, self.scroll + height - 1, len(self.contents), 1) + + # draws prior commands and output + drawLine = 1 + for entry in self.contents[self.scroll:]: + cursor = xOffset + + for msg, formatEntry in entry: + format = self.formats.get(formatEntry, curses.A_NORMAL) + self.addstr(drawLine, cursor, msg, format) + cursor += len(msg) + + drawLine += 1 + if drawLine >= height: break + + def _initFormats(self): + self.formats[Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") + self.formats[Formats.INPUT] = uiTools.getColor("cyan") + self.formats[Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") + self.formats[Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") + self.formats[Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") + self.formats[Formats.OUTPUT] = uiTools.getColor("blue") + self.formats[Formats.USAGE] = uiTools.getColor("cyan") + self.formats[Formats.HELP] = uiTools.getColor("magenta") + self.formats[Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") + +def _splitOnNewlines(entry): + """ + Splits a list of (msg, format) tuples on newlines into a list of lines. + + Arguments: + entry - list of display tuples + """ + + results, tmpLine = [], [] + entry = list(entry) # shallow copy + + while entry: + msg, format = entry.pop(0) + + if "\n" in msg: + msg, remainder = msg.split("\n", 1) + entry.insert(0, (remainder, format)) + + tmpLine.append((msg, format)) + results.append(tmpLine) + tmpLine = [] + else: + tmpLine.append((msg, format)) + + if tmpLine: results.append(tmpLine) + return results +

1 0

[arm/release] fix: preventing prompt launch without tor instance
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 1bdc11a0df6b35530b1dfa5a5c033cbcd88a4845 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 26 07:54:56 2011 -0700 fix: preventing prompt launch without tor instance It doesn't really make sense to allow the control prompt to launch when we're unable to connect to tor. --- src/starter.py | 4 ++++ 1 files changed, 4 insertions(+), 0 deletions(-) diff --git a/src/starter.py b/src/starter.py index 5b86c10..ff2f4a8 100644 --- a/src/starter.py +++ b/src/starter.py @@ -386,6 +386,10 @@ if __name__ == '__main__': msg = STANDARD_CFG_NOT_FOUND_MSG % configPath util.log.log(util.log.NOTICE, msg) + # when launching a prompt it doens't make sense to be without a tor instance + if launchPrompt: + config.set("features.allowDetachedStartup", "false") + # revises defaults to match user's configuration config.update(CONFIG)

1 0

[arm/release] Option to just start the control interpretor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 3e1a13538a4afa9ef2d66367b21e6d13ab7bc528 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 25 18:19:28 2011 -0700 Option to just start the control interpretor The control interpretor can be ran in either a curses panel or terminal prompt so giving an arm startup option for the later. --- src/starter.py | 12 +++++++++--- 1 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/starter.py b/src/starter.py index 2a81cd2..5b86c10 100644 --- a/src/starter.py +++ b/src/starter.py @@ -25,6 +25,7 @@ import util.panel import util.procTools import util.sysTools import util.torConfig +import util.torInterpretor import util.torTools import util.uiTools import TorCtl.TorCtl @@ -53,13 +54,14 @@ CONFIG = {"startup.controlPassword": None, "log.configDescriptions.persistance.saveFailed": util.log.NOTICE, "log.savingDebugLog": util.log.NOTICE} -OPT = "gi:s:c:dbe:vh" -OPT_EXPANDED = ["gui", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] +OPT = "gpi:s:c:dbe:vh" +OPT_EXPANDED = ["gui", "prompt", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] HELP_MSG = """Usage arm [OPTION] Terminal status monitor for Tor relays. -g, --gui launch the Gtk+ interface + -p, --prompt only start the control interpretor -i, --interface [ADDRESS:]PORT change control interface from %s:%i -s, --socket SOCKET_PATH attach using unix domain socket if present, SOCKET_PATH defaults to: %s @@ -298,6 +300,7 @@ if __name__ == '__main__': startTime = time.time() param = dict([(key, None) for key in CONFIG.keys()]) launchGui = False + launchPrompt = False isDebugMode = False configPath = DEFAULT_CONFIG # path used for customized configuration @@ -329,6 +332,7 @@ if __name__ == '__main__': elif opt in ("-s", "--socket"): param["startup.interface.socket"] = arg elif opt in ("-g", "--gui"): launchGui = True + elif opt in ("-p", "--prompt"): launchPrompt = True elif opt in ("-c", "--config"): configPath = arg # sets path of user's config elif opt in ("-d", "--debug"): isDebugMode = True # dumps all logs elif opt in ("-b", "--blind"): @@ -486,9 +490,11 @@ if __name__ == '__main__': if util.uiTools.isUnicodeAvailable(): locale.setlocale(locale.LC_ALL, "") - if launchGui == True: + if launchGui: import gui.controller gui.controller.start_gui() + elif launchPrompt: + util.torInterpretor.prompt() else: cli.controller.startTorMonitor(time.time() - initTime)

1 0

[arm/release] fix: adding config option to drop interpretor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit aa73b588dc8df25c2f60e6afcc2702d3b2af7754 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 25 18:26:19 2011 -0700 fix: adding config option to drop interpretor All of the panels can be included/excluded via the user's armrc configuration. Applying that to the interpretor panel too. --- armrc.sample | 1 + src/cli/controller.py | 4 +++- 2 files changed, 4 insertions(+), 1 deletions(-) diff --git a/armrc.sample b/armrc.sample index e19d4c4..8f65fbc 100644 --- a/armrc.sample +++ b/armrc.sample @@ -18,6 +18,7 @@ features.panels.show.log true features.panels.show.connection true features.panels.show.config true features.panels.show.torrc true +features.panels.show.interpretor true # Read the proc contents directly instead of calling ps, netstat, and other # resolvers. This provides very sizable performance benefits (around 90% diff --git a/src/cli/controller.py b/src/cli/controller.py index bc69e79..a0b465c 100644 --- a/src/cli/controller.py +++ b/src/cli/controller.py @@ -37,6 +37,7 @@ CONFIG = {"startup.events": "N3", "features.panels.show.connection": True, "features.panels.show.config": True, "features.panels.show.torrc": True, + "features.panels.show.interpretor": True, "features.redrawRate": 5, "features.refreshRate": 5, "features.confirmQuit": True, @@ -98,7 +99,8 @@ def initController(stdscr, startTime): if CONFIG["features.panels.show.torrc"]: pagePanels.append([cli.torrcPanel.TorrcPanel(stdscr, cli.torrcPanel.Config.TORRC, config)]) - pagePanels.append([cli.interpretorPanel.InterpretorPanel(stdscr)]) + if CONFIG["features.panels.show.interpretor"]: + pagePanels.append([cli.interpretorPanel.InterpretorPanel(stdscr)]) # initializes the controller ARM_CONTROLLER = Controller(stdscr, stickyPanels, pagePanels)

1 0

[arm/release] Tidying up the interpretor panel
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit d8d13f5fe5be8a29732d73d535df963aca34c8d9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Aug 28 14:57:43 2011 -0700 Tidying up the interpretor panel --- src/cli/interpretorPanel.py | 72 +++++++++++++++++++++++------------------- 1 files changed, 39 insertions(+), 33 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index b81fa85..162fd19 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -5,28 +5,48 @@ information, tab completion, and other usability features. import curses -from util import enum, panel, textInput, torInterpretor, torTools, uiTools - -from TorCtl import TorCtl +from util import panel, textInput, torInterpretor, uiTools USAGE_INFO = "to use this panel press enter" +PROMPT_LINE = [(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)] # limits used for cropping -COMMAND_BACKLOG = 100 -LINES_BACKLOG = 2000 +BACKLOG_LIMIT = 100 +LINES_LIMIT = 2000 + +# lazy loaded curses formatting constants +FORMATS = {} + +def getFormat(format): + """ + Provides the curses drawing attributes for a torInterpretor.Formats enum. + This returns plain formatting if the entry doesn't exist. + + Arguments: + format - format enum to fetch + """ + + # initializes formats if they haven't yet been loaded + if not FORMATS: + FORMATS[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") + FORMATS[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") + FORMATS[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") + FORMATS[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") + FORMATS[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") + FORMATS[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") + FORMATS[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") + FORMATS[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") + FORMATS[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") + + return FORMATS.get(format, curses.A_NORMAL) class InterpretorPanel(panel.Panel): def __init__(self, stdscr): panel.Panel.__init__(self, stdscr, "interpretor", 0) self.isInputMode = False self.scroll = 0 - self.formats = {} # lazy loaded curses formatting constants - self.previousCommands = [] # user input, newest to oldest - - # contents of the panel (oldest to newest), each line is a list of (msg, - # format enum) tuples - - self.contents = [[(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)]] + self.previousCommands = [] # user input, newest to oldest + self.contents = [PROMPT_LINE] # (msg, format enum) tuples being displayed (oldest to newest) def prompt(self): """ @@ -34,9 +54,7 @@ class InterpretorPanel(panel.Panel): a blank line. """ - if not self.formats: self._initFormats() self.isInputMode = True - panel.CURSES_LOCK.acquire() while self.isInputMode: @@ -50,14 +68,17 @@ class InterpretorPanel(panel.Panel): if len(self.contents) > self.maxY - 1: xOffset += 3 # offset for scrollbar - input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[torInterpretor.Formats.INPUT], validator = validator) + inputLine = min(self.maxY - 1, len(self.contents)) + inputFormat = getFormat(torInterpretor.Formats.INPUT) + input = self.getstr(inputLine, xOffset, "", inputFormat, validator = validator) input, isDone = input.strip(), False if not input: + # terminate input when we get a blank line isDone = True else: self.previousCommands.insert(0, input) - self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] + self.previousCommands = self.previousCommands[:BACKLOG_LIMIT] try: inputEntry, outputEntry = torInterpretor.handleQuery(input) @@ -70,7 +91,7 @@ class InterpretorPanel(panel.Panel): self.contents.append(promptEntry) # if too long then crop lines - cropLines = len(self.contents) - LINES_BACKLOG + cropLines = len(self.contents) - LINES_LIMIT if cropLines > 0: self.contents = self.contents[cropLines:] if isDone: @@ -80,8 +101,6 @@ class InterpretorPanel(panel.Panel): panel.CURSES_LOCK.release() def handleKey(self, key): - # TODO: allow contents to be searched (with hilighting?) - isKeystrokeConsumed = True if uiTools.isSelectionKey(key): self.prompt() @@ -97,8 +116,6 @@ class InterpretorPanel(panel.Panel): return isKeystrokeConsumed def draw(self, width, height): - if not self.formats: self._initFormats() - # page title usageMsg = " (enter \"/help\" for usage or a blank line to stop)" if self.isInputMode else "" self.addstr(0, 0, "Control Interpretor%s:" % usageMsg, curses.A_STANDOUT) @@ -118,21 +135,10 @@ class InterpretorPanel(panel.Panel): cursor = xOffset for msg, formatEntry in entry: - format = self.formats.get(formatEntry, curses.A_NORMAL) + format = getFormat(formatEntry) self.addstr(drawLine, cursor, msg, format) cursor += len(msg) drawLine += 1 if drawLine >= height: break - def _initFormats(self): - self.formats[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") - self.formats[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") - self.formats[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") - self.formats[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") - self.formats[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") - self.formats[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") - self.formats[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") - self.formats[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") - self.formats[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") -

1 0

[arm/release] fix: prevent startup if can't connect to tor
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit d977dc8d965abf0cb8ebae527222cb48b8ca3cdb Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 26 08:23:56 2011 -0700 fix: prevent startup if can't connect to tor We've had a couple people confused because tor is running without a control port but when they start arm it provides the wizard, saying that tor's shut down. Making detached startup contingent on not having an active tor process to avoid this. --- src/starter.py | 8 ++++++-- src/util/torTools.py | 14 ++++++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/starter.py b/src/starter.py index ff2f4a8..a2617f7 100644 --- a/src/starter.py +++ b/src/starter.py @@ -386,8 +386,12 @@ if __name__ == '__main__': msg = STANDARD_CFG_NOT_FOUND_MSG % configPath util.log.log(util.log.NOTICE, msg) - # when launching a prompt it doens't make sense to be without a tor instance - if launchPrompt: + # prevent arm from starting without a tor instance if... + # - we're launching a prompt + # - tor is running (otherwise it would be kinda confusing, "tor is running + # but why does arm say that it's shut down?") + + if launchPrompt or util.torTools.isTorRunning(): config.set("features.allowDetachedStartup", "false") # revises defaults to match user's configuration diff --git a/src/util/torTools.py b/src/util/torTools.py index 39cb176..5c1b1ad 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -345,6 +345,20 @@ def isVersion(myVersion, minVersion): return True # versions match (should have been caught above...) +def isTorRunning(): + """ + Simple check for if a tor process is running. If this can't be determined + then this returns False. + """ + + # suggestions welcome for making this more reliable + commandResults = sysTools.call("ps co command") + if commandResults: + for cmd in commandResults: + if cmd.strip() == "tor": return True + + return False + def getConn(): """ Singleton constructor for a Controller. Be aware that this starts as being

1 0

[arm/release] Porting basic interpretor functionality to prompt
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit 88bddc5de5d1b7bec947a6780a5874dadd723128 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 26 10:28:15 2011 -0700 Porting basic interpretor functionality to prompt Quick hack so the panel and prompt both share the same interpretor input/response logic. This makes the arm prompt now basically functional though gonna need to do some cleanup. --- src/cli/interpretorPanel.py | 160 +++++++++---------------------------------- src/util/torInterpretor.py | 132 +++++++++++++++++++++++++++++++++++- 2 files changed, 163 insertions(+), 129 deletions(-) diff --git a/src/cli/interpretorPanel.py b/src/cli/interpretorPanel.py index b7c3fe0..b81fa85 100644 --- a/src/cli/interpretorPanel.py +++ b/src/cli/interpretorPanel.py @@ -5,13 +5,10 @@ information, tab completion, and other usability features. import curses -from util import enum, panel, textInput, torTools, uiTools +from util import enum, panel, textInput, torInterpretor, torTools, uiTools from TorCtl import TorCtl -Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") - -PROMPT = ">>> " USAGE_INFO = "to use this panel press enter" # limits used for cropping @@ -29,7 +26,7 @@ class InterpretorPanel(panel.Panel): # contents of the panel (oldest to newest), each line is a list of (msg, # format enum) tuples - self.contents = [[(PROMPT, Formats.PROMPT), (USAGE_INFO, Formats.USAGE)]] + self.contents = [[(torInterpretor.PROMPT, torInterpretor.Formats.PROMPT), (USAGE_INFO, torInterpretor.Formats.USAGE)]] def prompt(self): """ @@ -49,13 +46,32 @@ class InterpretorPanel(panel.Panel): validator = textInput.BasicValidator() validator = textInput.HistoryValidator(self.previousCommands, validator) - xOffset = len(PROMPT) + xOffset = len(torInterpretor.PROMPT) if len(self.contents) > self.maxY - 1: xOffset += 3 # offset for scrollbar - input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[Formats.INPUT], validator = validator) + input = self.getstr(min(self.maxY - 1, len(self.contents)), xOffset, "", self.formats[torInterpretor.Formats.INPUT], validator = validator) + input, isDone = input.strip(), False - isDone = self.handleQuery(input) + if not input: + isDone = True + else: + self.previousCommands.insert(0, input) + self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] + + try: + inputEntry, outputEntry = torInterpretor.handleQuery(input) + except torInterpretor.InterpretorClosed: + isDone = True + + promptEntry = self.contents.pop() # removes old prompt entry + self.contents += inputEntry + self.contents += outputEntry + self.contents.append(promptEntry) + + # if too long then crop lines + cropLines = len(self.contents) - LINES_BACKLOG + if cropLines > 0: self.contents = self.contents[cropLines:] if isDone: self.isInputMode = False @@ -63,89 +79,6 @@ class InterpretorPanel(panel.Panel): panel.CURSES_LOCK.release() - def handleQuery(self, input): - """ - Processes the given input. Requests starting with a '/' are special - commands to the interpretor, and anything else is sent to the control port. - This returns a boolean to indicate if the interpretor should terminate or - not. - - Arguments: - input - user input to be processed - """ - - if not input or not input.strip(): return True - input = input.strip() - inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] - conn = torTools.getConn() - - # input falls into three general categories: - # - interpretor command which starts with a '/' - # - controller commands handled by torTools (this allows for caching, - # proper handling by the rest of arm, etc) - # - unrecognized controller command, this has the possability of confusing - # arm... - - if input.startswith("/"): - # interpretor command - inputEntry.append((input, Formats.INPUT_INTERPRETOR)) - outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement - - # TODO: add /help option - # TODO: add /write option - else: - # controller command - if " " in input: cmd, arg = input.split(" ", 1) - else: cmd, arg = input, "" - - inputEntry.append((cmd + " ", Formats.INPUT_CMD)) - if arg: inputEntry.append((arg, Formats.INPUT_ARG)) - - if cmd.upper() == "GETINFO": - try: - response = conn.getInfo(arg, suppressExc = False) - outputEntry.append((response, Formats.OUTPUT)) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - elif cmd.upper() == "SETCONF": - if "=" in arg: - param, value = arg.split("=", 1) - - try: - conn.setOption(param.strip(), value.strip()) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - else: - # TODO: resets the attribute - outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement - else: - try: - response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) - - for entry in response: - # Response entries are tuples with the response code, body, and - # extra info. For instance: - # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) - - if len(entry) == 3: - outputEntry.append((entry[1], Formats.OUTPUT)) - except Exception, exc: - outputEntry.append((str(exc), Formats.ERROR)) - - self.previousCommands.insert(0, input) - self.previousCommands = self.previousCommands[:COMMAND_BACKLOG] - - promptEntry = self.contents.pop() # removes old prompt entry - self.contents += _splitOnNewlines(inputEntry) - self.contents += _splitOnNewlines(outputEntry) - self.contents.append(promptEntry) - - # if too long then crop lines - cropLines = len(self.contents) - LINES_BACKLOG - if cropLines > 0: self.contents = self.contents[cropLines:] - - return False - def handleKey(self, key): # TODO: allow contents to be searched (with hilighting?) @@ -193,40 +126,13 @@ class InterpretorPanel(panel.Panel): if drawLine >= height: break def _initFormats(self): - self.formats[Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") - self.formats[Formats.INPUT] = uiTools.getColor("cyan") - self.formats[Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") - self.formats[Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") - self.formats[Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") - self.formats[Formats.OUTPUT] = uiTools.getColor("blue") - self.formats[Formats.USAGE] = uiTools.getColor("cyan") - self.formats[Formats.HELP] = uiTools.getColor("magenta") - self.formats[Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") - -def _splitOnNewlines(entry): - """ - Splits a list of (msg, format) tuples on newlines into a list of lines. - - Arguments: - entry - list of display tuples - """ - - results, tmpLine = [], [] - entry = list(entry) # shallow copy - - while entry: - msg, format = entry.pop(0) - - if "\n" in msg: - msg, remainder = msg.split("\n", 1) - entry.insert(0, (remainder, format)) - - tmpLine.append((msg, format)) - results.append(tmpLine) - tmpLine = [] - else: - tmpLine.append((msg, format)) - - if tmpLine: results.append(tmpLine) - return results + self.formats[torInterpretor.Formats.PROMPT] = curses.A_BOLD | uiTools.getColor("green") + self.formats[torInterpretor.Formats.INPUT] = uiTools.getColor("cyan") + self.formats[torInterpretor.Formats.INPUT_INTERPRETOR] = curses.A_BOLD | uiTools.getColor("magenta") + self.formats[torInterpretor.Formats.INPUT_CMD] = curses.A_BOLD | uiTools.getColor("green") + self.formats[torInterpretor.Formats.INPUT_ARG] = curses.A_BOLD | uiTools.getColor("cyan") + self.formats[torInterpretor.Formats.OUTPUT] = uiTools.getColor("blue") + self.formats[torInterpretor.Formats.USAGE] = uiTools.getColor("cyan") + self.formats[torInterpretor.Formats.HELP] = uiTools.getColor("magenta") + self.formats[torInterpretor.Formats.ERROR] = curses.A_BOLD | uiTools.getColor("red") diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py index 9b6bff4..866495d 100644 --- a/src/util/torInterpretor.py +++ b/src/util/torInterpretor.py @@ -6,7 +6,10 @@ directly, history and tab completion. import readline # simply importing this provides history to raw_input -from util import enum +from util import enum, torTools + +PROMPT = ">>> " +Formats = enum.Enum("PROMPT", "INPUT", "INPUT_INTERPRETOR", "INPUT_CMD", "INPUT_ARG", "OUTPUT", "USAGE", "HELP", "ERROR") TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE") @@ -21,6 +24,13 @@ ATTR_ENCODING = {Attr.BOLD: "1", Attr.UNDERLINE: "4", Attr.HILIGHT: "7"} CSI = "\x1B[%sm" RESET = CSI % "0" +class InterpretorClosed(Exception): + """ + Exception raised when the interpretor should be shut down. + """ + + pass + def format(msg, *attr): """ Simple terminal text formatting, using ANSI escape sequences from: @@ -60,7 +70,125 @@ def prompt(): prompt = format(">>> ", Color.GREEN, Attr.BOLD) input = "" + formatMap = {} # mapping of Format to Color and Attr enums + formatMap[Formats.PROMPT] = (Attr.BOLD, Color.GREEN) + formatMap[Formats.INPUT] = (Color.CYAN, ) + formatMap[Formats.INPUT_INTERPRETOR] = (Attr.BOLD, Color.MAGENTA) + formatMap[Formats.INPUT_CMD] = (Attr.BOLD, Color.GREEN) + formatMap[Formats.INPUT_ARG] = (Attr.BOLD, Color.CYAN) + formatMap[Formats.OUTPUT] = (Color.BLUE, ) + formatMap[Formats.USAGE] = (Color.CYAN, ) + formatMap[Formats.HELP] = (Color.MAGENTA, ) + formatMap[Formats.ERROR] = (Attr.BOLD, Color.RED) + while input != "/quit": input = raw_input(prompt) - print format("echoing back '%s'" % input, Color.BLUE) + + _, outputEntry = handleQuery(input) + + for line in outputEntry: + outputLine = "" + + for msg, msgFormat in line: + outputLine += format(msg, *formatMap[msgFormat]) + + print outputLine + +def handleQuery(input): + """ + Processes the given input. Requests starting with a '/' are special + commands to the interpretor, and anything else is sent to the control port. + This returns an input/output tuple, each entry being a list of lines, each + line having a list of (msg, format) tuples for the content to be displayed. + This raises a InterpretorClosed if the interpretor should be shut down. + + Arguments: + input - user input to be processed + """ + + input = input.strip() + inputEntry, outputEntry = [(PROMPT, Formats.PROMPT)], [] + conn = torTools.getConn() + + # input falls into three general categories: + # - interpretor command which starts with a '/' + # - controller commands handled by torTools (this allows for caching, + # proper handling by the rest of arm, etc) + # - unrecognized controller command, this has the possability of confusing + # arm... + + if input.startswith("/"): + # interpretor command + inputEntry.append((input, Formats.INPUT_INTERPRETOR)) + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + + # TODO: add /help option + # TODO: add /write option + else: + # controller command + if " " in input: cmd, arg = input.split(" ", 1) + else: cmd, arg = input, "" + + inputEntry.append((cmd + " ", Formats.INPUT_CMD)) + if arg: inputEntry.append((arg, Formats.INPUT_ARG)) + + if cmd.upper() == "GETINFO": + try: + response = conn.getInfo(arg, suppressExc = False) + outputEntry.append((response, Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + elif cmd.upper() == "SETCONF": + if "=" in arg: + param, value = arg.split("=", 1) + + try: + conn.setOption(param.strip(), value.strip()) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + else: + # TODO: resets the attribute + outputEntry.append(("Not yet implemented...", Formats.ERROR)) # TODO: implement + else: + try: + response = conn.getTorCtl().sendAndRecv("%s\r\n" % input) + + for entry in response: + # Response entries are tuples with the response code, body, and + # extra info. For instance: + # ('250', 'version=0.2.2.23-alpha (git-b85eb949b528f4d7)', None) + + if len(entry) == 3: + outputEntry.append((entry[1], Formats.OUTPUT)) + except Exception, exc: + outputEntry.append((str(exc), Formats.ERROR)) + + return (_splitOnNewlines(inputEntry), _splitOnNewlines(outputEntry)) + +def _splitOnNewlines(entry): + """ + Splits a list of (msg, format) tuples on newlines into a list of lines. + + Arguments: + entry - list of display tuples + """ + + results, tmpLine = [], [] + entry = list(entry) # shallow copy + + while entry: + msg, format = entry.pop(0) + + if "\n" in msg: + msg, remainder = msg.split("\n", 1) + entry.insert(0, (remainder, format)) + + tmpLine.append((msg, format)) + results.append(tmpLine) + tmpLine = [] + else: + tmpLine.append((msg, format)) + + if tmpLine: results.append(tmpLine) + return results

1 0

[arm/release] Merge commit 'krkhan/master'
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit de4b51a73316a0a4d366a9cab38707ccffa56cf0 Merge: ee6721e 5fff0b1 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 11 08:24:08 2011 -0700 Merge commit 'krkhan/master' src/gui/arm.xml | 169 +++++++++++---- src/gui/configPanel.py | 161 ++++++++++++++ src/gui/connections/circEntry.py | 37 ++-- src/gui/connections/connEntry.py | 48 ++--- src/gui/connections/connPanel.py | 134 +++++------- src/gui/controller.py | 32 ++-- src/gui/generalPanel.py | 25 +-- src/gui/graphing/__init__.py | 2 +- src/gui/graphing/bandwidthStats.py | 12 +- src/gui/graphing/graphPanel.py | 144 +++++++++++++ src/gui/graphing/graphStats.py | 142 ------------- src/gui/logPanel.py | 26 ++-- src/starter.py | 2 +- src/util/gtkTools.py | 405 ++++++++++++++++++++++++++++++++++++ 14 files changed, 979 insertions(+), 360 deletions(-)

1 0

[arm/release] Adding tor control socket support
by atagar＠torproject.org 25 Sep '11

25 Sep '11

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

1 0

[arm/release] fix: correcting default control socket path
by atagar＠torproject.org 25 Sep '11

25 Sep '11

commit ee6721e5dfc19fd360313d4630efc1e3591b9364 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 11 08:18:05 2011 -0700 fix: correcting default control socket path According to dererk the default control socket path is "/var/run/tor/control" rather than "/var/lib/tor/control" (the path mentioned by Peter). --- armrc.sample | 2 +- src/cli/headerPanel.py | 2 +- src/starter.py | 2 +- src/util/torTools.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/armrc.sample b/armrc.sample index 22fb903..e19d4c4 100644 --- a/armrc.sample +++ b/armrc.sample @@ -2,7 +2,7 @@ startup.controlPassword startup.interface.ipAddress 127.0.0.1 startup.interface.port 9051 -startup.interface.socket /var/lib/tor/control +startup.interface.socket /var/run/tor/control startup.blindModeEnabled false startup.events N3 startup.dataDirectory ~/.arm diff --git a/src/cli/headerPanel.py b/src/cli/headerPanel.py index d5ce332..0e8c018 100644 --- a/src/cli/headerPanel.py +++ b/src/cli/headerPanel.py @@ -41,7 +41,7 @@ VERSION_STATUS_COLORS = {"new": "blue", "new in series": "blue", "obsolete": "re DEFAULT_CONFIG = {"startup.interface.ipAddress": "127.0.0.1", "startup.interface.port": 9051, - "startup.interface.socket": "/var/lib/tor/control", + "startup.interface.socket": "/var/run/tor/control", "features.showFdUsage": False, "log.fdUsageSixtyPercent": log.NOTICE, "log.fdUsageNinetyPercent": log.WARN} diff --git a/src/starter.py b/src/starter.py index a148947..2bdc6d0 100644 --- a/src/starter.py +++ b/src/starter.py @@ -35,7 +35,7 @@ DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") CONFIG = {"startup.controlPassword": None, "startup.interface.ipAddress": "127.0.0.1", "startup.interface.port": 9051, - "startup.interface.socket": "/var/lib/tor/control", + "startup.interface.socket": "/var/run/tor/control", "startup.blindModeEnabled": False, "startup.events": "N3", "startup.dataDirectory": "~/.arm", diff --git a/src/util/torTools.py b/src/util/torTools.py index 366deb0..39cb176 100644 --- a/src/util/torTools.py +++ b/src/util/torTools.py @@ -113,7 +113,7 @@ def loadConfig(config): # TODO: temporary code until this is added to torctl as part of... # https://trac.torproject.org/projects/tor/ticket/3638 -def connect_socket(socketPath="/var/lib/tor/control", ConnClass=TorCtl.Connection): +def connect_socket(socketPath="/var/run/tor/control", ConnClass=TorCtl.Connection): """ Connects to a unix domain socket available to controllers (set via tor's ControlSocket option). This raises an IOError if unable to do so.

1 0