3 .\" Manual for the administration protocol
5 .\" (c) 2008 Straylight/Edgeware
8 .\"----- Licensing notice ---------------------------------------------------
10 .\" This file is part of Trivial IP Encryption (TrIPE).
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.
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.
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.
26 .\"--------------------------------------------------------------------------
27 .so ../common/defs.man \" @@@PRE@@@
29 .\"--------------------------------------------------------------------------
30 .TH tripe-admin 5 "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 tripe-admin \- administrator commands for TrIPE
37 .\"--------------------------------------------------------------------------
40 This manual page describes the administration interface provided by the
46 program can be used either interactively or in scripts to communicate
47 with the server using this interface. Alternatively, simple custom
48 clients can be written in scripting languages such as Perl, Python or
49 Tcl, or more advanced clients such as GUI monitors can be written in C
50 with little difficulty.
52 Administration commands use a textual protocol. Each client command or
53 server response consists of a line of ASCII text terminated by a single
54 linefeed character. No command may be longer than 255 characters.
55 .SS "General structure"
56 Each command or response line consists of a sequence of
57 whitespace-separated tokens. The number and nature of whitespace
58 characters separating two tokens in a client command is not significant;
59 the server always uses a single space character. The first token in a
62 identifying the type of command or response contained. Keywords in
63 client commands are not case-sensitive; the server always uses uppercase
66 In order to allow tokens to contain internal whitespace, a quoting
67 mechanism is provided. Whitespace within matched pairs of quotes \(en
72 \(en is considered to be internal. Any character (other than newline)
73 may be escaped by preceding it with a backslash
75 in particular, this can be used to include quote characters. It is
76 impossible for a token to contain a newline character.
78 On output, the server will use double quotes when necessary.
80 For simple client command, the server responds with zero or more
82 lines, followed by either an
88 provides information requested in the command. An
90 response contains no further data. A
92 code is followed by a machine-readable explanation of why the command
95 Simple command processing is strictly synchronous: the server reads a
96 command, processes it, and responds, before reading the next command.
97 All commands can be run as simple commands. Long-running commands
102 block the client until they finish, but the rest of the server continues
104 .B "Background commands"
105 to find out how to issue long-running commands without blocking.
106 .SS "Asynchronous broadcasts"
107 There are three types of asynchronous broadcast messages which aren't
108 associated with any particular command. Clients can select which
109 broadcast messages they're interested in using the
115 message contains a machine-readable message warning of an error
116 encountered while processing a command, unexpected or unusual behaviour
117 by a peer, or a possible attack by an adversary. Under normal
118 conditions, the server shouldn't emit any warnings.
122 message contains a human-readable tracing message containing diagnostic
123 information. Trace messages are controlled using the
125 command-line option to the server, or the
127 administration command (see below). Support for tracing can be disabled
128 when the package is being configured, and may not be available in your
133 message is a machine-readable notification about some routine but
134 interesting event such as creation or destruction of peers.
135 .SS "Background commands"
140 take a long time to complete. To prevent these long-running commands
141 from tying up a server connection, they can be run in the background.
142 Not all commands can be run like this: the ones that can provide a
144 option, which must be supplied with a
147 A command may fail before it starts running in the background. In this
148 case, the server emits a
150 response, as usual. To indicate that a command has started running in
151 the background, the server emits a response of the form
152 .BI "BGDETACH " tag \fR,
155 is the value passed to the
157 option. From this point on, the server is ready to process more
158 commands and reply to them.
160 Responses to background commands are indicated by a line beginning with
166 followed by the command tag. These correspond to the
171 responses for simple commands:
173 indicates information from a background command which has not completed
178 indicates that a background command succeeded or failed, respectively.
180 A background command will never issue an
184 response: it will always detach and then issue any
189 .SS "Client-provided services"
190 .\"* 25 Service-related messages
191 An administration client can provide services to other clients.
192 Services are given names and versions. A client can attempt to
194 a particular service by issuing the
196 command. This may fail, for example, if some other client already
197 provides the same or later version of the service.
199 Other clients can issue
200 .I "service commands"
203 command; the service provider is expected to handle these commands and
206 There are three important asynchronous messages which will be sent to
209 .BI "SVCCANCEL " jobid
210 The named job has been cancelled, either because the issuing client has
211 disconnected or explicitly cancelled the job using the
215 .BI "SVCCLAIM " service " " version
216 Another client has claimed a later version of the named
218 The recipient is no longer the provider of this service.
220 .BI "SVCJOB " jobid " " service " " command " " args \fR...
221 Announces the arrival of a new job. The
223 is a simple token consisting of alphanumeric characters which
225 uses to identify this job.
227 The service provider can reply to the job using the commands
232 The first of these sends an
234 response and leaves the job active; the other two send an
238 response respectively, and mark the job as being complete.
242 is a potentially long-running command, it can be run in the background.
243 This detail is hidden from service providers:
245 will issue the corresponding
247 responses when appropriate.)
248 .SS "Network addresses"
249 A network address is a sequence of tokens. The first is a token
250 identifying the network address family. The length of an address and
251 the meanings of the subsequent tokens depend on the address family.
252 Address family tokens are not case-sensitive on input; on output, they
253 are always in upper-case.
255 At present, only one address family is understood.
257 .BI "INET " address " \fR[" port \fR]
258 An Internet socket, naming an IPv4 address and UDP port. On output, the
259 address is always in numeric dotted-quad form, and the port is given as
260 a plain number. On input, DNS hostnames and symbolic port names are
261 permitted; if omitted, the default port 4070 is used. Name resolution
262 does not block the main server, but will block the requesting client,
263 unless the command is run in the background.
265 If, on input, no recognized address family token is found, the following
266 tokens are assumed to represent an
268 address. Addresses output by the server always have an address family
270 .SS "Key-value output"
275 produce output in the form of
277 pairs, one per token. Neither the
283 Commands which enable or disable kinds of output (e.g.,
287 work in similar ways. They take a single optional argument, which
288 consists of a string of letters selecting message types, optionally
293 to disable, the subsequently listed types.
295 If the argument is omitted, the available message types are displayed,
298 line, in a fixed-column format. Column zero contains the key letter for
299 selecting that message type; column one contains either a space or a
301 sign, if the message type is disabled or enabled respectively; and a
302 textual description of the message type begins at column 3 and continues
303 to the end of the line.
305 Lowercase key letters control individual message types. Uppercase key
306 letters control collections of message types.
308 .\"--------------------------------------------------------------------------
309 .SH "COMMAND REFERENCE"
312 The commands provided are:
314 .BI "ADD \fR[" options "\fR] " peer " " address "\fR..."
315 Adds a new peer. The peer is given the name
317 the peer's public key is assumed to be in the file
319 (or whatever alternative file was specified in the
321 option on the command line). The
323 is the network address (see above for the format) at which the peer can
324 be contacted. The following options are recognized.
328 .BI "\-background " tag
329 Run the command in the background, using the given
333 Don't send an immediate challenge to the peer; instead, wait until it
334 sends us something before responding.
336 .BI "\-keepalive " time
337 Send a no-op packet if we've not sent a packet to the peer in the last
339 interval. This is useful for persuading port-translating firewalls to
340 believe that the `connection' is still active. The
342 is expressed as a nonnegative integer followed optionally by
348 for days, hours, minutes, or seconds respectively; if no suffix is
349 given, seconds are assumed.
354 to authenticate the peer. The default is to use the key tagged
358 The peer is a mobile device, and is likely to change address rapidly.
359 If a packet arrives from an unknown address, the server's usual response
360 is to log a warning and discard it. If the server knows of any mobile
361 peers, however, it will attempt to decrypt the packet using their keys,
362 and if one succeeds, the server will update its idea of the peer's
370 to authenticate to the peer. The default is to use the key named in the
372 command-line option, or a key with type
380 .BI "\-tunnel " tunnel
381 Use the named tunnel driver, rather than the default.
388 line reporting the IP address and port number stored for
391 .BI "ALGS \fR[" peer \fR]
392 Emits information about the cryptographic algorithms in use, in
395 is given, then describe the algorithms used in the association with that
396 peer; otherwise describe the default algorithms.
399 The keys are as follows.
402 Type of key-exchange group in use, currently either
407 .B kx-group-order-bits
408 Length of the group order, in bits. This gives an approximate measure
409 of the group strength.
412 Length of a group element, in bits. This may be useful when analyzing
416 The hash function in use, e.g.,
420 The mask-generating function in use, e.g.,
424 The size of the hash function's output, in octets.
427 The name of the bulk data cipher in use, e.g.,
431 The length of key used by the bulk data cipher, in octets.
434 The block size of the bulk data cipher, or zero if it's not based on a
438 The maximum amount of data to be encrypted using a single key. (A new
439 key exchange is instigated well before the limit is reached, in order to
440 allow for a seamless changeover of keys.)
443 The message authentication algorithm in use, e.g.,
444 .BR ripemd160-hmac ..
447 The length of the key used by the message authentication algorithm, in
451 The length of the message authentication tag, in octets.
453 The various sizes are useful, for example, when computing the MTU for a
456 is the MTU of the path to the peer, then the tunnel MTU should be
464 allowing 20 bytes of IP header, 8 bytes of UDP header, a packet type
465 octet, a four-octet sequence number, an IV, and a MAC tag.
469 Cancels the background job with the named
472 .BI "CHECKCHAL " challenge
473 Verifies a challenge as being one earlier issued by
475 and not previously either passed to
477 or in a greeting message.
480 Causes the server to disassociate itself from its terminal and become a
481 background task. This only works once. A warning is issued.
483 .BI "EPING \fR[" options "\fR] " peer
484 Sends an encrypted ping to the peer, and expects an encrypted response.
485 This checks that the peer is running (and not being impersonated), and
486 that it can encrypt and decrypt packets correctly. Options and
487 responses are the same as for the
492 Requests the server to begin a new key exchange with
497 Requests a challenge. The challenge is returned in an
499 line, as a base64-encoded string. See
502 .BI "GREET " peer " " challenge
503 Sends a greeting packet containing the
505 (base-64 encoded) to the named
507 The expectation is that this will cause the peer to recognize us and
508 begin a key-exchange.
511 Causes the server to emit an
513 line for each command it supports. Each line lists the command name,
514 followed by the names of the arguments. This may be helpful as a memory
515 aid for interactive use, or for program clients probing for features.
520 line containing the name of the network interface used to collect IP
521 packets which are to be encrypted and sent to
523 Used by configuration scripts so that they can set up routing tables
524 appropriately after adding new peers.
529 line giving the tag for each outstanding background job.
532 Causes the server to forget all about
534 All keys are destroyed, and no more packets are sent. No notification
535 is sent to the peer: if it's important that the peer be notified, you
536 must think of a way to do that yourself.
539 For each currently-known peer, an
541 line is written containing the peer's name, as given to
544 .BI "NOTIFY " tokens\fR...
547 notification to all interested administration clients.
550 Returns information about a peer, in key-value form. The following keys
555 The tunnel driver used for this peer.
558 The keepalive interval, in seconds, or zero if no keepalives are to be
562 The (short) key tag being used for the peer, as passed to the
567 The full key tag of the peer's public key currently being used. This
568 may change during the life of the association.
571 The private key tag being used for the peer, as passed to the
575 .B current-private-key
576 The full key tag of the private key currently being used for this
577 association. This may change during the life of the association.
580 .BI "PING \fR[" options "\fR] " peer
581 Send a transport-level ping to the peer. The ping and its response are
582 not encrypted or authenticated. This command, possibly in conjunction
583 with tracing, is useful for ensuring that UDP packets are actually
584 flowing in both directions. See also the
590 line is printed describing the outcome:
593 .BI "ping-ok " millis
594 A response was received
596 after the ping was sent.
599 No response was received within the time allowed.
602 The peer was killed (probably by another admin connection) before a
603 response was received.
606 Options recognized for this command are:
610 .BI "\-background " tag
611 Run the command in the background, using the given
614 .BI "\-timeout " time
617 seconds before giving up on a response. The default is 5 seconds. The
619 is expressed as a nonnegative integer followed optionally by
625 for days, hours, minutes, or seconds respectively; if no suffix is
626 given, seconds are assumed.
633 line containing just the number of the UDP port used by the
635 server. If you've allowed your server to allocate a port dynamically,
636 this is how to find out which one it chose.
639 Instructs the server to recheck its keyring files. The server checks
640 these periodically anyway but it may be necessary to force a recheck,
641 for example after adding a new peer key.
644 Instructs the server to exit immediately. A warning is sent.
647 Returns information about the server, in the form of key-value pairs.
648 The following keys are used.
652 A keyword naming the implementation of the
654 server. The current implementation is called
658 The server's version number, as reported by
666 if the server has or hasn't (respectively) become a daemon.
669 .BI "SETIFNAME " peer " " new-name
670 Informs the server that the
672 tunnel-interface name has been changed to
674 This is useful if firewalling decisions are made based on interface
675 names: a setup script for a particular peer can change the name, and
676 then update the server's records so that they're accurate.
678 .BI "SVCCLAIM " service " " version
679 Attempts to claim the named
683 The claim is successful if the service is currently unclaimed, or if
684 a version earlier than
686 is provided; otherwise the command fails with the error
687 .BR "service-exists" .
689 .BI "SVCENSURE " service " \fR[" version \fR]
692 is provided, and (if specified) to at least the given
694 An error is reported if these conditions are not met; otherwise the
695 command succeeds silently.
697 .BI "SVCFAIL " jobid " " tokens \fR...
702 response to the service job with the given
706 as the reason for failure. The job is closed.
708 .BI "SVCINFO " jobid " " tokens \fR...
713 response to the service job with the given
717 as the info message. The job remains open.
720 Output a line of the form
727 for each service currently provided.
735 response to the service job with the given
739 .BI "SVCQUERY " service
742 lines in key-value format, describing the named
744 The following keys are used.
751 The service's version string.
754 .BI "SVCRELEASE " service
755 Announce that the client no longer wishes to provide the named
758 .BI "SVCSUBMIT \fR[" options "\fR] " service " " command " " arguments \fR...
759 Submit a job to the provider of the given
765 The following options are accepted.
769 .BI "\-background " tag
770 Run the command in the background, using the given
773 .BI "\-version " version
774 Ensure that at least the given
776 of the service is available before submitting the job.
783 lines, each containing one or more statistics in the form
784 .IB name = value \fR.
785 The statistics-gathering is experimental and subject to change.
787 .BR "TRACE " [\fIoptions\fP]
788 Selects trace outputs: see
790 above. Message types provided are:
793 Currently, the following tracing options are supported:
796 Tunnel events: reception of packets to be encrypted, and injection of
797 successfully-decrypted packets.
800 Peer management events: creation and destruction of peer attachments,
801 and arrival of messages.
804 Administration interface: acceptance of new connections, and handling of
805 the backgroud name-resolution required by the
810 Handling of symmetric keysets: creation and expiry of keysets, and
811 encryption and decryption of messages.
814 Key exchange: reception, parsing and emission of key exchange messages.
817 Key management: loading keys and checking for file modifications.
820 Display information about challenge issuing and verification.
823 Display contents of packets sent and received by the tunnel and/or peer
827 Display inputs, outputs and intermediate results of cryptographic
828 operations. This includes plaintext and key material. Use with
840 outputs provide extra detail for other outputs. Specifying
846 isn't useful; neither is specifying
857 For each available tunnel driver, an
859 line is printed giving its name.
862 Causes the server to emit an
864 line stating its software version, as two tokens: the server name, and
865 its version string. The server name
867 is reserved to the Straylight/Edgeware implementation.
869 .BR "WATCH " [\fIoptions\fP]
870 Enables or disables asynchronous broadcasts
871 .IR "for the current connection only" .
874 above. The default watch state for the connection the server opens
875 automatically on stdin/stdout is to show warnings and trace messages;
876 other connections show no asynchronous broadcast messages. (This is
877 done in order to guarantee that a program reading the server's stdout
878 does not miss any warnings.)
881 Message types provided are:
899 .BI "WARN " tokens\fR...
902 warning to all interested administration clients.
904 .\"--------------------------------------------------------------------------
907 .\"* 20 Error messages (FAIL codes)
912 messages are sent to clients as a result of errors during command
920 server is already running as a daemon.
922 .BI "bad-addr-syntax " message
923 (For commands accepting socket addresses.) The address couldn't be
926 .BI "bad-syntax " cmd " " message
927 (For any command.) The command couldn't be understood: e.g., the number
928 of arguments was wrong.
930 .BI "bad-time-spec " token
933 is not a valid time interval specification. Acceptable time
934 specifications are nonnegative integers followed optionally by
940 for days, hours, minutes, or seconds, respectively.
942 .BI "bad-trace-option " char
945 An unknown trace option was requested.
947 .BI "bad-watch-option " char
950 An unknown watch option was requested.
952 .BI "daemon-error " ecode " " message
955 An error occurred during the attempt to become a daemon, as reported by
958 .BI "invalid-port " number
961 The given port number is out of range.
963 .BI "not-service-provider " service
966 The invoking client is not the current provider of the named
968 and is therefore not allowed to release it.
970 .BI "peer-create-fail " peer
975 failed for some reason. A warning should have been emitted explaining
978 .BI "peer-addr-exists " address\fR...
981 There is already a peer with the given
984 .BI "peer-exists " peer
987 There is already a peer named
990 .B "ping-send-failed"
991 The attempt to send a ping packet failed, probably due to lack of
994 .BI "resolve-error " hostname
999 could not be resolved.
1001 .BI "resolver-timeout " hostname
1006 took too long to resolve.
1008 .BI "service-exists " service " " version
1011 Another client is already providing the stated
1016 .BI "service-too-old " service " " version
1025 is available, which does not meet the stated requirements.
1027 .BI "tag-exists " tag
1028 (For long-running commands.) The named
1030 is already the tag of an outstanding job.
1032 .BI "unknown-command " token
1037 .BI "unknown-jobid " jobid
1045 is not recognized as identifying an outstanding job. It may have just
1048 .BI "unknown-peer " name
1056 There is no peer called
1059 .BI "unknown-port " port
1064 couldn't be found in
1067 .BI "unknown-service " service
1076 is not recognized as the name of a client-provided service.
1078 .BI "unknown-tag " tag
1083 is not the tag for any outstanding background job. It may have just
1086 .\"--------------------------------------------------------------------------
1089 .\"* 30 Notification broadcasts (NOTE codes)
1090 The following notifications are sent to clients who request them.
1092 .BI "ADD " peer " " ifname " " address \fR...
1093 A new peer has been added. The peer's name is
1095 its tunnel is network interface
1097 and its network address is
1101 The server has forked off into the sunset and become a daemon.
1103 .BI "GREET " challenge " " address \fR...
1104 A valid greeting was received, with the given challenge (exactly as it
1117 finished successfully.
1122 has begun or restarted. If key exchange keeps failing, this message
1123 will be repeated periodically.
1125 .BI "NEWADDR " peer " " address
1128 IP address has been changed to
1131 .BI "NEWIFNAME " peer " " old-name " " new-name
1134 tunnel interface name has been changed from
1142 .BI "SVCCLAIM " service " " version
1145 is now available, at the stated
1148 .BI "SVCRELEASE " service
1151 is no longer available.
1153 .BI "USER " tokens\fR...
1154 An administration client issued a notification using the
1158 .\"--------------------------------------------------------------------------
1161 .\"* 40 Warning broadcasts (WARN codes)
1163 There are many possible warnings. They are categorized according to
1166 Many of these warnings report system errors. These are reported as a
1167 pair of tokens, described below as
1173 is a string of the form
1177 value of the error; the
1179 is the `human-readable' form of the message, as reported by
1181 .SS "ABORT warnings"
1182 These all indicate that the
1184 server has become unable to continue. If enabled, the server will dump
1185 core in its configuration directory.
1187 .BI "ABORT repeated-select-errors"
1188 The main event loop is repeatedly failing. If the server doesn't quit,
1189 it will probably waste all available CPU doing nothing.
1190 .SS "ADMIN warnings"
1191 These indicate a problem with the administration socket interface.
1193 .BI "ADMIN accept-error " ecode " " message
1194 There was an error while attempting to accept a connection from a new
1197 .BI "ADMIN client-write-error " ecode " " message
1198 There was an error sending data to a client. The connection to the
1199 client has been closed.
1201 These indicate errors in challenges, either in the
1203 command or in greeting packets.
1205 .B "CHAL impossible-challenge"
1206 The server hasn't issued any challenges yet. Quite how anyone else
1207 thought he could make one up is hard to imagine.
1209 .B "CHAL incorrect-tag"
1210 Challenge received contained the wrong authentication data. It might be
1211 very stale, or a forgery.
1213 .B "CHAL invalid-challenge"
1214 Challenge received was the wrong length. We might have changed MAC
1215 algorithms since the challenge was issued, or it might just be rubbish.
1217 .B "CHAL replay duplicated-sequence"
1218 Challenge received was a definite replay of an old challenge. Someone's
1221 .B "CHAL replay old-sequence"
1222 Challenge received was old, but maybe not actually a replay. Try again.
1223 .SS "KEYMGMT warnings"
1224 These indicate a problem with the keyring files, or the keys stored in
1225 them. The first token is either
1231 in the descriptions below) indicating which keyring file is problematic,
1232 and the second token is the filename of the keyring. Frequently a key
1233 tag may be given next, preceded by the token
1236 .BI "KEYMGMT public-keyring " file " key " tag " algorithm-mismatch"
1237 A peer's public key doesn't request the same algorithms as our private
1240 .BI "KEYMGMT " which "-keyring " file " key " tag " bad-tag-length " len
1241 The key attributes specify the length of MAC tag as
1243 but this is an invalid value \(en either too large or not a multiple of
1246 .BI "KEYMGMT " which "-keyring " file " key " tag " bad-tag-length-string " str
1247 The key attributes contain
1249 where a MAC tag length was expected. The key was generated wrongly.
1251 .BI "KEYMGMT private-keyring " file " key " tag " changed-group"
1252 The private keyring has been changed, but the new private key can't be
1253 used because it uses a different group for Diffie\(enHellman key
1256 .BI "KEYMGMT " which "-keyring " file " io-error " ecode " " message
1257 A system error occurred while opening or reading the keyring file.
1259 .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-cipher " cipher
1260 The key specifies the use of an unknown symmetric encryption algorithm
1262 Maybe the key was generated wrongly, or maybe the version of
1263 Catacomb installed is too old.
1265 .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-group-type " type
1266 The key specifies the use of a Diffie\(enHellman group of an unknown
1268 Maybe the key was generated wrongly, or maybe the version of
1272 .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-hash " hash
1273 The key specifies the use of an unknown hash function
1275 Maybe the key was generated wrongly, or maybe the version of Catacomb
1276 installed is too old.
1278 .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-mac " mac
1279 The key specifies the use of an unknown message authentication code
1281 Maybe the key was generated wrongly, or maybe the version of Catacomb
1282 installed is too old.
1284 .BI "KEYMGMT " which "-keyring " file " key " tag " unknown-mgf-cipher " mgf
1285 The key specifies the use of an unknown symmetric encryption function
1287 for mask generation. Maybe the key was generated wrongly, or maybe the
1288 version of Catacomb installed is too old.
1290 .BI "KEYMGMT " which "-keyring " file " key " tag " no-hmac-for-hash " hash
1291 No message authentication code was given explicitly, and there's no
1292 implementation of HMAC for the selected hash function
1295 .BI "KEYMGMT " which "-keyring " file " key " tag " " alg " " name " no-key-size " hashsz
1302 The named algorithm requires more key material than the hash function
1303 can provide. You must change either the hash function, or the cipher or
1306 .BI "KEYMGMT " which "-keyring " file " key " tag " mgf " mgf " restrictive-key-schedule"
1307 The cipher selected for mask-generation is unsuitable because it can't
1308 accept arbitrary-sized keys.
1310 .BI "KEYMGMT " which "-keyring " file " key-not-found " tag
1313 couldn't be found in the keyring.
1315 .BI "KEYMGMT " which "-keyring " file " line " line " " message
1316 The contents of the keyring file are invalid. There may well be a bug
1321 These indicate problems during key-exchange. Many indicate either a bug
1322 in the server (either yours or the remote one), or some kind of attack
1323 in progress. All name a
1325 as the second token: this is the peer the packet is apparently from,
1326 though it may have been sent by an attacker instead.
1328 In the descriptions below,
1330 is one of the tokens
1339 .BI "KX " peer " algorithms-mismatch local-private-key " privtag " peer-public-key " pubtag
1340 The algorithms specified in the peer's public key
1342 don't match the ones described in the private key
1345 .BI "KX " peer " bad-expected-reply-log"
1348 uses in its protocol contain a check value which proves that the
1349 challenge is honest. This message indicates that the check value
1350 supplied is wrong: someone is attempting to use bogus challenges to
1353 server to leak private key information. No chance!
1355 .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok"
1356 A symmetrically-encrypted portion of a key-exchange message failed to
1359 .BI "KX " peer " invalid " msgtoken
1360 A key-exchange message was malformed. This almost certainly indicates a
1363 .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok"
1364 A message didn't contain the right magic data. This may be a replay of
1365 some old exchange, or random packets being sent in an attempt to waste
1368 .BI "KX " peer " " which "-key-expired"
1369 The local private key or the peer's public key (distinguished by
1371 has expired. Either you or the peer's maintainer should have arranged
1372 for a replacement before now.
1374 .BI "KX " peer " sending-cookie"
1375 We've received too many bogus pre-challenge messages. Someone is trying
1376 to flood us with key-exchange messages and make us waste CPU on doing
1377 hard asymmetric crypto sums.
1379 .BI "KX " peer " unexpected " msgtoken
1380 The message received wasn't appropriate for this stage of the key
1381 exchange process. This may mean that one of our previous packets got
1384 it may simply mean that the peer has recently restarted.
1386 .BI "KX " peer " unknown-challenge"
1387 The peer is asking for an answer to a challenge which we don't know
1388 about. This may mean that we've been inundated with challenges from
1389 some malicious source
1390 .I who can read our messages
1391 and discarded the valid one.
1393 .BI "KX " peer " unknown-message 0x" nn
1394 An unknown key-exchange message arrived.
1396 These are largely concerned with management of peers and the low-level
1397 details of the network protocol. The second token is usually the name of
1400 if none is relevant.
1402 .BI "PEER " peer " bad-packet no-type"
1403 An empty packet arrived. This is very strange.
1405 .BI "PEER " peer " bad-packet unknown-category 0x" nn
1406 The message category
1408 (in hex) isn't understood. Probably a strange random packet from
1409 somewhere; could be an unlikely bug.
1411 .BI "PEER " peer " bad-packet unknown-type 0x" nn
1414 (in hex) isn't understood. Probably a strange random packet from
1415 somewhere; could be an unlikely bug.
1417 .BI "PEER " peer " corrupt-encrypted-ping"
1418 The peer sent a ping response which matches an outstanding ping, but its
1419 payload is wrong. There's definitely a bug somewhere.
1421 .BI "PEER " peer " corrupt-transport-ping"
1422 The peer (apparently) sent a ping response which matches an outstanding
1423 ping, but its payload is wrong. Either there's a bug, or the bad guys
1424 are playing tricks on you.
1426 .BI "PEER " peer " decrypt-failed"
1427 An encrypted IP packet failed to decrypt. It may have been mangled in
1428 transit, or may be a very old packet from an expired previous session
1429 key. There is usually a considerable overlap in the validity periods of
1430 successive session keys, so this shouldn't occur unless the key exchange
1431 takes ages or fails.
1433 .BI "PEER " peer " malformed-encrypted-ping"
1434 The peer sent a ping response which is hopelessly invalid. There's
1435 definitely a bug somewhere.
1437 .BI "PEER " peer " malformed-transport-ping"
1438 The peer (apparently) sent a ping response which is hopelessly invalid.
1439 Either there's a bug, or the bad guys are playing tricks on you.
1441 .BI "PEER " peer " packet-build-failed"
1442 There wasn't enough space in our buffer to put the packet we wanted to
1443 send. Shouldn't happen.
1445 .BI "PEER \- socket-read-error " ecode " " message
1446 An error occurred trying to read an incoming packet.
1448 .BI "PEER " peer " socket-write-error " ecode " " message
1449 An error occurred attempting to send a network packet. We lost that
1452 .BI "PEER " peer " unexpected-encrypted-ping 0x" id
1453 The peer sent an encrypted ping response whose id doesn't match any
1454 outstanding ping. Maybe it was delayed for longer than the server was
1455 willing to wait, or maybe the peer has gone mad.
1457 .BI "PEER \- unexpected-source " address\fR...
1458 A packet arrived from
1460 (a network address \(en see above), but no peer is known at that
1461 address. This may indicate a misconfiguration, or simply be a result of
1462 one end of a connection being set up before the other.
1464 .BI "PEER " peer " unexpected-transport-ping 0x" id
1465 The peer (apparently) sent a transport ping response whose id doesn't
1466 match any outstanding ping. Maybe it was delayed for longer than the
1467 server was willing to wait, or maybe the peer has gone mad; or maybe
1468 there are bad people trying to confuse you.
1469 .SS "SERVER warnings"
1470 These indicate problems concerning the server process as a whole.
1472 .BI "SERVER ignore signal " name
1473 A signal arrived, but the server ignored it. Currently this happens for
1475 because that's a popular way of telling daemons to re-read their
1476 configuration files. Since
1478 re-reads its keyrings automatically and has no other configuration
1479 files, it's not relevant, but it seemed better to ignore the signal than
1482 .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR]
1483 A signal arrived and
1487 .BI "SERVER quit admin-request"
1488 A client of the administration interface issued a
1492 .BI "SERVER quit foreground-eof"
1493 The server is running in foreground mode (the
1495 option), and encountered end-of-file on standard input.
1497 .BI "SERVER select-error " ecode " " message
1498 An error occurred in the server's main event loop. This is bad: if it
1499 happens too many times, the server will abort.
1501 These are concerned with the symmetric encryption and decryption
1504 .BI "SYMM replay old-sequence"
1505 A packet was received with an old sequence number. It may just have
1506 been delayed or duplicated, or it may have been an attempt at a replay
1509 .BI "SYMM replay duplicated-sequence"
1510 A packet was received with a sequence number we've definitely seen
1511 before. It may be an accidental duplication because the 'net is like
1512 that, or a deliberate attempt at a replay.
1514 These concern the workings of the system-specific tunnel driver. The
1515 second token is the name of the tunnel interface in question, or
1519 .BI "TUN \- bsd no-tunnel-devices"
1520 The driver couldn't find an available tunnel device. Maybe if you
1523 files, it will work.
1525 .BI "TUN \- " tun-name " open-error " device " " ecode " " message
1526 An attempt to open the tunnel device file
1530 .BI "TUN \- linux config-error " ecode " " message
1531 Configuring the Linux TUN/TAP interface failed.
1533 .BI "TUN " ifname " " tun-name " read-error " ecode " " message
1534 Reading from the tunnel device failed.
1536 .BI "TUN " ifname " " tun-name " write-error " ecode " " message
1537 Writing from the tunnel device failed.
1539 .BI "TUN " ifname " slip bad-escape"
1540 The SLIP driver encountered a escaped byte it wasn't expecting to see.
1541 The erroneous packet will be ignored.
1543 .BI "TUN " ifname " slip eof"
1544 The SLIP driver encountered end-of-file on its input descriptor.
1545 Pending data is discarded, and no attempt is made to read any more data
1546 from that interface ever.
1548 .BI "TUN " ifname " slip escape-end"
1549 The SLIP driver encountered an escaped `end' marker. This probably
1550 means that someone's been sending it junk. The erroneous packet is
1551 discarded, and we hope that we've rediscovered synchronization.
1553 .BI "TUN \- slip fork-error " ecode " " message
1554 The SLIP driver encountered an error forking a child process while
1555 allocating a new dynamic interface.
1557 .BI "TUN \- slip no-slip-interfaces"
1558 The driver ran out of static SLIP interfaces. Either preallocate more,
1559 or use dynamic SLIP interface allocation.
1561 .BI "TUN " ifname " slip overflow"
1562 The SLIP driver gave up reading a packet because it got too large.
1564 .BI "TUN \- slip pipe-error " ecode " " message
1565 The SLIP driver encountered an error creating pipes while allocating a
1566 new dynamic interface.
1568 .BI "TUN \- slip read-ifname-failed " ecode " " message
1569 The SLIP driver encountered an error reading the name of a dynamically
1570 allocated interface. Maybe the allocation script is broken.
1572 .BI "TUN \- unet config-error " ecode " " message
1573 Configuring the Linux Unet interface failed. Unet is obsolete and
1574 shouldn't be used any more.
1576 .BI "TUN \- unet getinfo-error " ecode " " message
1577 Reading information about the Unet interface failed. Unet is obsolete
1578 and shouldn't be used any more.
1580 These are issued by administration clients using the
1584 .BI "USER " tokens\fR...
1585 An administration client issued a warning.
1588 .\"--------------------------------------------------------------------------
1591 .SS "Command responses"
1594 .BI "BGFAIL " tag " " tokens \fR...
1595 .BI "BGINFO " tag " " tokens \fR...
1597 .BI "FAIL " tokens \fR...
1598 .BI "INFO " tokens \fR...
1603 .\"--------------------------------------------------------------------------
1609 .IR "The Trivial IP Encryption Protocol" .
1611 .\"--------------------------------------------------------------------------
1614 Mark Wooding, <mdw@distorted.org.uk>
1616 .\"----- That's all, folks --------------------------------------------------
~mdw / tripe / blob