75ad2f1f5d1e357bfdca8d4e2f9728cfb8336ea4
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*/,
380 /* Calculate a tag for the challenge in @m@, @msz@, and write it to
381 * @t@. Return @-1@ on error, zero on success.
384 int (*chalvrf
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
386 /* Check the tag @t@ on @m@, @msz@: return zero if the tag is OK,
387 * nonzero if it's bad.
390 void (*freechal
)(bulkchal */
*bc*/
);
391 /* Release a challenge context and the resources it holds. */
396 const gchash
*h
; size_t hashsz
; /* Hash function */
397 const gccipher
*mgf
; /* Mask-generation function */
398 bulkalgs
*bulk
; /* Bulk crypto algorithms */
402 unsigned ref
; /* Reference counter */
403 struct knode
*kn
; /* Pointer to cache entry */
404 char *tag
; /* Full tag name of the key */
405 dhgrp
*grp
; /* The group we work in */
406 dhsc
*k
; /* The private key (or null) */
407 dhge
*K
; /* The public key */
408 time_t t_exp
; /* Expiry time of the key */
409 algswitch algs
; /* Collection of algorithms */
412 typedef struct knode
{
413 sym_base _b
; /* Symbol table intrusion */
414 unsigned f
; /* Various flags */
415 #define KNF_BROKEN 1u /* Don't use this key any more */
416 struct keyhalf
*kh
; /* Pointer to the home keyhalf */
417 kdata
*kd
; /* Pointer to the key data */
420 #define MAXHASHSZ 64 /* Largest possible hash size */
422 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
424 extern const dhops dhtab
[];
425 extern const bulkops bulktab
[];
427 /*----- Data structures ---------------------------------------------------*/
429 /* --- Socket addresses --- *
431 * A magic union of supported socket addresses.
436 struct sockaddr_in sin
;
439 /* --- Mapping keyed on addresses --- */
441 typedef struct addrmap
{
446 typedef struct addrmap_base
{
451 /* --- Sequence number checking --- */
453 typedef struct seqwin
{
454 uint32 seq
; /* First acceptable input sequence */
455 uint32 win
; /* Window of acceptable numbers */
458 #define SEQ_WINSZ 32 /* Bits in sequence number window */
460 /* --- A symmetric keyset --- *
462 * A keyset contains a set of symmetric keys for encrypting and decrypting
463 * packets. Keysets are stored in a list, sorted in reverse order of
464 * creation, so that the most recent keyset (the one most likely to be used)
467 * Each keyset has a time limit and a data limit. The keyset is destroyed
468 * when either it has existed for too long, or it has been used to encrypt
469 * too much data. New key exchanges are triggered when keys are close to
473 enum { DIR_IN
, DIR_OUT
, NDIR
};
476 struct keyset
*next
; /* Next active keyset in the list */
477 unsigned ref
; /* Reference count for keyset */
478 struct peer
*p
; /* Pointer to peer structure */
479 time_t t_exp
; /* Expiry time for this keyset */
480 unsigned long sz_exp
, sz_regen
; /* Data limits for the keyset */
481 T( unsigned seq
; ) /* Sequence number for tracing */
482 unsigned f
; /* Various useful flags */
483 bulkctx
*bulk
; /* Bulk crypto transform */
484 uint32 oseq
; /* Outbound sequence number */
485 seqwin iseq
; /* Inbound sequence number */
488 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
489 #define KSF_LINK 2u /* Key is in a linked list */
491 #define KSERR_REGEN -1 /* Regenerate keys */
492 #define KSERR_NOKEYS -2 /* No keys left */
493 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
494 #define KSERR_SEQ -4 /* Incorrect sequence number */
495 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
497 /* --- Key exchange --- *
499 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
500 * Protocol has a number of desirable features (e.g., perfect forward
501 * secrecy, and zero-knowledge authentication) which make it attractive for
502 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
506 typedef struct retry
{
507 double t
; /* Current retry time */
512 typedef struct kxchal
{
513 struct keyexch
*kx
; /* Pointer back to key exchange */
514 dhge
*C
; /* Responder's challenge */
515 dhge
*R
; /* My reply to the challenge */
516 keyset
*ks
; /* Pointer to temporary keyset */
517 unsigned f
; /* Various useful flags */
518 sel_timer t
; /* Response timer for challenge */
519 retry rs
; /* Retry state */
520 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
521 octet ck
[MAXHASHSZ
]; /* His magical check value */
522 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
523 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
524 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
525 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
528 typedef struct keyexch
{
529 struct peer
*p
; /* Pointer back to the peer */
530 kdata
*kpriv
; /* Private key and related info */
531 kdata
*kpub
; /* Peer's public key */
532 keyset
**ks
; /* Peer's list of keysets */
533 unsigned f
; /* Various useful flags */
534 unsigned s
; /* Current state in exchange */
535 sel_timer t
; /* Timer for next exchange */
536 retry rs
; /* Retry state */
537 dhsc
*a
; /* My temporary secret */
538 dhge
*C
; /* My challenge */
539 dhge
*RX
; /* The expected response */
540 unsigned nr
; /* Number of extant responses */
541 time_t t_valid
; /* When this exchange goes bad */
542 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
543 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
546 #define KXF_TIMER 1u /* Waiting for a timer to go off */
547 #define KXF_DEAD 2u /* The key-exchanger isn't up */
548 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
549 #define KXF_CORK 8u /* Don't send anything yet */
552 KXS_DEAD
, /* Uninitialized state (magical) */
553 KXS_CHAL
, /* Main answer-challenges state */
554 KXS_COMMIT
, /* Committed: send switch request */
555 KXS_SWITCH
/* Switched: send confirmation */
558 /* --- Tunnel structure --- *
560 * Used to maintain system-specific information about the tunnel interface.
563 typedef struct tunnel tunnel
;
566 typedef struct tunnel_ops
{
567 const char *name
; /* Name of this tunnel driver */
568 unsigned flags
; /* Various interesting flags */
569 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
570 void (*init
)(void); /* Initializes the system */
571 tunnel
*(*create
)(struct peer */
*p*/
, int /*fd*/, char **/
*ifn*/
);
572 /* Initializes a new tunnel */
573 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
574 /* Notifies ifname change */
575 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
576 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
579 #ifndef TUN_INTERNALS
580 struct tunnel
{ const tunnel_ops
*ops
; };
583 /* --- Peer statistics --- *
585 * Contains various interesting and not-so-interesting statistics about a
586 * peer. This is updated by various parts of the code. The format of the
587 * structure isn't considered private, and @p_stats@ returns a pointer to the
588 * statistics block for a given peer.
591 typedef struct stats
{
592 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
593 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
594 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
595 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
596 unsigned long n_reject
; /* Number of rejected packets */
597 unsigned long n_in
, n_out
; /* Number of packets in and out */
598 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
599 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
602 /* --- Peer structure --- *
604 * The main structure which glues everything else together.
607 typedef struct peerspec
{
608 char *name
; /* Peer's name */
609 char *privtag
; /* Private key tag */
610 char *tag
; /* Public key tag */
611 const tunnel_ops
*tops
; /* Tunnel operations */
612 unsigned long t_ka
; /* Keep alive interval */
613 addr sa
; /* Socket address to speak to */
614 unsigned f
; /* Flags for the peer */
615 #define PSF_KXMASK 255u /* Key-exchange flags to set */
616 #define PSF_MOBILE 256u /* Address may change rapidly */
619 typedef struct peer_byname
{
624 typedef struct peer_byaddr
{
629 typedef struct peer
{
630 peer_byname
*byname
; /* Lookup-by-name block */
631 peer_byaddr
*byaddr
; /* Lookup-by-address block */
632 struct ping
*pings
; /* Pings we're waiting for */
633 peerspec spec
; /* Specifications for this peer */
634 tunnel
*t
; /* Tunnel for local packets */
635 char *ifname
; /* Interface name for tunnel */
636 keyset
*ks
; /* List head for keysets */
637 buf b
; /* Buffer for sending packets */
638 stats st
; /* Statistics */
639 keyexch kx
; /* Key exchange protocol block */
640 sel_timer tka
; /* Timer for keepalives */
643 typedef struct peer_iter
{ sym_iter i
; } peer_iter
;
645 typedef struct ping
{
646 struct ping
*next
, *prev
; /* Links to next and previous */
647 peer
*p
; /* Peer so we can free it */
648 unsigned msg
; /* Kind of response expected */
649 uint32 id
; /* Id so we can recognize response */
650 octet magic
[32]; /* Some random data */
651 sel_timer t
; /* Timeout for ping */
652 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
653 void *arg
; /* Argument for callback */
664 /* --- Admin structure --- */
666 #define OBUFSZ 16384u
668 typedef struct obuf
{
669 struct obuf
*next
; /* Next buffer in list */
670 char *p_in
, *p_out
; /* Pointers into the buffer */
671 char buf
[OBUFSZ
]; /* The actual buffer */
674 typedef struct oqueue
{
675 obuf
*hd
, *tl
; /* Head and tail pointers */
680 typedef struct admin_bgop
{
681 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
682 struct admin
*a
; /* Owner job */
683 char *tag
; /* Tag string for messages */
684 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
687 typedef struct admin_resop
{
688 admin_bgop bg
; /* Background operation header */
689 char *addr
; /* Hostname to be resolved */
690 bres_client r
; /* Background resolver task */
691 sel_timer t
; /* Timer for resolver */
692 addr sa
; /* Socket address */
693 size_t sasz
; /* Socket address size */
694 void (*func
)(struct admin_resop
*, int); /* Handler */
697 enum { ARES_OK
, ARES_FAIL
};
699 typedef struct admin_addop
{
700 admin_resop r
; /* Name resolution header */
701 peerspec peer
; /* Peer pending creation */
704 typedef struct admin_pingop
{
705 admin_bgop bg
; /* Background operation header */
706 ping ping
; /* Ping pending response */
707 struct timeval pingtime
; /* Time last ping was sent */
710 typedef struct admin_service
{
711 sym_base _b
; /* Hash table base structure */
712 char *version
; /* The provided version */
713 struct admin
*prov
; /* Which client provides me */
714 struct admin_service
*next
, *prev
; /* Client's list of services */
717 typedef struct admin_svcop
{
718 admin_bgop bg
; /* Background operation header */
719 struct admin
*prov
; /* Client servicing this job */
720 unsigned index
; /* This job's index */
721 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
724 typedef struct admin_jobentry
{
725 unsigned short seq
; /* Zero if unused */
727 admin_svcop
*op
; /* Operation, if slot in use, ... */
728 uint32 next
; /* ... or index of next free slot */
732 typedef struct admin_jobtable
{
733 uint32 n
, sz
; /* Used slots and table size */
734 admin_svcop
*active
; /* List of active jobs */
735 uint32 free
; /* Index of first free slot */
736 admin_jobentry
*v
; /* And the big array of entries */
740 struct admin
*next
, *prev
; /* Links to next and previous */
741 unsigned f
; /* Various useful flags */
742 unsigned ref
; /* Reference counter */
744 unsigned seq
; /* Sequence number for tracing */
746 oqueue out
; /* Output buffer list */
747 oqueue delay
; /* Delayed output buffer list */
748 admin_bgop
*bg
; /* Backgrounded operations */
749 admin_service
*svcs
; /* Which services I provide */
750 admin_jobtable j
; /* Table of outstanding jobs */
751 selbuf b
; /* Line buffer for commands */
752 sel_file w
; /* Selector for write buffering */
755 #define AF_DEAD 1u /* Destroy this admin block */
756 #define AF_CLOSE 2u /* Client closed connection */
757 #define AF_NOTE 4u /* Catch notifications */
758 #define AF_WARN 8u /* Catch warning messages */
760 # define AF_TRACE 16u /* Catch tracing */
762 #define AF_FOREGROUND 32u /* Quit server when client closes */
765 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
767 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
770 /*----- Global variables --------------------------------------------------*/
772 extern sel_state sel
; /* Global I/O event state */
773 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
], buf_u
[PKBUFSZ
];
774 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
775 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
776 extern kdata
*master
; /* Default private key */
777 extern const char *tag_priv
; /* Default private key tag */
780 extern const trace_opt tr_opts
[]; /* Trace options array */
781 extern unsigned tr_flags
; /* Trace options flags */
784 /*----- Other macros ------------------------------------------------------*/
787 do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0)
789 /*----- Key management ----------------------------------------------------*/
791 /* --- @km_init@ --- *
793 * Arguments: @const char *privkr@ = private keyring file
794 * @const char *pubkr@ = public keyring file
795 * @const char *ptag@ = default private-key tag
799 * Use: Initializes the key-management machinery, loading the
800 * keyrings and so on.
803 extern void km_init(const char */
*privkr*/
, const char */
*pubkr*/
,
804 const char */
*ptag*/
);
806 /* --- @km_reload@ --- *
810 * Returns: Zero if OK, nonzero to force reloading of keys.
812 * Use: Checks the keyrings to see if they need reloading.
815 extern int km_reload(void);
817 /* --- @km_findpub@, @km_findpriv@ --- *
819 * Arguments: @const char *tag@ = key tag to load
821 * Returns: Pointer to the kdata object if successful, or null on error.
823 * Use: Fetches a public or private key from the keyring.
826 extern kdata
*km_findpub(const char */
*tag*/
);
827 extern kdata
*km_findpriv(const char */
*tag*/
);
829 /* --- @km_samealgsp@ --- *
831 * Arguments: @const kdata *kdx, *kdy@ = two key data objects
833 * Returns: Nonzero if their two algorithm selections are the same.
835 * Use: Checks sameness of algorithm selections: used to ensure that
836 * peers are using sensible algorithms.
839 extern int km_samealgsp(const kdata */
*kdx*/
, const kdata */
*kdy*/
);
841 /* --- @km_ref@ --- *
843 * Arguments: @kdata *kd@ = pointer to the kdata object
847 * Use: Claim a new reference to a kdata object.
850 extern void km_ref(kdata */
*kd*/
);
852 /* --- @km_unref@ --- *
854 * Arguments: @kdata *kd@ = pointer to the kdata object
858 * Use: Releases a reference to a kdata object.
861 extern void km_unref(kdata */
*kd*/
);
863 /* --- @km_tag@ --- *
865 * Arguments: @kdata *kd@ - pointer to the kdata object
867 * Returns: A pointer to the short tag by which the kdata was loaded.
870 extern const char *km_tag(kdata */
*kd*/
);
872 /*----- Key exchange ------------------------------------------------------*/
874 /* --- @kx_start@ --- *
876 * Arguments: @keyexch *kx@ = pointer to key exchange context
877 * @int forcep@ = nonzero to ignore the quiet timer
881 * Use: Stimulates a key exchange. If a key exchage is in progress,
882 * a new challenge is sent (unless the quiet timer forbids
883 * this); if no exchange is in progress, one is commenced.
886 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
888 /* --- @kx_message@ --- *
890 * Arguments: @keyexch *kx@ = pointer to key exchange context
891 * @unsigned msg@ = the message code
892 * @buf *b@ = pointer to buffer containing the packet
896 * Use: Reads a packet containing key exchange messages and handles
900 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
902 /* --- @kx_free@ --- *
904 * Arguments: @keyexch *kx@ = pointer to key exchange context
908 * Use: Frees everything in a key exchange context.
911 extern void kx_free(keyexch */
*kx*/
);
913 /* --- @kx_newkeys@ --- *
915 * Arguments: @keyexch *kx@ = pointer to key exchange context
919 * Use: Informs the key exchange module that its keys may have
920 * changed. If fetching the new keys fails, the peer will be
921 * destroyed, we log messages and struggle along with the old
925 extern void kx_newkeys(keyexch */
*kx*/
);
927 /* --- @kx_init@ --- *
929 * Arguments: @keyexch *kx@ = pointer to key exchange context
930 * @peer *p@ = pointer to peer context
931 * @keyset **ks@ = pointer to keyset list
932 * @unsigned f@ = various useful flags
934 * Returns: Zero if OK, nonzero if it failed.
936 * Use: Initializes a key exchange module. The module currently
937 * contains no keys, and will attempt to initiate a key
941 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
,
942 keyset
**/
*ks*/
, unsigned /*f*/);
944 /*----- Keysets and symmetric cryptography --------------------------------*/
946 /* --- @ks_drop@ --- *
948 * Arguments: @keyset *ks@ = pointer to a keyset
952 * Use: Decrements a keyset's reference counter. If the counter hits
953 * zero, the keyset is freed.
956 extern void ks_drop(keyset */
*ks*/
);
958 /* --- @ks_gen@ --- *
960 * Arguments: @deriveargs *a@ = key derivation parameters (modified)
961 * @peer *p@ = pointer to peer information
963 * Returns: A pointer to the new keyset.
965 * Use: Derives a new keyset from the given key material. This will
966 * set the @what@, @f@, and @hc@ members in @*a@; other members
967 * must be filled in by the caller.
969 * The new key is marked so that it won't be selected for output
970 * by @ksl_encrypt@. You can still encrypt data with it by
971 * calling @ks_encrypt@ directly.
974 extern keyset
*ks_gen(deriveargs */
*a*/
, peer */
*p*/
);
976 /* --- @ks_activate@ --- *
978 * Arguments: @keyset *ks@ = pointer to a keyset
982 * Use: Activates a keyset, so that it can be used for encrypting
986 extern void ks_activate(keyset */
*ks*/
);
988 /* --- @ks_encrypt@ --- *
990 * Arguments: @keyset *ks@ = pointer to a keyset
991 * @unsigned ty@ = message type
992 * @buf *b@ = pointer to input buffer
993 * @buf *bb@ = pointer to output buffer
995 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
996 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
997 * returns zero if there was insufficient buffer (but the output
998 * buffer is broken in this case).
1000 * Use: Encrypts a block of data using the key. Note that the `key
1001 * ought to be replaced' notification is only ever given once
1002 * for each key. Also note that this call forces a keyset to be
1003 * used even if it's marked as not for data output.
1005 * The encryption transform is permitted to corrupt @buf_u@ for
1006 * its own purposes. Neither the source nor destination should
1007 * be within @buf_u@; and callers mustn't expect anything stored
1008 * in @buf_u@ to still
1011 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
1012 buf */
*b*/
, buf */
*bb*/
);
1014 /* --- @ks_decrypt@ --- *
1016 * Arguments: @keyset *ks@ = pointer to a keyset
1017 * @unsigned ty@ = expected type code
1018 * @buf *b@ = pointer to an input buffer
1019 * @buf *bb@ = pointer to an output buffer
1021 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1022 * zero if there was insufficient buffer (but the output buffer
1023 * is broken in this case).
1025 * Use: Attempts to decrypt a message using a given key. Note that
1026 * requesting decryption with a key directly won't clear a
1027 * marking that it's not for encryption.
1029 * The decryption transform is permitted to corrupt @buf_u@ for
1030 * its own purposes. Neither the source nor destination should
1031 * be within @buf_u@; and callers mustn't expect anything stored
1032 * in @buf_u@ to still
1035 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
1036 buf */
*b*/
, buf */
*bb*/
);
1038 /* --- @ksl_free@ --- *
1040 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1044 * Use: Frees (releases references to) all of the keys in a keyset.
1047 extern void ksl_free(keyset
**/
*ksroot*/
);
1049 /* --- @ksl_link@ --- *
1051 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1052 * @keyset *ks@ = pointer to a keyset
1056 * Use: Links a keyset into a list. A keyset can only be on one list
1057 * at a time. Bad things happen otherwise.
1060 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
1062 /* --- @ksl_prune@ --- *
1064 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1068 * Use: Prunes the keyset list by removing keys which mustn't be used
1072 extern void ksl_prune(keyset
**/
*ksroot*/
);
1074 /* --- @ksl_encrypt@ --- *
1076 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1077 * @unsigned ty@ = message type
1078 * @buf *b@ = pointer to input buffer
1079 * @buf *bb@ = pointer to output buffer
1081 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
1082 * new key; @KSERR_NOKEYS@ if there are no suitable keys
1083 * available. Also returns zero if there was insufficient
1084 * buffer space (but the output buffer is broken in this case).
1086 * Use: Encrypts a packet.
1089 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1090 buf */
*b*/
, buf */
*bb*/
);
1092 /* --- @ksl_decrypt@ --- *
1094 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1095 * @unsigned ty@ = expected type code
1096 * @buf *b@ = pointer to input buffer
1097 * @buf *bb@ = pointer to output buffer
1099 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1100 * zero if there was insufficient buffer (but the output buffer
1101 * is broken in this case).
1103 * Use: Decrypts a packet.
1106 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1107 buf */
*b*/
, buf */
*bb*/
);
1109 /*----- Challenges --------------------------------------------------------*/
1111 /* --- @c_new@ --- *
1113 * Arguments: @buf *b@ = where to put the challenge
1115 * Returns: Zero if OK, nonzero on error.
1117 * Use: Issues a new challenge.
1120 extern int c_new(buf */
*b*/
);
1122 /* --- @c_check@ --- *
1124 * Arguments: @buf *b@ = where to find the challenge
1126 * Returns: Zero if OK, nonzero if it didn't work.
1128 * Use: Checks a challenge. On failure, the buffer is broken.
1131 extern int c_check(buf */
*b*/
);
1133 /*----- Administration interface ------------------------------------------*/
1135 #define A_END ((char *)0)
1137 /* --- @a_vformat@ --- *
1139 * Arguments: @dstr *d@ = where to leave the formatted message
1140 * @const char *fmt@ = pointer to format string
1141 * @va_list *ap@ = arguments in list
1145 * Use: Main message token formatting driver. The arguments are
1146 * interleaved formatting tokens and their parameters, finally
1147 * terminated by an entry @A_END@.
1149 * Tokens recognized:
1151 * * "*..." ... -- pretokenized @dstr_putf@-like string
1153 * * "?ADDR" SOCKADDR -- a socket address, to be converted
1155 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
1157 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
1159 * * "?PEER" PEER -- peer's name
1161 * * "?ERRNO" ERRNO -- system error code
1163 * * "[!]..." ... -- @dstr_putf@-like string as single token
1166 extern void a_vformat(dstr */
*d*/
, const char */
*fmt*/
, va_list */
*ap*/
);
1168 /* --- @a_format@ --- *
1170 * Arguments: @dstr *d@ = where to leave the formatted message
1171 * @const char *fmt@ = pointer to format string
1175 * Use: Writes a tokenized message into a string, for later
1179 extern void EXECL_LIKE(0) a_format(dstr */
*d*/
, const char */
*fmt*/
, ...);
1181 /* --- @a_info@ --- *
1183 * Arguments: @admin *a@ = connection
1184 * @const char *fmt@ = format string
1185 * @...@ = other arguments
1189 * Use: Report information to an admin client.
1192 extern void EXECL_LIKE(0) a_info(admin */
*a*/
, const char */
*fmt*/
, ...);
1194 /* --- @a_warn@ --- *
1196 * Arguments: @const char *fmt@ = pointer to format string
1197 * @...@ = other arguments
1201 * Use: Informs all admin connections of a warning.
1204 extern void EXECL_LIKE(0) a_warn(const char */
*fmt*/
, ...);
1206 /* --- @a_notify@ --- *
1208 * Arguments: @const char *fmt@ = pointer to format string
1209 * @...@ = other arguments
1213 * Use: Sends a notification to interested admin connections.
1216 extern void EXECL_LIKE(0) a_notify(const char */
*fmt*/
, ...);
1218 /* --- @a_create@ --- *
1220 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1221 * @unsigned f@ = initial flags to set
1225 * Use: Creates a new admin connection.
1228 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
1230 /* --- @a_quit@ --- *
1236 * Use: Shuts things down nicely.
1239 extern void a_quit(void);
1241 /* --- @a_preselect@ --- *
1247 * Use: Informs the admin module that we're about to select again,
1248 * and that it should do cleanup things it has delayed until a
1252 extern void a_preselect(void);
1254 /* --- @a_daemon@ --- *
1260 * Use: Informs the admin module that it's a daemon.
1263 extern void a_daemon(void);
1265 /* --- @a_init@ --- *
1267 * Arguments: @const char *sock@ = socket name to create
1268 * @uid_t u@ = user to own the socket
1269 * @gid_t g@ = group to own the socket
1270 * @mode_t m@ = permissions to set on the socket
1274 * Use: Creates the admin listening socket.
1277 extern void a_init(const char */
*sock*/
,
1278 uid_t
/*u*/, gid_t
/*g*/, mode_t
/*m*/);
1280 /*----- Mapping with addresses as keys ------------------------------------*/
1282 /* --- @am_create@ --- *
1284 * Arguments: @addrmap *m@ = pointer to map
1288 * Use: Create an address map, properly set up.
1291 extern void am_create(addrmap */
*m*/
);
1293 /* --- @am_destroy@ --- *
1295 * Arguments: @addrmap *m@ = pointer to map
1299 * Use: Destroy an address map, throwing away all the entries.
1302 extern void am_destroy(addrmap */
*m*/
);
1304 /* --- @am_find@ --- *
1306 * Arguments: @addrmap *m@ = pointer to map
1307 * @const addr *a@ = address to look up
1308 * @size_t sz@ = size of block to allocate
1309 * @unsigned *f@ = where to store flags
1311 * Returns: Pointer to found item, or null.
1313 * Use: Finds a record with the given IP address, set @*f@ nonzero
1314 * and returns it. If @sz@ is zero, and no match was found,
1315 * return null; otherwise allocate a new block of @sz@ bytes,
1316 * clear @*f@ to zero and return the block pointer.
1319 extern void *am_find(addrmap */
*m*/
, const addr */
*a*/
,
1320 size_t /*sz*/, unsigned */
*f*/
);
1322 /* --- @am_remove@ --- *
1324 * Arguments: @addrmap *m@ = pointer to map
1325 * @void *i@ = pointer to the item
1329 * Use: Removes an item from the map.
1332 extern void am_remove(addrmap */
*m*/
, void */
*i*/
);
1334 /*----- Privilege separation ----------------------------------------------*/
1336 /* --- @ps_trace@ --- *
1338 * Arguments: @unsigned mask@ = trace mask to check
1339 * @const char *fmt@ = message format
1340 * @...@ = values for placeholders
1344 * Use: Writes a trace message.
1347 T( extern void PRINTF_LIKE(2, 3)
1348 ps_trace(unsigned /*mask*/, const char */
*fmt*/
, ...); )
1350 /* --- @ps_warn@ --- *
1352 * Arguments: @const char *fmt@ = message format
1353 * @...@ = values for placeholders
1357 * Use: Writes a warning message.
1360 extern void PRINTF_LIKE(1, 2) ps_warn(const char */
*fmt*/
, ...);
1362 /* --- @ps_tunfd@ --- *
1364 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1365 * @char **ifn@ = where to put the interface name
1367 * Returns: The file descriptor, or @-1@ on error.
1369 * Use: Fetches a file descriptor for a tunnel driver.
1372 extern int ps_tunfd(const tunnel_ops */
*tops*/
, char **/
*ifn*/
);
1374 /* --- @ps_split@ --- *
1376 * Arguments: @int detachp@ = whether to detach the child from its terminal
1380 * Use: Separates off the privileged tunnel-opening service from the
1381 * rest of the server.
1384 extern void ps_split(int /*detachp*/);
1386 /* --- @ps_quit@ --- *
1392 * Use: Detaches from the helper process.
1395 extern void ps_quit(void);
1397 /*----- Peer management ---------------------------------------------------*/
1399 /* --- @p_updateaddr@ --- *
1401 * Arguments: @peer *p@ = pointer to peer block
1402 * @const addr *a@ = address to associate with this peer
1404 * Returns: Zero if the address was changed; @+1@ if it was already
1407 * Use: Updates our idea of @p@'s address.
1410 extern int p_updateaddr(peer */
*p*/
, const addr */
*a*/
);
1412 /* --- @p_txstart@ --- *
1414 * Arguments: @peer *p@ = pointer to peer block
1415 * @unsigned msg@ = message type code
1417 * Returns: A pointer to a buffer to write to.
1419 * Use: Starts sending to a peer. Only one send can happen at a
1423 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
1425 /* --- @p_txend@ --- *
1427 * Arguments: @peer *p@ = pointer to peer block
1431 * Use: Sends a packet to the peer.
1434 extern void p_txend(peer */
*p*/
);
1436 /* --- @p_pingsend@ --- *
1438 * Arguments: @peer *p@ = destination peer
1439 * @ping *pg@ = structure to fill in
1440 * @unsigned type@ = message type
1441 * @unsigned long timeout@ = how long to wait before giving up
1442 * @void (*func)(int, void *)@ = callback function
1443 * @void *arg@ = argument for callback
1445 * Returns: Zero if successful, nonzero if it failed.
1447 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1448 * if we get an answer within the timeout, or zero if no answer.
1451 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
1452 unsigned long /*timeout*/,
1453 void (*/
*func*/
)(int, void *), void */
*arg*/
);
1455 /* --- @p_pingdone@ --- *
1457 * Arguments: @ping *p@ = ping structure
1458 * @int rc@ = return code to pass on
1462 * Use: Disposes of a ping structure, maybe sending a notification.
1465 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
1467 /* --- @p_greet@ --- *
1469 * Arguments: @peer *p@ = peer to send to
1470 * @const void *c@ = pointer to challenge
1471 * @size_t sz@ = size of challenge
1475 * Use: Sends a greeting packet.
1478 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
1480 /* --- @p_tun@ --- *
1482 * Arguments: @peer *p@ = pointer to peer block
1483 * @buf *b@ = buffer containing incoming packet
1487 * Use: Handles a packet which needs to be sent to a peer.
1490 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
1492 /* --- @p_keyreload@ --- *
1498 * Use: Forces a check of the daemon's keyring files.
1501 extern void p_keyreload(void);
1503 /* --- @p_interval@ --- *
1509 * Use: Called periodically to do tidying.
1512 extern void p_interval(void);
1514 /* --- @p_stats@ --- *
1516 * Arguments: @peer *p@ = pointer to a peer block
1518 * Returns: A pointer to the peer's statistics.
1521 extern stats
*p_stats(peer */
*p*/
);
1523 /* --- @p_ifname@ --- *
1525 * Arguments: @peer *p@ = pointer to a peer block
1527 * Returns: A pointer to the peer's interface name.
1530 extern const char *p_ifname(peer */
*p*/
);
1532 /* --- @p_setifname@ --- *
1534 * Arguments: @peer *p@ = pointer to a peer block
1535 * @const char *name@ = pointer to the new name
1539 * Use: Changes the name held for a peer's interface.
1542 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
1544 /* --- @p_addr@ --- *
1546 * Arguments: @peer *p@ = pointer to a peer block
1548 * Returns: A pointer to the peer's address.
1551 extern const addr
*p_addr(peer */
*p*/
);
1553 /* --- @p_init@ --- *
1555 * Arguments: @struct in_addr addr@ = address to bind to
1556 * @unsigned port@ = port number to listen to
1560 * Use: Initializes the peer system; creates the socket.
1563 extern void p_init(struct in_addr
/*addr*/, unsigned /*port*/);
1565 /* --- @p_port@ --- *
1569 * Returns: Port number used for socket.
1572 unsigned p_port(void);
1574 /* --- @p_create@ --- *
1576 * Arguments: @peerspec *spec@ = information about this peer
1578 * Returns: Pointer to the peer block, or null if it failed.
1580 * Use: Creates a new named peer block. No peer is actually attached
1584 extern peer
*p_create(peerspec */
*spec*/
);
1586 /* --- @p_name@ --- *
1588 * Arguments: @peer *p@ = pointer to a peer block
1590 * Returns: A pointer to the peer's name.
1592 * Use: Equivalent to @p_spec(p)->name@.
1595 extern const char *p_name(peer */
*p*/
);
1597 /* --- @p_tag@ --- *
1599 * Arguments: @peer *p@ = pointer to a peer block
1601 * Returns: A pointer to the peer's public key tag.
1604 extern const char *p_tag(peer */
*p*/
);
1606 /* --- @p_privtag@ --- *
1608 * Arguments: @peer *p@ = pointer to a peer block
1610 * Returns: A pointer to the peer's private key tag.
1613 extern const char *p_privtag(peer */
*p*/
);
1615 /* --- @p_spec@ --- *
1617 * Arguments: @peer *p@ = pointer to a peer block
1619 * Returns: Pointer to the peer's specification
1622 extern const peerspec
*p_spec(peer */
*p*/
);
1624 /* --- @p_findbyaddr@ --- *
1626 * Arguments: @const addr *a@ = address to look up
1628 * Returns: Pointer to the peer block, or null if not found.
1630 * Use: Finds a peer by address.
1633 extern peer
*p_findbyaddr(const addr */
*a*/
);
1635 /* --- @p_find@ --- *
1637 * Arguments: @const char *name@ = name to look up
1639 * Returns: Pointer to the peer block, or null if not found.
1641 * Use: Finds a peer by name.
1644 extern peer
*p_find(const char */
*name*/
);
1646 /* --- @p_destroy@ --- *
1648 * Arguments: @peer *p@ = pointer to a peer
1652 * Use: Destroys a peer.
1655 extern void p_destroy(peer */
*p*/
);
1657 /* --- @FOREACH_PEER@ --- *
1659 * Arguments: @p@ = name to bind to each peer
1660 * @stuff@ = thing to do for each item
1662 * Use: Does something for each current peer.
1665 #define FOREACH_PEER(p, stuff) do { \
1668 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \
1671 /* --- @p_mkiter@ --- *
1673 * Arguments: @peer_iter *i@ = pointer to an iterator
1677 * Use: Initializes the iterator.
1680 extern void p_mkiter(peer_iter */
*i*/
);
1682 /* --- @p_next@ --- *
1684 * Arguments: @peer_iter *i@ = pointer to an iterator
1686 * Returns: Next peer, or null if at the end.
1688 * Use: Returns the next peer.
1691 extern peer
*p_next(peer_iter */
*i*/
);
1693 /*----- Tunnel drivers ----------------------------------------------------*/
1696 extern const tunnel_ops tun_linux
;
1700 extern const tunnel_ops tun_unet
;
1704 extern const tunnel_ops tun_bsd
;
1707 extern const tunnel_ops tun_slip
;
1709 /*----- Other handy utilities ---------------------------------------------*/
1711 /* --- @timestr@ --- *
1713 * Arguments: @time_t t@ = a time to convert
1715 * Returns: A pointer to a textual representation of the time.
1717 * Use: Converts a time to a textual representation. Corrupts
1721 extern const char *timestr(time_t /*t*/);
1723 /* --- @mystrieq@ --- *
1725 * Arguments: @const char *x, *y@ = two strings
1727 * Returns: True if @x@ and @y are equal, up to case.
1730 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
1732 /* --- @addrsz@ --- *
1734 * Arguments: @const addr *a@ = a network address
1736 * Returns: The size of the address, for passing into the sockets API.
1739 extern socklen_t
addrsz(const addr */
*a*/
);
1741 /* --- @seq_reset@ --- *
1743 * Arguments: @seqwin *s@ = sequence-checking window
1747 * Use: Resets a sequence number window.
1750 extern void seq_reset(seqwin */
*s*/
);
1752 /* --- @seq_check@ --- *
1754 * Arguments: @seqwin *s@ = sequence-checking window
1755 * @uint32 q@ = sequence number to check
1756 * @const char *service@ = service to report message from
1758 * Returns: A @SEQ_@ code.
1760 * Use: Checks a sequence number against the window, updating things
1764 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1766 /*----- That's all, folks -------------------------------------------------*/