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