secnet.h

   1 /* Core interface of secnet, to be used by all modules */
   2
   3 #ifndef secnet_h
   4 #define secnet_h
   5
   6 #define ADNS_FEATURE_MANYAF
   7
   8 #include "config.h"
   9 #include <stdlib.h>
  10 #include <stdarg.h>
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <assert.h>
  14 #include <fcntl.h>
  15 #include <unistd.h>
  16 #include <errno.h>
  17 #include <sys/poll.h>
  18 #include <sys/types.h>
  19 #include <sys/time.h>
  20 #include <netinet/in.h>
  21 #include <arpa/inet.h>
  22
  23 #include <bsd/sys/queue.h>
  24
  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;
  30
  31 typedef char *string_t;
  32 typedef const char *cstring_t;
  33
  34 #define False (_Bool)0
  35 #define True  (_Bool)1
  36 typedef _Bool bool_t;
  37
  38 union iaddr {
  39     struct sockaddr sa;
  40     struct sockaddr_in sin;
  41 #ifdef CONFIG_IPV6
  42     struct sockaddr_in6 sin6;
  43 #endif
  44 };
  45
  46 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
  47                                          __FILE__,__LINE__); } } while(0)
  48
  49 /* from version.c */
  50
  51 extern char version[];
  52
  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
  61 /***** CONFIGURATION support *****/
  62
  63 extern bool_t just_check_config; /* If True then we're going to exit after
  64                                     reading the configuration file */
  65 extern bool_t background; /* If True then we'll eventually run as a daemon */
  66
  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 {
  74     cstring_t file;
  75     int line;
  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 {
  84     cstring_t description; /* For debugging */
  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
 103 /* Note that it is unwise to use this structure directly; use the list
 104    manipulation functions instead. */
 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 */
 112 extern list_t *dict_lookup(dict_t *dict, cstring_t key);
 113 /* Lookup a value in just the specified dictionary */
 114 extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key);
 115 /* Add a value to the specified dictionary */
 116 extern void dict_add(dict_t *dict, cstring_t key, list_t *val);
 117 /* Obtain an array of keys in the dictionary. malloced; caller frees */
 118 extern cstring_t *dict_keys(dict_t *dict);
 119
 120 /* List-manipulation functions */
 121 extern list_t *list_new(void);
 122 extern int32_t list_length(const list_t *a);
 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 */
 126 extern item_t *list_elem(list_t *l, int32_t index);
 127
 128 /* Convenience functions */
 129 extern list_t *new_closure(closure_t *cl);
 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,
 133                         struct cloc loc);
 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);
 141   /* return value can safely be assigned to int32_t */
 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);
 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
 152 struct flagstr {
 153     cstring_t name;
 154     uint32_t value;
 155 };
 156 extern uint32_t string_to_word(cstring_t s, struct cloc loc,
 157                                struct flagstr *f, cstring_t desc);
 158 extern uint32_t string_list_to_word(list_t *l, struct flagstr *f,
 159                                     cstring_t desc);
 160
 161 /***** END of configuration support *****/
 162
 163 /***** UTILITY functions *****/
 164
 165 extern char *safe_strdup(const char *string, const char *message);
 166 extern void *safe_malloc(size_t size, const char *message);
 167 extern void *safe_malloc_ary(size_t size, size_t count, const char *message);
 168
 169 void setcloexec(int fd); /* cannot fail */
 170 void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
 171
 172 extern int sys_cmd(const char *file, const char *argc, ...);
 173
 174 extern uint64_t now_global;
 175 extern struct timeval tv_now_global;
 176
 177 static const uint64_t       *const now    = &now_global;
 178 static const struct timeval *const tv_now = &tv_now_global;
 179
 180 /* "now" is current program time, in milliseconds. It is derived
 181    from tv_now. Both are provided by the event loop. */
 182
 183 /***** END of utility functions *****/
 184
 185 /***** START of max_start_pad handling *****/
 186
 187 extern int32_t site_max_start_pad, transform_max_start_pad,
 188     comm_max_start_pad;
 189
 190 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance);
 191 int32_t calculate_max_start_pad(void);
 192
 193 /***** END of max_start_pad handling *****/
 194
 195 /***** SCHEDULING support */
 196
 197 /* If nfds_io is insufficient for your needs, set it to the required
 198    number and return ERANGE. timeout is in milliseconds; if it is too
 199    high then lower it. It starts at -1 (==infinite) */
 200 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
 201                           int *timeout_io);
 202 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
 203
 204 /* void BEFOREPOLL_WANT_FDS(int want);
 205  *   Expects: int *nfds_io;
 206  *   Can perform non-local exit.
 207  * Checks whether there is space for want fds.  If so, sets *nfds_io.
 208  * If not, sets *nfds_io and returns. */
 209 #define BEFOREPOLL_WANT_FDS(want) do{                           \
 210     if (*nfds_io<(want)) { *nfds_io=(want); return ERANGE; }    \
 211     *nfds_io=(want);                                            \
 212   }while(0)
 213
 214 /* Register interest in the main loop of the program. Before a call
 215    to poll() your supplied beforepoll function will be called. After
 216    the call to poll() the supplied afterpoll function will be called.
 217    max_nfds is a _hint_ about the maximum number of struct pollfd
 218    structures you may require - you can always ask for more in
 219    *nfds_io. */
 220 extern void register_for_poll(void *st, beforepoll_fn *before,
 221                               afterpoll_fn *after, int32_t max_nfds,
 222                               cstring_t desc);
 223
 224 /***** END of scheduling support */
 225
 226 /***** PROGRAM LIFETIME support */
 227
 228 /* The secnet program goes through a number of phases in its lifetime.
 229    Module code may arrange to be called just as various phases are
 230    entered.
 231
 232    Remember to update the table in util.c if changing the set of
 233    phases. */
 234
 235 enum phase {
 236     PHASE_INIT,
 237     PHASE_GETOPTS,             /* Process command-line arguments */
 238     PHASE_READCONFIG,          /* Parse and process configuration file */
 239     PHASE_SETUP,               /* Process information in configuration */
 240     PHASE_DAEMONIZE,           /* Become a daemon (if necessary) */
 241     PHASE_GETRESOURCES,        /* Obtain all external resources */
 242     PHASE_DROPPRIV,            /* Last chance for privileged operations */
 243     PHASE_RUN,
 244     PHASE_SHUTDOWN,            /* About to die; delete key material, etc. */
 245     /* Keep this last: */
 246     NR_PHASES,
 247 };
 248
 249 typedef void hook_fn(void *self, uint32_t newphase);
 250 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
 251 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
 252
 253 extern uint32_t current_phase;
 254 extern void enter_phase(uint32_t new_phase);
 255
 256 /* Some features (like netlink 'soft' routes) require that secnet
 257    retain root privileges.  They should indicate that here when
 258    appropriate. */
 259 extern bool_t require_root_privileges;
 260 extern cstring_t require_root_privileges_explanation;
 261
 262 /***** END of program lifetime support *****/
 263
 264 /***** MODULE support *****/
 265
 266 /* Module initialisation function type - modules export one function of
 267    this type which is called to initialise them. For dynamically loaded
 268    modules it's called "secnet_module". */
 269 typedef void init_module(dict_t *dict);
 270
 271 extern void init_builtin_modules(dict_t *dict);
 272
 273 extern init_module resolver_module;
 274 extern init_module random_module;
 275 extern init_module udp_module;
 276 extern init_module util_module;
 277 extern init_module site_module;
 278 extern init_module transform_eax_module;
 279 extern init_module transform_cbcmac_module;
 280 extern init_module netlink_module;
 281 extern init_module rsa_module;
 282 extern init_module dh_module;
 283 extern init_module md5_module;
 284 extern init_module slip_module;
 285 extern init_module tun_module;
 286 extern init_module sha1_module;
 287 extern init_module log_module;
 288
 289 /***** END of module support *****/
 290
 291 /***** CLOSURE TYPES and interface definitions *****/
 292
 293 #define CL_PURE         0
 294 #define CL_RESOLVER     1
 295 #define CL_RANDOMSRC    2
 296 #define CL_RSAPUBKEY    3
 297 #define CL_RSAPRIVKEY   4
 298 #define CL_COMM         5
 299 #define CL_IPIF         6
 300 #define CL_LOG          7
 301 #define CL_SITE         8
 302 #define CL_TRANSFORM    9
 303 #define CL_DH          11
 304 #define CL_HASH        12
 305 #define CL_BUFFER      13
 306 #define CL_NETLINK     14
 307
 308 struct buffer_if;
 309
 310 /* PURE closure requires no interface */
 311
 312 /* RESOLVER interface */
 313
 314 /* Answers to queries are delivered to a function of this
 315    type. 'address' will be NULL if there was a problem with the query. It
 316    will be freed once resolve_answer_fn returns. It is in network byte
 317    order. */
 318 typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
 319                                int naddrs, const char *name,
 320                                const char *failwhy);
 321   /* name is the same ptr as passed to request, so its lifetime must
 322    * be suitable*/
 323 typedef bool_t resolve_request_fn(void *st, cstring_t name,
 324                                   int remoteport, struct comm_if *comm,
 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. */
 334 typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff);
 335
 336 struct random_if {
 337     void *st;
 338     bool_t blocking;
 339     random_fn *generate;
 340 };
 341
 342 /* RSAPUBKEY interface */
 343
 344 typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen,
 345                                cstring_t signature);
 346 struct rsapubkey_if {
 347     void *st;
 348     rsa_checksig_fn *check;
 349 };
 350
 351 /* RSAPRIVKEY interface */
 352
 353 typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen);
 354 struct rsaprivkey_if {
 355     void *st;
 356     rsa_makesig_fn *sign;
 357 };
 358
 359 /* COMM interface */
 360
 361 struct comm_addr {
 362     /* This struct is pure data; in particular comm's clients may
 363        freely copy it. */
 364     /* Everyone is also guaranteed that all padding is set to zero, ie
 365        that comm_addrs referring to semantically identical peers will
 366        compare equal with memcmp.  Anyone who constructs a comm_addr
 367        must start by memsetting it with FILLZERO, or some
 368        equivalent. */
 369     struct comm_if *comm;
 370     union iaddr ia;
 371     int ix;
 372 };
 373
 374 /* Return True if the packet was processed, and shouldn't be passed to
 375    any other potential receivers. */
 376 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
 377                               const struct comm_addr *source);
 378 typedef void comm_request_notify_fn(void *commst, void *nst,
 379                                     comm_notify_fn *fn);
 380 typedef void comm_release_notify_fn(void *commst, void *nst,
 381                                     comm_notify_fn *fn);
 382 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
 383                                const struct comm_addr *dest);
 384   /* Only returns false if (we know that) the local network
 385    * environment is such that this address cannot work; transient
 386    * or unknown/unexpected failures return true. */
 387 typedef const char *comm_addr_to_string_fn(void *commst,
 388                                            const struct comm_addr *ca);
 389         /* Returned string is in a static buffer. */
 390 struct comm_if {
 391     void *st;
 392     comm_request_notify_fn *request_notify;
 393     comm_release_notify_fn *release_notify;
 394     comm_sendmsg_fn *sendmsg;
 395     comm_addr_to_string_fn *addr_to_string;
 396 };
 397
 398 static inline const char *comm_addr_to_string(const struct comm_addr *ca)
 399 {
 400     return ca->comm->addr_to_string(ca->comm->st, ca);
 401 }
 402
 403 /* LOG interface */
 404
 405 #define LOG_MESSAGE_BUFLEN 1023
 406
 407 typedef void log_msg_fn(void *st, int class, const char *message, ...);
 408 typedef void log_vmsg_fn(void *st, int class, const char *message,
 409                          va_list args);
 410 struct log_if {
 411     void *st;
 412     log_vmsg_fn *vlogfn; /* printf format checking.  Use [v]slilog instead */
 413     char buff[LOG_MESSAGE_BUFLEN+1];
 414 };
 415 /* (convenience functions, defined in util.c) */
 416 extern void slilog(struct log_if *lf, int class, const char *message, ...)
 417 FORMAT(printf,3,4);
 418 extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
 419 FORMAT(printf,3,0);
 420
 421 /* Versions which take (parts of) (multiple) messages, using \n to
 422  * distinguish one message from another. */
 423 extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
 424 FORMAT(printf,3,4);
 425 extern void vslilog_part(struct log_if *lf, int class, const char *message,
 426                          va_list) FORMAT(printf,3,0);
 427
 428 /* SITE interface */
 429
 430 /* Pretty much a placeholder; allows starting and stopping of processing,
 431    key expiry, etc. */
 432 typedef void site_control_fn(void *st, bool_t run);
 433 typedef uint32_t site_status_fn(void *st);
 434 struct site_if {
 435     void *st;
 436     site_control_fn *control;
 437     site_status_fn *status;
 438 };
 439
 440 /* TRANSFORM interface */
 441
 442 /* A reversable transformation. Transforms buffer in-place; may add
 443    data to start or end. (Reverse transformations decrease
 444    length, of course.)  Transformations may be key-dependent, in which
 445    case key material is passed in at initialisation time. They may
 446    also depend on internal factors (eg. time) and keep internal
 447    state. A struct transform_if only represents a particular type of
 448    transformation; instances of the transformation (eg. with
 449    particular key material) have a different C type. The same
 450    secret key will be used in opposite directions between a pair of
 451    secnets; one of these pairs will get direction==False, the other True. */
 452
 453 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
 454 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
 455                                    bool_t direction);
 456 typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
 457 typedef void transform_delkey_fn(void *st);
 458 typedef void transform_destroyinstance_fn(void *st);
 459 /* Returns:
 460  *   0: all is well
 461  *   1: for any other problem
 462  *   2: message decrypted but sequence number was out of range
 463  */
 464 typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
 465                                     const char **errmsg);
 466
 467 struct transform_inst_if {
 468     void *st;
 469     transform_setkey_fn *setkey;
 470     transform_valid_fn *valid;
 471     transform_delkey_fn *delkey;
 472     transform_apply_fn *forwards;
 473     transform_apply_fn *reverse;
 474     transform_destroyinstance_fn *destroy;
 475 };
 476
 477 struct transform_if {
 478     void *st;
 479     int capab_transformnum;
 480     int32_t keylen; /* <<< INT_MAX */
 481     transform_createinstance_fn *create;
 482 };
 483
 484 /* NETLINK interface */
 485
 486 /* Used by netlink to deliver to site, and by site to deliver to
 487    netlink.  cid is the client identifier returned by
 488    netlink_regnets_fn.  If buf has size 0 then the function is just
 489    being called for its site-effects (eg. making the site code attempt
 490    to bring up a network link) */
 491 typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
 492 /* site code can tell netlink when outgoing packets will be dropped,
 493    so netlink can generate appropriate ICMP and make routing decisions */
 494 #define LINK_QUALITY_UNUSED 0   /* This link is unused, do not make this netlink */
 495 #define LINK_QUALITY_DOWN 1   /* No chance of a packet being delivered right away*/
 496 #define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
 497 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
 498 #define LINK_QUALITY_UP 4     /* Link active */
 499 #define MAXIMUM_LINK_QUALITY 3
 500 typedef void netlink_link_quality_fn(void *st, uint32_t quality);
 501 typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
 502                                  void *dst, uint32_t *localmtu_r /* NULL ok */);
 503 typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
 504 typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
 505 typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
 506 struct netlink_if {
 507     void *st;
 508     netlink_register_fn *reg;
 509     netlink_deliver_fn *deliver;
 510     netlink_link_quality_fn *set_quality;
 511     netlink_set_mtu_fn *set_mtu;
 512 };
 513
 514 /* DH interface */
 515
 516 /* Returns public key as a malloced hex string */
 517 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
 518                                   int32_t secretlen);
 519 /* Fills buffer (up to buflen) with shared secret */
 520 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
 521                               int32_t secretlen, cstring_t rempublic,
 522                               uint8_t *sharedsecret, int32_t buflen);
 523 struct dh_if {
 524     void *st;
 525     int32_t len; /* Approximate size of modulus in bytes */
 526     int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
 527     dh_makepublic_fn *makepublic;
 528     dh_makeshared_fn *makeshared;
 529 };
 530
 531 /* HASH interface */
 532
 533 typedef void *hash_init_fn(void);
 534 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
 535 typedef void hash_final_fn(void *st, uint8_t *digest);
 536 struct hash_if {
 537     int32_t len; /* Hash output length in bytes */
 538     hash_init_fn *init;
 539     hash_update_fn *update;
 540     hash_final_fn *final;
 541 };
 542
 543 /* BUFFER interface */
 544
 545 struct buffer_if {
 546     bool_t free;
 547     cstring_t owner; /* Set to constant string */
 548     uint32_t flags; /* How paranoid should we be? */
 549     struct cloc loc; /* Where we were defined */
 550     uint8_t *base;
 551     uint8_t *start;
 552     int32_t size; /* Size of buffer contents */
 553     int32_t alloclen; /* Total length allocated at base */
 554 };
 555
 556 /***** LOG functions *****/
 557
 558 #define M_DEBUG_CONFIG 0x001
 559 #define M_DEBUG_PHASE  0x002
 560 #define M_DEBUG        0x004
 561 #define M_INFO         0x008
 562 #define M_NOTICE       0x010
 563 #define M_WARNING      0x020
 564 #define M_ERR          0x040
 565 #define M_SECURITY     0x080
 566 #define M_FATAL        0x100
 567
 568 /* The fatal() family of functions require messages that do not end in '\n' */
 569 extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
 570 extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
 571 extern NORETURN(fatal_status(int status, const char *message, ...))
 572        FORMAT(printf,2,3);
 573 extern NORETURN(fatal_perror_status(int status, const char *message, ...))
 574        FORMAT(printf,2,3);
 575
 576 /* The cfgfatal() family of functions require messages that end in '\n' */
 577 extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
 578                          const char *message, ...)) FORMAT(printf,3,4);
 579 extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
 580 extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
 581                                     cstring_t facility, const char *message,
 582                                     va_list))
 583     FORMAT(printf,4,0);
 584 extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
 585                                    cstring_t facility,
 586                                    const char *message, ...))
 587     FORMAT(printf,4,5);
 588
 589 extern void Message(uint32_t class, const char *message, ...)
 590     FORMAT(printf,2,3);
 591 extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
 592
 593 /***** END of log functions *****/
 594
 595 #define STRING2(x) #x
 596 #define STRING(x) STRING2(x)
 597
 598 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
 599 #define ARRAY_SIZE(ary) (sizeof(ary)/sizeof(ary[0]))
 600
 601 #endif /* secnet_h */