chiark / gitweb /
privcache: New closure for signature key handling
[secnet.git] / secnet.h
index 99662a4135b37af90b4310a30e3879857b714dc3..84e732d88fd2c952d5cbf5ddd9069b79246f67a1 100644 (file)
--- a/secnet.h
+++ b/secnet.h
@@ -27,6 +27,8 @@
 #include <stdlib.h>
 #include <stdarg.h>
 #include <stdio.h>
+#include <stdint.h>
+#include <inttypes.h>
 #include <string.h>
 #include <assert.h>
 #include <fcntl.h>
 #define MAX_PEER_ADDRS 5
 /* send at most this many copies; honour at most that many addresses */
 
+#define MAX_NAK_MSG 80
+#define MAX_SIG_KEYS 4
+
+struct hash_if;
 struct comm_if;
 struct comm_addr;
+struct priomsg;
+struct log_if;
+struct buffer_if;
+struct sigpubkey_if;
+struct sigprivkey_if;
 
 typedef char *string_t;
 typedef const char *cstring_t;
@@ -64,6 +75,31 @@ union iaddr {
 #endif
 };
 
+#define GRPIDSZ 4
+#define ALGIDSZ 1
+#define KEYIDSZ (GRPIDSZ+ALGIDSZ)
+  /* Changing these is complex: this is the group id plus algo id */
+  /* They are costructed by pubkeys.fl.pl.  Also hardcoded in _PR_ */
+struct sigkeyid { uint8_t b[KEYIDSZ]; };
+
+#define SIGKEYID_PR_FMT "%02x%02x%02x%02x%02x"
+#define SIGKEYID_PR_VAL(id) /* SIGKEYID_PR_VAL(const sigkeyid *id) */  \
+    ((id) == (const struct sigkeyid*)0, (id)->b[0]),                   \
+    (id)->b[1],(id)->b[2],(id)->b[3],(id)->b[4]
+static inline bool_t sigkeyid_equal(const struct sigkeyid *a,
+                                   const struct sigkeyid *b) {
+    return !memcmp(a->b, b->b, KEYIDSZ);
+}
+
+#define SERIALSZ 4
+typedef uint32_t serialt;
+static inline int serial_cmp(serialt a, serialt b) {
+    if (a==b) return 0;
+    if (!a) return -1;
+    if (!b) return +1;
+    return b-a <= (serialt)0x7fffffffUL ? +1 : -1;
+}
+
 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
                                         __FILE__,__LINE__); } } while(0)
 
@@ -355,9 +391,46 @@ extern init_module slip_module;
 extern init_module tun_module;
 extern init_module sha1_module;
 extern init_module log_module;
+extern init_module privcache_module;
 
 /***** END of module support *****/
 
+/***** SIGNATURE SCHEMES *****/
+
+struct sigscheme_info;
+
+typedef bool_t sigscheme_loadpub(const struct sigscheme_info *algo,
+                                struct buffer_if *pubkeydata,
+                                struct sigpubkey_if **sigpub_r,
+                                struct log_if *log);
+  /* pubkeydata is (supposedly) for this algorithm.
+   * loadpub should log an error if it fails.
+   * pubkeydata may be modified (but not freed) */
+
+typedef bool_t sigscheme_loadpriv(const struct sigscheme_info *algo,
+                                 struct buffer_if *privkeydata,
+                                 struct sigprivkey_if **sigpriv_r,
+                                 struct log_if *log);
+  /* privkeydata may contain data for any algorithm, not necessarily
+   * this one!  If it is not for this algorithm, return False and do
+   * not log anything (other than at M_DEBUG).  If it *is* for this
+   * algorithm but is wrong, log at M_ERROR.
+   * On entry privkeydata->base==start.  loadpriv may modify base and
+   * size, but not anything else.  So it may use unprepend and
+   * unappend. */
+
+struct sigscheme_info {
+    const char *name;
+    const uint8_t algid;
+    sigscheme_loadpub *loadpub;
+    sigscheme_loadpriv *loadpriv;
+};
+
+extern const struct sigscheme_info rsa1_sigscheme;
+extern const struct sigscheme_info sigschemes[]; /* sentinel has name==0 */
+
+/***** END of signature schemes *****/
+
 /***** CLOSURE TYPES and interface definitions *****/
 
 #define CL_PURE         0
@@ -374,9 +447,15 @@ extern init_module log_module;
 #define CL_HASH        12
 #define CL_BUFFER      13
 #define CL_NETLINK     14
