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