/* -*-c-*-
*
- * $Id: tripe.h,v 1.19 2004/04/08 01:36:17 mdw Exp $
+ * $Id$
*
* Main header file for TrIPE
*
#include <assert.h>
#include <ctype.h>
#include <errno.h>
+#include <limits.h>
#include <signal.h>
#include <stdarg.h>
#include <stddef.h>
#include <mLib/alloc.h>
#include <mLib/arena.h>
+#include <mLib/base64.h>
#include <mLib/bres.h>
#include <mLib/dstr.h>
#include <mLib/env.h>
#include <mLib/str.h>
#include <mLib/sub.h>
#include <mLib/trace.h>
+#include <mLib/tv.h>
#include <catacomb/buf.h>
/*----- Magic numbers -----------------------------------------------------*/
-/* --- Tunnel types --- */
-
-#define TUN_NOTDEF 0
-#define TUN_UNET 1
-#define TUN_BSD 2
-#define TUN_LINUX 3
-
/* --- Trace flags --- */
#define T_TUNNEL 1u
#define T_KEYSET 32u
#define T_KEYEXCH 64u
#define T_KEYMGMT 128u
+#define T_CHAL 256u
-#define T_ALL 255u
+#define T_ALL 511u
/* --- Units --- */
/*----- Cipher selections -------------------------------------------------*/
-#include <catacomb/blowfish.h>
-#include <catacomb/blowfish-cbc.h>
-#include <catacomb/blowfish-counter.h>
-#include <catacomb/rmd160.h>
-#include <catacomb/rmd160-hmac.h>
-
-#define CIPHER (&blowfish_cbc)
-#define MAC (&rmd160_hmac)
+typedef struct algswitch {
+ const gccipher *c; /* Symmetric encryption scheme */
+ const gccipher *mgf; /* Mask-generation function */
+ const gchash *h; /* Hash function */
+ const gcmac *m; /* Message authentication code */
+ size_t hashsz; /* Hash output size */
+ size_t tagsz; /* Length to truncate MAC tags */
+ size_t cksz, mksz; /* Key lengths for @c@ and @m@ */
+} algswitch;
-#define HASH_CTX rmd160_ctx
-#define HASH_INIT rmd160_init
-#define HASH rmd160_hash
-#define HASH_STRING(c, s) HASH((c), s, sizeof(s))
-#define HASH_DONE rmd160_done
-#define HASHSZ RMD160_HASHSZ
+extern algswitch algs;
-#define MGF_CTX blowfish_counterctx
-#define MGF_INIT blowfish_counterinit
-#define MGF_CRYPT blowfish_counterencrypt
+#define MAXHASHSZ 64 /* Largest possible hash size */
-#define SEQSZ 4
-#define IVSZ BLOWFISH_BLKSZ
-#define MACSZ 10
+#define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
/*----- Data structures ---------------------------------------------------*/
struct sockaddr_in sin;
} addr;
+/* --- Sequence number checking --- */
+
+typedef struct seqwin {
+ uint32 seq; /* First acceptable input sequence */
+ uint32 win; /* Window of acceptable numbers */
+} seqwin;
+
+#define SEQ_WINSZ 32 /* Bits in sequence number window */
+
/* --- A symmetric keyset --- *
*
* A keyset contains a set of symmetric keys for encrypting and decrypting
T( unsigned seq; ) /* Sequence number for tracing */
unsigned f; /* Various useful flags */
gcipher *cin, *cout; /* Keyset ciphers for encryption */
+ size_t tagsz; /* Length to truncate MAC tags */
gmac *min, *mout; /* Keyset MACs for integrity */
uint32 oseq; /* Outbound sequence number */
- uint32 iseq, iwin; /* Inbound sequence number */
+ seqwin iseq; /* Inbound sequence number */
} keyset;
-#define KS_SEQWINSZ 32 /* Bits in sequence number window */
-
#define KSF_LISTEN 1u /* Don't encrypt packets yet */
#define KSF_LINK 2u /* Key is in a linked list */
keyset *ks; /* Pointer to temporary keyset */
unsigned f; /* Various useful flags */
sel_timer t; /* Response timer for challenge */
- octet hc[HASHSZ]; /* Hash of his challenge */
+ octet hc[MAXHASHSZ]; /* Hash of his challenge */
mp *ck; /* The check value */
- octet hswrq_in[HASHSZ]; /* Inbound switch request message */
- octet hswok_in[HASHSZ]; /* Inbound switch confirmation */
- octet hswrq_out[HASHSZ]; /* Outbound switch request message */
- octet hswok_out[HASHSZ]; /* Outbound switch confirmation */
+ octet hswrq_in[MAXHASHSZ]; /* Inbound switch request message */
+ octet hswok_in[MAXHASHSZ]; /* Inbound switch confirmation */
+ octet hswrq_out[MAXHASHSZ]; /* Outbound switch request message */
+ octet hswok_out[MAXHASHSZ]; /* Outbound switch confirmation */
} kxchal;
typedef struct keyexch {
ge *rx; /* The expected response */
unsigned nr; /* Number of extant responses */
time_t t_valid; /* When this exchange goes bad */
- octet hc[HASHSZ]; /* Hash of my challenge */
+ octet hc[MAXHASHSZ]; /* Hash of my challenge */
kxchal *r[KX_NCHAL]; /* Array of challenges */
} keyexch;
* Used to maintain system-specific information about the tunnel interface.
*/
-#if TUN_TYPE == TUN_LINUX
-# include <linux/if.h>
-# include <linux/if_tun.h>
-#endif
+typedef struct tunnel tunnel;
+struct peer;
-typedef struct tunnel {
-#if TUN_TYPE == TUN_UNET
- sel_file f; /* Selector for Usernet device */
- struct peer *p; /* Pointer to my peer */
-#elif TUN_TYPE == TUN_LINUX
- sel_file f; /* Selector for TUN/TAP device */
- struct peer *p; /* Pointer to my peer */
- char ifn[IFNAMSIZ]; /* Interface name buffer */
-#elif TUN_TYPE == TUN_BSD
- sel_file f; /* Selector for tunnel device */
- struct peer *p; /* Pointer to my peer */
- unsigned n; /* Number of my tunnel device */
-#else
-# error "No support for this tunnel type"
+typedef struct tunnel_ops {
+ const char *name; /* Name of this tunnel driver */
+ void (*init)(void); /* Initializes the system */
+ tunnel *(*create)(struct peer */*p*/); /* Initializes a new tunnel */
+ const char *(*ifname)(tunnel */*t*/); /* Returns tunnel's interface name */
+ void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
+ void (*destroy)(tunnel */*t*/); /* Destroys a tunnel */
+} tunnel_ops;
+
+#ifndef TUN_INTERNALS
+struct tunnel { const tunnel_ops *ops; };
#endif
-} tunnel;
/* --- Peer statistics --- *
*
unsigned long sz_in, sz_out; /* Size of all data in and out */
unsigned long sz_kxin, sz_kxout; /* Size of key exchange messages */
unsigned long sz_ipin, sz_ipout; /* Size of encapsulated IP packets */
- time_t t_start, t_last; /* Time peer created, last recv */
+ time_t t_start, t_last, t_kx; /* Time peer created, last pk, kx */
unsigned long n_reject; /* Number of rejected packets */
unsigned long n_in, n_out; /* Number of packets in and out */
unsigned long n_kxin, n_kxout; /* Number of key exchange packets */
* The main structure which glues everything else together.
*/
+typedef struct peerspec {
+ char *name; /* Peer's name */
+ const tunnel_ops *tops; /* Tunnel operations */
+ unsigned long t_ka; /* Keep alive interval */
+ addr sa; /* Socket address to speak to */
+ size_t sasz; /* Socket address size */
+} peerspec;
+
typedef struct peer {
struct peer *next, *prev; /* Links to next and previous */
- char *name; /* Name of this peer */
- tunnel t; /* Tunnel for local packets */
+ struct ping *pings; /* Pings we're waiting for */
+ peerspec spec; /* Specifications for this peer */
+ tunnel *t; /* Tunnel for local packets */
keyset *ks; /* List head for keysets */
buf b; /* Buffer for sending packets */
- addr peer; /* Peer socket address */
- size_t sasz; /* Socket address size */
stats st; /* Statistics */
keyexch kx; /* Key exchange protocol block */
+ sel_timer tka; /* Timer for keepalives */
} peer;
+typedef struct ping {
+ struct ping *next, *prev; /* Links to next and previous */
+ peer *p; /* Peer so we can free it */
+ unsigned msg; /* Kind of response expected */
+ uint32 id; /* Id so we can recognize response */
+ octet magic[32]; /* Some random data */
+ sel_timer t; /* Timeout for ping */
+ void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
+ void *arg; /* Argument for callback */
+} ping;
+
+enum {
+ PING_NONOTIFY = -1,
+ PING_OK = 0,
+ PING_TIMEOUT,
+ PING_PEERDIED,
+ PING_MAX
+};
+
/* --- Admin structure --- */
#define OBUFSZ 16384u
char buf[OBUFSZ]; /* The actual buffer */
} obuf;
+typedef struct oqueue {
+ obuf *hd, *tl; /* Head and tail pointers */
+} oqueue;
+
+struct admin;
+
+typedef struct admin_bgop {
+ struct admin_bgop *next, *prev; /* Links to next and previous */
+ struct admin *a; /* Owner job */
+ char *tag; /* Tag string for messages */
+ void (*cancel)(struct admin_bgop *); /* Destructor function */
+} admin_bgop;
+
+typedef struct admin_resop {
+ admin_bgop bg; /* Background operation header */
+ char *addr; /* Hostname to be resolved */
+ bres_client r; /* Background resolver task */
+ sel_timer t; /* Timer for resolver */
+ addr sa; /* Socket address */
+ size_t sasz; /* Socket address size */
+ void (*func)(struct admin_resop *, int); /* Handler */
+} admin_resop;
+
+enum { ARES_OK, ARES_FAIL };
+
+typedef struct admin_addop {
+ admin_resop r; /* Name resolution header */
+ peerspec peer; /* Peer pending creation */
+} admin_addop;
+
+typedef struct admin_greetop {
+ admin_resop r; /* Name resolution header */
+ void *c; /* Challenge block */
+ size_t sz; /* Length of challenge */
+} admin_greetop;
+
+typedef struct admin_pingop {
+ admin_bgop bg; /* Background operation header */
+ ping ping; /* Ping pending response */
+ struct timeval pingtime; /* Time last ping was sent */
+} admin_pingop;
+
typedef struct admin {
struct admin *next, *prev; /* Links to next and previous */
unsigned f; /* Various useful flags */
+ unsigned ref; /* Reference counter */
#ifndef NTRACE
unsigned seq; /* Sequence number for tracing */
#endif
- char *pname; /* Peer name to create */
- char *paddr; /* Address string to resolve */
- obuf *o_head, *o_tail; /* Output buffer list */
+ oqueue out; /* Output buffer list */
+ oqueue delay; /* Delayed output buffer list */
+ admin_bgop *bg; /* Backgrounded operations */
selbuf b; /* Line buffer for commands */
sel_file w; /* Selector for write buffering */
- bres_client r; /* Background resolver task */
- sel_timer t; /* Timer for resolver */
- addr peer; /* Address to set */
- size_t sasz; /* Size of the address */
} admin;
#define AF_DEAD 1u /* Destroy this admin block */
-#define AF_LOCK 2u /* Don't destroy it yet */
+#define AF_CLOSE 2u /* Client closed connection */
+#define AF_NOTE 4u /* Catch notifications */
+#define AF_WARN 8u /* Catch warning messages */
+#ifndef NTRACE
+ #define AF_TRACE 16u /* Catch tracing */
+#endif
+
+#ifndef NTRACE
+# define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
+#else
+# define AF_ALLMSGS (AF_NOTE | AF_WARN)
+#endif
/*----- Global variables --------------------------------------------------*/
extern group *gg; /* The group we work in */
extern mp *kpriv; /* Our private key */
extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ];
+extern const tunnel_ops *tunnels[]; /* Table of tunnels (0-term) */
+extern const tunnel_ops *tun_default; /* Default tunnel to use */
#ifndef NTRACE
extern const trace_opt tr_opts[]; /* Trace options array */
/*----- Key management ----------------------------------------------------*/
-/* --- @km_interval@ --- *
+/* --- @km_reload@ --- *
*
* Arguments: ---
*
* Returns: Zero if OK, nonzero to force reloading of keys.
*
- * Use: Called on the interval timer to perform various useful jobs.
+ * Use: Checks the keyrings to see if they need reloading.
*/
-extern int km_interval(void);
+extern int km_reload(void);
/* --- @km_init@ --- *
*
/* --- @kx_start@ --- *
*
* Arguments: @keyexch *kx@ = pointer to key exchange context
+ * @int forcep@ = nonzero to ignore the quiet timer
*
* Returns: ---
*
* this); if no exchange is in progress, one is commenced.
*/
-extern void kx_start(keyexch */*kx*/);
+extern void kx_start(keyexch */*kx*/, int /*forcep*/);
/* --- @kx_message@ --- *
*
extern int ksl_decrypt(keyset **/*ksroot*/, unsigned /*ty*/,
buf */*b*/, buf */*bb*/);
+/*----- Challenges --------------------------------------------------------*/
+
+/* --- @c_new@ --- *
+ *
+ * Arguments: @buf *b@ = where to put the challenge
+ *
+ * Returns: Zero if OK, nonzero on error.
+ *
+ * Use: Issues a new challenge.
+ */
+
+extern int c_new(buf */*b*/);
+
+/* --- @c_check@ --- *
+ *
+ * Arguments: @buf *b@ = where to find the challenge
+ *
+ * Returns: Zero if OK, nonzero if it didn't work.
+ *
+ * Use: Checks a challenge. On failure, the buffer is broken.
+ */
+
+extern int c_check(buf */*b*/);
+
/*----- Administration interface ------------------------------------------*/
+#define A_END ((char *)0)
+
/* --- @a_warn@ --- *
*
* Arguments: @const char *fmt@ = pointer to format string
extern void a_warn(const char */*fmt*/, ...);
+/* --- @a_notify@ --- *
+ *
+ * Arguments: @const char *fmt@ = pointer to format string
+ * @...@ = other arguments
+ *
+ * Returns: ---
+ *
+ * Use: Sends a notification to interested admin connections.
+ */
+
+extern void a_notify(const char */*fmt*/, ...);
+
/* --- @a_create@ --- *
*
* Arguments: @int fd_in, fd_out@ = file descriptors to use
+ * @unsigned f@ = initial flags to set
*
* Returns: ---
*
* Use: Creates a new admin connection.
*/
-extern void a_create(int /*fd_in*/, int /*fd_out*/);
+extern void a_create(int /*fd_in*/, int /*fd_out*/, unsigned /*f*/);
/* --- @a_quit@ --- *
*
extern void p_txend(peer */*p*/);
+/* --- @p_pingsend@ --- *
+ *
+ * Arguments: @peer *p@ = destination peer
+ * @ping *pg@ = structure to fill in
+ * @unsigned type@ = message type
+ * @unsigned long timeout@ = how long to wait before giving up
+ * @void (*func)(int, void *)@ = callback function
+ * @void *arg@ = argument for callback
+ *
+ * Returns: Zero if successful, nonzero if it failed.
+ *
+ * Use: Sends a ping to a peer. Call @func@ with a nonzero argument
+ * if we get an answer within the timeout, or zero if no answer.
+ */
+
+extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
+ unsigned long /*timeout*/,
+ void (*/*func*/)(int, void *), void */*arg*/);
+
+/* --- @p_pingdone@ --- *
+ *
+ * Arguments: @ping *p@ = ping structure
+ * @int rc@ = return code to pass on
+ *
+ * Returns: ---
+ *
+ * Use: Disposes of a ping structure, maybe sending a notification.
+ */
+
+extern void p_pingdone(ping */*p*/, int /*rc*/);
+
+/* --- @p_greet@ --- *
+ *
+ * Arguments: @peer *p@ = peer to send to
+ * @const void *c@ = pointer to challenge
+ * @size_t sz@ = size of challenge
+ *
+ * Returns: ---
+ *
+ * Use: Sends a greeting packet.
+ */
+
+extern void p_greet(peer */*p*/, const void */*c*/, size_t /*sz*/);
+
/* --- @p_tun@ --- *
*
* Arguments: @peer *p@ = pointer to peer block
extern void p_tun(peer */*p*/, buf */*b*/);
+/* --- @p_keyreload@ --- *
+ *
+ * Arguments: ---
+ *
+ * Returns: ---
+ *
+ * Use: Forces a check of the daemon's keyring files.
+ */
+
+extern void p_keyreload(void);
+
/* --- @p_interval@ --- *
*
* Arguments: ---
/* --- @p_create@ --- *
*
- * Arguments: @const char *name@ = name for this peer
- * @struct sockaddr *sa@ = socket address of peer
- * @size_t sz@ = size of socket address
+ * Arguments: @peerspec *spec@ = information about this peer
*
* Returns: Pointer to the peer block, or null if it failed.
*
* by this point.
*/
-extern peer *p_create(const char */*name*/,
- struct sockaddr */*sa*/, size_t /*sz*/);
+extern peer *p_create(peerspec */*spec*/);
/* --- @p_name@ --- *
*
* Arguments: @peer *p@ = pointer to a peer block
*
* Returns: A pointer to the peer's name.
+ *
+ * Use: Equivalent to @p_spec(p)->name@.
*/
extern const char *p_name(peer */*p*/);
+/* --- @p_spec@ --- *
+ *
+ * Arguments: @peer *p@ = pointer to a peer block
+ *
+ * Returns: Pointer to the peer's specification
+ */
+
+extern const peerspec *p_spec(peer */*p*/);
+
/* --- @p_find@ --- *
*
* Arguments: @const char *name@ = name to look up
extern peer *p_first(void);
extern peer *p_next(peer */*p*/);
-/*----- Tunnel interface --------------------------------------------------*/
-
-/* --- @tun_init@ --- *
- *
- * Arguments: ---
- *
- * Returns: ---
- *
- * Use: Initializes the tunneling system. Maybe this will require
- * opening file descriptors or something.
- */
-
-extern void tun_init(void);
-
-/* --- @tun_create@ --- *
- *
- * Arguments: @tunnel *t@ = pointer to tunnel block
- * @peer *p@ = pointer to peer block
- *
- * Returns: Zero if it worked, nonzero on failure.
- *
- * Use: Initializes a new tunnel.
- */
-
-extern int tun_create(tunnel */*t*/, peer */*p*/);
+/*----- Tunnel drivers ----------------------------------------------------*/
-/* --- @tun_ifname@ --- *
- *
- * Arguments: @tunnel *t@ = pointer to tunnel block
- *
- * Returns: A pointer to the tunnel's interface name.
- */
-
-extern const char *tun_ifname(tunnel */*t*/);
-
-/* --- @tun_inject@ --- *
- *
- * Arguments: @tunnel *t@ = pointer to tunnel block
- * @buf *b@ = buffer to send
- *
- * Returns: ---
- *
- * Use: Injects a packet into the local network stack.
- */
+#ifdef TUN_LINUX
+ extern const tunnel_ops tun_linux;
+#endif
-extern void tun_inject(tunnel */*t*/, buf */*b*/);
+#ifdef TUN_UNET
+ extern const tunnel_ops tun_unet;
+#endif
-/* --- @tun_destroy@ --- *
- *
- * Arguments: @tunnel *t@ = pointer to tunnel block
- *
- * Returns: ---
- *
- * Use: Destroys a tunnel.
- */
+#ifdef TUN_BSD
+ extern const tunnel_ops tun_bsd;
+#endif
-extern void tun_destroy(tunnel */*t*/);
+extern const tunnel_ops tun_slip;
/*----- Other handy utilities ---------------------------------------------*/
extern const char *timestr(time_t /*t*/);
+/* --- @mystrieq@ --- *
+ *
+ * Arguments: @const char *x, *y@ = two strings
+ *
+ * Returns: True if @x@ and @y are equal, up to case.
+ */
+
+extern int mystrieq(const char */*x*/, const char */*y*/);
+
+/* --- @seq_reset@ --- *
+ *
+ * Arguments: @seqwin *s@ = sequence-checking window
+ *
+ * Returns: ---
+ *
+ * Use: Resets a sequence number window.
+ */
+
+extern void seq_reset(seqwin */*s*/);
+
+/* --- @seq_check@ --- *
+ *
+ * Arguments: @seqwin *s@ = sequence-checking window
+ * @uint32 q@ = sequence number to check
+ * @const char *service@ = service to report message from
+ *
+ * Returns: A @SEQ_@ code.
+ *
+ * Use: Checks a sequence number against the window, updating things
+ * as necessary.
+ */
+
+extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
+
/*----- That's all, folks -------------------------------------------------*/
#ifdef __cplusplus
~mdw / tripe / blobdiff