Commit | Line | Data |
---|---|---|
d6623498 | 1 | .\" -*-nroff-*- |
fc916a09 MW |
2 | .\". |
3 | .\" Manual for the administration protocol | |
4 | .\" | |
5 | .\" (c) 2008 Straylight/Edgeware | |
060ca767 | 6 | .\" |
13a55605 | 7 | . |
fc916a09 MW |
8 | .\"----- Licensing notice --------------------------------------------------- |
9 | .\" | |
10 | .\" This file is part of Trivial IP Encryption (TrIPE). | |
11 | .\" | |
11ad66c2 MW |
12 | .\" TrIPE is free software: you can redistribute it and/or modify it under |
13 | .\" the terms of the GNU General Public License as published by the Free | |
14 | .\" Software Foundation; either version 3 of the License, or (at your | |
15 | .\" option) any later version. | |
fc916a09 | 16 | .\" |
11ad66c2 MW |
17 | .\" TrIPE is distributed in the hope that it will be useful, but WITHOUT |
18 | .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
19 | .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
20 | .\" for more details. | |
fc916a09 MW |
21 | .\" |
22 | .\" You should have received a copy of the GNU General Public License | |
11ad66c2 | 23 | .\" along with TrIPE. If not, see <https://www.gnu.org/licenses/>. |
fc916a09 MW |
24 | . |
25 | .\"-------------------------------------------------------------------------- | |
e99aedcf | 26 | .so ../common/defs.man \" @@@PRE@@@ |
fc916a09 MW |
27 | . |
28 | .\"-------------------------------------------------------------------------- | |
0647ba7c | 29 | .TH tripe-admin 5tripe "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" |
fc916a09 MW |
30 | . |
31 | .\"-------------------------------------------------------------------------- | |
32 | .SH "NAME" | |
33 | . | |
d6623498 | 34 | tripe-admin \- administrator commands for TrIPE |
fc916a09 MW |
35 | . |
36 | .\"-------------------------------------------------------------------------- | |
37 | .SH "DESCRIPTION" | |
38 | . | |
d6623498 | 39 | This manual page describes the administration interface provided by the |
40 | .BR tripe (8) | |
41 | daemon. | |
42 | .PP | |
43 | The | |
44 | .BR tripectl (8) | |
45 | program can be used either interactively or in scripts to communicate | |
46 | with the server using this interface. Alternatively, simple custom | |
47 | clients can be written in scripting languages such as Perl, Python or | |
48 | Tcl, or more advanced clients such as GUI monitors can be written in C | |
49 | with little difficulty. | |
50 | .PP | |
37941236 | 51 | Administration commands use a textual protocol. Each client command or |
52 | server response consists of a line of ASCII text terminated by a single | |
53 | linefeed character. No command may be longer than 255 characters. | |
d6623498 | 54 | .SS "General structure" |
55 | Each command or response line consists of a sequence of | |
83487ded MW |
56 | whitespace-separated tokens. The number and nature of whitespace |
57 | characters separating two tokens in a client command is not significant; | |
58 | the server always uses a single space character. The first token in a | |
d6623498 | 59 | line is a |
60 | .I keyword | |
61 | identifying the type of command or response contained. Keywords in | |
62 | client commands are not case-sensitive; the server always uses uppercase | |
63 | for its keywords. | |
83487ded MW |
64 | .PP |
65 | In order to allow tokens to contain internal whitespace, a quoting | |
66 | mechanism is provided. Whitespace within matched pairs of quotes \(en | |
67 | either single | |
68 | .RB ` ' ' | |
69 | or double | |
70 | .RB ` """" ' | |
71 | \(en is considered to be internal. Any character (other than newline) | |
72 | may be escaped by preceding it with a backslash | |
73 | .RB ` \e ': | |
74 | in particular, this can be used to include quote characters. It is | |
75 | impossible for a token to contain a newline character. | |
76 | .PP | |
77 | On output, the server will use double quotes when necessary. | |
de014da6 | 78 | .SS "Simple commands" |
79 | For simple client command, the server responds with zero or more | |
d6623498 | 80 | .B INFO |
81 | lines, followed by either an | |
82 | .B OK | |
83 | line or a | |
84 | .B FAIL | |
85 | line. Each | |
86 | .B INFO | |
87 | provides information requested in the command. An | |
88 | .B OK | |
89 | response contains no further data. A | |
90 | .B FAIL | |
3cdc3f3a | 91 | code is followed by a machine-readable explanation of why the command |
d6623498 | 92 | failed. |
93 | .PP | |
de014da6 | 94 | Simple command processing is strictly synchronous: the server reads a |
95 | command, processes it, and responds, before reading the next command. | |
96 | All commands can be run as simple commands. Long-running commands | |
97 | (e.g., | |
98 | .B ADD | |
99 | and | |
100 | .BR PING ) | |
101 | block the client until they finish, but the rest of the server continues | |
bdc44f5b MW |
102 | running. See |
103 | .B "Background commands" | |
104 | to find out how to issue long-running commands without blocking. | |
105 | .SS "Asynchronous broadcasts" | |
106 | There are three types of asynchronous broadcast messages which aren't | |
107 | associated with any particular command. Clients can select which | |
108 | broadcast messages they're interested in using the | |
109 | .B WATCH | |
110 | command. | |
de014da6 | 111 | .PP |
112 | The | |
d6623498 | 113 | .B WARN |
3cdc3f3a | 114 | message contains a machine-readable message warning of an error |
d6623498 | 115 | encountered while processing a command, unexpected or unusual behaviour |
116 | by a peer, or a possible attack by an adversary. Under normal | |
de014da6 | 117 | conditions, the server shouldn't emit any warnings. |
118 | .PP | |
119 | The | |
d6623498 | 120 | .B TRACE |
3cdc3f3a | 121 | message contains a human-readable tracing message containing diagnostic |
d6623498 | 122 | information. Trace messages are controlled using the |
123 | .B \-T | |
124 | command-line option to the server, or the | |
125 | .B TRACE | |
126 | administration command (see below). Support for tracing can be disabled | |
127 | when the package is being configured, and may not be available in your | |
de014da6 | 128 | version. |
129 | .PP | |
130 | Finally, the | |
3cdc3f3a | 131 | .B NOTE |
132 | message is a machine-readable notification about some routine but | |
133 | interesting event such as creation or destruction of peers. | |
de014da6 | 134 | .SS "Background commands" |
135 | Some commands (e.g., | |
136 | .B ADD | |
137 | and | |
138 | .BR PING ) | |
139 | take a long time to complete. To prevent these long-running commands | |
140 | from tying up a server connection, they can be run in the background. | |
141 | Not all commands can be run like this: the ones that can provide a | |
142 | .B \-background | |
143 | option, which must be supplied with a | |
144 | .IR tag . | |
145 | .PP | |
146 | A command may fail before it starts running in the background. In this | |
147 | case, the server emits a | |
148 | .B FAIL | |
149 | response, as usual. To indicate that a command has started running in | |
150 | the background, the server emits a response of the form | |
151 | .BI "BGDETACH " tag \fR, | |
152 | where | |
153 | .I tag | |
154 | is the value passed to the | |
155 | .B \-background | |
156 | option. From this point on, the server is ready to process more | |
157 | commands and reply to them. | |
158 | .PP | |
159 | Responses to background commands are indicated by a line beginning with | |
e04c2d50 | 160 | one of the tokens |
de014da6 | 161 | .BR BGOK , |
162 | .BR BGFAIL , | |
163 | or | |
164 | .BR BGINFO , | |
e04c2d50 | 165 | followed by the command tag. These correspond to the |
de014da6 | 166 | .BR OK , |
167 | .BR FAIL , | |
168 | and | |
169 | .B INFO | |
170 | responses for simple commands: | |
171 | .B BGINFO | |
172 | indicates information from a background command which has not completed | |
173 | yet; and | |
174 | .B BGOK | |
175 | and | |
176 | .B BGFAIL | |
177 | indicates that a background command succeeded or failed, respectively. | |
178 | .PP | |
179 | A background command will never issue an | |
180 | .B OK | |
060ca767 | 181 | or |
9df937a3 | 182 | .B INFO |
060ca767 | 183 | response: it will always detach and then issue any |
184 | .B BGINFO | |
185 | lines followed by | |
de014da6 | 186 | .B BGOK |
187 | response. | |
bdc44f5b MW |
188 | .SS "Client-provided services" |
189 | .\"* 25 Service-related messages | |
190 | An administration client can provide services to other clients. | |
191 | Services are given names and versions. A client can attempt to | |
192 | .I claim | |
193 | a particular service by issuing the | |
194 | .B SVCCLAIM | |
195 | command. This may fail, for example, if some other client already | |
196 | provides the same or later version of the service. | |
197 | .PP | |
198 | Other clients can issue | |
199 | .I "service commands" | |
200 | using the | |
201 | .B "SVCSUBMIT" | |
202 | command; the service provider is expected to handle these commands and | |
203 | reply to them. | |
204 | .PP | |
205 | There are three important asynchronous messages which will be sent to | |
206 | service providers. | |
207 | .SP | |
208 | .BI "SVCCANCEL " jobid | |
209 | The named job has been cancelled, either because the issuing client has | |
210 | disconnected or explicitly cancelled the job using the | |
211 | .B BGCANCEL | |
212 | command. | |
213 | .SP | |
214 | .BI "SVCCLAIM " service " " version | |
215 | Another client has claimed a later version of the named | |
9df937a3 MW |
216 | .IR service . |
217 | The recipient is no longer the provider of this service. | |
bdc44f5b MW |
218 | .SP |
219 | .BI "SVCJOB " jobid " " service " " command " " args \fR... | |
220 | Announces the arrival of a new job. The | |
221 | .I jobid | |
222 | is a simple token consisting of alphanumeric characters which | |
223 | .B tripe | |
224 | uses to identify this job. | |
225 | .PP | |
226 | The service provider can reply to the job using the commands | |
227 | .BR SVCINFO , | |
228 | .B SVCOK | |
229 | and | |
230 | .BR SVCFAIL . | |
231 | The first of these sends an | |
232 | .B INFO | |
233 | response and leaves the job active; the other two send an | |
234 | .B OK | |
235 | or | |
236 | .B FAIL | |
237 | response respectively, and mark the job as being complete. | |
238 | .PP | |
239 | (Since | |
240 | .B SVCSUBMIT | |
241 | is a potentially long-running command, it can be run in the background. | |
242 | This detail is hidden from service providers: | |
243 | .B tripe | |
244 | will issue the corresponding | |
245 | .BR BG ... | |
246 | responses when appropriate.) | |
3cdc3f3a | 247 | .SS "Network addresses" |
83487ded | 248 | A network address is a sequence of tokens. The first is a token |
3cdc3f3a | 249 | identifying the network address family. The length of an address and |
83487ded | 250 | the meanings of the subsequent tokens depend on the address family. |
3cdc3f3a | 251 | Address family tokens are not case-sensitive on input; on output, they |
252 | are always in upper-case. | |
253 | .PP | |
870ff51a MW |
254 | The following address families are recognized. |
255 | .TP | |
256 | .BI "ANY " address " \fR[" port \fR] | |
257 | An address and port number for any supported address family. On output, | |
258 | .B tripe | |
259 | never uses this form. On input, the | |
260 | .I address | |
261 | is examined: if it is a numeric address for some recognized address | |
262 | family, then it is interpreted as such; otherwise it is looked up using | |
263 | the DNS (in the background). The background resolver's address-sorting | |
264 | rules apply, and | |
265 | .B tripe | |
266 | simply takes the first address in the returned list which is of a | |
267 | supported address family. Symbolic port numbers are permitted; if | |
268 | omitted, the default port 4070 is used. | |
3cdc3f3a | 269 | .TP |
165efde7 | 270 | .BI "INET " address " \fR[" port \fR] |
3cdc3f3a | 271 | An Internet socket, naming an IPv4 address and UDP port. On output, the |
870ff51a MW |
272 | .I address |
273 | is always in numeric dotted-quad form, and the | |
274 | .I port | |
275 | is given as a plain decimal number. On input, DNS hostnames and | |
276 | symbolic port names are permitted; if omitted, the default port 4070 is | |
277 | used. | |
47828bd9 MW |
278 | .TP |
279 | .BI "INET6 " address " \fR[" port \fR] | |
280 | An Internet socket, naming an IPv6 address and UDP port. On output, the | |
281 | .I address | |
282 | is always in numeric hex-and-colons form, and the | |
283 | .I port | |
284 | is given as a plain decimal number. On input, DNS hostnames and | |
285 | symbolic port names may be permitted, depending on how | |
286 | .B tripe | |
287 | was compiled; if omitted, the default port 4070 is used. | |
3cdc3f3a | 288 | .PP |
78dcf842 | 289 | If, on input, no recognized address family token is found, the following |
83487ded | 290 | tokens are assumed to represent an |
870ff51a | 291 | .B ANY |
2acd7cd6 | 292 | address. Addresses output by the server always have an address family |
870ff51a MW |
293 | token, and do not use |
294 | .BR ANY . | |
295 | .PP | |
296 | Name resolution never blocks the main server, but will block the | |
297 | requesting client, unless the command is run in the background. | |
060ca767 | 298 | .SS "Key-value output" |
299 | Some commands (e.g., | |
300 | .B STATS | |
301 | and | |
302 | .BR SERVINFO ) | |
303 | produce output in the form of | |
304 | .IB key = value | |
83487ded | 305 | pairs, one per token. Neither the |
060ca767 | 306 | .I key |
307 | nor the | |
308 | .I value | |
309 | contain spaces. | |
310 | .SS "Trace lists" | |
311 | Commands which enable or disable kinds of output (e.g., | |
312 | .B TRACE | |
313 | and | |
314 | .BR WATCH ) | |
315 | work in similar ways. They take a single optional argument, which | |
316 | consists of a string of letters selecting message types, optionally | |
317 | interspersed with | |
318 | .RB ` + ' | |
319 | to enable, or | |
320 | .RB ` \- ' | |
321 | to disable, the subsequently listed types. | |
322 | .PP | |
323 | If the argument is omitted, the available message types are displayed, | |
324 | one to an | |
325 | .B INFO | |
326 | line, in a fixed-column format. Column zero contains the key letter for | |
327 | selecting that message type; column one contains either a space or a | |
e04c2d50 | 328 | .RB ` + ' |
060ca767 | 329 | sign, if the message type is disabled or enabled respectively; and a |
330 | textual description of the message type begins at column 3 and continues | |
331 | to the end of the line. | |
332 | .PP | |
333 | Lowercase key letters control individual message types. Uppercase key | |
334 | letters control collections of message types. | |
fc916a09 MW |
335 | . |
336 | .\"-------------------------------------------------------------------------- | |
3cdc3f3a | 337 | .SH "COMMAND REFERENCE" |
fc916a09 | 338 | . |
13a55605 | 339 | .\"* 10 Commands |
d6623498 | 340 | The commands provided are: |
13a55605 | 341 | .SP |
9986f0b5 | 342 | .BI "ADD \fR[" options "\fR] " peer " " address "\fR..." |
3cdc3f3a | 343 | Adds a new peer. The peer is given the name |
344 | .IR peer ; | |
345 | the peer's public key is assumed to be in the file | |
346 | .B keyring.pub | |
347 | (or whatever alternative file was specified in the | |
348 | .B \-K | |
349 | option on the command line). The | |
350 | .I address | |
351 | is the network address (see above for the format) at which the peer can | |
78dcf842 | 352 | be contacted. The following options are recognized. |
42da2a58 | 353 | .RS |
13a55605 | 354 | .\"+opts |
42da2a58 | 355 | .TP |
de014da6 | 356 | .BI "\-background " tag |
357 | Run the command in the background, using the given | |
358 | .IR tag . | |
359 | .TP | |
010e6f63 MW |
360 | .B "\-cork" |
361 | Don't send an immediate challenge to the peer; instead, wait until it | |
362 | sends us something before responding. | |
363 | .TP | |
067aa5f0 MW |
364 | .B "\-ephemeral" |
365 | The association with the peer is not intended to persist indefinitely. | |
366 | If a peer marked as ephemeral is killed, or the | |
367 | .BR tripe (8) | |
368 | daemon is shut down, send a | |
369 | .B bye | |
370 | packet to the peer so that it forgets about us; if a peer marked as | |
371 | ephemeral sends us a | |
372 | .B bye | |
373 | packet then it is killed (but in this case no further | |
374 | .B bye | |
375 | packet is sent). Peers not marked as ephemeral exhibit neither of these | |
376 | behaviours; each peer must have the other marked as ephemeral for the | |
377 | association to be fully torn down if either end kills the other. | |
378 | .TP | |
0ba8de86 | 379 | .BI "\-keepalive " time |
380 | Send a no-op packet if we've not sent a packet to the peer in the last | |
381 | .I time | |
382 | interval. This is useful for persuading port-translating firewalls to | |
383 | believe that the `connection' is still active. The | |
384 | .I time | |
385 | is expressed as a nonnegative integer followed optionally by | |
386 | .BR d , | |
387 | .BR h , | |
388 | .BR m , | |
389 | or | |
390 | .BR s | |
391 | for days, hours, minutes, or seconds respectively; if no suffix is | |
392 | given, seconds are assumed. | |
393 | .TP | |
48b84569 MW |
394 | .BI "\-key " tag |
395 | Use the public key | |
396 | .I tag | |
397 | to authenticate the peer. The default is to use the key tagged | |
398 | .IR peer . | |
399 | .TP | |
8362ac1c MW |
400 | .BI "\-knock \fR[" prefix .\fR] tag |
401 | Send the string | |
402 | .RI [ prefix\fB. ] tag | |
403 | in | |
404 | .B token-rq | |
405 | and | |
406 | .B knock | |
407 | messages to the peer during key-exchange. The string as a whole should | |
408 | name the local machine to the peer, and | |
409 | .I tag | |
410 | should name its public key. When such messages are received from a | |
411 | currently unknown peer, | |
412 | .BR tripe (8) | |
413 | emits a | |
414 | .B KNOCK | |
415 | notification stating the peer's (claimed) name and address. The server | |
416 | will already have verified that the sender is using the peer's private | |
067aa5f0 MW |
417 | key by this point. This option implies |
418 | .BR \-ephemeral . | |
8362ac1c | 419 | .TP |
6411163d MW |
420 | .B "\-mobile" |
421 | The peer is a mobile device, and is likely to change address rapidly. | |
422 | If a packet arrives from an unknown address, the server's usual response | |
423 | is to log a warning and discard it. If the server knows of any mobile | |
424 | peers, however, it will attempt to decrypt the packet using their keys, | |
425 | and if one succeeds, the server will update its idea of the peer's | |
426 | address and emit an | |
427 | .B NEWADDR | |
067aa5f0 MW |
428 | notification. This option implies |
429 | .BR \-ephemeral . | |
6411163d | 430 | .TP |
e1f1a2a0 MW |
431 | .BI "\-priv " tag |
432 | Use the private key | |
433 | .I tag | |
434 | to authenticate to the peer. The default is to use the key named in the | |
435 | .RB ` \-t ' | |
436 | command-line option, or a key with type | |
437 | .B tripe | |
438 | or | |
439 | .BR tripe-dh : | |
440 | see | |
441 | .BR tripe (8) | |
442 | for the details. | |
443 | .TP | |
0ba8de86 | 444 | .BI "\-tunnel " tunnel |
42da2a58 | 445 | Use the named tunnel driver, rather than the default. |
13a55605 | 446 | .\"-opts |
42da2a58 | 447 | .RE |
13a55605 | 448 | .SP |
3cdc3f3a | 449 | .BI "ADDR " peer |
450 | Emits an | |
451 | .B INFO | |
452 | line reporting the IP address and port number stored for | |
453 | .IR peer . | |
13a55605 | 454 | .SP |
35c8b547 | 455 | .BI "ALGS \fR[" peer \fR] |
449991a3 | 456 | Emits information about the cryptographic algorithms in use, in |
35c8b547 MW |
457 | key-value form. If a |
458 | .I peer | |
459 | is given, then describe the algorithms used in the association with that | |
460 | peer; otherwise describe the default algorithms. | |
449991a3 | 461 | .RS |
35c8b547 MW |
462 | .PP |
463 | The keys are as follows. | |
449991a3 MW |
464 | .TP |
465 | .B kx-group | |
466 | Type of key-exchange group in use, currently either | |
467 | .B ec | |
468 | or | |
469 | .BR prime . | |
470 | .TP | |
471 | .B kx-group-order-bits | |
472 | Length of the group order, in bits. This gives an approximate measure | |
473 | of the group strength. | |
474 | .TP | |
475 | .B kx-group-elt-bits | |
476 | Length of a group element, in bits. This may be useful when analyzing | |
477 | protocol traces. | |
478 | .TP | |
479 | .B hash | |
480 | The hash function in use, e.g., | |
481 | .BR sha256 . | |
482 | .TP | |
483 | .B mgf | |
484 | The mask-generating function in use, e.g., | |
485 | .BR whirlpool-mgf . | |
486 | .TP | |
487 | .B hashsz | |
488 | The size of the hash function's output, in octets. | |
489 | .TP | |
a93aacce MW |
490 | .B bulk-transform |
491 | The name of the bulk-crypto transform. | |
492 | .TP | |
493 | .B bulk-overhead | |
494 | The amount of overhead, in bytes, caused by the crypto transform. | |
495 | .TP | |
449991a3 MW |
496 | .B cipher |
497 | The name of the bulk data cipher in use, e.g., | |
498 | .BR blowfish-cbc . | |
499 | .TP | |
500 | .B cipher-keysz | |
501 | The length of key used by the bulk data cipher, in octets. | |
502 | .TP | |
503 | .B cipher-blksz | |
504 | The block size of the bulk data cipher, or zero if it's not based on a | |
505 | block cipher. | |
506 | .TP | |
507 | .B cipher-data-limit | |
508 | The maximum amount of data to be encrypted using a single key. (A new | |
509 | key exchange is instigated well before the limit is reached, in order to | |
510 | allow for a seamless changeover of keys.) | |
511 | .TP | |
512 | .B mac | |
513 | The message authentication algorithm in use, e.g., | |
494a7ac0 | 514 | .BR ripemd160-hmac . |
449991a3 MW |
515 | .TP |
516 | .B mac-keysz | |
517 | The length of the key used by the message authentication algorithm, in | |
518 | octets. | |
519 | .TP | |
520 | .B mac-tagsz | |
521 | The length of the message authentication tag, in octets. | |
b87bffcb MW |
522 | .TP |
523 | .B blkc | |
524 | The block cipher in use, e.g., | |
525 | .BR blowfish . | |
526 | .TP | |
527 | .B blkc-keysz | |
528 | The length of key used by the block cipher, in octets. | |
529 | .TP | |
530 | .B blkc-blksz | |
531 | The block size of the block cipher. | |
449991a3 MW |
532 | .PP |
533 | The various sizes are useful, for example, when computing the MTU for a | |
534 | tunnel interface. If | |
535 | .I MTU | |
536 | is the MTU of the path to the peer, then the tunnel MTU should be | |
537 | .IP | |
538 | .I MTU | |
47828bd9 MW |
539 | \- |
540 | .I header-length | |
541 | \- 9 \- | |
a93aacce | 542 | .I bulk-overhead |
449991a3 | 543 | .PP |
47828bd9 MW |
544 | allowing |
545 | .I header-length | |
546 | = 20 (IPv4) or 40 (IPv6) bytes of IP header, 8 bytes of UDP header, a | |
547 | packet type octet, and the bulk-crypto transform overhead (which | |
548 | includes the sequence number). | |
449991a3 MW |
549 | .RE |
550 | .SP | |
ff92ffd3 MW |
551 | .BI "BGCANCEL " tag |
552 | Cancels the background job with the named | |
553 | .IR tag . | |
554 | .SP | |
37941236 | 555 | .BI "CHECKCHAL " challenge |
556 | Verifies a challenge as being one earlier issued by | |
557 | .B GETCHAL | |
558 | and not previously either passed to | |
559 | .B CHECKCHAL | |
560 | or in a greeting message. | |
13a55605 | 561 | .SP |
3cdc3f3a | 562 | .B "DAEMON" |
563 | Causes the server to disassociate itself from its terminal and become a | |
c37b77e0 | 564 | background task. This only works once. A notification is issued. |
2acd7cd6 | 565 | .SP |
0ba8de86 | 566 | .BI "EPING \fR[" options "\fR] " peer |
567 | Sends an encrypted ping to the peer, and expects an encrypted response. | |
568 | This checks that the peer is running (and not being impersonated), and | |
569 | that it can encrypt and decrypt packets correctly. Options and | |
570 | responses are the same as for the | |
571 | .B PING | |
572 | command. | |
13a55605 | 573 | .SP |
de014da6 | 574 | .BI "FORCEKX " peer |
575 | Requests the server to begin a new key exchange with | |
576 | .I peer | |
577 | immediately. | |
13a55605 | 578 | .SP |
37941236 | 579 | .B "GETCHAL" |
580 | Requests a challenge. The challenge is returned in an | |
581 | .B INFO | |
582 | line, as a base64-encoded string. See | |
583 | .BR CHECKCHAL . | |
13a55605 | 584 | .SP |
37941236 | 585 | .BI "GREET " peer " " challenge |
586 | Sends a greeting packet containing the | |
587 | .I challenge | |
588 | (base-64 encoded) to the named | |
589 | .IR peer . | |
590 | The expectation is that this will cause the peer to recognize us and | |
591 | begin a key-exchange. | |
13a55605 | 592 | .SP |
d6623498 | 593 | .B "HELP" |
594 | Causes the server to emit an | |
595 | .B INFO | |
596 | line for each command it supports. Each line lists the command name, | |
597 | followed by the names of the arguments. This may be helpful as a memory | |
598 | aid for interactive use, or for program clients probing for features. | |
e04c2d50 | 599 | .SP |
3cdc3f3a | 600 | .BI "IFNAME " peer |
601 | Emits an | |
602 | .B INFO | |
603 | line containing the name of the network interface used to collect IP | |
604 | packets which are to be encrypted and sent to | |
605 | .IR peer . | |
606 | Used by configuration scripts so that they can set up routing tables | |
607 | appropriately after adding new peers. | |
13a55605 | 608 | .SP |
ff92ffd3 MW |
609 | .B "JOBS" |
610 | Emits an | |
611 | .B INFO | |
612 | line giving the tag for each outstanding background job. | |
613 | .SP | |
3cdc3f3a | 614 | .BI "KILL " peer |
615 | Causes the server to forget all about | |
616 | .IR peer . | |
617 | All keys are destroyed, and no more packets are sent. No notification | |
618 | is sent to the peer: if it's important that the peer be notified, you | |
619 | must think of a way to do that yourself. | |
13a55605 | 620 | .SP |
3cdc3f3a | 621 | .B "LIST" |
622 | For each currently-known peer, an | |
623 | .B INFO | |
624 | line is written containing the peer's name, as given to | |
625 | .BR ADD . | |
13a55605 | 626 | .SP |
bd58d532 | 627 | .BI "NOTIFY " tokens\fR... |
e04c2d50 | 628 | Issues a |
bd58d532 | 629 | .B USER |
630 | notification to all interested administration clients. | |
13a55605 | 631 | .SP |
060ca767 | 632 | .BI "PEERINFO " peer |
633 | Returns information about a peer, in key-value form. The following keys | |
634 | are returned. | |
635 | .RS | |
636 | .TP | |
637 | .B tunnel | |
638 | The tunnel driver used for this peer. | |
639 | .TP | |
640 | .B keepalive | |
641 | The keepalive interval, in seconds, or zero if no keepalives are to be | |
642 | sent. | |
48b84569 | 643 | .TP |
8362ac1c MW |
644 | .B knock |
645 | If present, the string sent to the peer to set up the association; see | |
646 | the | |
647 | .B \-knock | |
648 | option to | |
649 | .BR ADD , | |
650 | and the | |
651 | .B KNOCK | |
652 | notification. | |
653 | .TP | |
48b84569 | 654 | .B key |
fe2a5dcf | 655 | The (short) key tag being used for the peer, as passed to the |
48b84569 | 656 | .B ADD |
fe2a5dcf MW |
657 | command. |
658 | .TP | |
659 | .B current-key | |
660 | The full key tag of the peer's public key currently being used. This | |
661 | may change during the life of the association. | |
662 | .TP | |
663 | .B private-key | |
664 | The private key tag being used for the peer, as passed to the | |
665 | .B ADD | |
f3c6d21c MW |
666 | command, or the |
667 | .RB ` \-t ' | |
668 | command-line option. If neither of these was given explicitly, the | |
669 | private key tag is shown as | |
670 | .RB ` (default) ', | |
671 | since there is no fixed tag used under these circumstances. | |
fe2a5dcf MW |
672 | .TP |
673 | .B current-private-key | |
674 | The full key tag of the private key currently being used for this | |
675 | association. This may change during the life of the association. | |
bd322830 MW |
676 | .TP |
677 | .B corked | |
678 | Either | |
679 | .B t | |
680 | or | |
681 | .B nil | |
682 | depending on whether or not (respectively) key-exchange is waiting for | |
683 | the peer to initiate. | |
684 | .TP | |
685 | .B mobile | |
686 | Either | |
687 | .B t | |
688 | or | |
689 | .B nil | |
690 | depending on whether or not (respectively) the peer is expected to | |
691 | change its address unpredictably. | |
067aa5f0 MW |
692 | .TP |
693 | .B ephemeral | |
694 | Either | |
695 | .B t | |
696 | or | |
697 | .B nil | |
698 | depending on whether the association with the peer is expected to be | |
699 | temporary or persistent (respectively). | |
060ca767 | 700 | .RE |
13a55605 | 701 | .SP |
0ba8de86 | 702 | .BI "PING \fR[" options "\fR] " peer |
703 | Send a transport-level ping to the peer. The ping and its response are | |
704 | not encrypted or authenticated. This command, possibly in conjunction | |
705 | with tracing, is useful for ensuring that UDP packets are actually | |
706 | flowing in both directions. See also the | |
707 | .B EPING | |
708 | command. | |
709 | .IP | |
710 | An | |
711 | .B INFO | |
712 | line is printed describing the outcome: | |
713 | .RS | |
714 | .TP | |
715 | .BI "ping-ok " millis | |
e04c2d50 | 716 | A response was received |
0ba8de86 | 717 | .I millis |
718 | after the ping was sent. | |
719 | .TP | |
720 | .BI "ping-timeout" | |
721 | No response was received within the time allowed. | |
722 | .TP | |
723 | .BI "ping-peer-died" | |
724 | The peer was killed (probably by another admin connection) before a | |
725 | response was received. | |
726 | .RE | |
727 | .IP | |
728 | Options recognized for this command are: | |
729 | .RS | |
13a55605 | 730 | .\"+opts |
0ba8de86 | 731 | .TP |
de014da6 | 732 | .BI "\-background " tag |
733 | Run the command in the background, using the given | |
734 | .IR tag . | |
735 | .TP | |
0ba8de86 | 736 | .BI "\-timeout " time |
737 | Wait for | |
738 | .I time | |
2acd7cd6 MW |
739 | seconds before giving up on a response. The default is 5 seconds. The |
740 | .I time | |
741 | is expressed as a nonnegative integer followed optionally by | |
742 | .BR d , | |
743 | .BR h , | |
744 | .BR m , | |
745 | or | |
746 | .BR s | |
747 | for days, hours, minutes, or seconds respectively; if no suffix is | |
748 | given, seconds are assumed. | |
13a55605 | 749 | .\"-opts |
0ba8de86 | 750 | .RE |
13a55605 | 751 | .SP |
3cdc3f3a | 752 | .B "PORT" |
5d06f63e | 753 | .RI [ family ] |
3cdc3f3a | 754 | Emits an |
755 | .B INFO | |
756 | line containing just the number of the UDP port used by the | |
757 | .B tripe | |
5d06f63e MW |
758 | server, for the given address |
759 | .I family | |
760 | (or one chosen arbitrarily if omitted -- though | |
761 | .B tripe | |
762 | tries to use the same port number consistently so this is not a likely | |
763 | problem in practice). If you've allowed your server to allocate a port | |
764 | dynamically, this is how to find out which one it chose. | |
13a55605 | 765 | .SP |
de014da6 | 766 | .B "RELOAD" |
767 | Instructs the server to recheck its keyring files. The server checks | |
768 | these periodically anyway but it may be necessary to force a recheck, | |
769 | for example after adding a new peer key. | |
13a55605 | 770 | .SP |
3cdc3f3a | 771 | .B "QUIT" |
772 | Instructs the server to exit immediately. A warning is sent. | |
13a55605 | 773 | .SP |
060ca767 | 774 | .B "SERVINFO" |
775 | Returns information about the server, in the form of key-value pairs. | |
776 | The following keys are used. | |
777 | .RS | |
778 | .TP | |
779 | .B implementation | |
780 | A keyword naming the implementation of the | |
781 | .BR tripe (8) | |
782 | server. The current implementation is called | |
783 | .BR edgeware-tripe . | |
784 | .TP | |
785 | .B version | |
786 | The server's version number, as reported by | |
787 | .BR VERSION . | |
788 | .TP | |
789 | .B daemon | |
790 | Either | |
791 | .B t | |
792 | or | |
793 | .BR nil , | |
794 | if the server has or hasn't (respectively) become a daemon. | |
795 | .RE | |
13a55605 | 796 | .SP |
64cf2223 MW |
797 | .BI "SETIFNAME " peer " " new-name |
798 | Informs the server that the | |
799 | .IR peer 's | |
800 | tunnel-interface name has been changed to | |
801 | .IR new-name . | |
802 | This is useful if firewalling decisions are made based on interface | |
803 | names: a setup script for a particular peer can change the name, and | |
804 | then update the server's records so that they're accurate. | |
805 | .SP | |
405fc4da MW |
806 | .BI "STATS " peer |
807 | Emits a number of | |
808 | .B INFO | |
809 | lines, each containing one or more statistics in the form | |
810 | .IB name = value \fR. | |
811 | The statistics-gathering is experimental and subject to change. | |
812 | .SP | |
bdc44f5b MW |
813 | .BI "SVCCLAIM " service " " version |
814 | Attempts to claim the named | |
815 | .IR service , | |
816 | offering the given | |
817 | .IR version . | |
818 | The claim is successful if the service is currently unclaimed, or if | |
819 | a version earlier than | |
820 | .I version | |
821 | is provided; otherwise the command fails with the error | |
822 | .BR "service-exists" . | |
823 | .SP | |
824 | .BI "SVCENSURE " service " \fR[" version \fR] | |
e04c2d50 | 825 | Ensure that |
bdc44f5b MW |
826 | .I service |
827 | is provided, and (if specified) to at least the given | |
828 | .IR version . | |
829 | An error is reported if these conditions are not met; otherwise the | |
830 | command succeeds silently. | |
831 | .SP | |
832 | .BI "SVCFAIL " jobid " " tokens \fR... | |
833 | Send a | |
834 | .B FAIL | |
835 | (or | |
836 | .BR BGFAIL ) | |
837 | response to the service job with the given | |
838 | .IR jobid , | |
e04c2d50 | 839 | passing the |
bdc44f5b MW |
840 | .I tokens |
841 | as the reason for failure. The job is closed. | |
842 | .SP | |
843 | .BI "SVCINFO " jobid " " tokens \fR... | |
844 | Send an | |
845 | .B INFO | |
846 | (or | |
847 | .BR BGINFO ) | |
848 | response to the service job with the given | |
849 | .IR jobid , | |
850 | passing the | |
851 | .I tokens | |
852 | as the info message. The job remains open. | |
853 | .SP | |
854 | .B "SVCLIST" | |
855 | Output a line of the form | |
856 | .RS | |
857 | .IP | |
858 | .B INFO | |
859 | .I service | |
860 | .I version | |
861 | .PP | |
862 | for each service currently provided. | |
863 | .RE | |
864 | .SP | |
865 | .BI "SVCOK " jobid | |
866 | Send an | |
867 | .B OK | |
868 | (or | |
869 | .BR BGINFO ) | |
870 | response to the service job with the given | |
871 | .IR jobid . | |
872 | The job is closed. | |
873 | .SP | |
874 | .BI "SVCQUERY " service | |
875 | Emits a number of | |
876 | .B info | |
877 | lines in key-value format, describing the named | |
878 | .IR service. | |
879 | The following keys are used. | |
880 | .RS | |
881 | .TP | |
882 | .B name | |
883 | The service's name. | |
884 | .TP | |
885 | .B version | |
886 | The service's version string. | |
887 | .RE | |
888 | .SP | |
889 | .BI "SVCRELEASE " service | |
890 | Announce that the client no longer wishes to provide the named | |
891 | .IR service . | |
892 | .SP | |
893 | .BI "SVCSUBMIT \fR[" options "\fR] " service " " command " " arguments \fR... | |
894 | Submit a job to the provider of the given | |
895 | .IR service , | |
896 | passing it the named | |
897 | .I command | |
898 | and the given | |
899 | .IR arguments . | |
900 | The following options are accepted. | |
901 | .RS | |
902 | .\"+opts | |
903 | .TP | |
904 | .BI "\-background " tag | |
905 | Run the command in the background, using the given | |
906 | .IR tag . | |
907 | .TP | |
908 | .BI "\-version " version | |
909 | Ensure that at least the given | |
910 | .I version | |
911 | of the service is available before submitting the job. | |
912 | .RE | |
913 | .\"-opts | |
914 | .SP | |
d6623498 | 915 | .BR "TRACE " [\fIoptions\fP] |
060ca767 | 916 | Selects trace outputs: see |
e04c2d50 | 917 | .B "Trace lists" |
060ca767 | 918 | above. Message types provided are: |
d6623498 | 919 | .RS |
2d752320 | 920 | .PP |
d6623498 | 921 | Currently, the following tracing options are supported: |
922 | .TP | |
923 | .B t | |
924 | Tunnel events: reception of packets to be encrypted, and injection of | |
925 | successfully-decrypted packets. | |
926 | .TP | |
927 | .B r | |
928 | Peer management events: creation and destruction of peer attachments, | |
929 | and arrival of messages. | |
930 | .TP | |
931 | .B a | |
932 | Administration interface: acceptance of new connections, and handling of | |
933 | the backgroud name-resolution required by the | |
934 | .B ADD | |
935 | command. | |
936 | .TP | |
d6623498 | 937 | .B s |
938 | Handling of symmetric keysets: creation and expiry of keysets, and | |
939 | encryption and decryption of messages. | |
940 | .TP | |
941 | .B x | |
942 | Key exchange: reception, parsing and emission of key exchange messages. | |
943 | .TP | |
944 | .B m | |
945 | Key management: loading keys and checking for file modifications. | |
37941236 | 946 | .TP |
947 | .B l | |
948 | Display information about challenge issuing and verification. | |
949 | .TP | |
950 | .B p | |
951 | Display contents of packets sent and received by the tunnel and/or peer | |
952 | modules. | |
953 | .TP | |
954 | .B c | |
955 | Display inputs, outputs and intermediate results of cryptographic | |
956 | operations. This includes plaintext and key material. Use with | |
957 | caution. | |
958 | .TP | |
959 | .B A | |
960 | All of the above. | |
d6623498 | 961 | .PP |
962 | Note that the | |
963 | .B p | |
964 | (packet contents) | |
965 | and | |
966 | .B c | |
967 | (crypto details) | |
968 | outputs provide extra detail for other outputs. Specifying | |
969 | .B p | |
970 | without | |
37941236 | 971 | .BR r |
d6623498 | 972 | or |
973 | .B t | |
974 | isn't useful; neither is specifying | |
975 | .B c | |
976 | without one of | |
977 | .BR s , | |
37941236 | 978 | .BR l , |
d6623498 | 979 | .B x |
980 | or | |
981 | .BR m . | |
982 | .RE | |
13a55605 | 983 | .SP |
060ca767 | 984 | .B "TUNNELS" |
985 | For each available tunnel driver, an | |
986 | .B INFO | |
987 | line is printed giving its name. | |
13a55605 | 988 | .SP |
060ca767 | 989 | .B "VERSION" |
990 | Causes the server to emit an | |
991 | .B INFO | |
83487ded | 992 | line stating its software version, as two tokens: the server name, and |
060ca767 | 993 | its version string. The server name |
994 | .B tripe | |
995 | is reserved to the Straylight/Edgeware implementation. | |
13a55605 | 996 | .SP |
3cdc3f3a | 997 | .BR "WATCH " [\fIoptions\fP] |
bdc44f5b | 998 | Enables or disables asynchronous broadcasts |
3cdc3f3a | 999 | .IR "for the current connection only" . |
060ca767 | 1000 | See |
e04c2d50 | 1001 | .B "Trace lists" |
3cdc3f3a | 1002 | above. The default watch state for the connection the server opens |
1003 | automatically on stdin/stdout is to show warnings and trace messages; | |
bdc44f5b MW |
1004 | other connections show no asynchronous broadcast messages. (This is |
1005 | done in order to guarantee that a program reading the server's stdout | |
1006 | does not miss any warnings.) | |
3cdc3f3a | 1007 | .RS |
1008 | .PP | |
060ca767 | 1009 | Message types provided are: |
3cdc3f3a | 1010 | .TP |
1011 | .B t | |
1012 | .B TRACE | |
1013 | messages. | |
1014 | .TP | |
1015 | .B n | |
1016 | .B NOTE | |
1017 | messages. | |
1018 | .TP | |
1019 | .B w | |
1020 | .B WARN | |
1021 | messages. | |
1022 | .TP | |
37941236 | 1023 | .B A |
3cdc3f3a | 1024 | All of the above. |
1025 | .RE | |
13a55605 | 1026 | .SP |
bd58d532 | 1027 | .BI "WARN " tokens\fR... |
e04c2d50 | 1028 | Issues a |
bd58d532 | 1029 | .B USER |
1030 | warning to all interested administration clients. | |
fc916a09 MW |
1031 | . |
1032 | .\"-------------------------------------------------------------------------- | |
3cdc3f3a | 1033 | .SH "ERROR MESSAGES" |
fc916a09 | 1034 | . |
13a55605 | 1035 | .\"* 20 Error messages (FAIL codes) |
3cdc3f3a | 1036 | The following |
1037 | .B FAIL | |
de014da6 | 1038 | (or |
1039 | .BR BGFAIL ) | |
3cdc3f3a | 1040 | messages are sent to clients as a result of errors during command |
1041 | processing. | |
13a55605 | 1042 | .SP |
3cdc3f3a | 1043 | .BI "already-daemon" |
1044 | (For | |
1045 | .BR DAEMON .) | |
1046 | The | |
1047 | .B tripe | |
1048 | server is already running as a daemon. | |
13a55605 | 1049 | .SP |
f43df819 | 1050 | .BI "bad-addr-syntax " message |
37941236 | 1051 | (For commands accepting socket addresses.) The address couldn't be |
1052 | understood. | |
13a55605 | 1053 | .SP |
37d4c59e MW |
1054 | .BI "bad-base64 " message |
1055 | (For commands accepting Base64-encoded input.) The Base64-encoded | |
1056 | string was invalid. | |
1057 | .SP | |
f43df819 | 1058 | .BI "bad-syntax " cmd " " message |
3cdc3f3a | 1059 | (For any command.) The command couldn't be understood: e.g., the number |
1060 | of arguments was wrong. | |
13a55605 | 1061 | .SP |
83487ded | 1062 | .BI "bad-time-spec " token |
0ba8de86 | 1063 | The |
83487ded | 1064 | .I token |
0ba8de86 | 1065 | is not a valid time interval specification. Acceptable time |
e04c2d50 | 1066 | specifications are nonnegative integers followed optionally by |
0ba8de86 | 1067 | .BR d , |
1068 | .BR h , | |
1069 | .BR m , | |
1070 | or | |
1071 | .BR s , | |
1072 | for days, hours, minutes, or seconds, respectively. | |
13a55605 | 1073 | .SP |
3cdc3f3a | 1074 | .BI "bad-trace-option " char |
1075 | (For | |
1076 | .BR TRACE .) | |
1077 | An unknown trace option was requested. | |
13a55605 | 1078 | .SP |
3cdc3f3a | 1079 | .BI "bad-watch-option " char |
1080 | (For | |
1081 | .BR WATCH .) | |
1082 | An unknown watch option was requested. | |
13a55605 | 1083 | .SP |
f43df819 | 1084 | .BI "daemon-error " ecode " " message |
3cdc3f3a | 1085 | (For |
1086 | .BR DAEMON .) | |
1087 | An error occurred during the attempt to become a daemon, as reported by | |
1088 | .IR message . | |
13a55605 | 1089 | .SP |
47828bd9 MW |
1090 | .BI "disabled-address-family " afam |
1091 | (For | |
1092 | .B ADD | |
1093 | and | |
1094 | .BR PORT .) | |
1095 | The address family | |
1096 | .I afam | |
1097 | is supported, but was disabled using command-line arguments. | |
1098 | .SP | |
3cdc3f3a | 1099 | .BI "invalid-port " number |
1100 | (For | |
1101 | .BR ADD .) | |
1102 | The given port number is out of range. | |
13a55605 | 1103 | .SP |
bdc44f5b | 1104 | .BI "not-service-provider " service |
e04c2d50 | 1105 | (For |
bdc44f5b MW |
1106 | .BR SVCRELEASE .) |
1107 | The invoking client is not the current provider of the named | |
1108 | .IR service , | |
1109 | and is therefore not allowed to release it. | |
1110 | .SP | |
3cdc3f3a | 1111 | .BI "peer-create-fail " peer |
1112 | (For | |
1113 | .BR ADD .) | |
1114 | Adding | |
1115 | .I peer | |
1116 | failed for some reason. A warning should have been emitted explaining | |
1117 | why. | |
13a55605 | 1118 | .SP |
c8e02c8a MW |
1119 | .BI "peer-addr-exists " address\fR... |
1120 | (For | |
1121 | .BR ADD .) | |
1122 | There is already a peer with the given | |
1123 | .IR address . | |
1124 | .SP | |
3cdc3f3a | 1125 | .BI "peer-exists " peer |
1126 | (For | |
1127 | .BR ADD .) | |
1128 | There is already a peer named | |
d6623498 | 1129 | .IR peer . |
13a55605 | 1130 | .SP |
0ba8de86 | 1131 | .B "ping-send-failed" |
1132 | The attempt to send a ping packet failed, probably due to lack of | |
1133 | encryption keys. | |
13a55605 | 1134 | .SP |
75566d17 MW |
1135 | .B "provider-failed" |
1136 | (For | |
1137 | .BR SVCSUBMIT .) | |
1138 | The service provider disconnected without sending back a final reply to | |
1139 | the job. | |
1140 | .SP | |
1141 | .B "provider-overloaded" | |
1142 | (For | |
1143 | .BR SVCSUBMIT .) | |
1144 | The service provider has too many jobs queued up for it already. | |
1145 | .SP | |
3cdc3f3a | 1146 | .BI "resolve-error " hostname |
1147 | (For | |
1148 | .BR ADD .) | |
1149 | The DNS name | |
1150 | .I hostname | |
1151 | could not be resolved. | |
13a55605 | 1152 | .SP |
3cdc3f3a | 1153 | .BI "resolver-timeout " hostname |
1154 | (For | |
1155 | .BR ADD .) | |
1156 | The DNS name | |
1157 | .I hostname | |
1158 | took too long to resolve. | |
13a55605 | 1159 | .SP |
bdc44f5b MW |
1160 | .BI "service-exists " service " " version |
1161 | (For | |
1162 | .BR SVCCLAIM .) | |
1163 | Another client is already providing the stated | |
1164 | .I version | |
1165 | of the | |
1166 | .IR service . | |
1167 | .SP | |
1168 | .BI "service-too-old " service " " version | |
1169 | (For | |
1170 | .B SVCENSURE | |
1171 | and | |
1172 | .BR SVCSUBMIT .) | |
1173 | Only the given | |
1174 | .I version | |
1175 | of the requested | |
1176 | .I service | |
1177 | is available, which does not meet the stated requirements. | |
1178 | .SP | |
ff92ffd3 MW |
1179 | .BI "tag-exists " tag |
1180 | (For long-running commands.) The named | |
1181 | .I tag | |
1182 | is already the tag of an outstanding job. | |
1183 | .SP | |
5d06f63e MW |
1184 | .BI "unknown-address-family " afam |
1185 | (For | |
1186 | .BR PORT .) | |
1187 | The address family | |
1188 | .I afam | |
1189 | is unrecognized. | |
1190 | .SP | |
3cdc3f3a | 1191 | .BI "unknown-command " token |
1192 | The command | |
9df937a3 | 1193 | .I token |
78dcf842 | 1194 | was not recognized. |
13a55605 | 1195 | .SP |
72482dfa MW |
1196 | .BI "unknown-jobid " jobid |
1197 | (For | |
1198 | .BR SVCOK , | |
1199 | .BR SVCFAIL , | |
1200 | and | |
1201 | .BR SVCINFO .) | |
1202 | The token | |
1203 | .I jobid | |
1204 | is not recognized as identifying an outstanding job. It may have just | |
1205 | been cancelled. | |
1206 | .SP | |
3cdc3f3a | 1207 | .BI "unknown-peer " name |
1208 | (For | |
1209 | .BR ADDR , | |
1210 | .BR IFNAME , | |
1211 | .BR KILL , | |
64cf2223 | 1212 | .BR SETIFNAME , |
3cdc3f3a | 1213 | and |
1214 | .BR STATS .) | |
1215 | There is no peer called | |
1216 | .IR name . | |
13a55605 | 1217 | .SP |
fd68efa9 | 1218 | .BI "unknown-port " port |
3cdc3f3a | 1219 | (For |
1220 | .BR ADD .) | |
fd68efa9 MW |
1221 | The port name |
1222 | .I port | |
e04c2d50 | 1223 | couldn't be found in |
3cdc3f3a | 1224 | .BR /etc/services . |
dad7eebc | 1225 | .SP |
bdc44f5b MW |
1226 | .BI "unknown-service " service |
1227 | (For | |
1228 | .BR SVCENSURE , | |
1229 | .BR SVCQUERY , | |
1230 | .BR SVCRELEASE , | |
1231 | and | |
1232 | .BR SVCSUBMIT .) | |
1233 | The token | |
1234 | .I service | |
1235 | is not recognized as the name of a client-provided service. | |
dad7eebc | 1236 | .SP |
ff92ffd3 MW |
1237 | .BI "unknown-tag " tag |
1238 | (For | |
1239 | .BR BGCANCEL .) | |
1240 | The given | |
1241 | .I tag | |
1242 | is not the tag for any outstanding background job. It may have just | |
1243 | finished. | |
75566d17 MW |
1244 | .SP |
1245 | .BI "unknown-tunnel " tun | |
1246 | (For | |
1247 | .BR ADD .) | |
1248 | The given | |
1249 | .I tun | |
1250 | is not the name of any known tunnel driver. | |
fc916a09 MW |
1251 | . |
1252 | .\"-------------------------------------------------------------------------- | |
3cdc3f3a | 1253 | .SH "NOTIFICATIONS" |
fc916a09 | 1254 | . |
13a55605 | 1255 | .\"* 30 Notification broadcasts (NOTE codes) |
3cdc3f3a | 1256 | The following notifications are sent to clients who request them. |
13a55605 | 1257 | .SP |
42da2a58 | 1258 | .BI "ADD " peer " " ifname " " address \fR... |
3cdc3f3a | 1259 | A new peer has been added. The peer's name is |
42da2a58 | 1260 | .IR peer , |
1261 | its tunnel is network interface | |
1262 | .IR ifname , | |
3cdc3f3a | 1263 | and its network address is |
1264 | .IR address . | |
13a55605 | 1265 | .SP |
3cdc3f3a | 1266 | .BI "DAEMON" |
1267 | The server has forked off into the sunset and become a daemon. | |
13a55605 | 1268 | .SP |
37941236 | 1269 | .BI "GREET " challenge " " address \fR... |
1270 | A valid greeting was received, with the given challenge (exactly as it | |
1271 | was returned by | |
1272 | .B GETCHAL | |
1273 | earlier). | |
13a55605 | 1274 | .SP |
d6623498 | 1275 | .BI "KILL " peer |
3cdc3f3a | 1276 | The peer |
1277 | .I peer | |
1278 | has been killed. | |
13a55605 | 1279 | .SP |
8362ac1c MW |
1280 | .BI "KNOCK " peer " " address |
1281 | The currently unknown | |
1282 | .I peer | |
1283 | is attempting to connect from | |
1284 | .IR address . | |
1285 | .SP | |
3cdc3f3a | 1286 | .BI "KXDONE " peer |
1287 | Key exchange with | |
1288 | .I peer | |
1289 | finished successfully. | |
13a55605 | 1290 | .SP |
3cdc3f3a | 1291 | .BI "KXSTART " peer |
1292 | Key exchange with | |
1293 | .I peer | |
1294 | has begun or restarted. If key exchange keeps failing, this message | |
1295 | will be repeated periodically. | |
13a55605 | 1296 | .SP |
6411163d MW |
1297 | .BI "NEWADDR " peer " " address |
1298 | The given mobile | |
1299 | .IR peer 's | |
1300 | IP address has been changed to | |
1301 | .IR address . | |
1302 | .SP | |
64cf2223 MW |
1303 | .BI "NEWIFNAME " peer " " old-name " " new-name |
1304 | The given | |
1305 | .IR peer 's | |
1306 | tunnel interface name has been changed from | |
1307 | .I old-name | |
1308 | to | |
1309 | .IR new-name , | |
1310 | as a result of a | |
1311 | .B SETIFNAME | |
1312 | command. | |
1313 | .SP | |
bdc44f5b MW |
1314 | .BI "SVCCLAIM " service " " version |
1315 | The named | |
1316 | .I service | |
1317 | is now available, at the stated | |
1318 | .IR version . | |
1319 | .SP | |
1320 | .BI "SVCRELEASE " service | |
1321 | The named | |
1322 | .I service | |
1323 | is no longer available. | |
1324 | .SP | |
bd58d532 | 1325 | .BI "USER " tokens\fR... |
1326 | An administration client issued a notification using the | |
1327 | .B NOTIFY | |
1328 | command. | |
fc916a09 MW |
1329 | . |
1330 | .\"-------------------------------------------------------------------------- | |
3cdc3f3a | 1331 | .SH "WARNINGS" |
fc916a09 | 1332 | . |
13a55605 MW |
1333 | .\"* 40 Warning broadcasts (WARN codes) |
1334 | .\"+sep | |
3cdc3f3a | 1335 | There are many possible warnings. They are categorized according to |
1336 | their first tokens. | |
f43df819 MW |
1337 | .PP |
1338 | Many of these warnings report system errors. These are reported as a | |
1339 | pair of tokens, described below as | |
1340 | .I ecode | |
1341 | and | |
1342 | .IR message . | |
1343 | The | |
1344 | .I ecode | |
1345 | is a string of the form | |
1346 | .BI E number | |
1347 | giving the | |
1348 | .BR errno (3) | |
1349 | value of the error; the | |
1350 | .I message | |
1351 | is the `human-readable' form of the message, as reported by | |
1352 | .BR strerror (3). | |
3cdc3f3a | 1353 | .SS "ABORT warnings" |
1354 | These all indicate that the | |
d6623498 | 1355 | .B tripe |
3cdc3f3a | 1356 | server has become unable to continue. If enabled, the server will dump |
1357 | core in its configuration directory. | |
13a55605 | 1358 | .SP |
3cdc3f3a | 1359 | .BI "ABORT repeated-select-errors" |
1360 | The main event loop is repeatedly failing. If the server doesn't quit, | |
1361 | it will probably waste all available CPU doing nothing. | |
ac3a27f5 MW |
1362 | .SP |
1363 | .BI "ABORT hash-size-too-large hash " name " size " sz " limit " max | |
1364 | An internal inconsistency: the hash function | |
1365 | .I name | |
1366 | produces a | |
1367 | .IR sz -byte | |
1368 | hash, but the server has been compiled to assume that no hash function | |
1369 | returns more than | |
1370 | .I max | |
1371 | bytes. | |
3cdc3f3a | 1372 | .SS "ADMIN warnings" |
1373 | These indicate a problem with the administration socket interface. | |
13a55605 | 1374 | .SP |
f43df819 | 1375 | .BI "ADMIN accept-error " ecode " " message |
3cdc3f3a | 1376 | There was an error while attempting to accept a connection from a new |
1377 | client. | |
13a55605 | 1378 | .SP |
f43df819 | 1379 | .BI "ADMIN client-write-error " ecode " " message |
3cdc3f3a | 1380 | There was an error sending data to a client. The connection to the |
1381 | client has been closed. | |
5ae728a6 MW |
1382 | .SP |
1383 | .BI "ADMIN admin-socket " path " already-in-use" | |
1384 | The server failed to create the Unix-domain socket object in the | |
1385 | filesystem, because there's already a socket there, and some other | |
1386 | process is actively listening for incoming connections. | |
1387 | .SP | |
1388 | .BI "ADMIN admin-socket " path " bind-failed " ecode " " message | |
1389 | The server failed to create the Unix-domain socket object in the | |
1390 | filesystem for an unusual reason. (The usual reason is | |
1391 | .BR EADDRINUSE , | |
1392 | but this is handled specially.) | |
1393 | .SP | |
1394 | .BI "ADMIN admin-socket " path " chmod-failed " ecode " " message | |
1395 | The server failed to set the correct permissions of the Unix-domain | |
1396 | socket object. | |
1397 | .SP | |
1398 | .BI "ADMIN admin-socket " path " chown-failed " ecode " " message | |
1399 | The server failed to set the correct ownership of the Unix-domain socket | |
1400 | object. | |
1401 | .SP | |
1402 | .BI "ADMIN admin-socket " path " create-failed " ecode " " message | |
1403 | The server failed to create its administration socket. This is usually | |
1404 | because some system resource is unavailable. | |
1405 | .SP | |
1406 | .BI "ADMIN admin-socket " path " listen-failed " ecode " " message | |
1407 | The server failed to arrange to receive incoming connections on its | |
1408 | Unix-domain socket. | |
1409 | .SP | |
1410 | .BI "ADMIN admin-socket " path " name-too-long" | |
1411 | The server can't create its administration socket, because the chosen | |
1412 | pathname | |
1413 | .I path | |
1414 | is too long. There is, for historical reasons, a rather tight limit on | |
1415 | the length of name permitted for Unix-domain sockets, usually around 108 | |
1416 | bytes. | |
1417 | .SP | |
1418 | .BI "ADMIN admin-socket " path " stat-failed " ecode " " message | |
1419 | The server failed to create the Unix-domain socket object in the | |
1420 | filesystem, because there's already something there, but the server | |
1421 | couldn't discover what. | |
1422 | .SP | |
1423 | .BI "ADMIN admin-socket " path " too-many-retries" | |
1424 | The server failed to create the Unix-domain socket object in the | |
1425 | filesystem. This error indicates that another process is also | |
1426 | repeatedly trying to create a Unix-domain socket at the same | |
1427 | .IR path , | |
1428 | and then failing to actually listen for connections on it, but the | |
1429 | server always loses the applicable race for some reason. This situation | |
1430 | merits investigation. | |
1431 | .SP | |
1432 | .BI "ADMIN adns-init-failed " ecode " " message | |
1433 | The server failed to initialize the ADNS asynchronous DNS-resolution | |
1434 | library. | |
37941236 | 1435 | .SS "CHAL warnings" |
1436 | These indicate errors in challenges, either in the | |
1437 | .B CHECKCHAL | |
1438 | command or in greeting packets. | |
13a55605 | 1439 | .SP |
37941236 | 1440 | .B "CHAL impossible-challenge" |
1441 | The server hasn't issued any challenges yet. Quite how anyone else | |
1442 | thought he could make one up is hard to imagine. | |
13a55605 | 1443 | .SP |
37941236 | 1444 | .B "CHAL incorrect-tag" |
1445 | Challenge received contained the wrong authentication data. It might be | |
1446 | very stale, or a forgery. | |
13a55605 | 1447 | .SP |
37941236 | 1448 | .B "CHAL invalid-challenge" |
1449 | Challenge received was the wrong length. We might have changed MAC | |
1450 | algorithms since the challenge was issued, or it might just be rubbish. | |
13a55605 | 1451 | .SP |
37941236 | 1452 | .B "CHAL replay duplicated-sequence" |
1453 | Challenge received was a definite replay of an old challenge. Someone's | |
1454 | up to something! | |
13a55605 | 1455 | .SP |
37941236 | 1456 | .B "CHAL replay old-sequence" |
1457 | Challenge received was old, but maybe not actually a replay. Try again. | |
3cdc3f3a | 1458 | .SS "KEYMGMT warnings" |
1459 | These indicate a problem with the keyring files, or the keys stored in | |
4d36660a MW |
1460 | them. The first token is either |
1461 | .B private-keyring | |
1462 | or | |
1463 | .B public-keyring | |
1464 | (notated | |
1465 | .IB which -keyring | |
1466 | in the descriptions below) indicating which keyring file is problematic, | |
1467 | and the second token is the filename of the keyring. Frequently a key | |
1468 | tag may be given next, preceded by the token | |
1469 | .BR key . | |
1470 | .SP | |
f1d5c891 MW |
1471 | .BI "KEYMGMT private-keyring " file " key " tag " incorrect-public-key" |
1472 | The private key doesn't record the correct corresponding public key. | |
1473 | .SP | |
4d36660a MW |
1474 | .BI "KEYMGMT public-keyring " file " key " tag " algorithm-mismatch" |
1475 | A peer's public key doesn't request the same algorithms as our private | |
1476 | key. | |
1477 | .SP | |
1478 | .BI "KEYMGMT " which "-keyring " file " key " tag " bad-tag-length " len | |
1479 | The key attributes specify the length of MAC tag as | |
1480 | .I len | |
1481 | but this is an invalid value \(en either too large or not a multiple of | |
1482 | eight. | |
1483 | .SP | |
1484 | .BI "KEYMGMT " which "-keyring " file " key " tag " bad-tag-length-string " str | |
1485 | The key attributes contain | |
1486 | .I str | |
1487 | where a MAC tag length was expected. The key was generated wrongly. | |
1488 | .SP | |
1489 | .BI "KEYMGMT private-keyring " file " key " tag " changed-group" | |
1490 | The private keyring has been changed, but the new private key can't be | |
1491 | used because it uses a different group for Diffie\(enHellman key | |
1492 | exchange. | |
1493 | .SP | |
1494 | .BI "KEYMGMT " which "-keyring " file " io-error " ecode " " message | |
1495 | A system error occurred while opening or reading the keyring file. | |
1496 | .SP | |
a93aacce MW |
1497 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-bulk-transform " bulk |
1498 | The key specifies the use of an unknown bulk-crypto transform | |
1499 | .IR bulk . | |
1500 | Maybe the key was generated wrongly, or maybe the version of Catacomb | |
1501 | installed is too old. | |
1502 | .SP | |
4d36660a MW |
1503 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-cipher " cipher |
1504 | The key specifies the use of an unknown symmetric encryption algorithm | |
1505 | .IR cipher . | |
1506 | Maybe the key was generated wrongly, or maybe the version of | |
1507 | Catacomb installed is too old. | |
1508 | .SP | |
1509 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-group-type " type | |
1510 | The key specifies the use of a Diffie\(enHellman group of an unknown | |
1511 | .IR type . | |
1512 | Maybe the key was generated wrongly, or maybe the version of | |
1513 | .BR tripe (8) | |
1514 | is too old. | |
1515 | .SP | |
1516 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-hash " hash | |
1517 | The key specifies the use of an unknown hash function | |
1518 | .IR hash . | |
1519 | Maybe the key was generated wrongly, or maybe the version of Catacomb | |
1520 | installed is too old. | |
1521 | .SP | |
1522 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-mac " mac | |
1523 | The key specifies the use of an unknown message authentication code | |
1524 | .IR mac . | |
1525 | Maybe the key was generated wrongly, or maybe the version of Catacomb | |
1526 | installed is too old. | |
1527 | .SP | |
1528 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-mgf-cipher " mgf | |
1529 | The key specifies the use of an unknown symmetric encryption function | |
1530 | .I mgf | |
1531 | for mask generation. Maybe the key was generated wrongly, or maybe the | |
1532 | version of Catacomb installed is too old. | |
1533 | .SP | |
07bdda1f MW |
1534 | .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-serialization-format " ser |
1535 | The key specifies the use of an unknown serialization format | |
1536 | .I ser | |
1537 | for hashing group elements. Maybe the key was generated wrongly, or | |
1538 | maybe the version of Catacomb installed is too old. | |
1539 | .SP | |
4d36660a MW |
1540 | .BI "KEYMGMT " which "-keyring " file " key " tag " no-hmac-for-hash " hash |
1541 | No message authentication code was given explicitly, and there's no | |
1542 | implementation of HMAC for the selected hash function | |
1543 | .IR hash . | |
1544 | .SP | |
1545 | .BI "KEYMGMT " which "-keyring " file " key " tag " " alg " " name " no-key-size " hashsz | |
1546 | The | |
1547 | .I alg | |
1548 | token is either | |
1549 | .B cipher | |
1550 | or | |
1551 | .BR mac . | |
1552 | The named algorithm requires more key material than the hash function | |
1553 | can provide. You must change either the hash function, or the cipher or | |
1554 | MAC. | |
13a55605 | 1555 | .SP |
4d36660a MW |
1556 | .BI "KEYMGMT " which "-keyring " file " key " tag " mgf " mgf " restrictive-key-schedule" |
1557 | The cipher selected for mask-generation is unsuitable because it can't | |
1558 | accept arbitrary-sized keys. | |
13a55605 | 1559 | .SP |
4d36660a MW |
1560 | .BI "KEYMGMT " which "-keyring " file " key-not-found " tag |
1561 | A key named | |
3cdc3f3a | 1562 | .I tag |
4d36660a | 1563 | couldn't be found in the keyring. |
13a55605 | 1564 | .SP |
fb6a9f13 MW |
1565 | .BI "KEYMGMT " which "-keyring " file " unknown-key-id 0x" keyid |
1566 | A key with the given | |
1567 | .I keyid | |
1568 | (in hex) was requested but not found. | |
1569 | .SP | |
4d36660a MW |
1570 | .BI "KEYMGMT " which "-keyring " file " line " line " " message |
1571 | The contents of the keyring file are invalid. There may well be a bug | |
1572 | in the | |
1573 | .BR key (1) | |
1574 | program. | |
3cdc3f3a | 1575 | .SS "KX warnings" |
1576 | These indicate problems during key-exchange. Many indicate either a bug | |
1577 | in the server (either yours or the remote one), or some kind of attack | |
1578 | in progress. All name a | |
1579 | .I peer | |
1580 | as the second token: this is the peer the packet is apparently from, | |
1581 | though it may have been sent by an attacker instead. | |
1582 | .PP | |
1583 | In the descriptions below, | |
1584 | .I msgtoken | |
1585 | is one of the tokens | |
1586 | .BR pre-challenge , | |
1587 | .BR cookie , | |
1588 | .BR challenge , | |
1589 | .BR reply , | |
1590 | .BR switch-rq , | |
3cdc3f3a | 1591 | .BR switch-ok . |
8362ac1c MW |
1592 | .BR token-rq , |
1593 | .BR token , | |
1594 | or | |
1595 | .BR knock . | |
13a55605 | 1596 | .SP |
35c8b547 MW |
1597 | .BI "KX " peer " algorithms-mismatch local-private-key " privtag " peer-public-key " pubtag |
1598 | The algorithms specified in the peer's public key | |
1599 | .I pubtag | |
1600 | don't match the ones described in the private key | |
1601 | .IR privtag . | |
1602 | .SP | |
3cdc3f3a | 1603 | .BI "KX " peer " bad-expected-reply-log" |
1604 | The challenges | |
1605 | .B tripe | |
1606 | uses in its protocol contain a check value which proves that the | |
1607 | challenge is honest. This message indicates that the check value | |
1608 | supplied is wrong: someone is attempting to use bogus challenges to | |
1609 | persuade your | |
1610 | .B tripe | |
1611 | server to leak private key information. No chance! | |
13a55605 | 1612 | .SP |
bd58d532 | 1613 | .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok" |
3cdc3f3a | 1614 | A symmetrically-encrypted portion of a key-exchange message failed to |
1615 | decrypt. | |
13a55605 | 1616 | .SP |
3cdc3f3a | 1617 | .BI "KX " peer " invalid " msgtoken |
1618 | A key-exchange message was malformed. This almost certainly indicates a | |
1619 | bug somewhere. | |
13a55605 | 1620 | .SP |
bd58d532 | 1621 | .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok" |
3cdc3f3a | 1622 | A message didn't contain the right magic data. This may be a replay of |
1623 | some old exchange, or random packets being sent in an attempt to waste | |
1624 | CPU. | |
13a55605 | 1625 | .SP |
35c8b547 MW |
1626 | .BI "KX " peer " " which "-key-expired" |
1627 | The local private key or the peer's public key (distinguished by | |
1628 | .IR which ) | |
1629 | has expired. Either you or the peer's maintainer should have arranged | |
1630 | for a replacement before now. | |
13a55605 | 1631 | .SP |
3cdc3f3a | 1632 | .BI "KX " peer " sending-cookie" |
1633 | We've received too many bogus pre-challenge messages. Someone is trying | |
1634 | to flood us with key-exchange messages and make us waste CPU on doing | |
1635 | hard asymmetric crypto sums. | |
13a55605 | 1636 | .SP |
3cdc3f3a | 1637 | .BI "KX " peer " unexpected " msgtoken |
1638 | The message received wasn't appropriate for this stage of the key | |
1639 | exchange process. This may mean that one of our previous packets got | |
e04c2d50 | 1640 | lost. For |
3cdc3f3a | 1641 | .BR pre-challenge , |
1642 | it may simply mean that the peer has recently restarted. | |
13a55605 | 1643 | .SP |
3cdc3f3a | 1644 | .BI "KX " peer " unknown-challenge" |
1645 | The peer is asking for an answer to a challenge which we don't know | |
1646 | about. This may mean that we've been inundated with challenges from | |
1647 | some malicious source | |
1648 | .I who can read our messages | |
1649 | and discarded the valid one. | |
13a55605 | 1650 | .SP |
3cdc3f3a | 1651 | .BI "KX " peer " unknown-message 0x" nn |
1652 | An unknown key-exchange message arrived. | |
1653 | .SS "PEER warnings" | |
1654 | These are largely concerned with management of peers and the low-level | |
83487ded | 1655 | details of the network protocol. The second token is usually the name of |
e04c2d50 | 1656 | a peer, or |
3cdc3f3a | 1657 | .RB ` \- ' |
1658 | if none is relevant. | |
13a55605 | 1659 | .SP |
3cdc3f3a | 1660 | .BI "PEER " peer " bad-packet no-type" |
1661 | An empty packet arrived. This is very strange. | |
13a55605 | 1662 | .SP |
3cdc3f3a | 1663 | .BI "PEER " peer " bad-packet unknown-category 0x" nn |
1664 | The message category | |
1665 | .I nn | |
1666 | (in hex) isn't understood. Probably a strange random packet from | |
1667 | somewhere; could be an unlikely bug. | |
13a55605 | 1668 | .SP |
3cdc3f3a | 1669 | .BI "PEER " peer " bad-packet unknown-type 0x" nn |
1670 | The message type | |
1671 | .I nn | |
1672 | (in hex) isn't understood. Probably a strange random packet from | |
1673 | somewhere; could be an unlikely bug. | |
13a55605 | 1674 | .SP |
0ba8de86 | 1675 | .BI "PEER " peer " corrupt-encrypted-ping" |
1676 | The peer sent a ping response which matches an outstanding ping, but its | |
1677 | payload is wrong. There's definitely a bug somewhere. | |
13a55605 | 1678 | .SP |
0ba8de86 | 1679 | .BI "PEER " peer " corrupt-transport-ping" |
1680 | The peer (apparently) sent a ping response which matches an outstanding | |
1681 | ping, but its payload is wrong. Either there's a bug, or the bad guys | |
1682 | are playing tricks on you. | |
13a55605 | 1683 | .SP |
3cdc3f3a | 1684 | .BI "PEER " peer " decrypt-failed" |
1685 | An encrypted IP packet failed to decrypt. It may have been mangled in | |
1686 | transit, or may be a very old packet from an expired previous session | |
1687 | key. There is usually a considerable overlap in the validity periods of | |
1688 | successive session keys, so this shouldn't occur unless the key exchange | |
1689 | takes ages or fails. | |
13a55605 | 1690 | .SP |
0ba8de86 | 1691 | .BI "PEER " peer " malformed-encrypted-ping" |
1692 | The peer sent a ping response which is hopelessly invalid. There's | |
1693 | definitely a bug somewhere. | |
13a55605 | 1694 | .SP |
0ba8de86 | 1695 | .BI "PEER " peer " malformed-transport-ping" |
1696 | The peer (apparently) sent a ping response which is hopelessly invalid. | |
1697 | Either there's a bug, or the bad guys are playing tricks on you. | |
13a55605 | 1698 | .SP |
3cdc3f3a | 1699 | .BI "PEER " peer " packet-build-failed" |
1700 | There wasn't enough space in our buffer to put the packet we wanted to | |
1701 | send. Shouldn't happen. | |
13a55605 | 1702 | .SP |
f43df819 | 1703 | .BI "PEER \- socket-read-error " ecode " " message |
3cdc3f3a | 1704 | An error occurred trying to read an incoming packet. |
13a55605 | 1705 | .SP |
f43df819 | 1706 | .BI "PEER " peer " socket-write-error " ecode " " message |
3cdc3f3a | 1707 | An error occurred attempting to send a network packet. We lost that |
1708 | one. | |
13a55605 | 1709 | .SP |
56c76774 MW |
1710 | .BI "PEER " address\fR... " disabled-address-family" |
1711 | An attempt was made to send a packet to an address for which support was | |
1712 | switched off by command-line options. | |
1713 | .SP | |
8362ac1c MW |
1714 | .BI "PEER " address\fR... " socket-write-error " ecode " " message |
1715 | An error occurred attempting to send a network packet. We lost that | |
1716 | one. | |
1717 | .SP | |
5ae728a6 MW |
1718 | .BI "PEER \- udp-socket " address-family " bind-failed " ecode " " message |
1719 | The server failed to associate a UDP socket with a local address. | |
1720 | .SP | |
1721 | .BI "PEER \- udp-socket " address-family " create-failed " ecode " " message | |
1722 | The server failed to create a UDP socket for the | |
1723 | .IR address-family . | |
1724 | .SP | |
1725 | .BI "PEER \- udp-socket " address-family " read-local-address-failed " ecode " " message | |
1726 | The server failed to discover the local address for one of its own UDP | |
1727 | sockets. | |
1728 | .SP | |
1729 | .BI "PEER \- udp-socket " address-family " set-buffers-failed " ecode " " message | |
1730 | The server failed to configure appropriate buffer sizes on a UDP socket. | |
1731 | .SP | |
1732 | .BI "PEER \- udp-socket INET6 set-v6only-failed " ecode " " message | |
1733 | The server failed to configure an IPv6 socket not to try to collect IPv4 | |
1734 | traffic too. | |
1735 | .SP | |
0ba8de86 | 1736 | .BI "PEER " peer " unexpected-encrypted-ping 0x" id |
1737 | The peer sent an encrypted ping response whose id doesn't match any | |
1738 | outstanding ping. Maybe it was delayed for longer than the server was | |
1739 | willing to wait, or maybe the peer has gone mad. | |
13a55605 | 1740 | .SP |
0ba8de86 | 1741 | .BI "PEER \- unexpected-source " address\fR... |
1742 | A packet arrived from | |
1743 | .I address | |
1744 | (a network address \(en see above), but no peer is known at that | |
1745 | address. This may indicate a misconfiguration, or simply be a result of | |
1746 | one end of a connection being set up before the other. | |
13a55605 | 1747 | .SP |
0ba8de86 | 1748 | .BI "PEER " peer " unexpected-transport-ping 0x" id |
1749 | The peer (apparently) sent a transport ping response whose id doesn't | |
1750 | match any outstanding ping. Maybe it was delayed for longer than the | |
1751 | server was willing to wait, or maybe the peer has gone mad; or maybe | |
1752 | there are bad people trying to confuse you. | |
e8ea4061 MW |
1753 | .SS "PRIVSEP warnings" |
1754 | These indicate problems with the privilege-separation helper process. | |
1755 | (The server tries to drop its privileges when it starts up, leaving a | |
1756 | privileged helper process behind which will create and hand over tunnel | |
1757 | descriptors on request, but hopefully not do anything else especially | |
1758 | dangerous. Tunnel descriptors are not completely safe, but this is | |
1759 | probably better than nothing.) | |
1760 | .SP | |
1761 | .BI "PRIVSEP child-exited " rc | |
1762 | The helper process exited normally with status | |
1763 | .IR rc . | |
1764 | Status 0 means that it thought the server didn't want it any more; 1 | |
1765 | means that it was invoked incorrectly; 127 means that some system call | |
1766 | failed. | |
1767 | .SP | |
1768 | .BI "PRIVSEP child-killed " sig | |
1769 | The helper process was killed by signal number | |
1770 | .IR sig . | |
1771 | .SP | |
1772 | .BI "PRIVSEP child-died " status | |
1773 | The helper process died in some unexpected way; | |
1774 | .I status is the raw status code returned by | |
1775 | .BR waitpid (2), | |
1776 | because the server didn't understand how to decode it. | |
1777 | .SP | |
1778 | .BI "PRIVSEP helper-died" | |
1779 | A tunnel driver requires a tunnel descriptor from the helper, but the | |
1780 | helper isn't running so this won't work. | |
1781 | .SP | |
1782 | .BI "PRIVSEP helper-read-error " ecode " " message | |
1783 | The server failed to read a response from the helper process. | |
1784 | .SP | |
1785 | .BI "PRIVSEP helper-short-read" | |
1786 | The helper process didn't send back enough data, and has likely crashed. | |
1787 | .SP | |
1788 | .BI "PRIVSEP helper-write-error " ecode " " message | |
1789 | The server failed to send a message to the helper process. | |
1790 | .SP | |
1791 | .BI "PRIVSEP no-fd-from-helper" | |
1792 | The helper process sent back a positive response, but didn't include the | |
1793 | requested tunnel descriptor. | |
1794 | .SP | |
5ae728a6 MW |
1795 | .BI "PRIVSEP socketpair-create-failed " ecode " " message |
1796 | The server couldn't create the socketpair it's supposed to use to | |
1797 | communicate with the helper process. | |
1798 | .SP | |
e8ea4061 MW |
1799 | .BI "PRIVSEP unknown-response-code" |
1800 | The helper process sent back an incomprehensible reply. It's probably | |
1801 | very confused and may crash. | |
3cdc3f3a | 1802 | .SS "SERVER warnings" |
1803 | These indicate problems concerning the server process as a whole. | |
13a55605 | 1804 | .SP |
3cdc3f3a | 1805 | .BI "SERVER ignore signal " name |
1806 | A signal arrived, but the server ignored it. Currently this happens for | |
1807 | .B SIGHUP | |
1808 | because that's a popular way of telling daemons to re-read their | |
1809 | configuration files. Since | |
1810 | .B tripe | |
1811 | re-reads its keyrings automatically and has no other configuration | |
1812 | files, it's not relevant, but it seemed better to ignore the signal than | |
1813 | let the server die. | |
13a55605 | 1814 | .SP |
3cdc3f3a | 1815 | .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR] |
1816 | A signal arrived and | |
1817 | .B tripe | |
1818 | is going to quit. | |
13a55605 | 1819 | .SP |
3cdc3f3a | 1820 | .BI "SERVER quit admin-request" |
1821 | A client of the administration interface issued a | |
1822 | .B QUIT | |
1823 | command. | |
13a55605 | 1824 | .SP |
5ae728a6 MW |
1825 | .BI "SERVER daemon-error " ecode " " message |
1826 | The server failed to become a daemon during initialization. | |
1827 | .SP | |
46dde080 MW |
1828 | .BI "SERVER quit foreground-eof" |
1829 | The server is running in foreground mode (the | |
1830 | .B \-F | |
1831 | option), and encountered end-of-file on standard input. | |
1832 | .SP | |
f43df819 | 1833 | .BI "SERVER select-error " ecode " " message |
3cdc3f3a | 1834 | An error occurred in the server's main event loop. This is bad: if it |
1835 | happens too many times, the server will abort. | |
e8ea4061 MW |
1836 | .SP |
1837 | .BI "SERVER waitpid-error " ecode " " message | |
1838 | The server was informed that one of its child processes had exited, but | |
1839 | couldn't retrieve the child's status. | |
3cdc3f3a | 1840 | .SS "SYMM warnings" |
1841 | These are concerned with the symmetric encryption and decryption | |
1842 | process. | |
13a55605 | 1843 | .SP |
3cdc3f3a | 1844 | .BI "SYMM replay old-sequence" |
1845 | A packet was received with an old sequence number. It may just have | |
1846 | been delayed or duplicated, or it may have been an attempt at a replay | |
1847 | attack. | |
13a55605 | 1848 | .SP |
3cdc3f3a | 1849 | .BI "SYMM replay duplicated-sequence" |
1850 | A packet was received with a sequence number we've definitely seen | |
1851 | before. It may be an accidental duplication because the 'net is like | |
1852 | that, or a deliberate attempt at a replay. | |
1853 | .SS "TUN warnings" | |
1854 | These concern the workings of the system-specific tunnel driver. The | |
83487ded | 1855 | second token is the name of the tunnel interface in question, or |
3cdc3f3a | 1856 | .RB ` \- ' |
1857 | if none. | |
13a55605 | 1858 | .SP |
3cdc3f3a | 1859 | .BI "TUN \- bsd no-tunnel-devices" |
1860 | The driver couldn't find an available tunnel device. Maybe if you | |
e04c2d50 | 1861 | create some more |
3cdc3f3a | 1862 | .BI /dev/tun nn |
1863 | files, it will work. | |
13a55605 | 1864 | .SP |
72917fe7 | 1865 | .BI "TUN \- " tun-name " open-error " device " " ecode " " message |
3cdc3f3a | 1866 | An attempt to open the tunnel device file |
1867 | .I device | |
1868 | failed. | |
13a55605 | 1869 | .SP |
f43df819 | 1870 | .BI "TUN \- linux config-error " ecode " " message |
3cdc3f3a | 1871 | Configuring the Linux TUN/TAP interface failed. |
13a55605 | 1872 | .SP |
f43df819 | 1873 | .BI "TUN " ifname " " tun-name " read-error " ecode " " message |
42da2a58 | 1874 | Reading from the tunnel device failed. |
13a55605 | 1875 | .SP |
898975ee MW |
1876 | .BI "TUN " ifname " " tun-name " write-error " ecode " " message |
1877 | Writing from the tunnel device failed. | |
1878 | .SP | |
42da2a58 | 1879 | .BI "TUN " ifname " slip bad-escape" |
1880 | The SLIP driver encountered a escaped byte it wasn't expecting to see. | |
1881 | The erroneous packet will be ignored. | |
13a55605 | 1882 | .SP |
5ae728a6 MW |
1883 | .BI "TUN \- slip bad-interface-list" |
1884 | The interface list, in the | |
1885 | .B TRIPE_SLIPIF | |
1886 | environment variable, is malformed. | |
1887 | .SP | |
b9066fbb | 1888 | .BI "TUN " ifname " slip eof" |
1889 | The SLIP driver encountered end-of-file on its input descriptor. | |
1890 | Pending data is discarded, and no attempt is made to read any more data | |
1891 | from that interface ever. | |
13a55605 | 1892 | .SP |
b9066fbb | 1893 | .BI "TUN " ifname " slip escape-end" |
1894 | The SLIP driver encountered an escaped `end' marker. This probably | |
1895 | means that someone's been sending it junk. The erroneous packet is | |
1896 | discarded, and we hope that we've rediscovered synchronization. | |
13a55605 | 1897 | .SP |
f43df819 | 1898 | .BI "TUN \- slip fork-error " ecode " " message |
42da2a58 | 1899 | The SLIP driver encountered an error forking a child process while |
1900 | allocating a new dynamic interface. | |
13a55605 | 1901 | .SP |
42da2a58 | 1902 | .BI "TUN \- slip no-slip-interfaces" |
1903 | The driver ran out of static SLIP interfaces. Either preallocate more, | |
1904 | or use dynamic SLIP interface allocation. | |
13a55605 | 1905 | .SP |
b9066fbb | 1906 | .BI "TUN " ifname " slip overflow" |
1907 | The SLIP driver gave up reading a packet because it got too large. | |
13a55605 | 1908 | .SP |
f43df819 | 1909 | .BI "TUN \- slip pipe-error " ecode " " message |
42da2a58 | 1910 | The SLIP driver encountered an error creating pipes while allocating a |
1911 | new dynamic interface. | |
13a55605 | 1912 | .SP |
f43df819 | 1913 | .BI "TUN \- slip read-ifname-failed " ecode " " message |
42da2a58 | 1914 | The SLIP driver encountered an error reading the name of a dynamically |
1915 | allocated interface. Maybe the allocation script is broken. | |
13a55605 | 1916 | .SP |
f43df819 | 1917 | .BI "TUN \- unet config-error " ecode " " message |
42da2a58 | 1918 | Configuring the Linux Unet interface failed. Unet is obsolete and |
1919 | shouldn't be used any more. | |
13a55605 | 1920 | .SP |
f43df819 | 1921 | .BI "TUN \- unet getinfo-error " ecode " " message |
42da2a58 | 1922 | Reading information about the Unet interface failed. Unet is obsolete |
1923 | and shouldn't be used any more. | |
bd58d532 | 1924 | .SS "USER warnings" |
1925 | These are issued by administration clients using the | |
1926 | .B WARN | |
1927 | command. | |
13a55605 | 1928 | .SP |
bd58d532 | 1929 | .BI "USER " tokens\fR... |
1930 | An administration client issued a warning. | |
13a55605 | 1931 | .\"-sep |
fc916a09 MW |
1932 | . |
1933 | .\"-------------------------------------------------------------------------- | |
13a55605 | 1934 | .SH "SUMMARY" |
fc916a09 | 1935 | . |
13a55605 MW |
1936 | .SS "Command responses" |
1937 | .nf | |
2acd7cd6 | 1938 | .BI "BGDETACH " tag |
13a55605 MW |
1939 | .BI "BGFAIL " tag " " tokens \fR... |
1940 | .BI "BGINFO " tag " " tokens \fR... | |
1941 | .BI "BGOK " tag | |
1942 | .BI "FAIL " tokens \fR... | |
1943 | .BI "INFO " tokens \fR... | |
1944 | .B OK | |
1945 | .fi | |
1946 | .\"= summary | |
fc916a09 MW |
1947 | . |
1948 | .\"-------------------------------------------------------------------------- | |
d6623498 | 1949 | .SH "SEE ALSO" |
fc916a09 | 1950 | . |
d6623498 | 1951 | .BR tripectl (1), |
1952 | .BR tripe (8). | |
1953 | .PP | |
3cdc3f3a | 1954 | .IR "The Trivial IP Encryption Protocol" . |
fc916a09 MW |
1955 | . |
1956 | .\"-------------------------------------------------------------------------- | |
d6623498 | 1957 | .SH "AUTHOR" |
fc916a09 | 1958 | . |
d36eda2a | 1959 | Mark Wooding, <mdw@distorted.org.uk> |
fc916a09 MW |
1960 | . |
1961 | .\"----- That's all, folks -------------------------------------------------- |