/* -*-c-*-
*
- * $Id: tripe.h,v 1.2 2001/02/03 22:40:29 mdw Exp $
+ * $Id$
*
* Main header file for TrIPE
*
* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
-/*----- Revision history --------------------------------------------------*
- *
- * $Log: tripe.h,v $
- * Revision 1.2 2001/02/03 22:40:29 mdw
- * Put timer information into the entropy pool when packets are received
- * and on similar events. Reseed the generator on the interval timer.
- *
- * Revision 1.1 2001/02/03 20:26:37 mdw
- * Initial checkin.
- *
- */
-
#ifndef TRIPE_H
#define TRIPE_H
/*----- Header files ------------------------------------------------------*/
+#include "config.h"
+
#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>
#include <catacomb/gcipher.h>
#include <catacomb/gmac.h>
#include <catacomb/key.h>
#include <catacomb/paranoia.h>
-#include <catacomb/blowfish.h>
-#include <catacomb/blowfish-cbc.h>
#include <catacomb/noise.h>
#include <catacomb/rand.h>
-#include <catacomb/rmd160.h>
-#include <catacomb/rmd160-hmac.h>
#include <catacomb/mp.h>
-#include <catacomb/mpmont.h>
#include <catacomb/mprand.h>
#include <catacomb/dh.h>
+#include <catacomb/ec.h>
+#include <catacomb/ec-keys.h>
+#include <catacomb/group.h>
+#include "tripe-protocol.h"
#include "util.h"
#undef sun
/*----- Magic numbers -----------------------------------------------------*/
-/* --- Tunnel types --- */
-
-#define TUN_NOTDEF 0
-#define TUN_UNET 1
-#define TUN_BSD 2
-
/* --- 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 --- */
#define PKBUFSZ 65536
-/*----- TrIPE protocol ----------------------------------------------------*/
+/*----- Cipher selections -------------------------------------------------*/
-/* --- TrIPE packet format --- *
- *
- * A packet begins with a single-byte packet type. The remaining data
- * depends on the packet type.
- */
+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 MSG_PACKET 0u
-/* Followed by a 64-bit MAC and an encrypted packet. The MAC is used as an
- * IV for a 64-bit block cipher in CBC-stealing mode.
- */
+extern algswitch algs;
-#define MSG_PRECHALLENGE 1u
-/* Followed by the challenge only. Useful for bootstrapping the system.
- */
+#define MAXHASHSZ 64 /* Largest possible hash size */
-#define MSG_CHALLENGE 2u
-/* Followed by a response hash and a large-integer challenge.
- */
-
-#define MSG_RESPONSE 3u
-/* Followed by a large-integer response.
- */
+#define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s))
/*----- Data structures ---------------------------------------------------*/
-/* --- Buffers --- *
- *
- * Buffers provide a simple stream-like interface for building and parsing
- * packets.
- */
-
-typedef struct buf {
- octet *base, *p, *limit; /* Pointers to the buffer */
- unsigned f; /* Various flags */
-} buf;
-
-#define BF_BROKEN 1u /* Buffer is broken */
-
/* --- Socket addresses --- *
*
* A magic union of supported socket addresses.
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
typedef struct keyset {
struct keyset *next; /* Next active keyset in the list */
+ unsigned ref; /* Reference count for keyset */
+ struct peer *p; /* Pointer to peer structure */
time_t t_exp; /* Expiry time for this keyset */
unsigned long sz_exp; /* Data limit for the keyset */
-#ifndef NTRACE
- unsigned seq; /* Sequence number for tracing */
-#endif
- gcipher *c; /* Keyset cipher for encryption */
- gmac *m; /* Keyset MAC for integrity */
+ 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 */
+ seqwin iseq; /* Inbound sequence number */
} keyset;
+#define KSF_LISTEN 1u /* Don't encrypt packets yet */
+#define KSF_LINK 2u /* Key is in a linked list */
+
/* --- Key exchange --- *
*
* TrIPE uses the Wrestlers Protocol for its key exchange. The Wrestlers
* Clive Jones.
*/
+#define KX_NCHAL 16u
+#define KX_THRESH 4u
+
+typedef struct kxchal {
+ struct keyexch *kx; /* Pointer back to key exchange */
+ ge *c; /* Responder's challenge */
+ ge *r; /* My reply to the challenge */
+ keyset *ks; /* Pointer to temporary keyset */
+ unsigned f; /* Various useful flags */
+ sel_timer t; /* Response timer for challenge */
+ octet hc[MAXHASHSZ]; /* Hash of his challenge */
+ mp *ck; /* The check value */
+ 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 {
- keyset **ks; /* Peer's list of keysets */
struct peer *p; /* Pointer back to the peer */
+ keyset **ks; /* Peer's list of keysets */
unsigned f; /* Various useful flags */
+ unsigned s; /* Current state in exchange */
sel_timer t; /* Timer for next exchange */
- dh_pub kpub; /* Peer's public key */
- mp *my_x, *my_gx, *my_gxy; /* My half of the exchange */
- octet my_h[RMD160_HASHSZ]; /* My challenge hash */
- mp *your_gx, *your_gxy; /* Your half of the exchange */
- octet your_h[RMD160_HASHSZ]; /* Your challenge hash */
+ ge *kpub; /* Peer's public key */
+ time_t texp_kpub; /* Expiry time for public key */
+ mp *alpha; /* My temporary secret */
+ ge *c; /* My challenge */
+ ge *rx; /* The expected response */
+ unsigned nr; /* Number of extant responses */
time_t t_valid; /* When this exchange goes bad */
- time_t t_qchal, t_qresp; /* Quiet timers for packet types */
- time_t t_newchal; /* When to accept a new challenge */
+ octet hc[MAXHASHSZ]; /* Hash of my challenge */
+ kxchal *r[KX_NCHAL]; /* Array of challenges */
} keyexch;
#define KXF_TIMER 1u /* Waiting for a timer to go off */
-#define KXF_INIT 2u /* Big numbers are initialized */
-#define KXF_MYH 4u /* My hash has been computed */
-#define KXF_YOURH 8u /* Your hash has been received */
-#define KXF_REPLY 16u /* Received your response OK */
-#define KXF_DONE 32u /* Key exchange completed */
+#define KXF_DEAD 2u /* The key-exchanger isn't up */
+#define KXF_PUBKEY 4u /* Key exchanger has a public key */
+
+enum {
+ KXS_DEAD, /* Uninitialized state (magical) */
+ KXS_CHAL, /* Main answer-challenges state */
+ KXS_COMMIT, /* Committed: send switch request */
+ KXS_SWITCH /* Switched: send confirmation */
+};
/* --- Tunnel structure --- *
*
* Used to maintain system-specific information about the tunnel interface.
*/
-typedef struct tunnel {
-#if TUN_TYPE == TUN_UNET
- sel_file f; /* Selector for Usernet device */
- struct peer *p; /* Pointer to my peer */
-#else
-# error "No support for this tunnel type"
+typedef struct tunnel tunnel;
+struct peer;
+
+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 --- *
+ *
+ * Contains various interesting and not-so-interesting statistics about a
+ * peer. This is updated by various parts of the code. The format of the
+ * structure isn't considered private, and @p_stats@ returns a pointer to the
+ * statistics block for a given peer.
+ */
+
+typedef struct stats {
+ 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, 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 */
+ unsigned long n_ipin, n_ipout; /* Number of encrypted packets */
+} stats;
/* --- Peer structure --- *
*
* 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 */
- keyexch kx; /* Key exchange protocol block */
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
+
+typedef struct obuf {
+ struct obuf *next; /* Next buffer in list */
+ char *p_in, *p_out; /* Pointers into the buffer */
+ 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 */
- selbuf b; /* Line buffer for commands */
- int fd; /* File descriptor for output */
+ 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 */
- bres_client r; /* Background resolver task */
- sel_timer t; /* Timer for resolver */
- addr peer; /* Address to set */
- size_t sasz; /* Size of the address */
+ 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 */
} admin;
+#define AF_DEAD 1u /* Destroy this admin block */
+#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 sel_state sel; /* Global I/O event state */
-extern dh_priv kpriv; /* Our private key */
-extern mpmont mg; /* Montgomery context for DH group */
-extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ]; /* Big packet buffers */
+extern group *gg; /* The group we work in */
+extern mp *kpriv; /* Our private key */
+extern ge *kpub; /* Our public 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@ --- *
*
/* --- @km_getpubkey@ --- *
*
* Arguments: @const char *tag@ = public key tag to load
- * @dh_pub *kpub@ = where to put the public key
+ * @ge *kpub@ = where to put the public key
+ * @time_t *t_exp@ = where to put the expiry time
*
* Returns: Zero if OK, nonzero if it failed.
*
* Use: Fetches a public key from the keyring.
*/
-extern int km_getpubkey(const char */*tag*/, dh_pub */*kpub*/);
+extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
+ time_t */*t_exp*/);
/*----- Key exchange ------------------------------------------------------*/
/* --- @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_prechallenge@ --- *
- *
- * Arguments: @keyexch *kx@ = pointer to key exhange context
- * @buf *b@ = pointer to buffer containing the packet
- *
- * Returns: ---
- *
- * Use: Reads a prechallenge packet from the buffer and handles it.
- */
-
-extern void kx_prechallenge(keyexch */*kx*/, buf */*b*/);
-
-/* --- @kx_challenge@ --- *
+/* --- @kx_message@ --- *
*
* Arguments: @keyexch *kx@ = pointer to key exchange context
- * @buf *b@ = a buffer containing the packet to read
- *
- * Returns: ---
- *
- * Use: Reads a challenge from the buffer and handles it.
- */
-
-extern void kx_challenge(keyexch */*kx*/, buf */*b*/);
-
-/* --- @kx_response@ --- *
- *
- * Arguments: @keyexch *kx@ = pointer to key exchange context
- * @buf *b@ = a buffer containing the packet to read
+ * @unsigned msg@ = the message code
+ * @buf *b@ = pointer to buffer containing the packet
*
* Returns: ---
*
- * Use: Reads a response from the buffer and handles it.
+ * Use: Reads a packet containing key exchange messages and handles
+ * it.
*/
-extern void kx_response(keyexch */*kx*/, buf */*b*/);
+extern void kx_message(keyexch */*kx*/, unsigned /*msg*/, buf */*b*/);
/* --- @kx_free@ --- *
*
/*----- Keysets and symmetric cryptography --------------------------------*/
-/* --- @ks_free@ --- *
+/* --- @ks_drop@ --- *
+ *
+ * Arguments: @keyset *ks@ = pointer to a keyset
+ *
+ * Returns: ---
+ *
+ * Use: Decrements a keyset's reference counter. If the counter hits
+ * zero, the keyset is freed.
+ */
+
+extern void ks_drop(keyset */*ks*/);
+
+/* --- @ks_gen@ --- *
+ *
+ * Arguments: @const void *k@ = pointer to key material
+ * @size_t x, y, z@ = offsets into key material (see below)
+ * @peer *p@ = pointer to peer information
+ *
+ * Returns: A pointer to the new keyset.
+ *
+ * Use: Derives a new keyset from the given key material. The
+ * offsets @x@, @y@ and @z@ separate the key material into three
+ * parts. Between the @k@ and @k + x@ is `my' contribution to
+ * the key material; between @k + x@ and @k + y@ is `your'
+ * contribution; and between @k + y@ and @k + z@ is a shared
+ * value we made together. These are used to construct two
+ * pairs of symmetric keys. Each pair consists of an encryption
+ * key and a message authentication key. One pair is used for
+ * outgoing messages, the other for incoming messages.
+ *
+ * The new key is marked so that it won't be selected for output
+ * by @ksl_encrypt@. You can still encrypt data with it by
+ * calling @ks_encrypt@ directly.
+ */
+
+extern keyset *ks_gen(const void */*k*/,
+ size_t /*x*/, size_t /*y*/, size_t /*z*/,
+ peer */*p*/);
+
+/* --- @ks_tregen@ --- *
+ *
+ * Arguments: @keyset *ks@ = pointer to a keyset
+ *
+ * Returns: The time at which moves ought to be made to replace this key.
+ */
+
+extern time_t ks_tregen(keyset */*ks*/);
+
+/* --- @ks_activate@ --- *
+ *
+ * Arguments: @keyset *ks@ = pointer to a keyset
+ *
+ * Returns: ---
+ *
+ * Use: Activates a keyset, so that it can be used for encrypting
+ * outgoing messages.
+ */
+
+extern void ks_activate(keyset */*ks*/);
+
+/* --- @ks_encrypt@ --- *
+ *
+ * Arguments: @keyset *ks@ = pointer to a keyset
+ * @unsigned ty@ = message type
+ * @buf *b@ = pointer to input buffer
+ * @buf *bb@ = pointer to output buffer
+ *
+ * Returns: Zero if OK, nonzero if the key needs replacing. If the
+ * encryption failed, the output buffer is broken and zero is
+ * returned.
+ *
+ * Use: Encrypts a block of data using the key. Note that the `key
+ * ought to be replaced' notification is only ever given once
+ * for each key. Also note that this call forces a keyset to be
+ * used even if it's marked as not for data output.
+ */
+
+extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
+ buf */*b*/, buf */*bb*/);
+
+/* --- @ks_decrypt@ --- *
+ *
+ * Arguments: @keyset *ks@ = pointer to a keyset
+ * @unsigned ty@ = expected type code
+ * @buf *b@ = pointer to an input buffer
+ * @buf *bb@ = pointer to an output buffer
+ *
+ * Returns: Zero on success, or nonzero if there was some problem.
+ *
+ * Use: Attempts to decrypt a message using a given key. Note that
+ * requesting decryption with a key directly won't clear a
+ * marking that it's not for encryption.
+ */
+
+extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/,
+ buf */*b*/, buf */*bb*/);
+
+/* --- @ksl_free@ --- *
*
* Arguments: @keyset **ksroot@ = pointer to keyset list head
*
* Returns: ---
*
- * Use: Frees all of the keys in a keyset.
+ * Use: Frees (releases references to) all of the keys in a keyset.
*/
-extern void ks_free(keyset **/*ksroot*/);
+extern void ksl_free(keyset **/*ksroot*/);
-/* --- @ks_prune@ --- *
+/* --- @ksl_link@ --- *
*
* Arguments: @keyset **ksroot@ = pointer to keyset list head
+ * @keyset *ks@ = pointer to a keyset
*
* Returns: ---
*
- * Use: Prunes the keyset list by removing keys which mustn't be used
- * any more.
+ * Use: Links a keyset into a list. A keyset can only be on one list
+ * at a time. Bad things happen otherwise.
*/
-extern void ks_prune(keyset **/*ksroot*/);
+extern void ksl_link(keyset **/*ksroot*/, keyset */*ks*/);
-/* --- @ks_gen@ --- *
+/* --- @ksl_prune@ --- *
*
* Arguments: @keyset **ksroot@ = pointer to keyset list head
- * @const void *k@ = pointer to key material
- * @size_t sz@ = size of the key material
*
- * Returns: The regeneration time for the new key.
+ * Returns: ---
*
- * Use: Derives a keyset from the given key material and adds it to
- * the list.
+ * Use: Prunes the keyset list by removing keys which mustn't be used
+ * any more.
*/
-extern time_t ks_gen(keyset **/*ksroot*/, const void */*k*/, size_t /*sz*/);
+extern void ksl_prune(keyset **/*ksroot*/);
-/* --- @ks_encrypt@ --- *
+/* --- @ksl_encrypt@ --- *
*
* Arguments: @keyset **ksroot@ = pointer to keyset list head
+ * @unsigned ty@ = message type
* @buf *b@ = pointer to input buffer
* @buf *bb@ = pointer to output buffer
*
* Use: Encrypts a packet.
*/
-extern int ks_encrypt(keyset **/*ksroot*/, buf */*b*/, buf */*bb*/);
+extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
+ buf */*b*/, buf */*bb*/);
-/* --- @ks_decrypt@ --- *
+/* --- @ksl_decrypt@ --- *
*
* Arguments: @keyset **ksroot@ = pointer to keyset list head
+ * @unsigned ty@ = expected type code
* @buf *b@ = pointer to input buffer
* @buf *bb@ = pointer to output buffer
*
* Use: Decrypts a packet.
*/
-extern int ks_decrypt(keyset **/*ksroot*/, buf */*b*/, buf */*bb*/);
+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: ---
extern void p_interval(void);
+/* --- @p_stats@ --- *
+ *
+ * Arguments: @peer *p@ = pointer to a peer block
+ *
+ * Returns: A pointer to the peer's statistics.
+ */
+
+extern stats *p_stats(peer */*p*/);
+
/* --- @p_ifname@ --- *
*
* Arguments: @peer *p@ = pointer to a peer block
/* --- @p_init@ --- *
*
- * Arguments: @unsigned port@ = port number to listen to
+ * Arguments: @struct in_addr addr@ = address to bind to
+ * @unsigned port@ = port number to listen to
*
* Returns: ---
*
* Use: Initializes the peer system; creates the socket.
*/
-extern void p_init(unsigned /*port*/);
+extern void p_init(struct in_addr /*addr*/, unsigned /*port*/);
/* --- @p_port@ --- *
*
/* --- @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.
- */
-
-extern void tun_inject(tunnel */*t*/, buf */*b*/);
-
-/* --- @tun_destroy@ --- *
- *
- * Arguments: @tunnel *t@ = pointer to tunnel block
- *
- * Returns: ---
- *
- * Use: Destroys a tunnel.
- */
-
-extern void tun_destroy(tunnel */*t*/);
-
-/*----- Buffer handling ---------------------------------------------------*/
-
-/* --- Useful macros --- */
-
-#define BBASE(b) ((b)->base)
-#define BLIM(b) ((b)->limit)
-#define BCUR(b) ((b)->p)
-#define BSZ(b) ((b)->limit - (b)->base)
-#define BLEN(b) ((b)->p - (b)->base)
-#define BLEFT(b) ((b)->limit - (b)->p)
-#define BSTEP(b, sz) ((b)->p += (sz))
-#define BBAD(b) ((b)->f & BF_BROKEN)
-#define BOK(b) (!BBAD(b))
-
-#define BENSURE(b, sz) \
- (BBAD(b) ? -1 : (sz) > BLEFT(b) ? (b)->f |= BF_BROKEN, -1 : 0)
-
-/* --- @buf_init@ --- *
- *
- * Arguments: @buf *b@ = pointer to a buffer block
- * @void *p@ = pointer to a buffer
- * @size_t sz@ = size of the buffer
- *
- * Returns: ---
- *
- * Use: Initializes the buffer block appropriately.
- */
-
-extern void buf_init(buf */*b*/, void */*p*/, size_t /*sz*/);
-
-/* --- @buf_break@ --- *
- *
- * Arguments: @buf *b@ = pointer to a buffer block
- *
- * Returns: Some negative value.
- *
- * Use: Marks a buffer as broken.
- */
-
-extern int buf_break(buf */*b*/);
-
-/* --- @buf_ensure@ --- *
- *
- * Arguments: @buf *b@ = pointer to a buffer block
- * @size_t sz@ = size of data wanted
- *
- * Returns: Zero if it worked, nonzero if there wasn't enough space.
- *
- * Use: Ensures that there are @sz@ bytes still in the buffer.
- */
-
-extern int buf_ensure(buf */*b*/, size_t /*sz*/);
-
-/* --- @buf_get@ --- *
- *
- * Arguments: @buf *b@ = pointer to a buffer block
- * @void *p@ = pointer to a buffer
- * @size_t sz@ = size of the buffer
- *
- * Returns: Zero if it worked, nonzero if there wasn't enough data.
- *
- * Use: Fetches data from the buffer into some other place.
- */
-
-extern int buf_get(buf */*b*/, void */*p*/, size_t /*sz*/);
+#ifdef TUN_LINUX
+ extern const tunnel_ops tun_linux;
+#endif
-/* --- @buf_put@ --- *
- *
- * Arguments: @buf *b@ = pointer to a buffer block
- * @const void *p@ = pointer to a buffer
- * @size_t sz@ = size of the buffer
- *
- * Returns: Zero if it worked, nonzero if there wasn't enough space.
- *
- * Use: Fetches data from some place and puts it in the buffer
- */
+#ifdef TUN_UNET
+ extern const tunnel_ops tun_unet;
+#endif
-extern int buf_put(buf */*b*/, const void */*p*/, size_t /*sz*/);
+#ifdef TUN_BSD
+ extern const tunnel_ops tun_bsd;
+#endif
-/* --- @buf_getbyte@ --- *
- *
- * Arguments: @buf *b@ = pointer to a buffer block
- *
- * Returns: A byte, or less than zero if there wasn't a byte there.
- *
- * Use: Gets a single byte from a buffer.
- */
+extern const tunnel_ops tun_slip;
-extern int buf_getbyte(buf */*b*/);
+/*----- Other handy utilities ---------------------------------------------*/
-/* --- @buf_putbyte@ --- *
+/* --- @mpstr@ --- *
*
- * Arguments: @buf *b@ = pointer to a buffer block
- * @int ch@ = byte to write
+ * Arguments: @mp *m@ = a multiprecision integer
*
- * Returns: Zero if OK, nonzero if there wasn't enough space.
+ * Returns: A pointer to the integer's textual representation.
*
- * Use: Puts a single byte in a buffer.
+ * Use: Converts a multiprecision integer to a string. Corrupts
+ * @buf_t@.
*/
-extern int buf_putbyte(buf */*b*/, int /*ch*/);
+extern const char *mpstr(mp */*m*/);
-/* --- @buf_getword@ --- *
+/* --- @gestr@ --- *
*
- * Arguments: @buf *b@ = pointer to a buffer block
- * @uint32 *w@ = where to put the word
+ * Arguments: @group *g@ = a group
+ * @ge *x@ = a group element
*
- * Returns: Zero if OK, or nonzero if there wasn't a word there.
+ * Returns: A pointer to the element's textual representation.
*
- * Use: Gets a 32-bit word from a buffer.
+ * Use: Converts a group element to a string. Corrupts
+ * @buf_t@.
*/
-extern int buf_getword(buf */*b*/, uint32 */*w*/);
+extern const char *gestr(group */*g*/, ge */*x*/);
-/* --- @buf_putword@ --- *
+/* --- @timestr@ --- *
*
- * Arguments: @buf *b@ = pointer to a buffer block
- * @uint32 w@ = word to write
+ * Arguments: @time_t t@ = a time to convert
*
- * Returns: Zero if OK, nonzero if there wasn't enough space.
+ * Returns: A pointer to a textual representation of the time.
*
- * Use: Puts a 32-but word in a buffer.
+ * Use: Converts a time to a textual representation. Corrupts
+ * @buf_t@.
*/
-extern int buf_putword(buf */*b*/, uint32 /*w*/);
+extern const char *timestr(time_t /*t*/);
-/* --- @buf_getmp@ --- *
+/* --- @mystrieq@ --- *
*
- * Arguments: @buf *b@ = pointer to a buffer block
+ * Arguments: @const char *x, *y@ = two strings
*
- * Returns: A multiprecision integer, or null if there wasn't one there.
- *
- * Use: Gets a multiprecision integer from a buffer.
+ * Returns: True if @x@ and @y are equal, up to case.
*/
-extern mp *buf_getmp(buf */*b*/, mp */*d*/);
+extern int mystrieq(const char */*x*/, const char */*y*/);
-/* --- @buf_putmp@ --- *
+/* --- @seq_reset@ --- *
*
- * Arguments: @buf *b@ = pointer to a buffer block
- * @mp *m@ = a multiprecision integer
+ * Arguments: @seqwin *s@ = sequence-checking window
*
- * Returns: Zero if it worked, nonzero if there wasn't enough space.
+ * Returns: ---
*
- * Use: Puts a multiprecision integer to a buffer.
+ * Use: Resets a sequence number window.
*/
-extern int buf_putmp(buf */*b*/, mp */*m*/);
+extern void seq_reset(seqwin */*s*/);
-/*----- Other handy utilities ---------------------------------------------*/
-
-/* --- @mpstr@ --- *
+/* --- @seq_check@ --- *
*
- * Arguments: @mp *m@ = a multiprecision integer
+ * Arguments: @seqwin *s@ = sequence-checking window
+ * @uint32 q@ = sequence number to check
+ * @const char *service@ = service to report message from
*
- * Returns: A pointer to the integer's textual representation.
+ * Returns: A @SEQ_@ code.
*
- * Use: Converts a multiprecision integer to a string. Corrupts
- * @buf_o@.
+ * Use: Checks a sequence number against the window, updating things
+ * as necessary.
*/
-extern const char *mpstr(mp */*m*/);
+extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
/*----- That's all, folks -------------------------------------------------*/
~mdw / tripe / blobdiff