X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/tripe/blobdiff_plain/52307feec17cefc54d626f7737f650675eefab96..9317aa9290393480e8004bd443c38b5faa5f6f0c:/tripe.h diff --git a/tripe.h b/tripe.h index f3816b40..5f62f16d 100644 --- a/tripe.h +++ b/tripe.h @@ -1,6 +1,6 @@ /* -*-c-*- * - * $Id: tripe.h,v 1.7 2001/03/03 12:07:08 mdw Exp $ + * $Id$ * * Main header file for TrIPE * @@ -26,33 +26,6 @@ * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -/*----- Revision history --------------------------------------------------* - * - * $Log: tripe.h,v $ - * Revision 1.7 2001/03/03 12:07:08 mdw - * Rename word get and put functions now that there's 16-bit support. - * - * Revision 1.6 2001/02/19 19:11:09 mdw - * Output buffering on admin connections. - * - * Revision 1.5 2001/02/16 21:41:43 mdw - * Major changes. See source files for details. - * - * Revision 1.4 2001/02/05 19:56:37 mdw - * Sequence number protection, and BSD tunnels. - * - * Revision 1.3 2001/02/04 01:17:55 mdw - * Create a configuration header file to tidy up command lines. - * - * 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 @@ -67,6 +40,7 @@ #include #include #include +#include #include #include #include @@ -92,6 +66,7 @@ #include #include +#include #include #include #include @@ -106,6 +81,9 @@ #include #include #include +#include + +#include #include #include @@ -117,22 +95,19 @@ #include #include -#include #include #include +#include +#include +#include +#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 @@ -143,8 +118,9 @@ #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 --- */ @@ -156,111 +132,25 @@ #define PKBUFSZ 65536 -/*----- TrIPE protocol ----------------------------------------------------*/ - -/* --- TrIPE message format --- * - * - * A packet begins with a single-byte message type. The top four bits are a - * category code used to send the message to the right general place in the - * code; the bottom bits identify the actual message type. - */ - -#define MSG_CATMASK 0xf0 -#define MSG_TYPEMASK 0x0f - -/* --- Encrypted message packets --- * - * - * Messages of category @MSG_PACKET@ contain encrypted network packets. The - * message content is a symmetric-encrypted block (see below). Reception of - * a packet encrypted under a new key implicitly permits that key to be used - * to send further packets. - * - * The only packet type accepted is zero. - * - * Packets may be encrypted under any live keyset, but should use the most - * recent one. - */ - -#define MSG_PACKET 0x00 - -/* --- Key exchange packets --- */ - -#define MSG_KEYEXCH 0x10 - -#define KX_PRECHAL 0u -#define KX_COOKIE 1u -#define KX_CHAL 2u -#define KX_REPLY 3u -#define KX_SWITCH 4u -#define KX_SWITCHOK 5u -#define KX_NMSG 6u - -/* --- Symmetric encryption and keysets --- * - * - * Packets consist of a 64-bit MAC, a 32-bit sequence number, and the - * encrypted payload. - * - * The MAC is computed using the HMAC construction with RIPEMD160 over the - * sequence number and the original packet plaintext; the first 64 bits of - * the output are used. - * - * The plaintext is encrypted using Blowfish in CBC mode with ciphertext - * stealing (as described in [Schneier]. The initialization vector is - * precisely the 64-bit MAC computed previously. - * - * A keyset consists of - * - * * an integrity (MAC) key; - * * a confidentiality (encryption) key; and - * * a sequence numbering space - * - * in each direction. The packets sent by a host encrypted under a - * particular keyset are assigned consecutive sequence numbers starting from - * zero. The receiving host must ensure that it only accepts each packet at - * most once. It should maintain a window of sequence numbers: packets with - * numbers beyond the end of the window are accepted and cause the window to - * be advanced; packets with numbers before the start of the window are - * rejected; packets with numbers which appear within the window are accepted - * only if the number has not been seen before. - * - * When a host sends a @KX_SWITCH@ or @KX_SWITCHOK@ message, it installs the - * newly-negotiated keyset in a `listen-only' state: it may not send a packet - * encrypted under the keyset until either it has received a @KX_SWITCH@ or - * @KX_SWITCHOK@ message, or a @MSG_PACKET@ encrypted under the keyset, from - * its peer. - */ - /*----- Cipher selections -------------------------------------------------*/ -#include -#include -#include -#include - -#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; -/*----- Data structures ---------------------------------------------------*/ - -/* --- Buffers --- * - * - * Buffers provide a simple stream-like interface for building and parsing - * packets. - */ +#define MAXHASHSZ 64 /* Largest possible hash size */ -typedef struct buf { - octet *base, *p, *limit; /* Pointers to the buffer */ - unsigned f; /* Various flags */ -} buf; +#define HASH_STRING(h, s) GH_HASH((h), (s), sizeof(s)) -#define BF_BROKEN 1u /* Buffer is broken */ +/*----- Data structures ---------------------------------------------------*/ /* --- Socket addresses --- * * @@ -272,6 +162,15 @@ typedef union addr { 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 @@ -288,18 +187,18 @@ typedef union addr { 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 */ 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 */ @@ -317,17 +216,17 @@ typedef struct keyset { typedef struct kxchal { struct keyexch *kx; /* Pointer back to key exchange */ - mp *c; /* Responder's challenge */ - mp *r; /* My reply to the challenge */ + 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[HASHSZ]; /* Hash of his challenge */ - octet hrx[HASHSZ]; /* My expected reply hash */ - 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 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 { @@ -336,17 +235,20 @@ typedef struct keyexch { 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 */ + ge *kpub; /* Peer's public key */ + time_t texp_kpub; /* Expiry time for public key */ mp *alpha; /* My temporary secret */ - mp *c; /* My challenge */ - mp *rx; /* The expected response */ + ge *c; /* My challenge */ + 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; #define KXF_TIMER 1u /* Waiting for a timer to go off */ +#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) */ @@ -360,18 +262,21 @@ enum { * 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 */ -#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 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 --- * * @@ -385,7 +290,7 @@ 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; /* 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 */ @@ -397,18 +302,45 @@ typedef struct stats { * 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 @@ -419,32 +351,85 @@ typedef struct obuf { 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 sel_state sel; /* Global I/O event state */ -extern dh_priv kpriv; /* Our private key */ -extern mpmont mg; /* Montgomery context for DH group */ +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 */ @@ -457,16 +442,16 @@ extern unsigned tr_flags; /* Trace options flags */ /*----- 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@ --- * * @@ -485,20 +470,23 @@ extern void km_init(const char */*kr_priv*/, const char */*kr_pub*/, /* --- @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: --- * @@ -507,7 +495,7 @@ extern int km_getpubkey(const char */*tag*/, dh_pub */*kpub*/); * 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@ --- * * @@ -581,6 +569,7 @@ extern void ks_drop(keyset */*ks*/); * * 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. * @@ -600,7 +589,8 @@ extern void ks_drop(keyset */*ks*/); */ extern keyset *ks_gen(const void */*k*/, - size_t /*x*/, size_t /*y*/, size_t /*z*/); + size_t /*x*/, size_t /*y*/, size_t /*z*/, + peer */*p*/); /* --- @ks_tregen@ --- * * @@ -626,6 +616,7 @@ 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 * @@ -639,11 +630,13 @@ extern void ks_activate(keyset */*ks*/); * used even if it's marked as not for data output. */ -extern int ks_encrypt(keyset */*ks*/, buf */*b*/, buf */*bb*/); +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 * @@ -654,7 +647,8 @@ extern int ks_encrypt(keyset */*ks*/, buf */*b*/, buf */*bb*/); * marking that it's not for encryption. */ -extern int ks_decrypt(keyset */*ks*/, buf */*b*/, buf */*bb*/); +extern int ks_decrypt(keyset */*ks*/, unsigned /*ty*/, + buf */*b*/, buf */*bb*/); /* --- @ksl_free@ --- * * @@ -695,6 +689,7 @@ extern void ksl_prune(keyset **/*ksroot*/); /* --- @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 * @@ -703,11 +698,13 @@ extern void ksl_prune(keyset **/*ksroot*/); * Use: Encrypts a packet. */ -extern int ksl_encrypt(keyset **/*ksroot*/, buf */*b*/, buf */*bb*/); +extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/, + buf */*b*/, buf */*bb*/); /* --- @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 * @@ -716,10 +713,37 @@ extern int ksl_encrypt(keyset **/*ksroot*/, buf */*b*/, buf */*bb*/); * Use: Decrypts a packet. */ -extern int ksl_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 @@ -732,16 +756,29 @@ extern int ksl_decrypt(keyset **/*ksroot*/, buf */*b*/, buf */*bb*/); 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@ --- * * @@ -802,6 +839,50 @@ extern buf *p_txstart(peer */*p*/, unsigned /*msg*/); 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 @@ -814,6 +895,17 @@ extern void p_txend(peer */*p*/); 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: --- @@ -854,14 +946,15 @@ extern const addr *p_addr(peer */*p*/); /* --- @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@ --- * * @@ -874,9 +967,7 @@ unsigned p_port(void); /* --- @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. * @@ -884,18 +975,28 @@ unsigned p_port(void); * 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 @@ -930,274 +1031,94 @@ extern void p_destroy(peer */*p*/); extern peer *p_first(void); extern peer *p_next(peer */*p*/); -/*----- Tunnel interface --------------------------------------------------*/ +/*----- Tunnel drivers ----------------------------------------------------*/ -/* --- @tun_init@ --- * - * - * Arguments: --- - * - * Returns: --- - * - * Use: Initializes the tunneling system. Maybe this will require - * opening file descriptors or something. - */ - -extern void tun_init(void); +#ifdef TUN_LINUX + extern const tunnel_ops tun_linux; +#endif -/* --- @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. - */ +#ifdef TUN_UNET + extern const tunnel_ops tun_unet; +#endif -extern int tun_create(tunnel */*t*/, peer */*p*/); +#ifdef TUN_BSD + extern const tunnel_ops tun_bsd; +#endif -/* --- @tun_ifname@ --- * - * - * Arguments: @tunnel *t@ = pointer to tunnel block - * - * Returns: A pointer to the tunnel's interface name. - */ +extern const tunnel_ops tun_slip; -extern const char *tun_ifname(tunnel */*t*/); +/*----- Other handy utilities ---------------------------------------------*/ -/* --- @tun_inject@ --- * +/* --- @mpstr@ --- * * - * Arguments: @tunnel *t@ = pointer to tunnel block - * @buf *b@ = buffer to send + * Arguments: @mp *m@ = a multiprecision integer * - * Returns: --- + * Returns: A pointer to the integer's textual representation. * - * Use: Injects a packet into the local network stack. + * Use: Converts a multiprecision integer to a string. Corrupts + * @buf_t@. */ -extern void tun_inject(tunnel */*t*/, buf */*b*/); +extern const char *mpstr(mp */*m*/); -/* --- @tun_destroy@ --- * +/* --- @gestr@ --- * * - * Arguments: @tunnel *t@ = pointer to tunnel block + * Arguments: @group *g@ = a group + * @ge *x@ = a group element * - * Returns: --- + * Returns: A pointer to the element's textual representation. * - * Use: Destroys a tunnel. + * Use: Converts a group element to a string. Corrupts + * @buf_t@. */ -extern void tun_destroy(tunnel */*t*/); - -/*----- Buffer handling ---------------------------------------------------*/ - -/* --- Useful macros --- */ +extern const char *gestr(group */*g*/, ge */*x*/); -#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@ --- * +/* --- @timestr@ --- * * - * Arguments: @buf *b@ = pointer to a buffer block - * @void *p@ = pointer to a buffer - * @size_t sz@ = size of the buffer + * Arguments: @time_t t@ = a time to convert * - * Returns: --- + * Returns: A pointer to a textual representation of the time. * - * Use: Initializes the buffer block appropriately. + * Use: Converts a time to a textual representation. Corrupts + * @buf_t@. */ -extern void buf_init(buf */*b*/, void */*p*/, size_t /*sz*/); +extern const char *timestr(time_t /*t*/); -/* --- @buf_break@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block +/* --- @mystrieq@ --- * * - * Returns: Some negative value. + * Arguments: @const char *x, *y@ = two strings * - * Use: Marks a buffer as broken. + * Returns: True if @x@ and @y are equal, up to case. */ -extern int buf_break(buf */*b*/); +extern int mystrieq(const char */*x*/, const char */*y*/); -/* --- @buf_flip@ --- * +/* --- @seq_reset@ --- * * - * Arguments: @buf *b@ = pointer to a buffer block + * Arguments: @seqwin *s@ = sequence-checking window * * Returns: --- * - * Use: Flips a buffer so that if you've just been writing to it, - * you can now read from the bit you've written. - */ - -extern void buf_flip(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. + * Use: Resets a sequence number window. */ -extern int buf_ensure(buf */*b*/, size_t /*sz*/); +extern void seq_reset(seqwin */*s*/); -/* --- @buf_get@ --- * +/* --- @seq_check@ --- * * - * Arguments: @buf *b@ = pointer to a buffer block - * @size_t sz@ = size of the buffer + * Arguments: @seqwin *s@ = sequence-checking window + * @uint32 q@ = sequence number to check + * @const char *service@ = service to report message from * - * Returns: Pointer to the place in the buffer. + * Returns: A @SEQ_@ code. * - * Use: Reserves a space in the buffer of the requested size, and - * returns its start address. + * Use: Checks a sequence number against the window, updating things + * as necessary. */ -extern void *buf_get(buf */*b*/, size_t /*sz*/); - -/* --- @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 - */ - -extern int buf_put(buf */*b*/, const void */*p*/, size_t /*sz*/); - -/* --- @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 int buf_getbyte(buf */*b*/); - -/* --- @buf_putbyte@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @int ch@ = byte to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Puts a single byte in a buffer. - */ - -extern int buf_putbyte(buf */*b*/, int /*ch*/); - -/* --- @buf_getu16@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint16 *w@ = where to put the word - * - * Returns: Zero if OK, or nonzero if there wasn't a word there. - * - * Use: Gets a 16-bit word from a buffer. - */ - -extern int buf_getu16(buf */*b*/, uint16 */*w*/); - -/* --- @buf_putu16@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint16 w@ = word to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Puts a 16-but word in a buffer. - */ - -extern int buf_putu16(buf */*b*/, uint16 /*w*/); - -/* --- @buf_getu32@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint32 *w@ = where to put the word - * - * Returns: Zero if OK, or nonzero if there wasn't a word there. - * - * Use: Gets a 32-bit word from a buffer. - */ - -extern int buf_getu32(buf */*b*/, uint32 */*w*/); - -/* --- @buf_putu32@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @uint32 w@ = word to write - * - * Returns: Zero if OK, nonzero if there wasn't enough space. - * - * Use: Puts a 32-but word in a buffer. - */ - -extern int buf_putu32(buf */*b*/, uint32 /*w*/); - -/* --- @buf_getmp@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * - * Returns: A multiprecision integer, or null if there wasn't one there. - * - * Use: Gets a multiprecision integer from a buffer. - */ - -extern mp *buf_getmp(buf */*b*/); - -/* --- @buf_putmp@ --- * - * - * Arguments: @buf *b@ = pointer to a buffer block - * @mp *m@ = a multiprecision integer - * - * Returns: Zero if it worked, nonzero if there wasn't enough space. - * - * Use: Puts a multiprecision integer to a buffer. - */ - -extern int buf_putmp(buf */*b*/, mp */*m*/); - -/*----- Other handy utilities ---------------------------------------------*/ - -/* --- @mpstr@ --- * - * - * Arguments: @mp *m@ = a multiprecision integer - * - * Returns: A pointer to the integer's textual representation. - * - * Use: Converts a multiprecision integer to a string. Corrupts - * @buf_t@. - */ - -extern const char *mpstr(mp */*m*/); - -/* --- @timestr@ --- * - * - * Arguments: @time_t t@ = a time to convert - * - * Returns: A pointer to a textual representation of the time. - * - * Use: Converts a time to a textual representation. Corrupts - * @buf_t@. - */ - -extern const char *timestr(time_t /*t*/); +extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/); /*----- That's all, folks -------------------------------------------------*/