control-spec.txt 48.3 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
    Reply = *(MidReplyLine / DataReplyLine) EndReplyLine
Nick Mathewson's avatar
Nick Mathewson committed
66

67
68
69
70
71
72
    MidReplyLine = "-" ReplyLine
    DataReplyLine = "+" ReplyLine Data
    EndReplyLine = SP ReplyLine
    ReplyLine = StatusCode [ SP ReplyText ]  CRLF
    ReplyText = XXXX
    StatusCode = XXXX
Nick Mathewson's avatar
Nick Mathewson committed
73

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

77
2.4. General-use tokens
Nick Mathewson's avatar
Nick Mathewson committed
78

79
80
  ; Identifiers for servers.
  ServerID = Nickname / Fingerprint
81

82
  Nickname = 1*19 NicknameChar
83
84
  NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"
  Fingerprint = "$" 40*HEXDIG
Nick Mathewson's avatar
Nick Mathewson committed
85

86
87
88
89
90
91
92
93
94
  ; 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
95
  ;        digest, but only if the router has the given nickname.
96
97
98
99
100
101
102
103
104
  ;    $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

105
106
107
108
109
  ; 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
110

111
  Address = ip4-address / ip6-address / hostname   (XXXX Define these)
112

113
114
115
  ; 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
116
  ; an additional leading period as in RFC 2821 section 4.5.2.
117
  Data = *DataLine "." CRLF
118
  DataLine = CRLF / "." 1*LineItem CRLF / NonDotItem *LineItem CRLF
119
120
  LineItem = NonCR / 1*CR NonCRLF
  NonDotItem = NonDotCR / 1*CR NonCRLF
121

122
3. Commands
123

124
  All commands and other keywords are case-insensitive.
125

126
3.1. SETCONF
Nick Mathewson's avatar
Nick Mathewson committed
127

128
  Change the value of one or more configuration variables.  The syntax is:
129

130
    "SETCONF" 1*(SP keyword ["=" String]) CRLF
131

132
133
  Tor behaves as though it had just read each of the key-value pairs
  from its configuration file.  Keywords with no corresponding values have
134
  their configuration values reset to 0 or NULL (use RESETCONF if you want
135
136
  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.
137

138
  Tor responds with a "250 configuration values set" reply on success.
139
140
141
142
  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.
143

144
  When a configuration option takes multiple values, or when multiple
145
  configuration keys form a context-sensitive group (see GETCONF below), then
146
  setting _any_ of the options in a SETCONF command is taken to reset all of
147
148
149
  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.
150

151
3.2. RESETCONF
152

153
154
155
156
  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:
157

158
    "RESETCONF" 1*(SP keyword ["=" String]) CRLF
159
160
161
162

  Otherwise it behaves like SETCONF above.

3.3. GETCONF
163
164
165
166

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

    "GETCONF" 1*(SP keyword) CRLF
167

168
169
170
  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
171
172
173
  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
174
175

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

178
179
180
181
  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
182
183
184
185
  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.
186

187
3.4. SETEVENTS
188

189
190
  Request the server to inform the client about interesting events.  The
  syntax is:
191

192
     "SETEVENTS" [SP "EXTENDED"] *(SP EventCode) CRLF
193

194
     EventCode = "CIRC" / "STREAM" / "ORCONN" / "BW" / "DEBUG" /
195
         "INFO" / "NOTICE" / "WARN" / "ERR" / "NEWDESC" / "ADDRMAP" /
196
         "AUTHDIR_NEWDESCS" / "DESCCHANGED" / "STATUS_GENERAL" /
197
         "STATUS_CLIENT" / "STATUS_SERVER" / "GUARDS" / "NS"
198

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

202
203
204
  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.)
205

206
207
208
209
210
211
  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.

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

214
3.5. AUTHENTICATE
215

216
  Sent from the client to the server.  The syntax is:
217
     "AUTHENTICATE" [ SP 1*HEXDIG / QuotedString ] CRLF
218

219
220
  The server responds with "250 OK" on success or "515 Bad authentication" if
  the authentication cookie is incorrect.
221

222
223
  The format of the 'cookie' is implementation-dependent; see 5.1 below for
  information on how the standard Tor implementation handles it.
224

225
226
227
  If Tor requires authentication and the controller has not yet sent an
  AUTHENTICATE message, Tor sends a "514 authentication required" reply to
  any other kind of message.
228

229
3.6. SAVECONF
230

231
232
  Sent from the client to the server.  The syntax is:
     "SAVECONF" CRLF
233

234
  Instructs the server to write out its config options into its torrc. Server
235
236
  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.
237

