12 .TH tripe-admin 5 "18 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
14 tripe-admin \- administrator commands for TrIPE
16 This manual page describes the administration interface provided by the
22 program can be used either interactively or in scripts to communicate
23 with the server using this interface. Alternatively, simple custom
24 clients can be written in scripting languages such as Perl, Python or
25 Tcl, or more advanced clients such as GUI monitors can be written in C
26 with little difficulty.
28 By default, the server listens for admin connections on the Unix-domain
30 .BR /var/lib/tripe/tripesock .
31 Administration commands use a textual protocol. Each client command or
32 server response consists of a line of ASCII text terminated by a single
33 linefeed character. No command may be longer than 255 characters.
34 .SS "General structure"
35 Each command or response line consists of a sequence of
36 whitespace-separated words. The number and nature of whitespace
37 characters separating two words in a client command is not significant;
38 the server always uses a single space character. The first word in a
41 identifying the type of command or response contained. Keywords in
42 client commands are not case-sensitive; the server always uses uppercase
45 For simple client command, the server responds with zero or more
47 lines, followed by either an
53 provides information requested in the command. An
55 response contains no further data. A
57 code is followed by a machine-readable explanation of why the command
60 Simple command processing is strictly synchronous: the server reads a
61 command, processes it, and responds, before reading the next command.
62 All commands can be run as simple commands. Long-running commands
67 block the client until they finish, but the rest of the server continues
69 .SS "Asynchronous messages"
70 There are three types of asynchronous messages which
71 aren't associated with any particular command.
75 message contains a machine-readable message warning of an error
76 encountered while processing a command, unexpected or unusual behaviour
77 by a peer, or a possible attack by an adversary. Under normal
78 conditions, the server shouldn't emit any warnings.
82 message contains a human-readable tracing message containing diagnostic
83 information. Trace messages are controlled using the
85 command-line option to the server, or the
87 administration command (see below). Support for tracing can be disabled
88 when the package is being configured, and may not be available in your
93 message is a machine-readable notification about some routine but
94 interesting event such as creation or destruction of peers.
96 The presence of asynchronous messages can be controlled using the
99 .SS "Background commands"
104 take a long time to complete. To prevent these long-running commands
105 from tying up a server connection, they can be run in the background.
106 Not all commands can be run like this: the ones that can provide a
108 option, which must be supplied with a
111 A command may fail before it starts running in the background. In this
112 case, the server emits a
114 response, as usual. To indicate that a command has started running in
115 the background, the server emits a response of the form
116 .BI "BGDETACH " tag \fR,
119 is the value passed to the
121 option. From this point on, the server is ready to process more
122 commands and reply to them.
124 Responses to background commands are indicated by a line beginning with
130 followed by the command tag. These correspond to the
135 responses for simple commands:
137 indicates information from a background command which has not completed
142 indicates that a background command succeeded or failed, respectively.
144 A background command will never issue an
148 response: it will always detach and then issue any
153 .SS "Network addresses"
154 A network address is a sequence of words. The first is a token
155 identifying the network address family. The length of an address and
156 the meanings of the subsequent words depend on the address family.
157 Address family tokens are not case-sensitive on input; on output, they
158 are always in upper-case.
160 At present, only one address family is understood.
162 .BI "INET " address " " port
163 An Internet socket, naming an IPv4 address and UDP port. On output, the
164 address is always in numeric dotted-quad form, and the port is given as
165 a plain number. On input, DNS hostnames and symbolic port names are
166 permitted. Name resolution does not block the main server, but will
167 block the requesting client. This hopefully makes life simpler for
168 stupid clients. Complex clients which don't wish to be held up can open
169 extra connections or do the resolution themselves.)
171 If, on input, no recognised address family token is found, the following
172 words are assumed to represent an
175 .SS "Key-value output"
180 produce output in the form of
182 pairs, one per word. Neither the
188 Commands which enable or disable kinds of output (e.g.,
192 work in similar ways. They take a single optional argument, which
193 consists of a string of letters selecting message types, optionally
198 to disable, the subsequently listed types.
200 If the argument is omitted, the available message types are displayed,
203 line, in a fixed-column format. Column zero contains the key letter for
204 selecting that message type; column one contains either a space or a
206 sign, if the message type is disabled or enabled respectively; and a
207 textual description of the message type begins at column 3 and continues
208 to the end of the line.
210 Lowercase key letters control individual message types. Uppercase key
211 letters control collections of message types.
212 .SH "COMMAND REFERENCE"
214 The commands provided are:
216 .BI "ADD " peer " \fR[" options "\fR] " address "\fR..."
217 Adds a new peer. The peer is given the name
219 the peer's public key is assumed to be in the file
221 (or whatever alternative file was specified in the
223 option on the command line). The
225 is the network address (see above for the format) at which the peer can
226 be contacted. The following options are recognised.
230 .BI "\-background " tag
231 Run the command in the background, using the given
234 .BI "\-keepalive " time
235 Send a no-op packet if we've not sent a packet to the peer in the last
237 interval. This is useful for persuading port-translating firewalls to
238 believe that the `connection' is still active. The
240 is expressed as a nonnegative integer followed optionally by
246 for days, hours, minutes, or seconds respectively; if no suffix is
247 given, seconds are assumed.
249 .BI "\-tunnel " tunnel
250 Use the named tunnel driver, rather than the default.
257 line reporting the IP address and port number stored for
260 .BI "CHECKCHAL " challenge
261 Verifies a challenge as being one earlier issued by
263 and not previously either passed to
265 or in a greeting message.
268 Causes the server to disassociate itself from its terminal and become a
269 background task. This only works once. A warning is issued.
271 .BI "EPING \fR[" options "\fR] " peer
272 Sends an encrypted ping to the peer, and expects an encrypted response.
273 This checks that the peer is running (and not being impersonated), and
274 that it can encrypt and decrypt packets correctly. Options and
275 responses are the same as for the
280 Requests the server to begin a new key exchange with
285 Requests a challenge. The challenge is returned in an
287 line, as a base64-encoded string. See
290 .BI "GREET " peer " " challenge
291 Sends a greeting packet containing the
293 (base-64 encoded) to the named
295 The expectation is that this will cause the peer to recognize us and
296 begin a key-exchange.
299 Causes the server to emit an
301 line for each command it supports. Each line lists the command name,
302 followed by the names of the arguments. This may be helpful as a memory
303 aid for interactive use, or for program clients probing for features.
308 line containing the name of the network interface used to collect IP
309 packets which are to be encrypted and sent to
311 Used by configuration scripts so that they can set up routing tables
312 appropriately after adding new peers.
315 Causes the server to forget all about
317 All keys are destroyed, and no more packets are sent. No notification
318 is sent to the peer: if it's important that the peer be notified, you
319 must think of a way to do that yourself.
322 For each currently-known peer, an
324 line is written containing the peer's name, as given to
327 .BI "NOTIFY " tokens\fR...
330 notification to all interested administration clients.
333 Returns information about a peer, in key-value form. The following keys
338 The tunnel driver used for this peer.
341 The keepalive interval, in seconds, or zero if no keepalives are to be
345 .BI "PING \fR[" options "\fR] " peer
346 Send a transport-level ping to the peer. The ping and its response are
347 not encrypted or authenticated. This command, possibly in conjunction
348 with tracing, is useful for ensuring that UDP packets are actually
349 flowing in both directions. See also the
355 line is printed describing the outcome:
358 .BI "ping-ok " millis
359 A response was received
361 after the ping was sent.
364 No response was received within the time allowed.
367 The peer was killed (probably by another admin connection) before a
368 response was received.
371 Options recognized for this command are:
375 .BI "\-background " tag
376 Run the command in the background, using the given
379 .BI "\-timeout " time
382 seconds before giving up on a response. The default is 5 seconds. (The
383 time format is the same as for the
392 line containing just the number of the UDP port used by the
394 server. If you've allowed your server to allocate a port dynamically,
395 this is how to find out which one it chose.
398 Instructs the server to recheck its keyring files. The server checks
399 these periodically anyway but it may be necessary to force a recheck,
400 for example after adding a new peer key.
403 Instructs the server to exit immediately. A warning is sent.
406 Returns information about the server, in the form of key-value pairs.
407 The following keys are used.
411 A keyword naming the implementation of the
413 server. The current implementation is called
417 The server's version number, as reported by
425 if the server has or hasn't (respectively) become a daemon.
431 lines, each containing one or more statistics in the form
432 .IB name = value \fR.
433 The statistics-gathering is experimental and subject to change.
435 .BR "TRACE " [\fIoptions\fP]
436 Selects trace outputs: see
438 above. Message types provided are:
441 Currently, the following tracing options are supported:
444 Tunnel events: reception of packets to be encrypted, and injection of
445 successfully-decrypted packets.
448 Peer management events: creation and destruction of peer attachments,
449 and arrival of messages.
452 Administration interface: acceptance of new connections, and handling of
453 the backgroud name-resolution required by the
458 Handling of symmetric keysets: creation and expiry of keysets, and
459 encryption and decryption of messages.
462 Key exchange: reception, parsing and emission of key exchange messages.
465 Key management: loading keys and checking for file modifications.
468 Display information about challenge issuing and verification.
471 Display contents of packets sent and received by the tunnel and/or peer
475 Display inputs, outputs and intermediate results of cryptographic
476 operations. This includes plaintext and key material. Use with
488 outputs provide extra detail for other outputs. Specifying
494 isn't useful; neither is specifying
505 For each available tunnel driver, an
507 line is printed giving its name.
510 Causes the server to emit an
512 line stating its software version, as two words: the server name, and
513 its version string. The server name
515 is reserved to the Straylight/Edgeware implementation.
517 .BR "WATCH " [\fIoptions\fP]
518 Enables or disables asynchronous messages
519 .IR "for the current connection only" .
522 above. The default watch state for the connection the server opens
523 automatically on stdin/stdout is to show warnings and trace messages;
524 other connections show no asynchronous messages. (This is done in order
525 to guarantee that a program reading the server's stdout does not miss
529 Message types provided are:
547 .BI "WARN " tokens\fR...
550 warning to all interested administration clients.
552 .\"* 20 Error messages (FAIL codes)
557 messages are sent to clients as a result of errors during command
565 server is already running as a daemon.
567 .BI "bad-addr-syntax " message
568 (For commands accepting socket addresses.) The address couldn't be
571 .BI "bad-syntax " cmd " " message
572 (For any command.) The command couldn't be understood: e.g., the number
573 of arguments was wrong.
575 .BI "bad-time-spec " word
578 is not a valid time interval specification. Acceptable time
579 specifications are nonnegative integers followed optionally by
585 for days, hours, minutes, or seconds, respectively.
587 .BI "bad-trace-option " char
590 An unknown trace option was requested.
592 .BI "bad-watch-option " char
595 An unknown watch option was requested.
597 .BI "daemon-error " ecode " " message
600 An error occurred during the attempt to become a daemon, as reported by
603 .BI "invalid-port " number
606 The given port number is out of range.
608 .BI "peer-create-fail " peer
613 failed for some reason. A warning should have been emitted explaining
616 .BI "peer-exists " peer
619 There is already a peer named
622 .B "ping-send-failed"
623 The attempt to send a ping packet failed, probably due to lack of
626 .BI "resolve-error " hostname
631 could not be resolved.
633 .BI "resolver-timeout " hostname
638 took too long to resolve.
640 .BI "unknown-command " token
645 .BI "unknown-peer " name
652 There is no peer called
655 .BI "unknown-service " service
663 .\"* 30 Notification broadcasts (NOTE codes)
664 The following notifications are sent to clients who request them.
666 .BI "ADD " peer " " ifname " " address \fR...
667 A new peer has been added. The peer's name is
669 its tunnel is network interface
671 and its network address is
675 The server has forked off into the sunset and become a daemon.
677 .BI "GREET " challenge " " address \fR...
678 A valid greeting was received, with the given challenge (exactly as it
691 finished successfully.
696 has begun or restarted. If key exchange keeps failing, this message
697 will be repeated periodically.
699 .BI "USER " tokens\fR...
700 An administration client issued a notification using the
704 .\"* 40 Warning broadcasts (WARN codes)
706 There are many possible warnings. They are categorized according to
709 Many of these warnings report system errors. These are reported as a
710 pair of tokens, described below as
716 is a string of the form
720 value of the error; the
722 is the `human-readable' form of the message, as reported by
725 These all indicate that the
727 server has become unable to continue. If enabled, the server will dump
728 core in its configuration directory.
730 .BI "ABORT repeated-select-errors"
731 The main event loop is repeatedly failing. If the server doesn't quit,
732 it will probably waste all available CPU doing nothing.
734 These indicate a problem with the administration socket interface.
736 .BI "ADMIN accept-error " ecode " " message
737 There was an error while attempting to accept a connection from a new
740 .BI "ADMIN client-write-error " ecode " " message
741 There was an error sending data to a client. The connection to the
742 client has been closed.
744 These indicate errors in challenges, either in the
746 command or in greeting packets.
748 .B "CHAL impossible-challenge"
749 The server hasn't issued any challenges yet. Quite how anyone else
750 thought he could make one up is hard to imagine.
752 .B "CHAL incorrect-tag"
753 Challenge received contained the wrong authentication data. It might be
754 very stale, or a forgery.
756 .B "CHAL invalid-challenge"
757 Challenge received was the wrong length. We might have changed MAC
758 algorithms since the challenge was issued, or it might just be rubbish.
760 .B "CHAL replay duplicated-sequence"
761 Challenge received was a definite replay of an old challenge. Someone's
764 .B "CHAL replay old-sequence"
765 Challenge received was old, but maybe not actually a replay. Try again.
766 .SS "KEYMGMT warnings"
767 These indicate a problem with the keyring files, or the keys stored in
770 .BI "KEYMGMT bad-private-key " message
771 The private key could not be read, or failed a consistency check. If
772 there was a problem with the file, usually there will have been
774 warnings before this.
776 .BI "KEYMGMT bad-public-keyring " message
777 The public keyring couldn't be read. Usually, there will have been
779 warnings before this.
781 .BI "KEYMGMT key-file-error " file ":" line " " message
782 Reports a specific error with the named keyring file. This probably
786 .BI "KEYMGMT public-key " tag " " tokens\fR...
787 These messages all indicate a problem with the public key named
790 .BI "KEYMGMT public-key " tag " algorithm-mismatch"
791 The algorithms specified on the public key don't match the ones for our
792 private key. All the peers in a network have to use the same
795 .BI "KEYMGMT public-key " tag " bad " message
796 The public key couldn't be read, or is invalid.
798 .BI "KEYMGMT public-key " tag " bad-public-group-element"
799 The public key is invalid. This may indicate a malicious attempt to
800 introduce a bogus key.
802 .BI "KEYMGMT public-key " tag " bad-algorithm-selection"
803 The algorithms listed on the public key couldn't be understood. The
804 algorithm selection attributes are probably malformed and need fixing.
806 .BI "KEYMGMT public-key " tag " incorrect-group"
807 The public key doesn't use the same group as our private key. All the
808 peers in a network have to use the same group.
810 .BI "KEYMGMT public-key " tag " not-found"
811 The public key for peer
813 wasn't in the public keyring.
815 .BI "KEYMGMT public-key " tag " unknown-type"
816 The type of the public key isn't understood. Maybe you need to upgrade
819 (Even if you do, you'll have to regenerate your keys.)
821 These indicate problems during key-exchange. Many indicate either a bug
822 in the server (either yours or the remote one), or some kind of attack
823 in progress. All name a
825 as the second token: this is the peer the packet is apparently from,
826 though it may have been sent by an attacker instead.
828 In the descriptions below,
839 .BI "KX " peer " bad-expected-reply-log"
842 uses in its protocol contain a check value which proves that the
843 challenge is honest. This message indicates that the check value
844 supplied is wrong: someone is attempting to use bogus challenges to
847 server to leak private key information. No chance!
849 .BI "KX " peer " decrypt-failed reply\fR|\fBswitch-ok"
850 A symmetrically-encrypted portion of a key-exchange message failed to
853 .BI "KX " peer " invalid " msgtoken
854 A key-exchange message was malformed. This almost certainly indicates a
857 .BI "KX " peer " incorrect cookie\fR|\fBswitch-rq\fR|\fBswitch-ok"
858 A message didn't contain the right magic data. This may be a replay of
859 some old exchange, or random packets being sent in an attempt to waste
862 .BI "KX " peer " public-key-expired"
863 The peer's public key has expired. It's maintainer should have given
864 you a replacement before now.
866 .BI "KX " peer " sending-cookie"
867 We've received too many bogus pre-challenge messages. Someone is trying
868 to flood us with key-exchange messages and make us waste CPU on doing
869 hard asymmetric crypto sums.
871 .BI "KX " peer " unexpected " msgtoken
872 The message received wasn't appropriate for this stage of the key
873 exchange process. This may mean that one of our previous packets got
876 it may simply mean that the peer has recently restarted.
878 .BI "KX " peer " unknown-challenge"
879 The peer is asking for an answer to a challenge which we don't know
880 about. This may mean that we've been inundated with challenges from
881 some malicious source
882 .I who can read our messages
883 and discarded the valid one.
885 .BI "KX " peer " unknown-message 0x" nn
886 An unknown key-exchange message arrived.
888 These are largely concerned with management of peers and the low-level
889 details of the network protocol. The second word is usually the name of
894 .BI "PEER " peer " bad-packet no-type"
895 An empty packet arrived. This is very strange.
897 .BI "PEER " peer " bad-packet unknown-category 0x" nn
900 (in hex) isn't understood. Probably a strange random packet from
901 somewhere; could be an unlikely bug.
903 .BI "PEER " peer " bad-packet unknown-type 0x" nn
906 (in hex) isn't understood. Probably a strange random packet from
907 somewhere; could be an unlikely bug.
909 .BI "PEER " peer " corrupt-encrypted-ping"
910 The peer sent a ping response which matches an outstanding ping, but its
911 payload is wrong. There's definitely a bug somewhere.
913 .BI "PEER " peer " corrupt-transport-ping"
914 The peer (apparently) sent a ping response which matches an outstanding
915 ping, but its payload is wrong. Either there's a bug, or the bad guys
916 are playing tricks on you.
918 .BI "PEER " peer " decrypt-failed"
919 An encrypted IP packet failed to decrypt. It may have been mangled in
920 transit, or may be a very old packet from an expired previous session
921 key. There is usually a considerable overlap in the validity periods of
922 successive session keys, so this shouldn't occur unless the key exchange
925 .BI "PEER " peer " malformed-encrypted-ping"
926 The peer sent a ping response which is hopelessly invalid. There's
927 definitely a bug somewhere.
929 .BI "PEER " peer " malformed-transport-ping"
930 The peer (apparently) sent a ping response which is hopelessly invalid.
931 Either there's a bug, or the bad guys are playing tricks on you.
933 .BI "PEER " peer " packet-build-failed"
934 There wasn't enough space in our buffer to put the packet we wanted to
935 send. Shouldn't happen.
937 .BI "PEER \- socket-read-error " ecode " " message
938 An error occurred trying to read an incoming packet.
940 .BI "PEER " peer " socket-write-error " ecode " " message
941 An error occurred attempting to send a network packet. We lost that
944 .BI "PEER " peer " unexpected-encrypted-ping 0x" id
945 The peer sent an encrypted ping response whose id doesn't match any
946 outstanding ping. Maybe it was delayed for longer than the server was
947 willing to wait, or maybe the peer has gone mad.
949 .BI "PEER \- unexpected-source " address\fR...
950 A packet arrived from
952 (a network address \(en see above), but no peer is known at that
953 address. This may indicate a misconfiguration, or simply be a result of
954 one end of a connection being set up before the other.
956 .BI "PEER " peer " unexpected-transport-ping 0x" id
957 The peer (apparently) sent a transport ping response whose id doesn't
958 match any outstanding ping. Maybe it was delayed for longer than the
959 server was willing to wait, or maybe the peer has gone mad; or maybe
960 there are bad people trying to confuse you.
961 .SS "SERVER warnings"
962 These indicate problems concerning the server process as a whole.
964 .BI "SERVER ignore signal " name
965 A signal arrived, but the server ignored it. Currently this happens for
967 because that's a popular way of telling daemons to re-read their
968 configuration files. Since
970 re-reads its keyrings automatically and has no other configuration
971 files, it's not relevant, but it seemed better to ignore the signal than
974 .BI "SERVER quit signal " \fR[\fInn\fR|\fIname\fR]
979 .BI "SERVER quit admin-request"
980 A client of the administration interface issued a
984 .BI "SERVER select-error " ecode " " message
985 An error occurred in the server's main event loop. This is bad: if it
986 happens too many times, the server will abort.
988 These are concerned with the symmetric encryption and decryption
991 .BI "SYMM replay old-sequence"
992 A packet was received with an old sequence number. It may just have
993 been delayed or duplicated, or it may have been an attempt at a replay
996 .BI "SYMM replay duplicated-sequence"
997 A packet was received with a sequence number we've definitely seen
998 before. It may be an accidental duplication because the 'net is like
999 that, or a deliberate attempt at a replay.
1001 These concern the workings of the system-specific tunnel driver. The
1002 second word is the name of the tunnel interface in question, or
1006 .BI "TUN \- bsd no-tunnel-devices"
1007 The driver couldn't find an available tunnel device. Maybe if you
1010 files, it will work.
1012 .BI "TUN - " tun-name " open-error " device " " ecode " " message
1013 An attempt to open the tunnel device file
1017 .BI "TUN \- linux config-error " ecode " " message
1018 Configuring the Linux TUN/TAP interface failed.
1020 .BI "TUN " ifname " " tun-name " read-error " ecode " " message
1021 Reading from the tunnel device failed.
1023 .BI "TUN " ifname " slip bad-escape"
1024 The SLIP driver encountered a escaped byte it wasn't expecting to see.
1025 The erroneous packet will be ignored.
1027 .BI "TUN " ifname " slip eof"
1028 The SLIP driver encountered end-of-file on its input descriptor.
1029 Pending data is discarded, and no attempt is made to read any more data
1030 from that interface ever.
1032 .BI "TUN " ifname " slip escape-end"
1033 The SLIP driver encountered an escaped `end' marker. This probably
1034 means that someone's been sending it junk. The erroneous packet is
1035 discarded, and we hope that we've rediscovered synchronization.
1037 .BI "TUN \- slip fork-error " ecode " " message
1038 The SLIP driver encountered an error forking a child process while
1039 allocating a new dynamic interface.
1041 .BI "TUN \- slip no-slip-interfaces"
1042 The driver ran out of static SLIP interfaces. Either preallocate more,
1043 or use dynamic SLIP interface allocation.
1045 .BI "TUN " ifname " slip overflow"
1046 The SLIP driver gave up reading a packet because it got too large.
1048 .BI "TUN \- slip pipe-error " ecode " " message
1049 The SLIP driver encountered an error creating pipes while allocating a
1050 new dynamic interface.
1052 .BI "TUN \- slip read-ifname-failed " ecode " " message
1053 The SLIP driver encountered an error reading the name of a dynamically
1054 allocated interface. Maybe the allocation script is broken.
1056 .BI "TUN \- unet config-error " ecode " " message
1057 Configuring the Linux Unet interface failed. Unet is obsolete and
1058 shouldn't be used any more.
1060 .BI "TUN \- unet getinfo-error " ecode " " message
1061 Reading information about the Unet interface failed. Unet is obsolete
1062 and shouldn't be used any more.
1064 .BI "TUN \- unet ifname-too-long"
1065 The Unet interface's name overflowed, so we couldn't read it properly.
1066 Unet is obsolete and shouldn't be used any more.
1068 These are issued by administration clients using the
1072 .BI "USER " tokens\fR...
1073 An administration client issued a warning.
1076 .SS "Command responses"
1078 .BI "BGFAIL " tag " " tokens \fR...
1079 .BI "BGINFO " tag " " tokens \fR...
1081 .BI "FAIL " tokens \fR...
1082 .BI "INFO " tokens \fR...
1090 .IR "The Trivial IP Encryption Protocol" .
1092 Mark Wooding, <mdw@distorted.org.uk>
~mdw / tripe / blob