#include "config.h"
#include <stdlib.h>
#include <stdarg.h>
-#include <syslog.h>
+#include <stdio.h>
#include <sys/poll.h>
#include <sys/types.h>
#include <sys/time.h>
#include <netinet/in.h>
+/*
+ * 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 " __LINE__ \
- " file " __FILE__ "\n"); } while(0)
-
-/***** SHARED types *****/
+#define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
+ __FILE__,__LINE__); } } while(0)
-/* These are stored in HOST byte order */
-struct subnet {
- uint32_t prefix;
- uint32_t mask;
-};
+/* from version.c */
-struct subnet_list {
- uint32_t entries;
- struct subnet *list;
-};
+extern char version[];
-/* 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);
+/* from logmsg.c */
+extern uint32_t message_level;
+extern bool_t secnet_is_daemon;
+extern struct log_if *system_log;
-/***** END of shared types *****/
+/* 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
+ 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;
/* 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.
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 */
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;
/* 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 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 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);
+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 {
+ cstring_t name;
+ uint32_t value;
+};
+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,
+ cstring_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 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 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 int sys_cmd(const char *file, const char *argc, ...);
-extern char *safe_strdup(char *string, char *message);
-extern void *safe_malloc(size_t size, char *message);
+extern uint64_t now_global;
+extern struct timeval tv_now_global;
-extern void Message(uint32_t class, char *message, ...);
+static const uint64_t *const now = &now_global;
+static const struct timeval *const tv_now = &tv_now_global;
-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, ...);
+/* "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
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 */
#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 cstring_t require_root_privileges_explanation;
+
/***** END of program lifetime support *****/
/***** MODULE support *****/
/* 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);
+
+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 *****/
-#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;
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,
+typedef bool_t resolve_request_fn(void *st, cstring_t name,
resolve_answer_fn *cb, void *cst);
struct resolver_if {
void *st;
/* 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;
/* 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;
/* 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;
/* 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;
+ 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 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, 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 priority, 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 */
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;
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;
};
/* 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, 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, int32_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 */
/* 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;
};
/* 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;
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 *****/
+
+#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(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, 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,
+ cstring_t facility, const char *message,
+ va_list));
+extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
+ cstring_t facility,
+ const char *message, ...));
+
+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 */