1 /* Core interface of secnet, to be used by all modules */
10 #include <sys/types.h>
12 #include <netinet/in.h>
14 typedef char *string_t
;
15 typedef enum {False
,True
} bool_t
;
17 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
18 __FILE__ "\n",__LINE__); } } while(0)
20 /***** CONFIGURATION support *****/
22 extern bool_t just_check_config
; /* If True then we're going to exit after
23 reading the configuration file */
24 extern bool_t background
; /* If True then we'll eventually run as a daemon */
26 typedef struct dict dict_t
; /* Configuration dictionary */
27 typedef struct closure closure_t
;
28 typedef struct item item_t
;
29 typedef struct list list_t
; /* A list of items */
31 /* Configuration file location, for error-reporting */
37 /* Modules export closures, which can be invoked from the configuration file.
38 "Invoking" a closure usually returns another closure (of a different
39 type), but can actually return any configuration object. */
40 typedef list_t
*(apply_fn
)(closure_t
*self
, struct cloc loc
,
41 dict_t
*context
, list_t
*data
);
43 string_t description
; /* For debugging */
44 uint32_t type
; /* Central registry... */
46 void *interface
; /* Interface for use inside secnet; depends on type */
49 enum types
{ t_null
, t_bool
, t_string
, t_number
, t_dict
, t_closure
};
67 /* In the following two lookup functions, NULL means 'not found' */
68 /* Lookup a value in the specified dictionary, or its parents */
69 extern list_t
*dict_lookup(dict_t
*dict
, string_t key
);
70 /* Lookup a value in just the specified dictionary */
71 extern list_t
*dict_lookup_primitive(dict_t
*dict
, string_t key
);
72 /* Add a value to the specified dictionary */
73 extern void dict_add(dict_t
*dict
, string_t key
, list_t
*val
);
74 /* Obtain an array of keys in the dictionary. malloced; caller frees */
75 extern string_t
*dict_keys(dict_t
*dict
);
77 /* List-manipulation functions */
78 extern list_t
*list_new(void);
79 extern uint32_t list_length(list_t
*a
);
80 extern list_t
*list_append(list_t
*a
, item_t
*i
);
81 extern list_t
*list_append_list(list_t
*a
, list_t
*b
);
82 /* Returns an item from the list (index starts at 0), or NULL */
83 extern item_t
*list_elem(list_t
*l
, uint32_t index
);
85 /* Convenience functions */
86 extern list_t
*new_closure(closure_t
*cl
);
87 extern void add_closure(dict_t
*dict
, string_t name
, apply_fn apply
);
88 extern void *find_cl_if(dict_t
*dict
, string_t name
, uint32_t type
,
89 bool_t fail_if_invalid
, string_t desc
,
91 extern item_t
*dict_find_item(dict_t
*dict
, string_t key
, bool_t required
,
92 string_t desc
, struct cloc loc
);
93 extern string_t
dict_read_string(dict_t
*dict
, string_t key
, bool_t required
,
94 string_t desc
, struct cloc loc
);
95 extern uint32_t dict_read_number(dict_t
*dict
, string_t key
, bool_t required
,
96 string_t desc
, struct cloc loc
, uint32_t def
);
97 extern bool_t
dict_read_bool(dict_t
*dict
, string_t key
, bool_t required
,
98 string_t desc
, struct cloc loc
, bool_t def
);
103 extern uint32_t string_to_word(string_t s
, struct cloc loc
,
104 struct flagstr
*f
, string_t desc
);
105 extern uint32_t string_list_to_word(list_t
*l
, struct flagstr
*f
,
108 /***** END of configuration support *****/
110 /***** LOG functions *****/
112 #define M_DEBUG_CONFIG 0x001
113 #define M_DEBUG_PHASE 0x002
114 #define M_DEBUG 0x004
116 #define M_NOTICE 0x010
117 #define M_WARNING 0x020
119 #define M_SECURITY 0x080
120 #define M_FATAL 0x100
122 extern void fatal(char *message
, ...);
123 extern void fatal_perror(char *message
, ...);
124 extern void fatal_status(int status
, char *message
, ...);
125 extern void fatal_perror_status(int status
, char *message
, ...);
126 extern void cfgfatal(struct cloc loc
, string_t facility
, char *message
, ...);
128 extern void Message(uint32_t class, char *message
, ...);
130 /***** END of log functions *****/
132 /***** UTILITY functions *****/
134 extern char *safe_strdup(char *string
, char *message
);
135 extern void *safe_malloc(size_t size
, char *message
);
137 extern int sys_cmd(const char *file
, char *argc
, ...);
139 /***** END of utility functions *****/
141 /***** SCHEDULING support */
143 /* "now" is current program time, in milliseconds. It is derived
144 (once) from tv_now. If nfds_io is insufficient for your needs, set
145 it to the required number and return ERANGE. timeout is in milliseconds;
146 if it is too high then lower it. It starts at -1 (==infinite) */
147 typedef int beforepoll_fn(void *st
, struct pollfd
*fds
, int *nfds_io
,
148 int *timeout_io
, const struct timeval
*tv_now
,
150 typedef void afterpoll_fn(void *st
, struct pollfd
*fds
, int nfds
,
151 const struct timeval
*tv_now
, uint64_t *now
);
153 /* Register interest in the main loop of the program. Before a call
154 to poll() your supplied beforepoll function will be called. After
155 the call to poll() the supplied afterpoll function will be called.
156 max_nfds is a _hint_ about the maximum number of struct pollfd
157 structures you may require - you can always ask for more in
159 extern void register_for_poll(void *st
, beforepoll_fn
*before
,
160 afterpoll_fn
*after
, uint32_t max_nfds
,
163 /***** END of scheduling support */
165 /***** PROGRAM LIFETIME support */
167 /* The secnet program goes through a number of phases in its lifetime.
168 Module code may arrange to be called just as various phases are
172 #define PHASE_GETOPTS 1 /* Process command-line arguments */
173 #define PHASE_READCONFIG 2 /* Parse and process configuration file */
174 #define PHASE_SETUP 3 /* Process information in configuration */
175 #define PHASE_GETRESOURCES 4 /* Obtain all external resources */
176 #define PHASE_DROPPRIV 5 /* Last chance for privileged operations */
178 #define PHASE_SHUTDOWN 7 /* About to die; delete key material, etc. */
181 typedef void hook_fn(void *self
, uint32_t newphase
);
182 bool_t
add_hook(uint32_t phase
, hook_fn
*f
, void *state
);
183 bool_t
remove_hook(uint32_t phase
, hook_fn
*f
, void *state
);
185 extern uint32_t current_phase
;
186 extern void enter_phase(uint32_t new_phase
);
188 extern bool_t require_root_privileges
; /* Some features (like netlink
189 'soft' routes) require that
191 privileges. They should
192 indicate that here when
194 extern string_t require_root_privileges_explanation
;
196 /***** END of program lifetime support *****/
198 /***** MODULE support *****/
200 /* Module initialisation function type - modules export one function of
201 this type which is called to initialise them. For dynamically loaded
202 modules it's called "secnet_module". */
203 typedef void init_module(dict_t
*dict
);
205 /***** END of module support *****/
207 /***** CLOSURE TYPES and interface definitions *****/
210 #define CL_RESOLVER 1
211 #define CL_RANDOMSRC 2
212 #define CL_RSAPUBKEY 3
213 #define CL_RSAPRIVKEY 4
218 #define CL_TRANSFORM 9
222 #define CL_NETLINK 14
226 /* PURE closure requires no interface */
228 /* RESOLVER interface */
230 /* Answers to queries are delivered to a function of this
231 type. 'address' will be NULL if there was a problem with the query. It
232 will be freed once resolve_answer_fn returns. It is in network byte
234 typedef void resolve_answer_fn(void *st
, struct in_addr
*addr
);
235 typedef bool_t
resolve_request_fn(void *st
, string_t name
,
236 resolve_answer_fn
*cb
, void *cst
);
239 resolve_request_fn
*request
;
242 /* RANDOMSRC interface */
244 /* Return some random data. Returns TRUE for success. */
245 typedef bool_t
random_fn(void *st
, uint32_t bytes
, uint8_t *buff
);
253 /* RSAPUBKEY interface */
255 typedef bool_t
rsa_checksig_fn(void *st
, uint8_t *data
, uint32_t datalen
,
257 struct rsapubkey_if
{
259 rsa_checksig_fn
*check
;
262 /* RSAPRIVKEY interface */
264 typedef string_t
rsa_makesig_fn(void *st
, uint8_t *data
, uint32_t datalen
);
265 struct rsaprivkey_if
{
267 rsa_makesig_fn
*sign
;
272 /* Return True if the packet was processed, and shouldn't be passed to
273 any other potential receivers. */
274 typedef bool_t
comm_notify_fn(void *state
, struct buffer_if
*buf
,
275 struct sockaddr_in
*source
);
276 typedef void comm_request_notify_fn(void *commst
, void *nst
,
278 typedef void comm_release_notify_fn(void *commst
, void *nst
,
280 typedef bool_t
comm_sendmsg_fn(void *commst
, struct buffer_if
*buf
,
281 struct sockaddr_in
*dest
);
284 comm_request_notify_fn
*request_notify
;
285 comm_release_notify_fn
*release_notify
;
286 comm_sendmsg_fn
*sendmsg
;
291 typedef void log_msg_fn(void *st
, int class, char *message
, ...);
292 typedef void log_vmsg_fn(void *st
, int class, char *message
, va_list args
);
298 /* (convenience function, defined in util.c) */
299 extern void log(struct log_if
*lf
, int class, char *message
, ...);
303 /* Pretty much a placeholder; allows starting and stopping of processing,
305 typedef void site_control_fn(void *st
, bool_t run
);
306 typedef uint32_t site_status_fn(void *st
);
309 site_control_fn
*control
;
310 site_status_fn
*status
;
313 /* TRANSFORM interface */
315 /* A reversable transformation. Transforms buffer in-place; may add
316 data to start or end. Maximum amount of data to be added specified
317 in max_start_pad and max_end_pad. (Reverse transformations decrease
318 length, of course.) Transformations may be key-dependent, in which
319 case key material is passed in at initialisation time. They may
320 also depend on internal factors (eg. time) and keep internal
321 state. A struct transform_if only represents a particular type of
322 transformation; instances of the transformation (eg. with
323 particular key material) have a different C type. */
325 typedef struct transform_inst_if
*transform_createinstance_fn(void *st
);
326 typedef bool_t
transform_setkey_fn(void *st
, uint8_t *key
, uint32_t keylen
);
327 typedef void transform_delkey_fn(void *st
);
328 typedef void transform_destroyinstance_fn(void *st
);
329 /* Returns 0 for 'all is well', any other value for a problem */
330 typedef uint32_t transform_apply_fn(void *st
, struct buffer_if
*buf
,
333 struct transform_inst_if
{
335 transform_setkey_fn
*setkey
;
336 transform_delkey_fn
*delkey
;
337 transform_apply_fn
*forwards
;
338 transform_apply_fn
*reverse
;
339 transform_destroyinstance_fn
*destroy
;
342 struct transform_if
{
344 uint32_t max_start_pad
;
345 uint32_t max_end_pad
;
347 transform_createinstance_fn
*create
;
350 /* NETLINK interface */
352 /* Used by netlink to deliver to site, and by site to deliver to
353 netlink. cid is the client identifier returned by
354 netlink_regnets_fn. If buf has size 0 then the function is just
355 being called for its site-effects (eg. making the site code attempt
356 to bring up a network link) */
357 typedef void netlink_deliver_fn(void *st
, struct buffer_if
*buf
);
358 /* site code can tell netlink when outgoing packets will be dropped,
359 so netlink can generate appropriate ICMP and make routing decisions */
360 #define LINK_QUALITY_DOWN 0 /* No chance of a packet being delivered */
361 #define LINK_QUALITY_DOWN_STALE_ADDRESS 1 /* Link down, old address information */
362 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 2 /* Link down, current address information */
363 #define LINK_QUALITY_UP 3 /* Link active */
364 #define MAXIMUM_LINK_QUALITY 3
365 typedef void netlink_link_quality_fn(void *st
, uint32_t quality
);
366 typedef void netlink_register_fn(void *st
, netlink_deliver_fn
*deliver
,
367 void *dst
, uint32_t max_start_pad
,
368 uint32_t max_end_pad
);
369 typedef void netlink_output_config_fn(void *st
, struct buffer_if
*buf
);
370 typedef bool_t
netlink_check_config_fn(void *st
, struct buffer_if
*buf
);
371 typedef void netlink_set_mtu_fn(void *st
, uint32_t new_mtu
);
374 netlink_register_fn
*reg
;
375 netlink_deliver_fn
*deliver
;
376 netlink_link_quality_fn
*set_quality
;
377 netlink_output_config_fn
*output_config
;
378 netlink_check_config_fn
*check_config
;
379 netlink_set_mtu_fn
*set_mtu
;
384 /* Returns public key as a malloced hex string */
385 typedef string_t
dh_makepublic_fn(void *st
, uint8_t *secret
,
387 /* Fills buffer (up to buflen) with shared secret */
388 typedef void dh_makeshared_fn(void *st
, uint8_t *secret
,
389 uint32_t secretlen
, string_t rempublic
,
390 uint8_t *sharedsecret
, uint32_t buflen
);
393 uint32_t len
; /* Approximate size of modulus in bytes */
394 dh_makepublic_fn
*makepublic
;
395 dh_makeshared_fn
*makeshared
;
400 typedef void *hash_init_fn(void);
401 typedef void hash_update_fn(void *st
, uint8_t const *buf
, uint32_t len
);
402 typedef void hash_final_fn(void *st
, uint8_t *digest
);
404 uint32_t len
; /* Hash output length in bytes */
406 hash_update_fn
*update
;
407 hash_final_fn
*final
;
410 /* BUFFER interface */
414 string_t owner
; /* Set to constant string */
415 uint32_t flags
; /* How paranoid should we be? */
416 struct cloc loc
; /* Where we were defined */
419 uint32_t size
; /* Size of buffer contents */
420 uint32_t len
; /* Total length allocated at base */
423 #endif /* secnet_h */