3 * Main header file for TrIPE
5 * (c) 2001 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Trivial IP Encryption (TrIPE).
12 * TrIPE is free software: you can redistribute it and/or modify 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.
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
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/>.
33 /*----- Header files ------------------------------------------------------*/
49 #include <sys/types.h>
56 #include <sys/socket.h>
58 #include <netinet/in.h>
59 #include <arpa/inet.h>
65 #include <mLib/alloc.h>
66 #include <mLib/arena.h>
67 #include <mLib/base64.h>
68 #include <mLib/bres.h>
69 #include <mLib/codec.h>
70 #include <mLib/daemonize.h>
71 #include <mLib/dstr.h>
73 #include <mLib/fdflags.h>
74 #include <mLib/fdpass.h>
75 #include <mLib/fwatch.h>
76 #include <mLib/hash.h>
77 #include <mLib/macros.h>
78 #include <mLib/mdup.h>
79 #include <mLib/mdwopt.h>
80 #include <mLib/quis.h>
81 #include <mLib/report.h>
83 #include <mLib/selbuf.h>
87 #include <mLib/trace.h>
89 #include <mLib/versioncmp.h>
91 #include <catacomb/buf.h>
92 #include <catacomb/ct.h>
94 #include <catacomb/chacha.h>
95 #include <catacomb/gcipher.h>
96 #include <catacomb/gmac.h>
97 #include <catacomb/grand.h>
98 #include <catacomb/key.h>
99 #include <catacomb/paranoia.h>
100 #include <catacomb/poly1305.h>
101 #include <catacomb/salsa20.h>
103 #include <catacomb/noise.h>
104 #include <catacomb/rand.h>
106 #include <catacomb/mp.h>
107 #include <catacomb/mpmont.h>
108 #include <catacomb/mprand.h>
109 #include <catacomb/dh.h>
110 #include <catacomb/ec.h>
111 #include <catacomb/ec-raw.h>
112 #include <catacomb/ec-keys.h>
113 #include <catacomb/x25519.h>
114 #include <catacomb/x448.h>
117 #include "protocol.h"
123 /*----- Magic numbers -----------------------------------------------------*/
125 /* --- Trace flags --- */
133 #define T_KEYEXCH 64u
134 #define T_KEYMGMT 128u
136 /* T_PRIVSEP in priv.h */
142 #define SEC(n) (n##u)
143 #define MIN(n) (n##u * 60u)
144 #define F_2P32 (65536.0*65536.0)
145 #define MEG(n) (n##ul * 1024ul * 1024ul)
147 /* --- Timing parameters --- */
149 #define T_EXP MIN(60) /* Expiry time for a key */
150 #define T_REGEN MIN(40) /* Regeneration time for a key */
152 #define T_VALID SEC(20) /* Challenge validity period */
153 #define T_RETRYMIN SEC(2) /* Minimum retry interval */
154 #define T_RETRYMAX MIN(5) /* Maximum retry interval */
155 #define T_RETRYGROW (5.0/4.0) /* Retry interval growth factor */
157 #define T_WOBBLE (1.0/3.0) /* Relative timer randomness */
159 /* --- Other things --- */
161 #define PKBUFSZ 65536
163 /*----- Cipher selections -------------------------------------------------*/
165 typedef struct keyset keyset;
166 typedef struct algswitch algswitch;
167 typedef struct kdata kdata;
168 typedef struct admin admin;
170 typedef struct dhgrp {
171 const struct dhops *ops;
175 typedef struct dhsc dhsc;
176 typedef struct dhge dhge;
179 DHFMT_STD, /* Fixed-width format, suitable for encryption */
180 DHFMT_HASH, /* Deterministic format, suitable for hashing */
181 DHFMT_VAR /* Variable-width-format, mostly a bad idea */
184 typedef struct deriveargs {
185 const char *what; /* Operation name (hashed) */
186 unsigned f; /* Flags */
187 #define DF_IN 1u /* Make incoming key */
188 #define DF_OUT 2u /* Make outgoing key */
189 const gchash *hc; /* Hash class */
190 const octet *k; /* Pointer to contributions */
191 size_t x, y, z; /* Markers in contributions */
194 typedef struct bulkalgs {
195 const struct bulkops *ops;
198 typedef struct bulkctx {
199 const struct bulkops *ops;
202 typedef struct bulkchal {
203 const struct bulkops *ops;
207 typedef struct dhops {
210 int (*ldpriv)(key_file */*kf*/, key */*k*/, key_data */*d*/,
211 kdata */*kd*/, dstr */*t*/, dstr */*e*/);
212 /* Load a private key from @d@, storing the data in @kd@. The key's
213 * file and key object are in @kf@ and @k@, mostly in case its
214 * attributes are interesting; the key tag is in @t@; errors are
215 * reported by writing tokens to @e@ and returning nonzero.
218 int (*ldpub)(key_file */*kf*/, key */*k*/, key_data */*d*/,
219 kdata */*kd*/, dstr */*t*/, dstr */*e*/);
220 /* Load a public key from @d@, storing the data in @kd@. The key's
221 * file and key object are in @kf@ and @k@, mostly in case its
222 * attributes are interesting; the key tag is in @t@; errors are
223 * reported by writing tokens to @e@ and returning nonzero.
226 const char *(*checkgrp)(const dhgrp */*g*/);
227 /* Check that the group is valid; return null on success, or an error
231 void (*grpinfo)(const dhgrp */*g*/, admin */*a*/);
232 /* Report on the group to an admin client. */
234 T( void (*tracegrp)(const dhgrp */*g*/); )
235 /* Trace a description of the group. */
237 int (*samegrpp)(const dhgrp */*g*/, const dhgrp */*gg*/);
238 /* Return nonzero if the two group objects represent the same
242 void (*freegrp)(dhgrp */*g*/);
243 /* Free a group and the resources it holds. */
245 dhsc *(*ldsc)(const dhgrp */*g*/, const void */*p*/, size_t /*sz*/);
246 /* Load a scalar from @p@, @sz@ and return it. Return null on
250 int (*stsc)(const dhgrp */*g*/,
251 void */*p*/, size_t /*sz*/, const dhsc */*x*/);
252 /* Store a scalar at @p@, @sz@. Return nonzero on error. */
254 dhsc *(*randsc)(const dhgrp */*g*/);
255 /* Return a random scalar. */
257 T( const char *(*scstr)(const dhgrp */*g*/, const dhsc */*x*/); )
258 /* Return a human-readable representation of @x@; @buf_t@ may be used
262 void (*freesc)(const dhgrp */*g*/, dhsc */*x*/);
263 /* Free a scalar and the resources it holds. */
265 dhge *(*ldge)(const dhgrp */*g*/, buf */*b*/, int /*fmt*/);
266 /* Load a group element from @b@, encoded using format @fmt@. Return
270 int (*stge)(const dhgrp */*g*/, buf */*b*/,
271 const dhge */*Y*/, int /*fmt*/);
272 /* Store a group element in @b@, encoded using format @fmt@. Return
276 int (*checkge)(const dhgrp */*h*/, const dhge */*Y*/);
277 /* Check a group element for validity. Return zero if everything
278 * checks out; nonzero on failure.
281 int (*eq)(const dhgrp */*g*/, const dhge */*Y*/, const dhge */*Z*/);
282 /* Return nonzero if @Y@ and @Z@ are equal. */
284 dhge *(*mul)(const dhgrp */*g*/, const dhsc */*x*/, const dhge */*Y*/);
285 /* Multiply a group element by a scalar, resulting in a shared-secret
286 * group element. If @y@ is null, then multiply the well-known
290 T( const char *(*gestr)(const dhgrp */*g*/, const dhge */*Y*/); )
291 /* Return a human-readable representation of @Y@; @buf_t@ may be used
295 void (*freege)(const dhgrp */*g*/, dhge */*Y*/);
296 /* Free a group element and the resources it holds. */
300 typedef struct bulkops {
303 bulkalgs *(*getalgs)(const algswitch */*asw*/, dstr */*e*/,
304 key_file */*kf*/, key */*k*/);
305 /* Determine algorithms to use and return a @bulkalgs@ object
306 * representing the decision. On error, write tokens to @e@ and
310 T( void (*tracealgs)(const bulkalgs */*a*/); )
311 /* Write trace information about the algorithm selection. */
313 int (*checkalgs)(bulkalgs */*a*/, const algswitch */*asw*/, dstr */*e*/);
314 /* Check that the algorithms in @a@ and @asw@ are acceptable. On
315 * error, write tokens to @e@ and return @-1@; otherwise return zero.
318 int (*samealgsp)(const bulkalgs */*a*/, const bulkalgs */*aa*/);
319 /* If @a@ and @aa@ represent the same algorithm selection, return
320 * nonzero; if not, return zero.
323 void (*alginfo)(const bulkalgs */*a*/, admin */*adm*/);
324 /* Report on the algorithm selection to an admin client: call
325 * @a_info@ with appropriate key-value pairs.
328 size_t (*overhead)(const bulkalgs */*a*/);
329 /* Return the per-packet overhead of the bulk transform, in bytes. */
331 size_t (*expsz)(const bulkalgs */*a*/);
332 /* Return the total size limit for the bulk transform, in bytes,
333 * after which the keys must no longer be used.
336 bulkctx *(*genkeys)(const bulkalgs */*a*/, const deriveargs */*a*/);
337 /* Generate session keys and construct and return an appropriate
338 * context for using them. The offsets @a->x@, @a->y@ and @a->z@
339 * separate the key material into three parts. Between @a->k@ and
340 * @a->k + a->x@ is `my' contribution to the key material; between
341 * @a->k + a->x@ and @a->k + a->y@ is `your' contribution; and
342 * between @a->k + a->y@ and @a->k + a->z@ is a shared value we made
343 * together. These are used to construct (up to) two collections of
344 * symmetric keys: one for outgoing messages, the other for incoming
345 * messages. If @a->x == 0@ (or @a->y == a->x@) then my (or your)
346 * contribution is omitted.
349 bulkchal *(*genchal)(const bulkalgs */*a*/);
350 /* Construct and return a challenge issuing and verification
351 * context with a fresh random key.
354 void (*freealgs)(bulkalgs */*a*/);
355 /* Release an algorithm selection object. (Associated bulk
356 * encryption contexts and challenge contexts may still exist and
357 * must remain valid.)
360 int (*encrypt)(bulkctx */*bc*/, unsigned /*ty*/,
361 buf */*b*/, buf */*bb*/, uint32 /*seq*/);
362 /* Encrypt the packet in @b@, with type @ty@ (which doesn't need
363 * encoding separately) and sequence number @seq@ (which must be
364 * recoverable by @decrypt@), and write the result to @bb@. On
365 * error, return a @KSERR_...@ code and/or break the output buffer.
368 int (*decrypt)(bulkctx */*bc*/, unsigned /*ty*/,
369 buf */*b*/, buf */*bb*/, uint32 */*seq*/);
370 /* Decrypt the packet in @b@, with type @ty@, writing the result to
371 * @bb@ and storing the incoming (claimed) sequence number in @seq@.
372 * On error, return a @KSERR_...@ code.
375 void (*freectx)(bulkctx */*a*/);
376 /* Release a bulk encryption context and the resources it holds. */
378 int (*chaltag)(bulkchal */*bc*/, const void */*m*/, size_t /*msz*/,
379 uint32 /*seq*/, void */*t*/);
380 /* Calculate a tag for the challenge in @m@, @msz@, with the sequence
381 * number @seq@, and write it to @t@. Return @-1@ on error, zero on
385 int (*chalvrf)(bulkchal */*bc*/, const void */*m*/, size_t /*msz*/,
386 uint32 /*seq*/, const void */*t*/);
387 /* Check the tag @t@ on @m@, @msz@ and @seq@: return zero if the tag
388 * is OK, nonzero if it's bad.
391 void (*freechal)(bulkchal */*bc*/);
392 /* Release a challenge context and the resources it holds. */
397 const gchash *h; size_t hashsz; /* Hash function */
398 const gccipher *mgf; /* Mask-generation function */
399 bulkalgs *bulk; /* Bulk crypto algorithms */
403 unsigned ref; /* Reference counter */
404 struct knode *kn; /* Pointer to cache entry */
405 uint32 id; /* The underlying key's id */
406 char *tag; /* Full tag name of the key */
407 dhgrp *grp; /* The group we work in */
408 dhsc *k; /* The private key (or null) */
409 dhge *K; /* The public key */
410 time_t t_exp; /* Expiry time of the key */
411 algswitch algs; /* Collection of algorithms */
414 typedef struct knode {
415 sym_base _b; /* Symbol table intrusion */
416 unsigned f; /* Various flags */
417 #define KNF_BROKEN 1u /* Don't use this key any more */
418 struct keyhalf *kh; /* Pointer to the home keyhalf */
419 kdata *kd; /* Pointer to the key data */
422 #define MAXHASHSZ 64 /* Largest possible hash size */
424 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
426 extern const dhops dhtab[];
427 extern const bulkops bulktab[];
429 /*----- Data structures ---------------------------------------------------*/
431 /* --- Socket addresses --- *
433 * A magic union of supported socket addresses.
438 struct sockaddr_in sin;
441 /* --- Mapping keyed on addresses --- */
443 typedef struct addrmap {
448 typedef struct addrmap_base {
453 /* --- Sequence number checking --- */
455 typedef struct seqwin {
456 uint32 seq; /* First acceptable input sequence */
457 uint32 win; /* Window of acceptable numbers */
460 #define SEQ_WINSZ 32 /* Bits in sequence number window */
462 /* --- A symmetric keyset --- *
464 * A keyset contains a set of symmetric keys for encrypting and decrypting
465 * packets. Keysets are stored in a list, sorted in reverse order of
466 * creation, so that the most recent keyset (the one most likely to be used)
469 * Each keyset has a time limit and a data limit. The keyset is destroyed
470 * when either it has existed for too long, or it has been used to encrypt
471 * too much data. New key exchanges are triggered when keys are close to
475 enum { DIR_IN, DIR_OUT, NDIR };
478 struct keyset *next; /* Next active keyset in the list */
479 unsigned ref; /* Reference count for keyset */
480 struct peer *p; /* Pointer to peer structure */
481 time_t t_exp; /* Expiry time for this keyset */
482 unsigned long sz_exp, sz_regen; /* Data limits for the keyset */
483 T( unsigned seq; ) /* Sequence number for tracing */
484 unsigned f; /* Various useful flags */
485 bulkctx *bulk; /* Bulk crypto transform */
486 uint32 oseq; /* Outbound sequence number */
487 seqwin iseq; /* Inbound sequence number */
490 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
491 #define KSF_LINK 2u /* Key is in a linked list */
493 #define KSERR_REGEN -1 /* Regenerate keys */
494 #define KSERR_NOKEYS -2 /* No keys left */
495 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
496 #define KSERR_SEQ -4 /* Incorrect sequence number */
497 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
499 /* --- Key exchange --- *
501 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
502 * Protocol has a number of desirable features (e.g., perfect forward
503 * secrecy, and zero-knowledge authentication) which make it attractive for
504 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
508 typedef struct retry {
509 double t; /* Current retry time */
514 typedef struct kxchal {
515 struct keyexch *kx; /* Pointer back to key exchange */
516 dhge *C; /* Responder's challenge */
517 dhge *R; /* My reply to the challenge */
518 keyset *ks; /* Pointer to temporary keyset */
519 unsigned f; /* Various useful flags */
520 sel_timer t; /* Response timer for challenge */
521 retry rs; /* Retry state */
522 octet hc[MAXHASHSZ]; /* Hash of his challenge */
523 octet ck[MAXHASHSZ]; /* His magical check value */
524 octet hswrq_in[MAXHASHSZ]; /* Inbound switch request message */
525 octet hswok_in[MAXHASHSZ]; /* Inbound switch confirmation */
526 octet hswrq_out[MAXHASHSZ]; /* Outbound switch request message */
527 octet hswok_out[MAXHASHSZ]; /* Outbound switch confirmation */
530 typedef struct keyexch {
531 struct peer *p; /* Pointer back to the peer */
532 kdata *kpriv; /* Private key and related info */
533 kdata *kpub; /* Peer's public key */
534 keyset **ks; /* Peer's list of keysets */
535 unsigned f; /* Various useful flags */
536 unsigned s; /* Current state in exchange */
537 sel_timer t; /* Timer for next exchange */
538 retry rs; /* Retry state */
539 dhsc *a; /* My temporary secret */
540 dhge *C; /* My challenge */
541 dhge *RX; /* The expected response */
542 unsigned nr; /* Number of extant responses */
543 time_t t_valid; /* When this exchange goes bad */
544 octet hc[MAXHASHSZ]; /* Hash of my challenge */
545 kxchal *r[KX_NCHAL]; /* Array of challenges */
548 #define KXF_TIMER 1u /* Waiting for a timer to go off */
549 #define KXF_DEAD 2u /* The key-exchanger isn't up */
550 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
551 #define KXF_CORK 8u /* Don't send anything yet */
554 KXS_DEAD, /* Uninitialized state (magical) */
555 KXS_CHAL, /* Main answer-challenges state */
556 KXS_COMMIT, /* Committed: send switch request */
557 KXS_SWITCH /* Switched: send confirmation */
560 /* --- Tunnel structure --- *
562 * Used to maintain system-specific information about the tunnel interface.
565 typedef struct tunnel tunnel;
568 typedef struct tunnel_ops {
569 const char *name; /* Name of this tunnel driver */
570 unsigned flags; /* Various interesting flags */
571 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
572 void (*init)(void); /* Initializes the system */
573 tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/);
574 /* Initializes a new tunnel */
575 void (*setifname)(tunnel */*t*/, const char */*ifn*/);
576 /* Notifies ifname change */
577 void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
578 void (*destroy)(tunnel */*t*/); /* Destroys a tunnel */
581 #ifndef TUN_INTERNALS
582 struct tunnel { const tunnel_ops *ops; };
585 /* --- Peer statistics --- *
587 * Contains various interesting and not-so-interesting statistics about a
588 * peer. This is updated by various parts of the code. The format of the
589 * structure isn't considered private, and @p_stats@ returns a pointer to the
590 * statistics block for a given peer.
593 typedef struct stats {
594 unsigned long sz_in, sz_out; /* Size of all data in and out */
595 unsigned long sz_kxin, sz_kxout; /* Size of key exchange messages */
596 unsigned long sz_ipin, sz_ipout; /* Size of encapsulated IP packets */
597 time_t t_start, t_last, t_kx; /* Time peer created, last pk, kx */
598 unsigned long n_reject; /* Number of rejected packets */
599 unsigned long n_in, n_out; /* Number of packets in and out */
600 unsigned long n_kxin, n_kxout; /* Number of key exchange packets */
601 unsigned long n_ipin, n_ipout; /* Number of encrypted packets */
604 /* --- Peer structure --- *
606 * The main structure which glues everything else together.
609 typedef struct peerspec {
610 char *name; /* Peer's name */
611 char *privtag; /* Private key tag */
612 char *tag; /* Public key tag */
613 char *knock; /* Knock string, or null */
614 const tunnel_ops *tops; /* Tunnel operations */
615 unsigned long t_ka; /* Keep alive interval */
616 addr sa; /* Socket address to speak to */
617 unsigned f; /* Flags for the peer */
618 #define PSF_KXMASK 255u /* Key-exchange flags to set */
619 #define PSF_MOBILE 256u /* Address may change rapidly */
622 typedef struct peer_byname {
627 typedef struct peer_byaddr {
632 typedef struct peer {
633 peer_byname *byname; /* Lookup-by-name block */
634 peer_byaddr *byaddr; /* Lookup-by-address block */
635 struct ping *pings; /* Pings we're waiting for */
636 peerspec spec; /* Specifications for this peer */
637 tunnel *t; /* Tunnel for local packets */
638 char *ifname; /* Interface name for tunnel */
639 keyset *ks; /* List head for keysets */
640 buf b; /* Buffer for sending packets */
641 stats st; /* Statistics */
642 keyexch kx; /* Key exchange protocol block */
643 sel_timer tka; /* Timer for keepalives */
646 typedef struct peer_iter { sym_iter i; } peer_iter;
648 typedef struct ping {
649 struct ping *next, *prev; /* Links to next and previous */
650 peer *p; /* Peer so we can free it */
651 unsigned msg; /* Kind of response expected */
652 uint32 id; /* Id so we can recognize response */
653 octet magic[32]; /* Some random data */
654 sel_timer t; /* Timeout for ping */
655 void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
656 void *arg; /* Argument for callback */
667 /* --- Admin structure --- */
669 #define OBUFSZ 16384u
671 typedef struct obuf {
672 struct obuf *next; /* Next buffer in list */
673 char *p_in, *p_out; /* Pointers into the buffer */
674 char buf[OBUFSZ]; /* The actual buffer */
677 typedef struct oqueue {
678 obuf *hd, *tl; /* Head and tail pointers */
683 typedef struct admin_bgop {
684 struct admin_bgop *next, *prev; /* Links to next and previous */
685 struct admin *a; /* Owner job */
686 char *tag; /* Tag string for messages */
687 void (*cancel)(struct admin_bgop *); /* Destructor function */
690 typedef struct admin_resop {
691 admin_bgop bg; /* Background operation header */
692 char *addr; /* Hostname to be resolved */
693 bres_client r; /* Background resolver task */
694 sel_timer t; /* Timer for resolver */
695 addr sa; /* Socket address */
696 size_t sasz; /* Socket address size */
697 void (*func)(struct admin_resop *, int); /* Handler */
700 enum { ARES_OK, ARES_FAIL };
702 typedef struct admin_addop {
703 admin_resop r; /* Name resolution header */
704 peerspec peer; /* Peer pending creation */
707 typedef struct admin_pingop {
708 admin_bgop bg; /* Background operation header */
709 ping ping; /* Ping pending response */
710 struct timeval pingtime; /* Time last ping was sent */
713 typedef struct admin_service {
714 sym_base _b; /* Hash table base structure */
715 char *version; /* The provided version */
716 struct admin *prov; /* Which client provides me */
717 struct admin_service *next, *prev; /* Client's list of services */
720 typedef struct admin_svcop {
721 admin_bgop bg; /* Background operation header */
722 struct admin *prov; /* Client servicing this job */
723 unsigned index; /* This job's index */
724 struct admin_svcop *next, *prev; /* Links for provider's jobs */
727 typedef struct admin_jobentry {
728 unsigned short seq; /* Zero if unused */
730 admin_svcop *op; /* Operation, if slot in use, ... */
731 uint32 next; /* ... or index of next free slot */
735 typedef struct admin_jobtable {
736 uint32 n, sz; /* Used slots and table size */
737 admin_svcop *active; /* List of active jobs */
738 uint32 free; /* Index of first free slot */
739 admin_jobentry *v; /* And the big array of entries */
743 struct admin *next, *prev; /* Links to next and previous */
744 unsigned f; /* Various useful flags */
745 unsigned ref; /* Reference counter */
747 unsigned seq; /* Sequence number for tracing */
749 oqueue out; /* Output buffer list */
750 oqueue delay; /* Delayed output buffer list */
751 admin_bgop *bg; /* Backgrounded operations */
752 admin_service *svcs; /* Which services I provide */
753 admin_jobtable j; /* Table of outstanding jobs */
754 selbuf b; /* Line buffer for commands */
755 sel_file w; /* Selector for write buffering */
758 #define AF_DEAD 1u /* Destroy this admin block */
759 #define AF_CLOSE 2u /* Client closed connection */
760 #define AF_NOTE 4u /* Catch notifications */
761 #define AF_WARN 8u /* Catch warning messages */
763 # define AF_TRACE 16u /* Catch tracing */
765 #define AF_FOREGROUND 32u /* Quit server when client closes */
768 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
770 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
773 /*----- Global variables --------------------------------------------------*/
775 extern sel_state sel; /* Global I/O event state */
776 extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
777 extern const tunnel_ops *tunnels[]; /* Table of tunnels (0-term) */
778 extern const tunnel_ops *tun_default; /* Default tunnel to use */
779 extern kdata *master; /* Default private key */
780 extern const char *tag_priv; /* Default private key tag */
783 extern const trace_opt tr_opts[]; /* Trace options array */
784 extern unsigned tr_flags; /* Trace options flags */
787 /*----- Other macros ------------------------------------------------------*/
790 do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0)
792 /*----- Key management ----------------------------------------------------*/
794 /* --- @km_init@ --- *
796 * Arguments: @const char *privkr@ = private keyring file
797 * @const char *pubkr@ = public keyring file
798 * @const char *ptag@ = default private-key tag
802 * Use: Initializes the key-management machinery, loading the
803 * keyrings and so on.
806 extern void km_init(const char */*privkr*/, const char */*pubkr*/,
807 const char */*ptag*/);
809 /* --- @km_reload@ --- *
813 * Returns: Zero if OK, nonzero to force reloading of keys.
815 * Use: Checks the keyrings to see if they need reloading.
818 extern int km_reload(void);
820 /* --- @km_findpub@, @km_findpriv@ --- *
822 * Arguments: @const char *tag@ = key tag to load
824 * Returns: Pointer to the kdata object if successful, or null on error.
826 * Use: Fetches a public or private key from the keyring.
829 extern kdata *km_findpub(const char */*tag*/);
830 extern kdata *km_findpriv(const char */*tag*/);
832 /* --- @km_findpubbyid@, @km_findprivbyid@ --- *
834 * Arguments: @uint32 id@ = key id to load
836 * Returns: Pointer to the kdata object if successful, or null on error.
838 * Use: Fetches a public or private key from the keyring given its
842 extern kdata *km_findpubbyid(uint32 /*id*/);
843 extern kdata *km_findprivbyid(uint32 /*id*/);
845 /* --- @km_samealgsp@ --- *
847 * Arguments: @const kdata *kdx, *kdy@ = two key data objects
849 * Returns: Nonzero if their two algorithm selections are the same.
851 * Use: Checks sameness of algorithm selections: used to ensure that
852 * peers are using sensible algorithms.
855 extern int km_samealgsp(const kdata */*kdx*/, const kdata */*kdy*/);
857 /* --- @km_ref@ --- *
859 * Arguments: @kdata *kd@ = pointer to the kdata object
863 * Use: Claim a new reference to a kdata object.
866 extern void km_ref(kdata */*kd*/);
868 /* --- @km_unref@ --- *
870 * Arguments: @kdata *kd@ = pointer to the kdata object
874 * Use: Releases a reference to a kdata object.
877 extern void km_unref(kdata */*kd*/);
879 /* --- @km_tag@ --- *
881 * Arguments: @kdata *kd@ - pointer to the kdata object
883 * Returns: A pointer to the short tag by which the kdata was loaded.
886 extern const char *km_tag(kdata */*kd*/);
888 /*----- Key exchange ------------------------------------------------------*/
890 /* --- @kx_start@ --- *
892 * Arguments: @keyexch *kx@ = pointer to key exchange context
893 * @int forcep@ = nonzero to ignore the quiet timer
897 * Use: Stimulates a key exchange. If a key exchage is in progress,
898 * a new challenge is sent (unless the quiet timer forbids
899 * this); if no exchange is in progress, one is commenced.
902 extern void kx_start(keyexch */*kx*/, int /*forcep*/);
904 /* --- @kx_message@ --- *
906 * Arguments: @keyexch *kx@ = pointer to key exchange context
907 * @const addr *a@ = sender's IP address and port
908 * @unsigned msg@ = the message code
909 * @buf *b@ = pointer to buffer containing the packet
911 * Returns: Nonzero if the sender's address was unknown.
913 * Use: Reads a packet containing key exchange messages and handles
917 extern int kx_message(keyexch */*kx*/, const addr */*a*/,
918 unsigned /*msg*/, buf */*b*/);
920 /* --- @kx_free@ --- *
922 * Arguments: @keyexch *kx@ = pointer to key exchange context
926 * Use: Frees everything in a key exchange context.
929 extern void kx_free(keyexch */*kx*/);
931 /* --- @kx_newkeys@ --- *
933 * Arguments: @keyexch *kx@ = pointer to key exchange context
937 * Use: Informs the key exchange module that its keys may have
938 * changed. If fetching the new keys fails, the peer will be
939 * destroyed, we log messages and struggle along with the old
943 extern void kx_newkeys(keyexch */*kx*/);
945 /* --- @kx_setup@ --- *
947 * Arguments: @keyexch *kx@ = pointer to key exchange context
948 * @peer *p@ = pointer to peer context
949 * @keyset **ks@ = pointer to keyset list
950 * @unsigned f@ = various useful flags
952 * Returns: Zero if OK, nonzero if it failed.
954 * Use: Initializes a key exchange module. The module currently
955 * contains no keys, and will attempt to initiate a key
959 extern int kx_setup(keyexch */*kx*/, peer */*p*/,
960 keyset **/*ks*/, unsigned /*f*/);
962 /* --- @kx_init@ --- *
968 * Use: Initializes the key-exchange logic.
971 extern void kx_init(void);
973 /*----- Keysets and symmetric cryptography --------------------------------*/
975 /* --- @ks_drop@ --- *
977 * Arguments: @keyset *ks@ = pointer to a keyset
981 * Use: Decrements a keyset's reference counter. If the counter hits
982 * zero, the keyset is freed.
985 extern void ks_drop(keyset */*ks*/);
987 /* --- @ks_gen@ --- *
989 * Arguments: @deriveargs *a@ = key derivation parameters (modified)
990 * @peer *p@ = pointer to peer information
992 * Returns: A pointer to the new keyset.
994 * Use: Derives a new keyset from the given key material. This will
995 * set the @what@, @f@, and @hc@ members in @*a@; other members
996 * must be filled in by the caller.
998 * The new key is marked so that it won't be selected for output
999 * by @ksl_encrypt@. You can still encrypt data with it by
1000 * calling @ks_encrypt@ directly.
1003 extern keyset *ks_gen(deriveargs */*a*/, peer */*p*/);
1005 /* --- @ks_activate@ --- *
1007 * Arguments: @keyset *ks@ = pointer to a keyset
1011 * Use: Activates a keyset, so that it can be used for encrypting
1012 * outgoing messages.
1015 extern void ks_activate(keyset */*ks*/);
1017 /* --- @ks_encrypt@ --- *
1019 * Arguments: @keyset *ks@ = pointer to a keyset
1020 * @unsigned ty@ = message type
1021 * @buf *b@ = pointer to input buffer
1022 * @buf *bb@ = pointer to output buffer
1024 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
1025 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
1026 * returns zero if there was insufficient buffer (but the output
1027 * buffer is broken in this case).
1029 * Use: Encrypts a block of data using the key. Note that the `key
1030 * ought to be replaced' notification is only ever given once
1031 * for each key. Also note that this call forces a keyset to be
1032 * used even if it's marked as not for data output.
1034 * The encryption transform is permitted to corrupt @buf_u@ for
1035 * its own purposes. Neither the source nor destination should
1036 * be within @buf_u@; and callers mustn't expect anything stored
1037 * in @buf_u@ to still
1040 extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
1041 buf */*b*/, buf */*bb*/);
1043 /* --- @ks_decrypt@ --- *
1045 * Arguments: @keyset *ks@ = pointer to a keyset
1046 * @unsigned ty@ = expected type code
1047 * @buf *b@ = pointer to an input buffer
1048 * @buf *bb@ = pointer to an output buffer
1050 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1051 * zero if there was insufficient buffer (but the output buffer
1052 * is broken in this case).
1054 * Use: Attempts to decrypt a message using a given key. Note that
1055 * requesting decryption with a key directly won't clear a
1056 * marking that it's not for encryption.
1058 * The decryption transform is permitted to corrupt @buf_u@ for
1059 * its own purposes. Neither the source nor destination should
1060 * be within @buf_u@; and callers mustn't expect anything stored
1061 * in @buf_u@ to still
1064 extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
1065 buf */*b*/, buf */*bb*/);
1067 /* --- @ksl_free@ --- *
1069 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1073 * Use: Frees (releases references to) all of the keys in a keyset.
1076 extern void ksl_free(keyset **/*ksroot*/);
1078 /* --- @ksl_link@ --- *
1080 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1081 * @keyset *ks@ = pointer to a keyset
1085 * Use: Links a keyset into a list. A keyset can only be on one list
1086 * at a time. Bad things happen otherwise.
1089 extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
1091 /* --- @ksl_prune@ --- *
1093 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1097 * Use: Prunes the keyset list by removing keys which mustn't be used
1101 extern void ksl_prune(keyset **/*ksroot*/);
1103 /* --- @ksl_encrypt@ --- *
1105 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1106 * @unsigned ty@ = message type
1107 * @buf *b@ = pointer to input buffer
1108 * @buf *bb@ = pointer to output buffer
1110 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
1111 * new key; @KSERR_NOKEYS@ if there are no suitable keys
1112 * available. Also returns zero if there was insufficient
1113 * buffer space (but the output buffer is broken in this case).
1115 * Use: Encrypts a packet.
1118 extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
1119 buf */*b*/, buf */*bb*/);
1121 /* --- @ksl_decrypt@ --- *
1123 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1124 * @unsigned ty@ = expected type code
1125 * @buf *b@ = pointer to input buffer
1126 * @buf *bb@ = pointer to output buffer
1128 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1129 * zero if there was insufficient buffer (but the output buffer
1130 * is broken in this case).
1132 * Use: Decrypts a packet.
1135 extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
1136 buf */*b*/, buf */*bb*/);
1138 /*----- Challenges --------------------------------------------------------*/
1140 /* --- @c_new@ --- *
1142 * Arguments: @const void *m@ = pointer to associated message, or null
1143 * @size_t msz@ = length of associated message
1144 * @buf *b@ = where to put the challenge
1146 * Returns: Zero if OK, nonzero on error.
1148 * Use: Issues a new challenge.
1151 extern int c_new(const void */*m*/, size_t /*msz*/, buf */*b*/);
1153 /* --- @c_check@ --- *
1155 * Arguments: @const void *m@ = pointer to associated message, or null
1156 * @size_t msz@ = length of associated message
1157 * @buf *b@ = where to find the challenge
1159 * Returns: Zero if OK, nonzero if it didn't work.
1161 * Use: Checks a challenge. On failure, the buffer is broken.
1164 extern int c_check(const void */*m*/, size_t /*msz*/, buf */*b*/);
1166 /*----- Administration interface ------------------------------------------*/
1168 #define A_END ((char *)0)
1170 /* --- @a_vformat@ --- *
1172 * Arguments: @dstr *d@ = where to leave the formatted message
1173 * @const char *fmt@ = pointer to format string
1174 * @va_list *ap@ = arguments in list
1178 * Use: Main message token formatting driver. The arguments are
1179 * interleaved formatting tokens and their parameters, finally
1180 * terminated by an entry @A_END@.
1182 * Tokens recognized:
1184 * * "*..." ... -- pretokenized @dstr_putf@-like string
1186 * * "?ADDR" SOCKADDR -- a socket address, to be converted
1188 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
1190 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
1192 * * "?PEER" PEER -- peer's name
1194 * * "?ERRNO" ERRNO -- system error code
1196 * * "[!]..." ... -- @dstr_putf@-like string as single token
1199 extern void a_vformat(dstr */*d*/, const char */*fmt*/, va_list */*ap*/);
1201 /* --- @a_format@ --- *
1203 * Arguments: @dstr *d@ = where to leave the formatted message
1204 * @const char *fmt@ = pointer to format string
1208 * Use: Writes a tokenized message into a string, for later
1212 extern void EXECL_LIKE(0) a_format(dstr */*d*/, const char */*fmt*/, ...);
1214 /* --- @a_info@ --- *
1216 * Arguments: @admin *a@ = connection
1217 * @const char *fmt@ = format string
1218 * @...@ = other arguments
1222 * Use: Report information to an admin client.
1225 extern void EXECL_LIKE(0) a_info(admin */*a*/, const char */*fmt*/, ...);
1227 /* --- @a_warn@ --- *
1229 * Arguments: @const char *fmt@ = pointer to format string
1230 * @...@ = other arguments
1234 * Use: Informs all admin connections of a warning.
1237 extern void EXECL_LIKE(0) a_warn(const char */*fmt*/, ...);
1239 /* --- @a_notify@ --- *
1241 * Arguments: @const char *fmt@ = pointer to format string
1242 * @...@ = other arguments
1246 * Use: Sends a notification to interested admin connections.
1249 extern void EXECL_LIKE(0) a_notify(const char */*fmt*/, ...);
1251 /* --- @a_create@ --- *
1253 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1254 * @unsigned f@ = initial flags to set
1258 * Use: Creates a new admin connection.
1261 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
1263 /* --- @a_quit@ --- *
1269 * Use: Shuts things down nicely.
1272 extern void a_quit(void);
1274 /* --- @a_preselect@ --- *
1280 * Use: Informs the admin module that we're about to select again,
1281 * and that it should do cleanup things it has delayed until a
1285 extern void a_preselect(void);
1287 /* --- @a_daemon@ --- *
1293 * Use: Informs the admin module that it's a daemon.
1296 extern void a_daemon(void);
1298 /* --- @a_init@ --- *
1300 * Arguments: @const char *sock@ = socket name to create
1301 * @uid_t u@ = user to own the socket
1302 * @gid_t g@ = group to own the socket
1303 * @mode_t m@ = permissions to set on the socket
1307 * Use: Creates the admin listening socket.
1310 extern void a_init(const char */*sock*/,
1311 uid_t /*u*/, gid_t /*g*/, mode_t /*m*/);
1313 /*----- Mapping with addresses as keys ------------------------------------*/
1315 /* --- @am_create@ --- *
1317 * Arguments: @addrmap *m@ = pointer to map
1321 * Use: Create an address map, properly set up.
1324 extern void am_create(addrmap */*m*/);
1326 /* --- @am_destroy@ --- *
1328 * Arguments: @addrmap *m@ = pointer to map
1332 * Use: Destroy an address map, throwing away all the entries.
1335 extern void am_destroy(addrmap */*m*/);
1337 /* --- @am_find@ --- *
1339 * Arguments: @addrmap *m@ = pointer to map
1340 * @const addr *a@ = address to look up
1341 * @size_t sz@ = size of block to allocate
1342 * @unsigned *f@ = where to store flags
1344 * Returns: Pointer to found item, or null.
1346 * Use: Finds a record with the given IP address, set @*f@ nonzero
1347 * and returns it. If @sz@ is zero, and no match was found,
1348 * return null; otherwise allocate a new block of @sz@ bytes,
1349 * clear @*f@ to zero and return the block pointer.
1352 extern void *am_find(addrmap */*m*/, const addr */*a*/,
1353 size_t /*sz*/, unsigned */*f*/);
1355 /* --- @am_remove@ --- *
1357 * Arguments: @addrmap *m@ = pointer to map
1358 * @void *i@ = pointer to the item
1362 * Use: Removes an item from the map.
1365 extern void am_remove(addrmap */*m*/, void */*i*/);
1367 /*----- Privilege separation ----------------------------------------------*/
1369 /* --- @ps_trace@ --- *
1371 * Arguments: @unsigned mask@ = trace mask to check
1372 * @const char *fmt@ = message format
1373 * @...@ = values for placeholders
1377 * Use: Writes a trace message.
1380 T( extern void PRINTF_LIKE(2, 3)
1381 ps_trace(unsigned /*mask*/, const char */*fmt*/, ...); )
1383 /* --- @ps_warn@ --- *
1385 * Arguments: @const char *fmt@ = message format
1386 * @...@ = values for placeholders
1390 * Use: Writes a warning message.
1393 extern void PRINTF_LIKE(1, 2) ps_warn(const char */*fmt*/, ...);
1395 /* --- @ps_tunfd@ --- *
1397 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1398 * @char **ifn@ = where to put the interface name
1400 * Returns: The file descriptor, or @-1@ on error.
1402 * Use: Fetches a file descriptor for a tunnel driver.
1405 extern int ps_tunfd(const tunnel_ops */*tops*/, char **/*ifn*/);
1407 /* --- @ps_split@ --- *
1409 * Arguments: @int detachp@ = whether to detach the child from its terminal
1413 * Use: Separates off the privileged tunnel-opening service from the
1414 * rest of the server.
1417 extern void ps_split(int /*detachp*/);
1419 /* --- @ps_quit@ --- *
1425 * Use: Detaches from the helper process.
1428 extern void ps_quit(void);
1430 /*----- Peer management ---------------------------------------------------*/
1432 /* --- @p_updateaddr@ --- *
1434 * Arguments: @peer *p@ = pointer to peer block
1435 * @const addr *a@ = address to associate with this peer
1437 * Returns: Zero if the address was changed; @+1@ if it was already
1440 * Use: Updates our idea of @p@'s address.
1443 extern int p_updateaddr(peer */*p*/, const addr */*a*/);
1445 /* --- @p_txstart@ --- *
1447 * Arguments: @peer *p@ = pointer to peer block
1448 * @unsigned msg@ = message type code
1450 * Returns: A pointer to a buffer to write to.
1452 * Use: Starts sending to a peer. Only one send can happen at a
1456 extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
1458 /* --- @p_txaddr@ --- *
1460 * Arguments: @const addr *a@ = recipient address
1461 * @const void *p@ = pointer to packet to send
1462 * @size_t sz@ = length of packet
1464 * Returns: Zero if successful, nonzero on error.
1466 * Use: Sends a packet to an address which (possibly) isn't a current
1470 extern int p_txaddr(const addr */*a*/, const void */*p*/, size_t /*sz*/);
1472 /* --- @p_txend@ --- *
1474 * Arguments: @peer *p@ = pointer to peer block
1478 * Use: Sends a packet to the peer.
1481 extern void p_txend(peer */*p*/);
1483 /* --- @p_pingsend@ --- *
1485 * Arguments: @peer *p@ = destination peer
1486 * @ping *pg@ = structure to fill in
1487 * @unsigned type@ = message type
1488 * @unsigned long timeout@ = how long to wait before giving up
1489 * @void (*func)(int, void *)@ = callback function
1490 * @void *arg@ = argument for callback
1492 * Returns: Zero if successful, nonzero if it failed.
1494 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1495 * if we get an answer within the timeout, or zero if no answer.
1498 extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
1499 unsigned long /*timeout*/,
1500 void (*/*func*/)(int, void *), void */*arg*/);
1502 /* --- @p_pingdone@ --- *
1504 * Arguments: @ping *p@ = ping structure
1505 * @int rc@ = return code to pass on
1509 * Use: Disposes of a ping structure, maybe sending a notification.
1512 extern void p_pingdone(ping */*p*/, int /*rc*/);
1514 /* --- @p_greet@ --- *
1516 * Arguments: @peer *p@ = peer to send to
1517 * @const void *c@ = pointer to challenge
1518 * @size_t sz@ = size of challenge
1522 * Use: Sends a greeting packet.
1525 extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
1527 /* --- @p_tun@ --- *
1529 * Arguments: @peer *p@ = pointer to peer block
1530 * @buf *b@ = buffer containing incoming packet
1534 * Use: Handles a packet which needs to be sent to a peer.
1537 extern void p_tun(peer */*p*/, buf */*b*/);
1539 /* --- @p_keyreload@ --- *
1545 * Use: Forces a check of the daemon's keyring files.
1548 extern void p_keyreload(void);
1550 /* --- @p_interval@ --- *
1556 * Use: Called periodically to do tidying.
1559 extern void p_interval(void);
1561 /* --- @p_stats@ --- *
1563 * Arguments: @peer *p@ = pointer to a peer block
1565 * Returns: A pointer to the peer's statistics.
1568 extern stats *p_stats(peer */*p*/);
1570 /* --- @p_ifname@ --- *
1572 * Arguments: @peer *p@ = pointer to a peer block
1574 * Returns: A pointer to the peer's interface name.
1577 extern const char *p_ifname(peer */*p*/);
1579 /* --- @p_setifname@ --- *
1581 * Arguments: @peer *p@ = pointer to a peer block
1582 * @const char *name@ = pointer to the new name
1586 * Use: Changes the name held for a peer's interface.
1589 extern void p_setifname(peer */*p*/, const char */*name*/);
1591 /* --- @p_addr@ --- *
1593 * Arguments: @peer *p@ = pointer to a peer block
1595 * Returns: A pointer to the peer's address.
1598 extern const addr *p_addr(peer */*p*/);
1600 /* --- @p_init@ --- *
1602 * Arguments: @struct in_addr addr@ = address to bind to
1603 * @unsigned port@ = port number to listen to
1607 * Use: Initializes the peer system; creates the socket.
1610 extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
1612 /* --- @p_port@ --- *
1616 * Returns: Port number used for socket.
1619 unsigned p_port(void);
1621 /* --- @p_create@ --- *
1623 * Arguments: @peerspec *spec@ = information about this peer
1625 * Returns: Pointer to the peer block, or null if it failed.
1627 * Use: Creates a new named peer block. No peer is actually attached
1631 extern peer *p_create(peerspec */*spec*/);
1633 /* --- @p_name@ --- *
1635 * Arguments: @peer *p@ = pointer to a peer block
1637 * Returns: A pointer to the peer's name.
1639 * Use: Equivalent to @p_spec(p)->name@.
1642 extern const char *p_name(peer */*p*/);
1644 /* --- @p_tag@ --- *
1646 * Arguments: @peer *p@ = pointer to a peer block
1648 * Returns: A pointer to the peer's public key tag.
1651 extern const char *p_tag(peer */*p*/);
1653 /* --- @p_privtag@ --- *
1655 * Arguments: @peer *p@ = pointer to a peer block
1657 * Returns: A pointer to the peer's private key tag.
1660 extern const char *p_privtag(peer */*p*/);
1662 /* --- @p_spec@ --- *
1664 * Arguments: @peer *p@ = pointer to a peer block
1666 * Returns: Pointer to the peer's specification
1669 extern const peerspec *p_spec(peer */*p*/);
1671 /* --- @p_findbyaddr@ --- *
1673 * Arguments: @const addr *a@ = address to look up
1675 * Returns: Pointer to the peer block, or null if not found.
1677 * Use: Finds a peer by address.
1680 extern peer *p_findbyaddr(const addr */*a*/);
1682 /* --- @p_find@ --- *
1684 * Arguments: @const char *name@ = name to look up
1686 * Returns: Pointer to the peer block, or null if not found.
1688 * Use: Finds a peer by name.
1691 extern peer *p_find(const char */*name*/);
1693 /* --- @p_destroy@ --- *
1695 * Arguments: @peer *p@ = pointer to a peer
1699 * Use: Destroys a peer.
1702 extern void p_destroy(peer */*p*/);
1704 /* --- @FOREACH_PEER@ --- *
1706 * Arguments: @p@ = name to bind to each peer
1707 * @stuff@ = thing to do for each item
1709 * Use: Does something for each current peer.
1712 #define FOREACH_PEER(p, stuff) do { \
1715 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \
1718 /* --- @p_mkiter@ --- *
1720 * Arguments: @peer_iter *i@ = pointer to an iterator
1724 * Use: Initializes the iterator.
1727 extern void p_mkiter(peer_iter */*i*/);
1729 /* --- @p_next@ --- *
1731 * Arguments: @peer_iter *i@ = pointer to an iterator
1733 * Returns: Next peer, or null if at the end.
1735 * Use: Returns the next peer.
1738 extern peer *p_next(peer_iter */*i*/);
1740 /*----- Tunnel drivers ----------------------------------------------------*/
1743 extern const tunnel_ops tun_linux;
1747 extern const tunnel_ops tun_unet;
1751 extern const tunnel_ops tun_bsd;
1754 extern const tunnel_ops tun_slip;
1756 /*----- Other handy utilities ---------------------------------------------*/
1758 /* --- @timestr@ --- *
1760 * Arguments: @time_t t@ = a time to convert
1762 * Returns: A pointer to a textual representation of the time.
1764 * Use: Converts a time to a textual representation. Corrupts
1768 extern const char *timestr(time_t /*t*/);
1770 /* --- @mystrieq@ --- *
1772 * Arguments: @const char *x, *y@ = two strings
1774 * Returns: True if @x@ and @y are equal, up to case.
1777 extern int mystrieq(const char */*x*/, const char */*y*/);
1779 /* --- @addrsz@ --- *
1781 * Arguments: @const addr *a@ = a network address
1783 * Returns: The size of the address, for passing into the sockets API.
1786 extern socklen_t addrsz(const addr */*a*/);
1788 /* --- @seq_reset@ --- *
1790 * Arguments: @seqwin *s@ = sequence-checking window
1794 * Use: Resets a sequence number window.
1797 extern void seq_reset(seqwin */*s*/);
1799 /* --- @seq_check@ --- *
1801 * Arguments: @seqwin *s@ = sequence-checking window
1802 * @uint32 q@ = sequence number to check
1803 * @const char *service@ = service to report message from
1805 * Returns: A @SEQ_@ code.
1807 * Use: Checks a sequence number against the window, updating things
1811 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
1813 typedef struct ratelim {
1814 unsigned n, max, persec;
1815 struct timeval when;
1818 /* --- @ratelim_init@ --- *
1820 * Arguments: @ratelim *r@ = rate-limiting state to fill in
1821 * @unsigned persec@ = credit to accumulate per second
1822 * @unsigned max@ = maximum credit to retain
1826 * Use: Initialize a rate-limiting state.
1829 extern void ratelim_init(ratelim */*r*/,
1830 unsigned /*persec*/, unsigned /*max*/);
1832 /* --- @ratelim_withdraw@ --- *
1834 * Arguments: @ratelim *r@ = rate-limiting state
1835 * @unsigned n@ = credit to withdraw
1837 * Returns: Zero if successful; @-1@ if there is unsufficient credit
1839 * Use: Updates the state with any accumulated credit. Then, if
1840 * there there are more than @n@ credits available, withdraw @n@
1841 * and return successfully; otherwise, report failure.
1844 extern int ratelim_withdraw(ratelim */*r*/, unsigned /*n*/);
1846 /* --- @ies_encrypt@ --- *
1848 * Arguments: @kdata *kpub@ = recipient's public key
1849 * @unsigned ty@ = message type octet
1850 * @buf *b@ = input message buffer
1851 * @buf *bb@ = output buffer for the ciphertext
1853 * Returns: On error, returns a @KSERR_...@ code or breaks the buffer;
1854 * on success, returns zero and the buffer is good.
1856 * Use: Encrypts a message for a recipient, given their public key.
1857 * This does not (by itself) provide forward secrecy or sender
1858 * authenticity. The ciphertext is self-delimiting (unlike
1862 extern int ies_encrypt(kdata */*kpub*/, unsigned /*ty*/,
1863 buf */*b*/, buf */*bb*/);
1865 /* --- @ies_decrypt@ --- *
1867 * Arguments: @kdata *kpub@ = private key key
1868 * @unsigned ty@ = message type octet
1869 * @buf *b@ = input ciphertext buffer
1870 * @buf *bb@ = output buffer for the message
1872 * Returns: On error, returns a @KSERR_...@ code; on success, returns
1873 * zero and the buffer is good.
1875 * Use: Decrypts a message encrypted using @ies_encrypt@, given our
1879 extern int ies_decrypt(kdata */*kpriv*/, unsigned /*ty*/,
1880 buf */*b*/, buf */*bb*/);
1882 /*----- That's all, folks -------------------------------------------------*/