chiark / gitweb /
admin.c (a_format): New function formats token sequences to strings.
[tripe] / server / tripe.h
1 /* -*-c-*-
2  *
3  * Main header file for TrIPE
4  *
5  * (c) 2001 Straylight/Edgeware
6  */
7
8 /*----- Licensing notice --------------------------------------------------*
9  *
10  * This file is part of Trivial IP Encryption (TrIPE).
11  *
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.
16  *
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.
21  *
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.
25  */
26
27 #ifndef TRIPE_H
28 #define TRIPE_H
29
30 #ifdef __cplusplus
31   extern "C" {
32 #endif
33
34 /*----- Header files ------------------------------------------------------*/
35
36 #include "config.h"
37
38 #include <assert.h>
39 #include <ctype.h>
40 #include <errno.h>
41 #include <limits.h>
42 #include <signal.h>
43 #include <stdarg.h>
44 #include <stddef.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <time.h>
49
50 #include <sys/types.h>
51 #include <sys/time.h>
52 #include <unistd.h>
53 #include <fcntl.h>
54 #include <sys/stat.h>
55 #include <sys/wait.h>
56
57 #include <sys/socket.h>
58 #include <sys/un.h>
59 #include <netinet/in.h>
60 #include <arpa/inet.h>
61 #include <netdb.h>
62
63 #include <pwd.h>
64 #include <grp.h>
65
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>
72 #include <mLib/env.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>
82 #include <mLib/sel.h>
83 #include <mLib/selbuf.h>
84 #include <mLib/sig.h>
85 #include <mLib/str.h>
86 #include <mLib/sub.h>
87 #include <mLib/trace.h>
88 #include <mLib/tv.h>
89 #include <mLib/versioncmp.h>
90
91 #include <catacomb/buf.h>
92
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>
98
99 #include <catacomb/noise.h>
100 #include <catacomb/rand.h>
101
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>
108
109 #include "priv.h"
110 #include "protocol.h"
111 #include "slip.h"
112 #include "util.h"
113
114 #undef sun
115
116 /*----- Magic numbers -----------------------------------------------------*/
117
118 /* --- Trace flags --- */
119
120 #define T_TUNNEL 1u
121 #define T_PEER 2u
122 #define T_PACKET 4u
123 #define T_ADMIN 8u
124 #define T_CRYPTO 16u
125 #define T_KEYSET 32u
126 #define T_KEYEXCH 64u
127 #define T_KEYMGMT 128u
128 #define T_CHAL 256u
129 /* T_PRIVSEP  in priv.h */
130
131 #define T_ALL 1023u
132
133 /* --- Units --- */
134
135 #define SEC(n) (n##u)
136 #define MIN(n) (n##u * 60u)
137 #define MEG(n) (n##ul * 1024ul * 1024ul)
138
139 /* --- Other things --- */
140
141 #define PKBUFSZ 65536
142
143 /*----- Cipher selections -------------------------------------------------*/
144
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@ */
154 } algswitch;
155
156 extern algswitch algs;
157
158 #define MAXHASHSZ 64                    /* Largest possible hash size */
159
160 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
161
162 /*----- Data structures ---------------------------------------------------*/
163
164 /* --- Socket addresses --- *
165  *
166  * A magic union of supported socket addresses.
167  */
168
169 typedef union addr {
170   struct sockaddr sa;
171   struct sockaddr_in sin;
172 } addr;
173
174 /* --- Mapping keyed on addresses --- */
175
176 typedef struct addrmap {
177   hash_table t;
178   size_t load;
179 } addrmap;
180
181 typedef struct addrmap_base {
182   hash_base b;
183   addr a;
184 } addrmap_base;
185
186 /* --- Sequence number checking --- */
187
188 typedef struct seqwin {
189   uint32 seq;                           /* First acceptable input sequence */
190   uint32 win;                           /* Window of acceptable numbers */
191 } seqwin;
192
193 #define SEQ_WINSZ 32                    /* Bits in sequence number window */
194
195 /* --- A symmetric keyset --- *
196  *
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)
200  * is first.
201  *
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
205  * expiry.
206  */
207
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 */
221 } keyset;
222
223 #define KSF_LISTEN 1u                   /* Don't encrypt packets yet */
224 #define KSF_LINK 2u                     /* Key is in a linked list */
225
226 #define KSERR_REGEN -1                  /* Regenerate keys */
227 #define KSERR_NOKEYS -2                 /* No keys left */
228 #define KSERR_DECRYPT -3                /* Unable to decrypt message */
229 #define KSERR_SEQ -4                    /* Incorrect sequence number */
230 #define KSERR_MALFORMED -5              /* Input ciphertext is broken */
231
232 /* --- Key exchange --- *
233  *
234  * TrIPE uses the Wrestlers Protocol for its key exchange.  The Wrestlers
235  * Protocol has a number of desirable features (e.g., perfect forward
236  * secrecy, and zero-knowledge authentication) which make it attractive for
237  * use in TrIPE.  The Wrestlers Protocol was designed by Mark Wooding and
238  * Clive Jones.
239  */
240
241 #define KX_NCHAL 16u
242
243 typedef struct kxchal {
244   struct keyexch *kx;                   /* Pointer back to key exchange */
245   ge *c;                                /* Responder's challenge */
246   ge *r;                                /* My reply to the challenge */
247   keyset *ks;                           /* Pointer to temporary keyset */
248   unsigned f;                           /* Various useful flags */
249   sel_timer t;                          /* Response timer for challenge */
250   octet hc[MAXHASHSZ];                  /* Hash of his challenge */
251   octet ck[MAXHASHSZ];                  /* His magical check value */
252   octet hswrq_in[MAXHASHSZ];            /* Inbound switch request message */
253   octet hswok_in[MAXHASHSZ];            /* Inbound switch confirmation */
254   octet hswrq_out[MAXHASHSZ];           /* Outbound switch request message */
255   octet hswok_out[MAXHASHSZ];           /* Outbound switch confirmation */
256 } kxchal;
257
258 typedef struct keyexch {
259   struct peer *p;                       /* Pointer back to the peer */
260   keyset **ks;                          /* Peer's list of keysets */
261   unsigned f;                           /* Various useful flags */
262   unsigned s;                           /* Current state in exchange */
263   sel_timer t;                          /* Timer for next exchange */
264   ge *kpub;                             /* Peer's public key */
265   time_t texp_kpub;                     /* Expiry time for public key */
266   mp *alpha;                            /* My temporary secret */
267   ge *c;                                /* My challenge */
268   ge *rx;                               /* The expected response */
269   unsigned nr;                          /* Number of extant responses */
270   time_t t_valid;                       /* When this exchange goes bad */
271   octet hc[MAXHASHSZ];                  /* Hash of my challenge */
272   kxchal *r[KX_NCHAL];                  /* Array of challenges */
273 } keyexch;
274
275 #define KXF_TIMER 1u                    /* Waiting for a timer to go off */
276 #define KXF_DEAD 2u                     /* The key-exchanger isn't up */
277 #define KXF_PUBKEY 4u                   /* Key exchanger has a public key */
278 #define KXF_CORK 8u                     /* Don't send anything yet */
279
280 enum {
281   KXS_DEAD,                             /* Uninitialized state (magical) */
282   KXS_CHAL,                             /* Main answer-challenges state */
283   KXS_COMMIT,                           /* Committed: send switch request */
284   KXS_SWITCH                            /* Switched: send confirmation */
285 };
286
287 /* --- Tunnel structure --- *
288  *
289  * Used to maintain system-specific information about the tunnel interface.
290  */
291
292 typedef struct tunnel tunnel;
293 struct peer;
294
295 typedef struct tunnel_ops {
296   const char *name;                     /* Name of this tunnel driver */
297   unsigned flags;                       /* Various interesting flags */
298 #define TUNF_PRIVOPEN 1u                /*   Need helper to open file */
299   void (*init)(void);                   /* Initializes the system */
300   tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/);
301                                         /* Initializes a new tunnel */
302   void (*setifname)(tunnel */*t*/, const char */*ifn*/);
303                                         /*  Notifies ifname change */
304   void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
305   void (*destroy)(tunnel */*t*/);       /* Destroys a tunnel */
306 } tunnel_ops;
307
308 #ifndef TUN_INTERNALS
309 struct tunnel { const tunnel_ops *ops; };
310 #endif
311
312 /* --- Peer statistics --- *
313  *
314  * Contains various interesting and not-so-interesting statistics about a
315  * peer.  This is updated by various parts of the code.  The format of the
316  * structure isn't considered private, and @p_stats@ returns a pointer to the
317  * statistics block for a given peer.
318  */
319
320 typedef struct stats {
321   unsigned long sz_in, sz_out;          /* Size of all data in and out */
322   unsigned long sz_kxin, sz_kxout;      /* Size of key exchange messages */
323   unsigned long sz_ipin, sz_ipout;      /* Size of encapsulated IP packets */
324   time_t t_start, t_last, t_kx;         /* Time peer created, last pk, kx */
325   unsigned long n_reject;               /* Number of rejected packets */
326   unsigned long n_in, n_out;            /* Number of packets in and out */
327   unsigned long n_kxin, n_kxout;        /* Number of key exchange packets */
328   unsigned long n_ipin, n_ipout;        /* Number of encrypted packets */
329 } stats;
330
331 /* --- Peer structure --- *
332  *
333  * The main structure which glues everything else together.
334  */
335
336 typedef struct peerspec {
337   char *name;                           /* Peer's name */
338   char *tag;                            /* Public key tag */
339   const tunnel_ops *tops;               /* Tunnel operations */
340   unsigned long t_ka;                   /* Keep alive interval */
341   addr sa;                              /* Socket address to speak to */
342   size_t sasz;                          /* Socket address size */
343   unsigned f;                           /* Flags for the peer */
344 #define PSF_KXMASK 255u                 /*   Key-exchange flags to set */
345 #define PSF_MOBILE 256u                 /*   Address may change rapidly */
346 } peerspec;
347
348 typedef struct peer_byname {
349   sym_base _b;
350   struct peer *p;
351 } peer_byname;
352
353 typedef struct peer_byaddr {
354   addrmap_base _b;
355   struct peer *p;
356 } peer_byaddr;
357
358 typedef struct peer {
359   peer_byname *byname;                  /* Lookup-by-name block */
360   peer_byaddr *byaddr;                  /* Lookup-by-address block */
361   struct ping *pings;                   /* Pings we're waiting for */
362   peerspec spec;                        /* Specifications for this peer */
363   tunnel *t;                            /* Tunnel for local packets */
364   char *ifname;                         /* Interface name for tunnel */
365   keyset *ks;                           /* List head for keysets */
366   buf b;                                /* Buffer for sending packets */
367   stats st;                             /* Statistics */
368   keyexch kx;                           /* Key exchange protocol block */
369   sel_timer tka;                        /* Timer for keepalives */
370 } peer;
371
372 typedef struct peer_iter { sym_iter i; } peer_iter;
373
374 typedef struct ping {
375   struct ping *next, *prev;             /* Links to next and previous */
376   peer *p;                              /* Peer so we can free it */
377   unsigned msg;                         /* Kind of response expected */
378   uint32 id;                            /* Id so we can recognize response */
379   octet magic[32];                      /* Some random data */
380   sel_timer t;                          /* Timeout for ping */
381   void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
382   void *arg;                            /* Argument for callback */
383 } ping;
384
385 enum {
386   PING_NONOTIFY = -1,
387   PING_OK = 0,
388   PING_TIMEOUT,
389   PING_PEERDIED,
390   PING_MAX
391 };
392
393 /* --- Admin structure --- */
394
395 #define OBUFSZ 16384u
396
397 typedef struct obuf {
398   struct obuf *next;                    /* Next buffer in list */
399   char *p_in, *p_out;                   /* Pointers into the buffer */
400   char buf[OBUFSZ];                     /* The actual buffer */
401 } obuf;
402
403 typedef struct oqueue {
404   obuf *hd, *tl;                        /* Head and tail pointers */
405 } oqueue;
406
407 struct admin;
408
409 typedef struct admin_bgop {
410   struct admin_bgop *next, *prev;       /* Links to next and previous */
411   struct admin *a;                      /* Owner job */
412   char *tag;                            /* Tag string for messages */
413   void (*cancel)(struct admin_bgop *);  /* Destructor function */
414 } admin_bgop;
415
416 typedef struct admin_resop {
417   admin_bgop bg;                        /* Background operation header */
418   char *addr;                           /* Hostname to be resolved */
419   bres_client r;                        /* Background resolver task */
420   sel_timer t;                          /* Timer for resolver */
421   addr sa;                              /* Socket address */
422   size_t sasz;                          /* Socket address size */
423   void (*func)(struct admin_resop *, int); /* Handler */
424 } admin_resop;
425
426 enum { ARES_OK, ARES_FAIL };
427
428 typedef struct admin_addop {
429   admin_resop r;                        /* Name resolution header */
430   peerspec peer;                        /* Peer pending creation */
431 } admin_addop;
432
433 typedef struct admin_pingop {
434   admin_bgop bg;                        /* Background operation header */
435   ping ping;                            /* Ping pending response */
436   struct timeval pingtime;              /* Time last ping was sent */
437 } admin_pingop;
438
439 typedef struct admin_service {
440   sym_base _b;                          /* Hash table base structure */
441   char *version;                        /* The provided version */
442   struct admin *prov;                   /* Which client provides me */
443   struct admin_service *next, *prev;    /* Client's list of services */
444 } admin_service;
445
446 typedef struct admin_svcop {
447   admin_bgop bg;                        /* Background operation header */
448   struct admin *prov;                   /* Client servicing this job */
449   unsigned index;                       /* This job's index */
450   struct admin_svcop *next, *prev;      /* Links for provider's jobs */
451 } admin_svcop;
452
453 typedef struct admin_jobentry {
454   unsigned short seq;                   /* Zero if unused */
455   union {
456     admin_svcop *op;                    /* Operation, if slot in use, ... */
457     uint32 next;                        /* ... or index of next free slot */
458   } u;
459 } admin_jobentry;
460
461 typedef struct admin_jobtable {
462   uint32 n, sz;                         /* Used slots and table size */
463   admin_svcop *active;                  /* List of active jobs */
464   uint32 free;                          /* Index of first free slot */
465   admin_jobentry *v;                    /* And the big array of entries */
466 } admin_jobtable;
467
468 typedef struct admin {
469   struct admin *next, *prev;            /* Links to next and previous */
470   unsigned f;                           /* Various useful flags */
471   unsigned ref;                         /* Reference counter */
472 #ifndef NTRACE
473   unsigned seq;                         /* Sequence number for tracing */
474 #endif
475   oqueue out;                           /* Output buffer list */
476   oqueue delay;                         /* Delayed output buffer list */
477   admin_bgop *bg;                       /* Backgrounded operations */
478   admin_service *svcs;                  /* Which services I provide */
479   admin_jobtable j;                     /* Table of outstanding jobs */
480   selbuf b;                             /* Line buffer for commands */
481   sel_file w;                           /* Selector for write buffering */
482 } admin;
483
484 #define AF_DEAD 1u                      /* Destroy this admin block */
485 #define AF_CLOSE 2u                     /* Client closed connection */
486 #define AF_NOTE 4u                      /* Catch notifications */
487 #define AF_WARN 8u                      /* Catch warning messages */
488 #ifndef NTRACE
489   #define AF_TRACE 16u                  /* Catch tracing */
490 #endif
491 #define AF_FOREGROUND 32u               /* Quit server when client closes */
492
493 #ifndef NTRACE
494 #  define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
495 #else
496 #  define AF_ALLMSGS (AF_NOTE | AF_WARN)
497 #endif
498
499 /*----- Global variables --------------------------------------------------*/
500
501 extern sel_state sel;                   /* Global I/O event state */
502 extern group *gg;                       /* The group we work in */
503 extern size_t indexsz;                  /* Size of exponent for the group */
504 extern mp *kpriv;                       /* Our private key */
505 extern ge *kpub;                        /* Our public key */
506 extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
507 extern const tunnel_ops *tunnels[];     /* Table of tunnels (0-term) */
508 extern const tunnel_ops *tun_default;   /* Default tunnel to use */
509
510 #ifndef NTRACE
511 extern const trace_opt tr_opts[];       /* Trace options array */
512 extern unsigned tr_flags;               /* Trace options flags */
513 #endif
514
515 /*----- Other macros ------------------------------------------------------*/
516
517 #define TIMER noise_timer(RAND_GLOBAL)
518
519 /*----- Key management ----------------------------------------------------*/
520
521 /* --- @km_reload@ --- *
522  *
523  * Arguments:   ---
524  *
525  * Returns:     Zero if OK, nonzero to force reloading of keys.
526  *
527  * Use:         Checks the keyrings to see if they need reloading.
528  */
529
530 extern int km_reload(void);
531
532 /* --- @km_init@ --- *
533  *
534  * Arguments:   @const char *kr_priv@ = private keyring file
535  *              @const char *kr_pub@ = public keyring file
536  *              @const char *tag@ = tag to load
537  *
538  * Returns:     ---
539  *
540  * Use:         Initializes, and loads the private key.
541  */
542
543 extern void km_init(const char */*kr_priv*/, const char */*kr_pub*/,
544                     const char */*tag*/);
545
546 /* --- @km_getpubkey@ --- *
547  *
548  * Arguments:   @const char *tag@ = public key tag to load
549  *              @ge *kpub@ = where to put the public key
550  *              @time_t *t_exp@ = where to put the expiry time
551  *
552  * Returns:     Zero if OK, nonzero if it failed.
553  *
554  * Use:         Fetches a public key from the keyring.
555  */
556
557 extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
558                         time_t */*t_exp*/);
559
560 /*----- Key exchange ------------------------------------------------------*/
561
562 /* --- @kx_start@ --- *
563  *
564  * Arguments:   @keyexch *kx@ = pointer to key exchange context
565  *              @int forcep@ = nonzero to ignore the quiet timer
566  *
567  * Returns:     ---
568  *
569  * Use:         Stimulates a key exchange.  If a key exchage is in progress,
570  *              a new challenge is sent (unless the quiet timer forbids
571  *              this); if no exchange is in progress, one is commenced.
572  */
573
574 extern void kx_start(keyexch */*kx*/, int /*forcep*/);
575
576 /* --- @kx_message@ --- *
577  *
578  * Arguments:   @keyexch *kx@ = pointer to key exchange context
579  *              @unsigned msg@ = the message code
580  *              @buf *b@ = pointer to buffer containing the packet
581  *
582  * Returns:     ---
583  *
584  * Use:         Reads a packet containing key exchange messages and handles
585  *              it.
586  */
587
588 extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/);
589
590 /* --- @kx_free@ --- *
591  *
592  * Arguments:   @keyexch *kx@ = pointer to key exchange context
593  *
594  * Returns:     ---
595  *
596  * Use:         Frees everything in a key exchange context.
597  */
598
599 extern void kx_free(keyexch */*kx*/);
600
601 /* --- @kx_newkeys@ --- *
602  *
603  * Arguments:   @keyexch *kx@ = pointer to key exchange context
604  *
605  * Returns:     ---
606  *
607  * Use:         Informs the key exchange module that its keys may have
608  *              changed.  If fetching the new keys fails, the peer will be
609  *              destroyed, we log messages and struggle along with the old
610  *              keys.
611  */
612
613 extern void kx_newkeys(keyexch */*kx*/);
614
615 /* --- @kx_init@ --- *
616  *
617  * Arguments:   @keyexch *kx@ = pointer to key exchange context
618  *              @peer *p@ = pointer to peer context
619  *              @keyset **ks@ = pointer to keyset list
620  *              @unsigned f@ = various useful flags
621  *
622  * Returns:     Zero if OK, nonzero if it failed.
623  *
624  * Use:         Initializes a key exchange module.  The module currently
625  *              contains no keys, and will attempt to initiate a key
626  *              exchange.
627  */
628
629 extern int kx_init(keyexch */*kx*/, peer */*p*/,
630                    keyset **/*ks*/, unsigned /*f*/);
631
632 /*----- Keysets and symmetric cryptography --------------------------------*/
633
634 /* --- @ks_drop@ --- *
635  *
636  * Arguments:   @keyset *ks@ = pointer to a keyset
637  *
638  * Returns:     ---
639  *
640  * Use:         Decrements a keyset's reference counter.  If the counter hits
641  *              zero, the keyset is freed.
642  */
643
644 extern void ks_drop(keyset */*ks*/);
645
646 /* --- @ks_gen@ --- *
647  *
648  * Arguments:   @const void *k@ = pointer to key material
649  *              @size_t x, y, z@ = offsets into key material (see below)
650  *              @peer *p@ = pointer to peer information
651  *
652  * Returns:     A pointer to the new keyset.
653  *
654  * Use:         Derives a new keyset from the given key material.  The
655  *              offsets @x@, @y@ and @z@ separate the key material into three
656  *              parts.  Between the @k@ and @k + x@ is `my' contribution to
657  *              the key material; between @k + x@ and @k + y@ is `your'
658  *              contribution; and between @k + y@ and @k + z@ is a shared
659  *              value we made together.  These are used to construct two
660  *              pairs of symmetric keys.  Each pair consists of an encryption
661  *              key and a message authentication key.  One pair is used for
662  *              outgoing messages, the other for incoming messages.
663  *
664  *              The new key is marked so that it won't be selected for output
665  *              by @ksl_encrypt@.  You can still encrypt data with it by
666  *              calling @ks_encrypt@ directly.
667  */
668
669 extern keyset *ks_gen(const void */*k*/,
670                       size_t /*x*/, size_t /*y*/, size_t /*z*/,
671                       peer */*p*/);
672
673 /* --- @ks_tregen@ --- *
674  *
675  * Arguments:   @keyset *ks@ = pointer to a keyset
676  *
677  * Returns:     The time at which moves ought to be made to replace this key.
678  */
679
680 extern time_t ks_tregen(keyset */*ks*/);
681
682 /* --- @ks_activate@ --- *
683  *
684  * Arguments:   @keyset *ks@ = pointer to a keyset
685  *
686  * Returns:     ---
687  *
688  * Use:         Activates a keyset, so that it can be used for encrypting
689  *              outgoing messages.
690  */
691
692 extern void ks_activate(keyset */*ks*/);
693
694 /* --- @ks_encrypt@ --- *
695  *
696  * Arguments:   @keyset *ks@ = pointer to a keyset
697  *              @unsigned ty@ = message type
698  *              @buf *b@ = pointer to input buffer
699  *              @buf *bb@ = pointer to output buffer
700  *
701  * Returns:     Zero if successful; @KSERR_REGEN@ if we should negotiate a
702  *              new key; @KSERR_NOKEYS@ if the key is not usable.  Also
703  *              returns zero if there was insufficient buffer (but the output
704  *              buffer is broken in this case).
705  *
706  * Use:         Encrypts a block of data using the key.  Note that the `key
707  *              ought to be replaced' notification is only ever given once
708  *              for each key.  Also note that this call forces a keyset to be
709  *              used even if it's marked as not for data output.
710  */
711
712 extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
713                       buf */*b*/, buf */*bb*/);
714
715 /* --- @ks_decrypt@ --- *
716  *
717  * Arguments:   @keyset *ks@ = pointer to a keyset
718  *              @unsigned ty@ = expected type code
719  *              @buf *b@ = pointer to an input buffer
720  *              @buf *bb@ = pointer to an output buffer
721  *
722  * Returns:     Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
723  *              zero if there was insufficient buffer (but the output buffer
724  *              is broken in this case).
725  *
726  * Use:         Attempts to decrypt a message using a given key.  Note that
727  *              requesting decryption with a key directly won't clear a
728  *              marking that it's not for encryption.
729  */
730
731 extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
732                       buf */*b*/, buf */*bb*/);
733
734 /* --- @ksl_free@ --- *
735  *
736  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
737  *
738  * Returns:     ---
739  *
740  * Use:         Frees (releases references to) all of the keys in a keyset.
741  */
742
743 extern void ksl_free(keyset **/*ksroot*/);
744
745 /* --- @ksl_link@ --- *
746  *
747  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
748  *              @keyset *ks@ = pointer to a keyset
749  *
750  * Returns:     ---
751  *
752  * Use:         Links a keyset into a list.  A keyset can only be on one list
753  *              at a time.  Bad things happen otherwise.
754  */
755
756 extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
757
758 /* --- @ksl_prune@ --- *
759  *
760  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
761  *
762  * Returns:     ---
763  *
764  * Use:         Prunes the keyset list by removing keys which mustn't be used
765  *              any more.
766  */
767
768 extern void ksl_prune(keyset **/*ksroot*/);
769
770 /* --- @ksl_encrypt@ --- *
771  *
772  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
773  *              @unsigned ty@ = message type
774  *              @buf *b@ = pointer to input buffer
775  *              @buf *bb@ = pointer to output buffer
776  *
777  * Returns:     Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
778  *              new key; @KSERR_NOKEYS@ if there are no suitable keys
779  *              available.  Also returns zero if there was insufficient
780  *              buffer space (but the output buffer is broken in this case).
781  *
782  * Use:         Encrypts a packet.
783  */
784
785 extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
786                        buf */*b*/, buf */*bb*/);
787
788 /* --- @ksl_decrypt@ --- *
789  *
790  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
791  *              @unsigned ty@ = expected type code
792  *              @buf *b@ = pointer to input buffer
793  *              @buf *bb@ = pointer to output buffer
794  *
795  * Returns:     Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
796  *              zero if there was insufficient buffer (but the output buffer
797  *              is broken in this case).
798  *
799  * Use:         Decrypts a packet.
800  */
801
802 extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
803                        buf */*b*/, buf */*bb*/);
804
805 /*----- Challenges --------------------------------------------------------*/
806
807 /* --- @c_new@ --- *
808  *
809  * Arguments:   @buf *b@ = where to put the challenge
810  *
811  * Returns:     Zero if OK, nonzero on error.
812  *
813  * Use:         Issues a new challenge.
814  */
815
816 extern int c_new(buf */*b*/);
817
818 /* --- @c_check@ --- *
819  *
820  * Arguments:   @buf *b@ = where to find the challenge
821  *
822  * Returns:     Zero if OK, nonzero if it didn't work.
823  *
824  * Use:         Checks a challenge.  On failure, the buffer is broken.
825  */
826
827 extern int c_check(buf */*b*/);
828
829 /*----- Administration interface ------------------------------------------*/
830
831 #define A_END ((char *)0)
832
833 /* --- @a_vformat@ --- *
834  *
835  * Arguments:   @dstr *d@ = where to leave the formatted message
836  *              @const char *fmt@ = pointer to format string
837  *              @va_list ap@ = arguments in list
838  *
839  * Returns:     ---
840  *
841  * Use:         Main message token formatting driver.  The arguments are
842  *              interleaved formatting tokens and their parameters, finally
843  *              terminated by an entry @A_END@.
844  *
845  *              Tokens recognized:
846  *
847  *                * "*..." ... -- pretokenized @dstr_putf@-like string
848  *
849  *                * "?ADDR" SOCKADDR -- a socket address, to be converted
850  *
851  *                * "?B64" BUFFER SIZE -- binary data to be base64-encoded
852  *
853  *                * "?TOKENS" VECTOR -- null-terminated vector of tokens
854  *
855  *                * "?PEER" PEER -- peer's name
856  *
857  *                * "?ERRNO" ERRNO -- system error code
858  *
859  *                * "[!]..." ... -- @dstr_putf@-like string as single token
860  */
861
862 extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list /*ap*/);
863
864 /* --- @a_format@ --- *
865  *
866  * Arguments:   @dstr *d@ = where to leave the formatted message
867  *              @const char *fmt@ = pointer to format string
868  *
869  * Returns:     ---
870  *
871  * Use:         Writes a tokenized message into a string, for later
872  *              presentation.
873  */
874
875 extern void a_format(dstr */*d*/, const char */*fmt*/, ...);
876
877 /* --- @a_warn@ --- *
878  *
879  * Arguments:   @const char *fmt@ = pointer to format string
880  *              @...@ = other arguments
881  *
882  * Returns:     ---
883  *
884  * Use:         Informs all admin connections of a warning.
885  */
886
887 extern void a_warn(const char */*fmt*/, ...);
888
889 /* --- @a_notify@ --- *
890  *
891  * Arguments:   @const char *fmt@ = pointer to format string
892  *              @...@ = other arguments
893  *
894  * Returns:     ---
895  *
896  * Use:         Sends a notification to interested admin connections.
897  */
898
899 extern void a_notify(const char */*fmt*/, ...);
900
901 /* --- @a_create@ --- *
902  *
903  * Arguments:   @int fd_in, fd_out@ = file descriptors to use
904  *              @unsigned f@ = initial flags to set
905  *
906  * Returns:     ---
907  *
908  * Use:         Creates a new admin connection.
909  */
910
911 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
912
913 /* --- @a_quit@ --- *
914  *
915  * Arguments:   ---
916  *
917  * Returns:     ---
918  *
919  * Use:         Shuts things down nicely.
920  */
921
922 extern void a_quit(void);
923
924 /* --- @a_preselect@ --- *
925  *
926  * Arguments:   ---
927  *
928  * Returns:     ---
929  *
930  * Use:         Informs the admin module that we're about to select again,
931  *              and that it should do cleanup things it has delayed until a
932  *              `safe' time.
933  */
934
935 extern void a_preselect(void);
936
937 /* --- @a_daemon@ --- *
938  *
939  * Arguments:   ---
940  *
941  * Returns:     ---
942  *
943  * Use:         Informs the admin module that it's a daemon.
944  */
945
946 extern void a_daemon(void);
947
948 /* --- @a_init@ --- *
949  *
950  * Arguments:   @const char *sock@ = socket name to create
951  *              @uid_t u@ = user to own the socket
952  *              @gid_t g@ = group to own the socket
953  *              @mode_t m@ = permissions to set on the socket
954  *
955  * Returns:     ---
956  *
957  * Use:         Creates the admin listening socket.
958  */
959
960 extern void a_init(const char */*sock*/,
961                    uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
962
963 /*----- Mapping with addresses as keys ------------------------------------*/
964
965 /* --- @am_create@ --- *
966  *
967  * Arguments:   @addrmap *m@ = pointer to map
968  *
969  * Returns:     ---
970  *
971  * Use:         Create an address map, properly set up.
972  */
973
974 extern void am_create(addrmap */*m*/);
975
976 /* --- @am_destroy@ --- *
977  *
978  * Arguments:   @addrmap *m@ = pointer to map
979  *
980  * Returns:     ---
981  *
982  * Use:         Destroy an address map, throwing away all the entries.
983  */
984
985 extern void am_destroy(addrmap */*m*/);
986
987 /* --- @am_find@ --- *
988  *
989  * Arguments:   @addrmap *m@ = pointer to map
990  *              @const addr *a@ = address to look up
991  *              @size_t sz@ = size of block to allocate
992  *              @unsigned *f@ = where to store flags
993  *
994  * Returns:     Pointer to found item, or null.
995  *
996  * Use:         Finds a record with the given IP address, set @*f@ nonzero
997  *              and returns it.  If @sz@ is zero, and no match was found,
998  *              return null; otherwise allocate a new block of @sz@ bytes,
999  *              clear @*f@ to zero and return the block pointer.
1000  */
1001
1002 extern void *am_find(addrmap */*m*/, const addr */*a*/,
1003                      size_t /*sz*/, unsigned */*f*/);
1004
1005 /* --- @am_remove@ --- *
1006  *
1007  * Arguments:   @addrmap *m@ = pointer to map
1008  *              @void *i@ = pointer to the item
1009  *
1010  * Returns:     ---
1011  *
1012  * Use:         Removes an item from the map.
1013  */
1014
1015 extern void am_remove(addrmap */*m*/, void */*i*/);
1016
1017 /*----- Privilege separation ----------------------------------------------*/
1018
1019 /* --- @ps_trace@ --- *
1020  *
1021  * Arguments:   @unsigned mask@ = trace mask to check
1022  *              @const char *fmt@ = message format
1023  *              @...@ = values for placeholders
1024  *
1025  * Returns:     ---
1026  *
1027  * Use:         Writes a trace message.
1028  */
1029
1030 T( extern void ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); )
1031
1032 /* --- @ps_warn@ --- *
1033  *
1034  * Arguments:   @const char *fmt@ = message format
1035  *              @...@ = values for placeholders
1036  *
1037  * Returns:     ---
1038  *
1039  * Use:         Writes a warning message.
1040  */
1041
1042 extern void ps_warn(const char */*fmt*/, ...);
1043
1044 /* --- @ps_tunfd@ --- *
1045  *
1046  * Arguments:   @const tunnel_ops *tops@ = pointer to tunnel operations
1047  *              @char **ifn@ = where to put the interface name
1048  *
1049  * Returns:     The file descriptor, or @-1@ on error.
1050  *
1051  * Use:         Fetches a file descriptor for a tunnel driver.
1052  */
1053
1054 extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/);
1055
1056 /* --- @ps_split@ --- *
1057  *
1058  * Arguments:   @int detachp@ = whether to detach the child from its terminal
1059  *
1060  * Returns:     ---
1061  *
1062  * Use:         Separates off the privileged tunnel-opening service from the
1063  *              rest of the server.
1064  */
1065
1066 extern void ps_split(int /*detachp*/);
1067
1068 /* --- @ps_quit@ --- *
1069  *
1070  * Arguments:   ---
1071  *
1072  * Returns:     ---
1073  *
1074  * Use:         Detaches from the helper process.
1075  */
1076
1077 extern void ps_quit(void);
1078
1079 /*----- Peer management ---------------------------------------------------*/
1080
1081 /* --- @p_txstart@ --- *
1082  *
1083  * Arguments:   @peer *p@ = pointer to peer block
1084  *              @unsigned msg@ = message type code
1085  *
1086  * Returns:     A pointer to a buffer to write to.
1087  *
1088  * Use:         Starts sending to a peer.  Only one send can happen at a
1089  *              time.
1090  */
1091
1092 extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
1093
1094 /* --- @p_txend@ --- *
1095  *
1096  * Arguments:   @peer *p@ = pointer to peer block
1097  *
1098  * Returns:     ---
1099  *
1100  * Use:         Sends a packet to the peer.
1101  */
1102
1103 extern void p_txend(peer */*p*/);
1104
1105 /* --- @p_pingsend@ --- *
1106  *
1107  * Arguments:   @peer *p@ = destination peer
1108  *              @ping *pg@ = structure to fill in
1109  *              @unsigned type@ = message type
1110  *              @unsigned long timeout@ = how long to wait before giving up
1111  *              @void (*func)(int, void *)@ = callback function
1112  *              @void *arg@ = argument for callback
1113  *
1114  * Returns:     Zero if successful, nonzero if it failed.
1115  *
1116  * Use:         Sends a ping to a peer.  Call @func@ with a nonzero argument
1117  *              if we get an answer within the timeout, or zero if no answer.
1118  */
1119
1120 extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
1121                       unsigned long /*timeout*/,
1122                       void (*/*func*/)(int, void *), void */*arg*/);
1123
1124 /* --- @p_pingdone@ --- *
1125  *
1126  * Arguments:   @ping *p@ = ping structure
1127  *              @int rc@ = return code to pass on
1128  *
1129  * Returns:     ---
1130  *
1131  * Use:         Disposes of a ping structure, maybe sending a notification.
1132  */
1133
1134 extern void p_pingdone(ping */*p*/, int /*rc*/);
1135
1136 /* --- @p_greet@ --- *
1137  *
1138  * Arguments:   @peer *p@ = peer to send to
1139  *              @const void *c@ = pointer to challenge
1140  *              @size_t sz@ = size of challenge
1141  *
1142  * Returns:     ---
1143  *
1144  * Use:         Sends a greeting packet.
1145  */
1146
1147 extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
1148
1149 /* --- @p_tun@ --- *
1150  *
1151  * Arguments:   @peer *p@ = pointer to peer block
1152  *              @buf *b@ = buffer containing incoming packet
1153  *
1154  * Returns:     ---
1155  *
1156  * Use:         Handles a packet which needs to be sent to a peer.
1157  */
1158
1159 extern void p_tun(peer */*p*/, buf */*b*/);
1160
1161 /* --- @p_keyreload@ --- *
1162  *
1163  * Arguments:   ---
1164  *
1165  * Returns:     ---
1166  *
1167  * Use:         Forces a check of the daemon's keyring files.
1168  */
1169
1170 extern void p_keyreload(void);
1171
1172 /* --- @p_interval@ --- *
1173  *
1174  * Arguments:   ---
1175  *
1176  * Returns:     ---
1177  *
1178  * Use:         Called periodically to do tidying.
1179  */
1180
1181 extern void p_interval(void);
1182
1183 /* --- @p_stats@ --- *
1184  *
1185  * Arguments:   @peer *p@ = pointer to a peer block
1186  *
1187  * Returns:     A pointer to the peer's statistics.
1188  */
1189
1190 extern stats *p_stats(peer */*p*/);
1191
1192 /* --- @p_ifname@ --- *
1193  *
1194  * Arguments:   @peer *p@ = pointer to a peer block
1195  *
1196  * Returns:     A pointer to the peer's interface name.
1197  */
1198
1199 extern const char *p_ifname(peer */*p*/);
1200
1201 /* --- @p_setifname@ --- *
1202  *
1203  * Arguments:   @peer *p@ = pointer to a peer block
1204  *              @const char *name@ = pointer to the new name
1205  *
1206  * Returns:     ---
1207  *
1208  * Use:         Changes the name held for a peer's interface.
1209  */
1210
1211 extern void p_setifname(peer */*p*/, const char */*name*/);
1212
1213 /* --- @p_addr@ --- *
1214  *
1215  * Arguments:   @peer *p@ = pointer to a peer block
1216  *
1217  * Returns:     A pointer to the peer's address.
1218  */
1219
1220 extern const addr *p_addr(peer */*p*/);
1221
1222 /* --- @p_init@ --- *
1223  *
1224  * Arguments:   @struct in_addr addr@ = address to bind to
1225  *              @unsigned port@ = port number to listen to
1226  *
1227  * Returns:     ---
1228  *
1229  * Use:         Initializes the peer system; creates the socket.
1230  */
1231
1232 extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
1233
1234 /* --- @p_port@ --- *
1235  *
1236  * Arguments:   ---
1237  *
1238  * Returns:     Port number used for socket.
1239  */
1240
1241 unsigned p_port(void);
1242
1243 /* --- @p_create@ --- *
1244  *
1245  * Arguments:   @peerspec *spec@ = information about this peer
1246  *
1247  * Returns:     Pointer to the peer block, or null if it failed.
1248  *
1249  * Use:         Creates a new named peer block.  No peer is actually attached
1250  *              by this point.
1251  */
1252
1253 extern peer *p_create(peerspec */*spec*/);
1254
1255 /* --- @p_name@ --- *
1256  *
1257  * Arguments:   @peer *p@ = pointer to a peer block
1258  *
1259  * Returns:     A pointer to the peer's name.
1260  *
1261  * Use:         Equivalent to @p_spec(p)->name@.
1262  */
1263
1264 extern const char *p_name(peer */*p*/);
1265
1266 /* --- @p_tag@ --- *
1267  *
1268  * Arguments:   @peer *p@ = pointer to a peer block
1269  *
1270  * Returns:     A pointer to the peer's public key tag.
1271  */
1272
1273 extern const char *p_tag(peer */*p*/);
1274
1275 /* --- @p_spec@ --- *
1276  *
1277  * Arguments:   @peer *p@ = pointer to a peer block
1278  *
1279  * Returns:     Pointer to the peer's specification
1280  */
1281
1282 extern const peerspec *p_spec(peer */*p*/);
1283
1284 /* --- @p_findbyaddr@ --- *
1285  *
1286  * Arguments:   @const addr *a@ = address to look up
1287  *
1288  * Returns:     Pointer to the peer block, or null if not found.
1289  *
1290  * Use:         Finds a peer by address.
1291  */
1292
1293 extern peer *p_findbyaddr(const addr */*a*/);
1294
1295 /* --- @p_find@ --- *
1296  *
1297  * Arguments:   @const char *name@ = name to look up
1298  *
1299  * Returns:     Pointer to the peer block, or null if not found.
1300  *
1301  * Use:         Finds a peer by name.
1302  */
1303
1304 extern peer *p_find(const char */*name*/);
1305
1306 /* --- @p_destroy@ --- *
1307  *
1308  * Arguments:   @peer *p@ = pointer to a peer
1309  *
1310  * Returns:     ---
1311  *
1312  * Use:         Destroys a peer.
1313  */
1314
1315 extern void p_destroy(peer */*p*/);
1316
1317 /* --- @FOREACH_PEER@ --- *
1318  *
1319  * Arguments:   @p@ = name to bind to each peer
1320  *              @stuff@ = thing to do for each item
1321  *
1322  * Use:         Does something for each current peer.
1323  */
1324
1325 #define FOREACH_PEER(p, stuff) do {                                     \
1326   peer_iter i_;                                                         \
1327   peer *p;                                                              \
1328   for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff                   \
1329 } while (0)
1330
1331 /* --- @p_mkiter@ --- *
1332  *
1333  * Arguments:   @peer_iter *i@ = pointer to an iterator
1334  *
1335  * Returns:     ---
1336  *
1337  * Use:         Initializes the iterator.
1338  */
1339
1340 extern void p_mkiter(peer_iter */*i*/);
1341
1342 /* --- @p_next@ --- *
1343  *
1344  * Arguments:   @peer_iter *i@ = pointer to an iterator
1345  *
1346  * Returns:     Next peer, or null if at the end.
1347  *
1348  * Use:         Returns the next peer.
1349  */
1350
1351 extern peer *p_next(peer_iter */*i*/);
1352
1353 /*----- Tunnel drivers ----------------------------------------------------*/
1354
1355 #ifdef TUN_LINUX
1356   extern const tunnel_ops tun_linux;
1357 #endif
1358
1359 #ifdef TUN_UNET
1360   extern const tunnel_ops tun_unet;
1361 #endif
1362
1363 #ifdef TUN_BSD
1364   extern const tunnel_ops tun_bsd;
1365 #endif
1366
1367 extern const tunnel_ops tun_slip;
1368
1369 /*----- Other handy utilities ---------------------------------------------*/
1370
1371 /* --- @mpstr@ --- *
1372  *
1373  * Arguments:   @mp *m@ = a multiprecision integer
1374  *
1375  * Returns:     A pointer to the integer's textual representation.
1376  *
1377  * Use:         Converts a multiprecision integer to a string.  Corrupts
1378  *              @buf_u@.
1379  */
1380
1381 extern const char *mpstr(mp */*m*/);
1382
1383 /* --- @gestr@ --- *
1384  *
1385  * Arguments:   @group *g@ = a group
1386  *              @ge *x@ = a group element
1387  *
1388  * Returns:     A pointer to the element's textual representation.
1389  *
1390  * Use:         Converts a group element to a string.  Corrupts
1391  *              @buf_u@.
1392  */
1393
1394 extern const char *gestr(group */*g*/, ge */*x*/);
1395
1396 /* --- @timestr@ --- *
1397  *
1398  * Arguments:   @time_t t@ = a time to convert
1399  *
1400  * Returns:     A pointer to a textual representation of the time.
1401  *
1402  * Use:         Converts a time to a textual representation.  Corrupts
1403  *              @buf_u@.
1404  */
1405
1406 extern const char *timestr(time_t /*t*/);
1407
1408 /* --- @mystrieq@ --- *
1409  *
1410  * Arguments:   @const char *x, *y@ = two strings
1411  *
1412  * Returns:     True if @x@ and @y are equal, up to case.
1413  */
1414
1415 extern int mystrieq(const char */*x*/, const char */*y*/);
1416
1417 /* --- @seq_reset@ --- *
1418  *
1419  * Arguments:   @seqwin *s@ = sequence-checking window
1420  *
1421  * Returns:     ---
1422  *
1423  * Use:         Resets a sequence number window.
1424  */
1425
1426 extern void seq_reset(seqwin */*s*/);
1427
1428 /* --- @seq_check@ --- *
1429  *
1430  * Arguments:   @seqwin *s@ = sequence-checking window
1431  *              @uint32 q@ = sequence number to check
1432  *              @const char *service@ = service to report message from
1433  *
1434  * Returns:     A @SEQ_@ code.
1435  *
1436  * Use:         Checks a sequence number against the window, updating things
1437  *              as necessary.
1438  */
1439
1440 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
1441
1442 /*----- That's all, folks -------------------------------------------------*/
1443
1444 #ifdef __cplusplus
1445   }
1446 #endif
1447
1448 #endif