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