control-spec.txt 59 KB
Newer Older
1
2
$Id$

3
                   TC: A Tor control protocol (Version 1)
4

5
0. Scope
6

7
8
9
10
  This document describes an implementation-specific protocol that is used
  for other programs (such as frontend user-interfaces) to communicate with a
  locally running Tor process.  It is not part of the Tor onion routing
  protocol.
11

12
13
14
  This protocol replaces version 0 of TC, which is now deprecated.  For
  reference, TC is described in "control-spec-v0.txt".  Implementors are
  recommended to avoid using TC directly, but instead to use a library that
15
16
17
  can easily be updated to use the newer protocol.  (Version 0 is used by Tor
  versions 0.1.0.x; the protocol in this document only works with Tor
  versions in the 0.1.1.x series and later.)
18

19
1. Protocol outline
20

21
  TC is a bidirectional message-based protocol.  It assumes an underlying
22
23
24
25
  stream for communication between a controlling process (the "client"
  or "controller") and a Tor process (or "server").  The stream may be
  implemented via TCP, TLS-over-TCP, a Unix-domain socket, or so on,
  but it must provide reliable in-order delivery.  For security, the
26
  stream should not be accessible by untrusted parties.
27

28
29
30
  In TC, the client and server send typed messages to each other over the
  underlying stream.  The client sends "commands" and the server sends
  "replies".
31

32
33
34
  By default, all messages from the server are in response to messages from
  the client.  Some client requests, however, will cause the server to send
  messages to the client indefinitely far into the future.  Such
35
  "asynchronous" replies are marked as such.
36

37
  Servers respond to messages in the order messages are received.
38

39
2. Message format
40

41
2.1. Description format
42

43
  The message formats listed below use ABNF as described in RFC 2234.
44
  The protocol itself is loosely based on SMTP (see RFC 2821).
45

46
  We use the following nonterminals from RFC 2822: atom, qcontent
47

48
  We define the following general-use nonterminals:
49

50
     String = DQUOTE *qcontent DQUOTE
51

52
53
  There are explicitly no limits on line length.  All 8-bit characters are
  permitted unless explicitly disallowed.
54

55
2.2. Commands from controller to Tor
56

57
58
59
    Command = Keyword Arguments CRLF / "+" Keyword Arguments CRLF Data
    Keyword = 1*ALPHA
    Arguments = *(SP / VCHAR)
60

61
  Specific commands and their arguments are described below in section 3.
62

63
2.3. Replies from Tor to the controller
64

65
66
    Reply = SyncReply / AsyncReply
    SyncReply = *(MidReplyLine / DataReplyLine) EndReplyLine
67
    AsyncReply = *(MidReplyLine / DataReplyLine) EndReplyLine
68
69
70
71
72

    MidReplyLine = StatusCode "-" ReplyLine
    DataReplyLine = StatusCode "+" ReplyLine Data
    EndReplyLine = StatusCode SP ReplyLine
    ReplyLine = [ReplyText] CRLF
73
    ReplyText = XXXX
74
    StatusCode = 3DIGIT
Nick Mathewson's avatar
Nick Mathewson committed
75

76
77
  Specific replies are mentioned below in section 3, and described more fully
  in section 4.
Nick Mathewson's avatar
Nick Mathewson committed
78

79
80
81
82
83
84
  [Compatibility note:  versions of Tor before 0.2.0.3-alpha sometimes
  generate AsyncReplies of the form "*(MidReplyLine / DataReplyLine)".
  This is incorrect, but controllers that need to work with these
  versions of Tor should be prepared to get multi-line AsyncReplies with
  the final line (usually "650 OK") omitted.]

85
2.4. General-use tokens
Nick Mathewson's avatar
Nick Mathewson committed
86

87
88
  ; Identifiers for servers.
  ServerID = Nickname / Fingerprint
89

90
  Nickname = 1*19 NicknameChar
91
92
  NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
  Fingerprint = "$" 40*HEXDIG
Nick Mathewson's avatar
Nick Mathewson committed
93

94
95
96
97
98
99
100
101
102
  ; A "=" indicates that the given nickname is canonical; a "~" indicates
  ; that the given nickname is not canonical.
  LongName = Fingerprint [ ( "=" / "~" ) Nickname ]

  ; How a controller tells Tor about a particular OR.  There are four
  ; possible formats:
  ;    $Digest -- The router whose identity key hashes to the given digest.
  ;        This is the preferred way to refer to an OR.
  ;    $Digest~Name -- The router whose identity key hashes to the given
103
  ;        digest, but only if the router has the given nickname.
104
105
106
107
108
109
110
111
112
  ;    $Digest=Name -- The router whose identity key hashes to the given
  ;        digest, but only if the router is Named and has the given
  ;        nickname.
  ;    Name -- The Named router with the given nickname, or, if no such
  ;        router exists, any router whose nickname matches the one given.
  ;        This is not a safe way to refer to routers, since Named status
  ;        could under some circumstances change over time.
  ServerSpec = LongName / Nickname

113
114
115
116
117
  ; Unique identifiers for streams or circuits.  Currently, Tor only
  ; uses digits, but this may change
  StreamID = 1*16 IDChar
  CircuitID = 1*16 IDChar
  IDChar = ALPHA / DIGIT
118

119
  Address = ip4-address / ip6-address / hostname   (XXXX Define these)
120

