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/daemonize.h>
72 #include <mLib/dstr.h>
74 #include <mLib/fdflags.h>
75 #include <mLib/fwatch.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"
111 /*----- Magic numbers -----------------------------------------------------*/
113 /* --- Trace flags --- */
121 #define T_KEYEXCH 64u
122 #define T_KEYMGMT 128u
129 #define SEC(n) (n##u)
130 #define MIN(n) (n##u * 60u)
131 #define MEG(n) (n##ul * 1024ul * 1024ul)
133 /* --- Other things --- */
135 #define PKBUFSZ 65536
137 /*----- Cipher selections -------------------------------------------------*/
139 typedef struct algswitch
{
140 const gccipher
*c
; /* Symmetric encryption scheme */
141 const gccipher
*mgf
; /* Mask-generation function */
142 const gchash
*h
; /* Hash function */
143 const gcmac
*m
; /* Message authentication code */
144 size_t hashsz
; /* Hash output size */
145 size_t tagsz
; /* Length to truncate MAC tags */
146 size_t cksz
, mksz
; /* Key lengths for @c@ and @m@ */
149 extern algswitch algs
;
151 #define MAXHASHSZ 64 /* Largest possible hash size */
153 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
155 /*----- Data structures ---------------------------------------------------*/
157 /* --- Socket addresses --- *
159 * A magic union of supported socket addresses.
164 struct sockaddr_in sin
;
167 /* --- Sequence number checking --- */
169 typedef struct seqwin
{
170 uint32 seq
; /* First acceptable input sequence */
171 uint32 win
; /* Window of acceptable numbers */
174 #define SEQ_WINSZ 32 /* Bits in sequence number window */
176 /* --- A symmetric keyset --- *
178 * A keyset contains a set of symmetric keys for encrypting and decrypting
179 * packets. Keysets are stored in a list, sorted in reverse order of
180 * creation, so that the most recent keyset (the one most likely to be used)
183 * Each keyset has a time limit and a data limit. The keyset is destroyed
184 * when either it has existed for too long, or it has been used to encrypt
185 * too much data. New key exchanges are triggered when keys are close to
189 typedef struct keyset
{
190 struct keyset
*next
; /* Next active keyset in the list */
191 unsigned ref
; /* Reference count for keyset */
192 struct peer
*p
; /* Pointer to peer structure */
193 time_t t_exp
; /* Expiry time for this keyset */
194 unsigned long sz_exp
; /* Data limit for the keyset */
195 T( unsigned seq
; ) /* Sequence number for tracing */
196 unsigned f
; /* Various useful flags */
197 gcipher
*cin
, *cout
; /* Keyset ciphers for encryption */
198 size_t tagsz
; /* Length to truncate MAC tags */
199 gmac
*min
, *mout
; /* Keyset MACs for integrity */
200 uint32 oseq
; /* Outbound sequence number */
201 seqwin iseq
; /* Inbound sequence number */
204 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
205 #define KSF_LINK 2u /* Key is in a linked list */
207 /* --- Key exchange --- *
209 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
210 * Protocol has a number of desirable features (e.g., perfect forward
211 * secrecy, and zero-knowledge authentication) which make it attractive for
212 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
218 typedef struct kxchal
{
219 struct keyexch
*kx
; /* Pointer back to key exchange */
220 ge
*c
; /* Responder's challenge */
221 ge
*r
; /* My reply to the challenge */
222 keyset
*ks
; /* Pointer to temporary keyset */
223 unsigned f
; /* Various useful flags */
224 sel_timer t
; /* Response timer for challenge */
225 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
226 octet ck
[MAXHASHSZ
]; /* His magical check value */
227 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
228 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
229 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
230 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
233 typedef struct keyexch
{
234 struct peer
*p
; /* Pointer back to the peer */
235 keyset
**ks
; /* Peer's list of keysets */
236 unsigned f
; /* Various useful flags */
237 unsigned s
; /* Current state in exchange */
238 sel_timer t
; /* Timer for next exchange */
239 ge
*kpub
; /* Peer's public key */
240 time_t texp_kpub
; /* Expiry time for public key */
241 mp
*alpha
; /* My temporary secret */
242 ge
*c
; /* My challenge */
243 ge
*rx
; /* The expected response */
244 unsigned nr
; /* Number of extant responses */
245 time_t t_valid
; /* When this exchange goes bad */
246 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
247 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
250 #define KXF_TIMER 1u /* Waiting for a timer to go off */
251 #define KXF_DEAD 2u /* The key-exchanger isn't up */
252 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
255 KXS_DEAD
, /* Uninitialized state (magical) */
256 KXS_CHAL
, /* Main answer-challenges state */
257 KXS_COMMIT
, /* Committed: send switch request */
258 KXS_SWITCH
/* Switched: send confirmation */
261 /* --- Tunnel structure --- *
263 * Used to maintain system-specific information about the tunnel interface.
266 typedef struct tunnel tunnel
;
269 typedef struct tunnel_ops
{
270 const char *name
; /* Name of this tunnel driver */
271 void (*init
)(void); /* Initializes the system */
272 tunnel
*(*create
)(struct peer */
*p*/
, char **/
*ifn*/
);
273 /* Initializes a new tunnel */
274 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
275 /* Notifies ifname change */
276 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
277 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
280 #ifndef TUN_INTERNALS
281 struct tunnel
{ const tunnel_ops
*ops
; };
284 /* --- Peer statistics --- *
286 * Contains various interesting and not-so-interesting statistics about a
287 * peer. This is updated by various parts of the code. The format of the
288 * structure isn't considered private, and @p_stats@ returns a pointer to the
289 * statistics block for a given peer.
292 typedef struct stats
{
293 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
294 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
295 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
296 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
297 unsigned long n_reject
; /* Number of rejected packets */
298 unsigned long n_in
, n_out
; /* Number of packets in and out */
299 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
300 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
303 /* --- Peer structure --- *
305 * The main structure which glues everything else together.
308 typedef struct peerspec
{
309 char *name
; /* Peer's name */
310 const tunnel_ops
*tops
; /* Tunnel operations */
311 unsigned long t_ka
; /* Keep alive interval */
312 addr sa
; /* Socket address to speak to */
313 size_t sasz
; /* Socket address size */
316 typedef struct peer
{
317 struct peer
*next
, *prev
; /* Links to next and previous */
318 struct ping
*pings
; /* Pings we're waiting for */
319 peerspec spec
; /* Specifications for this peer */
320 tunnel
*t
; /* Tunnel for local packets */
321 char *ifname
; /* Interface name for tunnel */
322 keyset
*ks
; /* List head for keysets */
323 buf b
; /* Buffer for sending packets */
324 stats st
; /* Statistics */
325 keyexch kx
; /* Key exchange protocol block */
326 sel_timer tka
; /* Timer for keepalives */
329 typedef struct ping
{
330 struct ping
*next
, *prev
; /* Links to next and previous */
331 peer
*p
; /* Peer so we can free it */
332 unsigned msg
; /* Kind of response expected */
333 uint32 id
; /* Id so we can recognize response */
334 octet magic
[32]; /* Some random data */
335 sel_timer t
; /* Timeout for ping */
336 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
337 void *arg
; /* Argument for callback */
348 /* --- Admin structure --- */
350 #define OBUFSZ 16384u
352 typedef struct obuf
{
353 struct obuf
*next
; /* Next buffer in list */
354 char *p_in
, *p_out
; /* Pointers into the buffer */
355 char buf
[OBUFSZ
]; /* The actual buffer */
358 typedef struct oqueue
{
359 obuf
*hd
, *tl
; /* Head and tail pointers */
364 typedef struct admin_bgop
{
365 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
366 struct admin
*a
; /* Owner job */
367 char *tag
; /* Tag string for messages */
368 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
371 typedef struct admin_resop
{
372 admin_bgop bg
; /* Background operation header */
373 char *addr
; /* Hostname to be resolved */
374 bres_client r
; /* Background resolver task */
375 sel_timer t
; /* Timer for resolver */
376 addr sa
; /* Socket address */
377 size_t sasz
; /* Socket address size */
378 void (*func
)(struct admin_resop
*, int); /* Handler */
381 enum { ARES_OK
, ARES_FAIL
};
383 typedef struct admin_addop
{
384 admin_resop r
; /* Name resolution header */
385 peerspec peer
; /* Peer pending creation */
388 typedef struct admin_greetop
{
389 admin_resop r
; /* Name resolution header */
390 void *c
; /* Challenge block */
391 size_t sz
; /* Length of challenge */
394 typedef struct admin_pingop
{
395 admin_bgop bg
; /* Background operation header */
396 ping ping
; /* Ping pending response */
397 struct timeval pingtime
; /* Time last ping was sent */
400 typedef struct admin_service
{
401 sym_base _b
; /* Hash table base structure */
402 char *version
; /* The provided version */
403 struct admin
*prov
; /* Which client provides me */
404 struct admin_service
*next
, *prev
; /* Client's list of services */
407 typedef struct admin_svcop
{
408 admin_bgop bg
; /* Background operation header */
409 struct admin
*prov
; /* Client servicing this job */
410 unsigned short index
; /* This job's index */
411 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
414 typedef struct admin_jobentry
{
415 unsigned short seq
; /* Zero if unused */
417 admin_svcop
*op
; /* Operation, if slot in use, ... */
418 uint32 next
; /* ... or index of next free slot */
422 typedef struct admin_jobtable
{
423 uint32 n
, sz
; /* Used slots and table size */
424 admin_svcop
*active
; /* List of active jobs */
425 uint32 free
; /* Index of first free slot */
426 admin_jobentry
*v
; /* And the big array of entries */
429 typedef struct admin
{
430 struct admin
*next
, *prev
; /* Links to next and previous */
431 unsigned f
; /* Various useful flags */
432 unsigned ref
; /* Reference counter */
434 unsigned seq
; /* Sequence number for tracing */
436 oqueue out
; /* Output buffer list */
437 oqueue delay
; /* Delayed output buffer list */
438 admin_bgop
*bg
; /* Backgrounded operations */
439 admin_service
*svcs
; /* Which services I provide */
440 admin_jobtable j
; /* Table of outstanding jobs */
441 selbuf b
; /* Line buffer for commands */
442 sel_file w
; /* Selector for write buffering */
445 #define AF_DEAD 1u /* Destroy this admin block */
446 #define AF_CLOSE 2u /* Client closed connection */
447 #define AF_NOTE 4u /* Catch notifications */
448 #define AF_WARN 8u /* Catch warning messages */
450 #define AF_TRACE 16u /* Catch tracing */
454 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
456 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
459 /*----- Global variables --------------------------------------------------*/
461 extern sel_state sel
; /* Global I/O event state */
462 extern group
*gg
; /* The group we work in */
463 extern size_t indexsz
; /* Size of exponent for the group */
464 extern mp
*kpriv
; /* Our private key */
465 extern ge
*kpub
; /* Our public key */
466 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
];
467 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
468 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
471 extern const trace_opt tr_opts
[]; /* Trace options array */
472 extern unsigned tr_flags
; /* Trace options flags */
475 /*----- Other macros ------------------------------------------------------*/
477 #define TIMER noise_timer(RAND_GLOBAL)
479 /*----- Key management ----------------------------------------------------*/
481 /* --- @km_reload@ --- *
485 * Returns: Zero if OK, nonzero to force reloading of keys.
487 * Use: Checks the keyrings to see if they need reloading.
490 extern int km_reload(void);
492 /* --- @km_init@ --- *
494 * Arguments: @const char *kr_priv@ = private keyring file
495 * @const char *kr_pub@ = public keyring file
496 * @const char *tag@ = tag to load
500 * Use: Initializes, and loads the private key.
503 extern void km_init(const char */
*kr_priv*/
, const char */
*kr_pub*/
,
504 const char */
*tag*/
);
506 /* --- @km_getpubkey@ --- *
508 * Arguments: @const char *tag@ = public key tag to load
509 * @ge *kpub@ = where to put the public key
510 * @time_t *t_exp@ = where to put the expiry time
512 * Returns: Zero if OK, nonzero if it failed.
514 * Use: Fetches a public key from the keyring.
517 extern int km_getpubkey(const char */
*tag*/
, ge */
*kpub*/
,
520 /*----- Key exchange ------------------------------------------------------*/
522 /* --- @kx_start@ --- *
524 * Arguments: @keyexch *kx@ = pointer to key exchange context
525 * @int forcep@ = nonzero to ignore the quiet timer
529 * Use: Stimulates a key exchange. If a key exchage is in progress,
530 * a new challenge is sent (unless the quiet timer forbids
531 * this); if no exchange is in progress, one is commenced.
534 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
536 /* --- @kx_message@ --- *
538 * Arguments: @keyexch *kx@ = pointer to key exchange context
539 * @unsigned msg@ = the message code
540 * @buf *b@ = pointer to buffer containing the packet
544 * Use: Reads a packet containing key exchange messages and handles
548 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
550 /* --- @kx_free@ --- *
552 * Arguments: @keyexch *kx@ = pointer to key exchange context
556 * Use: Frees everything in a key exchange context.
559 extern void kx_free(keyexch */
*kx*/
);
561 /* --- @kx_newkeys@ --- *
563 * Arguments: @keyexch *kx@ = pointer to key exchange context
567 * Use: Informs the key exchange module that its keys may have
568 * changed. If fetching the new keys fails, the peer will be
569 * destroyed, we log messages and struggle along with the old
573 extern void kx_newkeys(keyexch */
*kx*/
);
575 /* --- @kx_init@ --- *
577 * Arguments: @keyexch *kx@ = pointer to key exchange context
578 * @peer *p@ = pointer to peer context
579 * @keyset **ks@ = pointer to keyset list
581 * Returns: Zero if OK, nonzero if it failed.
583 * Use: Initializes a key exchange module. The module currently
584 * contains no keys, and will attempt to initiate a key
588 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
, keyset
**/
*ks*/
);
590 /*----- Keysets and symmetric cryptography --------------------------------*/
592 /* --- @ks_drop@ --- *
594 * Arguments: @keyset *ks@ = pointer to a keyset
598 * Use: Decrements a keyset's reference counter. If the counter hits
599 * zero, the keyset is freed.
602 extern void ks_drop(keyset */
*ks*/
);
604 /* --- @ks_gen@ --- *
606 * Arguments: @const void *k@ = pointer to key material
607 * @size_t x, y, z@ = offsets into key material (see below)
608 * @peer *p@ = pointer to peer information
610 * Returns: A pointer to the new keyset.
612 * Use: Derives a new keyset from the given key material. The
613 * offsets @x@, @y@ and @z@ separate the key material into three
614 * parts. Between the @k@ and @k + x@ is `my' contribution to
615 * the key material; between @k + x@ and @k + y@ is `your'
616 * contribution; and between @k + y@ and @k + z@ is a shared
617 * value we made together. These are used to construct two
618 * pairs of symmetric keys. Each pair consists of an encryption
619 * key and a message authentication key. One pair is used for
620 * outgoing messages, the other for incoming messages.
622 * The new key is marked so that it won't be selected for output
623 * by @ksl_encrypt@. You can still encrypt data with it by
624 * calling @ks_encrypt@ directly.
627 extern keyset
*ks_gen(const void */
*k*/
,
628 size_t /*x*/, size_t /*y*/, size_t /*z*/,
631 /* --- @ks_tregen@ --- *
633 * Arguments: @keyset *ks@ = pointer to a keyset
635 * Returns: The time at which moves ought to be made to replace this key.
638 extern time_t ks_tregen(keyset */
*ks*/
);
640 /* --- @ks_activate@ --- *
642 * Arguments: @keyset *ks@ = pointer to a keyset
646 * Use: Activates a keyset, so that it can be used for encrypting
650 extern void ks_activate(keyset */
*ks*/
);
652 /* --- @ks_encrypt@ --- *
654 * Arguments: @keyset *ks@ = pointer to a keyset
655 * @unsigned ty@ = message type
656 * @buf *b@ = pointer to input buffer
657 * @buf *bb@ = pointer to output buffer
659 * Returns: Zero if OK, nonzero if the key needs replacing. If the
660 * encryption failed, the output buffer is broken and zero is
663 * Use: Encrypts a block of data using the key. Note that the `key
664 * ought to be replaced' notification is only ever given once
665 * for each key. Also note that this call forces a keyset to be
666 * used even if it's marked as not for data output.
669 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
670 buf */
*b*/
, buf */
*bb*/
);
672 /* --- @ks_decrypt@ --- *
674 * Arguments: @keyset *ks@ = pointer to a keyset
675 * @unsigned ty@ = expected type code
676 * @buf *b@ = pointer to an input buffer
677 * @buf *bb@ = pointer to an output buffer
679 * Returns: Zero on success, or nonzero if there was some problem.
681 * Use: Attempts to decrypt a message using a given key. Note that
682 * requesting decryption with a key directly won't clear a
683 * marking that it's not for encryption.
686 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
687 buf */
*b*/
, buf */
*bb*/
);
689 /* --- @ksl_free@ --- *
691 * Arguments: @keyset **ksroot@ = pointer to keyset list head
695 * Use: Frees (releases references to) all of the keys in a keyset.
698 extern void ksl_free(keyset
**/
*ksroot*/
);
700 /* --- @ksl_link@ --- *
702 * Arguments: @keyset **ksroot@ = pointer to keyset list head
703 * @keyset *ks@ = pointer to a keyset
707 * Use: Links a keyset into a list. A keyset can only be on one list
708 * at a time. Bad things happen otherwise.
711 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
713 /* --- @ksl_prune@ --- *
715 * Arguments: @keyset **ksroot@ = pointer to keyset list head
719 * Use: Prunes the keyset list by removing keys which mustn't be used
723 extern void ksl_prune(keyset
**/
*ksroot*/
);
725 /* --- @ksl_encrypt@ --- *
727 * Arguments: @keyset **ksroot@ = pointer to keyset list head
728 * @unsigned ty@ = message type
729 * @buf *b@ = pointer to input buffer
730 * @buf *bb@ = pointer to output buffer
732 * Returns: Nonzero if a new key is needed.
734 * Use: Encrypts a packet.
737 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
738 buf */
*b*/
, buf */
*bb*/
);
740 /* --- @ksl_decrypt@ --- *
742 * Arguments: @keyset **ksroot@ = pointer to keyset list head
743 * @unsigned ty@ = expected type code
744 * @buf *b@ = pointer to input buffer
745 * @buf *bb@ = pointer to output buffer
747 * Returns: Nonzero if the packet couldn't be decrypted.
749 * Use: Decrypts a packet.
752 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
753 buf */
*b*/
, buf */
*bb*/
);
755 /*----- Challenges --------------------------------------------------------*/
759 * Arguments: @buf *b@ = where to put the challenge
761 * Returns: Zero if OK, nonzero on error.
763 * Use: Issues a new challenge.
766 extern int c_new(buf */
*b*/
);
768 /* --- @c_check@ --- *
770 * Arguments: @buf *b@ = where to find the challenge
772 * Returns: Zero if OK, nonzero if it didn't work.
774 * Use: Checks a challenge. On failure, the buffer is broken.
777 extern int c_check(buf */
*b*/
);
779 /*----- Administration interface ------------------------------------------*/
781 #define A_END ((char *)0)
783 /* --- @a_warn@ --- *
785 * Arguments: @const char *fmt@ = pointer to format string
786 * @...@ = other arguments
790 * Use: Informs all admin connections of a warning.
793 extern void a_warn(const char */
*fmt*/
, ...);
795 /* --- @a_notify@ --- *
797 * Arguments: @const char *fmt@ = pointer to format string
798 * @...@ = other arguments
802 * Use: Sends a notification to interested admin connections.
805 extern void a_notify(const char */
*fmt*/
, ...);
807 /* --- @a_create@ --- *
809 * Arguments: @int fd_in, fd_out@ = file descriptors to use
810 * @unsigned f@ = initial flags to set
814 * Use: Creates a new admin connection.
817 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
819 /* --- @a_quit@ --- *
825 * Use: Shuts things down nicely.
828 extern void a_quit(void);
830 /* --- @a_preselect@ --- *
836 * Use: Informs the admin module that we're about to select again,
837 * and that it should do cleanup things it has delayed until a
841 extern void a_preselect(void);
843 /* --- @a_daemon@ --- *
849 * Use: Informs the admin module that it's a daemon.
852 extern void a_daemon(void);
854 /* --- @a_init@ --- *
856 * Arguments: @const char *sock@ = socket name to create
860 * Use: Creates the admin listening socket.
863 extern void a_init(const char */
*sock*/
);
865 /*----- Peer management ---------------------------------------------------*/
867 /* --- @p_txstart@ --- *
869 * Arguments: @peer *p@ = pointer to peer block
870 * @unsigned msg@ = message type code
872 * Returns: A pointer to a buffer to write to.
874 * Use: Starts sending to a peer. Only one send can happen at a
878 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
880 /* --- @p_txend@ --- *
882 * Arguments: @peer *p@ = pointer to peer block
886 * Use: Sends a packet to the peer.
889 extern void p_txend(peer */
*p*/
);
891 /* --- @p_pingsend@ --- *
893 * Arguments: @peer *p@ = destination peer
894 * @ping *pg@ = structure to fill in
895 * @unsigned type@ = message type
896 * @unsigned long timeout@ = how long to wait before giving up
897 * @void (*func)(int, void *)@ = callback function
898 * @void *arg@ = argument for callback
900 * Returns: Zero if successful, nonzero if it failed.
902 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
903 * if we get an answer within the timeout, or zero if no answer.
906 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
907 unsigned long /*timeout*/,
908 void (*/
*func*/
)(int, void *), void */
*arg*/
);
910 /* --- @p_pingdone@ --- *
912 * Arguments: @ping *p@ = ping structure
913 * @int rc@ = return code to pass on
917 * Use: Disposes of a ping structure, maybe sending a notification.
920 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
922 /* --- @p_greet@ --- *
924 * Arguments: @peer *p@ = peer to send to
925 * @const void *c@ = pointer to challenge
926 * @size_t sz@ = size of challenge
930 * Use: Sends a greeting packet.
933 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
937 * Arguments: @peer *p@ = pointer to peer block
938 * @buf *b@ = buffer containing incoming packet
942 * Use: Handles a packet which needs to be sent to a peer.
945 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
947 /* --- @p_keyreload@ --- *
953 * Use: Forces a check of the daemon's keyring files.
956 extern void p_keyreload(void);
958 /* --- @p_interval@ --- *
964 * Use: Called periodically to do tidying.
967 extern void p_interval(void);
969 /* --- @p_stats@ --- *
971 * Arguments: @peer *p@ = pointer to a peer block
973 * Returns: A pointer to the peer's statistics.
976 extern stats
*p_stats(peer */
*p*/
);
978 /* --- @p_ifname@ --- *
980 * Arguments: @peer *p@ = pointer to a peer block
982 * Returns: A pointer to the peer's interface name.
985 extern const char *p_ifname(peer */
*p*/
);
987 /* --- @p_setifname@ --- *
989 * Arguments: @peer *p@ = pointer to a peer block
990 * @const char *name@ = pointer to the new name
994 * Use: Changes the name held for a peer's interface.
997 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
999 /* --- @p_addr@ --- *
1001 * Arguments: @peer *p@ = pointer to a peer block
1003 * Returns: A pointer to the peer's address.
1006 extern const addr
*p_addr(peer */
*p*/
);
1008 /* --- @p_init@ --- *
1010 * Arguments: @struct in_addr addr@ = address to bind to
1011 * @unsigned port@ = port number to listen to
1015 * Use: Initializes the peer system; creates the socket.
1018 extern void p_init(struct in_addr
/*addr*/, unsigned /*port*/);
1020 /* --- @p_port@ --- *
1024 * Returns: Port number used for socket.
1027 unsigned p_port(void);
1029 /* --- @p_create@ --- *
1031 * Arguments: @peerspec *spec@ = information about this peer
1033 * Returns: Pointer to the peer block, or null if it failed.
1035 * Use: Creates a new named peer block. No peer is actually attached
1039 extern peer
*p_create(peerspec */
*spec*/
);
1041 /* --- @p_name@ --- *
1043 * Arguments: @peer *p@ = pointer to a peer block
1045 * Returns: A pointer to the peer's name.
1047 * Use: Equivalent to @p_spec(p)->name@.
1050 extern const char *p_name(peer */
*p*/
);
1052 /* --- @p_spec@ --- *
1054 * Arguments: @peer *p@ = pointer to a peer block
1056 * Returns: Pointer to the peer's specification
1059 extern const peerspec
*p_spec(peer */
*p*/
);
1061 /* --- @p_find@ --- *
1063 * Arguments: @const char *name@ = name to look up
1065 * Returns: Pointer to the peer block, or null if not found.
1067 * Use: Finds a peer by name.
1070 extern peer
*p_find(const char */
*name*/
);
1072 /* --- @p_destroy@ --- *
1074 * Arguments: @peer *p@ = pointer to a peer
1078 * Use: Destroys a peer.
1081 extern void p_destroy(peer */
*p*/
);
1083 /* --- @p_first@, @p_next@ --- *
1085 * Arguments: @peer *p@ = a peer block
1087 * Returns: @peer_first@ returns the first peer in some ordering;
1088 * @peer_next@ returns the peer following a given one in the
1089 * same ordering. Null is returned for the end of the list.
1092 extern peer
*p_first(void);
1093 extern peer
*p_next(peer */
*p*/
);
1095 /*----- Tunnel drivers ----------------------------------------------------*/
1098 extern const tunnel_ops tun_linux
;
1102 extern const tunnel_ops tun_unet
;
1106 extern const tunnel_ops tun_bsd
;
1109 extern const tunnel_ops tun_slip
;
1111 /*----- Other handy utilities ---------------------------------------------*/
1113 /* --- @mpstr@ --- *
1115 * Arguments: @mp *m@ = a multiprecision integer
1117 * Returns: A pointer to the integer's textual representation.
1119 * Use: Converts a multiprecision integer to a string. Corrupts
1123 extern const char *mpstr(mp */
*m*/
);
1125 /* --- @gestr@ --- *
1127 * Arguments: @group *g@ = a group
1128 * @ge *x@ = a group element
1130 * Returns: A pointer to the element's textual representation.
1132 * Use: Converts a group element to a string. Corrupts
1136 extern const char *gestr(group */
*g*/
, ge */
*x*/
);
1138 /* --- @timestr@ --- *
1140 * Arguments: @time_t t@ = a time to convert
1142 * Returns: A pointer to a textual representation of the time.
1144 * Use: Converts a time to a textual representation. Corrupts
1148 extern const char *timestr(time_t /*t*/);
1150 /* --- @mystrieq@ --- *
1152 * Arguments: @const char *x, *y@ = two strings
1154 * Returns: True if @x@ and @y are equal, up to case.
1157 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
1159 /* --- @seq_reset@ --- *
1161 * Arguments: @seqwin *s@ = sequence-checking window
1165 * Use: Resets a sequence number window.
1168 extern void seq_reset(seqwin */
*s*/
);
1170 /* --- @seq_check@ --- *
1172 * Arguments: @seqwin *s@ = sequence-checking window
1173 * @uint32 q@ = sequence number to check
1174 * @const char *service@ = service to report message from
1176 * Returns: A @SEQ_@ code.
1178 * Use: Checks a sequence number against the window, updating things
1182 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1184 /*----- That's all, folks -------------------------------------------------*/