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 resolver_module;
381 extern init_module random_module;
382 extern init_module udp_module;
383 extern init_module polypath_module;
384 extern init_module util_module;
385 extern init_module site_module;
386 extern init_module transform_eax_module;
387 extern init_module transform_cbcmac_module;
388 extern init_module netlink_module;
389 extern init_module rsa_module;
390 extern init_module dh_module;
391 extern init_module md5_module;
392 extern init_module slip_module;
393 extern init_module tun_module;
394 extern init_module sha1_module;
395 extern init_module log_module;
396 extern init_module privcache_module;
398 /***** END of module support *****/
400 /***** SIGNATURE SCHEMES *****/
402 struct sigscheme_info;
404 typedef bool_t sigscheme_loadpub(const struct sigscheme_info *algo,
405 struct buffer_if *pubkeydata,
406 struct sigpubkey_if **sigpub_r,
408 /* pubkeydata is (supposedly) for this algorithm.
409 * loadpub should log an error if it fails.
410 * pubkeydata may be modified (but not freed) */
412 typedef bool_t sigscheme_loadpriv(const struct sigscheme_info *algo,
413 struct buffer_if *privkeydata,
414 struct sigprivkey_if **sigpriv_r,
416 /* privkeydata may contain data for any algorithm, not necessarily
417 * this one! If it is not for this algorithm, return False and do
418 * not log anything (other than at M_DEBUG). If it *is* for this
419 * algorithm but is wrong, log at M_ERROR.
420 * On entry privkeydata->base==start. loadpriv may modify base and
421 * size, but not anything else. So it may use unprepend and
424 struct sigscheme_info {
427 sigscheme_loadpub *loadpub;
428 sigscheme_loadpriv *loadpriv;
431 extern const struct sigscheme_info rsa1_sigscheme;
432 extern const struct sigscheme_info sigschemes[]; /* sentinel has name==0 */
434 /***** END of signature schemes *****/
436 /***** CLOSURE TYPES and interface definitions *****/
439 #define CL_RESOLVER 1
440 #define CL_RANDOMSRC 2
441 #define CL_SIGPUBKEY 3
442 #define CL_SIGPRIVKEY 4
447 #define CL_TRANSFORM 9
451 #define CL_NETLINK 14
452 #define CL_PRIVCACHE 15
456 struct alg_msg_data {
461 /* PURE closure requires no interface */
463 /* RESOLVER interface */
465 /* Answers to queries are delivered to a function of this
466 type. 'address' will be NULL if there was a problem with the query. It
467 will be freed once resolve_answer_fn returns. naddrs is the actual
468 size of the array at addrs; was_naddrs is the number of addresses
469 actually found in the DNS, which may be bigger if addrs is equal
470 to MAX_PEER_ADDRS (ie there were too many). */
471 typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
472 int naddrs, int was_naddrs,
473 const char *name, const char *failwhy);
474 /* name is the same ptr as passed to request, so its lifetime must
476 typedef bool_t resolve_request_fn(void *st, cstring_t name,
477 int remoteport, struct comm_if *comm,
478 resolve_answer_fn *cb, void *cst);
481 resolve_request_fn *request;
484 /* RANDOMSRC interface */
486 /* Return some random data. Cannot fail. */
487 typedef void random_fn(void *st, int32_t bytes, uint8_t *buff);
495 /* SIGPUBKEY interface */
497 typedef void sig_sethash_fn(void *st, struct hash_if *hash);
498 typedef void sig_dispose_fn(void *st);
500 typedef bool_t sig_unpick_fn(void *sst, struct buffer_if *msg,
501 struct alg_msg_data *sig);
502 typedef bool_t sig_checksig_fn(void *st, uint8_t *data, int32_t datalen,
503 const struct alg_msg_data *sig);
504 struct sigpubkey_if {
506 sig_sethash_fn *sethash; /* must be called before use, if non-0 */
507 sig_unpick_fn *unpick;
508 sig_checksig_fn *check;
509 const struct hash_if *hash;
510 sig_dispose_fn *dispose;
513 /* SIGPRIVKEY interface */
515 /* Appends the signature to msg.
516 * Can fail and returnn False, eg if the buffer is too small. */
517 typedef bool_t sig_makesig_fn(void *st, uint8_t *data, int32_t datalen,
518 struct buffer_if *msg);
519 struct sigprivkey_if {
521 sig_sethash_fn *sethash; /* must be called before use, if non-0 */
522 sig_makesig_fn *sign;
523 const struct hash_if *hash;
524 sig_dispose_fn *dispose;
527 /* PRIVCACHE interface */
529 typedef struct sigprivkey_if *privcache_lookup_fn(void *st,
530 const struct sigkeyid *id,
532 /* Return is valid only until you return from the current event!
533 * You do not need to call ->sethash. */
535 struct privcache_if {
537 privcache_lookup_fn *lookup;
543 /* This struct is pure data; in particular comm's clients may
545 struct comm_if *comm;
547 int ix; /* see comment `Re comm_addr.ix' in udp.c */
550 struct comm_clientinfo; /* private for comm */
552 typedef struct comm_clientinfo *comm_clientinfo_fn(void *state, dict_t*,
554 /* A comm client may call this during configuration, and then pass
555 * the resulting comm_clientinfo* to some or all sendmsg calls.
556 * The semantics depend on the dict and defined by the comm, and
557 * should be documented in README. */
560 comm_notify_whynot_general,
561 comm_notify_whynot_unpick,
562 comm_notify_whynot_name_local,
563 comm_notify_whynot_name_remote,
566 /* Return True if the packet was processed, and shouldn't be passed to
567 any other potential receivers. (buf is freed iff True returned.) */
568 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
569 const struct comm_addr *source,
570 struct priomsg *whynot);
571 typedef void comm_request_notify_fn(void *commst, void *nst,
573 typedef void comm_release_notify_fn(void *commst, void *nst,
575 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
576 const struct comm_addr *dest,
577 struct comm_clientinfo* /* 0 OK */);
578 /* Only returns false if (we know that) the local network
579 * environment is such that this address cannot work; transient
580 * or unknown/unexpected failures return true. */
581 typedef const char *comm_addr_to_string_fn(void *commst,
582 const struct comm_addr *ca);
583 /* Returned string is in a static buffer. */
586 comm_clientinfo_fn *clientinfo;
587 comm_request_notify_fn *request_notify;
588 comm_release_notify_fn *release_notify;
589 comm_sendmsg_fn *sendmsg;
590 comm_addr_to_string_fn *addr_to_string;
593 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib,
596 static inline const char *comm_addr_to_string(const struct comm_addr *ca)
598 return ca->comm->addr_to_string(ca->comm->st, ca);
601 static inline bool_t comm_addr_equal(const struct comm_addr *a,
602 const struct comm_addr *b)
604 return a->comm==b->comm && iaddr_equal(&a->ia,&b->ia,False);
609 #define LOG_MESSAGE_BUFLEN 1023
611 typedef void log_msg_fn(void *st, int class, const char *message, ...);
612 typedef void log_vmsg_fn(void *st, int class, const char *message,
616 log_vmsg_fn *vlogfn; /* printf format checking. Use [v]slilog instead */
617 char buff[LOG_MESSAGE_BUFLEN+1];
619 /* (convenience functions, defined in util.c) */
620 extern void slilog(struct log_if *lf, int class, const char *message, ...)
622 extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
625 /* Versions which take (parts of) (multiple) messages, using \n to
626 * distinguish one message from another. */
627 extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
629 extern void vslilog_part(struct log_if *lf, int class, const char *message,
630 va_list) FORMAT(printf,3,0);
634 /* Pretty much a placeholder; allows starting and stopping of processing,
636 typedef void site_control_fn(void *st, bool_t run);
637 typedef uint32_t site_status_fn(void *st);
640 site_control_fn *control;
641 site_status_fn *status;
644 /* TRANSFORM interface */
646 /* A reversable transformation. Transforms buffer in-place; may add
647 data to start or end. (Reverse transformations decrease
648 length, of course.) Transformations may be key-dependent, in which
649 case key material is passed in at initialisation time. They may
650 also depend on internal factors (eg. time) and keep internal
651 state. A struct transform_if only represents a particular type of
652 transformation; instances of the transformation (eg. with
653 particular key material) have a different C type. The same
654 secret key will be used in opposite directions between a pair of
655 secnets; one of these pairs will get direction==False, the other True. */
657 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
658 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
660 typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
661 typedef void transform_delkey_fn(void *st);
662 typedef void transform_destroyinstance_fn(void *st);
665 transform_apply_ok = 0, /* all is well (everyone may assume==0) */
666 transform_apply_err = 1, /* any other problem */
667 transform_apply_seqrange = 2,
668 /* message decrypted but sequence number was out of recent range */
669 transform_apply_seqdupe = 3,
670 /* message decrypted but was dupe of recent packet */
671 } transform_apply_return;
674 transform_apply_return_badseq(transform_apply_return problem) {
675 return problem == transform_apply_seqrange ||
676 problem == transform_apply_seqdupe;
679 typedef transform_apply_return transform_apply_fn(void *st,
680 struct buffer_if *buf, const char **errmsg);
682 struct transform_inst_if {
684 transform_setkey_fn *setkey;
685 transform_valid_fn *valid;
686 transform_delkey_fn *delkey;
687 transform_apply_fn *forwards;
688 transform_apply_fn *reverse;
689 transform_destroyinstance_fn *destroy;
692 struct transform_if {
695 int32_t keylen; /* <<< INT_MAX */
696 transform_createinstance_fn *create;
699 /* NETLINK interface */
701 /* Used by netlink to deliver to site, and by site to deliver to
702 netlink. cid is the client identifier returned by
703 netlink_regnets_fn. If buf has size 0 then the function is just
704 being called for its site-effects (eg. making the site code attempt
705 to bring up a network link) */
706 typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
707 /* site code can tell netlink when outgoing packets will be dropped,
708 so netlink can generate appropriate ICMP and make routing decisions */
709 #define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */
710 #define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/
711 #define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
712 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
713 #define LINK_QUALITY_UP 4 /* Link active */
714 #define MAXIMUM_LINK_QUALITY 3
715 typedef void netlink_link_quality_fn(void *st, uint32_t quality);
716 typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
717 void *dst, uint32_t *localmtu_r /* NULL ok */);
718 typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
719 typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
720 typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
723 netlink_register_fn *reg;
724 netlink_deliver_fn *deliver;
725 netlink_link_quality_fn *set_quality;
726 netlink_set_mtu_fn *set_mtu;
731 /* Returns public key as a malloced hex string */
732 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
734 /* Fills buffer (up to buflen) with shared secret */
735 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
736 int32_t secretlen, cstring_t rempublic,
737 uint8_t *sharedsecret, int32_t buflen);
740 int32_t len; /* Approximate size of modulus in bytes */
741 int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
742 dh_makepublic_fn *makepublic;
743 dh_makeshared_fn *makeshared;
748 typedef void hash_init_fn(void *st /* slen bytes alloc'd by caller */);
749 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
750 typedef void hash_final_fn(void *st, uint8_t *digest /* hlen bytes */);
752 int32_t slen; /* State length in bytes */
753 int32_t hlen; /* Hash output length in bytes */
755 hash_update_fn *update;
756 hash_final_fn *final;
759 /* BUFFER interface */
763 cstring_t owner; /* Set to constant string */
764 struct cloc loc; /* Where we were defined */
767 int32_t size; /* Size of buffer contents */
768 int32_t alloclen; /* Total length allocated at base */
771 /***** LOG functions *****/
773 #define M_DEBUG_CONFIG 0x001
774 #define M_DEBUG_PHASE 0x002
775 #define M_DEBUG 0x004
777 #define M_NOTICE 0x010
778 #define M_WARNING 0x020
780 #define M_SECURITY 0x080
781 #define M_FATAL 0x100
783 /* The fatal() family of functions require messages that do not end in '\n' */
784 extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
785 extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
786 extern NORETURN(fatal_status(int status, const char *message, ...))
788 extern NORETURN(fatal_perror_status(int status, const char *message, ...))
791 /* Convenient nonfatal logging. Requires message that does not end in '\n'.
792 * If class contains M_FATAL, exits (after entering PHASE_SHUTDOWN).
793 * lg, errnoval and loc may sensibly be 0. desc must NOT be 0.
794 * lg_[v]perror save and restore errno. */
795 void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
796 int class, int errnoval, const char *fmt, va_list al)
798 void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
799 int class, int errnoval, const char *fmt, ...)
801 void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
802 int class, int status, const char *progname);
804 /* The cfgfatal() family of functions require messages that end in '\n' */
805 extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
806 const char *message, ...)) FORMAT(printf,3,4);
807 extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
808 extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
809 cstring_t facility, const char *message,
812 extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
814 const char *message, ...))
817 extern void Message(uint32_t class, const char *message, ...)
819 extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
821 /***** END of log functions *****/
823 #define STRING2(x) #x
824 #define STRING(x) STRING2(x)
826 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
827 #define ARRAY_SIZE(ary) (sizeof((ary))/sizeof((ary)[0]))
830 * void COPY_OBJ( OBJECT& dst, const OBJECT& src);
831 * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
832 * // Typesafe: we check that the type OBJECT is the same in both cases.
833 * // It is OK to use COPY_OBJ on an array object, provided dst is
834 * // _actually_ the whole array object and not decayed into a
835 * // pointer (e.g. a formal parameter).
837 #define COPY_OBJ(dst,src) \
838 (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst))))
839 #define COPY_ARRAY(dst,src,count) \
840 (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count)))
842 #endif /* secnet_h */