121
122
123
  ; A "Data" section is a sequence of octets concluded by the terminating
  ; sequence CRLF "." CRLF.  The terminating sequence may not appear in the
  ; body of the data.  Leading periods on lines in the data are escaped with
124
  ; an additional leading period as in RFC 2821 section 4.5.2.
125
  Data = *DataLine "." CRLF
126
  DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
127
128
  LineItem = NonCR / 1*CR NonCRLF
  NonDotItem = NonDotCR / 1*CR NonCRLF
129

130
3. Commands
131

132
  All commands and other keywords are case-insensitive.
133

134
3.1. SETCONF
Nick Mathewson's avatar
Nick Mathewson committed
135

136
  Change the value of one or more configuration variables.  The syntax is:
137

138
    "SETCONF" 1*(SP keyword ["=" String]) CRLF
139

140
141
  Tor behaves as though it had just read each of the key-value pairs
  from its configuration file.  Keywords with no corresponding values have
142
  their configuration values reset to 0 or NULL (use RESETCONF if you want
143
144
  to set it back to its default).  SETCONF is all-or-nothing: if there
  is an error in any of the configuration settings, Tor sets none of them.
145

146
  Tor responds with a "250 configuration values set" reply on success.
147
148
149
150
  If some of the listed keywords can't be found, Tor replies with a
  "552 Unrecognized option" message. Otherwise, Tor responds with a
  "513 syntax error in configuration values" reply on syntax error, or a
  "553 impossible configuration setting" reply on a semantic error.
151

152
  When a configuration option takes multiple values, or when multiple
153
  configuration keys form a context-sensitive group (see GETCONF below), then
154
  setting _any_ of the options in a SETCONF command is taken to reset all of
155
156
157
  the others.  For example, if two ORBindAddress values are configured, and a
  SETCONF command arrives containing a single ORBindAddress value, the new
  command's value replaces the two old values.
158

159
3.2. RESETCONF
160

161
162
163
164
  Remove all settings for a given configuration option entirely, assign
  its default value (if any), and then assign the String provided.
  Typically the String is left empty, to simply set an option back to
  its default. The syntax is:
165

166
    "RESETCONF" 1*(SP keyword ["=" String]) CRLF
167
168
169
170

  Otherwise it behaves like SETCONF above.

3.3. GETCONF
171
172
173
174

  Request the value of a configuration variable.  The syntax is:

    "GETCONF" 1*(SP keyword) CRLF
175

176
177
178
  If all of the listed keywords exist in the Tor configuration, Tor replies
  with a series of reply lines of the form:
      250 keyword=value
179
180
181
  If any option is set to a 'default' value semantically different from an
  empty string, Tor may reply with a reply line of the form:
      250 keyword
182
183

  If some of the listed keywords can't be found, Tor replies with a
184
  "552 unknown configuration keyword" message.
185

186
187
188
189
  If an option appears multiple times in the configuration, all of its
  key-value pairs are returned in order.

  Some options are context-sensitive, and depend on other options with
190
191
192
193
  different keywords.  These cannot be fetched directly.  Currently there
  is only one such option: clients should use the "HiddenServiceOptions"
  virtual keyword to get all HiddenServiceDir, HiddenServicePort,
  HiddenServiceNodes, and HiddenServiceExcludeNodes option settings.
194

195
3.4. SETEVENTS
196

197
198
  Request the server to inform the client about interesting events.  The
  syntax is:
199

200
     "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
201

202
     EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
203
         "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
204
         "AUTHDIR_NEWDESCS" / "DESCCHANGED" / "STATUS_GENERAL" /
205
         "STATUS_CLIENT" / "STATUS_SERVER" / "GUARD" / "NS" / "STREAM_BW"
206

207
208
  Any events *not* listed in the SETEVENTS line are turned off; thus, sending
  SETEVENTS with an empty body turns off all event reporting.
209

210
211
212
  The server responds with a "250 OK" reply on success, and a "552
  Unrecognized event" reply if one of the event codes isn't recognized.  (On
  error, the list of active event codes isn't changed.)
213

214
215
216
217
218
219
  If the flag string "EXTENDED" is provided, Tor may provide extra
  information with events for this connection; see 4.1 for more information.
  NOTE: All events on a given connection will be provided in extended format,
  or none.
  NOTE: "EXTENDED" is only supported in Tor 0.1.1.9-alpha or later.

220
  Each event is described in more detail in Section 4.1.
Roger Dingledine's avatar
Roger Dingledine committed
221

222
3.5. AUTHENTICATE
223

224
  Sent from the client to the server.  The syntax is:
225
     "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
226

227
  The server responds with "250 OK" on success or "515 Bad authentication" if
228
229
  the authentication cookie is incorrect.  Tor closes the connection on an
  authentication failure.
230

231
232
  The format of the 'cookie' is implementation-dependent; see 5.1 below for
  information on how the standard Tor implementation handles it.
233

234
235
236
237
238
  Before the client has authenticated, no command other than PROTOCOLINFO,
  AUTHENTICATE, or QUIT is valid.  If the controller sends any other command,
  or sends a malformed command, or sends an unsuccessful AUTHENTICATE
  command, or sends PROTOCOLINFO more than once, Tor sends an error reply and
  closes the connection.
239
240
241

  (Versions of Tor before 0.1.2.16 and 0.2.0.4-alpha did not close the
  connection after an authentication failure.)
