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