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