242

243
3.6. SAVECONF
244

245
246
  Sent from the client to the server.  The syntax is:
     "SAVECONF" CRLF
247

248
  Instructs the server to write out its config options into its torrc. Server
249
250
  returns "250 OK" if successful, or "551 Unable to write configuration
  to disk" if it can't write the file or some other error occurs.
251

252
3.7. SIGNAL
253

254
  Sent from the client to the server. The syntax is:
255

256
     "SIGNAL" SP Signal CRLF
257

258
     Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
259
260
              "HUP" / "INT" / "USR1" / "USR2" / "TERM" / "NEWNYM" /
              "CLEARDNSCACHE"
261

262
  The meaning of the signals are:
263

264
      RELOAD    -- Reload: reload config items, refetch directory. (like HUP)
265
      SHUTDOWN  -- Controlled shutdown: if server is an OP, exit immediately.
266
                   If it's an OR, close listeners and exit after 30 seconds.
267
                   (like INT)
268
      DUMP      -- Dump stats: log information about open connections and
269
270
                   circuits. (like USR1)
      DEBUG     -- Debug: switch all open logs to loglevel debug. (like USR2)
271
      HALT      -- Immediate shutdown: clean up and exit now. (like TERM)
272
      CLEARDNSCACHE -- Forget the client-side cached IPs for all hostnames.
273
      NEWNYM    -- Switch to clean circuits, so new application requests
274
                   don't share any circuits with old ones.  Also clears
275
276
                   the client-side DNS cache.  (Tor MAY rate-limit its
                   response to this signal.)
277

278
279
280
  The server responds with "250 OK" if the signal is recognized (or simply
  closes the socket if it was asked to close immediately), or "552
  Unrecognized signal" if the signal is unrecognized.
281

282
3.8. MAPADDRESS
283

284
  Sent from the client to the server.  The syntax is:
285

286
    "MAPADDRESS" 1*(Address "=" Address SP) CRLF
287

288
289
290
291
292
293
294
295
296
  The first address in each pair is an "original" address; the second is a
  "replacement" address.  The client sends this message to the server in
  order to tell it that future SOCKS requests for connections to the original
  address should be replaced with connections to the specified replacement
  address.  If the addresses are well-formed, and the server is able to
  fulfill the request, the server replies with a 250 message:
    250-OldAddress1=NewAddress1
    250 OldAddress2=NewAddress2

297
298
299
  containing the source and destination addresses.  If request is
  malformed, the server replies with "512 syntax error in command
  argument".  If the server can't fulfill the request, it replies with
Roger Dingledine's avatar
Roger Dingledine committed
300
  "451 resource exhausted".
301
302

  The client may decline to provide a body for the original address, and
303
304
  instead send a special null address ("0.0.0.0" for IPv4, "::0" for IPv6, or
  "." for hostname), signifying that the server should choose the original
305
  address itself, and return that address in the reply.  The server
306
307
308
  should ensure that it returns an element of address space that is unlikely
  to be in actual use.  If there is already an address mapped to the
  destination address, the server may reuse that mapping.
309
310
311
312
313
314

  If the original address is already mapped to a different address, the old
  mapping is removed.  If the original address and the destination address
  are the same, the server removes any mapping in place for the original
  address.

315
316
317
318
319
  Example:
    C: MAPADDRESS 0.0.0.0=tor.eff.org 1.2.3.4=tor.freehaven.net
    S: 250-127.192.10.10=tor.eff.org
    S: 250 1.2.3.4=tor.freehaven.net

320
321
322
323
324
325
326
327
328
329
330
331
  {Note: This feature is designed to be used to help Tor-ify applications
  that need to use SOCKS4 or hostname-less SOCKS5.  There are three
  approaches to doing this:
     1. Somehow make them use SOCKS4a or SOCKS5-with-hostnames instead.
     2. Use tor-resolve (or another interface to Tor's resolve-over-SOCKS
        feature) to resolve the hostname remotely.  This doesn't work
        with special addresses like x.onion or x.y.exit.
     3. Use MAPADDRESS to map an IP address to the desired hostname, and then
        arrange to fool the application into thinking that the hostname
        has resolved to that IP.
  This functionality is designed to help implement the 3rd approach.}

332
333
334
335
  Mappings set by the controller last until the Tor process exits:
  they never expire. If the controller wants the mapping to last only
  a certain time, then it must explicitly un-map the address when that
  time has elapsed.
336

337
3.9. GETINFO
338

339
340
  Sent from the client to the server.  The syntax is as for GETCONF:
    "GETINFO" 1*(SP keyword) CRLF
341
  one or more NL-terminated strings.  The server replies with an INFOVALUE
342
  message, or a 551 or 552 error.
343

344
345
346
347
348
  Unlike GETCONF, this message is used for data that are not stored in the Tor
  configuration file, and that may be longer than a single line.  On success,
  one ReplyLine is sent for each requested value, followed by a final 250 OK
  ReplyLine.  If a value fits on a single line, the format is:
      250-keyword=value
349
  If a value must be split over multiple lines, the format is:
350
351
352
      250+keyword=
      value
      .
353
  Recognized keys and their values include:
354

355
356
357
    "version" -- The version of the server's software, including the name
      of the software. (example: "Tor 0.0.9.4")

358
359
    "config-file" -- The location of Tor's configuration file ("torrc").

