1 /* Core interface of secnet, to be used by all modules */
11 #include <sys/types.h>
13 #include <netinet/in.h>
15 typedef char *string_t;
16 typedef enum {False,True} bool_t;
18 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line " __LINE__ \
19 " file " __FILE__ "\n"); } while(0)
21 /***** SHARED types *****/
23 /* These are stored in HOST byte order */
34 /* Match an address (in HOST byte order) with a subnet list.
35 Returns True if matched. */
36 extern bool_t subnet_match(struct subnet_list *list, uint32_t address);
37 extern bool_t subnets_intersect(struct subnet a, struct subnet b);
38 extern bool_t subnet_intersects_with_list(struct subnet a,
39 struct subnet_list *b);
40 extern bool_t subnet_lists_intersect(struct subnet_list *a,
41 struct subnet_list *b);
43 /***** END of shared types *****/
45 /***** CONFIGURATION support *****/
47 extern bool_t just_check_config; /* If True then we're going to exit after
48 reading the configuration file */
50 typedef struct dict dict_t; /* Configuration dictionary */
51 typedef struct closure closure_t;
52 typedef struct item item_t;
53 typedef struct list list_t; /* A list of items */
55 /* Configuration file location, for error-reporting */
61 /* Modules export closures, which can be invoked from the configuration file.
62 "Invoking" a closure usually returns another closure (of a different
63 type), but can actually return any configuration object. */
64 typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
65 dict_t *context, list_t *data);
67 string_t description; /* For debugging */
68 uint32_t type; /* Central registry... */
70 void *interface; /* Interface for use inside secnet; depends on type */
73 enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
91 /* In the following two lookup functions, NULL means 'not found' */
92 /* Lookup a value in the specified dictionary, or its parents */
93 extern list_t *dict_lookup(dict_t *dict, string_t key);
94 /* Lookup a value in just the specified dictionary */
95 extern list_t *dict_lookup_primitive(dict_t *dict, string_t key);
96 /* Add a value to the specified dictionary */
97 extern void dict_add(dict_t *dict, string_t key, list_t *val);
98 /* Obtain an array of keys in the dictionary. malloced; caller frees */
99 extern string_t *dict_keys(dict_t *dict);
101 /* List-manipulation functions */
102 extern list_t *list_new(void);
103 extern list_t *list_append(list_t *a, item_t *i);
104 extern list_t *list_append_list(list_t *a, list_t *b);
105 /* Returns an item from the list (index starts at 0), or NULL */
106 extern item_t *list_elem(list_t *l, uint32_t index);
108 /* Convenience functions */
109 extern list_t *new_closure(closure_t *cl);
110 extern void add_closure(dict_t *dict, string_t name, apply_fn apply);
111 extern void *find_cl_if(dict_t *dict, string_t name, uint32_t type,
112 bool_t fail_if_invalid, string_t desc,
114 extern item_t *dict_find_item(dict_t *dict, string_t key, bool_t required,
115 string_t desc, struct cloc loc);
116 extern string_t dict_read_string(dict_t *dict, string_t key, bool_t required,
117 string_t desc, struct cloc loc);
118 extern uint32_t dict_read_number(dict_t *dict, string_t key, bool_t required,
119 string_t desc, struct cloc loc, uint32_t def);
120 extern bool_t dict_read_bool(dict_t *dict, string_t key, bool_t required,
121 string_t desc, struct cloc loc, bool_t def);
122 extern void dict_read_subnet_list(dict_t *dict, string_t key, bool_t required,
123 string_t desc, struct cloc loc,
124 struct subnet_list *sl);
125 extern uint32_t string_to_ipaddr(item_t *i, string_t desc);
127 /***** END of configuration support *****/
129 /***** UTILITY functions *****/
135 #define M_DEBUG_CONFIG 16
136 #define M_DEBUG_PHASE 32
138 extern void fatal(char *message, ...);
139 extern void fatal_perror(char *message, ...);
140 extern void fatal_status(int status, char *message, ...);
141 extern void fatal_perror_status(int status, char *message, ...);
142 extern void cfgfatal(struct cloc loc, string_t facility, char *message, ...);
144 extern char *safe_strdup(char *string, char *message);
145 extern void *safe_malloc(size_t size, char *message);
147 extern void Message(uint32_t class, char *message, ...);
149 extern string_t ipaddr_to_string(uint32_t addr);
150 extern string_t subnet_to_string(struct subnet *sn);
152 extern int sys_cmd(const char *file, char *argc, ...);
154 /***** END of utility functions *****/
156 /***** SCHEDULING support */
158 /* "now" is current program time, in milliseconds. It is derived
159 (once) from tv_now. If nfds_io is insufficient for your needs, set
160 it to the required number and return ERANGE. timeout is in milliseconds;
161 if it is too high then lower it. It starts at -1 (==infinite) */
162 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
163 int *timeout_io, const struct timeval *tv_now,
165 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds,
166 const struct timeval *tv_now, uint64_t *now);
168 /* Register interest in the main loop of the program. Before a call
169 to poll() your supplied beforepoll function will be called. After
170 the call to poll() the supplied afterpoll function will be called.
171 max_nfds is a _hint_ about the maximum number of struct pollfd
172 structures you may require - you can always ask for more in
174 extern void register_for_poll(void *st, beforepoll_fn *before,
175 afterpoll_fn *after, uint32_t max_nfds,
178 /***** END of scheduling support */
180 /***** PROGRAM LIFETIME support */
182 /* The secnet program goes through a number of phases in its lifetime.
183 Module code may arrange to be called just as various phases are
187 #define PHASE_GETOPTS 1 /* Process command-line arguments */
188 #define PHASE_READCONFIG 2 /* Parse and process configuration file */
189 #define PHASE_SETUP 3 /* Process information in configuration */
190 #define PHASE_GETRESOURCES 4 /* Obtain all external resources */
191 #define PHASE_DROPPRIV 5 /* Last chance for privileged operations */
193 #define PHASE_SHUTDOWN 7 /* About to die; delete key material, etc. */
196 typedef void hook_fn(void *self, uint32_t newphase);
197 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
198 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
200 /***** END of program lifetime support *****/
202 /***** MODULE support *****/
204 /* Module initialisation function type - modules export one function of
205 this type which is called to initialise them. For dynamically loaded
206 modules it's called "secnet_module". */
207 typedef void (init_module)(dict_t *dict);
209 /***** END of module support *****/
211 /***** CLOSURE TYPES and interface definitions *****/
214 #define CL_RESOLVER 1
215 #define CL_RANDOMSRC 2
216 #define CL_RSAPUBKEY 3
217 #define CL_RSAPRIVKEY 4
222 #define CL_TRANSFORM 9
223 #define CL_NETLINK 10
230 /* PURE closure requires no interface */
232 /* RESOLVER interface */
234 /* Answers to queries are delivered to a function of this
235 type. 'address' will be NULL if there was a problem with the query. It
236 will be freed once resolve_answer_fn returns. It is in network byte
238 typedef void resolve_answer_fn(void *st, struct in_addr *addr);
239 typedef bool_t resolve_request_fn(void *st, string_t name,
240 resolve_answer_fn *cb, void *cst);
243 resolve_request_fn *request;
246 /* RANDOMSRC interface */
248 /* Return some random data. Returns TRUE for success. */
249 typedef bool_t random_fn(void *st, uint32_t bytes, uint8_t *buff);
257 /* RSAPUBKEY interface */
259 typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, uint32_t datalen,
261 struct rsapubkey_if {
263 rsa_checksig_fn *check;
266 /* RSAPRIVKEY interface */
268 typedef string_t rsa_makesig_fn(void *st, uint8_t *data, uint32_t datalen);
269 struct rsaprivkey_if {
271 rsa_makesig_fn *sign;
276 /* Return True if the packet was processed, and shouldn't be passed to
277 any other potential receivers. */
278 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
279 struct sockaddr_in *source);
280 typedef void comm_request_notify_fn(void *commst, void *nst,
282 typedef void comm_release_notify_fn(void *commst, void *nst,
284 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
285 struct sockaddr_in *dest);
288 comm_request_notify_fn *request_notify;
289 comm_release_notify_fn *release_notify;
290 comm_sendmsg_fn *sendmsg;
295 typedef void log_msg_fn(void *st, int priority, char *message, ...);
296 typedef void log_vmsg_fn(void *st, int priority, char *message, va_list args);
302 /* (convenience function, defined in util.c) */
303 extern void log(struct log_if *lf, int priority, char *message, ...);
307 /* Pretty much a placeholder; allows starting and stopping of processing,
309 typedef void site_control_fn(void *st, bool_t run);
310 typedef uint32_t site_status_fn(void *st);
313 site_control_fn *control;
314 site_status_fn *status;
317 /* TRANSFORM interface */
319 /* A reversable transformation. Transforms buffer in-place; may add
320 data to start or end. Maximum amount of data to be added specified
321 in max_start_pad and max_end_pad. (Reverse transformations decrease
322 length, of course.) Transformations may be key-dependent, in which
323 case key material is passed in at initialisation time. They may
324 also depend on internal factors (eg. time) and keep internal
325 state. A struct transform_if only represents a particular type of
326 transformation; instances of the transformation (eg. with
327 particular key material) have a different C type. */
329 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
330 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, uint32_t keylen);
331 typedef void transform_delkey_fn(void *st);
332 typedef void transform_destroyinstance_fn(void *st);
333 /* Returns 0 for 'all is well', any other value for a problem */
334 typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
337 struct transform_inst_if {
339 transform_setkey_fn *setkey;
340 transform_delkey_fn *delkey;
341 transform_apply_fn *forwards;
342 transform_apply_fn *reverse;
343 transform_destroyinstance_fn *destroy;
346 struct transform_if {
348 uint32_t max_start_pad;
349 uint32_t max_end_pad;
351 transform_createinstance_fn *create;
354 /* NETLINK interface */
356 /* Used by netlink to deliver to site, and by site to deliver to netlink.
357 cid is the client identifier returned by netlink_regnets_fn */
358 typedef void netlink_deliver_fn(void *st, void *cid, struct buffer_if *buf);
359 /* site code can tell netlink when outgoing packets will be dropped,
360 so netlink can generate appropriate ICMP */
361 typedef void netlink_can_deliver_fn(void *st, void *cid, bool_t can_deliver);
362 /* Register for packets from specified networks. Return value is client
364 typedef void *netlink_regnets_fn(void *st, struct subnet_list *networks,
365 netlink_deliver_fn *deliver, void *dst,
366 uint32_t max_start_pad, uint32_t max_end_pad,
367 string_t client_name);
371 netlink_regnets_fn *regnets;
372 netlink_deliver_fn *deliver;
373 netlink_can_deliver_fn *set_delivery;
378 /* Returns public key as a malloced hex string */
379 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
381 /* Fills buffer (up to buflen) with shared secret */
382 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
383 uint32_t secretlen, string_t rempublic,
384 uint8_t *sharedsecret, uint32_t buflen);
387 uint32_t len; /* Approximate size of modulus in bytes */
388 dh_makepublic_fn *makepublic;
389 dh_makeshared_fn *makeshared;
394 typedef void *hash_init_fn(void);
395 typedef void hash_update_fn(void *st, uint8_t const *buf, uint32_t len);
396 typedef void hash_final_fn(void *st, uint8_t *digest);
398 uint32_t len; /* Hash output length in bytes */
400 hash_update_fn *update;
401 hash_final_fn *final;
404 /* BUFFER interface */
408 string_t owner; /* Set to constant string */
409 uint32_t flags; /* How paranoid should we be? */
410 struct cloc loc; /* Where we were defined */
413 uint32_t size; /* Size of buffer contents */
414 uint32_t len; /* Total length allocated at base */
417 #endif /* secnet_h */