control-spec-v0.txt 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498
  1. $Id$
  2. TC: A Tor control protocol (Version 0)
  3. -1. Deprecation
  4. THIS PROTOCOL IS DEPRECATED. It is still documented here because it is the
  5. only Tor control protocol supported in the Tor implementation right now.
  6. 0. Scope
  7. This document describes an implementation-specific protocol that is used
  8. for other programs (such as frontend user-interfaces) to communicate
  9. with a locally running Tor process. It is not part of the Tor onion
  10. routing protocol.
  11. We're trying to be pretty extensible here, but not infinitely
  12. forward-compatible.
  13. 1. Protocol outline
  14. TC is a bidirectional message-based protocol. It assumes an underlying
  15. stream for communication between a controlling process (the "client") and
  16. a Tor process (the "server"). The stream may be implemented via TCP,
  17. TLS-over-TCP, a Unix-domain socket, or so on, but it must provide
  18. reliable in-order delivery. For security, the stream should not be
  19. accessible by untrusted parties.
  20. In TC, the client and server send typed variable-length messages to each
  21. other over the underlying stream. By default, all messages from the server
  22. are in response to messages from the client. Some client requests, however,
  23. will cause the server to send messages to the client indefinitely far into
  24. the future.
  25. Servers respond to messages in the order they're received.
  26. 2. Message format
  27. The messages take the following format:
  28. Length [2 octets; big-endian]
  29. Type [2 octets; big-endian]
  30. Body [Length octets]
  31. Upon encountering a recognized Type, implementations behave as described in
  32. section 3 below. If the type is not recognized, servers respond with an
  33. "ERROR" message (code UNRECOGNIZED; see 3.1 below), and clients simply ignore
  34. the message.
  35. 2.1. Types and encodings
  36. All numbers are given in big-endian (network) order.
  37. OR identities are given in hexadecimal, in the same format as identity key
  38. fingerprints, but without spaces; see tor-spec.txt for more information.
  39. 3. Message types
  40. Message types are drawn from the following ranges:
  41. 0x0000-0xEFFF : Reserved for use by official versions of this spec.
  42. 0xF000-0xFFFF : Unallocated; usable by unofficial extensions.
  43. 3.1. ERROR (Type 0x0000)
  44. Sent in response to a message that could not be processed as requested.
  45. The body of the message begins with a 2-byte error code. The following
  46. values are defined:
  47. 0x0000 Unspecified error
  48. []
  49. 0x0001 Internal error
  50. [Something went wrong inside Tor, so that the client's
  51. request couldn't be fulfilled.]
  52. 0x0002 Unrecognized message type
  53. [The client sent a message type we don't understand.]
  54. 0x0003 Syntax error
  55. [The client sent a message body in a format we can't parse.]
  56. 0x0004 Unrecognized configuration key
  57. [The client tried to get or set a configuration option we don't
  58. recognize.]
  59. 0x0005 Invalid configuration value
  60. [The client tried to set a configuration option to an
  61. incorrect, ill-formed, or impossible value.]
  62. 0x0006 Unrecognized byte code
  63. [The client tried to set a byte code (in the body) that
  64. we don't recognize.]
  65. 0x0007 Unauthorized.
  66. [The client tried to send a command that requires
  67. authorization, but it hasn't sent a valid AUTHENTICATE
  68. message.]
  69. 0x0008 Failed authentication attempt
  70. [The client sent a well-formed authorization message.]
  71. 0x0009 Resource exhausted
  72. [The server didn't have enough of a given resource to
  73. fulfill a given request.]
  74. 0x000A No such stream
  75. 0x000B No such circuit
  76. 0x000C No such OR
  77. The rest of the body should be a human-readable description of the error.
  78. In general, new error codes should only be added when they don't fall under
  79. one of the existing error codes.
  80. 3.2. DONE (Type 0x0001)
  81. Sent from server to client in response to a request that was successfully
  82. completed, with no more information needed. The body is usually empty but
  83. may contain a message.
  84. 3.3. SETCONF (Type 0x0002)
  85. Change the value of a configuration variable. The body contains a list of
  86. newline-terminated key-value configuration lines. An individual key-value
  87. configuration line consists of the key, followed by a space, followed by
  88. the value. The server behaves as though it had just read the key-value pair
  89. in its configuration file.
  90. The server responds with a DONE message on success, or an ERROR message on
  91. failure.
  92. When a configuration options takes multiple values, or when multiple
  93. configuration keys form a context-sensitive group (see below), then
  94. setting _any_ of the options in a SETCONF command is taken to reset all of
  95. the others. For example, if two ORBindAddress values are configured,
  96. and a SETCONF command arrives containing a single ORBindAddress value, the
  97. new command's value replaces the two old values.
  98. To _remove_ all settings for a given option entirely (and go back to its
  99. default value), send a single line containing the key and no value.
  100. 3.4. GETCONF (Type 0x0003)
  101. Request the value of a configuration variable. The body contains one or
  102. more NL-terminated strings for configuration keys. The server replies
  103. with a CONFVALUE message.
  104. If an option appears multiple times in the configuration, all of its
  105. key-value pairs are returned in order.
  106. Some options are context-sensitive, and depend on other options with
  107. different keywords. These cannot be fetched directly. Currently there
  108. is only one such option: clients should use the "HiddenServiceOptions"
  109. virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  110. HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
  111. 3.5. CONFVALUE (Type 0x0004)
  112. Sent in response to a GETCONF message; contains a list of "Key Value\n"
  113. (A non-whitespace keyword, a single space, a non-NL value, a NL)
  114. strings.
  115. 3.6. SETEVENTS (Type 0x0005)
  116. Request the server to inform the client about interesting events.
  117. The body contains a list of 2-byte event codes (see "event" below).
  118. Any events *not* listed in the SETEVENTS body are turned off; thus, sending
  119. SETEVENTS with an empty body turns off all event reporting.
  120. The server responds with a DONE message on success, and an ERROR message
  121. if one of the event codes isn't recognized. (On error, the list of active
  122. event codes isn't changed.)
  123. 3.7. EVENT (Type 0x0006)
  124. Sent from the server to the client when an event has occurred and the
  125. client has requested that kind of event. The body contains a 2-byte
  126. event code followed by additional event-dependent information. Event
  127. codes are:
  128. 0x0001 -- Circuit status changed
  129. Status [1 octet]
  130. 0x00 Launched - circuit ID assigned to new circuit
  131. 0x01 Built - all hops finished, can now accept streams
  132. 0x02 Extended - one more hop has been completed
  133. 0x03 Failed - circuit closed (was not built)
  134. 0x04 Closed - circuit closed (was built)
  135. Circuit ID [4 octets]
  136. (Must be unique to Tor process/time)
  137. Path [NUL-terminated comma-separated string]
  138. (For extended/failed, is the portion of the path that is
  139. built)
  140. 0x0002 -- Stream status changed
  141. Status [1 octet]
  142. (Sent connect=0,sent resolve=1,succeeded=2,failed=3,
  143. closed=4, new connection=5, new resolve request=6,
  144. stream detached from circuit and still retriable=7)
  145. Stream ID [4 octets]
  146. (Must be unique to Tor process/time)
  147. Target (NUL-terminated address-port string]
  148. 0x0003 -- OR Connection status changed
  149. Status [1 octet]
  150. (Launched=0,connected=1,failed=2,closed=3)
  151. OR nickname/identity [NUL-terminated]
  152. 0x0004 -- Bandwidth used in the last second
  153. Bytes read [4 octets]
  154. Bytes written [4 octets]
  155. 0x0005 -- Notice/warning/error occurred
  156. Message [NUL-terminated]
  157. <obsolete: use 0x0007-0x000B instead.>
  158. 0x0006 -- New descriptors available
  159. OR List [NUL-terminated, comma-delimited list of
  160. OR identity]
  161. 0x0007 -- Debug message occurred
  162. 0x0008 -- Info message occurred
  163. 0x0009 -- Notice message occurred
  164. 0x000A -- Warning message occurred
  165. 0x000B -- Error message occurred
  166. Message [NUL-terminated]
  167. 3.8. AUTHENTICATE (Type 0x0007)
  168. Sent from the client to the server. Contains a 'magic cookie' to prove
  169. that client is really allowed to control this Tor process. The server
  170. responds with DONE or ERROR.
  171. The format of the 'cookie' is implementation-dependent; see 4.1 below for
  172. information on how the standard Tor implementation handles it.
  173. 3.9. SAVECONF (Type 0x0008)
  174. Sent from the client to the server. Instructs the server to write out
  175. its config options into its torrc. Server returns DONE if successful, or
  176. ERROR if it can't write the file or some other error occurs.
  177. 3.10. SIGNAL (Type 0x0009)
  178. Sent from the client to the server. The body contains one byte that
  179. indicates the action the client wishes the server to take.
  180. 1 (0x01) -- Reload: reload config items, refetch directory.
  181. 2 (0x02) -- Controlled shutdown: if server is an OP, exit immediately.
  182. If it's an OR, close listeners and exit after 30 seconds.
  183. 10 (0x0A) -- Dump stats: log information about open connections and
  184. circuits.
  185. 12 (0x0C) -- Debug: switch all open logs to loglevel debug.
  186. 15 (0x0F) -- Immediate shutdown: clean up and exit now.
  187. The server responds with DONE if the signal is recognized (or simply
  188. closes the socket if it was asked to close immediately), else ERROR.
  189. 3.11. MAPADDRESS (Type 0x000A)
  190. Sent from the client to the server. The body contains a sequence of
  191. address mappings, each consisting of the address to be mapped, a single
  192. space, the replacement address, and a NL character.
  193. Addresses may be IPv4 addresses, IPv6 addresses, or hostnames.
  194. The client sends this message to the server in order to tell it that future
  195. SOCKS requests for connections to the original address should be replaced
  196. with connections to the specified replacement address. If the addresses
  197. are well-formed, and the server is able to fulfill the request, the server
  198. replies with a single DONE message containing the source and destination
  199. addresses. If request is malformed, the server replies with a syntax error
  200. message. The server can't fulfill the request, it replies with an internal
  201. ERROR message.
  202. The client may decline to provide a body for the original address, and
  203. instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  204. "." for hostname), signifying that the server should choose the original
  205. address itself, and return that address in the DONE message. The server
  206. should ensure that it returns an element of address space that is unlikely
  207. to be in actual use. If there is already an address mapped to the
  208. destination address, the server may reuse that mapping.
  209. If the original address is already mapped to a different address, the old
  210. mapping is removed. If the original address and the destination address
  211. are the same, the server removes any mapping in place for the original
  212. address.
  213. {Note: This feature is designed to be used to help Tor-ify applications
  214. that need to use SOCKS4 or hostname-less SOCKS5. There are three
  215. approaches to doing this:
  216. 1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
  217. 2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
  218. feature) to resolve the hostname remotely. This doesn't work
  219. with special addresses like x.onion or x.y.exit.
  220. 3. Use MAPADDRESS to map an IP address to the desired hostname, and then
  221. arrange to fool the application into thinking that the hostname
  222. has resolved to that IP.
  223. This functionality is designed to help implement the 3rd approach.}
  224. [XXXX When, if ever, can mappings expire? Should they expire?]
  225. [XXXX What addresses, if any, are safe to use?]
  226. 3.12 GETINFO (Type 0x000B)
  227. Sent from the client to the server. The message body is as for GETCONF:
  228. one or more NL-terminated strings. The server replies with an INFOVALUE
  229. message.
  230. Unlike GETCONF, this message is used for data that are not stored in the
  231. Tor configuration file, but instead.
  232. Recognized key and their values include:
  233. "version" -- The version of the server's software, including the name
  234. of the software. (example: "Tor 0.0.9.4")
  235. "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest server
  236. descriptor for a given OR, NUL-terminated. If no such OR is known, the
  237. corresponding value is an empty string.
  238. "network-status" -- a space-separated list of all known OR identities.
  239. This is in the same format as the router-status line in directories;
  240. see tor-spec.txt for details.
  241. "addr-mappings/all"
  242. "addr-mappings/config"
  243. "addr-mappings/cache"
  244. "addr-mappings/control" -- a NL-terminated list of address mappings, each
  245. in the form of "from-address" SP "to-address". The 'config' key
  246. returns those address mappings set in the configuration; the 'cache'
  247. key returns the mappings in the client-side DNS cache; the 'control'
  248. key returns the mappings set via the control interface; the 'all'
  249. target returns the mappings set through any mechanism.
  250. 3.13 INFOVALUE (Type 0x000C)
  251. Sent from the server to the client in response to a GETINFO message.
  252. Contains one or more items of the format:
  253. Key [(NUL-terminated string)]
  254. Value [(NUL-terminated string)]
  255. The keys match those given in the GETINFO message.
  256. 3.14 EXTENDCIRCUIT (Type 0x000D)
  257. Sent from the client to the server. The message body contains two fields:
  258. Circuit ID [4 octets]
  259. Path [NUL-terminated, comma-delimited string of OR nickname/identity]
  260. This request takes one of two forms: either the Circuit ID is zero, in
  261. which case it is a request for the server to build a new circuit according
  262. to the specified path, or the Circuit ID is nonzero, in which case it is a
  263. request for the server to extend an existing circuit with that ID according
  264. to the specified path.
  265. If the request is successful, the server sends a DONE message containing
  266. a message body consisting of the four-octet Circuit ID of the newly created
  267. circuit.
  268. 3.15 ATTACHSTREAM (Type 0x000E)
  269. Sent from the client to the server. The message body contains two fields:
  270. Stream ID [4 octets]
  271. Circuit ID [4 octets]
  272. This message informs the server that the specified stream should be
  273. associated with the specified circuit. Each stream may be associated with
  274. at most one circuit, and multiple streams may share the same circuit.
  275. Streams can only be attached to completed circuits (that is, circuits that
  276. have sent a circuit status 'built' event).
  277. If the circuit ID is 0, responsibility for attaching the given stream is
  278. returned to Tor.
  279. {Implementation note: By default, Tor automatically attaches streams to
  280. circuits itself, unless the configuration variable
  281. "__LeaveStreamsUnattached" is set to "1". Attempting to attach streams
  282. via TC when "__LeaveStreamsUnattached" is false may cause a race between
  283. Tor and the controller, as both attempt to attach streams to circuits.}
  284. 3.16 POSTDESCRIPTOR (Type 0x000F)
  285. Sent from the client to the server. The message body contains one field:
  286. Descriptor [NUL-terminated string]
  287. This message informs the server about a new descriptor.
  288. The descriptor, when parsed, must contain a number of well-specified
  289. fields, including fields for its nickname and identity.
  290. If there is an error in parsing the descriptor, the server must send an
  291. appropriate error message. If the descriptor is well-formed but the server
  292. chooses not to add it, it must reply with a DONE message whose body
  293. explains why the server was not added.
  294. 3.17 FRAGMENTHEADER (Type 0x0010)
  295. Sent in either direction. Used to encapsulate messages longer than 65535
  296. bytes in length.
  297. Underlying type [2 bytes]
  298. Total Length [4 bytes]
  299. Data [Rest of message]
  300. A FRAGMENTHEADER message MUST be followed immediately by a number of
  301. FRAGMENT messages, such that lengths of the "Data" fields of the
  302. FRAGMENTHEADER and FRAGMENT messages add to the "Total Length" field of the
  303. FRAGMENTHEADER message.
  304. Implementations MUST NOT fragment messages of length less than 65536 bytes.
  305. Implementations MUST be able to process fragmented messages that not
  306. optimally packed.
  307. 3.18 FRAGMENT (Type 0x0011)
  308. Data [Entire message]
  309. See FRAGMENTHEADER for more information
  310. 3.19 REDIRECTSTREAM (Type 0x0012)
  311. Sent from the client to the server. The message body contains two fields:
  312. Stream ID [4 octets]
  313. Address [variable-length, NUL-terminated.]
  314. Tells the server to change the exit address on the specified stream. No
  315. remapping is performed on the new provided address.
  316. To be sure that the modified address will be used, this event must be sent
  317. after a new stream event is received, and before attaching this stream to
  318. a circuit.
  319. 3.20 CLOSESTREAM (Type 0x0013)
  320. Sent from the client to the server. The message body contains three
  321. fields:
  322. Stream ID [4 octets]
  323. Reason [1 octet]
  324. Flags [1 octet]
  325. Tells the server to close the specified stream. The reason should be
  326. one of the Tor RELAY_END reasons given in tor-spec.txt. Flags is not
  327. used currently. Tor may hold the stream open for a while to flush
  328. any data that is pending.
  329. 3.21 CLOSECIRCUIT (Type 0x0014)
  330. Sent from the client to the server. The message body contains two
  331. fields:
  332. Circuit ID [4 octets]
  333. Flags [1 octet]
  334. Tells the server to close the specified circuit. If the LSB of the flags
  335. field is nonzero, do not close the circuit unless it is unused.
  336. 4. Implementation notes
  337. 4.1. Authentication
  338. By default, the current Tor implementation trusts all local users.
  339. If the 'CookieAuthentication' option is true, Tor writes a "magic cookie"
  340. file named "control_auth_cookie" into its data directory. To authenticate,
  341. the controller must send the contents of this file.
  342. If the 'HashedControlPassword' option is set, it must contain the salted
  343. hash of a secret password. The salted hash is computed according to the
  344. S2K algorithm in RFC 2440 (OpenPGP), and prefixed with the s2k specifier.
  345. This is then encoded in hexadecimal, prefixed by the indicator sequence
  346. "16:". Thus, for example, the password 'foo' could encode to:
  347. 16:660537E3E1CD49996044A3BF558097A981F539FEA2F9DA662B4626C1C2
  348. ++++++++++++++++**^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  349. salt hashed value
  350. indicator
  351. You can generate the salt of a password by calling
  352. 'tor --hash-password <password>'
  353. or by using the example code in the Python and Java controller libraries.
  354. To authenticate under this scheme, the controller sends Tor the original
  355. secret that was used to generate the password.
  356. 4.2. Don't let the buffer get too big.
  357. If you ask for lots of events, and 16MB of them queue up on the buffer,
  358. the Tor process will close the socket.