control-spec.txt
上传用户:awang829
上传日期:2019-07-14
资源大小:2356k
文件大小:75k
源码类别:

网络

开发平台:

Unix_Linux

  1. $Id$
  2.                    TC: A Tor control protocol (Version 1)
  3. 0. Scope
  4.   This document describes an implementation-specific protocol that is used
  5.   for other programs (such as frontend user-interfaces) to communicate with a
  6.   locally running Tor process.  It is not part of the Tor onion routing
  7.   protocol.
  8.   This protocol replaces version 0 of TC, which is now deprecated.  For
  9.   reference, TC is described in "control-spec-v0.txt".  Implementors are
  10.   recommended to avoid using TC directly, but instead to use a library that
  11.   can easily be updated to use the newer protocol.  (Version 0 is used by Tor
  12.   versions 0.1.0.x; the protocol in this document only works with Tor
  13.   versions in the 0.1.1.x series and later.)
  14. 1. Protocol outline
  15.   TC is a bidirectional message-based protocol.  It assumes an underlying
  16.   stream for communication between a controlling process (the "client"
  17.   or "controller") and a Tor process (or "server").  The stream may be
  18.   implemented via TCP, TLS-over-TCP, a Unix-domain socket, or so on,
  19.   but it must provide reliable in-order delivery.  For security, the
  20.   stream should not be accessible by untrusted parties.
  21.   In TC, the client and server send typed messages to each other over the
  22.   underlying stream.  The client sends "commands" and the server sends
  23.   "replies".
  24.   By default, all messages from the server are in response to messages from
  25.   the client.  Some client requests, however, will cause the server to send
  26.   messages to the client indefinitely far into the future.  Such
  27.   "asynchronous" replies are marked as such.
  28.   Servers respond to messages in the order messages are received.
  29. 2. Message format
  30. 2.1. Description format
  31.   The message formats listed below use ABNF as described in RFC 2234.
  32.   The protocol itself is loosely based on SMTP (see RFC 2821).
  33.   We use the following nonterminals from RFC 2822: atom, qcontent
  34.   We define the following general-use nonterminals:
  35.      String = DQUOTE *qcontent DQUOTE
  36.   There are explicitly no limits on line length.  All 8-bit characters are
  37.   permitted unless explicitly disallowed.
  38.   Wherever CRLF is specified to be accepted from the controller, Tor MAY also
  39.   accept LF.  Tor, however, MUST NOT generate LF instead of CRLF.
  40.   Controllers SHOULD always send CRLF.
  41. 2.2. Commands from controller to Tor
  42.     Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data
  43.     Keyword = 1*ALPHA
  44.     Arguments = *(SP / VCHAR)
  45.   Specific commands and their arguments are described below in section 3.
  46. 2.3. Replies from Tor to the controller
  47.     Reply = SyncReply / AsyncReply
  48.     SyncReply = *(MidReplyLine / DataReplyLine) EndReplyLine
  49.     AsyncReply = *(MidReplyLine / DataReplyLine) EndReplyLine
  50.     MidReplyLine = StatusCode "-" ReplyLine
  51.     DataReplyLine = StatusCode "+" ReplyLine Data
  52.     EndReplyLine = StatusCode SP ReplyLine
  53.     ReplyLine = [ReplyText] CRLF
  54.     ReplyText = XXXX
  55.     StatusCode = 3DIGIT
  56.   Specific replies are mentioned below in section 3, and described more fully
  57.   in section 4.
  58.   [Compatibility note:  versions of Tor before 0.2.0.3-alpha sometimes
  59.   generate AsyncReplies of the form "*(MidReplyLine / DataReplyLine)".
  60.   This is incorrect, but controllers that need to work with these
  61.   versions of Tor should be prepared to get multi-line AsyncReplies with
  62.   the final line (usually "650 OK") omitted.]
  63. 2.4. General-use tokens
  64.   ; Identifiers for servers.
  65.   ServerID = Nickname / Fingerprint
  66.   Nickname = 1*19 NicknameChar
  67.   NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
  68.   Fingerprint = "$" 40*HEXDIG
  69.   ; A "=" indicates that the given nickname is canonical; a "~" indicates
  70.   ; that the given nickname is not canonical.  If no nickname is given at
  71.   ; all, Tor does not even have a guess for what this router calls itself.
  72.   LongName = Fingerprint [ ( "=" / "~" ) Nickname ]
  73.   ; How a controller tells Tor about a particular OR.  There are four
  74.   ; possible formats:
  75.   ;    $Digest -- The router whose identity key hashes to the given digest.
  76.   ;        This is the preferred way to refer to an OR.
  77.   ;    $Digest~Name -- The router whose identity key hashes to the given
  78.   ;        digest, but only if the router has the given nickname.
  79.   ;    $Digest=Name -- The router whose identity key hashes to the given
  80.   ;        digest, but only if the router is Named and has the given
  81.   ;        nickname.
  82.   ;    Name -- The Named router with the given nickname, or, if no such
  83.   ;        router exists, any router whose nickname matches the one given.
  84.   ;        This is not a safe way to refer to routers, since Named status
  85.   ;        could under some circumstances change over time.
  86.   ServerSpec = LongName / Nickname
  87.   ; Unique identifiers for streams or circuits.  Currently, Tor only
  88.   ; uses digits, but this may change
  89.   StreamID = 1*16 IDChar
  90.   CircuitID = 1*16 IDChar
  91.   IDChar = ALPHA / DIGIT
  92.   Address = ip4-address / ip6-address / hostname   (XXXX Define these)
  93.   ; A "Data" section is a sequence of octets concluded by the terminating
  94.   ; sequence CRLF "." CRLF.  The terminating sequence may not appear in the
  95.   ; body of the data.  Leading periods on lines in the data are escaped with
  96.   ; an additional leading period as in RFC 2821 section 4.5.2.
  97.   Data = *DataLine "." CRLF
  98.   DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
  99.   LineItem = NonCR / 1*CR NonCRLF
  100.   NonDotItem = NonDotCR / 1*CR NonCRLF
  101. 3. Commands
  102.   All commands are case-insensitive, but most keywords are case-sensitive.
  103. 3.1. SETCONF
  104.   Change the value of one or more configuration variables.  The syntax is:
  105.     "SETCONF" 1*(SP keyword ["=" value]) CRLF
  106.     value = String / QuotedString
  107.   Tor behaves as though it had just read each of the key-value pairs
  108.   from its configuration file.  Keywords with no corresponding values have
  109.   their configuration values reset to 0 or NULL (use RESETCONF if you want
  110.   to set it back to its default).  SETCONF is all-or-nothing: if there
  111.   is an error in any of the configuration settings, Tor sets none of them.
  112.   Tor responds with a "250 configuration values set" reply on success.
  113.   If some of the listed keywords can't be found, Tor replies with a
  114.   "552 Unrecognized option" message. Otherwise, Tor responds with a
  115.   "513 syntax error in configuration values" reply on syntax error, or a
  116.   "553 impossible configuration setting" reply on a semantic error.
  117.   When a configuration option takes multiple values, or when multiple
  118.   configuration keys form a context-sensitive group (see GETCONF below), then
  119.   setting _any_ of the options in a SETCONF command is taken to reset all of
  120.   the others.  For example, if two ORBindAddress values are configured, and a
  121.   SETCONF command arrives containing a single ORBindAddress value, the new
  122.   command's value replaces the two old values.
  123.   Sometimes it is not possible to change configuration options solely by
  124.   issuing a series of SETCONF commands, because the value of one of the
  125.   configuration options depends on the value of another which has not yet
  126.   been set. Such situations can be overcome by setting multiple configuration
  127.   options with a single SETCONF command (e.g. SETCONF ORPort=443
  128.   ORListenAddress=9001).
  129. 3.2. RESETCONF
  130.   Remove all settings for a given configuration option entirely, assign
  131.   its default value (if any), and then assign the String provided.
  132.   Typically the String is left empty, to simply set an option back to
  133.   its default. The syntax is:
  134.     "RESETCONF" 1*(SP keyword ["=" String]) CRLF
  135.   Otherwise it behaves like SETCONF above.
  136. 3.3. GETCONF
  137.   Request the value of a configuration variable.  The syntax is:
  138.     "GETCONF" 1*(SP keyword) CRLF
  139.   If all of the listed keywords exist in the Tor configuration, Tor replies
  140.   with a series of reply lines of the form:
  141.       250 keyword=value
  142.   If any option is set to a 'default' value semantically different from an
  143.   empty string, Tor may reply with a reply line of the form:
  144.       250 keyword
  145.   Value may be a raw value or a quoted string.  Tor will try to use
  146.   unquoted values except when the value could be misinterpreted through
  147.   not being quoted.
  148.   If some of the listed keywords can't be found, Tor replies with a
  149.   "552 unknown configuration keyword" message.
  150.   If an option appears multiple times in the configuration, all of its
  151.   key-value pairs are returned in order.
  152.   Some options are context-sensitive, and depend on other options with
  153.   different keywords.  These cannot be fetched directly.  Currently there
  154.   is only one such option: clients should use the "HiddenServiceOptions"
  155.   virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  156.   HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
  157. 3.4. SETEVENTS
  158.   Request the server to inform the client about interesting events.  The
  159.   syntax is:
  160.      "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
  161.      EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
  162.          "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
  163.          "AUTHDIR_NEWDESCS" / "DESCCHANGED" / "STATUS_GENERAL" /
  164.          "STATUS_CLIENT" / "STATUS_SERVER" / "GUARD" / "NS" / "STREAM_BW" /
  165.          "CLIENTS_SEEN"
  166.   Any events *not* listed in the SETEVENTS line are turned off; thus, sending
  167.   SETEVENTS with an empty body turns off all event reporting.
  168.   The server responds with a "250 OK" reply on success, and a "552
  169.   Unrecognized event" reply if one of the event codes isn't recognized.  (On
  170.   error, the list of active event codes isn't changed.)
  171.   If the flag string "EXTENDED" is provided, Tor may provide extra
  172.   information with events for this connection; see 4.1 for more information.
  173.   NOTE: All events on a given connection will be provided in extended format,
  174.   or none.
  175.   NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.
  176.   Each event is described in more detail in Section 4.1.
  177. 3.5. AUTHENTICATE
  178.   Sent from the client to the server.  The syntax is:
  179.      "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
  180.   The server responds with "250 OK" on success or "515 Bad authentication" if
  181.   the authentication cookie is incorrect.  Tor closes the connection on an
  182.   authentication failure.
  183.   The format of the 'cookie' is implementation-dependent; see 5.1 below for
  184.   information on how the standard Tor implementation handles it.
  185.   Before the client has authenticated, no command other than PROTOCOLINFO,
  186.   AUTHENTICATE, or QUIT is valid.  If the controller sends any other command,
  187.   or sends a malformed command, or sends an unsuccessful AUTHENTICATE
  188.   command, or sends PROTOCOLINFO more than once, Tor sends an error reply and
  189.   closes the connection.
  190.   To prevent some cross-protocol attacks, the AUTHENTICATE command is still
  191.   required even if all authentication methods in Tor are disabled.  In this
  192.   case, the controller should just send "AUTHENTICATE" CRLF.
  193.   (Versions of Tor before 0.1.2.16 and 0.2.0.4-alpha did not close the
  194.   connection after an authentication failure.)
  195. 3.6. SAVECONF
  196.   Sent from the client to the server.  The syntax is:
  197.      "SAVECONF" CRLF
  198.   Instructs the server to write out its config options into its torrc. Server
  199.   returns "250 OK" if successful, or "551 Unable to write configuration
  200.   to disk" if it can't write the file or some other error occurs.
  201. 3.7. SIGNAL
  202.   Sent from the client to the server. The syntax is:
  203.      "SIGNAL" SP Signal CRLF
  204.      Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
  205.               "HUP" / "INT" / "USR1" / "USR2" / "TERM" / "NEWNYM" /
  206.               "CLEARDNSCACHE"
  207.   The meaning of the signals are:
  208.       RELOAD    -- Reload: reload config items, refetch directory. (like HUP)
  209.       SHUTDOWN  -- Controlled shutdown: if server is an OP, exit immediately.
  210.                    If it's an OR, close listeners and exit after 30 seconds.
  211.                    (like INT)
  212.       DUMP      -- Dump stats: log information about open connections and
  213.                    circuits. (like USR1)
  214.       DEBUG     -- Debug: switch all open logs to loglevel debug. (like USR2)
  215.       HALT      -- Immediate shutdown: clean up and exit now. (like TERM)
  216.       CLEARDNSCACHE -- Forget the client-side cached IPs for all hostnames.
  217.       NEWNYM    -- Switch to clean circuits, so new application requests
  218.                    don't share any circuits with old ones.  Also clears
  219.                    the client-side DNS cache.  (Tor MAY rate-limit its
  220.                    response to this signal.)
  221.   The server responds with "250 OK" if the signal is recognized (or simply
  222.   closes the socket if it was asked to close immediately), or "552
  223.   Unrecognized signal" if the signal is unrecognized.
  224. 3.8. MAPADDRESS
  225.   Sent from the client to the server.  The syntax is:
  226.     "MAPADDRESS" 1*(Address "=" Address SP) CRLF
  227.   The first address in each pair is an "original" address; the second is a
  228.   "replacement" address.  The client sends this message to the server in
  229.   order to tell it that future SOCKS requests for connections to the original
  230.   address should be replaced with connections to the specified replacement
  231.   address.  If the addresses are well-formed, and the server is able to
  232.   fulfill the request, the server replies with a 250 message:
  233.     250-OldAddress1=NewAddress1
  234.     250 OldAddress2=NewAddress2
  235.   containing the source and destination addresses.  If request is
  236.   malformed, the server replies with "512 syntax error in command
  237.   argument".  If the server can't fulfill the request, it replies with
  238.   "451 resource exhausted".
  239.   The client may decline to provide a body for the original address, and
  240.   instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  241.   "." for hostname), signifying that the server should choose the original
  242.   address itself, and return that address in the reply.  The server
  243.   should ensure that it returns an element of address space that is unlikely
  244.   to be in actual use.  If there is already an address mapped to the
  245.   destination address, the server may reuse that mapping.
  246.   If the original address is already mapped to a different address, the old
  247.   mapping is removed.  If the original address and the destination address
  248.   are the same, the server removes any mapping in place for the original
  249.   address.
  250.   Example:
  251.     C: MAPADDRESS 0.0.0.0=torproject.org 1.2.3.4=tor.freehaven.net
  252.     S: 250-127.192.10.10=torproject.org
  253.     S: 250 1.2.3.4=tor.freehaven.net
  254.   {Note: This feature is designed to be used to help Tor-ify applications
  255.   that need to use SOCKS4 or hostname-less SOCKS5.  There are three
  256.   approaches to doing this:
  257.      1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
  258.      2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
  259.         feature) to resolve the hostname remotely.  This doesn't work
  260.         with special addresses like x.onion or x.y.exit.
  261.      3. Use MAPADDRESS to map an IP address to the desired hostname, and then
  262.         arrange to fool the application into thinking that the hostname
  263.         has resolved to that IP.
  264.   This functionality is designed to help implement the 3rd approach.}
  265.   Mappings set by the controller last until the Tor process exits:
  266.   they never expire. If the controller wants the mapping to last only
  267.   a certain time, then it must explicitly un-map the address when that
  268.   time has elapsed.
  269. 3.9. GETINFO
  270.   Sent from the client to the server.  The syntax is as for GETCONF:
  271.     "GETINFO" 1*(SP keyword) CRLF
  272.   one or more NL-terminated strings.  The server replies with an INFOVALUE
  273.   message, or a 551 or 552 error.
  274.   Unlike GETCONF, this message is used for data that are not stored in the Tor
  275.   configuration file, and that may be longer than a single line.  On success,
  276.   one ReplyLine is sent for each requested value, followed by a final 250 OK
  277.   ReplyLine.  If a value fits on a single line, the format is:
  278.       250-keyword=value
  279.   If a value must be split over multiple lines, the format is:
  280.       250+keyword=
  281.       value
  282.       .
  283.   Recognized keys and their values include:
  284.     "version" -- The version of the server's software, including the name
  285.       of the software. (example: "Tor 0.0.9.4")
  286.     "config-file" -- The location of Tor's configuration file ("torrc").
  287.     ["exit-policy/prepend" -- The default exit policy lines that Tor will
  288.       *prepend* to the ExitPolicy config option.
  289.      -- Never implemented. Useful?]
  290.     "exit-policy/default" -- The default exit policy lines that Tor will
  291.       *append* to the ExitPolicy config option.
  292.     "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest
  293.       server descriptor for a given OR, NUL-terminated.
  294.     "desc-annotations/id/<OR identity>" -- outputs the annotations string
  295.       (source, timestamp of arrival, purpose, etc) for the corresponding
  296.       descriptor. [First implemented in 0.2.0.13-alpha.]
  297.     "extra-info/digest/<digest>"  -- the extrainfo document whose digest (in
  298.       hex) is <digest>.  Only available if we're downloading extra-info
  299.       documents.
  300.     "ns/id/<OR identity>" or "ns/name/<OR nickname>" -- the latest router
  301.       status info (v2 directory style) for a given OR.  Router status
  302.       info is as given in
  303.       dir-spec.txt, and reflects the current beliefs of this Tor about the
  304.       router in question. Like directory clients, controllers MUST
  305.       tolerate unrecognized flags and lines.  The published date and
  306.       descriptor digest are those believed to be best by this Tor,
  307.       not necessarily those for a descriptor that Tor currently has.
  308.       [First implemented in 0.1.2.3-alpha.]
  309.     "ns/all" -- Router status info (v2 directory style) for all ORs we
  310.       have an opinion about, joined by newlines. [First implemented
  311.       in 0.1.2.3-alpha.]
  312.     "ns/purpose/<purpose>" -- Router status info (v2 directory style)
  313.       for all ORs of this purpose. Mostly designed for /ns/purpose/bridge
  314.       queries. [First implemented in 0.2.0.13-alpha.]
  315.     "desc/all-recent" -- the latest server descriptor for every router that
  316.       Tor knows about.
  317.     "network-status" -- a space-separated list (v1 directory style)
  318.       of all known OR identities. This is in the same format as the
  319.       router-status line in v1 directories; see dir-spec-v1.txt section
  320.       3 for details.  (If VERBOSE_NAMES is enabled, the output will
  321.       not conform to dir-spec-v1.txt; instead, the result will be a
  322.       space-separated list of LongName, each preceded by a "!" if it is
  323.       believed to be not running.) This option is deprecated; use
  324.       "ns/all" instead.
  325.     "address-mappings/all"
  326.     "address-mappings/config"
  327.     "address-mappings/cache"
  328.     "address-mappings/control" -- a rn-separated list of address
  329.       mappings, each in the form of "from-address to-address expiry".
  330.       The 'config' key returns those address mappings set in the
  331.       configuration; the 'cache' key returns the mappings in the
  332.       client-side DNS cache; the 'control' key returns the mappings set
  333.       via the control interface; the 'all' target returns the mappings
  334.       set through any mechanism.
  335.       Expiry is formatted as with ADDRMAP events, except that "expiry" is
  336.       always a time in GMT or the string "NEVER"; see section 4.1.7.
  337.       First introduced in 0.2.0.3-alpha.
  338.     "addr-mappings/*" -- as for address-mappings/*, but without the
  339.       expiry portion of the value.  Use of this value is deprecated
  340.       since 0.2.0.3-alpha; use address-mappings instead.
  341.     "address" -- the best guess at our external IP address. If we
  342.       have no guess, return a 551 error. (Added in 0.1.2.2-alpha)
  343.     "fingerprint" -- the contents of the fingerprint file that Tor
  344.       writes as a server, or a 551 if we're not a server currently.
  345.       (Added in 0.1.2.3-alpha)
  346.     "circuit-status"
  347.       A series of lines as for a circuit status event. Each line is of
  348.       the form:
  349.          CircuitID SP CircStatus [SP Path] CRLF
  350.     "stream-status"
  351.       A series of lines as for a stream status event.  Each is of the form:
  352.          StreamID SP StreamStatus SP CircID SP Target CRLF
  353.     "orconn-status"
  354.       A series of lines as for an OR connection status event.  Each is of the
  355.       form:
  356.          ServerID SP ORStatus CRLF
  357.     "entry-guards"
  358.       A series of lines listing the currently chosen entry guards, if any.
  359.       Each is of the form:
  360.          ServerID2 SP Status [SP ISOTime] CRLF
  361.          Status-with-time = ("unlisted") SP ISOTime
  362.          Status = ("up" / "never-connected" / "down" /
  363.                       "unusable" / "unlisted" )
  364.          ServerID2 = Nickname / 40*HEXDIG
  365.       [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
  366.        Tor still supports calling it that for now, but support will be
  367.        removed in 0.1.3.x.]
  368.       [Older versions of Tor (before 0.1.2.x-final) generated 'down' instead
  369.        of unlisted/unusable.  Current Tors never generate 'down'.]
  370.       [XXXX ServerID2 differs from ServerID in not prefixing fingerprints
  371.        with a $.  This is an implementation error.  It would be nice to add
  372.        the $ back in if we can do so without breaking compatibility.]
  373.     "accounting/enabled"
  374.     "accounting/hibernating"
  375.     "accounting/bytes"
  376.     "accounting/bytes-left"
  377.     "accounting/interval-start"
  378.     "accounting/interval-wake"
  379.     "accounting/interval-end"
  380.       Information about accounting status.  If accounting is enabled,
  381.       "enabled" is 1; otherwise it is 0.  The "hibernating" field is "hard"
  382.       if we are accepting no data; "soft" if we're accepting no new
  383.       connections, and "awake" if we're not hibernating at all.  The "bytes"
  384.       and "bytes-left" fields contain (read-bytes SP write-bytes), for the
  385.       start and the rest of the interval respectively.  The 'interval-start'
  386.       and 'interval-end' fields are the borders of the current interval; the
  387.       'interval-wake' field is the time within the current interval (if any)
  388.       where we plan[ned] to start being active.
  389.     "config/names"
  390.       A series of lines listing the available configuration options. Each is
  391.       of the form:
  392.          OptionName SP OptionType [ SP Documentation ] CRLF
  393.          OptionName = Keyword
  394.          OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
  395.            "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
  396.            "String" / "LineList"
  397.          Documentation = Text
  398.     "info/names"
  399.       A series of lines listing the available GETINFO options.  Each is of
  400.       one of these forms:
  401.          OptionName SP Documentation CRLF
  402.          OptionPrefix SP Documentation CRLF
  403.          OptionPrefix = OptionName "/*"
  404.     "events/names"
  405.       A space-separated list of all the events supported by this version of
  406.       Tor's SETEVENTS.
  407.     "features/names"
  408.       A space-separated list of all the events supported by this version of
  409.       Tor's USEFEATURE.
  410.     "ip-to-country/*"
  411.       Maps IP addresses to 2-letter country codes.  For example,
  412.       "GETINFO ip-to-country/18.0.0.1" should give "US".
  413.     "next-circuit/IP:port"
  414.       XXX todo.
  415.     "dir/status-vote/current/consensus" [added in Tor 0.2.1.6-alpha]
  416.     "dir/status/authority"
  417.     "dir/status/fp/<F>"
  418.     "dir/status/fp/<F1>+<F2>+<F3>"
  419.     "dir/status/all"
  420.     "dir/server/fp/<F>"
  421.     "dir/server/fp/<F1>+<F2>+<F3>"
  422.     "dir/server/d/<D>"
  423.     "dir/server/d/<D1>+<D2>+<D3>"
  424.     "dir/server/authority"
  425.     "dir/server/all"
  426.       A series of lines listing directory contents, provided according to the
  427.       specification for the URLs listed in Section 4.4 of dir-spec.txt.  Note
  428.       that Tor MUST NOT provide private information, such as descriptors for
  429.       routers not marked as general-purpose.  When asked for 'authority'
  430.       information for which this Tor is not authoritative, Tor replies with
  431.       an empty string.
  432.     "status/circuit-established"
  433.     "status/enough-dir-info"
  434.     "status/good-server-descriptor"
  435.     "status/accepted-server-descriptor"
  436.     "status/..."
  437.       These provide the current internal Tor values for various Tor
  438.       states. See Section 4.1.10 for explanations. (Only a few of the
  439.       status events are available as getinfo's currently. Let us know if
  440.       you want more exposed.)
  441.     "status/reachability/or"
  442.       0 or 1, depending on whether we've found our ORPort reachable.
  443.     "status/reachability/dir"
  444.       0 or 1, depending on whether we've found our DirPort reachable.
  445.     "status/reachability"
  446.       "OR=" ("0"/"1") SP "DIR=" ("0"/"1")
  447.       Combines status/reachability/*; controllers MUST ignore unrecognized
  448.       elements in this entry.
  449.     "status/bootstrap-phase"
  450.       Returns the most recent bootstrap phase status event
  451.       sent. Specifically, it returns a string starting with either
  452.       "NOTICE BOOTSTRAP ..." or "WARN BOOTSTRAP ...". Controllers should
  453.       use this getinfo when they connect or attach to Tor to learn its
  454.       current bootstrap state.
  455.     "status/version/recommended"
  456.       List of currently recommended versions.
  457.     "status/version/current"
  458.       Status of the current version. One of: new, old, unrecommended,
  459.       recommended, new in series, obsolete.
  460.     "status/clients-seen"
  461.       A summary of which countries we've seen clients from recently,
  462.       formatted the same as the CLIENTS_SEEN status event described in
  463.       Section 4.1.14. This GETINFO option is currently available only
  464.       for bridge relays.
  465.   Examples:
  466.      C: GETINFO version desc/name/moria1
  467.      S: 250+desc/name/moria=
  468.      S: [Descriptor for moria]
  469.      S: .
  470.      S: 250-version=Tor 0.1.1.0-alpha-cvs
  471.      S: 250 OK
  472. 3.10. EXTENDCIRCUIT
  473.   Sent from the client to the server.  The format is:
  474.       "EXTENDCIRCUIT" SP CircuitID SP
  475.                       ServerSpec *("," ServerSpec)
  476.                       [SP "purpose=" Purpose] CRLF
  477.   This request takes one of two forms: either the CircuitID is zero, in
  478.   which case it is a request for the server to build a new circuit according
  479.   to the specified path, or the CircuitID is nonzero, in which case it is a
  480.   request for the server to extend an existing circuit with that ID according
  481.   to the specified path.
  482.   If CircuitID is 0 and "purpose=" is specified, then the circuit's
  483.   purpose is set. Two choices are recognized: "general" and
  484.   "controller". If not specified, circuits are created as "general".
  485.   If the request is successful, the server sends a reply containing a
  486.   message body consisting of the CircuitID of the (maybe newly created)
  487.   circuit. The syntax is "250" SP "EXTENDED" SP CircuitID CRLF.
  488. 3.11. SETCIRCUITPURPOSE
  489.   Sent from the client to the server.  The format is:
  490.       "SETCIRCUITPURPOSE" SP CircuitID SP Purpose CRLF
  491.   This changes the circuit's purpose. See EXTENDCIRCUIT above for details.
  492. 3.12. SETROUTERPURPOSE
  493.   Sent from the client to the server.  The format is:
  494.       "SETROUTERPURPOSE" SP NicknameOrKey SP Purpose CRLF
  495.   This changes the descriptor's purpose. See +POSTDESCRIPTOR below
  496.   for details.
  497.   NOTE: This command was disabled and made obsolete as of Tor
  498.   0.2.0.8-alpha. It doesn't exist anymore, and is listed here only for
  499.   historical interest.
  500. 3.13. ATTACHSTREAM
  501.   Sent from the client to the server.  The syntax is:
  502.      "ATTACHSTREAM" SP StreamID SP CircuitID [SP "HOP=" HopNum] CRLF
  503.   This message informs the server that the specified stream should be
  504.   associated with the specified circuit.  Each stream may be associated with
  505.   at most one circuit, and multiple streams may share the same circuit.
  506.   Streams can only be attached to completed circuits (that is, circuits that
  507.   have sent a circuit status 'BUILT' event or are listed as built in a
  508.   GETINFO circuit-status request).
  509.   If the circuit ID is 0, responsibility for attaching the given stream is
  510.   returned to Tor.
  511.   If HOP=HopNum is specified, Tor will choose the HopNumth hop in the
  512.   circuit as the exit node, rather than the last node in the circuit.
  513.   Hops are 1-indexed; generally, it is not permitted to attach to hop 1.
  514.   Tor responds with "250 OK" if it can attach the stream, 552 if the circuit
  515.   or stream didn't exist, or 551 if the stream couldn't be attached for
  516.   another reason.
  517.   {Implementation note: Tor will close unattached streams by itself,
  518.   roughly two minutes after they are born. Let the developers know if
  519.   that turns out to be a problem.}
  520.   {Implementation note: By default, Tor automatically attaches streams to
  521.   circuits itself, unless the configuration variable
  522.   "__LeaveStreamsUnattached" is set to "1".  Attempting to attach streams
  523.   via TC when "__LeaveStreamsUnattached" is false may cause a race between
  524.   Tor and the controller, as both attempt to attach streams to circuits.}
  525.   {Implementation note: You can try to attachstream to a stream that
  526.   has already sent a connect or resolve request but hasn't succeeded
  527.   yet, in which case Tor will detach the stream from its current circuit
  528.   before proceeding with the new attach request.}
  529. 3.14. POSTDESCRIPTOR
  530.   Sent from the client to the server. The syntax is:
  531.     "+POSTDESCRIPTOR" [SP "purpose=" Purpose] [SP "cache=" Cache]
  532.                       CRLF Descriptor CRLF "." CRLF
  533.   This message informs the server about a new descriptor. If Purpose is
  534.   specified, it must be either "general", "controller", or "bridge",
  535.   else we return a 552 error. The default is "general".
  536.   If Cache is specified, it must be either "no" or "yes", else we
  537.   return a 552 error. If Cache is not specified, Tor will decide for
  538.   itself whether it wants to cache the descriptor, and controllers
  539.   must not rely on its choice.
  540.   The descriptor, when parsed, must contain a number of well-specified
  541.   fields, including fields for its nickname and identity.
  542.   If there is an error in parsing the descriptor, the server must send a
  543.   "554 Invalid descriptor" reply. If the descriptor is well-formed but
  544.   the server chooses not to add it, it must reply with a 251 message
  545.   whose body explains why the server was not added. If the descriptor
  546.   is added, Tor replies with "250 OK".
  547. 3.15. REDIRECTSTREAM
  548.   Sent from the client to the server. The syntax is:
  549.     "REDIRECTSTREAM" SP StreamID SP Address [SP Port] CRLF
  550.   Tells the server to change the exit address on the specified stream.  If
  551.   Port is specified, changes the destination port as well.  No remapping
  552.   is performed on the new provided address.
  553.   To be sure that the modified address will be used, this event must be sent
  554.   after a new stream event is received, and before attaching this stream to
  555.   a circuit.
  556.   Tor replies with "250 OK" on success.
  557. 3.16. CLOSESTREAM
  558.   Sent from the client to the server.  The syntax is:
  559.     "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
  560.   Tells the server to close the specified stream.  The reason should be one
  561.   of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal.  Flags is
  562.   not used currently; Tor servers SHOULD ignore unrecognized flags.  Tor may
  563.   hold the stream open for a while to flush any data that is pending.
  564.   Tor replies with "250 OK" on success, or a 512 if there aren't enough
  565.   arguments, or a 552 if it doesn't recognize the StreamID or reason.
  566. 3.17. CLOSECIRCUIT
  567.    The syntax is:
  568.      CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
  569.      Flag = "IfUnused"
  570.   Tells the server to close the specified circuit.   If "IfUnused" is
  571.   provided, do not close the circuit unless it is unused.
  572.   Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  573.   flags.
  574.   Tor replies with "250 OK" on success, or a 512 if there aren't enough
  575.   arguments, or a 552 if it doesn't recognize the CircuitID.
  576. 3.18. QUIT
  577.   Tells the server to hang up on this controller connection. This command
  578.   can be used before authenticating.
  579. 3.19. USEFEATURE
  580.   The syntax is:
  581.     "USEFEATURE" *(SP FeatureName) CRLF
  582.     FeatureName = 1*(ALPHA / DIGIT / "_" / "-")
  583.   Sometimes extensions to the controller protocol break compatibility with
  584.   older controllers.  In this case, whenever possible, the extensions are
  585.   first included in Tor disabled by default, and only enabled on a given
  586.   controller connection when the "USEFEATURE" command is given.  Once a
  587.   "USEFEATURE" command is given, it applies to all subsequent interactions on
  588.   the same connection; to disable an enabled feature, a new controller
  589.   connection must be opened.
  590.   This is a forward-compatibility mechanism; each feature will eventually
  591.   become a regular part of the control protocol in some future version of Tor.
  592.   Tor will ignore a request to use any feature that is already on by default.
  593.   Tor will give a "552" error if any requested feature is not recognized.
  594.   Feature names are case-insensitive.
  595.   EXTENDED_EVENTS
  596.      Same as passing 'EXTENDED' to SETEVENTS; this is the preferred way to
  597.      request the extended event syntax.
  598.      This will not be always-enabled until at least two stable releases
  599.      after 0.1.2.3-alpha, the release where it was first used for
  600.      anything.
  601.   VERBOSE_NAMES
  602.      Instead of ServerID as specified above, the controller should
  603.      identify ORs by LongName in events and GETINFO results.  This format is
  604.      strictly more informative: rather than including Nickname for
  605.      known Named routers and Fingerprint for unknown or unNamed routers, the
  606.      LongName format includes a Fingerprint, an indication of Named status,
  607.      and a Nickname (if one is known).
  608.      This will not be always-enabled until at least two stable releases
  609.      after 0.1.2.2-alpha, the release where it was first available.
  610. 3.20. RESOLVE
  611.   The syntax is
  612.     "RESOLVE" *Option *Address CRLF
  613.     Option = "mode=reverse"
  614.     Address = a hostname or IPv4 address
  615.   This command launches a remote hostname lookup request for every specified
  616.   request (or reverse lookup if "mode=reverse" is specified).  Note that the
  617.   request is done in the background: to see the answers, your controller will
  618.   need to listen for ADDRMAP events; see 4.1.7 below.
  619.   [Added in Tor 0.2.0.3-alpha]
  620. 3.21. PROTOCOLINFO
  621.   The syntax is:
  622.     "PROTOCOLINFO" *(SP PIVERSION) CRLF
  623.   The server reply format is:
  624.     "250-PROTOCOLINFO" SP PIVERSION CRLF *InfoLine "250 OK" CRLF
  625.     InfoLine = AuthLine / VersionLine / OtherLine
  626.      AuthLine = "250-AUTH" SP "METHODS=" AuthMethod *(",")AuthMethod
  627.                        *(SP "COOKIEFILE=" AuthCookieFile) CRLF
  628.      VersionLine = "250-VERSION" SP "Tor=" TorVersion [SP Arguments] CRLF
  629.      AuthMethod =
  630.       "NULL"           / ; No authentication is required
  631.       "HASHEDPASSWORD" / ; A controller must supply the original password
  632.       "COOKIE"         / ; A controller must supply the contents of a cookie
  633.      AuthCookieFile = QuotedString
  634.      TorVersion = QuotedString
  635.      OtherLine = "250-" Keyword [SP Arguments] CRLF
  636.     PIVERSION: 1*DIGIT
  637.   Tor MAY give its InfoLines in any order; controllers MUST ignore InfoLines
  638.   with keywords they do not recognize.  Controllers MUST ignore extraneous
  639.   data on any InfoLine.
  640.   PIVERSION is there in case we drastically change the syntax one day. For
  641.   now it should always be "1".  Controllers MAY provide a list of the
  642.   protocolinfo versions they support; Tor MAY select a version that the
  643.   controller does not support.
  644.   AuthMethod is used to specify one or more control authentication
  645.   methods that Tor currently accepts.
  646.   AuthCookieFile specifies the absolute path and filename of the
  647.   authentication cookie that Tor is expecting and is provided iff
  648.   the METHODS field contains the method "COOKIE".  Controllers MUST handle
  649.   escape sequences inside this string.
  650.   The VERSION line contains the Tor version.
  651.   [Unlike other commands besides AUTHENTICATE, PROTOCOLINFO may be used (but
  652.   only once!) before AUTHENTICATE.]
  653.   [PROTOCOLINFO was not supported before Tor 0.2.0.5-alpha.]
  654. 4. Replies
  655.   Reply codes follow the same 3-character format as used by SMTP, with the
  656.   first character defining a status, the second character defining a
  657.   subsystem, and the third designating fine-grained information.
  658.   The TC protocol currently uses the following first characters:
  659.     2yz   Positive Completion Reply
  660.        The command was successful; a new request can be started.
  661.     4yz   Temporary Negative Completion reply
  662.        The command was unsuccessful but might be reattempted later.
  663.     5yz   Permanent Negative Completion Reply
  664.        The command was unsuccessful; the client should not try exactly
  665.        that sequence of commands again.
  666.     6yz   Asynchronous Reply
  667.        Sent out-of-order in response to an earlier SETEVENTS command.
  668.   The following second characters are used:
  669.     x0z   Syntax
  670.        Sent in response to ill-formed or nonsensical commands.
  671.     x1z   Protocol
  672.        Refers to operations of the Tor Control protocol.
  673.     x5z   Tor
  674.        Refers to actual operations of Tor system.
  675.   The following codes are defined:
  676.      250 OK
  677.      251 Operation was unnecessary
  678.          [Tor has declined to perform the operation, but no harm was done.]
  679.      451 Resource exhausted
  680.      500 Syntax error: protocol
  681.      510 Unrecognized command
  682.      511 Unimplemented command
  683.      512 Syntax error in command argument
  684.      513 Unrecognized command argument
  685.      514 Authentication required
  686.      515 Bad authentication
  687.      550 Unspecified Tor error
  688.      551 Internal error
  689.                [Something went wrong inside Tor, so that the client's
  690.                 request couldn't be fulfilled.]
  691.      552 Unrecognized entity
  692.                [A configuration key, a stream ID, circuit ID, event,
  693.                 mentioned in the command did not actually exist.]
  694.      553 Invalid configuration value
  695.          [The client tried to set a configuration option to an
  696.            incorrect, ill-formed, or impossible value.]
  697.      554 Invalid descriptor
  698.      555 Unmanaged entity
  699.      650 Asynchronous event notification
  700.   Unless specified to have specific contents, the human-readable messages
  701.   in error replies should not be relied upon to match those in this document.
  702. 4.1. Asynchronous events
  703.   These replies can be sent after a corresponding SETEVENTS command has been
  704.   received.  They will not be interleaved with other Reply elements, but they
  705.   can appear between a command and its corresponding reply.  For example,
  706.   this sequence is possible:
  707.      C: SETEVENTS CIRC
  708.      S: 250 OK
  709.      C: GETCONF SOCKSPORT ORPORT
  710.      S: 650 CIRC 1000 EXTENDED moria1,moria2
  711.      S: 250-SOCKSPORT=9050
  712.      S: 250 ORPORT=0
  713.   But this sequence is disallowed:
  714.      C: SETEVENTS CIRC
  715.      S: 250 OK
  716.      C: GETCONF SOCKSPORT ORPORT
  717.      S: 250-SOCKSPORT=9050
  718.      S: 650 CIRC 1000 EXTENDED moria1,moria2
  719.      S: 250 ORPORT=0
  720.   Clients MUST tolerate more arguments in an asynchonous reply than
  721.   expected, and MUST tolerate more lines in an asynchronous reply than
  722.   expected.  For instance, a client that expects a CIRC message like:
  723.       650 CIRC 1000 EXTENDED moria1,moria2
  724.   must tolerate:
  725.       650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
  726.       650-EXTRAMAGIC=99
  727.       650 ANONYMITY=high
  728.   If clients ask for extended events, then each event line as specified below
  729.   will be followed by additional extensions. Additional lines will be of the
  730.   form
  731.       "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  732.   Additional arguments will be of the form
  733.       SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
  734.   Such clients MUST tolerate lines with keywords they do not recognize.
  735. 4.1.1. Circuit status changed
  736.    The syntax is:
  737.      "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
  738.           [SP "REASON=" Reason [SP "REMOTE_REASON=" Reason]] CRLF
  739.       CircStatus =
  740.                "LAUNCHED" / ; circuit ID assigned to new circuit
  741.                "BUILT"    / ; all hops finished, can now accept streams
  742.                "EXTENDED" / ; one more hop has been completed
  743.                "FAILED"   / ; circuit closed (was not built)
  744.                "CLOSED"     ; circuit closed (was built)
  745.       Path = ServerID *("," ServerID)
  746.       Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
  747.                "HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
  748.                "OR_IDENTITY" / "OR_CONN_CLOSED" / "TIMEOUT" /
  749.                "FINISHED" / "DESTROYED" / "NOPATH" / "NOSUCHSERVICE"
  750.    The path is provided only when the circuit has been extended at least one
  751.    hop.
  752.    The "REASON" field is provided only for FAILED and CLOSED events, and only
  753.    if extended events are enabled (see 3.19).  Clients MUST accept reasons
  754.    not listed above.  Reasons are as given in tor-spec.txt, except for:
  755.       NOPATH          (Not enough nodes to make circuit)
  756.    The "REMOTE_REASON" field is provided only when we receive a DESTROY or
  757.    TRUNCATE cell, and only if extended events are enabled.  It contains the
  758.    actual reason given by the remote OR for closing the circuit. Clients MUST
  759.    accept reasons not listed above.  Reasons are as listed in tor-spec.txt.
  760. 4.1.2. Stream status changed
  761.     The syntax is:
  762.       "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target
  763.           [SP "REASON=" Reason [ SP "REMOTE_REASON=" Reason ]]
  764.           [SP "SOURCE=" Source] [ SP "SOURCE_ADDR=" Address ":" Port ]
  765.           [SP "PURPOSE=" Purpose]
  766.           CRLF
  767.       StreamStatus =
  768.                "NEW"          / ; New request to connect
  769.                "NEWRESOLVE"   / ; New request to resolve an address
  770.                "REMAP"        / ; Address re-mapped to another
  771.                "SENTCONNECT"  / ; Sent a connect cell along a circuit
  772.                "SENTRESOLVE"  / ; Sent a resolve cell along a circuit
  773.                "SUCCEEDED"    / ; Received a reply; stream established
  774.                "FAILED"       / ; Stream failed and not retriable
  775.                "CLOSED"       / ; Stream closed
  776.                "DETACHED"       ; Detached from circuit; still retriable
  777.        Target = Address ":" Port
  778.   The circuit ID designates which circuit this stream is attached to.  If
  779.   the stream is unattached, the circuit ID "0" is given.
  780.       Reason = "MISC" / "RESOLVEFAILED" / "CONNECTREFUSED" /
  781.                "EXITPOLICY" / "DESTROY" / "DONE" / "TIMEOUT" /
  782.                "HIBERNATING" / "INTERNAL"/ "RESOURCELIMIT" /
  783.                "CONNRESET" / "TORPROTOCOL" / "NOTDIRECTORY" / "END"
  784.    The "REASON" field is provided only for FAILED, CLOSED, and DETACHED
  785.    events, and only if extended events are enabled (see 3.19).  Clients MUST
  786.    accept reasons not listed above.  Reasons are as given in tor-spec.txt,
  787.    except for:
  788.       END          (We received a RELAY_END cell from the other side of this
  789.                     stream.)
  790.       [XXXX document more. -NM]
  791.    The "REMOTE_REASON" field is provided only when we receive a RELAY_END
  792.    cell, and only if extended events are enabled.  It contains the actual
  793.    reason given by the remote OR for closing the stream. Clients MUST accept
  794.    reasons not listed above.  Reasons are as listed in tor-spec.txt.
  795.    "REMAP" events include a Source if extended events are enabled:
  796.       Source = "CACHE" / "EXIT"
  797.    Clients MUST accept sources not listed above.  "CACHE" is given if
  798.    the Tor client decided to remap the address because of a cached
  799.    answer, and "EXIT" is given if the remote node we queried gave us
  800.    the new address as a response.
  801.    The "SOURCE_ADDR" field is included with NEW and NEWRESOLVE events if
  802.    extended events are enabled.  It indicates the address and port
  803.    that requested the connection, and can be (e.g.) used to look up the
  804.    requesting program.
  805.       Purpose = "DIR_FETCH" / "UPLOAD_DESC" / "DNS_REQUEST" /
  806.                  "USER" /  "DIRPORT_TEST"
  807.    The "PURPOSE" field is provided only for NEW and NEWRESOLVE events, and
  808.    only if extended events are enabled (see 3.19).  Clients MUST accept
  809.    purposes not listed above.
  810. 4.1.3. OR Connection status changed
  811.   The syntax is:
  812.     "650" SP "ORCONN" SP (ServerID / Target) SP ORStatus [ SP "REASON="
  813.              Reason ] [ SP "NCIRCS=" NumCircuits ] CRLF
  814.     ORStatus = "NEW" / "LAUNCHED" / "CONNECTED" / "FAILED" / "CLOSED"
  815.   NEW is for incoming connections, and LAUNCHED is for outgoing
  816.   connections. CONNECTED means the TLS handshake has finished (in
  817.   either direction). FAILED means a connection is being closed that
  818.   hasn't finished its handshake, and CLOSED is for connections that
  819.   have handshaked.
  820.   A ServerID is specified unless it's a NEW connection, in which
  821.   case we don't know what server it is yet, so we use Address:Port.
  822.   If extended events are enabled (see 3.19), optional reason and
  823.   circuit counting information is provided for CLOSED and FAILED
  824.   events.
  825.       Reason = "MISC" / "DONE" / "CONNECTREFUSED" /
  826.                "IDENTITY" / "CONNECTRESET" / "TIMEOUT" / "NOROUTE" /
  827.                "IOERROR" / "RESOURCELIMIT"
  828.   NumCircuits counts both established and pending circuits.
  829. 4.1.4. Bandwidth used in the last second
  830.   The syntax is:
  831.      "650" SP "BW" SP BytesRead SP BytesWritten *(SP Type "=" Num) CRLF
  832.      BytesRead = 1*DIGIT
  833.      BytesWritten = 1*DIGIT
  834.      Type = "DIR" / "OR" / "EXIT" / "APP" / ...
  835.      Num = 1*DIGIT
  836.   BytesRead and BytesWritten are the totals. [In a future Tor version,
  837.   we may also include a breakdown of the connection types that used
  838.   bandwidth this second (not implemented yet).]
  839. 4.1.5. Log messages
  840.   The syntax is:
  841.      "650" SP Severity SP ReplyText CRLF
  842.   or
  843.      "650+" Severity CRLF Data 650 SP "OK" CRLF
  844.      Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"
  845. 4.1.6. New descriptors available
  846.   Syntax:
  847.      "650" SP "NEWDESC" 1*(SP ServerID) CRLF
  848. 4.1.7. New Address mapping
  849.   Syntax:
  850.      "650" SP "ADDRMAP" SP Address SP NewAddress SP Expiry
  851.        [SP Error] SP GMTExpiry CRLF
  852.      NewAddress = Address / "<error>"
  853.      Expiry = DQUOTE ISOTime DQUOTE / "NEVER"
  854.      Error = "error=" ErrorCode
  855.      ErrorCode = XXXX
  856.      GMTExpiry = "EXPIRES=" DQUOTE IsoTime DQUOTE
  857.   Error and GMTExpiry are only provided if extended events are enabled.
  858.   Expiry is expressed as the local time (rather than GMT).  This is a bug,
  859.   left in for backward compatibility; new code should look at GMTExpiry
  860.   instead.
  861.   These events are generated when a new address mapping is entered in the
  862.   cache, or when the answer for a RESOLVE command is found.
  863. 4.1.8. Descriptors uploaded to us in our role as authoritative dirserver
  864.   Syntax:
  865.      "650" "+" "AUTHDIR_NEWDESCS" CRLF Action CRLF Message CRLF
  866.        Descriptor CRLF "." CRLF "650" SP "OK" CRLF
  867.      Action = "ACCEPTED" / "DROPPED" / "REJECTED"
  868.      Message = Text
  869. 4.1.9. Our descriptor changed
  870.   Syntax:
  871.      "650" SP "DESCCHANGED" CRLF
  872.   [First added in 0.1.2.2-alpha.]
  873. 4.1.10. Status events
  874.   Status events (STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER) are sent
  875.   based on occurrences in the Tor process pertaining to the general state of
  876.   the program.  Generally, they correspond to log messages of severity Notice
  877.   or higher.  They differ from log messages in that their format is a
  878.   specified interface.
  879.   Syntax:
  880.      "650" SP StatusType SP StatusSeverity SP StatusAction
  881.                                          [SP StatusArguments] CRLF
  882.      StatusType = "STATUS_GENERAL" / "STATUS_CLIENT" / "STATUS_SERVER"
  883.      StatusSeverity = "NOTICE" / "WARN" / "ERR"
  884.      StatusAction = 1*ALPHA
  885.      StatusArguments = StatusArgument *(SP StatusArgument)
  886.      StatusArgument = StatusKeyword '=' StatusValue
  887.      StatusKeyword = 1*(ALNUM / "_")
  888.      StatusValue = 1*(ALNUM / '_')  / QuotedString
  889.      Action is a string, and Arguments is a series of keyword=value
  890.      pairs on the same line.  Values may be space-terminated strings,
  891.      or quoted strings.
  892.      These events are always produced with EXTENDED_EVENTS and
  893.      VERBOSE_NAMES; see the explanations in the USEFEATURE section
  894.      for details.
  895.      Controllers MUST tolerate unrecognized actions, MUST tolerate
  896.      unrecognized arguments, MUST tolerate missing arguments, and MUST
  897.      tolerate arguments that arrive in any order.
  898.      Each event description below is accompanied by a recommendation for
  899.      controllers.  These recommendations are suggestions only; no controller
  900.      is required to implement them.
  901.   Compatibility note: versions of Tor before 0.2.0.22-rc incorrectly
  902.   generated "STATUS_SERVER" as "STATUS_SEVER".  To be compatible with those
  903.   versions, tools should accept both.
  904.   Actions for STATUS_GENERAL events can be as follows:
  905.      CLOCK_JUMPED
  906.      "TIME=NUM"
  907.        Tor spent enough time without CPU cycles that it has closed all
  908.        its circuits and will establish them anew. This typically
  909.        happens when a laptop goes to sleep and then wakes up again. It
  910.        also happens when the system is swapping so heavily that Tor is
  911.        starving. The "time" argument specifies the number of seconds Tor
  912.        thinks it was unconscious for (or alternatively, the number of
  913.        seconds it went back in time).
  914.        This status event is sent as NOTICE severity normally, but WARN
  915.        severity if Tor is acting as a server currently.
  916.        {Recommendation for controller: ignore it, since we don't really
  917.        know what the user should do anyway. Hm.}
  918.      DANGEROUS_VERSION
  919.      "CURRENT=version"
  920.      "REASON=NEW/OBSOLETE/UNRECOMMENDED"
  921.      "RECOMMENDED="version, version, ...""
  922.        Tor has found that directory servers don't recommend its version of
  923.        the Tor software.  RECOMMENDED is a comma-and-space-separated string
  924.        of Tor versions that are recommended.  REASON is NEW if this version
  925.        of Tor is newer than any recommended version, OBSOLETE if
  926.        this version of Tor is older than any recommended version, and
  927.        UNRECOMMENDED if some recommended versions of Tor are newer and
  928.        some are older than this version. (The "OBSOLETE" reason was called
  929.        "OLD" from Tor 0.1.2.3-alpha up to and including 0.2.0.12-alpha.)
  930.        {Controllers may want to suggest that the user upgrade OLD or
  931.        UNRECOMMENDED versions.  NEW versions may be known-insecure, or may
  932.        simply be development versions.}
  933.      TOO_MANY_CONNECTIONS
  934.      "CURRENT=NUM"
  935.        Tor has reached its ulimit -n or whatever the native limit is on file
  936.        descriptors or sockets.  CURRENT is the number of sockets Tor
  937.        currently has open.  The user should really do something about
  938.        this. The "current" argument shows the number of connections currently
  939.        open.
  940.        {Controllers may recommend that the user increase the limit, or
  941.        increase it for them.  Recommendations should be phrased in an
  942.        OS-appropriate way and automated when possible.}
  943.      BUG
  944.      "REASON=STRING"
  945.        Tor has encountered a situation that its developers never expected,
  946.        and the developers would like to learn that it happened. Perhaps
  947.        the controller can explain this to the user and encourage her to
  948.        file a bug report?
  949.        {Controllers should log bugs, but shouldn't annoy the user in case a
  950.        bug appears frequently.}
  951.      CLOCK_SKEW
  952.        SKEW="+" / "-" SECONDS
  953.        MIN_SKEW="+" / "-" SECONDS.
  954.        SOURCE="DIRSERV:" IP ":" Port /
  955.               "NETWORKSTATUS:" IP ":" Port /
  956.               "OR:" IP ":" Port /
  957.               "CONSENSUS"
  958.          If "SKEW" is present, it's an estimate of how far we are from the
  959.          time declared in the source.  (In other words, if we're an hour in
  960.          the past, the value is -3600.)  "MIN_SKEW" is present, it's a lower
  961.          bound.  If the source is a DIRSERV, we got the current time from a
  962.          connection to a dirserver.  If the source is a NETWORKSTATUS, we
  963.          decided we're skewed because we got a v2 networkstatus from far in
  964.          the future.  If the source is OR, the skew comes from a NETINFO
  965.          cell from a connection to another relay.  If the source is
  966.          CONSENSUS, we decided we're skewed because we got a networkstatus
  967.          consensus from the future.
  968.          {Tor should send this message to controllers when it thinks the
  969.          skew is so high that it will interfere with proper Tor operation.
  970.          Controllers shouldn't blindly adjust the clock, since the more
  971.          accurate source of skew info (DIRSERV) is currently
  972.          unauthenticated.}
  973.      BAD_LIBEVENT
  974.      "METHOD=" libevent method
  975.      "VERSION=" libevent version
  976.      "BADNESS=" "BROKEN" / "BUGGY" / "SLOW"
  977.      "RECOVERED=" "NO" / "YES"
  978.         Tor knows about bugs in using the configured event method in this
  979.         version of libevent.  "BROKEN" libevents won't work at all;
  980.         "BUGGY" libevents might work okay; "SLOW" libevents will work
  981.         fine, but not quickly.  If "RECOVERED" is YES, Tor managed to
  982.         switch to a more reliable (but probably slower!) libevent method.
  983.         {Controllers may want to warn the user if this event occurs, though
  984.         generally it's the fault of whoever built the Tor binary and there's
  985.         not much the user can do besides upgrade libevent or upgrade the
  986.         binary.}
  987.      DIR_ALL_UNREACHABLE
  988.        Tor believes that none of the known directory servers are
  989.        reachable -- this is most likely because the local network is
  990.        down or otherwise not working, and might help to explain for the
  991.        user why Tor appears to be broken.
  992.        {Controllers may want to warn the user if this event occurs; further
  993.        action is generally not possible.}
  994.      CONSENSUS_ARRIVED
  995.         Tor has received and validated a new consensus networkstatus.
  996.         (This event can be delayed a little while after the consensus
  997.         is received, if Tor needs to fetch certificates.)
  998.   Actions for STATUS_CLIENT events can be as follows:
  999.      BOOTSTRAP
  1000.      "PROGRESS=" num
  1001.      "TAG=" Keyword
  1002.      "SUMMARY=" String
  1003.      ["WARNING=" String
  1004.       "REASON=" Keyword
  1005.       "COUNT=" num
  1006.       "RECOMMENDATION=" Keyword
  1007.      ]
  1008.        Tor has made some progress at establishing a connection to the
  1009.        Tor network, fetching directory information, or making its first
  1010.        circuit; or it has encountered a problem while bootstrapping. This
  1011.        status event is especially useful for users with slow connections
  1012.        or with connectivity problems.
  1013.        "Progress" gives a number between 0 and 100 for how far through
  1014.        the bootstrapping process we are. "Summary" is a string that can
  1015.        be displayed to the user to describe the *next* task that Tor
  1016.        will tackle, i.e., the task it is working on after sending the
  1017.        status event. "Tag" is a string that controllers can use to
  1018.        recognize bootstrap phases, if they want to do something smarter
  1019.        than just blindly displaying the summary string; see Section 5
  1020.        for the current tags that Tor issues.
  1021.        The StatusSeverity describes whether this is a normal bootstrap
  1022.        phase (severity notice) or an indication of a bootstrapping
  1023.        problem (severity warn).
  1024.        For bootstrap problems, we include the same progress, tag, and
  1025.        summary values as we would for a normal bootstrap event, but we
  1026.        also include "warning", "reason", "count", and "recommendation"
  1027.        key/value combos. The "count" number tells how many bootstrap
  1028.        problems there have been so far at this phase. The "reason"
  1029.        string lists one of the reasons allowed in the ORCONN event. The
  1030.        "warning" argument string with any hints Tor has to offer about
  1031.        why it's having troubles bootstrapping.
  1032.        The "reason" values are long-term-stable controller-facing tags to
  1033.        identify particular issues in a bootstrapping step.  The warning
  1034.        strings, on the other hand, are human-readable. Controllers
  1035.        SHOULD NOT rely on the format of any warning string. Currently
  1036.        the possible values for "recommendation" are either "ignore" or
  1037.        "warn" -- if ignore, the controller can accumulate the string in
  1038.        a pile of problems to show the user if the user asks; if warn,
  1039.        the controller should alert the user that Tor is pretty sure
  1040.        there's a bootstrapping problem.
  1041.        Currently Tor uses recommendation=ignore for the first
  1042.        nine bootstrap problem reports for a given phase, and then
  1043.        uses recommendation=warn for subsequent problems at that
  1044.        phase. Hopefully this is a good balance between tolerating
  1045.        occasional errors and reporting serious problems quickly.
  1046.      ENOUGH_DIR_INFO
  1047.        Tor now knows enough network-status documents and enough server
  1048.        descriptors that it's going to start trying to build circuits now.
  1049.        {Controllers may want to use this event to decide when to indicate
  1050.        progress to their users, but should not interrupt the user's browsing
  1051.        to tell them so.}
  1052.      NOT_ENOUGH_DIR_INFO
  1053.        We discarded expired statuses and router descriptors to fall
  1054.        below the desired threshold of directory information. We won't
  1055.        try to build any circuits until ENOUGH_DIR_INFO occurs again.
  1056.        {Controllers may want to use this event to decide when to indicate
  1057.        progress to their users, but should not interrupt the user's browsing
  1058.        to tell them so.}
  1059.      CIRCUIT_ESTABLISHED
  1060.        Tor is able to establish circuits for client use. This event will
  1061.        only be sent if we just built a circuit that changed our mind --
  1062.        that is, prior to this event we didn't know whether we could
  1063.        establish circuits.
  1064.        {Suggested use: controllers can notify their users that Tor is
  1065.        ready for use as a client once they see this status event. [Perhaps
  1066.        controllers should also have a timeout if too much time passes and
  1067.        this event hasn't arrived, to give tips on how to troubleshoot.
  1068.        On the other hand, hopefully Tor will send further status events
  1069.        if it can identify the problem.]}
  1070.      CIRCUIT_NOT_ESTABLISHED
  1071.      "REASON=" "EXTERNAL_ADDRESS" / "DIR_ALL_UNREACHABLE" / "CLOCK_JUMPED"
  1072.        We are no longer confident that we can build circuits. The "reason"
  1073.        keyword provides an explanation: which other status event type caused
  1074.        our lack of confidence.
  1075.        {Controllers may want to use this event to decide when to indicate
  1076.        progress to their users, but should not interrupt the user's browsing
  1077.        to do so.}
  1078.        [Note: only REASON=CLOCK_JUMPED is implemented currently.]
  1079.      DANGEROUS_PORT
  1080.      "PORT=" port
  1081.      "RESULT=" "REJECT" / "WARN"
  1082.        A stream was initiated to a port that's commonly used for
  1083.        vulnerable-plaintext protocols. If the Result is "reject", we
  1084.        refused the connection; whereas if it's "warn", we allowed it.
  1085.        {Controllers should warn their users when this occurs, unless they
  1086.        happen to know that the application using Tor is in fact doing so
  1087.        correctly (e.g., because it is part of a distributed bundle). They
  1088.        might also want some sort of interface to let the user configure
  1089.        their RejectPlaintextPorts and WarnPlaintextPorts config options.}
  1090.      DANGEROUS_SOCKS
  1091.      "PROTOCOL=" "SOCKS4" / "SOCKS5"
  1092.      "ADDRESS=" IP:port
  1093.        A connection was made to Tor's SOCKS port using one of the SOCKS
  1094.        approaches that doesn't support hostnames -- only raw IP addresses.
  1095.        If the client application got this address from gethostbyname(),
  1096.        it may be leaking target addresses via DNS.
  1097.        {Controllers should warn their users when this occurs, unless they
  1098.        happen to know that the application using Tor is in fact doing so
  1099.        correctly (e.g., because it is part of a distributed bundle).}
  1100.      SOCKS_UNKNOWN_PROTOCOL
  1101.        "DATA=string"
  1102.        A connection was made to Tor's SOCKS port that tried to use it
  1103.        for something other than the SOCKS protocol. Perhaps the user is
  1104.        using Tor as an HTTP proxy?   The DATA is the first few characters
  1105.        sent to Tor on the SOCKS port.
  1106.        {Controllers may want to warn their users when this occurs: it
  1107.        indicates a misconfigured application.}
  1108.      SOCKS_BAD_HOSTNAME
  1109.       "HOSTNAME=QuotedString"
  1110.        Some application gave us a funny-looking hostname. Perhaps
  1111.        it is broken? In any case it won't work with Tor and the user
  1112.        should know.
  1113.        {Controllers may want to warn their users when this occurs: it
  1114.        usually indicates a misconfigured application.}
  1115.   Actions for STATUS_SERVER can be as follows:
  1116.      EXTERNAL_ADDRESS
  1117.      "ADDRESS=IP"
  1118.      "HOSTNAME=NAME"
  1119.      "METHOD=CONFIGURED/DIRSERV/RESOLVED/INTERFACE/GETHOSTNAME"
  1120.        Our best idea for our externally visible IP has changed to 'IP'.
  1121.        If 'HOSTNAME' is present, we got the new IP by resolving 'NAME'.  If the
  1122.        method is 'CONFIGURED', the IP was given verbatim as a configuration
  1123.        option.  If the method is 'RESOLVED', we resolved the Address
  1124.        configuration option to get the IP.  If the method is 'GETHOSTNAME',
  1125.        we resolved our hostname to get the IP.  If the method is 'INTERFACE',
  1126.        we got the address of one of our network interfaces to get the IP.  If
  1127.        the method is 'DIRSERV', a directory server told us a guess for what
  1128.        our IP might be.
  1129.        {Controllers may want to record this info and display it to the user.}
  1130.      CHECKING_REACHABILITY
  1131.      "ORADDRESS=IP:port"
  1132.      "DIRADDRESS=IP:port"
  1133.        We're going to start testing the reachability of our external OR port
  1134.        or directory port.
  1135.        {This event could affect the controller's idea of server status, but
  1136.        the controller should not interrupt the user to tell them so.}
  1137.      REACHABILITY_SUCCEEDED
  1138.      "ORADDRESS=IP:port"
  1139.      "DIRADDRESS=IP:port"
  1140.        We successfully verified the reachability of our external OR port or
  1141.        directory port (depending on which of ORADDRESS or DIRADDRESS is
  1142.        given.)
  1143.        {This event could affect the controller's idea of server status, but
  1144.        the controller should not interrupt the user to tell them so.}
  1145.      GOOD_SERVER_DESCRIPTOR
  1146.        We successfully uploaded our server descriptor to at least one
  1147.        of the directory authorities, with no complaints.
  1148.        {Originally, the goal of this event was to declare "every authority
  1149.        has accepted the descriptor, so there will be no complaints
  1150.        about it." But since some authorities might be offline, it's
  1151.        harder to get certainty than we had thought. As such, this event
  1152.        is equivalent to ACCEPTED_SERVER_DESCRIPTOR below. Controllers
  1153.        should just look at ACCEPTED_SERVER_DESCRIPTOR and should ignore
  1154.        this event for now.}
  1155.      NAMESERVER_STATUS
  1156.      "NS=addr"
  1157.      "STATUS=" "UP" / "DOWN"
  1158.      "ERR=" message
  1159.         One of our nameservers has changed status.
  1160.         {This event could affect the controller's idea of server status, but
  1161.         the controller should not interrupt the user to tell them so.}
  1162.      NAMESERVER_ALL_DOWN
  1163.         All of our nameservers have gone down.
  1164.         {This is a problem; if it happens often without the nameservers
  1165.         coming up again, the user needs to configure more or better
  1166.         nameservers.}
  1167.      DNS_HIJACKED
  1168.         Our DNS provider is providing an address when it should be saying
  1169.         "NOTFOUND"; Tor will treat the address as a synonym for "NOTFOUND".
  1170.         {This is an annoyance; controllers may want to tell admins that their
  1171.         DNS provider is not to be trusted.}
  1172.      DNS_USELESS
  1173.         Our DNS provider is giving a hijacked address instead of well-known
  1174.         websites; Tor will not try to be an exit node.
  1175.         {Controllers could warn the admin if the server is running as an
  1176.         exit server: the admin needs to configure a good DNS server.
  1177.         Alternatively, this happens a lot in some restrictive environments
  1178.         (hotels, universities, coffeeshops) when the user hasn't registered.}
  1179.      BAD_SERVER_DESCRIPTOR
  1180.      "DIRAUTH=addr:port"
  1181.      "REASON=string"
  1182.         A directory authority rejected our descriptor.  Possible reasons
  1183.         include malformed descriptors, incorrect keys, highly skewed clocks,
  1184.         and so on.
  1185.         {Controllers should warn the admin, and try to cope if they can.}
  1186.      ACCEPTED_SERVER_DESCRIPTOR
  1187.      "DIRAUTH=addr:port"
  1188.         A single directory authority accepted our descriptor.
  1189.         // actually notice
  1190.        {This event could affect the controller's idea of server status, but
  1191.        the controller should not interrupt the user to tell them so.}
  1192.      REACHABILITY_FAILED
  1193.      "ORADDRESS=IP:port"
  1194.      "DIRADDRESS=IP:port"
  1195.        We failed to connect to our external OR port or directory port
  1196.        successfully.
  1197.        {This event could affect the controller's idea of server status.  The
  1198.        controller should warn the admin and suggest reasonable steps to take.}
  1199. 4.1.11. Our set of guard nodes has changed
  1200.   Syntax:
  1201.      "650" SP "GUARD" SP Type SP Name SP Status ... CRLF
  1202.      Type = "ENTRY"
  1203.      Name = The (possibly verbose) nickname of the guard affected.
  1204.      Status = "NEW" | "UP" | "DOWN" | "BAD" | "GOOD" | "DROPPED"
  1205.   [explain states. XXX]
  1206. 4.1.12. Network status has changed
  1207.   Syntax:
  1208.      "650" "+" "NS" CRLF 1*NetworkStatus "." CRLF "650" SP "OK" CRLF
  1209.   The event is used whenever our local view of a relay status changes.
  1210.   This happens when we get a new v3 consensus (in which case the entries
  1211.   we see are a duplicate of what we see in the NEWCONSENSUS event,
  1212.   below), but it also happens when we decide to mark a relay as up or
  1213.   down in our local status, for example based on connection attempts.
  1214.   [First added in 0.1.2.3-alpha]
  1215. 4.1.13. Bandwidth used on an application stream
  1216.   The syntax is:
  1217.      "650" SP "STREAM_BW" SP StreamID SP BytesRead SP BytesWritten CRLF
  1218.      BytesRead = 1*DIGIT
  1219.      BytesWritten = 1*DIGIT
  1220.   BytesRead and BytesWritten are the number of bytes read and written since
  1221.   the last STREAM_BW event on this stream.  These events are generated about
  1222.   once per second per stream; no events are generated for streams that have
  1223.   not read or written.
  1224.   These events apply only to streams entering Tor (such as on a SOCKSPort,
  1225.   TransPort, or so on).  They are not generated for exiting streams.
  1226. 4.1.14. Per-country client stats
  1227.   The syntax is:
  1228.      "650" SP "CLIENTS_SEEN" SP TimeStarted SP CountrySummary CRLF
  1229.   We just generated a new summary of which countries we've seen clients
  1230.   from recently. The controller could display this for the user, e.g.
  1231.   in their "relay" configuration window, to give them a sense that they
  1232.   are actually being useful.
  1233.   Currently only bridge relays will receive this event, but once we figure
  1234.   out how to sufficiently aggregate and sanitize the client counts on
  1235.   main relays, we might start sending these events in other cases too.
  1236.   TimeStarted is a quoted string indicating when the reported summary
  1237.   counts from (in GMT).
  1238.   The CountrySummary keyword has as its argument a comma-separated
  1239.   set of "countrycode=count" pairs. For example,
  1240.   650-CLIENTS_SEEN TimeStarted="Thu Dec 25 23:50:43 EST 2008"
  1241.   650 CountrySummary=us=16,de=8,uk=8
  1242. [XXX Matt Edman informs me that the time format above is wrong. -RD]
  1243. 4.1.15. New consensus networkstatus has arrived.
  1244.   The syntax is:
  1245.      "650" "+" "NEWCONSENSUS" CRLF 1*NetworkStatus "." CRLF "650" SP
  1246.      "OK" CRLF
  1247.   A new consensus networkstatus has arrived. We include NS-style lines for
  1248.   every relay in the consensus. NEWCONSENSUS is a separate event from the
  1249.   NS event, because the list here represents every usable relay: so any
  1250.   relay *not* mentioned in this list is implicitly no longer recommended.
  1251.   [First added in 0.2.1.13-alpha]
  1252. 5. Implementation notes
  1253. 5.1. Authentication
  1254.   If the control port is open and no authentication operation is enabled, Tor
  1255.   trusts any local user that connects to the control port.  This is generally
  1256.   a poor idea.
  1257.   If the 'CookieAuthentication' option is true, Tor writes a "magic cookie"
  1258.   file named "control_auth_cookie" into its data directory.  To authenticate,
  1259.   the controller must send the contents of this file, encoded in hexadecimal.
  1260.   If the 'HashedControlPassword' option is set, it must contain the salted
  1261.   hash of a secret password.  The salted hash is computed according to the
  1262.   S2K algorithm in RFC 2440 (OpenPGP), and prefixed with the s2k specifier.
  1263.   This is then encoded in hexadecimal, prefixed by the indicator sequence
  1264.   "16:".  Thus, for example, the password 'foo' could encode to:
  1265.      16:660537E3E1CD49996044A3BF558097A981F539FEA2F9DA662B4626C1C2
  1266.         ++++++++++++++++**^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1267.            salt                       hashed value
  1268.                        indicator
  1269.   You can generate the salt of a password by calling
  1270.            'tor --hash-password <password>'
  1271.   or by using the example code in the Python and Java controller libraries.
  1272.   To authenticate under this scheme, the controller sends Tor the original
  1273.   secret that was used to generate the password, either as a quoted string
  1274.   or encoded in hexadecimal.
  1275. 5.2. Don't let the buffer get too big.
  1276.   If you ask for lots of events, and 16MB of them queue up on the buffer,
  1277.   the Tor process will close the socket.
  1278. 5.3. Backward compatibility with v0 control protocol.
  1279.   The 'version 0' control protocol was replaced in Tor 0.1.1.x. Support
  1280.   was removed in Tor 0.2.0.x. Every non-obsolete version of Tor now
  1281.   supports the version 1 control protocol.
  1282.   For backward compatibility with the "version 0" control protocol,
  1283.   Tor used to check whether the third octet of the first command is zero.
  1284.   (If it was, Tor assumed that version 0 is in use.)
  1285.   This compatibility was removed in Tor 0.1.2.16 and 0.2.0.4-alpha.
  1286. 5.4. Tor config options for use by controllers
  1287.   Tor provides a few special configuration options for use by controllers.
  1288.   These options can be set and examined by the SETCONF and GETCONF commands,
  1289.   but are not saved to disk by SAVECONF.
  1290.   Generally, these options make Tor unusable by disabling a portion of Tor's
  1291.   normal operations.  Unless a controller provides replacement functionality
  1292.   to fill this gap, Tor will not correctly handle user requests.
  1293.   __AllDirOptionsPrivate
  1294.     If true, Tor will try to launch all directory operations through
  1295.     anonymous connections.  (Ordinarily, Tor only tries to anonymize
  1296.     requests related to hidden services.)  This option will slow down
  1297.     directory access, and may stop Tor from working entirely if it does not
  1298.     yet have enough directory information to build circuits.
  1299.     (Boolean. Default: "0".)
  1300.   __DisablePredictedCircuits
  1301.     If true, Tor will not launch preemptive "general-purpose" circuits for
  1302.     streams to attach to.  (It will still launch circuits for testing and
  1303.     for hidden services.)
  1304.     (Boolean. Default: "0".)
  1305.   __LeaveStreamsUnattached
  1306.     If true, Tor will not automatically attach new streams to circuits;
  1307.     instead, the controller must attach them with ATTACHSTREAM.  If the
  1308.     controller does not attach the streams, their data will never be routed.
  1309.     (Boolean. Default: "0".)
  1310.   __HashedControlSessionPassword
  1311.     As HashedControlPassword, but is not saved to the torrc file by
  1312.     SAVECONF.  Added in Tor 0.2.0.20-rc.
  1313.   __ReloadTorrcOnSIGHUP
  1314.     If this option is true (the default), we reload the torrc from disk
  1315.     every time we get a SIGHUP (from the controller or via a signal).
  1316.     Otherwise, we don't.  This option exists so that controllers can keep
  1317.     their options from getting overwritten when a user sends Tor a HUP for
  1318.     some other reason (for example, to rotate the logs).
  1319.     (Boolean.  Default: "1")
  1320. 5.5. Phases from the Bootstrap status event.
  1321.   This section describes the various bootstrap phases currently reported
  1322.   by Tor. Controllers should not assume that the percentages and tags
  1323.   listed here will continue to match up, or even that the tags will stay
  1324.   in the same order. Some phases might also be skipped (not reported)
  1325.   if the associated bootstrap step is already complete, or if the phase
  1326.   no longer is necessary. Only "starting" and "done" are guaranteed to
  1327.   exist in all future versions.
  1328.   Current Tor versions enter these phases in order, monotonically.
  1329.   Future Tors MAY revisit earlier stages.
  1330.   Phase 0:
  1331.   tag=starting summary="Starting"
  1332.   Tor starts out in this phase.
  1333.   Phase 5:
  1334.   tag=conn_dir summary="Connecting to directory mirror"
  1335.   Tor sends this event as soon as Tor has chosen a directory mirror --
  1336.   e.g. one of the authorities if bootstrapping for the first time or
  1337.   after a long downtime, or one of the relays listed in its cached
  1338.   directory information otherwise.
  1339.   Tor will stay at this phase until it has successfully established
  1340.   a TCP connection with some directory mirror. Problems in this phase
  1341.   generally happen because Tor doesn't have a network connection, or
  1342.   because the local firewall is dropping SYN packets.
  1343.   Phase 10:
  1344.   tag=handshake_dir summary="Finishing handshake with directory mirror"
  1345.   This event occurs when Tor establishes a TCP connection with a relay used
  1346.   as a directory mirror (or its https proxy if it's using one). Tor remains
  1347.   in this phase until the TLS handshake with the relay is finished.
  1348.   Problems in this phase generally happen because Tor's firewall is
  1349.   doing more sophisticated MITM attacks on it, or doing packet-level
  1350.   keyword recognition of Tor's handshake.
  1351.   Phase 15:
  1352.   tag=onehop_create summary="Establishing one-hop circuit for dir info"
  1353.   Once TLS is finished with a relay, Tor will send a CREATE_FAST cell
  1354.   to establish a one-hop circuit for retrieving directory information.
  1355.   It will remain in this phase until it receives the CREATED_FAST cell
  1356.   back, indicating that the circuit is ready.
  1357.   Phase 20:
  1358.   tag=requesting_status summary="Asking for networkstatus consensus"
  1359.   Once we've finished our one-hop circuit, we will start a new stream
  1360.   for fetching the networkstatus consensus. We'll stay in this phase
  1361.   until we get the 'connected' relay cell back, indicating that we've
  1362.   established a directory connection.
  1363.   Phase 25:
  1364.   tag=loading_status summary="Loading networkstatus consensus"
  1365.   Once we've established a directory connection, we will start fetching
  1366.   the networkstatus consensus document. This could take a while; this
  1367.   phase is a good opportunity for using the "progress" keyword to indicate
  1368.   partial progress.
  1369.   This phase could stall if the directory mirror we picked doesn't
  1370.   have a copy of the networkstatus consensus so we have to ask another,
  1371.   or it does give us a copy but we don't find it valid.
  1372.   Phase 40:
  1373.   tag=loading_keys summary="Loading authority key certs"
  1374.   Sometimes when we've finished loading the networkstatus consensus,
  1375.   we find that we don't have all the authority key certificates for the
  1376.   keys that signed the consensus. At that point we put the consensus we
  1377.   fetched on hold and fetch the keys so we can verify the signatures.
  1378.   Phase 45
  1379.   tag=requesting_descriptors summary="Asking for relay descriptors"
  1380.   Once we have a valid networkstatus consensus and we've checked all
  1381.   its signatures, we start asking for relay descriptors. We stay in this
  1382.   phase until we have received a 'connected' relay cell in response to
  1383.   a request for descriptors.
  1384.   Phase 50:
  1385.   tag=loading_descriptors summary="Loading relay descriptors"
  1386.   We will ask for relay descriptors from several different locations,
  1387.   so this step will probably make up the bulk of the bootstrapping,
  1388.   especially for users with slow connections. We stay in this phase until
  1389.   we have descriptors for at least 1/4 of the usable relays listed in
  1390.   the networkstatus consensus. This phase is also a good opportunity to
  1391.   use the "progress" keyword to indicate partial steps.
  1392.   Phase 80:
  1393.   tag=conn_or summary="Connecting to entry guard"
  1394.   Once we have a valid consensus and enough relay descriptors, we choose
  1395.   some entry guards and start trying to build some circuits. This step
  1396.   is similar to the "conn_dir" phase above; the only difference is
  1397.   the context.
  1398.   If a Tor starts with enough recent cached directory information,
  1399.   its first bootstrap status event will be for the conn_or phase.
  1400.   Phase 85:
  1401.   tag=handshake_or summary="Finishing handshake with entry guard"
  1402.   This phase is similar to the "handshake_dir" phase, but it gets reached
  1403.   if we finish a TCP connection to a Tor relay and we have already reached
  1404.   the "conn_or" phase. We'll stay in this phase until we complete a TLS
  1405.   handshake with a Tor relay.
  1406.   Phase 90:
  1407.   tag=circuit_create summary="Establishing circuits"
  1408.   Once we've finished our TLS handshake with an entry guard, we will
  1409.   set about trying to make some 3-hop circuits in case we need them soon.
  1410.   Phase 100:
  1411.   tag=done summary="Done"
  1412.   A full 3-hop exit circuit has been established. Tor is ready to handle
  1413.   application connections now.