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