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