X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?p=secnet.git;a=blobdiff_plain;f=secnet.h;h=f8062e6a81704b035299274a05c213f73969002e;hp=35e06d10d0364a6ab6eb7a5b0aa6379fdec79299;hb=4f5e39ecfaa49376b0a5c3a4c384e91a828c1105;hpb=8689b3a94c043f04e334a7b181a7250ad5940616 diff --git a/secnet.h b/secnet.h index 35e06d1..f8062e6 100644 --- a/secnet.h +++ b/secnet.h @@ -6,7 +6,7 @@ #include "config.h" #include #include -#include +#include #include #include #include @@ -15,30 +15,15 @@ typedef char *string_t; typedef enum {False,True} bool_t; -#define ASSERT(x) do { if (!(x)) { fatal("assertion failed line " __LINE__ \ - " file " __FILE__ "\n"); } while(0) - -/***** SHARED types *****/ - -/* These are stored in HOST byte order */ -struct subnet { - uint32_t prefix; - uint32_t mask; -}; - -struct subnet_list { - uint32_t entries; - struct subnet *list; -}; - -/* Match an address (in HOST byte order) with a subnet list. - Returns True if matched. */ -extern bool_t subnet_match(struct subnet_list *list, uint32_t address); - -/***** END of shared types *****/ +#define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \ + __FILE__,__LINE__); } } while(0) /***** CONFIGURATION support *****/ +extern bool_t just_check_config; /* If True then we're going to exit after + reading the configuration file */ +extern bool_t background; /* If True then we'll eventually run as a daemon */ + typedef struct dict dict_t; /* Configuration dictionary */ typedef struct closure closure_t; typedef struct item item_t; @@ -75,6 +60,8 @@ struct item { struct cloc loc; }; +/* Note that it is unwise to use this structure directly; use the list + manipulation functions instead. */ struct list { item_t *item; struct list *next; @@ -92,6 +79,7 @@ extern string_t *dict_keys(dict_t *dict); /* List-manipulation functions */ extern list_t *list_new(void); +extern uint32_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 */ @@ -111,36 +99,22 @@ 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 void dict_read_subnet_list(dict_t *dict, string_t key, bool_t required, - string_t desc, struct cloc loc, - struct subnet_list *sl); -extern uint32_t string_to_ipaddr(item_t *i, string_t desc); +struct flagstr { + string_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_list_to_word(list_t *l, struct flagstr *f, + string_t desc); /***** END of configuration support *****/ /***** UTILITY functions *****/ -#define M_WARNING 1 -#define M_ERROR 2 -#define M_FATAL 4 -#define M_INFO 8 -#define M_DEBUG_CONFIG 16 -#define M_DEBUG_PHASE 32 - -extern void fatal(char *message, ...); -extern void fatal_perror(char *message, ...); -extern void fatal_status(int status, char *message, ...); -extern void fatal_perror_status(int status, char *message, ...); -extern void cfgfatal(struct cloc loc, string_t facility, char *message, ...); - extern char *safe_strdup(char *string, char *message); extern void *safe_malloc(size_t size, char *message); -extern void Message(uint32_t class, char *message, ...); - -extern string_t ipaddr_to_string(uint32_t addr); -extern string_t subnet_to_string(struct subnet *sn); - extern int sys_cmd(const char *file, char *argc, ...); /***** END of utility functions *****/ @@ -179,15 +153,25 @@ extern void register_for_poll(void *st, beforepoll_fn *before, #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_DROPPRIV 4 /* Last chance for privileged operations */ -#define PHASE_RUN 5 -#define PHASE_SHUTDOWN 6 /* About to die; delete key material, etc. */ -#define NR_PHASES 7 +#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 typedef void hook_fn(void *self, uint32_t newphase); bool_t add_hook(uint32_t phase, hook_fn *f, void *state); bool_t remove_hook(uint32_t phase, hook_fn *f, void *state); +extern uint32_t current_phase; +extern void enter_phase(uint32_t new_phase); + +/* Some features (like netlink 'soft' routes) require that secnet + retain root privileges. They should indicate that here when + appropriate. */ +extern bool_t require_root_privileges; +extern string_t require_root_privileges_explanation; + /***** END of program lifetime support *****/ /***** MODULE support *****/ @@ -195,26 +179,26 @@ bool_t remove_hook(uint32_t phase, hook_fn *f, void *state); /* Module initialisation function type - modules export one function of this type which is called to initialise them. For dynamically loaded modules it's called "secnet_module". */ -typedef void (init_module)(dict_t *dict); +typedef void init_module(dict_t *dict); /***** END of module support *****/ /***** CLOSURE TYPES and interface definitions *****/ -#define CL_PURE 0 -#define CL_RESOLVER 1 -#define CL_RANDOMSRC 2 -#define CL_RSAPUBKEY 3 -#define CL_RSAPRIVKEY 4 -#define CL_COMM 5 -#define CL_IPIF 6 -#define CL_LOG 7 -#define CL_SITE 8 -#define CL_TRANSFORM 9 -#define CL_NETLINK 10 -#define CL_DH 11 -#define CL_HASH 12 -#define CL_BUFFER 13 +#define CL_PURE 0 +#define CL_RESOLVER 1 +#define CL_RANDOMSRC 2 +#define CL_RSAPUBKEY 3 +#define CL_RSAPRIVKEY 4 +#define CL_COMM 5 +#define CL_IPIF 6 +#define CL_LOG 7 +#define CL_SITE 8 +#define CL_TRANSFORM 9 +#define CL_DH 11 +#define CL_HASH 12 +#define CL_BUFFER 13 +#define CL_NETLINK 14 struct buffer_if; @@ -226,6 +210,7 @@ struct buffer_if; type. 'address' will be NULL if there was a problem with the query. It will be freed once resolve_answer_fn returns. It is in network byte 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, resolve_answer_fn *cb, void *cst); @@ -276,6 +261,8 @@ typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf, struct sockaddr_in *dest); 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; @@ -283,15 +270,16 @@ struct comm_if { /* LOG interface */ -typedef void log_msg_fn(void *st, int priority, char *message, ...); -typedef void log_vmsg_fn(void *st, int priority, char *message, va_list args); +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); 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 priority, char *message, ...); +extern void log(struct log_if *lf, int class, char *message, ...) +FORMAT(printf,3,4); /* SITE interface */ @@ -344,24 +332,34 @@ struct transform_if { /* NETLINK interface */ -/* Used by netlink to deliver to site, and by site to deliver to netlink. - cid is the client identifier returned by netlink_regnets_fn */ -typedef void netlink_deliver_fn(void *st, void *cid, struct buffer_if *buf); +/* Used by netlink to deliver to site, and by site to deliver to + netlink. cid is the client identifier returned by + netlink_regnets_fn. If buf has size 0 then the function is just + being called for its site-effects (eg. making the site code attempt + to bring up a network link) */ +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 */ -typedef void netlink_can_deliver_fn(void *st, void *cid, bool_t can_deliver); -/* Register for packets from specified networks. Return value is client - identifier. */ -typedef void *netlink_regnets_fn(void *st, struct subnet_list *networks, - netlink_deliver_fn *deliver, void *dst, - uint32_t max_start_pad, uint32_t max_end_pad, - string_t client_name); - + 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 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); +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); struct netlink_if { void *st; - netlink_regnets_fn *regnets; + netlink_register_fn *reg; netlink_deliver_fn *deliver; - netlink_can_deliver_fn *set_delivery; + netlink_link_quality_fn *set_quality; + netlink_output_config_fn *output_config; + netlink_check_config_fn *check_config; + netlink_set_mtu_fn *set_mtu; }; /* DH interface */ @@ -405,4 +403,36 @@ struct buffer_if { uint32_t len; /* Total length allocated at base */ }; +/***** LOG functions *****/ + +#define M_DEBUG_CONFIG 0x001 +#define M_DEBUG_PHASE 0x002 +#define M_DEBUG 0x004 +#define M_INFO 0x008 +#define M_NOTICE 0x010 +#define M_WARNING 0x020 +#define M_ERR 0x040 +#define M_SECURITY 0x080 +#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, ...)); + +/* The cfgfatal() family of functions require messages that end in '\n' */ +extern NORETURN(cfgfatal(struct cloc loc, string_t facility, 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, + va_list)); +extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc, + string_t facility, char *message, ...)); + +extern void Message(uint32_t class, char *message, ...) FORMAT(printf,2,3); + +/***** END of log functions *****/ + #endif /* secnet_h */