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
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * TrIPE is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with TrIPE; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 /*----- Header files ------------------------------------------------------*/
50 #include <sys/types.h>
57 #include <sys/socket.h>
59 #include <netinet/in.h>
60 #include <arpa/inet.h>
66 #include <mLib/alloc.h>
67 #include <mLib/arena.h>
68 #include <mLib/base64.h>
69 #include <mLib/bres.h>
70 #include <mLib/daemonize.h>
71 #include <mLib/dstr.h>
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 bulkalgs
{
185 const struct bulkops
*ops
;
188 typedef struct bulkctx
{
189 const struct bulkops
*ops
;
192 typedef struct bulkchal
{
193 const struct bulkops
*ops
;
199 typedef struct dhops
{
202 int (*ldpriv
)(key_file */
*kf*/
, key */
*k*/
, key_data */
*d*/
,
203 kdata */
*kd*/
, dstr */
*t*/
, dstr */
*e*/
);
204 /* Load a private key from @d@, storing the data in @kd@. The key's
205 * file and key object are in @kf@ and @k, mostly in case its
206 * attributes are interesting; the key tag is in @t@; errors are
207 * reported by writing tokens to @e@ and returning nonzero.
210 int (*ldpub
)(key_file */
*kf*/
, key */
*k*/
, key_data */
*d*/
,
211 kdata */
*kd*/
, dstr */
*t*/
, dstr */
*e*/
);
212 /* Load a public 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 const char *(*checkgrp
)(const dhgrp */
*g*/
);
219 /* Check that the group is valid; return null on success, or an error
223 void (*grpinfo
)(const dhgrp */
*g*/
, admin */
*a*/
);
224 /* Report on the group to an admin client. */
226 T( void (*tracegrp
)(const dhgrp */
*g*/
); )
227 /* Trace a description of the group. */
229 int (*samegrpp
)(const dhgrp */
*g*/
, const dhgrp */
*gg*/
);
230 /* Return nonzero if the two group objects represent the same
234 void (*freegrp
)(dhgrp */
*g*/
);
235 /* Free a group and the resources it holds. */
237 dhsc
*(*ldsc
)(const dhgrp */
*g*/
, const void */
*p*/
, size_t /*sz*/);
238 /* Load a scalar from @p@, @sz@ and return it. Return null on
242 int (*stsc
)(const dhgrp */
*g*/
,
243 void */
*p*/
, size_t /*sz*/, const dhsc */
*x*/
);
244 /* Store a scalar at @p@, @sz@. Return nonzero on error. */
246 dhsc
*(*randsc
)(const dhgrp */
*g*/
);
247 /* Return a random scalar. */
249 T( const char *(*scstr
)(const dhgrp */
*g*/
, const dhsc */
*x*/
); )
250 /* Return a human-readable representation of @x@; @buf_t@ may be used
254 void (*freesc
)(const dhgrp */
*g*/
, dhsc */
*x*/
);
255 /* Free a scalar and the resources it holds. */
257 dhge
*(*ldge
)(const dhgrp */
*g*/
, buf */
*b*/
, int /*fmt*/);
258 /* Load a group element from @b@, encoded using format @fmt@. Return
262 int (*stge
)(const dhgrp */
*g*/
, buf */
*b*/
,
263 const dhge */
*Y*/
, int /*fmt*/);
264 /* Store a group element in @b@, encoded using format @fmt@. Return
268 int (*checkge
)(const dhgrp */
*h*/
, const dhge */
*Y*/
);
269 /* Check a group element for validity. Return zero if everything
270 * checks out; nonzero on failure.
273 int (*eq
)(const dhgrp */
*g*/
, const dhge */
*Y*/
, const dhge */
*Z*/
);
274 /* Return nonzero if @Y@ and @Z@ are equal. */
276 dhge
*(*mul
)(const dhgrp */
*g*/
, const dhsc */
*x*/
, const dhge */
*Y*/
);
277 /* Multiply a group element by a scalar, resulting in a shared-secret
278 * group element. If @y@ is null, then multiply the well-known
282 T( const char *(*gestr
)(const dhgrp */
*g*/
, const dhge */
*Y*/
); )
283 /* Return a human-readable representation of @Y@; @buf_t@ may be used
287 void (*freege
)(const dhgrp */
*g*/
, dhge */
*Y*/
);
288 /* Free a group element and the resources it holds. */
292 typedef struct bulkops
{
295 bulkalgs
*(*getalgs
)(const algswitch */
*asw*/
, dstr */
*e*/
,
296 key_file */
*kf*/
, key */
*k*/
);
297 /* Determine algorithms to use and return a @bulkalgs@ object
298 * representing the decision. On error, write tokens to @e@ and
302 T( void (*tracealgs
)(const bulkalgs */
*a*/
); )
303 /* Write trace information about the algorithm selection. */
305 int (*checkalgs
)(bulkalgs */
*a*/
, const algswitch */
*asw*/
, dstr */
*e*/
);
306 /* Check that the algorithms in @a@ and @asw@ are acceptable. On
307 * error, write tokens to @e@ and return @-1@; otherwise return zero.
310 int (*samealgsp
)(const bulkalgs */
*a*/
, const bulkalgs */
*aa*/
);
311 /* If @a@ and @aa@ represent the same algorithm selection, return
312 * nonzero; if not, return zero.
315 void (*alginfo
)(const bulkalgs */
*a*/
, admin */
*adm*/
);
316 /* Report on the algorithm selection to an admin client: call
317 * @a_info@ with appropriate key-value pairs.
320 size_t (*overhead
)(const bulkalgs */
*a*/
);
321 /* Return the per-packet overhead of the bulk transform, in bytes. */
323 size_t (*expsz
)(const bulkalgs */
*a*/
);
324 /* Return the total size limit for the bulk transform, in bytes,
325 * after which the keys must no longer be used.
328 bulkctx
*(*genkeys
)(const bulkalgs */
*a*/
, const struct rawkey */
*rk*/
);
329 /* Generate session keys and construct and return an appropriate
330 * context for using them, by calling @ks_derive@.
333 bulkchal
*(*genchal
)(const bulkalgs */
*a*/
);
334 /* Construct and return a challenge issuing and verification
335 * context with a fresh random key.
338 void (*freealgs
)(bulkalgs */
*a*/
);
339 /* Release an algorithm selection object. (Associated bulk
340 * encryption contexts and challenge contexts may still exist and
341 * must remain valid.)
344 int (*encrypt
)(bulkctx */
*bc*/
, unsigned /*ty*/,
345 buf */
*b*/
, buf */
*bb*/
, uint32
/*seq*/);
346 /* Encrypt the packet in @b@, with type @ty@ (which doesn't need
347 * encoding separately) and sequence number @seq@ (which must be
348 * recoverable by @decrypt@), and write the result to @bb@. On
349 * error, return a @KSERR_...@ code and/or break the output buffer.
352 int (*decrypt
)(bulkctx */
*bc*/
, unsigned /*ty*/,
353 buf */
*b*/
, buf */
*bb*/
, uint32 */
*seq*/
);
354 /* Decrypt the packet in @b@, with type @ty@, writing the result to
355 * @bb@ and storing the incoming (claimed) sequence number in @seq@.
356 * On error, return a @KSERR_...@ code.
359 void (*freectx
)(bulkctx */
*a*/
);
360 /* Release a bulk encryption context and the resources it holds. */
362 int (*chaltag
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
364 /* Calculate a tag for the challenge in @m@, @msz@, and write it to
365 * @t@. Return @-1@ on error, zero on success.
368 int (*chalvrf
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
370 /* Check the tag @t@ on @m@, @msz@: return zero if the tag is OK,
371 * nonzero if it's bad.
374 void (*freechal
)(bulkchal */
*bc*/
);
375 /* Release a challenge context and the resources it holds. */
380 const gchash
*h
; size_t hashsz
; /* Hash function */
381 const gccipher
*mgf
; /* Mask-generation function */
382 bulkalgs
*bulk
; /* Bulk crypto algorithms */
386 unsigned ref
; /* Reference counter */
387 struct knode
*kn
; /* Pointer to cache entry */
388 char *tag
; /* Full tag name of the key */
389 dhgrp
*grp
; /* The group we work in */
390 dhsc
*k
; /* The private key (or null) */
391 dhge
*K
; /* The public key */
392 time_t t_exp
; /* Expiry time of the key */
393 algswitch algs
; /* Collection of algorithms */
396 typedef struct knode
{
397 sym_base _b
; /* Symbol table intrusion */
398 unsigned f
; /* Various flags */
399 #define KNF_BROKEN 1u /* Don't use this key any more */
400 struct keyhalf
*kh
; /* Pointer to the home keyhalf */
401 kdata
*kd
; /* Pointer to the key data */
404 #define MAXHASHSZ 64 /* Largest possible hash size */
406 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
408 extern const dhops dhtab
[];
409 extern const bulkops bulktab
[];
411 /*----- Data structures ---------------------------------------------------*/
413 /* --- Socket addresses --- *
415 * A magic union of supported socket addresses.
420 struct sockaddr_in sin
;
423 /* --- Mapping keyed on addresses --- */
425 typedef struct addrmap
{
430 typedef struct addrmap_base
{
435 /* --- Sequence number checking --- */
437 typedef struct seqwin
{
438 uint32 seq
; /* First acceptable input sequence */
439 uint32 win
; /* Window of acceptable numbers */
442 #define SEQ_WINSZ 32 /* Bits in sequence number window */
444 /* --- A symmetric keyset --- *
446 * A keyset contains a set of symmetric keys for encrypting and decrypting
447 * packets. Keysets are stored in a list, sorted in reverse order of
448 * creation, so that the most recent keyset (the one most likely to be used)
451 * Each keyset has a time limit and a data limit. The keyset is destroyed
452 * when either it has existed for too long, or it has been used to encrypt
453 * too much data. New key exchanges are triggered when keys are close to
457 enum { DIR_IN
, DIR_OUT
, NDIR
};
460 struct keyset
*next
; /* Next active keyset in the list */
461 unsigned ref
; /* Reference count for keyset */
462 struct peer
*p
; /* Pointer to peer structure */
463 time_t t_exp
; /* Expiry time for this keyset */
464 unsigned long sz_exp
, sz_regen
; /* Data limits for the keyset */
465 T( unsigned seq
; ) /* Sequence number for tracing */
466 unsigned f
; /* Various useful flags */
467 bulkctx
*bulk
; /* Bulk crypto transform */
468 uint32 oseq
; /* Outbound sequence number */
469 seqwin iseq
; /* Inbound sequence number */
472 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
473 #define KSF_LINK 2u /* Key is in a linked list */
475 #define KSERR_REGEN -1 /* Regenerate keys */
476 #define KSERR_NOKEYS -2 /* No keys left */
477 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
478 #define KSERR_SEQ -4 /* Incorrect sequence number */
479 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
481 /* --- Key exchange --- *
483 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
484 * Protocol has a number of desirable features (e.g., perfect forward
485 * secrecy, and zero-knowledge authentication) which make it attractive for
486 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
490 typedef struct retry
{
491 double t
; /* Current retry time */
496 typedef struct kxchal
{
497 struct keyexch
*kx
; /* Pointer back to key exchange */
498 dhge
*C
; /* Responder's challenge */
499 dhge
*R
; /* My reply to the challenge */
500 keyset
*ks
; /* Pointer to temporary keyset */
501 unsigned f
; /* Various useful flags */
502 sel_timer t
; /* Response timer for challenge */
503 retry rs
; /* Retry state */
504 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
505 octet ck
[MAXHASHSZ
]; /* His magical check value */
506 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
507 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
508 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
509 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
512 typedef struct keyexch
{
513 struct peer
*p
; /* Pointer back to the peer */
514 kdata
*kpriv
; /* Private key and related info */
515 kdata
*kpub
; /* Peer's public key */
516 keyset
**ks
; /* Peer's list of keysets */
517 unsigned f
; /* Various useful flags */
518 unsigned s
; /* Current state in exchange */
519 sel_timer t
; /* Timer for next exchange */
520 retry rs
; /* Retry state */
521 dhsc
*a
; /* My temporary secret */
522 dhge
*C
; /* My challenge */
523 dhge
*RX
; /* The expected response */
524 unsigned nr
; /* Number of extant responses */
525 time_t t_valid
; /* When this exchange goes bad */
526 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
527 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
530 #define KXF_TIMER 1u /* Waiting for a timer to go off */
531 #define KXF_DEAD 2u /* The key-exchanger isn't up */
532 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
533 #define KXF_CORK 8u /* Don't send anything yet */
536 KXS_DEAD
, /* Uninitialized state (magical) */
537 KXS_CHAL
, /* Main answer-challenges state */
538 KXS_COMMIT
, /* Committed: send switch request */
539 KXS_SWITCH
/* Switched: send confirmation */
542 /* --- Tunnel structure --- *
544 * Used to maintain system-specific information about the tunnel interface.
547 typedef struct tunnel tunnel
;
550 typedef struct tunnel_ops
{
551 const char *name
; /* Name of this tunnel driver */
552 unsigned flags
; /* Various interesting flags */
553 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
554 void (*init
)(void); /* Initializes the system */
555 tunnel
*(*create
)(struct peer */
*p*/
, int /*fd*/, char **/
*ifn*/
);
556 /* Initializes a new tunnel */
557 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
558 /* Notifies ifname change */
559 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
560 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
563 #ifndef TUN_INTERNALS
564 struct tunnel
{ const tunnel_ops
*ops
; };
567 /* --- Peer statistics --- *
569 * Contains various interesting and not-so-interesting statistics about a
570 * peer. This is updated by various parts of the code. The format of the
571 * structure isn't considered private, and @p_stats@ returns a pointer to the
572 * statistics block for a given peer.
575 typedef struct stats
{
576 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
577 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
578 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
579 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
580 unsigned long n_reject
; /* Number of rejected packets */
581 unsigned long n_in
, n_out
; /* Number of packets in and out */
582 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
583 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
586 /* --- Peer structure --- *
588 * The main structure which glues everything else together.
591 typedef struct peerspec
{
592 char *name
; /* Peer's name */
593 char *privtag
; /* Private key tag */
594 char *tag
; /* Public key tag */
595 const tunnel_ops
*tops
; /* Tunnel operations */
596 unsigned long t_ka
; /* Keep alive interval */
597 addr sa
; /* Socket address to speak to */
598 size_t sasz
; /* Socket address size */
599 unsigned f
; /* Flags for the peer */
600 #define PSF_KXMASK 255u /* Key-exchange flags to set */
601 #define PSF_MOBILE 256u /* Address may change rapidly */
604 typedef struct peer_byname
{
609 typedef struct peer_byaddr
{
614 typedef struct peer
{
615 peer_byname
*byname
; /* Lookup-by-name block */
616 peer_byaddr
*byaddr
; /* Lookup-by-address block */
617 struct ping
*pings
; /* Pings we're waiting for */
618 peerspec spec
; /* Specifications for this peer */
619 tunnel
*t
; /* Tunnel for local packets */
620 char *ifname
; /* Interface name for tunnel */
621 keyset
*ks
; /* List head for keysets */
622 buf b
; /* Buffer for sending packets */
623 stats st
; /* Statistics */
624 keyexch kx
; /* Key exchange protocol block */
625 sel_timer tka
; /* Timer for keepalives */
628 typedef struct peer_iter
{ sym_iter i
; } peer_iter
;
630 typedef struct ping
{
631 struct ping
*next
, *prev
; /* Links to next and previous */
632 peer
*p
; /* Peer so we can free it */
633 unsigned msg
; /* Kind of response expected */
634 uint32 id
; /* Id so we can recognize response */
635 octet magic
[32]; /* Some random data */
636 sel_timer t
; /* Timeout for ping */
637 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
638 void *arg
; /* Argument for callback */
649 /* --- Admin structure --- */
651 #define OBUFSZ 16384u
653 typedef struct obuf
{
654 struct obuf
*next
; /* Next buffer in list */
655 char *p_in
, *p_out
; /* Pointers into the buffer */
656 char buf
[OBUFSZ
]; /* The actual buffer */
659 typedef struct oqueue
{
660 obuf
*hd
, *tl
; /* Head and tail pointers */
665 typedef struct admin_bgop
{
666 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
667 struct admin
*a
; /* Owner job */
668 char *tag
; /* Tag string for messages */
669 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
672 typedef struct admin_resop
{
673 admin_bgop bg
; /* Background operation header */
674 char *addr
; /* Hostname to be resolved */
675 bres_client r
; /* Background resolver task */
676 sel_timer t
; /* Timer for resolver */
677 addr sa
; /* Socket address */
678 size_t sasz
; /* Socket address size */
679 void (*func
)(struct admin_resop
*, int); /* Handler */
682 enum { ARES_OK
, ARES_FAIL
};
684 typedef struct admin_addop
{
685 admin_resop r
; /* Name resolution header */
686 peerspec peer
; /* Peer pending creation */
689 typedef struct admin_pingop
{
690 admin_bgop bg
; /* Background operation header */
691 ping ping
; /* Ping pending response */
692 struct timeval pingtime
; /* Time last ping was sent */
695 typedef struct admin_service
{
696 sym_base _b
; /* Hash table base structure */
697 char *version
; /* The provided version */
698 struct admin
*prov
; /* Which client provides me */
699 struct admin_service
*next
, *prev
; /* Client's list of services */
702 typedef struct admin_svcop
{
703 admin_bgop bg
; /* Background operation header */
704 struct admin
*prov
; /* Client servicing this job */
705 unsigned index
; /* This job's index */
706 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
709 typedef struct admin_jobentry
{
710 unsigned short seq
; /* Zero if unused */
712 admin_svcop
*op
; /* Operation, if slot in use, ... */
713 uint32 next
; /* ... or index of next free slot */
717 typedef struct admin_jobtable
{
718 uint32 n
, sz
; /* Used slots and table size */
719 admin_svcop
*active
; /* List of active jobs */
720 uint32 free
; /* Index of first free slot */
721 admin_jobentry
*v
; /* And the big array of entries */
725 struct admin
*next
, *prev
; /* Links to next and previous */
726 unsigned f
; /* Various useful flags */
727 unsigned ref
; /* Reference counter */
729 unsigned seq
; /* Sequence number for tracing */
731 oqueue out
; /* Output buffer list */
732 oqueue delay
; /* Delayed output buffer list */
733 admin_bgop
*bg
; /* Backgrounded operations */
734 admin_service
*svcs
; /* Which services I provide */
735 admin_jobtable j
; /* Table of outstanding jobs */
736 selbuf b
; /* Line buffer for commands */
737 sel_file w
; /* Selector for write buffering */
740 #define AF_DEAD 1u /* Destroy this admin block */
741 #define AF_CLOSE 2u /* Client closed connection */
742 #define AF_NOTE 4u /* Catch notifications */
743 #define AF_WARN 8u /* Catch warning messages */
745 #define AF_TRACE 16u /* Catch tracing */
747 #define AF_FOREGROUND 32u /* Quit server when client closes */
750 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
752 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
755 /*----- Global variables --------------------------------------------------*/
757 extern sel_state sel
; /* Global I/O event state */
758 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
], buf_u
[PKBUFSZ
];
759 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
760 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
761 extern kdata
*master
; /* Default private key */
762 extern const char *tag_priv
; /* Default private key tag */
765 extern const trace_opt tr_opts
[]; /* Trace options array */
766 extern unsigned tr_flags
; /* Trace options flags */
769 /*----- Other macros ------------------------------------------------------*/
772 do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0)
774 /*----- Key management ----------------------------------------------------*/
776 /* --- @km_init@ --- *
778 * Arguments: @const char *privkr@ = private keyring file
779 * @const char *pubkr@ = public keyring file
780 * @const char *ptag@ = default private-key tag
784 * Use: Initializes the key-management machinery, loading the
785 * keyrings and so on.
788 extern void km_init(const char */
*privkr*/
, const char */
*pubkr*/
,
789 const char */
*ptag*/
);
791 /* --- @km_reload@ --- *
795 * Returns: Zero if OK, nonzero to force reloading of keys.
797 * Use: Checks the keyrings to see if they need reloading.
800 extern int km_reload(void);
802 /* --- @km_findpub@, @km_findpriv@ --- *
804 * Arguments: @const char *tag@ = key tag to load
806 * Returns: Pointer to the kdata object if successful, or null on error.
808 * Use: Fetches a public or private key from the keyring.
811 extern kdata
*km_findpub(const char */
*tag*/
);
812 extern kdata
*km_findpriv(const char */
*tag*/
);
814 /* --- @km_samealgsp@ --- *
816 * Arguments: @const kdata *kdx, *kdy@ = two key data objects
818 * Returns: Nonzero if their two algorithm selections are the same.
820 * Use: Checks sameness of algorithm selections: used to ensure that
821 * peers are using sensible algorithms.
824 extern int km_samealgsp(const kdata */
*kdx*/
, const kdata */
*kdy*/
);
826 /* --- @km_ref@ --- *
828 * Arguments: @kdata *kd@ = pointer to the kdata object
832 * Use: Claim a new reference to a kdata object.
835 extern void km_ref(kdata */
*kd*/
);
837 /* --- @km_unref@ --- *
839 * Arguments: @kdata *kd@ = pointer to the kdata object
843 * Use: Releases a reference to a kdata object.
846 extern void km_unref(kdata */
*kd*/
);
848 /* --- @km_tag@ --- *
850 * Arguments: @kdata *kd@ - pointer to the kdata object
852 * Returns: A pointer to the short tag by which the kdata was loaded.
855 extern const char *km_tag(kdata */
*kd*/
);
857 /*----- Key exchange ------------------------------------------------------*/
859 /* --- @kx_start@ --- *
861 * Arguments: @keyexch *kx@ = pointer to key exchange context
862 * @int forcep@ = nonzero to ignore the quiet timer
866 * Use: Stimulates a key exchange. If a key exchage is in progress,
867 * a new challenge is sent (unless the quiet timer forbids
868 * this); if no exchange is in progress, one is commenced.
871 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
873 /* --- @kx_message@ --- *
875 * Arguments: @keyexch *kx@ = pointer to key exchange context
876 * @unsigned msg@ = the message code
877 * @buf *b@ = pointer to buffer containing the packet
881 * Use: Reads a packet containing key exchange messages and handles
885 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
887 /* --- @kx_free@ --- *
889 * Arguments: @keyexch *kx@ = pointer to key exchange context
893 * Use: Frees everything in a key exchange context.
896 extern void kx_free(keyexch */
*kx*/
);
898 /* --- @kx_newkeys@ --- *
900 * Arguments: @keyexch *kx@ = pointer to key exchange context
904 * Use: Informs the key exchange module that its keys may have
905 * changed. If fetching the new keys fails, the peer will be
906 * destroyed, we log messages and struggle along with the old
910 extern void kx_newkeys(keyexch */
*kx*/
);
912 /* --- @kx_init@ --- *
914 * Arguments: @keyexch *kx@ = pointer to key exchange context
915 * @peer *p@ = pointer to peer context
916 * @keyset **ks@ = pointer to keyset list
917 * @unsigned f@ = various useful flags
919 * Returns: Zero if OK, nonzero if it failed.
921 * Use: Initializes a key exchange module. The module currently
922 * contains no keys, and will attempt to initiate a key
926 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
,
927 keyset
**/
*ks*/
, unsigned /*f*/);
929 /*----- Keysets and symmetric cryptography --------------------------------*/
931 /* --- @ks_drop@ --- *
933 * Arguments: @keyset *ks@ = pointer to a keyset
937 * Use: Decrements a keyset's reference counter. If the counter hits
938 * zero, the keyset is freed.
941 extern void ks_drop(keyset */
*ks*/
);
943 /* --- @ks_derivekey@ --- *
945 * Arguments: @octet *k@ = pointer to an output buffer of at least
947 * @size_t ksz@ = actual size wanted (for tracing)
948 * @const struct rawkey *rk@ = a raw key, as passed into
950 * @int dir@ = direction for the key (@DIR_IN@ or @DIR_OUT@)
951 * @const char *what@ = label for the key (input to derivation)
955 * Use: Derives a session key, for use on incoming or outgoing data.
956 * This function is part of a private protocol between @ks_gen@
957 * and the bulk crypto transform @genkeys@ operation.
960 extern void ks_derivekey(octet */
*k*/
, size_t /*ksz*/,
961 const struct rawkey */
*rk*/
,
962 int /*dir*/, const char */
*what*/
);
964 /* --- @ks_gen@ --- *
966 * Arguments: @const void *k@ = pointer to key material
967 * @size_t x, y, z@ = offsets into key material (see below)
968 * @peer *p@ = pointer to peer information
970 * Returns: A pointer to the new keyset.
972 * Use: Derives a new keyset from the given key material. The
973 * offsets @x@, @y@ and @z@ separate the key material into three
974 * parts. Between the @k@ and @k + x@ is `my' contribution to
975 * the key material; between @k + x@ and @k + y@ is `your'
976 * contribution; and between @k + y@ and @k + z@ is a shared
977 * value we made together. These are used to construct two
978 * pairs of symmetric keys. Each pair consists of an encryption
979 * key and a message authentication key. One pair is used for
980 * outgoing messages, the other for incoming messages.
982 * The new key is marked so that it won't be selected for output
983 * by @ksl_encrypt@. You can still encrypt data with it by
984 * calling @ks_encrypt@ directly.
987 extern keyset
*ks_gen(const void */
*k*/
,
988 size_t /*x*/, size_t /*y*/, size_t /*z*/,
991 /* --- @ks_activate@ --- *
993 * Arguments: @keyset *ks@ = pointer to a keyset
997 * Use: Activates a keyset, so that it can be used for encrypting
1001 extern void ks_activate(keyset */
*ks*/
);
1003 /* --- @ks_encrypt@ --- *
1005 * Arguments: @keyset *ks@ = pointer to a keyset
1006 * @unsigned ty@ = message type
1007 * @buf *b@ = pointer to input buffer
1008 * @buf *bb@ = pointer to output buffer
1010 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
1011 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
1012 * returns zero if there was insufficient buffer (but the output
1013 * buffer is broken in this case).
1015 * Use: Encrypts a block of data using the key. Note that the `key
1016 * ought to be replaced' notification is only ever given once
1017 * for each key. Also note that this call forces a keyset to be
1018 * used even if it's marked as not for data output.
1020 * The encryption transform is permitted to corrupt @buf_u@ for
1021 * its own purposes. Neither the source nor destination should
1022 * be within @buf_u@; and callers mustn't expect anything stored
1023 * in @buf_u@ to still
1026 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
1027 buf */
*b*/
, buf */
*bb*/
);
1029 /* --- @ks_decrypt@ --- *
1031 * Arguments: @keyset *ks@ = pointer to a keyset
1032 * @unsigned ty@ = expected type code
1033 * @buf *b@ = pointer to an input buffer
1034 * @buf *bb@ = pointer to an output buffer
1036 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1037 * zero if there was insufficient buffer (but the output buffer
1038 * is broken in this case).
1040 * Use: Attempts to decrypt a message using a given key. Note that
1041 * requesting decryption with a key directly won't clear a
1042 * marking that it's not for encryption.
1044 * The decryption transform is permitted to corrupt @buf_u@ for
1045 * its own purposes. Neither the source nor destination should
1046 * be within @buf_u@; and callers mustn't expect anything stored
1047 * in @buf_u@ to still
1050 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
1051 buf */
*b*/
, buf */
*bb*/
);
1053 /* --- @ksl_free@ --- *
1055 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1059 * Use: Frees (releases references to) all of the keys in a keyset.
1062 extern void ksl_free(keyset
**/
*ksroot*/
);
1064 /* --- @ksl_link@ --- *
1066 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1067 * @keyset *ks@ = pointer to a keyset
1071 * Use: Links a keyset into a list. A keyset can only be on one list
1072 * at a time. Bad things happen otherwise.
1075 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
1077 /* --- @ksl_prune@ --- *
1079 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1083 * Use: Prunes the keyset list by removing keys which mustn't be used
1087 extern void ksl_prune(keyset
**/
*ksroot*/
);
1089 /* --- @ksl_encrypt@ --- *
1091 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1092 * @unsigned ty@ = message type
1093 * @buf *b@ = pointer to input buffer
1094 * @buf *bb@ = pointer to output buffer
1096 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
1097 * new key; @KSERR_NOKEYS@ if there are no suitable keys
1098 * available. Also returns zero if there was insufficient
1099 * buffer space (but the output buffer is broken in this case).
1101 * Use: Encrypts a packet.
1104 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1105 buf */
*b*/
, buf */
*bb*/
);
1107 /* --- @ksl_decrypt@ --- *
1109 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1110 * @unsigned ty@ = expected type code
1111 * @buf *b@ = pointer to input buffer
1112 * @buf *bb@ = pointer to output buffer
1114 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1115 * zero if there was insufficient buffer (but the output buffer
1116 * is broken in this case).
1118 * Use: Decrypts a packet.
1121 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1122 buf */
*b*/
, buf */
*bb*/
);
1124 /*----- Challenges --------------------------------------------------------*/
1126 /* --- @c_new@ --- *
1128 * Arguments: @buf *b@ = where to put the challenge
1130 * Returns: Zero if OK, nonzero on error.
1132 * Use: Issues a new challenge.
1135 extern int c_new(buf */
*b*/
);
1137 /* --- @c_check@ --- *
1139 * Arguments: @buf *b@ = where to find the challenge
1141 * Returns: Zero if OK, nonzero if it didn't work.
1143 * Use: Checks a challenge. On failure, the buffer is broken.
1146 extern int c_check(buf */
*b*/
);
1148 /*----- Administration interface ------------------------------------------*/
1150 #define A_END ((char *)0)
1152 /* --- @a_vformat@ --- *
1154 * Arguments: @dstr *d@ = where to leave the formatted message
1155 * @const char *fmt@ = pointer to format string
1156 * @va_list *ap@ = arguments in list
1160 * Use: Main message token formatting driver. The arguments are
1161 * interleaved formatting tokens and their parameters, finally
1162 * terminated by an entry @A_END@.
1164 * Tokens recognized:
1166 * * "*..." ... -- pretokenized @dstr_putf@-like string
1168 * * "?ADDR" SOCKADDR -- a socket address, to be converted
1170 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
1172 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
1174 * * "?PEER" PEER -- peer's name
1176 * * "?ERRNO" ERRNO -- system error code
1178 * * "[!]..." ... -- @dstr_putf@-like string as single token
1181 extern void a_vformat(dstr */
*d*/
, const char */
*fmt*/
, va_list */
*ap*/
);
1183 /* --- @a_format@ --- *
1185 * Arguments: @dstr *d@ = where to leave the formatted message
1186 * @const char *fmt@ = pointer to format string
1190 * Use: Writes a tokenized message into a string, for later
1194 extern void EXECL_LIKE(0) a_format(dstr */
*d*/
, const char */
*fmt*/
, ...);
1196 /* --- @a_info@ --- *
1198 * Arguments: @admin *a@ = connection
1199 * @const char *fmt@ = format string
1200 * @...@ = other arguments
1204 * Use: Report information to an admin client.
1207 extern void EXECL_LIKE(0) a_info(admin */
*a*/
, const char */
*fmt*/
, ...);
1209 /* --- @a_warn@ --- *
1211 * Arguments: @const char *fmt@ = pointer to format string
1212 * @...@ = other arguments
1216 * Use: Informs all admin connections of a warning.
1219 extern void EXECL_LIKE(0) a_warn(const char */
*fmt*/
, ...);
1221 /* --- @a_notify@ --- *
1223 * Arguments: @const char *fmt@ = pointer to format string
1224 * @...@ = other arguments
1228 * Use: Sends a notification to interested admin connections.
1231 extern void EXECL_LIKE(0) a_notify(const char */
*fmt*/
, ...);
1233 /* --- @a_create@ --- *
1235 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1236 * @unsigned f@ = initial flags to set
1240 * Use: Creates a new admin connection.
1243 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
1245 /* --- @a_quit@ --- *
1251 * Use: Shuts things down nicely.
1254 extern void a_quit(void);
1256 /* --- @a_preselect@ --- *
1262 * Use: Informs the admin module that we're about to select again,
1263 * and that it should do cleanup things it has delayed until a
1267 extern void a_preselect(void);
1269 /* --- @a_daemon@ --- *
1275 * Use: Informs the admin module that it's a daemon.
1278 extern void a_daemon(void);
1280 /* --- @a_init@ --- *
1282 * Arguments: @const char *sock@ = socket name to create
1283 * @uid_t u@ = user to own the socket
1284 * @gid_t g@ = group to own the socket
1285 * @mode_t m@ = permissions to set on the socket
1289 * Use: Creates the admin listening socket.
1292 extern void a_init(const char */
*sock*/
,
1293 uid_t
/*u*/, gid_t
/*g*/, mode_t
/*m*/);
1295 /*----- Mapping with addresses as keys ------------------------------------*/
1297 /* --- @am_create@ --- *
1299 * Arguments: @addrmap *m@ = pointer to map
1303 * Use: Create an address map, properly set up.
1306 extern void am_create(addrmap */
*m*/
);
1308 /* --- @am_destroy@ --- *
1310 * Arguments: @addrmap *m@ = pointer to map
1314 * Use: Destroy an address map, throwing away all the entries.
1317 extern void am_destroy(addrmap */
*m*/
);
1319 /* --- @am_find@ --- *
1321 * Arguments: @addrmap *m@ = pointer to map
1322 * @const addr *a@ = address to look up
1323 * @size_t sz@ = size of block to allocate
1324 * @unsigned *f@ = where to store flags
1326 * Returns: Pointer to found item, or null.
1328 * Use: Finds a record with the given IP address, set @*f@ nonzero
1329 * and returns it. If @sz@ is zero, and no match was found,
1330 * return null; otherwise allocate a new block of @sz@ bytes,
1331 * clear @*f@ to zero and return the block pointer.
1334 extern void *am_find(addrmap */
*m*/
, const addr */
*a*/
,
1335 size_t /*sz*/, unsigned */
*f*/
);
1337 /* --- @am_remove@ --- *
1339 * Arguments: @addrmap *m@ = pointer to map
1340 * @void *i@ = pointer to the item
1344 * Use: Removes an item from the map.
1347 extern void am_remove(addrmap */
*m*/
, void */
*i*/
);
1349 /*----- Privilege separation ----------------------------------------------*/
1351 /* --- @ps_trace@ --- *
1353 * Arguments: @unsigned mask@ = trace mask to check
1354 * @const char *fmt@ = message format
1355 * @...@ = values for placeholders
1359 * Use: Writes a trace message.
1362 T( extern void PRINTF_LIKE(2, 3)
1363 ps_trace(unsigned /*mask*/, const char */
*fmt*/
, ...); )
1365 /* --- @ps_warn@ --- *
1367 * Arguments: @const char *fmt@ = message format
1368 * @...@ = values for placeholders
1372 * Use: Writes a warning message.
1375 extern void PRINTF_LIKE(1, 2) ps_warn(const char */
*fmt*/
, ...);
1377 /* --- @ps_tunfd@ --- *
1379 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1380 * @char **ifn@ = where to put the interface name
1382 * Returns: The file descriptor, or @-1@ on error.
1384 * Use: Fetches a file descriptor for a tunnel driver.
1387 extern int ps_tunfd(const tunnel_ops */
*tops*/
, char **/
*ifn*/
);
1389 /* --- @ps_split@ --- *
1391 * Arguments: @int detachp@ = whether to detach the child from its terminal
1395 * Use: Separates off the privileged tunnel-opening service from the
1396 * rest of the server.
1399 extern void ps_split(int /*detachp*/);
1401 /* --- @ps_quit@ --- *
1407 * Use: Detaches from the helper process.
1410 extern void ps_quit(void);
1412 /*----- Peer management ---------------------------------------------------*/
1414 /* --- @p_txstart@ --- *
1416 * Arguments: @peer *p@ = pointer to peer block
1417 * @unsigned msg@ = message type code
1419 * Returns: A pointer to a buffer to write to.
1421 * Use: Starts sending to a peer. Only one send can happen at a
1425 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
1427 /* --- @p_txend@ --- *
1429 * Arguments: @peer *p@ = pointer to peer block
1433 * Use: Sends a packet to the peer.
1436 extern void p_txend(peer */
*p*/
);
1438 /* --- @p_pingsend@ --- *
1440 * Arguments: @peer *p@ = destination peer
1441 * @ping *pg@ = structure to fill in
1442 * @unsigned type@ = message type
1443 * @unsigned long timeout@ = how long to wait before giving up
1444 * @void (*func)(int, void *)@ = callback function
1445 * @void *arg@ = argument for callback
1447 * Returns: Zero if successful, nonzero if it failed.
1449 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1450 * if we get an answer within the timeout, or zero if no answer.
1453 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
1454 unsigned long /*timeout*/,
1455 void (*/
*func*/
)(int, void *), void */
*arg*/
);
1457 /* --- @p_pingdone@ --- *
1459 * Arguments: @ping *p@ = ping structure
1460 * @int rc@ = return code to pass on
1464 * Use: Disposes of a ping structure, maybe sending a notification.
1467 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
1469 /* --- @p_greet@ --- *
1471 * Arguments: @peer *p@ = peer to send to
1472 * @const void *c@ = pointer to challenge
1473 * @size_t sz@ = size of challenge
1477 * Use: Sends a greeting packet.
1480 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
1482 /* --- @p_tun@ --- *
1484 * Arguments: @peer *p@ = pointer to peer block
1485 * @buf *b@ = buffer containing incoming packet
1489 * Use: Handles a packet which needs to be sent to a peer.
1492 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
1494 /* --- @p_keyreload@ --- *
1500 * Use: Forces a check of the daemon's keyring files.
1503 extern void p_keyreload(void);
1505 /* --- @p_interval@ --- *
1511 * Use: Called periodically to do tidying.
1514 extern void p_interval(void);
1516 /* --- @p_stats@ --- *
1518 * Arguments: @peer *p@ = pointer to a peer block
1520 * Returns: A pointer to the peer's statistics.
1523 extern stats
*p_stats(peer */
*p*/
);
1525 /* --- @p_ifname@ --- *
1527 * Arguments: @peer *p@ = pointer to a peer block
1529 * Returns: A pointer to the peer's interface name.
1532 extern const char *p_ifname(peer */
*p*/
);
1534 /* --- @p_setifname@ --- *
1536 * Arguments: @peer *p@ = pointer to a peer block
1537 * @const char *name@ = pointer to the new name
1541 * Use: Changes the name held for a peer's interface.
1544 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
1546 /* --- @p_addr@ --- *
1548 * Arguments: @peer *p@ = pointer to a peer block
1550 * Returns: A pointer to the peer's address.
1553 extern const addr
*p_addr(peer */
*p*/
);
1555 /* --- @p_init@ --- *
1557 * Arguments: @struct in_addr addr@ = address to bind to
1558 * @unsigned port@ = port number to listen to
1562 * Use: Initializes the peer system; creates the socket.
1565 extern void p_init(struct in_addr
/*addr*/, unsigned /*port*/);
1567 /* --- @p_port@ --- *
1571 * Returns: Port number used for socket.
1574 unsigned p_port(void);
1576 /* --- @p_create@ --- *
1578 * Arguments: @peerspec *spec@ = information about this peer
1580 * Returns: Pointer to the peer block, or null if it failed.
1582 * Use: Creates a new named peer block. No peer is actually attached
1586 extern peer
*p_create(peerspec */
*spec*/
);
1588 /* --- @p_name@ --- *
1590 * Arguments: @peer *p@ = pointer to a peer block
1592 * Returns: A pointer to the peer's name.
1594 * Use: Equivalent to @p_spec(p)->name@.
1597 extern const char *p_name(peer */
*p*/
);
1599 /* --- @p_tag@ --- *
1601 * Arguments: @peer *p@ = pointer to a peer block
1603 * Returns: A pointer to the peer's public key tag.
1606 extern const char *p_tag(peer */
*p*/
);
1608 /* --- @p_privtag@ --- *
1610 * Arguments: @peer *p@ = pointer to a peer block
1612 * Returns: A pointer to the peer's private key tag.
1615 extern const char *p_privtag(peer */
*p*/
);
1617 /* --- @p_spec@ --- *
1619 * Arguments: @peer *p@ = pointer to a peer block
1621 * Returns: Pointer to the peer's specification
1624 extern const peerspec
*p_spec(peer */
*p*/
);
1626 /* --- @p_findbyaddr@ --- *
1628 * Arguments: @const addr *a@ = address to look up
1630 * Returns: Pointer to the peer block, or null if not found.
1632 * Use: Finds a peer by address.
1635 extern peer
*p_findbyaddr(const addr */
*a*/
);
1637 /* --- @p_find@ --- *
1639 * Arguments: @const char *name@ = name to look up
1641 * Returns: Pointer to the peer block, or null if not found.
1643 * Use: Finds a peer by name.
1646 extern peer
*p_find(const char */
*name*/
);
1648 /* --- @p_destroy@ --- *
1650 * Arguments: @peer *p@ = pointer to a peer
1654 * Use: Destroys a peer.
1657 extern void p_destroy(peer */
*p*/
);
1659 /* --- @FOREACH_PEER@ --- *
1661 * Arguments: @p@ = name to bind to each peer
1662 * @stuff@ = thing to do for each item
1664 * Use: Does something for each current peer.
1667 #define FOREACH_PEER(p, stuff) do { \
1670 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \
1673 /* --- @p_mkiter@ --- *
1675 * Arguments: @peer_iter *i@ = pointer to an iterator
1679 * Use: Initializes the iterator.
1682 extern void p_mkiter(peer_iter */
*i*/
);
1684 /* --- @p_next@ --- *
1686 * Arguments: @peer_iter *i@ = pointer to an iterator
1688 * Returns: Next peer, or null if at the end.
1690 * Use: Returns the next peer.
1693 extern peer
*p_next(peer_iter */
*i*/
);
1695 /*----- Tunnel drivers ----------------------------------------------------*/
1698 extern const tunnel_ops tun_linux
;
1702 extern const tunnel_ops tun_unet
;
1706 extern const tunnel_ops tun_bsd
;
1709 extern const tunnel_ops tun_slip
;
1711 /*----- Other handy utilities ---------------------------------------------*/
1713 /* --- @timestr@ --- *
1715 * Arguments: @time_t t@ = a time to convert
1717 * Returns: A pointer to a textual representation of the time.
1719 * Use: Converts a time to a textual representation. Corrupts
1723 extern const char *timestr(time_t /*t*/);
1725 /* --- @mystrieq@ --- *
1727 * Arguments: @const char *x, *y@ = two strings
1729 * Returns: True if @x@ and @y are equal, up to case.
1732 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
1734 /* --- @seq_reset@ --- *
1736 * Arguments: @seqwin *s@ = sequence-checking window
1740 * Use: Resets a sequence number window.
1743 extern void seq_reset(seqwin */
*s*/
);
1745 /* --- @seq_check@ --- *
1747 * Arguments: @seqwin *s@ = sequence-checking window
1748 * @uint32 q@ = sequence number to check
1749 * @const char *service@ = service to report message from
1751 * Returns: A @SEQ_@ code.
1753 * Use: Checks a sequence number against the window, updating things
1757 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1759 /*----- That's all, folks -------------------------------------------------*/