+#define CL_PRIVCACHE   15
 
 struct buffer_if;
 
+struct alg_msg_data {
+    uint8_t *start;
+    int32_t len;
+};
+
 /* PURE closure requires no interface */
 
 /* RESOLVER interface */
@@ -413,19 +492,47 @@ struct random_if {
 
 /* SIGPUBKEY interface */
 
+typedef void sig_sethash_fn(void *st, struct hash_if *hash);
+typedef void sig_dispose_fn(void *st);
+
+typedef bool_t sig_unpick_fn(void *sst, struct buffer_if *msg,
+                            struct alg_msg_data *sig);
 typedef bool_t sig_checksig_fn(void *st, uint8_t *data, int32_t datalen,
-                              cstring_t signature);
+                              const struct alg_msg_data *sig);
 struct sigpubkey_if {
     void *st;
+    sig_sethash_fn *sethash; /* must be called before use, if non-0 */
+    sig_unpick_fn *unpick;
     sig_checksig_fn *check;
+    const struct hash_if *hash;
+    sig_dispose_fn *dispose;
 };
 
 /* SIGPRIVKEY interface */
 
-typedef string_t sig_makesig_fn(void *st, uint8_t *data, int32_t datalen);
+/* Appends the signature to msg.
+ * Can fail and returnn False, eg if the buffer is too small. */
+typedef bool_t sig_makesig_fn(void *st, uint8_t *data, int32_t datalen,
+                             struct buffer_if *msg);
 struct sigprivkey_if {
     void *st;
+    sig_sethash_fn *sethash; /* must be called before use, if non-0 */
     sig_makesig_fn *sign;
+    const struct hash_if *hash;
+    sig_dispose_fn *dispose;
+};
+
+/* PRIVCACHE interface */
+
+typedef struct sigprivkey_if *privcache_lookup_fn(void *st,
+                                          const struct sigkeyid *id,
+                                          struct log_if*);
+  /* Return is valid only until you return from the current event!
+   * You do not need to call ->sethash. */
+
+struct privcache_if {
+    void *st;
+    privcache_lookup_fn *lookup;
 };
 
 /* COMM interface */
@@ -447,10 +554,18 @@ typedef struct comm_clientinfo *comm_clientinfo_fn(void *state, dict_t*,
  * The semantics depend on the dict and defined by the comm, and
  * should be documented in README. */
 
+enum {
+    comm_notify_whynot_general,
+    comm_notify_whynot_unpick,
+    comm_notify_whynot_name_local,
+    comm_notify_whynot_name_remote,
+};
+
 /* Return True if the packet was processed, and shouldn't be passed to
    any other potential receivers. (buf is freed iff True returned.) */
 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
-                             const struct comm_addr *source);
+                             const struct comm_addr *source,
+                             struct priomsg *whynot);
 typedef void comm_request_notify_fn(void *commst, void *nst,
                                    comm_notify_fn *fn);
 typedef void comm_release_notify_fn(void *commst, void *nst,
@@ -628,11 +743,12 @@ struct dh_if {
 
 /* HASH interface */
 
-typedef void *hash_init_fn(void);
+typedef void hash_init_fn(void *st /* slen bytes alloc'd by caller */);
 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
-typedef void hash_final_fn(void *st, uint8_t *digest);
+typedef void hash_final_fn(void *st, uint8_t *digest /* hlen bytes */);
 struct hash_if {
-    int32_t len; /* Hash output length in bytes */
+    int32_t slen; /* State length in bytes */
+    int32_t hlen; /* Hash output length in bytes */
     hash_init_fn *init;
     hash_update_fn *update;
     hash_final_fn *final;
@@ -643,7 +759,6 @@ struct hash_if {
 struct buffer_if {
     bool_t free;
     cstring_t owner; /* Set to constant string */
-    uint32_t flags; /* How paranoid should we be? */
     struct cloc loc; /* Where we were defined */
     uint8_t *base;
     uint8_t *start;
@@ -713,7 +828,7 @@ extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
  * void COPY_OBJ(  OBJECT& dst, const OBJECT& src);
  * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
  *   // Typesafe: we check that the type OBJECT is the same in both cases.
- *   // It is OK to use COPY_OBJ on an array object, provided it's
+ *   // It is OK to use COPY_OBJ on an array object, provided dst is
  *   // _actually_ the whole array object and not decayed into a
  *   // pointer (e.g. a formal parameter).
  */