Commit | Line | Data |
---|---|---|
d6623498 | 1 | .\" -*-nroff-*- |
060ca767 | 2 | .\" |
3 | .ie t \{\ | |
4 | . if \n(.g \{\ | |
5 | . fam P | |
6 | . \} | |
7 | .\} | |
d6623498 | 8 | .TH tripe-admin 5 "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" |
9 | .SH NAME | |
10 | tripe-admin \- administrator commands for TrIPE | |
11 | .SH DESCRIPTION | |
12 | This manual page describes the administration interface provided by the | |
13 | .BR tripe (8) | |
14 | daemon. | |
15 | .PP | |
16 | The | |
17 | .BR tripectl (8) | |
18 | program can be used either interactively or in scripts to communicate | |
19 | with the server using this interface. Alternatively, simple custom | |
20 | clients can be written in scripting languages such as Perl, Python or | |
21 | Tcl, or more advanced clients such as GUI monitors can be written in C | |
22 | with little difficulty. | |
23 | .PP | |
24 | By default, the server listens for admin connections on the Unix-domain | |
25 | socket | |
26 | .BR /var/lib/tripe/tripesock . | |
37941236 | 27 | Administration commands use a textual protocol. Each client command or |
28 | server response consists of a line of ASCII text terminated by a single | |
29 | linefeed character. No command may be longer than 255 characters. | |
d6623498 | 30 | .SS "General structure" |
31 | Each command or response line consists of a sequence of | |
32 | whitespace-separated words. The number and nature of whitespace | |
33 | characters separating two words in a client command is not significant; | |
34 | the server always uses a single space character. The first word in a | |
35 | line is a | |
36 | .I keyword | |
37 | identifying the type of command or response contained. Keywords in | |
38 | client commands are not case-sensitive; the server always uses uppercase | |
39 | for its keywords. | |
de014da6 | 40 | .SS "Simple commands" |
41 | For simple client command, the server responds with zero or more | |
d6623498 | 42 | .B INFO |
43 | lines, followed by either an | |
44 | .B OK | |
45 | line or a | |
46 | .B FAIL | |
47 | line. Each | |
48 | .B INFO | |
49 | provides information requested in the command. An | |
50 | .B OK | |
51 | response contains no further data. A | |
52 | .B FAIL | |
3cdc3f3a | 53 | code is followed by a machine-readable explanation of why the command |
d6623498 | 54 | failed. |
55 | .PP | |
de014da6 | 56 | Simple command processing is strictly synchronous: the server reads a |
57 | command, processes it, and responds, before reading the next command. | |
58 | All commands can be run as simple commands. Long-running commands | |
59 | (e.g., | |
60 | .B ADD | |
61 | and | |
62 | .BR PING ) | |
63 | block the client until they finish, but the rest of the server continues | |
64 | running. | |
65 | .SS "Asynchronous messages" | |
66 | There are three types of asynchronous messages which | |
67 | aren't associated with any particular command. | |
68 | .PP | |
69 | The | |
d6623498 | 70 | .B WARN |
3cdc3f3a | 71 | message contains a machine-readable message warning of an error |
d6623498 | 72 | encountered while processing a command, unexpected or unusual behaviour |
73 | by a peer, or a possible attack by an adversary. Under normal | |
de014da6 | 74 | conditions, the server shouldn't emit any warnings. |
75 | .PP | |
76 | The | |
d6623498 | 77 | .B TRACE |
3cdc3f3a | 78 | message contains a human-readable tracing message containing diagnostic |
d6623498 | 79 | information. Trace messages are controlled using the |
80 | .B \-T | |
81 | command-line option to the server, or the | |
82 | .B TRACE | |
83 | administration command (see below). Support for tracing can be disabled | |
84 | when the package is being configured, and may not be available in your | |
de014da6 | 85 | version. |
86 | .PP | |
87 | Finally, the | |
3cdc3f3a | 88 | .B NOTE |
89 | message is a machine-readable notification about some routine but | |
90 | interesting event such as creation or destruction of peers. | |
91 | .PP | |
92 | The presence of asynchronous messages can be controlled using the | |
93 | .B WATCH | |
94 | command. | |
de014da6 | 95 | .SS "Background commands" |
96 | Some commands (e.g., | |
97 | .B ADD | |
98 | and | |
99 | .BR PING ) | |
100 | take a long time to complete. To prevent these long-running commands | |
101 | from tying up a server connection, they can be run in the background. | |
102 | Not all commands can be run like this: the ones that can provide a | |
103 | .B \-background | |
104 | option, which must be supplied with a | |
105 | .IR tag . | |
106 | .PP | |
107 | A command may fail before it starts running in the background. In this | |
108 | case, the server emits a | |
109 | .B FAIL | |
110 | response, as usual. To indicate that a command has started running in | |
111 | the background, the server emits a response of the form | |
112 | .BI "BGDETACH " tag \fR, | |
113 | where | |
114 | .I tag | |
115 | is the value passed to the | |
116 | .B \-background | |
117 | option. From this point on, the server is ready to process more | |
118 | commands and reply to them. | |
119 | .PP | |
120 | Responses to background commands are indicated by a line beginning with | |
121 | one of the tokens | |
122 | .BR BGOK , | |
123 | .BR BGFAIL , | |
124 | or | |
125 | .BR BGINFO , | |
126 | followed by the command tag. These correspond to the | |
127 | .BR OK , | |
128 | .BR FAIL , | |
129 | and | |
130 | .B INFO | |
131 | responses for simple commands: | |
132 | .B BGINFO | |
133 | indicates information from a background command which has not completed | |
134 | yet; and | |
135 | .B BGOK | |
136 | and | |
137 | .B BGFAIL | |
138 | indicates that a background command succeeded or failed, respectively. | |
139 | .PP | |
140 | A background command will never issue an | |
141 | .B OK | |
060ca767 | 142 | or |
143 | .B BGINFO | |
144 | response: it will always detach and then issue any | |
145 | .B BGINFO | |
146 | lines followed by | |
de014da6 | 147 | .B BGOK |
148 | response. | |
3cdc3f3a | 149 | .SS "Network addresses" |
150 | A network address is a sequence of words. The first is a token | |
151 | identifying the network address family. The length of an address and | |
152 | the meanings of the subsequent words depend on the address family. | |
153 | Address family tokens are not case-sensitive on input; on output, they | |
154 | are always in upper-case. | |
155 | .PP | |
156 | At present, only one address family is understood. | |
157 | .TP | |
158 | .BI "INET " address " " port | |
159 | An Internet socket, naming an IPv4 address and UDP port. On output, the | |
160 | address is always in numeric dotted-quad form, and the port is given as | |
161 | a plain number. On input, DNS hostnames and symbolic port names are | |
162 | permitted. Name resolution does not block the main server, but will | |
163 | block the requesting client. This hopefully makes life simpler for | |
164 | stupid clients. Complex clients which don't wish to be held up can open | |
165 | extra connections or do the resolution themselves.) | |
166 | .PP | |
167 | If, on input, no recognised address family token is found, the following | |
168 | words are assumed to represent an | |
169 | .B INET | |
170 | address. | |
060ca767 | 171 | .SS "Key-value output" |
172 | Some commands (e.g., | |
173 | .B STATS | |
174 | and | |
175 | .BR SERVINFO ) | |
176 | produce output in the form of | |
177 | .IB key = value | |
178 | pairs, one per word. Neither the | |
179 | .I key | |
180 | nor the | |
181 | .I value | |
182 | contain spaces. | |
183 | .SS "Trace lists" | |
184 | Commands which enable or disable kinds of output (e.g., | |
185 | .B TRACE | |
186 | and | |
187 | .BR WATCH ) | |
188 | work in similar ways. They take a single optional argument, which | |
189 | consists of a string of letters selecting message types, optionally | |
190 | interspersed with | |
191 | .RB ` + ' | |
192 | to enable, or | |
193 | .RB ` \- ' | |
194 | to disable, the subsequently listed types. | |
195 | .PP | |
196 | If the argument is omitted, the available message types are displayed, | |
197 | one to an | |
198 | .B INFO | |
199 | line, in a fixed-column format. Column zero contains the key letter for | |
200 | selecting that message type; column one contains either a space or a | |
201 | .RB ` + ' | |
202 | sign, if the message type is disabled or enabled respectively; and a | |
203 | textual description of the message type begins at column 3 and continues | |
204 | to the end of the line. | |
205 | .PP | |
206 | Lowercase key letters control individual message types. Uppercase key | |
207 | letters control collections of message types. | |
3cdc3f3a | 208 | .SH "COMMAND REFERENCE" |
d6623498 | 209 | The commands provided are: |
210 | .TP | |
42da2a58 | 211 | .BI "ADD " peer " \fR[" options "\fR] " address "\fR..." |
3cdc3f3a | 212 | Adds a new peer. The peer is given the name |
213 | .IR peer ; | |
214 | the peer's public key is assumed to be in the file | |
215 | .B keyring.pub | |
216 | (or whatever alternative file was specified in the | |
217 | .B \-K | |
218 | option on the command line). The | |
219 | .I address | |
220 | is the network address (see above for the format) at which the peer can | |
42da2a58 | 221 | be contacted. The following options are recognised. |
222 | .RS | |
223 | .TP | |
de014da6 | 224 | .BI "\-background " tag |
225 | Run the command in the background, using the given | |
226 | .IR tag . | |
227 | .TP | |
0ba8de86 | 228 | .BI "\-keepalive " time |
229 | Send a no-op packet if we've not sent a packet to the peer in the last | |
230 | .I time | |
231 | interval. This is useful for persuading port-translating firewalls to | |
232 | believe that the `connection' is still active. The | |
233 | .I time | |
234 | is expressed as a nonnegative integer followed optionally by | |
235 | .BR d , | |
236 | .BR h , | |
237 | .BR m , | |
238 | or | |
239 | .BR s | |
240 | for days, hours, minutes, or seconds respectively; if no suffix is | |
241 | given, seconds are assumed. | |
242 | .TP | |
243 | .BI "\-tunnel " tunnel | |
42da2a58 | 244 | Use the named tunnel driver, rather than the default. |
245 | .RE | |
3cdc3f3a | 246 | .TP |
247 | .BI "ADDR " peer | |
248 | Emits an | |
249 | .B INFO | |
250 | line reporting the IP address and port number stored for | |
251 | .IR peer . | |
252 | .TP | |
37941236 | 253 | .BI "CHECKCHAL " challenge |
254 | Verifies a challenge as being one earlier issued by | |
255 | .B GETCHAL | |
256 | and not previously either passed to | |
257 | .B CHECKCHAL | |
258 | or in a greeting message. | |
259 | .TP | |
3cdc3f3a | 260 | .B "DAEMON" |
261 | Causes the server to disassociate itself from its terminal and become a | |
262 | background task. This only works once. A warning is issued. | |
263 | .TP | |
0ba8de86 | 264 | .BI "EPING \fR[" options "\fR] " peer |
265 | Sends an encrypted ping to the peer, and expects an encrypted response. | |
266 | This checks that the peer is running (and not being impersonated), and | |
267 | that it can encrypt and decrypt packets correctly. Options and | |
268 | responses are the same as for the | |
269 | .B PING | |
270 | command. | |
271 | .TP | |
de014da6 | 272 | .BI "FORCEKX " peer |
273 | Requests the server to begin a new key exchange with | |
274 | .I peer | |
275 | immediately. | |
276 | .TP | |
37941236 | 277 | .B "GETCHAL" |
278 | Requests a challenge. The challenge is returned in an | |
279 | .B INFO | |
280 | line, as a base64-encoded string. See | |
281 | .BR CHECKCHAL . | |
282 | .TP | |
283 | .BI "GREET " peer " " challenge | |
284 | Sends a greeting packet containing the | |
285 | .I challenge | |
286 | (base-64 encoded) to the named | |
287 | .IR peer . | |
288 | The expectation is that this will cause the peer to recognize us and | |
289 | begin a key-exchange. | |
290 | .TP | |
d6623498 | 291 | .B "HELP" |
292 | Causes the server to emit an | |
293 | .B INFO | |
294 | line for each command it supports. Each line lists the command name, | |
295 | followed by the names of the arguments. This may be helpful as a memory | |
296 | aid for interactive use, or for program clients probing for features. | |
3cdc3f3a | 297 | .TP |
298 | .BI "IFNAME " peer | |
299 | Emits an | |
300 | .B INFO | |
301 | line containing the name of the network interface used to collect IP | |
302 | packets which are to be encrypted and sent to | |
303 | .IR peer . | |
304 | Used by configuration scripts so that they can set up routing tables | |
305 | appropriately after adding new peers. | |
306 | .TP | |
307 | .BI "KILL " peer | |
308 | Causes the server to forget all about | |
309 | .IR peer . | |
310 | All keys are destroyed, and no more packets are sent. No notification | |
311 | is sent to the peer: if it's important that the peer be notified, you | |
312 | must think of a way to do that yourself. | |
313 | .TP | |
314 | .B "LIST" | |
315 | For each currently-known peer, an | |
316 | .B INFO | |
317 | line is written containing the peer's name, as given to | |
318 | .BR ADD . | |
319 | .TP | |
bd58d532 | 320 | .BI "NOTIFY " tokens\fR... |
321 | Issues a | |
322 | .B USER | |
323 | notification to all interested administration clients. | |
324 | .TP | |
060ca767 | 325 | .BI "PEERINFO " peer |
326 | Returns information about a peer, in key-value form. The following keys | |
327 | are returned. | |
328 | .RS | |
329 | .TP | |
330 | .B tunnel | |
331 | The tunnel driver used for this peer. | |
332 | .TP | |
333 | .B keepalive | |
334 | The keepalive interval, in seconds, or zero if no keepalives are to be | |
335 | sent. | |
336 | .RE | |
337 | .TP | |
0ba8de86 | 338 | .BI "PING \fR[" options "\fR] " peer |
339 | Send a transport-level ping to the peer. The ping and its response are | |
340 | not encrypted or authenticated. This command, possibly in conjunction | |
341 | with tracing, is useful for ensuring that UDP packets are actually | |
342 | flowing in both directions. See also the | |
343 | .B EPING | |
344 | command. | |
345 | .IP | |
346 | An | |
347 | .B INFO | |
348 | line is printed describing the outcome: | |
349 | .RS | |
350 | .TP | |
351 | .BI "ping-ok " millis | |
352 | A response was received | |
353 | .I millis | |
354 | after the ping was sent. | |
355 | .TP | |
356 | .BI "ping-timeout" | |
357 | No response was received within the time allowed. | |
358 | .TP | |
359 | .BI "ping-peer-died" | |
360 | The peer was killed (probably by another admin connection) before a | |
361 | response was received. | |
362 | .RE | |
363 | .IP | |
364 | Options recognized for this command are: | |
365 | .RS | |
366 | .TP | |
de014da6 | 367 | .BI "\-background " tag |
368 | Run the command in the background, using the given | |
369 | .IR tag . | |
370 | .TP | |
0ba8de86 | 371 | .BI "\-timeout " time |
372 | Wait for | |
373 | .I time | |
374 | seconds before giving up on a response. The default is 5 seconds. (The | |
375 | time format is the same as for the | |
376 | .B "ADD \-keepalive" | |
377 | option.) | |
378 | .RE | |
379 | .TP | |
3cdc3f3a | 380 | .B "PORT" |
381 | Emits an | |
382 | .B INFO | |
383 | line containing just the number of the UDP port used by the | |
384 | .B tripe | |
385 | server. If you've allowed your server to allocate a port dynamically, | |
386 | this is how to find out which one it chose. | |
387 | .TP | |
de014da6 | 388 | .B "RELOAD" |
389 | Instructs the server to recheck its keyring files. The server checks | |
390 | these periodically anyway but it may be necessary to force a recheck, | |
391 | for example after adding a new peer key. | |
392 | .TP | |
3cdc3f3a | 393 | .B "QUIT" |
394 | Instructs the server to exit immediately. A warning is sent. | |
395 | .TP | |
060ca767 | 396 | .B "SERVINFO" |
397 | Returns information about the server, in the form of key-value pairs. | |
398 | The following keys are used. | |
399 | .RS | |
400 | .TP | |
401 | .B implementation | |
402 | A keyword naming the implementation of the | |
403 | .BR tripe (8) | |
404 | server. The current implementation is called | |
405 | .BR edgeware-tripe . | |
406 | .TP | |
407 | .B version | |
408 | The server's version number, as reported by | |
409 | .BR VERSION . | |
410 | .TP | |
411 | .B daemon | |
412 | Either | |
413 | .B t | |
414 | or | |
415 | .BR nil , | |
416 | if the server has or hasn't (respectively) become a daemon. | |
417 | .RE | |
418 | .TP | |
3cdc3f3a | 419 | .BI "STATS " peer |
420 | Emits a number of | |
421 | .B INFO | |
422 | lines, each containing one or more statistics in the form | |
423 | .IB name = value \fR. | |
424 | The statistics-gathering is experimental and subject to change. | |
d6623498 | 425 | .TP |
426 | .BR "TRACE " [\fIoptions\fP] | |
060ca767 | 427 | Selects trace outputs: see |
428 | .B "Trace lists" | |
429 | above. Message types provided are: | |
d6623498 | 430 | .RS |
2d752320 | 431 | .PP |
d6623498 | 432 | Currently, the following tracing options are supported: |
433 | .TP | |
434 | .B t | |
435 | Tunnel events: reception of packets to be encrypted, and injection of | |
436 | successfully-decrypted packets. | |
437 | .TP | |
438 | .B r | |
439 | Peer management events: creation and destruction of peer attachments, | |
440 | and arrival of messages. | |
441 | .TP | |
442 | .B a | |
443 | Administration interface: acceptance of new connections, and handling of | |
444 | the backgroud name-resolution required by the | |
445 | .B ADD | |
446 | command. | |
447 | .TP | |
d6623498 | 448 | .B s |
449 | Handling of symmetric keysets: creation and expiry of keysets, and | |
450 | encryption and decryption of messages. | |
451 | .TP | |
452 | .B x | |
453 | Key exchange: reception, parsing and emission of key exchange messages. | |
454 | .TP | |
455 | .B m | |
456 | Key management: loading keys and checking for file modifications. | |
37941236 | 457 | .TP |
458 | .B l | |
459 | Display information about challenge issuing and verification. | |
460 | .TP | |
461 | .B p | |
462 | Display contents of packets sent and received by the tunnel and/or peer | |
463 | modules. | |
464 | .TP | |
465 | .B c | |
466 | Display inputs, outputs and intermediate results of cryptographic | |
467 | operations. This includes plaintext and key material. Use with | |
468 | caution. | |
469 | .TP | |
470 | .B A | |
471 | All of the above. | |
d6623498 | 472 | .PP |
473 | Note that the | |
474 | .B p | |
475 | (packet contents) | |
476 | and | |
477 | .B c | |
478 | (crypto details) | |
479 | outputs provide extra detail for other outputs. Specifying | |
480 | .B p | |
481 | without | |
37941236 | 482 | .BR r |
d6623498 | 483 | or |
484 | .B t | |
485 | isn't useful; neither is specifying | |
486 | .B c | |
487 | without one of | |
488 | .BR s , | |
37941236 | 489 | .BR l , |
d6623498 | 490 | .B x |
491 | or | |
492 | .BR m . | |
493 | .RE | |
494 | .TP | |
060ca767 | 495 | .B "TUNNELS" |
496 | For each available tunnel driver, an | |
497 | .B INFO | |
498 | line is printed giving its name. | |
499 | .TP | |
500 | .B "VERSION" | |
501 | Causes the server to emit an | |
502 | .B INFO | |
503 | line stating its software version, as two words: the server name, and | |
504 | its version string. The server name | |
505 | .B tripe | |
506 | is reserved to the Straylight/Edgeware implementation. | |
507 | .TP | |
3cdc3f3a | 508 | .BR "WATCH " [\fIoptions\fP] |
509 | Enables or disables asynchronous messages | |
510 | .IR "for the current connection only" . | |
060ca767 | 511 | See |
512 | .B "Trace lists" | |
3cdc3f3a | 513 | above. The default watch state for the connection the server opens |
514 | automatically on stdin/stdout is to show warnings and trace messages; | |
515 | other connections show no asynchronous messages. (This is done in order | |
516 | to guarantee that a program reading the server's stdout does not miss | |
517 | any warnings.) | |
518 | .RS | |
519 | .PP | |
060ca767 | 520 | Message types provided are: |
3cdc3f3a | 521 | .TP |
522 | .B t | |
523 | .B TRACE | |
524 | messages. | |
525 | .TP | |
526 | .B n | |
527 | .B NOTE | |
528 | messages. | |
529 | .TP | |
530 | .B w | |
531 | .B WARN | |
532 | messages. | |
533 | .TP | |
37941236 | 534 | .B A |
3cdc3f3a | 535 | All of the above. |
536 | .RE | |
537 | .TP | |
bd58d532 | 538 | .BI "WARN " tokens\fR... |
539 | Issues a | |
540 | .B USER | |
541 | warning to all interested administration clients. | |
3cdc3f3a | 542 | .SH "ERROR MESSAGES" |
543 | The following | |
544 | .B FAIL | |
de014da6 | 545 | (or |
546 | .BR BGFAIL ) | |
3cdc3f3a | 547 | messages are sent to clients as a result of errors during command |
548 | processing. | |
d6623498 | 549 | .TP |
3cdc3f3a | 550 | .BI "already-daemon" |
551 | (For | |
552 | .BR DAEMON .) | |
553 | The | |
554 | .B tripe | |
555 | server is already running as a daemon. | |
d6623498 | 556 | .TP |
f43df819 | 557 | .BI "bad-addr-syntax " message |
37941236 | 558 | (For commands accepting socket addresses.) The address couldn't be |
559 | understood. | |
560 | .TP | |
f43df819 | 561 | .BI "bad-syntax " cmd " " message |
3cdc3f3a | 562 | (For any command.) The command couldn't be understood: e.g., the number |
563 | of arguments was wrong. | |
d6623498 | 564 | .TP |
0ba8de86 | 565 | .BI "bad-time-spec " word |
566 | The | |
567 | .I word | |
568 | is not a valid time interval specification. Acceptable time | |
569 | specifications are nonnegative integers followed optionally by | |
570 | .BR d , | |
571 | .BR h , | |
572 | .BR m , | |
573 | or | |
574 | .BR s , | |
575 | for days, hours, minutes, or seconds, respectively. | |
576 | .TP | |
3cdc3f3a | 577 | .BI "bad-trace-option " char |
578 | (For | |
579 | .BR TRACE .) | |
580 | An unknown trace option was requested. | |
581 | .TP | |
582 | .BI "bad-watch-option " char | |
583 | (For | |
584 | .BR WATCH .) | |
585 | An unknown watch option was requested. | |
586 | .TP | |
f43df819 | 587 | .BI "daemon-error " ecode " " message |
3cdc3f3a | 588 | (For |
589 | .BR DAEMON .) | |
590 | An error occurred during the attempt to become a daemon, as reported by | |
591 | .IR message . | |
592 | .TP | |
593 | .BI "invalid-port " number | |
594 | (For | |
595 | .BR ADD .) | |
596 | The given port number is out of range. | |
597 | .TP | |
598 | .BI "peer-create-fail " peer | |
599 | (For | |
600 | .BR ADD .) | |
601 | Adding | |
602 | .I peer | |
603 | failed for some reason. A warning should have been emitted explaining | |
604 | why. | |
605 | .TP | |
606 | .BI "peer-exists " peer | |
607 | (For | |
608 | .BR ADD .) | |
609 | There is already a peer named | |
d6623498 | 610 | .IR peer . |
611 | .TP | |
0ba8de86 | 612 | .B "ping-send-failed" |
613 | The attempt to send a ping packet failed, probably due to lack of | |
614 | encryption keys. | |
615 | .TP | |
3cdc3f3a | 616 | .BI "resolve-error " hostname |
617 | (For | |
618 | .BR ADD .) | |
619 | The DNS name | |
620 | .I hostname | |
621 | could not be resolved. | |
622 | .TP | |
623 | .BI "resolver-timeout " hostname | |
624 | (For | |
625 | .BR ADD .) | |
626 | The DNS name | |
627 | .I hostname | |
628 | took too long to resolve. | |
629 | .TP | |
630 | .BI "unknown-command " token | |
631 | The command | |
632 | .B token | |
633 | was not recognised. | |
634 | .TP | |
635 | .BI "unknown-peer " name | |
636 | (For | |
637 | .BR ADDR , | |
638 | .BR IFNAME , | |
639 | .BR KILL , | |
640 | and | |
641 | .BR STATS .) | |
642 | There is no peer called | |
643 | .IR name . | |
644 | .TP | |
645 | .BI "unknown-service " service | |
646 | (For | |
647 | .BR ADD .) | |
648 | The service name | |
649 | .I service | |
650 | couldn't be found in | |
651 | .BR /etc/services . | |
652 | .SH "NOTIFICATIONS" | |
653 | The following notifications are sent to clients who request them. | |
654 | .TP | |
42da2a58 | 655 | .BI "ADD " peer " " ifname " " address \fR... |
3cdc3f3a | 656 | A new peer has been added. The peer's name is |
42da2a58 | 657 | .IR peer , |
658 | its tunnel is network interface | |
659 | .IR ifname , | |
3cdc3f3a | 660 | and its network address is |
661 | .IR address . | |
662 | .TP | |
663 | .BI "DAEMON" | |
664 | The server has forked off into the sunset and become a daemon. | |
d6623498 | 665 | .TP |
37941236 | 666 | .BI "GREET " challenge " " address \fR... |
667 | A valid greeting was received, with the given challenge (exactly as it | |
668 | was returned by | |
669 | .B GETCHAL | |
670 | earlier). | |
671 | .TP | |
d6623498 | 672 | .BI "KILL " peer |
3cdc3f3a | 673 | The peer |
674 | .I peer | |
675 | has been killed. | |
d6623498 | 676 | .TP |
3cdc3f3a | 677 | .BI "KXDONE " peer |
678 | Key exchange with | |
679 | .I peer | |
680 | finished successfully. | |
681 | .TP | |
682 | .BI "KXSTART " peer | |
683 | Key exchange with | |
684 | .I peer | |
685 | has begun or restarted. If key exchange keeps failing, this message | |
686 | will be repeated periodically. | |
bd58d532 | 687 | .TP |
688 | .BI "USER " tokens\fR... | |
689 | An administration client issued a notification using the | |
690 | .B NOTIFY | |
691 | command. | |
3cdc3f3a | 692 | .SH "WARNINGS" |
693 | There are many possible warnings. They are categorized according to | |
694 | their first tokens. | |
f43df819 MW |
695 | .PP |
696 | Many of these warnings report system errors. These are reported as a | |
697 | pair of tokens, described below as | |
698 | .I ecode | |
699 | and | |
700 | .IR message . | |
701 | The | |
702 | .I ecode | |
703 | is a string of the form | |
704 | .BI E number | |
705 | giving the | |
706 | .BR errno (3) | |
707 | value of the error; the | |
708 | .I message | |
709 | is the `human-readable' form of the message, as reported by | |
710 | .BR strerror (3). | |
3cdc3f3a | 711 | .SS "ABORT warnings" |
712 | These all indicate that the | |
d6623498 | 713 | .B tripe |
3cdc3f3a | 714 | server has become unable to continue. If enabled, the server will dump |
715 | core in its configuration directory. | |
d6623498 | 716 | .TP |
3cdc3f3a | 717 | .BI "ABORT repeated-select-errors" |
718 | The main event loop is repeatedly failing. If the server doesn't quit, | |
719 | it will probably waste all available CPU doing nothing. | |
720 | .SS "ADMIN warnings" | |
721 | These indicate a problem with the administration socket interface. | |
722 | .TP | |
f43df819 | 723 | .BI "ADMIN accept-error " ecode " " message |
3cdc3f3a | 724 | There was an error while attempting to accept a connection from a new |
725 | client. | |
726 | .TP | |
f43df819 | 727 | .BI "ADMIN client-write-error " ecode " " message |
3cdc3f3a | 728 | There was an error sending data to a client. The connection to the |
729 | client has been closed. | |
37941236 | 730 | .SS "CHAL warnings" |
731 | These indicate errors in challenges, either in the | |
732 | .B CHECKCHAL | |
733 | command or in greeting packets. | |
734 | .TP | |
735 | .B "CHAL impossible-challenge" | |
736 | The server hasn't issued any challenges yet. Quite how anyone else | |
737 | thought he could make one up is hard to imagine. | |
738 | .TP | |
739 | .B "CHAL incorrect-tag" | |
740 | Challenge received contained the wrong authentication data. It might be | |
741 | very stale, or a forgery. | |
742 | .TP | |
743 | .B "CHAL invalid-challenge" | |
744 | Challenge received was the wrong length. We might have changed MAC | |
745 | algorithms since the challenge was issued, or it might just be rubbish. | |
746 | .TP | |
747 | .B "CHAL replay duplicated-sequence" | |
748 | Challenge received was a definite replay of an old challenge. Someone's | |
749 | up to something! | |
750 | .TP | |
751 | .B "CHAL replay old-sequence" | |
752 | Challenge received was old, but maybe not actually a replay. Try again. | |
3cdc3f3a | 753 | .SS "KEYMGMT warnings" |
754 | These indicate a problem with the keyring files, or the keys stored in | |
755 | them. | |
756 | .TP | |
f43df819 | 757 | .BI "KEYMGMT bad-private-key " message |
3cdc3f3a | 758 | The private key could not be read, or failed a consistency check. If |
759 | there was a problem with the file, usually there will have been | |
760 | .B key-file-error | |
761 | warnings before this. | |
762 | .TP | |
f43df819 | 763 | .BI "KEYMGMT bad-public-keyring " message |
3cdc3f3a | 764 | The public keyring couldn't be read. Usually, there will have been |
765 | .B key-file-error | |
766 | warnings before this. | |
767 | .TP | |
f43df819 | 768 | .BI "KEYMGMT key-file-error " file ":" line " " message |
3cdc3f3a | 769 | Reports a specific error with the named keyring file. This probably |
770 | indicates a bug in | |
771 | .BR key (1). | |
772 | .TP | |
773 | .BI "KEYMGMT public-key " tag " " tokens\fR... | |
774 | These messages all indicate a problem with the public key named | |
775 | .IR tag . | |
776 | .TP | |
777 | .BI "KEYMGMT public-key " tag " algorithm-mismatch" | |
778 | The algorithms specified on the public key don't match the ones for our | |
779 | private key. All the peers in a network have to use the same | |
780 | algorithms. | |
781 | .TP | |
f43df819 | 782 | .BI "KEYMGMT public-key " tag " bad " message |
3cdc3f3a | 783 | The public key couldn't be read, or is invalid. |
784 | .TP | |
785 | .BI "KEYMGMT public-key " tag " bad-public-group-element" | |
786 | The public key is invalid. This may indicate a malicious attempt to | |
787 | introduce a bogus key. | |
788 | .TP | |
789 | .BI "KEYMGMT public-key " tag " bad-algorithm-selection" | |
790 | The algorithms listed on the public key couldn't be understood. The | |
791 | algorithm selection attributes are probably malformed and need fixing. | |
792 | .TP | |
793 | .BI "KEYMGMT public-key " tag " incorrect-group" | |
794 | The public key doesn't use the same group as our private key. All the | |
795 | peers in a network have to use the same group. | |
796 | .TP | |
797 | .BI "KEYMGMT public-key " tag " not-found" | |
798 | The public key for peer | |
799 | .I tag | |
800 | wasn't in the public keyring. | |
801 | .TP | |
802 | .BI "KEYMGMT public-key " tag " unknown-type" | |
803 | The type of the public key isn't understood. Maybe you need to upgrade | |
804 | your copy of | |
805 | .BR tripe . | |
806 | (Even if you do, you'll have to regenerate your keys.) | |
807 | .SS "KX warnings" | |
808 | These indicate problems during key-exchange. Many indicate either a bug | |
809 | in the server (either yours or the remote one), or some kind of attack | |
810 | in progress. All name a | |
811 | .I peer | |
812 | as the second token: this is the peer the packet is apparently from, | |
813 | though it may have been sent by an attacker instead. | |
814 | .PP | |
815 | In the descriptions below, | |
816 | .I msgtoken | |
817 | is one of the tokens | |
818 | .BR pre-challenge , | |
819 | .BR cookie , | |
820 | .BR challenge , | |
821 | .BR reply , | |
822 | .BR switch-rq , | |
823 | or | |
824 | .BR switch-ok . | |
825 | .TP | |
826 | .BI "KX " peer " bad-expected-reply-log" | |
827 | The challenges | |
828 | .B tripe | |
829 | uses in its protocol contain a check value which proves that the | |
830 | challenge is honest. This message indicates that the check value | |
831 | supplied is wrong: someone is attempting to use bogus challenges to | |
832 | persuade your | |
833 | .B tripe | |
834 | server to leak private key information. No chance! | |
835 | .TP | |
bd58d532 | 836 | .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok" |
3cdc3f3a | 837 | A symmetrically-encrypted portion of a key-exchange message failed to |
838 | decrypt. | |
839 | .TP | |
840 | .BI "KX " peer " invalid " msgtoken | |
841 | A key-exchange message was malformed. This almost certainly indicates a | |
842 | bug somewhere. | |
843 | .TP | |
bd58d532 | 844 | .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok" |
3cdc3f3a | 845 | A message didn't contain the right magic data. This may be a replay of |
846 | some old exchange, or random packets being sent in an attempt to waste | |
847 | CPU. | |
848 | .TP | |
849 | .BI "KX " peer " public-key-expired" | |
850 | The peer's public key has expired. It's maintainer should have given | |
851 | you a replacement before now. | |
852 | .TP | |
853 | .BI "KX " peer " sending-cookie" | |
854 | We've received too many bogus pre-challenge messages. Someone is trying | |
855 | to flood us with key-exchange messages and make us waste CPU on doing | |
856 | hard asymmetric crypto sums. | |
857 | .TP | |
858 | .BI "KX " peer " unexpected " msgtoken | |
859 | The message received wasn't appropriate for this stage of the key | |
860 | exchange process. This may mean that one of our previous packets got | |
861 | lost. For | |
862 | .BR pre-challenge , | |
863 | it may simply mean that the peer has recently restarted. | |
864 | .TP | |
865 | .BI "KX " peer " unknown-challenge" | |
866 | The peer is asking for an answer to a challenge which we don't know | |
867 | about. This may mean that we've been inundated with challenges from | |
868 | some malicious source | |
869 | .I who can read our messages | |
870 | and discarded the valid one. | |
871 | .TP | |
872 | .BI "KX " peer " unknown-message 0x" nn | |
873 | An unknown key-exchange message arrived. | |
874 | .SS "PEER warnings" | |
875 | These are largely concerned with management of peers and the low-level | |
876 | details of the network protocol. The second word is usually the name of | |
877 | a peer, or | |
878 | .RB ` \- ' | |
879 | if none is relevant. | |
880 | .TP | |
3cdc3f3a | 881 | .BI "PEER " peer " bad-packet no-type" |
882 | An empty packet arrived. This is very strange. | |
883 | .TP | |
884 | .BI "PEER " peer " bad-packet unknown-category 0x" nn | |
885 | The message category | |
886 | .I nn | |
887 | (in hex) isn't understood. Probably a strange random packet from | |
888 | somewhere; could be an unlikely bug. | |
889 | .TP | |
890 | .BI "PEER " peer " bad-packet unknown-type 0x" nn | |
891 | The message type | |
892 | .I nn | |
893 | (in hex) isn't understood. Probably a strange random packet from | |
894 | somewhere; could be an unlikely bug. | |
895 | .TP | |
0ba8de86 | 896 | .BI "PEER " peer " corrupt-encrypted-ping" |
897 | The peer sent a ping response which matches an outstanding ping, but its | |
898 | payload is wrong. There's definitely a bug somewhere. | |
899 | .TP | |
900 | .BI "PEER " peer " corrupt-transport-ping" | |
901 | The peer (apparently) sent a ping response which matches an outstanding | |
902 | ping, but its payload is wrong. Either there's a bug, or the bad guys | |
903 | are playing tricks on you. | |
904 | .TP | |
3cdc3f3a | 905 | .BI "PEER " peer " decrypt-failed" |
906 | An encrypted IP packet failed to decrypt. It may have been mangled in | |
907 | transit, or may be a very old packet from an expired previous session | |
908 | key. There is usually a considerable overlap in the validity periods of | |
909 | successive session keys, so this shouldn't occur unless the key exchange | |
910 | takes ages or fails. | |
911 | .TP | |
0ba8de86 | 912 | .BI "PEER " peer " malformed-encrypted-ping" |
913 | The peer sent a ping response which is hopelessly invalid. There's | |
914 | definitely a bug somewhere. | |
915 | .TP | |
916 | .BI "PEER " peer " malformed-transport-ping" | |
917 | The peer (apparently) sent a ping response which is hopelessly invalid. | |
918 | Either there's a bug, or the bad guys are playing tricks on you. | |
919 | .TP | |
3cdc3f3a | 920 | .BI "PEER " peer " packet-build-failed" |
921 | There wasn't enough space in our buffer to put the packet we wanted to | |
922 | send. Shouldn't happen. | |
923 | .TP | |
f43df819 | 924 | .BI "PEER \- socket-read-error " ecode " " message |
3cdc3f3a | 925 | An error occurred trying to read an incoming packet. |
926 | .TP | |
f43df819 | 927 | .BI "PEER " peer " socket-write-error " ecode " " message |
3cdc3f3a | 928 | An error occurred attempting to send a network packet. We lost that |
929 | one. | |
0ba8de86 | 930 | .TP |
931 | .BI "PEER " peer " unexpected-encrypted-ping 0x" id | |
932 | The peer sent an encrypted ping response whose id doesn't match any | |
933 | outstanding ping. Maybe it was delayed for longer than the server was | |
934 | willing to wait, or maybe the peer has gone mad. | |
935 | .TP | |
936 | .BI "PEER \- unexpected-source " address\fR... | |
937 | A packet arrived from | |
938 | .I address | |
939 | (a network address \(en see above), but no peer is known at that | |
940 | address. This may indicate a misconfiguration, or simply be a result of | |
941 | one end of a connection being set up before the other. | |
942 | .TP | |
943 | .BI "PEER " peer " unexpected-transport-ping 0x" id | |
944 | The peer (apparently) sent a transport ping response whose id doesn't | |
945 | match any outstanding ping. Maybe it was delayed for longer than the | |
946 | server was willing to wait, or maybe the peer has gone mad; or maybe | |
947 | there are bad people trying to confuse you. | |
3cdc3f3a | 948 | .SS "SERVER warnings" |
949 | These indicate problems concerning the server process as a whole. | |
950 | .TP | |
951 | .BI "SERVER ignore signal " name | |
952 | A signal arrived, but the server ignored it. Currently this happens for | |
953 | .B SIGHUP | |
954 | because that's a popular way of telling daemons to re-read their | |
955 | configuration files. Since | |
956 | .B tripe | |
957 | re-reads its keyrings automatically and has no other configuration | |
958 | files, it's not relevant, but it seemed better to ignore the signal than | |
959 | let the server die. | |
960 | .TP | |
961 | .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR] | |
962 | A signal arrived and | |
963 | .B tripe | |
964 | is going to quit. | |
965 | .TP | |
966 | .BI "SERVER quit admin-request" | |
967 | A client of the administration interface issued a | |
968 | .B QUIT | |
969 | command. | |
970 | .TP | |
f43df819 | 971 | .BI "SERVER select-error " ecode " " message |
3cdc3f3a | 972 | An error occurred in the server's main event loop. This is bad: if it |
973 | happens too many times, the server will abort. | |
974 | .SS "SYMM warnings" | |
975 | These are concerned with the symmetric encryption and decryption | |
976 | process. | |
977 | .TP | |
978 | .BI "SYMM replay old-sequence" | |
979 | A packet was received with an old sequence number. It may just have | |
980 | been delayed or duplicated, or it may have been an attempt at a replay | |
981 | attack. | |
982 | .TP | |
983 | .BI "SYMM replay duplicated-sequence" | |
984 | A packet was received with a sequence number we've definitely seen | |
985 | before. It may be an accidental duplication because the 'net is like | |
986 | that, or a deliberate attempt at a replay. | |
987 | .SS "TUN warnings" | |
988 | These concern the workings of the system-specific tunnel driver. The | |
989 | second word is the name of the tunnel interface in question, or | |
990 | .RB ` \- ' | |
991 | if none. | |
992 | .TP | |
993 | .BI "TUN \- bsd no-tunnel-devices" | |
994 | The driver couldn't find an available tunnel device. Maybe if you | |
995 | create some more | |
996 | .BI /dev/tun nn | |
997 | files, it will work. | |
998 | .TP | |
f43df819 | 999 | .BI "TUN - " tun-name " open-error " device " " ecode " " message |
3cdc3f3a | 1000 | An attempt to open the tunnel device file |
1001 | .I device | |
1002 | failed. | |
1003 | .TP | |
f43df819 | 1004 | .BI "TUN \- linux config-error " ecode " " message |
3cdc3f3a | 1005 | Configuring the Linux TUN/TAP interface failed. |
1006 | .TP | |
f43df819 | 1007 | .BI "TUN " ifname " " tun-name " read-error " ecode " " message |
42da2a58 | 1008 | Reading from the tunnel device failed. |
3cdc3f3a | 1009 | .TP |
42da2a58 | 1010 | .BI "TUN " ifname " slip bad-escape" |
1011 | The SLIP driver encountered a escaped byte it wasn't expecting to see. | |
1012 | The erroneous packet will be ignored. | |
b9066fbb | 1013 | .TP |
1014 | .BI "TUN " ifname " slip eof" | |
1015 | The SLIP driver encountered end-of-file on its input descriptor. | |
1016 | Pending data is discarded, and no attempt is made to read any more data | |
1017 | from that interface ever. | |
1018 | .TP | |
1019 | .BI "TUN " ifname " slip escape-end" | |
1020 | The SLIP driver encountered an escaped `end' marker. This probably | |
1021 | means that someone's been sending it junk. The erroneous packet is | |
1022 | discarded, and we hope that we've rediscovered synchronization. | |
1023 | .TP | |
f43df819 | 1024 | .BI "TUN \- slip fork-error " ecode " " message |
42da2a58 | 1025 | The SLIP driver encountered an error forking a child process while |
1026 | allocating a new dynamic interface. | |
1027 | .TP | |
1028 | .BI "TUN \- slip no-slip-interfaces" | |
1029 | The driver ran out of static SLIP interfaces. Either preallocate more, | |
1030 | or use dynamic SLIP interface allocation. | |
b9066fbb | 1031 | .TP |
1032 | .BI "TUN " ifname " slip overflow" | |
1033 | The SLIP driver gave up reading a packet because it got too large. | |
42da2a58 | 1034 | .TP |
f43df819 | 1035 | .BI "TUN \- slip pipe-error " ecode " " message |
42da2a58 | 1036 | The SLIP driver encountered an error creating pipes while allocating a |
1037 | new dynamic interface. | |
1038 | .TP | |
f43df819 | 1039 | .BI "TUN \- slip read-ifname-failed " ecode " " message |
42da2a58 | 1040 | The SLIP driver encountered an error reading the name of a dynamically |
1041 | allocated interface. Maybe the allocation script is broken. | |
1042 | .TP | |
f43df819 | 1043 | .BI "TUN \- unet config-error " ecode " " message |
42da2a58 | 1044 | Configuring the Linux Unet interface failed. Unet is obsolete and |
1045 | shouldn't be used any more. | |
1046 | .TP | |
f43df819 | 1047 | .BI "TUN \- unet getinfo-error " ecode " " message |
42da2a58 | 1048 | Reading information about the Unet interface failed. Unet is obsolete |
1049 | and shouldn't be used any more. | |
1050 | .TP | |
f43df819 | 1051 | .BI "TUN \- unet ifname-too-long" |
42da2a58 | 1052 | The Unet interface's name overflowed, so we couldn't read it properly. |
1053 | Unet is obsolete and shouldn't be used any more. | |
bd58d532 | 1054 | .SS "USER warnings" |
1055 | These are issued by administration clients using the | |
1056 | .B WARN | |
1057 | command. | |
1058 | .TP | |
1059 | .BI "USER " tokens\fR... | |
1060 | An administration client issued a warning. | |
d6623498 | 1061 | .SH "SEE ALSO" |
1062 | .BR tripectl (1), | |
1063 | .BR tripe (8). | |
1064 | .PP | |
3cdc3f3a | 1065 | .IR "The Trivial IP Encryption Protocol" . |
d6623498 | 1066 | .SH "AUTHOR" |
d36eda2a | 1067 | Mark Wooding, <mdw@distorted.org.uk> |