control-spec.txt 57 KB

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