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