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