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