360
361
362
363
364
365
366
    ["exit-policy/prepend" -- The default exit policy lines that Tor will
      *prepend* to the ExitPolicy config option.
     -- Never implemented. Useful?]

    "exit-policy/default" -- The default exit policy lines that Tor will
      *append* to the ExitPolicy config option.

Roger Dingledine's avatar
Roger Dingledine committed
367
368
    "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest
      server descriptor for a given OR, NUL-terminated.
369

370
    "ns/id/<OR identity>" or "ns/name/<OR nickname>" -- the latest network
371
372
      status info for a given OR.  Network status info is as given in
      dir-spec.txt, and reflects the current beliefs of this Tor about the
373
374
375
376
377
      router in question. Like directory clients, controllers MUST
      tolerate unrecognized flags and lines.  The published date and
      descriptor digest are those believed to be best by this Tor,
      not necessarily those for a descriptor that Tor currently has.
      [First implemented in 0.1.2.3-alpha.]
378

Roger Dingledine's avatar
Roger Dingledine committed
379
380
381
    "ns/all" -- Network status info (v2 directory style) for all ORs we
      have an opinion about, joined by newlines. [First implemented
      in 0.1.2.3-alpha.]
382

383
384
385
    "desc/all-recent" -- the latest server descriptor for every router that
      Tor knows about.

Roger Dingledine's avatar
Roger Dingledine committed
386
387
388
389
390
391
392
    "network-status" -- a space-separated list (v1 directory style)
      of all known OR identities. This is in the same format as the
      router-status line in v1 directories; see dir-spec-v1.txt section
      3 for details.  (If VERBOSE_NAMES is enabled, the output will
      not conform to dir-spec-v1.txt; instead, the result will be a
      space-separated list of LongName, each preceded by a "!" if it is
      believed to be not running.)
393

394
395
396
397
398
    "address-mappings/all"
    "address-mappings/config"
    "address-mappings/cache"
    "address-mappings/control" -- a \r\n-separated list of address
      mappings, each in the form of "from-address to-address expiry".
399
400
401
402
403
      The 'config' key returns those address mappings set in the
      configuration; the 'cache' key returns the mappings in the
      client-side DNS cache; the 'control' key returns the mappings set
      via the control interface; the 'all' target returns the mappings
      set through any mechanism.
404
405
      Expiry is formatted as with ADDRMAP events, except that "expiry" is
      always a time in GMT or the string "NEVER"; see section 4.1.7.
