3 * Main header file for TrIPE
5 * (c) 2001 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.
34 /*----- Header files ------------------------------------------------------*/
50 #include <sys/types.h>
57 #include <sys/socket.h>
59 #include <netinet/in.h>
60 #include <arpa/inet.h>
66 #include <mLib/alloc.h>
67 #include <mLib/arena.h>
68 #include <mLib/base64.h>
69 #include <mLib/bres.h>
70 #include <mLib/daemonize.h>
71 #include <mLib/dstr.h>
73 #include <mLib/fdflags.h>
74 #include <mLib/fdpass.h>
75 #include <mLib/fwatch.h>
76 #include <mLib/hash.h>
77 #include <mLib/macros.h>
78 #include <mLib/mdup.h>
79 #include <mLib/mdwopt.h>
80 #include <mLib/quis.h>
81 #include <mLib/report.h>
83 #include <mLib/selbuf.h>
87 #include <mLib/trace.h>
89 #include <mLib/versioncmp.h>
91 #include <catacomb/buf.h>
93 #include <catacomb/gcipher.h>
94 #include <catacomb/gmac.h>
95 #include <catacomb/grand.h>
96 #include <catacomb/key.h>
97 #include <catacomb/paranoia.h>
99 #include <catacomb/noise.h>
100 #include <catacomb/rand.h>
102 #include <catacomb/mp.h>
103 #include <catacomb/mprand.h>
104 #include <catacomb/dh.h>
105 #include <catacomb/ec.h>
106 #include <catacomb/ec-keys.h>
107 #include <catacomb/group.h>
110 #include "protocol.h"
116 /*----- Magic numbers -----------------------------------------------------*/
118 /* --- Trace flags --- */
126 #define T_KEYEXCH 64u
127 #define T_KEYMGMT 128u
129 /* T_PRIVSEP in priv.h */
135 #define SEC(n) (n##u)
136 #define MIN(n) (n##u * 60u)
137 #define MEG(n) (n##ul * 1024ul * 1024ul)
139 /* --- Other things --- */
141 #define PKBUFSZ 65536
143 /*----- Cipher selections -------------------------------------------------*/
145 typedef struct algswitch {
146 const gccipher *c; /* Symmetric encryption scheme */
147 const gccipher *mgf; /* Mask-generation function */
148 const gchash *h; /* Hash function */
149 const gcmac *m; /* Message authentication code */
150 size_t hashsz; /* Hash output size */
151 size_t tagsz; /* Length to truncate MAC tags */
152 size_t expsz; /* Size of data to process */
153 size_t cksz, mksz; /* Key lengths for @c@ and @m@ */
156 extern algswitch algs;
158 #define MAXHASHSZ 64 /* Largest possible hash size */
160 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
162 /*----- Data structures ---------------------------------------------------*/
164 /* --- Socket addresses --- *
166 * A magic union of supported socket addresses.
171 struct sockaddr_in sin;
174 /* --- Mapping keyed on addresses --- */
176 typedef struct addrmap {
181 typedef struct addrmap_base {
186 /* --- Sequence number checking --- */
188 typedef struct seqwin {
189 uint32 seq; /* First acceptable input sequence */
190 uint32 win; /* Window of acceptable numbers */
193 #define SEQ_WINSZ 32 /* Bits in sequence number window */
195 /* --- A symmetric keyset --- *
197 * A keyset contains a set of symmetric keys for encrypting and decrypting
198 * packets. Keysets are stored in a list, sorted in reverse order of
199 * creation, so that the most recent keyset (the one most likely to be used)
202 * Each keyset has a time limit and a data limit. The keyset is destroyed
203 * when either it has existed for too long, or it has been used to encrypt
204 * too much data. New key exchanges are triggered when keys are close to
208 typedef struct keyset {
209 struct keyset *next; /* Next active keyset in the list */
210 unsigned ref; /* Reference count for keyset */
211 struct peer *p; /* Pointer to peer structure */
212 time_t t_exp; /* Expiry time for this keyset */
213 unsigned long sz_exp, sz_regen; /* Data limits for the keyset */
214 T( unsigned seq; ) /* Sequence number for tracing */
215 unsigned f; /* Various useful flags */
216 gcipher *cin, *cout; /* Keyset ciphers for encryption */
217 size_t tagsz; /* Length to truncate MAC tags */
218 gmac *min, *mout; /* Keyset MACs for integrity */
219 uint32 oseq; /* Outbound sequence number */
220 seqwin iseq; /* Inbound sequence number */
223 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
224 #define KSF_LINK 2u /* Key is in a linked list */
226 #define KSERR_REGEN -1 /* Regenerate keys */
227 #define KSERR_NOKEYS -2 /* No keys left */
228 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
230 /* --- Key exchange --- *
232 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
233 * Protocol has a number of desirable features (e.g., perfect forward
234 * secrecy, and zero-knowledge authentication) which make it attractive for
235 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
241 typedef struct kxchal {
242 struct keyexch *kx; /* Pointer back to key exchange */
243 ge *c; /* Responder's challenge */
244 ge *r; /* My reply to the challenge */
245 keyset *ks; /* Pointer to temporary keyset */
246 unsigned f; /* Various useful flags */
247 sel_timer t; /* Response timer for challenge */
248 octet hc[MAXHASHSZ]; /* Hash of his challenge */
249 octet ck[MAXHASHSZ]; /* His magical check value */
250 octet hswrq_in[MAXHASHSZ]; /* Inbound switch request message */
251 octet hswok_in[MAXHASHSZ]; /* Inbound switch confirmation */
252 octet hswrq_out[MAXHASHSZ]; /* Outbound switch request message */
253 octet hswok_out[MAXHASHSZ]; /* Outbound switch confirmation */
256 typedef struct keyexch {
257 struct peer *p; /* Pointer back to the peer */
258 keyset **ks; /* Peer's list of keysets */
259 unsigned f; /* Various useful flags */
260 unsigned s; /* Current state in exchange */
261 sel_timer t; /* Timer for next exchange */
262 ge *kpub; /* Peer's public key */
263 time_t texp_kpub; /* Expiry time for public key */
264 mp *alpha; /* My temporary secret */
265 ge *c; /* My challenge */
266 ge *rx; /* The expected response */
267 unsigned nr; /* Number of extant responses */
268 time_t t_valid; /* When this exchange goes bad */
269 octet hc[MAXHASHSZ]; /* Hash of my challenge */
270 kxchal *r[KX_NCHAL]; /* Array of challenges */
273 #define KXF_TIMER 1u /* Waiting for a timer to go off */
274 #define KXF_DEAD 2u /* The key-exchanger isn't up */
275 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
276 #define KXF_CORK 8u /* Don't send anything yet */
279 KXS_DEAD, /* Uninitialized state (magical) */
280 KXS_CHAL, /* Main answer-challenges state */
281 KXS_COMMIT, /* Committed: send switch request */
282 KXS_SWITCH /* Switched: send confirmation */
285 /* --- Tunnel structure --- *
287 * Used to maintain system-specific information about the tunnel interface.
290 typedef struct tunnel tunnel;
293 typedef struct tunnel_ops {
294 const char *name; /* Name of this tunnel driver */
295 unsigned flags; /* Various interesting flags */
296 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
297 void (*init)(void); /* Initializes the system */
298 tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/);
299 /* Initializes a new tunnel */
300 void (*setifname)(tunnel */*t*/, const char */*ifn*/);
301 /* Notifies ifname change */
302 void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
303 void (*destroy)(tunnel */*t*/); /* Destroys a tunnel */
306 #ifndef TUN_INTERNALS
307 struct tunnel { const tunnel_ops *ops; };
310 /* --- Peer statistics --- *
312 * Contains various interesting and not-so-interesting statistics about a
313 * peer. This is updated by various parts of the code. The format of the
314 * structure isn't considered private, and @p_stats@ returns a pointer to the
315 * statistics block for a given peer.
318 typedef struct stats {
319 unsigned long sz_in, sz_out; /* Size of all data in and out */
320 unsigned long sz_kxin, sz_kxout; /* Size of key exchange messages */
321 unsigned long sz_ipin, sz_ipout; /* Size of encapsulated IP packets */
322 time_t t_start, t_last, t_kx; /* Time peer created, last pk, kx */
323 unsigned long n_reject; /* Number of rejected packets */
324 unsigned long n_in, n_out; /* Number of packets in and out */
325 unsigned long n_kxin, n_kxout; /* Number of key exchange packets */
326 unsigned long n_ipin, n_ipout; /* Number of encrypted packets */
329 /* --- Peer structure --- *
331 * The main structure which glues everything else together.
334 typedef struct peerspec {
335 char *name; /* Peer's name */
336 const tunnel_ops *tops; /* Tunnel operations */
337 unsigned long t_ka; /* Keep alive interval */
338 addr sa; /* Socket address to speak to */
339 size_t sasz; /* Socket address size */
340 unsigned kxf; /* Key exchange flags to set */
343 typedef struct peer_byname {
348 typedef struct peer_byaddr {
353 typedef struct peer {
354 peer_byname *byname; /* Lookup-by-name block */
355 peer_byaddr *byaddr; /* Lookup-by-address block */
356 struct ping *pings; /* Pings we're waiting for */
357 peerspec spec; /* Specifications for this peer */
358 tunnel *t; /* Tunnel for local packets */
359 char *ifname; /* Interface name for tunnel */
360 keyset *ks; /* List head for keysets */
361 buf b; /* Buffer for sending packets */
362 stats st; /* Statistics */
363 keyexch kx; /* Key exchange protocol block */
364 sel_timer tka; /* Timer for keepalives */
367 typedef struct peer_iter { sym_iter i; } peer_iter;
369 typedef struct ping {
370 struct ping *next, *prev; /* Links to next and previous */
371 peer *p; /* Peer so we can free it */
372 unsigned msg; /* Kind of response expected */
373 uint32 id; /* Id so we can recognize response */
374 octet magic[32]; /* Some random data */
375 sel_timer t; /* Timeout for ping */
376 void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
377 void *arg; /* Argument for callback */
388 /* --- Admin structure --- */
390 #define OBUFSZ 16384u
392 typedef struct obuf {
393 struct obuf *next; /* Next buffer in list */
394 char *p_in, *p_out; /* Pointers into the buffer */
395 char buf[OBUFSZ]; /* The actual buffer */
398 typedef struct oqueue {
399 obuf *hd, *tl; /* Head and tail pointers */
404 typedef struct admin_bgop {
405 struct admin_bgop *next, *prev; /* Links to next and previous */
406 struct admin *a; /* Owner job */
407 char *tag; /* Tag string for messages */
408 void (*cancel)(struct admin_bgop *); /* Destructor function */
411 typedef struct admin_resop {
412 admin_bgop bg; /* Background operation header */
413 char *addr; /* Hostname to be resolved */
414 bres_client r; /* Background resolver task */
415 sel_timer t; /* Timer for resolver */
416 addr sa; /* Socket address */
417 size_t sasz; /* Socket address size */
418 void (*func)(struct admin_resop *, int); /* Handler */
421 enum { ARES_OK, ARES_FAIL };
423 typedef struct admin_addop {
424 admin_resop r; /* Name resolution header */
425 peerspec peer; /* Peer pending creation */
428 typedef struct admin_greetop {
429 admin_resop r; /* Name resolution header */
430 void *c; /* Challenge block */
431 size_t sz; /* Length of challenge */
434 typedef struct admin_pingop {
435 admin_bgop bg; /* Background operation header */
436 ping ping; /* Ping pending response */
437 struct timeval pingtime; /* Time last ping was sent */
440 typedef struct admin_service {
441 sym_base _b; /* Hash table base structure */
442 char *version; /* The provided version */
443 struct admin *prov; /* Which client provides me */
444 struct admin_service *next, *prev; /* Client's list of services */
447 typedef struct admin_svcop {
448 admin_bgop bg; /* Background operation header */
449 struct admin *prov; /* Client servicing this job */
450 unsigned index; /* This job's index */
451 struct admin_svcop *next, *prev; /* Links for provider's jobs */
454 typedef struct admin_jobentry {
455 unsigned short seq; /* Zero if unused */
457 admin_svcop *op; /* Operation, if slot in use, ... */
458 uint32 next; /* ... or index of next free slot */
462 typedef struct admin_jobtable {
463 uint32 n, sz; /* Used slots and table size */
464 admin_svcop *active; /* List of active jobs */
465 uint32 free; /* Index of first free slot */
466 admin_jobentry *v; /* And the big array of entries */
469 typedef struct admin {
470 struct admin *next, *prev; /* Links to next and previous */
471 unsigned f; /* Various useful flags */
472 unsigned ref; /* Reference counter */
474 unsigned seq; /* Sequence number for tracing */
476 oqueue out; /* Output buffer list */
477 oqueue delay; /* Delayed output buffer list */
478 admin_bgop *bg; /* Backgrounded operations */
479 admin_service *svcs; /* Which services I provide */
480 admin_jobtable j; /* Table of outstanding jobs */
481 selbuf b; /* Line buffer for commands */
482 sel_file w; /* Selector for write buffering */
485 #define AF_DEAD 1u /* Destroy this admin block */
486 #define AF_CLOSE 2u /* Client closed connection */
487 #define AF_NOTE 4u /* Catch notifications */
488 #define AF_WARN 8u /* Catch warning messages */
490 #define AF_TRACE 16u /* Catch tracing */
492 #define AF_FOREGROUND 32u /* Quit server when client closes */
495 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
497 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
500 /*----- Global variables --------------------------------------------------*/
502 extern sel_state sel; /* Global I/O event state */
503 extern group *gg; /* The group we work in */
504 extern size_t indexsz; /* Size of exponent for the group */
505 extern mp *kpriv; /* Our private key */
506 extern ge *kpub; /* Our public key */
507 extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
508 extern const tunnel_ops *tunnels[]; /* Table of tunnels (0-term) */
509 extern const tunnel_ops *tun_default; /* Default tunnel to use */
512 extern const trace_opt tr_opts[]; /* Trace options array */
513 extern unsigned tr_flags; /* Trace options flags */
516 /*----- Other macros ------------------------------------------------------*/
518 #define TIMER noise_timer(RAND_GLOBAL)
520 /*----- Key management ----------------------------------------------------*/
522 /* --- @km_reload@ --- *
526 * Returns: Zero if OK, nonzero to force reloading of keys.
528 * Use: Checks the keyrings to see if they need reloading.
531 extern int km_reload(void);
533 /* --- @km_init@ --- *
535 * Arguments: @const char *kr_priv@ = private keyring file
536 * @const char *kr_pub@ = public keyring file
537 * @const char *tag@ = tag to load
541 * Use: Initializes, and loads the private key.
544 extern void km_init(const char */*kr_priv*/, const char */*kr_pub*/,
545 const char */*tag*/);
547 /* --- @km_getpubkey@ --- *
549 * Arguments: @const char *tag@ = public key tag to load
550 * @ge *kpub@ = where to put the public key
551 * @time_t *t_exp@ = where to put the expiry time
553 * Returns: Zero if OK, nonzero if it failed.
555 * Use: Fetches a public key from the keyring.
558 extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
561 /*----- Key exchange ------------------------------------------------------*/
563 /* --- @kx_start@ --- *
565 * Arguments: @keyexch *kx@ = pointer to key exchange context
566 * @int forcep@ = nonzero to ignore the quiet timer
570 * Use: Stimulates a key exchange. If a key exchage is in progress,
571 * a new challenge is sent (unless the quiet timer forbids
572 * this); if no exchange is in progress, one is commenced.
575 extern void kx_start(keyexch */*kx*/, int /*forcep*/);
577 /* --- @kx_message@ --- *
579 * Arguments: @keyexch *kx@ = pointer to key exchange context
580 * @unsigned msg@ = the message code
581 * @buf *b@ = pointer to buffer containing the packet
585 * Use: Reads a packet containing key exchange messages and handles
589 extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/);
591 /* --- @kx_free@ --- *
593 * Arguments: @keyexch *kx@ = pointer to key exchange context
597 * Use: Frees everything in a key exchange context.
600 extern void kx_free(keyexch */*kx*/);
602 /* --- @kx_newkeys@ --- *
604 * Arguments: @keyexch *kx@ = pointer to key exchange context
608 * Use: Informs the key exchange module that its keys may have
609 * changed. If fetching the new keys fails, the peer will be
610 * destroyed, we log messages and struggle along with the old
614 extern void kx_newkeys(keyexch */*kx*/);
616 /* --- @kx_init@ --- *
618 * Arguments: @keyexch *kx@ = pointer to key exchange context
619 * @peer *p@ = pointer to peer context
620 * @keyset **ks@ = pointer to keyset list
621 * @unsigned f@ = various useful flags
623 * Returns: Zero if OK, nonzero if it failed.
625 * Use: Initializes a key exchange module. The module currently
626 * contains no keys, and will attempt to initiate a key
630 extern int kx_init(keyexch */*kx*/, peer */*p*/,
631 keyset **/*ks*/, unsigned /*f*/);
633 /*----- Keysets and symmetric cryptography --------------------------------*/
635 /* --- @ks_drop@ --- *
637 * Arguments: @keyset *ks@ = pointer to a keyset
641 * Use: Decrements a keyset's reference counter. If the counter hits
642 * zero, the keyset is freed.
645 extern void ks_drop(keyset */*ks*/);
647 /* --- @ks_gen@ --- *
649 * Arguments: @const void *k@ = pointer to key material
650 * @size_t x, y, z@ = offsets into key material (see below)
651 * @peer *p@ = pointer to peer information
653 * Returns: A pointer to the new keyset.
655 * Use: Derives a new keyset from the given key material. The
656 * offsets @x@, @y@ and @z@ separate the key material into three
657 * parts. Between the @k@ and @k + x@ is `my' contribution to
658 * the key material; between @k + x@ and @k + y@ is `your'
659 * contribution; and between @k + y@ and @k + z@ is a shared
660 * value we made together. These are used to construct two
661 * pairs of symmetric keys. Each pair consists of an encryption
662 * key and a message authentication key. One pair is used for
663 * outgoing messages, the other for incoming messages.
665 * The new key is marked so that it won't be selected for output
666 * by @ksl_encrypt@. You can still encrypt data with it by
667 * calling @ks_encrypt@ directly.
670 extern keyset *ks_gen(const void */*k*/,
671 size_t /*x*/, size_t /*y*/, size_t /*z*/,
674 /* --- @ks_tregen@ --- *
676 * Arguments: @keyset *ks@ = pointer to a keyset
678 * Returns: The time at which moves ought to be made to replace this key.
681 extern time_t ks_tregen(keyset */*ks*/);
683 /* --- @ks_activate@ --- *
685 * Arguments: @keyset *ks@ = pointer to a keyset
689 * Use: Activates a keyset, so that it can be used for encrypting
693 extern void ks_activate(keyset */*ks*/);
695 /* --- @ks_encrypt@ --- *
697 * Arguments: @keyset *ks@ = pointer to a keyset
698 * @unsigned ty@ = message type
699 * @buf *b@ = pointer to input buffer
700 * @buf *bb@ = pointer to output buffer
702 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
703 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
704 * returns zero if there was insufficient buffer (but the output
705 * buffer is broken in this case).
707 * Use: Encrypts a block of data using the key. Note that the `key
708 * ought to be replaced' notification is only ever given once
709 * for each key. Also note that this call forces a keyset to be
710 * used even if it's marked as not for data output.
713 extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
714 buf */*b*/, buf */*bb*/);
716 /* --- @ks_decrypt@ --- *
718 * Arguments: @keyset *ks@ = pointer to a keyset
719 * @unsigned ty@ = expected type code
720 * @buf *b@ = pointer to an input buffer
721 * @buf *bb@ = pointer to an output buffer
723 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
724 * zero if there was insufficient buffer (but the output buffer
725 * is broken in this case).
727 * Use: Attempts to decrypt a message using a given key. Note that
728 * requesting decryption with a key directly won't clear a
729 * marking that it's not for encryption.
732 extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
733 buf */*b*/, buf */*bb*/);
735 /* --- @ksl_free@ --- *
737 * Arguments: @keyset **ksroot@ = pointer to keyset list head
741 * Use: Frees (releases references to) all of the keys in a keyset.
744 extern void ksl_free(keyset **/*ksroot*/);
746 /* --- @ksl_link@ --- *
748 * Arguments: @keyset **ksroot@ = pointer to keyset list head
749 * @keyset *ks@ = pointer to a keyset
753 * Use: Links a keyset into a list. A keyset can only be on one list
754 * at a time. Bad things happen otherwise.
757 extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
759 /* --- @ksl_prune@ --- *
761 * Arguments: @keyset **ksroot@ = pointer to keyset list head
765 * Use: Prunes the keyset list by removing keys which mustn't be used
769 extern void ksl_prune(keyset **/*ksroot*/);
771 /* --- @ksl_encrypt@ --- *
773 * Arguments: @keyset **ksroot@ = pointer to keyset list head
774 * @unsigned ty@ = message type
775 * @buf *b@ = pointer to input buffer
776 * @buf *bb@ = pointer to output buffer
778 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
779 * new key; @KSERR_NOKEYS@ if there are no suitable keys
780 * available. Also returns zero if there was insufficient
781 * buffer space (but the output buffer is broken in this case).
783 * Use: Encrypts a packet.
786 extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
787 buf */*b*/, buf */*bb*/);
789 /* --- @ksl_decrypt@ --- *
791 * Arguments: @keyset **ksroot@ = pointer to keyset list head
792 * @unsigned ty@ = expected type code
793 * @buf *b@ = pointer to input buffer
794 * @buf *bb@ = pointer to output buffer
796 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
797 * zero if there was insufficient buffer (but the output buffer
798 * is broken in this case).
800 * Use: Decrypts a packet.
803 extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
804 buf */*b*/, buf */*bb*/);
806 /*----- Challenges --------------------------------------------------------*/
810 * Arguments: @buf *b@ = where to put the challenge
812 * Returns: Zero if OK, nonzero on error.
814 * Use: Issues a new challenge.
817 extern int c_new(buf */*b*/);
819 /* --- @c_check@ --- *
821 * Arguments: @buf *b@ = where to find the challenge
823 * Returns: Zero if OK, nonzero if it didn't work.
825 * Use: Checks a challenge. On failure, the buffer is broken.
828 extern int c_check(buf */*b*/);
830 /*----- Administration interface ------------------------------------------*/
832 #define A_END ((char *)0)
834 /* --- @a_vformat@ --- *
836 * Arguments: @dstr *d@ = where to leave the formatted message
837 * @const char *fmt@ = pointer to format string
838 * @va_list ap@ = arguments in list
842 * Use: Main message token formatting driver. The arguments are
843 * interleaved formatting tokens and their parameters, finally
844 * terminated by an entry @A_END@.
848 * * "*..." ... -- pretokenized @dstr_putf@-like string
850 * * "?ADDR" SOCKADDR -- a socket address, to be converted
852 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
854 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
856 * * "?PEER" PEER -- peer's name
858 * * "?ERRNO" ERRNO -- system error code
860 * * "[!]..." ... -- @dstr_putf@-like string as single token
863 extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list /*ap*/);
865 /* --- @a_warn@ --- *
867 * Arguments: @const char *fmt@ = pointer to format string
868 * @...@ = other arguments
872 * Use: Informs all admin connections of a warning.
875 extern void a_warn(const char */*fmt*/, ...);
877 /* --- @a_notify@ --- *
879 * Arguments: @const char *fmt@ = pointer to format string
880 * @...@ = other arguments
884 * Use: Sends a notification to interested admin connections.
887 extern void a_notify(const char */*fmt*/, ...);
889 /* --- @a_create@ --- *
891 * Arguments: @int fd_in, fd_out@ = file descriptors to use
892 * @unsigned f@ = initial flags to set
896 * Use: Creates a new admin connection.
899 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
901 /* --- @a_quit@ --- *
907 * Use: Shuts things down nicely.
910 extern void a_quit(void);
912 /* --- @a_preselect@ --- *
918 * Use: Informs the admin module that we're about to select again,
919 * and that it should do cleanup things it has delayed until a
923 extern void a_preselect(void);
925 /* --- @a_daemon@ --- *
931 * Use: Informs the admin module that it's a daemon.
934 extern void a_daemon(void);
936 /* --- @a_init@ --- *
938 * Arguments: @const char *sock@ = socket name to create
939 * @uid_t u@ = user to own the socket
940 * @gid_t g@ = group to own the socket
944 * Use: Creates the admin listening socket.
947 extern void a_init(const char */*sock*/, uid_t /*u*/, gid_t /*g*/);
949 /*----- Mapping with addresses as keys ------------------------------------*/
951 /* --- @am_create@ --- *
953 * Arguments: @addrmap *m@ = pointer to map
957 * Use: Create an address map, properly set up.
960 extern void am_create(addrmap */*m*/);
962 /* --- @am_destroy@ --- *
964 * Arguments: @addrmap *m@ = pointer to map
968 * Use: Destroy an address map, throwing away all the entries.
971 extern void am_destroy(addrmap */*m*/);
973 /* --- @am_find@ --- *
975 * Arguments: @addrmap *m@ = pointer to map
976 * @const addr *a@ = address to look up
977 * @size_t sz@ = size of block to allocate
978 * @unsigned *f@ = where to store flags
980 * Returns: Pointer to found item, or null.
982 * Use: Finds a record with the given IP address, set @*f@ nonzero
983 * and returns it. If @sz@ is zero, and no match was found,
984 * return null; otherwise allocate a new block of @sz@ bytes,
985 * clear @*f@ to zero and return the block pointer.
988 extern void *am_find(addrmap */*m*/, const addr */*a*/,
989 size_t /*sz*/, unsigned */*f*/);
991 /* --- @am_remove@ --- *
993 * Arguments: @addrmap *m@ = pointer to map
994 * @void *i@ = pointer to the item
998 * Use: Removes an item from the map.
1001 extern void am_remove(addrmap */*m*/, void */*i*/);
1003 /*----- Privilege separation ----------------------------------------------*/
1005 /* --- @ps_trace@ --- *
1007 * Arguments: @unsigned mask@ = trace mask to check
1008 * @const char *fmt@ = message format
1009 * @...@ = values for placeholders
1013 * Use: Writes a trace message.
1016 T( extern void ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); )
1018 /* --- @ps_warn@ --- *
1020 * Arguments: @const char *fmt@ = message format
1021 * @...@ = values for placeholders
1025 * Use: Writes a warning message.
1028 extern void ps_warn(const char */*fmt*/, ...);
1030 /* --- @ps_tunfd@ --- *
1032 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1033 * @char **ifn@ = where to put the interface name
1035 * Returns: The file descriptor, or @-1@ on error.
1037 * Use: Fetches a file descriptor for a tunnel driver.
1040 extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/);
1042 /* --- @ps_split@ --- *
1044 * Arguments: @int detachp@ = whether to detach the child from its terminal
1048 * Use: Separates off the privileged tunnel-opening service from the
1049 * rest of the server.
1052 extern void ps_split(int /*detachp*/);
1054 /* --- @ps_quit@ --- *
1060 * Use: Detaches from the helper process.
1063 extern void ps_quit(void);
1065 /*----- Peer management ---------------------------------------------------*/
1067 /* --- @p_txstart@ --- *
1069 * Arguments: @peer *p@ = pointer to peer block
1070 * @unsigned msg@ = message type code
1072 * Returns: A pointer to a buffer to write to.
1074 * Use: Starts sending to a peer. Only one send can happen at a
1078 extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
1080 /* --- @p_txend@ --- *
1082 * Arguments: @peer *p@ = pointer to peer block
1086 * Use: Sends a packet to the peer.
1089 extern void p_txend(peer */*p*/);
1091 /* --- @p_pingsend@ --- *
1093 * Arguments: @peer *p@ = destination peer
1094 * @ping *pg@ = structure to fill in
1095 * @unsigned type@ = message type
1096 * @unsigned long timeout@ = how long to wait before giving up
1097 * @void (*func)(int, void *)@ = callback function
1098 * @void *arg@ = argument for callback
1100 * Returns: Zero if successful, nonzero if it failed.
1102 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1103 * if we get an answer within the timeout, or zero if no answer.
1106 extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
1107 unsigned long /*timeout*/,
1108 void (*/*func*/)(int, void *), void */*arg*/);
1110 /* --- @p_pingdone@ --- *
1112 * Arguments: @ping *p@ = ping structure
1113 * @int rc@ = return code to pass on
1117 * Use: Disposes of a ping structure, maybe sending a notification.
1120 extern void p_pingdone(ping */*p*/, int /*rc*/);
1122 /* --- @p_greet@ --- *
1124 * Arguments: @peer *p@ = peer to send to
1125 * @const void *c@ = pointer to challenge
1126 * @size_t sz@ = size of challenge
1130 * Use: Sends a greeting packet.
1133 extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
1135 /* --- @p_tun@ --- *
1137 * Arguments: @peer *p@ = pointer to peer block
1138 * @buf *b@ = buffer containing incoming packet
1142 * Use: Handles a packet which needs to be sent to a peer.
1145 extern void p_tun(peer */*p*/, buf */*b*/);
1147 /* --- @p_keyreload@ --- *
1153 * Use: Forces a check of the daemon's keyring files.
1156 extern void p_keyreload(void);
1158 /* --- @p_interval@ --- *
1164 * Use: Called periodically to do tidying.
1167 extern void p_interval(void);
1169 /* --- @p_stats@ --- *
1171 * Arguments: @peer *p@ = pointer to a peer block
1173 * Returns: A pointer to the peer's statistics.
1176 extern stats *p_stats(peer */*p*/);
1178 /* --- @p_ifname@ --- *
1180 * Arguments: @peer *p@ = pointer to a peer block
1182 * Returns: A pointer to the peer's interface name.
1185 extern const char *p_ifname(peer */*p*/);
1187 /* --- @p_setifname@ --- *
1189 * Arguments: @peer *p@ = pointer to a peer block
1190 * @const char *name@ = pointer to the new name
1194 * Use: Changes the name held for a peer's interface.
1197 extern void p_setifname(peer */*p*/, const char */*name*/);
1199 /* --- @p_addr@ --- *
1201 * Arguments: @peer *p@ = pointer to a peer block
1203 * Returns: A pointer to the peer's address.
1206 extern const addr *p_addr(peer */*p*/);
1208 /* --- @p_init@ --- *
1210 * Arguments: @struct in_addr addr@ = address to bind to
1211 * @unsigned port@ = port number to listen to
1215 * Use: Initializes the peer system; creates the socket.
1218 extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
1220 /* --- @p_port@ --- *
1224 * Returns: Port number used for socket.
1227 unsigned p_port(void);
1229 /* --- @p_create@ --- *
1231 * Arguments: @peerspec *spec@ = information about this peer
1233 * Returns: Pointer to the peer block, or null if it failed.
1235 * Use: Creates a new named peer block. No peer is actually attached
1239 extern peer *p_create(peerspec */*spec*/);
1241 /* --- @p_name@ --- *
1243 * Arguments: @peer *p@ = pointer to a peer block
1245 * Returns: A pointer to the peer's name.
1247 * Use: Equivalent to @p_spec(p)->name@.
1250 extern const char *p_name(peer */*p*/);
1252 /* --- @p_spec@ --- *
1254 * Arguments: @peer *p@ = pointer to a peer block
1256 * Returns: Pointer to the peer's specification
1259 extern const peerspec *p_spec(peer */*p*/);
1261 /* --- @p_findbyaddr@ --- *
1263 * Arguments: @const addr *a@ = address to look up
1265 * Returns: Pointer to the peer block, or null if not found.
1267 * Use: Finds a peer by address.
1270 extern peer *p_findbyaddr(const addr */*a*/);
1272 /* --- @p_find@ --- *
1274 * Arguments: @const char *name@ = name to look up
1276 * Returns: Pointer to the peer block, or null if not found.
1278 * Use: Finds a peer by name.
1281 extern peer *p_find(const char */*name*/);
1283 /* --- @p_destroy@ --- *
1285 * Arguments: @peer *p@ = pointer to a peer
1289 * Use: Destroys a peer.
1292 extern void p_destroy(peer */*p*/);
1294 /* --- @FOREACH_PEER@ --- *
1296 * Arguments: @p@ = name to bind to each peer
1297 * @stuff@ = thing to do for each item
1299 * Use: Does something for each current peer.
1302 #define FOREACH_PEER(p, stuff) do { \
1305 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) do stuff while (0); \
1308 /* --- @p_mkiter@ --- *
1310 * Arguments: @peer_iter *i@ = pointer to an iterator
1314 * Use: Initializes the iterator.
1317 extern void p_mkiter(peer_iter */*i*/);
1319 /* --- @p_next@ --- *
1321 * Arguments: @peer_iter *i@ = pointer to an iterator
1323 * Returns: Next peer, or null if at the end.
1325 * Use: Returns the next peer.
1328 extern peer *p_next(peer_iter */*i*/);
1330 /*----- Tunnel drivers ----------------------------------------------------*/
1333 extern const tunnel_ops tun_linux;
1337 extern const tunnel_ops tun_unet;
1341 extern const tunnel_ops tun_bsd;
1344 extern const tunnel_ops tun_slip;
1346 /*----- Other handy utilities ---------------------------------------------*/
1348 /* --- @mpstr@ --- *
1350 * Arguments: @mp *m@ = a multiprecision integer
1352 * Returns: A pointer to the integer's textual representation.
1354 * Use: Converts a multiprecision integer to a string. Corrupts
1358 extern const char *mpstr(mp */*m*/);
1360 /* --- @gestr@ --- *
1362 * Arguments: @group *g@ = a group
1363 * @ge *x@ = a group element
1365 * Returns: A pointer to the element's textual representation.
1367 * Use: Converts a group element to a string. Corrupts
1371 extern const char *gestr(group */*g*/, ge */*x*/);
1373 /* --- @timestr@ --- *
1375 * Arguments: @time_t t@ = a time to convert
1377 * Returns: A pointer to a textual representation of the time.
1379 * Use: Converts a time to a textual representation. Corrupts
1383 extern const char *timestr(time_t /*t*/);
1385 /* --- @mystrieq@ --- *
1387 * Arguments: @const char *x, *y@ = two strings
1389 * Returns: True if @x@ and @y are equal, up to case.
1392 extern int mystrieq(const char */*x*/, const char */*y*/);
1394 /* --- @seq_reset@ --- *
1396 * Arguments: @seqwin *s@ = sequence-checking window
1400 * Use: Resets a sequence number window.
1403 extern void seq_reset(seqwin */*s*/);
1405 /* --- @seq_check@ --- *
1407 * Arguments: @seqwin *s@ = sequence-checking window
1408 * @uint32 q@ = sequence number to check
1409 * @const char *service@ = service to report message from
1411 * Returns: A @SEQ_@ code.
1413 * Use: Checks a sequence number against the window, updating things
1417 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
1419 /*----- That's all, folks -------------------------------------------------*/