238
3.7. SIGNAL
239

240
  Sent from the client to the server. The syntax is:
241

242
     "SIGNAL" SP Signal CRLF
243

244
     Signal = "RELOAD" / "SHUTDOWN" / "DUMP" / "DEBUG" / "HALT" /
245
246
              "HUP" / "INT" / "USR1" / "USR2" / "TERM" / "NEWNYM" /
              "CLEARDNSCACHE"
247

248
  The meaning of the signals are:
249

250
      RELOAD    -- Reload: reload config items, refetch directory. (like HUP)
251
      SHUTDOWN  -- Controlled shutdown: if server is an OP, exit immediately.
252
                   If it's an OR, close listeners and exit after 30 seconds.
253
                   (like INT)
254
      DUMP      -- Dump stats: log information about open connections and
255
256
                   circuits. (like USR1)
      DEBUG     -- Debug: switch all open logs to loglevel debug. (like USR2)
257
      HALT      -- Immediate shutdown: clean up and exit now. (like TERM)
258
      CLEARDNSCACHE -- Forget the client-side cached IPs for all hostnames.
259
      NEWNYM    -- Switch to clean circuits, so new application requests
260
261
                   don't share any circuits with old ones.  Also clears
                   the client-side DNS cache.
262

263
264
265
  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.
266

267
3.8. MAPADDRESS
268

269
  Sent from the client to the server.  The syntax is:
270

271
    "MAPADDRESS" 1*(Address "=" Address SP) CRLF
272

273
274
275
276
277
278
279
280
281
  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

282
283
284
  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
285
  "451 resource exhausted".
286
287

  The client may decline to provide a body for the original address, and
288
289
  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
290
  address itself, and return that address in the reply.  The server
291
292
293
  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.
294
295
296
297
298
299

  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.

300
301
302
303
304
  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

305
306
307
308
309
310
311
312
313
314
315
316
  {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.}

317
318
319
320
  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.
321

322
3.9. GETINFO
323

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

329
330
331
332
333
  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
334
  If a value must be split over multiple lines, the format is:
335
336
337
      250+keyword=
      value
      .
338
  Recognized keys and their values include:
339

340
341
342
    "version" -- The version of the server's software, including the name
      of the software. (example: "Tor 0.0.9.4")

343
344
    "config-file" -- The location of Tor's configuration file ("torrc").

345
346
347
348
349
350
351
    ["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
352
353
    "desc/id/<OR identity>" or "desc/name/<OR nickname>" -- the latest
      server descriptor for a given OR, NUL-terminated.
354

355
    "ns/id/<OR identity>" or "ns/name/<OR nickname>" -- the latest network
356
357
      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
358
359
360
361
362
      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.]
363
364
365
366

    "ns/all" -- Network status info for all ORs we have an opinion about,
      joined by newlines. [First implemented in 0.1.2.3-alpha.]

367
368
369
    "desc/all-recent" -- the latest server descriptor for every router that
      Tor knows about.

Roger Dingledine's avatar
Roger Dingledine committed
370
371
    "network-status" -- a space-separated list of all known OR identities.
      This is in the same format as the router-status line in directories;
372
373
374
375
      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.)
376

377
378
379
    "addr-mappings/all"
    "addr-mappings/config"
    "addr-mappings/cache"
380
381
382
383
384
385
386
    "addr-mappings/control" -- a space-separated list of address
      mappings, each in the form of "from-address=to-address".
      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.
387

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

391
    "fingerprint" -- the contents of the fingerprint file that Tor
392
      writes as a server, or a 551 if we're not a server currently.
393
394
      (Added in 0.1.2.3-alpha)

395
    "circuit-status"
396
397
      A series of lines as for a circuit status event. Each line is of
      the form:
398
         CircuitID SP CircStatus [SP Path] CRLF
399

400
401
    "stream-status"
      A series of lines as for a stream status event.  Each is of the form:
402
         StreamID SP StreamStatus SP CircID SP Target CRLF
403

404
    "orconn-status"
405
      A series of lines as for an OR connection status event.  Each is of the
406
407
      form:
         ServerID SP ORStatus CRLF
408

409
410
    "entry-guards"
      A series of lines listing the currently chosen entry guards, if any.
411
      Each is of the form:
412
413
414
415
         ServerID  SP (Status-with-time / Status) CRLF

         Status-with-time = ("down" / "unlisted") SP ISOTime
         Status = ("up" / "never-connected")
416

417
418
      [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
419
       removed in 0.1.3.x.]
420

421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
    "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
450
      one of these forms:
451
452
453
454
         OptionName SP Documentation CRLF
         OptionPrefix SP Documentation CRLF
         OptionPrefix = OptionName "/*"

