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