1 /* Core interface of secnet, to be used by all modules */
3 * This file is part of secnet.
4 * See README for full list of copyright holders.
6 * secnet is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * secnet is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * version 3 along with secnet; if not, see
18 * https://www.gnu.org/licenses/gpl.html.
24 #define ADNS_FEATURE_MANYAF
40 #include <sys/types.h>
43 #include <netinet/in.h>
44 #include <arpa/inet.h>
46 #include <bsd/sys/queue.h>
50 #define MAX_PEER_ADDRS 5
51 /* send at most this many copies; honour at most that many addresses */
53 #define MAX_NAK_MSG 80
54 #define MAX_SIG_KEYS 4
65 typedef char *string_t;
66 typedef const char *cstring_t;
68 #define False (_Bool)0
74 struct sockaddr_in sin;
76 struct sockaddr_in6 sin6;
82 #define KEYIDSZ (GRPIDSZ+ALGIDSZ)
83 /* Changing these is complex: this is the group id plus algo id */
84 /* They are costructed by pubkeys.fl.pl. Also hardcoded in _PR_ */
85 struct sigkeyid { uint8_t b[KEYIDSZ]; };
87 #define SIGKEYID_PR_FMT "%02x%02x%02x%02x%02x"
88 #define SIGKEYID_PR_VAL(id) /* SIGKEYID_PR_VAL(const sigkeyid *id) */ \
89 ((id) == (const struct sigkeyid*)0, (id)->b[0]), \
90 (id)->b[1],(id)->b[2],(id)->b[3],(id)->b[4]
91 static inline bool_t sigkeyid_equal(const struct sigkeyid *a,
92 const struct sigkeyid *b) {
93 return !memcmp(a->b, b->b, KEYIDSZ);
97 typedef uint32_t serialt;
98 static inline int serial_cmp(serialt a, serialt b) {
102 return b-a <= (serialt)0x7fffffffUL ? +1 : -1;
105 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
106 __FILE__,__LINE__); } } while(0)
110 extern char version[];
113 extern uint32_t message_level;
114 extern bool_t secnet_is_daemon;
115 extern struct log_if *system_log;
118 extern void start_signal_handling(void);
120 void afterfork(void);
121 /* Must be called before exec in every child made after
122 start_signal_handling. Safe to call in earlier children too. */
124 void childpersist_closefd_hook(void *fd_p, uint32_t newphase);
125 /* Convenience hook function for use with add_hook PHASE_CHILDPERSIST.
126 With `int fd' in your state struct, pass fd_p=&fd. The hook checks
127 whether fd>=0, so you can use it for an fd which is only sometimes
128 open. This function will set fd to -1, so it is idempotent. */
130 /***** CONFIGURATION support *****/
132 extern bool_t just_check_config; /* If True then we're going to exit after
133 reading the configuration file */
134 extern bool_t background; /* If True then we'll eventually run as a daemon */
136 typedef struct dict dict_t; /* Configuration dictionary */
137 typedef struct closure closure_t;
138 typedef struct item item_t;
139 typedef struct list list_t; /* A list of items */
141 /* Configuration file location, for error-reporting */
147 /* Modules export closures, which can be invoked from the configuration file.
148 "Invoking" a closure usually returns another closure (of a different
149 type), but can actually return any configuration object. */
150 typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
151 dict_t *context, list_t *data);
153 cstring_t description; /* For debugging */
154 uint32_t type; /* Central registry... */
156 void *interface; /* Interface for use inside secnet; depends on type */
159 enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
172 /* Note that it is unwise to use this structure directly; use the list
173 manipulation functions instead. */
179 /* In the following two lookup functions, NULL means 'not found' */
180 /* Lookup a value in the specified dictionary, or its parents */
181 extern list_t *dict_lookup(dict_t *dict, cstring_t key);
182 /* Lookup a value in just the specified dictionary */
183 extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key);
184 /* Add a value to the specified dictionary */
185 extern void dict_add(dict_t *dict, cstring_t key, list_t *val);
186 /* Obtain an array of keys in the dictionary. malloced; caller frees */
187 extern cstring_t *dict_keys(dict_t *dict);
189 /* List-manipulation functions */
190 extern list_t *list_new(void);
191 extern int32_t list_length(const list_t *a);
192 extern list_t *list_append(list_t *a, item_t *i);
193 extern list_t *list_append_list(list_t *a, list_t *b);
194 /* Returns an item from the list (index starts at 0), or NULL */
195 extern item_t *list_elem(list_t *l, int32_t index);
197 /* Convenience functions */
198 extern list_t *new_closure(closure_t *cl);
199 extern void add_closure(dict_t *dict, cstring_t name, apply_fn apply);
200 extern void *find_cl_if(dict_t *dict, cstring_t name, uint32_t type,
201 bool_t fail_if_invalid, cstring_t desc,
203 extern item_t *dict_find_item(dict_t *dict, cstring_t key, bool_t required,
204 cstring_t desc, struct cloc loc);
205 extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required,
206 cstring_t desc, struct cloc loc);
207 extern uint32_t dict_read_number(dict_t *dict, cstring_t key, bool_t required,
208 cstring_t desc, struct cloc loc,
210 /* return value can safely be assigned to int32_t */
211 extern bool_t dict_read_bool(dict_t *dict, cstring_t key, bool_t required,
212 cstring_t desc, struct cloc loc, bool_t def);
213 extern dict_t *dict_read_dict(dict_t *dict, cstring_t key, bool_t required,
214 cstring_t desc, struct cloc loc);
215 const char **dict_read_string_array(dict_t *dict, cstring_t key,
216 bool_t required, cstring_t desc,
217 struct cloc loc, const char *const *def);
218 /* Return value is a NULL-terminated array obtained from malloc;
219 * Individual string values are still owned by config file machinery
220 * and must not be modified or freed. Returns NULL if key not
227 extern uint32_t string_to_word(cstring_t s, struct cloc loc,
228 struct flagstr *f, cstring_t desc);
229 extern uint32_t string_list_to_word(list_t *l, struct flagstr *f,
232 /***** END of configuration support *****/
234 /***** UTILITY functions *****/
236 extern char *safe_strdup(const char *string, const char *message);
237 extern void *safe_malloc(size_t size, const char *message);
238 extern void *safe_malloc_ary(size_t size, size_t count, const char *message);
239 extern void *safe_realloc_ary(void *p, size_t size, size_t count,
240 const char *message);
243 ((p)=safe_malloc(sizeof(*(p)), \
245 #define NEW_ARY(p,count) \
246 ((p)=safe_malloc_ary(sizeof(*(p)),(count), \
247 __FILE__ ":" #p "[" #count "]"))
248 #define REALLOC_ARY(p,count) \
249 ((p)=safe_realloc_ary((p),sizeof(*(p)),(count), \
250 __FILE__ ":" #p "[" #count "]"))
252 void setcloexec(int fd); /* cannot fail */
253 void setnonblock(int fd); /* cannot fail */
254 void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
256 extern int sys_cmd(const char *file, const char *argc, ...);
258 extern uint64_t now_global;
259 extern struct timeval tv_now_global;
261 static const uint64_t *const now = &now_global;
262 static const struct timeval *const tv_now = &tv_now_global;
264 /* "now" is current program time, in milliseconds. It is derived
265 from tv_now. Both are provided by the event loop. */
267 /***** END of utility functions *****/
269 /***** START of max_start_pad handling *****/
271 extern int32_t site_max_start_pad, transform_max_start_pad,
274 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance);
275 int32_t calculate_max_start_pad(void);
277 /***** END of max_start_pad handling *****/
279 /***** SCHEDULING support */
281 /* If nfds_io is insufficient for your needs, set it to the required
282 number and return ERANGE. timeout is in milliseconds; if it is too
283 high then lower it. It starts at -1 (==infinite). */
284 /* Note that beforepoll_fn may NOT do anything which might change the
285 fds or timeouts wanted by other registered poll loop loopers.
286 Callers should make sure of this by not making any calls into other
287 modules from the beforepoll_fn; the easiest way to ensure this is
288 for beforepoll_fn to only retreive information and not take any
291 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
293 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
294 /* If beforepoll_fn returned ERANGE, afterpoll_fn gets nfds==0.
295 afterpoll_fn never gets !!(fds[].revents & POLLNVAL) - such
296 a report is detected as a fatal error by the event loop. */
298 /* void BEFOREPOLL_WANT_FDS(int want);
299 * Expects: int *nfds_io;
300 * Can perform non-local exit.
301 * Checks whether there is space for want fds. If so, sets *nfds_io.
302 * If not, sets *nfds_io and returns. */
303 #define BEFOREPOLL_WANT_FDS(want) do{ \
304 if (*nfds_io<(want)) { *nfds_io=(want); return ERANGE; } \
308 /* Register interest in the main loop of the program. Before a call
309 to poll() your supplied beforepoll function will be called. After
310 the call to poll() the supplied afterpoll function will be called. */
311 struct poll_interest *register_for_poll(void *st, beforepoll_fn *before,
312 afterpoll_fn *after, cstring_t desc);
313 void deregister_for_poll(struct poll_interest *i);
315 /***** END of scheduling support */
317 /***** PROGRAM LIFETIME support */
319 /* The secnet program goes through a number of phases in its lifetime.
320 Module code may arrange to be called just as various phases are
323 Remember to update the table in util.c if changing the set of
328 PHASE_GETOPTS, /* Process command-line arguments */
329 PHASE_READCONFIG, /* Parse and process configuration file */
330 PHASE_SETUP, /* Process information in configuration */
331 PHASE_DAEMONIZE, /* Become a daemon (if necessary) */
332 PHASE_GETRESOURCES, /* Obtain all external resources */
333 PHASE_DROPPRIV, /* Last chance for privileged operations */
335 PHASE_SHUTDOWN, /* About to die; delete key material, etc. */
336 PHASE_CHILDPERSIST, /* Forked long-term child: close fds, etc. */
337 /* Keep this last: */
341 /* Each module should, in its CHILDPERSIST hooks, close all fds which
342 constitute ownership of important operating system resources, or
343 which are used for IPC with other processes who want to get the
344 usual disconnection effects if the main secnet process dies.
345 CHILDPERSIST hooks are not run if the child is going to exec;
346 so fds such as described above should be CLOEXEC too. */
348 typedef void hook_fn(void *self, uint32_t newphase);
349 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
350 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
352 extern uint32_t current_phase;
353 extern void enter_phase(uint32_t new_phase);
355 void phase_hooks_init(void); /* for main() only */
356 void clear_phase_hooks(uint32_t phase); /* for afterfork() */
358 /* Some features (like netlink 'soft' routes) require that secnet
359 retain root privileges. They should indicate that here when
361 extern bool_t require_root_privileges;
362 extern cstring_t require_root_privileges_explanation;
364 /* Some modules may want to know whether secnet is going to drop
365 privilege, so that they know whether to do privsep. Call only
366 in phases SETUP and later. */
367 bool_t will_droppriv(void);
369 /***** END of program lifetime support *****/
371 /***** MODULE support *****/
373 /* Module initialisation function type - modules export one function of
374 this type which is called to initialise them. For dynamically loaded
375 modules it's called "secnet_module". */
376 typedef void init_module(dict_t *dict);
378 extern void init_builtin_modules(dict_t *dict);
380 extern init_module pubkeys_init;
381 extern init_module resolver_module;
382 extern init_module random_module;
383 extern init_module udp_module;
384 extern init_module polypath_module;
385 extern init_module util_module;
386 extern init_module site_module;
387 extern init_module transform_eax_module;
388 extern init_module transform_cbcmac_module;
389 extern init_module netlink_module;
390 extern init_module rsa_module;
391 extern init_module dh_module;
392 extern init_module md5_module;
393 extern init_module slip_module;
394 extern init_module tun_module;
395 extern init_module sha1_module;
396 extern init_module log_module;
397 extern init_module privcache_module;
399 /***** END of module support *****/
401 /***** SIGNATURE SCHEMES *****/
403 struct sigscheme_info;
405 typedef bool_t sigscheme_loadpub(const struct sigscheme_info *algo,
406 struct buffer_if *pubkeydata,
407 struct sigpubkey_if **sigpub_r,
408 closure_t **closure_r,
409 struct log_if *log, struct cloc loc);
410 /* pubkeydata is (supposedly) for this algorithm.
411 * loadpub should log an error if it fails.
412 * pubkeydata may be modified (but not freed).
413 * both *sigpub_r and *closure_r must always be written and must
414 * refer to the same object, so on successful return
415 * (*closure_r)->type==CL_SIGPUBKEY
416 * and (*closure_r)->interface==*sigpub_r */
418 typedef bool_t sigscheme_loadpriv(const struct sigscheme_info *algo,
419 struct buffer_if *privkeydata,
420 struct sigprivkey_if **sigpriv_r,
421 struct log_if *log, struct cloc loc);
422 /* Ideally, check whether privkeydata contains data for any algorithm.
423 * That avoids security problems if a key file is misidentified (which
424 * might happen if the file is simply renamed).
425 * If there is an error (including that the key data is not for this
426 * algorithm, return False and log an error at M_ERROR.
427 * On entry privkeydata->base==start. loadpriv may modify
428 * privkeydata, including the contents. */
430 struct sigscheme_info {
433 sigscheme_loadpub *loadpub;
434 sigscheme_loadpriv *loadpriv;
437 extern const struct sigscheme_info rsa1_sigscheme;
438 extern const struct sigscheme_info sigschemes[]; /* sentinel has name==0 */
440 const struct sigscheme_info *sigscheme_lookup(const char *name);
442 extern sigscheme_loadpriv rsa1_loadpriv;
443 extern sigscheme_loadpub rsa1_loadpub;
445 /***** END of signature schemes *****/
447 /***** CLOSURE TYPES and interface definitions *****/
450 #define CL_RESOLVER 1
451 #define CL_RANDOMSRC 2
452 #define CL_SIGPUBKEY 3
453 #define CL_SIGPRIVKEY 4
458 #define CL_TRANSFORM 9
462 #define CL_NETLINK 14
463 #define CL_PRIVCACHE 15
467 struct alg_msg_data {
472 /* PURE closure requires no interface */
474 /* RESOLVER interface */
476 /* Answers to queries are delivered to a function of this
477 type. 'address' will be NULL if there was a problem with the query. It
478 will be freed once resolve_answer_fn returns. naddrs is the actual
479 size of the array at addrs; was_naddrs is the number of addresses
480 actually found in the DNS, which may be bigger if addrs is equal
481 to MAX_PEER_ADDRS (ie there were too many). */
482 typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
483 int naddrs, int was_naddrs,
484 const char *name, const char *failwhy);
485 /* name is the same ptr as passed to request, so its lifetime must
487 typedef bool_t resolve_request_fn(void *st, cstring_t name,
488 int remoteport, struct comm_if *comm,
489 resolve_answer_fn *cb, void *cst);
492 resolve_request_fn *request;
495 /* RANDOMSRC interface */
497 /* Return some random data. Cannot fail. */
498 typedef void random_fn(void *st, int32_t bytes, uint8_t *buff);
506 /* SIGPUBKEY interface */
508 typedef void sig_sethash_fn(void *st, struct hash_if *hash);
509 typedef void sig_dispose_fn(void *st);
511 typedef bool_t sig_unpick_fn(void *sst, struct buffer_if *msg,
512 struct alg_msg_data *sig);
513 typedef bool_t sig_checksig_fn(void *st, uint8_t *data, int32_t datalen,
514 const struct alg_msg_data *sig);
515 struct sigpubkey_if {
517 sig_sethash_fn *sethash; /* must be called before use, if non-0 */
518 sig_unpick_fn *unpick;
519 sig_checksig_fn *check;
520 const struct hash_if *hash;
521 sig_dispose_fn *dispose;
524 /* SIGPRIVKEY interface */
526 /* Appends the signature to msg.
527 * Can fail and returnn False, eg if the buffer is too small. */
528 typedef bool_t sig_makesig_fn(void *st, uint8_t *data, int32_t datalen,
529 struct buffer_if *msg);
530 struct sigprivkey_if {
532 sig_sethash_fn *sethash; /* must be called before use, if non-0 */
533 sig_makesig_fn *sign;
534 const struct hash_if *hash;
535 sig_dispose_fn *dispose;
538 /* PRIVCACHE interface */
540 typedef struct sigprivkey_if *privcache_lookup_fn(void *st,
541 const struct sigkeyid *id,
543 /* Return is valid only until you return from the current event!
544 * You do not need to call ->sethash. */
546 struct privcache_if {
548 privcache_lookup_fn *lookup;
554 /* This struct is pure data; in particular comm's clients may
556 struct comm_if *comm;
558 int ix; /* see comment `Re comm_addr.ix' in udp.c */
561 struct comm_clientinfo; /* private for comm */
563 typedef struct comm_clientinfo *comm_clientinfo_fn(void *state, dict_t*,
565 /* A comm client may call this during configuration, and then pass
566 * the resulting comm_clientinfo* to some or all sendmsg calls.
567 * The semantics depend on the dict and defined by the comm, and
568 * should be documented in README. */
571 comm_notify_whynot_general,
572 comm_notify_whynot_unpick,
573 comm_notify_whynot_name_local,
574 comm_notify_whynot_name_remote,
577 /* Return True if the packet was processed, and shouldn't be passed to
578 any other potential receivers. (buf is freed iff True returned.) */
579 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
580 const struct comm_addr *source,
581 struct priomsg *whynot);
582 typedef void comm_request_notify_fn(void *commst, void *nst,
584 typedef void comm_release_notify_fn(void *commst, void *nst,
586 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
587 const struct comm_addr *dest,
588 struct comm_clientinfo* /* 0 OK */);
589 /* Only returns false if (we know that) the local network
590 * environment is such that this address cannot work; transient
591 * or unknown/unexpected failures return true. */
592 typedef const char *comm_addr_to_string_fn(void *commst,
593 const struct comm_addr *ca);
594 /* Returned string is in a static buffer. */
597 comm_clientinfo_fn *clientinfo;
598 comm_request_notify_fn *request_notify;
599 comm_release_notify_fn *release_notify;
600 comm_sendmsg_fn *sendmsg;
601 comm_addr_to_string_fn *addr_to_string;
604 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib,
607 static inline const char *comm_addr_to_string(const struct comm_addr *ca)
609 return ca->comm->addr_to_string(ca->comm->st, ca);
612 static inline bool_t comm_addr_equal(const struct comm_addr *a,
613 const struct comm_addr *b)
615 return a->comm==b->comm && iaddr_equal(&a->ia,&b->ia,False);
620 #define LOG_MESSAGE_BUFLEN 1023
622 typedef void log_msg_fn(void *st, int class, const char *message, ...);
623 typedef void log_vmsg_fn(void *st, int class, const char *message,
627 log_vmsg_fn *vlogfn; /* printf format checking. Use [v]slilog instead */
628 char buff[LOG_MESSAGE_BUFLEN+1];
630 /* (convenience functions, defined in util.c) */
631 extern void slilog(struct log_if *lf, int class, const char *message, ...)
633 extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
636 /* Versions which take (parts of) (multiple) messages, using \n to
637 * distinguish one message from another. */
638 extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
640 extern void vslilog_part(struct log_if *lf, int class, const char *message,
641 va_list) FORMAT(printf,3,0);
643 void cfgfile_log__vmsg(void *sst, int class, const char *message, va_list);
648 const char *facility;
650 static inline void cfgfile_log_init(struct cfgfile_log *cfl,
651 struct cloc loc, const char *facility)
654 cfl->log.vlogfn=cfgfile_log__vmsg;
656 cfl->facility=facility;
661 /* Pretty much a placeholder; allows starting and stopping of processing,
663 typedef void site_control_fn(void *st, bool_t run);
664 typedef uint32_t site_status_fn(void *st);
667 site_control_fn *control;
668 site_status_fn *status;
671 /* TRANSFORM interface */
673 /* A reversable transformation. Transforms buffer in-place; may add
674 data to start or end. (Reverse transformations decrease
675 length, of course.) Transformations may be key-dependent, in which
676 case key material is passed in at initialisation time. They may
677 also depend on internal factors (eg. time) and keep internal
678 state. A struct transform_if only represents a particular type of
679 transformation; instances of the transformation (eg. with
680 particular key material) have a different C type. The same
681 secret key will be used in opposite directions between a pair of
682 secnets; one of these pairs will get direction==False, the other True. */
684 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
685 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
687 typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
688 typedef void transform_delkey_fn(void *st);
689 typedef void transform_destroyinstance_fn(void *st);
692 transform_apply_ok = 0, /* all is well (everyone may assume==0) */
693 transform_apply_err = 1, /* any other problem */
694 transform_apply_seqrange = 2,
695 /* message decrypted but sequence number was out of recent range */
696 transform_apply_seqdupe = 3,
697 /* message decrypted but was dupe of recent packet */
698 } transform_apply_return;
701 transform_apply_return_badseq(transform_apply_return problem) {
702 return problem == transform_apply_seqrange ||
703 problem == transform_apply_seqdupe;
706 typedef transform_apply_return transform_apply_fn(void *st,
707 struct buffer_if *buf, const char **errmsg);
709 struct transform_inst_if {
711 transform_setkey_fn *setkey;
712 transform_valid_fn *valid;
713 transform_delkey_fn *delkey;
714 transform_apply_fn *forwards;
715 transform_apply_fn *reverse;
716 transform_destroyinstance_fn *destroy;
719 struct transform_if {
722 int32_t keylen; /* <<< INT_MAX */
723 transform_createinstance_fn *create;
726 /* NETLINK interface */
728 /* Used by netlink to deliver to site, and by site to deliver to
729 netlink. cid is the client identifier returned by
730 netlink_regnets_fn. If buf has size 0 then the function is just
731 being called for its site-effects (eg. making the site code attempt
732 to bring up a network link) */
733 typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
734 /* site code can tell netlink when outgoing packets will be dropped,
735 so netlink can generate appropriate ICMP and make routing decisions */
736 #define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */
737 #define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/
738 #define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
739 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
740 #define LINK_QUALITY_UP 4 /* Link active */
741 #define MAXIMUM_LINK_QUALITY 3
742 typedef void netlink_link_quality_fn(void *st, uint32_t quality);
743 typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
744 void *dst, uint32_t *localmtu_r /* NULL ok */);
745 typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
746 typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
747 typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
750 netlink_register_fn *reg;
751 netlink_deliver_fn *deliver;
752 netlink_link_quality_fn *set_quality;
753 netlink_set_mtu_fn *set_mtu;
758 /* Returns public key as a malloced hex string */
759 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
761 /* Fills buffer (up to buflen) with shared secret */
762 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
763 int32_t secretlen, cstring_t rempublic,
764 uint8_t *sharedsecret, int32_t buflen);
767 int32_t len; /* Approximate size of modulus in bytes */
768 int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
769 dh_makepublic_fn *makepublic;
770 dh_makeshared_fn *makeshared;
775 typedef void hash_init_fn(void *st /* slen bytes alloc'd by caller */);
776 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
777 typedef void hash_final_fn(void *st, uint8_t *digest /* hlen bytes */);
779 int32_t slen; /* State length in bytes */
780 int32_t hlen; /* Hash output length in bytes */
782 hash_update_fn *update;
783 hash_final_fn *final;
786 /* BUFFER interface */
790 cstring_t owner; /* Set to constant string */
791 struct cloc loc; /* Where we were defined */
794 int32_t size; /* Size of buffer contents */
795 int32_t alloclen; /* Total length allocated at base */
798 /***** LOG functions *****/
800 #define M_DEBUG_CONFIG 0x001
801 #define M_DEBUG_PHASE 0x002
802 #define M_DEBUG 0x004
804 #define M_NOTICE 0x010
805 #define M_WARNING 0x020
807 #define M_SECURITY 0x080
808 #define M_FATAL 0x100
810 /* The fatal() family of functions require messages that do not end in '\n' */
811 extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
812 extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
813 extern NORETURN(fatal_status(int status, const char *message, ...))
815 extern NORETURN(fatal_perror_status(int status, const char *message, ...))
818 /* Convenient nonfatal logging. Requires message that does not end in '\n'.
819 * If class contains M_FATAL, exits (after entering PHASE_SHUTDOWN).
820 * lg, errnoval and loc may sensibly be 0. desc must NOT be 0.
821 * lg_[v]perror save and restore errno. */
822 void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
823 int class, int errnoval, const char *fmt, va_list al)
825 void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
826 int class, int errnoval, const char *fmt, ...)
828 void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
829 int class, int status, const char *progname);
831 /* The cfgfatal() family of functions require messages that end in '\n' */
832 extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
833 const char *message, ...)) FORMAT(printf,3,4);
834 extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
835 extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
836 cstring_t facility, const char *message,
837 va_list, const char *suffix))
839 extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
841 const char *message, ...))
844 extern void Message(uint32_t class, const char *message, ...)
846 extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
848 /***** END of log functions *****/
850 #define STRING2(x) #x
851 #define STRING(x) STRING2(x)
853 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
854 #define ARRAY_SIZE(ary) (sizeof((ary))/sizeof((ary)[0]))
857 * void COPY_OBJ( OBJECT& dst, const OBJECT& src);
858 * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
859 * // Typesafe: we check that the type OBJECT is the same in both cases.
860 * // It is OK to use COPY_OBJ on an array object, provided dst is
861 * // _actually_ the whole array object and not decayed into a
862 * // pointer (e.g. a formal parameter).
864 #define COPY_OBJ(dst,src) \
865 (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst))))
866 #define COPY_ARRAY(dst,src,count) \
867 (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count)))
869 #endif /* secnet_h */