5 * Main header file for TrIPE
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Trivial IP Encryption (TrIPE).
14 * TrIPE is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * TrIPE is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with TrIPE; if not, write to the Free Software Foundation,
26 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
36 /*----- Header files ------------------------------------------------------*/
52 #include <sys/types.h>
58 #include <sys/socket.h>
60 #include <netinet/in.h>
61 #include <arpa/inet.h>
67 #include <mLib/alloc.h>
68 #include <mLib/arena.h>
69 #include <mLib/base64.h>
70 #include <mLib/bres.h>
71 #include <mLib/dstr.h>
73 #include <mLib/fdflags.h>
74 #include <mLib/fwatch.h>
75 #include <mLib/mdwopt.h>
76 #include <mLib/quis.h>
77 #include <mLib/report.h>
79 #include <mLib/selbuf.h>
83 #include <mLib/trace.h>
86 #include <catacomb/buf.h>
88 #include <catacomb/gcipher.h>
89 #include <catacomb/gmac.h>
90 #include <catacomb/grand.h>
91 #include <catacomb/key.h>
92 #include <catacomb/paranoia.h>
94 #include <catacomb/noise.h>
95 #include <catacomb/rand.h>
97 #include <catacomb/mp.h>
98 #include <catacomb/mprand.h>
99 #include <catacomb/dh.h>
100 #include <catacomb/ec.h>
101 #include <catacomb/ec-keys.h>
102 #include <catacomb/group.h>
104 #include "protocol.h"
109 /*----- Magic numbers -----------------------------------------------------*/
111 /* --- Trace flags --- */
119 #define T_KEYEXCH 64u
120 #define T_KEYMGMT 128u
127 #define SEC(n) (n##u)
128 #define MIN(n) (n##u * 60u)
129 #define MEG(n) (n##ul * 1024ul * 1024ul)
131 /* --- Other things --- */
133 #define PKBUFSZ 65536
135 /*----- Cipher selections -------------------------------------------------*/
137 typedef struct algswitch
{
138 const gccipher
*c
; /* Symmetric encryption scheme */
139 const gccipher
*mgf
; /* Mask-generation function */
140 const gchash
*h
; /* Hash function */
141 const gcmac
*m
; /* Message authentication code */
142 size_t hashsz
; /* Hash output size */
143 size_t tagsz
; /* Length to truncate MAC tags */
144 size_t cksz
, mksz
; /* Key lengths for @c@ and @m@ */
147 extern algswitch algs
;
149 #define MAXHASHSZ 64 /* Largest possible hash size */
151 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
153 /*----- Data structures ---------------------------------------------------*/
155 /* --- Socket addresses --- *
157 * A magic union of supported socket addresses.
162 struct sockaddr_in sin
;
165 /* --- Sequence number checking --- */
167 typedef struct seqwin
{
168 uint32 seq
; /* First acceptable input sequence */
169 uint32 win
; /* Window of acceptable numbers */
172 #define SEQ_WINSZ 32 /* Bits in sequence number window */
174 /* --- A symmetric keyset --- *
176 * A keyset contains a set of symmetric keys for encrypting and decrypting
177 * packets. Keysets are stored in a list, sorted in reverse order of
178 * creation, so that the most recent keyset (the one most likely to be used)
181 * Each keyset has a time limit and a data limit. The keyset is destroyed
182 * when either it has existed for too long, or it has been used to encrypt
183 * too much data. New key exchanges are triggered when keys are close to
187 typedef struct keyset
{
188 struct keyset
*next
; /* Next active keyset in the list */
189 unsigned ref
; /* Reference count for keyset */
190 struct peer
*p
; /* Pointer to peer structure */
191 time_t t_exp
; /* Expiry time for this keyset */
192 unsigned long sz_exp
; /* Data limit for the keyset */
193 T( unsigned seq
; ) /* Sequence number for tracing */
194 unsigned f
; /* Various useful flags */
195 gcipher
*cin
, *cout
; /* Keyset ciphers for encryption */
196 size_t tagsz
; /* Length to truncate MAC tags */
197 gmac
*min
, *mout
; /* Keyset MACs for integrity */
198 uint32 oseq
; /* Outbound sequence number */
199 seqwin iseq
; /* Inbound sequence number */
202 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
203 #define KSF_LINK 2u /* Key is in a linked list */
205 /* --- Key exchange --- *
207 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
208 * Protocol has a number of desirable features (e.g., perfect forward
209 * secrecy, and zero-knowledge authentication) which make it attractive for
210 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
216 typedef struct kxchal
{
217 struct keyexch
*kx
; /* Pointer back to key exchange */
218 ge
*c
; /* Responder's challenge */
219 ge
*r
; /* My reply to the challenge */
220 keyset
*ks
; /* Pointer to temporary keyset */
221 unsigned f
; /* Various useful flags */
222 sel_timer t
; /* Response timer for challenge */
223 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
224 octet ck
[MAXHASHSZ
]; /* His magical check value */
225 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
226 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
227 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
228 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
231 typedef struct keyexch
{
232 struct peer
*p
; /* Pointer back to the peer */
233 keyset
**ks
; /* Peer's list of keysets */
234 unsigned f
; /* Various useful flags */
235 unsigned s
; /* Current state in exchange */
236 sel_timer t
; /* Timer for next exchange */
237 ge
*kpub
; /* Peer's public key */
238 time_t texp_kpub
; /* Expiry time for public key */
239 mp
*alpha
; /* My temporary secret */
240 ge
*c
; /* My challenge */
241 ge
*rx
; /* The expected response */
242 unsigned nr
; /* Number of extant responses */
243 time_t t_valid
; /* When this exchange goes bad */
244 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
245 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
248 #define KXF_TIMER 1u /* Waiting for a timer to go off */
249 #define KXF_DEAD 2u /* The key-exchanger isn't up */
250 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
253 KXS_DEAD
, /* Uninitialized state (magical) */
254 KXS_CHAL
, /* Main answer-challenges state */
255 KXS_COMMIT
, /* Committed: send switch request */
256 KXS_SWITCH
/* Switched: send confirmation */
259 /* --- Tunnel structure --- *
261 * Used to maintain system-specific information about the tunnel interface.
264 typedef struct tunnel tunnel
;
267 typedef struct tunnel_ops
{
268 const char *name
; /* Name of this tunnel driver */
269 void (*init
)(void); /* Initializes the system */
270 tunnel
*(*create
)(struct peer */
*p*/
); /* Initializes a new tunnel */
271 const char *(*ifname
)(tunnel */
*t*/
); /* Returns tunnel's interface name */
272 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
273 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
276 #ifndef TUN_INTERNALS
277 struct tunnel
{ const tunnel_ops
*ops
; };
280 /* --- Peer statistics --- *
282 * Contains various interesting and not-so-interesting statistics about a
283 * peer. This is updated by various parts of the code. The format of the
284 * structure isn't considered private, and @p_stats@ returns a pointer to the
285 * statistics block for a given peer.
288 typedef struct stats
{
289 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
290 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
291 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
292 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
293 unsigned long n_reject
; /* Number of rejected packets */
294 unsigned long n_in
, n_out
; /* Number of packets in and out */
295 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
296 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
299 /* --- Peer structure --- *
301 * The main structure which glues everything else together.
304 typedef struct peerspec
{
305 char *name
; /* Peer's name */
306 const tunnel_ops
*tops
; /* Tunnel operations */
307 unsigned long t_ka
; /* Keep alive interval */
308 addr sa
; /* Socket address to speak to */
309 size_t sasz
; /* Socket address size */
312 typedef struct peer
{
313 struct peer
*next
, *prev
; /* Links to next and previous */
314 struct ping
*pings
; /* Pings we're waiting for */
315 peerspec spec
; /* Specifications for this peer */
316 tunnel
*t
; /* Tunnel for local packets */
317 char *ifname
; /* Interface name for tunnel */
318 keyset
*ks
; /* List head for keysets */
319 buf b
; /* Buffer for sending packets */
320 stats st
; /* Statistics */
321 keyexch kx
; /* Key exchange protocol block */
322 sel_timer tka
; /* Timer for keepalives */
325 typedef struct ping
{
326 struct ping
*next
, *prev
; /* Links to next and previous */
327 peer
*p
; /* Peer so we can free it */
328 unsigned msg
; /* Kind of response expected */
329 uint32 id
; /* Id so we can recognize response */
330 octet magic
[32]; /* Some random data */
331 sel_timer t
; /* Timeout for ping */
332 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
333 void *arg
; /* Argument for callback */
344 /* --- Admin structure --- */
346 #define OBUFSZ 16384u
348 typedef struct obuf
{
349 struct obuf
*next
; /* Next buffer in list */
350 char *p_in
, *p_out
; /* Pointers into the buffer */
351 char buf
[OBUFSZ
]; /* The actual buffer */
354 typedef struct oqueue
{
355 obuf
*hd
, *tl
; /* Head and tail pointers */
360 typedef struct admin_bgop
{
361 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
362 struct admin
*a
; /* Owner job */
363 char *tag
; /* Tag string for messages */
364 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
367 typedef struct admin_resop
{
368 admin_bgop bg
; /* Background operation header */
369 char *addr
; /* Hostname to be resolved */
370 bres_client r
; /* Background resolver task */
371 sel_timer t
; /* Timer for resolver */
372 addr sa
; /* Socket address */
373 size_t sasz
; /* Socket address size */
374 void (*func
)(struct admin_resop
*, int); /* Handler */
377 enum { ARES_OK
, ARES_FAIL
};
379 typedef struct admin_addop
{
380 admin_resop r
; /* Name resolution header */
381 peerspec peer
; /* Peer pending creation */
384 typedef struct admin_greetop
{
385 admin_resop r
; /* Name resolution header */
386 void *c
; /* Challenge block */
387 size_t sz
; /* Length of challenge */
390 typedef struct admin_pingop
{
391 admin_bgop bg
; /* Background operation header */
392 ping ping
; /* Ping pending response */
393 struct timeval pingtime
; /* Time last ping was sent */
396 typedef struct admin_service
{
397 sym_base _b
; /* Hash table base structure */
398 char *version
; /* The provided version */
399 struct admin
*prov
; /* Which client provides me */
400 struct admin_service
*next
, *prev
; /* Client's list of services */
403 typedef struct admin_svcop
{
404 admin_bgop bg
; /* Background operation header */
405 struct admin
*prov
; /* Client servicing this job */
406 unsigned short index
; /* This job's index */
407 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
410 typedef struct admin_jobentry
{
411 unsigned short seq
; /* Zero if unused */
413 admin_svcop
*op
; /* Operation, if slot in use, ... */
414 uint32 next
; /* ... or index of next free slot */
418 typedef struct admin_jobtable
{
419 uint32 n
, sz
; /* Used slots and table size */
420 admin_svcop
*active
; /* List of active jobs */
421 uint32 free
; /* Index of first free slot */
422 admin_jobentry
*v
; /* And the big array of entries */
425 typedef struct admin
{
426 struct admin
*next
, *prev
; /* Links to next and previous */
427 unsigned f
; /* Various useful flags */
428 unsigned ref
; /* Reference counter */
430 unsigned seq
; /* Sequence number for tracing */
432 oqueue out
; /* Output buffer list */
433 oqueue delay
; /* Delayed output buffer list */
434 admin_bgop
*bg
; /* Backgrounded operations */
435 admin_service
*svcs
; /* Which services I provide */
436 admin_jobtable j
; /* Table of outstanding jobs */
437 selbuf b
; /* Line buffer for commands */
438 sel_file w
; /* Selector for write buffering */
441 #define AF_DEAD 1u /* Destroy this admin block */
442 #define AF_CLOSE 2u /* Client closed connection */
443 #define AF_NOTE 4u /* Catch notifications */
444 #define AF_WARN 8u /* Catch warning messages */
446 #define AF_TRACE 16u /* Catch tracing */
450 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
452 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
455 /*----- Global variables --------------------------------------------------*/
457 extern sel_state sel
; /* Global I/O event state */
458 extern group
*gg
; /* The group we work in */
459 extern size_t indexsz
; /* Size of exponent for the group */
460 extern mp
*kpriv
; /* Our private key */
461 extern ge
*kpub
; /* Our public key */
462 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
];
463 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
464 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
467 extern const trace_opt tr_opts
[]; /* Trace options array */
468 extern unsigned tr_flags
; /* Trace options flags */
471 /*----- Other macros ------------------------------------------------------*/
473 #define TIMER noise_timer(RAND_GLOBAL)
475 /*----- Key management ----------------------------------------------------*/
477 /* --- @km_reload@ --- *
481 * Returns: Zero if OK, nonzero to force reloading of keys.
483 * Use: Checks the keyrings to see if they need reloading.
486 extern int km_reload(void);
488 /* --- @km_init@ --- *
490 * Arguments: @const char *kr_priv@ = private keyring file
491 * @const char *kr_pub@ = public keyring file
492 * @const char *tag@ = tag to load
496 * Use: Initializes, and loads the private key.
499 extern void km_init(const char */
*kr_priv*/
, const char */
*kr_pub*/
,
500 const char */
*tag*/
);
502 /* --- @km_getpubkey@ --- *
504 * Arguments: @const char *tag@ = public key tag to load
505 * @ge *kpub@ = where to put the public key
506 * @time_t *t_exp@ = where to put the expiry time
508 * Returns: Zero if OK, nonzero if it failed.
510 * Use: Fetches a public key from the keyring.
513 extern int km_getpubkey(const char */
*tag*/
, ge */
*kpub*/
,
516 /*----- Key exchange ------------------------------------------------------*/
518 /* --- @kx_start@ --- *
520 * Arguments: @keyexch *kx@ = pointer to key exchange context
521 * @int forcep@ = nonzero to ignore the quiet timer
525 * Use: Stimulates a key exchange. If a key exchage is in progress,
526 * a new challenge is sent (unless the quiet timer forbids
527 * this); if no exchange is in progress, one is commenced.
530 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
532 /* --- @kx_message@ --- *
534 * Arguments: @keyexch *kx@ = pointer to key exchange context
535 * @unsigned msg@ = the message code
536 * @buf *b@ = pointer to buffer containing the packet
540 * Use: Reads a packet containing key exchange messages and handles
544 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
546 /* --- @kx_free@ --- *
548 * Arguments: @keyexch *kx@ = pointer to key exchange context
552 * Use: Frees everything in a key exchange context.
555 extern void kx_free(keyexch */
*kx*/
);
557 /* --- @kx_newkeys@ --- *
559 * Arguments: @keyexch *kx@ = pointer to key exchange context
563 * Use: Informs the key exchange module that its keys may have
564 * changed. If fetching the new keys fails, the peer will be
565 * destroyed, we log messages and struggle along with the old
569 extern void kx_newkeys(keyexch */
*kx*/
);
571 /* --- @kx_init@ --- *
573 * Arguments: @keyexch *kx@ = pointer to key exchange context
574 * @peer *p@ = pointer to peer context
575 * @keyset **ks@ = pointer to keyset list
577 * Returns: Zero if OK, nonzero if it failed.
579 * Use: Initializes a key exchange module. The module currently
580 * contains no keys, and will attempt to initiate a key
584 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
, keyset
**/
*ks*/
);
586 /*----- Keysets and symmetric cryptography --------------------------------*/
588 /* --- @ks_drop@ --- *
590 * Arguments: @keyset *ks@ = pointer to a keyset
594 * Use: Decrements a keyset's reference counter. If the counter hits
595 * zero, the keyset is freed.
598 extern void ks_drop(keyset */
*ks*/
);
600 /* --- @ks_gen@ --- *
602 * Arguments: @const void *k@ = pointer to key material
603 * @size_t x, y, z@ = offsets into key material (see below)
604 * @peer *p@ = pointer to peer information
606 * Returns: A pointer to the new keyset.
608 * Use: Derives a new keyset from the given key material. The
609 * offsets @x@, @y@ and @z@ separate the key material into three
610 * parts. Between the @k@ and @k + x@ is `my' contribution to
611 * the key material; between @k + x@ and @k + y@ is `your'
612 * contribution; and between @k + y@ and @k + z@ is a shared
613 * value we made together. These are used to construct two
614 * pairs of symmetric keys. Each pair consists of an encryption
615 * key and a message authentication key. One pair is used for
616 * outgoing messages, the other for incoming messages.
618 * The new key is marked so that it won't be selected for output
619 * by @ksl_encrypt@. You can still encrypt data with it by
620 * calling @ks_encrypt@ directly.
623 extern keyset
*ks_gen(const void */
*k*/
,
624 size_t /*x*/, size_t /*y*/, size_t /*z*/,
627 /* --- @ks_tregen@ --- *
629 * Arguments: @keyset *ks@ = pointer to a keyset
631 * Returns: The time at which moves ought to be made to replace this key.
634 extern time_t ks_tregen(keyset */
*ks*/
);
636 /* --- @ks_activate@ --- *
638 * Arguments: @keyset *ks@ = pointer to a keyset
642 * Use: Activates a keyset, so that it can be used for encrypting
646 extern void ks_activate(keyset */
*ks*/
);
648 /* --- @ks_encrypt@ --- *
650 * Arguments: @keyset *ks@ = pointer to a keyset
651 * @unsigned ty@ = message type
652 * @buf *b@ = pointer to input buffer
653 * @buf *bb@ = pointer to output buffer
655 * Returns: Zero if OK, nonzero if the key needs replacing. If the
656 * encryption failed, the output buffer is broken and zero is
659 * Use: Encrypts a block of data using the key. Note that the `key
660 * ought to be replaced' notification is only ever given once
661 * for each key. Also note that this call forces a keyset to be
662 * used even if it's marked as not for data output.
665 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
666 buf */
*b*/
, buf */
*bb*/
);
668 /* --- @ks_decrypt@ --- *
670 * Arguments: @keyset *ks@ = pointer to a keyset
671 * @unsigned ty@ = expected type code
672 * @buf *b@ = pointer to an input buffer
673 * @buf *bb@ = pointer to an output buffer
675 * Returns: Zero on success, or nonzero if there was some problem.
677 * Use: Attempts to decrypt a message using a given key. Note that
678 * requesting decryption with a key directly won't clear a
679 * marking that it's not for encryption.
682 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
683 buf */
*b*/
, buf */
*bb*/
);
685 /* --- @ksl_free@ --- *
687 * Arguments: @keyset **ksroot@ = pointer to keyset list head
691 * Use: Frees (releases references to) all of the keys in a keyset.
694 extern void ksl_free(keyset
**/
*ksroot*/
);
696 /* --- @ksl_link@ --- *
698 * Arguments: @keyset **ksroot@ = pointer to keyset list head
699 * @keyset *ks@ = pointer to a keyset
703 * Use: Links a keyset into a list. A keyset can only be on one list
704 * at a time. Bad things happen otherwise.
707 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
709 /* --- @ksl_prune@ --- *
711 * Arguments: @keyset **ksroot@ = pointer to keyset list head
715 * Use: Prunes the keyset list by removing keys which mustn't be used
719 extern void ksl_prune(keyset
**/
*ksroot*/
);
721 /* --- @ksl_encrypt@ --- *
723 * Arguments: @keyset **ksroot@ = pointer to keyset list head
724 * @unsigned ty@ = message type
725 * @buf *b@ = pointer to input buffer
726 * @buf *bb@ = pointer to output buffer
728 * Returns: Nonzero if a new key is needed.
730 * Use: Encrypts a packet.
733 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
734 buf */
*b*/
, buf */
*bb*/
);
736 /* --- @ksl_decrypt@ --- *
738 * Arguments: @keyset **ksroot@ = pointer to keyset list head
739 * @unsigned ty@ = expected type code
740 * @buf *b@ = pointer to input buffer
741 * @buf *bb@ = pointer to output buffer
743 * Returns: Nonzero if the packet couldn't be decrypted.
745 * Use: Decrypts a packet.
748 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
749 buf */
*b*/
, buf */
*bb*/
);
751 /*----- Challenges --------------------------------------------------------*/
755 * Arguments: @buf *b@ = where to put the challenge
757 * Returns: Zero if OK, nonzero on error.
759 * Use: Issues a new challenge.
762 extern int c_new(buf */
*b*/
);
764 /* --- @c_check@ --- *
766 * Arguments: @buf *b@ = where to find the challenge
768 * Returns: Zero if OK, nonzero if it didn't work.
770 * Use: Checks a challenge. On failure, the buffer is broken.
773 extern int c_check(buf */
*b*/
);
775 /*----- Administration interface ------------------------------------------*/
777 #define A_END ((char *)0)
779 /* --- @a_warn@ --- *
781 * Arguments: @const char *fmt@ = pointer to format string
782 * @...@ = other arguments
786 * Use: Informs all admin connections of a warning.
789 extern void a_warn(const char */
*fmt*/
, ...);
791 /* --- @a_notify@ --- *
793 * Arguments: @const char *fmt@ = pointer to format string
794 * @...@ = other arguments
798 * Use: Sends a notification to interested admin connections.
801 extern void a_notify(const char */
*fmt*/
, ...);
803 /* --- @a_create@ --- *
805 * Arguments: @int fd_in, fd_out@ = file descriptors to use
806 * @unsigned f@ = initial flags to set
810 * Use: Creates a new admin connection.
813 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
815 /* --- @a_quit@ --- *
821 * Use: Shuts things down nicely.
824 extern void a_quit(void);
826 /* --- @a_preselect@ --- *
832 * Use: Informs the admin module that we're about to select again,
833 * and that it should do cleanup things it has delayed until a
837 extern void a_preselect(void);
839 /* --- @a_daemon@ --- *
845 * Use: Informs the admin module that it's a daemon.
848 extern void a_daemon(void);
850 /* --- @a_init@ --- *
852 * Arguments: @const char *sock@ = socket name to create
856 * Use: Creates the admin listening socket.
859 extern void a_init(const char */
*sock*/
);
861 /*----- Peer management ---------------------------------------------------*/
863 /* --- @p_txstart@ --- *
865 * Arguments: @peer *p@ = pointer to peer block
866 * @unsigned msg@ = message type code
868 * Returns: A pointer to a buffer to write to.
870 * Use: Starts sending to a peer. Only one send can happen at a
874 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
876 /* --- @p_txend@ --- *
878 * Arguments: @peer *p@ = pointer to peer block
882 * Use: Sends a packet to the peer.
885 extern void p_txend(peer */
*p*/
);
887 /* --- @p_pingsend@ --- *
889 * Arguments: @peer *p@ = destination peer
890 * @ping *pg@ = structure to fill in
891 * @unsigned type@ = message type
892 * @unsigned long timeout@ = how long to wait before giving up
893 * @void (*func)(int, void *)@ = callback function
894 * @void *arg@ = argument for callback
896 * Returns: Zero if successful, nonzero if it failed.
898 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
899 * if we get an answer within the timeout, or zero if no answer.
902 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
903 unsigned long /*timeout*/,
904 void (*/
*func*/
)(int, void *), void */
*arg*/
);
906 /* --- @p_pingdone@ --- *
908 * Arguments: @ping *p@ = ping structure
909 * @int rc@ = return code to pass on
913 * Use: Disposes of a ping structure, maybe sending a notification.
916 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
918 /* --- @p_greet@ --- *
920 * Arguments: @peer *p@ = peer to send to
921 * @const void *c@ = pointer to challenge
922 * @size_t sz@ = size of challenge
926 * Use: Sends a greeting packet.
929 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
933 * Arguments: @peer *p@ = pointer to peer block
934 * @buf *b@ = buffer containing incoming packet
938 * Use: Handles a packet which needs to be sent to a peer.
941 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
943 /* --- @p_keyreload@ --- *
949 * Use: Forces a check of the daemon's keyring files.
952 extern void p_keyreload(void);
954 /* --- @p_interval@ --- *
960 * Use: Called periodically to do tidying.
963 extern void p_interval(void);
965 /* --- @p_stats@ --- *
967 * Arguments: @peer *p@ = pointer to a peer block
969 * Returns: A pointer to the peer's statistics.
972 extern stats
*p_stats(peer */
*p*/
);
974 /* --- @p_ifname@ --- *
976 * Arguments: @peer *p@ = pointer to a peer block
978 * Returns: A pointer to the peer's interface name.
981 extern const char *p_ifname(peer */
*p*/
);
983 /* --- @p_setifname@ --- *
985 * Arguments: @peer *p@ = pointer to a peer block
986 * @const char *name@ = pointer to the new name
990 * Use: Changes the name held for a peer's interface.
993 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
995 /* --- @p_addr@ --- *
997 * Arguments: @peer *p@ = pointer to a peer block
999 * Returns: A pointer to the peer's address.
1002 extern const addr
*p_addr(peer */
*p*/
);
1004 /* --- @p_init@ --- *
1006 * Arguments: @struct in_addr addr@ = address to bind to
1007 * @unsigned port@ = port number to listen to
1011 * Use: Initializes the peer system; creates the socket.
1014 extern void p_init(struct in_addr
/*addr*/, unsigned /*port*/);
1016 /* --- @p_port@ --- *
1020 * Returns: Port number used for socket.
1023 unsigned p_port(void);
1025 /* --- @p_create@ --- *
1027 * Arguments: @peerspec *spec@ = information about this peer
1029 * Returns: Pointer to the peer block, or null if it failed.
1031 * Use: Creates a new named peer block. No peer is actually attached
1035 extern peer
*p_create(peerspec */
*spec*/
);
1037 /* --- @p_name@ --- *
1039 * Arguments: @peer *p@ = pointer to a peer block
1041 * Returns: A pointer to the peer's name.
1043 * Use: Equivalent to @p_spec(p)->name@.
1046 extern const char *p_name(peer */
*p*/
);
1048 /* --- @p_spec@ --- *
1050 * Arguments: @peer *p@ = pointer to a peer block
1052 * Returns: Pointer to the peer's specification
1055 extern const peerspec
*p_spec(peer */
*p*/
);
1057 /* --- @p_find@ --- *
1059 * Arguments: @const char *name@ = name to look up
1061 * Returns: Pointer to the peer block, or null if not found.
1063 * Use: Finds a peer by name.
1066 extern peer
*p_find(const char */
*name*/
);
1068 /* --- @p_destroy@ --- *
1070 * Arguments: @peer *p@ = pointer to a peer
1074 * Use: Destroys a peer.
1077 extern void p_destroy(peer */
*p*/
);
1079 /* --- @p_first@, @p_next@ --- *
1081 * Arguments: @peer *p@ = a peer block
1083 * Returns: @peer_first@ returns the first peer in some ordering;
1084 * @peer_next@ returns the peer following a given one in the
1085 * same ordering. Null is returned for the end of the list.
1088 extern peer
*p_first(void);
1089 extern peer
*p_next(peer */
*p*/
);
1091 /*----- Tunnel drivers ----------------------------------------------------*/
1094 extern const tunnel_ops tun_linux
;
1098 extern const tunnel_ops tun_unet
;
1102 extern const tunnel_ops tun_bsd
;
1105 extern const tunnel_ops tun_slip
;
1107 /*----- Other handy utilities ---------------------------------------------*/
1109 /* --- @mpstr@ --- *
1111 * Arguments: @mp *m@ = a multiprecision integer
1113 * Returns: A pointer to the integer's textual representation.
1115 * Use: Converts a multiprecision integer to a string. Corrupts
1119 extern const char *mpstr(mp */
*m*/
);
1121 /* --- @gestr@ --- *
1123 * Arguments: @group *g@ = a group
1124 * @ge *x@ = a group element
1126 * Returns: A pointer to the element's textual representation.
1128 * Use: Converts a group element to a string. Corrupts
1132 extern const char *gestr(group */
*g*/
, ge */
*x*/
);
1134 /* --- @timestr@ --- *
1136 * Arguments: @time_t t@ = a time to convert
1138 * Returns: A pointer to a textual representation of the time.
1140 * Use: Converts a time to a textual representation. Corrupts
1144 extern const char *timestr(time_t /*t*/);
1146 /* --- @mystrieq@ --- *
1148 * Arguments: @const char *x, *y@ = two strings
1150 * Returns: True if @x@ and @y are equal, up to case.
1153 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
1155 /* --- @seq_reset@ --- *
1157 * Arguments: @seqwin *s@ = sequence-checking window
1161 * Use: Resets a sequence number window.
1164 extern void seq_reset(seqwin */
*s*/
);
1166 /* --- @seq_check@ --- *
1168 * Arguments: @seqwin *s@ = sequence-checking window
1169 * @uint32 q@ = sequence number to check
1170 * @const char *service@ = service to report message from
1172 * Returns: A @SEQ_@ code.
1174 * Use: Checks a sequence number against the window, updating things
1178 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1180 /* --- @versioncmp@ --- *
1182 * Arguments: @const char *va, *vb@ = two version strings
1184 * Returns: Less than, equal to, or greater than zero, according to
1185 * whether @va@ is less than, equal to, or greater than @vb@.
1187 * Use: Compares version number strings.
1189 * The algorithm is an extension of the Debian version
1190 * comparison algorithm. A version number consists of three
1193 * [EPOCH :] MAIN [- SUB]
1195 * The MAIN part may contain colons or hyphens if there is an
1196 * EPOCH or SUB, respectively. Version strings are compared
1197 * componentwise: first epochs, then main parts, and finally
1200 * The component comparison is done as follows. First, the
1201 * initial subsequence of nondigit characters is extracted from
1202 * each string, and these are compared lexicographically, using
1203 * ASCII ordering, except that letters precede non-letters. If
1204 * both are the same, an initial sequence of digits is extracted
1205 * from the remaining parts of the version strings, and these
1206 * are compared numerically (an empty sequence being considered
1207 * to have the value zero). This process is repeated until we
1208 * have a winner or until both strings are exhausted.
1211 extern int versioncmp(const char */
*va*/
, const char */
*vb*/
);
1213 /*----- That's all, folks -------------------------------------------------*/