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