chiark / gitweb /
More support scripts and other cool stuff.
[tripe] / tripe.h
diff --git a/tripe.h b/tripe.h
index 6dbfbad3c4ffa5814162c45c9c4c442dfbe76d65..47719fe99353ee1b54a1330e8d40172d395d2247 100644 (file)
--- a/tripe.h
+++ b/tripe.h
@@ -80,6 +80,7 @@
 #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
-#define TUN_SLIP 4
-
 /* --- Trace flags --- */
 
 #define T_TUNNEL 1u
@@ -260,49 +253,21 @@ enum {
  * 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;
 
-#if TUN_TYPE == TUN_SLIP
-  typedef struct slipif {
-    struct slipif *next;               /* Next one in the list */
-    int ifd, ofd;                      /* File descriptors to talk on */
-    char *name;                                /* Interface name */
-    pid_t kid;                         /* Child process id */
-    unsigned f;                                /* Various flags */
-#     define SLIPIFF_INUSE 1u          /*   Interface is in use */
-#     define SLIPIFF_DYNAMIC 2u                /*   Interface found dynamically */
-  } slipif;
-#endif
+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;
 
-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 */
-#elif TUN_TYPE == TUN_SLIP
-  slipif *sl;                          /* My interface record */
-  sel_file f;                          /* Selector for SLIP tty */
-  struct peer *p;                      /* Pointer to my peer */
-  unsigned st;                         /* Current parser state */
-#   define SLIPST_ESC 1u               /*   Last saw an escape character */
-#   define SLIPST_BAD 2u               /*   This packet is malformed */
-#   define SLIPST_EOF 4u               /*   File descriptor reported EOF */
-  size_t n;                            /* Number of bytes used in buffer */
-  octet buf[PKBUFSZ];                  /* Buffer for incoming data */
-#else
-#  error "No support for this tunnel type"
+#ifndef TUN_INTERNALS
+struct tunnel { const tunnel_ops *ops; };
 #endif
-} tunnel;
 
 /* --- Peer statistics --- *
  *
@@ -328,18 +293,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
@@ -350,30 +342,54 @@ 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_addop {
+  admin_bgop bg;                       /* Background operation header */
+  peerspec peer;                       /* Peer pending creation */
+  char *paddr;                         /* Hostname to be resolved */
+  bres_client r;                       /* Background resolver task */
+  sel_timer t;                         /* Timer for resolver */
+} admin_addop;
+
+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 8u                  /* Catch tracing */
+  #define AF_TRACE 16u                 /* Catch tracing */
 #endif
-#define AF_WARN 16u                    /* Catch warning messages */
 
 #ifndef NTRACE
 #  define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
@@ -387,6 +403,8 @@ extern sel_state sel;                       /* Global I/O event state */
 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 */
@@ -399,16 +417,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@ --- *
  *
@@ -443,6 +461,7 @@ extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
 /* --- @kx_start@ --- *
  *
  * Arguments:  @keyexch *kx@ = pointer to key exchange context
+ *             @int forcep@ = nonzero to ignore the quiet timer
  *
  * Returns:    ---
  *
@@ -451,7 +470,7 @@ extern int km_getpubkey(const char */*tag*/, ge */*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@ --- *
  *
@@ -769,6 +788,37 @@ 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_tun@ --- *
  *
  * Arguments:  @peer *p@ = pointer to peer block
@@ -781,6 +831,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:  ---
@@ -842,9 +903,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.
  *
@@ -852,18 +911,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
@@ -898,63 +967,21 @@ extern void p_destroy(peer */*p*/);
 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);
+/*----- Tunnel drivers ----------------------------------------------------*/
 
-/* --- @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*/);
-
-/* --- @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 ---------------------------------------------*/
 
@@ -995,6 +1022,15 @@ extern const char *gestr(group */*g*/, ge */*x*/);
 
 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*/);
+
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus