chiark - git - mdw - tripe/blob - 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 } peerspec;
 346
 347 typedef struct peer_byname {
 348   sym_base _b;
 349   struct peer *p;
 350 } peer_byname;
 351
 352 typedef struct peer_byaddr {
 353   addrmap_base _b;
 354   struct peer *p;
 355 } peer_byaddr;
 356
 357 typedef struct peer {
 358   peer_byname *byname;                  /* Lookup-by-name block */
 359   peer_byaddr *byaddr;                  /* Lookup-by-address block */
 360   struct ping *pings;                   /* Pings we're waiting for */
 361   peerspec spec;                        /* Specifications for this peer */
 362   tunnel *t;                            /* Tunnel for local packets */
 363   char *ifname;                         /* Interface name for tunnel */
 364   keyset *ks;                           /* List head for keysets */
 365   buf b;                                /* Buffer for sending packets */
 366   stats st;                             /* Statistics */
 367   keyexch kx;                           /* Key exchange protocol block */
 368   sel_timer tka;                        /* Timer for keepalives */
 369 } peer;
 370
 371 typedef struct peer_iter { sym_iter i; } peer_iter;
 372
 373 typedef struct ping {
 374   struct ping *next, *prev;             /* Links to next and previous */
 375   peer *p;                              /* Peer so we can free it */
 376   unsigned msg;                         /* Kind of response expected */
 377   uint32 id;                            /* Id so we can recognize response */
 378   octet magic[32];                      /* Some random data */
 379   sel_timer t;                          /* Timeout for ping */
 380   void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
 381   void *arg;                            /* Argument for callback */
 382 } ping;
 383
 384 enum {
 385   PING_NONOTIFY = -1,
 386   PING_OK = 0,
 387   PING_TIMEOUT,
 388   PING_PEERDIED,
 389   PING_MAX
 390 };
 391
 392 /* --- Admin structure --- */
 393
 394 #define OBUFSZ 16384u
 395
 396 typedef struct obuf {
 397   struct obuf *next;                    /* Next buffer in list */
 398   char *p_in, *p_out;                   /* Pointers into the buffer */
 399   char buf[OBUFSZ];                     /* The actual buffer */
 400 } obuf;
 401
 402 typedef struct oqueue {
 403   obuf *hd, *tl;                        /* Head and tail pointers */
 404 } oqueue;
 405
 406 struct admin;
 407
 408 typedef struct admin_bgop {
 409   struct admin_bgop *next, *prev;       /* Links to next and previous */
 410   struct admin *a;                      /* Owner job */
 411   char *tag;                            /* Tag string for messages */
 412   void (*cancel)(struct admin_bgop *);  /* Destructor function */
 413 } admin_bgop;
 414
 415 typedef struct admin_resop {
 416   admin_bgop bg;                        /* Background operation header */
 417   char *addr;                           /* Hostname to be resolved */
 418   bres_client r;                        /* Background resolver task */
 419   sel_timer t;                          /* Timer for resolver */
 420   addr sa;                              /* Socket address */
 421   size_t sasz;                          /* Socket address size */
 422   void (*func)(struct admin_resop *, int); /* Handler */
 423 } admin_resop;
 424
 425 enum { ARES_OK, ARES_FAIL };
 426
 427 typedef struct admin_addop {
 428   admin_resop r;                        /* Name resolution header */
 429   peerspec peer;                        /* Peer pending creation */
 430 } admin_addop;
 431
 432 typedef struct admin_pingop {
 433   admin_bgop bg;                        /* Background operation header */
 434   ping ping;                            /* Ping pending response */
 435   struct timeval pingtime;              /* Time last ping was sent */
 436 } admin_pingop;
 437
 438 typedef struct admin_service {
 439   sym_base _b;                          /* Hash table base structure */
 440   char *version;                        /* The provided version */
 441   struct admin *prov;                   /* Which client provides me */
 442   struct admin_service *next, *prev;    /* Client's list of services */
 443 } admin_service;
 444
 445 typedef struct admin_svcop {
 446   admin_bgop bg;                        /* Background operation header */
 447   struct admin *prov;                   /* Client servicing this job */
 448   unsigned index;                       /* This job's index */
 449   struct admin_svcop *next, *prev;      /* Links for provider's jobs */
 450 } admin_svcop;
 451
 452 typedef struct admin_jobentry {
 453   unsigned short seq;                   /* Zero if unused */
 454   union {
 455     admin_svcop *op;                    /* Operation, if slot in use, ... */
 456     uint32 next;                        /* ... or index of next free slot */
 457   } u;
 458 } admin_jobentry;
 459
 460 typedef struct admin_jobtable {
 461   uint32 n, sz;                         /* Used slots and table size */
 462   admin_svcop *active;                  /* List of active jobs */
 463   uint32 free;                          /* Index of first free slot */
 464   admin_jobentry *v;                    /* And the big array of entries */
 465 } admin_jobtable;
 466
 467 typedef struct admin {
 468   struct admin *next, *prev;            /* Links to next and previous */
 469   unsigned f;                           /* Various useful flags */
 470   unsigned ref;                         /* Reference counter */
 471 #ifndef NTRACE
 472   unsigned seq;                         /* Sequence number for tracing */
 473 #endif
 474   oqueue out;                           /* Output buffer list */
 475   oqueue delay;                         /* Delayed output buffer list */
 476   admin_bgop *bg;                       /* Backgrounded operations */
 477   admin_service *svcs;                  /* Which services I provide */
 478   admin_jobtable j;                     /* Table of outstanding jobs */
 479   selbuf b;                             /* Line buffer for commands */
 480   sel_file w;                           /* Selector for write buffering */
 481 } admin;
 482
 483 #define AF_DEAD 1u                      /* Destroy this admin block */
 484 #define AF_CLOSE 2u                     /* Client closed connection */
 485 #define AF_NOTE 4u                      /* Catch notifications */
 486 #define AF_WARN 8u                      /* Catch warning messages */
 487 #ifndef NTRACE
 488   #define AF_TRACE 16u                  /* Catch tracing */
 489 #endif
 490 #define AF_FOREGROUND 32u               /* Quit server when client closes */
 491
 492 #ifndef NTRACE
 493 #  define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
 494 #else
 495 #  define AF_ALLMSGS (AF_NOTE | AF_WARN)
 496 #endif
 497
 498 /*----- Global variables --------------------------------------------------*/
 499
 500 extern sel_state sel;                   /* Global I/O event state */
 501 extern group *gg;                       /* The group we work in */
 502 extern size_t indexsz;                  /* Size of exponent for the group */
 503 extern mp *kpriv;                       /* Our private key */
 504 extern ge *kpub;                        /* Our public key */
 505 extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
 506 extern const tunnel_ops *tunnels[];     /* Table of tunnels (0-term) */
 507 extern const tunnel_ops *tun_default;   /* Default tunnel to use */
 508
 509 #ifndef NTRACE
 510 extern const trace_opt tr_opts[];       /* Trace options array */
 511 extern unsigned tr_flags;               /* Trace options flags */
 512 #endif
 513
 514 /*----- Other macros ------------------------------------------------------*/
 515
 516 #define TIMER noise_timer(RAND_GLOBAL)
 517
 518 /*----- Key management ----------------------------------------------------*/
 519
 520 /* --- @km_reload@ --- *
 521  *
 522  * Arguments:   ---
 523  *
 524  * Returns:     Zero if OK, nonzero to force reloading of keys.
 525  *
 526  * Use:         Checks the keyrings to see if they need reloading.
 527  */
 528
 529 extern int km_reload(void);
 530
 531 /* --- @km_init@ --- *
 532  *
 533  * Arguments:   @const char *kr_priv@ = private keyring file
 534  *              @const char *kr_pub@ = public keyring file
 535  *              @const char *tag@ = tag to load
 536  *
 537  * Returns:     ---
 538  *
 539  * Use:         Initializes, and loads the private key.
 540  */
 541
 542 extern void km_init(const char */*kr_priv*/, const char */*kr_pub*/,
 543                     const char */*tag*/);
 544
 545 /* --- @km_getpubkey@ --- *
 546  *
 547  * Arguments:   @const char *tag@ = public key tag to load
 548  *              @ge *kpub@ = where to put the public key
 549  *              @time_t *t_exp@ = where to put the expiry time
 550  *
 551  * Returns:     Zero if OK, nonzero if it failed.
 552  *
 553  * Use:         Fetches a public key from the keyring.
 554  */
 555
 556 extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
 557                         time_t */*t_exp*/);
 558
 559 /*----- Key exchange ------------------------------------------------------*/
 560
 561 /* --- @kx_start@ --- *
 562  *
 563  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 564  *              @int forcep@ = nonzero to ignore the quiet timer
 565  *
 566  * Returns:     ---
 567  *
 568  * Use:         Stimulates a key exchange.  If a key exchage is in progress,
 569  *              a new challenge is sent (unless the quiet timer forbids
 570  *              this); if no exchange is in progress, one is commenced.
 571  */
 572
 573 extern void kx_start(keyexch */*kx*/, int /*forcep*/);
 574
 575 /* --- @kx_message@ --- *
 576  *
 577  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 578  *              @unsigned msg@ = the message code
 579  *              @buf *b@ = pointer to buffer containing the packet
 580  *
 581  * Returns:     ---
 582  *
 583  * Use:         Reads a packet containing key exchange messages and handles
 584  *              it.
 585  */
 586
 587 extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/);
 588
 589 /* --- @kx_free@ --- *
 590  *
 591  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 592  *
 593  * Returns:     ---
 594  *
 595  * Use:         Frees everything in a key exchange context.
 596  */
 597
 598 extern void kx_free(keyexch */*kx*/);
 599
 600 /* --- @kx_newkeys@ --- *
 601  *
 602  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 603  *
 604  * Returns:     ---
 605  *
 606  * Use:         Informs the key exchange module that its keys may have
 607  *              changed.  If fetching the new keys fails, the peer will be
 608  *              destroyed, we log messages and struggle along with the old
 609  *              keys.
 610  */
 611
 612 extern void kx_newkeys(keyexch */*kx*/);
 613
 614 /* --- @kx_init@ --- *
 615  *
 616  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 617  *              @peer *p@ = pointer to peer context
 618  *              @keyset **ks@ = pointer to keyset list
 619  *              @unsigned f@ = various useful flags
 620  *
 621  * Returns:     Zero if OK, nonzero if it failed.
 622  *
 623  * Use:         Initializes a key exchange module.  The module currently
 624  *              contains no keys, and will attempt to initiate a key
 625  *              exchange.
 626  */
 627
 628 extern int kx_init(keyexch */*kx*/, peer */*p*/,
 629                    keyset **/*ks*/, unsigned /*f*/);
 630
 631 /*----- Keysets and symmetric cryptography --------------------------------*/
 632
 633 /* --- @ks_drop@ --- *
 634  *
 635  * Arguments:   @keyset *ks@ = pointer to a keyset
 636  *
 637  * Returns:     ---
 638  *
 639  * Use:         Decrements a keyset's reference counter.  If the counter hits
 640  *              zero, the keyset is freed.
 641  */
 642
 643 extern void ks_drop(keyset */*ks*/);
 644
 645 /* --- @ks_gen@ --- *
 646  *
 647  * Arguments:   @const void *k@ = pointer to key material
 648  *              @size_t x, y, z@ = offsets into key material (see below)
 649  *              @peer *p@ = pointer to peer information
 650  *
 651  * Returns:     A pointer to the new keyset.
 652  *
 653  * Use:         Derives a new keyset from the given key material.  The
 654  *              offsets @x@, @y@ and @z@ separate the key material into three
 655  *              parts.  Between the @k@ and @k + x@ is `my' contribution to
 656  *              the key material; between @k + x@ and @k + y@ is `your'
 657  *              contribution; and between @k + y@ and @k + z@ is a shared
 658  *              value we made together.  These are used to construct two
 659  *              pairs of symmetric keys.  Each pair consists of an encryption
 660  *              key and a message authentication key.  One pair is used for
 661  *              outgoing messages, the other for incoming messages.
 662  *
 663  *              The new key is marked so that it won't be selected for output
 664  *              by @ksl_encrypt@.  You can still encrypt data with it by
 665  *              calling @ks_encrypt@ directly.
 666  */
 667
 668 extern keyset *ks_gen(const void */*k*/,
 669                       size_t /*x*/, size_t /*y*/, size_t /*z*/,
 670                       peer */*p*/);
 671
 672 /* --- @ks_tregen@ --- *
 673  *
 674  * Arguments:   @keyset *ks@ = pointer to a keyset
 675  *
 676  * Returns:     The time at which moves ought to be made to replace this key.
 677  */
 678
 679 extern time_t ks_tregen(keyset */*ks*/);
 680
 681 /* --- @ks_activate@ --- *
 682  *
 683  * Arguments:   @keyset *ks@ = pointer to a keyset
 684  *
 685  * Returns:     ---
 686  *
 687  * Use:         Activates a keyset, so that it can be used for encrypting
 688  *              outgoing messages.
 689  */
 690
 691 extern void ks_activate(keyset */*ks*/);
 692
 693 /* --- @ks_encrypt@ --- *
 694  *
 695  * Arguments:   @keyset *ks@ = pointer to a keyset
 696  *              @unsigned ty@ = message type
 697  *              @buf *b@ = pointer to input buffer
 698  *              @buf *bb@ = pointer to output buffer
 699  *
 700  * Returns:     Zero if successful; @KSERR_REGEN@ if we should negotiate a
 701  *              new key; @KSERR_NOKEYS@ if the key is not usable.  Also
 702  *              returns zero if there was insufficient buffer (but the output
 703  *              buffer is broken in this case).
 704  *
 705  * Use:         Encrypts a block of data using the key.  Note that the `key
 706  *              ought to be replaced' notification is only ever given once
 707  *              for each key.  Also note that this call forces a keyset to be
 708  *              used even if it's marked as not for data output.
 709  */
 710
 711 extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
 712                       buf */*b*/, buf */*bb*/);
 713
 714 /* --- @ks_decrypt@ --- *
 715  *
 716  * Arguments:   @keyset *ks@ = pointer to a keyset
 717  *              @unsigned ty@ = expected type code
 718  *              @buf *b@ = pointer to an input buffer
 719  *              @buf *bb@ = pointer to an output buffer
 720  *
 721  * Returns:     Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
 722  *              zero if there was insufficient buffer (but the output buffer
 723  *              is broken in this case).
 724  *
 725  * Use:         Attempts to decrypt a message using a given key.  Note that
 726  *              requesting decryption with a key directly won't clear a
 727  *              marking that it's not for encryption.
 728  */
 729
 730 extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
 731                       buf */*b*/, buf */*bb*/);
 732
 733 /* --- @ksl_free@ --- *
 734  *
 735  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
 736  *
 737  * Returns:     ---
 738  *
 739  * Use:         Frees (releases references to) all of the keys in a keyset.
 740  */
 741
 742 extern void ksl_free(keyset **/*ksroot*/);
 743
 744 /* --- @ksl_link@ --- *
 745  *
 746  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
 747  *              @keyset *ks@ = pointer to a keyset
 748  *
 749  * Returns:     ---
 750  *
 751  * Use:         Links a keyset into a list.  A keyset can only be on one list
 752  *              at a time.  Bad things happen otherwise.
 753  */
 754
 755 extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
 756
 757 /* --- @ksl_prune@ --- *
 758  *
 759  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
 760  *
 761  * Returns:     ---
 762  *
 763  * Use:         Prunes the keyset list by removing keys which mustn't be used
 764  *              any more.
 765  */
 766
 767 extern void ksl_prune(keyset **/*ksroot*/);
 768
 769 /* --- @ksl_encrypt@ --- *
 770  *
 771  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
 772  *              @unsigned ty@ = message type
 773  *              @buf *b@ = pointer to input buffer
 774  *              @buf *bb@ = pointer to output buffer
 775  *
 776  * Returns:     Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
 777  *              new key; @KSERR_NOKEYS@ if there are no suitable keys
 778  *              available.  Also returns zero if there was insufficient
 779  *              buffer space (but the output buffer is broken in this case).
 780  *
 781  * Use:         Encrypts a packet.
 782  */
 783
 784 extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
 785                        buf */*b*/, buf */*bb*/);
 786
 787 /* --- @ksl_decrypt@ --- *
 788  *
 789  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
 790  *              @unsigned ty@ = expected type code
 791  *              @buf *b@ = pointer to input buffer
 792  *              @buf *bb@ = pointer to output buffer
 793  *
 794  * Returns:     Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
 795  *              zero if there was insufficient buffer (but the output buffer
 796  *              is broken in this case).
 797  *
 798  * Use:         Decrypts a packet.
 799  */
 800
 801 extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
 802                        buf */*b*/, buf */*bb*/);
 803
 804 /*----- Challenges --------------------------------------------------------*/
 805
 806 /* --- @c_new@ --- *
 807  *
 808  * Arguments:   @buf *b@ = where to put the challenge
 809  *
 810  * Returns:     Zero if OK, nonzero on error.
 811  *
 812  * Use:         Issues a new challenge.
 813  */
 814
 815 extern int c_new(buf */*b*/);
 816
 817 /* --- @c_check@ --- *
 818  *
 819  * Arguments:   @buf *b@ = where to find the challenge
 820  *
 821  * Returns:     Zero if OK, nonzero if it didn't work.
 822  *
 823  * Use:         Checks a challenge.  On failure, the buffer is broken.
 824  */
 825
 826 extern int c_check(buf */*b*/);
 827
 828 /*----- Administration interface ------------------------------------------*/
 829
 830 #define A_END ((char *)0)
 831
 832 /* --- @a_vformat@ --- *
 833  *
 834  * Arguments:   @dstr *d@ = where to leave the formatted message
 835  *              @const char *fmt@ = pointer to format string
 836  *              @va_list ap@ = arguments in list
 837  *
 838  * Returns:     ---
 839  *
 840  * Use:         Main message token formatting driver.  The arguments are
 841  *              interleaved formatting tokens and their parameters, finally
 842  *              terminated by an entry @A_END@.
 843  *
 844  *              Tokens recognized:
 845  *
 846  *                * "*..." ... -- pretokenized @dstr_putf@-like string
 847  *
 848  *                * "?ADDR" SOCKADDR -- a socket address, to be converted
 849  *
 850  *                * "?B64" BUFFER SIZE -- binary data to be base64-encoded
 851  *
 852  *                * "?TOKENS" VECTOR -- null-terminated vector of tokens
 853  *
 854  *                * "?PEER" PEER -- peer's name
 855  *
 856  *                * "?ERRNO" ERRNO -- system error code
 857  *
 858  *                * "[!]..." ... -- @dstr_putf@-like string as single token
 859  */
 860
 861 extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list /*ap*/);
 862
 863 /* --- @a_warn@ --- *
 864  *
 865  * Arguments:   @const char *fmt@ = pointer to format string
 866  *              @...@ = other arguments
 867  *
 868  * Returns:     ---
 869  *
 870  * Use:         Informs all admin connections of a warning.
 871  */
 872
 873 extern void a_warn(const char */*fmt*/, ...);
 874
 875 /* --- @a_notify@ --- *
 876  *
 877  * Arguments:   @const char *fmt@ = pointer to format string
 878  *              @...@ = other arguments
 879  *
 880  * Returns:     ---
 881  *
 882  * Use:         Sends a notification to interested admin connections.
 883  */
 884
 885 extern void a_notify(const char */*fmt*/, ...);
 886
 887 /* --- @a_create@ --- *
 888  *
 889  * Arguments:   @int fd_in, fd_out@ = file descriptors to use
 890  *              @unsigned f@ = initial flags to set
 891  *
 892  * Returns:     ---
 893  *
 894  * Use:         Creates a new admin connection.
 895  */
 896
 897 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
 898
 899 /* --- @a_quit@ --- *
 900  *
 901  * Arguments:   ---
 902  *
 903  * Returns:     ---
 904  *
 905  * Use:         Shuts things down nicely.
 906  */
 907
 908 extern void a_quit(void);
 909
 910 /* --- @a_preselect@ --- *
 911  *
 912  * Arguments:   ---
 913  *
 914  * Returns:     ---
 915  *
 916  * Use:         Informs the admin module that we're about to select again,
 917  *              and that it should do cleanup things it has delayed until a
 918  *              `safe' time.
 919  */
 920
 921 extern void a_preselect(void);
 922
 923 /* --- @a_daemon@ --- *
 924  *
 925  * Arguments:   ---
 926  *
 927  * Returns:     ---
 928  *
 929  * Use:         Informs the admin module that it's a daemon.
 930  */
 931
 932 extern void a_daemon(void);
 933
 934 /* --- @a_init@ --- *
 935  *
 936  * Arguments:   @const char *sock@ = socket name to create
 937  *              @uid_t u@ = user to own the socket
 938  *              @gid_t g@ = group to own the socket
 939  *              @mode_t m@ = permissions to set on the socket
 940  *
 941  * Returns:     ---
 942  *
 943  * Use:         Creates the admin listening socket.
 944  */
 945
 946 extern void a_init(const char */*sock*/,
 947                    uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
 948
 949 /*----- Mapping with addresses as keys ------------------------------------*/
 950
 951 /* --- @am_create@ --- *
 952  *
 953  * Arguments:   @addrmap *m@ = pointer to map
 954  *
 955  * Returns:     ---
 956  *
 957  * Use:         Create an address map, properly set up.
 958  */
 959
 960 extern void am_create(addrmap */*m*/);
 961
 962 /* --- @am_destroy@ --- *
 963  *
 964  * Arguments:   @addrmap *m@ = pointer to map
 965  *
 966  * Returns:     ---
 967  *
 968  * Use:         Destroy an address map, throwing away all the entries.
 969  */
 970
 971 extern void am_destroy(addrmap */*m*/);
 972
 973 /* --- @am_find@ --- *
 974  *
 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
 979  *
 980  * Returns:     Pointer to found item, or null.
 981  *
 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.
 986  */
 987
 988 extern void *am_find(addrmap */*m*/, const addr */*a*/,
 989                      size_t /*sz*/, unsigned */*f*/);
 990
 991 /* --- @am_remove@ --- *
 992  *
 993  * Arguments:   @addrmap *m@ = pointer to map
 994  *              @void *i@ = pointer to the item
 995  *
 996  * Returns:     ---
 997  *
 998  * Use:         Removes an item from the map.
 999  */
1000
1001 extern void am_remove(addrmap */*m*/, void */*i*/);
1002
1003 /*----- Privilege separation ----------------------------------------------*/
1004
1005 /* --- @ps_trace@ --- *
1006  *
1007  * Arguments:   @unsigned mask@ = trace mask to check
1008  *              @const char *fmt@ = message format
1009  *              @...@ = values for placeholders
1010  *
1011  * Returns:     ---
1012  *
1013  * Use:         Writes a trace message.
1014  */
1015
1016 T( extern void ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); )
1017
1018 /* --- @ps_warn@ --- *
1019  *
1020  * Arguments:   @const char *fmt@ = message format
1021  *              @...@ = values for placeholders
1022  *
1023  * Returns:     ---
1024  *
1025  * Use:         Writes a warning message.
1026  */
1027
1028 extern void ps_warn(const char */*fmt*/, ...);
1029
1030 /* --- @ps_tunfd@ --- *
1031  *
1032  * Arguments:   @const tunnel_ops *tops@ = pointer to tunnel operations
1033  *              @char **ifn@ = where to put the interface name
1034  *
1035  * Returns:     The file descriptor, or @-1@ on error.
1036  *
1037  * Use:         Fetches a file descriptor for a tunnel driver.
1038  */
1039
1040 extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/);
1041
1042 /* --- @ps_split@ --- *
1043  *
1044  * Arguments:   @int detachp@ = whether to detach the child from its terminal
1045  *
1046  * Returns:     ---
1047  *
1048  * Use:         Separates off the privileged tunnel-opening service from the
1049  *              rest of the server.
1050  */
1051
1052 extern void ps_split(int /*detachp*/);
1053
1054 /* --- @ps_quit@ --- *
1055  *
1056  * Arguments:   ---
1057  *
1058  * Returns:     ---
1059  *
1060  * Use:         Detaches from the helper process.
1061  */
1062
1063 extern void ps_quit(void);
1064
1065 /*----- Peer management ---------------------------------------------------*/
1066
1067 /* --- @p_txstart@ --- *
1068  *
1069  * Arguments:   @peer *p@ = pointer to peer block
1070  *              @unsigned msg@ = message type code
1071  *
1072  * Returns:     A pointer to a buffer to write to.
1073  *
1074  * Use:         Starts sending to a peer.  Only one send can happen at a
1075  *              time.
1076  */
1077
1078 extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
1079
1080 /* --- @p_txend@ --- *
1081  *
1082  * Arguments:   @peer *p@ = pointer to peer block
1083  *
1084  * Returns:     ---
1085  *
1086  * Use:         Sends a packet to the peer.
1087  */
1088
1089 extern void p_txend(peer */*p*/);
1090
1091 /* --- @p_pingsend@ --- *
1092  *
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
1099  *
1100  * Returns:     Zero if successful, nonzero if it failed.
1101  *
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.
1104  */
1105
1106 extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
1107                       unsigned long /*timeout*/,
1108                       void (*/*func*/)(int, void *), void */*arg*/);
1109
1110 /* --- @p_pingdone@ --- *
1111  *
1112  * Arguments:   @ping *p@ = ping structure
1113  *              @int rc@ = return code to pass on
1114  *
1115  * Returns:     ---
1116  *
1117  * Use:         Disposes of a ping structure, maybe sending a notification.
1118  */
1119
1120 extern void p_pingdone(ping */*p*/, int /*rc*/);
1121
1122 /* --- @p_greet@ --- *
1123  *
1124  * Arguments:   @peer *p@ = peer to send to
1125  *              @const void *c@ = pointer to challenge
1126  *              @size_t sz@ = size of challenge
1127  *
1128  * Returns:     ---
1129  *
1130  * Use:         Sends a greeting packet.
1131  */
1132
1133 extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
1134
1135 /* --- @p_tun@ --- *
1136  *
1137  * Arguments:   @peer *p@ = pointer to peer block
1138  *              @buf *b@ = buffer containing incoming packet
1139  *
1140  * Returns:     ---
1141  *
1142  * Use:         Handles a packet which needs to be sent to a peer.
1143  */
1144
1145 extern void p_tun(peer */*p*/, buf */*b*/);
1146
1147 /* --- @p_keyreload@ --- *
1148  *
1149  * Arguments:   ---
1150  *
1151  * Returns:     ---
1152  *
1153  * Use:         Forces a check of the daemon's keyring files.
1154  */
1155
1156 extern void p_keyreload(void);
1157
1158 /* --- @p_interval@ --- *
1159  *
1160  * Arguments:   ---
1161  *
1162  * Returns:     ---
1163  *
1164  * Use:         Called periodically to do tidying.
1165  */
1166
1167 extern void p_interval(void);
1168
1169 /* --- @p_stats@ --- *
1170  *
1171  * Arguments:   @peer *p@ = pointer to a peer block
1172  *
1173  * Returns:     A pointer to the peer's statistics.
1174  */
1175
1176 extern stats *p_stats(peer */*p*/);
1177
1178 /* --- @p_ifname@ --- *
1179  *
1180  * Arguments:   @peer *p@ = pointer to a peer block
1181  *
1182  * Returns:     A pointer to the peer's interface name.
1183  */
1184
1185 extern const char *p_ifname(peer */*p*/);
1186
1187 /* --- @p_setifname@ --- *
1188  *
1189  * Arguments:   @peer *p@ = pointer to a peer block
1190  *              @const char *name@ = pointer to the new name
1191  *
1192  * Returns:     ---
1193  *
1194  * Use:         Changes the name held for a peer's interface.
1195  */
1196
1197 extern void p_setifname(peer */*p*/, const char */*name*/);
1198
1199 /* --- @p_addr@ --- *
1200  *
1201  * Arguments:   @peer *p@ = pointer to a peer block
1202  *
1203  * Returns:     A pointer to the peer's address.
1204  */
1205
1206 extern const addr *p_addr(peer */*p*/);
1207
1208 /* --- @p_init@ --- *
1209  *
1210  * Arguments:   @struct in_addr addr@ = address to bind to
1211  *              @unsigned port@ = port number to listen to
1212  *
1213  * Returns:     ---
1214  *
1215  * Use:         Initializes the peer system; creates the socket.
1216  */
1217
1218 extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
1219
1220 /* --- @p_port@ --- *
1221  *
1222  * Arguments:   ---
1223  *
1224  * Returns:     Port number used for socket.
1225  */
1226
1227 unsigned p_port(void);
1228
1229 /* --- @p_create@ --- *
1230  *
1231  * Arguments:   @peerspec *spec@ = information about this peer
1232  *
1233  * Returns:     Pointer to the peer block, or null if it failed.
1234  *
1235  * Use:         Creates a new named peer block.  No peer is actually attached
1236  *              by this point.
1237  */
1238
1239 extern peer *p_create(peerspec */*spec*/);
1240
1241 /* --- @p_name@ --- *
1242  *
1243  * Arguments:   @peer *p@ = pointer to a peer block
1244  *
1245  * Returns:     A pointer to the peer's name.
1246  *
1247  * Use:         Equivalent to @p_spec(p)->name@.
1248  */
1249
1250 extern const char *p_name(peer */*p*/);
1251
1252 /* --- @p_tag@ --- *
1253  *
1254  * Arguments:   @peer *p@ = pointer to a peer block
1255  *
1256  * Returns:     A pointer to the peer's public key tag.
1257  */
1258
1259 extern const char *p_tag(peer */*p*/);
1260
1261 /* --- @p_spec@ --- *
1262  *
1263  * Arguments:   @peer *p@ = pointer to a peer block
1264  *
1265  * Returns:     Pointer to the peer's specification
1266  */
1267
1268 extern const peerspec *p_spec(peer */*p*/);
1269
1270 /* --- @p_findbyaddr@ --- *
1271  *
1272  * Arguments:   @const addr *a@ = address to look up
1273  *
1274  * Returns:     Pointer to the peer block, or null if not found.
1275  *
1276  * Use:         Finds a peer by address.
1277  */
1278
1279 extern peer *p_findbyaddr(const addr */*a*/);
1280
1281 /* --- @p_find@ --- *
1282  *
1283  * Arguments:   @const char *name@ = name to look up
1284  *
1285  * Returns:     Pointer to the peer block, or null if not found.
1286  *
1287  * Use:         Finds a peer by name.
1288  */
1289
1290 extern peer *p_find(const char */*name*/);
1291
1292 /* --- @p_destroy@ --- *
1293  *
1294  * Arguments:   @peer *p@ = pointer to a peer
1295  *
1296  * Returns:     ---
1297  *
1298  * Use:         Destroys a peer.
1299  */
1300
1301 extern void p_destroy(peer */*p*/);
1302
1303 /* --- @FOREACH_PEER@ --- *
1304  *
1305  * Arguments:   @p@ = name to bind to each peer
1306  *              @stuff@ = thing to do for each item
1307  *
1308  * Use:         Does something for each current peer.
1309  */
1310
1311 #define FOREACH_PEER(p, stuff) do {                                     \
1312   peer_iter i_;                                                         \
1313   peer *p;                                                              \
1314   for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff                   \
1315 } while (0)
1316
1317 /* --- @p_mkiter@ --- *
1318  *
1319  * Arguments:   @peer_iter *i@ = pointer to an iterator
1320  *
1321  * Returns:     ---
1322  *
1323  * Use:         Initializes the iterator.
1324  */
1325
1326 extern void p_mkiter(peer_iter */*i*/);
1327
1328 /* --- @p_next@ --- *
1329  *
1330  * Arguments:   @peer_iter *i@ = pointer to an iterator
1331  *
1332  * Returns:     Next peer, or null if at the end.
1333  *
1334  * Use:         Returns the next peer.
1335  */
1336
1337 extern peer *p_next(peer_iter */*i*/);
1338
1339 /*----- Tunnel drivers ----------------------------------------------------*/
1340
1341 #ifdef TUN_LINUX
1342   extern const tunnel_ops tun_linux;
1343 #endif
1344
1345 #ifdef TUN_UNET
1346   extern const tunnel_ops tun_unet;
1347 #endif
1348
1349 #ifdef TUN_BSD
1350   extern const tunnel_ops tun_bsd;
1351 #endif
1352
1353 extern const tunnel_ops tun_slip;
1354
1355 /*----- Other handy utilities ---------------------------------------------*/
1356
1357 /* --- @mpstr@ --- *
1358  *
1359  * Arguments:   @mp *m@ = a multiprecision integer
1360  *
1361  * Returns:     A pointer to the integer's textual representation.
1362  *
1363  * Use:         Converts a multiprecision integer to a string.  Corrupts
1364  *              @buf_u@.
1365  */
1366
1367 extern const char *mpstr(mp */*m*/);
1368
1369 /* --- @gestr@ --- *
1370  *
1371  * Arguments:   @group *g@ = a group
1372  *              @ge *x@ = a group element
1373  *
1374  * Returns:     A pointer to the element's textual representation.
1375  *
1376  * Use:         Converts a group element to a string.  Corrupts
1377  *              @buf_u@.
1378  */
1379
1380 extern const char *gestr(group */*g*/, ge */*x*/);
1381
1382 /* --- @timestr@ --- *
1383  *
1384  * Arguments:   @time_t t@ = a time to convert
1385  *
1386  * Returns:     A pointer to a textual representation of the time.
1387  *
1388  * Use:         Converts a time to a textual representation.  Corrupts
1389  *              @buf_u@.
1390  */
1391
1392 extern const char *timestr(time_t /*t*/);
1393
1394 /* --- @mystrieq@ --- *
1395  *
1396  * Arguments:   @const char *x, *y@ = two strings
1397  *
1398  * Returns:     True if @x@ and @y are equal, up to case.
1399  */
1400
1401 extern int mystrieq(const char */*x*/, const char */*y*/);
1402
1403 /* --- @seq_reset@ --- *
1404  *
1405  * Arguments:   @seqwin *s@ = sequence-checking window
1406  *
1407  * Returns:     ---
1408  *
1409  * Use:         Resets a sequence number window.
1410  */
1411
1412 extern void seq_reset(seqwin */*s*/);
1413
1414 /* --- @seq_check@ --- *
1415  *
1416  * Arguments:   @seqwin *s@ = sequence-checking window
1417  *              @uint32 q@ = sequence number to check
1418  *              @const char *service@ = service to report message from
1419  *
1420  * Returns:     A @SEQ_@ code.
1421  *
1422  * Use:         Checks a sequence number against the window, updating things
1423  *              as necessary.
1424  */
1425
1426 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
1427
1428 /*----- That's all, folks -------------------------------------------------*/
1429
1430 #ifdef __cplusplus
1431   }
1432 #endif
1433
1434 #endif