control-spec.txt 79 KB

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