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>
56 #include <sys/socket.h>
58 #include <netinet/in.h>
59 #include <arpa/inet.h>
65 #include <mLib/alloc.h>
66 #include <mLib/arena.h>
67 #include <mLib/base64.h>
68 #include <mLib/bres.h>
69 #include <mLib/daemonize.h>
70 #include <mLib/dstr.h>
72 #include <mLib/fdflags.h>
73 #include <mLib/fwatch.h>
74 #include <mLib/hash.h>
75 #include <mLib/macros.h>
76 #include <mLib/mdwopt.h>
77 #include <mLib/quis.h>
78 #include <mLib/report.h>
80 #include <mLib/selbuf.h>
84 #include <mLib/trace.h>
86 #include <mLib/versioncmp.h>
88 #include <catacomb/buf.h>
90 #include <catacomb/gcipher.h>
91 #include <catacomb/gmac.h>
92 #include <catacomb/grand.h>
93 #include <catacomb/key.h>
94 #include <catacomb/paranoia.h>
96 #include <catacomb/noise.h>
97 #include <catacomb/rand.h>
99 #include <catacomb/mp.h>
100 #include <catacomb/mprand.h>
101 #include <catacomb/dh.h>
102 #include <catacomb/ec.h>
103 #include <catacomb/ec-keys.h>
104 #include <catacomb/group.h>
106 #include "protocol.h"
112 /*----- Magic numbers -----------------------------------------------------*/
114 /* --- Trace flags --- */
122 #define T_KEYEXCH 64u
123 #define T_KEYMGMT 128u
130 #define SEC(n) (n##u)
131 #define MIN(n) (n##u * 60u)
132 #define MEG(n) (n##ul * 1024ul * 1024ul)
134 /* --- Other things --- */
136 #define PKBUFSZ 65536
138 /*----- Cipher selections -------------------------------------------------*/
140 typedef struct algswitch
{
141 const gccipher
*c
; /* Symmetric encryption scheme */
142 const gccipher
*mgf
; /* Mask-generation function */
143 const gchash
*h
; /* Hash function */
144 const gcmac
*m
; /* Message authentication code */
145 size_t hashsz
; /* Hash output size */
146 size_t tagsz
; /* Length to truncate MAC tags */
147 size_t cksz
, mksz
; /* Key lengths for @c@ and @m@ */
150 extern algswitch algs
;
152 #define MAXHASHSZ 64 /* Largest possible hash size */
154 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
156 /*----- Data structures ---------------------------------------------------*/
158 /* --- Socket addresses --- *
160 * A magic union of supported socket addresses.
165 struct sockaddr_in sin
;
168 /* --- Mapping keyed on addresses --- */
170 typedef struct addrmap
{
175 typedef struct addrmap_base
{
180 /* --- Sequence number checking --- */
182 typedef struct seqwin
{
183 uint32 seq
; /* First acceptable input sequence */
184 uint32 win
; /* Window of acceptable numbers */
187 #define SEQ_WINSZ 32 /* Bits in sequence number window */
189 /* --- A symmetric keyset --- *
191 * A keyset contains a set of symmetric keys for encrypting and decrypting
192 * packets. Keysets are stored in a list, sorted in reverse order of
193 * creation, so that the most recent keyset (the one most likely to be used)
196 * Each keyset has a time limit and a data limit. The keyset is destroyed
197 * when either it has existed for too long, or it has been used to encrypt
198 * too much data. New key exchanges are triggered when keys are close to
202 typedef struct keyset
{
203 struct keyset
*next
; /* Next active keyset in the list */
204 unsigned ref
; /* Reference count for keyset */
205 struct peer
*p
; /* Pointer to peer structure */
206 time_t t_exp
; /* Expiry time for this keyset */
207 unsigned long sz_exp
; /* Data limit for the keyset */
208 T( unsigned seq
; ) /* Sequence number for tracing */
209 unsigned f
; /* Various useful flags */
210 gcipher
*cin
, *cout
; /* Keyset ciphers for encryption */
211 size_t tagsz
; /* Length to truncate MAC tags */
212 gmac
*min
, *mout
; /* Keyset MACs for integrity */
213 uint32 oseq
; /* Outbound sequence number */
214 seqwin iseq
; /* Inbound sequence number */
217 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
218 #define KSF_LINK 2u /* Key is in a linked list */
220 /* --- Key exchange --- *
222 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
223 * Protocol has a number of desirable features (e.g., perfect forward
224 * secrecy, and zero-knowledge authentication) which make it attractive for
225 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
231 typedef struct kxchal
{
232 struct keyexch
*kx
; /* Pointer back to key exchange */
233 ge
*c
; /* Responder's challenge */
234 ge
*r
; /* My reply to the challenge */
235 keyset
*ks
; /* Pointer to temporary keyset */
236 unsigned f
; /* Various useful flags */
237 sel_timer t
; /* Response timer for challenge */
238 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
239 octet ck
[MAXHASHSZ
]; /* His magical check value */
240 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
241 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
242 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
243 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
246 typedef struct keyexch
{
247 struct peer
*p
; /* Pointer back to the peer */
248 keyset
**ks
; /* Peer's list of keysets */
249 unsigned f
; /* Various useful flags */
250 unsigned s
; /* Current state in exchange */
251 sel_timer t
; /* Timer for next exchange */
252 ge
*kpub
; /* Peer's public key */
253 time_t texp_kpub
; /* Expiry time for public key */
254 mp
*alpha
; /* My temporary secret */
255 ge
*c
; /* My challenge */
256 ge
*rx
; /* The expected response */
257 unsigned nr
; /* Number of extant responses */
258 time_t t_valid
; /* When this exchange goes bad */
259 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
260 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
263 #define KXF_TIMER 1u /* Waiting for a timer to go off */
264 #define KXF_DEAD 2u /* The key-exchanger isn't up */
265 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
266 #define KXF_CORK 8u /* Don't send anything yet */
269 KXS_DEAD
, /* Uninitialized state (magical) */
270 KXS_CHAL
, /* Main answer-challenges state */
271 KXS_COMMIT
, /* Committed: send switch request */
272 KXS_SWITCH
/* Switched: send confirmation */
275 /* --- Tunnel structure --- *
277 * Used to maintain system-specific information about the tunnel interface.
280 typedef struct tunnel tunnel
;
283 typedef struct tunnel_ops
{
284 const char *name
; /* Name of this tunnel driver */
285 void (*init
)(void); /* Initializes the system */
286 tunnel
*(*create
)(struct peer */
*p*/
, char **/
*ifn*/
);
287 /* Initializes a new tunnel */
288 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
289 /* Notifies ifname change */
290 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
291 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
294 #ifndef TUN_INTERNALS
295 struct tunnel
{ const tunnel_ops
*ops
; };
298 /* --- Peer statistics --- *
300 * Contains various interesting and not-so-interesting statistics about a
301 * peer. This is updated by various parts of the code. The format of the
302 * structure isn't considered private, and @p_stats@ returns a pointer to the
303 * statistics block for a given peer.
306 typedef struct stats
{
307 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
308 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
309 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
310 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
311 unsigned long n_reject
; /* Number of rejected packets */
312 unsigned long n_in
, n_out
; /* Number of packets in and out */
313 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
314 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
317 /* --- Peer structure --- *
319 * The main structure which glues everything else together.
322 typedef struct peerspec
{
323 char *name
; /* Peer's name */
324 const tunnel_ops
*tops
; /* Tunnel operations */
325 unsigned long t_ka
; /* Keep alive interval */
326 addr sa
; /* Socket address to speak to */
327 size_t sasz
; /* Socket address size */
328 unsigned kxf
; /* Key exchange flags to set */
331 typedef struct peer_byname
{
336 typedef struct peer_byaddr
{
341 typedef struct peer
{
342 peer_byname
*byname
; /* Lookup-by-name block */
343 peer_byaddr
*byaddr
; /* Lookup-by-address block */
344 struct ping
*pings
; /* Pings we're waiting for */
345 peerspec spec
; /* Specifications for this peer */
346 tunnel
*t
; /* Tunnel for local packets */
347 char *ifname
; /* Interface name for tunnel */
348 keyset
*ks
; /* List head for keysets */
349 buf b
; /* Buffer for sending packets */
350 stats st
; /* Statistics */
351 keyexch kx
; /* Key exchange protocol block */
352 sel_timer tka
; /* Timer for keepalives */
355 typedef struct peer_iter
{ sym_iter i
; } peer_iter
;
357 typedef struct ping
{
358 struct ping
*next
, *prev
; /* Links to next and previous */
359 peer
*p
; /* Peer so we can free it */
360 unsigned msg
; /* Kind of response expected */
361 uint32 id
; /* Id so we can recognize response */
362 octet magic
[32]; /* Some random data */
363 sel_timer t
; /* Timeout for ping */
364 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
365 void *arg
; /* Argument for callback */
376 /* --- Admin structure --- */
378 #define OBUFSZ 16384u
380 typedef struct obuf
{
381 struct obuf
*next
; /* Next buffer in list */
382 char *p_in
, *p_out
; /* Pointers into the buffer */
383 char buf
[OBUFSZ
]; /* The actual buffer */
386 typedef struct oqueue
{
387 obuf
*hd
, *tl
; /* Head and tail pointers */
392 typedef struct admin_bgop
{
393 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
394 struct admin
*a
; /* Owner job */
395 char *tag
; /* Tag string for messages */
396 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
399 typedef struct admin_resop
{
400 admin_bgop bg
; /* Background operation header */
401 char *addr
; /* Hostname to be resolved */
402 bres_client r
; /* Background resolver task */
403 sel_timer t
; /* Timer for resolver */
404 addr sa
; /* Socket address */
405 size_t sasz
; /* Socket address size */
406 void (*func
)(struct admin_resop
*, int); /* Handler */
409 enum { ARES_OK
, ARES_FAIL
};
411 typedef struct admin_addop
{
412 admin_resop r
; /* Name resolution header */
413 peerspec peer
; /* Peer pending creation */
416 typedef struct admin_greetop
{
417 admin_resop r
; /* Name resolution header */
418 void *c
; /* Challenge block */
419 size_t sz
; /* Length of challenge */
422 typedef struct admin_pingop
{
423 admin_bgop bg
; /* Background operation header */
424 ping ping
; /* Ping pending response */
425 struct timeval pingtime
; /* Time last ping was sent */
428 typedef struct admin_service
{
429 sym_base _b
; /* Hash table base structure */
430 char *version
; /* The provided version */
431 struct admin
*prov
; /* Which client provides me */
432 struct admin_service
*next
, *prev
; /* Client's list of services */
435 typedef struct admin_svcop
{
436 admin_bgop bg
; /* Background operation header */
437 struct admin
*prov
; /* Client servicing this job */
438 unsigned index
; /* This job's index */
439 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
442 typedef struct admin_jobentry
{
443 unsigned short seq
; /* Zero if unused */
445 admin_svcop
*op
; /* Operation, if slot in use, ... */
446 uint32 next
; /* ... or index of next free slot */
450 typedef struct admin_jobtable
{
451 uint32 n
, sz
; /* Used slots and table size */
452 admin_svcop
*active
; /* List of active jobs */
453 uint32 free
; /* Index of first free slot */
454 admin_jobentry
*v
; /* And the big array of entries */
457 typedef struct admin
{
458 struct admin
*next
, *prev
; /* Links to next and previous */
459 unsigned f
; /* Various useful flags */
460 unsigned ref
; /* Reference counter */
462 unsigned seq
; /* Sequence number for tracing */
464 oqueue out
; /* Output buffer list */
465 oqueue delay
; /* Delayed output buffer list */
466 admin_bgop
*bg
; /* Backgrounded operations */
467 admin_service
*svcs
; /* Which services I provide */
468 admin_jobtable j
; /* Table of outstanding jobs */
469 selbuf b
; /* Line buffer for commands */
470 sel_file w
; /* Selector for write buffering */
473 #define AF_DEAD 1u /* Destroy this admin block */
474 #define AF_CLOSE 2u /* Client closed connection */
475 #define AF_NOTE 4u /* Catch notifications */
476 #define AF_WARN 8u /* Catch warning messages */
478 #define AF_TRACE 16u /* Catch tracing */
482 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
484 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
487 /*----- Global variables --------------------------------------------------*/
489 extern sel_state sel
; /* Global I/O event state */
490 extern group
*gg
; /* The group we work in */
491 extern size_t indexsz
; /* Size of exponent for the group */
492 extern mp
*kpriv
; /* Our private key */
493 extern ge
*kpub
; /* Our public key */
494 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
], buf_u
[PKBUFSZ
];
495 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
496 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
499 extern const trace_opt tr_opts
[]; /* Trace options array */
500 extern unsigned tr_flags
; /* Trace options flags */
503 /*----- Other macros ------------------------------------------------------*/
505 #define TIMER noise_timer(RAND_GLOBAL)
507 /*----- Key management ----------------------------------------------------*/
509 /* --- @km_reload@ --- *
513 * Returns: Zero if OK, nonzero to force reloading of keys.
515 * Use: Checks the keyrings to see if they need reloading.
518 extern int km_reload(void);
520 /* --- @km_init@ --- *
522 * Arguments: @const char *kr_priv@ = private keyring file
523 * @const char *kr_pub@ = public keyring file
524 * @const char *tag@ = tag to load
528 * Use: Initializes, and loads the private key.
531 extern void km_init(const char */
*kr_priv*/
, const char */
*kr_pub*/
,
532 const char */
*tag*/
);
534 /* --- @km_getpubkey@ --- *
536 * Arguments: @const char *tag@ = public key tag to load
537 * @ge *kpub@ = where to put the public key
538 * @time_t *t_exp@ = where to put the expiry time
540 * Returns: Zero if OK, nonzero if it failed.
542 * Use: Fetches a public key from the keyring.
545 extern int km_getpubkey(const char */
*tag*/
, ge */
*kpub*/
,
548 /*----- Key exchange ------------------------------------------------------*/
550 /* --- @kx_start@ --- *
552 * Arguments: @keyexch *kx@ = pointer to key exchange context
553 * @int forcep@ = nonzero to ignore the quiet timer
557 * Use: Stimulates a key exchange. If a key exchage is in progress,
558 * a new challenge is sent (unless the quiet timer forbids
559 * this); if no exchange is in progress, one is commenced.
562 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
564 /* --- @kx_message@ --- *
566 * Arguments: @keyexch *kx@ = pointer to key exchange context
567 * @unsigned msg@ = the message code
568 * @buf *b@ = pointer to buffer containing the packet
572 * Use: Reads a packet containing key exchange messages and handles
576 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
578 /* --- @kx_free@ --- *
580 * Arguments: @keyexch *kx@ = pointer to key exchange context
584 * Use: Frees everything in a key exchange context.
587 extern void kx_free(keyexch */
*kx*/
);
589 /* --- @kx_newkeys@ --- *
591 * Arguments: @keyexch *kx@ = pointer to key exchange context
595 * Use: Informs the key exchange module that its keys may have
596 * changed. If fetching the new keys fails, the peer will be
597 * destroyed, we log messages and struggle along with the old
601 extern void kx_newkeys(keyexch */
*kx*/
);
603 /* --- @kx_init@ --- *
605 * Arguments: @keyexch *kx@ = pointer to key exchange context
606 * @peer *p@ = pointer to peer context
607 * @keyset **ks@ = pointer to keyset list
608 * @unsigned f@ = various useful flags
610 * Returns: Zero if OK, nonzero if it failed.
612 * Use: Initializes a key exchange module. The module currently
613 * contains no keys, and will attempt to initiate a key
617 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
,
618 keyset
**/
*ks*/
, unsigned /*f*/);
620 /*----- Keysets and symmetric cryptography --------------------------------*/
622 /* --- @ks_drop@ --- *
624 * Arguments: @keyset *ks@ = pointer to a keyset
628 * Use: Decrements a keyset's reference counter. If the counter hits
629 * zero, the keyset is freed.
632 extern void ks_drop(keyset */
*ks*/
);
634 /* --- @ks_gen@ --- *
636 * Arguments: @const void *k@ = pointer to key material
637 * @size_t x, y, z@ = offsets into key material (see below)
638 * @peer *p@ = pointer to peer information
640 * Returns: A pointer to the new keyset.
642 * Use: Derives a new keyset from the given key material. The
643 * offsets @x@, @y@ and @z@ separate the key material into three
644 * parts. Between the @k@ and @k + x@ is `my' contribution to
645 * the key material; between @k + x@ and @k + y@ is `your'
646 * contribution; and between @k + y@ and @k + z@ is a shared
647 * value we made together. These are used to construct two
648 * pairs of symmetric keys. Each pair consists of an encryption
649 * key and a message authentication key. One pair is used for
650 * outgoing messages, the other for incoming messages.
652 * The new key is marked so that it won't be selected for output
653 * by @ksl_encrypt@. You can still encrypt data with it by
654 * calling @ks_encrypt@ directly.
657 extern keyset
*ks_gen(const void */
*k*/
,
658 size_t /*x*/, size_t /*y*/, size_t /*z*/,
661 /* --- @ks_tregen@ --- *
663 * Arguments: @keyset *ks@ = pointer to a keyset
665 * Returns: The time at which moves ought to be made to replace this key.
668 extern time_t ks_tregen(keyset */
*ks*/
);
670 /* --- @ks_activate@ --- *
672 * Arguments: @keyset *ks@ = pointer to a keyset
676 * Use: Activates a keyset, so that it can be used for encrypting
680 extern void ks_activate(keyset */
*ks*/
);
682 /* --- @ks_encrypt@ --- *
684 * Arguments: @keyset *ks@ = pointer to a keyset
685 * @unsigned ty@ = message type
686 * @buf *b@ = pointer to input buffer
687 * @buf *bb@ = pointer to output buffer
689 * Returns: Zero if OK, nonzero if the key needs replacing. If the
690 * encryption failed, the output buffer is broken and zero is
693 * Use: Encrypts a block of data using the key. Note that the `key
694 * ought to be replaced' notification is only ever given once
695 * for each key. Also note that this call forces a keyset to be
696 * used even if it's marked as not for data output.
699 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
700 buf */
*b*/
, buf */
*bb*/
);
702 /* --- @ks_decrypt@ --- *
704 * Arguments: @keyset *ks@ = pointer to a keyset
705 * @unsigned ty@ = expected type code
706 * @buf *b@ = pointer to an input buffer
707 * @buf *bb@ = pointer to an output buffer
709 * Returns: Zero on success, or nonzero if there was some problem.
711 * Use: Attempts to decrypt a message using a given key. Note that
712 * requesting decryption with a key directly won't clear a
713 * marking that it's not for encryption.
716 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
717 buf */
*b*/
, buf */
*bb*/
);
719 /* --- @ksl_free@ --- *
721 * Arguments: @keyset **ksroot@ = pointer to keyset list head
725 * Use: Frees (releases references to) all of the keys in a keyset.
728 extern void ksl_free(keyset
**/
*ksroot*/
);
730 /* --- @ksl_link@ --- *
732 * Arguments: @keyset **ksroot@ = pointer to keyset list head
733 * @keyset *ks@ = pointer to a keyset
737 * Use: Links a keyset into a list. A keyset can only be on one list
738 * at a time. Bad things happen otherwise.
741 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
743 /* --- @ksl_prune@ --- *
745 * Arguments: @keyset **ksroot@ = pointer to keyset list head
749 * Use: Prunes the keyset list by removing keys which mustn't be used
753 extern void ksl_prune(keyset
**/
*ksroot*/
);
755 /* --- @ksl_encrypt@ --- *
757 * Arguments: @keyset **ksroot@ = pointer to keyset list head
758 * @unsigned ty@ = message type
759 * @buf *b@ = pointer to input buffer
760 * @buf *bb@ = pointer to output buffer
762 * Returns: Nonzero if a new key is needed.
764 * Use: Encrypts a packet.
767 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
768 buf */
*b*/
, buf */
*bb*/
);
770 /* --- @ksl_decrypt@ --- *
772 * Arguments: @keyset **ksroot@ = pointer to keyset list head
773 * @unsigned ty@ = expected type code
774 * @buf *b@ = pointer to input buffer
775 * @buf *bb@ = pointer to output buffer
777 * Returns: Nonzero if the packet couldn't be decrypted.
779 * Use: Decrypts a packet.
782 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
783 buf */
*b*/
, buf */
*bb*/
);
785 /*----- Challenges --------------------------------------------------------*/
789 * Arguments: @buf *b@ = where to put the challenge
791 * Returns: Zero if OK, nonzero on error.
793 * Use: Issues a new challenge.
796 extern int c_new(buf */
*b*/
);
798 /* --- @c_check@ --- *
800 * Arguments: @buf *b@ = where to find the challenge
802 * Returns: Zero if OK, nonzero if it didn't work.
804 * Use: Checks a challenge. On failure, the buffer is broken.
807 extern int c_check(buf */
*b*/
);
809 /*----- Administration interface ------------------------------------------*/
811 #define A_END ((char *)0)
813 /* --- @a_warn@ --- *
815 * Arguments: @const char *fmt@ = pointer to format string
816 * @...@ = other arguments
820 * Use: Informs all admin connections of a warning.
823 extern void a_warn(const char */
*fmt*/
, ...);
825 /* --- @a_notify@ --- *
827 * Arguments: @const char *fmt@ = pointer to format string
828 * @...@ = other arguments
832 * Use: Sends a notification to interested admin connections.
835 extern void a_notify(const char */
*fmt*/
, ...);
837 /* --- @a_create@ --- *
839 * Arguments: @int fd_in, fd_out@ = file descriptors to use
840 * @unsigned f@ = initial flags to set
844 * Use: Creates a new admin connection.
847 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
849 /* --- @a_quit@ --- *
855 * Use: Shuts things down nicely.
858 extern void a_quit(void);
860 /* --- @a_preselect@ --- *
866 * Use: Informs the admin module that we're about to select again,
867 * and that it should do cleanup things it has delayed until a
871 extern void a_preselect(void);
873 /* --- @a_daemon@ --- *
879 * Use: Informs the admin module that it's a daemon.
882 extern void a_daemon(void);
884 /* --- @a_init@ --- *
886 * Arguments: @const char *sock@ = socket name to create
890 * Use: Creates the admin listening socket.
893 extern void a_init(const char */
*sock*/
);
895 /*----- Mapping with addresses as keys ------------------------------------*/
897 /* --- @am_create@ --- *
899 * Arguments: @addrmap *m@ = pointer to map
903 * Use: Create an address map, properly set up.
906 extern void am_create(addrmap */
*m*/
);
908 /* --- @am_destroy@ --- *
910 * Arguments: @addrmap *m@ = pointer to map
914 * Use: Destroy an address map, throwing away all the entries.
917 extern void am_destroy(addrmap */
*m*/
);
919 /* --- @am_find@ --- *
921 * Arguments: @addrmap *m@ = pointer to map
922 * @const addr *a@ = address to look up
923 * @size_t sz@ = size of block to allocate
924 * @unsigned *f@ = where to store flags
926 * Returns: Pointer to found item, or null.
928 * Use: Finds a record with the given IP address, set @*f@ nonzero
929 * and returns it. If @sz@ is zero, and no match was found,
930 * return null; otherwise allocate a new block of @sz@ bytes,
931 * clear @*f@ to zero and return the block pointer.
934 extern void *am_find(addrmap */
*m*/
, const addr */
*a*/
,
935 size_t /*sz*/, unsigned */
*f*/
);
937 /* --- @am_remove@ --- *
939 * Arguments: @addrmap *m@ = pointer to map
940 * @void *i@ = pointer to the item
944 * Use: Removes an item from the map.
947 extern void am_remove(addrmap */
*m*/
, void */
*i*/
);
949 /*----- Peer management ---------------------------------------------------*/
951 /* --- @p_txstart@ --- *
953 * Arguments: @peer *p@ = pointer to peer block
954 * @unsigned msg@ = message type code
956 * Returns: A pointer to a buffer to write to.
958 * Use: Starts sending to a peer. Only one send can happen at a
962 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
964 /* --- @p_txend@ --- *
966 * Arguments: @peer *p@ = pointer to peer block
970 * Use: Sends a packet to the peer.
973 extern void p_txend(peer */
*p*/
);
975 /* --- @p_pingsend@ --- *
977 * Arguments: @peer *p@ = destination peer
978 * @ping *pg@ = structure to fill in
979 * @unsigned type@ = message type
980 * @unsigned long timeout@ = how long to wait before giving up
981 * @void (*func)(int, void *)@ = callback function
982 * @void *arg@ = argument for callback
984 * Returns: Zero if successful, nonzero if it failed.
986 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
987 * if we get an answer within the timeout, or zero if no answer.
990 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
991 unsigned long /*timeout*/,
992 void (*/
*func*/
)(int, void *), void */
*arg*/
);
994 /* --- @p_pingdone@ --- *
996 * Arguments: @ping *p@ = ping structure
997 * @int rc@ = return code to pass on
1001 * Use: Disposes of a ping structure, maybe sending a notification.
1004 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
1006 /* --- @p_greet@ --- *
1008 * Arguments: @peer *p@ = peer to send to
1009 * @const void *c@ = pointer to challenge
1010 * @size_t sz@ = size of challenge
1014 * Use: Sends a greeting packet.
1017 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
1019 /* --- @p_tun@ --- *
1021 * Arguments: @peer *p@ = pointer to peer block
1022 * @buf *b@ = buffer containing incoming packet
1026 * Use: Handles a packet which needs to be sent to a peer.
1029 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
1031 /* --- @p_keyreload@ --- *
1037 * Use: Forces a check of the daemon's keyring files.
1040 extern void p_keyreload(void);
1042 /* --- @p_interval@ --- *
1048 * Use: Called periodically to do tidying.
1051 extern void p_interval(void);
1053 /* --- @p_stats@ --- *
1055 * Arguments: @peer *p@ = pointer to a peer block
1057 * Returns: A pointer to the peer's statistics.
1060 extern stats
*p_stats(peer */
*p*/
);
1062 /* --- @p_ifname@ --- *
1064 * Arguments: @peer *p@ = pointer to a peer block
1066 * Returns: A pointer to the peer's interface name.
1069 extern const char *p_ifname(peer */
*p*/
);
1071 /* --- @p_setifname@ --- *
1073 * Arguments: @peer *p@ = pointer to a peer block
1074 * @const char *name@ = pointer to the new name
1078 * Use: Changes the name held for a peer's interface.
1081 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
1083 /* --- @p_addr@ --- *
1085 * Arguments: @peer *p@ = pointer to a peer block
1087 * Returns: A pointer to the peer's address.
1090 extern const addr
*p_addr(peer */
*p*/
);
1092 /* --- @p_init@ --- *
1094 * Arguments: @struct in_addr addr@ = address to bind to
1095 * @unsigned port@ = port number to listen to
1099 * Use: Initializes the peer system; creates the socket.
1102 extern void p_init(struct in_addr
/*addr*/, unsigned /*port*/);
1104 /* --- @p_port@ --- *
1108 * Returns: Port number used for socket.
1111 unsigned p_port(void);
1113 /* --- @p_create@ --- *
1115 * Arguments: @peerspec *spec@ = information about this peer
1117 * Returns: Pointer to the peer block, or null if it failed.
1119 * Use: Creates a new named peer block. No peer is actually attached
1123 extern peer
*p_create(peerspec */
*spec*/
);
1125 /* --- @p_name@ --- *
1127 * Arguments: @peer *p@ = pointer to a peer block
1129 * Returns: A pointer to the peer's name.
1131 * Use: Equivalent to @p_spec(p)->name@.
1134 extern const char *p_name(peer */
*p*/
);
1136 /* --- @p_spec@ --- *
1138 * Arguments: @peer *p@ = pointer to a peer block
1140 * Returns: Pointer to the peer's specification
1143 extern const peerspec
*p_spec(peer */
*p*/
);
1145 /* --- @p_findbyaddr@ --- *
1147 * Arguments: @const addr *a@ = address to look up
1149 * Returns: Pointer to the peer block, or null if not found.
1151 * Use: Finds a peer by address.
1154 extern peer
*p_findbyaddr(const addr */
*a*/
);
1156 /* --- @p_find@ --- *
1158 * Arguments: @const char *name@ = name to look up
1160 * Returns: Pointer to the peer block, or null if not found.
1162 * Use: Finds a peer by name.
1165 extern peer
*p_find(const char */
*name*/
);
1167 /* --- @p_destroy@ --- *
1169 * Arguments: @peer *p@ = pointer to a peer
1173 * Use: Destroys a peer.
1176 extern void p_destroy(peer */
*p*/
);
1178 /* --- @FOREACH_PEER@ --- *
1180 * Arguments: @p@ = name to bind to each peer
1181 * @stuff@ = thing to do for each item
1183 * Use: Does something for each current peer.
1186 #define FOREACH_PEER(p, stuff) do { \
1189 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) do stuff while (0); \
1192 /* --- @p_mkiter@ --- *
1194 * Arguments: @peer_iter *i@ = pointer to an iterator
1198 * Use: Initializes the iterator.
1201 extern void p_mkiter(peer_iter */
*i*/
);
1203 /* --- @p_next@ --- *
1205 * Arguments: @peer_iter *i@ = pointer to an iterator
1207 * Returns: Next peer, or null if at the end.
1209 * Use: Returns the next peer.
1212 extern peer
*p_next(peer_iter */
*i*/
);
1214 /*----- Tunnel drivers ----------------------------------------------------*/
1217 extern const tunnel_ops tun_linux
;
1221 extern const tunnel_ops tun_unet
;
1225 extern const tunnel_ops tun_bsd
;
1228 extern const tunnel_ops tun_slip
;
1230 /*----- Other handy utilities ---------------------------------------------*/
1232 /* --- @mpstr@ --- *
1234 * Arguments: @mp *m@ = a multiprecision integer
1236 * Returns: A pointer to the integer's textual representation.
1238 * Use: Converts a multiprecision integer to a string. Corrupts
1242 extern const char *mpstr(mp */
*m*/
);
1244 /* --- @gestr@ --- *
1246 * Arguments: @group *g@ = a group
1247 * @ge *x@ = a group element
1249 * Returns: A pointer to the element's textual representation.
1251 * Use: Converts a group element to a string. Corrupts
1255 extern const char *gestr(group */
*g*/
, ge */
*x*/
);
1257 /* --- @timestr@ --- *
1259 * Arguments: @time_t t@ = a time to convert
1261 * Returns: A pointer to a textual representation of the time.
1263 * Use: Converts a time to a textual representation. Corrupts
1267 extern const char *timestr(time_t /*t*/);
1269 /* --- @mystrieq@ --- *
1271 * Arguments: @const char *x, *y@ = two strings
1273 * Returns: True if @x@ and @y are equal, up to case.
1276 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
1278 /* --- @seq_reset@ --- *
1280 * Arguments: @seqwin *s@ = sequence-checking window
1284 * Use: Resets a sequence number window.
1287 extern void seq_reset(seqwin */
*s*/
);
1289 /* --- @seq_check@ --- *
1291 * Arguments: @seqwin *s@ = sequence-checking window
1292 * @uint32 q@ = sequence number to check
1293 * @const char *service@ = service to report message from
1295 * Returns: A @SEQ_@ code.
1297 * Use: Checks a sequence number against the window, updating things
1301 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1303 /*----- That's all, folks -------------------------------------------------*/