455
456
457
458
459
460
461
462
    "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.

463
464
465
    "next-circuit/IP:port"
      XXX todo.

466
467
468
469
470
471
472
473
474
475
    "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"
476
477
478
479
480
481
      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.
482

483
484
    "status/circuit-established"
    "status/..."
485
486
487
488
489
      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.)

490
491
492
493
494
495
496
497
    "status/client"
    "status/server"
      These two special cases of internal Tor values return a (possibly
      empty) list of status events from Section 4.1.10 that Tor believes
      are still accurate. Controllers can use them to get a summary of
      any current problems with Tor's operation.
      [The answers should include notice events, not just warns and
      errs, for example so Tor can learn whether any circuits have been
498
499
500
501
502
      established yet.-RD]
        [notice, warn, and errs need to be separated here, though.
        Otherwise, when we add a new status event type in the future,
        controllers won't know whether it's good or bad. -NM]

503
504
505
      [Does this mean that Tor must keep state on its side of all the
      statuses it's sent, and recognize when they're cancelled out,
      and so on? It's a shame that Tor needs to do this and also Vidalia
506
507
508
      needs to do this. -RD]
        [Is there a good alternative? If we want controllers who connect
        to a running Tor to see its status, I think we need to do this. -NM]
509

510
511
512
      [What is the format of this list? Is it space-separated,
      newline-separated?  Does it include keywords, arguments, etc?  Also,
      what about STATUS_GENERAL? -NM]
513

514
515
516
517
518
519
520
  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
521

522
3.10. EXTENDCIRCUIT
523

524
  Sent from the client to the server.  The format is:
525
      "EXTENDCIRCUIT" SP CircuitID SP
526
                      ServerSpec *("," ServerSpec) SP
527
                      ("purpose=" Purpose) CRLF
528

529
  This request takes one of two forms: either the CircuitID is zero, in
530
  which case it is a request for the server to build a new circuit according
531
  to the specified path, or the CircuitID is nonzero, in which case it is a
532
533
534
  request for the server to extend an existing circuit with that ID according
  to the specified path.

535
536
537
  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".
538

539
540
541
542
543
544
545
546
547
548
549
  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.

550
551
552
553
554
555
556
557
558
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
559

560
561
  Sent from the client to the server.  The syntax is:
     "ATTACHSTREAM" SP StreamID SP CircuitID CRLF
562
563
564
565

  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.
566
  Streams can only be attached to completed circuits (that is, circuits that
567
  have sent a circuit status 'BUILT' event or are listed as built in a
568
  GETINFO circuit-status request).
569

570
571
572
  If the circuit ID is 0, responsibility for attaching the given stream is
  returned to Tor.

573
574
575
576
  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.

577
578
579
580
  {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.}

581
  {Implementation note: By default, Tor automatically attaches streams to
582
583
584
585
  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.}
586

587
588
589
590
591
  {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.}

592
3.14. POSTDESCRIPTOR
593

594
  Sent from the client to the server. The syntax is:
595
    "+POSTDESCRIPTOR" ("purpose=" Purpose) CRLF Descriptor CRLF "." CRLF
596

597
598
599
  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.
600
601
602
603

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

604
605
606
607
608
  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".
609

610
3.15. REDIRECTSTREAM
611
612

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

615
616
617
  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.
618
619
620
621

  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.
622

623
  Tor replies with "250 OK" on success.
624

625
3.16. CLOSESTREAM
626

627
  Sent from the client to the server.  The syntax is:
628

629
    "CLOSESTREAM" SP StreamID SP Reason *(SP Flag) CRLF
630

631
632
633
634
  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.
635

636
637
638
  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.

639
3.17. CLOSECIRCUIT
640

641
642
643
   The syntax is:
     CLOSECIRCUIT SP CircuitID *(SP Flag) CRLF
     Flag = "IfUnused"
644

645
646
  Tells the server to close the specified circuit.   If "IfUnused" is
  provided, do not close the circuit unless it is unused.
647

648
649
  Other flags may be defined in the future; Tor SHOULD ignore unrecognized
  flags.
650

651
652
653
  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.

654
3.18. QUIT
655
656
657
658

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

659
660
661
662
663
664
665
666
667
668
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
669
  controller connection when the "USEFEATURE" command is given.  Once a
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
  "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.

686
     This will not be always-enabled until at least XXX (or, at least two
687
688
689
690
691
     stable releases after XXX, the release where it was first used for
     anything.)

  VERBOSE_NAMES

692
     Instead of ServerID as specified above, the controller should
