X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=secnet.git;a=blobdiff_plain;f=secnet.h;h=ecbb9959bc7d2fbc824514a82d5397b574f39c88;hp=f8062e6a81704b035299274a05c213f73969002e;hb=26f727b913e16936c8f319fde9d7e06b677345f6;hpb=4f5e39ecfaa49376b0a5c3a4c384e91a828c1105 diff --git a/secnet.h b/secnet.h index f8062e6..ecbb995 100644 --- a/secnet.h +++ b/secnet.h @@ -12,12 +12,40 @@ #include #include +/* + * Macros added by SGT for endianness-independence + */ +#define GET_32BIT_MSB_FIRST(cp) \ + (((unsigned long)(unsigned char)(cp)[0] << 24) | \ + ((unsigned long)(unsigned char)(cp)[1] << 16) | \ + ((unsigned long)(unsigned char)(cp)[2] << 8) | \ + ((unsigned long)(unsigned char)(cp)[3])) + +#define PUT_32BIT_MSB_FIRST(cp, value) ( \ + (cp)[0] = (char)((value) >> 24), \ + (cp)[1] = (char)((value) >> 16), \ + (cp)[2] = (char)((value) >> 8), \ + (cp)[3] = (char)(value) ) + typedef char *string_t; +typedef const char *cstring_t; typedef enum {False,True} 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 @@ -31,8 +59,8 @@ typedef struct list list_t; /* A list of items */ /* Configuration file location, for error-reporting */ struct cloc { - string_t file; - uint32_t line; + cstring_t file; + int line; }; /* Modules export closures, which can be invoked from the configuration file. @@ -41,7 +69,7 @@ struct cloc { typedef list_t *(apply_fn)(closure_t *self, struct cloc loc, dict_t *context, list_t *data); struct closure { - string_t description; /* For debugging */ + cstring_t description; /* For debugging */ uint32_t type; /* Central registry... */ apply_fn *apply; void *interface; /* Interface for use inside secnet; depends on type */ @@ -69,67 +97,76 @@ struct list { /* In the following two lookup functions, NULL means 'not found' */ /* Lookup a value in the specified dictionary, or its parents */ -extern list_t *dict_lookup(dict_t *dict, string_t key); +extern list_t *dict_lookup(dict_t *dict, cstring_t key); /* Lookup a value in just the specified dictionary */ -extern list_t *dict_lookup_primitive(dict_t *dict, string_t key); +extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key); /* Add a value to the specified dictionary */ -extern void dict_add(dict_t *dict, string_t key, list_t *val); +extern void dict_add(dict_t *dict, cstring_t key, list_t *val); /* Obtain an array of keys in the dictionary. malloced; caller frees */ -extern string_t *dict_keys(dict_t *dict); +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); -extern void add_closure(dict_t *dict, string_t name, apply_fn apply); -extern void *find_cl_if(dict_t *dict, string_t name, uint32_t type, - bool_t fail_if_invalid, string_t desc, +extern void add_closure(dict_t *dict, cstring_t name, apply_fn apply); +extern void *find_cl_if(dict_t *dict, cstring_t name, uint32_t type, + bool_t fail_if_invalid, cstring_t desc, struct cloc loc); -extern item_t *dict_find_item(dict_t *dict, string_t key, bool_t required, - string_t desc, struct cloc loc); -extern string_t dict_read_string(dict_t *dict, string_t key, bool_t required, - string_t desc, struct cloc loc); -extern uint32_t dict_read_number(dict_t *dict, string_t key, bool_t required, - string_t desc, struct cloc loc, uint32_t def); -extern bool_t dict_read_bool(dict_t *dict, string_t key, bool_t required, - string_t desc, struct cloc loc, bool_t def); +extern item_t *dict_find_item(dict_t *dict, cstring_t key, bool_t required, + cstring_t desc, struct cloc loc); +extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required, + cstring_t desc, struct cloc loc); +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 { - string_t name; + cstring_t name; uint32_t value; }; -extern uint32_t string_to_word(string_t s, struct cloc loc, - struct flagstr *f, string_t desc); +extern uint32_t string_to_word(cstring_t s, struct cloc loc, + struct flagstr *f, cstring_t desc); extern uint32_t string_list_to_word(list_t *l, struct flagstr *f, - string_t desc); + cstring_t desc); /***** END of configuration support *****/ /***** UTILITY functions *****/ -extern char *safe_strdup(char *string, char *message); -extern void *safe_malloc(size_t size, char *message); +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); + +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; -extern int sys_cmd(const char *file, char *argc, ...); +/* "now" is current program time, in milliseconds. It is derived + from tv_now. Both are provided by the event loop. */ /***** END of utility functions *****/ /***** 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 @@ -138,8 +175,8 @@ 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, - string_t desc); + afterpoll_fn *after, int32_t max_nfds, + cstring_t desc); /***** END of scheduling support */ @@ -147,17 +184,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); @@ -170,7 +214,7 @@ extern void enter_phase(uint32_t new_phase); retain root privileges. They should indicate that here when appropriate. */ extern bool_t require_root_privileges; -extern string_t require_root_privileges_explanation; +extern cstring_t require_root_privileges_explanation; /***** END of program lifetime support *****/ @@ -181,6 +225,23 @@ extern string_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_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 *****/ @@ -212,7 +273,7 @@ struct buffer_if; order. */ /* XXX extend to be able to provide multiple answers */ typedef void resolve_answer_fn(void *st, struct in_addr *addr); -typedef bool_t resolve_request_fn(void *st, string_t name, +typedef bool_t resolve_request_fn(void *st, cstring_t name, resolve_answer_fn *cb, void *cst); struct resolver_if { void *st; @@ -222,7 +283,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; @@ -232,8 +293,8 @@ struct random_if { /* RSAPUBKEY interface */ -typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, uint32_t datalen, - string_t signature); +typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen, + cstring_t signature); struct rsapubkey_if { void *st; rsa_checksig_fn *check; @@ -241,7 +302,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; @@ -249,37 +310,56 @@ 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; + int32_t min_start_pad; + int32_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; }; /* LOG interface */ -typedef void log_msg_fn(void *st, int class, char *message, ...); -typedef void log_vmsg_fn(void *st, int class, char *message, va_list args); +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; }; -/* (convenience function, defined in util.c) */ -extern void log(struct log_if *lf, int class, 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); /* SITE interface */ @@ -306,12 +386,12 @@ struct site_if { particular key material) have a different C type. */ 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); 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 */ typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf, - char **errmsg); + const char **errmsg); struct transform_inst_if { void *st; @@ -324,9 +404,9 @@ struct transform_inst_if { struct transform_if { void *st; - uint32_t max_start_pad; - uint32_t max_end_pad; - uint32_t keylen; + int32_t max_start_pad; /* these three are all <<< INT_MAX */ + int32_t max_end_pad; + int32_t keylen; transform_createinstance_fn *create; }; @@ -340,18 +420,19 @@ 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, int32_t max_start_pad, + int32_t max_end_pad); 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; @@ -366,14 +447,14 @@ 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, string_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 */ dh_makepublic_fn *makepublic; dh_makeshared_fn *makeshared; }; @@ -381,10 +462,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; @@ -394,13 +475,13 @@ struct hash_if { struct buffer_if { bool_t free; - string_t owner; /* Set to constant string */ + 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; - uint32_t size; /* Size of buffer contents */ - uint32_t len; /* Total length allocated at base */ + int32_t size; /* Size of buffer contents */ + int32_t len; /* Total length allocated at base */ }; /***** LOG functions *****/ @@ -416,23 +497,31 @@ struct buffer_if { #define M_FATAL 0x100 /* The fatal() family of functions require messages that do not end in '\n' */ -extern NORETURN(fatal(char *message, ...)); -extern NORETURN(fatal_perror(char *message, ...)); -extern NORETURN(fatal_status(int status, char *message, ...)); -extern NORETURN(fatal_perror_status(int status, char *message, ...)); +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, ...)); /* The cfgfatal() family of functions require messages that end in '\n' */ -extern NORETURN(cfgfatal(struct cloc loc, string_t facility, char *message, - ...)); +extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility, + const char *message, ...)); extern void cfgfile_postreadcheck(struct cloc loc, FILE *f); extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc, - string_t facility, char *message, + cstring_t facility, const char *message, va_list)); extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc, - string_t facility, char *message, ...)); + cstring_t facility, + const char *message, ...)); -extern void Message(uint32_t class, char *message, ...) FORMAT(printf,2,3); +extern void Message(uint32_t class, const char *message, ...) + FORMAT(printf,2,3); +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)))) + #endif /* secnet_h */