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 ../defs.man.in \" @@@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
217 .I service. The recipient is no longer the provider of this service.
219 .BI "SVCJOB " jobid " " service " " command " " args \fR...
220 Announces the arrival of a new job. The
222 is a simple token consisting of alphanumeric characters which
224 uses to identify this job.
226 The service provider can reply to the job using the commands
231 The first of these sends an
233 response and leaves the job active; the other two send an
237 response respectively, and mark the job as being complete.
241 is a potentially long-running command, it can be run in the background.
242 This detail is hidden from service providers:
244 will issue the corresponding
246 responses when appropriate.)
247 .SS "Network addresses"
248 A network address is a sequence of tokens. The first is a token
249 identifying the network address family. The length of an address and
250 the meanings of the subsequent tokens depend on the address family.
251 Address family tokens are not case-sensitive on input; on output, they
252 are always in upper-case.
254 At present, only one address family is understood.
256 .BI "INET " address " \fR[" port \fR]
257 An Internet socket, naming an IPv4 address and UDP port. On output, the
258 address is always in numeric dotted-quad form, and the port is given as
259 a plain number. On input, DNS hostnames and symbolic port names are
260 permitted; if omitted, the default port 4070 is used. Name resolution
261 does not block the main server, but will block the requesting client,
262 unless the command is run in the background.
264 If, on input, no recognised address family token is found, the following
265 tokens are assumed to represent an
267 address. Addresses output by the server always have an address family
269 .SS "Key-value output"
274 produce output in the form of
276 pairs, one per token. Neither the
282 Commands which enable or disable kinds of output (e.g.,
286 work in similar ways. They take a single optional argument, which
287 consists of a string of letters selecting message types, optionally
292 to disable, the subsequently listed types.
294 If the argument is omitted, the available message types are displayed,
297 line, in a fixed-column format. Column zero contains the key letter for
298 selecting that message type; column one contains either a space or a
300 sign, if the message type is disabled or enabled respectively; and a
301 textual description of the message type begins at column 3 and continues
302 to the end of the line.
304 Lowercase key letters control individual message types. Uppercase key
305 letters control collections of message types.
307 .\"--------------------------------------------------------------------------
308 .SH "COMMAND REFERENCE"
311 The commands provided are:
313 .BI "ADD \fR[" options "\fR] " peer " " address "\fR..."
314 Adds a new peer. The peer is given the name
316 the peer's public key is assumed to be in the file
318 (or whatever alternative file was specified in the
320 option on the command line). The
322 is the network address (see above for the format) at which the peer can
323 be contacted. The following options are recognised.
327 .BI "\-background " tag
328 Run the command in the background, using the given
332 Don't send an immediate challenge to the peer; instead, wait until it
333 sends us something before responding.
335 .BI "\-keepalive " time
336 Send a no-op packet if we've not sent a packet to the peer in the last
338 interval. This is useful for persuading port-translating firewalls to
339 believe that the `connection' is still active. The
341 is expressed as a nonnegative integer followed optionally by
347 for days, hours, minutes, or seconds respectively; if no suffix is
348 given, seconds are assumed.
350 .BI "\-tunnel " tunnel
351 Use the named tunnel driver, rather than the default.
358 line reporting the IP address and port number stored for
362 Emits information about the cryptographic algorithms in use, in
363 key-value form. The keys are as follows.
367 Type of key-exchange group in use, currently either
372 .B kx-group-order-bits
373 Length of the group order, in bits. This gives an approximate measure
374 of the group strength.
377 Length of a group element, in bits. This may be useful when analyzing
381 The hash function in use, e.g.,
385 The mask-generating function in use, e.g.,
389 The size of the hash function's output, in octets.
392 The name of the bulk data cipher in use, e.g.,
396 The length of key used by the bulk data cipher, in octets.
399 The block size of the bulk data cipher, or zero if it's not based on a
403 The maximum amount of data to be encrypted using a single key. (A new
404 key exchange is instigated well before the limit is reached, in order to
405 allow for a seamless changeover of keys.)
408 The message authentication algorithm in use, e.g.,
409 .BR ripemd160-hmac ..
412 The length of the key used by the message authentication algorithm, in
416 The length of the message authentication tag, in octets.
418 The various sizes are useful, for example, when computing the MTU for a
421 is the MTU of the path to the peer, then the tunnel MTU should be
429 allowing 20 bytes of IP header, 8 bytes of UDP header, a packet type
430 octet, a four-octet sequence number, an IV, and a MAC tag.
434 Cancels the background job with the named
437 .BI "CHECKCHAL " challenge
438 Verifies a challenge as being one earlier issued by
440 and not previously either passed to
442 or in a greeting message.
445 Causes the server to disassociate itself from its terminal and become a
446 background task. This only works once. A warning is issued.
448 .BI "EPING \fR[" options "\fR] " peer
449 Sends an encrypted ping to the peer, and expects an encrypted response.
450 This checks that the peer is running (and not being impersonated), and
451 that it can encrypt and decrypt packets correctly. Options and
452 responses are the same as for the
457 Requests the server to begin a new key exchange with
462 Requests a challenge. The challenge is returned in an
464 line, as a base64-encoded string. See
467 .BI "GREET " peer " " challenge
468 Sends a greeting packet containing the
470 (base-64 encoded) to the named
472 The expectation is that this will cause the peer to recognize us and
473 begin a key-exchange.
476 Causes the server to emit an
478 line for each command it supports. Each line lists the command name,
479 followed by the names of the arguments. This may be helpful as a memory
480 aid for interactive use, or for program clients probing for features.
485 line containing the name of the network interface used to collect IP
486 packets which are to be encrypted and sent to
488 Used by configuration scripts so that they can set up routing tables
489 appropriately after adding new peers.
494 line giving the tag for each outstanding background job.
497 Causes the server to forget all about
499 All keys are destroyed, and no more packets are sent. No notification
500 is sent to the peer: if it's important that the peer be notified, you
501 must think of a way to do that yourself.
504 For each currently-known peer, an
506 line is written containing the peer's name, as given to
509 .BI "NOTIFY " tokens\fR...
512 notification to all interested administration clients.
515 Returns information about a peer, in key-value form. The following keys
520 The tunnel driver used for this peer.
523 The keepalive interval, in seconds, or zero if no keepalives are to be
527 .BI "PING \fR[" options "\fR] " peer
528 Send a transport-level ping to the peer. The ping and its response are
529 not encrypted or authenticated. This command, possibly in conjunction
530 with tracing, is useful for ensuring that UDP packets are actually
531 flowing in both directions. See also the
537 line is printed describing the outcome:
540 .BI "ping-ok " millis
541 A response was received
543 after the ping was sent.
546 No response was received within the time allowed.
549 The peer was killed (probably by another admin connection) before a
550 response was received.
553 Options recognized for this command are:
557 .BI "\-background " tag
558 Run the command in the background, using the given
561 .BI "\-timeout " time
564 seconds before giving up on a response. The default is 5 seconds. The
566 is expressed as a nonnegative integer followed optionally by
572 for days, hours, minutes, or seconds respectively; if no suffix is
573 given, seconds are assumed.
580 line containing just the number of the UDP port used by the
582 server. If you've allowed your server to allocate a port dynamically,
583 this is how to find out which one it chose.
586 Instructs the server to recheck its keyring files. The server checks
587 these periodically anyway but it may be necessary to force a recheck,
588 for example after adding a new peer key.
591 Instructs the server to exit immediately. A warning is sent.
594 Returns information about the server, in the form of key-value pairs.
595 The following keys are used.
599 A keyword naming the implementation of the
601 server. The current implementation is called
605 The server's version number, as reported by
613 if the server has or hasn't (respectively) become a daemon.
616 .BI "SETIFNAME " peer " " new-name
617 Informs the server that the
619 tunnel-interface name has been changed to
621 This is useful if firewalling decisions are made based on interface
622 names: a setup script for a particular peer can change the name, and
623 then update the server's records so that they're accurate.
625 .BI "SVCCLAIM " service " " version
626 Attempts to claim the named
630 The claim is successful if the service is currently unclaimed, or if
631 a version earlier than
633 is provided; otherwise the command fails with the error
634 .BR "service-exists" .
636 .BI "SVCENSURE " service " \fR[" version \fR]
639 is provided, and (if specified) to at least the given
641 An error is reported if these conditions are not met; otherwise the
642 command succeeds silently.
644 .BI "SVCFAIL " jobid " " tokens \fR...
649 response to the service job with the given
653 as the reason for failure. The job is closed.
655 .BI "SVCINFO " jobid " " tokens \fR...
660 response to the service job with the given
664 as the info message. The job remains open.
667 Output a line of the form
674 for each service currently provided.
682 response to the service job with the given
686 .BI "SVCQUERY " service
689 lines in key-value format, describing the named
691 The following keys are used.
698 The service's version string.
701 .BI "SVCRELEASE " service
702 Announce that the client no longer wishes to provide the named
705 .BI "SVCSUBMIT \fR[" options "\fR] " service " " command " " arguments \fR...
706 Submit a job to the provider of the given
712 The following options are accepted.
716 .BI "\-background " tag
717 Run the command in the background, using the given
720 .BI "\-version " version
721 Ensure that at least the given
723 of the service is available before submitting the job.
730 lines, each containing one or more statistics in the form
731 .IB name = value \fR.
732 The statistics-gathering is experimental and subject to change.
734 .BR "TRACE " [\fIoptions\fP]
735 Selects trace outputs: see
737 above. Message types provided are:
740 Currently, the following tracing options are supported:
743 Tunnel events: reception of packets to be encrypted, and injection of
744 successfully-decrypted packets.
747 Peer management events: creation and destruction of peer attachments,
748 and arrival of messages.
751 Administration interface: acceptance of new connections, and handling of
752 the backgroud name-resolution required by the
757 Handling of symmetric keysets: creation and expiry of keysets, and
758 encryption and decryption of messages.
761 Key exchange: reception, parsing and emission of key exchange messages.
764 Key management: loading keys and checking for file modifications.
767 Display information about challenge issuing and verification.
770 Display contents of packets sent and received by the tunnel and/or peer
774 Display inputs, outputs and intermediate results of cryptographic
775 operations. This includes plaintext and key material. Use with
787 outputs provide extra detail for other outputs. Specifying
793 isn't useful; neither is specifying
804 For each available tunnel driver, an
806 line is printed giving its name.
809 Causes the server to emit an
811 line stating its software version, as two tokens: the server name, and
812 its version string. The server name
814 is reserved to the Straylight/Edgeware implementation.
816 .BR "WATCH " [\fIoptions\fP]
817 Enables or disables asynchronous broadcasts
818 .IR "for the current connection only" .
821 above. The default watch state for the connection the server opens
822 automatically on stdin/stdout is to show warnings and trace messages;
823 other connections show no asynchronous broadcast messages. (This is
824 done in order to guarantee that a program reading the server's stdout
825 does not miss any warnings.)
828 Message types provided are:
846 .BI "WARN " tokens\fR...
849 warning to all interested administration clients.
851 .\"--------------------------------------------------------------------------
854 .\"* 20 Error messages (FAIL codes)
859 messages are sent to clients as a result of errors during command
867 server is already running as a daemon.
869 .BI "bad-addr-syntax " message
870 (For commands accepting socket addresses.) The address couldn't be
873 .BI "bad-syntax " cmd " " message
874 (For any command.) The command couldn't be understood: e.g., the number
875 of arguments was wrong.
877 .BI "bad-time-spec " token
880 is not a valid time interval specification. Acceptable time
881 specifications are nonnegative integers followed optionally by
887 for days, hours, minutes, or seconds, respectively.
889 .BI "bad-trace-option " char
892 An unknown trace option was requested.
894 .BI "bad-watch-option " char
897 An unknown watch option was requested.
899 .BI "daemon-error " ecode " " message
902 An error occurred during the attempt to become a daemon, as reported by
905 .BI "invalid-port " number
908 The given port number is out of range.
910 .BI "not-service-provider " service
913 The invoking client is not the current provider of the named
915 and is therefore not allowed to release it.
917 .BI "peer-create-fail " peer
922 failed for some reason. A warning should have been emitted explaining
925 .BI "peer-addr-exists " address\fR...
928 There is already a peer with the given
931 .BI "peer-exists " peer
934 There is already a peer named
937 .B "ping-send-failed"
938 The attempt to send a ping packet failed, probably due to lack of
941 .BI "resolve-error " hostname
946 could not be resolved.
948 .BI "resolver-timeout " hostname
953 took too long to resolve.
955 .BI "service-exists " service " " version
958 Another client is already providing the stated
963 .BI "service-too-old " service " " version
972 is available, which does not meet the stated requirements.
974 .BI "tag-exists " tag
975 (For long-running commands.) The named
977 is already the tag of an outstanding job.
979 .BI "unknown-command " token
984 .BI "unknown-peer " name
992 There is no peer called
995 .BI "unknown-port " port
1000 couldn't be found in
1003 .BI "unknown-service " service
1012 is not recognized as the name of a client-provided service.
1014 .BI "unknown-tag " tag
1019 is not the tag for any outstanding background job. It may have just
1022 .\"--------------------------------------------------------------------------
1025 .\"* 30 Notification broadcasts (NOTE codes)
1026 The following notifications are sent to clients who request them.
1028 .BI "ADD " peer " " ifname " " address \fR...
1029 A new peer has been added. The peer's name is
1031 its tunnel is network interface
1033 and its network address is
1037 The server has forked off into the sunset and become a daemon.
1039 .BI "GREET " challenge " " address \fR...
1040 A valid greeting was received, with the given challenge (exactly as it
1053 finished successfully.
1058 has begun or restarted. If key exchange keeps failing, this message
1059 will be repeated periodically.
1061 .BI "NEWIFNAME " peer " " old-name " " new-name
1064 tunnel interface name has been changed from
1072 .BI "SVCCLAIM " service " " version
1075 is now available, at the stated
1078 .BI "SVCRELEASE " service
1081 is no longer available.
1083 .BI "USER " tokens\fR...
1084 An administration client issued a notification using the
1088 .\"--------------------------------------------------------------------------
1091 .\"* 40 Warning broadcasts (WARN codes)
1093 There are many possible warnings. They are categorized according to
1096 Many of these warnings report system errors. These are reported as a
1097 pair of tokens, described below as
1103 is a string of the form
1107 value of the error; the
1109 is the `human-readable' form of the message, as reported by
1111 .SS "ABORT warnings"
1112 These all indicate that the
1114 server has become unable to continue. If enabled, the server will dump
1115 core in its configuration directory.
1117 .BI "ABORT repeated-select-errors"
1118 The main event loop is repeatedly failing. If the server doesn't quit,
1119 it will probably waste all available CPU doing nothing.
1120 .SS "ADMIN warnings"
1121 These indicate a problem with the administration socket interface.
1123 .BI "ADMIN accept-error " ecode " " message
1124 There was an error while attempting to accept a connection from a new
1127 .BI "ADMIN client-write-error " ecode " " message
1128 There was an error sending data to a client. The connection to the
1129 client has been closed.
1131 These indicate errors in challenges, either in the
1133 command or in greeting packets.
1135 .B "CHAL impossible-challenge"
1136 The server hasn't issued any challenges yet. Quite how anyone else
1137 thought he could make one up is hard to imagine.
1139 .B "CHAL incorrect-tag"
1140 Challenge received contained the wrong authentication data. It might be
1141 very stale, or a forgery.
1143 .B "CHAL invalid-challenge"
1144 Challenge received was the wrong length. We might have changed MAC
1145 algorithms since the challenge was issued, or it might just be rubbish.
1147 .B "CHAL replay duplicated-sequence"
1148 Challenge received was a definite replay of an old challenge. Someone's
1151 .B "CHAL replay old-sequence"
1152 Challenge received was old, but maybe not actually a replay. Try again.
1153 .SS "KEYMGMT warnings"
1154 These indicate a problem with the keyring files, or the keys stored in
1157 .BI "KEYMGMT bad-private-key " message
1158 The private key could not be read, or failed a consistency check. If
1159 there was a problem with the file, usually there will have been
1161 warnings before this.
1163 .BI "KEYMGMT bad-public-keyring " message
1164 The public keyring couldn't be read. Usually, there will have been
1166 warnings before this.
1168 .BI "KEYMGMT key-file-error " file ":" line " " message
1169 Reports a specific error with the named keyring file. This probably
1173 .BI "KEYMGMT public-key " tag " " tokens\fR...
1174 These messages all indicate a problem with the public key named
1177 .BI "KEYMGMT public-key " tag " algorithm-mismatch"
1178 The algorithms specified on the public key don't match the ones for our
1179 private key. All the peers in a network have to use the same
1182 .BI "KEYMGMT public-key " tag " bad " message
1183 The public key couldn't be read, or is invalid.
1185 .BI "KEYMGMT public-key " tag " bad-public-group-element"
1186 The public key is invalid. This may indicate a malicious attempt to
1187 introduce a bogus key.
1189 .BI "KEYMGMT public-key " tag " bad-algorithm-selection"
1190 The algorithms listed on the public key couldn't be understood. The
1191 algorithm selection attributes are probably malformed and need fixing.
1193 .BI "KEYMGMT public-key " tag " incorrect-group"
1194 The public key doesn't use the same group as our private key. All the
1195 peers in a network have to use the same group.
1197 .BI "KEYMGMT public-key " tag " not-found"
1198 The public key for peer
1200 wasn't in the public keyring.
1202 .BI "KEYMGMT public-key " tag " unknown-type"
1203 The type of the public key isn't understood. Maybe you need to upgrade
1206 (Even if you do, you'll have to regenerate your keys.)
1208 These indicate problems during key-exchange. Many indicate either a bug
1209 in the server (either yours or the remote one), or some kind of attack
1210 in progress. All name a
1212 as the second token: this is the peer the packet is apparently from,
1213 though it may have been sent by an attacker instead.
1215 In the descriptions below,
1217 is one of the tokens
1226 .BI "KX " peer " bad-expected-reply-log"
1229 uses in its protocol contain a check value which proves that the
1230 challenge is honest. This message indicates that the check value
1231 supplied is wrong: someone is attempting to use bogus challenges to
1234 server to leak private key information. No chance!
1236 .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok"
1237 A symmetrically-encrypted portion of a key-exchange message failed to
1240 .BI "KX " peer " invalid " msgtoken
1241 A key-exchange message was malformed. This almost certainly indicates a
1244 .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok"
1245 A message didn't contain the right magic data. This may be a replay of
1246 some old exchange, or random packets being sent in an attempt to waste
1249 .BI "KX " peer " public-key-expired"
1250 The peer's public key has expired. It's maintainer should have given
1251 you a replacement before now.
1253 .BI "KX " peer " sending-cookie"
1254 We've received too many bogus pre-challenge messages. Someone is trying
1255 to flood us with key-exchange messages and make us waste CPU on doing
1256 hard asymmetric crypto sums.
1258 .BI "KX " peer " unexpected " msgtoken
1259 The message received wasn't appropriate for this stage of the key
1260 exchange process. This may mean that one of our previous packets got
1263 it may simply mean that the peer has recently restarted.
1265 .BI "KX " peer " unknown-challenge"
1266 The peer is asking for an answer to a challenge which we don't know
1267 about. This may mean that we've been inundated with challenges from
1268 some malicious source
1269 .I who can read our messages
1270 and discarded the valid one.
1272 .BI "KX " peer " unknown-message 0x" nn
1273 An unknown key-exchange message arrived.
1275 These are largely concerned with management of peers and the low-level
1276 details of the network protocol. The second token is usually the name of
1279 if none is relevant.
1281 .BI "PEER " peer " bad-packet no-type"
1282 An empty packet arrived. This is very strange.
1284 .BI "PEER " peer " bad-packet unknown-category 0x" nn
1285 The message category
1287 (in hex) isn't understood. Probably a strange random packet from
1288 somewhere; could be an unlikely bug.
1290 .BI "PEER " peer " bad-packet unknown-type 0x" nn
1293 (in hex) isn't understood. Probably a strange random packet from
1294 somewhere; could be an unlikely bug.
1296 .BI "PEER " peer " corrupt-encrypted-ping"
1297 The peer sent a ping response which matches an outstanding ping, but its
1298 payload is wrong. There's definitely a bug somewhere.
1300 .BI "PEER " peer " corrupt-transport-ping"
1301 The peer (apparently) sent a ping response which matches an outstanding
1302 ping, but its payload is wrong. Either there's a bug, or the bad guys
1303 are playing tricks on you.
1305 .BI "PEER " peer " decrypt-failed"
1306 An encrypted IP packet failed to decrypt. It may have been mangled in
1307 transit, or may be a very old packet from an expired previous session
1308 key. There is usually a considerable overlap in the validity periods of
1309 successive session keys, so this shouldn't occur unless the key exchange
1310 takes ages or fails.
1312 .BI "PEER " peer " malformed-encrypted-ping"
1313 The peer sent a ping response which is hopelessly invalid. There's
1314 definitely a bug somewhere.
1316 .BI "PEER " peer " malformed-transport-ping"
1317 The peer (apparently) sent a ping response which is hopelessly invalid.
1318 Either there's a bug, or the bad guys are playing tricks on you.
1320 .BI "PEER " peer " packet-build-failed"
1321 There wasn't enough space in our buffer to put the packet we wanted to
1322 send. Shouldn't happen.
1324 .BI "PEER \- socket-read-error " ecode " " message
1325 An error occurred trying to read an incoming packet.
1327 .BI "PEER " peer " socket-write-error " ecode " " message
1328 An error occurred attempting to send a network packet. We lost that
1331 .BI "PEER " peer " unexpected-encrypted-ping 0x" id
1332 The peer sent an encrypted ping response whose id doesn't match any
1333 outstanding ping. Maybe it was delayed for longer than the server was
1334 willing to wait, or maybe the peer has gone mad.
1336 .BI "PEER \- unexpected-source " address\fR...
1337 A packet arrived from
1339 (a network address \(en see above), but no peer is known at that
1340 address. This may indicate a misconfiguration, or simply be a result of
1341 one end of a connection being set up before the other.
1343 .BI "PEER " peer " unexpected-transport-ping 0x" id
1344 The peer (apparently) sent a transport ping response whose id doesn't
1345 match any outstanding ping. Maybe it was delayed for longer than the
1346 server was willing to wait, or maybe the peer has gone mad; or maybe
1347 there are bad people trying to confuse you.
1348 .SS "SERVER warnings"
1349 These indicate problems concerning the server process as a whole.
1351 .BI "SERVER ignore signal " name
1352 A signal arrived, but the server ignored it. Currently this happens for
1354 because that's a popular way of telling daemons to re-read their
1355 configuration files. Since
1357 re-reads its keyrings automatically and has no other configuration
1358 files, it's not relevant, but it seemed better to ignore the signal than
1361 .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR]
1362 A signal arrived and
1366 .BI "SERVER quit admin-request"
1367 A client of the administration interface issued a
1371 .BI "SERVER quit foreground-eof"
1372 The server is running in foreground mode (the
1374 option), and encountered end-of-file on standard input.
1376 .BI "SERVER select-error " ecode " " message
1377 An error occurred in the server's main event loop. This is bad: if it
1378 happens too many times, the server will abort.
1380 These are concerned with the symmetric encryption and decryption
1383 .BI "SYMM replay old-sequence"
1384 A packet was received with an old sequence number. It may just have
1385 been delayed or duplicated, or it may have been an attempt at a replay
1388 .BI "SYMM replay duplicated-sequence"
1389 A packet was received with a sequence number we've definitely seen
1390 before. It may be an accidental duplication because the 'net is like
1391 that, or a deliberate attempt at a replay.
1393 These concern the workings of the system-specific tunnel driver. The
1394 second token is the name of the tunnel interface in question, or
1398 .BI "TUN \- bsd no-tunnel-devices"
1399 The driver couldn't find an available tunnel device. Maybe if you
1402 files, it will work.
1404 .BI "TUN \- " tun-name " open-error " device " " ecode " " message
1405 An attempt to open the tunnel device file
1409 .BI "TUN \- linux config-error " ecode " " message
1410 Configuring the Linux TUN/TAP interface failed.
1412 .BI "TUN " ifname " " tun-name " read-error " ecode " " message
1413 Reading from the tunnel device failed.
1415 .BI "TUN " ifname " slip bad-escape"
1416 The SLIP driver encountered a escaped byte it wasn't expecting to see.
1417 The erroneous packet will be ignored.
1419 .BI "TUN " ifname " slip eof"
1420 The SLIP driver encountered end-of-file on its input descriptor.
1421 Pending data is discarded, and no attempt is made to read any more data
1422 from that interface ever.
1424 .BI "TUN " ifname " slip escape-end"
1425 The SLIP driver encountered an escaped `end' marker. This probably
1426 means that someone's been sending it junk. The erroneous packet is
1427 discarded, and we hope that we've rediscovered synchronization.
1429 .BI "TUN \- slip fork-error " ecode " " message
1430 The SLIP driver encountered an error forking a child process while
1431 allocating a new dynamic interface.
1433 .BI "TUN \- slip no-slip-interfaces"
1434 The driver ran out of static SLIP interfaces. Either preallocate more,
1435 or use dynamic SLIP interface allocation.
1437 .BI "TUN " ifname " slip overflow"
1438 The SLIP driver gave up reading a packet because it got too large.
1440 .BI "TUN \- slip pipe-error " ecode " " message
1441 The SLIP driver encountered an error creating pipes while allocating a
1442 new dynamic interface.
1444 .BI "TUN \- slip read-ifname-failed " ecode " " message
1445 The SLIP driver encountered an error reading the name of a dynamically
1446 allocated interface. Maybe the allocation script is broken.
1448 .BI "TUN \- unet config-error " ecode " " message
1449 Configuring the Linux Unet interface failed. Unet is obsolete and
1450 shouldn't be used any more.
1452 .BI "TUN \- unet getinfo-error " ecode " " message
1453 Reading information about the Unet interface failed. Unet is obsolete
1454 and shouldn't be used any more.
1456 These are issued by administration clients using the
1460 .BI "USER " tokens\fR...
1461 An administration client issued a warning.
1464 .\"--------------------------------------------------------------------------
1467 .SS "Command responses"
1470 .BI "BGFAIL " tag " " tokens \fR...
1471 .BI "BGINFO " tag " " tokens \fR...
1473 .BI "FAIL " tokens \fR...
1474 .BI "INFO " tokens \fR...
1479 .\"--------------------------------------------------------------------------
1485 .IR "The Trivial IP Encryption Protocol" .
1487 .\"--------------------------------------------------------------------------
1490 Mark Wooding, <mdw@distorted.org.uk>
1492 .\"----- That's all, folks --------------------------------------------------
~mdw / tripe / blob