1 /* Core interface of secnet, to be used by all modules */
15 #include <sys/types.h>
17 #include <netinet/in.h>
18 #include <arpa/inet.h>
20 #define MAX_PEER_ADDRS 5
21 /* send at most this many copies; honour at most that many addresses */
26 typedef char *string_t;
27 typedef const char *cstring_t;
29 #define False (_Bool)0
35 struct sockaddr_in sin;
37 struct sockaddr_in6 sin6;
41 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
42 __FILE__,__LINE__); } } while(0)
46 extern char version[];
49 extern uint32_t message_level;
50 extern bool_t secnet_is_daemon;
51 extern struct log_if *system_log;
54 extern void start_signal_handling(void);
56 /***** CONFIGURATION support *****/
58 extern bool_t just_check_config; /* If True then we're going to exit after
59 reading the configuration file */
60 extern bool_t background; /* If True then we'll eventually run as a daemon */
62 typedef struct dict dict_t; /* Configuration dictionary */
63 typedef struct closure closure_t;
64 typedef struct item item_t;
65 typedef struct list list_t; /* A list of items */
67 /* Configuration file location, for error-reporting */
73 /* Modules export closures, which can be invoked from the configuration file.
74 "Invoking" a closure usually returns another closure (of a different
75 type), but can actually return any configuration object. */
76 typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
77 dict_t *context, list_t *data);
79 cstring_t description; /* For debugging */
80 uint32_t type; /* Central registry... */
82 void *interface; /* Interface for use inside secnet; depends on type */
85 enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
98 /* Note that it is unwise to use this structure directly; use the list
99 manipulation functions instead. */
105 /* In the following two lookup functions, NULL means 'not found' */
106 /* Lookup a value in the specified dictionary, or its parents */
107 extern list_t *dict_lookup(dict_t *dict, cstring_t key);
108 /* Lookup a value in just the specified dictionary */
109 extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key);
110 /* Add a value to the specified dictionary */
111 extern void dict_add(dict_t *dict, cstring_t key, list_t *val);
112 /* Obtain an array of keys in the dictionary. malloced; caller frees */
113 extern cstring_t *dict_keys(dict_t *dict);
115 /* List-manipulation functions */
116 extern list_t *list_new(void);
117 extern int32_t list_length(const list_t *a);
118 extern list_t *list_append(list_t *a, item_t *i);
119 extern list_t *list_append_list(list_t *a, list_t *b);
120 /* Returns an item from the list (index starts at 0), or NULL */
121 extern item_t *list_elem(list_t *l, int32_t index);
123 /* Convenience functions */
124 extern list_t *new_closure(closure_t *cl);
125 extern void add_closure(dict_t *dict, cstring_t name, apply_fn apply);
126 extern void *find_cl_if(dict_t *dict, cstring_t name, uint32_t type,
127 bool_t fail_if_invalid, cstring_t desc,
129 extern item_t *dict_find_item(dict_t *dict, cstring_t key, bool_t required,
130 cstring_t desc, struct cloc loc);
131 extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required,
132 cstring_t desc, struct cloc loc);
133 extern uint32_t dict_read_number(dict_t *dict, cstring_t key, bool_t required,
134 cstring_t desc, struct cloc loc,
136 /* return value can safely be assigned to int32_t */
137 extern bool_t dict_read_bool(dict_t *dict, cstring_t key, bool_t required,
138 cstring_t desc, struct cloc loc, bool_t def);
143 extern uint32_t string_to_word(cstring_t s, struct cloc loc,
144 struct flagstr *f, cstring_t desc);
145 extern uint32_t string_list_to_word(list_t *l, struct flagstr *f,
148 /***** END of configuration support *****/
150 /***** UTILITY functions *****/
152 extern char *safe_strdup(const char *string, const char *message);
153 extern void *safe_malloc(size_t size, const char *message);
154 extern void *safe_malloc_ary(size_t size, size_t count, const char *message);
156 void setcloexec(int fd); /* cannot fail */
157 void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
159 extern int sys_cmd(const char *file, const char *argc, ...);
161 extern uint64_t now_global;
162 extern struct timeval tv_now_global;
164 static const uint64_t *const now = &now_global;
165 static const struct timeval *const tv_now = &tv_now_global;
167 /* "now" is current program time, in milliseconds. It is derived
168 from tv_now. Both are provided by the event loop. */
170 /***** END of utility functions *****/
172 /***** START of max_start_pad handling *****/
174 extern int32_t site_max_start_pad, transform_max_start_pad,
177 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance);
178 int32_t calculate_max_start_pad(void);
180 /***** END of max_start_pad handling *****/
182 /***** SCHEDULING support */
184 /* If nfds_io is insufficient for your needs, set it to the required
185 number and return ERANGE. timeout is in milliseconds; if it is too
186 high then lower it. It starts at -1 (==infinite) */
187 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
189 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
191 /* Register interest in the main loop of the program. Before a call
192 to poll() your supplied beforepoll function will be called. After
193 the call to poll() the supplied afterpoll function will be called.
194 max_nfds is a _hint_ about the maximum number of struct pollfd
195 structures you may require - you can always ask for more in
197 extern void register_for_poll(void *st, beforepoll_fn *before,
198 afterpoll_fn *after, int32_t max_nfds,
201 /***** END of scheduling support */
203 /***** PROGRAM LIFETIME support */
205 /* The secnet program goes through a number of phases in its lifetime.
206 Module code may arrange to be called just as various phases are
209 Remember to update the table in util.c if changing the set of
214 PHASE_GETOPTS, /* Process command-line arguments */
215 PHASE_READCONFIG, /* Parse and process configuration file */
216 PHASE_SETUP, /* Process information in configuration */
217 PHASE_DAEMONIZE, /* Become a daemon (if necessary) */
218 PHASE_GETRESOURCES, /* Obtain all external resources */
219 PHASE_DROPPRIV, /* Last chance for privileged operations */
221 PHASE_SHUTDOWN, /* About to die; delete key material, etc. */
222 /* Keep this last: */
226 typedef void hook_fn(void *self, uint32_t newphase);
227 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
228 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
230 extern uint32_t current_phase;
231 extern void enter_phase(uint32_t new_phase);
233 /* Some features (like netlink 'soft' routes) require that secnet
234 retain root privileges. They should indicate that here when
236 extern bool_t require_root_privileges;
237 extern cstring_t require_root_privileges_explanation;
239 /***** END of program lifetime support *****/
241 /***** MODULE support *****/
243 /* Module initialisation function type - modules export one function of
244 this type which is called to initialise them. For dynamically loaded
245 modules it's called "secnet_module". */
246 typedef void init_module(dict_t *dict);
248 extern void init_builtin_modules(dict_t *dict);
250 extern init_module resolver_module;
251 extern init_module random_module;
252 extern init_module udp_module;
253 extern init_module util_module;
254 extern init_module site_module;
255 extern init_module transform_eax_module;
256 extern init_module transform_cbcmac_module;
257 extern init_module netlink_module;
258 extern init_module rsa_module;
259 extern init_module dh_module;
260 extern init_module md5_module;
261 extern init_module slip_module;
262 extern init_module tun_module;
263 extern init_module sha1_module;
264 extern init_module log_module;
266 /***** END of module support *****/
268 /***** CLOSURE TYPES and interface definitions *****/
271 #define CL_RESOLVER 1
272 #define CL_RANDOMSRC 2
273 #define CL_RSAPUBKEY 3
274 #define CL_RSAPRIVKEY 4
279 #define CL_TRANSFORM 9
283 #define CL_NETLINK 14
287 /* PURE closure requires no interface */
289 /* RESOLVER interface */
291 /* Answers to queries are delivered to a function of this
292 type. 'address' will be NULL if there was a problem with the query. It
293 will be freed once resolve_answer_fn returns. naddrs is the actual
294 size of the array at addrs; was_naddrs is the number of addresses
295 actually found in the DNS, which may be bigger if addrs is equal
296 to MAX_PEER_ADDRS (ie there were too many). */
297 typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
298 int naddrs, int was_naddrs);
299 typedef bool_t resolve_request_fn(void *st, cstring_t name,
300 int remoteport, struct comm_if *comm,
301 resolve_answer_fn *cb, void *cst);
304 resolve_request_fn *request;
307 /* RANDOMSRC interface */
309 /* Return some random data. Returns TRUE for success. */
310 typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff);
318 /* RSAPUBKEY interface */
320 typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen,
321 cstring_t signature);
322 struct rsapubkey_if {
324 rsa_checksig_fn *check;
327 /* RSAPRIVKEY interface */
329 typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen);
330 struct rsaprivkey_if {
332 rsa_makesig_fn *sign;
338 /* This struct is pure data; in particular comm's clients may
340 struct comm_if *comm;
342 int ix; /* see comment `Re comm_addr.ix' in udp.c */
345 /* Return True if the packet was processed, and shouldn't be passed to
346 any other potential receivers. */
347 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
348 const struct comm_addr *source);
349 typedef void comm_request_notify_fn(void *commst, void *nst,
351 typedef void comm_release_notify_fn(void *commst, void *nst,
353 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
354 const struct comm_addr *dest);
355 /* Only returns false if (we know that) the local network
356 * environment is such that this address cannot work; transient
357 * or unknown/unexpected failures return true. */
358 typedef const char *comm_addr_to_string_fn(void *commst,
359 const struct comm_addr *ca);
360 /* Returned string is in a static buffer. */
363 comm_request_notify_fn *request_notify;
364 comm_release_notify_fn *release_notify;
365 comm_sendmsg_fn *sendmsg;
366 comm_addr_to_string_fn *addr_to_string;
369 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib);
371 static inline const char *comm_addr_to_string(const struct comm_addr *ca)
373 return ca->comm->addr_to_string(ca->comm->st, ca);
376 static inline bool_t comm_addr_equal(const struct comm_addr *a,
377 const struct comm_addr *b)
379 return a->comm==b->comm && iaddr_equal(&a->ia,&b->ia);
384 #define LOG_MESSAGE_BUFLEN 1023
386 typedef void log_msg_fn(void *st, int class, const char *message, ...);
387 typedef void log_vmsg_fn(void *st, int class, const char *message,
391 log_vmsg_fn *vlogfn; /* printf format checking. Use [v]slilog instead */
392 char buff[LOG_MESSAGE_BUFLEN+1];
394 /* (convenience functions, defined in util.c) */
395 extern void slilog(struct log_if *lf, int class, const char *message, ...)
397 extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
400 /* Versions which take (parts of) (multiple) messages, using \n to
401 * distinguish one message from another. */
402 extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
404 extern void vslilog_part(struct log_if *lf, int class, const char *message,
405 va_list) FORMAT(printf,3,0);
409 /* Pretty much a placeholder; allows starting and stopping of processing,
411 typedef void site_control_fn(void *st, bool_t run);
412 typedef uint32_t site_status_fn(void *st);
415 site_control_fn *control;
416 site_status_fn *status;
419 /* TRANSFORM interface */
421 /* A reversable transformation. Transforms buffer in-place; may add
422 data to start or end. (Reverse transformations decrease
423 length, of course.) Transformations may be key-dependent, in which
424 case key material is passed in at initialisation time. They may
425 also depend on internal factors (eg. time) and keep internal
426 state. A struct transform_if only represents a particular type of
427 transformation; instances of the transformation (eg. with
428 particular key material) have a different C type. The same
429 secret key will be used in opposite directions between a pair of
430 secnets; one of these pairs will get direction==False, the other True. */
432 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
433 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
435 typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
436 typedef void transform_delkey_fn(void *st);
437 typedef void transform_destroyinstance_fn(void *st);
440 * 1: for any other problem
441 * 2: message decrypted but sequence number was out of range
443 typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
444 const char **errmsg);
446 struct transform_inst_if {
448 transform_setkey_fn *setkey;
449 transform_valid_fn *valid;
450 transform_delkey_fn *delkey;
451 transform_apply_fn *forwards;
452 transform_apply_fn *reverse;
453 transform_destroyinstance_fn *destroy;
456 struct transform_if {
458 int capab_transformnum;
459 int32_t keylen; /* <<< INT_MAX */
460 transform_createinstance_fn *create;
463 /* NETLINK interface */
465 /* Used by netlink to deliver to site, and by site to deliver to
466 netlink. cid is the client identifier returned by
467 netlink_regnets_fn. If buf has size 0 then the function is just
468 being called for its site-effects (eg. making the site code attempt
469 to bring up a network link) */
470 typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
471 /* site code can tell netlink when outgoing packets will be dropped,
472 so netlink can generate appropriate ICMP and make routing decisions */
473 #define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */
474 #define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/
475 #define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
476 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
477 #define LINK_QUALITY_UP 4 /* Link active */
478 #define MAXIMUM_LINK_QUALITY 3
479 typedef void netlink_link_quality_fn(void *st, uint32_t quality);
480 typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
481 void *dst, uint32_t *localmtu_r /* NULL ok */);
482 typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
483 typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
484 typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
487 netlink_register_fn *reg;
488 netlink_deliver_fn *deliver;
489 netlink_link_quality_fn *set_quality;
490 netlink_set_mtu_fn *set_mtu;
495 /* Returns public key as a malloced hex string */
496 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
498 /* Fills buffer (up to buflen) with shared secret */
499 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
500 int32_t secretlen, cstring_t rempublic,
501 uint8_t *sharedsecret, int32_t buflen);
504 int32_t len; /* Approximate size of modulus in bytes */
505 int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
506 dh_makepublic_fn *makepublic;
507 dh_makeshared_fn *makeshared;
512 typedef void *hash_init_fn(void);
513 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
514 typedef void hash_final_fn(void *st, uint8_t *digest);
516 int32_t len; /* Hash output length in bytes */
518 hash_update_fn *update;
519 hash_final_fn *final;
522 /* BUFFER interface */
526 cstring_t owner; /* Set to constant string */
527 uint32_t flags; /* How paranoid should we be? */
528 struct cloc loc; /* Where we were defined */
531 int32_t size; /* Size of buffer contents */
532 int32_t alloclen; /* Total length allocated at base */
535 /***** LOG functions *****/
537 #define M_DEBUG_CONFIG 0x001
538 #define M_DEBUG_PHASE 0x002
539 #define M_DEBUG 0x004
541 #define M_NOTICE 0x010
542 #define M_WARNING 0x020
544 #define M_SECURITY 0x080
545 #define M_FATAL 0x100
547 /* The fatal() family of functions require messages that do not end in '\n' */
548 extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
549 extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
550 extern NORETURN(fatal_status(int status, const char *message, ...))
552 extern NORETURN(fatal_perror_status(int status, const char *message, ...))
555 /* The cfgfatal() family of functions require messages that end in '\n' */
556 extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
557 const char *message, ...)) FORMAT(printf,3,4);
558 extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
559 extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
560 cstring_t facility, const char *message,
563 extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
565 const char *message, ...))
568 extern void Message(uint32_t class, const char *message, ...)
570 extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
572 /***** END of log functions *****/
574 #define STRING2(x) #x
575 #define STRING(x) STRING2(x)
577 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
578 #define ARRAY_SIZE(ary) (sizeof((ary))/sizeof((ary)[0]))
581 * void COPY_OBJ( OBJECT& dst, const OBJECT& src);
582 * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
583 * // Typesafe: we check that the type OBJECT is the same in both cases.
584 * // It is OK to use COPY_OBJ on an array object, provided it's
585 * // _actually_ the whole array object and not decayed into a
586 * // pointer (e.g. a formal parameter).
588 #define COPY_OBJ(dst,src) \
589 (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst))))
590 #define COPY_ARRAY(dst,src,count) \
591 (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count)))
593 #endif /* secnet_h */