3 * Main header file for TrIPE
5 * (c) 2001 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Trivial IP Encryption (TrIPE).
12 * TrIPE is free software: you can redistribute it and/or modify it under
13 * the terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your
15 * option) any later version.
17 * TrIPE is distributed in the hope that it will be useful, but WITHOUT
18 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 * You should have received a copy of the GNU General Public License
23 * along with TrIPE. If not, see <https://www.gnu.org/licenses/>.
33 /*----- Header files ------------------------------------------------------*/
49 #include <sys/types.h>
56 #include <sys/socket.h>
58 #include <netinet/in.h>
59 #include <arpa/inet.h>
66 # define ADNS_FEATURE_MANYAF
70 #include <mLib/alloc.h>
71 #include <mLib/arena.h>
72 #include <mLib/base64.h>
74 # include <mLib/bres.h>
76 #include <mLib/codec.h>
77 #include <mLib/daemonize.h>
78 #include <mLib/dstr.h>
80 #include <mLib/fdflags.h>
81 #include <mLib/fdpass.h>
82 #include <mLib/fwatch.h>
83 #include <mLib/hash.h>
84 #include <mLib/macros.h>
85 #include <mLib/mdup.h>
86 #include <mLib/mdwopt.h>
87 #include <mLib/quis.h>
88 #include <mLib/report.h>
90 #include <mLib/selbuf.h>
94 #include <mLib/trace.h>
96 #include <mLib/versioncmp.h>
98 #include <catacomb/buf.h>
99 #include <catacomb/ct.h>
101 #include <catacomb/chacha.h>
102 #include <catacomb/gcipher.h>
103 #include <catacomb/gmac.h>
104 #include <catacomb/grand.h>
105 #include <catacomb/key.h>
106 #include <catacomb/paranoia.h>
107 #include <catacomb/poly1305.h>
108 #include <catacomb/salsa20.h>
110 #include <catacomb/noise.h>
111 #include <catacomb/rand.h>
113 #include <catacomb/mp.h>
114 #include <catacomb/mpmont.h>
115 #include <catacomb/mprand.h>
116 #include <catacomb/dh.h>
117 #include <catacomb/ec.h>
118 #include <catacomb/ec-raw.h>
119 #include <catacomb/ec-keys.h>
120 #include <catacomb/x25519.h>
121 #include <catacomb/x448.h>
124 #include "protocol.h"
130 /*----- Magic numbers -----------------------------------------------------*/
132 /* --- Trace flags --- */
140 #define T_KEYEXCH 64u
141 #define T_KEYMGMT 128u
143 /* T_PRIVSEP in priv.h */
149 #define SEC(n) (n##u)
150 #define MIN(n) (n##u * 60u)
151 #define F_2P32 (65536.0*65536.0)
152 #define MEG(n) (n##ul * 1024ul * 1024ul)
154 /* --- Timing parameters --- */
156 #define T_EXP MIN(60) /* Expiry time for a key */
157 #define T_REGEN MIN(40) /* Regeneration time for a key */
159 #define T_VALID SEC(20) /* Challenge validity period */
160 #define T_RETRYMIN SEC(2) /* Minimum retry interval */
161 #define T_RETRYMAX MIN(5) /* Maximum retry interval */
162 #define T_RETRYGROW (5.0/4.0) /* Retry interval growth factor */
164 #define T_WOBBLE (1.0/3.0) /* Relative timer randomness */
166 /* --- Other things --- */
168 #define PKBUFSZ 65536
170 /*----- Cipher selections -------------------------------------------------*/
172 typedef struct keyset keyset
;
173 typedef struct algswitch algswitch
;
174 typedef struct kdata kdata
;
175 typedef struct admin admin
;
177 typedef struct dhgrp
{
178 const struct dhops
*ops
;
182 typedef struct dhsc dhsc
;
183 typedef struct dhge dhge
;
186 DHFMT_STD
, /* Fixed-width format, suitable for encryption */
187 DHFMT_HASH
, /* Deterministic format, suitable for hashing */
188 DHFMT_VAR
/* Variable-width-format, mostly a bad idea */
191 typedef struct deriveargs
{
192 const char *what
; /* Operation name (hashed) */
193 unsigned f
; /* Flags */
194 #define DF_IN 1u /* Make incoming key */
195 #define DF_OUT 2u /* Make outgoing key */
196 const gchash
*hc
; /* Hash class */
197 const octet
*k
; /* Pointer to contributions */
198 size_t x
, y
, z
; /* Markers in contributions */
201 typedef struct bulkalgs
{
202 const struct bulkops
*ops
;
205 typedef struct bulkctx
{
206 const struct bulkops
*ops
;
209 typedef struct bulkchal
{
210 const struct bulkops
*ops
;
214 typedef struct dhops
{
217 int (*ldpriv
)(key_file */
*kf*/
, key */
*k*/
, key_data */
*d*/
,
218 kdata */
*kd*/
, dstr */
*t*/
, dstr */
*e*/
);
219 /* Load a private key from @d@, storing the data in @kd@. The key's
220 * file and key object are in @kf@ and @k@, mostly in case its
221 * attributes are interesting; the key tag is in @t@; errors are
222 * reported by writing tokens to @e@ and returning nonzero.
225 int (*ldpub
)(key_file */
*kf*/
, key */
*k*/
, key_data */
*d*/
,
226 kdata */
*kd*/
, dstr */
*t*/
, dstr */
*e*/
);
227 /* Load a public key from @d@, storing the data in @kd@. The key's
228 * file and key object are in @kf@ and @k@, mostly in case its
229 * attributes are interesting; the key tag is in @t@; errors are
230 * reported by writing tokens to @e@ and returning nonzero.
233 const char *(*checkgrp
)(const dhgrp */
*g*/
);
234 /* Check that the group is valid; return null on success, or an error
238 void (*grpinfo
)(const dhgrp */
*g*/
, admin */
*a*/
);
239 /* Report on the group to an admin client. */
241 T( void (*tracegrp
)(const dhgrp */
*g*/
); )
242 /* Trace a description of the group. */
244 int (*samegrpp
)(const dhgrp */
*g*/
, const dhgrp */
*gg*/
);
245 /* Return nonzero if the two group objects represent the same
249 void (*freegrp
)(dhgrp */
*g*/
);
250 /* Free a group and the resources it holds. */
252 dhsc
*(*ldsc
)(const dhgrp */
*g*/
, const void */
*p*/
, size_t /*sz*/);
253 /* Load a scalar from @p@, @sz@ and return it. Return null on
257 int (*stsc
)(const dhgrp */
*g*/
,
258 void */
*p*/
, size_t /*sz*/, const dhsc */
*x*/
);
259 /* Store a scalar at @p@, @sz@. Return nonzero on error. */
261 dhsc
*(*randsc
)(const dhgrp */
*g*/
);
262 /* Return a random scalar. */
264 T( const char *(*scstr
)(const dhgrp */
*g*/
, const dhsc */
*x*/
); )
265 /* Return a human-readable representation of @x@; @buf_t@ may be used
269 void (*freesc
)(const dhgrp */
*g*/
, dhsc */
*x*/
);
270 /* Free a scalar and the resources it holds. */
272 dhge
*(*ldge
)(const dhgrp */
*g*/
, buf */
*b*/
, int /*fmt*/);
273 /* Load a group element from @b@, encoded using format @fmt@. Return
277 int (*stge
)(const dhgrp */
*g*/
, buf */
*b*/
,
278 const dhge */
*Y*/
, int /*fmt*/);
279 /* Store a group element in @b@, encoded using format @fmt@. Return
283 int (*checkge
)(const dhgrp */
*h*/
, const dhge */
*Y*/
);
284 /* Check a group element for validity. Return zero if everything
285 * checks out; nonzero on failure.
288 int (*eq
)(const dhgrp */
*g*/
, const dhge */
*Y*/
, const dhge */
*Z*/
);
289 /* Return nonzero if @Y@ and @Z@ are equal. */
291 dhge
*(*mul
)(const dhgrp */
*g*/
, const dhsc */
*x*/
, const dhge */
*Y*/
);
292 /* Multiply a group element by a scalar, resulting in a shared-secret
293 * group element. If @y@ is null, then multiply the well-known
297 T( const char *(*gestr
)(const dhgrp */
*g*/
, const dhge */
*Y*/
); )
298 /* Return a human-readable representation of @Y@; @buf_t@ may be used
302 void (*freege
)(const dhgrp */
*g*/
, dhge */
*Y*/
);
303 /* Free a group element and the resources it holds. */
307 typedef struct bulkops
{
310 bulkalgs
*(*getalgs
)(const algswitch */
*asw*/
, dstr */
*e*/
,
311 key_file */
*kf*/
, key */
*k*/
);
312 /* Determine algorithms to use and return a @bulkalgs@ object
313 * representing the decision. On error, write tokens to @e@ and
317 T( void (*tracealgs
)(const bulkalgs */
*a*/
); )
318 /* Write trace information about the algorithm selection. */
320 int (*checkalgs
)(bulkalgs */
*a*/
, const algswitch */
*asw*/
, dstr */
*e*/
);
321 /* Check that the algorithms in @a@ and @asw@ are acceptable. On
322 * error, write tokens to @e@ and return @-1@; otherwise return zero.
325 int (*samealgsp
)(const bulkalgs */
*a*/
, const bulkalgs */
*aa*/
);
326 /* If @a@ and @aa@ represent the same algorithm selection, return
327 * nonzero; if not, return zero.
330 void (*alginfo
)(const bulkalgs */
*a*/
, admin */
*adm*/
);
331 /* Report on the algorithm selection to an admin client: call
332 * @a_info@ with appropriate key-value pairs.
335 size_t (*overhead
)(const bulkalgs */
*a*/
);
336 /* Return the per-packet overhead of the bulk transform, in bytes. */
338 size_t (*expsz
)(const bulkalgs */
*a*/
);
339 /* Return the total size limit for the bulk transform, in bytes,
340 * after which the keys must no longer be used.
343 bulkctx
*(*genkeys
)(const bulkalgs */
*a*/
, const deriveargs */
*a*/
);
344 /* Generate session keys and construct and return an appropriate
345 * context for using them. The offsets @a->x@, @a->y@ and @a->z@
346 * separate the key material into three parts. Between @a->k@ and
347 * @a->k + a->x@ is `my' contribution to the key material; between
348 * @a->k + a->x@ and @a->k + a->y@ is `your' contribution; and
349 * between @a->k + a->y@ and @a->k + a->z@ is a shared value we made
350 * together. These are used to construct (up to) two collections of
351 * symmetric keys: one for outgoing messages, the other for incoming
352 * messages. If @a->x == 0@ (or @a->y == a->x@) then my (or your)
353 * contribution is omitted.
356 bulkchal
*(*genchal
)(const bulkalgs */
*a*/
);
357 /* Construct and return a challenge issuing and verification
358 * context with a fresh random key.
361 void (*freealgs
)(bulkalgs */
*a*/
);
362 /* Release an algorithm selection object. (Associated bulk
363 * encryption contexts and challenge contexts may still exist and
364 * must remain valid.)
367 int (*encrypt
)(bulkctx */
*bc*/
, unsigned /*ty*/,
368 buf */
*b*/
, buf */
*bb*/
, uint32
/*seq*/);
369 /* Encrypt the packet in @b@, with type @ty@ (which doesn't need
370 * encoding separately) and sequence number @seq@ (which must be
371 * recoverable by @decrypt@), and write the result to @bb@. On
372 * error, return a @KSERR_...@ code and/or break the output buffer.
375 int (*decrypt
)(bulkctx */
*bc*/
, unsigned /*ty*/,
376 buf */
*b*/
, buf */
*bb*/
, uint32 */
*seq*/
);
377 /* Decrypt the packet in @b@, with type @ty@, writing the result to
378 * @bb@ and storing the incoming (claimed) sequence number in @seq@.
379 * On error, return a @KSERR_...@ code.
382 void (*freectx
)(bulkctx */
*a*/
);
383 /* Release a bulk encryption context and the resources it holds. */
385 int (*chaltag
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
386 uint32
/*seq*/, void */
*t*/
);
387 /* Calculate a tag for the challenge in @m@, @msz@, with the sequence
388 * number @seq@, and write it to @t@. Return @-1@ on error, zero on
392 int (*chalvrf
)(bulkchal */
*bc*/
, const void */
*m*/
, size_t /*msz*/,
393 uint32
/*seq*/, const void */
*t*/
);
394 /* Check the tag @t@ on @m@, @msz@ and @seq@: return zero if the tag
395 * is OK, nonzero if it's bad.
398 void (*freechal
)(bulkchal */
*bc*/
);
399 /* Release a challenge context and the resources it holds. */
404 const gchash
*h
; size_t hashsz
; /* Hash function */
405 const gccipher
*mgf
; /* Mask-generation function */
406 bulkalgs
*bulk
; /* Bulk crypto algorithms */
410 unsigned ref
; /* Reference counter */
411 struct knode
*kn
; /* Pointer to cache entry */
412 uint32 id
; /* The underlying key's id */
413 char *tag
; /* Full tag name of the key */
414 dhgrp
*grp
; /* The group we work in */
415 dhsc
*k
; /* The private key (or null) */
416 dhge
*K
; /* The public key */
417 time_t t_exp
; /* Expiry time of the key */
418 algswitch algs
; /* Collection of algorithms */
421 typedef struct knode
{
422 sym_base _b
; /* Symbol table intrusion */
423 unsigned f
; /* Various flags */
424 #define KNF_BROKEN 1u /* Don't use this key any more */
425 struct keyhalf
*kh
; /* Pointer to the home keyhalf */
426 kdata
*kd
; /* Pointer to the key data */
429 #define MAXHASHSZ 64 /* Largest possible hash size */
431 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
433 extern const dhops dhtab
[];
434 extern const bulkops bulktab
[];
436 /*----- Data structures ---------------------------------------------------*/
438 /* --- The address-family table --- */
445 #define ENUM(af, qf) AFIX_##af,
451 extern const struct addrfam
{
459 /* --- Socket addresses --- *
461 * A magic union of supported socket addresses.
466 struct sockaddr_in sin
;
467 struct sockaddr_in6 sin6
;
470 /* --- Mapping keyed on addresses --- */
472 typedef struct addrmap
{
477 typedef struct addrmap_base
{
482 /* --- Sequence number checking --- */
484 typedef struct seqwin
{
485 uint32 seq
; /* First acceptable input sequence */
486 uint32 win
; /* Window of acceptable numbers */
489 #define SEQ_WINSZ 32 /* Bits in sequence number window */
491 /* --- A symmetric keyset --- *
493 * A keyset contains a set of symmetric keys for encrypting and decrypting
494 * packets. Keysets are stored in a list, sorted in reverse order of
495 * creation, so that the most recent keyset (the one most likely to be used)
498 * Each keyset has a time limit and a data limit. The keyset is destroyed
499 * when either it has existed for too long, or it has been used to encrypt
500 * too much data. New key exchanges are triggered when keys are close to
504 enum { DIR_IN
, DIR_OUT
, NDIR
};
507 struct keyset
*next
; /* Next active keyset in the list */
508 unsigned ref
; /* Reference count for keyset */
509 struct peer
*p
; /* Pointer to peer structure */
510 time_t t_exp
; /* Expiry time for this keyset */
511 unsigned long sz_exp
, sz_regen
; /* Data limits for the keyset */
512 T( unsigned seq
; ) /* Sequence number for tracing */
513 unsigned f
; /* Various useful flags */
514 bulkctx
*bulk
; /* Bulk crypto transform */
515 uint32 oseq
; /* Outbound sequence number */
516 seqwin iseq
; /* Inbound sequence number */
519 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
520 #define KSF_LINK 2u /* Key is in a linked list */
522 #define KSERR_REGEN -1 /* Regenerate keys */
523 #define KSERR_NOKEYS -2 /* No keys left */
524 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
525 #define KSERR_SEQ -4 /* Incorrect sequence number */
526 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
528 /* --- Key exchange --- *
530 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
531 * Protocol has a number of desirable features (e.g., perfect forward
532 * secrecy, and zero-knowledge authentication) which make it attractive for
533 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
537 typedef struct retry
{
538 double t
; /* Current retry time */
543 typedef struct kxchal
{
544 struct keyexch
*kx
; /* Pointer back to key exchange */
545 dhge
*C
; /* Responder's challenge */
546 dhge
*R
; /* My reply to the challenge */
547 keyset
*ks
; /* Pointer to temporary keyset */
548 unsigned f
; /* Various useful flags */
549 sel_timer t
; /* Response timer for challenge */
550 retry rs
; /* Retry state */
551 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
552 octet ck
[MAXHASHSZ
]; /* His magical check value */
553 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
554 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
555 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
556 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
559 typedef struct keyexch
{
560 struct peer
*p
; /* Pointer back to the peer */
561 kdata
*kpriv
; /* Private key and related info */
562 kdata
*kpub
; /* Peer's public key */
563 keyset
**ks
; /* Peer's list of keysets */
564 unsigned f
; /* Various useful flags */
565 unsigned s
; /* Current state in exchange */
566 sel_timer t
; /* Timer for next exchange */
567 retry rs
; /* Retry state */
568 dhsc
*a
; /* My temporary secret */
569 dhge
*C
; /* My challenge */
570 dhge
*RX
; /* The expected response */
571 unsigned nr
; /* Number of extant responses */
572 time_t t_valid
; /* When this exchange goes bad */
573 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
574 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
577 #define KXF_TIMER 1u /* Waiting for a timer to go off */
578 #define KXF_DEAD 2u /* The key-exchanger isn't up */
579 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
580 #define KXF_CORK 8u /* Don't send anything yet */
583 KXS_DEAD
, /* Uninitialized state (magical) */
584 KXS_CHAL
, /* Main answer-challenges state */
585 KXS_COMMIT
, /* Committed: send switch request */
586 KXS_SWITCH
/* Switched: send confirmation */
589 /* --- Tunnel structure --- *
591 * Used to maintain system-specific information about the tunnel interface.
594 typedef struct tunnel tunnel
;
597 typedef struct tunnel_ops
{
598 const char *name
; /* Name of this tunnel driver */
599 unsigned flags
; /* Various interesting flags */
600 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
601 int (*init
)(void); /* Initializes the system */
602 tunnel
*(*create
)(struct peer */
*p*/
, int /*fd*/, char **/
*ifn*/
);
603 /* Initializes a new tunnel */
604 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
605 /* Notifies ifname change */
606 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
607 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
610 #ifndef TUN_INTERNALS
611 struct tunnel
{ const tunnel_ops
*ops
; };
614 typedef struct tun_iter
{
615 const struct tunnel_node
*next
;
618 /* --- Peer statistics --- *
620 * Contains various interesting and not-so-interesting statistics about a
621 * peer. This is updated by various parts of the code. The format of the
622 * structure isn't considered private, and @p_stats@ returns a pointer to the
623 * statistics block for a given peer.
626 typedef struct stats
{
627 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
628 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
629 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
630 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
631 unsigned long n_reject
; /* Number of rejected packets */
632 unsigned long n_in
, n_out
; /* Number of packets in and out */
633 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
634 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
637 /* --- Peer structure --- *
639 * The main structure which glues everything else together.
642 typedef struct peerspec
{
643 char *name
; /* Peer's name */
644 char *privtag
; /* Private key tag */
645 char *tag
; /* Public key tag */
646 char *knock
; /* Knock string, or null */
647 const tunnel_ops
*tops
; /* Tunnel operations */
648 unsigned long t_ka
; /* Keep alive interval */
649 addr sa
; /* Socket address to speak to */
650 unsigned f
; /* Flags for the peer */
651 #define PSF_KXMASK 255u /* Key-exchange flags to set */
652 #define PSF_MOBILE 256u /* Address may change rapidly */
653 #define PSF_EPHEM 512u /* Association is ephemeral */
656 typedef struct peer_byname
{
661 typedef struct peer_byaddr
{
666 typedef struct peer
{
667 peer_byname
*byname
; /* Lookup-by-name block */
668 peer_byaddr
*byaddr
; /* Lookup-by-address block */
669 struct ping
*pings
; /* Pings we're waiting for */
670 peerspec spec
; /* Specifications for this peer */
671 int afix
; /* Index of address family */
672 tunnel
*t
; /* Tunnel for local packets */
673 char *ifname
; /* Interface name for tunnel */
674 keyset
*ks
; /* List head for keysets */
675 buf b
; /* Buffer for sending packets */
676 stats st
; /* Statistics */
677 keyexch kx
; /* Key exchange protocol block */
678 sel_timer tka
; /* Timer for keepalives */
681 typedef struct peer_iter
{ sym_iter i
; } peer_iter
;
683 typedef struct udpsocket
{
684 sel_file sf
; /* Selector for the socket */
685 unsigned port
; /* Chosen port number */
688 typedef struct ping
{
689 struct ping
*next
, *prev
; /* Links to next and previous */
690 peer
*p
; /* Peer so we can free it */
691 unsigned msg
; /* Kind of response expected */
692 uint32 id
; /* Id so we can recognize response */
693 octet magic
[32]; /* Some random data */
694 sel_timer t
; /* Timeout for ping */
695 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
696 void *arg
; /* Argument for callback */
707 /* --- Admin structure --- */
709 #define OBUFSZ 16384u
711 typedef struct obuf
{
712 struct obuf
*next
; /* Next buffer in list */
713 char *p_in
, *p_out
; /* Pointers into the buffer */
714 char buf
[OBUFSZ
]; /* The actual buffer */
717 typedef struct oqueue
{
718 obuf
*hd
, *tl
; /* Head and tail pointers */
723 typedef struct admin_bgop
{
724 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
725 struct admin
*a
; /* Owner job */
726 char *tag
; /* Tag string for messages */
727 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
730 typedef struct admin_resop
{
731 admin_bgop bg
; /* Background operation header */
732 char *addr
; /* Hostname to be resolved */
736 bres_client r
; /* Background resolver task */
738 sel_timer t
; /* Timer for resolver */
739 addr sa
; /* Socket address */
740 unsigned port
; /* Port number chosen */
741 size_t sasz
; /* Socket address size */
742 void (*func
)(struct admin_resop
*, int); /* Handler */
745 enum { ARES_OK
, ARES_FAIL
};
747 typedef struct admin_addop
{
748 admin_resop r
; /* Name resolution header */
749 peerspec peer
; /* Peer pending creation */
752 typedef struct admin_pingop
{
753 admin_bgop bg
; /* Background operation header */
754 ping ping
; /* Ping pending response */
755 struct timeval pingtime
; /* Time last ping was sent */
758 typedef struct admin_service
{
759 sym_base _b
; /* Hash table base structure */
760 char *version
; /* The provided version */
761 struct admin
*prov
; /* Which client provides me */
762 struct admin_service
*next
, *prev
; /* Client's list of services */
765 typedef struct admin_svcop
{
766 admin_bgop bg
; /* Background operation header */
767 struct admin
*prov
; /* Client servicing this job */
768 unsigned index
; /* This job's index */
769 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
772 typedef struct admin_jobentry
{
773 unsigned short seq
; /* Zero if unused */
775 admin_svcop
*op
; /* Operation, if slot in use, ... */
776 uint32 next
; /* ... or index of next free slot */
780 typedef struct admin_jobtable
{
781 uint32 n
, sz
; /* Used slots and table size */
782 admin_svcop
*active
; /* List of active jobs */
783 uint32 free
; /* Index of first free slot */
784 admin_jobentry
*v
; /* And the big array of entries */
788 struct admin
*next
, *prev
; /* Links to next and previous */
789 unsigned f
; /* Various useful flags */
790 unsigned ref
; /* Reference counter */
792 unsigned seq
; /* Sequence number for tracing */
794 oqueue out
; /* Output buffer list */
795 oqueue delay
; /* Delayed output buffer list */
796 admin_bgop
*bg
; /* Backgrounded operations */
797 admin_service
*svcs
; /* Which services I provide */
798 admin_jobtable j
; /* Table of outstanding jobs */
799 selbuf b
; /* Line buffer for commands */
800 sel_file w
; /* Selector for write buffering */
803 #define AF_DEAD 1u /* Destroy this admin block */
804 #define AF_CLOSE 2u /* Client closed connection */
805 #define AF_NOTE 4u /* Catch notifications */
806 #define AF_WARN 8u /* Catch warning messages */
808 # define AF_TRACE 16u /* Catch tracing */
810 #define AF_FOREGROUND 32u /* Quit server when client closes */
813 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
815 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
818 /*----- Global variables --------------------------------------------------*/
820 extern sel_state sel
; /* Global I/O event state */
821 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
], buf_u
[PKBUFSZ
];
822 extern udpsocket udpsock
[NADDRFAM
]; /* The master UDP sockets */
823 extern kdata
*master
; /* Default private key */
824 extern char *tag_priv
; /* Default private key tag */
827 extern const trace_opt tr_opts
[]; /* Trace options array */
828 extern unsigned tr_flags
; /* Trace options flags */
831 /*----- Other macros ------------------------------------------------------*/
834 do { rand_quick(RAND_GLOBAL); noise_timer(RAND_GLOBAL); } while (0)
836 /*----- Key management ----------------------------------------------------*/
838 /* --- @km_init@ --- *
840 * Arguments: @const char *privkr@ = private keyring file
841 * @const char *pubkr@ = public keyring file
842 * @const char *ptag@ = default private-key tag
844 * Returns: Zero on success, @-1@ on failure.
846 * Use: Initializes the key-management machinery, loading the
847 * keyrings and so on.
850 extern int km_init(const char */
*privkr*/
, const char */
*pubkr*/
,
851 const char */
*ptag*/
);
853 /* --- @km_reload@ --- *
857 * Returns: Zero if OK, nonzero to force reloading of keys.
859 * Use: Checks the keyrings to see if they need reloading.
862 extern int km_reload(void);
864 /* --- @km_clear@ --- *
870 * Use: Forget the currently loaded keyrings. The @master@ key will
871 * be cleared, but other keys already loaded will continue to
872 * exist until their reference count drops to zero. Call
873 * @km_init@ to make everything work again.
876 extern void km_clear(void);
878 /* --- @km_findpub@, @km_findpriv@ --- *
880 * Arguments: @const char *tag@ = key tag to load
882 * Returns: Pointer to the kdata object if successful, or null on error.
884 * Use: Fetches a public or private key from the keyring.
887 extern kdata
*km_findpub(const char */
*tag*/
);
888 extern kdata
*km_findpriv(const char */
*tag*/
);
890 /* --- @km_findpubbyid@, @km_findprivbyid@ --- *
892 * Arguments: @uint32 id@ = key id to load
894 * Returns: Pointer to the kdata object if successful, or null on error.
896 * Use: Fetches a public or private key from the keyring given its
900 extern kdata
*km_findpubbyid(uint32
/*id*/);
901 extern kdata
*km_findprivbyid(uint32
/*id*/);
903 /* --- @km_samealgsp@ --- *
905 * Arguments: @const kdata *kdx, *kdy@ = two key data objects
907 * Returns: Nonzero if their two algorithm selections are the same.
909 * Use: Checks sameness of algorithm selections: used to ensure that
910 * peers are using sensible algorithms.
913 extern int km_samealgsp(const kdata */
*kdx*/
, const kdata */
*kdy*/
);
915 /* --- @km_ref@ --- *
917 * Arguments: @kdata *kd@ = pointer to the kdata object
921 * Use: Claim a new reference to a kdata object.
924 extern void km_ref(kdata */
*kd*/
);
926 /* --- @km_unref@ --- *
928 * Arguments: @kdata *kd@ = pointer to the kdata object
932 * Use: Releases a reference to a kdata object.
935 extern void km_unref(kdata */
*kd*/
);
937 /* --- @km_tag@ --- *
939 * Arguments: @kdata *kd@ - pointer to the kdata object
941 * Returns: A pointer to the short tag by which the kdata was loaded.
944 extern const char *km_tag(kdata */
*kd*/
);
946 /*----- Key exchange ------------------------------------------------------*/
948 /* --- @kx_start@ --- *
950 * Arguments: @keyexch *kx@ = pointer to key exchange context
951 * @int forcep@ = nonzero to ignore the quiet timer
955 * Use: Stimulates a key exchange. If a key exchage is in progress,
956 * a new challenge is sent (unless the quiet timer forbids
957 * this); if no exchange is in progress, one is commenced.
960 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
962 /* --- @kx_message@ --- *
964 * Arguments: @keyexch *kx@ = pointer to key exchange context
965 * @const addr *a@ = sender's IP address and port
966 * @unsigned msg@ = the message code
967 * @buf *b@ = pointer to buffer containing the packet
969 * Returns: Nonzero if the sender's address was unknown.
971 * Use: Reads a packet containing key exchange messages and handles
975 extern int kx_message(keyexch */
*kx*/
, const addr */
*a*/
,
976 unsigned /*msg*/, buf */
*b*/
);
978 /* --- @kx_free@ --- *
980 * Arguments: @keyexch *kx@ = pointer to key exchange context
984 * Use: Frees everything in a key exchange context.
987 extern void kx_free(keyexch */
*kx*/
);
989 /* --- @kx_newkeys@ --- *
991 * Arguments: @keyexch *kx@ = pointer to key exchange context
995 * Use: Informs the key exchange module that its keys may have
996 * changed. If fetching the new keys fails, the peer will be
997 * destroyed, we log messages and struggle along with the old
1001 extern void kx_newkeys(keyexch */
*kx*/
);
1003 /* --- @kx_setup@ --- *
1005 * Arguments: @keyexch *kx@ = pointer to key exchange context
1006 * @peer *p@ = pointer to peer context
1007 * @keyset **ks@ = pointer to keyset list
1008 * @unsigned f@ = various useful flags
1010 * Returns: Zero if OK, nonzero if it failed.
1012 * Use: Initializes a key exchange module. The module currently
1013 * contains no keys, and will attempt to initiate a key
1017 extern int kx_setup(keyexch */
*kx*/
, peer */
*p*/
,
1018 keyset
**/
*ks*/
, unsigned /*f*/);
1020 /* --- @kx_init@ --- *
1026 * Use: Initializes the key-exchange logic.
1029 extern void kx_init(void);
1031 /*----- Keysets and symmetric cryptography --------------------------------*/
1033 /* --- @ks_drop@ --- *
1035 * Arguments: @keyset *ks@ = pointer to a keyset
1039 * Use: Decrements a keyset's reference counter. If the counter hits
1040 * zero, the keyset is freed.
1043 extern void ks_drop(keyset */
*ks*/
);
1045 /* --- @ks_gen@ --- *
1047 * Arguments: @deriveargs *a@ = key derivation parameters (modified)
1048 * @peer *p@ = pointer to peer information
1050 * Returns: A pointer to the new keyset.
1052 * Use: Derives a new keyset from the given key material. This will
1053 * set the @what@, @f@, and @hc@ members in @*a@; other members
1054 * must be filled in by the caller.
1056 * The new key is marked so that it won't be selected for output
1057 * by @ksl_encrypt@. You can still encrypt data with it by
1058 * calling @ks_encrypt@ directly.
1061 extern keyset
*ks_gen(deriveargs */
*a*/
, peer */
*p*/
);
1063 /* --- @ks_activate@ --- *
1065 * Arguments: @keyset *ks@ = pointer to a keyset
1069 * Use: Activates a keyset, so that it can be used for encrypting
1070 * outgoing messages.
1073 extern void ks_activate(keyset */
*ks*/
);
1075 /* --- @ks_encrypt@ --- *
1077 * Arguments: @keyset *ks@ = pointer to a keyset
1078 * @unsigned ty@ = message type
1079 * @buf *b@ = pointer to input buffer
1080 * @buf *bb@ = pointer to output buffer
1082 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
1083 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
1084 * returns zero if there was insufficient buffer (but the output
1085 * buffer is broken in this case).
1087 * Use: Encrypts a block of data using the key. Note that the `key
1088 * ought to be replaced' notification is only ever given once
1089 * for each key. Also note that this call forces a keyset to be
1090 * used even if it's marked as not for data output.
1092 * The encryption transform is permitted to corrupt @buf_u@ for
1093 * its own purposes. Neither the source nor destination should
1094 * be within @buf_u@; and callers mustn't expect anything stored
1095 * in @buf_u@ to still
1098 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
1099 buf */
*b*/
, buf */
*bb*/
);
1101 /* --- @ks_decrypt@ --- *
1103 * Arguments: @keyset *ks@ = pointer to a keyset
1104 * @unsigned ty@ = expected type code
1105 * @buf *b@ = pointer to an input buffer
1106 * @buf *bb@ = pointer to an output buffer
1108 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1109 * zero if there was insufficient buffer (but the output buffer
1110 * is broken in this case).
1112 * Use: Attempts to decrypt a message using a given key. Note that
1113 * requesting decryption with a key directly won't clear a
1114 * marking that it's not for encryption.
1116 * The decryption transform is permitted to corrupt @buf_u@ for
1117 * its own purposes. Neither the source nor destination should
1118 * be within @buf_u@; and callers mustn't expect anything stored
1119 * in @buf_u@ to still
1122 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
1123 buf */
*b*/
, buf */
*bb*/
);
1125 /* --- @ksl_free@ --- *
1127 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1131 * Use: Frees (releases references to) all of the keys in a keyset.
1134 extern void ksl_free(keyset
**/
*ksroot*/
);
1136 /* --- @ksl_link@ --- *
1138 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1139 * @keyset *ks@ = pointer to a keyset
1143 * Use: Links a keyset into a list. A keyset can only be on one list
1144 * at a time. Bad things happen otherwise.
1147 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
1149 /* --- @ksl_prune@ --- *
1151 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1155 * Use: Prunes the keyset list by removing keys which mustn't be used
1159 extern void ksl_prune(keyset
**/
*ksroot*/
);
1161 /* --- @ksl_encrypt@ --- *
1163 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1164 * @unsigned ty@ = message type
1165 * @buf *b@ = pointer to input buffer
1166 * @buf *bb@ = pointer to output buffer
1168 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
1169 * new key; @KSERR_NOKEYS@ if there are no suitable keys
1170 * available. Also returns zero if there was insufficient
1171 * buffer space (but the output buffer is broken in this case).
1173 * Use: Encrypts a packet.
1176 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1177 buf */
*b*/
, buf */
*bb*/
);
1179 /* --- @ksl_decrypt@ --- *
1181 * Arguments: @keyset **ksroot@ = pointer to keyset list head
1182 * @unsigned ty@ = expected type code
1183 * @buf *b@ = pointer to input buffer
1184 * @buf *bb@ = pointer to output buffer
1186 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
1187 * zero if there was insufficient buffer (but the output buffer
1188 * is broken in this case).
1190 * Use: Decrypts a packet.
1193 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
1194 buf */
*b*/
, buf */
*bb*/
);
1196 /*----- Challenges --------------------------------------------------------*/
1198 /* --- @c_new@ --- *
1200 * Arguments: @const void *m@ = pointer to associated message, or null
1201 * @size_t msz@ = length of associated message
1202 * @buf *b@ = where to put the challenge
1204 * Returns: Zero if OK, nonzero on error.
1206 * Use: Issues a new challenge.
1209 extern int c_new(const void */
*m*/
, size_t /*msz*/, buf */
*b*/
);
1211 /* --- @c_check@ --- *
1213 * Arguments: @const void *m@ = pointer to associated message, or null
1214 * @size_t msz@ = length of associated message
1215 * @buf *b@ = where to find the challenge
1217 * Returns: Zero if OK, nonzero if it didn't work.
1219 * Use: Checks a challenge. On failure, the buffer is broken.
1222 extern int c_check(const void */
*m*/
, size_t /*msz*/, buf */
*b*/
);
1224 /*----- Administration interface ------------------------------------------*/
1226 #define A_END ((char *)0)
1228 /* --- @a_vformat@ --- *
1230 * Arguments: @dstr *d@ = where to leave the formatted message
1231 * @const char *fmt@ = pointer to format string
1232 * @va_list *ap@ = arguments in list
1236 * Use: Main message token formatting driver. The arguments are
1237 * interleaved formatting tokens and their parameters, finally
1238 * terminated by an entry @A_END@.
1240 * Tokens recognized:
1242 * * "*..." ... -- pretokenized @dstr_putf@-like string
1244 * * "?ADDR" SOCKADDR -- a socket address, to be converted
1246 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
1248 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
1250 * * "?PEER" PEER -- peer's name
1252 * * "?ERR" CODE -- system error code
1254 * * "?ERRNO" -- system error code from @errno@
1256 * * "[!]..." ... -- @dstr_putf@-like string as single token
1259 extern void a_vformat(dstr */
*d*/
, const char */
*fmt*/
, va_list */
*ap*/
);
1261 /* --- @a_format@ --- *
1263 * Arguments: @dstr *d@ = where to leave the formatted message
1264 * @const char *fmt@ = pointer to format string
1268 * Use: Writes a tokenized message into a string, for later
1272 extern void EXECL_LIKE(0) a_format(dstr */
*d*/
, const char */
*fmt*/
, ...);
1274 /* --- @a_info@ --- *
1276 * Arguments: @admin *a@ = connection
1277 * @const char *fmt@ = format string
1278 * @...@ = other arguments
1282 * Use: Report information to an admin client.
1285 extern void EXECL_LIKE(0) a_info(admin */
*a*/
, const char */
*fmt*/
, ...);
1287 /* --- @a_warn@ --- *
1289 * Arguments: @const char *fmt@ = pointer to format string
1290 * @...@ = other arguments
1294 * Use: Informs all admin connections of a warning.
1297 extern void EXECL_LIKE(0) a_warn(const char */
*fmt*/
, ...);
1299 /* --- @a_notify@ --- *
1301 * Arguments: @const char *fmt@ = pointer to format string
1302 * @...@ = other arguments
1306 * Use: Sends a notification to interested admin connections.
1309 extern void EXECL_LIKE(0) a_notify(const char */
*fmt*/
, ...);
1311 /* --- @a_create@ --- *
1313 * Arguments: @int fd_in, fd_out@ = file descriptors to use
1314 * @unsigned f@ = initial flags to set
1318 * Use: Creates a new admin connection. It's safe to call this
1319 * before @a_init@ -- and, indeed, this makes sense if you also
1320 * call @a_switcherr@ to report initialization errors through
1321 * the administration machinery.
1324 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
1326 /* --- @a_preselect@ --- *
1332 * Use: Informs the admin module that we're about to select again,
1333 * and that it should do cleanup things it has delayed until a
1337 extern void a_preselect(void);
1339 /* --- @a_daemon@ --- *
1345 * Use: Informs the admin module that it's a daemon.
1348 extern void a_daemon(void);
1350 /* --- @a_listen@ --- *
1352 * Arguments: @const char *name@ = socket name to create
1353 * @uid_t u@ = user to own the socket
1354 * @gid_t g@ = group to own the socket
1355 * @mode_t m@ = permissions to set on the socket
1357 * Returns: Zero on success, @-1@ on failure.
1359 * Use: Creates the admin listening socket.
1362 extern int a_listen(const char */
*sock*/
,
1363 uid_t
/*u*/, gid_t
/*g*/, mode_t
/*m*/);
1365 /* --- @a_unlisten@ --- *
1371 * Use: Stops listening to the administration socket and removes it.
1374 extern void a_unlisten(void);
1376 /* --- @a_switcherr@ --- *
1382 * Use: Arrange to report warnings, trace messages, etc. to
1383 * administration clients rather than the standard-error stream.
1385 * Obviously this makes no sense unless there is at least one
1386 * client established. Calling @a_listen@ won't help with this,
1387 * because the earliest a new client can connect is during the
1388 * first select-loop iteration, which is too late: some initial
1389 * client must have been added manually using @a_create@.
1392 extern void a_switcherr(void);
1394 /* --- @a_signals@ --- *
1400 * Use: Establishes handlers for the obvious signals.
1403 extern void a_signals(void);
1405 /* --- @a_init@ --- *
1407 * Arguments: @const char *sock@ = socket name to create
1408 * @uid_t u@ = user to own the socket
1409 * @gid_t g@ = group to own the socket
1410 * @mode_t m@ = permissions to set on the socket
1412 * Returns: Zero on success, @-1@ on failure.
1414 * Use: Creates the admin listening socket.
1417 extern int a_init(void);
1419 /*----- Mapping with addresses as keys ------------------------------------*/
1421 /* --- @am_create@ --- *
1423 * Arguments: @addrmap *m@ = pointer to map
1427 * Use: Create an address map, properly set up.
1430 extern void am_create(addrmap */
*m*/
);
1432 /* --- @am_destroy@ --- *
1434 * Arguments: @addrmap *m@ = pointer to map
1438 * Use: Destroy an address map, throwing away all the entries.
1441 extern void am_destroy(addrmap */
*m*/
);
1443 /* --- @am_find@ --- *
1445 * Arguments: @addrmap *m@ = pointer to map
1446 * @const addr *a@ = address to look up
1447 * @size_t sz@ = size of block to allocate
1448 * @unsigned *f@ = where to store flags
1450 * Returns: Pointer to found item, or null.
1452 * Use: Finds a record with the given IP address, set @*f@ nonzero
1453 * and returns it. If @sz@ is zero, and no match was found,
1454 * return null; otherwise allocate a new block of @sz@ bytes,
1455 * clear @*f@ to zero and return the block pointer.
1458 extern void *am_find(addrmap */
*m*/
, const addr */
*a*/
,
1459 size_t /*sz*/, unsigned */
*f*/
);
1461 /* --- @am_remove@ --- *
1463 * Arguments: @addrmap *m@ = pointer to map
1464 * @void *i@ = pointer to the item
1468 * Use: Removes an item from the map.
1471 extern void am_remove(addrmap */
*m*/
, void */
*i*/
);
1473 /*----- Privilege separation ----------------------------------------------*/
1475 /* --- @ps_trace@ --- *
1477 * Arguments: @unsigned mask@ = trace mask to check
1478 * @const char *fmt@ = message format
1479 * @...@ = values for placeholders
1483 * Use: Writes a trace message.
1486 T( extern void PRINTF_LIKE(2, 3)
1487 ps_trace(unsigned /*mask*/, const char */
*fmt*/
, ...); )
1489 /* --- @ps_warn@ --- *
1491 * Arguments: @const char *fmt@ = message format
1492 * @...@ = values for placeholders
1496 * Use: Writes a warning message.
1499 extern void PRINTF_LIKE(1, 2) ps_warn(const char */
*fmt*/
, ...);
1501 /* --- @ps_tunfd@ --- *
1503 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1504 * @char **ifn@ = where to put the interface name
1506 * Returns: The file descriptor, or @-1@ on error.
1508 * Use: Fetches a file descriptor for a tunnel driver.
1511 extern int ps_tunfd(const tunnel_ops */
*tops*/
, char **/
*ifn*/
);
1513 /* --- @ps_split@ --- *
1515 * Arguments: @int detachp@ = whether to detach the child from its terminal
1517 * Returns: Zero on success, @-1@ on failure.
1519 * Use: Separates off the privileged tunnel-opening service from the
1520 * rest of the server.
1523 extern int ps_split(int /*detachp*/);
1525 /* --- @ps_quit@ --- *
1531 * Use: Detaches from the helper process.
1534 extern void ps_quit(void);
1536 /*----- Peer management ---------------------------------------------------*/
1538 /* --- @p_updateaddr@ --- *
1540 * Arguments: @peer *p@ = pointer to peer block
1541 * @const addr *a@ = address to associate with this peer
1543 * Returns: Zero if the address was changed; @+1@ if it was already
1546 * Use: Updates our idea of @p@'s address.
1549 extern int p_updateaddr(peer */
*p*/
, const addr */
*a*/
);
1551 /* --- @p_txstart@ --- *
1553 * Arguments: @peer *p@ = pointer to peer block
1554 * @unsigned msg@ = message type code
1556 * Returns: A pointer to a buffer to write to.
1558 * Use: Starts sending to a peer. Only one send can happen at a
1562 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
1564 /* --- @p_txaddr@ --- *
1566 * Arguments: @const addr *a@ = recipient address
1567 * @const void *p@ = pointer to packet to send
1568 * @size_t sz@ = length of packet
1570 * Returns: Zero if successful, nonzero on error.
1572 * Use: Sends a packet to an address which (possibly) isn't a current
1576 extern int p_txaddr(const addr */
*a*/
, const void */
*p*/
, size_t /*sz*/);
1578 /* --- @p_txend@ --- *
1580 * Arguments: @peer *p@ = pointer to peer block
1584 * Use: Sends a packet to the peer.
1587 extern void p_txend(peer */
*p*/
);
1589 /* --- @p_pingsend@ --- *
1591 * Arguments: @peer *p@ = destination peer
1592 * @ping *pg@ = structure to fill in
1593 * @unsigned type@ = message type
1594 * @unsigned long timeout@ = how long to wait before giving up
1595 * @void (*func)(int, void *)@ = callback function
1596 * @void *arg@ = argument for callback
1598 * Returns: Zero if successful, nonzero if it failed.
1600 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1601 * if we get an answer within the timeout, or zero if no answer.
1604 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
1605 unsigned long /*timeout*/,
1606 void (*/
*func*/
)(int, void *), void */
*arg*/
);
1608 /* --- @p_pingdone@ --- *
1610 * Arguments: @ping *p@ = ping structure
1611 * @int rc@ = return code to pass on
1615 * Use: Disposes of a ping structure, maybe sending a notification.
1618 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
1620 /* --- @p_greet@ --- *
1622 * Arguments: @peer *p@ = peer to send to
1623 * @const void *c@ = pointer to challenge
1624 * @size_t sz@ = size of challenge
1628 * Use: Sends a greeting packet.
1631 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
1633 /* --- @p_tun@ --- *
1635 * Arguments: @peer *p@ = pointer to peer block
1636 * @buf *b@ = buffer containing incoming packet
1640 * Use: Handles a packet which needs to be sent to a peer.
1643 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
1645 /* --- @p_keyreload@ --- *
1651 * Use: Forces a check of the daemon's keyring files.
1654 extern void p_keyreload(void);
1656 /* --- @p_interval@ --- *
1662 * Use: Called periodically to do tidying.
1665 extern void p_interval(void);
1667 /* --- @p_stats@ --- *
1669 * Arguments: @peer *p@ = pointer to a peer block
1671 * Returns: A pointer to the peer's statistics.
1674 extern stats
*p_stats(peer */
*p*/
);
1676 /* --- @p_ifname@ --- *
1678 * Arguments: @peer *p@ = pointer to a peer block
1680 * Returns: A pointer to the peer's interface name.
1683 extern const char *p_ifname(peer */
*p*/
);
1685 /* --- @p_setifname@ --- *
1687 * Arguments: @peer *p@ = pointer to a peer block
1688 * @const char *name@ = pointer to the new name
1692 * Use: Changes the name held for a peer's interface.
1695 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
1697 /* --- @p_addr@ --- *
1699 * Arguments: @peer *p@ = pointer to a peer block
1701 * Returns: A pointer to the peer's address.
1704 extern const addr
*p_addr(peer */
*p*/
);
1706 /* --- @p_bind@ --- *
1708 * Arguments: @struct addrinfo *ailist@ = addresses to bind to
1710 * Returns: Zero on success, @-1@ on failure.
1712 * Use: Binds to the main UDP sockets.
1715 extern int p_bind(struct addrinfo */
*ailist*/
);
1717 /* --- @p_unbind@ --- *
1723 * Use: Unbinds the UDP sockets. There must not be any active peers,
1724 * and none can be created until the sockets are rebound.
1727 extern void p_unbind(void);
1729 /* --- @p_init@ --- *
1735 * Use: Initializes the peer system.
1738 extern void p_init(void);
1740 /* --- @p_addtun@ --- *
1742 * Arguments: @const tunnel_ops *tops@ = tunnel ops to add
1744 * Returns: Zero on success, @-1@ on failure.
1746 * Use: Adds a tunnel class to the list of known classes, if it
1747 * initializes properly. If there is no current default tunnel,
1748 * then this one is made the default.
1750 * Does nothing if the tunnel class is already known. So adding
1751 * a bunch of tunnels takes quadratic time, but there will be
1752 * too few to care about.
1755 extern int p_addtun(const tunnel_ops */
*tops*/
);
1757 /* --- @p_setdflttun@ --- *
1759 * Arguments: @const tunnel_ops *tops@ = tunnel ops to set
1763 * Use: Sets the default tunnel. It must already be registered. The
1764 * old default is forgotten.
1767 extern void p_setdflttun(const tunnel_ops */
*tops*/
);
1769 /* --- @p_dflttun@ --- *
1773 * Returns: A pointer to the current default tunnel operations, or null
1774 * if no tunnels are defined.
1777 extern const tunnel_ops
*p_dflttun(void);
1779 /* --- @p_findtun@ --- *
1781 * Arguments: @const char *name@ = tunnel name
1783 * Returns: Pointer to the tunnel operations, or null.
1785 * Use: Finds the operations for a named tunnel class.
1788 extern const tunnel_ops
*p_findtun(const char */
*name*/
);
1790 /* --- @p_mktuniter@ --- *
1792 * Arguments: @tuniter *i@ = pointer to iterator to initialize
1796 * Use: Initializes a tunnel iterator.
1799 extern void p_mktuniter(tun_iter */
*i*/
);
1801 /* --- @p_nexttun@ --- *
1803 * Arguments: @tuniter *i@ = pointer to iterator
1805 * Returns: Pointer to the next tunnel's operations, or null.
1808 extern const tunnel_ops
*p_nexttun(tun_iter */
*i*/
);
1810 /* --- @FOREACH_TUN@ --- *
1812 * Arguments: @tops@ = name to bind to each tunnel
1813 * @stuff@ = thing to do for each item
1815 * Use: Does something for each known tunnel class.
1818 #define FOREACH_TUN(tops, stuff) do { \
1820 const tunnel_ops *tops; \
1821 for (p_mktuniter(&i_); (tops = p_nexttun(&i_)) != 0; ) stuff; \
1824 /* --- @p_create@ --- *
1826 * Arguments: @peerspec *spec@ = information about this peer
1828 * Returns: Pointer to the peer block, or null if it failed.
1830 * Use: Creates a new named peer block. No peer is actually attached
1834 extern peer
*p_create(peerspec */
*spec*/
);
1836 /* --- @p_name@ --- *
1838 * Arguments: @peer *p@ = pointer to a peer block
1840 * Returns: A pointer to the peer's name.
1842 * Use: Equivalent to @p_spec(p)->name@.
1845 extern const char *p_name(peer */
*p*/
);
1847 /* --- @p_tag@ --- *
1849 * Arguments: @peer *p@ = pointer to a peer block
1851 * Returns: A pointer to the peer's public key tag.
1854 extern const char *p_tag(peer */
*p*/
);
1856 /* --- @p_privtag@ --- *
1858 * Arguments: @peer *p@ = pointer to a peer block
1860 * Returns: A pointer to the peer's private key tag.
1863 extern const char *p_privtag(peer */
*p*/
);
1865 /* --- @p_spec@ --- *
1867 * Arguments: @peer *p@ = pointer to a peer block
1869 * Returns: Pointer to the peer's specification
1872 extern const peerspec
*p_spec(peer */
*p*/
);
1874 /* --- @p_findbyaddr@ --- *
1876 * Arguments: @const addr *a@ = address to look up
1878 * Returns: Pointer to the peer block, or null if not found.
1880 * Use: Finds a peer by address.
1883 extern peer
*p_findbyaddr(const addr */
*a*/
);
1885 /* --- @p_find@ --- *
1887 * Arguments: @const char *name@ = name to look up
1889 * Returns: Pointer to the peer block, or null if not found.
1891 * Use: Finds a peer by name.
1894 extern peer
*p_find(const char */
*name*/
);
1896 /* --- @p_destroy@ --- *
1898 * Arguments: @peer *p@ = pointer to a peer
1899 * @int bye@ = say goodbye to the peer?
1903 * Use: Destroys a peer.
1906 extern void p_destroy(peer */
*p*/
, int /*bye*/);
1908 /* --- @p_destroyall@ --- *
1914 * Use: Destroys all of the peers, saying goodbye.
1917 extern void p_destroyall(void);
1919 /* --- @FOREACH_PEER@ --- *
1921 * Arguments: @p@ = name to bind to each peer
1922 * @stuff@ = thing to do for each item
1924 * Use: Does something for each current peer.
1927 #define FOREACH_PEER(p, stuff) do { \
1930 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \
1933 /* --- @p_mkiter@ --- *
1935 * Arguments: @peer_iter *i@ = pointer to an iterator
1939 * Use: Initializes the iterator.
1942 extern void p_mkiter(peer_iter */
*i*/
);
1944 /* --- @p_next@ --- *
1946 * Arguments: @peer_iter *i@ = pointer to an iterator
1948 * Returns: Next peer, or null if at the end.
1950 * Use: Returns the next peer.
1953 extern peer
*p_next(peer_iter */
*i*/
);
1955 /*----- The interval timer ------------------------------------------------*/
1957 /* --- @iv_addreason@ --- *
1963 * Use: Adds an `interval timer reason'; if there are no others, the
1964 * interval timer is engaged.
1967 extern void iv_addreason(void);
1969 /* --- @iv_rmreason@ --- *
1975 * Use: Removes an interval timer reason; if there are none left, the
1976 * interval timer is disengaged.
1979 extern void iv_rmreason(void);
1981 /*----- The main loop -----------------------------------------------------*/
1983 /* --- @lp_init@ --- *
1989 * Use: Initializes the main loop. Most importantly, this sets up
1990 * the select multiplexor that everything else hooks onto.
1993 extern void lp_init(void);
1995 /* --- @lp_end@ --- *
2001 * Use: Requests an exit from the main loop.
2004 extern void lp_end(void);
2006 /* --- @lp_run@ --- *
2010 * Returns: Zero on successful termination; @-1@ if things went wrong.
2012 * Use: Cranks the main loop until it should be cranked no more.
2015 extern int lp_run(void);
2017 /*----- Tunnel drivers ----------------------------------------------------*/
2020 extern const tunnel_ops tun_linux
;
2024 extern const tunnel_ops tun_unet
;
2028 extern const tunnel_ops tun_bsd
;
2031 extern const tunnel_ops tun_slip
;
2033 /*----- Other handy utilities ---------------------------------------------*/
2035 /* --- @timestr@ --- *
2037 * Arguments: @time_t t@ = a time to convert
2039 * Returns: A pointer to a textual representation of the time.
2041 * Use: Converts a time to a textual representation. Corrupts
2045 extern const char *timestr(time_t /*t*/);
2047 /* --- @mystrieq@ --- *
2049 * Arguments: @const char *x, *y@ = two strings
2051 * Returns: True if @x@ and @y are equal, up to case.
2054 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
2058 * Arguments: @int af@ = an address family code
2060 * Returns: The index of the address family's record in @aftab@, or @-1@.
2063 extern int afix(int af
);
2065 /* --- @addrsz@ --- *
2067 * Arguments: @const addr *a@ = a network address
2069 * Returns: The size of the address, for passing into the sockets API.
2072 extern socklen_t
addrsz(const addr */
*a*/
);
2074 /* --- @getport@, @setport@ --- *
2076 * Arguments: @addr *a@ = a network address
2077 * @unsigned port@ = port number to set
2081 * Use: Retrieves or sets the port number in an address structure.
2084 extern unsigned getport(addr */
*a*/
);
2085 extern void setport(addr */
*a*/
, unsigned /*port*/);
2087 /* --- @seq_reset@ --- *
2089 * Arguments: @seqwin *s@ = sequence-checking window
2093 * Use: Resets a sequence number window.
2096 extern void seq_reset(seqwin */
*s*/
);
2098 /* --- @seq_check@ --- *
2100 * Arguments: @seqwin *s@ = sequence-checking window
2101 * @uint32 q@ = sequence number to check
2102 * @const char *service@ = service to report message from
2104 * Returns: A @SEQ_@ code.
2106 * Use: Checks a sequence number against the window, updating things
2110 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
2112 typedef struct ratelim
{
2113 unsigned n
, max
, persec
;
2114 struct timeval when
;
2117 /* --- @ratelim_init@ --- *
2119 * Arguments: @ratelim *r@ = rate-limiting state to fill in
2120 * @unsigned persec@ = credit to accumulate per second
2121 * @unsigned max@ = maximum credit to retain
2125 * Use: Initialize a rate-limiting state.
2128 extern void ratelim_init(ratelim */
*r*/
,
2129 unsigned /*persec*/, unsigned /*max*/);
2131 /* --- @ratelim_withdraw@ --- *
2133 * Arguments: @ratelim *r@ = rate-limiting state
2134 * @unsigned n@ = credit to withdraw
2136 * Returns: Zero if successful; @-1@ if there is unsufficient credit
2138 * Use: Updates the state with any accumulated credit. Then, if
2139 * there there are more than @n@ credits available, withdraw @n@
2140 * and return successfully; otherwise, report failure.
2143 extern int ratelim_withdraw(ratelim */
*r*/
, unsigned /*n*/);
2145 /* --- @ies_encrypt@ --- *
2147 * Arguments: @kdata *kpub@ = recipient's public key
2148 * @unsigned ty@ = message type octet
2149 * @buf *b@ = input message buffer
2150 * @buf *bb@ = output buffer for the ciphertext
2152 * Returns: On error, returns a @KSERR_...@ code or breaks the buffer;
2153 * on success, returns zero and the buffer is good.
2155 * Use: Encrypts a message for a recipient, given their public key.
2156 * This does not (by itself) provide forward secrecy or sender
2157 * authenticity. The ciphertext is self-delimiting (unlike
2161 extern int ies_encrypt(kdata */
*kpub*/
, unsigned /*ty*/,
2162 buf */
*b*/
, buf */
*bb*/
);
2164 /* --- @ies_decrypt@ --- *
2166 * Arguments: @kdata *kpub@ = private key key
2167 * @unsigned ty@ = message type octet
2168 * @buf *b@ = input ciphertext buffer
2169 * @buf *bb@ = output buffer for the message
2171 * Returns: On error, returns a @KSERR_...@ code; on success, returns
2172 * zero and the buffer is good.
2174 * Use: Decrypts a message encrypted using @ies_encrypt@, given our
2178 extern int ies_decrypt(kdata */
*kpriv*/
, unsigned /*ty*/,
2179 buf */
*b*/
, buf */
*bb*/
);
2181 /*----- That's all, folks -------------------------------------------------*/