/usr/share/arm/util/torInterpretor.py is in tor-arm 1.4.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 | """
Provides an interactive interpretor for working with the Tor control port. This
adds usability features like IRC style interpretor commands and, when ran
directly, history and tab completion.
"""
import re
import sys
import version
# TODO: util should never import from the cli. This is being done as a hack to
# simplify event listening, but we should later move the TorEventObserver into
# the util.
from cli.logPanel import TorEventObserver
from util import connections, enum, hostnames, torConfig, torTools, uiTools
COLOR_PROMPT = True # provides a colored interpretor prompt
INFO_HOSTNAMES = False # hostname lookups in /info results
# initial location /write will save to when no path is specified
DEFAULT_WRITE_PATH = "/tmp/torInterpretor_output"
INIT_MSG = """Arm %s Control Interpretor
Enter \"/help\" for usage information and \"/quit\" to stop.
""" % version.VERSION
TERM_COLORS = ("BLACK", "RED", "GREEN", "YELLOW", "BLUE", "MAGENTA", "CYAN", "WHITE")
Color = enum.Enum(*TERM_COLORS)
BgColor = enum.Enum(*["BG_" + color for color in TERM_COLORS])
Attr = enum.Enum("BOLD", "UNDERLINE", "HILIGHT")
FG_ENCODING = dict([(Color.values()[i], str(30 + i)) for i in range(8)])
BG_ENCODING = dict([(BgColor.values()[i], str(40 + i)) for i in range(8)])
ATTR_ENCODING = {Attr.BOLD: "1", Attr.UNDERLINE: "4", Attr.HILIGHT: "7"}
PROMPT = (">>> ", (Attr.BOLD, Color.GREEN))
INPUT_FORMAT = (Color.CYAN, )
INPUT_INTERPRETOR_FORMAT = (Attr.BOLD, Color.MAGENTA)
INPUT_CMD_FORMAT = (Attr.BOLD, Color.GREEN)
INPUT_ARG_FORMAT = (Attr.BOLD, Color.CYAN)
OUTPUT_FORMAT = (Color.BLUE, )
USAGE_FORMAT = (Color.CYAN, )
HELP_FORMAT = (Color.MAGENTA, )
ERROR_FORMAT = (Attr.BOLD, Color.RED)
CSI = "\x1B[%sm"
RESET = CSI % "0"
# limits used for cropping
BACKLOG_LIMIT = 100
EVENTS_LIMIT = 200
CONTENT_LIMIT = 20000
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
/info - general information for a relay
/find - searches backlog for lines with the given regex
/events - prints events that we've received
/write - saves backlog to a given location
/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 info # provides a description of the '/info' option
/help GETINFO # usage information for tor's GETINFO controller option
/help ExitPolicy # description of tor's ExitPolicy configuration option"""
HELP_WRITE = """Writes the interpretor's backlog to the given path. If no location is
specified then this saves to the last path specified (initially '%s').""" % DEFAULT_WRITE_PATH
HELP_EVENTS = """Provides events that we've received belonging to the given event types. If
no types are specified then this provides all the messages that we've
received."""
HELP_INFO = """Provides general information for a relay that's currently in the consensus.
If no relay is specified then this provides information on ourselves."""
HELP_FIND = """Searches the backlog for lines matching a given regular expression pattern.
Results are deduplicated and the matching portions bolded."""
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@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),
"WRITE": ("/write [PATH]", HELP_WRITE),
"EVENTS": ("/events [types]", HELP_EVENTS),
"INFO": ("/info [relay fingerprint, nickname, or IP address]", HELP_INFO),
"FIND": ("/find PATTERN", HELP_FIND),
"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),
}
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:
https://secure.wikimedia.org/wikipedia/en/wiki/ANSI_escape_code#CSI_codes
toolkits providing similar capabilities:
* django.utils.termcolors
https://code.djangoproject.com/browser/django/trunk/django/utils/termcolors.py
* termcolor
http://pypi.python.org/pypi/termcolor
* colorama
http://pypi.python.org/pypi/colorama
Arguments:
msg - string to be formatted
attr - text attributes, this can be Color, BgColor, or Attr enums and are
case insensitive (so strings like "red" are fine)
"""
encodings = []
for textAttr in attr:
textAttr, encoding = enum.toCamelCase(textAttr), None
encoding = FG_ENCODING.get(textAttr, encoding)
encoding = BG_ENCODING.get(textAttr, encoding)
encoding = ATTR_ENCODING.get(textAttr, encoding)
if encoding: encodings.append(encoding)
if encodings:
return (CSI % ";".join(encodings)) + msg + RESET
else: return msg
class TorControlCompleter:
"""
Command autocompleter, fetching the valid options from the attached Tor
instance.
"""
def __init__(self):
self._prefix = None
self._prefixMatches = []
self.commands = []
conn = torTools.getConn()
# adds all of the valid GETINFO options
infoOptions = conn.getInfo("info/names")
if infoOptions:
for line in infoOptions.split("\n"):
if " " in line:
# skipping non-existant options mentioned in:
# https://trac.torproject.org/projects/tor/ticket/3844
if line.startswith("config/*") or line.startswith("dir-usage"):
continue
infoOpt = line.split(" ", 1)[0]
# strips off the ending asterisk if it accepts a value
if infoOpt.endswith("*"): infoOpt = infoOpt[:-1]
self.commands.append("GETINFO %s" % infoOpt)
else: self.commands.append("GETINFO ")
# adds all of the valid GETCONF / SETCONF / RESETCONF options
confOptions = conn.getInfo("config/names")
if confOptions:
# individual options are '<name> <type>' pairs
confEntries = [opt.split(" ", 1)[0] for opt in confOptions.split("\n")]
self.commands += ["GETCONF %s" % conf for conf in confEntries]
self.commands += ["SETCONF %s " % conf for conf in confEntries]
self.commands += ["RESETCONF %s" % conf for conf in confEntries]
else:
self.commands.append("GETCONF ")
self.commands.append("SETCONF ")
self.commands.append("RESETCONF ")
# adds all of the valid SETEVENTS options
eventOptions = conn.getInfo("events/names")
if eventOptions:
self.commands += ["SETEVENTS %s" % event for event in eventOptions.split(" ")]
else: self.commands.append("SETEVENTS ")
# adds all of the valid USEFEATURE options
featureOptions = conn.getInfo("features/names")
if featureOptions:
self.commands += ["USEFEATURE %s" % feature for feature in featureOptions.split(" ")]
else: self.commands.append("USEFEATURE ")
# adds all of the valid SIGNAL options
# this can't yet be fetched dynamically, as per:
# https://trac.torproject.org/projects/tor/ticket/3842
signals = ("RELOAD", "SHUTDOWN", "DUMP", "DEBUG", "HALT", "HUP", "INT",
"USR1", "USR2", "TERM", "NEWNYM", "CLEARDNSCACHE")
self.commands += ["SIGNAL %s" % sig for sig in signals]
# shouldn't use AUTHENTICATE since we only provide the prompt with an
# authenticated controller connection
#self.commands.append("AUTHENTICATE")
# other options
self.commands.append("SAVECONF")
self.commands.append("MAPADDRESS ")
self.commands.append("EXTENDCIRCUIT ")
self.commands.append("SETCIRCUITPURPOSE ")
#self.commands.append("SETROUTERPURPOSE ") # deprecated option
self.commands.append("ATTACHSTREAM ")
self.commands.append("+POSTDESCRIPTOR ") # TODO: needs to support multiline options for this (ugg)
self.commands.append("REDIRECTSTREAM ")
self.commands.append("CLOSESTREAM ")
self.commands.append("CLOSECIRCUIT ")
self.commands.append("RESOLVE ")
self.commands.append("PROTOCOLINFO ")
self.commands.append("+LOADCONF") # TODO: another multiline...
self.commands.append("TAKEOWNERSHIP")
self.commands.append("QUIT") # TODO: give a confirmation when the user does this?
# adds interpretor commands
for cmd in HELP_OPTIONS:
if HELP_OPTIONS[cmd][0].startswith("/"):
self.commands.append("/" + cmd.lower())
# adds help options for the previous commands
baseCmd = set([cmd.split(" ")[0].replace("+", "").replace("/", "") for cmd in self.commands])
for cmd in baseCmd:
self.commands.append("/help " + cmd)
# adds /help for tor configuration options
for opt in torConfig.getConfigOptions():
self.commands.append("/help " + opt)
def getMatches(self, text):
"""
Provides all options that match the given input. This is case insensetive.
Arguments:
text - user input text to be matched against
"""
return [cmd for cmd in self.commands if cmd.lower().startswith(text.lower())]
def complete(self, text, state):
"""
Provides case insensetive autocompletion options, acting as a functor for
the readlines set_completer function.
"""
if text != self._prefix:
self._prefix = text
self._prefixMatches = self.getMatches(text)
# Tab completion fills in the first common prefix which can be
# problematic if they don't all match. For instance completing "Map" will
# result in ["MAPADDRESS", "MapAddress"], which gets truncated to the
# common prefix of just "M" when the user presses tab.
if len(self._prefixMatches) > 1:
prefixToResult = {}
for match in self._prefixMatches:
prefix = match[:len(text)]
if prefix in prefixToResult:
prefixToResult[prefix].append(match)
else:
prefixToResult[prefix] = [match]
if len(prefixToResult) > 1:
# we have multiple prefixes, pick the one with the most results
self._prefixMatches = None
for matchSet in prefixToResult.values():
if not self._prefixMatches or len(self._prefixMatches) < len(matchSet):
self._prefixMatches = matchSet
if state < len(self._prefixMatches):
return self._prefixMatches[state]
else: return None
class ControlInterpretor:
"""
Interpretor that handles queries to the control port, providing usability
imporvements like irc style help optoins. This tracks input and responses.
"""
def __init__(self):
self.backlog = [] # prior requests the user has made
self.contents = [] # (msg, format list) tuples for what's been displayed
self.writePath = DEFAULT_WRITE_PATH # last location we've saved to
self.eventBuffer = [] # unread event messages
self.loggedEvents = [] # event types that we're listening for
torTools.getConn().addEventListener(TorEventObserver(self.registerEvent))
def registerEvent(self, event):
"""
Adds the event to our buffer so it'll be in '/events' output.
"""
if event.type in self.loggedEvents:
self.eventBuffer.append(event)
eventsCrop = len(self.eventBuffer) - EVENTS_LIMIT
if eventsCrop > 0: self.eventBuffer = self.eventBuffer[eventsCrop:]
def getBacklog(self):
"""
Provides the backlog of prior user input.
"""
return self.backlog
def getDisplayContents(self, appendPrompt = None):
"""
Provides a list of lines to be displayed, each being a list of (msg,
format) tuples for the content to be displayed. This is ordered as the
oldest to newest.
Arguments:
appendPrompt - adds the given line to the end
"""
if appendPrompt:
return self.contents + [appendPrompt]
else: return self.contents
def doHelp(self, arg, outputEntry):
"""
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:]
if arg:
if 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]
outputEntry.append((usage + "\n", OUTPUT_FORMAT + (Attr.BOLD, )))
for line in description.split("\n"):
outputEntry.append((" " + line + "\n", OUTPUT_FORMAT))
if arg == "GETINFO":
# if this is the GETINFO option then also list the valid options
infoOptions = torTools.getConn().getInfo("info/names")
if infoOptions:
for line in infoOptions.split("\n"):
if line.startswith("config/*") or line.startswith("dir-usage"):
continue
lineMatch = re.match("^(.+) -- (.+)$", line)
if lineMatch:
opt, description = lineMatch.groups()
outputEntry.append(("%-33s" % opt, OUTPUT_FORMAT + (Attr.BOLD, )))
outputEntry.append((" - %s\n" % description, OUTPUT_FORMAT))
elif arg == "GETCONF":
# lists all of the configuration options
confOptions = torTools.getConn().getInfo("config/names")
if confOptions:
confEntries = [opt.split(" ", 1)[0] for opt in confOptions.split("\n")]
# displays two columns of 42 characters
for i in range(0, len(confEntries), 2):
lineEntries = confEntries[i : i+2]
lineContent = ""
for entry in lineEntries:
lineContent += "%-42s" % entry
outputEntry.append((lineContent + "\n", OUTPUT_FORMAT))
outputEntry.append(("For more information use '/help [CONFIG OPTION]'.", OUTPUT_FORMAT + (Attr.BOLD, )))
elif arg == "SIGNAL":
# lists descriptions for all of the signals
for signal, description in SIGNAL_DESCRIPTIONS:
outputEntry.append(("%-15s" % signal, OUTPUT_FORMAT + (Attr.BOLD, )))
outputEntry.append((" - %s\n" % description, OUTPUT_FORMAT))
elif arg == "SETEVENTS":
# lists all of the event types
eventOptions = torTools.getConn().getInfo("events/names")
if eventOptions:
eventEntries = eventOptions.split()
# displays four columns of 20 characters
for i in range(0, len(eventEntries), 4):
lineEntries = eventEntries[i : i+4]
lineContent = ""
for entry in lineEntries:
lineContent += "%-20s" % entry
outputEntry.append((lineContent + "\n", OUTPUT_FORMAT))
elif arg == "USEFEATURE":
# lists the feature options
featureOptions = torTools.getConn().getInfo("features/names")
if featureOptions:
outputEntry.append((featureOptions + "\n", OUTPUT_FORMAT))
elif arg in ("LOADCONF", "POSTDESCRIPTOR"):
# gives a warning that this option isn't yet implemented
outputEntry.append(("\n" + MULTILINE_UNIMPLEMENTED_NOTICE + "\n", ERROR_FORMAT))
else:
# check if this is a configuration option
manEntry = torConfig.getConfigDescription(arg)
if manEntry:
# provides basic usage information in bold, followed an indented
# copy of the man page description (wrapped to eighty characters)
helpTitle = "%s %s (category: %s)\n" % (manEntry.option, manEntry.argUsage, manEntry.category)
outputEntry.append((helpTitle, OUTPUT_FORMAT + (Attr.BOLD, )))
descLines = manEntry.description.split("\n")
for line in descLines:
if not line:
outputEntry.append(("\n", OUTPUT_FORMAT))
else:
while line:
drawPortion, line = uiTools.cropStr(line, 88, 4, 4, uiTools.Ending.HYPHEN, True)
outputEntry.append((" %s\n" % drawPortion.strip(), OUTPUT_FORMAT))
else:
outputEntry.append(("No help information available for '%s'..." % arg, ERROR_FORMAT))
else:
# provides the GENERAL_HELP with everything bolded except descriptions
for line in GENERAL_HELP.split("\n"):
cmdStart = line.find(" - ")
if cmdStart != -1:
outputEntry.append((line[:cmdStart], OUTPUT_FORMAT + (Attr.BOLD, )))
outputEntry.append((line[cmdStart:] + "\n", OUTPUT_FORMAT))
else:
outputEntry.append((line + "\n", OUTPUT_FORMAT + (Attr.BOLD, )))
def doEvents(self, arg, outputEntry):
"""
Performs the '/events' operation, dumping the events that we've received
belonging to the given types. If no types are specified then this provides
all buffered events.
"""
bufferedEvents = self.eventBuffer
# if we have an argument then restrict it to those event types
eventTypes = arg.upper().split()
if eventTypes:
bufferedEvents = [event for event in self.eventBuffer if event.type in eventTypes]
for event in bufferedEvents:
outputEntry.append((event.getDisplayMessage() + "\n", OUTPUT_FORMAT))
def doWrite(self, arg, outputEntry):
"""
Performs the '/write' operation, which attempts to save the backlog to a
given path, defaulting to the last location we write to.
"""
if arg: self.writePath = arg
outputLines = []
for line in self.contents:
outputLines.append("".join([msg for msg, _ in line]))
try:
outputFile = open(self.writePath, "w")
outputFile.write("\n".join(outputLines))
outputFile.close()
outputEntry.append(("Interpretor backlog written to: %s" % self.writePath, OUTPUT_FORMAT))
except IOError, exc:
outputEntry.append(("Unable to write to '%s': %s" % (self.writePath, exc), ERROR_FORMAT))
def doFind(self, arg, outputEntry):
"""
Performs the '/find' operation, which lists output from the backlog which
matches the given regex. Results are deduplicated and matches are bolded.
"""
argMatcher = None
if not arg:
outputEntry.append(("Nothing to match against", ERROR_FORMAT))
else:
try: argMatcher = re.compile("(%s)" % arg)
except: outputEntry.append(("Unable to compile regex '%s'" % arg, ERROR_FORMAT))
if argMatcher:
printedLines = []
for line in self.contents:
lineText = "".join([msg for msg, _ in line])
# skip if this was user input or a duplicate
if lineText.startswith(PROMPT[0]) or lineText in printedLines:
continue
match = argMatcher.search(lineText)
if match:
# outputs the matching line, with the match itself bolded
outputEntry.append((lineText[:match.start()], OUTPUT_FORMAT))
outputEntry.append((match.group(), (OUTPUT_FORMAT + (Attr.BOLD, ))))
outputEntry.append((lineText[match.end():] + "\n", OUTPUT_FORMAT))
printedLines.append(lineText)
def doInfo(self, arg, outputEntry):
"""
Performs the '/info' operation, looking up a relay by fingerprint, IP
address, or nickname and printing its descriptor and consensus entries in a
pretty fashion.
"""
fingerprint, conn = None, torTools.getConn()
# TODO: also recognize <ip>:<port> entries?
# determines the fingerprint, leaving it unset and adding an error message
# if unsuccessful
if not arg:
# uses our fingerprint if we're a relay, otherwise gives an error
fingerprint = conn.getInfo("fingerprint")
if not fingerprint:
outputEntry.append(("We aren't a relay, no information to provide", ERROR_FORMAT))
elif len(arg) == 40 and re.match("^[0-9a-fA-F]+$", arg):
# we got a fingerprint (fourty character hex string)
fingerprint = arg
elif connections.isValidIpAddress(arg):
# we got an ip address, look up the fingerprint
fpMatches = conn.getRelayFingerprint(arg, getAllMatches = True)
if len(fpMatches) == 0:
outputEntry.append(("No relays found at %s" % arg, ERROR_FORMAT))
elif len(fpMatches) == 1:
fingerprint = fpMatches[0][1]
else:
outputEntry.append(("Multiple relays at %s, specify which by giving a port" % arg, ERROR_FORMAT))
for i in range(len(fpMatches)):
relayEntry = outputEntry[i]
outputEntry.append((" %i. or port: %-5s fingerprint: %s" % (i + 1, relayEntry[0], relayEntry[1]), ERROR_FORMAT))
else:
# we got something else, treat it as a nickname
fingerprint = conn.getNicknameFingerprint(arg)
if not fingerprint:
outputEntry.append(("No relay with the nickname of '%s' found" % arg, ERROR_FORMAT))
if fingerprint:
consensusEntry = conn.getConsensusEntry(fingerprint)
# The nickname, address, and port lookups are all based on the consensus
# entry so if this succeeds we should be pretty confident that those
# queries will work too.
if not consensusEntry:
outputEntry.append(("Unable to find consensus information for %s" % fingerprint, ERROR_FORMAT))
return
address, port = conn.getRelayAddress(fingerprint, (None, None))
# ... but not sure enough that we won't check
if not address or not port: return
locale = conn.getInfo("ip-to-country/%s" % address, "??")
if INFO_HOSTNAMES:
hostname = hostnames.resolve(address, 10)
else:
hostname = None
# TODO: Most of the following is copied from the _getDetailContent method
# of cli/connections/connEntry.py - useful bits should be refactored.
consensusLines = consensusEntry.split("\n")
firstLineComp = consensusLines[0].split(" ")
if len(firstLineComp) >= 9:
_, nickname, _, _, pubDate, pubTime, _, orPort, _ = firstLineComp[:9]
else: nickname, pubDate, pubTime, orPort = "", "", "", ""
flags = "unknown"
if len(consensusLines) >= 2 and consensusLines[1].startswith("s "):
flags = consensusLines[1][2:]
exitPolicy = conn.getRelayExitPolicy(fingerprint)
if exitPolicy: policyLabel = exitPolicy.getSummary()
else: policyLabel = "unknown"
# fetches information from the descriptor if it's available
torVersion, platform, contact = "", "", ""
descriptorEntry = conn.getDescriptorEntry(fingerprint)
if descriptorEntry:
for descLine in descriptorEntry.split("\n"):
if descLine.startswith("platform"):
# has the tor version and platform, ex:
# platform Tor 0.2.1.29 (r318f470bc5f2ad43) on Linux x86_64
torVersion = descLine[13:descLine.find(" ", 13)]
platform = descLine[descLine.rfind(" on ") + 4:]
elif descLine.startswith("contact"):
contact = descLine[8:]
# clears up some highly common obscuring
for alias in (" at ", " AT "): contact = contact.replace(alias, "@")
for alias in (" dot ", " DOT "): contact = contact.replace(alias, ".")
break # contact lines come after the platform
headingAttr, infoAttr = (Attr.BOLD, Color.BLUE), ()
outputEntry.append(("%s (%s)\n" % (nickname, fingerprint), infoAttr))
hostnameLabel = ", %s" % hostname if hostname else ""
outputEntry.append(("address: ", headingAttr))
outputEntry.append(("%s:%s (%s%s)\n" % (address, port, locale, hostnameLabel), infoAttr))
outputEntry.append(("published: ", headingAttr))
outputEntry.append(("%s %s" % (pubTime, pubDate) + "\n", infoAttr))
if torVersion and platform:
outputEntry.append(("os: ", headingAttr))
outputEntry.append((platform + "\n", infoAttr))
outputEntry.append(("version: ", headingAttr))
outputEntry.append((torVersion + "\n", infoAttr))
outputEntry.append(("flags: ", headingAttr))
outputEntry.append((flags.replace(" ", ", ") + "\n", infoAttr))
outputEntry.append(("exit policy: ", headingAttr))
outputEntry.append((policyLabel + "\n", infoAttr))
if contact:
outputEntry.append(("contact: ", headingAttr))
outputEntry.append((contact + "\n", infoAttr))
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 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
"""
conn = torTools.getConn()
# abort if the control connection has been severed
if not conn.isAlive():
raise InterpretorClosed("Control connection has been closed")
input = input.strip()
# appends new input, cropping if too long
self.backlog.append(input)
backlogCrop = len(self.backlog) - BACKLOG_LIMIT
if backlogCrop > 0: self.backlog = self.backlog[backlogCrop:]
inputEntry, outputEntry = [PROMPT], []
# 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 " " in input: cmd, arg = input.split(" ", 1)
else: cmd, arg = input, ""
if cmd.startswith("/"):
# interpretor command
inputEntry.append((input, INPUT_INTERPRETOR_FORMAT))
if cmd == "/quit": raise InterpretorClosed()
elif cmd == "/help": self.doHelp(arg, outputEntry)
elif cmd == "/write": self.doWrite(arg, outputEntry)
elif cmd == "/find": self.doFind(arg, outputEntry)
elif cmd == "/events": self.doEvents(arg, outputEntry)
elif cmd == "/info": self.doInfo(arg, outputEntry)
else:
outputEntry.append(("Not yet implemented...", ERROR_FORMAT)) # TODO: implement
# appends a newline so all interpretor commands have a blank before the prompt
if outputEntry:
lastEntry = outputEntry[-1]
outputEntry[-1] = (lastEntry[0].rstrip() + "\n", lastEntry[1])
# TODO: add /help option
else:
# controller command
cmd = cmd.upper() # makes commands uppercase to match the spec
inputEntry.append((cmd + " ", INPUT_CMD_FORMAT))
if arg: inputEntry.append((arg, INPUT_ARG_FORMAT))
if cmd == "GETINFO":
try:
for param in arg.split():
response = conn.getInfo(param, suppressExc = False)
outputEntry.append((response + "\n", OUTPUT_FORMAT))
except Exception, exc:
outputEntry.append((str(exc), ERROR_FORMAT))
elif cmd == "SETCONF" or cmd == "RESETCONF":
# arguments can either be '<param>', '<param>=<value>', or
# '<param>="<value>"' entries
paramList = []
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.
quotedMatch = re.match(r'^(\S+)=\"([^"]+)\"', arg)
nonquotedMatch = re.match(r'^(\S+)=(\S+)', arg)
if quotedMatch:
# we're dealing with a '<param>="<value>"' entry
param, value = quotedMatch.groups()
paramList.append((param, value))
arg = arg[len(param) + len(value) + 3:].strip()
elif nonquotedMatch:
# we're dealing with a '<param>=<value>' entry
param, value = nonquotedMatch.groups()
paramList.append((param, value))
arg = arg[len(param) + len(value) + 1:].strip()
else:
# starts with just a param
param = arg.split()[0]
paramList.append((param, None))
arg = arg[len(param):].strip()
try:
isReset = cmd == "RESETCONF"
conn.setOptions(paramList, isReset)
except Exception, exc:
outputEntry.append((str(exc), ERROR_FORMAT))
elif cmd == "SETEVENTS":
self.loggedEvents = arg.split()
allEvents = torTools.getConn().setControllerEvents(self.loggedEvents)
setEvents = set(self.loggedEvents).intersection(allEvents)
if setEvents:
outputEntry.append(("Successfully set event listening to: %s\n" % ", ".join(setEvents), OUTPUT_FORMAT))
else:
if not self.loggedEvents:
# we purposefully disabled event listening
outputEntry.append(("Disabled event listening\n", OUTPUT_FORMAT))
else:
# we tried to set events but they all failed
outputEntry.append(("Unable to set any of the events. Event listening disabled.\n", ERROR_FORMAT))
elif cmd.replace("+", "") in ("LOADCONF", "POSTDESCRIPTOR"):
# provides a notice that multi-line controller input isn't yet implemented
outputEntry.append((MULTILINE_UNIMPLEMENTED_NOTICE + "\n", ERROR_FORMAT))
else:
try:
response = conn.getTorCtl().sendAndRecv("%s\r\n" % input)
if cmd == "QUIT":
raise InterpretorClosed("Closing the connection")
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], OUTPUT_FORMAT))
except Exception, exc:
if isinstance(exc, InterpretorClosed):
raise exc
else:
outputEntry.append((str(exc), ERROR_FORMAT))
# converts to lists split on newlines
inputLines = _splitOnNewlines(inputEntry)
outputLines = _splitOnNewlines(outputEntry)
# appends new contents, cropping if too long
# TODO: it would be nice if InterpretorClosed exceptions were added to the content too
self.contents += inputLines + outputLines
cropLines = len(self.contents) - CONTENT_LIMIT
if cropLines > 0: self.contents = self.contents[cropLines:]
return (inputLines, outputLines)
def showPrompt():
# When displaying the prompt we want the readline module to be imported so
# we get its neat features like history scrollback. HOWEVER, importing
# readline prior to initializing curses causes terminal bugs, most noticeably
# screen resizing.
import readline
# For Python 2.6 and earlier cycling history via the readline module with
# up/down is buggy with a color prompt. For more information see:
# http://bugs.python.org/issue12972
#
# To work around this while keeping a color prompt I'm padding the prompt
# with extra reset encodings so its length is non-rendered higher (around
# sixty characters). There's two ways that this can go wrong...
# - if the user uses up/down to display input longer than this non-rendered
# length then the original bug will manifest (screwed up prompt)
# - if the terminal's width is smaller than the non-rendered prompt length
# then the cursor and some movement will be displaced
if COLOR_PROMPT:
prompt = format(">>> ", Color.GREEN, Attr.BOLD)
majorVersion = sys.version_info[0]
minorVersion = sys.version_info[1]
if majorVersion <= 2 and minorVersion <= 6:
prompt += "\x1b[0m" * 10
else:
prompt = ">>> "
input = ""
# sets up tab autocompetion
torCommands = TorControlCompleter()
readline.parse_and_bind("tab: complete")
readline.set_completer(torCommands.complete)
# Essentially disables autocompletion by word delimiters. This is because
# autocompletion options are full commands (ex. "GETINFO version") so we want
# "GETINFO" to match to all the options rather than be treated as a complete
# command by itself.
readline.set_completer_delims("\n")
interpretor = ControlInterpretor()
print INIT_MSG
while True:
try:
input = raw_input(prompt)
_, outputEntry = interpretor.handleQuery(input)
except (KeyboardInterrupt, Exception), exc:
if isinstance(exc, InterpretorClosed) and str(exc):
print format(str(exc), *ERROR_FORMAT)
# moves cursor to the next line and terminates (most commonly
# KeyboardInterrupt and EOFErro)
print
torTools.NO_SPAWN = True
torTools.getConn().close()
# stop daemons
hostnames.stop()
break
for line in outputEntry:
outputLine = ""
for msg, msgFormat in line:
outputLine += format(msg, *msgFormat)
print outputLine
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, msgFormat = entry.pop(0)
if "\n" in msg:
msg, remainder = msg.split("\n", 1)
entry.insert(0, (remainder, msgFormat))
tmpLine.append((msg, msgFormat))
results.append(tmpLine)
tmpLine = []
else:
tmpLine.append((msg, msgFormat))
if tmpLine: results.append(tmpLine)
return results
|