693
     identify ORs by LongName in events and GETINFO results.  This format is
694
695
     strictly more informative: rather than including Nickname for
     known Named routers and Fingerprint for unknown or unNamed routers, the
696
697
698
     LongName format includes a Fingerprint, an indication of Named status,
     and a Nickname (if one is known).

699
700
701
702
     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.)

703
4. Replies
704

705
706
  Reply codes follow the same 3-character format as used by SMTP, with the
  first character defining a status, the second character defining a
707
  subsystem, and the third designating fine-grained information.
708

709
  The TC protocol currently uses the following first characters:
710

711
712
    2yz   Positive Completion Reply
       The command was successful; a new request can be started.
713

714
715
    4yz   Temporary Negative Completion reply
       The command was unsuccessful but might be reattempted later.
716

717
718
719
    5yz   Permanent Negative Completion Reply
       The command was unsuccessful; the client should not try exactly
       that sequence of commands again.
720

721
722
    6yz   Asynchronous Reply
       Sent out-of-order in response to an earlier SETEVENTS command.
723

724
  The following second characters are used:
725

726
727
    x0z   Syntax
       Sent in response to ill-formed or nonsensical commands.
728

729
730
731
    x1z   Protocol
       Refers to operations of the Tor Control protocol.

732
    x5z   Tor
733
734
735
736
737
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
       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.]

766
767
     554 Invalid descriptor

768
769
     555 Unmanaged entity

770
771
     650 Asynchronous event notification

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

775
4.1. Asynchronous events
776
777
778
779
780
781
782
783

  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
784
     C: GETCONF SOCKSPORT ORPORT
785
786
787
788
789
790
791
     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
792
     C: GETCONF SOCKSPORT ORPORT
793
794
795
796
     S: 250-SOCKSPORT=9050
     S: 650 CIRC 1000 EXTENDED moria1,moria2
     S: 250 ORPORT=0

797
798
799
800
801
  Clients SHOULD tolerate more arguments in an asynchonous reply than
  expected, and SHOULD tolerate more lines in an asynchronous reply than
  expected.  For instance, a client that expects a CIRC message like:
      650 CIRC 1000 EXTENDED moria1,moria2
  should tolerate:
802
      650-CIRC 1000 EXTENDED moria1,moria2 0xBEEF
803
804
805
      650-EXTRAMAGIC=99
      650 ANONYMITY=high

806
807
808
809
810
811
  If clients ask for extended events, then each event line as specified below
  will be followed by additional extensions.  Clients that do so MUST
  tolerate additional arguments and lines.  Additional lines will be of the
  form
      "650" ("-"/" ") KEYWORD ["=" ARGUMENTS] CRLF
  Additional arguments will be of the form
Roger Dingledine's avatar
Roger Dingledine committed
812
      SP KEYWORD ["=" ( QuotedString / * NonSpDquote ) ]
813
814
  Such clients MUST tolerate lines with keywords they do not recognize.

815
4.1.1. Circuit status changed
816
817
818

   The syntax is:

819
     "650" SP "CIRC" SP CircuitID SP CircStatus [SP Path]
820
          [SP "REASON=" Reason [SP "REMOTE_REASON=" Reason]] CRLF
821
822
823
824
825
826
827
828
829
830

      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)

831
      Reason = "NONE" / "TORPROTOCOL" / "INTERNAL" / "REQUESTED" /
832
               "HIBERNATING" / "RESOURCELIMIT" / "CONNECTFAILED" /
833
834
               "OR_IDENTITY" / "OR_CONN_CLOSED" / "TIMEOUT" /
               "FINISHED" / "DESTROYED" / "NOPATH" / "NOSUCHSERVICE"
835

836
837
838
   The path is provided only when the circuit has been extended at least one
   hop.

839
840
   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
841
   not listed above.  Reasons are as given in tor-spec.txt, except for:
842

843
      NOPATH          (Not enough nodes to make circuit)
844

845
846
847
848
849
   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.

850
851
852
853
4.1.2. Stream status changed

    The syntax is:

Roger Dingledine's avatar
Roger Dingledine committed
854
      "650" SP "STREAM" SP StreamID SP StreamStatus SP CircID SP Target
855
          [SP "REASON=" Reason [ SP "REMOTE_REASON=" Reason ]] CRLF
856
857
858

      StreamStatus =
               "NEW"          / ; New request to connect
859
860
861
               "NEWRESOLVE"   / ; New request to resolve an address
               "SENTCONNECT"  / ; Sent a connect cell along a circuit
               "SENTRESOLVE"  / ; Sent a resolve cell along a circuit
862
               "SUCCEEDED"    / ; Received a reply; stream established
