chiark / gitweb /
peer, tunnels: New file-descriptor opening interface.
[tripe] / server / tripe.h
index 1d13f32d99180a444c004c1c7362baf371167497..d955c88ee20b63244ea5636cfb87d9d7556860e3 100644 (file)
@@ -1,13 +1,11 @@
 /* -*-c-*-
- *
- * $Id$
  *
  * Main header file for TrIPE
  *
  * (c) 2001 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of Trivial IP Encryption (TrIPE).
  *
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * TrIPE is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with TrIPE; if not, write to the Free Software Foundation,
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 #include <mLib/arena.h>
 #include <mLib/base64.h>
 #include <mLib/bres.h>
+#include <mLib/daemonize.h>
 #include <mLib/dstr.h>
 #include <mLib/env.h>
 #include <mLib/fdflags.h>
 #include <mLib/fwatch.h>
+#include <mLib/hash.h>
+#include <mLib/macros.h>
 #include <mLib/mdwopt.h>
 #include <mLib/quis.h>
 #include <mLib/report.h>
@@ -82,6 +83,7 @@
 #include <mLib/sub.h>
 #include <mLib/trace.h>
 #include <mLib/tv.h>
+#include <mLib/versioncmp.h>
 
 #include <catacomb/buf.h>
 
 #include <catacomb/group.h>
 
 #include "protocol.h"
+#include "slip.h"
 #include "util.h"
 
 #undef sun
@@ -141,6 +144,7 @@ typedef struct algswitch {
   const gcmac *m;                      /* Message authentication code */
   size_t hashsz;                       /* Hash output size */
   size_t tagsz;                                /* Length to truncate MAC tags */
+  size_t expsz;                                /* Size of data to process */
   size_t cksz, mksz;                   /* Key lengths for @c@ and @m@ */
 } algswitch;
 
@@ -162,6 +166,18 @@ typedef union addr {
   struct sockaddr_in sin;
 } addr;
 
