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