863
               "FAILED"       / ; Stream failed and not retriable
864
               "CLOSED"       / ; Stream closed
865
               "DETACHED"       ; Detached from circuit; still retriable
866
867
868

       Target = Address ":" Port

869
870
  The circuit ID designates which circuit this stream is attached to.  If
  the stream is unattached, the circuit ID "0" is given.
871

872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
      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.)

   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.

890
4.1.3. OR Connection status changed
891
892

  The syntax is:
893
    "650" SP "ORCONN" SP (ServerID / Target) SP ORStatus
894

895
896
897
898
899
900
901
902
903
904
    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
  hasn't finished its handshake, and CLOSED is for connections that
  have handshaked.

  A ServerID is specified unless it's a NEW connection, in which
  case we don't know what server it is yet, so we use Address:Port.
905

906
4.1.4. Bandwidth used in the last second
907
908
909
910
911
912

  The syntax is:
     "650" SP "BW" SP BytesRead SP BytesWritten
     BytesRead = 1*DIGIT
     BytesWritten = 1*DIGIT

913
4.1.5. Log messages
914
915
916
917
918
919
920
921

  The syntax is:
     "650" SP Severity SP ReplyText
  or
     "650+" Severity CRLF Data

     Severity = "DEBUG" / "INFO" / "NOTICE" / "WARN"/ "ERR"

922
4.1.6. New descriptors available
923
924
925
926

  Syntax:
     "650" SP "NEWDESC" 1*(SP ServerID)

927
4.1.7. New Address mapping
928
929
930
931
932

  Syntax:
     "650" SP "ADDRMAP" SP Address SP Address SP Expiry
     Expiry = DQOUTE ISOTime DQUOTE / "NEVER"

933
934
  Expiry is expressed as the local time (rather than GMT).

Roger Dingledine's avatar
Roger Dingledine committed
935
936
937
938
939
  [XXX We should rename this to ADDRESSMAP. -RD]

  [FFF We should add a SOURCE=%s argument for extended events,
   which specifies what exit node told us this addressmap. -RD]

940
941
942
4.1.8. Descriptors uploaded to us in our role as authoritative dirserver

  Syntax:
943
944
     "650" "+" "AUTHDIR_NEWDESCS" CRLF Action CRLF Message CRLF
       Descriptor CRLF "." CRLF
945
946
947
     Action = "ACCEPTED" / "DROPPED" / "REJECTED"
     Message = Text

948
949
950
951
952
953
954
4.1.9. Our descriptor changed

  Syntax:
     "650" SP "DESCCHANGED"

  [First added in 0.1.2.2-alpha.]

955
4.1.10. Status events
956

957
958
  [Don't rely on any of these until we work out more of the details. -RD]

959
  Syntax:
960
961
962
963
     "650" SP Type SP Severity SP Action SP Arguments
     Type = "STATUS_GENERAL" / "STATUS_CLIENT" / "STATUS_SERVER"
     Severity = "NOTICE" / "WARN" / "ERR"

964
     Action is a string, and Arguments is a series of keyword=value
965
966
     pairs on the same line.  Values may be space-terminated strings,
     or quoted strings.
967

968
969
970
     These events are always produced with EXTENDED_EVENTS and
     VERBOSE_NAMES; see the explanations in the USEFEATURE section
     for details.
971

972
  Actions for STATUS_GENERAL events can be as follows:
973

974
     CLOCK_JUMPED
975
     "TIME=NUM"
976
       Tor spent enough time without CPU cycles that it has closed all
Roger Dingledine's avatar
Roger Dingledine committed
977
       its circuits and will establish them anew. This typically
978
979
       happens when a laptop goes to sleep and then wakes up again. It
       also happens when the system is swapping so heavily that Tor is
Roger Dingledine's avatar
Roger Dingledine committed
980
       starving. The "time" argument specifies the number of seconds Tor
981
       thinks it was unconscious for.
982
983
       This status event is sent as NOTICE severity normally, but WARN
       severity if Tor is acting as a server currently.
984
985
986
987

       [Recommendation for controller: ignore it, since we don't really
       know what the user should do anyway. Hm.]

988
989
990
991
992
[the basic idea for the rest is to do it like the CLOCK_JUMPED entry
above: specify a Type, describe what it is and its arguments, and
describe what Severities to expect and what we suggest the controller
do for each. -RD]

993
994
995
     DIR_REACHABLE
     [not implemented yet]

996
  typically severity WARN events:
997
998

     DANGEROUS_VERSION
999
1000
     "CURRENT=version"
     "REASON=NEW/OLD/UNRECOMMENDED"