X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=secnet.git;a=blobdiff_plain;f=secnet.h;h=5eeb2132554f8cb8e971eb8075283d6cc45b5244;hp=4b211f5c687a1e17caf8b7d4dc0057ab72e2a5b3;hb=3d4c5c21baa7d5fcb654c09e4e5dac4770ad570e;hpb=fe5e9cc422cd72526ccfceffbc7e5af8ac83b407 diff --git a/secnet.h b/secnet.h index 4b211f5..5eeb213 100644 --- a/secnet.h +++ b/secnet.h @@ -7,6 +7,10 @@ #include #include #include +#include +#include +#include +#include #include #include #include @@ -14,11 +18,26 @@ typedef char *string_t; typedef const char *cstring_t; -typedef enum {False,True} bool_t; + +#define False (_Bool)0 +#define True (_Bool)1 +typedef _Bool bool_t; #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \ __FILE__,__LINE__); } } while(0) +/* from version.c */ + +extern char version[]; + +/* from logmsg.c */ +extern uint32_t message_level; +extern bool_t secnet_is_daemon; +extern struct log_if *system_log; + +/* from process.c */ +extern void start_signal_handling(void); + /***** CONFIGURATION support *****/ extern bool_t just_check_config; /* If True then we're going to exit after @@ -33,7 +52,7 @@ typedef struct list list_t; /* A list of items */ /* Configuration file location, for error-reporting */ struct cloc { cstring_t file; - uint32_t line; + int line; }; /* Modules export closures, which can be invoked from the configuration file. @@ -80,11 +99,11 @@ extern cstring_t *dict_keys(dict_t *dict); /* List-manipulation functions */ extern list_t *list_new(void); -extern uint32_t list_length(list_t *a); +extern int32_t list_length(list_t *a); extern list_t *list_append(list_t *a, item_t *i); extern list_t *list_append_list(list_t *a, list_t *b); /* Returns an item from the list (index starts at 0), or NULL */ -extern item_t *list_elem(list_t *l, uint32_t index); +extern item_t *list_elem(list_t *l, int32_t index); /* Convenience functions */ extern list_t *new_closure(closure_t *cl); @@ -99,6 +118,7 @@ extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required, extern uint32_t dict_read_number(dict_t *dict, cstring_t key, bool_t required, cstring_t desc, struct cloc loc, uint32_t def); + /* 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); struct flagstr { @@ -116,22 +136,42 @@ extern uint32_t string_list_to_word(list_t *l, struct flagstr *f, extern char *safe_strdup(const char *string, const char *message); extern void *safe_malloc(size_t size, const char *message); +extern void *safe_malloc_ary(size_t size, size_t count, const char *message); + +void setcloexec(int fd); /* cannot fail */ +void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */ extern int sys_cmd(const char *file, const char *argc, ...); +extern uint64_t now_global; +extern struct timeval tv_now_global; + +static const uint64_t *const now = &now_global; +static const struct timeval *const tv_now = &tv_now_global; + +/* "now" is current program time, in milliseconds. It is derived + from tv_now. Both are provided by the event loop. */ + /***** END of utility functions *****/ +/***** START of max_start_pad handling *****/ + +extern int32_t site_max_start_pad, transform_max_start_pad, + comm_max_start_pad; + +void update_max_start_pad(int32_t *our_module_global, int32_t our_instance); +int32_t calculate_max_start_pad(void); + +/***** END of max_start_pad handling *****/ + /***** SCHEDULING support */ -/* "now" is current program time, in milliseconds. It is derived - (once) from tv_now. If nfds_io is insufficient for your needs, set - it to the required number and return ERANGE. timeout is in milliseconds; - if it is too high then lower it. It starts at -1 (==infinite) */ +/* If nfds_io is insufficient for your needs, set it to the required + number and return ERANGE. timeout is in milliseconds; if it is too + high then lower it. It starts at -1 (==infinite) */ typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io, - int *timeout_io, const struct timeval *tv_now, - uint64_t *now); -typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds, - const struct timeval *tv_now, uint64_t *now); + int *timeout_io); +typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds); /* Register interest in the main loop of the program. Before a call to poll() your supplied beforepoll function will be called. After @@ -140,7 +180,7 @@ typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds, structures you may require - you can always ask for more in *nfds_io. */ extern void register_for_poll(void *st, beforepoll_fn *before, - afterpoll_fn *after, uint32_t max_nfds, + afterpoll_fn *after, int32_t max_nfds, cstring_t desc); /***** END of scheduling support */ @@ -149,17 +189,24 @@ extern void register_for_poll(void *st, beforepoll_fn *before, /* The secnet program goes through a number of phases in its lifetime. Module code may arrange to be called just as various phases are - entered. */ - -#define PHASE_INIT 0 -#define PHASE_GETOPTS 1 /* Process command-line arguments */ -#define PHASE_READCONFIG 2 /* Parse and process configuration file */ -#define PHASE_SETUP 3 /* Process information in configuration */ -#define PHASE_GETRESOURCES 4 /* Obtain all external resources */ -#define PHASE_DROPPRIV 5 /* Last chance for privileged operations */ -#define PHASE_RUN 6 -#define PHASE_SHUTDOWN 7 /* About to die; delete key material, etc. */ -#define NR_PHASES 8 + entered. + + Remember to update the table in util.c if changing the set of + phases. */ + +enum phase { + PHASE_INIT, + PHASE_GETOPTS, /* Process command-line arguments */ + PHASE_READCONFIG, /* Parse and process configuration file */ + PHASE_SETUP, /* Process information in configuration */ + PHASE_DAEMONIZE, /* Become a daemon (if necessary) */ + PHASE_GETRESOURCES, /* Obtain all external resources */ + PHASE_DROPPRIV, /* Last chance for privileged operations */ + PHASE_RUN, + PHASE_SHUTDOWN, /* About to die; delete key material, etc. */ + /* Keep this last: */ + NR_PHASES, +}; typedef void hook_fn(void *self, uint32_t newphase); bool_t add_hook(uint32_t phase, hook_fn *f, void *state); @@ -183,6 +230,24 @@ extern cstring_t require_root_privileges_explanation; modules it's called "secnet_module". */ typedef void init_module(dict_t *dict); +extern void init_builtin_modules(dict_t *dict); + +extern init_module resolver_module; +extern init_module random_module; +extern init_module udp_module; +extern init_module util_module; +extern init_module site_module; +extern init_module transform_eax_module; +extern init_module transform_cbcmac_module; +extern init_module netlink_module; +extern init_module rsa_module; +extern init_module dh_module; +extern init_module md5_module; +extern init_module slip_module; +extern init_module tun_module; +extern init_module sha1_module; +extern init_module log_module; + /***** END of module support *****/ /***** CLOSURE TYPES and interface definitions *****/ @@ -224,7 +289,7 @@ struct resolver_if { /* RANDOMSRC interface */ /* Return some random data. Returns TRUE for success. */ -typedef bool_t random_fn(void *st, uint32_t bytes, uint8_t *buff); +typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff); struct random_if { void *st; @@ -234,7 +299,7 @@ struct random_if { /* RSAPUBKEY interface */ -typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, uint32_t datalen, +typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen, cstring_t signature); struct rsapubkey_if { void *st; @@ -243,7 +308,7 @@ struct rsapubkey_if { /* RSAPRIVKEY interface */ -typedef string_t rsa_makesig_fn(void *st, uint8_t *data, uint32_t datalen); +typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen); struct rsaprivkey_if { void *st; rsa_makesig_fn *sign; @@ -251,38 +316,68 @@ struct rsaprivkey_if { /* COMM interface */ +struct comm_addr { + /* This struct is pure data; in particular comm's clients may + freely copy it. */ + /* Everyone is also guaranteed that all padding is set to zero, ie + that comm_addrs referring to semantically identical peers will + compare equal with memcmp. Anyone who constructs a comm_addr + must start by memsetting it with FILLZERO, or some + equivalent. */ + struct comm_if *comm; + struct sockaddr_in sin; +}; + /* Return True if the packet was processed, and shouldn't be passed to any other potential receivers. */ typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf, - struct sockaddr_in *source); + const struct comm_addr *source); 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, - struct sockaddr_in *dest); + const struct comm_addr *dest); +typedef const char *comm_addr_to_string_fn(void *commst, + const struct comm_addr *ca); + /* Returned string is in a static buffer. */ struct comm_if { void *st; - uint32_t min_start_pad; - uint32_t min_end_pad; comm_request_notify_fn *request_notify; comm_release_notify_fn *release_notify; comm_sendmsg_fn *sendmsg; + comm_addr_to_string_fn *addr_to_string; }; +static inline const char *comm_addr_to_string(const struct comm_addr *ca) +{ + return ca->comm->addr_to_string(ca->comm->st, ca); +} + /* LOG interface */ +#define LOG_MESSAGE_BUFLEN 1023 + typedef void log_msg_fn(void *st, int class, const char *message, ...); typedef void log_vmsg_fn(void *st, int class, const char *message, va_list args); struct log_if { void *st; - log_msg_fn *log; - log_vmsg_fn *vlog; + log_vmsg_fn *vlogfn; /* printf format checking. Use [v]slilog instead */ + char buff[LOG_MESSAGE_BUFLEN+1]; }; -/* (convenience function, defined in util.c) */ -extern void log(struct log_if *lf, int class, const char *message, ...) +/* (convenience functions, defined in util.c) */ +extern void slilog(struct log_if *lf, int class, const char *message, ...) FORMAT(printf,3,4); +extern void vslilog(struct log_if *lf, int class, const char *message, va_list) +FORMAT(printf,3,0); + +/* Versions which take (parts of) (multiple) messages, using \n to + * distinguish one message from another. */ +extern void slilog_part(struct log_if *lf, int class, const char *message, ...) +FORMAT(printf,3,4); +extern void vslilog_part(struct log_if *lf, int class, const char *message, + va_list) FORMAT(printf,3,0); /* SITE interface */ @@ -299,26 +394,34 @@ struct site_if { /* TRANSFORM interface */ /* A reversable transformation. Transforms buffer in-place; may add - data to start or end. Maximum amount of data to be added specified - in max_start_pad and max_end_pad. (Reverse transformations decrease + data to start or end. (Reverse transformations decrease length, of course.) Transformations may be key-dependent, in which case key material is passed in at initialisation time. They may also depend on internal factors (eg. time) and keep internal state. A struct transform_if only represents a particular type of transformation; instances of the transformation (eg. with - particular key material) have a different C type. */ + particular key material) have a different C type. The same + secret key will be used in opposite directions between a pair of + secnets; one of these pairs will get direction==False, the other True. */ typedef struct transform_inst_if *transform_createinstance_fn(void *st); -typedef bool_t transform_setkey_fn(void *st, uint8_t *key, uint32_t keylen); +typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen, + bool_t direction); +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 for 'all is well', any other value for a problem */ +/* 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); struct transform_inst_if { void *st; transform_setkey_fn *setkey; + transform_valid_fn *valid; transform_delkey_fn *delkey; transform_apply_fn *forwards; transform_apply_fn *reverse; @@ -327,9 +430,8 @@ struct transform_inst_if { struct transform_if { void *st; - uint32_t max_start_pad; - uint32_t max_end_pad; - uint32_t keylen; + int capab_transformnum; + int32_t keylen; /* <<< INT_MAX */ transform_createinstance_fn *create; }; @@ -343,25 +445,23 @@ struct transform_if { typedef void netlink_deliver_fn(void *st, struct buffer_if *buf); /* site code can tell netlink when outgoing packets will be dropped, so netlink can generate appropriate ICMP and make routing decisions */ -#define LINK_QUALITY_DOWN 0 /* No chance of a packet being delivered */ -#define LINK_QUALITY_DOWN_STALE_ADDRESS 1 /* Link down, old address information */ -#define LINK_QUALITY_DOWN_CURRENT_ADDRESS 2 /* Link down, current address information */ -#define LINK_QUALITY_UP 3 /* Link active */ +#define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */ +#define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/ +#define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */ +#define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */ +#define LINK_QUALITY_UP 4 /* Link active */ #define MAXIMUM_LINK_QUALITY 3 typedef void netlink_link_quality_fn(void *st, uint32_t quality); typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver, - void *dst, uint32_t max_start_pad, - uint32_t max_end_pad); + void *dst, uint32_t *localmtu_r /* NULL ok */); typedef void netlink_output_config_fn(void *st, struct buffer_if *buf); typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf); -typedef void netlink_set_mtu_fn(void *st, uint32_t new_mtu); +typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu); struct netlink_if { void *st; netlink_register_fn *reg; netlink_deliver_fn *deliver; netlink_link_quality_fn *set_quality; - netlink_output_config_fn *output_config; - netlink_check_config_fn *check_config; netlink_set_mtu_fn *set_mtu; }; @@ -369,14 +469,15 @@ struct netlink_if { /* Returns public key as a malloced hex string */ typedef string_t dh_makepublic_fn(void *st, uint8_t *secret, - uint32_t secretlen); + int32_t secretlen); /* Fills buffer (up to buflen) with shared secret */ typedef void dh_makeshared_fn(void *st, uint8_t *secret, - uint32_t secretlen, cstring_t rempublic, - uint8_t *sharedsecret, uint32_t buflen); + int32_t secretlen, cstring_t rempublic, + uint8_t *sharedsecret, int32_t buflen); struct dh_if { void *st; - uint32_t len; /* Approximate size of modulus in bytes */ + int32_t len; /* Approximate size of modulus in bytes */ + int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */ dh_makepublic_fn *makepublic; dh_makeshared_fn *makeshared; }; @@ -384,10 +485,10 @@ struct dh_if { /* HASH interface */ typedef void *hash_init_fn(void); -typedef void hash_update_fn(void *st, uint8_t const *buf, uint32_t len); +typedef void hash_update_fn(void *st, const void *buf, int32_t len); typedef void hash_final_fn(void *st, uint8_t *digest); struct hash_if { - uint32_t len; /* Hash output length in bytes */ + int32_t len; /* Hash output length in bytes */ hash_init_fn *init; hash_update_fn *update; hash_final_fn *final; @@ -402,8 +503,8 @@ struct buffer_if { struct cloc loc; /* Where we were defined */ uint8_t *base; uint8_t *start; - uint32_t size; /* Size of buffer contents */ - uint32_t len; /* Total length allocated at base */ + int32_t size; /* Size of buffer contents */ + int32_t alloclen; /* Total length allocated at base */ }; /***** LOG functions *****/ @@ -419,21 +520,25 @@ struct buffer_if { #define M_FATAL 0x100 /* The fatal() family of functions require messages that do not end in '\n' */ -extern NORETURN(fatal(const char *message, ...)); -extern NORETURN(fatal_perror(const char *message, ...)); -extern NORETURN(fatal_status(int status, const char *message, ...)); -extern NORETURN(fatal_perror_status(int status, const char *message, ...)); +extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2); +extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2); +extern NORETURN(fatal_status(int status, const char *message, ...)) + FORMAT(printf,2,3); +extern NORETURN(fatal_perror_status(int status, const char *message, ...)) + FORMAT(printf,2,3); /* The cfgfatal() family of functions require messages that end in '\n' */ extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility, - const char *message, ...)); + const char *message, ...)) FORMAT(printf,3,4); extern void cfgfile_postreadcheck(struct cloc loc, FILE *f); extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc, cstring_t facility, const char *message, - va_list)); + va_list)) + FORMAT(printf,4,0); extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc, cstring_t facility, - const char *message, ...)); + const char *message, ...)) + FORMAT(printf,4,5); extern void Message(uint32_t class, const char *message, ...) FORMAT(printf,2,3); @@ -441,4 +546,22 @@ extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log); /***** END of log functions *****/ +#define STRING2(x) #x +#define STRING(x) STRING2(x) + +#define FILLZERO(obj) (memset(&(obj),0,sizeof((obj)))) + +/* + * 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, proviced it's + * // _actually_ the whole array object and not decayed into a + * // pointer (e.g. a formal parameter). + */ +#define COPY_OBJ(dst,src) \ + (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst)))) +#define COPY_ARRAY(dst,src,count) \ + (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count))) + #endif /* secnet_h */