+/* --- Mapping keyed on addresses --- */
+
+typedef struct addrmap {
+  hash_table t;
+  size_t load;
+} addrmap;
+
+typedef struct addrmap_base {
+  hash_base b;
+  addr a;
+} addrmap_base;
+
 /* --- Sequence number checking --- */
 
 typedef struct seqwin {
@@ -189,12 +205,12 @@ typedef struct keyset {
   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 */
+  unsigned long sz_exp, sz_regen;      /* Data limits for the keyset */
   T( unsigned seq; )                   /* Sequence number for tracing */
   unsigned f;                          /* Various useful flags */
-  gcipher *cin, *cout;                         /* Keyset ciphers for encryption */
+  gcipher *cin, *cout;                 /* Keyset ciphers for encryption */
   size_t tagsz;                                /* Length to truncate MAC tags */
-  gmac *min, *mout;                    /* Keyset MACs for integrity */
+  gmac *min, *mout;                    /* Keyset MACs for integrity */
   uint32 oseq;                         /* Outbound sequence number */
   seqwin iseq;                         /* Inbound sequence number */
 } keyset;
@@ -202,6 +218,10 @@ typedef struct keyset {
 #define KSF_LISTEN 1u                  /* Don't encrypt packets yet */
 #define KSF_LINK 2u                    /* Key is in a linked list */
 
+#define KSERR_REGEN -1                 /* Regenerate keys */
+#define KSERR_NOKEYS -2                        /* No keys left */
+#define KSERR_DECRYPT -3               /* Unable to decrypt message */
+
 /* --- Key exchange --- *
  *
  * TrIPE uses the Wrestlers Protocol for its key exchange.  The Wrestlers
@@ -248,6 +268,7 @@ typedef struct 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 */
+#define KXF_CORK 8u                    /* Don't send anything yet */
 
 enum {
   KXS_DEAD,                            /* Uninitialized state (magical) */
@@ -267,8 +288,11 @@ 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 */
+  int (*open)(char **/*ifn*/);         /* Open tunnel and report ifname */
+  tunnel *(*create)(struct peer */*p*/, int /*fd*/, char **/*ifn*/);
+                                       /* Initializes a new tunnel */
+  void (*setifname)(tunnel */*t*/, const char */*ifn*/);
+                                       /*  Notifies ifname change */
   void (*inject)(tunnel */*t*/, buf */*b*/); /* Sends packet through if */
   void (*destroy)(tunnel */*t*/);      /* Destroys a tunnel */
 } tunnel_ops;
@@ -307,10 +331,22 @@ typedef struct peerspec {
   unsigned long t_ka;                  /* Keep alive interval */
   addr sa;                             /* Socket address to speak to */
   size_t sasz;                         /* Socket address size */
+  unsigned kxf;                                /* Key exchange flags to set */
 } peerspec;
 
+typedef struct peer_byname {
+  sym_base _b;
+  struct peer *p;
+} peer_byname;
+
+typedef struct peer_byaddr {
+  addrmap_base _b;
+  struct peer *p;
+} peer_byaddr;
+
 typedef struct peer {
-  struct peer *next, *prev;            /* Links to next and previous */
+  peer_byname *byname;                 /* Lookup-by-name block */
+  peer_byaddr *byaddr;                 /* Lookup-by-address block */
   struct ping *pings;                  /* Pings we're waiting for */
   peerspec spec;                       /* Specifications for this peer */
   tunnel *t;                           /* Tunnel for local packets */
@@ -322,6 +358,8 @@ typedef struct peer {
   sel_timer tka;                       /* Timer for keepalives */
 } peer;
 
+typedef struct peer_iter { sym_iter i; } peer_iter;
+
 typedef struct ping {
   struct ping *next, *prev;            /* Links to next and previous */
   peer *p;                             /* Peer so we can free it */
@@ -403,7 +441,7 @@ typedef struct admin_service {
 typedef struct admin_svcop {
   admin_bgop bg;                       /* Background operation header */
   struct admin *prov;                  /* Client servicing this job */
-  unsigned short index;                        /* This job's index */
+  unsigned index;                      /* This job's index */
   struct admin_svcop *next, *prev;     /* Links for provider's jobs */
 } admin_svcop;
 
@@ -445,6 +483,7 @@ typedef struct admin {
 #ifndef NTRACE
   #define AF_TRACE 16u                 /* Catch tracing */
 #endif
+#define AF_FOREGROUND 32u              /* Quit server when client closes */
 
 #ifndef NTRACE
 #  define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
@@ -459,7 +498,7 @@ extern group *gg;                   /* The group we work in */
 extern size_t indexsz;                 /* Size of exponent for the group */
 extern mp *kpriv;                      /* Our private key */
 extern ge *kpub;                       /* Our public key */
-extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ];
+extern octet buf_i[PKBUFSZ], buf_o[PKBUFSZ], buf_t[PKBUFSZ], buf_u[PKBUFSZ];
 extern const tunnel_ops *tunnels[];    /* Table of tunnels (0-term) */
 extern const tunnel_ops *tun_default;  /* Default tunnel to use */
 
@@ -573,6 +612,7 @@ extern void kx_newkeys(keyexch */*kx*/);
  * Arguments:  @keyexch *kx@ = pointer to key exchange context
  *             @peer *p@ = pointer to peer context
  *             @keyset **ks@ = pointer to keyset list
+ *             @unsigned f@ = various useful flags
  *
  * Returns:    Zero if OK, nonzero if it failed.
  *
@@ -581,7 +621,8 @@ extern void kx_newkeys(keyexch */*kx*/);
  *             exchange.
  */
 
-extern int kx_init(keyexch */*kx*/, peer */*p*/, keyset **/*ks*/);
+extern int kx_init(keyexch */*kx*/, peer */*p*/,
+                  keyset **/*ks*/, unsigned /*f*/);
 
 /*----- Keysets and symmetric cryptography --------------------------------*/
 
@@ -652,9 +693,10 @@ extern void ks_activate(keyset */*ks*/);
  *             @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.
+ * Returns:    Zero if successful; @KSERR_REGEN@ if we should negotiate a
+ *             new key; @KSERR_NOKEYS@ if the key is not usable.  Also
+ *             returns zero if there was insufficient buffer (but the output
+ *             buffer is broken in this case).
  *
  * Use:                Encrypts a block of data using the key.  Note that the `key
  *             ought to be replaced' notification is only ever given once
@@ -672,7 +714,9 @@ extern int ks_encrypt(keyset */*ks*/, unsigned /*ty*/,
  *             @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.
+ * Returns:    Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
+ *             zero if there was insufficient buffer (but the output buffer
+ *             is broken in this case).
  *
  * Use:                Attempts to decrypt a message using a given key.  Note that
  *             requesting decryption with a key directly won't clear a
@@ -725,7 +769,10 @@ extern void ksl_prune(keyset **/*ksroot*/);
  *             @buf *b@ = pointer to input buffer
  *             @buf *bb@ = pointer to output buffer
  *
- * Returns:    Nonzero if a new key is needed.
+ * Returns:    Zero if successful; @KSERR_REGEN@ if it's time to negotiate a
+ *             new key; @KSERR_NOKEYS@ if there are no suitable keys
+ *             available.  Also returns zero if there was insufficient
+ *             buffer space (but the output buffer is broken in this case).
  *
  * Use:                Encrypts a packet.
  */
@@ -740,7 +787,9 @@ extern int ksl_encrypt(keyset **/*ksroot*/, unsigned /*ty*/,
  *             @buf *b@ = pointer to input buffer
  *             @buf *bb@ = pointer to output buffer
  *
- * Returns:    Nonzero if the packet couldn't be decrypted.
+ * Returns:    Zero on success; @KSERR_DECRYPT@ on failure.  Also returns
+ *             zero if there was insufficient buffer (but the output buffer
+ *             is broken in this case).
  *
  * Use:                Decrypts a packet.
  */
@@ -858,6 +907,60 @@ extern void a_daemon(void);
 
 extern void a_init(const char */*sock*/);
 
+/*----- Mapping with addresses as keys ------------------------------------*/
+
+/* --- @am_create@ --- *
+ *
+ * Arguments:  @addrmap *m@ = pointer to map
+ *
+ * Returns:    ---
+ *
+ * Use:                Create an address map, properly set up.
+ */
+
+extern void am_create(addrmap */*m*/);
+
+/* --- @am_destroy@ --- *
+ *
+ * Arguments:  @addrmap *m@ = pointer to map
+ *
+ * Returns:    ---
+ *
+ * Use:                Destroy an address map, throwing away all the entries.
+ */
+
+extern void am_destroy(addrmap */*m*/);
+
+/* --- @am_find@ --- *
+ *
+ * Arguments:  @addrmap *m@ = pointer to map
+ *             @const addr *a@ = address to look up
+ *             @size_t sz@ = size of block to allocate
+ *             @unsigned *f@ = where to store flags
+ *
+ * Returns:    Pointer to found item, or null.
+ *
+ * Use:                Finds a record with the given IP address, set @*f@ nonzero
+ *             and returns it.  If @sz@ is zero, and no match was found,
+ *             return null; otherwise allocate a new block of @sz@ bytes,
+ *             clear @*f@ to zero and return the block pointer.
+ */
+
+extern void *am_find(addrmap */*m*/, const addr */*a*/,
+                    size_t /*sz*/, unsigned */*f*/);
+
+/* --- @am_remove@ --- *
+ *
+ * Arguments:  @addrmap *m@ = pointer to map
+ *             @void *i@ = pointer to the item
+ *
+ * Returns:    ---
+ *
+ * Use:                Removes an item from the map.
+ */
+
+extern void am_remove(addrmap */*m*/, void */*i*/);
+
 /*----- Peer management ---------------------------------------------------*/
 
 /* --- @p_txstart@ --- *
@@ -1054,6 +1157,17 @@ extern const char *p_name(peer */*p*/);
 
 extern const peerspec *p_spec(peer */*p*/);
 
+/* --- @p_findbyaddr@ --- *
+ *
+ * Arguments:  @const addr *a@ = address to look up
+ *
+ * Returns:    Pointer to the peer block, or null if not found.
+ *
+ * Use:                Finds a peer by address.
+ */
+
+extern peer *p_findbyaddr(const addr */*a*/);
+
 /* --- @p_find@ --- *
  *
  * Arguments:  @const char *name@ = name to look up
@@ -1076,17 +1190,41 @@ extern peer *p_find(const char */*name*/);
 
 extern void p_destroy(peer */*p*/);
 
-/* --- @p_first@, @p_next@ --- *
+/* --- @FOREACH_PEER@ --- *
+ *
+ * Arguments:  @p@ = name to bind to each peer
+ *             @stuff@ = thing to do for each item
+ *
+ * Use:                Does something for each current peer.
+ */
+
+#define FOREACH_PEER(p, stuff) do {                                    \
+  peer_iter i_;                                                                \
+  peer *p;                                                             \
+  for (p_mkiter(&i_); (p = p_next(&i_)) != 0; ) do stuff while (0);    \
+} while (0)
+
+/* --- @p_mkiter@ --- *
+ *
+ * Arguments:  @peer_iter *i@ = pointer to an iterator
+ *
+ * Returns:    ---
+ *
+ * Use:                Initializes the iterator.
+ */
+
+extern void p_mkiter(peer_iter */*i*/);
+
+/* --- @p_next@ --- *
+ *
+ * Arguments:  @peer_iter *i@ = pointer to an iterator
  *
- * Arguments:  @peer *p@ = a peer block
+ * Returns:    Next peer, or null if at the end.
  *
- * Returns:    @peer_first@ returns the first peer in some ordering;
- *             @peer_next@ returns the peer following a given one in the
- *             same ordering.  Null is returned for the end of the list.
+ * Use:                Returns the next peer.
  */
 
-extern peer *p_first(void);
-extern peer *p_next(peer */*p*/);
+extern peer *p_next(peer_iter */*i*/);
 
 /*----- Tunnel drivers ----------------------------------------------------*/
 
@@ -1113,7 +1251,7 @@ extern const tunnel_ops tun_slip;
  * Returns:    A pointer to the integer's textual representation.
  *
  * Use:                Converts a multiprecision integer to a string.  Corrupts
- *             @buf_t@.
+ *             @buf_u@.
  */
 
 extern const char *mpstr(mp */*m*/);
@@ -1126,7 +1264,7 @@ extern const char *mpstr(mp */*m*/);
  * Returns:    A pointer to the element's textual representation.
  *
  * Use:                Converts a group element to a string.  Corrupts
- *             @buf_t@.
+ *             @buf_u@.
  */
 
 extern const char *gestr(group */*g*/, ge */*x*/);
@@ -1138,7 +1276,7 @@ extern const char *gestr(group */*g*/, ge */*x*/);
  * Returns:    A pointer to a textual representation of the time.
  *
  * Use:                Converts a time to a textual representation.  Corrupts
- *             @buf_t@.
+ *             @buf_u@.
  */
 
 extern const char *timestr(time_t /*t*/);
@@ -1177,39 +1315,6 @@ extern void seq_reset(seqwin */*s*/);
 
 extern int seq_check(seqwin */*s*/, uint32 /*q*/, const char */*service*/);
 
-/* --- @versioncmp@ --- *
- *
- * Arguments:  @const char *va, *vb@ = two version strings
- *
- * Returns:    Less than, equal to, or greater than zero, according to
- *             whether @va@ is less than, equal to, or greater than @vb@.
- *
- * Use:                Compares version number strings.
- *
- *             The algorithm is an extension of the Debian version
- *             comparison algorithm.  A version number consists of three
- *             components:
- *
- *               [EPOCH :] MAIN [- SUB]
- *
- *             The MAIN part may contain colons or hyphens if there is an
- *             EPOCH or SUB, respectively.  Version strings are compared
- *             componentwise: first epochs, then main parts, and finally
- *             subparts.
- *
- *             The component comparison is done as follows.  First, the
- *             initial subsequence of nondigit characters is extracted from
- *             each string, and these are compared lexicographically, using
- *             ASCII ordering, except that letters precede non-letters.  If
- *             both are the same, an initial sequence of digits is extracted
- *             from the remaining parts of the version strings, and these
- *             are compared numerically (an empty sequence being considered
- *             to have the value zero).  This process is repeated until we
- *             have a winner or until both strings are exhausted.
- */
-
-extern int versioncmp(const char */*va*/, const char */*vb*/);
-
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus