Build system: Fix check for <linux/if_tun.h> and remove our copy
[secnet] / secnet.h
CommitLineData
2fe58dfd
SE
1/* Core interface of secnet, to be used by all modules */
2
3#ifndef secnet_h
4#define secnet_h
5
0e646750
IJ
6#define ADNS_FEATURE_MANYAF
7
59635212 8#include "config.h"
2fe58dfd 9#include <stdlib.h>
2fe58dfd 10#include <stdarg.h>
4f5e39ec 11#include <stdio.h>
b02b720a
IJ
12#include <string.h>
13#include <assert.h>
4fb0f88d
IJ
14#include <fcntl.h>
15#include <unistd.h>
ee697dd9 16#include <errno.h>
ce5c098f 17#include <fnmatch.h>
2fe58dfd 18#include <sys/poll.h>
8689b3a9 19#include <sys/types.h>
45736f73 20#include <sys/wait.h>
8689b3a9 21#include <sys/time.h>
2fe58dfd 22#include <netinet/in.h>
cc420616
IJ
23#include <arpa/inet.h>
24
6bad2cd5
IJ
25#include <bsd/sys/queue.h>
26
cc420616
IJ
27#define MAX_PEER_ADDRS 5
28/* send at most this many copies; honour at most that many addresses */
29
30struct comm_if;
31struct comm_addr;
2fe58dfd 32
2fe58dfd 33typedef char *string_t;
fe5e9cc4 34typedef const char *cstring_t;
09aecaa2
IJ
35
36#define False (_Bool)0
37#define True (_Bool)1
38typedef _Bool bool_t;
2fe58dfd 39
a32d56fb
IJ
40union iaddr {
41 struct sockaddr sa;
42 struct sockaddr_in sin;
61dbc9e0
IJ
43#ifdef CONFIG_IPV6
44 struct sockaddr_in6 sin6;
45#endif
a32d56fb
IJ
46};
47
794f2398 48#define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
4f5e39ec 49 __FILE__,__LINE__); } } while(0)
2fe58dfd 50
fcbc5905
IJ
51/* from version.c */
52
53extern char version[];
54
08ee90a2
IJ
55/* from logmsg.c */
56extern uint32_t message_level;
57extern bool_t secnet_is_daemon;
58extern struct log_if *system_log;
59
60/* from process.c */
61extern void start_signal_handling(void);
62
5e7a5e2d
IJ
63void afterfork(void);
64/* Must be called before exec in every child made after
65 start_signal_handling. Safe to call in earlier children too. */
66
32654a31
IJ
67void childpersist_closefd_hook(void *fd_p, uint32_t newphase);
68/* Convenience hook function for use with add_hook PHASE_CHILDPERSIST.
69 With `int fd' in your state struct, pass fd_p=&fd. The hook checks
70 whether fd>=0, so you can use it for an fd which is only sometimes
71 open. This function will set fd to -1, so it is idempotent. */
72
2fe58dfd
SE
73/***** CONFIGURATION support *****/
74
baa06aeb
SE
75extern bool_t just_check_config; /* If True then we're going to exit after
76 reading the configuration file */
b2a56f7c 77extern bool_t background; /* If True then we'll eventually run as a daemon */
baa06aeb 78
2fe58dfd
SE
79typedef struct dict dict_t; /* Configuration dictionary */
80typedef struct closure closure_t;
81typedef struct item item_t;
82typedef struct list list_t; /* A list of items */
83
84/* Configuration file location, for error-reporting */
85struct cloc {
fe5e9cc4 86 cstring_t file;
1caa23ff 87 int line;
2fe58dfd
SE
88};
89
90/* Modules export closures, which can be invoked from the configuration file.
91 "Invoking" a closure usually returns another closure (of a different
92 type), but can actually return any configuration object. */
93typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
94 dict_t *context, list_t *data);
95struct closure {
fe5e9cc4 96 cstring_t description; /* For debugging */
2fe58dfd
SE
97 uint32_t type; /* Central registry... */
98 apply_fn *apply;
99 void *interface; /* Interface for use inside secnet; depends on type */
100};
101
102enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
103struct item {
104 enum types type;
105 union {
106 bool_t bool;
107 string_t string;
108 uint32_t number;
109 dict_t *dict;
110 closure_t *closure;
111 } data;
112 struct cloc loc;
113};
114
ff05a229
SE
115/* Note that it is unwise to use this structure directly; use the list
116 manipulation functions instead. */
2fe58dfd
SE
117struct list {
118 item_t *item;
119 struct list *next;
120};
121
122/* In the following two lookup functions, NULL means 'not found' */
123/* Lookup a value in the specified dictionary, or its parents */
fe5e9cc4 124extern list_t *dict_lookup(dict_t *dict, cstring_t key);
2fe58dfd 125/* Lookup a value in just the specified dictionary */
fe5e9cc4 126extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key);
2fe58dfd 127/* Add a value to the specified dictionary */
fe5e9cc4 128extern void dict_add(dict_t *dict, cstring_t key, list_t *val);
2fe58dfd 129/* Obtain an array of keys in the dictionary. malloced; caller frees */
fe5e9cc4 130extern cstring_t *dict_keys(dict_t *dict);
2fe58dfd
SE
131
132/* List-manipulation functions */
133extern list_t *list_new(void);
a094a1ba 134extern int32_t list_length(const list_t *a);
2fe58dfd
SE
135extern list_t *list_append(list_t *a, item_t *i);
136extern list_t *list_append_list(list_t *a, list_t *b);
137/* Returns an item from the list (index starts at 0), or NULL */
1caa23ff 138extern item_t *list_elem(list_t *l, int32_t index);
2fe58dfd
SE
139
140/* Convenience functions */
141extern list_t *new_closure(closure_t *cl);
fe5e9cc4
SE
142extern void add_closure(dict_t *dict, cstring_t name, apply_fn apply);
143extern void *find_cl_if(dict_t *dict, cstring_t name, uint32_t type,
144 bool_t fail_if_invalid, cstring_t desc,
2fe58dfd 145 struct cloc loc);
fe5e9cc4
SE
146extern item_t *dict_find_item(dict_t *dict, cstring_t key, bool_t required,
147 cstring_t desc, struct cloc loc);
148extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required,
149 cstring_t desc, struct cloc loc);
150extern uint32_t dict_read_number(dict_t *dict, cstring_t key, bool_t required,
151 cstring_t desc, struct cloc loc,
152 uint32_t def);
59230b9b 153 /* return value can safely be assigned to int32_t */
fe5e9cc4
SE
154extern bool_t dict_read_bool(dict_t *dict, cstring_t key, bool_t required,
155 cstring_t desc, struct cloc loc, bool_t def);
55e96f16
IJ
156const char **dict_read_string_array(dict_t *dict, cstring_t key,
157 bool_t required, cstring_t desc,
158 struct cloc loc, const char *const *def);
159 /* Return value is a NULL-terminated array obtained from malloc;
160 * Individual string values are still owned by config file machinery
161 * and must not be modified or freed. Returns NULL if key not
162 * found. */
163
9d3a4132 164struct flagstr {
fe5e9cc4 165 cstring_t name;
9d3a4132
SE
166 uint32_t value;
167};
fe5e9cc4
SE
168extern uint32_t string_to_word(cstring_t s, struct cloc loc,
169 struct flagstr *f, cstring_t desc);
9d3a4132 170extern uint32_t string_list_to_word(list_t *l, struct flagstr *f,
fe5e9cc4 171 cstring_t desc);
2fe58dfd
SE
172
173/***** END of configuration support *****/
174
7138d0c5
SE
175/***** UTILITY functions *****/
176
fe5e9cc4
SE
177extern char *safe_strdup(const char *string, const char *message);
178extern void *safe_malloc(size_t size, const char *message);
bb9d0561 179extern void *safe_malloc_ary(size_t size, size_t count, const char *message);
6f146b5d
IJ
180extern void *safe_realloc_ary(void *p, size_t size, size_t count,
181 const char *message);
2fe58dfd 182
8f828e0f
IJ
183#define NEW(p) \
184 ((p)=safe_malloc(sizeof(*(p)), \
185 __FILE__ ":" #p))
186#define NEW_ARY(p,count) \
187 ((p)=safe_malloc_ary(sizeof(*(p)),(count), \
188 __FILE__ ":" #p "[" #count "]"))
189#define REALLOC_ARY(p,count) \
190 ((p)=safe_realloc_ary((p),sizeof(*(p)),(count), \
191 __FILE__ ":" #p "[" #count "]"))
192
4fb0f88d 193void setcloexec(int fd); /* cannot fail */
f54d5ada 194void setnonblock(int fd); /* cannot fail */
6a06198c 195void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
4fb0f88d 196
fe5e9cc4 197extern int sys_cmd(const char *file, const char *argc, ...);
4efd681a 198
698280de
IJ
199extern uint64_t now_global;
200extern struct timeval tv_now_global;
201
202static const uint64_t *const now = &now_global;
203static const struct timeval *const tv_now = &tv_now_global;
204
205/* "now" is current program time, in milliseconds. It is derived
206 from tv_now. Both are provided by the event loop. */
207
2fe58dfd
SE
208/***** END of utility functions *****/
209
3abd18e8
IJ
210/***** START of max_start_pad handling *****/
211
212extern int32_t site_max_start_pad, transform_max_start_pad,
213 comm_max_start_pad;
214
215void update_max_start_pad(int32_t *our_module_global, int32_t our_instance);
216int32_t calculate_max_start_pad(void);
217
218/***** END of max_start_pad handling *****/
219
2fe58dfd
SE
220/***** SCHEDULING support */
221
90a39563
IJ
222/* If nfds_io is insufficient for your needs, set it to the required
223 number and return ERANGE. timeout is in milliseconds; if it is too
51abbe5f
IJ
224 high then lower it. It starts at -1 (==infinite). */
225/* Note that beforepoll_fn may NOT do anything which might change the
226 fds or timeouts wanted by other registered poll loop loopers.
227 Callers should make sure of this by not making any calls into other
228 modules from the beforepoll_fn; the easiest way to ensure this is
229 for beforepoll_fn to only retreive information and not take any
230 action.
231 */
2fe58dfd 232typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
90a39563
IJ
233 int *timeout_io);
234typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
51abbe5f
IJ
235 /* If beforepoll_fn returned ERANGE, afterpoll_fn gets nfds==0.
236 afterpoll_fn never gets !!(fds[].revents & POLLNVAL) - such
237 a report is detected as a fatal error by the event loop. */
2fe58dfd 238
ee697dd9
IJ
239/* void BEFOREPOLL_WANT_FDS(int want);
240 * Expects: int *nfds_io;
241 * Can perform non-local exit.
242 * Checks whether there is space for want fds. If so, sets *nfds_io.
243 * If not, sets *nfds_io and returns. */
244#define BEFOREPOLL_WANT_FDS(want) do{ \
245 if (*nfds_io<(want)) { *nfds_io=(want); return ERANGE; } \
246 *nfds_io=(want); \
247 }while(0)
248
2fe58dfd
SE
249/* Register interest in the main loop of the program. Before a call
250 to poll() your supplied beforepoll function will be called. After
32fc582f 251 the call to poll() the supplied afterpoll function will be called. */
8bebb299 252struct poll_interest *register_for_poll(void *st, beforepoll_fn *before,
32fc582f 253 afterpoll_fn *after, cstring_t desc);
8bebb299 254void deregister_for_poll(struct poll_interest *i);
2fe58dfd
SE
255
256/***** END of scheduling support */
257
258/***** PROGRAM LIFETIME support */
259
260/* The secnet program goes through a number of phases in its lifetime.
261 Module code may arrange to be called just as various phases are
7b1a9fb7
RK
262 entered.
263
264 Remember to update the table in util.c if changing the set of
265 phases. */
2fe58dfd 266
42394c37
RK
267enum phase {
268 PHASE_INIT,
269 PHASE_GETOPTS, /* Process command-line arguments */
270 PHASE_READCONFIG, /* Parse and process configuration file */
271 PHASE_SETUP, /* Process information in configuration */
7b1a9fb7 272 PHASE_DAEMONIZE, /* Become a daemon (if necessary) */
42394c37
RK
273 PHASE_GETRESOURCES, /* Obtain all external resources */
274 PHASE_DROPPRIV, /* Last chance for privileged operations */
275 PHASE_RUN,
276 PHASE_SHUTDOWN, /* About to die; delete key material, etc. */
32654a31 277 PHASE_CHILDPERSIST, /* Forked long-term child: close fds, etc. */
42394c37
RK
278 /* Keep this last: */
279 NR_PHASES,
280};
2fe58dfd 281
32654a31
IJ
282/* Each module should, in its CHILDPERSIST hooks, close all fds which
283 constitute ownership of important operating system resources, or
284 which are used for IPC with other processes who want to get the
285 usual disconnection effects if the main secnet process dies.
286 CHILDPERSIST hooks are not run if the child is going to exec;
287 so fds such as described above should be CLOEXEC too. */
288
2fe58dfd
SE
289typedef void hook_fn(void *self, uint32_t newphase);
290bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
291bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
292
7138d0c5
SE
293extern uint32_t current_phase;
294extern void enter_phase(uint32_t new_phase);
295
a614cf77 296void phase_hooks_init(void); /* for main() only */
c72aa743 297void clear_phase_hooks(uint32_t phase); /* for afterfork() */
a614cf77 298
ff05a229
SE
299/* Some features (like netlink 'soft' routes) require that secnet
300 retain root privileges. They should indicate that here when
301 appropriate. */
302extern bool_t require_root_privileges;
fe5e9cc4 303extern cstring_t require_root_privileges_explanation;
9d3a4132 304
64f5ae57
IJ
305/* Some modules may want to know whether secnet is going to drop
306 privilege, so that they know whether to do privsep. Call only
307 in phases SETUP and later. */
308bool_t will_droppriv(void);
309
2fe58dfd
SE
310/***** END of program lifetime support *****/
311
312/***** MODULE support *****/
313
314/* Module initialisation function type - modules export one function of
315 this type which is called to initialise them. For dynamically loaded
316 modules it's called "secnet_module". */
469fd1d9 317typedef void init_module(dict_t *dict);
2fe58dfd 318
08ee90a2
IJ
319extern void init_builtin_modules(dict_t *dict);
320
321extern init_module resolver_module;
322extern init_module random_module;
323extern init_module udp_module;
ce5c098f 324extern init_module polypath_module;
08ee90a2
IJ
325extern init_module util_module;
326extern init_module site_module;
b02b720a 327extern init_module transform_eax_module;
92a7d254 328extern init_module transform_cbcmac_module;
08ee90a2
IJ
329extern init_module netlink_module;
330extern init_module rsa_module;
331extern init_module dh_module;
332extern init_module md5_module;
333extern init_module slip_module;
334extern init_module tun_module;
335extern init_module sha1_module;
336extern init_module log_module;
337
2fe58dfd
SE
338/***** END of module support *****/
339
340/***** CLOSURE TYPES and interface definitions *****/
341
469fd1d9
SE
342#define CL_PURE 0
343#define CL_RESOLVER 1
344#define CL_RANDOMSRC 2
345#define CL_RSAPUBKEY 3
346#define CL_RSAPRIVKEY 4
347#define CL_COMM 5
348#define CL_IPIF 6
349#define CL_LOG 7
350#define CL_SITE 8
351#define CL_TRANSFORM 9
352#define CL_DH 11
353#define CL_HASH 12
354#define CL_BUFFER 13
355#define CL_NETLINK 14
2fe58dfd
SE
356
357struct buffer_if;
358
359/* PURE closure requires no interface */
360
361/* RESOLVER interface */
362
363/* Answers to queries are delivered to a function of this
364 type. 'address' will be NULL if there was a problem with the query. It
cc420616
IJ
365 will be freed once resolve_answer_fn returns. naddrs is the actual
366 size of the array at addrs; was_naddrs is the number of addresses
367 actually found in the DNS, which may be bigger if addrs is equal
368 to MAX_PEER_ADDRS (ie there were too many). */
369typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
ec2ae5fa 370 int naddrs, int was_naddrs,
bc07424d
IJ
371 const char *name, const char *failwhy);
372 /* name is the same ptr as passed to request, so its lifetime must
373 * be suitable*/
fe5e9cc4 374typedef bool_t resolve_request_fn(void *st, cstring_t name,
cc420616 375 int remoteport, struct comm_if *comm,
2fe58dfd
SE
376 resolve_answer_fn *cb, void *cst);
377struct resolver_if {
378 void *st;
379 resolve_request_fn *request;
380};
381
382/* RANDOMSRC interface */
383
384/* Return some random data. Returns TRUE for success. */
1caa23ff 385typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff);
2fe58dfd
SE
386
387struct random_if {
388 void *st;
389 bool_t blocking;
390 random_fn *generate;
391};
392
393/* RSAPUBKEY interface */
394
1caa23ff 395typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen,
fe5e9cc4 396 cstring_t signature);
2fe58dfd
SE
397struct rsapubkey_if {
398 void *st;
399 rsa_checksig_fn *check;
400};
401
402/* RSAPRIVKEY interface */
403
1caa23ff 404typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen);
2fe58dfd
SE
405struct rsaprivkey_if {
406 void *st;
407 rsa_makesig_fn *sign;
408};
409
410/* COMM interface */
411
a15faeb2
IJ
412struct comm_addr {
413 /* This struct is pure data; in particular comm's clients may
414 freely copy it. */
a15faeb2 415 struct comm_if *comm;
a32d56fb 416 union iaddr ia;
08b62a6c 417 int ix; /* see comment `Re comm_addr.ix' in udp.c */
a15faeb2
IJ
418};
419
2fe58dfd 420/* Return True if the packet was processed, and shouldn't be passed to
54d5ef00 421 any other potential receivers. (buf is freed iff True returned.) */
2fe58dfd 422typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
a15faeb2 423 const struct comm_addr *source);
2fe58dfd
SE
424typedef void comm_request_notify_fn(void *commst, void *nst,
425 comm_notify_fn *fn);
426typedef void comm_release_notify_fn(void *commst, void *nst,
427 comm_notify_fn *fn);
428typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
a15faeb2 429 const struct comm_addr *dest);
855fb066
IJ
430 /* Only returns false if (we know that) the local network
431 * environment is such that this address cannot work; transient
432 * or unknown/unexpected failures return true. */
5edf478f
IJ
433typedef const char *comm_addr_to_string_fn(void *commst,
434 const struct comm_addr *ca);
435 /* Returned string is in a static buffer. */
2fe58dfd
SE
436struct comm_if {
437 void *st;
438 comm_request_notify_fn *request_notify;
439 comm_release_notify_fn *release_notify;
440 comm_sendmsg_fn *sendmsg;
5edf478f 441 comm_addr_to_string_fn *addr_to_string;
2fe58dfd
SE
442};
443
9c44ef13
IJ
444bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib,
445 bool_t ignoreport);
2093fb5c 446
1a448682
IJ
447static inline const char *comm_addr_to_string(const struct comm_addr *ca)
448{
449 return ca->comm->addr_to_string(ca->comm->st, ca);
450}
451
2093fb5c
IJ
452static inline bool_t comm_addr_equal(const struct comm_addr *a,
453 const struct comm_addr *b)
454{
9c44ef13 455 return a->comm==b->comm && iaddr_equal(&a->ia,&b->ia,False);
2093fb5c
IJ
456}
457
2fe58dfd
SE
458/* LOG interface */
459
ff1dcd86
IJ
460#define LOG_MESSAGE_BUFLEN 1023
461
fe5e9cc4
SE
462typedef void log_msg_fn(void *st, int class, const char *message, ...);
463typedef void log_vmsg_fn(void *st, int class, const char *message,
464 va_list args);
2fe58dfd
SE
465struct log_if {
466 void *st;
779837e1 467 log_vmsg_fn *vlogfn; /* printf format checking. Use [v]slilog instead */
ff1dcd86 468 char buff[LOG_MESSAGE_BUFLEN+1];
2fe58dfd 469};
59938e0e 470/* (convenience functions, defined in util.c) */
040ee979 471extern void slilog(struct log_if *lf, int class, const char *message, ...)
4f5e39ec 472FORMAT(printf,3,4);
59938e0e
IJ
473extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
474FORMAT(printf,3,0);
2fe58dfd 475
ff1dcd86
IJ
476/* Versions which take (parts of) (multiple) messages, using \n to
477 * distinguish one message from another. */
478extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
479FORMAT(printf,3,4);
480extern void vslilog_part(struct log_if *lf, int class, const char *message,
481 va_list) FORMAT(printf,3,0);
482
2fe58dfd
SE
483/* SITE interface */
484
485/* Pretty much a placeholder; allows starting and stopping of processing,
486 key expiry, etc. */
487typedef void site_control_fn(void *st, bool_t run);
488typedef uint32_t site_status_fn(void *st);
489struct site_if {
490 void *st;
491 site_control_fn *control;
492 site_status_fn *status;
493};
494
495/* TRANSFORM interface */
496
497/* A reversable transformation. Transforms buffer in-place; may add
3abd18e8 498 data to start or end. (Reverse transformations decrease
2fe58dfd
SE
499 length, of course.) Transformations may be key-dependent, in which
500 case key material is passed in at initialisation time. They may
501 also depend on internal factors (eg. time) and keep internal
502 state. A struct transform_if only represents a particular type of
503 transformation; instances of the transformation (eg. with
0118121a
IJ
504 particular key material) have a different C type. The same
505 secret key will be used in opposite directions between a pair of
506 secnets; one of these pairs will get direction==False, the other True. */
2fe58dfd
SE
507
508typedef struct transform_inst_if *transform_createinstance_fn(void *st);
0118121a
IJ
509typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
510 bool_t direction);
b67dab18 511typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
2fe58dfd
SE
512typedef void transform_delkey_fn(void *st);
513typedef void transform_destroyinstance_fn(void *st);
07e4774c
IJ
514/* Returns:
515 * 0: all is well
516 * 1: for any other problem
517 * 2: message decrypted but sequence number was out of range
518 */
2fe58dfd 519typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
fe5e9cc4 520 const char **errmsg);
2fe58dfd
SE
521
522struct transform_inst_if {
523 void *st;
524 transform_setkey_fn *setkey;
b67dab18 525 transform_valid_fn *valid;
2fe58dfd
SE
526 transform_delkey_fn *delkey;
527 transform_apply_fn *forwards;
528 transform_apply_fn *reverse;
529 transform_destroyinstance_fn *destroy;
530};
531
532struct transform_if {
533 void *st;
5b5f297f 534 int capab_transformnum;
3abd18e8 535 int32_t keylen; /* <<< INT_MAX */
2fe58dfd
SE
536 transform_createinstance_fn *create;
537};
538
539/* NETLINK interface */
540
70dc107b
SE
541/* Used by netlink to deliver to site, and by site to deliver to
542 netlink. cid is the client identifier returned by
543 netlink_regnets_fn. If buf has size 0 then the function is just
544 being called for its site-effects (eg. making the site code attempt
545 to bring up a network link) */
469fd1d9 546typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
4efd681a 547/* site code can tell netlink when outgoing packets will be dropped,
70dc107b 548 so netlink can generate appropriate ICMP and make routing decisions */
f208b9a9
IJ
549#define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */
550#define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/
551#define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
552#define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
553#define LINK_QUALITY_UP 4 /* Link active */
70dc107b 554#define MAXIMUM_LINK_QUALITY 3
469fd1d9
SE
555typedef void netlink_link_quality_fn(void *st, uint32_t quality);
556typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
1c085348 557 void *dst, uint32_t *localmtu_r /* NULL ok */);
794f2398
SE
558typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
559typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
1caa23ff 560typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
2fe58dfd
SE
561struct netlink_if {
562 void *st;
469fd1d9 563 netlink_register_fn *reg;
2fe58dfd 564 netlink_deliver_fn *deliver;
70dc107b 565 netlink_link_quality_fn *set_quality;
d3fe100d 566 netlink_set_mtu_fn *set_mtu;
2fe58dfd
SE
567};
568
569/* DH interface */
570
571/* Returns public key as a malloced hex string */
572typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
1caa23ff 573 int32_t secretlen);
2fe58dfd
SE
574/* Fills buffer (up to buflen) with shared secret */
575typedef void dh_makeshared_fn(void *st, uint8_t *secret,
1caa23ff
IJ
576 int32_t secretlen, cstring_t rempublic,
577 uint8_t *sharedsecret, int32_t buflen);
2fe58dfd
SE
578struct dh_if {
579 void *st;
1caa23ff 580 int32_t len; /* Approximate size of modulus in bytes */
7c9ca4bd 581 int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
2fe58dfd
SE
582 dh_makepublic_fn *makepublic;
583 dh_makeshared_fn *makeshared;
584};
585
586/* HASH interface */
587
588typedef void *hash_init_fn(void);
babd74ec 589typedef void hash_update_fn(void *st, const void *buf, int32_t len);
2fe58dfd
SE
590typedef void hash_final_fn(void *st, uint8_t *digest);
591struct hash_if {
1caa23ff 592 int32_t len; /* Hash output length in bytes */
2fe58dfd
SE
593 hash_init_fn *init;
594 hash_update_fn *update;
595 hash_final_fn *final;
596};
597
598/* BUFFER interface */
599
600struct buffer_if {
601 bool_t free;
fe5e9cc4 602 cstring_t owner; /* Set to constant string */
2fe58dfd
SE
603 uint32_t flags; /* How paranoid should we be? */
604 struct cloc loc; /* Where we were defined */
605 uint8_t *base;
606 uint8_t *start;
1caa23ff 607 int32_t size; /* Size of buffer contents */
10068344 608 int32_t alloclen; /* Total length allocated at base */
2fe58dfd
SE
609};
610
4f5e39ec
SE
611/***** LOG functions *****/
612
613#define M_DEBUG_CONFIG 0x001
614#define M_DEBUG_PHASE 0x002
615#define M_DEBUG 0x004
616#define M_INFO 0x008
617#define M_NOTICE 0x010
618#define M_WARNING 0x020
619#define M_ERR 0x040
620#define M_SECURITY 0x080
621#define M_FATAL 0x100
622
623/* The fatal() family of functions require messages that do not end in '\n' */
779837e1
IJ
624extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
625extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
626extern NORETURN(fatal_status(int status, const char *message, ...))
627 FORMAT(printf,2,3);
628extern NORETURN(fatal_perror_status(int status, const char *message, ...))
629 FORMAT(printf,2,3);
4f5e39ec 630
f1393100
IJ
631/* Convenient nonfatal logging. Requires message that does not end in '\n'.
632 * If class contains M_FATAL, exits (after entering PHASE_SHUTDOWN).
633 * lg, errnoval and loc may sensibly be 0. desc must NOT be 0.
634 * lg_[v]perror save and restore errno. */
635void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
636 int class, int errnoval, const char *fmt, va_list al)
637 FORMAT(printf,6,0);
638void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
639 int class, int errnoval, const char *fmt, ...)
640 FORMAT(printf,6,7);
45736f73
IJ
641void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
642 int class, int status, const char *progname);
f1393100 643
4f5e39ec 644/* The cfgfatal() family of functions require messages that end in '\n' */
fe5e9cc4 645extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
779837e1 646 const char *message, ...)) FORMAT(printf,3,4);
4f5e39ec
SE
647extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
648extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
fe5e9cc4 649 cstring_t facility, const char *message,
779837e1
IJ
650 va_list))
651 FORMAT(printf,4,0);
4f5e39ec 652extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
fe5e9cc4 653 cstring_t facility,
779837e1
IJ
654 const char *message, ...))
655 FORMAT(printf,4,5);
4f5e39ec 656
fe5e9cc4
SE
657extern void Message(uint32_t class, const char *message, ...)
658 FORMAT(printf,2,3);
659extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
4f5e39ec
SE
660
661/***** END of log functions *****/
662
45cfab8c
IJ
663#define STRING2(x) #x
664#define STRING(x) STRING2(x)
665
076bb54e 666#define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
9c99fe6a 667#define ARRAY_SIZE(ary) (sizeof((ary))/sizeof((ary)[0]))
076bb54e 668
8438de14
IJ
669/*
670 * void COPY_OBJ( OBJECT& dst, const OBJECT& src);
671 * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
672 * // Typesafe: we check that the type OBJECT is the same in both cases.
673 * // It is OK to use COPY_OBJ on an array object, provided it's
674 * // _actually_ the whole array object and not decayed into a
675 * // pointer (e.g. a formal parameter).
676 */
677#define COPY_OBJ(dst,src) \
678 (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst))))
679#define COPY_ARRAY(dst,src,count) \
680 (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count)))
681
2fe58dfd 682#endif /* secnet_h */