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