control-spec.txt 60 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526
  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.
  71. LongName = Fingerprint [ ( "=" / "~" ) Nickname ]
  72. ; How a controller tells Tor about a particular OR. There are four
  73. ; possible formats:
  74. ; $Digest -- The router whose identity key hashes to the given digest.
  75. ; This is the preferred way to refer to an OR.
  76. ; $Digest~Name -- The router whose identity key hashes to the given
  77. ; digest, but only if the router has the given nickname.
  78. ; $Digest=Name -- The router whose identity key hashes to the given
  79. ; digest, but only if the router is Named and has the given
  80. ; nickname.
  81. ; Name -- The Named router with the given nickname, or, if no such
  82. ; router exists, any router whose nickname matches the one given.
  83. ; This is not a safe way to refer to routers, since Named status
  84. ; could under some circumstances change over time.
  85. ServerSpec = LongName / Nickname
  86. ; Unique identifiers for streams or circuits. Currently, Tor only
  87. ; uses digits, but this may change
  88. StreamID = 1*16 IDChar
  89. CircuitID = 1*16 IDChar
  90. IDChar = ALPHA / DIGIT
  91. Address = ip4-address / ip6-address / hostname (XXXX Define these)
  92. ; A "Data" section is a sequence of octets concluded by the terminating
  93. ; sequence CRLF "." CRLF. The terminating sequence may not appear in the
  94. ; body of the data. Leading periods on lines in the data are escaped with
  95. ; an additional leading period as in RFC 2821 section 4.5.2.
  96. Data = *DataLine "." CRLF
  97. DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
  98. LineItem = NonCR / 1*CR NonCRLF
  99. NonDotItem = NonDotCR / 1*CR NonCRLF
  100. 3. Commands
  101. All commands and other keywords are case-insensitive.
  102. 3.1. SETCONF
  103. Change the value of one or more configuration variables. The syntax is:
  104. "SETCONF" 1*(SP keyword ["=" String]) CRLF
  105. Tor behaves as though it had just read each of the key-value pairs
  106. from its configuration file. Keywords with no corresponding values have
  107. their configuration values reset to 0 or NULL (use RESETCONF if you want
  108. to set it back to its default). SETCONF is all-or-nothing: if there
  109. is an error in any of the configuration settings, Tor sets none of them.
  110. Tor responds with a "250 configuration values set" reply on success.
  111. If some of the listed keywords can't be found, Tor replies with a
  112. "552 Unrecognized option" message. Otherwise, Tor responds with a
  113. "513 syntax error in configuration values" reply on syntax error, or a
  114. "553 impossible configuration setting" reply on a semantic error.
  115. When a configuration option takes multiple values, or when multiple
  116. configuration keys form a context-sensitive group (see GETCONF below), then
  117. setting _any_ of the options in a SETCONF command is taken to reset all of
  118. the others. For example, if two ORBindAddress values are configured, and a
  119. SETCONF command arrives containing a single ORBindAddress value, the new
  120. command's value replaces the two old values.
  121. 3.2. RESETCONF
  122. Remove all settings for a given configuration option entirely, assign
  123. its default value (if any), and then assign the String provided.
  124. Typically the String is left empty, to simply set an option back to
  125. its default. The syntax is:
  126. "RESETCONF" 1*(SP keyword ["=" String]) CRLF
  127. Otherwise it behaves like SETCONF above.
  128. 3.3. GETCONF
  129. Request the value of a configuration variable. The syntax is:
  130. "GETCONF" 1*(SP keyword) CRLF
  131. If all of the listed keywords exist in the Tor configuration, Tor replies
  132. with a series of reply lines of the form:
  133. 250 keyword=value
  134. If any option is set to a 'default' value semantically different from an
  135. empty string, Tor may reply with a reply line of the form:
  136. 250 keyword
  137. If some of the listed keywords can't be found, Tor replies with a
  138. "552 unknown configuration keyword" message.
  139. If an option appears multiple times in the configuration, all of its
  140. key-value pairs are returned in order.
  141. Some options are context-sensitive, and depend on other options with
  142. different keywords. These cannot be fetched directly. Currently there
  143. is only one such option: clients should use the "HiddenServiceOptions"
  144. virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  145. HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
  146. 3.4. SETEVENTS
  147. Request the server to inform the client about interesting events. The
  148. syntax is:
  149. "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
  150. EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
  151. "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
  152. "AUTHDIR_NEWDESCS" / "DESCCHANGED" / "STATUS_GENERAL" /
  153. "STATUS_CLIENT" / "STATUS_SERVER" / "GUARD" / "NS" / "STREAM_BW"
  154. Any events *not* listed in the SETEVENTS line are turned off; thus, sending
  155. SETEVENTS with an empty body turns off all event reporting.
  156. The server responds with a "250 OK" reply on success, and a "552
  157. Unrecognized event" reply if one of the event codes isn't recognized. (On
  158. error, the list of active event codes isn't changed.)
  159. If the flag string "EXTENDED" is provided, Tor may provide extra
  160. information with events for this connection; see 4.1 for more information.
  161. NOTE: All events on a given connection will be provided in extended format,
  162. or none.
  163. NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.
  164. Each event is described in more detail in Section 4.1.
  165. 3.5. AUTHENTICATE
  166. Sent from the client to the server. The syntax is:
  167. "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
  168. The server responds with "250 OK" on success or "515 Bad authentication" if
  169. the authentication cookie is incorrect. Tor closes the connection on an
  170. authentication failure.
  171. The format of the 'cookie' is implementation-dependent; see 5.1 below for
  172. information on how the standard Tor implementation handles it.
  173. Before the client has authenticated, no command other than PROTOCOLINFO,
  174. AUTHENTICATE, or QUIT is valid. If the controller sends any other command,
  175. or sends a malformed command, or sends an unsuccessful AUTHENTICATE
  176. command, or sends PROTOCOLINFO more than once, Tor sends an error reply and
  177. closes the connection.
  178. (Versions of Tor before 0.1.2.16 and 0.2.0.4-alpha did not close the
  179. connection after an authentication failure.)
  180. 3.6. SAVECONF
  181. Sent from the client to the server. The syntax is:
  182. "SAVECONF" CRLF
  183. Instructs the server to write out its config options into its torrc. Server
  184. returns "250 OK" if successful, or "551 Unable to write configuration
  185. to disk" if it can't write the file or some other error occurs.
  186. 3.7. SIGNAL
  187. Sent from the client to the server. The syntax is:
  188. "SIGNAL" SP Signal CRLF
  189. Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
  190. "HUP" / "INT" / "USR1" / "USR2" / "TERM" / "NEWNYM" /
  191. "CLEARDNSCACHE"
  192. The meaning of the signals are:
  193. RELOAD -- Reload: reload config items, refetch directory. (like HUP)
  194. SHUTDOWN -- Controlled shutdown: if server is an OP, exit immediately.
  195. If it's an OR, close listeners and exit after 30 seconds.
  196. (like INT)
  197. DUMP -- Dump stats: log information about open connections and
  198. circuits. (like USR1)
  199. DEBUG -- Debug: switch all open logs to loglevel debug. (like USR2)
  200. HALT -- Immediate shutdown: clean up and exit now. (like TERM)
  201. CLEARDNSCACHE -- Forget the client-side cached IPs for all hostnames.
  202. NEWNYM -- Switch to clean circuits, so new application requests
  203. don't share any circuits with old ones. Also clears
  204. the client-side DNS cache. (Tor MAY rate-limit its
  205. response to this signal.)
  206. The server responds with "250 OK" if the signal is recognized (or simply
  207. closes the socket if it was asked to close immediately), or "552
  208. Unrecognized signal" if the signal is unrecognized.
  209. 3.8. MAPADDRESS
  210. Sent from the client to the server. The syntax is:
  211. "MAPADDRESS" 1*(Address "=" Address SP) CRLF
  212. The first address in each pair is an "original" address; the second is a
  213. "replacement" address. The client sends this message to the server in
  214. order to tell it that future SOCKS requests for connections to the original
  215. address should be replaced with connections to the specified replacement
  216. address. If the addresses are well-formed, and the server is able to
  217. fulfill the request, the server replies with a 250 message:
  218. 250-OldAddress1=NewAddress1
  219. 250 OldAddress2=NewAddress2
  220. containing the source and destination addresses. If request is
  221. malformed, the server replies with "512 syntax error in command
  222. argument". If the server can't fulfill the request, it replies with
  223. "451 resource exhausted".
  224. The client may decline to provide a body for the original address, and
  225. instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  226. "." for hostname), signifying that the server should choose the original
  227. address itself, and return that address in the reply. The server
  228. should ensure that it returns an element of address space that is unlikely
  229. to be in actual use. If there is already an address mapped to the
  230. destination address, the server may reuse that mapping.
  231. If the original address is already mapped to a different address, the old
  232. mapping is removed. If the original address and the destination address
  233. are the same, the server removes any mapping in place for the original
  234. address.
  235. Example:
  236. C: MAPADDRESS 0.0.0.0=tor.eff.org 1.2.3.4=tor.freehaven.net
  237. S: 250-127.192.10.10=tor.eff.org
  238. S: 250 1.2.3.4=tor.freehaven.net
  239. {Note: This feature is designed to be used to help Tor-ify applications
  240. that need to use SOCKS4 or hostname-less SOCKS5. There are three
  241. approaches to doing this:
  242. 1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
  243. 2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
  244. feature) to resolve the hostname remotely. This doesn't work
  245. with special addresses like x.onion or x.y.exit.
  246. 3. Use MAPADDRESS to map an IP address to the desired hostname, and then
  247. arrange to fool the application into thinking that the hostname
  248. has resolved to that IP.
  249. This functionality is designed to help implement the 3rd approach.}
  250. Mappings set by the controller last until the Tor process exits:
  251. they never expire. If the controller wants the mapping to last only
  252. a certain time, then it must explicitly un-map the address when that
  253. time has elapsed.
  254. 3.9. GETINFO
  255. Sent from the client to the server. The syntax is as for GETCONF:
  256. "GETINFO" 1*(SP keyword) CRLF
  257. one or more NL-terminated strings. The server replies with an INFOVALUE
  258. message, or a 551 or 552 error.
  259. Unlike GETCONF, this message is used for data that are not stored in the Tor
  260. configuration file, and that may be longer than a single line. On success,
  261. one ReplyLine is sent for each requested value, followed by a final 250 OK
  262. ReplyLine. If a value fits on a single line, the format is:
  263. 250-keyword=value
  264. If a value must be split over multiple lines, the format is:
  265. 250+keyword=
  266. value
  267. .
  268. Recognized keys and their values include:
  269. "version" -- The version of the server's software, including the name
  270. of the software. (example: "Tor 0.0.9.4")
  271. "config-file" -- The location of Tor's configuration file ("torrc").
  272. ["exit-policy/prepend" -- The default exit policy lines that Tor will
  273. *prepend* to the ExitPolicy config option.
  274. -- Never implemented. Useful?]
  275. "exit-policy/default" -- The default exit policy lines that Tor will
  276. *append* to the ExitPolicy config option.
  277. "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest
  278. server descriptor for a given OR, NUL-terminated.
  279. "extra-info/digest/<digest>" -- the extrainfo document whose digest (in
  280. hex) is <digest>. Only available if we're downloading extra-info
  281. documents.
  282. "ns/id/<OR identity>" or "ns/name/<OR nickname>" -- the latest network
  283. status info for a given OR. Network status info is as given in
  284. dir-spec.txt, and reflects the current beliefs of this Tor about the
  285. router in question. Like directory clients, controllers MUST
  286. tolerate unrecognized flags and lines. The published date and
  287. descriptor digest are those believed to be best by this Tor,
  288. not necessarily those for a descriptor that Tor currently has.
  289. [First implemented in 0.1.2.3-alpha.]
  290. "ns/all" -- Network status info (v2 directory style) for all ORs we
  291. have an opinion about, joined by newlines. [First implemented
  292. in 0.1.2.3-alpha.]
  293. "desc/all-recent" -- the latest server descriptor for every router that
  294. Tor knows about.
  295. "network-status" -- a space-separated list (v1 directory style)
  296. of all known OR identities. This is in the same format as the
  297. router-status line in v1 directories; see dir-spec-v1.txt section
  298. 3 for details. (If VERBOSE_NAMES is enabled, the output will
  299. not conform to dir-spec-v1.txt; instead, the result will be a
  300. space-separated list of LongName, each preceded by a "!" if it is
  301. believed to be not running.)
  302. "address-mappings/all"
  303. "address-mappings/config"
  304. "address-mappings/cache"
  305. "address-mappings/control" -- a \r\n-separated list of address
  306. mappings, each in the form of "from-address to-address expiry".
  307. The 'config' key returns those address mappings set in the
  308. configuration; the 'cache' key returns the mappings in the
  309. client-side DNS cache; the 'control' key returns the mappings set
  310. via the control interface; the 'all' target returns the mappings
  311. set through any mechanism.
  312. Expiry is formatted as with ADDRMAP events, except that "expiry" is
  313. always a time in GMT or the string "NEVER"; see section 4.1.7.
  314. First introduced in 0.2.0.3-alpha.
  315. "addr-mappings/*" -- as for address-mappings/*, but without the
  316. expiry portion of the value. Use of this value is deprecated
  317. since 0.2.0.3-alpha; use address-mappings instead.
  318. "address" -- the best guess at our external IP address. If we
  319. have no guess, return a 551 error. (Added in 0.1.2.2-alpha)
  320. "fingerprint" -- the contents of the fingerprint file that Tor
  321. writes as a server, or a 551 if we're not a server currently.
  322. (Added in 0.1.2.3-alpha)
  323. "circuit-status"
  324. A series of lines as for a circuit status event. Each line is of
  325. the form:
  326. CircuitID SP CircStatus [SP Path] CRLF
  327. "stream-status"
  328. A series of lines as for a stream status event. Each is of the form:
  329. StreamID SP StreamStatus SP CircID SP Target CRLF
  330. "orconn-status"
  331. A series of lines as for an OR connection status event. Each is of the
  332. form:
  333. ServerID SP ORStatus CRLF
  334. "entry-guards"
  335. A series of lines listing the currently chosen entry guards, if any.
  336. Each is of the form:
  337. ServerID2 SP Status [SP ISOTime] CRLF
  338. Status-with-time = ("unlisted") SP ISOTime
  339. Status = ("up" / "never-connected" / "down" /
  340. "unusable" / "unlisted" )
  341. ServerID2 = Nickname / 40*HEXDIG
  342. [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
  343. Tor still supports calling it that for now, but support will be
  344. removed in 0.1.3.x.]
  345. [Older versions of Tor (before 0.1.2.x-final) generated 'down' instead
  346. of unlisted/unusable. Current Tors never generate 'down'.]
  347. [XXXX ServerID2 differs from ServerID in not prefixing fingerprints
  348. with a $. This is an implementation error. It would be nice to add
  349. the $ back in if we can do so without breaking compatibility.]
  350. "accounting/enabled"
  351. "accounting/hibernating"
  352. "accounting/bytes"
  353. "accounting/bytes-left"
  354. "accounting/interval-start"
  355. "accounting/interval-wake"
  356. "accounting/interval-end"
  357. Information about accounting status. If accounting is enabled,
  358. "enabled" is 1; otherwise it is 0. The "hibernating" field is "hard"
  359. if we are accepting no data; "soft" if we're accepting no new
  360. connections, and "awake" if we're not hibernating at all. The "bytes"
  361. and "bytes-left" fields contain (read-bytes SP write-bytes), for the
  362. start and the rest of the interval respectively. The 'interval-start'
  363. and 'interval-end' fields are the borders of the current interval; the
  364. 'interval-wake' field is the time within the current interval (if any)
  365. where we plan[ned] to start being active.
  366. "config/names"
  367. A series of lines listing the available configuration options. Each is
  368. of the form:
  369. OptionName SP OptionType [ SP Documentation ] CRLF
  370. OptionName = Keyword
  371. OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
  372. "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
  373. "String" / "LineList"
  374. Documentation = Text
  375. "info/names"
  376. A series of lines listing the available GETINFO options. Each is of
  377. one of these forms:
  378. OptionName SP Documentation CRLF
  379. OptionPrefix SP Documentation CRLF
  380. OptionPrefix = OptionName "/*"
  381. "events/names"
  382. A space-separated list of all the events supported by this version of
  383. Tor's SETEVENTS.
  384. "features/names"
  385. A space-separated list of all the events supported by this version of
  386. Tor's USEFEATURE.
  387. "next-circuit/IP:port"
  388. XXX todo.
  389. "dir/status/authority"
  390. "dir/status/fp/<F>"
  391. "dir/status/fp/<F1>+<F2>+<F3>"
  392. "dir/status/all"
  393. "dir/server/fp/<F>"
  394. "dir/server/fp/<F1>+<F2>+<F3>"
  395. "dir/server/d/<D>"
  396. "dir/server/d/<D1>+<D2>+<D3>"
  397. "dir/server/authority"
  398. "dir/server/all"
  399. A series of lines listing directory contents, provided according to the
  400. specification for the URLs listed in Section 4.4 of dir-spec.txt. Note
  401. that Tor MUST NOT provide private information, such as descriptors for
  402. routers not marked as general-purpose. When asked for 'authority'
  403. information for which this Tor is not authoritative, Tor replies with
  404. an empty string.
  405. "status/circuit-established"
  406. "status/enough-dir-info"
  407. "status/good-server-descriptor"
  408. "status/..."
  409. These provide the current internal Tor values for various Tor
  410. states. See Section 4.1.10 for explanations. (Only a few of the
  411. status events are available as getinfo's currently. Let us know if
  412. you want more exposed.)<
  413. "status/reachability/or"
  414. 0 or 1, depending on whether we've found our ORPort reachable.
  415. "status/reachability/dir"
  416. 0 or 1, depending on whether we've found our DirPort reachable.
  417. "status/reachability"
  418. "OR=" ("0"/"1") SP "DIR=" ("0"/"1")
  419. Combines status/reachability/*; controllers MUST ignore unrecognized
  420. elements in this entry.
  421. "status/version/recommended" -- List of currently recommended versions
  422. "status/version/current" -- Status of the current version. One of:
  423. new, old, unrecommended, recommended, new in series, obsolete.
  424. "status/version/num-versioning" -- Number of versioning authorities
  425. "status/version/num-concurring" -- Number of versioning authorities
  426. agreeing on the status of the current version
  427. Examples:
  428. C: GETINFO version desc/name/moria1
  429. S: 250+desc/name/moria=
  430. S: [Descriptor for moria]
  431. S: .
  432. S: 250-version=Tor 0.1.1.0-alpha-cvs
  433. S: 250 OK
  434. 3.10. EXTENDCIRCUIT
  435. Sent from the client to the server. The format is:
  436. "EXTENDCIRCUIT" SP CircuitID SP
  437. ServerSpec *("," ServerSpec)
  438. [SP "purpose=" Purpose] CRLF
  439. This request takes one of two forms: either the CircuitID is zero, in
  440. which case it is a request for the server to build a new circuit according
  441. to the specified path, or the CircuitID is nonzero, in which case it is a
  442. request for the server to extend an existing circuit with that ID according
  443. to the specified path.
  444. If CircuitID is 0 and "purpose=" is specified, then the circuit's
  445. purpose is set. Two choices are recognized: "general" and
  446. "controller". If not specified, circuits are created as "general".
  447. If the request is successful, the server sends a reply containing a
  448. message body consisting of the CircuitID of the (maybe newly created)
  449. circuit. The syntax is "250" SP "EXTENDED" SP CircuitID CRLF.
  450. 3.11. SETCIRCUITPURPOSE
  451. Sent from the client to the server. The format is:
  452. "SETCIRCUITPURPOSE" SP CircuitID SP Purpose CRLF
  453. This changes the circuit's purpose. See EXTENDCIRCUIT above for details.
  454. 3.12. SETROUTERPURPOSE
  455. Sent from the client to the server. The format is:
  456. "SETROUTERPURPOSE" SP NicknameOrKey SP Purpose CRLF
  457. This changes the descriptor's purpose. See +POSTDESCRIPTOR below
  458. for details.
  459. NOTE: This command was disabled and made obsolete as of Tor
  460. 0.2.0.8-alpha. It doesn't exist anymore, and is listed here only for
  461. historical interest.
  462. 3.13. ATTACHSTREAM
  463. Sent from the client to the server. The syntax is:
  464. "ATTACHSTREAM" SP StreamID SP CircuitID [SP "HOP=" HopNum] CRLF
  465. This message informs the server that the specified stream should be
  466. associated with the specified circuit. Each stream may be associated with
  467. at most one circuit, and multiple streams may share the same circuit.
  468. Streams can only be attached to completed circuits (that is, circuits that
  469. have sent a circuit status 'BUILT' event or are listed as built in a
  470. GETINFO circuit-status request).
  471. If the circuit ID is 0, responsibility for attaching the given stream is
  472. returned to Tor.
  473. If HOP=HopNum is specified, Tor will choose the HopNumth hop in the
  474. circuit as the exit node, rather than the last node in the circuit.
  475. Hops are 1-indexed; generally, it is not permitted to attach to hop 1.
  476. Tor responds with "250 OK" if it can attach the stream, 552 if the circuit
  477. or stream didn't exist, or 551 if the stream couldn't be attached for
  478. another reason.
  479. {Implementation note: Tor will close unattached streams by itself,
  480. roughly two minutes after they are born. Let the developers know if
  481. that turns out to be a problem.}
  482. {Implementation note: By default, Tor automatically attaches streams to
  483. circuits itself, unless the configuration variable
  484. "__LeaveStreamsUnattached" is set to "1". Attempting to attach streams
  485. via TC when "__LeaveStreamsUnattached" is false may cause a race between
  486. Tor and the controller, as both attempt to attach streams to circuits.}
  487. {Implementation note: You can try to attachstream to a stream that
  488. has already sent a connect or resolve request but hasn't succeeded
  489. yet, in which case Tor will detach the stream from its current circuit
  490. before proceeding with the new attach request.}
  491. 3.14. POSTDESCRIPTOR
  492. Sent from the client to the server. The syntax is:
  493. "+POSTDESCRIPTOR" [SP "purpose=" Purpose] [SP "cache=" Cache]
  494. CRLF Descriptor CRLF "." CRLF
  495. This message informs the server about a new descriptor. If Purpose is
  496. specified, it must be either "general" or "controller", else we
  497. return a 552 error.
  498. If Cache is specified, it must be either "no" or "yes", else we
  499. return a 552 error. If Cache is not specified, Tor will decide for
  500. itself whether it wants to cache the descriptor, and controllers
  501. must not rely on its choice.
  502. The descriptor, when parsed, must contain a number of well-specified
  503. fields, including fields for its nickname and identity.
  504. If there is an error in parsing the descriptor, the server must send a "554
  505. Invalid descriptor" reply. If the descriptor is well-formed but the server
  506. chooses not to add it, it must reply with a 251 message whose body explains
  507. why the server was not added. If the descriptor is added, Tor replies with
  508. "250 OK".
  509. 3.15. REDIRECTSTREAM
  510. Sent from the client to the server. The syntax is:
  511. "REDIRECTSTREAM" SP StreamID SP Address [SP Port] CRLF
  512. Tells the server to change the exit address on the specified stream. If
  513. Port is specified, changes the destination port as well. No remapping
  514. is performed on the new provided address.
  515. To be sure that the modified address will be used, this event must be sent
  516. after a new stream event is received, and before attaching this stream to
  517. a circuit.
  518. Tor replies with "250 OK" on success.
  519. 3.16. CLOSESTREAM
  520. Sent from the client to the server. The syntax is:
  521. "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
  522. Tells the server to close the specified stream. The reason should be one
  523. of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal. Flags is
  524. not used currently; Tor servers SHOULD ignore unrecognized flags. Tor may
  525. hold the stream open for a while to flush any data that is pending.
  526. Tor replies with "250 OK" on success, or a 512 if there aren't enough
  527. arguments, or a 552 if it doesn't recognize the StreamID or reason.
  528. 3.17. CLOSECIRCUIT
  529. The syntax is:
  530. CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
  531. Flag = "IfUnused"
  532. Tells the server to close the specified circuit. If "IfUnused" is
  533. provided, do not close the circuit unless it is unused.
  534. Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  535. flags.
  536. Tor replies with "250 OK" on success, or a 512 if there aren't enough
  537. arguments, or a 552 if it doesn't recognize the CircuitID.
  538. 3.18. QUIT
  539. Tells the server to hang up on this controller connection. This command
  540. can be used before authenticating.
  541. 3.19. USEFEATURE
  542. The syntax is:
  543. "USEFEATURE" *(SP FeatureName) CRLF
  544. FeatureName = 1*(ALPHA / DIGIT / "_" / "-")
  545. Sometimes extensions to the controller protocol break compatibility with
  546. older controllers. In this case, whenever possible, the extensions are
  547. first included in Tor disabled by default, and only enabled on a given
  548. controller connection when the "USEFEATURE" command is given. Once a
  549. "USEFEATURE" command is given, it applies to all subsequent interactions on
  550. the same connection; to disable an enabled feature, a new controller
  551. connection must be opened.
  552. This is a forward-compatibility mechanism; each feature will eventually
  553. become a regular part of the control protocol in some future version of Tor.
  554. Tor will ignore a request to use any feature that is already on by default.
  555. Tor will give a "552" error if any requested feature is not recognized.
  556. Feature names are case-insensitive.
  557. EXTENDED_EVENTS
  558. Same as passing 'EXTENDED' to SETEVENTS; this is the preferred way to
  559. request the extended event syntax.
  560. This will not be always-enabled until at least XXX (or, at least two
  561. stable releases after XXX, the release where it was first used for
  562. anything.)
  563. VERBOSE_NAMES
  564. Instead of ServerID as specified above, the controller should
  565. identify ORs by LongName in events and GETINFO results. This format is
  566. strictly more informative: rather than including Nickname for
  567. known Named routers and Fingerprint for unknown or unNamed routers, the
  568. LongName format includes a Fingerprint, an indication of Named status,
  569. and a Nickname (if one is known).
  570. This will not be always-enabled until at least 0.1.4.x (or at least two
  571. stable releases after 0.1.2.2-alpha, the release where it was first
  572. available.)
  573. 3.20. RESOLVE
  574. The syntax is
  575. "RESOLVE" *Option *Address CRLF
  576. Option = "mode=reverse"
  577. Address = a hostname or IPv4 address
  578. This command launches a remote hostname lookup request for every specified
  579. request (or reverse lookup if "mode=reverse" is specified). Note that the
  580. request is done in the background: to see the answers, your controller will
  581. need to listen for ADDRMAP events; see 4.1.7 below.
  582. [Added in Tor 0.2.0.3-alpha]
  583. 3.21. PROTOCOLINFO
  584. The syntax is:
  585. "PROTOCOLINFO" *(SP PIVERSION) CRLF
  586. The server reply format is:
  587. "250-PROTOCOLINFO" SP PIVERSION CRLF *InfoLine "250 OK" CRLF
  588. InfoLine = AuthLine / VersionLine / OtherLine
  589. AuthLine = "250-AUTH" SP "METHODS=" AuthMethod *(",")AuthMethod
  590. *(SP "COOKIEFILE=" AuthCookieFile) CRLF
  591. VersionLine = "250-VERSION" SP "Tor=" TorVersion [SP Arguments] CRLF
  592. AuthMethod =
  593. "NULL" / ; No authentication is required
  594. "HASHEDPASSWORD" / ; A controller must supply the original password
  595. "COOKIE" / ; A controller must supply the contents of a cookie
  596. AuthCookieFile = QuotedString
  597. TorVersion = QuotedString
  598. OtherLine = "250-" Keyword [SP Arguments] CRLF
  599. PIVERSION: 1*DIGIT
  600. Tor MAY give its InfoLines in any order; controllers MUST ignore InfoLines
  601. with keywords they do not recognize. Controllers MUST ignore extraneous
  602. data on any InfoLine.
  603. PIVERSION is there in case we drastically change the syntax one day. For
  604. now it should always be "1". Controllers MAY provide a list of the
  605. protocolinfo versions they support; Tor MAY select a version that the
  606. controller does not support.
  607. AuthMethod is used to specify one or more control authentication
  608. methods that Tor currently accepts.
  609. AuthCookieFile specifies the absolute path and filename of the
  610. authentication cookie that Tor is expecting and is provided iff
  611. the METHODS field contains the method "COOKIE". Controllers MUST handle
  612. escape sequences inside this string.
  613. The VERSION line contains the Tor version.
  614. [Unlike other commands besides AUTHENTICATE, PROTOCOLINFO may be used (but
  615. only once!) before AUTHENTICATE.]
  616. [PROTOCOLINFO was not supported before Tor 0.2.0.5-alpha.]
  617. 4. Replies
  618. Reply codes follow the same 3-character format as used by SMTP, with the
  619. first character defining a status, the second character defining a
  620. subsystem, and the third designating fine-grained information.
  621. The TC protocol currently uses the following first characters:
  622. 2yz Positive Completion Reply
  623. The command was successful; a new request can be started.
  624. 4yz Temporary Negative Completion reply
  625. The command was unsuccessful but might be reattempted later.
  626. 5yz Permanent Negative Completion Reply
  627. The command was unsuccessful; the client should not try exactly
  628. that sequence of commands again.
  629. 6yz Asynchronous Reply
  630. Sent out-of-order in response to an earlier SETEVENTS command.
  631. The following second characters are used:
  632. x0z Syntax
  633. Sent in response to ill-formed or nonsensical commands.
  634. x1z Protocol
  635. Refers to operations of the Tor Control protocol.
  636. x5z Tor
  637. Refers to actual operations of Tor system.
  638. The following codes are defined:
  639. 250 OK
  640. 251 Operation was unnecessary
  641. [Tor has declined to perform the operation, but no harm was done.]
  642. 451 Resource exhausted
  643. 500 Syntax error: protocol
  644. 510 Unrecognized command
  645. 511 Unimplemented command
  646. 512 Syntax error in command argument
  647. 513 Unrecognized command argument
  648. 514 Authentication required
  649. 515 Bad authentication
  650. 550 Unspecified Tor error
  651. 551 Internal error
  652. [Something went wrong inside Tor, so that the client's
  653. request couldn't be fulfilled.]
  654. 552 Unrecognized entity
  655. [A configuration key, a stream ID, circuit ID, event,
  656. mentioned in the command did not actually exist.]
  657. 553 Invalid configuration value
  658. [The client tried to set a configuration option to an
  659. incorrect, ill-formed, or impossible value.]
  660. 554 Invalid descriptor
  661. 555 Unmanaged entity
  662. 650 Asynchronous event notification
  663. Unless specified to have specific contents, the human-readable messages
  664. in error replies should not be relied upon to match those in this document.
  665. 4.1. Asynchronous events
  666. These replies can be sent after a corresponding SETEVENTS command has been
  667. received. They will not be interleaved with other Reply elements, but they
  668. can appear between a command and its corresponding reply. For example,
  669. this sequence is possible:
  670. C: SETEVENTS CIRC
  671. S: 250 OK
  672. C: GETCONF SOCKSPORT ORPORT
  673. S: 650 CIRC 1000 EXTENDED moria1,moria2
  674. S: 250-SOCKSPORT=9050
  675. S: 250 ORPORT=0
  676. But this sequence is disallowed:
  677. C: SETEVENTS CIRC
  678. S: 250 OK
  679. C: GETCONF SOCKSPORT ORPORT
  680. S: 250-SOCKSPORT=9050
  681. S: 650 CIRC 1000 EXTENDED moria1,moria2
  682. S: 250 ORPORT=0
  683. Clients MUST tolerate more arguments in an asynchonous reply than
  684. expected, and MUST tolerate more lines in an asynchronous reply than
  685. expected. For instance, a client that expects a CIRC message like:
  686. 650 CIRC 1000 EXTENDED moria1,moria2
  687. must tolerate:
  688. 650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
  689. 650-EXTRAMAGIC=99
  690. 650 ANONYMITY=high
  691. If clients ask for extended events, then each event line as specified below
  692. will be followed by additional extensions. Additional lines will be of the
  693. form
  694. "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  695. Additional arguments will be of the form
  696. SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
  697. Such clients MUST tolerate lines with keywords they do not recognize.
  698. 4.1.1. Circuit status changed
  699. The syntax is:
  700. "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
  701. [SP "REASON=" Reason [SP "REMOTE_REASON=" Reason]] CRLF
  702. CircStatus =
  703. "LAUNCHED" / ; circuit ID assigned to new circuit
  704. "BUILT" / ; all hops finished, can now accept streams
  705. "EXTENDED" / ; one more hop has been completed
  706. "FAILED" / ; circuit closed (was not built)
  707. "CLOSED" ; circuit closed (was built)
  708. Path = ServerID *("," ServerID)
  709. Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
  710. "HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
  711. "OR_IDENTITY" / "OR_CONN_CLOSED" / "TIMEOUT" /
  712. "FINISHED" / "DESTROYED" / "NOPATH" / "NOSUCHSERVICE"
  713. The path is provided only when the circuit has been extended at least one
  714. hop.
  715. The "REASON" field is provided only for FAILED and CLOSED events, and only
  716. if extended events are enabled (see 3.19). Clients MUST accept reasons
  717. not listed above. Reasons are as given in tor-spec.txt, except for:
  718. NOPATH (Not enough nodes to make circuit)
  719. The "REMOTE_REASON" field is provided only when we receive a DESTROY or
  720. TRUNCATE cell, and only if extended events are enabled. It contains the
  721. actual reason given by the remote OR for closing the circuit. Clients MUST
  722. accept reasons not listed above. Reasons are as listed in tor-spec.txt.
  723. 4.1.2. Stream status changed
  724. The syntax is:
  725. "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target
  726. [SP "REASON=" Reason [ SP "REMOTE_REASON=" Reason ]]
  727. [SP "SOURCE=" Source] [ SP "SOURCE_ADDR=" Address ":" Port ]
  728. CRLF
  729. StreamStatus =
  730. "NEW" / ; New request to connect
  731. "NEWRESOLVE" / ; New request to resolve an address
  732. "REMAP" / ; Address re-mapped to another
  733. "SENTCONNECT" / ; Sent a connect cell along a circuit
  734. "SENTRESOLVE" / ; Sent a resolve cell along a circuit
  735. "SUCCEEDED" / ; Received a reply; stream established
  736. "FAILED" / ; Stream failed and not retriable
  737. "CLOSED" / ; Stream closed
  738. "DETACHED" ; Detached from circuit; still retriable
  739. Target = Address ":" Port
  740. The circuit ID designates which circuit this stream is attached to. If
  741. the stream is unattached, the circuit ID "0" is given.
  742. Reason = "MISC" / "RESOLVEFAILED" / "CONNECTREFUSED" /
  743. "EXITPOLICY" / "DESTROY" / "DONE" / "TIMEOUT" /
  744. "HIBERNATING" / "INTERNAL"/ "RESOURCELIMIT" /
  745. "CONNRESET" / "TORPROTOCOL" / "NOTDIRECTORY" / "END"
  746. The "REASON" field is provided only for FAILED, CLOSED, and DETACHED
  747. events, and only if extended events are enabled (see 3.19). Clients MUST
  748. accept reasons not listed above. Reasons are as given in tor-spec.txt,
  749. except for:
  750. END (We received a RELAY_END cell from the other side of thise
  751. stream.)
  752. [XXXX document more.]
  753. The "REMOTE_REASON" field is provided only when we receive a RELAY_END
  754. cell, and only if extended events are enabled. It contains the actual
  755. reason given by the remote OR for closing the stream. Clients MUST accept
  756. reasons not listed above. Reasons are as listed in tor-spec.txt.
  757. "REMAP" events include a Source if extended events are enabled:
  758. Source = "CACHE" / "EXIT"
  759. Clients MUST accept sources not listed above. "CACHE" is given if
  760. the Tor client decided to remap the address because of a cached
  761. answer, and "EXIT" is given if the remote node we queried gave us
  762. the new address as a response.
  763. The "SOURCE_ADDR" field is included with NEW and NEWRESOLVE events if
  764. extended events are enabled. It indicates the address and port
  765. that requested the connection, and can be (e.g.) used to look up the
  766. requesting program.
  767. 4.1.3. OR Connection status changed
  768. The syntax is:
  769. "650" SP "ORCONN" SP (ServerID / Target) SP ORStatus [ SP "REASON="
  770. Reason ] [ SP "NCIRCS=" NumCircuits ] CRLF
  771. ORStatus = "NEW" / "LAUNCHED" / "CONNECTED" / "FAILED" / "CLOSED"
  772. NEW is for incoming connections, and LAUNCHED is for outgoing
  773. connections. CONNECTED means the TLS handshake has finished (in
  774. either direction). FAILED means a connection is being closed that
  775. hasn't finished its handshake, and CLOSED is for connections that
  776. have handshaked.
  777. A ServerID is specified unless it's a NEW connection, in which
  778. case we don't know what server it is yet, so we use Address:Port.
  779. If extended events are enabled (see 3.19), optional reason and
  780. circuit counting information is provided for CLOSED and FAILED
  781. events.
  782. Reason = "MISC" / "DONE" / "CONNECTREFUSED" /
  783. "IDENTITY" / "CONNECTRESET" / "TIMEOUT" / "NOROUTE" /
  784. "IOERROR"
  785. NumCircuits counts both established and pending circuits.
  786. 4.1.4. Bandwidth used in the last second
  787. The syntax is:
  788. "650" SP "BW" SP BytesRead SP BytesWritten *(SP Type "=" Num) CRLF
  789. BytesRead = 1*DIGIT
  790. BytesWritten = 1*DIGIT
  791. Type = "DIR" / "OR" / "EXIT" / "APP" / ...
  792. Num = 1*DIGIT
  793. BytesRead and BytesWritten are the totals. In Tor 0.1.x.y-alpha
  794. and later, we also include a breakdown of the connection types
  795. that used bandwidth this second (not implemented yet).
  796. 4.1.5. Log messages
  797. The syntax is:
  798. "650" SP Severity SP ReplyText CRLF
  799. or
  800. "650+" Severity CRLF Data 650 SP "OK" CRLF
  801. Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"
  802. 4.1.6. New descriptors available
  803. Syntax:
  804. "650" SP "NEWDESC" 1*(SP ServerID) CRLF
  805. 4.1.7. New Address mapping
  806. Syntax:
  807. "650" SP "ADDRMAP" SP Address SP NewAddress SP Expiry
  808. [SP Error] SP GMTExpiry CRLF
  809. NewAddress = Address / "<error>"
  810. Expiry = DQUOTE ISOTime DQUOTE / "NEVER"
  811. Error = "error=" ErrorCode
  812. ErrorCode = XXXX
  813. GMTExpiry = "EXPIRES=" DQUOTE IsoTime DQUOTE
  814. Error and GMTExpiry are only provided if extended events are enabled.
  815. Expiry is expressed as the local time (rather than GMT). This is a bug,
  816. left in for backward compatibility; new code should look at GMTExpiry
  817. instead.
  818. These events are generated when a new address mapping is entered in the
  819. cache, or when the answer for a RESOLVE command is found.
  820. 4.1.8. Descriptors uploaded to us in our role as authoritative dirserver
  821. Syntax:
  822. "650" "+" "AUTHDIR_NEWDESCS" CRLF Action CRLF Message CRLF
  823. Descriptor CRLF "." CRLF "650" SP "OK" CRLF
  824. Action = "ACCEPTED" / "DROPPED" / "REJECTED"
  825. Message = Text
  826. 4.1.9. Our descriptor changed
  827. Syntax:
  828. "650" SP "DESCCHANGED" CRLF
  829. [First added in 0.1.2.2-alpha.]
  830. 4.1.10. Status events
  831. Status events (STATUS_GENERAL, STATUS_CLIENT, and STATUS_SERVER) are sent
  832. based on occurrences in the Tor process pertaining to the general state of
  833. the program. Generally, they correspond to log messages of severity Notice
  834. or higher. They differ from log messages in that their format is a
  835. specified interface.
  836. Syntax:
  837. "650" SP StatusType SP StatusSeverity SP StatusAction
  838. [SP StatusArguments] CRLF
  839. StatusType = "STATUS_GENERAL" / "STATUS_CLIENT" / "STATUS_SERVER"
  840. StatusSeverity = "NOTICE" / "WARN" / "ERR"
  841. StatusAction = 1*ALPHA
  842. StatusArguments = StatusArgument *(SP StatusArgument)
  843. StatusArgument = StatusKeyword '=' StatusValue
  844. StatusKeyword = 1*(ALNUM / "_")
  845. StatusValue = 1*(ALNUM / '_') / QuotedString
  846. Action is a string, and Arguments is a series of keyword=value
  847. pairs on the same line. Values may be space-terminated strings,
  848. or quoted strings.
  849. These events are always produced with EXTENDED_EVENTS and
  850. VERBOSE_NAMES; see the explanations in the USEFEATURE section
  851. for details.
  852. Controllers MUST tolerate unrecognized actions, MUST tolerate
  853. unrecognized arguments, MUST tolerate missing arguments, and MUST
  854. tolerate arguments that arrive in any order.
  855. Each event description below is accompanied by a recommendation for
  856. controllers. These recommendations are suggestions only; no controller
  857. is required to implement them.
  858. Actions for STATUS_GENERAL events can be as follows:
  859. CLOCK_JUMPED
  860. "TIME=NUM"
  861. Tor spent enough time without CPU cycles that it has closed all
  862. its circuits and will establish them anew. This typically
  863. happens when a laptop goes to sleep and then wakes up again. It
  864. also happens when the system is swapping so heavily that Tor is
  865. starving. The "time" argument specifies the number of seconds Tor
  866. thinks it was unconscious for (or alternatively, the number of
  867. seconds it went back in time).
  868. This status event is sent as NOTICE severity normally, but WARN
  869. severity if Tor is acting as a server currently.
  870. {Recommendation for controller: ignore it, since we don't really
  871. know what the user should do anyway. Hm.}
  872. DANGEROUS_VERSION
  873. "CURRENT=version"
  874. "REASON=NEW/OLD/UNRECOMMENDED"
  875. "RECOMMENDED=\"version, version, ...\""
  876. Tor has found that directory servers don't recommend its version of
  877. the Tor software. RECOMMENDED is a comma-and-space-separated string
  878. of Tor versions that are recommended. REASON is NEW if this version
  879. of Tor is newer than any recommended version, OLD if this version of
  880. Tor is older than any recommended version, and UNRECOMMENDED if
  881. some recommended versions of Tor are newer and some are old than this
  882. version.
  883. {Controllers may want to suggest that the user upgrade OLD or
  884. UNRECOMMENDED versions. NEW versions may be known-insecure, or may
  885. simply be development versions.}
  886. TOO_MANY_CONNECTIONS
  887. "CURRENT=NUM"
  888. Tor has reached its ulimit -n or whatever the native limit is on file
  889. descriptors or sockets. CURRENT is the number of sockets Tor
  890. currently has open. The user should really do something about
  891. this. The "current" argument shows the number of connections currently
  892. open.
  893. {Controllers may recommend that the user increase the limit, or
  894. increase it for them. Recommendations should be phrased in an
  895. OS-appropriate way and automated when possible.}
  896. BUG
  897. "REASON=STRING"
  898. Tor has encountered a situation that its developers never expected,
  899. and the developers would like to learn that it happened. Perhaps
  900. the controller can explain this to the user and encourage her to
  901. file a bug report?
  902. {Controllers should log bugs, but shouldn't annoy the user in case a
  903. bug appears frequently.}
  904. CLOCK_SKEW
  905. SKEW="+" / "-" SECONDS
  906. SOURCE="DIRSERV:IP:Port" / "NETWORKSTATUS:IP:PORT"
  907. If "SKEW" is present, it's an estimate of how far we are from the
  908. time declared in the source. If the source is a DIRSERV, we got
  909. the current time from a connection to a dirserver. If the source is
  910. a NETWORKSTATUS, we decided we're skewed because we got a
  911. networkstatus from far in the future.
  912. {Controllers may want to warn the user if the skew is high, or if
  913. multiple skew messages appear at severity WARN. Controllers
  914. shouldn't blindly adjust the clock, since the more accurate source
  915. of skew info (DIRSERV) is currently unauthenticated.}
  916. BAD_LIBEVENT
  917. "METHOD=" libevent method
  918. "VERSION=" libevent version
  919. "BADNESS=" "BROKEN" / "BUGGY" / "SLOW"
  920. "RECOVERED=" "NO" / "YES"
  921. Tor knows about bugs in using the configured event method in this
  922. version of libevent. "BROKEN" libevents won't work at all;
  923. "BUGGY" libevents might work okay; "SLOW" libevents will work
  924. fine, but not quickly. If "RECOVERED" is YES, Tor managed to
  925. switch to a more reliable (but probably slower!) libevent method.
  926. {Controllers may want to warn the user if this event occurs, though
  927. generally it's the fault of whoever built the Tor binary and there's
  928. not much the user can do besides upgrade libevent or upgrade the
  929. binary.}
  930. DIR_ALL_UNREACHABLE
  931. Tor believes that none of the known directory servers are
  932. reachable -- this is most likely because the local network is
  933. down or otherwise not working, and might help to explain for the
  934. user why Tor appears to be broken.
  935. {Controllers may want to warn the user if this event occurs; further
  936. action is generally not possible.}
  937. Actions for STATUS_CLIENT events can be as follows:
  938. ENOUGH_DIR_INFO
  939. Tor now knows enough network-status documents and enough server
  940. descriptors that it's going to start trying to build circuits now.
  941. {Controllers may want to use this event to decide when to indicate
  942. progress to their users, but should not interrupt the user's browsing
  943. to tell them so.}
  944. NOT_ENOUGH_DIR_INFO
  945. We discarded expired statuses and router descriptors to fall
  946. below the desired threshold of directory information. We won't
  947. try to build any circuits until ENOUGH_DIR_INFO occurs again.
  948. {Controllers may want to use this event to decide when to indicate
  949. progress to their users, but should not interrupt the user's browsing
  950. to tell them so.}
  951. CIRCUIT_ESTABLISHED
  952. Tor is able to establish circuits for client use. This event will
  953. only be sent if we just built a circuit that changed our mind --
  954. that is, prior to this event we didn't know whether we could
  955. establish circuits.
  956. {Suggested use: controllers can notify their users that Tor is
  957. ready for use as a client once they see this status event. [Perhaps
  958. controllers should also have a timeout if too much time passes and
  959. this event hasn't arrived, to give tips on how to troubleshoot.
  960. On the other hand, hopefully Tor will send further status events
  961. if it can identify the problem.]}
  962. CIRCUIT_NOT_ESTABLISHED
  963. "REASON=" "EXTERNAL_ADDRESS" / "DIR_ALL_UNREACHABLE" / "CLOCK_JUMPED"
  964. We are no longer confident that we can build circuits. The "reason"
  965. keyword provides an explanation: which other status event type caused
  966. our lack of confidence.
  967. {Controllers may want to use this event to decide when to indicate
  968. progress to their users, but should not interrupt the user's browsing
  969. to do so.}
  970. [Note: only REASON=CLOCK_JUMPED is implemented currently.]
  971. DANGEROUS_SOCKS
  972. "PROTOCOL=SOCKS4/SOCKS5"
  973. "ADDRESS=IP:port"
  974. A connection was made to Tor's SOCKS port using one of the SOCKS
  975. approaches that doesn't support hostnames -- only raw IP addresses.
  976. If the client application got this address from gethostbyname(),
  977. it may be leaking target addresses via DNS.
  978. {Controllers should warn their users when this occurs, unless they
  979. happen to know that the application using Tor is in fact doing so
  980. correctly (e.g., because it is part of a distributed bundle).}
  981. SOCKS_UNKNOWN_PROTOCOL
  982. "DATA=string"
  983. A connection was made to Tor's SOCKS port that tried to use it
  984. for something other than the SOCKS protocol. Perhaps the user is
  985. using Tor as an HTTP proxy? The DATA is the first few characters
  986. sent to Tor on the SOCKS port.
  987. {Controllers may want to warn their users when this occurs: it
  988. indicates a misconfigured application.}
  989. SOCKS_BAD_HOSTNAME
  990. "HOSTNAME=QuotedString"
  991. Some application gave us a funny-looking hostname. Perhaps
  992. it is broken? In any case it won't work with Tor and the user
  993. should know.
  994. {Controllers may want to warn their users when this occurs: it
  995. usually indicates a misconfigured application.}
  996. Actions for STATUS_SERVER can be as follows:
  997. EXTERNAL_ADDRESS
  998. "ADDRESS=IP"
  999. "HOSTNAME=NAME"
  1000. "METHOD=CONFIGURED/DIRSERV/RESOLVED/INTERFACE/GETHOSTNAME"
  1001. Our best idea for our externally visible IP has changed to 'IP'.
  1002. If 'HOSTNAME' is present, we got the new IP by resolving 'NAME'. If the
  1003. method is 'CONFIGURED', the IP was given verbatim as a configuration
  1004. option. If the method is 'RESOLVED', we resolved the Address
  1005. configuration option to get the IP. If the method is 'GETHOSTNAME',
  1006. we resolved our hostname to get the IP. If the method is 'INTERFACE',
  1007. we got the address of one of our network interfaces to get the IP. If
  1008. the method is 'DIRSERV', a directory server told us a guess for what
  1009. our IP might be.
  1010. {Controllers may want to record this info and display it to the user.}
  1011. CHECKING_REACHABILITY
  1012. "ORADDRESS=IP:port"
  1013. "DIRADDRESS=IP:port"
  1014. We're going to start testing the reachability of our external OR port
  1015. or directory port.
  1016. {This event could effect the controller's idea of server status, but
  1017. the controller should not interrupt the user to tell them so.}
  1018. REACHABILITY_SUCCEEDED
  1019. "ORADDRESS=IP:port"
  1020. "DIRADDRESS=IP:port"
  1021. We successfully verified the reachability of our external OR port or
  1022. directory port (depending on which of ORADDRESS or DIRADDRESS is
  1023. given.)
  1024. {This event could effect the controller's idea of server status, but
  1025. the controller should not interrupt the user to tell them so.}
  1026. GOOD_SERVER_DESCRIPTOR
  1027. We successfully uploaded our server descriptor to each of the
  1028. directory authorities, with no complaints.
  1029. {This event could effect the controller's idea of server status, but
  1030. the controller should not interrupt the user to tell them so.}
  1031. NAMESERVER_STATUS
  1032. "NS=addr"
  1033. "STATUS=" "UP" / "DOWN"
  1034. "ERR=" message
  1035. One of our nameservers has changed status.
  1036. // actually notice
  1037. {This event could effect the controller's idea of server status, but
  1038. the controller should not interrupt the user to tell them so.}
  1039. NAMESERVER_ALL_DOWN
  1040. All of our nameservers have gone down.
  1041. {This is a problem; if it happens often without the nameservers
  1042. coming up again, the user needs to configure more or better
  1043. nameservers.}
  1044. DNS_HIJACKED
  1045. Our DNS provider is providing an address when it should be saying
  1046. "NOTFOUND"; Tor will treat the address as a synonym for "NOTFOUND".
  1047. {This is an annoyance; controllers may want to tell admins that their
  1048. DNS provider is not to be trusted.}
  1049. DNS_USELESS
  1050. Our DNS provider is giving a hijacked address instead of well-known
  1051. websites; Tor will not try to be an exit node.
  1052. {Controllers could warn the admin if the server is running as an
  1053. exit server: the admin needs to configure a good DNS server.
  1054. Alternatively, this happens a lot in some restrictive environments
  1055. (hotels, universities, coffeeshops) when the user hasn't registered.}
  1056. BAD_SERVER_DESCRIPTOR
  1057. "DIRAUTH=addr:port"
  1058. "REASON=string"
  1059. A directory authority rejected our descriptor. Possible reasons
  1060. include malformed descriptors, incorrect keys, highly skewed clocks,
  1061. and so on.
  1062. {Controllers should warn the admin, and try to cope if they can.}
  1063. ACCEPTED_SERVER_DESCRIPTOR
  1064. "DIRAUTH=addr:port"
  1065. A single directory authority accepted our descriptor.
  1066. // actually notice
  1067. {This event could effect the controller's idea of server status, but
  1068. the controller should not interrupt the user to tell them so.}
  1069. REACHABILITY_FAILED
  1070. "ORADDRESS=IP:port"
  1071. "DIRADDRESS=IP:port"
  1072. We failed to connect to our external OR port or directory port
  1073. successfully.
  1074. {This event could effect the controller's idea of server status. The
  1075. controller should warn the admin and suggest reasonable steps to take.}
  1076. 4.1.11. Our set of guard nodes has changed
  1077. Syntax:
  1078. "650" SP "GUARD" SP Type SP Name SP Status ... CRLF
  1079. Type = "ENTRY"
  1080. Name = The (possibly verbose) nickname of the guard affected.
  1081. Status = "NEW" | "UP" | "DOWN" | "BAD" | "GOOD" | "DROPPED"
  1082. [explain states. XXX]
  1083. 4.1.12. Network status has changed
  1084. Syntax:
  1085. "650" "+" "NS" CRLF 1*NetworkStatus "." CRLF "650" SP "OK" CRLF
  1086. [First added in 0.1.2.3-alpha]
  1087. 4.1.13. Bandwidth used on an application stream
  1088. The syntax is:
  1089. "650" SP "STREAM_BW" SP StreamID SP BytesRead SP BytesWritten CRLF
  1090. BytesRead = 1*DIGIT
  1091. BytesWritten = 1*DIGIT
  1092. BytesRead and BytesWritten are the number of bytes read and written since
  1093. the last STREAM_BW event on this stream. These events are generated about
  1094. once per second per stream; no events are generated for streams that have
  1095. not read or written.
  1096. These events apply only to streams entering Tor (such as on a SOCKSPort,
  1097. TransPort, or so on). They are not generated for exiting streams.
  1098. 5. Implementation notes
  1099. 5.1. Authentication
  1100. By default, the current Tor implementation trusts all local users.
  1101. If the 'CookieAuthentication' option is true, Tor writes a "magic cookie"
  1102. file named "control_auth_cookie" into its data directory. To authenticate,
  1103. the controller must send the contents of this file, encoded in hexadecimal.
  1104. If the 'HashedControlPassword' option is set, it must contain the salted
  1105. hash of a secret password. The salted hash is computed according to the
  1106. S2K algorithm in RFC 2440 (OpenPGP), and prefixed with the s2k specifier.
  1107. This is then encoded in hexadecimal, prefixed by the indicator sequence
  1108. "16:". Thus, for example, the password 'foo' could encode to:
  1109. 16:660537E3E1CD49996044A3BF558097A981F539FEA2F9DA662B4626C1C2
  1110. ++++++++++++++++**^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  1111. salt hashed value
  1112. indicator
  1113. You can generate the salt of a password by calling
  1114. 'tor --hash-password <password>'
  1115. or by using the example code in the Python and Java controller libraries.
  1116. To authenticate under this scheme, the controller sends Tor the original
  1117. secret that was used to generate the password.
  1118. 5.2. Don't let the buffer get too big.
  1119. If you ask for lots of events, and 16MB of them queue up on the buffer,
  1120. the Tor process will close the socket.
  1121. 5.3. Backward compatibility with v0 control protocol.
  1122. The 'version 0' control protocol was replaced in Tor 0.1.1.x. Support was
  1123. removed in Tor 0.2.0.x. Every non-obsolete version of Tor now supports the
  1124. version 1 control protocol.
  1125. For backward compatibility with the "version 0" control protocol,
  1126. Tor used to check whether the third octet of the first command is zero.
  1127. (If it was, Tor assumed that version 0 is in use.)
  1128. This compatibility was removed in Tor 0.1.2.16 and 0.2.0.4-alpha.
  1129. 5.4. Options for use by controllers
  1130. Tor provides a few special configuration options for use by controllers.
  1131. These options can be set and examined by the SETCONF and GETCONF commands,
  1132. but are not saved to disk by SAVECONF.
  1133. Generally, these options make Tor unusable by disabling a portion of Tor's
  1134. normal operations. Unless a controller provides replacement functionality
  1135. to fill this gap, Tor will not correctly handle user requests.
  1136. __AllDirOptionsPrivate
  1137. If true, Tor will try to launch all directory operations through
  1138. anonymous connections. (Ordinarily, Tor only tries to anonymize
  1139. requests related to hidden services.) This option will slow down
  1140. directory access, and may stop Tor from working entirely if it does not
  1141. yet have enough directory information to build circuits.
  1142. (Boolean. Default: "0".)
  1143. __DisablePredictedCircuits
  1144. If true, Tor will not launch preemptive "general purpose" circuits for
  1145. streams to attach to. (It will still launch circuits for testing and
  1146. for hidden services.)
  1147. (Boolean. Default: "0".)
  1148. __LeaveStreamsUnattached
  1149. If true, Tor will not automatically attach new streams to circuits;
  1150. instead, the controller must attach them with ATTACHSTREAM. If the
  1151. controller does not attach the streams, their data will never be routed.
  1152. (Boolean. Default: "0".)