406
407
408
409
410
      First introduced in 0.2.0.3-alpha.

    "addr-mappings/*" -- as for address-mappings/*, but without the
      expiry portion of the value.  Use of this value is deprecated
      since 0.2.0.3-alpha; use address-mappings instead.
411

412
    "address" -- the best guess at our external IP address. If we
413
      have no guess, return a 551 error. (Added in 0.1.2.2-alpha)
414

415
    "fingerprint" -- the contents of the fingerprint file that Tor
416
      writes as a server, or a 551 if we're not a server currently.
417
418
      (Added in 0.1.2.3-alpha)

419
    "circuit-status"
420
421
      A series of lines as for a circuit status event. Each line is of
      the form:
422
         CircuitID SP CircStatus [SP Path] CRLF
423

424
425
    "stream-status"
      A series of lines as for a stream status event.  Each is of the form:
426
         StreamID SP StreamStatus SP CircID SP Target CRLF
427

428
    "orconn-status"
429
      A series of lines as for an OR connection status event.  Each is of the
430
431
      form:
         ServerID SP ORStatus CRLF
432

433
434
    "entry-guards"
      A series of lines listing the currently chosen entry guards, if any.
435
      Each is of the form:
436
         ServerID2 SP Status [SP ISOTime] CRLF
437

438
439
440
441
442
         Status-with-time = ("unlisted") SP ISOTime
         Status = ("up" / "never-connected" / "down" /
                      "unusable" / "unlisted" )

         ServerID2 = Nickname / 40*HEXDIG
443

444
445
      [From 0.1.1.4-alpha to 0.1.1.10-alpha, this was called "helper-nodes".
       Tor still supports calling it that for now, but support will be
446
       removed in 0.1.3.x.]
447

448
449
450
451
452
453
454
      [Older versions of Tor (before 0.1.2.x-final) generated 'down' instead
       of unlisted/unusable.  Current Tors never generate 'down'.]

      [XXXX ServerID2 differs from ServerID in not prefixing fingerprints
       with a $.  This is an implementation error.  It would be nice to add
       the $ back in if we can do so without breaking compatibility.]

455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
    "accounting/enabled"
    "accounting/hibernating"
    "accounting/bytes"
    "accounting/bytes-left"
    "accounting/interval-start"
    "accounting/interval-wake"
    "accounting/interval-end"
      Information about accounting status.  If accounting is enabled,
      "enabled" is 1; otherwise it is 0.  The "hibernating" field is "hard"
      if we are accepting no data; "soft" if we're accepting no new
      connections, and "awake" if we're not hibernating at all.  The "bytes"
      and "bytes-left" fields contain (read-bytes SP write-bytes), for the
      start and the rest of the interval respectively.  The 'interval-start'
      and 'interval-end' fields are the borders of the current interval; the
      'interval-wake' field is the time within the current interval (if any)
      where we plan[ned] to start being active.

    "config/names"
      A series of lines listing the available configuration options. Each is
      of the form:
         OptionName SP OptionType [ SP Documentation ] CRLF
         OptionName = Keyword
         OptionType = "Integer" / "TimeInterval" / "DataSize" / "Float" /
           "Boolean" / "Time" / "CommaList" / "Dependant" / "Virtual" /
           "String" / "LineList"
         Documentation = Text

    "info/names"
      A series of lines listing the available GETINFO options.  Each is of
484
      one of these forms:
485
486
487
488
         OptionName SP Documentation CRLF
         OptionPrefix SP Documentation CRLF
         OptionPrefix = OptionName "/*"

489
490
491
492
493
494
495
496
    "events/names"
      A space-separated list of all the events supported by this version of
      Tor's SETEVENTS.

    "features/names"
      A space-separated list of all the events supported by this version of
      Tor's USEFEATURE.

497
498
499
    "next-circuit/IP:port"
      XXX todo.

500
501
502
503
504
505
506
507
508
509
    "dir/status/authority"
    "dir/status/fp/<F>"
    "dir/status/fp/<F1>+<F2>+<F3>"
    "dir/status/all"
    "dir/server/fp/<F>"
    "dir/server/fp/<F1>+<F2>+<F3>"
    "dir/server/d/<D>"
    "dir/server/d/<D1>+<D2>+<D3>"
    "dir/server/authority"
    "dir/server/all"
510
511
512
513
514
515
      A series of lines listing directory contents, provided according to the
      specification for the URLs listed in Section 4.4 of dir-spec.txt.  Note
      that Tor MUST NOT provide private information, such as descriptors for
      routers not marked as general-purpose.  When asked for 'authority'
      information for which this Tor is not authoritative, Tor replies with
      an empty string.
516

517
    "status/circuit-established"
518
    "status/enough-dir-info"
519
    "status/..."
520
521
522
523
      These provide the current internal Tor values for various Tor
      states. See Section 4.1.10 for explanations. (Only a few of the
      status events are available as getinfo's currently. Let us know if
      you want more exposed.)
524
525
526
527
528
529
    "status/version/recommended" -- List of currently recommended versions
    "status/version/current" -- Status of the current version. One of:
        new, old, unrecommended, recommended, new in series, obsolete.
    "status/version/num-versioning" -- Number of versioning authorities
    "status/version/num-concurring" -- Number of versioning authorities
        agreeing on the status of the current version
530

531
532
533
534
535
536
537
  Examples:
     C: GETINFO version desc/name/moria1
     S: 250+desc/name/moria=
     S: [Descriptor for moria]
     S: .
     S: 250-version=Tor 0.1.1.0-alpha-cvs
     S: 250 OK
538

539
3.10. EXTENDCIRCUIT
540

541
  Sent from the client to the server.  The format is:
542
      "EXTENDCIRCUIT" SP CircuitID SP
543
                      ServerSpec *("," ServerSpec) SP
544
                      ("purpose=" Purpose) CRLF
545

546
  This request takes one of two forms: either the CircuitID is zero, in
547
  which case it is a request for the server to build a new circuit according
548
  to the specified path, or the CircuitID is nonzero, in which case it is a
549
550
551
  request for the server to extend an existing circuit with that ID according
  to the specified path.

552
553
554
  If CircuitID is 0 and "purpose=" is specified, then the circuit's
  purpose is set. Two choices are recognized: "general" and
  "controller". If not specified, circuits are created as "general".
555

556
557
558
559
560
561
562
563
564
565
566
  If the request is successful, the server sends a reply containing a
  message body consisting of the CircuitID of the (maybe newly created)
  circuit. The syntax is "250" SP "EXTENDED" SP CircuitID CRLF.

3.11. SETCIRCUITPURPOSE

  Sent from the client to the server.  The format is:
      "SETCIRCUITPURPOSE" SP CircuitID SP Purpose CRLF

  This changes the circuit's purpose. See EXTENDCIRCUIT above for details.

567
568
569
570
571
572
573
574
575
3.12. SETROUTERPURPOSE

  Sent from the client to the server.  The format is:
      "SETROUTERPURPOSE" SP NicknameOrKey SP Purpose CRLF

  This changes the descriptor's purpose. See +POSTDESCRIPTOR below
  for details.

3.13. ATTACHSTREAM
576

577
  Sent from the client to the server.  The syntax is:
578
     "ATTACHSTREAM" SP StreamID SP CircuitID [SP "HOP=" HopNum] CRLF
579
580
581
582

  This message informs the server that the specified stream should be
  associated with the specified circuit.  Each stream may be associated with
  at most one circuit, and multiple streams may share the same circuit.
583
  Streams can only be attached to completed circuits (that is, circuits that
584
  have sent a circuit status 'BUILT' event or are listed as built in a
585
  GETINFO circuit-status request).
586

587
588
589
  If the circuit ID is 0, responsibility for attaching the given stream is
  returned to Tor.

590
591
  If HOP=HopNum is specified, Tor will choose the HopNumth hop in the
  circuit as the exit node, rather than the last node in the circuit.
592
  Hops are 1-indexed; generally, it is not permitted to attach to hop 1.
593

594
595
596
597
  Tor responds with "250 OK" if it can attach the stream, 552 if the circuit
  or stream didn't exist, or 551 if the stream couldn't be attached for
  another reason.

598
599
600
601
  {Implementation note: Tor will close unattached streams by itself,
  roughly two minutes after they are born. Let the developers know if
  that turns out to be a problem.}

602
  {Implementation note: By default, Tor automatically attaches streams to
603
604
605
606
  circuits itself, unless the configuration variable
  "__LeaveStreamsUnattached" is set to "1".  Attempting to attach streams
  via TC when "__LeaveStreamsUnattached" is false may cause a race between
  Tor and the controller, as both attempt to attach streams to circuits.}
607

608
609
610
611
612
  {Implementation note: You can try to attachstream to a stream that
  has already sent a connect or resolve request but hasn't succeeded
  yet, in which case Tor will detach the stream from its current circuit
  before proceeding with the new attach request.}

613
3.14. POSTDESCRIPTOR
614

615
  Sent from the client to the server. The syntax is:
616
    "+POSTDESCRIPTOR" ("purpose=" Purpose) CRLF Descriptor CRLF "." CRLF
617

618
619
620
  This message informs the server about a new descriptor. If Purpose is
  specified, it must be either "general" or "controller", else we
  return a 552 error.
621
622
623
624

  The descriptor, when parsed, must contain a number of well-specified
  fields, including fields for its nickname and identity.

625
626
627
628
629
  If there is an error in parsing the descriptor, the server must send a "554
  Invalid descriptor" reply.  If the descriptor is well-formed but the server
  chooses not to add it, it must reply with a 251 message whose body explains
  why the server was not added.  If the descriptor is added, Tor replies with
  "250 OK".
630

631
3.15. REDIRECTSTREAM
632
633

  Sent from the client to the server. The syntax is:
634
    "REDIRECTSTREAM" SP StreamID SP Address (SP Port) CRLF
635

636
637
638
  Tells the server to change the exit address on the specified stream.  If
  Port is specified, changes the destination port as well.  No remapping
  is performed on the new provided address.
639
640
641
642

  To be sure that the modified address will be used, this event must be sent
  after a new stream event is received, and before attaching this stream to
  a circuit.
643

644
  Tor replies with "250 OK" on success.
645

646
3.16. CLOSESTREAM
647

648
  Sent from the client to the server.  The syntax is:
649

650
    "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
651

652
653
654
655
  Tells the server to close the specified stream.  The reason should be one
  of the Tor RELAY_END reasons given in tor-spec.txt, as a decimal.  Flags is
  not used currently; Tor servers SHOULD ignore unrecognized flags.  Tor may
  hold the stream open for a while to flush any data that is pending.
656

657
658
659
  Tor replies with "250 OK" on success, or a 512 if there aren't enough
  arguments, or a 552 if it doesn't recognize the StreamID or reason.

660
3.17. CLOSECIRCUIT
661

662
663
664
   The syntax is:
     CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
     Flag = "IfUnused"
665

666
667
  Tells the server to close the specified circuit.   If "IfUnused" is
  provided, do not close the circuit unless it is unused.
668

669
670
  Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  flags.
671

672
673
674
  Tor replies with "250 OK" on success, or a 512 if there aren't enough
  arguments, or a 552 if it doesn't recognize the CircuitID.

675
3.18. QUIT
676
677
678
679

  Tells the server to hang up on this controller connection. This command
  can be used before authenticating.

680
681
682
683
684
685
686
687
688
689
3.19. USEFEATURE

  The syntax is:

    "USEFEATURE" *(SP FeatureName) CRLF
    FeatureName = 1*(ALPHA / DIGIT / "_" / "-")

  Sometimes extensions to the controller protocol break compatibility with
  older controllers.  In this case, whenever possible, the extensions are
  first included in Tor disabled by default, and only enabled on a given
690
  controller connection when the "USEFEATURE" command is given.  Once a
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
  "USEFEATURE" command is given, it applies to all subsequent interactions on
  the same connection; to disable an enabled feature, a new controller
  connection must be opened.

  This is a forward-compatibility mechanism; each feature will eventually
  become a regular part of the control protocol in some future version of Tor.
  Tor will ignore a request to use any feature that is already on by default.
  Tor will give a "552" error if any requested feature is not recognized.

  Feature names are case-insensitive.

  EXTENDED_EVENTS

     Same as passing 'EXTENDED' to SETEVENTS; this is the preferred way to
     request the extended event syntax.

707
     This will not be always-enabled until at least XXX (or, at least two
708
709
710
711
712
     stable releases after XXX, the release where it was first used for
     anything.)

  VERBOSE_NAMES

713
     Instead of ServerID as specified above, the controller should
714
     identify ORs by LongName in events and GETINFO results.  This format is
715
716
     strictly more informative: rather than including Nickname for
     known Named routers and Fingerprint for unknown or unNamed routers, the
717
718
719
     LongName format includes a Fingerprint, an indication of Named status,
     and a Nickname (if one is known).

720
721
722
723
     This will not be always-enabled until at least 0.1.4.x (or at least two
     stable releases after 0.1.2.2-alpha, the release where it was first
     available.)

724
725
726
727
728
729
730
731
732
733
734
735
3.20. RESOLVE

  The syntax is
    "RESOLVE" *Option *Address CRLF
    Option = "mode=reverse"
    Address = a hostname or IPv4 address

  This command launches a remote hostname lookup request for every specified
  request (or reverse lookup if "mode=reverse" is specified).  Note that the
  request is done in the background: to see the answers, your controller will
  need to listen for ADDRMAP events; see 4.1.7 below.

736
737
  [Added in Tor 0.2.0.3-alpha]

738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
3.21. PROTOCOLINFO

  The syntax is:
    "PROTOCOLINFO" *(SP PIVERSION) CRLF

  The server reply format is:
    "250+PROTOCOLINFO" SP PIVERSION CRLF *InfoLine "250 OK" CRLF

    InfoLine = AuthLine / VersionLine / OtherLine

     AuthLine = "250-AUTH" SP "METHODS=" AuthMethod *(",")AuthMethod
                       *(SP "COOKIEFILE=" AuthCookieFile) CRLF
     VersionLine = "250-VERSION" SP "Tor=" TorVersion [SP Arguments] CRLF

     AuthMethod =
      "NULL"           / ; No authentication is required
      "HASHEDPASSWORD" / ; A controller must supply the original password
      "COOKIE"         / ; A controller must supply the contents of a cookie

     AuthCookieFile = QuotedString
     TorVersion = QuotedString

     OtherLine = "250-" Keyword [SP Arguments] CRLF

    PIVERSION: 1*DIGIT

  Tor MAY give its InfoLines in any order; controllers MUST ignore InfoLines
  with keywords it does not recognize.  Controllers MUST ignore extraneous
  data on any InfoLine.

  PIVERSION is there in case we drastically change the syntax one day. For
  now it should always be "1", for the controller protocol.  Controllers MAY
  provide a list of the protocol versions they support; Tor MAY select a
  version that the controller does not support.

  AuthMethod is used to specify one or more control authentication
  methods that Tor currently accepts.

  AuthCookieFile specifies the absolute path and filename of the
  authentication cookie that Tor is expecting and is provided iff
  the METHODS field contains the method "COOKIE".  Controllers MUST handle
  escape sequences inside this string.

  The VERSION line contains the Tor version.

  [Unlike other commands besides AUTHENTICATE, PROTOCOLINFO may be used (but
  only once!) before AUTHENTICATE.]

  [PROTOCOLINFO was not supported before Tor 0.2.0.5-alpha.]

788
4. Replies
789

790
791
  Reply codes follow the same 3-character format as used by SMTP, with the
  first character defining a status, the second character defining a
792
  subsystem, and the third designating fine-grained information.
793

794
  The TC protocol currently uses the following first characters:
795

796
797
    2yz   Positive Completion Reply
       The command was successful; a new request can be started.
798

799
800
    4yz   Temporary Negative Completion reply
       The command was unsuccessful but might be reattempted later.
801

802
803
804
    5yz   Permanent Negative Completion Reply
       The command was unsuccessful; the client should not try exactly
       that sequence of commands again.
805

806
807
    6yz   Asynchronous Reply
       Sent out-of-order in response to an earlier SETEVENTS command.
808

809
  The following second characters are used:
810

811
812
    x0z   Syntax
       Sent in response to ill-formed or nonsensical commands.
813

814
815
816
    x1z   Protocol
       Refers to operations of the Tor Control protocol.

817
    x5z   Tor
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
       Refers to actual operations of Tor system.

  The following codes are defined:

     250 OK
     251 Operation was unnecessary
         [Tor has declined to perform the operation, but no harm was done.]

     451 Resource exhausted

     500 Syntax error: protocol

     510 Unrecognized command
     511 Unimplemented command
     512 Syntax error in command argument
     513 Unrecognized command argument
     514 Authentication required
     515 Bad authentication

     550 Unspecified Tor error

     551 Internal error
               [Something went wrong inside Tor, so that the client's
                request couldn't be fulfilled.]

     552 Unrecognized entity
               [A configuration key, a stream ID, circuit ID, event,
                mentioned in the command did not actually exist.]

     553 Invalid configuration value
         [The client tried to set a configuration option to an
           incorrect, ill-formed, or impossible value.]

851
852
     554 Invalid descriptor

853
854
     555 Unmanaged entity

855
856
     650 Asynchronous event notification

857
858
859
  Unless specified to have specific contents, the human-readable messages
  in error replies should not be relied upon to match those in this document.

860
4.1. Asynchronous events
861
862
863
864
865
866
867
868

  These replies can be sent after a corresponding SETEVENTS command has been
  received.  They will not be interleaved with other Reply elements, but they
  can appear between a command and its corresponding reply.  For example,
  this sequence is possible:

     C: SETEVENTS CIRC
     S: 250 OK
869
     C: GETCONF SOCKSPORT ORPORT
870
871
872
873
874
875
876
     S: 650 CIRC 1000 EXTENDED moria1,moria2
     S: 250-SOCKSPORT=9050
     S: 250 ORPORT=0

  But this sequence is disallowed:
     C: SETEVENTS CIRC
     S: 250 OK
877
     C: GETCONF SOCKSPORT ORPORT
878
879
880
881
     S: 250-SOCKSPORT=9050
     S: 650 CIRC 1000 EXTENDED moria1,moria2
     S: 250 ORPORT=0

882
883
  Clients MUST tolerate more arguments in an asynchonous reply than
  expected, and MUST tolerate more lines in an asynchronous reply than
884
885
  expected.  For instance, a client that expects a CIRC message like:
      650 CIRC 1000 EXTENDED moria1,moria2
886
  must tolerate:
887
      650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
888
889
890
      650-EXTRAMAGIC=99
      650 ANONYMITY=high

891
  If clients ask for extended events, then each event line as specified below
892
  will be followed by additional extensions. Additional lines will be of the
893
894
895
  form
      "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  Additional arguments will be of the form
Roger Dingledine's avatar
Roger Dingledine committed
896
      SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
897
898
  Such clients MUST tolerate lines with keywords they do not recognize.

899
4.1.1. Circuit status changed
900
901
902

   The syntax is:

903
     "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
904
          [SP "REASON=" Reason [SP "REMOTE_REASON=" Reason]] CRLF
905
906
907
908
909
910
911
912
913
914

      CircStatus =
               "LAUNCHED" / ; circuit ID assigned to new circuit
               "BUILT"    / ; all hops finished, can now accept streams
               "EXTENDED" / ; one more hop has been completed
               "FAILED"   / ; circuit closed (was not built)
               "CLOSED"     ; circuit closed (was built)

      Path = ServerID *("," ServerID)

915
      Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
916
               "HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
917
918
               "OR_IDENTITY" / "OR_CONN_CLOSED" / "TIMEOUT" /
               "FINISHED" / "DESTROYED" / "NOPATH" / "NOSUCHSERVICE"
919

920
921
922
   The path is provided only when the circuit has been extended at least one
   hop.

923
924
   The "REASON" field is provided only for FAILED and CLOSED events, and only
   if extended events are enabled (see 3.19).  Clients MUST accept reasons
925
   not listed above.  Reasons are as given in tor-spec.txt, except for:
926

927
      NOPATH          (Not enough nodes to make circuit)
928

929
930
931
932
933
   The "REMOTE_REASON" field is provided only when we receive a DESTROY or
   TRUNCATE cell, and only if extended events are enabled.  It contains the
   actual reason given by the remote OR for closing the circuit. Clients MUST
   accept reasons not listed above.  Reasons are as listed in tor-spec.txt.

934
935
936
937
4.1.2. Stream status changed

    The syntax is:

Roger Dingledine's avatar
Roger Dingledine committed
938
      "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target
939
          [SP "REASON=" Reason [ SP "REMOTE_REASON=" Reason ]]
940
941
          [SP "SOURCE=" Source] [ SP "SOURCE_ADDR=" Address ":" Port ]
          CRLF
942
943
944

      StreamStatus =
               "NEW"          / ; New request to connect
945
               "NEWRESOLVE"   / ; New request to resolve an address
946
               "REMAP"        / ; Address re-mapped to another
947
948
               "SENTCONNECT"  / ; Sent a connect cell along a circuit
               "SENTRESOLVE"  / ; Sent a resolve cell along a circuit
949
               "SUCCEEDED"    / ; Received a reply; stream established
950
               "FAILED"       / ; Stream failed and not retriable
951
               "CLOSED"       / ; Stream closed
952
               "DETACHED"       ; Detached from circuit; still retriable
953
954
955

       Target = Address ":" Port

956
957
  The circuit ID designates which circuit this stream is attached to.  If
  the stream is unattached, the circuit ID "0" is given.
958

959
960
961
962
963
964
965
966
967
968
969
970
      Reason = "MISC" / "RESOLVEFAILED" / "CONNECTREFUSED" /
               "EXITPOLICY" / "DESTROY" / "DONE" / "TIMEOUT" /
               "HIBERNATING" / "INTERNAL"/ "RESOURCELIMIT" /
               "CONNRESET" / "TORPROTOCOL" / "NOTDIRECTORY" / "END"

   The "REASON" field is provided only for FAILED, CLOSED, and DETACHED
   events, and only if extended events are enabled (see 3.19).  Clients MUST
   accept reasons not listed above.  Reasons are as given in tor-spec.txt,
   except for:

      END          (We received a RELAY_END cell from the other side of thise
                    stream.)
971
      [XXXX document more.]
972
973
974
975
976
977

   The "REMOTE_REASON" field is provided only when we receive a RELAY_END
   cell, and only if extended events are enabled.  It contains the actual
   reason given by the remote OR for closing the stream. Clients MUST accept
   reasons not listed above.  Reasons are as listed in tor-spec.txt.

978
979
980
981
982
983
984
   "REMAP" events include a Source if extended events are enabled:
      Source = "CACHE" / "EXIT"
   Clients MUST accept sources not listed above.  "CACHE" is given if
   the Tor client decided to remap the address because of a cached
   answer, and "EXIT" is given if the remote node we queried gave us
   the new address as a response.

985
   The "SOURCE_ADDR" field is included with NEW and NEWRESOLVE events if
986
987
988
   extended events are enabled.  It indicates the address and port
   that requested the connection, and can be (e.g.) used to look up the
   requesting program.
989

990
4.1.3. OR Connection status changed
991
992

  The syntax is:
993
    "650" SP "ORCONN" SP (ServerID / Target) SP ORStatus [ SP "REASON="
994
             Reason ] [ SP "NCIRCS=" NumCircuits ]
995

996
997
998
999
1000
    ORStatus = "NEW" / "LAUNCHED" / "CONNECTED" / "FAILED" / "CLOSED"

  NEW is for incoming connections, and LAUNCHED is for outgoing
  connections. CONNECTED means the TLS handshake has finished (in
  either direction). FAILED means a connection is being closed that
For faster browsing, not all history is shown. View entire blame