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);
38 /***** END of shared types *****/
40 /***** CONFIGURATION support *****/
42 typedef struct dict dict_t; /* Configuration dictionary */
43 typedef struct closure closure_t;
44 typedef struct item item_t;
45 typedef struct list list_t; /* A list of items */
47 /* Configuration file location, for error-reporting */
53 /* Modules export closures, which can be invoked from the configuration file.
54 "Invoking" a closure usually returns another closure (of a different
55 type), but can actually return any configuration object. */
56 typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
57 dict_t *context, list_t *data);
59 string_t description; /* For debugging */
60 uint32_t type; /* Central registry... */
62 void *interface; /* Interface for use inside secnet; depends on type */
65 enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
83 /* In the following two lookup functions, NULL means 'not found' */
84 /* Lookup a value in the specified dictionary, or its parents */
85 extern list_t *dict_lookup(dict_t *dict, string_t key);
86 /* Lookup a value in just the specified dictionary */
87 extern list_t *dict_lookup_primitive(dict_t *dict, string_t key);
88 /* Add a value to the specified dictionary */
89 extern void dict_add(dict_t *dict, string_t key, list_t *val);
90 /* Obtain an array of keys in the dictionary. malloced; caller frees */
91 extern string_t *dict_keys(dict_t *dict);
93 /* List-manipulation functions */
94 extern list_t *list_new(void);
95 extern list_t *list_append(list_t *a, item_t *i);
96 extern list_t *list_append_list(list_t *a, list_t *b);
97 /* Returns an item from the list (index starts at 0), or NULL */
98 extern item_t *list_elem(list_t *l, uint32_t index);
100 /* Convenience functions */
101 extern list_t *new_closure(closure_t *cl);
102 extern void add_closure(dict_t *dict, string_t name, apply_fn apply);
103 extern void *find_cl_if(dict_t *dict, string_t name, uint32_t type,
104 bool_t fail_if_invalid, string_t desc,
106 extern item_t *dict_find_item(dict_t *dict, string_t key, bool_t required,
107 string_t desc, struct cloc loc);
108 extern string_t dict_read_string(dict_t *dict, string_t key, bool_t required,
109 string_t desc, struct cloc loc);
110 extern uint32_t dict_read_number(dict_t *dict, string_t key, bool_t required,
111 string_t desc, struct cloc loc, uint32_t def);
112 extern bool_t dict_read_bool(dict_t *dict, string_t key, bool_t required,
113 string_t desc, struct cloc loc, bool_t def);
114 extern void dict_read_subnet_list(dict_t *dict, string_t key, bool_t required,
115 string_t desc, struct cloc loc,
116 struct subnet_list *sl);
117 extern uint32_t string_to_ipaddr(item_t *i, string_t desc);
119 /***** END of configuration support *****/
121 /***** UTILITY functions *****/
127 #define M_DEBUG_CONFIG 16
128 #define M_DEBUG_PHASE 32
130 extern void fatal(char *message, ...);
131 extern void fatal_perror(char *message, ...);
132 extern void fatal_status(int status, char *message, ...);
133 extern void fatal_perror_status(int status, char *message, ...);
134 extern void cfgfatal(struct cloc loc, string_t facility, char *message, ...);
136 extern char *safe_strdup(char *string, char *message);
137 extern void *safe_malloc(size_t size, char *message);
139 extern void Message(uint32_t class, char *message, ...);
141 extern string_t ipaddr_to_string(uint32_t addr);
142 extern string_t subnet_to_string(struct subnet *sn);
144 extern int sys_cmd(const char *file, char *argc, ...);
146 /***** END of utility functions *****/
148 /***** SCHEDULING support */
150 /* "now" is current program time, in milliseconds. It is derived
151 (once) from tv_now. If nfds_io is insufficient for your needs, set
152 it to the required number and return ERANGE. timeout is in milliseconds;
153 if it is too high then lower it. It starts at -1 (==infinite) */
154 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
155 int *timeout_io, const struct timeval *tv_now,
157 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds,
158 const struct timeval *tv_now, uint64_t *now);
160 /* Register interest in the main loop of the program. Before a call
161 to poll() your supplied beforepoll function will be called. After
162 the call to poll() the supplied afterpoll function will be called.
163 max_nfds is a _hint_ about the maximum number of struct pollfd
164 structures you may require - you can always ask for more in
166 extern void register_for_poll(void *st, beforepoll_fn *before,
167 afterpoll_fn *after, uint32_t max_nfds,
170 /***** END of scheduling support */
172 /***** PROGRAM LIFETIME support */
174 /* The secnet program goes through a number of phases in its lifetime.
175 Module code may arrange to be called just as various phases are
179 #define PHASE_GETOPTS 1 /* Process command-line arguments */
180 #define PHASE_READCONFIG 2 /* Parse and process configuration file */
181 #define PHASE_SETUP 3 /* Process information in configuration */
182 #define PHASE_DROPPRIV 4 /* Last chance for privileged operations */
184 #define PHASE_SHUTDOWN 6 /* About to die; delete key material, etc. */
187 typedef void hook_fn(void *self, uint32_t newphase);
188 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
189 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
191 /***** END of program lifetime support *****/
193 /***** MODULE support *****/
195 /* Module initialisation function type - modules export one function of
196 this type which is called to initialise them. For dynamically loaded
197 modules it's called "secnet_module". */
198 typedef void (init_module)(dict_t *dict);
200 /***** END of module support *****/
202 /***** CLOSURE TYPES and interface definitions *****/
205 #define CL_RESOLVER 1
206 #define CL_RANDOMSRC 2
207 #define CL_RSAPUBKEY 3
208 #define CL_RSAPRIVKEY 4
213 #define CL_TRANSFORM 9
214 #define CL_NETLINK 10
221 /* PURE closure requires no interface */
223 /* RESOLVER interface */
225 /* Answers to queries are delivered to a function of this
226 type. 'address' will be NULL if there was a problem with the query. It
227 will be freed once resolve_answer_fn returns. It is in network byte
229 typedef void resolve_answer_fn(void *st, struct in_addr *addr);
230 typedef bool_t resolve_request_fn(void *st, string_t name,
231 resolve_answer_fn *cb, void *cst);
234 resolve_request_fn *request;
237 /* RANDOMSRC interface */
239 /* Return some random data. Returns TRUE for success. */
240 typedef bool_t random_fn(void *st, uint32_t bytes, uint8_t *buff);
248 /* RSAPUBKEY interface */
250 typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, uint32_t datalen,
252 struct rsapubkey_if {
254 rsa_checksig_fn *check;
257 /* RSAPRIVKEY interface */
259 typedef string_t rsa_makesig_fn(void *st, uint8_t *data, uint32_t datalen);
260 struct rsaprivkey_if {
262 rsa_makesig_fn *sign;
267 /* Return True if the packet was processed, and shouldn't be passed to
268 any other potential receivers. */
269 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
270 struct sockaddr_in *source);
271 typedef void comm_request_notify_fn(void *commst, void *nst,
273 typedef void comm_release_notify_fn(void *commst, void *nst,
275 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
276 struct sockaddr_in *dest);
279 comm_request_notify_fn *request_notify;
280 comm_release_notify_fn *release_notify;
281 comm_sendmsg_fn *sendmsg;
286 typedef void log_msg_fn(void *st, int priority, char *message, ...);
287 typedef void log_vmsg_fn(void *st, int priority, char *message, va_list args);
293 /* (convenience function, defined in util.c) */
294 extern void log(struct log_if *lf, int priority, char *message, ...);
298 /* Pretty much a placeholder; allows starting and stopping of processing,
300 typedef void site_control_fn(void *st, bool_t run);
301 typedef uint32_t site_status_fn(void *st);
304 site_control_fn *control;
305 site_status_fn *status;
308 /* TRANSFORM interface */
310 /* A reversable transformation. Transforms buffer in-place; may add
311 data to start or end. Maximum amount of data to be added specified
312 in max_start_pad and max_end_pad. (Reverse transformations decrease
313 length, of course.) Transformations may be key-dependent, in which
314 case key material is passed in at initialisation time. They may
315 also depend on internal factors (eg. time) and keep internal
316 state. A struct transform_if only represents a particular type of
317 transformation; instances of the transformation (eg. with
318 particular key material) have a different C type. */
320 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
321 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, uint32_t keylen);
322 typedef void transform_delkey_fn(void *st);
323 typedef void transform_destroyinstance_fn(void *st);
324 /* Returns 0 for 'all is well', any other value for a problem */
325 typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
328 struct transform_inst_if {
330 transform_setkey_fn *setkey;
331 transform_delkey_fn *delkey;
332 transform_apply_fn *forwards;
333 transform_apply_fn *reverse;
334 transform_destroyinstance_fn *destroy;
337 struct transform_if {
339 uint32_t max_start_pad;
340 uint32_t max_end_pad;
342 transform_createinstance_fn *create;
345 /* NETLINK interface */
347 /* Used by netlink to deliver to site, and by site to deliver to netlink.
348 cid is the client identifier returned by netlink_regnets_fn */
349 typedef void netlink_deliver_fn(void *st, void *cid, struct buffer_if *buf);
350 /* site code can tell netlink when outgoing packets will be dropped,
351 so netlink can generate appropriate ICMP */
352 typedef void netlink_can_deliver_fn(void *st, void *cid, bool_t can_deliver);
353 /* Register for packets from specified networks. Return value is client
355 typedef void *netlink_regnets_fn(void *st, struct subnet_list *networks,
356 netlink_deliver_fn *deliver, void *dst,
357 uint32_t max_start_pad, uint32_t max_end_pad,
358 string_t client_name);
362 netlink_regnets_fn *regnets;
363 netlink_deliver_fn *deliver;
364 netlink_can_deliver_fn *set_delivery;
369 /* Returns public key as a malloced hex string */
370 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
372 /* Fills buffer (up to buflen) with shared secret */
373 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
374 uint32_t secretlen, string_t rempublic,
375 uint8_t *sharedsecret, uint32_t buflen);
378 uint32_t len; /* Approximate size of modulus in bytes */
379 dh_makepublic_fn *makepublic;
380 dh_makeshared_fn *makeshared;
385 typedef void *hash_init_fn(void);
386 typedef void hash_update_fn(void *st, uint8_t const *buf, uint32_t len);
387 typedef void hash_final_fn(void *st, uint8_t *digest);
389 uint32_t len; /* Hash output length in bytes */
391 hash_update_fn *update;
392 hash_final_fn *final;
395 /* BUFFER interface */
399 string_t owner; /* Set to constant string */
400 uint32_t flags; /* How paranoid should we be? */
401 struct cloc loc; /* Where we were defined */
404 uint32_t size; /* Size of buffer contents */
405 uint32_t len; /* Total length allocated at base */
408 #endif /* secnet_h */