control-spec.txt 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727
  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.
  12. 1. Protocol outline
  13. TC is a bidirectional message-based protocol. It assumes an underlying
  14. stream for communication between a controlling process (the "client"
  15. or "controller") and a Tor process (or "server"). The stream may be
  16. implemented via TCP, TLS-over-TCP, a Unix-domain socket, or so on,
  17. but it must provide reliable in-order delivery. For security, the
  18. stream should not be accessible by untrusted parties.
  19. In TC, the client and server send typed messages to each other over the
  20. underlying stream. The client sends "commands" and the server sends
  21. "replies".
  22. By default, all messages from the server are in response to messages from
  23. the client. Some client requests, however, will cause the server to send
  24. messages to the client indefinitely far into the future. Such
  25. "asynchronous" replies are marked as such.
  26. Servers respond to messages in the order messages are received.
  27. 2. Message format
  28. 2.1. Description format
  29. The message formats listed below use ABNF as described in RFC2234.
  30. The protocol itself is loosely based on SMTP (see RFC 2821).
  31. We use the following nonterminals from RFC2822: atom, qcontent
  32. We define the following general-use nonterminals:
  33. String = DQUOTE *qcontent DQUOTE
  34. There are explicitly no limits on line length. All 8-bit characters are
  35. permitted unless explicitly disallowed.
  36. 2.2. Commands from controller to Tor
  37. Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data
  38. Keyword = 1*ALPHA
  39. Arguments = *(SP / VCHAR)
  40. Specific commands and their arguments are described below in section 3.
  41. 2.3. Replies from Tor to the controller
  42. Reply = *(MidReplyLine / DataReplyLine) EndReplyLine
  43. MidReplyLine = "-" ReplyLine
  44. DataReplyLine = "+" ReplyLine Data
  45. EndReplyLine = SP ReplyLine
  46. ReplyLine = StatusCode [ SP ReplyText ] CRLF
  47. ReplyText = XXXX
  48. StatusCode = XXXX
  49. Specific replies are mentioned below in section 3, and described more fully
  50. in section 4.
  51. 2.4. General-use tokens
  52. ; Identifiers for servers.
  53. ServerID = Nickname / Fingerprint
  54. Nickname = 1*19 NicknameChar
  55. NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
  56. Fingerprint = "$" 40*HEXDIG
  57. ; Unique identifiers for streams or circuits. Currently, Tor only
  58. ; uses digits, but this may change
  59. StreamID = 1*16 IDChar
  60. CircuitID = 1*16 IDChar
  61. IDChar = ALPHA / DIGIT
  62. Address = ip4-address / ip6-address / hostname (XXXX Define these)
  63. ; A "Data" section is a sequence of octets concluded by the terminating
  64. ; sequence CRLF "." CRLF. The terminating sequence may not appear in the
  65. ; body of the data. Leading periods on lines in the data are escaped with
  66. ; an additional leading period as in RFC2821 section 4.5.2
  67. Data = *DataLine "." CRLF
  68. DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
  69. LineItem = NonCR / 1*CR NonCRLF
  70. NonDotItem = NonDotCR / 1*CR NonCRLF
  71. 3. Commands
  72. All commands and other keywords are case-insensitive.
  73. 3.1. SETCONF
  74. Change the value of one or more configuration variables. The syntax is:
  75. "SETCONF" 1*(SP keyword ["=" String]) CRLF
  76. Tor behaves as though it had just read each of the key-value pairs
  77. from its configuration file. Keywords with no corresponding values have
  78. their configuration values reset to 0 or NULL (use RESETCONF if you want
  79. to set it back to its default). SETCONF is all-or-nothing: if there
  80. is an error in any of the configuration settings, Tor sets none of them.
  81. Tor responds with a "250 configuration values set" reply on success.
  82. If some of the listed keywords can't be found, Tor replies with a
  83. "552 Unrecognized option" message. Otherwise, Tor responds with a
  84. "513 syntax error in configuration values" reply on syntax error, or a
  85. "553 impossible configuration setting" reply on a semantic error.
  86. When a configuration option takes multiple values, or when multiple
  87. configuration keys form a context-sensitive group (see GETCONF below), then
  88. setting _any_ of the options in a SETCONF command is taken to reset all of
  89. the others. For example, if two ORBindAddress values are configured, and a
  90. SETCONF command arrives containing a single ORBindAddress value, the new
  91. command's value replaces the two old values.
  92. 3.2. RESETCONF
  93. Remove all settings for a given configuration option entirely, assign
  94. its default value (if any), and then assign the String provided.
  95. Typically the String is left empty, to simply set an option back to
  96. its default. The syntax is:
  97. "RESETCONF" 1*(SP keyword ["=" String]) CRLF
  98. Otherwise it behaves like SETCONF above.
  99. 3.3. GETCONF
  100. Request the value of a configuration variable. The syntax is:
  101. "GETCONF" 1*(SP keyword) CRLF
  102. If all of the listed keywords exist in the Tor configuration, Tor replies
  103. with a series of reply lines of the form:
  104. 250 keyword=value
  105. If any option is set to a 'default' value semantically different from an
  106. empty string, Tor may reply with a reply line of the form:
  107. 250 keyword
  108. If some of the listed keywords can't be found, Tor replies with a
  109. "552 unknown configuration keyword" message.
  110. If an option appears multiple times in the configuration, all of its
  111. key-value pairs are returned in order.
  112. Some options are context-sensitive, and depend on other options with
  113. different keywords. These cannot be fetched directly. Currently there
  114. is only one such option: clients should use the "HiddenServiceOptions"
  115. virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  116. HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
  117. 3.4. SETEVENTS
  118. Request the server to inform the client about interesting events. The
  119. syntax is:
  120. "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
  121. EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
  122. "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
  123. "AUTHDIR_NEWDESCS"
  124. Any events *not* listed in the SETEVENTS line are turned off; thus, sending
  125. SETEVENTS with an empty body turns off all event reporting.
  126. The server responds with a "250 OK" reply on success, and a "552
  127. Unrecognized event" reply if one of the event codes isn't recognized. (On
  128. error, the list of active event codes isn't changed.)
  129. If the flag string "EXTENDED" is provided, Tor may provide extra
  130. information with events for this connection; see 4.1 for more information.
  131. NOTE: All events on a given connection will be provided in extended format,
  132. or none.
  133. NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.
  134. 3.5. AUTHENTICATE
  135. Sent from the client to the server. The syntax is:
  136. "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
  137. The server responds with "250 OK" on success or "515 Bad authentication" if
  138. the authentication cookie is incorrect.
  139. The format of the 'cookie' is implementation-dependent; see 5.1 below for
  140. information on how the standard Tor implementation handles it.
  141. If Tor requires authentication and the controller has not yet sent an
  142. AUTHENTICATE message, Tor sends a "514 authentication required" reply to
  143. any other kind of message.
  144. 3.6. SAVECONF
  145. Sent from the client to the server. The syntax is:
  146. "SAVECONF" CRLF
  147. Instructs the server to write out its config options into its torrc. Server
  148. returns "250 OK" if successful, or "551 Unable to write configuration
  149. to disk" if it can't write the file or some other error occurs.
  150. 3.7. SIGNAL
  151. Sent from the client to the server. The syntax is:
  152. "SIGNAL" SP Signal CRLF
  153. Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
  154. "HUP" / "INT" / "USR1" / "USR2" / "TERM"
  155. The meaning of the signals are:
  156. RELOAD -- Reload: reload config items, refetch directory. (like HUP)
  157. SHUTDOWN -- Controlled shutdown: if server is an OP, exit immediately.
  158. If it's an OR, close listeners and exit after 30 seconds.
  159. (like INT)
  160. DUMP -- Dump stats: log information about open connections and
  161. circuits. (like USR1)
  162. DEBUG -- Debug: switch all open logs to loglevel debug. (like USR2)
  163. HALT -- Immediate shutdown: clean up and exit now. (like TERM)
  164. The server responds with "250 OK" if the signal is recognized (or simply
  165. closes the socket if it was asked to close immediately), or "552
  166. Unrecognized signal" if the signal is unrecognized.
  167. 3.8. MAPADDRESS
  168. Sent from the client to the server. The syntax is:
  169. "MAPADDRESS" 1*(Address "=" Address SP) CRLF
  170. The first address in each pair is an "original" address; the second is a
  171. "replacement" address. The client sends this message to the server in
  172. order to tell it that future SOCKS requests for connections to the original
  173. address should be replaced with connections to the specified replacement
  174. address. If the addresses are well-formed, and the server is able to
  175. fulfill the request, the server replies with a 250 message:
  176. 250-OldAddress1=NewAddress1
  177. 250 OldAddress2=NewAddress2
  178. containing the source and destination addresses. If request is malformed,
  179. the server replies with "512 syntax error in command argument". If the server
  180. can't fulfill the request, it replies with "451 resource exhausted."
  181. The client may decline to provide a body for the original address, and
  182. instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  183. "." for hostname), signifying that the server should choose the original
  184. address itself, and return that address in the reply. The server
  185. should ensure that it returns an element of address space that is unlikely
  186. to be in actual use. If there is already an address mapped to the
  187. destination address, the server may reuse that mapping.
  188. If the original address is already mapped to a different address, the old
  189. mapping is removed. If the original address and the destination address
  190. are the same, the server removes any mapping in place for the original
  191. address.
  192. Example:
  193. C: MAPADDRESS 0.0.0.0=tor.eff.org 1.2.3.4=tor.freehaven.net
  194. S: 250-127.192.10.10=tor.eff.org
  195. S: 250 1.2.3.4=tor.freehaven.net
  196. {Note: This feature is designed to be used to help Tor-ify applications
  197. that need to use SOCKS4 or hostname-less SOCKS5. There are three
  198. approaches to doing this:
  199. 1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
  200. 2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
  201. feature) to resolve the hostname remotely. This doesn't work
  202. with special addresses like x.onion or x.y.exit.
  203. 3. Use MAPADDRESS to map an IP address to the desired hostname, and then
  204. arrange to fool the application into thinking that the hostname
  205. has resolved to that IP.
  206. This functionality is designed to help implement the 3rd approach.}
  207. Mappings set by the controller last until the Tor process exits:
  208. they never expire. If the controller wants the mapping to last only
  209. a certain time, then it must explicitly un-map the address when that
  210. time has elapsed.
  211. 3.9. GETINFO
  212. Sent from the client to the server. The syntax is as for GETCONF:
  213. "GETINFO" 1*(SP keyword) CRLF
  214. one or more NL-terminated strings. The server replies with an INFOVALUE
  215. message.
  216. Unlike GETCONF, this message is used for data that are not stored in the Tor
  217. configuration file, and that may be longer than a single line. On success,
  218. one ReplyLine is sent for each requested value, followed by a final 250 OK
  219. ReplyLine. If a value fits on a single line, the format is:
  220. 250-keyword=value
  221. If a value must be split over multiple lines, the format is:
  222. 250+keyword=
  223. value
  224. .
  225. Recognized keys and their values include:
  226. "version" -- The version of the server's software, including the name
  227. of the software. (example: "Tor 0.0.9.4")
  228. "config-file" -- The location of Tor's configuration file ("torrc").
  229. "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest server
  230. descriptor for a given OR, NUL-terminated. If no such OR is known, the
  231. corresponding value is an empty string.
  232. "network-status" -- a space-separated list of all known OR identities.
  233. This is in the same format as the router-status line in directories;
  234. see tor-spec.txt for details.
  235. "addr-mappings/all"
  236. "addr-mappings/config"
  237. "addr-mappings/cache"
  238. "addr-mappings/control" -- a space-separated list of address mappings, each
  239. in the form of "from-address=to-address". The 'config' key
  240. returns those address mappings set in the configuration; the 'cache'
  241. key returns the mappings in the client-side DNS cache; the 'control'
  242. key returns the mappings set via the control interface; the 'all'
  243. target returns the mappings set through any mechanism.
  244. "circuit-status"
  245. A series of lines as for a circuit status event. Each line is of the form:
  246. CircuitID SP CircStatus SP Path CRLF
  247. "stream-status"
  248. A series of lines as for a stream status event. Each is of the form:
  249. StreamID SP StreamStatus SP CircID SP Target CRLF
  250. "orconn-status"
  251. A series of lines as for an OR connection status event. Each is of the
  252. form:
  253. ServerID SP ORStatus CRLF
  254. "helper-nodes"
  255. A series of lines listing the currently chosen helper nodes, if any.
  256. Each is of the form:
  257. ServerID SP ((("down" / "unlisted") ISOTime) / "up") CRLF
  258. "accounting/enabled"
  259. "accounting/hibernating"
  260. "accounting/bytes"
  261. "accounting/bytes-left"
  262. "accounting/interval-start"
  263. "accounting/interval-wake"
  264. "accounting/interval-end"
  265. Information about accounting status. If accounting is enabled,
  266. "enabled" is 1; otherwise it is 0. The "hibernating" field is "hard"
  267. if we are accepting no data; "soft" if we're accepting no new
  268. connections, and "awake" if we're not hibernating at all. The "bytes"
  269. and "bytes-left" fields contain (read-bytes SP write-bytes), for the
  270. start and the rest of the interval respectively. The 'interval-start'
  271. and 'interval-end' fields are the borders of the current interval; the
  272. 'interval-wake' field is the time within the current interval (if any)
  273. where we plan[ned] to start being active.
  274. "config/names"
  275. A series of lines listing the available configuration options. Each is
  276. of the form:
  277. OptionName SP OptionType [ SP Documentation ] CRLF
  278. OptionName = Keyword
  279. OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
  280. "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
  281. "String" / "LineList"
  282. Documentation = Text
  283. "info/names"
  284. A series of lines listing the available GETINFO options. Each is of
  285. one of these forms:
  286. OptionName SP Documentation CRLF
  287. OptionPrefix SP Documentation CRLF
  288. OptionPrefix = OptionName "/*"
  289. Examples:
  290. C: GETINFO version desc/name/moria1
  291. S: 250+desc/name/moria=
  292. S: [Descriptor for moria]
  293. S: .
  294. S: 250-version=Tor 0.1.1.0-alpha-cvs
  295. S: 250 OK
  296. 3.10. EXTENDCIRCUIT
  297. Sent from the client to the server. The format is:
  298. "EXTENDCIRCUIT" SP CircuitID SP ServerID *("," ServerID) CRLF
  299. This request takes one of two forms: either the Circuit ID is zero, in
  300. which case it is a request for the server to build a new circuit according
  301. to the specified path, or the Circuit ID is nonzero, in which case it is a
  302. request for the server to extend an existing circuit with that ID according
  303. to the specified path.
  304. If the request is successful, the server sends a reply containing a message
  305. body consisting of the Circuit ID of the (maybe newly created) circuit.
  306. The syntax is "250" SP "EXTENDED" SP CircuitID CRLF.
  307. 3.11. ATTACHSTREAM
  308. Sent from the client to the server. The syntax is:
  309. "ATTACHSTREAM" SP StreamID SP CircuitID CRLF
  310. This message informs the server that the specified stream should be
  311. associated with the specified circuit. Each stream may be associated with
  312. at most one circuit, and multiple streams may share the same circuit.
  313. Streams can only be attached to completed circuits (that is, circuits that
  314. have sent a circuit status 'BUILT' event or are listed as built in a
  315. GETINFO circuit-status request).
  316. If the circuit ID is 0, responsibility for attaching the given stream is
  317. returned to Tor.
  318. Tor responds with "250 OK" if it can attach the stream, 552 if the circuit
  319. or stream didn't exist, or 551 if the stream couldn't be attached for
  320. another reason.
  321. {Implementation note: By default, Tor automatically attaches streams to
  322. circuits itself, unless the configuration variable
  323. "__LeaveStreamsUnattached" is set to "1". Attempting to attach streams
  324. via TC when "__LeaveStreamsUnattached" is false may cause a race between
  325. Tor and the controller, as both attempt to attach streams to circuits.}
  326. 3.12. POSTDESCRIPTOR
  327. Sent from the client to the server. The syntax is:
  328. "+POSTDESCRIPTOR" CRLF Descriptor CRLF "." CRLF
  329. This message informs the server about a new descriptor.
  330. The descriptor, when parsed, must contain a number of well-specified
  331. fields, including fields for its nickname and identity.
  332. If there is an error in parsing the descriptor, the server must send a "554
  333. Invalid descriptor" reply. If the descriptor is well-formed but the server
  334. chooses not to add it, it must reply with a 251 message whose body explains
  335. why the server was not added. If the descriptor is added, Tor replies with
  336. "250 OK".
  337. 3.13. REDIRECTSTREAM
  338. Sent from the client to the server. The syntax is:
  339. "REDIRECTSTREAM" SP StreamID SP Address (Port) CRLF
  340. Tells the server to change the exit address on the specified stream. If
  341. Port is specified, changes the destination port as well. No remapping
  342. is performed on the new provided address.
  343. To be sure that the modified address will be used, this event must be sent
  344. after a new stream event is received, and before attaching this stream to
  345. a circuit.
  346. Tor replies with "250 OK" on success.
  347. 3.14. CLOSESTREAM
  348. Sent from the client to the server. The syntax is:
  349. "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
  350. Tells the server to close the specified stream. The reason should be one
  351. of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal. Flags is
  352. not used currently; Tor servers SHOULD ignore unrecognized flags. Tor may
  353. hold the stream open for a while to flush any data that is pending.
  354. Tor replies with "250 OK" on success, or a 512 if there aren't enough
  355. arguments, or a 552 if it doesn't recognize the StreamID or reason.
  356. 3.15. CLOSECIRCUIT
  357. The syntax is:
  358. CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
  359. Flag = "IfUnused"
  360. Tells the server to close the specified circuit. If "IfUnused" is
  361. provided, do not close the circuit unless it is unused.
  362. Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  363. flags.
  364. Tor replies with "250 OK" on success, or a 512 if there aren't enough
  365. arguments, or a 552 if it doesn't recognize the CircuitID.
  366. 3.16. QUIT
  367. Tells the server to hang up on this controller connection. This command
  368. can be used before authenticating.
  369. 4. Replies
  370. Reply codes follow the same 3-character format as used by SMTP, with the
  371. first character defining a status, the second character defining a
  372. subsystem, and the third designating fine-grained information.
  373. The TC protocol currently uses the following first characters:
  374. 2yz Positive Completion Reply
  375. The command was successful; a new request can be started.
  376. 4yz Temporary Negative Completion reply
  377. The command was unsuccessful but might be reattempted later.
  378. 5yz Permanent Negative Completion Reply
  379. The command was unsuccessful; the client should not try exactly
  380. that sequence of commands again.
  381. 6yz Asynchronous Reply
  382. Sent out-of-order in response to an earlier SETEVENTS command.
  383. The following second characters are used:
  384. x0z Syntax
  385. Sent in response to ill-formed or nonsensical commands.
  386. x1z Protocol
  387. Refers to operations of the Tor Control protocol.
  388. x5z Tor
  389. Refers to actual operations of Tor system.
  390. The following codes are defined:
  391. 250 OK
  392. 251 Operation was unnecessary
  393. [Tor has declined to perform the operation, but no harm was done.]
  394. 451 Resource exhausted
  395. 500 Syntax error: protocol
  396. 510 Unrecognized command
  397. 511 Unimplemented command
  398. 512 Syntax error in command argument
  399. 513 Unrecognized command argument
  400. 514 Authentication required
  401. 515 Bad authentication
  402. 550 Unspecified Tor error
  403. 551 Internal error
  404. [Something went wrong inside Tor, so that the client's
  405. request couldn't be fulfilled.]
  406. 552 Unrecognized entity
  407. [A configuration key, a stream ID, circuit ID, event,
  408. mentioned in the command did not actually exist.]
  409. 553 Invalid configuration value
  410. [The client tried to set a configuration option to an
  411. incorrect, ill-formed, or impossible value.]
  412. 554 Invalid descriptor
  413. 555 Unmanaged entity
  414. 650 Asynchronous event notification
  415. Unless specified to have specific contents, the human-readable messages
  416. in error replies should not be relied upon to match those in this document.
  417. 4.1. Asynchronous events
  418. These replies can be sent after a corresponding SETEVENTS command has been
  419. received. They will not be interleaved with other Reply elements, but they
  420. can appear between a command and its corresponding reply. For example,
  421. this sequence is possible:
  422. C: SETEVENTS CIRC
  423. S: 250 OK
  424. C: GETCONF SOCKSPORT ORPORT
  425. S: 650 CIRC 1000 EXTENDED moria1,moria2
  426. S: 250-SOCKSPORT=9050
  427. S: 250 ORPORT=0
  428. But this sequence is disallowed:
  429. C: SETEVENTS CIRC
  430. S: 250 OK
  431. C: GETCONF SOCKSPORT ORPORT
  432. S: 250-SOCKSPORT=9050
  433. S: 650 CIRC 1000 EXTENDED moria1,moria2
  434. S: 250 ORPORT=0
  435. Clients SHOULD tolerate more arguments in an asynchonous reply than
  436. expected, and SHOULD tolerate more lines in an asynchronous reply than
  437. expected. For instance, a client that expects a CIRC message like:
  438. 650 CIRC 1000 EXTENDED moria1,moria2
  439. should tolerate:
  440. 650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
  441. 650-EXTRAMAGIC=99
  442. 650 ANONYMITY=high
  443. If clients ask for extended events, then each event line as specified below
  444. will be followed by additional extensions. Clients that do so MUST
  445. tolerate additional arguments and lines. Additional lines will be of the
  446. form
  447. "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  448. Additional arguments will be of the form
  449. SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
  450. Such clients MUST tolerate lines with keywords they do not recognize.
  451. 4.1.1. Circuit status changed
  452. The syntax is:
  453. "650" SP "CIRC" SP CircuitID SP CircStatus SP Path
  454. CircStatus =
  455. "LAUNCHED" / ; circuit ID assigned to new circuit
  456. "BUILT" / ; all hops finished, can now accept streams
  457. "EXTENDED" / ; one more hop has been completed
  458. "FAILED" / ; circuit closed (was not built)
  459. "CLOSED" ; circuit closed (was built)
  460. Path = ServerID *("," ServerID)
  461. 4.1.2. Stream status changed
  462. The syntax is:
  463. "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target SP
  464. StreamStatus =
  465. "NEW" / ; New request to connect
  466. "NEWRESOLVE" / ; New request to resolve an address
  467. "SENTCONNECT" / ; Sent a connect cell along a circuit
  468. "SENTRESOLVE" / ; Sent a resolve cell along a circuit
  469. "SUCCEEDED" / ; Received a reply; stream established
  470. "FAILED" / ; Stream failed and not retriable.
  471. "CLOSED" / ; Stream closed
  472. "DETACHED" ; Detached from circuit; still retriable.
  473. Target = Address ":" Port
  474. The circuit ID designates which circuit this stream is attached to. If
  475. the stream is unattached, the circuit ID "0" is given.
  476. 4.1.3. OR Connection status changed
  477. The syntax is:
  478. "650" SP "ORCONN" SP ServerID SP ORStatus
  479. ORStatus = "LAUNCHED" / "CONNECTED" / "FAILED" / "CLOSED"
  480. 4.1.4. Bandwidth used in the last second
  481. The syntax is:
  482. "650" SP "BW" SP BytesRead SP BytesWritten
  483. BytesRead = 1*DIGIT
  484. BytesWritten = 1*DIGIT
  485. 4.1.5. Log message
  486. The syntax is:
  487. "650" SP Severity SP ReplyText
  488. or
  489. "650+" Severity CRLF Data
  490. Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"
  491. 4.1.6. New descriptors available
  492. Syntax:
  493. "650" SP "NEWDESC" 1*(SP ServerID)
  494. 4.1.7. New Address mapping
  495. Syntax:
  496. "650" SP "ADDRMAP" SP Address SP Address SP Expiry
  497. Expiry = DQOUTE ISOTime DQUOTE / "NEVER"
  498. 4.1.8. Descriptors uploaded to us in our role as authoritative dirserver
  499. Syntax:
  500. "650" "+" "AUTHDIR_NEWDESCS" CRLF Action CRLF Message CRLF Descriptor CRLF "." CRLF
  501. Action = "ACCEPTED" / "DROPPED" / "REJECTED"
  502. Message = Text
  503. 5. Implementation notes
  504. 5.1. Authentication
  505. By default, the current Tor implementation trusts all local users.
  506. If the 'CookieAuthentication' option is true, Tor writes a "magic cookie"
  507. file named "control_auth_cookie" into its data directory. To authenticate,
  508. the controller must send the contents of this file.
  509. If the 'HashedControlPassword' option is set, it must contain the salted
  510. hash of a secret password. The salted hash is computed according to the
  511. S2K algorithm in RFC 2440 (OpenPGP), and prefixed with the s2k specifier.
  512. This is then encoded in hexadecimal, prefixed by the indicator sequence
  513. "16:". Thus, for example, the password 'foo' could encode to:
  514. 16:660537E3E1CD49996044A3BF558097A981F539FEA2F9DA662B4626C1C2
  515. ++++++++++++++++**^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  516. salt hashed value
  517. indicator
  518. You can generate the salt of a password by calling
  519. 'tor --hash-password <password>'
  520. or by using the example code in the Python and Java controller libraries.
  521. To authenticate under this scheme, the controller sends Tor the original
  522. secret that was used to generate the password.
  523. 5.2. Don't let the buffer get too big.
  524. If you ask for lots of events, and 16MB of them queue up on the buffer,
  525. the Tor process will close the socket.
  526. 5.3. Backward compatibility
  527. For backward compatibility with the "version 0" control protocol, Tor checks
  528. whether the third octet the first command is zero. If it is, Tor
  529. assumes that version 0 is in use. This feature is deprecated, and will be
  530. removed in the 0.1.2.x Tor development series.
  531. In order to detect which version of the protocol is supported controllers
  532. should send the sequence [00 00 0D 0A]. This is a valid and unrecognized
  533. command in both protocol versions, and implementations can detect which
  534. error they have received.