3 * Main header file for TrIPE
5 * (c) 2001 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Trivial IP Encryption (TrIPE).
12 * TrIPE is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * TrIPE is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with TrIPE; if not, write to the Free Software Foundation,
24 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 /*----- Header files ------------------------------------------------------*/
50 #include <sys/types.h>
57 #include <sys/socket.h>
59 #include <netinet/in.h>
60 #include <arpa/inet.h>
66 #include <mLib/alloc.h>
67 #include <mLib/arena.h>
68 #include <mLib/base64.h>
69 #include <mLib/bres.h>
70 #include <mLib/daemonize.h>
71 #include <mLib/dstr.h>
73 #include <mLib/fdflags.h>
74 #include <mLib/fdpass.h>
75 #include <mLib/fwatch.h>
76 #include <mLib/hash.h>
77 #include <mLib/macros.h>
78 #include <mLib/mdup.h>
79 #include <mLib/mdwopt.h>
80 #include <mLib/quis.h>
81 #include <mLib/report.h>
83 #include <mLib/selbuf.h>
87 #include <mLib/trace.h>
89 #include <mLib/versioncmp.h>
91 #include <catacomb/buf.h>
93 #include <catacomb/gcipher.h>
94 #include <catacomb/gmac.h>
95 #include <catacomb/grand.h>
96 #include <catacomb/key.h>
97 #include <catacomb/paranoia.h>
99 #include <catacomb/noise.h>
100 #include <catacomb/rand.h>
102 #include <catacomb/mp.h>
103 #include <catacomb/mprand.h>
104 #include <catacomb/dh.h>
105 #include <catacomb/ec.h>
106 #include <catacomb/ec-keys.h>
107 #include <catacomb/group.h>
110 #include "protocol.h"
116 /*----- Magic numbers -----------------------------------------------------*/
118 /* --- Trace flags --- */
126 #define T_KEYEXCH 64u
127 #define T_KEYMGMT 128u
129 /* T_PRIVSEP in priv.h */
135 #define SEC(n) (n##u)
136 #define MIN(n) (n##u * 60u)
137 #define MEG(n) (n##ul * 1024ul * 1024ul)
139 /* --- Other things --- */
141 #define PKBUFSZ 65536
143 /*----- Cipher selections -------------------------------------------------*/
145 typedef struct algswitch
{
146 const gccipher
*c
; /* Symmetric encryption scheme */
147 const gccipher
*mgf
; /* Mask-generation function */
148 const gchash
*h
; /* Hash function */
149 const gcmac
*m
; /* Message authentication code */
150 size_t hashsz
; /* Hash output size */
151 size_t tagsz
; /* Length to truncate MAC tags */
152 size_t expsz
; /* Size of data to process */
153 size_t cksz
, mksz
; /* Key lengths for @c@ and @m@ */
156 extern algswitch algs
;
158 #define MAXHASHSZ 64 /* Largest possible hash size */
160 #define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
162 /*----- Data structures ---------------------------------------------------*/
164 /* --- Socket addresses --- *
166 * A magic union of supported socket addresses.
171 struct sockaddr_in sin
;
174 /* --- Mapping keyed on addresses --- */
176 typedef struct addrmap
{
181 typedef struct addrmap_base
{
186 /* --- Sequence number checking --- */
188 typedef struct seqwin
{
189 uint32 seq
; /* First acceptable input sequence */
190 uint32 win
; /* Window of acceptable numbers */
193 #define SEQ_WINSZ 32 /* Bits in sequence number window */
195 /* --- A symmetric keyset --- *
197 * A keyset contains a set of symmetric keys for encrypting and decrypting
198 * packets. Keysets are stored in a list, sorted in reverse order of
199 * creation, so that the most recent keyset (the one most likely to be used)
202 * Each keyset has a time limit and a data limit. The keyset is destroyed
203 * when either it has existed for too long, or it has been used to encrypt
204 * too much data. New key exchanges are triggered when keys are close to
208 typedef struct keyset
{
209 struct keyset
*next
; /* Next active keyset in the list */
210 unsigned ref
; /* Reference count for keyset */
211 struct peer
*p
; /* Pointer to peer structure */
212 time_t t_exp
; /* Expiry time for this keyset */
213 unsigned long sz_exp
, sz_regen
; /* Data limits for the keyset */
214 T( unsigned seq
; ) /* Sequence number for tracing */
215 unsigned f
; /* Various useful flags */
216 gcipher
*cin
, *cout
; /* Keyset ciphers for encryption */
217 size_t tagsz
; /* Length to truncate MAC tags */
218 gmac
*min
, *mout
; /* Keyset MACs for integrity */
219 uint32 oseq
; /* Outbound sequence number */
220 seqwin iseq
; /* Inbound sequence number */
223 #define KSF_LISTEN 1u /* Don't encrypt packets yet */
224 #define KSF_LINK 2u /* Key is in a linked list */
226 #define KSERR_REGEN -1 /* Regenerate keys */
227 #define KSERR_NOKEYS -2 /* No keys left */
228 #define KSERR_DECRYPT -3 /* Unable to decrypt message */
229 #define KSERR_SEQ -4 /* Incorrect sequence number */
230 #define KSERR_MALFORMED -5 /* Input ciphertext is broken */
232 /* --- Key exchange --- *
234 * TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
235 * Protocol has a number of desirable features (e.g., perfect forward
236 * secrecy, and zero-knowledge authentication) which make it attractive for
237 * use in TrIPE. The Wrestlers Protocol was designed by Mark Wooding and
243 typedef struct kxchal
{
244 struct keyexch
*kx
; /* Pointer back to key exchange */
245 ge
*c
; /* Responder's challenge */
246 ge
*r
; /* My reply to the challenge */
247 keyset
*ks
; /* Pointer to temporary keyset */
248 unsigned f
; /* Various useful flags */
249 sel_timer t
; /* Response timer for challenge */
250 octet hc
[MAXHASHSZ
]; /* Hash of his challenge */
251 octet ck
[MAXHASHSZ
]; /* His magical check value */
252 octet hswrq_in
[MAXHASHSZ
]; /* Inbound switch request message */
253 octet hswok_in
[MAXHASHSZ
]; /* Inbound switch confirmation */
254 octet hswrq_out
[MAXHASHSZ
]; /* Outbound switch request message */
255 octet hswok_out
[MAXHASHSZ
]; /* Outbound switch confirmation */
258 typedef struct keyexch
{
259 struct peer
*p
; /* Pointer back to the peer */
260 keyset
**ks
; /* Peer's list of keysets */
261 unsigned f
; /* Various useful flags */
262 unsigned s
; /* Current state in exchange */
263 sel_timer t
; /* Timer for next exchange */
264 ge
*kpub
; /* Peer's public key */
265 time_t texp_kpub
; /* Expiry time for public key */
266 mp
*alpha
; /* My temporary secret */
267 ge
*c
; /* My challenge */
268 ge
*rx
; /* The expected response */
269 unsigned nr
; /* Number of extant responses */
270 time_t t_valid
; /* When this exchange goes bad */
271 octet hc
[MAXHASHSZ
]; /* Hash of my challenge */
272 kxchal
*r
[KX_NCHAL
]; /* Array of challenges */
275 #define KXF_TIMER 1u /* Waiting for a timer to go off */
276 #define KXF_DEAD 2u /* The key-exchanger isn't up */
277 #define KXF_PUBKEY 4u /* Key exchanger has a public key */
278 #define KXF_CORK 8u /* Don't send anything yet */
281 KXS_DEAD
, /* Uninitialized state (magical) */
282 KXS_CHAL
, /* Main answer-challenges state */
283 KXS_COMMIT
, /* Committed: send switch request */
284 KXS_SWITCH
/* Switched: send confirmation */
287 /* --- Tunnel structure --- *
289 * Used to maintain system-specific information about the tunnel interface.
292 typedef struct tunnel tunnel
;
295 typedef struct tunnel_ops
{
296 const char *name
; /* Name of this tunnel driver */
297 unsigned flags
; /* Various interesting flags */
298 #define TUNF_PRIVOPEN 1u /* Need helper to open file */
299 void (*init
)(void); /* Initializes the system */
300 tunnel
*(*create
)(struct peer */
*p*/
, int /*fd*/, char **/
*ifn*/
);
301 /* Initializes a new tunnel */
302 void (*setifname
)(tunnel */
*t*/
, const char */
*ifn*/
);
303 /* Notifies ifname change */
304 void (*inject
)(tunnel */
*t*/
, buf */
*b*/
); /* Sends packet through if */
305 void (*destroy
)(tunnel */
*t*/
); /* Destroys a tunnel */
308 #ifndef TUN_INTERNALS
309 struct tunnel
{ const tunnel_ops
*ops
; };
312 /* --- Peer statistics --- *
314 * Contains various interesting and not-so-interesting statistics about a
315 * peer. This is updated by various parts of the code. The format of the
316 * structure isn't considered private, and @p_stats@ returns a pointer to the
317 * statistics block for a given peer.
320 typedef struct stats
{
321 unsigned long sz_in
, sz_out
; /* Size of all data in and out */
322 unsigned long sz_kxin
, sz_kxout
; /* Size of key exchange messages */
323 unsigned long sz_ipin
, sz_ipout
; /* Size of encapsulated IP packets */
324 time_t t_start
, t_last
, t_kx
; /* Time peer created, last pk, kx */
325 unsigned long n_reject
; /* Number of rejected packets */
326 unsigned long n_in
, n_out
; /* Number of packets in and out */
327 unsigned long n_kxin
, n_kxout
; /* Number of key exchange packets */
328 unsigned long n_ipin
, n_ipout
; /* Number of encrypted packets */
331 /* --- Peer structure --- *
333 * The main structure which glues everything else together.
336 typedef struct peerspec
{
337 char *name
; /* Peer's name */
338 char *tag
; /* Public key tag */
339 const tunnel_ops
*tops
; /* Tunnel operations */
340 unsigned long t_ka
; /* Keep alive interval */
341 addr sa
; /* Socket address to speak to */
342 size_t sasz
; /* Socket address size */
343 unsigned kxf
; /* Key exchange flags to set */
346 typedef struct peer_byname
{
351 typedef struct peer_byaddr
{
356 typedef struct peer
{
357 peer_byname
*byname
; /* Lookup-by-name block */
358 peer_byaddr
*byaddr
; /* Lookup-by-address block */
359 struct ping
*pings
; /* Pings we're waiting for */
360 peerspec spec
; /* Specifications for this peer */
361 tunnel
*t
; /* Tunnel for local packets */
362 char *ifname
; /* Interface name for tunnel */
363 keyset
*ks
; /* List head for keysets */
364 buf b
; /* Buffer for sending packets */
365 stats st
; /* Statistics */
366 keyexch kx
; /* Key exchange protocol block */
367 sel_timer tka
; /* Timer for keepalives */
370 typedef struct peer_iter
{ sym_iter i
; } peer_iter
;
372 typedef struct ping
{
373 struct ping
*next
, *prev
; /* Links to next and previous */
374 peer
*p
; /* Peer so we can free it */
375 unsigned msg
; /* Kind of response expected */
376 uint32 id
; /* Id so we can recognize response */
377 octet magic
[32]; /* Some random data */
378 sel_timer t
; /* Timeout for ping */
379 void (*func
)(int /*rc*/, void */
*arg*/
); /* Function to call when done */
380 void *arg
; /* Argument for callback */
391 /* --- Admin structure --- */
393 #define OBUFSZ 16384u
395 typedef struct obuf
{
396 struct obuf
*next
; /* Next buffer in list */
397 char *p_in
, *p_out
; /* Pointers into the buffer */
398 char buf
[OBUFSZ
]; /* The actual buffer */
401 typedef struct oqueue
{
402 obuf
*hd
, *tl
; /* Head and tail pointers */
407 typedef struct admin_bgop
{
408 struct admin_bgop
*next
, *prev
; /* Links to next and previous */
409 struct admin
*a
; /* Owner job */
410 char *tag
; /* Tag string for messages */
411 void (*cancel
)(struct admin_bgop
*); /* Destructor function */
414 typedef struct admin_resop
{
415 admin_bgop bg
; /* Background operation header */
416 char *addr
; /* Hostname to be resolved */
417 bres_client r
; /* Background resolver task */
418 sel_timer t
; /* Timer for resolver */
419 addr sa
; /* Socket address */
420 size_t sasz
; /* Socket address size */
421 void (*func
)(struct admin_resop
*, int); /* Handler */
424 enum { ARES_OK
, ARES_FAIL
};
426 typedef struct admin_addop
{
427 admin_resop r
; /* Name resolution header */
428 peerspec peer
; /* Peer pending creation */
431 typedef struct admin_pingop
{
432 admin_bgop bg
; /* Background operation header */
433 ping ping
; /* Ping pending response */
434 struct timeval pingtime
; /* Time last ping was sent */
437 typedef struct admin_service
{
438 sym_base _b
; /* Hash table base structure */
439 char *version
; /* The provided version */
440 struct admin
*prov
; /* Which client provides me */
441 struct admin_service
*next
, *prev
; /* Client's list of services */
444 typedef struct admin_svcop
{
445 admin_bgop bg
; /* Background operation header */
446 struct admin
*prov
; /* Client servicing this job */
447 unsigned index
; /* This job's index */
448 struct admin_svcop
*next
, *prev
; /* Links for provider's jobs */
451 typedef struct admin_jobentry
{
452 unsigned short seq
; /* Zero if unused */
454 admin_svcop
*op
; /* Operation, if slot in use, ... */
455 uint32 next
; /* ... or index of next free slot */
459 typedef struct admin_jobtable
{
460 uint32 n
, sz
; /* Used slots and table size */
461 admin_svcop
*active
; /* List of active jobs */
462 uint32 free
; /* Index of first free slot */
463 admin_jobentry
*v
; /* And the big array of entries */
466 typedef struct admin
{
467 struct admin
*next
, *prev
; /* Links to next and previous */
468 unsigned f
; /* Various useful flags */
469 unsigned ref
; /* Reference counter */
471 unsigned seq
; /* Sequence number for tracing */
473 oqueue out
; /* Output buffer list */
474 oqueue delay
; /* Delayed output buffer list */
475 admin_bgop
*bg
; /* Backgrounded operations */
476 admin_service
*svcs
; /* Which services I provide */
477 admin_jobtable j
; /* Table of outstanding jobs */
478 selbuf b
; /* Line buffer for commands */
479 sel_file w
; /* Selector for write buffering */
482 #define AF_DEAD 1u /* Destroy this admin block */
483 #define AF_CLOSE 2u /* Client closed connection */
484 #define AF_NOTE 4u /* Catch notifications */
485 #define AF_WARN 8u /* Catch warning messages */
487 #define AF_TRACE 16u /* Catch tracing */
489 #define AF_FOREGROUND 32u /* Quit server when client closes */
492 # define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
494 # define AF_ALLMSGS (AF_NOTE | AF_WARN)
497 /*----- Global variables --------------------------------------------------*/
499 extern sel_state sel
; /* Global I/O event state */
500 extern group
*gg
; /* The group we work in */
501 extern size_t indexsz
; /* Size of exponent for the group */
502 extern mp
*kpriv
; /* Our private key */
503 extern ge
*kpub
; /* Our public key */
504 extern octet buf_i
[PKBUFSZ
], buf_o
[PKBUFSZ
], buf_t
[PKBUFSZ
], buf_u
[PKBUFSZ
];
505 extern const tunnel_ops
*tunnels
[]; /* Table of tunnels (0-term) */
506 extern const tunnel_ops
*tun_default
; /* Default tunnel to use */
509 extern const trace_opt tr_opts
[]; /* Trace options array */
510 extern unsigned tr_flags
; /* Trace options flags */
513 /*----- Other macros ------------------------------------------------------*/
515 #define TIMER noise_timer(RAND_GLOBAL)
517 /*----- Key management ----------------------------------------------------*/
519 /* --- @km_reload@ --- *
523 * Returns: Zero if OK, nonzero to force reloading of keys.
525 * Use: Checks the keyrings to see if they need reloading.
528 extern int km_reload(void);
530 /* --- @km_init@ --- *
532 * Arguments: @const char *kr_priv@ = private keyring file
533 * @const char *kr_pub@ = public keyring file
534 * @const char *tag@ = tag to load
538 * Use: Initializes, and loads the private key.
541 extern void km_init(const char */
*kr_priv*/
, const char */
*kr_pub*/
,
542 const char */
*tag*/
);
544 /* --- @km_getpubkey@ --- *
546 * Arguments: @const char *tag@ = public key tag to load
547 * @ge *kpub@ = where to put the public key
548 * @time_t *t_exp@ = where to put the expiry time
550 * Returns: Zero if OK, nonzero if it failed.
552 * Use: Fetches a public key from the keyring.
555 extern int km_getpubkey(const char */
*tag*/
, ge */
*kpub*/
,
558 /*----- Key exchange ------------------------------------------------------*/
560 /* --- @kx_start@ --- *
562 * Arguments: @keyexch *kx@ = pointer to key exchange context
563 * @int forcep@ = nonzero to ignore the quiet timer
567 * Use: Stimulates a key exchange. If a key exchage is in progress,
568 * a new challenge is sent (unless the quiet timer forbids
569 * this); if no exchange is in progress, one is commenced.
572 extern void kx_start(keyexch */
*kx*/
, int /*forcep*/);
574 /* --- @kx_message@ --- *
576 * Arguments: @keyexch *kx@ = pointer to key exchange context
577 * @unsigned msg@ = the message code
578 * @buf *b@ = pointer to buffer containing the packet
582 * Use: Reads a packet containing key exchange messages and handles
586 extern void kx_message(keyexch */
*kx*/
, unsigned /*msg*/, buf */
*b*/
);
588 /* --- @kx_free@ --- *
590 * Arguments: @keyexch *kx@ = pointer to key exchange context
594 * Use: Frees everything in a key exchange context.
597 extern void kx_free(keyexch */
*kx*/
);
599 /* --- @kx_newkeys@ --- *
601 * Arguments: @keyexch *kx@ = pointer to key exchange context
605 * Use: Informs the key exchange module that its keys may have
606 * changed. If fetching the new keys fails, the peer will be
607 * destroyed, we log messages and struggle along with the old
611 extern void kx_newkeys(keyexch */
*kx*/
);
613 /* --- @kx_init@ --- *
615 * Arguments: @keyexch *kx@ = pointer to key exchange context
616 * @peer *p@ = pointer to peer context
617 * @keyset **ks@ = pointer to keyset list
618 * @unsigned f@ = various useful flags
620 * Returns: Zero if OK, nonzero if it failed.
622 * Use: Initializes a key exchange module. The module currently
623 * contains no keys, and will attempt to initiate a key
627 extern int kx_init(keyexch */
*kx*/
, peer */
*p*/
,
628 keyset
**/
*ks*/
, unsigned /*f*/);
630 /*----- Keysets and symmetric cryptography --------------------------------*/
632 /* --- @ks_drop@ --- *
634 * Arguments: @keyset *ks@ = pointer to a keyset
638 * Use: Decrements a keyset's reference counter. If the counter hits
639 * zero, the keyset is freed.
642 extern void ks_drop(keyset */
*ks*/
);
644 /* --- @ks_gen@ --- *
646 * Arguments: @const void *k@ = pointer to key material
647 * @size_t x, y, z@ = offsets into key material (see below)
648 * @peer *p@ = pointer to peer information
650 * Returns: A pointer to the new keyset.
652 * Use: Derives a new keyset from the given key material. The
653 * offsets @x@, @y@ and @z@ separate the key material into three
654 * parts. Between the @k@ and @k + x@ is `my' contribution to
655 * the key material; between @k + x@ and @k + y@ is `your'
656 * contribution; and between @k + y@ and @k + z@ is a shared
657 * value we made together. These are used to construct two
658 * pairs of symmetric keys. Each pair consists of an encryption
659 * key and a message authentication key. One pair is used for
660 * outgoing messages, the other for incoming messages.
662 * The new key is marked so that it won't be selected for output
663 * by @ksl_encrypt@. You can still encrypt data with it by
664 * calling @ks_encrypt@ directly.
667 extern keyset
*ks_gen(const void */
*k*/
,
668 size_t /*x*/, size_t /*y*/, size_t /*z*/,
671 /* --- @ks_tregen@ --- *
673 * Arguments: @keyset *ks@ = pointer to a keyset
675 * Returns: The time at which moves ought to be made to replace this key.
678 extern time_t ks_tregen(keyset */
*ks*/
);
680 /* --- @ks_activate@ --- *
682 * Arguments: @keyset *ks@ = pointer to a keyset
686 * Use: Activates a keyset, so that it can be used for encrypting
690 extern void ks_activate(keyset */
*ks*/
);
692 /* --- @ks_encrypt@ --- *
694 * Arguments: @keyset *ks@ = pointer to a keyset
695 * @unsigned ty@ = message type
696 * @buf *b@ = pointer to input buffer
697 * @buf *bb@ = pointer to output buffer
699 * Returns: Zero if successful; @KSERR_REGEN@ if we should negotiate a
700 * new key; @KSERR_NOKEYS@ if the key is not usable. Also
701 * returns zero if there was insufficient buffer (but the output
702 * buffer is broken in this case).
704 * Use: Encrypts a block of data using the key. Note that the `key
705 * ought to be replaced' notification is only ever given once
706 * for each key. Also note that this call forces a keyset to be
707 * used even if it's marked as not for data output.
710 extern int ks_encrypt(keyset */
*ks*/
, unsigned /*ty*/,
711 buf */
*b*/
, buf */
*bb*/
);
713 /* --- @ks_decrypt@ --- *
715 * Arguments: @keyset *ks@ = pointer to a keyset
716 * @unsigned ty@ = expected type code
717 * @buf *b@ = pointer to an input buffer
718 * @buf *bb@ = pointer to an output buffer
720 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
721 * zero if there was insufficient buffer (but the output buffer
722 * is broken in this case).
724 * Use: Attempts to decrypt a message using a given key. Note that
725 * requesting decryption with a key directly won't clear a
726 * marking that it's not for encryption.
729 extern int ks_decrypt(keyset */
*ks*/
, unsigned /*ty*/,
730 buf */
*b*/
, buf */
*bb*/
);
732 /* --- @ksl_free@ --- *
734 * Arguments: @keyset **ksroot@ = pointer to keyset list head
738 * Use: Frees (releases references to) all of the keys in a keyset.
741 extern void ksl_free(keyset
**/
*ksroot*/
);
743 /* --- @ksl_link@ --- *
745 * Arguments: @keyset **ksroot@ = pointer to keyset list head
746 * @keyset *ks@ = pointer to a keyset
750 * Use: Links a keyset into a list. A keyset can only be on one list
751 * at a time. Bad things happen otherwise.
754 extern void ksl_link(keyset
**/
*ksroot*/
, keyset */
*ks*/
);
756 /* --- @ksl_prune@ --- *
758 * Arguments: @keyset **ksroot@ = pointer to keyset list head
762 * Use: Prunes the keyset list by removing keys which mustn't be used
766 extern void ksl_prune(keyset
**/
*ksroot*/
);
768 /* --- @ksl_encrypt@ --- *
770 * Arguments: @keyset **ksroot@ = pointer to keyset list head
771 * @unsigned ty@ = message type
772 * @buf *b@ = pointer to input buffer
773 * @buf *bb@ = pointer to output buffer
775 * Returns: Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
776 * new key; @KSERR_NOKEYS@ if there are no suitable keys
777 * available. Also returns zero if there was insufficient
778 * buffer space (but the output buffer is broken in this case).
780 * Use: Encrypts a packet.
783 extern int ksl_encrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
784 buf */
*b*/
, buf */
*bb*/
);
786 /* --- @ksl_decrypt@ --- *
788 * Arguments: @keyset **ksroot@ = pointer to keyset list head
789 * @unsigned ty@ = expected type code
790 * @buf *b@ = pointer to input buffer
791 * @buf *bb@ = pointer to output buffer
793 * Returns: Zero on success; @KSERR_DECRYPT@ on failure. Also returns
794 * zero if there was insufficient buffer (but the output buffer
795 * is broken in this case).
797 * Use: Decrypts a packet.
800 extern int ksl_decrypt(keyset
**/
*ksroot*/
, unsigned /*ty*/,
801 buf */
*b*/
, buf */
*bb*/
);
803 /*----- Challenges --------------------------------------------------------*/
807 * Arguments: @buf *b@ = where to put the challenge
809 * Returns: Zero if OK, nonzero on error.
811 * Use: Issues a new challenge.
814 extern int c_new(buf */
*b*/
);
816 /* --- @c_check@ --- *
818 * Arguments: @buf *b@ = where to find the challenge
820 * Returns: Zero if OK, nonzero if it didn't work.
822 * Use: Checks a challenge. On failure, the buffer is broken.
825 extern int c_check(buf */
*b*/
);
827 /*----- Administration interface ------------------------------------------*/
829 #define A_END ((char *)0)
831 /* --- @a_vformat@ --- *
833 * Arguments: @dstr *d@ = where to leave the formatted message
834 * @const char *fmt@ = pointer to format string
835 * @va_list ap@ = arguments in list
839 * Use: Main message token formatting driver. The arguments are
840 * interleaved formatting tokens and their parameters, finally
841 * terminated by an entry @A_END@.
845 * * "*..." ... -- pretokenized @dstr_putf@-like string
847 * * "?ADDR" SOCKADDR -- a socket address, to be converted
849 * * "?B64" BUFFER SIZE -- binary data to be base64-encoded
851 * * "?TOKENS" VECTOR -- null-terminated vector of tokens
853 * * "?PEER" PEER -- peer's name
855 * * "?ERRNO" ERRNO -- system error code
857 * * "[!]..." ... -- @dstr_putf@-like string as single token
860 extern void a_vformat(dstr */
*d*/
, const char */
*fmt*/
, va_list /*ap*/);
862 /* --- @a_warn@ --- *
864 * Arguments: @const char *fmt@ = pointer to format string
865 * @...@ = other arguments
869 * Use: Informs all admin connections of a warning.
872 extern void a_warn(const char */
*fmt*/
, ...);
874 /* --- @a_notify@ --- *
876 * Arguments: @const char *fmt@ = pointer to format string
877 * @...@ = other arguments
881 * Use: Sends a notification to interested admin connections.
884 extern void a_notify(const char */
*fmt*/
, ...);
886 /* --- @a_create@ --- *
888 * Arguments: @int fd_in, fd_out@ = file descriptors to use
889 * @unsigned f@ = initial flags to set
893 * Use: Creates a new admin connection.
896 extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
898 /* --- @a_quit@ --- *
904 * Use: Shuts things down nicely.
907 extern void a_quit(void);
909 /* --- @a_preselect@ --- *
915 * Use: Informs the admin module that we're about to select again,
916 * and that it should do cleanup things it has delayed until a
920 extern void a_preselect(void);
922 /* --- @a_daemon@ --- *
928 * Use: Informs the admin module that it's a daemon.
931 extern void a_daemon(void);
933 /* --- @a_init@ --- *
935 * Arguments: @const char *sock@ = socket name to create
936 * @uid_t u@ = user to own the socket
937 * @gid_t g@ = group to own the socket
938 * @mode_t m@ = permissions to set on the socket
942 * Use: Creates the admin listening socket.
945 extern void a_init(const char */
*sock*/
,
946 uid_t
/*u*/, gid_t
/*g*/, mode_t
/*m*/);
948 /*----- Mapping with addresses as keys ------------------------------------*/
950 /* --- @am_create@ --- *
952 * Arguments: @addrmap *m@ = pointer to map
956 * Use: Create an address map, properly set up.
959 extern void am_create(addrmap */
*m*/
);
961 /* --- @am_destroy@ --- *
963 * Arguments: @addrmap *m@ = pointer to map
967 * Use: Destroy an address map, throwing away all the entries.
970 extern void am_destroy(addrmap */
*m*/
);
972 /* --- @am_find@ --- *
974 * Arguments: @addrmap *m@ = pointer to map
975 * @const addr *a@ = address to look up
976 * @size_t sz@ = size of block to allocate
977 * @unsigned *f@ = where to store flags
979 * Returns: Pointer to found item, or null.
981 * Use: Finds a record with the given IP address, set @*f@ nonzero
982 * and returns it. If @sz@ is zero, and no match was found,
983 * return null; otherwise allocate a new block of @sz@ bytes,
984 * clear @*f@ to zero and return the block pointer.
987 extern void *am_find(addrmap */
*m*/
, const addr */
*a*/
,
988 size_t /*sz*/, unsigned */
*f*/
);
990 /* --- @am_remove@ --- *
992 * Arguments: @addrmap *m@ = pointer to map
993 * @void *i@ = pointer to the item
997 * Use: Removes an item from the map.
1000 extern void am_remove(addrmap */
*m*/
, void */
*i*/
);
1002 /*----- Privilege separation ----------------------------------------------*/
1004 /* --- @ps_trace@ --- *
1006 * Arguments: @unsigned mask@ = trace mask to check
1007 * @const char *fmt@ = message format
1008 * @...@ = values for placeholders
1012 * Use: Writes a trace message.
1015 T( extern void ps_trace(unsigned /*mask*/, const char */
*fmt*/
, ...); )
1017 /* --- @ps_warn@ --- *
1019 * Arguments: @const char *fmt@ = message format
1020 * @...@ = values for placeholders
1024 * Use: Writes a warning message.
1027 extern void ps_warn(const char */
*fmt*/
, ...);
1029 /* --- @ps_tunfd@ --- *
1031 * Arguments: @const tunnel_ops *tops@ = pointer to tunnel operations
1032 * @char **ifn@ = where to put the interface name
1034 * Returns: The file descriptor, or @-1@ on error.
1036 * Use: Fetches a file descriptor for a tunnel driver.
1039 extern int ps_tunfd(const tunnel_ops */
*tops*/
, char **/
*ifn*/
);
1041 /* --- @ps_split@ --- *
1043 * Arguments: @int detachp@ = whether to detach the child from its terminal
1047 * Use: Separates off the privileged tunnel-opening service from the
1048 * rest of the server.
1051 extern void ps_split(int /*detachp*/);
1053 /* --- @ps_quit@ --- *
1059 * Use: Detaches from the helper process.
1062 extern void ps_quit(void);
1064 /*----- Peer management ---------------------------------------------------*/
1066 /* --- @p_txstart@ --- *
1068 * Arguments: @peer *p@ = pointer to peer block
1069 * @unsigned msg@ = message type code
1071 * Returns: A pointer to a buffer to write to.
1073 * Use: Starts sending to a peer. Only one send can happen at a
1077 extern buf
*p_txstart(peer */
*p*/
, unsigned /*msg*/);
1079 /* --- @p_txend@ --- *
1081 * Arguments: @peer *p@ = pointer to peer block
1085 * Use: Sends a packet to the peer.
1088 extern void p_txend(peer */
*p*/
);
1090 /* --- @p_pingsend@ --- *
1092 * Arguments: @peer *p@ = destination peer
1093 * @ping *pg@ = structure to fill in
1094 * @unsigned type@ = message type
1095 * @unsigned long timeout@ = how long to wait before giving up
1096 * @void (*func)(int, void *)@ = callback function
1097 * @void *arg@ = argument for callback
1099 * Returns: Zero if successful, nonzero if it failed.
1101 * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
1102 * if we get an answer within the timeout, or zero if no answer.
1105 extern int p_pingsend(peer */
*p*/
, ping */
*pg*/
, unsigned /*type*/,
1106 unsigned long /*timeout*/,
1107 void (*/
*func*/
)(int, void *), void */
*arg*/
);
1109 /* --- @p_pingdone@ --- *
1111 * Arguments: @ping *p@ = ping structure
1112 * @int rc@ = return code to pass on
1116 * Use: Disposes of a ping structure, maybe sending a notification.
1119 extern void p_pingdone(ping */
*p*/
, int /*rc*/);
1121 /* --- @p_greet@ --- *
1123 * Arguments: @peer *p@ = peer to send to
1124 * @const void *c@ = pointer to challenge
1125 * @size_t sz@ = size of challenge
1129 * Use: Sends a greeting packet.
1132 extern void p_greet(peer */
*p*/
, const void */
*c*/
, size_t /*sz*/);
1134 /* --- @p_tun@ --- *
1136 * Arguments: @peer *p@ = pointer to peer block
1137 * @buf *b@ = buffer containing incoming packet
1141 * Use: Handles a packet which needs to be sent to a peer.
1144 extern void p_tun(peer */
*p*/
, buf */
*b*/
);
1146 /* --- @p_keyreload@ --- *
1152 * Use: Forces a check of the daemon's keyring files.
1155 extern void p_keyreload(void);
1157 /* --- @p_interval@ --- *
1163 * Use: Called periodically to do tidying.
1166 extern void p_interval(void);
1168 /* --- @p_stats@ --- *
1170 * Arguments: @peer *p@ = pointer to a peer block
1172 * Returns: A pointer to the peer's statistics.
1175 extern stats
*p_stats(peer */
*p*/
);
1177 /* --- @p_ifname@ --- *
1179 * Arguments: @peer *p@ = pointer to a peer block
1181 * Returns: A pointer to the peer's interface name.
1184 extern const char *p_ifname(peer */
*p*/
);
1186 /* --- @p_setifname@ --- *
1188 * Arguments: @peer *p@ = pointer to a peer block
1189 * @const char *name@ = pointer to the new name
1193 * Use: Changes the name held for a peer's interface.
1196 extern void p_setifname(peer */
*p*/
, const char */
*name*/
);
1198 /* --- @p_addr@ --- *
1200 * Arguments: @peer *p@ = pointer to a peer block
1202 * Returns: A pointer to the peer's address.
1205 extern const addr
*p_addr(peer */
*p*/
);
1207 /* --- @p_init@ --- *
1209 * Arguments: @struct in_addr addr@ = address to bind to
1210 * @unsigned port@ = port number to listen to
1214 * Use: Initializes the peer system; creates the socket.
1217 extern void p_init(struct in_addr
/*addr*/, unsigned /*port*/);
1219 /* --- @p_port@ --- *
1223 * Returns: Port number used for socket.
1226 unsigned p_port(void);
1228 /* --- @p_create@ --- *
1230 * Arguments: @peerspec *spec@ = information about this peer
1232 * Returns: Pointer to the peer block, or null if it failed.
1234 * Use: Creates a new named peer block. No peer is actually attached
1238 extern peer
*p_create(peerspec */
*spec*/
);
1240 /* --- @p_name@ --- *
1242 * Arguments: @peer *p@ = pointer to a peer block
1244 * Returns: A pointer to the peer's name.
1246 * Use: Equivalent to @p_spec(p)->name@.
1249 extern const char *p_name(peer */
*p*/
);
1251 /* --- @p_tag@ --- *
1253 * Arguments: @peer *p@ = pointer to a peer block
1255 * Returns: A pointer to the peer's public key tag.
1258 extern const char *p_tag(peer */
*p*/
);
1260 /* --- @p_spec@ --- *
1262 * Arguments: @peer *p@ = pointer to a peer block
1264 * Returns: Pointer to the peer's specification
1267 extern const peerspec
*p_spec(peer */
*p*/
);
1269 /* --- @p_findbyaddr@ --- *
1271 * Arguments: @const addr *a@ = address to look up
1273 * Returns: Pointer to the peer block, or null if not found.
1275 * Use: Finds a peer by address.
1278 extern peer
*p_findbyaddr(const addr */
*a*/
);
1280 /* --- @p_find@ --- *
1282 * Arguments: @const char *name@ = name to look up
1284 * Returns: Pointer to the peer block, or null if not found.
1286 * Use: Finds a peer by name.
1289 extern peer
*p_find(const char */
*name*/
);
1291 /* --- @p_destroy@ --- *
1293 * Arguments: @peer *p@ = pointer to a peer
1297 * Use: Destroys a peer.
1300 extern void p_destroy(peer */
*p*/
);
1302 /* --- @FOREACH_PEER@ --- *
1304 * Arguments: @p@ = name to bind to each peer
1305 * @stuff@ = thing to do for each item
1307 * Use: Does something for each current peer.
1310 #define FOREACH_PEER(p, stuff) do { \
1313 for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) stuff \
1316 /* --- @p_mkiter@ --- *
1318 * Arguments: @peer_iter *i@ = pointer to an iterator
1322 * Use: Initializes the iterator.
1325 extern void p_mkiter(peer_iter */
*i*/
);
1327 /* --- @p_next@ --- *
1329 * Arguments: @peer_iter *i@ = pointer to an iterator
1331 * Returns: Next peer, or null if at the end.
1333 * Use: Returns the next peer.
1336 extern peer
*p_next(peer_iter */
*i*/
);
1338 /*----- Tunnel drivers ----------------------------------------------------*/
1341 extern const tunnel_ops tun_linux
;
1345 extern const tunnel_ops tun_unet
;
1349 extern const tunnel_ops tun_bsd
;
1352 extern const tunnel_ops tun_slip
;
1354 /*----- Other handy utilities ---------------------------------------------*/
1356 /* --- @mpstr@ --- *
1358 * Arguments: @mp *m@ = a multiprecision integer
1360 * Returns: A pointer to the integer's textual representation.
1362 * Use: Converts a multiprecision integer to a string. Corrupts
1366 extern const char *mpstr(mp */
*m*/
);
1368 /* --- @gestr@ --- *
1370 * Arguments: @group *g@ = a group
1371 * @ge *x@ = a group element
1373 * Returns: A pointer to the element's textual representation.
1375 * Use: Converts a group element to a string. Corrupts
1379 extern const char *gestr(group */
*g*/
, ge */
*x*/
);
1381 /* --- @timestr@ --- *
1383 * Arguments: @time_t t@ = a time to convert
1385 * Returns: A pointer to a textual representation of the time.
1387 * Use: Converts a time to a textual representation. Corrupts
1391 extern const char *timestr(time_t /*t*/);
1393 /* --- @mystrieq@ --- *
1395 * Arguments: @const char *x, *y@ = two strings
1397 * Returns: True if @x@ and @y are equal, up to case.
1400 extern int mystrieq(const char */
*x*/
, const char */
*y*/
);
1402 /* --- @seq_reset@ --- *
1404 * Arguments: @seqwin *s@ = sequence-checking window
1408 * Use: Resets a sequence number window.
1411 extern void seq_reset(seqwin */
*s*/
);
1413 /* --- @seq_check@ --- *
1415 * Arguments: @seqwin *s@ = sequence-checking window
1416 * @uint32 q@ = sequence number to check
1417 * @const char *service@ = service to report message from
1419 * Returns: A @SEQ_@ code.
1421 * Use: Checks a sequence number against the window, updating things
1425 extern int seq_check(seqwin */
*s*/
, uint32
/*q*/, const char */
*service*/
);
1427 /*----- That's all, folks -------------------------------------------------*/