/* Core interface of secnet, to be used by all modules */
+/*
+ * This file is part of secnet.
+ * See README for full list of copyright holders.
+ *
+ * secnet is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * secnet 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
+ * version 3 along with secnet; if not, see
+ * https://www.gnu.org/licenses/gpl.html.
+ */
#ifndef secnet_h
#define secnet_h
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
+#include <limits.h>
#include <fnmatch.h>
#include <sys/poll.h>
#include <sys/types.h>
#define MAX_PEER_ADDRS 5
/* send at most this many copies; honour at most that many addresses */
+#define MAX_NAK_MSG 80
+
+struct hash_if;
struct comm_if;
struct comm_addr;
+struct priomsg;
typedef char *string_t;
typedef const char *cstring_t;
/* return value can safely be assigned to int32_t */
extern bool_t dict_read_bool(dict_t *dict, cstring_t key, bool_t required,
cstring_t desc, struct cloc loc, bool_t def);
+extern dict_t *dict_read_dict(dict_t *dict, cstring_t key, bool_t required,
+ cstring_t desc, struct cloc loc);
const char **dict_read_string_array(dict_t *dict, cstring_t key,
bool_t required, cstring_t desc,
struct cloc loc, const char *const *def);
extern void *safe_realloc_ary(void *p, size_t size, size_t count,
const char *message);
+#define NEW(p) \
+ ((p)=safe_malloc(sizeof(*(p)), \
+ __FILE__ ":" #p))
+#define NEW_ARY(p,count) \
+ ((p)=safe_malloc_ary(sizeof(*(p)),(count), \
+ __FILE__ ":" #p "[" #count "]"))
+#define REALLOC_ARY(p,count) \
+ ((p)=safe_realloc_ary((p),sizeof(*(p)),(count), \
+ __FILE__ ":" #p "[" #count "]"))
+
void setcloexec(int fd); /* cannot fail */
void setnonblock(int fd); /* cannot fail */
void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
#define CL_PURE 0
#define CL_RESOLVER 1
#define CL_RANDOMSRC 2
-#define CL_RSAPUBKEY 3
-#define CL_RSAPRIVKEY 4
+#define CL_SIGPUBKEY 3
+#define CL_SIGPRIVKEY 4
#define CL_COMM 5
#define CL_IPIF 6
#define CL_LOG 7
struct buffer_if;
+struct alg_msg_data {
+ uint8_t *start;
+ int32_t len;
+};
+
/* PURE closure requires no interface */
/* RESOLVER interface */
/* RANDOMSRC interface */
-/* Return some random data. Returns TRUE for success. */
-typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff);
+/* Return some random data. Cannot fail. */
+typedef void random_fn(void *st, int32_t bytes, uint8_t *buff);
struct random_if {
void *st;
random_fn *generate;
};
-/* RSAPUBKEY interface */
+/* SIGPUBKEY interface */
-typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen,
- cstring_t signature);
-struct rsapubkey_if {
+typedef void sig_sethash_fn(void *st, struct hash_if *hash);
+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,
+ const struct alg_msg_data *sig);
+struct sigpubkey_if {
void *st;
- rsa_checksig_fn *check;
+ sig_sethash_fn *sethash; /* must be called before check, if non-0 */
+ sig_unpick_fn *unpick;
+ sig_checksig_fn *check;
};
-/* RSAPRIVKEY interface */
+/* SIGPRIVKEY interface */
-typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen);
-struct rsaprivkey_if {
+/* 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;
- rsa_makesig_fn *sign;
+ sig_sethash_fn *sethash; /* must be called before sign, if non-0 */
+ sig_makesig_fn *sign;
};
/* COMM interface */
int ix; /* see comment `Re comm_addr.ix' in udp.c */
};
+struct comm_clientinfo; /* private for comm */
+
+typedef struct comm_clientinfo *comm_clientinfo_fn(void *state, dict_t*,
+ struct cloc cloc);
+/* A comm client may call this during configuration, and then pass
+ * the resulting comm_clientinfo* to some or all sendmsg calls.
+ * 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,
comm_notify_fn *fn);
typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
- const struct comm_addr *dest);
+ const struct comm_addr *dest,
+ struct comm_clientinfo* /* 0 OK */);
/* Only returns false if (we know that) the local network
* environment is such that this address cannot work; transient
* or unknown/unexpected failures return true. */
/* Returned string is in a static buffer. */
struct comm_if {
void *st;
+ comm_clientinfo_fn *clientinfo;
comm_request_notify_fn *request_notify;
comm_release_notify_fn *release_notify;
comm_sendmsg_fn *sendmsg;
typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
typedef void transform_delkey_fn(void *st);
typedef void transform_destroyinstance_fn(void *st);
-/* Returns:
- * 0: all is well
- * 1: for any other problem
- * 2: message decrypted but sequence number was out of range
- */
-typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
- const char **errmsg);
+
+typedef enum {
+ transform_apply_ok = 0, /* all is well (everyone may assume==0) */
+ transform_apply_err = 1, /* any other problem */
+ transform_apply_seqrange = 2,
+ /* message decrypted but sequence number was out of recent range */
+ transform_apply_seqdupe = 3,
+ /* message decrypted but was dupe of recent packet */
+} transform_apply_return;
+
+static inline bool_t
+transform_apply_return_badseq(transform_apply_return problem) {
+ return problem == transform_apply_seqrange ||
+ problem == transform_apply_seqdupe;
+}
+
+typedef transform_apply_return transform_apply_fn(void *st,
+ struct buffer_if *buf, const char **errmsg);
struct transform_inst_if {
void *st;
struct transform_if {
void *st;
- int capab_transformnum;
+ int capab_bit;
int32_t keylen; /* <<< INT_MAX */
transform_createinstance_fn *create;
};
/* 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;
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;
* 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).
*/
~ianmdlvl / secnet.git / blobdiff