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 typedef struct kdata {
159 unsigned ref; /* Reference counter */
160 struct knode *kn; /* Pointer to cache entry */
161 char *tag; /* Full tag name of the key */
162 group *g; /* The group we work in */
163 size_t indexsz; /* Size of exponent for the group */
164 mp *kpriv; /* The private key (or null) */
165 ge *kpub; /* The public key */
166 time_t t_exp; /* Expiry time of the key */
167 algswitch algs; /* Collection of algorithms */
170 typedef struct knode {
171 sym_base _b; /* Symbol table intrusion */
172 unsigned f; /* Various flags */
173 #define KNF_BROKEN 1u /* Don't use this key any more */
174 struct keyhalf *kh; /* Pointer to the home keyhalf */
175 kdata *kd; /* Pointer to the key data */
178 #define MAXHASHSZ 64 /* Largest possible hash size */
180 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
182 /*----- Data structures ---------------------------------------------------*/
184 /* --- Socket addresses --- *
186 * A magic union of supported socket addresses.
191 struct sockaddr_in sin;
194 /* --- Mapping keyed on addresses --- */
196 typedef struct addrmap {
201 typedef struct addrmap_base {
206 /* --- Sequence number checking --- */
208 typedef struct seqwin {
209 uint32 seq; /* First acceptable input sequence */
210 uint32 win; /* Window of acceptable numbers */
213 #define SEQ_WINSZ 32 /* Bits in sequence number window */
215 /* --- A symmetric keyset --- *
217 * A keyset contains a set of symmetric keys for encrypting and decrypting
218 * packets. Keysets are stored in a list, sorted in reverse order of
219 * creation, so that the most recent keyset (the one most likely to be used)
222 * Each keyset has a time limit and a data limit. The keyset is destroyed
223 * when either it has existed for too long, or it has been used to encrypt
224 * too much data. New key exchanges are triggered when keys are close to
228 typedef struct keyset {
229 struct keyset *next; /* Next active keyset in the list */
230 unsigned ref; /* Reference count for keyset */
231 struct peer *p; /* Pointer to peer structure */
232 time_t t_exp; /* Expiry time for this keyset */
233 unsigned long sz_exp, sz_regen; /* Data limits for the keyset */
234 T( unsigned seq; ) /* Sequence number for tracing */
235 unsigned f; /* Various useful flags */
236 gcipher *cin, *cout; /* Keyset ciphers for encryption */
237 size_t tagsz; /* Length to truncate MAC tags */
238 gmac *min, *mout; /* Keyset MACs for integrity */
239 uint32 oseq; /* Outbound sequence number */
240 seqwin iseq; /* Inbound sequence number */
243 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
244 #define KSF_LINK 2u /* Key is in a linked list */
246 #define KSERR_REGEN -1 /* Regenerate keys */
247 #define KSERR_NOKEYS -2 /* No keys left */
248 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
249 #define KSERR_SEQ -4 /* Incorrect sequence number */
250 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
252 /* --- Key exchange --- *
254 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
255 * Protocol has a number of desirable features (e.g., perfect forward
256 * secrecy, and zero-knowledge authentication) which make it attractive for
257 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
263 typedef struct kxchal {
264 struct keyexch *kx; /* Pointer back to key exchange */
265 ge *c; /* Responder's challenge */
266 ge *r; /* My reply to the challenge */
267 keyset *ks; /* Pointer to temporary keyset */
268 unsigned f; /* Various useful flags */
269 sel_timer t; /* Response timer for challenge */
270 octet hc[MAXHASHSZ]; /* Hash of his challenge */
271 octet ck[MAXHASHSZ]; /* His magical check value */
272 octet hswrq_in[MAXHASHSZ]; /* Inbound switch request message */
273 octet hswok_in[MAXHASHSZ]; /* Inbound switch confirmation */
274 octet hswrq_out[MAXHASHSZ]; /* Outbound switch request message */
275 octet hswok_out[MAXHASHSZ]; /* Outbound switch confirmation */
278 typedef struct keyexch {
279 struct peer *p; /* Pointer back to the peer */
280 keyset **ks; /* Peer's list of keysets */
281 unsigned f; /* Various useful flags */
282 unsigned s; /* Current state in exchange */
283 sel_timer t; /* Timer for next exchange */
284 ge *kpub; /* Peer's public key */
285 time_t texp_kpub; /* Expiry time for public key */
286 mp *alpha; /* My temporary secret */
287 ge *c; /* My challenge */
288 ge *rx; /* The expected response */
289 unsigned nr; /* Number of extant responses */
290 time_t t_valid; /* When this exchange goes bad */
291 octet hc[MAXHASHSZ]; /* Hash of my challenge */
292 kxchal *r[KX_NCHAL]; /* Array of challenges */
295 #define KXF_TIMER 1u /* Waiting for a timer to go off */
296 #define KXF_DEAD 2u /* The key-exchanger isn't up */
297 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
298 #define KXF_CORK 8u /* Don't send anything yet */
301 KXS_DEAD, /* Uninitialized state (magical) */
302 KXS_CHAL, /* Main answer-challenges state */
303 KXS_COMMIT, /* Committed: send switch request */
304 KXS_SWITCH /* Switched: send confirmation */
307 /* --- Tunnel structure --- *
309 * Used to maintain system-specific information about the tunnel interface.
312 typedef struct tunnel tunnel;
315 typedef struct tunnel_ops {
316 const char *name; /* Name of this tunnel driver */
317 unsigned flags; /* Various interesting flags */
318 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
319 void (*init)(void); /* Initializes the system */
320 tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/);
321 /* Initializes a new tunnel */
322 void (*setifname)(tunnel */*t*/, const char */*ifn*/);
323 /* Notifies ifname change */
324 void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
325 void (*destroy)(tunnel */*t*/); /* Destroys a tunnel */
328 #ifndef TUN_INTERNALS
329 struct tunnel { const tunnel_ops *ops; };
332 /* --- Peer statistics --- *
334 * Contains various interesting and not-so-interesting statistics about a
335 * peer. This is updated by various parts of the code. The format of the
336 * structure isn't considered private, and @p_stats@ returns a pointer to the
337 * statistics block for a given peer.
340 typedef struct stats {
341 unsigned long sz_in, sz_out; /* Size of all data in and out */
342 unsigned long sz_kxin, sz_kxout; /* Size of key exchange messages */
343 unsigned long sz_ipin, sz_ipout; /* Size of encapsulated IP packets */
344 time_t t_start, t_last, t_kx; /* Time peer created, last pk, kx */
345 unsigned long n_reject; /* Number of rejected packets */
346 unsigned long n_in, n_out; /* Number of packets in and out */
347 unsigned long n_kxin, n_kxout; /* Number of key exchange packets */
348 unsigned long n_ipin, n_ipout; /* Number of encrypted packets */
351 /* --- Peer structure --- *
353 * The main structure which glues everything else together.
356 typedef struct peerspec {
357 char *name; /* Peer's name */
358 char *tag; /* Public key tag */
359 const tunnel_ops *tops; /* Tunnel operations */
360 unsigned long t_ka; /* Keep alive interval */
361 addr sa; /* Socket address to speak to */
362 size_t sasz; /* Socket address size */
363 unsigned f; /* Flags for the peer */
364 #define PSF_KXMASK 255u /* Key-exchange flags to set */
365 #define PSF_MOBILE 256u /* Address may change rapidly */
368 typedef struct peer_byname {
373 typedef struct peer_byaddr {
378 typedef struct peer {
379 peer_byname *byname; /* Lookup-by-name block */
380 peer_byaddr *byaddr; /* Lookup-by-address block */
381 struct ping *pings; /* Pings we're waiting for */
382 peerspec spec; /* Specifications for this peer */
383 tunnel *t; /* Tunnel for local packets */
384 char *ifname; /* Interface name for tunnel */
385 keyset *ks; /* List head for keysets */
386 buf b; /* Buffer for sending packets */
387 stats st; /* Statistics */
388 keyexch kx; /* Key exchange protocol block */
389 sel_timer tka; /* Timer for keepalives */
392 typedef struct peer_iter { sym_iter i; } peer_iter;
394 typedef struct ping {
395 struct ping *next, *prev; /* Links to next and previous */
396 peer *p; /* Peer so we can free it */
397 unsigned msg; /* Kind of response expected */
398 uint32 id; /* Id so we can recognize response */
399 octet magic[32]; /* Some random data */
400 sel_timer t; /* Timeout for ping */
401 void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
402 void *arg; /* Argument for callback */
413 /* --- Admin structure --- */
415 #define OBUFSZ 16384u
417 typedef struct obuf {
418 struct obuf *next; /* Next buffer in list */
419 char *p_in, *p_out; /* Pointers into the buffer */
420 char buf[OBUFSZ]; /* The actual buffer */
423 typedef struct oqueue {
424 obuf *hd, *tl; /* Head and tail pointers */
429 typedef struct admin_bgop {
430 struct admin_bgop *next, *prev; /* Links to next and previous */
431 struct admin *a; /* Owner job */
432 char *tag; /* Tag string for messages */
433 void (*cancel)(struct admin_bgop *); /* Destructor function */
436 typedef struct admin_resop {
437 admin_bgop bg; /* Background operation header */
438 char *addr; /* Hostname to be resolved */
439 bres_client r; /* Background resolver task */
440 sel_timer t; /* Timer for resolver */
441 addr sa; /* Socket address */
442 size_t sasz; /* Socket address size */
443 void (*func)(struct admin_resop *, int); /* Handler */
446 enum { ARES_OK, ARES_FAIL };
448 typedef struct admin_addop {
449 admin_resop r; /* Name resolution header */
450 peerspec peer; /* Peer pending creation */
453 typedef struct admin_pingop {
454 admin_bgop bg; /* Background operation header */
455 ping ping; /* Ping pending response */
456 struct timeval pingtime; /* Time last ping was sent */
459 typedef struct admin_service {
460 sym_base _b; /* Hash table base structure */
461 char *version; /* The provided version */
462 struct admin *prov; /* Which client provides me */
463 struct admin_service *next, *prev; /* Client's list of services */
466 typedef struct admin_svcop {
467 admin_bgop bg; /* Background operation header */
468 struct admin *prov; /* Client servicing this job */
469 unsigned index; /* This job's index */
470 struct admin_svcop *next, *prev; /* Links for provider's jobs */
473 typedef struct admin_jobentry {
474 unsigned short seq; /* Zero if unused */
476 admin_svcop *op; /* Operation, if slot in use, ... */
477 uint32 next; /* ... or index of next free slot */
481 typedef struct admin_jobtable {
482 uint32 n, sz; /* Used slots and table size */
483 admin_svcop *active; /* List of active jobs */
484 uint32 free; /* Index of first free slot */
485 admin_jobentry *v; /* And the big array of entries */
488 typedef struct admin {
489 struct admin *next, *prev; /* Links to next and previous */
490 unsigned f; /* Various useful flags */
491 unsigned ref; /* Reference counter */
493 unsigned seq; /* Sequence number for tracing */
495 oqueue out; /* Output buffer list */
496 oqueue delay; /* Delayed output buffer list */
497 admin_bgop *bg; /* Backgrounded operations */
498 admin_service *svcs; /* Which services I provide */
499 admin_jobtable j; /* Table of outstanding jobs */
500 selbuf b; /* Line buffer for commands */
501 sel_file w; /* Selector for write buffering */
504 #define AF_DEAD 1u /* Destroy this admin block */
505 #define AF_CLOSE 2u /* Client closed connection */
506 #define AF_NOTE 4u /* Catch notifications */
507 #define AF_WARN 8u /* Catch warning messages */
509 #define AF_TRACE 16u /* Catch tracing */
511 #define AF_FOREGROUND 32u /* Quit server when client closes */
514 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
516 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
519 /*----- Global variables --------------------------------------------------*/
521 extern sel_state sel; /* Global I/O event state */
522 extern group *gg; /* The group we work in */
523 extern size_t indexsz; /* Size of exponent for the group */
524 extern mp *kpriv; /* Our private key */
525 extern ge *kpub; /* Our public key */
526 extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
527 extern const tunnel_ops *tunnels[]; /* Table of tunnels (0-term) */
528 extern const tunnel_ops *tun_default; /* Default tunnel to use */
529 extern kdata *master; /* Default private key */
530 extern const char *tag_priv; /* Default private key tag */
533 extern const trace_opt tr_opts[]; /* Trace options array */
534 extern unsigned tr_flags; /* Trace options flags */
537 /*----- Other macros ------------------------------------------------------*/
539 #define TIMER noise_timer(RAND_GLOBAL)
541 /*----- Key management ----------------------------------------------------*/
543 /* --- @km_init@ --- *
545 * Arguments: @const char *privkr@ = private keyring file
546 * @const char *pubkr@ = public keyring file
547 * @const char *ptag@ = default private-key tag
551 * Use: Initializes the key-management machinery, loading the
552 * keyrings and so on.
555 extern void km_init(const char */*privkr*/, const char */*pubkr*/,
556 const char */*ptag*/);
558 /* --- @km_reload@ --- *
562 * Returns: Zero if OK, nonzero to force reloading of keys.
564 * Use: Checks the keyrings to see if they need reloading.
567 extern int km_reload(void);
569 /* --- @km_findpub@, @km_findpriv@ --- *
571 * Arguments: @const char *tag@ = key tag to load
573 * Returns: Pointer to the kdata object if successful, or null on error.
575 * Use: Fetches a public or private key from the keyring.
578 extern kdata *km_findpub(const char */*tag*/);
579 extern kdata *km_findpriv(const char */*tag*/);
581 /* --- @km_samealgsp@ --- *
583 * Arguments: @const kdata *kdx, *kdy@ = two key data objects
585 * Returns: Nonzero if their two algorithm selections are the same.
587 * Use: Checks sameness of algorithm selections: used to ensure that
588 * peers are using sensible algorithms.
591 extern int km_samealgsp(const kdata */*kdx*/, const kdata */*kdy*/);
593 /* --- @km_ref@ --- *
595 * Arguments: @kdata *kd@ = pointer to the kdata object
599 * Use: Claim a new reference to a kdata object.
602 extern void km_ref(kdata */*kd*/);
604 /* --- @km_unref@ --- *
606 * Arguments: @kdata *kd@ = pointer to the kdata object
610 * Use: Releases a reference to a kdata object.
613 extern void km_unref(kdata */*kd*/);
615 /* --- @km_tag@ --- *
617 * Arguments: @kdata *kd@ - pointer to the kdata object
619 * Returns: A pointer to the short tag by which the kdata was loaded.
622 extern const char *km_tag(kdata */*kd*/);
624 /* --- @km_getpubkey@ --- *
626 * Arguments: @const char *tag@ = public key tag to load
627 * @ge *kpub@ = where to put the public key
628 * @time_t *t_exp@ = where to put the expiry time
630 * Returns: Zero if OK, nonzero if it failed.
632 * Use: Fetches a public key from the keyring. (Temporary
633 * compatibility hack.)
636 extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
639 /*----- Key exchange ------------------------------------------------------*/
641 /* --- @kx_start@ --- *
643 * Arguments: @keyexch *kx@ = pointer to key exchange context
644 * @int forcep@ = nonzero to ignore the quiet timer
648 * Use: Stimulates a key exchange. If a key exchage is in progress,
649 * a new challenge is sent (unless the quiet timer forbids
650 * this); if no exchange is in progress, one is commenced.
653 extern void kx_start(keyexch */*kx*/, int /*forcep*/);
655 /* --- @kx_message@ --- *
657 * Arguments: @keyexch *kx@ = pointer to key exchange context
658 * @unsigned msg@ = the message code
659 * @buf *b@ = pointer to buffer containing the packet
663 * Use: Reads a packet containing key exchange messages and handles
667 extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/);
669 /* --- @kx_free@ --- *
671 * Arguments: @keyexch *kx@ = pointer to key exchange context
675 * Use: Frees everything in a key exchange context.
678 extern void kx_free(keyexch */*kx*/);
680 /* --- @kx_newkeys@ --- *
682 * Arguments: @keyexch *kx@ = pointer to key exchange context
686 * Use: Informs the key exchange module that its keys may have
687 * changed. If fetching the new keys fails, the peer will be
688 * destroyed, we log messages and struggle along with the old
692 extern void kx_newkeys(keyexch */*kx*/);
694 /* --- @kx_init@ --- *
696 * Arguments: @keyexch *kx@ = pointer to key exchange context
697 * @peer *p@ = pointer to peer context
698 * @keyset **ks@ = pointer to keyset list
699 * @unsigned f@ = various useful flags
701 * Returns: Zero if OK, nonzero if it failed.
703 * Use: Initializes a key exchange module. The module currently
704 * contains no keys, and will attempt to initiate a key
708 extern int kx_init(keyexch */*kx*/, peer */*p*/,
709 keyset **/*ks*/, unsigned /*f*/);
711 /*----- Keysets and symmetric cryptography --------------------------------*/
713 /* --- @ks_drop@ --- *
715 * Arguments: @keyset *ks@ = pointer to a keyset
719 * Use: Decrements a keyset's reference counter. If the counter hits
720 * zero, the keyset is freed.
723 extern void ks_drop(keyset */*ks*/);
725 /* --- @ks_gen@ --- *
727 * Arguments: @const void *k@ = pointer to key material
728 * @size_t x, y, z@ = offsets into key material (see below)
729 * @peer *p@ = pointer to peer information
731 * Returns: A pointer to the new keyset.
733 * Use: Derives a new keyset from the given key material. The
734 * offsets @x@, @y@ and @z@ separate the key material into three
735 * parts. Between the @k@ and @k + x@ is `my' contribution to
736 * the key material; between @k + x@ and @k + y@ is `your'
737 * contribution; and between @k + y@ and @k + z@ is a shared
738 * value we made together. These are used to construct two
739 * pairs of symmetric keys. Each pair consists of an encryption
740 * key and a message authentication key. One pair is used for
741 * outgoing messages, the other for incoming messages.
743 * The new key is marked so that it won't be selected for output
744 * by @ksl_encrypt@. You can still encrypt data with it by
745 * calling @ks_encrypt@ directly.
748 extern keyset *ks_gen(const void */*k*/,
749 size_t /*x*/, size_t /*y*/, size_t /*z*/,
752 /* --- @ks_tregen@ --- *
754 * Arguments: @keyset *ks@ = pointer to a keyset
756 * Returns: The time at which moves ought to be made to replace this key.
759 extern time_t ks_tregen(keyset */*ks*/);
761 /* --- @ks_activate@ --- *
763 * Arguments: @keyset *ks@ = pointer to a keyset
767 * Use: Activates a keyset, so that it can be used for encrypting
771 extern void ks_activate(keyset */*ks*/);
773 /* --- @ks_encrypt@ --- *
775 * Arguments: @keyset *ks@ = pointer to a keyset
776 * @unsigned ty@ = message type
777 * @buf *b@ = pointer to input buffer
778 * @buf *bb@ = pointer to output buffer
780 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
781 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
782 * returns zero if there was insufficient buffer (but the output
783 * buffer is broken in this case).
785 * Use: Encrypts a block of data using the key. Note that the `key
786 * ought to be replaced' notification is only ever given once
787 * for each key. Also note that this call forces a keyset to be
788 * used even if it's marked as not for data output.
791 extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
792 buf */*b*/, buf */*bb*/);
794 /* --- @ks_decrypt@ --- *
796 * Arguments: @keyset *ks@ = pointer to a keyset
797 * @unsigned ty@ = expected type code
798 * @buf *b@ = pointer to an input buffer
799 * @buf *bb@ = pointer to an output buffer
801 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
802 * zero if there was insufficient buffer (but the output buffer
803 * is broken in this case).
805 * Use: Attempts to decrypt a message using a given key. Note that
806 * requesting decryption with a key directly won't clear a
807 * marking that it's not for encryption.
810 extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
811 buf */*b*/, buf */*bb*/);
813 /* --- @ksl_free@ --- *
815 * Arguments: @keyset **ksroot@ = pointer to keyset list head
819 * Use: Frees (releases references to) all of the keys in a keyset.
822 extern void ksl_free(keyset **/*ksroot*/);
824 /* --- @ksl_link@ --- *
826 * Arguments: @keyset **ksroot@ = pointer to keyset list head
827 * @keyset *ks@ = pointer to a keyset
831 * Use: Links a keyset into a list. A keyset can only be on one list
832 * at a time. Bad things happen otherwise.
835 extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
837 /* --- @ksl_prune@ --- *
839 * Arguments: @keyset **ksroot@ = pointer to keyset list head
843 * Use: Prunes the keyset list by removing keys which mustn't be used
847 extern void ksl_prune(keyset **/*ksroot*/);
849 /* --- @ksl_encrypt@ --- *
851 * Arguments: @keyset **ksroot@ = pointer to keyset list head
852 * @unsigned ty@ = message type
853 * @buf *b@ = pointer to input buffer
854 * @buf *bb@ = pointer to output buffer
856 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
857 * new key; @KSERR_NOKEYS@ if there are no suitable keys
858 * available. Also returns zero if there was insufficient
859 * buffer space (but the output buffer is broken in this case).
861 * Use: Encrypts a packet.
864 extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
865 buf */*b*/, buf */*bb*/);
867 /* --- @ksl_decrypt@ --- *
869 * Arguments: @keyset **ksroot@ = pointer to keyset list head
870 * @unsigned ty@ = expected type code
871 * @buf *b@ = pointer to input buffer
872 * @buf *bb@ = pointer to output buffer
874 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
875 * zero if there was insufficient buffer (but the output buffer
876 * is broken in this case).
878 * Use: Decrypts a packet.
881 extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
882 buf */*b*/, buf */*bb*/);
884 /*----- Challenges --------------------------------------------------------*/
888 * Arguments: @buf *b@ = where to put the challenge
890 * Returns: Zero if OK, nonzero on error.
892 * Use: Issues a new challenge.
895 extern int c_new(buf */*b*/);
897 /* --- @c_check@ --- *
899 * Arguments: @buf *b@ = where to find the challenge
901 * Returns: Zero if OK, nonzero if it didn't work.
903 * Use: Checks a challenge. On failure, the buffer is broken.
906 extern int c_check(buf */*b*/);
908 /*----- Administration interface ------------------------------------------*/
910 #define A_END ((char *)0)
912 /* --- @a_vformat@ --- *
914 * Arguments: @dstr *d@ = where to leave the formatted message
915 * @const char *fmt@ = pointer to format string
916 * @va_list ap@ = arguments in list
920 * Use: Main message token formatting driver. The arguments are
921 * interleaved formatting tokens and their parameters, finally
922 * terminated by an entry @A_END@.
926 * * "*..." ... -- pretokenized @dstr_putf@-like string
928 * * "?ADDR" SOCKADDR -- a socket address, to be converted
930 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
932 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
934 * * "?PEER" PEER -- peer's name
936 * * "?ERRNO" ERRNO -- system error code
938 * * "[!]..." ... -- @dstr_putf@-like string as single token
941 extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list /*ap*/);
943 /* --- @a_format@ --- *
945 * Arguments: @dstr *d@ = where to leave the formatted message
946 * @const char *fmt@ = pointer to format string
950 * Use: Writes a tokenized message into a string, for later
954 extern void a_format(dstr */*d*/, const char */*fmt*/, ...);
956 /* --- @a_warn@ --- *
958 * Arguments: @const char *fmt@ = pointer to format string
959 * @...@ = other arguments
963 * Use: Informs all admin connections of a warning.
966 extern void a_warn(const char */*fmt*/, ...);
968 /* --- @a_notify@ --- *
970 * Arguments: @const char *fmt@ = pointer to format string
971 * @...@ = other arguments
975 * Use: Sends a notification to interested admin connections.
978 extern void a_notify(const char */*fmt*/, ...);
980 /* --- @a_create@ --- *
982 * Arguments: @int fd_in, fd_out@ = file descriptors to use
983 * @unsigned f@ = initial flags to set
987 * Use: Creates a new admin connection.
990 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
992 /* --- @a_quit@ --- *
998 * Use: Shuts things down nicely.
1001 extern void a_quit(void);
1003 /* --- @a_preselect@ --- *
1009 * Use: Informs the admin module that we're about to select again,
1010 * and that it should do cleanup things it has delayed until a
1014 extern void a_preselect(void);
1016 /* --- @a_daemon@ --- *
1022 * Use: Informs the admin module that it's a daemon.
1025 extern void a_daemon(void);
1027 /* --- @a_init@ --- *
1029 * Arguments: @const char *sock@ = socket name to create
1030 * @uid_t u@ = user to own the socket
1031 * @gid_t g@ = group to own the socket
1032 * @mode_t m@ = permissions to set on the socket
1036 * Use: Creates the admin listening socket.
1039 extern void a_init(const char */*sock*/,
1040 uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
1042 /*----- Mapping with addresses as keys ------------------------------------*/
1044 /* --- @am_create@ --- *
1046 * Arguments: @addrmap *m@ = pointer to map
1050 * Use: Create an address map, properly set up.
1053 extern void am_create(addrmap */*m*/);
1055 /* --- @am_destroy@ --- *
1057 * Arguments: @addrmap *m@ = pointer to map
1061 * Use: Destroy an address map, throwing away all the entries.
1064 extern void am_destroy(addrmap */*m*/);
1066 /* --- @am_find@ --- *
1068 * Arguments: @addrmap *m@ = pointer to map
1069 * @const addr *a@ = address to look up
1070 * @size_t sz@ = size of block to allocate
1071 * @unsigned *f@ = where to store flags
1073 * Returns: Pointer to found item, or null.
1075 * Use: Finds a record with the given IP address, set @*f@ nonzero
1076 * and returns it. If @sz@ is zero, and no match was found,
1077 * return null; otherwise allocate a new block of @sz@ bytes,
1078 * clear @*f@ to zero and return the block pointer.
1081 extern void *am_find(addrmap */*m*/, const addr */*a*/,
1082 size_t /*sz*/, unsigned */*f*/);
1084 /* --- @am_remove@ --- *
1086 * Arguments: @addrmap *m@ = pointer to map
1087 * @void *i@ = pointer to the item
1091 * Use: Removes an item from the map.
1094 extern void am_remove(addrmap */*m*/, void */*i*/);
1096 /*----- Privilege separation ----------------------------------------------*/
1098 /* --- @ps_trace@ --- *
1100 * Arguments: @unsigned mask@ = trace mask to check
1101 * @const char *fmt@ = message format
1102 * @...@ = values for placeholders
1106 * Use: Writes a trace message.
1109 T( extern void ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); )
1111 /* --- @ps_warn@ --- *
1113 * Arguments: @const char *fmt@ = message format
1114 * @...@ = values for placeholders
1118 * Use: Writes a warning message.
1121 extern void ps_warn(const char */*fmt*/, ...);
1123 /* --- @ps_tunfd@ --- *
1125 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1126 * @char **ifn@ = where to put the interface name
1128 * Returns: The file descriptor, or @-1@ on error.
1130 * Use: Fetches a file descriptor for a tunnel driver.
1133 extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/);
1135 /* --- @ps_split@ --- *
1137 * Arguments: @int detachp@ = whether to detach the child from its terminal
1141 * Use: Separates off the privileged tunnel-opening service from the
1142 * rest of the server.
1145 extern void ps_split(int /*detachp*/);
1147 /* --- @ps_quit@ --- *
1153 * Use: Detaches from the helper process.
1156 extern void ps_quit(void);
1158 /*----- Peer management ---------------------------------------------------*/
1160 /* --- @p_txstart@ --- *
1162 * Arguments: @peer *p@ = pointer to peer block
1163 * @unsigned msg@ = message type code
1165 * Returns: A pointer to a buffer to write to.
1167 * Use: Starts sending to a peer. Only one send can happen at a
1171 extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
1173 /* --- @p_txend@ --- *
1175 * Arguments: @peer *p@ = pointer to peer block
1179 * Use: Sends a packet to the peer.
1182 extern void p_txend(peer */*p*/);
1184 /* --- @p_pingsend@ --- *
1186 * Arguments: @peer *p@ = destination peer
1187 * @ping *pg@ = structure to fill in
1188 * @unsigned type@ = message type
1189 * @unsigned long timeout@ = how long to wait before giving up
1190 * @void (*func)(int, void *)@ = callback function
1191 * @void *arg@ = argument for callback
1193 * Returns: Zero if successful, nonzero if it failed.
1195 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1196 * if we get an answer within the timeout, or zero if no answer.
1199 extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
1200 unsigned long /*timeout*/,
1201 void (*/*func*/)(int, void *), void */*arg*/);
1203 /* --- @p_pingdone@ --- *
1205 * Arguments: @ping *p@ = ping structure
1206 * @int rc@ = return code to pass on
1210 * Use: Disposes of a ping structure, maybe sending a notification.
1213 extern void p_pingdone(ping */*p*/, int /*rc*/);
1215 /* --- @p_greet@ --- *
1217 * Arguments: @peer *p@ = peer to send to
1218 * @const void *c@ = pointer to challenge
1219 * @size_t sz@ = size of challenge
1223 * Use: Sends a greeting packet.
1226 extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
1228 /* --- @p_tun@ --- *
1230 * Arguments: @peer *p@ = pointer to peer block
1231 * @buf *b@ = buffer containing incoming packet
1235 * Use: Handles a packet which needs to be sent to a peer.
1238 extern void p_tun(peer */*p*/, buf */*b*/);
1240 /* --- @p_keyreload@ --- *
1246 * Use: Forces a check of the daemon's keyring files.
1249 extern void p_keyreload(void);
1251 /* --- @p_interval@ --- *
1257 * Use: Called periodically to do tidying.
1260 extern void p_interval(void);
1262 /* --- @p_stats@ --- *
1264 * Arguments: @peer *p@ = pointer to a peer block
1266 * Returns: A pointer to the peer's statistics.
1269 extern stats *p_stats(peer */*p*/);
1271 /* --- @p_ifname@ --- *
1273 * Arguments: @peer *p@ = pointer to a peer block
1275 * Returns: A pointer to the peer's interface name.
1278 extern const char *p_ifname(peer */*p*/);
1280 /* --- @p_setifname@ --- *
1282 * Arguments: @peer *p@ = pointer to a peer block
1283 * @const char *name@ = pointer to the new name
1287 * Use: Changes the name held for a peer's interface.
1290 extern void p_setifname(peer */*p*/, const char */*name*/);
1292 /* --- @p_addr@ --- *
1294 * Arguments: @peer *p@ = pointer to a peer block
1296 * Returns: A pointer to the peer's address.
1299 extern const addr *p_addr(peer */*p*/);
1301 /* --- @p_init@ --- *
1303 * Arguments: @struct in_addr addr@ = address to bind to
1304 * @unsigned port@ = port number to listen to
1308 * Use: Initializes the peer system; creates the socket.
1311 extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
1313 /* --- @p_port@ --- *
1317 * Returns: Port number used for socket.
1320 unsigned p_port(void);
1322 /* --- @p_create@ --- *
1324 * Arguments: @peerspec *spec@ = information about this peer
1326 * Returns: Pointer to the peer block, or null if it failed.
1328 * Use: Creates a new named peer block. No peer is actually attached
1332 extern peer *p_create(peerspec */*spec*/);
1334 /* --- @p_name@ --- *
1336 * Arguments: @peer *p@ = pointer to a peer block
1338 * Returns: A pointer to the peer's name.
1340 * Use: Equivalent to @p_spec(p)->name@.
1343 extern const char *p_name(peer */*p*/);
1345 /* --- @p_tag@ --- *
1347 * Arguments: @peer *p@ = pointer to a peer block
1349 * Returns: A pointer to the peer's public key tag.
1352 extern const char *p_tag(peer */*p*/);
1354 /* --- @p_spec@ --- *
1356 * Arguments: @peer *p@ = pointer to a peer block
1358 * Returns: Pointer to the peer's specification
1361 extern const peerspec *p_spec(peer */*p*/);
1363 /* --- @p_findbyaddr@ --- *
1365 * Arguments: @const addr *a@ = address to look up
1367 * Returns: Pointer to the peer block, or null if not found.
1369 * Use: Finds a peer by address.
1372 extern peer *p_findbyaddr(const addr */*a*/);
1374 /* --- @p_find@ --- *
1376 * Arguments: @const char *name@ = name to look up
1378 * Returns: Pointer to the peer block, or null if not found.
1380 * Use: Finds a peer by name.
1383 extern peer *p_find(const char */*name*/);
1385 /* --- @p_destroy@ --- *
1387 * Arguments: @peer *p@ = pointer to a peer
1391 * Use: Destroys a peer.
1394 extern void p_destroy(peer */*p*/);
1396 /* --- @FOREACH_PEER@ --- *
1398 * Arguments: @p@ = name to bind to each peer
1399 * @stuff@ = thing to do for each item
1401 * Use: Does something for each current peer.
1404 #define FOREACH_PEER(p, stuff) do { \
1407 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \
1410 /* --- @p_mkiter@ --- *
1412 * Arguments: @peer_iter *i@ = pointer to an iterator
1416 * Use: Initializes the iterator.
1419 extern void p_mkiter(peer_iter */*i*/);
1421 /* --- @p_next@ --- *
1423 * Arguments: @peer_iter *i@ = pointer to an iterator
1425 * Returns: Next peer, or null if at the end.
1427 * Use: Returns the next peer.
1430 extern peer *p_next(peer_iter */*i*/);
1432 /*----- Tunnel drivers ----------------------------------------------------*/
1435 extern const tunnel_ops tun_linux;
1439 extern const tunnel_ops tun_unet;
1443 extern const tunnel_ops tun_bsd;
1446 extern const tunnel_ops tun_slip;
1448 /*----- Other handy utilities ---------------------------------------------*/
1450 /* --- @mpstr@ --- *
1452 * Arguments: @mp *m@ = a multiprecision integer
1454 * Returns: A pointer to the integer's textual representation.
1456 * Use: Converts a multiprecision integer to a string. Corrupts
1460 extern const char *mpstr(mp */*m*/);
1462 /* --- @gestr@ --- *
1464 * Arguments: @group *g@ = a group
1465 * @ge *x@ = a group element
1467 * Returns: A pointer to the element's textual representation.
1469 * Use: Converts a group element to a string. Corrupts
1473 extern const char *gestr(group */*g*/, ge */*x*/);
1475 /* --- @timestr@ --- *
1477 * Arguments: @time_t t@ = a time to convert
1479 * Returns: A pointer to a textual representation of the time.
1481 * Use: Converts a time to a textual representation. Corrupts
1485 extern const char *timestr(time_t /*t*/);
1487 /* --- @mystrieq@ --- *
1489 * Arguments: @const char *x, *y@ = two strings
1491 * Returns: True if @x@ and @y are equal, up to case.
1494 extern int mystrieq(const char */*x*/, const char */*y*/);
1496 /* --- @seq_reset@ --- *
1498 * Arguments: @seqwin *s@ = sequence-checking window
1502 * Use: Resets a sequence number window.
1505 extern void seq_reset(seqwin */*s*/);
1507 /* --- @seq_check@ --- *
1509 * Arguments: @seqwin *s@ = sequence-checking window
1510 * @uint32 q@ = sequence number to check
1511 * @const char *service@ = service to report message from
1513 * Returns: A @SEQ_@ code.
1515 * Use: Checks a sequence number against the window, updating things
1519 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
1521 /*----- That's all, folks -------------------------------------------------*/