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 it under
  13  * the terms of the GNU General Public License as published by the Free
  14  * Software Foundation; either version 3 of the License, or (at your
  15  * option) any later version.
  16  *
  17  * TrIPE is distributed in the hope that it will be useful, but WITHOUT
  18  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with TrIPE.  If not, see <https://www.gnu.org/licenses/>.
  24  */
  25
  26 #ifndef TRIPE_H
  27 #define TRIPE_H
  28
  29 #ifdef __cplusplus
  30   extern "C" {
  31 #endif
  32
  33 /*----- Header files ------------------------------------------------------*/
  34
  35 #include "config.h"
  36
  37 #include <assert.h>
  38 #include <ctype.h>
  39 #include <errno.h>
  40 #include <limits.h>
  41 #include <signal.h>
  42 #include <stdarg.h>
  43 #include <stddef.h>
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <string.h>
  47 #include <time.h>
  48
  49 #include <sys/types.h>
  50 #include <sys/time.h>
  51 #include <unistd.h>
  52 #include <fcntl.h>
  53 #include <sys/stat.h>
  54 #include <sys/wait.h>
  55
  56 #include <sys/socket.h>
  57 #include <sys/un.h>
  58 #include <netinet/in.h>
  59 #include <arpa/inet.h>
  60 #include <netdb.h>
  61
  62 #include <pwd.h>
  63 #include <grp.h>
  64
  65 #ifdef HAVE_LIBADNS
  66 #  define ADNS_FEATURE_MANYAF
  67 #  include <adns.h>
  68 #endif
  69
  70 #include <mLib/alloc.h>
  71 #include <mLib/arena.h>
  72 #include <mLib/base64.h>
  73 #ifndef HAVE_LIBADNS
  74 #  include <mLib/bres.h>
  75 #endif
  76 #include <mLib/codec.h>
  77 #include <mLib/daemonize.h>
  78 #include <mLib/dstr.h>
  79 #include <mLib/env.h>
  80 #include <mLib/fdflags.h>
  81 #include <mLib/fdpass.h>
  82 #include <mLib/fwatch.h>
  83 #include <mLib/hash.h>
  84 #include <mLib/macros.h>
  85 #include <mLib/mdup.h>
  86 #include <mLib/mdwopt.h>
  87 #include <mLib/quis.h>
  88 #include <mLib/report.h>
  89 #include <mLib/sel.h>
  90 #include <mLib/selbuf.h>
  91 #include <mLib/sig.h>
  92 #include <mLib/str.h>
  93 #include <mLib/sub.h>
  94 #include <mLib/trace.h>
  95 #include <mLib/tv.h>
  96 #include <mLib/versioncmp.h>
  97
  98 #include <catacomb/buf.h>
  99 #include <catacomb/ct.h>
 100
 101 #include <catacomb/chacha.h>
 102 #include <catacomb/gcipher.h>
 103 #include <catacomb/gmac.h>
 104 #include <catacomb/grand.h>
 105 #include <catacomb/key.h>
 106 #include <catacomb/paranoia.h>
 107 #include <catacomb/poly1305.h>
 108 #include <catacomb/salsa20.h>
 109
 110 #include <catacomb/noise.h>
 111 #include <catacomb/rand.h>
 112
 113 #include <catacomb/mp.h>
 114 #include <catacomb/mpmont.h>
 115 #include <catacomb/mprand.h>
 116 #include <catacomb/dh.h>
 117 #include <catacomb/ec.h>
 118 #include <catacomb/ec-raw.h>
 119 #include <catacomb/ec-keys.h>
 120 #include <catacomb/x25519.h>
 121 #include <catacomb/x448.h>
 122
 123 #include "priv.h"
 124 #include "protocol.h"
 125 #include "slip.h"
 126 #include "util.h"
 127
 128 #undef sun
 129
 130 /*----- Magic numbers -----------------------------------------------------*/
 131
 132 /* --- Trace flags --- */
 133
 134 #define T_TUNNEL 1u
 135 #define T_PEER 2u
 136 #define T_PACKET 4u
 137 #define T_ADMIN 8u
 138 #define T_CRYPTO 16u
 139 #define T_KEYSET 32u
 140 #define T_KEYEXCH 64u
 141 #define T_KEYMGMT 128u
 142 #define T_CHAL 256u
 143 /* T_PRIVSEP  in priv.h */
 144
 145 #define T_ALL 1023u
 146
 147 /* --- Units --- */
 148
 149 #define SEC(n) (n##u)
 150 #define MIN(n) (n##u * 60u)
 151 #define F_2P32 (65536.0*65536.0)
 152 #define MEG(n) (n##ul * 1024ul * 1024ul)
 153
 154 /* --- Timing parameters --- */
 155
 156 #define T_EXP MIN(60)                   /* Expiry time for a key */
 157 #define T_REGEN MIN(40)                 /* Regeneration time for a key */
 158
 159 #define T_VALID SEC(20)                 /* Challenge validity period */
 160 #define T_RETRYMIN SEC(2)               /* Minimum retry interval */
 161 #define T_RETRYMAX MIN(5)               /* Maximum retry interval */
 162 #define T_RETRYGROW (5.0/4.0)           /* Retry interval growth factor */
 163
 164 #define T_WOBBLE (1.0/3.0)              /* Relative timer randomness */
 165
 166 /* --- Other things --- */
 167
 168 #define PKBUFSZ 65536
 169
 170 /*----- Cipher selections -------------------------------------------------*/
 171
 172 typedef struct keyset keyset;
 173 typedef struct algswitch algswitch;
 174 typedef struct kdata kdata;
 175 typedef struct admin admin;
 176
 177 typedef struct dhgrp {
 178   const struct dhops *ops;
 179   size_t scsz;
 180 } dhgrp;
 181
 182 typedef struct dhsc dhsc;
 183 typedef struct dhge dhge;
 184
 185 enum {
 186   DHFMT_STD,                /* Fixed-width format, suitable for encryption */
 187   DHFMT_HASH,                /* Deterministic format, suitable for hashing */
 188   DHFMT_VAR                    /* Variable-width-format, mostly a bad idea */
 189 };
 190
 191 typedef struct deriveargs {
 192   const char *what;                     /* Operation name (hashed) */
 193   unsigned f;                           /* Flags */
 194 #define DF_IN 1u                        /*   Make incoming key */
 195 #define DF_OUT 2u                       /*   Make outgoing key */
 196   const gchash *hc;                     /* Hash class */
 197   const octet *k;                       /* Pointer to contributions */
 198   size_t x, y, z;                       /* Markers in contributions */
 199 } deriveargs;
 200
 201 typedef struct bulkalgs {
 202   const struct bulkops *ops;
 203 } bulkalgs;
 204
 205 typedef struct bulkctx {
 206   const struct bulkops *ops;
 207 } bulkctx;
 208
 209 typedef struct bulkchal {
 210   const struct bulkops *ops;
 211   size_t tagsz;
 212 } bulkchal;
 213
 214 typedef struct dhops {
 215   const char *name;
 216
 217   int (*ldpriv)(key_file */*kf*/, key */*k*/, key_data */*d*/,
 218                 kdata */*kd*/, dstr */*t*/, dstr */*e*/);
 219         /* Load a private key from @d@, storing the data in @kd@.  The key's
 220          * file and key object are in @kf@ and @k@, mostly in case its
 221          * attributes are interesting; the key tag is in @t@; errors are
 222          * reported by writing tokens to @e@ and returning nonzero.
 223          */
 224
 225   int (*ldpub)(key_file */*kf*/, key */*k*/, key_data */*d*/,
 226                kdata */*kd*/, dstr */*t*/, dstr */*e*/);
 227         /* Load a public key from @d@, storing the data in @kd@.  The key's
 228          * file and key object are in @kf@ and @k@, mostly in case its
 229          * attributes are interesting; the key tag is in @t@; errors are
 230          * reported by writing tokens to @e@ and returning nonzero.
 231          */
 232
 233   const char *(*checkgrp)(const dhgrp */*g*/);
 234         /* Check that the group is valid; return null on success, or an error
 235          * string.
 236          */
 237
 238   void (*grpinfo)(const dhgrp */*g*/, admin */*a*/);
 239         /* Report on the group to an admin client. */
 240
 241   T( void (*tracegrp)(const dhgrp */*g*/); )
 242         /* Trace a description of the group. */
 243
 244   int (*samegrpp)(const dhgrp */*g*/, const dhgrp */*gg*/);
 245         /* Return nonzero if the two group objects represent the same
 246          * group.
 247          */
 248
 249   void (*freegrp)(dhgrp */*g*/);
 250         /* Free a group and the resources it holds. */
 251
 252   dhsc *(*ldsc)(const dhgrp */*g*/, const void */*p*/, size_t /*sz*/);
 253         /* Load a scalar from @p@, @sz@ and return it.  Return null on
 254          * error.
 255          */
 256
 257   int (*stsc)(const dhgrp */*g*/,
 258                void */*p*/, size_t /*sz*/, const dhsc */*x*/);
 259         /* Store a scalar at @p@, @sz@.  Return nonzero on error. */
 260
 261   dhsc *(*randsc)(const dhgrp */*g*/);
 262         /* Return a random scalar. */
 263
 264   T( const char *(*scstr)(const dhgrp */*g*/, const dhsc */*x*/); )
 265         /* Return a human-readable representation of @x@; @buf_t@ may be used
 266          * to hold it.
 267          */
 268
 269   void (*freesc)(const dhgrp */*g*/, dhsc */*x*/);
 270         /* Free a scalar and the resources it holds. */
 271
 272   dhge *(*ldge)(const dhgrp */*g*/, buf */*b*/, int /*fmt*/);
 273         /* Load a group element from @b@, encoded using format @fmt@.  Return
 274          * null on error.
 275          */
 276
 277   int (*stge)(const dhgrp */*g*/, buf */*b*/,
 278               const dhge */*Y*/, int /*fmt*/);
 279         /* Store a group element in @b@, encoded using format @fmt@.  Return
 280          * nonzero on error.
 281          */
 282
 283   int (*checkge)(const dhgrp */*h*/, const dhge */*Y*/);
 284         /* Check a group element for validity.  Return zero if everything
 285          * checks out; nonzero on failure.
 286          */
 287
 288   int (*eq)(const dhgrp */*g*/, const dhge */*Y*/, const dhge */*Z*/);
 289         /* Return nonzero if @Y@ and @Z@ are equal. */
 290
 291   dhge *(*mul)(const dhgrp */*g*/, const dhsc */*x*/, const dhge */*Y*/);
 292         /* Multiply a group element by a scalar, resulting in a shared-secret
 293          * group element.  If @y@ is null, then multiply the well-known
 294          * generator.
 295          */
 296
 297   T( const char *(*gestr)(const dhgrp */*g*/, const dhge */*Y*/); )
 298         /* Return a human-readable representation of @Y@; @buf_t@ may be used
 299          * to hold it.
 300          */
 301
 302   void (*freege)(const dhgrp */*g*/, dhge */*Y*/);
 303         /* Free a group element and the resources it holds. */
 304
 305 } dhops;
 306
 307 typedef struct bulkops {
 308   const char *name;
 309
 310   bulkalgs *(*getalgs)(const algswitch */*asw*/, dstr */*e*/,
 311                        key_file */*kf*/, key */*k*/);
 312         /* Determine algorithms to use and return a @bulkalgs@ object
 313          * representing the decision.  On error, write tokens to @e@ and
 314          * return null.
 315          */
 316
 317   T( void (*tracealgs)(const bulkalgs */*a*/); )
 318         /* Write trace information about the algorithm selection. */
 319
 320   int (*checkalgs)(bulkalgs */*a*/, const algswitch */*asw*/, dstr */*e*/);
 321         /* Check that the algorithms in @a@ and @asw@ are acceptable.  On
 322          * error, write tokens to @e@ and return @-1@; otherwise return zero.
 323          */
 324
 325   int (*samealgsp)(const bulkalgs */*a*/, const bulkalgs */*aa*/);
 326         /* If @a@ and @aa@ represent the same algorithm selection, return
 327          * nonzero; if not, return zero.
 328          */
 329
 330   void (*alginfo)(const bulkalgs */*a*/, admin */*adm*/);
 331         /* Report on the algorithm selection to an admin client: call
 332          * @a_info@ with appropriate key-value pairs.
 333          */
 334
 335   size_t (*overhead)(const bulkalgs */*a*/);
 336         /* Return the per-packet overhead of the bulk transform, in bytes. */
 337
 338   size_t (*expsz)(const bulkalgs */*a*/);
 339         /* Return the total size limit for the bulk transform, in bytes,
 340          * after which the keys must no longer be used.
 341          */
 342
 343   bulkctx *(*genkeys)(const bulkalgs */*a*/, const deriveargs */*a*/);
 344         /* Generate session keys and construct and return an appropriate
 345          * context for using them.  The offsets @a->x@, @a->y@ and @a->z@
 346          * separate the key material into three parts.  Between @a->k@ and
 347          * @a->k + a->x@ is `my' contribution to the key material; between
 348          * @a->k + a->x@ and @a->k + a->y@ is `your' contribution; and
 349          * between @a->k + a->y@ and @a->k + a->z@ is a shared value we made
 350          * together.  These are used to construct (up to) two collections of
 351          * symmetric keys: one for outgoing messages, the other for incoming
 352          * messages.  If @a->x == 0@ (or @a->y == a->x@) then my (or your)
 353          * contribution is omitted.
 354          */
 355
 356   bulkchal *(*genchal)(const bulkalgs */*a*/);
 357         /* Construct and return a challenge issuing and verification
 358          * context with a fresh random key.
 359          */
 360
 361   void (*freealgs)(bulkalgs */*a*/);
 362         /* Release an algorithm selection object.  (Associated bulk
 363          * encryption contexts and challenge contexts may still exist and
 364          * must remain valid.)
 365          */
 366
 367   int (*encrypt)(bulkctx */*bc*/, unsigned /*ty*/,
 368                  buf */*b*/, buf */*bb*/, uint32 /*seq*/);
 369         /* Encrypt the packet in @b@, with type @ty@ (which doesn't need
 370          * encoding separately) and sequence number @seq@ (which must be
 371          * recoverable by @decrypt@), and write the result to @bb@.  On
 372          * error, return a @KSERR_...@ code and/or break the output buffer.
 373          */
 374
 375   int (*decrypt)(bulkctx */*bc*/, unsigned /*ty*/,
 376                  buf */*b*/, buf */*bb*/, uint32 */*seq*/);
 377         /* Decrypt the packet in @b@, with type @ty@, writing the result to
 378          * @bb@ and storing the incoming (claimed) sequence number in @seq@.
 379          * On error, return a @KSERR_...@ code.
 380          */
 381
 382   void (*freectx)(bulkctx */*a*/);
 383         /* Release a bulk encryption context and the resources it holds. */
 384
 385   int (*chaltag)(bulkchal */*bc*/, const void */*m*/, size_t /*msz*/,
 386                  uint32 /*seq*/, void */*t*/);
 387         /* Calculate a tag for the challenge in @m@, @msz@, with the sequence
 388          * number @seq@, and write it to @t@.  Return @-1@ on error, zero on
 389          * success.
 390          */
 391
 392   int (*chalvrf)(bulkchal */*bc*/, const void */*m*/, size_t /*msz*/,
 393                  uint32 /*seq*/, const void */*t*/);
 394         /* Check the tag @t@ on @m@, @msz@ and @seq@: return zero if the tag
 395          * is OK, nonzero if it's bad.
 396          */
 397
 398   void (*freechal)(bulkchal */*bc*/);
 399         /* Release a challenge context and the resources it holds. */
 400
 401 } bulkops;
 402
 403 struct algswitch {
 404   const gchash *h; size_t hashsz;       /* Hash function */
 405   const gccipher *mgf;                  /* Mask-generation function */
 406   bulkalgs *bulk;                       /* Bulk crypto algorithms */
 407 };
 408
 409 struct kdata {
 410   unsigned ref;                         /* Reference counter */
 411   struct knode *kn;                     /* Pointer to cache entry */
 412   uint32 id;                            /* The underlying key's id */
 413   char *tag;                            /* Full tag name of the key */
 414   dhgrp *grp;                           /* The group we work in */
 415   dhsc *k;                              /* The private key (or null) */
 416   dhge *K;                              /* The public key */
 417   time_t t_exp;                         /* Expiry time of the key */
 418   algswitch algs;                       /* Collection of algorithms */
 419 };
 420
 421 typedef struct knode {
 422   sym_base _b;                          /* Symbol table intrusion */
 423   unsigned f;                           /* Various flags */
 424 #define KNF_BROKEN 1u                   /*   Don't use this key any more */
 425   struct keyhalf *kh;                   /* Pointer to the home keyhalf */
 426   kdata *kd;                            /* Pointer to the key data */
 427 } knode;
 428
 429 #define MAXHASHSZ 64                    /* Largest possible hash size */
 430
 431 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
 432
 433 extern const dhops dhtab[];
 434 extern const bulkops bulktab[];
 435
 436 /*----- Data structures ---------------------------------------------------*/
 437
 438 /* --- The address-family table --- */
 439
 440 #define ADDRFAM(_)                                                      \
 441   _(INET,       want_ipv4)                                              \
 442   _(INET6,      want_ipv6)
 443
 444 enum {
 445 #define ENUM(af, qf) AFIX_##af,
 446   ADDRFAM(ENUM)
 447 #undef ENUM
 448   NADDRFAM
 449 };
 450
 451 extern const struct addrfam {
 452   int af;
 453   const char *name;
 454 #ifdef HAVE_LIBADNS
 455   adns_queryflags qf;
 456 #endif
 457 } aftab[NADDRFAM];
 458
 459 /* --- Socket addresses --- *
 460  *
 461  * A magic union of supported socket addresses.
 462  */
 463
 464 typedef union addr {
 465   struct sockaddr sa;
 466   struct sockaddr_in sin;
 467   struct sockaddr_in6 sin6;
 468 } addr;
 469
 470 /* --- Mapping keyed on addresses --- */
 471
 472 typedef struct addrmap {
 473   hash_table t;
 474   size_t load;
 475 } addrmap;
 476
 477 typedef struct addrmap_base {
 478   hash_base b;
 479   addr a;
 480 } addrmap_base;
 481
 482 /* --- Sequence number checking --- */
 483
 484 typedef struct seqwin {
 485   uint32 seq;                           /* First acceptable input sequence */
 486   uint32 win;                           /* Window of acceptable numbers */
 487 } seqwin;
 488
 489 #define SEQ_WINSZ 32                    /* Bits in sequence number window */
 490
 491 /* --- A symmetric keyset --- *
 492  *
 493  * A keyset contains a set of symmetric keys for encrypting and decrypting
 494  * packets.  Keysets are stored in a list, sorted in reverse order of
 495  * creation, so that the most recent keyset (the one most likely to be used)
 496  * is first.
 497  *
 498  * Each keyset has a time limit and a data limit.  The keyset is destroyed
 499  * when either it has existed for too long, or it has been used to encrypt
 500  * too much data.  New key exchanges are triggered when keys are close to
 501  * expiry.
 502  */
 503
 504 enum { DIR_IN, DIR_OUT, NDIR };
 505
 506 struct keyset {
 507   struct keyset *next;                  /* Next active keyset in the list */
 508   unsigned ref;                         /* Reference count for keyset */
 509   struct peer *p;                       /* Pointer to peer structure */
 510   time_t t_exp;                         /* Expiry time for this keyset */
 511   unsigned long sz_exp, sz_regen;       /* Data limits for the keyset */
 512   T( unsigned seq; )                    /* Sequence number for tracing */
 513   unsigned f;                           /* Various useful flags */
 514   bulkctx *bulk;                        /* Bulk crypto transform */
 515   uint32 oseq;                          /* Outbound sequence number */
 516   seqwin iseq;                          /* Inbound sequence number */
 517 };
 518
 519 #define KSF_LISTEN 1u                   /* Don't encrypt packets yet */
 520 #define KSF_LINK 2u                     /* Key is in a linked list */
 521
 522 #define KSERR_REGEN -1                  /* Regenerate keys */
 523 #define KSERR_NOKEYS -2                 /* No keys left */
 524 #define KSERR_DECRYPT -3                /* Unable to decrypt message */
 525 #define KSERR_SEQ -4                    /* Incorrect sequence number */
 526 #define KSERR_MALFORMED -5              /* Input ciphertext is broken */
 527
 528 /* --- Key exchange --- *
 529  *
 530  * TrIPE uses the Wrestlers Protocol for its key exchange.  The Wrestlers
 531  * Protocol has a number of desirable features (e.g., perfect forward
 532  * secrecy, and zero-knowledge authentication) which make it attractive for
 533  * use in TrIPE.  The Wrestlers Protocol was designed by Mark Wooding and
 534  * Clive Jones.
 535  */
 536
 537 typedef struct retry {
 538   double t;                             /* Current retry time */
 539 } retry;
 540
 541 #define KX_NCHAL 16u
 542
 543 typedef struct kxchal {
 544   struct keyexch *kx;                   /* Pointer back to key exchange */
 545   dhge *C;                              /* Responder's challenge */
 546   dhge *R;                              /* My reply to the challenge */
 547   keyset *ks;                           /* Pointer to temporary keyset */
 548   unsigned f;                           /* Various useful flags */
 549   sel_timer t;                          /* Response timer for challenge */
 550   retry rs;                             /* Retry state */
 551   octet hc[MAXHASHSZ];                  /* Hash of his challenge */
 552   octet ck[MAXHASHSZ];                  /* His magical check value */
 553   octet hswrq_in[MAXHASHSZ];            /* Inbound switch request message */
 554   octet hswok_in[MAXHASHSZ];            /* Inbound switch confirmation */
 555   octet hswrq_out[MAXHASHSZ];           /* Outbound switch request message */
 556   octet hswok_out[MAXHASHSZ];           /* Outbound switch confirmation */
 557 } kxchal;
 558
 559 typedef struct keyexch {
 560   struct peer *p;                       /* Pointer back to the peer */
 561   kdata *kpriv;                         /* Private key and related info */
 562   kdata *kpub;                          /* Peer's public key */
 563   keyset **ks;                          /* Peer's list of keysets */
 564   unsigned f;                           /* Various useful flags */
 565   unsigned s;                           /* Current state in exchange */
 566   sel_timer t;                          /* Timer for next exchange */
 567   retry rs;                             /* Retry state */
 568   dhsc *a;                              /* My temporary secret */
 569   dhge *C;                              /* My challenge */
 570   dhge *RX;                             /* The expected response */
 571   unsigned nr;                          /* Number of extant responses */
 572   time_t t_valid;                       /* When this exchange goes bad */
 573   octet hc[MAXHASHSZ];                  /* Hash of my challenge */
 574   kxchal *r[KX_NCHAL];                  /* Array of challenges */
 575 } keyexch;
 576
 577 #define KXF_TIMER 1u                    /* Waiting for a timer to go off */
 578 #define KXF_DEAD 2u                     /* The key-exchanger isn't up */
 579 #define KXF_PUBKEY 4u                   /* Key exchanger has a public key */
 580 #define KXF_CORK 8u                     /* Don't send anything yet */
 581
 582 enum {
 583   KXS_DEAD,                             /* Uninitialized state (magical) */
 584   KXS_CHAL,                             /* Main answer-challenges state */
 585   KXS_COMMIT,                           /* Committed: send switch request */
 586   KXS_SWITCH                            /* Switched: send confirmation */
 587 };
 588
 589 /* --- Tunnel structure --- *
 590  *
 591  * Used to maintain system-specific information about the tunnel interface.
 592  */
 593
 594 typedef struct tunnel tunnel;
 595 struct peer;
 596
 597 typedef struct tunnel_ops {
 598   const char *name;                     /* Name of this tunnel driver */
 599   unsigned flags;                       /* Various interesting flags */
 600 #define TUNF_PRIVOPEN 1u                /*   Need helper to open file */
 601   void (*init)(void);                   /* Initializes the system */
 602   tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/);
 603                                         /* Initializes a new tunnel */
 604   void (*setifname)(tunnel */*t*/, const char */*ifn*/);
 605                                         /*  Notifies ifname change */
 606   void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
 607   void (*destroy)(tunnel */*t*/);       /* Destroys a tunnel */
 608 } tunnel_ops;
 609
 610 #ifndef TUN_INTERNALS
 611 struct tunnel { const tunnel_ops *ops; };
 612 #endif
 613
 614 /* --- Peer statistics --- *
 615  *
 616  * Contains various interesting and not-so-interesting statistics about a
 617  * peer.  This is updated by various parts of the code.  The format of the
 618  * structure isn't considered private, and @p_stats@ returns a pointer to the
 619  * statistics block for a given peer.
 620  */
 621
 622 typedef struct stats {
 623   unsigned long sz_in, sz_out;          /* Size of all data in and out */
 624   unsigned long sz_kxin, sz_kxout;      /* Size of key exchange messages */
 625   unsigned long sz_ipin, sz_ipout;      /* Size of encapsulated IP packets */
 626   time_t t_start, t_last, t_kx;         /* Time peer created, last pk, kx */
 627   unsigned long n_reject;               /* Number of rejected packets */
 628   unsigned long n_in, n_out;            /* Number of packets in and out */
 629   unsigned long n_kxin, n_kxout;        /* Number of key exchange packets */
 630   unsigned long n_ipin, n_ipout;        /* Number of encrypted packets */
 631 } stats;
 632
 633 /* --- Peer structure --- *
 634  *
 635  * The main structure which glues everything else together.
 636  */
 637
 638 typedef struct peerspec {
 639   char *name;                           /* Peer's name */
 640   char *privtag;                        /* Private key tag */
 641   char *tag;                            /* Public key tag */
 642   char *knock;                          /* Knock string, or null */
 643   const tunnel_ops *tops;               /* Tunnel operations */
 644   unsigned long t_ka;                   /* Keep alive interval */
 645   addr sa;                              /* Socket address to speak to */
 646   unsigned f;                           /* Flags for the peer */
 647 #define PSF_KXMASK 255u                 /*   Key-exchange flags to set */
 648 #define PSF_MOBILE 256u                 /*   Address may change rapidly */
 649 #define PSF_EPHEM 512u                  /*   Association is ephemeral */
 650 } peerspec;
 651
 652 typedef struct peer_byname {
 653   sym_base _b;
 654   struct peer *p;
 655 } peer_byname;
 656
 657 typedef struct peer_byaddr {
 658   addrmap_base _b;
 659   struct peer *p;
 660 } peer_byaddr;
 661
 662 typedef struct peer {
 663   peer_byname *byname;                  /* Lookup-by-name block */
 664   peer_byaddr *byaddr;                  /* Lookup-by-address block */
 665   struct ping *pings;                   /* Pings we're waiting for */
 666   peerspec spec;                        /* Specifications for this peer */
 667   int afix;                             /* Index of address family */
 668   tunnel *t;                            /* Tunnel for local packets */
 669   char *ifname;                         /* Interface name for tunnel */
 670   keyset *ks;                           /* List head for keysets */
 671   buf b;                                /* Buffer for sending packets */
 672   stats st;                             /* Statistics */
 673   keyexch kx;                           /* Key exchange protocol block */
 674   sel_timer tka;                        /* Timer for keepalives */
 675 } peer;
 676
 677 typedef struct peer_iter { sym_iter i; } peer_iter;
 678
 679 typedef struct ping {
 680   struct ping *next, *prev;             /* Links to next and previous */
 681   peer *p;                              /* Peer so we can free it */
 682   unsigned msg;                         /* Kind of response expected */
 683   uint32 id;                            /* Id so we can recognize response */
 684   octet magic[32];                      /* Some random data */
 685   sel_timer t;                          /* Timeout for ping */
 686   void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
 687   void *arg;                            /* Argument for callback */
 688 } ping;
 689
 690 enum {
 691   PING_NONOTIFY = -1,
 692   PING_OK = 0,
 693   PING_TIMEOUT,
 694   PING_PEERDIED,
 695   PING_MAX
 696 };
 697
 698 /* --- Admin structure --- */
 699
 700 #define OBUFSZ 16384u
 701
 702 typedef struct obuf {
 703   struct obuf *next;                    /* Next buffer in list */
 704   char *p_in, *p_out;                   /* Pointers into the buffer */
 705   char buf[OBUFSZ];                     /* The actual buffer */
 706 } obuf;
 707
 708 typedef struct oqueue {
 709   obuf *hd, *tl;                        /* Head and tail pointers */
 710 } oqueue;
 711
 712 struct admin;
 713
 714 typedef struct admin_bgop {
 715   struct admin_bgop *next, *prev;       /* Links to next and previous */
 716   struct admin *a;                      /* Owner job */
 717   char *tag;                            /* Tag string for messages */
 718   void (*cancel)(struct admin_bgop *);  /* Destructor function */
 719 } admin_bgop;
 720
 721 typedef struct admin_resop {
 722   admin_bgop bg;                        /* Background operation header */
 723   char *addr;                           /* Hostname to be resolved */
 724 #ifdef HAVE_LIBADNS
 725   adns_query q;
 726 #else
 727   bres_client r;                        /* Background resolver task */
 728 #endif
 729   sel_timer t;                          /* Timer for resolver */
 730   addr sa;                              /* Socket address */
 731   unsigned port;                        /* Port number chosen */
 732   size_t sasz;                          /* Socket address size */
 733   void (*func)(struct admin_resop *, int); /* Handler */
 734 } admin_resop;
 735
 736 enum { ARES_OK, ARES_FAIL };
 737
 738 typedef struct admin_addop {
 739   admin_resop r;                        /* Name resolution header */
 740   peerspec peer;                        /* Peer pending creation */
 741 } admin_addop;
 742
 743 typedef struct admin_pingop {
 744   admin_bgop bg;                        /* Background operation header */
 745   ping ping;                            /* Ping pending response */
 746   struct timeval pingtime;              /* Time last ping was sent */
 747 } admin_pingop;
 748
 749 typedef struct admin_service {
 750   sym_base _b;                          /* Hash table base structure */
 751   char *version;                        /* The provided version */
 752   struct admin *prov;                   /* Which client provides me */
 753   struct admin_service *next, *prev;    /* Client's list of services */
 754 } admin_service;
 755
 756 typedef struct admin_svcop {
 757   admin_bgop bg;                        /* Background operation header */
 758   struct admin *prov;                   /* Client servicing this job */
 759   unsigned index;                       /* This job's index */
 760   struct admin_svcop *next, *prev;      /* Links for provider's jobs */
 761 } admin_svcop;
 762
 763 typedef struct admin_jobentry {
 764   unsigned short seq;                   /* Zero if unused */
 765   union {
 766     admin_svcop *op;                    /* Operation, if slot in use, ... */
 767     uint32 next;                        /* ... or index of next free slot */
 768   } u;
 769 } admin_jobentry;
 770
 771 typedef struct admin_jobtable {
 772   uint32 n, sz;                         /* Used slots and table size */
 773   admin_svcop *active;                  /* List of active jobs */
 774   uint32 free;                          /* Index of first free slot */
 775   admin_jobentry *v;                    /* And the big array of entries */
 776 } admin_jobtable;
 777
 778 struct admin {
 779   struct admin *next, *prev;            /* Links to next and previous */
 780   unsigned f;                           /* Various useful flags */
 781   unsigned ref;                         /* Reference counter */
 782 #ifndef NTRACE
 783   unsigned seq;                         /* Sequence number for tracing */
 784 #endif
 785   oqueue out;                           /* Output buffer list */
 786   oqueue delay;                         /* Delayed output buffer list */
 787   admin_bgop *bg;                       /* Backgrounded operations */
 788   admin_service *svcs;                  /* Which services I provide */
 789   admin_jobtable j;                     /* Table of outstanding jobs */
 790   selbuf b;                             /* Line buffer for commands */
 791   sel_file w;                           /* Selector for write buffering */
 792 };
 793
 794 #define AF_DEAD 1u                      /* Destroy this admin block */
 795 #define AF_CLOSE 2u                     /* Client closed connection */
 796 #define AF_NOTE 4u                      /* Catch notifications */
 797 #define AF_WARN 8u                      /* Catch warning messages */
 798 #ifndef NTRACE
 799 #  define AF_TRACE 16u                  /* Catch tracing */
 800 #endif
 801 #define AF_FOREGROUND 32u               /* Quit server when client closes */
 802
 803 #ifndef NTRACE
 804 #  define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
 805 #else
 806 #  define AF_ALLMSGS (AF_NOTE | AF_WARN)
 807 #endif
 808
 809 /*----- Global variables --------------------------------------------------*/
 810
 811 extern sel_state sel;                   /* Global I/O event state */
 812 extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
 813 extern const tunnel_ops *tunnels[];     /* Table of tunnels (0-term) */
 814 extern const tunnel_ops *tun_default;   /* Default tunnel to use */
 815 extern sel_file udpsock[NADDRFAM];      /* The master UDP sockets */
 816 extern kdata *master;                   /* Default private key */
 817 extern const char *tag_priv;            /* Default private key tag */
 818
 819 #ifndef NTRACE
 820 extern const trace_opt tr_opts[];       /* Trace options array */
 821 extern unsigned tr_flags;               /* Trace options flags */
 822 #endif
 823
 824 /*----- Other macros ------------------------------------------------------*/
 825
 826 #define QUICKRAND                                                       \
 827   do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0)
 828
 829 /*----- Key management ----------------------------------------------------*/
 830
 831 /* --- @km_init@ --- *
 832  *
 833  * Arguments:   @const char *privkr@ = private keyring file
 834  *              @const char *pubkr@ = public keyring file
 835  *              @const char *ptag@ = default private-key tag
 836  *
 837  * Returns:     ---
 838  *
 839  * Use:         Initializes the key-management machinery, loading the
 840  *              keyrings and so on.
 841  */
 842
 843 extern void km_init(const char */*privkr*/, const char */*pubkr*/,
 844                     const char */*ptag*/);
 845
 846 /* --- @km_reload@ --- *
 847  *
 848  * Arguments:   ---
 849  *
 850  * Returns:     Zero if OK, nonzero to force reloading of keys.
 851  *
 852  * Use:         Checks the keyrings to see if they need reloading.
 853  */
 854
 855 extern int km_reload(void);
 856
 857 /* --- @km_findpub@, @km_findpriv@ --- *
 858  *
 859  * Arguments:   @const char *tag@ = key tag to load
 860  *
 861  * Returns:     Pointer to the kdata object if successful, or null on error.
 862  *
 863  * Use:         Fetches a public or private key from the keyring.
 864  */
 865
 866 extern kdata *km_findpub(const char */*tag*/);
 867 extern kdata *km_findpriv(const char */*tag*/);
 868
 869 /* --- @km_findpubbyid@, @km_findprivbyid@ --- *
 870  *
 871  * Arguments:   @uint32 id@ = key id to load
 872  *
 873  * Returns:     Pointer to the kdata object if successful, or null on error.
 874  *
 875  * Use:         Fetches a public or private key from the keyring given its
 876  *              numeric id.
 877  */
 878
 879 extern kdata *km_findpubbyid(uint32 /*id*/);
 880 extern kdata *km_findprivbyid(uint32 /*id*/);
 881
 882 /* --- @km_samealgsp@ --- *
 883  *
 884  * Arguments:   @const kdata *kdx, *kdy@ = two key data objects
 885  *
 886  * Returns:     Nonzero if their two algorithm selections are the same.
 887  *
 888  * Use:         Checks sameness of algorithm selections: used to ensure that
 889  *              peers are using sensible algorithms.
 890  */
 891
 892 extern int km_samealgsp(const kdata */*kdx*/, const kdata */*kdy*/);
 893
 894 /* --- @km_ref@ --- *
 895  *
 896  * Arguments:   @kdata *kd@ = pointer to the kdata object
 897  *
 898  * Returns:     ---
 899  *
 900  * Use:         Claim a new reference to a kdata object.
 901  */
 902
 903 extern void km_ref(kdata */*kd*/);
 904
 905 /* --- @km_unref@ --- *
 906  *
 907  * Arguments:   @kdata *kd@ = pointer to the kdata object
 908  *
 909  * Returns:     ---
 910  *
 911  * Use:         Releases a reference to a kdata object.
 912  */
 913
 914 extern void km_unref(kdata */*kd*/);
 915
 916 /* --- @km_tag@ --- *
 917  *
 918  * Arguments:   @kdata *kd@ - pointer to the kdata object
 919  *
 920  * Returns:     A pointer to the short tag by which the kdata was loaded.
 921  */
 922
 923 extern const char *km_tag(kdata */*kd*/);
 924
 925 /*----- Key exchange ------------------------------------------------------*/
 926
 927 /* --- @kx_start@ --- *
 928  *
 929  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 930  *              @int forcep@ = nonzero to ignore the quiet timer
 931  *
 932  * Returns:     ---
 933  *
 934  * Use:         Stimulates a key exchange.  If a key exchage is in progress,
 935  *              a new challenge is sent (unless the quiet timer forbids
 936  *              this); if no exchange is in progress, one is commenced.
 937  */
 938
 939 extern void kx_start(keyexch */*kx*/, int /*forcep*/);
 940
 941 /* --- @kx_message@ --- *
 942  *
 943  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 944  *              @const addr *a@ = sender's IP address and port
 945  *              @unsigned msg@ = the message code
 946  *              @buf *b@ = pointer to buffer containing the packet
 947  *
 948  * Returns:     Nonzero if the sender's address was unknown.
 949  *
 950  * Use:         Reads a packet containing key exchange messages and handles
 951  *              it.
 952  */
 953
 954 extern int kx_message(keyexch */*kx*/, const addr */*a*/,
 955                       unsigned /*msg*/, buf */*b*/);
 956
 957 /* --- @kx_free@ --- *
 958  *
 959  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 960  *
 961  * Returns:     ---
 962  *
 963  * Use:         Frees everything in a key exchange context.
 964  */
 965
 966 extern void kx_free(keyexch */*kx*/);
 967
 968 /* --- @kx_newkeys@ --- *
 969  *
 970  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 971  *
 972  * Returns:     ---
 973  *
 974  * Use:         Informs the key exchange module that its keys may have
 975  *              changed.  If fetching the new keys fails, the peer will be
 976  *              destroyed, we log messages and struggle along with the old
 977  *              keys.
 978  */
 979
 980 extern void kx_newkeys(keyexch */*kx*/);
 981
 982 /* --- @kx_setup@ --- *
 983  *
 984  * Arguments:   @keyexch *kx@ = pointer to key exchange context
 985  *              @peer *p@ = pointer to peer context
 986  *              @keyset **ks@ = pointer to keyset list
 987  *              @unsigned f@ = various useful flags
 988  *
 989  * Returns:     Zero if OK, nonzero if it failed.
 990  *
 991  * Use:         Initializes a key exchange module.  The module currently
 992  *              contains no keys, and will attempt to initiate a key
 993  *              exchange.
 994  */
 995
 996 extern int kx_setup(keyexch */*kx*/, peer */*p*/,
 997                     keyset **/*ks*/, unsigned /*f*/);
 998
 999 /* --- @kx_init@ --- *
1000  *
1001  * Arguments:   ---
1002  *
1003  * Returns:     ---
1004  *
1005  * Use:         Initializes the key-exchange logic.
1006  */
1007
1008 extern void kx_init(void);
1009
1010 /*----- Keysets and symmetric cryptography --------------------------------*/
1011
1012 /* --- @ks_drop@ --- *
1013  *
1014  * Arguments:   @keyset *ks@ = pointer to a keyset
1015  *
1016  * Returns:     ---
1017  *
1018  * Use:         Decrements a keyset's reference counter.  If the counter hits
1019  *              zero, the keyset is freed.
1020  */
1021
1022 extern void ks_drop(keyset */*ks*/);
1023
1024 /* --- @ks_gen@ --- *
1025  *
1026  * Arguments:   @deriveargs *a@ = key derivation parameters (modified)
1027  *              @peer *p@ = pointer to peer information
1028  *
1029  * Returns:     A pointer to the new keyset.
1030  *
1031  * Use:         Derives a new keyset from the given key material.  This will
1032  *              set the @what@, @f@, and @hc@ members in @*a@; other members
1033  *              must be filled in by the caller.
1034  *
1035  *              The new key is marked so that it won't be selected for output
1036  *              by @ksl_encrypt@.  You can still encrypt data with it by
1037  *              calling @ks_encrypt@ directly.
1038  */
1039
1040 extern keyset *ks_gen(deriveargs */*a*/, peer */*p*/);
1041
1042 /* --- @ks_activate@ --- *
1043  *
1044  * Arguments:   @keyset *ks@ = pointer to a keyset
1045  *
1046  * Returns:     ---
1047  *
1048  * Use:         Activates a keyset, so that it can be used for encrypting
1049  *              outgoing messages.
1050  */
1051
1052 extern void ks_activate(keyset */*ks*/);
1053
1054 /* --- @ks_encrypt@ --- *
1055  *
1056  * Arguments:   @keyset *ks@ = pointer to a keyset
1057  *              @unsigned ty@ = message type
1058  *              @buf *b@ = pointer to input buffer
1059  *              @buf *bb@ = pointer to output buffer
1060  *
1061  * Returns:     Zero if successful; @KSERR_REGEN@ if we should negotiate a
1062  *              new key; @KSERR_NOKEYS@ if the key is not usable.  Also
1063  *              returns zero if there was insufficient buffer (but the output
1064  *              buffer is broken in this case).
1065  *
1066  * Use:         Encrypts a block of data using the key.  Note that the `key
1067  *              ought to be replaced' notification is only ever given once
1068  *              for each key.  Also note that this call forces a keyset to be
1069  *              used even if it's marked as not for data output.
1070  *
1071  *              The encryption transform is permitted to corrupt @buf_u@ for
1072  *              its own purposes.  Neither the source nor destination should
1073  *              be within @buf_u@; and callers mustn't expect anything stored
1074  *              in @buf_u@ to still
1075  */
1076
1077 extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
1078                       buf */*b*/, buf */*bb*/);
1079
1080 /* --- @ks_decrypt@ --- *
1081  *
1082  * Arguments:   @keyset *ks@ = pointer to a keyset
1083  *              @unsigned ty@ = expected type code
1084  *              @buf *b@ = pointer to an input buffer
1085  *              @buf *bb@ = pointer to an output buffer
1086  *
1087  * Returns:     Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
1088  *              zero if there was insufficient buffer (but the output buffer
1089  *              is broken in this case).
1090  *
1091  * Use:         Attempts to decrypt a message using a given key.  Note that
1092  *              requesting decryption with a key directly won't clear a
1093  *              marking that it's not for encryption.
1094  *
1095  *              The decryption transform is permitted to corrupt @buf_u@ for
1096  *              its own purposes.  Neither the source nor destination should
1097  *              be within @buf_u@; and callers mustn't expect anything stored
1098  *              in @buf_u@ to still
1099  */
1100
1101 extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
1102                       buf */*b*/, buf */*bb*/);
1103
1104 /* --- @ksl_free@ --- *
1105  *
1106  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
1107  *
1108  * Returns:     ---
1109  *
1110  * Use:         Frees (releases references to) all of the keys in a keyset.
1111  */
1112
1113 extern void ksl_free(keyset **/*ksroot*/);
1114
1115 /* --- @ksl_link@ --- *
1116  *
1117  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
1118  *              @keyset *ks@ = pointer to a keyset
1119  *
1120  * Returns:     ---
1121  *
1122  * Use:         Links a keyset into a list.  A keyset can only be on one list
1123  *              at a time.  Bad things happen otherwise.
1124  */
1125
1126 extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
1127
1128 /* --- @ksl_prune@ --- *
1129  *
1130  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
1131  *
1132  * Returns:     ---
1133  *
1134  * Use:         Prunes the keyset list by removing keys which mustn't be used
1135  *              any more.
1136  */
1137
1138 extern void ksl_prune(keyset **/*ksroot*/);
1139
1140 /* --- @ksl_encrypt@ --- *
1141  *
1142  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
1143  *              @unsigned ty@ = message type
1144  *              @buf *b@ = pointer to input buffer
1145  *              @buf *bb@ = pointer to output buffer
1146  *
1147  * Returns:     Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
1148  *              new key; @KSERR_NOKEYS@ if there are no suitable keys
1149  *              available.  Also returns zero if there was insufficient
1150  *              buffer space (but the output buffer is broken in this case).
1151  *
1152  * Use:         Encrypts a packet.
1153  */
1154
1155 extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
1156                        buf */*b*/, buf */*bb*/);
1157
1158 /* --- @ksl_decrypt@ --- *
1159  *
1160  * Arguments:   @keyset **ksroot@ = pointer to keyset list head
1161  *              @unsigned ty@ = expected type code
1162  *              @buf *b@ = pointer to input buffer
1163  *              @buf *bb@ = pointer to output buffer
1164  *
1165  * Returns:     Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
1166  *              zero if there was insufficient buffer (but the output buffer
1167  *              is broken in this case).
1168  *
1169  * Use:         Decrypts a packet.
1170  */
1171
1172 extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
1173                        buf */*b*/, buf */*bb*/);
1174
1175 /*----- Challenges --------------------------------------------------------*/
1176
1177 /* --- @c_new@ --- *
1178  *
1179  * Arguments:   @const void *m@ = pointer to associated message, or null
1180  *              @size_t msz@ = length of associated message
1181  *              @buf *b@ = where to put the challenge
1182  *
1183  * Returns:     Zero if OK, nonzero on error.
1184  *
1185  * Use:         Issues a new challenge.
1186  */
1187
1188 extern int c_new(const void */*m*/, size_t /*msz*/, buf */*b*/);
1189
1190 /* --- @c_check@ --- *
1191  *
1192  * Arguments:   @const void *m@ = pointer to associated message, or null
1193  *              @size_t msz@ = length of associated message
1194  *              @buf *b@ = where to find the challenge
1195  *
1196  * Returns:     Zero if OK, nonzero if it didn't work.
1197  *
1198  * Use:         Checks a challenge.  On failure, the buffer is broken.
1199  */
1200
1201 extern int c_check(const void */*m*/, size_t /*msz*/, buf */*b*/);
1202
1203 /*----- Administration interface ------------------------------------------*/
1204
1205 #define A_END ((char *)0)
1206
1207 /* --- @a_vformat@ --- *
1208  *
1209  * Arguments:   @dstr *d@ = where to leave the formatted message
1210  *              @const char *fmt@ = pointer to format string
1211  *              @va_list *ap@ = arguments in list
1212  *
1213  * Returns:     ---
1214  *
1215  * Use:         Main message token formatting driver.  The arguments are
1216  *              interleaved formatting tokens and their parameters, finally
1217  *              terminated by an entry @A_END@.
1218  *
1219  *              Tokens recognized:
1220  *
1221  *                * "*..." ... -- pretokenized @dstr_putf@-like string
1222  *
1223  *                * "?ADDR" SOCKADDR -- a socket address, to be converted
1224  *
1225  *                * "?B64" BUFFER SIZE -- binary data to be base64-encoded
1226  *
1227  *                * "?TOKENS" VECTOR -- null-terminated vector of tokens
1228  *
1229  *                * "?PEER" PEER -- peer's name
1230  *
1231  *                * "?ERRNO" ERRNO -- system error code
1232  *
1233  *                * "[!]..." ... -- @dstr_putf@-like string as single token
1234  */
1235
1236 extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list */*ap*/);
1237
1238 /* --- @a_format@ --- *
1239  *
1240  * Arguments:   @dstr *d@ = where to leave the formatted message
1241  *              @const char *fmt@ = pointer to format string
1242  *
1243  * Returns:     ---
1244  *
1245  * Use:         Writes a tokenized message into a string, for later
1246  *              presentation.
1247  */
1248
1249 extern void EXECL_LIKE(0) a_format(dstr */*d*/, const char */*fmt*/, ...);
1250
1251 /* --- @a_info@ --- *
1252  *
1253  * Arguments:   @admin *a@ = connection
1254  *              @const char *fmt@ = format string
1255  *              @...@ = other arguments
1256  *
1257  * Returns:     ---
1258  *
1259  * Use:         Report information to an admin client.
1260  */
1261
1262 extern void EXECL_LIKE(0) a_info(admin */*a*/, const char */*fmt*/, ...);
1263
1264 /* --- @a_warn@ --- *
1265  *
1266  * Arguments:   @const char *fmt@ = pointer to format string
1267  *              @...@ = other arguments
1268  *
1269  * Returns:     ---
1270  *
1271  * Use:         Informs all admin connections of a warning.
1272  */
1273
1274 extern void EXECL_LIKE(0) a_warn(const char */*fmt*/, ...);
1275
1276 /* --- @a_notify@ --- *
1277  *
1278  * Arguments:   @const char *fmt@ = pointer to format string
1279  *              @...@ = other arguments
1280  *
1281  * Returns:     ---
1282  *
1283  * Use:         Sends a notification to interested admin connections.
1284  */
1285
1286 extern void EXECL_LIKE(0) a_notify(const char */*fmt*/, ...);
1287
1288 /* --- @a_create@ --- *
1289  *
1290  * Arguments:   @int fd_in, fd_out@ = file descriptors to use
1291  *              @unsigned f@ = initial flags to set
1292  *
1293  * Returns:     ---
1294  *
1295  * Use:         Creates a new admin connection.
1296  */
1297
1298 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
1299
1300 /* --- @a_quit@ --- *
1301  *
1302  * Arguments:   ---
1303  *
1304  * Returns:     ---
1305  *
1306  * Use:         Shuts things down nicely.
1307  */
1308
1309 extern void a_quit(void);
1310
1311 /* --- @a_preselect@ --- *
1312  *
1313  * Arguments:   ---
1314  *
1315  * Returns:     ---
1316  *
1317  * Use:         Informs the admin module that we're about to select again,
1318  *              and that it should do cleanup things it has delayed until a
1319  *              `safe' time.
1320  */
1321
1322 extern void a_preselect(void);
1323
1324 /* --- @a_daemon@ --- *
1325  *
1326  * Arguments:   ---
1327  *
1328  * Returns:     ---
1329  *
1330  * Use:         Informs the admin module that it's a daemon.
1331  */
1332
1333 extern void a_daemon(void);
1334
1335 /* --- @a_init@ --- *
1336  *
1337  * Arguments:   @const char *sock@ = socket name to create
1338  *              @uid_t u@ = user to own the socket
1339  *              @gid_t g@ = group to own the socket
1340  *              @mode_t m@ = permissions to set on the socket
1341  *
1342  * Returns:     ---
1343  *
1344  * Use:         Creates the admin listening socket.
1345  */
1346
1347 extern void a_init(const char */*sock*/,
1348                    uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
1349
1350 /*----- Mapping with addresses as keys ------------------------------------*/
1351
1352 /* --- @am_create@ --- *
1353  *
1354  * Arguments:   @addrmap *m@ = pointer to map
1355  *
1356  * Returns:     ---
1357  *
1358  * Use:         Create an address map, properly set up.
1359  */
1360
1361 extern void am_create(addrmap */*m*/);
1362
1363 /* --- @am_destroy@ --- *
1364  *
1365  * Arguments:   @addrmap *m@ = pointer to map
1366  *
1367  * Returns:     ---
1368  *
1369  * Use:         Destroy an address map, throwing away all the entries.
1370  */
1371
1372 extern void am_destroy(addrmap */*m*/);
1373
1374 /* --- @am_find@ --- *
1375  *
1376  * Arguments:   @addrmap *m@ = pointer to map
1377  *              @const addr *a@ = address to look up
1378  *              @size_t sz@ = size of block to allocate
1379  *              @unsigned *f@ = where to store flags
1380  *
1381  * Returns:     Pointer to found item, or null.
1382  *
1383  * Use:         Finds a record with the given IP address, set @*f@ nonzero
1384  *              and returns it.  If @sz@ is zero, and no match was found,
1385  *              return null; otherwise allocate a new block of @sz@ bytes,
1386  *              clear @*f@ to zero and return the block pointer.
1387  */
1388
1389 extern void *am_find(addrmap */*m*/, const addr */*a*/,
1390                      size_t /*sz*/, unsigned */*f*/);
1391
1392 /* --- @am_remove@ --- *
1393  *
1394  * Arguments:   @addrmap *m@ = pointer to map
1395  *              @void *i@ = pointer to the item
1396  *
1397  * Returns:     ---
1398  *
1399  * Use:         Removes an item from the map.
1400  */
1401
1402 extern void am_remove(addrmap */*m*/, void */*i*/);
1403
1404 /*----- Privilege separation ----------------------------------------------*/
1405
1406 /* --- @ps_trace@ --- *
1407  *
1408  * Arguments:   @unsigned mask@ = trace mask to check
1409  *              @const char *fmt@ = message format
1410  *              @...@ = values for placeholders
1411  *
1412  * Returns:     ---
1413  *
1414  * Use:         Writes a trace message.
1415  */
1416
1417 T( extern void PRINTF_LIKE(2, 3)
1418      ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); )
1419
1420 /* --- @ps_warn@ --- *
1421  *
1422  * Arguments:   @const char *fmt@ = message format
1423  *              @...@ = values for placeholders
1424  *
1425  * Returns:     ---
1426  *
1427  * Use:         Writes a warning message.
1428  */
1429
1430 extern void PRINTF_LIKE(1, 2) ps_warn(const char */*fmt*/, ...);
1431
1432 /* --- @ps_tunfd@ --- *
1433  *
1434  * Arguments:   @const tunnel_ops *tops@ = pointer to tunnel operations
1435  *              @char **ifn@ = where to put the interface name
1436  *
1437  * Returns:     The file descriptor, or @-1@ on error.
1438  *
1439  * Use:         Fetches a file descriptor for a tunnel driver.
1440  */
1441
1442 extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/);
1443
1444 /* --- @ps_split@ --- *
1445  *
1446  * Arguments:   @int detachp@ = whether to detach the child from its terminal
1447  *
1448  * Returns:     ---
1449  *
1450  * Use:         Separates off the privileged tunnel-opening service from the
1451  *              rest of the server.
1452  */
1453
1454 extern void ps_split(int /*detachp*/);
1455
1456 /* --- @ps_quit@ --- *
1457  *
1458  * Arguments:   ---
1459  *
1460  * Returns:     ---
1461  *
1462  * Use:         Detaches from the helper process.
1463  */
1464
1465 extern void ps_quit(void);
1466
1467 /*----- Peer management ---------------------------------------------------*/
1468
1469 /* --- @p_updateaddr@ --- *
1470  *
1471  * Arguments:   @peer *p@ = pointer to peer block
1472  *              @const addr *a@ = address to associate with this peer
1473  *
1474  * Returns:     Zero if the address was changed; @+1@ if it was already
1475  *              right.
1476  *
1477  * Use:         Updates our idea of @p@'s address.
1478  */
1479
1480 extern int p_updateaddr(peer */*p*/, const addr */*a*/);
1481
1482 /* --- @p_txstart@ --- *
1483  *
1484  * Arguments:   @peer *p@ = pointer to peer block
1485  *              @unsigned msg@ = message type code
1486  *
1487  * Returns:     A pointer to a buffer to write to.
1488  *
1489  * Use:         Starts sending to a peer.  Only one send can happen at a
1490  *              time.
1491  */
1492
1493 extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
1494
1495 /* --- @p_txaddr@ --- *
1496  *
1497  * Arguments:   @const addr *a@ = recipient address
1498  *              @const void *p@ = pointer to packet to send
1499  *              @size_t sz@ = length of packet
1500  *
1501  * Returns:     Zero if successful, nonzero on error.
1502  *
1503  * Use:         Sends a packet to an address which (possibly) isn't a current
1504  *              peer.
1505  */
1506
1507 extern int p_txaddr(const addr */*a*/, const void */*p*/, size_t /*sz*/);
1508
1509 /* --- @p_txend@ --- *
1510  *
1511  * Arguments:   @peer *p@ = pointer to peer block
1512  *
1513  * Returns:     ---
1514  *
1515  * Use:         Sends a packet to the peer.
1516  */
1517
1518 extern void p_txend(peer */*p*/);
1519
1520 /* --- @p_pingsend@ --- *
1521  *
1522  * Arguments:   @peer *p@ = destination peer
1523  *              @ping *pg@ = structure to fill in
1524  *              @unsigned type@ = message type
1525  *              @unsigned long timeout@ = how long to wait before giving up
1526  *              @void (*func)(int, void *)@ = callback function
1527  *              @void *arg@ = argument for callback
1528  *
1529  * Returns:     Zero if successful, nonzero if it failed.
1530  *
1531  * Use:         Sends a ping to a peer.  Call @func@ with a nonzero argument
1532  *              if we get an answer within the timeout, or zero if no answer.
1533  */
1534
1535 extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
1536                       unsigned long /*timeout*/,
1537                       void (*/*func*/)(int, void *), void */*arg*/);
1538
1539 /* --- @p_pingdone@ --- *
1540  *
1541  * Arguments:   @ping *p@ = ping structure
1542  *              @int rc@ = return code to pass on
1543  *
1544  * Returns:     ---
1545  *
1546  * Use:         Disposes of a ping structure, maybe sending a notification.
1547  */
1548
1549 extern void p_pingdone(ping */*p*/, int /*rc*/);
1550
1551 /* --- @p_greet@ --- *
1552  *
1553  * Arguments:   @peer *p@ = peer to send to
1554  *              @const void *c@ = pointer to challenge
1555  *              @size_t sz@ = size of challenge
1556  *
1557  * Returns:     ---
1558  *
1559  * Use:         Sends a greeting packet.
1560  */
1561
1562 extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
1563
1564 /* --- @p_tun@ --- *
1565  *
1566  * Arguments:   @peer *p@ = pointer to peer block
1567  *              @buf *b@ = buffer containing incoming packet
1568  *
1569  * Returns:     ---
1570  *
1571  * Use:         Handles a packet which needs to be sent to a peer.
1572  */
1573
1574 extern void p_tun(peer */*p*/, buf */*b*/);
1575
1576 /* --- @p_keyreload@ --- *
1577  *
1578  * Arguments:   ---
1579  *
1580  * Returns:     ---
1581  *
1582  * Use:         Forces a check of the daemon's keyring files.
1583  */
1584
1585 extern void p_keyreload(void);
1586
1587 /* --- @p_interval@ --- *
1588  *
1589  * Arguments:   ---
1590  *
1591  * Returns:     ---
1592  *
1593  * Use:         Called periodically to do tidying.
1594  */
1595
1596 extern void p_interval(void);
1597
1598 /* --- @p_stats@ --- *
1599  *
1600  * Arguments:   @peer *p@ = pointer to a peer block
1601  *
1602  * Returns:     A pointer to the peer's statistics.
1603  */
1604
1605 extern stats *p_stats(peer */*p*/);
1606
1607 /* --- @p_ifname@ --- *
1608  *
1609  * Arguments:   @peer *p@ = pointer to a peer block
1610  *
1611  * Returns:     A pointer to the peer's interface name.
1612  */
1613
1614 extern const char *p_ifname(peer */*p*/);
1615
1616 /* --- @p_setifname@ --- *
1617  *
1618  * Arguments:   @peer *p@ = pointer to a peer block
1619  *              @const char *name@ = pointer to the new name
1620  *
1621  * Returns:     ---
1622  *
1623  * Use:         Changes the name held for a peer's interface.
1624  */
1625
1626 extern void p_setifname(peer */*p*/, const char */*name*/);
1627
1628 /* --- @p_addr@ --- *
1629  *
1630  * Arguments:   @peer *p@ = pointer to a peer block
1631  *
1632  * Returns:     A pointer to the peer's address.
1633  */
1634
1635 extern const addr *p_addr(peer */*p*/);
1636
1637 /* --- @p_init@ --- *
1638  *
1639  * Arguments:   @struct addrinfo *ailist@ = addresses to bind to
1640  *
1641  * Returns:     ---
1642  *
1643  * Use:         Initializes the peer system; creates the socket.
1644  */
1645
1646 extern void p_init(struct addrinfo */*ailist*/);
1647
1648 /* --- @p_port@ --- *
1649  *
1650  * Arguments:   @int i@ = address family index to retrieve
1651  *
1652  * Returns:     Port number used for socket.
1653  */
1654
1655 extern unsigned p_port(int /*i*/);
1656
1657 /* --- @p_create@ --- *
1658  *
1659  * Arguments:   @peerspec *spec@ = information about this peer
1660  *
1661  * Returns:     Pointer to the peer block, or null if it failed.
1662  *
1663  * Use:         Creates a new named peer block.  No peer is actually attached
1664  *              by this point.
1665  */
1666
1667 extern peer *p_create(peerspec */*spec*/);
1668
1669 /* --- @p_name@ --- *
1670  *
1671  * Arguments:   @peer *p@ = pointer to a peer block
1672  *
1673  * Returns:     A pointer to the peer's name.
1674  *
1675  * Use:         Equivalent to @p_spec(p)->name@.
1676  */
1677
1678 extern const char *p_name(peer */*p*/);
1679
1680 /* --- @p_tag@ --- *
1681  *
1682  * Arguments:   @peer *p@ = pointer to a peer block
1683  *
1684  * Returns:     A pointer to the peer's public key tag.
1685  */
1686
1687 extern const char *p_tag(peer */*p*/);
1688
1689 /* --- @p_privtag@ --- *
1690  *
1691  * Arguments:   @peer *p@ = pointer to a peer block
1692  *
1693  * Returns:     A pointer to the peer's private key tag.
1694  */
1695
1696 extern const char *p_privtag(peer */*p*/);
1697
1698 /* --- @p_spec@ --- *
1699  *
1700  * Arguments:   @peer *p@ = pointer to a peer block
1701  *
1702  * Returns:     Pointer to the peer's specification
1703  */
1704
1705 extern const peerspec *p_spec(peer */*p*/);
1706
1707 /* --- @p_findbyaddr@ --- *
1708  *
1709  * Arguments:   @const addr *a@ = address to look up
1710  *
1711  * Returns:     Pointer to the peer block, or null if not found.
1712  *
1713  * Use:         Finds a peer by address.
1714  */
1715
1716 extern peer *p_findbyaddr(const addr */*a*/);
1717
1718 /* --- @p_find@ --- *
1719  *
1720  * Arguments:   @const char *name@ = name to look up
1721  *
1722  * Returns:     Pointer to the peer block, or null if not found.
1723  *
1724  * Use:         Finds a peer by name.
1725  */
1726
1727 extern peer *p_find(const char */*name*/);
1728
1729 /* --- @p_destroy@ --- *
1730  *
1731  * Arguments:   @peer *p@ = pointer to a peer
1732  *              @int bye@ = say goodbye to the peer?
1733  *
1734  * Returns:     ---
1735  *
1736  * Use:         Destroys a peer.
1737  */
1738
1739 extern void p_destroy(peer */*p*/, int /*bye*/);
1740
1741 /* --- @FOREACH_PEER@ --- *
1742  *
1743  * Arguments:   @p@ = name to bind to each peer
1744  *              @stuff@ = thing to do for each item
1745  *
1746  * Use:         Does something for each current peer.
1747  */
1748
1749 #define FOREACH_PEER(p, stuff) do {                                     \
1750   peer_iter i_;                                                         \
1751   peer *p;                                                              \
1752   for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff                   \
1753 } while (0)
1754
1755 /* --- @p_mkiter@ --- *
1756  *
1757  * Arguments:   @peer_iter *i@ = pointer to an iterator
1758  *
1759  * Returns:     ---
1760  *
1761  * Use:         Initializes the iterator.
1762  */
1763
1764 extern void p_mkiter(peer_iter */*i*/);
1765
1766 /* --- @p_next@ --- *
1767  *
1768  * Arguments:   @peer_iter *i@ = pointer to an iterator
1769  *
1770  * Returns:     Next peer, or null if at the end.
1771  *
1772  * Use:         Returns the next peer.
1773  */
1774
1775 extern peer *p_next(peer_iter */*i*/);
1776
1777 /*----- Tunnel drivers ----------------------------------------------------*/
1778
1779 #ifdef TUN_LINUX
1780   extern const tunnel_ops tun_linux;
1781 #endif
1782
1783 #ifdef TUN_UNET
1784   extern const tunnel_ops tun_unet;
1785 #endif
1786
1787 #ifdef TUN_BSD
1788   extern const tunnel_ops tun_bsd;
1789 #endif
1790
1791 extern const tunnel_ops tun_slip;
1792
1793 /*----- Other handy utilities ---------------------------------------------*/
1794
1795 /* --- @timestr@ --- *
1796  *
1797  * Arguments:   @time_t t@ = a time to convert
1798  *
1799  * Returns:     A pointer to a textual representation of the time.
1800  *
1801  * Use:         Converts a time to a textual representation.  Corrupts
1802  *              @buf_u@.
1803  */
1804
1805 extern const char *timestr(time_t /*t*/);
1806
1807 /* --- @mystrieq@ --- *
1808  *
1809  * Arguments:   @const char *x, *y@ = two strings
1810  *
1811  * Returns:     True if @x@ and @y are equal, up to case.
1812  */
1813
1814 extern int mystrieq(const char */*x*/, const char */*y*/);
1815
1816 /* --- @afix@ --- *
1817  *
1818  * Arguments:   @int af@ = an address family code
1819  *
1820  * Returns:     The index of the address family's record in @aftab@, or @-1@.
1821  */
1822
1823 extern int afix(int af);
1824
1825 /* --- @addrsz@ --- *
1826  *
1827  * Arguments:   @const addr *a@ = a network address
1828  *
1829  * Returns:     The size of the address, for passing into the sockets API.
1830  */
1831
1832 extern socklen_t addrsz(const addr */*a*/);
1833
1834 /* --- @getport@, @setport@ --- *
1835  *
1836  * Arguments:   @addr *a@ = a network address
1837  *              @unsigned port@ = port number to set
1838  *
1839  * Returns:     ---
1840  *
1841  * Use:         Retrieves or sets the port number in an address structure.
1842  */
1843
1844 extern unsigned getport(addr */*a*/);
1845 extern void setport(addr */*a*/, unsigned /*port*/);
1846
1847 /* --- @seq_reset@ --- *
1848  *
1849  * Arguments:   @seqwin *s@ = sequence-checking window
1850  *
1851  * Returns:     ---
1852  *
1853  * Use:         Resets a sequence number window.
1854  */
1855
1856 extern void seq_reset(seqwin */*s*/);
1857
1858 /* --- @seq_check@ --- *
1859  *
1860  * Arguments:   @seqwin *s@ = sequence-checking window
1861  *              @uint32 q@ = sequence number to check
1862  *              @const char *service@ = service to report message from
1863  *
1864  * Returns:     A @SEQ_@ code.
1865  *
1866  * Use:         Checks a sequence number against the window, updating things
1867  *              as necessary.
1868  */
1869
1870 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
1871
1872 typedef struct ratelim {
1873   unsigned n, max, persec;
1874   struct timeval when;
1875 } ratelim;
1876
1877 /* --- @ratelim_init@ --- *
1878  *
1879  * Arguments:   @ratelim *r@ = rate-limiting state to fill in
1880  *              @unsigned persec@ = credit to accumulate per second
1881  *              @unsigned max@ = maximum credit to retain
1882  *
1883  * Returns:     ---
1884  *
1885  * Use:         Initialize a rate-limiting state.
1886  */
1887
1888 extern void ratelim_init(ratelim */*r*/,
1889                          unsigned /*persec*/, unsigned /*max*/);
1890
1891 /* --- @ratelim_withdraw@ --- *
1892  *
1893  * Arguments:   @ratelim *r@ = rate-limiting state
1894  *              @unsigned n@ = credit to withdraw
1895  *
1896  * Returns:     Zero if successful; @-1@ if there is unsufficient credit
1897  *
1898  * Use:         Updates the state with any accumulated credit.  Then, if
1899  *              there there are more than @n@ credits available, withdraw @n@
1900  *              and return successfully; otherwise, report failure.
1901  */
1902
1903 extern int ratelim_withdraw(ratelim */*r*/, unsigned /*n*/);
1904
1905 /* --- @ies_encrypt@ --- *
1906  *
1907  * Arguments:   @kdata *kpub@ = recipient's public key
1908  *              @unsigned ty@ = message type octet
1909  *              @buf *b@ = input message buffer
1910  *              @buf *bb@ = output buffer for the ciphertext
1911  *
1912  * Returns:     On error, returns a @KSERR_...@ code or breaks the buffer;
1913  *              on success, returns zero and the buffer is good.
1914  *
1915  * Use:         Encrypts a message for a recipient, given their public key.
1916  *              This does not (by itself) provide forward secrecy or sender
1917  *              authenticity.  The ciphertext is self-delimiting (unlike
1918  *              @ks_encrypt@).
1919  */
1920
1921 extern int ies_encrypt(kdata */*kpub*/, unsigned /*ty*/,
1922                        buf */*b*/, buf */*bb*/);
1923
1924 /* --- @ies_decrypt@ --- *
1925  *
1926  * Arguments:   @kdata *kpub@ = private key key
1927  *              @unsigned ty@ = message type octet
1928  *              @buf *b@ = input ciphertext buffer
1929  *              @buf *bb@ = output buffer for the message
1930  *
1931  * Returns:     On error, returns a @KSERR_...@ code; on success, returns
1932  *              zero and the buffer is good.
1933  *
1934  * Use:         Decrypts a message encrypted using @ies_encrypt@, given our
1935  *              private key.
1936  */
1937
1938 extern int ies_decrypt(kdata */*kpriv*/, unsigned /*ty*/,
1939                        buf */*b*/, buf */*bb*/);
1940
1941 /*----- That's all, folks -------------------------------------------------*/
1942
1943 #ifdef __cplusplus
1944   }
1945 #endif
1946
1947 #endif