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>
115 #include "protocol.h"
121 /*----- Magic numbers -----------------------------------------------------*/
123 /* --- Trace flags --- */
131 #define T_KEYEXCH 64u
132 #define T_KEYMGMT 128u
134 /* T_PRIVSEP in priv.h */
140 #define SEC(n) (n##u)
141 #define MIN(n) (n##u * 60u)
142 #define F_2P32 (65536.0*65536.0)
143 #define MEG(n) (n##ul * 1024ul * 1024ul)
145 /* --- Timing parameters --- */
147 #define T_EXP MIN(60) /* Expiry time for a key */
148 #define T_REGEN MIN(40) /* Regeneration time for a key */
150 #define T_VALID SEC(20) /* Challenge validity period */
151 #define T_RETRYMIN SEC(2) /* Minimum retry interval */
152 #define T_RETRYMAX MIN(5) /* Maximum retry interval */
153 #define T_RETRYGROW (5.0/4.0) /* Retry interval growth factor */
155 #define T_WOBBLE (1.0/3.0) /* Relative timer randomness */
157 /* --- Other things --- */
159 #define PKBUFSZ 65536
161 /*----- Cipher selections -------------------------------------------------*/
163 typedef struct keyset keyset
;
164 typedef struct algswitch algswitch
;
165 typedef struct kdata kdata
;
166 typedef struct admin admin
;
168 typedef struct dhgrp
{
169 const struct dhops
*ops
;
173 typedef struct dhsc dhsc
;
174 typedef struct dhge dhge
;
177 DHFMT_STD
, /* Fixed-width format, suitable for encryption */
178 DHFMT_HASH
, /* Deterministic format, suitable for hashing */
179 DHFMT_VAR
/* Variable-width-format, mostly a bad idea */
182 typedef struct bulkalgs
{
183 const struct bulkops
*ops
;
186 typedef struct bulkctx
{
187 const struct bulkops
*ops
;
190 typedef struct bulkchal
{
191 const struct bulkops
*ops
;
197 typedef struct dhops
{
200 int (*ldpriv
)(key_file */
*kf*/
, key */
*k*/
, key_data */
*d*/
,
201 kdata */
*kd*/
, dstr */
*t*/
, dstr */
*e*/
);
202 /* Load a private key from @d@, storing the data in @kd@. The key's
203 * file and key object are in @kf@ and @k, mostly in case its
204 * attributes are interesting; the key tag is in @t@; errors are
205 * reported by writing tokens to @e@ and returning nonzero.
208 int (*ldpub
)(key_file */
*kf*/
, key */
*k*/
, key_data */
*d*/
,
209 kdata */
*kd*/
, dstr */
*t*/
, dstr */
*e*/
);
210 /* Load a public key from @d@, storing the data in @kd@. The key's
211 * file and key object are in @kf@ and @k, mostly in case its
212 * attributes are interesting; the key tag is in @t@; errors are
213 * reported by writing tokens to @e@ and returning nonzero.
216 const char *(*checkgrp
)(const dhgrp */
*g*/
);
217 /* Check that the group is valid; return null on success, or an error
221 void (*grpinfo
)(const dhgrp */
*g*/
, admin */
*a*/
);
222 /* Report on the group to an admin client. */
224 T( void (*tracegrp
)(const dhgrp */
*g*/
); )
225 /* Trace a description of the group. */
227 int (*samegrpp
)(const dhgrp */
*g*/
, const dhgrp */
*gg*/
);
228 /* Return nonzero if the two group objects represent the same
232 void (*freegrp
)(dhgrp */
*g*/
);
233 /* Free a group and the resources it holds. */
235 dhsc
*(*ldsc
)(const dhgrp */
*g*/
, const void */
*p*/
, size_t /*sz*/);
236 /* Load a scalar from @p@, @sz@ and return it. Return null on
240 int (*stsc
)(const dhgrp */
*g*/
,
241 void */
*p*/
, size_t /*sz*/, const dhsc */
*x*/
);
242 /* Store a scalar at @p@, @sz@. Return nonzero on error. */
244 dhsc
*(*randsc
)(const dhgrp */
*g*/
);
245 /* Return a random scalar. */
247 T( const char *(*scstr
)(const dhgrp */
*g*/
, const dhsc */
*x*/
); )
248 /* Return a human-readable representation of @x@; @buf_t@ may be used
252 void (*freesc
)(const dhgrp */
*g*/
, dhsc */
*x*/
);
253 /* Free a scalar and the resources it holds. */
255 dhge
*(*ldge
)(const dhgrp */
*g*/
, buf */
*b*/
, int /*fmt*/);
256 /* Load a group element from @b@, encoded using format @fmt@. Return
260 int (*stge
)(const dhgrp */
*g*/
, buf */
*b*/
,
261 const dhge */
*Y*/
, int /*fmt*/);
262 /* Store a group element in @b@, encoded using format @fmt@. Return
266 int (*checkge
)(const dhgrp */
*h*/
, const dhge */
*Y*/
);
267 /* Check a group element for validity. Return zero if everything
268 * checks out; nonzero on failure.
271 int (*eq
)(const dhgrp */
*g*/
, const dhge */
*Y*/
, const dhge */
*Z*/
);
272 /* Return nonzero if @Y@ and @Z@ are equal. */
274 dhge
*(*mul
)(const dhgrp */
*g*/
, const dhsc */
*x*/
, const dhge */
*Y*/
);
275 /* Multiply a group element by a scalar, resulting in a shared-secret
276 * group element. If @y@ is null, then multiply the well-known
280 T( const char *(*gestr
)(const dhgrp */
*g*/
, const dhge */
*Y*/
); )
281 /* Return a human-readable representation of @Y@; @buf_t@ may be used
285 void (*freege
)(const dhgrp */
*g*/
, dhge */
*Y*/
);
286 /* Free a group element and the resources it holds. */
290 typedef struct bulkops
{
293 bulkalgs
*(*getalgs
)(const algswitch */
*asw*/
, dstr */
*e*/
,
294 key_file */
*kf*/
, key */
*k*/
);
295 /* Determine algorithms to use and return a @bulkalgs@ object
296 * representing the decision. On error, write tokens to @e@ and
300 T( void (*tracealgs
)(const bulkalgs */
*a*/
); )
301 /* Write trace information about the algorithm selection. */
303 int (*checkalgs
)(bulkalgs */
*a*/
, const algswitch */
*asw*/
, dstr */
*e*/
);
304 /* Check that the algorithms in @a@ and @asw@ are acceptable. On
305 * error, write tokens to @e@ and return @-1@; otherwise return zero.
308 int (*samealgsp
)(const bulkalgs */
*a*/
, const bulkalgs */
*aa*/
);
309 /* If @a@ and @aa@ represent the same algorithm selection, return
310 * nonzero; if not, return zero.
313 void (*alginfo
)(const bulkalgs */
*a*/
, admin */
*adm*/
);
314 /* Report on the algorithm selection to an admin client: call
315 * @a_info@ with appropriate key-value pairs.
318 size_t (*overhead
)(const bulkalgs */
*a*/
);
319 /* Return the per-packet overhead of the bulk transform, in bytes. */
321 size_t (*expsz
)(const bulkalgs */
*a*/
);
322 /* Return the total size limit for the bulk transform, in bytes,
323 * after which the keys must no longer be used.
326 bulkctx
*(*genkeys
)(const bulkalgs */
*a*/
, const struct rawkey */
*rk*/
);
327 /* Generate session keys and construct and return an appropriate
328 * context for using them, by calling @ks_derive@.
331 bulkchal
*(*genchal
)(const bulkalgs */
*a*/
);
332 /* Construct and return a challenge issuing and verification
333 * context with a fresh random key.
336 void (*freealgs
)(bulkalgs */
*a*/
);
337 /* Release an algorithm selection object. (Associated bulk
338 * encryption contexts and challenge contexts may still exist and
339 * must remain valid.)
342 int (*encrypt
)(bulkctx */
*bc*/
, unsigned /*ty*/,
343 buf */
*b*/
, buf */
*bb*/
, uint32
/*seq*/);
344 /* Encrypt the packet in @b@, with type @ty@ (which doesn't need
345 * encoding separately) and sequence number @seq@ (which must be
346 * recoverable by @decrypt@), and write the result to @bb@. On
347 * error, return a @KSERR_...@ code and/or break the output buffer.
350 int (*decrypt
)(bulkctx */
*bc*/
, unsigned /*ty*/,
351 buf */
*b*/
, buf */
*bb*/
, uint32 */
*seq*/
);
352 /* Decrypt the packet in @b@, with type @ty@, writing the result to
353 * @bb@ and storing the incoming (claimed) sequence number in @seq@.
354 * On error, return a @KSERR_...@ code.
357 void (*freectx
)(bulkctx */
*a*/
);
358 /* Release a bulk encryption context and the resources it holds. */
360 int (*chaltag
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
362 /* Calculate a tag for the challenge in @m@, @msz@, and write it to
363 * @t@. Return @-1@ on error, zero on success.
366 int (*chalvrf
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
368 /* Check the tag @t@ on @m@, @msz@: return zero if the tag is OK,
369 * nonzero if it's bad.
372 void (*freechal
)(bulkchal */
*bc*/
);
373 /* Release a challenge context and the resources it holds. */
378 const gchash
*h
; size_t hashsz
; /* Hash function */
379 const gccipher
*mgf
; /* Mask-generation function */
380 bulkalgs
*bulk
; /* Bulk crypto algorithms */
384 unsigned ref
; /* Reference counter */
385 struct knode
*kn
; /* Pointer to cache entry */
386 char *tag
; /* Full tag name of the key */
387 dhgrp
*grp
; /* The group we work in */
388 dhsc
*k
; /* The private key (or null) */
389 dhge
*K
; /* The public key */
390 time_t t_exp
; /* Expiry time of the key */
391 algswitch algs
; /* Collection of algorithms */
394 typedef struct knode
{
395 sym_base _b
; /* Symbol table intrusion */
396 unsigned f
; /* Various flags */
397 #define KNF_BROKEN 1u /* Don't use this key any more */
398 struct keyhalf
*kh
; /* Pointer to the home keyhalf */
399 kdata
*kd
; /* Pointer to the key data */
402 #define MAXHASHSZ 64 /* Largest possible hash size */
404 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
406 extern const dhops dhtab
[];
407 extern const bulkops bulktab
[];
409 /*----- Data structures ---------------------------------------------------*/
411 /* --- Socket addresses --- *
413 * A magic union of supported socket addresses.
418 struct sockaddr_in sin
;
421 /* --- Mapping keyed on addresses --- */
423 typedef struct addrmap
{
428 typedef struct addrmap_base
{
433 /* --- Sequence number checking --- */
435 typedef struct seqwin
{
436 uint32 seq
; /* First acceptable input sequence */
437 uint32 win
; /* Window of acceptable numbers */
440 #define SEQ_WINSZ 32 /* Bits in sequence number window */
442 /* --- A symmetric keyset --- *
444 * A keyset contains a set of symmetric keys for encrypting and decrypting
445 * packets. Keysets are stored in a list, sorted in reverse order of
446 * creation, so that the most recent keyset (the one most likely to be used)
449 * Each keyset has a time limit and a data limit. The keyset is destroyed
450 * when either it has existed for too long, or it has been used to encrypt
451 * too much data. New key exchanges are triggered when keys are close to
455 enum { DIR_IN
, DIR_OUT
, NDIR
};
458 struct keyset
*next
; /* Next active keyset in the list */
459 unsigned ref
; /* Reference count for keyset */
460 struct peer
*p
; /* Pointer to peer structure */
461 time_t t_exp
; /* Expiry time for this keyset */
462 unsigned long sz_exp
, sz_regen
; /* Data limits for the keyset */
463 T( unsigned seq
; ) /* Sequence number for tracing */
464 unsigned f
; /* Various useful flags */
465 bulkctx
*bulk
; /* Bulk crypto transform */
466 uint32 oseq
; /* Outbound sequence number */
467 seqwin iseq
; /* Inbound sequence number */
470 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
471 #define KSF_LINK 2u /* Key is in a linked list */
473 #define KSERR_REGEN -1 /* Regenerate keys */
474 #define KSERR_NOKEYS -2 /* No keys left */
475 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
476 #define KSERR_SEQ -4 /* Incorrect sequence number */
477 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
479 /* --- Key exchange --- *
481 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
482 * Protocol has a number of desirable features (e.g., perfect forward
483 * secrecy, and zero-knowledge authentication) which make it attractive for
484 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
488 typedef struct retry
{
489 double t
; /* Current retry time */
494 typedef struct kxchal
{
495 struct keyexch
*kx
; /* Pointer back to key exchange */
496 dhge
*C
; /* Responder's challenge */
497 dhge
*R
; /* My reply to the challenge */
498 keyset
*ks
; /* Pointer to temporary keyset */
499 unsigned f
; /* Various useful flags */
500 sel_timer t
; /* Response timer for challenge */
501 retry rs
; /* Retry state */
502 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
503 octet ck
[MAXHASHSZ
]; /* His magical check value */
504 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
505 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
506 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
507 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
510 typedef struct keyexch
{
511 struct peer
*p
; /* Pointer back to the peer */
512 kdata
*kpriv
; /* Private key and related info */
513 kdata
*kpub
; /* Peer's public key */
514 keyset
**ks
; /* Peer's list of keysets */
515 unsigned f
; /* Various useful flags */
516 unsigned s
; /* Current state in exchange */
517 sel_timer t
; /* Timer for next exchange */
518 retry rs
; /* Retry state */
519 dhsc
*a
; /* My temporary secret */
520 dhge
*C
; /* My challenge */
521 dhge
*RX
; /* The expected response */
522 unsigned nr
; /* Number of extant responses */
523 time_t t_valid
; /* When this exchange goes bad */
524 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
525 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
528 #define KXF_TIMER 1u /* Waiting for a timer to go off */
529 #define KXF_DEAD 2u /* The key-exchanger isn't up */
530 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
531 #define KXF_CORK 8u /* Don't send anything yet */
534 KXS_DEAD
, /* Uninitialized state (magical) */
535 KXS_CHAL
, /* Main answer-challenges state */
536 KXS_COMMIT
, /* Committed: send switch request */
537 KXS_SWITCH
/* Switched: send confirmation */
540 /* --- Tunnel structure --- *
542 * Used to maintain system-specific information about the tunnel interface.
545 typedef struct tunnel tunnel
;
548 typedef struct tunnel_ops
{
549 const char *name
; /* Name of this tunnel driver */
550 unsigned flags
; /* Various interesting flags */
551 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
552 void (*init
)(void); /* Initializes the system */
553 tunnel
*(*create
)(struct peer */
*p*/
, int /*fd*/, char **/
*ifn*/
);
554 /* Initializes a new tunnel */
555 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
556 /* Notifies ifname change */
557 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
558 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
561 #ifndef TUN_INTERNALS
562 struct tunnel
{ const tunnel_ops
*ops
; };
565 /* --- Peer statistics --- *
567 * Contains various interesting and not-so-interesting statistics about a
568 * peer. This is updated by various parts of the code. The format of the
569 * structure isn't considered private, and @p_stats@ returns a pointer to the
570 * statistics block for a given peer.
573 typedef struct stats
{
574 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
575 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
576 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
577 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
578 unsigned long n_reject
; /* Number of rejected packets */
579 unsigned long n_in
, n_out
; /* Number of packets in and out */
580 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
581 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
584 /* --- Peer structure --- *
586 * The main structure which glues everything else together.
589 typedef struct peerspec
{
590 char *name
; /* Peer's name */
591 char *privtag
; /* Private key tag */
592 char *tag
; /* Public key tag */
593 const tunnel_ops
*tops
; /* Tunnel operations */
594 unsigned long t_ka
; /* Keep alive interval */
595 addr sa
; /* Socket address to speak to */
596 size_t sasz
; /* Socket address size */
597 unsigned f
; /* Flags for the peer */
598 #define PSF_KXMASK 255u /* Key-exchange flags to set */
599 #define PSF_MOBILE 256u /* Address may change rapidly */
602 typedef struct peer_byname
{
607 typedef struct peer_byaddr
{
612 typedef struct peer
{
613 peer_byname
*byname
; /* Lookup-by-name block */
614 peer_byaddr
*byaddr
; /* Lookup-by-address block */
615 struct ping
*pings
; /* Pings we're waiting for */
616 peerspec spec
; /* Specifications for this peer */
617 tunnel
*t
; /* Tunnel for local packets */
618 char *ifname
; /* Interface name for tunnel */
619 keyset
*ks
; /* List head for keysets */
620 buf b
; /* Buffer for sending packets */
621 stats st
; /* Statistics */
622 keyexch kx
; /* Key exchange protocol block */
623 sel_timer tka
; /* Timer for keepalives */
626 typedef struct peer_iter
{ sym_iter i
; } peer_iter
;
628 typedef struct ping
{
629 struct ping
*next
, *prev
; /* Links to next and previous */
630 peer
*p
; /* Peer so we can free it */
631 unsigned msg
; /* Kind of response expected */
632 uint32 id
; /* Id so we can recognize response */
633 octet magic
[32]; /* Some random data */
634 sel_timer t
; /* Timeout for ping */
635 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
636 void *arg
; /* Argument for callback */
647 /* --- Admin structure --- */
649 #define OBUFSZ 16384u
651 typedef struct obuf
{
652 struct obuf
*next
; /* Next buffer in list */
653 char *p_in
, *p_out
; /* Pointers into the buffer */
654 char buf
[OBUFSZ
]; /* The actual buffer */
657 typedef struct oqueue
{
658 obuf
*hd
, *tl
; /* Head and tail pointers */
663 typedef struct admin_bgop
{
664 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
665 struct admin
*a
; /* Owner job */
666 char *tag
; /* Tag string for messages */
667 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
670 typedef struct admin_resop
{
671 admin_bgop bg
; /* Background operation header */
672 char *addr
; /* Hostname to be resolved */
673 bres_client r
; /* Background resolver task */
674 sel_timer t
; /* Timer for resolver */
675 addr sa
; /* Socket address */
676 size_t sasz
; /* Socket address size */
677 void (*func
)(struct admin_resop
*, int); /* Handler */
680 enum { ARES_OK
, ARES_FAIL
};
682 typedef struct admin_addop
{
683 admin_resop r
; /* Name resolution header */
684 peerspec peer
; /* Peer pending creation */
687 typedef struct admin_pingop
{
688 admin_bgop bg
; /* Background operation header */
689 ping ping
; /* Ping pending response */
690 struct timeval pingtime
; /* Time last ping was sent */
693 typedef struct admin_service
{
694 sym_base _b
; /* Hash table base structure */
695 char *version
; /* The provided version */
696 struct admin
*prov
; /* Which client provides me */
697 struct admin_service
*next
, *prev
; /* Client's list of services */
700 typedef struct admin_svcop
{
701 admin_bgop bg
; /* Background operation header */
702 struct admin
*prov
; /* Client servicing this job */
703 unsigned index
; /* This job's index */
704 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
707 typedef struct admin_jobentry
{
708 unsigned short seq
; /* Zero if unused */
710 admin_svcop
*op
; /* Operation, if slot in use, ... */
711 uint32 next
; /* ... or index of next free slot */
715 typedef struct admin_jobtable
{
716 uint32 n
, sz
; /* Used slots and table size */
717 admin_svcop
*active
; /* List of active jobs */
718 uint32 free
; /* Index of first free slot */
719 admin_jobentry
*v
; /* And the big array of entries */
723 struct admin
*next
, *prev
; /* Links to next and previous */
724 unsigned f
; /* Various useful flags */
725 unsigned ref
; /* Reference counter */
727 unsigned seq
; /* Sequence number for tracing */
729 oqueue out
; /* Output buffer list */
730 oqueue delay
; /* Delayed output buffer list */
731 admin_bgop
*bg
; /* Backgrounded operations */
732 admin_service
*svcs
; /* Which services I provide */
733 admin_jobtable j
; /* Table of outstanding jobs */
734 selbuf b
; /* Line buffer for commands */
735 sel_file w
; /* Selector for write buffering */
738 #define AF_DEAD 1u /* Destroy this admin block */
739 #define AF_CLOSE 2u /* Client closed connection */
740 #define AF_NOTE 4u /* Catch notifications */
741 #define AF_WARN 8u /* Catch warning messages */
743 #define AF_TRACE 16u /* Catch tracing */
745 #define AF_FOREGROUND 32u /* Quit server when client closes */
748 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
750 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
753 /*----- Global variables --------------------------------------------------*/
755 extern sel_state sel
; /* Global I/O event state */
756 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
], buf_u
[PKBUFSZ
];
757 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
758 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
759 extern kdata
*master
; /* Default private key */
760 extern const char *tag_priv
; /* Default private key tag */
763 extern const trace_opt tr_opts
[]; /* Trace options array */
764 extern unsigned tr_flags
; /* Trace options flags */
767 /*----- Other macros ------------------------------------------------------*/
770 do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0)
772 /*----- Key management ----------------------------------------------------*/
774 /* --- @km_init@ --- *
776 * Arguments: @const char *privkr@ = private keyring file
777 * @const char *pubkr@ = public keyring file
778 * @const char *ptag@ = default private-key tag
782 * Use: Initializes the key-management machinery, loading the
783 * keyrings and so on.
786 extern void km_init(const char */
*privkr*/
, const char */
*pubkr*/
,
787 const char */
*ptag*/
);
789 /* --- @km_reload@ --- *
793 * Returns: Zero if OK, nonzero to force reloading of keys.
795 * Use: Checks the keyrings to see if they need reloading.
798 extern int km_reload(void);
800 /* --- @km_findpub@, @km_findpriv@ --- *
802 * Arguments: @const char *tag@ = key tag to load
804 * Returns: Pointer to the kdata object if successful, or null on error.
806 * Use: Fetches a public or private key from the keyring.
809 extern kdata
*km_findpub(const char */
*tag*/
);
810 extern kdata
*km_findpriv(const char */
*tag*/
);
812 /* --- @km_samealgsp@ --- *
814 * Arguments: @const kdata *kdx, *kdy@ = two key data objects
816 * Returns: Nonzero if their two algorithm selections are the same.
818 * Use: Checks sameness of algorithm selections: used to ensure that
819 * peers are using sensible algorithms.
822 extern int km_samealgsp(const kdata */
*kdx*/
, const kdata */
*kdy*/
);
824 /* --- @km_ref@ --- *
826 * Arguments: @kdata *kd@ = pointer to the kdata object
830 * Use: Claim a new reference to a kdata object.
833 extern void km_ref(kdata */
*kd*/
);
835 /* --- @km_unref@ --- *
837 * Arguments: @kdata *kd@ = pointer to the kdata object
841 * Use: Releases a reference to a kdata object.
844 extern void km_unref(kdata */
*kd*/
);
846 /* --- @km_tag@ --- *
848 * Arguments: @kdata *kd@ - pointer to the kdata object
850 * Returns: A pointer to the short tag by which the kdata was loaded.
853 extern const char *km_tag(kdata */
*kd*/
);
855 /*----- Key exchange ------------------------------------------------------*/
857 /* --- @kx_start@ --- *
859 * Arguments: @keyexch *kx@ = pointer to key exchange context
860 * @int forcep@ = nonzero to ignore the quiet timer
864 * Use: Stimulates a key exchange. If a key exchage is in progress,
865 * a new challenge is sent (unless the quiet timer forbids
866 * this); if no exchange is in progress, one is commenced.
869 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
871 /* --- @kx_message@ --- *
873 * Arguments: @keyexch *kx@ = pointer to key exchange context
874 * @unsigned msg@ = the message code
875 * @buf *b@ = pointer to buffer containing the packet
879 * Use: Reads a packet containing key exchange messages and handles
883 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
885 /* --- @kx_free@ --- *
887 * Arguments: @keyexch *kx@ = pointer to key exchange context
891 * Use: Frees everything in a key exchange context.
894 extern void kx_free(keyexch */
*kx*/
);
896 /* --- @kx_newkeys@ --- *
898 * Arguments: @keyexch *kx@ = pointer to key exchange context
902 * Use: Informs the key exchange module that its keys may have
903 * changed. If fetching the new keys fails, the peer will be
904 * destroyed, we log messages and struggle along with the old
908 extern void kx_newkeys(keyexch */
*kx*/
);
910 /* --- @kx_init@ --- *
912 * Arguments: @keyexch *kx@ = pointer to key exchange context
913 * @peer *p@ = pointer to peer context
914 * @keyset **ks@ = pointer to keyset list
915 * @unsigned f@ = various useful flags
917 * Returns: Zero if OK, nonzero if it failed.
919 * Use: Initializes a key exchange module. The module currently
920 * contains no keys, and will attempt to initiate a key
924 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
,
925 keyset
**/
*ks*/
, unsigned /*f*/);
927 /*----- Keysets and symmetric cryptography --------------------------------*/
929 /* --- @ks_drop@ --- *
931 * Arguments: @keyset *ks@ = pointer to a keyset
935 * Use: Decrements a keyset's reference counter. If the counter hits
936 * zero, the keyset is freed.
939 extern void ks_drop(keyset */
*ks*/
);
941 /* --- @ks_derivekey@ --- *
943 * Arguments: @octet *k@ = pointer to an output buffer of at least
945 * @size_t ksz@ = actual size wanted (for tracing)
946 * @const struct rawkey *rk@ = a raw key, as passed into
948 * @int dir@ = direction for the key (@DIR_IN@ or @DIR_OUT@)
949 * @const char *what@ = label for the key (input to derivation)
953 * Use: Derives a session key, for use on incoming or outgoing data.
954 * This function is part of a private protocol between @ks_gen@
955 * and the bulk crypto transform @genkeys@ operation.
958 extern void ks_derivekey(octet */
*k*/
, size_t /*ksz*/,
959 const struct rawkey */
*rk*/
,
960 int /*dir*/, const char */
*what*/
);
962 /* --- @ks_gen@ --- *
964 * Arguments: @const void *k@ = pointer to key material
965 * @size_t x, y, z@ = offsets into key material (see below)
966 * @peer *p@ = pointer to peer information
968 * Returns: A pointer to the new keyset.
970 * Use: Derives a new keyset from the given key material. The
971 * offsets @x@, @y@ and @z@ separate the key material into three
972 * parts. Between the @k@ and @k + x@ is `my' contribution to
973 * the key material; between @k + x@ and @k + y@ is `your'
974 * contribution; and between @k + y@ and @k + z@ is a shared
975 * value we made together. These are used to construct two
976 * pairs of symmetric keys. Each pair consists of an encryption
977 * key and a message authentication key. One pair is used for
978 * outgoing messages, the other for incoming messages.
980 * The new key is marked so that it won't be selected for output
981 * by @ksl_encrypt@. You can still encrypt data with it by
982 * calling @ks_encrypt@ directly.
985 extern keyset
*ks_gen(const void */
*k*/
,
986 size_t /*x*/, size_t /*y*/, size_t /*z*/,
989 /* --- @ks_activate@ --- *
991 * Arguments: @keyset *ks@ = pointer to a keyset
995 * Use: Activates a keyset, so that it can be used for encrypting
999 extern void ks_activate(keyset */
*ks*/
);
1001 /* --- @ks_encrypt@ --- *
1003 * Arguments: @keyset *ks@ = pointer to a keyset
1004 * @unsigned ty@ = message type
1005 * @buf *b@ = pointer to input buffer
1006 * @buf *bb@ = pointer to output buffer
1008 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
1009 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
1010 * returns zero if there was insufficient buffer (but the output
1011 * buffer is broken in this case).
1013 * Use: Encrypts a block of data using the key. Note that the `key
1014 * ought to be replaced' notification is only ever given once
1015 * for each key. Also note that this call forces a keyset to be
1016 * used even if it's marked as not for data output.
1018 * The encryption transform is permitted to corrupt @buf_u@ for
1019 * its own purposes. Neither the source nor destination should
1020 * be within @buf_u@; and callers mustn't expect anything stored
1021 * in @buf_u@ to still
1024 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
1025 buf */
*b*/
, buf */
*bb*/
);
1027 /* --- @ks_decrypt@ --- *
1029 * Arguments: @keyset *ks@ = pointer to a keyset
1030 * @unsigned ty@ = expected type code
1031 * @buf *b@ = pointer to an input buffer
1032 * @buf *bb@ = pointer to an output buffer
1034 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1035 * zero if there was insufficient buffer (but the output buffer
1036 * is broken in this case).
1038 * Use: Attempts to decrypt a message using a given key. Note that
1039 * requesting decryption with a key directly won't clear a
1040 * marking that it's not for encryption.
1042 * The decryption transform is permitted to corrupt @buf_u@ for
1043 * its own purposes. Neither the source nor destination should
1044 * be within @buf_u@; and callers mustn't expect anything stored
1045 * in @buf_u@ to still
1048 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
1049 buf */
*b*/
, buf */
*bb*/
);
1051 /* --- @ksl_free@ --- *
1053 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1057 * Use: Frees (releases references to) all of the keys in a keyset.
1060 extern void ksl_free(keyset
**/
*ksroot*/
);
1062 /* --- @ksl_link@ --- *
1064 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1065 * @keyset *ks@ = pointer to a keyset
1069 * Use: Links a keyset into a list. A keyset can only be on one list
1070 * at a time. Bad things happen otherwise.
1073 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
1075 /* --- @ksl_prune@ --- *
1077 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1081 * Use: Prunes the keyset list by removing keys which mustn't be used
1085 extern void ksl_prune(keyset
**/
*ksroot*/
);
1087 /* --- @ksl_encrypt@ --- *
1089 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1090 * @unsigned ty@ = message type
1091 * @buf *b@ = pointer to input buffer
1092 * @buf *bb@ = pointer to output buffer
1094 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
1095 * new key; @KSERR_NOKEYS@ if there are no suitable keys
1096 * available. Also returns zero if there was insufficient
1097 * buffer space (but the output buffer is broken in this case).
1099 * Use: Encrypts a packet.
1102 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1103 buf */
*b*/
, buf */
*bb*/
);
1105 /* --- @ksl_decrypt@ --- *
1107 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1108 * @unsigned ty@ = expected type code
1109 * @buf *b@ = pointer to input buffer
1110 * @buf *bb@ = pointer to output buffer
1112 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1113 * zero if there was insufficient buffer (but the output buffer
1114 * is broken in this case).
1116 * Use: Decrypts a packet.
1119 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1120 buf */
*b*/
, buf */
*bb*/
);
1122 /*----- Challenges --------------------------------------------------------*/
1124 /* --- @c_new@ --- *
1126 * Arguments: @buf *b@ = where to put the challenge
1128 * Returns: Zero if OK, nonzero on error.
1130 * Use: Issues a new challenge.
1133 extern int c_new(buf */
*b*/
);
1135 /* --- @c_check@ --- *
1137 * Arguments: @buf *b@ = where to find the challenge
1139 * Returns: Zero if OK, nonzero if it didn't work.
1141 * Use: Checks a challenge. On failure, the buffer is broken.
1144 extern int c_check(buf */
*b*/
);
1146 /*----- Administration interface ------------------------------------------*/
1148 #define A_END ((char *)0)
1150 /* --- @a_vformat@ --- *
1152 * Arguments: @dstr *d@ = where to leave the formatted message
1153 * @const char *fmt@ = pointer to format string
1154 * @va_list *ap@ = arguments in list
1158 * Use: Main message token formatting driver. The arguments are
1159 * interleaved formatting tokens and their parameters, finally
1160 * terminated by an entry @A_END@.
1162 * Tokens recognized:
1164 * * "*..." ... -- pretokenized @dstr_putf@-like string
1166 * * "?ADDR" SOCKADDR -- a socket address, to be converted
1168 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
1170 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
1172 * * "?PEER" PEER -- peer's name
1174 * * "?ERRNO" ERRNO -- system error code
1176 * * "[!]..." ... -- @dstr_putf@-like string as single token
1179 extern void a_vformat(dstr */
*d*/
, const char */
*fmt*/
, va_list */
*ap*/
);
1181 /* --- @a_format@ --- *
1183 * Arguments: @dstr *d@ = where to leave the formatted message
1184 * @const char *fmt@ = pointer to format string
1188 * Use: Writes a tokenized message into a string, for later
1192 extern void EXECL_LIKE(0) a_format(dstr */
*d*/
, const char */
*fmt*/
, ...);
1194 /* --- @a_info@ --- *
1196 * Arguments: @admin *a@ = connection
1197 * @const char *fmt@ = format string
1198 * @...@ = other arguments
1202 * Use: Report information to an admin client.
1205 extern void EXECL_LIKE(0) a_info(admin */
*a*/
, const char */
*fmt*/
, ...);
1207 /* --- @a_warn@ --- *
1209 * Arguments: @const char *fmt@ = pointer to format string
1210 * @...@ = other arguments
1214 * Use: Informs all admin connections of a warning.
1217 extern void EXECL_LIKE(0) a_warn(const char */
*fmt*/
, ...);
1219 /* --- @a_notify@ --- *
1221 * Arguments: @const char *fmt@ = pointer to format string
1222 * @...@ = other arguments
1226 * Use: Sends a notification to interested admin connections.
1229 extern void EXECL_LIKE(0) a_notify(const char */
*fmt*/
, ...);
1231 /* --- @a_create@ --- *
1233 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1234 * @unsigned f@ = initial flags to set
1238 * Use: Creates a new admin connection.
1241 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
1243 /* --- @a_quit@ --- *
1249 * Use: Shuts things down nicely.
1252 extern void a_quit(void);
1254 /* --- @a_preselect@ --- *
1260 * Use: Informs the admin module that we're about to select again,
1261 * and that it should do cleanup things it has delayed until a
1265 extern void a_preselect(void);
1267 /* --- @a_daemon@ --- *
1273 * Use: Informs the admin module that it's a daemon.
1276 extern void a_daemon(void);
1278 /* --- @a_init@ --- *
1280 * Arguments: @const char *sock@ = socket name to create
1281 * @uid_t u@ = user to own the socket
1282 * @gid_t g@ = group to own the socket
1283 * @mode_t m@ = permissions to set on the socket
1287 * Use: Creates the admin listening socket.
1290 extern void a_init(const char */
*sock*/
,
1291 uid_t
/*u*/, gid_t
/*g*/, mode_t
/*m*/);
1293 /*----- Mapping with addresses as keys ------------------------------------*/
1295 /* --- @am_create@ --- *
1297 * Arguments: @addrmap *m@ = pointer to map
1301 * Use: Create an address map, properly set up.
1304 extern void am_create(addrmap */
*m*/
);
1306 /* --- @am_destroy@ --- *
1308 * Arguments: @addrmap *m@ = pointer to map
1312 * Use: Destroy an address map, throwing away all the entries.
1315 extern void am_destroy(addrmap */
*m*/
);
1317 /* --- @am_find@ --- *
1319 * Arguments: @addrmap *m@ = pointer to map
1320 * @const addr *a@ = address to look up
1321 * @size_t sz@ = size of block to allocate
1322 * @unsigned *f@ = where to store flags
1324 * Returns: Pointer to found item, or null.
1326 * Use: Finds a record with the given IP address, set @*f@ nonzero
1327 * and returns it. If @sz@ is zero, and no match was found,
1328 * return null; otherwise allocate a new block of @sz@ bytes,
1329 * clear @*f@ to zero and return the block pointer.
1332 extern void *am_find(addrmap */
*m*/
, const addr */
*a*/
,
1333 size_t /*sz*/, unsigned */
*f*/
);
1335 /* --- @am_remove@ --- *
1337 * Arguments: @addrmap *m@ = pointer to map
1338 * @void *i@ = pointer to the item
1342 * Use: Removes an item from the map.
1345 extern void am_remove(addrmap */
*m*/
, void */
*i*/
);
1347 /*----- Privilege separation ----------------------------------------------*/
1349 /* --- @ps_trace@ --- *
1351 * Arguments: @unsigned mask@ = trace mask to check
1352 * @const char *fmt@ = message format
1353 * @...@ = values for placeholders
1357 * Use: Writes a trace message.
1360 T( extern void PRINTF_LIKE(2, 3)
1361 ps_trace(unsigned /*mask*/, const char */
*fmt*/
, ...); )
1363 /* --- @ps_warn@ --- *
1365 * Arguments: @const char *fmt@ = message format
1366 * @...@ = values for placeholders
1370 * Use: Writes a warning message.
1373 extern void PRINTF_LIKE(1, 2) ps_warn(const char */
*fmt*/
, ...);
1375 /* --- @ps_tunfd@ --- *
1377 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1378 * @char **ifn@ = where to put the interface name
1380 * Returns: The file descriptor, or @-1@ on error.
1382 * Use: Fetches a file descriptor for a tunnel driver.
1385 extern int ps_tunfd(const tunnel_ops */
*tops*/
, char **/
*ifn*/
);
1387 /* --- @ps_split@ --- *
1389 * Arguments: @int detachp@ = whether to detach the child from its terminal
1393 * Use: Separates off the privileged tunnel-opening service from the
1394 * rest of the server.
1397 extern void ps_split(int /*detachp*/);
1399 /* --- @ps_quit@ --- *
1405 * Use: Detaches from the helper process.
1408 extern void ps_quit(void);
1410 /*----- Peer management ---------------------------------------------------*/
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 /* --- @seq_reset@ --- *
1734 * Arguments: @seqwin *s@ = sequence-checking window
1738 * Use: Resets a sequence number window.
1741 extern void seq_reset(seqwin */
*s*/
);
1743 /* --- @seq_check@ --- *
1745 * Arguments: @seqwin *s@ = sequence-checking window
1746 * @uint32 q@ = sequence number to check
1747 * @const char *service@ = service to report message from
1749 * Returns: A @SEQ_@ code.
1751 * Use: Checks a sequence number against the window, updating things
1755 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1757 /*----- That's all, folks -------------------------------------------------*/