1 /* Core interface of secnet, to be used by all modules */
6 #define ADNS_FEATURE_MANYAF
18 #include <sys/types.h>
20 #include <netinet/in.h>
21 #include <arpa/inet.h>
23 #include <bsd/sys/queue.h>
25 #define MAX_PEER_ADDRS 5
26 /* send at most this many copies; honour at most that many addresses */
31 typedef char *string_t;
32 typedef const char *cstring_t;
34 #define False (_Bool)0
40 struct sockaddr_in sin;
42 struct sockaddr_in6 sin6;
46 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
47 __FILE__,__LINE__); } } while(0)
51 extern char version[];
54 extern uint32_t message_level;
55 extern bool_t secnet_is_daemon;
56 extern struct log_if *system_log;
59 extern void start_signal_handling(void);
61 /***** CONFIGURATION support *****/
63 extern bool_t just_check_config; /* If True then we're going to exit after
64 reading the configuration file */
65 extern bool_t background; /* If True then we'll eventually run as a daemon */
67 typedef struct dict dict_t; /* Configuration dictionary */
68 typedef struct closure closure_t;
69 typedef struct item item_t;
70 typedef struct list list_t; /* A list of items */
72 /* Configuration file location, for error-reporting */
78 /* Modules export closures, which can be invoked from the configuration file.
79 "Invoking" a closure usually returns another closure (of a different
80 type), but can actually return any configuration object. */
81 typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
82 dict_t *context, list_t *data);
84 cstring_t description; /* For debugging */
85 uint32_t type; /* Central registry... */
87 void *interface; /* Interface for use inside secnet; depends on type */
90 enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
103 /* Note that it is unwise to use this structure directly; use the list
104 manipulation functions instead. */
110 /* In the following two lookup functions, NULL means 'not found' */
111 /* Lookup a value in the specified dictionary, or its parents */
112 extern list_t *dict_lookup(dict_t *dict, cstring_t key);
113 /* Lookup a value in just the specified dictionary */
114 extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key);
115 /* Add a value to the specified dictionary */
116 extern void dict_add(dict_t *dict, cstring_t key, list_t *val);
117 /* Obtain an array of keys in the dictionary. malloced; caller frees */
118 extern cstring_t *dict_keys(dict_t *dict);
120 /* List-manipulation functions */
121 extern list_t *list_new(void);
122 extern int32_t list_length(const list_t *a);
123 extern list_t *list_append(list_t *a, item_t *i);
124 extern list_t *list_append_list(list_t *a, list_t *b);
125 /* Returns an item from the list (index starts at 0), or NULL */
126 extern item_t *list_elem(list_t *l, int32_t index);
128 /* Convenience functions */
129 extern list_t *new_closure(closure_t *cl);
130 extern void add_closure(dict_t *dict, cstring_t name, apply_fn apply);
131 extern void *find_cl_if(dict_t *dict, cstring_t name, uint32_t type,
132 bool_t fail_if_invalid, cstring_t desc,
134 extern item_t *dict_find_item(dict_t *dict, cstring_t key, bool_t required,
135 cstring_t desc, struct cloc loc);
136 extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required,
137 cstring_t desc, struct cloc loc);
138 extern uint32_t dict_read_number(dict_t *dict, cstring_t key, bool_t required,
139 cstring_t desc, struct cloc loc,
141 /* return value can safely be assigned to int32_t */
142 extern bool_t dict_read_bool(dict_t *dict, cstring_t key, bool_t required,
143 cstring_t desc, struct cloc loc, bool_t def);
144 const char **dict_read_string_array(dict_t *dict, cstring_t key,
145 bool_t required, cstring_t desc,
146 struct cloc loc, const char *const *def);
147 /* Return value is a NULL-terminated array obtained from malloc;
148 * Individual string values are still owned by config file machinery
149 * and must not be modified or freed. Returns NULL if key not
156 extern uint32_t string_to_word(cstring_t s, struct cloc loc,
157 struct flagstr *f, cstring_t desc);
158 extern uint32_t string_list_to_word(list_t *l, struct flagstr *f,
161 /***** END of configuration support *****/
163 /***** UTILITY functions *****/
165 extern char *safe_strdup(const char *string, const char *message);
166 extern void *safe_malloc(size_t size, const char *message);
167 extern void *safe_malloc_ary(size_t size, size_t count, const char *message);
168 extern void *safe_realloc_ary(void *p, size_t size, size_t count,
169 const char *message);
171 void setcloexec(int fd); /* cannot fail */
172 void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
174 extern int sys_cmd(const char *file, const char *argc, ...);
176 extern uint64_t now_global;
177 extern struct timeval tv_now_global;
179 static const uint64_t *const now = &now_global;
180 static const struct timeval *const tv_now = &tv_now_global;
182 /* "now" is current program time, in milliseconds. It is derived
183 from tv_now. Both are provided by the event loop. */
185 /***** END of utility functions *****/
187 /***** START of max_start_pad handling *****/
189 extern int32_t site_max_start_pad, transform_max_start_pad,
192 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance);
193 int32_t calculate_max_start_pad(void);
195 /***** END of max_start_pad handling *****/
197 /***** SCHEDULING support */
199 /* If nfds_io is insufficient for your needs, set it to the required
200 number and return ERANGE. timeout is in milliseconds; if it is too
201 high then lower it. It starts at -1 (==infinite). */
202 /* Note that beforepoll_fn may NOT do anything which might change the
203 fds or timeouts wanted by other registered poll loop loopers.
204 Callers should make sure of this by not making any calls into other
205 modules from the beforepoll_fn; the easiest way to ensure this is
206 for beforepoll_fn to only retreive information and not take any
209 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
211 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
213 /* void BEFOREPOLL_WANT_FDS(int want);
214 * Expects: int *nfds_io;
215 * Can perform non-local exit.
216 * Checks whether there is space for want fds. If so, sets *nfds_io.
217 * If not, sets *nfds_io and returns. */
218 #define BEFOREPOLL_WANT_FDS(want) do{ \
219 if (*nfds_io<(want)) { *nfds_io=(want); return ERANGE; } \
223 /* Register interest in the main loop of the program. Before a call
224 to poll() your supplied beforepoll function will be called. After
225 the call to poll() the supplied afterpoll function will be called. */
226 struct poll_interest *register_for_poll(void *st, beforepoll_fn *before,
227 afterpoll_fn *after, cstring_t desc);
228 void deregister_for_poll(struct poll_interest *i);
230 /***** END of scheduling support */
232 /***** PROGRAM LIFETIME support */
234 /* The secnet program goes through a number of phases in its lifetime.
235 Module code may arrange to be called just as various phases are
238 Remember to update the table in util.c if changing the set of
243 PHASE_GETOPTS, /* Process command-line arguments */
244 PHASE_READCONFIG, /* Parse and process configuration file */
245 PHASE_SETUP, /* Process information in configuration */
246 PHASE_DAEMONIZE, /* Become a daemon (if necessary) */
247 PHASE_GETRESOURCES, /* Obtain all external resources */
248 PHASE_DROPPRIV, /* Last chance for privileged operations */
250 PHASE_SHUTDOWN, /* About to die; delete key material, etc. */
251 /* Keep this last: */
255 typedef void hook_fn(void *self, uint32_t newphase);
256 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
257 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
259 extern uint32_t current_phase;
260 extern void enter_phase(uint32_t new_phase);
262 /* Some features (like netlink 'soft' routes) require that secnet
263 retain root privileges. They should indicate that here when
265 extern bool_t require_root_privileges;
266 extern cstring_t require_root_privileges_explanation;
268 /***** END of program lifetime support *****/
270 /***** MODULE support *****/
272 /* Module initialisation function type - modules export one function of
273 this type which is called to initialise them. For dynamically loaded
274 modules it's called "secnet_module". */
275 typedef void init_module(dict_t *dict);
277 extern void init_builtin_modules(dict_t *dict);
279 extern init_module resolver_module;
280 extern init_module random_module;
281 extern init_module udp_module;
282 extern init_module util_module;
283 extern init_module site_module;
284 extern init_module transform_eax_module;
285 extern init_module transform_cbcmac_module;
286 extern init_module netlink_module;
287 extern init_module rsa_module;
288 extern init_module dh_module;
289 extern init_module md5_module;
290 extern init_module slip_module;
291 extern init_module tun_module;
292 extern init_module sha1_module;
293 extern init_module log_module;
295 /***** END of module support *****/
297 /***** CLOSURE TYPES and interface definitions *****/
300 #define CL_RESOLVER 1
301 #define CL_RANDOMSRC 2
302 #define CL_RSAPUBKEY 3
303 #define CL_RSAPRIVKEY 4
308 #define CL_TRANSFORM 9
312 #define CL_NETLINK 14
316 /* PURE closure requires no interface */
318 /* RESOLVER interface */
320 /* Answers to queries are delivered to a function of this
321 type. 'address' will be NULL if there was a problem with the query. It
322 will be freed once resolve_answer_fn returns. It is in network byte
324 typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
325 int naddrs, const char *name,
326 const char *failwhy);
327 /* name is the same ptr as passed to request, so its lifetime must
329 typedef bool_t resolve_request_fn(void *st, cstring_t name,
330 int remoteport, struct comm_if *comm,
331 resolve_answer_fn *cb, void *cst);
334 resolve_request_fn *request;
337 /* RANDOMSRC interface */
339 /* Return some random data. Returns TRUE for success. */
340 typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff);
348 /* RSAPUBKEY interface */
350 typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen,
351 cstring_t signature);
352 struct rsapubkey_if {
354 rsa_checksig_fn *check;
357 /* RSAPRIVKEY interface */
359 typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen);
360 struct rsaprivkey_if {
362 rsa_makesig_fn *sign;
368 /* This struct is pure data; in particular comm's clients may
370 /* Everyone is also guaranteed that all padding is set to zero, ie
371 that comm_addrs referring to semantically identical peers will
372 compare equal with memcmp. Anyone who constructs a comm_addr
373 must start by memsetting it with FILLZERO, or some
375 struct comm_if *comm;
380 /* Return True if the packet was processed, and shouldn't be passed to
381 any other potential receivers. */
382 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
383 const struct comm_addr *source);
384 typedef void comm_request_notify_fn(void *commst, void *nst,
386 typedef void comm_release_notify_fn(void *commst, void *nst,
388 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
389 const struct comm_addr *dest);
390 /* Only returns false if (we know that) the local network
391 * environment is such that this address cannot work; transient
392 * or unknown/unexpected failures return true. */
393 typedef const char *comm_addr_to_string_fn(void *commst,
394 const struct comm_addr *ca);
395 /* Returned string is in a static buffer. */
398 comm_request_notify_fn *request_notify;
399 comm_release_notify_fn *release_notify;
400 comm_sendmsg_fn *sendmsg;
401 comm_addr_to_string_fn *addr_to_string;
404 static inline const char *comm_addr_to_string(const struct comm_addr *ca)
406 return ca->comm->addr_to_string(ca->comm->st, ca);
411 #define LOG_MESSAGE_BUFLEN 1023
413 typedef void log_msg_fn(void *st, int class, const char *message, ...);
414 typedef void log_vmsg_fn(void *st, int class, const char *message,
418 log_vmsg_fn *vlogfn; /* printf format checking. Use [v]slilog instead */
419 char buff[LOG_MESSAGE_BUFLEN+1];
421 /* (convenience functions, defined in util.c) */
422 extern void slilog(struct log_if *lf, int class, const char *message, ...)
424 extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
427 /* Versions which take (parts of) (multiple) messages, using \n to
428 * distinguish one message from another. */
429 extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
431 extern void vslilog_part(struct log_if *lf, int class, const char *message,
432 va_list) FORMAT(printf,3,0);
436 /* Pretty much a placeholder; allows starting and stopping of processing,
438 typedef void site_control_fn(void *st, bool_t run);
439 typedef uint32_t site_status_fn(void *st);
442 site_control_fn *control;
443 site_status_fn *status;
446 /* TRANSFORM interface */
448 /* A reversable transformation. Transforms buffer in-place; may add
449 data to start or end. (Reverse transformations decrease
450 length, of course.) Transformations may be key-dependent, in which
451 case key material is passed in at initialisation time. They may
452 also depend on internal factors (eg. time) and keep internal
453 state. A struct transform_if only represents a particular type of
454 transformation; instances of the transformation (eg. with
455 particular key material) have a different C type. The same
456 secret key will be used in opposite directions between a pair of
457 secnets; one of these pairs will get direction==False, the other True. */
459 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
460 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
462 typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
463 typedef void transform_delkey_fn(void *st);
464 typedef void transform_destroyinstance_fn(void *st);
467 * 1: for any other problem
468 * 2: message decrypted but sequence number was out of range
470 typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
471 const char **errmsg);
473 struct transform_inst_if {
475 transform_setkey_fn *setkey;
476 transform_valid_fn *valid;
477 transform_delkey_fn *delkey;
478 transform_apply_fn *forwards;
479 transform_apply_fn *reverse;
480 transform_destroyinstance_fn *destroy;
483 struct transform_if {
485 int capab_transformnum;
486 int32_t keylen; /* <<< INT_MAX */
487 transform_createinstance_fn *create;
490 /* NETLINK interface */
492 /* Used by netlink to deliver to site, and by site to deliver to
493 netlink. cid is the client identifier returned by
494 netlink_regnets_fn. If buf has size 0 then the function is just
495 being called for its site-effects (eg. making the site code attempt
496 to bring up a network link) */
497 typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
498 /* site code can tell netlink when outgoing packets will be dropped,
499 so netlink can generate appropriate ICMP and make routing decisions */
500 #define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */
501 #define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/
502 #define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
503 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
504 #define LINK_QUALITY_UP 4 /* Link active */
505 #define MAXIMUM_LINK_QUALITY 3
506 typedef void netlink_link_quality_fn(void *st, uint32_t quality);
507 typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
508 void *dst, uint32_t *localmtu_r /* NULL ok */);
509 typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
510 typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
511 typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
514 netlink_register_fn *reg;
515 netlink_deliver_fn *deliver;
516 netlink_link_quality_fn *set_quality;
517 netlink_set_mtu_fn *set_mtu;
522 /* Returns public key as a malloced hex string */
523 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
525 /* Fills buffer (up to buflen) with shared secret */
526 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
527 int32_t secretlen, cstring_t rempublic,
528 uint8_t *sharedsecret, int32_t buflen);
531 int32_t len; /* Approximate size of modulus in bytes */
532 int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
533 dh_makepublic_fn *makepublic;
534 dh_makeshared_fn *makeshared;
539 typedef void *hash_init_fn(void);
540 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
541 typedef void hash_final_fn(void *st, uint8_t *digest);
543 int32_t len; /* Hash output length in bytes */
545 hash_update_fn *update;
546 hash_final_fn *final;
549 /* BUFFER interface */
553 cstring_t owner; /* Set to constant string */
554 uint32_t flags; /* How paranoid should we be? */
555 struct cloc loc; /* Where we were defined */
558 int32_t size; /* Size of buffer contents */
559 int32_t alloclen; /* Total length allocated at base */
562 /***** LOG functions *****/
564 #define M_DEBUG_CONFIG 0x001
565 #define M_DEBUG_PHASE 0x002
566 #define M_DEBUG 0x004
568 #define M_NOTICE 0x010
569 #define M_WARNING 0x020
571 #define M_SECURITY 0x080
572 #define M_FATAL 0x100
574 /* The fatal() family of functions require messages that do not end in '\n' */
575 extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
576 extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
577 extern NORETURN(fatal_status(int status, const char *message, ...))
579 extern NORETURN(fatal_perror_status(int status, const char *message, ...))
582 /* Convenient nonfatal logging. Requires message that does not end in '\n'.
583 * If class contains M_FATAL, exits (after entering PHASE_SHUTDOWN).
584 * lg, errnoval and loc may sensibly be 0. desc must NOT be 0.
585 * lg_[v]perror save and restore errno. */
586 void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
587 int class, int errnoval, const char *fmt, va_list al)
589 void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
590 int class, int errnoval, const char *fmt, ...)
593 /* The cfgfatal() family of functions require messages that end in '\n' */
594 extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
595 const char *message, ...)) FORMAT(printf,3,4);
596 extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
597 extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
598 cstring_t facility, const char *message,
601 extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
603 const char *message, ...))
606 extern void Message(uint32_t class, const char *message, ...)
608 extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
610 /***** END of log functions *****/
612 #define STRING2(x) #x
613 #define STRING(x) STRING2(x)
615 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
616 #define ARRAY_SIZE(ary) (sizeof(ary)/sizeof(ary[0]))
619 * void COPY_OBJ( OBJECT& dst, const OBJECT& src);
620 * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
621 * // Typesafe: we check that the type OBJECT is the same in both cases.
622 * // It is OK to use COPY_OBJ on an array object, proviced it's
623 * // _actually_ the whole array object and not decayed into a
624 * // pointer (e.g. a formal parameter).
626 #define COPY_OBJ(dst,src) \
627 (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst))))
628 #define COPY_ARRAY(dst,src,count) \
629 (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count)))
631 #endif /* secnet_h */