lib/libdmsg/dmsg.h

   1 /*
   2  * Copyright (c) 2011-2012 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@dragonflybsd.org>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #include <sys/types.h>
  36 #include <sys/queue.h>
  37 #include <sys/tree.h>
  38 #include <sys/dmsg.h>
  39
  40 #include <pthread.h>
  41
  42 #if 0
  43 #include <openssl/rsa.h>        /* public/private key functions */
  44 #include <openssl/pem.h>        /* public/private key file load */
  45 #endif
  46 #include <openssl/err.h>
  47 #include <openssl/evp.h>        /* aes_256_cbc functions */
  48
  49 #define DMSG_DEFAULT_DIR        "/etc/hammer2"
  50 #define DMSG_PATH_REMOTE        DMSG_DEFAULT_DIR "/remote"
  51
  52 #define DMSG_LISTEN_PORT        987
  53
  54 /***************************************************************************
  55  *                              CRYPTO HANDSHAKE                           *
  56  ***************************************************************************
  57  *
  58  * The initial public-key exchange is implementing by transmitting a
  59  * 512-byte buffer to the other side in a symmetrical fashion.  This
  60  * buffer contains the following:
  61  *
  62  * (1) A random session key.  512 bits is specified.  We use aes_256_cbc()
  63  *     and initialize the key with the first 256 bits and the iv[] with
  64  *     the second.  Note that the transmitted and received session
  65  *     keys are XOR'd together to create the session key used for
  66  *     communications (so even if the verifier is compromised the session
  67  *     will still be gobbly gook if the public key has not been completely
  68  *     broken).
  69  *
  70  * (2) A verifier to determine that the decode was successful.  It encodes
  71  *     an XOR of each group of 4 bytes from the session key.
  72  *
  73  * (3) Additional configuration and additional random data.
  74  *
  75  *     - The hammer2 message header magic for endian detect
  76  *
  77  *     - The hammer2 protocol version.  The two sides agree on the
  78  *       smaller of the two.
  79  *
  80  *     - All unused fields (junk*) are filled with random data.
  81  *
  82  * This structure must be exactly 512 bytes and expects to use 256-byte
  83  * RSA keys.
  84  */
  85 struct dmsg_handshake {
  86         char pad1[8];           /* 000 */
  87         uint16_t magic;         /* 008 DMSG_HDR_MAGIC for endian detect */
  88         uint16_t version;       /* 00A hammer2 protocol version */
  89         uint32_t flags;         /* 00C protocol extension flags */
  90         uint8_t sess[64];       /* 010 512-bit session key */
  91         uint8_t verf[16];       /* 050 verifier = ~sess */
  92         char quickmsg[32];      /* 060 reason for connecting */
  93         char junk080[128];      /* 080-0FF */
  94         char pad2[8];           /* 100-107 */
  95         char junk100[256-8];    /* 108-1FF */
  96 };
  97
  98 typedef struct dmsg_handshake dmsg_handshake_t;
  99
 100
 101 #define DMSG_CRYPTO_CHUNK_SIZE          DMSG_ALIGN
 102 #define DMSG_MAX_IV_SIZE                32
 103
 104 #define DMSG_CRYPTO_GCM_IV_FIXED_SIZE   4
 105 #define DMSG_CRYPTO_GCM_IV_SIZE         12
 106 #define DMSG_CRYPTO_GCM_KEY_SIZE        32
 107 #define DMSG_CRYPTO_GCM_TAG_SIZE        16
 108
 109 #define DMSG_CRYPTO_ALGO_GCM_IDX        0
 110
 111 #define DMSG_CRYPTO_ALGO                DMSG_CRYPTO_ALGO_GCM_IDX
 112
 113 /***************************************************************************
 114  *                              LOW LEVEL MESSAGING                        *
 115  ***************************************************************************
 116  *
 117  * dmsg_msg - A standalone copy of a message, typically referenced by
 118  *               or embedded in other structures, or used with I/O queues.
 119  *
 120  * These structures are strictly temporary, so they do not have to be
 121  * particularly optimized for size.  All possible message headers are
 122  * directly embedded (any), and the message may contain a reference
 123  * to allocated auxillary data.  The structure is recycled quite often
 124  * by a connection.
 125  */
 126 struct dmsg_iocom;
 127 struct dmsg_state;
 128 struct dmsg_msg;
 129
 130 TAILQ_HEAD(dmsg_state_queue, dmsg_state);
 131 TAILQ_HEAD(dmsg_msg_queue, dmsg_msg);
 132 RB_HEAD(dmsg_state_tree, dmsg_state);
 133
 134 struct h2span_link;
 135 struct h2span_relay;
 136 struct h2span_conn;
 137
 138 /*
 139  * This represents a media, managed by LNK_CONN connection state
 140  */
 141 TAILQ_HEAD(dmsg_media_queue, dmsg_media);
 142
 143 struct dmsg_media {
 144         TAILQ_ENTRY(dmsg_media) entry;
 145         uuid_t  mediaid;
 146         int     refs;
 147         void    *usrhandle;
 148 };
 149
 150 typedef struct dmsg_media dmsg_media_t;
 151
 152 /*
 153  * The state structure is ref-counted.  The iocom cannot go away while
 154  * state structures are active.  However, the related h2span_* linkages
 155  * can be destroyed and NULL'd out if the state is terminated in both
 156  * directions.
 157  */
 158 struct dmsg_state {
 159         RB_ENTRY(dmsg_state) rbnode;            /* by state->msgid */
 160         TAILQ_HEAD(, dmsg_state) subq;          /* active stacked states */
 161         TAILQ_ENTRY(dmsg_state) entry;          /* on parent subq */
 162         struct dmsg_iocom *iocom;
 163         struct dmsg_state *parent;              /* transaction stacking */
 164         struct dmsg_state *relay;               /* routing */
 165         uint32_t        icmd;                   /* command creating state */
 166         uint32_t        txcmd;                  /* mostly for CMDF flags */
 167         uint32_t        rxcmd;                  /* mostly for CMDF flags */
 168         uint64_t        msgid;
 169         int             flags;
 170         int             error;
 171         int             refs;                   /* prevent destruction */
 172         void (*func)(struct dmsg_msg *);
 173         union {
 174                 void *any;
 175                 struct h2span_link *link;
 176                 struct h2span_conn *conn;
 177                 struct h2span_relay *relay;
 178         } any;
 179         dmsg_media_t    *media;
 180 };
 181
 182 #define DMSG_STATE_INSERTED     0x0001
 183 #define DMSG_STATE_DYNAMIC      0x0002
 184 #define DMSG_STATE_NODEID       0x0004          /* manages a node id */
 185 #define DMSG_STATE_UNUSED_0008  0x0008
 186 #define DMSG_STATE_OPPOSITE     0x0010          /* initiated by other end */
 187 #define DMSG_STATE_CIRCUIT      0x0020          /* LNK_SPAN special case */
 188 #define DMSG_STATE_DYING        0x0040          /* indicates circuit failure */
 189 #define DMSG_STATE_ROOT         0x8000          /* iocom->state0 */
 190
 191 /*
 192  * This is the core in-memory representation of a message structure.
 193  * state is the local representation of the transactional state and
 194  * will point to &iocom->state0 for non-transactional messages.
 195  *
 196  * Message headers are embedded while auxillary data is separately allocated.
 197  */
 198 struct dmsg_msg {
 199         TAILQ_ENTRY(dmsg_msg) qentry;
 200         struct dmsg_state *state;               /* message state */
 201         size_t          hdr_size;
 202         size_t          aux_size;
 203         char            *aux_data;
 204         uint32_t        tcmd;                   /* easy-switch cmd */
 205         dmsg_any_t      any;                    /* must be last element */
 206 };
 207
 208 typedef struct dmsg_state dmsg_state_t;
 209 typedef struct dmsg_msg dmsg_msg_t;
 210 typedef struct dmsg_msg_queue dmsg_msg_queue_t;
 211
 212 int dmsg_state_cmp(dmsg_state_t *state1, dmsg_state_t *state2);
 213 RB_PROTOTYPE(dmsg_state_tree, dmsg_state, rbnode, dmsg_state_cmp);
 214
 215 /*
 216  * dmsg_ioq - An embedded component of dmsg_conn, holds state
 217  * for the buffering and parsing of incoming and outgoing messages.
 218  *
 219  * cdx - beg  - processed buffer data, encrypted or decrypted
 220  * end - cdn  - unprocessed buffer data not yet encrypted or decrypted
 221  */
 222 struct dmsg_ioq {
 223         enum { DMSG_MSGQ_STATE_HEADER1,
 224                DMSG_MSGQ_STATE_HEADER2,
 225                DMSG_MSGQ_STATE_AUXDATA1,
 226                DMSG_MSGQ_STATE_AUXDATA2,
 227                DMSG_MSGQ_STATE_ERROR } state;
 228         size_t          fifo_beg;               /* buffered data */
 229         size_t          fifo_cdx;               /* cdx-beg processed */
 230         size_t          fifo_cdn;               /* end-cdn unprocessed */
 231         size_t          fifo_end;
 232         size_t          hbytes;                 /* header size */
 233         size_t          abytes;                 /* aligned aux_data size */
 234         size_t          unaligned_aux_size;     /* actual aux_data size */
 235         int             error;
 236         int             seq;                    /* salt sequencer */
 237         int             msgcount;
 238         EVP_CIPHER_CTX  ctx;
 239         char            iv[DMSG_MAX_IV_SIZE]; /* encrypt or decrypt iv[] */
 240         dmsg_msg_t      *msg;
 241         dmsg_msg_queue_t msgq;
 242         char            buf[DMSG_BUF_SIZE];     /* staging buffer */
 243 };
 244
 245 typedef struct dmsg_ioq dmsg_ioq_t;
 246
 247 #define DMSG_IOQ_ERROR_SYNC             1       /* bad magic / out of sync */
 248 #define DMSG_IOQ_ERROR_EOF              2       /* unexpected EOF */
 249 #define DMSG_IOQ_ERROR_SOCK             3       /* read() error on socket */
 250 #define DMSG_IOQ_ERROR_FIELD            4       /* invalid field */
 251 #define DMSG_IOQ_ERROR_HCRC             5       /* core header crc bad */
 252 #define DMSG_IOQ_ERROR_XCRC             6       /* ext header crc bad */
 253 #define DMSG_IOQ_ERROR_ACRC             7       /* aux data crc bad */
 254 #define DMSG_IOQ_ERROR_STATE            8       /* bad state */
 255 #define DMSG_IOQ_ERROR_NOPEER           9       /* bad socket peer */
 256 #define DMSG_IOQ_ERROR_NORKEY           10      /* no remote keyfile found */
 257 #define DMSG_IOQ_ERROR_NOLKEY           11      /* no local keyfile found */
 258 #define DMSG_IOQ_ERROR_KEYXCHGFAIL      12      /* key exchange failed */
 259 #define DMSG_IOQ_ERROR_KEYFMT           13      /* key file format problem */
 260 #define DMSG_IOQ_ERROR_BADURANDOM       14      /* /dev/urandom is bad */
 261 #define DMSG_IOQ_ERROR_MSGSEQ           15      /* message sequence error */
 262 #define DMSG_IOQ_ERROR_EALREADY         16      /* ignore this message */
 263 #define DMSG_IOQ_ERROR_TRANS            17      /* state transaction issue */
 264 #define DMSG_IOQ_ERROR_IVWRAP           18      /* IVs exhaused */
 265 #define DMSG_IOQ_ERROR_MACFAIL          19      /* MAC of encr alg failed */
 266 #define DMSG_IOQ_ERROR_ALGO             20      /* Misc. encr alg error */
 267 #define DMSG_IOQ_ERROR_UNUSED21         21
 268 #define DMSG_IOQ_ERROR_BAD_CIRCUIT      22      /* unconfigured circuit */
 269 #define DMSG_IOQ_ERROR_UNUSED23         23
 270 #define DMSG_IOQ_ERROR_ASSYM            24      /* Assymetric path */
 271
 272 #define DMSG_IOQ_MAXIOVEC    16
 273
 274 /*
 275  * dmsg_iocom - governs a messaging stream connection
 276  */
 277 struct dmsg_iocom {
 278         char            *label;                 /* label for error reporting */
 279         dmsg_ioq_t      ioq_rx;
 280         dmsg_ioq_t      ioq_tx;
 281         dmsg_msg_queue_t freeq;                 /* free msgs hdr only */
 282         dmsg_msg_queue_t freeq_aux;             /* free msgs w/aux_data */
 283         dmsg_state_t    state0;                 /* root state for stacking */
 284         struct dmsg_state_tree  staterd_tree;   /* active transactions */
 285         struct dmsg_state_tree  statewr_tree;   /* active transactions */
 286         int     sock_fd;                        /* comm socket or pipe */
 287         int     alt_fd;                         /* thread signal, tty, etc */
 288         int     wakeupfds[2];                   /* pipe wakes up iocom thread */
 289         int     flags;
 290         int     rxmisc;
 291         int     txmisc;
 292         void    (*signal_callback)(struct dmsg_iocom *);
 293         void    (*altmsg_callback)(struct dmsg_iocom *);
 294         void    (*rcvmsg_callback)(dmsg_msg_t *msg);
 295         void    (*usrmsg_callback)(dmsg_msg_t *msg, int unmanaged);
 296         dmsg_msg_queue_t txmsgq;                /* tx msgq from remote */
 297         struct h2span_conn *conn;               /* if LNK_CONN active */
 298         uint64_t        conn_msgid;             /* LNK_CONN circuit */
 299         pthread_mutex_t mtx;                    /* mutex for state*tree/rmsgq */
 300 };
 301
 302 typedef struct dmsg_iocom dmsg_iocom_t;
 303
 304 #define DMSG_IOCOMF_EOF         0x00000001      /* EOF or ERROR on desc */
 305 #define DMSG_IOCOMF_RREQ        0x00000002      /* request read-data event */
 306 #define DMSG_IOCOMF_WREQ        0x00000004      /* request write-avail event */
 307 #define DMSG_IOCOMF_RWORK       0x00000008      /* immediate work pending */
 308 #define DMSG_IOCOMF_WWORK       0x00000010      /* immediate work pending */
 309 #define DMSG_IOCOMF_PWORK       0x00000020      /* immediate work pending */
 310 #define DMSG_IOCOMF_ARWORK      0x00000040      /* immediate work pending */
 311 #define DMSG_IOCOMF_AWWORK      0x00000080      /* immediate work pending */
 312 #define DMSG_IOCOMF_SWORK       0x00000100      /* immediate work pending */
 313 #define DMSG_IOCOMF_CRYPTED     0x00000200      /* encrypt enabled */
 314 #define DMSG_IOCOMF_CLOSEALT    0x00000400      /* close alt_fd */
 315
 316 /*
 317  * Crypto algorithm table and related typedefs.
 318  */
 319 typedef int (*algo_init_fn)(dmsg_ioq_t *, char *, int, char *, int, int);
 320 typedef int (*algo_enc_fn)(dmsg_ioq_t *, char *, char *, int, int *);
 321 typedef int (*algo_dec_fn)(dmsg_ioq_t *, char *, char *, int, int *);
 322
 323 struct crypto_algo {
 324         const char      *name;
 325         int             keylen;
 326         int             taglen;
 327         algo_init_fn    init;
 328         algo_enc_fn     enc_chunk;
 329         algo_dec_fn     dec_chunk;
 330 };
 331
 332 /*
 333  * Master service thread info
 334  */
 335 struct dmsg_master_service_info {
 336         int     fd;
 337         int     altfd;
 338         int     noclosealt;
 339         int     detachme;
 340         char    *label;
 341         void    *handle;
 342         void    (*altmsg_callback)(dmsg_iocom_t *iocom);
 343         void    (*usrmsg_callback)(dmsg_msg_t *msg, int unmanaged);
 344         void    (*exit_callback)(void *handle);
 345 };
 346
 347 typedef struct dmsg_master_service_info dmsg_master_service_info_t;
 348
 349 /*
 350  * node callbacks
 351  */
 352 #define DMSG_NODEOP_ADD         1
 353 #define DMSG_NODEOP_DEL         2
 354
 355 /*
 356  * icrc
 357  */
 358 uint32_t dmsg_icrc32(const void *buf, size_t size);
 359 uint32_t dmsg_icrc32c(const void *buf, size_t size, uint32_t crc);
 360
 361 /*
 362  * debug
 363  */
 364 const char *dmsg_basecmd_str(uint32_t cmd);
 365 const char *dmsg_msg_str(dmsg_msg_t *msg);
 366
 367 /*
 368  * subs
 369  */
 370 void *dmsg_alloc(size_t bytes);
 371 void dmsg_free(void *ptr);
 372 const char *dmsg_uuid_to_str(uuid_t *uuid, char **strp);
 373 const char *dmsg_peer_type_to_str(uint8_t type);
 374 int dmsg_connect(const char *hostname);
 375
 376 /*
 377  * Msg support functions
 378  */
 379 void dmsg_bswap_head(dmsg_hdr_t *head);
 380 void dmsg_ioq_init(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq);
 381 void dmsg_ioq_done(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq);
 382 void dmsg_iocom_init(dmsg_iocom_t *iocom, int sock_fd, int alt_fd,
 383                         void (*state_func)(dmsg_iocom_t *iocom),
 384                         void (*rcvmsg_func)(dmsg_msg_t *msg),
 385                         void (*usrmsg_func)(dmsg_msg_t *msg, int unmanaged),
 386                         void (*altmsg_func)(dmsg_iocom_t *iocom));
 387 void dmsg_iocom_restate(dmsg_iocom_t *iocom,
 388                         void (*state_func)(dmsg_iocom_t *iocom),
 389                         void (*rcvmsg_func)(dmsg_msg_t *msg));
 390 void dmsg_iocom_label(dmsg_iocom_t *iocom, const char *ctl, ...);
 391 void dmsg_iocom_signal(dmsg_iocom_t *iocom);
 392 void dmsg_iocom_done(dmsg_iocom_t *iocom);
 393 dmsg_msg_t *dmsg_msg_alloc(dmsg_state_t *state, size_t aux_size,
 394                         uint32_t cmd,
 395                         void (*func)(dmsg_msg_t *), void *data);
 396 dmsg_msg_t *dmsg_msg_alloc_locked(dmsg_state_t *state, size_t aux_size,
 397                         uint32_t cmd,
 398                         void (*func)(dmsg_msg_t *), void *data);
 399 void dmsg_msg_reply(dmsg_msg_t *msg, uint32_t error);
 400 void dmsg_msg_result(dmsg_msg_t *msg, uint32_t error);
 401 void dmsg_state_reply(dmsg_state_t *state, uint32_t error);
 402 void dmsg_state_result(dmsg_state_t *state, uint32_t error);
 403
 404 void dmsg_msg_free(dmsg_msg_t *msg);
 405
 406 void dmsg_iocom_core(dmsg_iocom_t *iocom);
 407 dmsg_msg_t *dmsg_ioq_read(dmsg_iocom_t *iocom);
 408 void dmsg_msg_write(dmsg_msg_t *msg);
 409
 410 void dmsg_iocom_drain(dmsg_iocom_t *iocom);
 411 void dmsg_iocom_flush1(dmsg_iocom_t *iocom);
 412 void dmsg_iocom_flush2(dmsg_iocom_t *iocom);
 413
 414 void dmsg_state_relay(dmsg_msg_t *msg);
 415 void dmsg_state_cleanuprx(dmsg_iocom_t *iocom, dmsg_msg_t *msg);
 416 void dmsg_state_hold(dmsg_state_t *state);
 417 void dmsg_state_drop(dmsg_state_t *state);
 418
 419 /*
 420  * Msg protocol functions
 421  */
 422 void dmsg_msg_lnk_signal(dmsg_iocom_t *iocom);
 423 void dmsg_msg_lnk(dmsg_msg_t *msg);
 424 void dmsg_msg_dbg(dmsg_msg_t *msg);
 425 void dmsg_shell_tree(dmsg_iocom_t *iocom, char *cmdbuf __unused);
 426 int dmsg_debug_findspan(uint64_t msgid, dmsg_state_t **statep);
 427 dmsg_state_t *dmsg_findspan(const char *label);
 428
 429
 430 /*
 431  * Crypto functions
 432  */
 433 void dmsg_crypto_setup(void);
 434 void dmsg_crypto_negotiate(dmsg_iocom_t *iocom);
 435 void dmsg_crypto_decrypt(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq);
 436 int dmsg_crypto_encrypt(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq,
 437                         struct iovec *iov, int n, size_t *nactp);
 438
 439 /*
 440  * Service daemon functions
 441  */
 442 void *dmsg_master_service(void *data);
 443 void dmsg_printf(dmsg_iocom_t *iocom, const char *ctl, ...) __printflike(2, 3);
 444
 445 extern int DMsgDebugOpt;