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_circuit; 128 struct dmsg_state; 129 struct dmsg_msg; 130 131 TAILQ_HEAD(dmsg_state_queue, dmsg_state); 132 TAILQ_HEAD(dmsg_msg_queue, dmsg_msg); 133 RB_HEAD(dmsg_state_tree, dmsg_state); 134 RB_HEAD(dmsg_circuit_tree, dmsg_circuit); 135 136 struct h2span_link; 137 struct h2span_relay; 138 struct h2span_conn; 139 140 struct dmsg_circuit { 141 RB_ENTRY(dmsg_circuit) rbnode; 142 uint64_t msgid; 143 struct dmsg_iocom *iocom; 144 struct dmsg_state_tree staterd_tree; /* active transactions */ 145 struct dmsg_state_tree statewr_tree; /* active transactions */ 146 struct dmsg_circuit *peer; /* (if circuit relay) */ 147 struct dmsg_state *state; /* open VC transaction state */ 148 struct dmsg_state *span_state; /* span, relay or link */ 149 int is_relay; /* span is h2span_relay */ 150 int refs; 151 }; 152 153 /* 154 * This represents a media, managed by LNK_CONN connection state 155 */ 156 TAILQ_HEAD(dmsg_media_queue, dmsg_media); 157 158 struct dmsg_media { 159 TAILQ_ENTRY(dmsg_media) entry; 160 uuid_t mediaid; 161 int refs; 162 void *usrhandle; 163 }; 164 165 typedef struct dmsg_media dmsg_media_t; 166 167 /* 168 * The state structure is ref-counted. The iocom cannot go away while 169 * state structures are active. However, the related h2span_* linkages 170 * can be destroyed and NULL'd out if the state is terminated in both 171 * directions. 172 */ 173 struct dmsg_state { 174 RB_ENTRY(dmsg_state) rbnode; /* indexed by msgid */ 175 struct dmsg_iocom *iocom; 176 struct dmsg_circuit *circuit; /* associated circuit */ 177 uint32_t icmd; /* command creating state */ 178 uint32_t txcmd; /* mostly for CMDF flags */ 179 uint32_t rxcmd; /* mostly for CMDF flags */ 180 uint64_t msgid; /* {spanid,msgid} uniq */ 181 int flags; 182 int error; 183 int refs; /* prevent destruction */ 184 struct dmsg_msg *msg; /* msg creating orig state */ 185 void (*func)(struct dmsg_msg *); 186 union { 187 void *any; 188 struct h2span_link *link; 189 struct h2span_conn *conn; 190 struct h2span_relay *relay; 191 struct dmsg_circuit *circ; 192 } any; 193 dmsg_media_t *media; 194 }; 195 196 #define DMSG_STATE_INSERTED 0x0001 197 #define DMSG_STATE_DYNAMIC 0x0002 198 #define DMSG_STATE_NODEID 0x0004 /* manages a node id */ 199 200 /* 201 * This is the core in-memory representation of a message structure. 202 * The iocom represents the incoming or outgoing iocom. Various state 203 * pointers are calculated based on the message's raw source and target 204 * fields, and will ref the underlying state. Message headers are embedded 205 * while auxillary data is separately allocated. 206 */ 207 struct dmsg_msg { 208 TAILQ_ENTRY(dmsg_msg) qentry; 209 struct dmsg_iocom *iocom; /* incoming/outgoing iocom */ 210 struct dmsg_circuit *circuit; /* associated circuit */ 211 struct dmsg_state *state; /* message state */ 212 size_t hdr_size; 213 size_t aux_size; 214 char *aux_data; 215 dmsg_any_t any; /* must be last element */ 216 }; 217 218 typedef struct dmsg_circuit dmsg_circuit_t; 219 typedef struct dmsg_state dmsg_state_t; 220 typedef struct dmsg_msg dmsg_msg_t; 221 typedef struct dmsg_msg_queue dmsg_msg_queue_t; 222 223 int dmsg_state_cmp(dmsg_state_t *state1, dmsg_state_t *state2); 224 RB_PROTOTYPE(dmsg_state_tree, dmsg_state, rbnode, dmsg_state_cmp); 225 int dmsg_circuit_cmp(dmsg_circuit_t *circuit1, dmsg_circuit_t *circuit2); 226 RB_PROTOTYPE(dmsg_circuit_tree, dmsg_circuit, rbnode, dmsg_circuit_cmp); 227 228 /* 229 * dmsg_ioq - An embedded component of dmsg_conn, holds state 230 * for the buffering and parsing of incoming and outgoing messages. 231 * 232 * cdx - beg - processed buffer data, encrypted or decrypted 233 * end - cdn - unprocessed buffer data not yet encrypted or decrypted 234 */ 235 struct dmsg_ioq { 236 enum { DMSG_MSGQ_STATE_HEADER1, 237 DMSG_MSGQ_STATE_HEADER2, 238 DMSG_MSGQ_STATE_AUXDATA1, 239 DMSG_MSGQ_STATE_AUXDATA2, 240 DMSG_MSGQ_STATE_ERROR } state; 241 size_t fifo_beg; /* buffered data */ 242 size_t fifo_cdx; /* cdx-beg processed */ 243 size_t fifo_cdn; /* end-cdn unprocessed */ 244 size_t fifo_end; 245 size_t hbytes; /* header size */ 246 size_t abytes; /* aligned aux_data size */ 247 size_t unaligned_aux_size; /* actual aux_data size */ 248 int error; 249 int seq; /* salt sequencer */ 250 int msgcount; 251 EVP_CIPHER_CTX ctx; 252 char iv[DMSG_MAX_IV_SIZE]; /* encrypt or decrypt iv[] */ 253 dmsg_msg_t *msg; 254 dmsg_msg_queue_t msgq; 255 char buf[DMSG_BUF_SIZE]; /* staging buffer */ 256 }; 257 258 typedef struct dmsg_ioq dmsg_ioq_t; 259 260 #define DMSG_IOQ_ERROR_SYNC 1 /* bad magic / out of sync */ 261 #define DMSG_IOQ_ERROR_EOF 2 /* unexpected EOF */ 262 #define DMSG_IOQ_ERROR_SOCK 3 /* read() error on socket */ 263 #define DMSG_IOQ_ERROR_FIELD 4 /* invalid field */ 264 #define DMSG_IOQ_ERROR_HCRC 5 /* core header crc bad */ 265 #define DMSG_IOQ_ERROR_XCRC 6 /* ext header crc bad */ 266 #define DMSG_IOQ_ERROR_ACRC 7 /* aux data crc bad */ 267 #define DMSG_IOQ_ERROR_STATE 8 /* bad state */ 268 #define DMSG_IOQ_ERROR_NOPEER 9 /* bad socket peer */ 269 #define DMSG_IOQ_ERROR_NORKEY 10 /* no remote keyfile found */ 270 #define DMSG_IOQ_ERROR_NOLKEY 11 /* no local keyfile found */ 271 #define DMSG_IOQ_ERROR_KEYXCHGFAIL 12 /* key exchange failed */ 272 #define DMSG_IOQ_ERROR_KEYFMT 13 /* key file format problem */ 273 #define DMSG_IOQ_ERROR_BADURANDOM 14 /* /dev/urandom is bad */ 274 #define DMSG_IOQ_ERROR_MSGSEQ 15 /* message sequence error */ 275 #define DMSG_IOQ_ERROR_EALREADY 16 /* ignore this message */ 276 #define DMSG_IOQ_ERROR_TRANS 17 /* state transaction issue */ 277 #define DMSG_IOQ_ERROR_IVWRAP 18 /* IVs exhaused */ 278 #define DMSG_IOQ_ERROR_MACFAIL 19 /* MAC of encr alg failed */ 279 #define DMSG_IOQ_ERROR_ALGO 20 /* Misc. encr alg error */ 280 #define DMSG_IOQ_ERROR_ROUTED 21 /* ignore routed message */ 281 #define DMSG_IOQ_ERROR_BAD_CIRCUIT 22 /* unconfigured circuit */ 282 #define DMSG_IOQ_ERROR_UNUSED23 23 283 #define DMSG_IOQ_ERROR_ASSYM 24 /* Assymetric path */ 284 285 #define DMSG_IOQ_MAXIOVEC 16 286 287 /* 288 * dmsg_iocom - governs a messaging stream connection 289 */ 290 struct dmsg_iocom { 291 char *label; /* label for error reporting */ 292 dmsg_ioq_t ioq_rx; 293 dmsg_ioq_t ioq_tx; 294 dmsg_msg_queue_t freeq; /* free msgs hdr only */ 295 dmsg_msg_queue_t freeq_aux; /* free msgs w/aux_data */ 296 int sock_fd; /* comm socket or pipe */ 297 int alt_fd; /* thread signal, tty, etc */ 298 int wakeupfds[2]; /* pipe wakes up iocom thread */ 299 int flags; 300 int rxmisc; 301 int txmisc; 302 void (*signal_callback)(struct dmsg_iocom *); 303 void (*altmsg_callback)(struct dmsg_iocom *); 304 void (*rcvmsg_callback)(dmsg_msg_t *msg); 305 void (*usrmsg_callback)(dmsg_msg_t *msg, int unmanaged); 306 void (*node_handler)(void **opaquep, dmsg_msg_t *msg, int op); 307 struct dmsg_circuit_tree circuit_tree; /* active circuits */ 308 struct dmsg_circuit circuit0; /* embedded circuit0 */ 309 dmsg_msg_queue_t txmsgq; /* tx msgq from remote */ 310 struct h2span_conn *conn; /* if LNK_CONN active */ 311 pthread_mutex_t mtx; /* mutex for state*tree/rmsgq */ 312 }; 313 314 typedef struct dmsg_iocom dmsg_iocom_t; 315 316 #define DMSG_IOCOMF_EOF 0x00000001 /* EOF or ERROR on desc */ 317 #define DMSG_IOCOMF_RREQ 0x00000002 /* request read-data event */ 318 #define DMSG_IOCOMF_WREQ 0x00000004 /* request write-avail event */ 319 #define DMSG_IOCOMF_RWORK 0x00000008 /* immediate work pending */ 320 #define DMSG_IOCOMF_WWORK 0x00000010 /* immediate work pending */ 321 #define DMSG_IOCOMF_PWORK 0x00000020 /* immediate work pending */ 322 #define DMSG_IOCOMF_ARWORK 0x00000040 /* immediate work pending */ 323 #define DMSG_IOCOMF_AWWORK 0x00000080 /* immediate work pending */ 324 #define DMSG_IOCOMF_SWORK 0x00000100 /* immediate work pending */ 325 #define DMSG_IOCOMF_CRYPTED 0x00000200 /* encrypt enabled */ 326 #define DMSG_IOCOMF_CLOSEALT 0x00000400 /* close alt_fd */ 327 328 /* 329 * Crypto algorithm table and related typedefs. 330 */ 331 typedef int (*algo_init_fn)(dmsg_ioq_t *, char *, int, char *, int, int); 332 typedef int (*algo_enc_fn)(dmsg_ioq_t *, char *, char *, int, int *); 333 typedef int (*algo_dec_fn)(dmsg_ioq_t *, char *, char *, int, int *); 334 335 struct crypto_algo { 336 const char *name; 337 int keylen; 338 int taglen; 339 algo_init_fn init; 340 algo_enc_fn enc_chunk; 341 algo_dec_fn dec_chunk; 342 }; 343 344 /* 345 * Master service thread info 346 */ 347 struct dmsg_master_service_info { 348 int fd; 349 int altfd; 350 int noclosealt; 351 int detachme; 352 char *label; 353 void *handle; 354 void (*altmsg_callback)(dmsg_iocom_t *iocom); 355 void (*usrmsg_callback)(dmsg_msg_t *msg, int unmanaged); 356 void (*node_handler)(void **opaquep, dmsg_msg_t *msg, int op); 357 void (*exit_callback)(void *handle); 358 }; 359 360 typedef struct dmsg_master_service_info dmsg_master_service_info_t; 361 362 /* 363 * node callbacks 364 */ 365 #define DMSG_NODEOP_ADD 1 366 #define DMSG_NODEOP_DEL 2 367 368 /* 369 * icrc 370 */ 371 uint32_t dmsg_icrc32(const void *buf, size_t size); 372 uint32_t dmsg_icrc32c(const void *buf, size_t size, uint32_t crc); 373 374 /* 375 * debug 376 */ 377 const char *dmsg_basecmd_str(uint32_t cmd); 378 const char *dmsg_msg_str(dmsg_msg_t *msg); 379 380 /* 381 * subs 382 */ 383 void *dmsg_alloc(size_t bytes); 384 void dmsg_free(void *ptr); 385 const char *dmsg_uuid_to_str(uuid_t *uuid, char **strp); 386 const char *dmsg_peer_type_to_str(uint8_t type); 387 int dmsg_connect(const char *hostname); 388 389 /* 390 * Msg support functions 391 */ 392 void dmsg_bswap_head(dmsg_hdr_t *head); 393 void dmsg_ioq_init(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq); 394 void dmsg_ioq_done(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq); 395 void dmsg_iocom_init(dmsg_iocom_t *iocom, int sock_fd, int alt_fd, 396 void (*state_func)(dmsg_iocom_t *iocom), 397 void (*rcvmsg_func)(dmsg_msg_t *msg), 398 void (*usrmsg_func)(dmsg_msg_t *msg, int unmanaged), 399 void (*altmsg_func)(dmsg_iocom_t *iocom)); 400 void dmsg_iocom_restate(dmsg_iocom_t *iocom, 401 void (*state_func)(dmsg_iocom_t *iocom), 402 void (*rcvmsg_func)(dmsg_msg_t *msg)); 403 void dmsg_iocom_label(dmsg_iocom_t *iocom, const char *ctl, ...); 404 void dmsg_iocom_signal(dmsg_iocom_t *iocom); 405 void dmsg_iocom_done(dmsg_iocom_t *iocom); 406 void dmsg_circuit_init(dmsg_iocom_t *iocom, dmsg_circuit_t *circuit); 407 dmsg_msg_t *dmsg_msg_alloc(dmsg_circuit_t *circuit, 408 size_t aux_size, uint32_t cmd, 409 void (*func)(dmsg_msg_t *), void *data); 410 void dmsg_msg_reply(dmsg_msg_t *msg, uint32_t error); 411 void dmsg_msg_result(dmsg_msg_t *msg, uint32_t error); 412 void dmsg_state_reply(dmsg_state_t *state, uint32_t error); 413 void dmsg_state_result(dmsg_state_t *state, uint32_t error); 414 415 void dmsg_msg_free(dmsg_msg_t *msg); 416 417 void dmsg_iocom_core(dmsg_iocom_t *iocom); 418 dmsg_msg_t *dmsg_ioq_read(dmsg_iocom_t *iocom); 419 void dmsg_msg_write(dmsg_msg_t *msg); 420 421 void dmsg_iocom_drain(dmsg_iocom_t *iocom); 422 void dmsg_iocom_flush1(dmsg_iocom_t *iocom); 423 void dmsg_iocom_flush2(dmsg_iocom_t *iocom); 424 425 void dmsg_state_cleanuprx(dmsg_iocom_t *iocom, dmsg_msg_t *msg); 426 void dmsg_state_free(dmsg_state_t *state); 427 void dmsg_circuit_hold(dmsg_circuit_t *circuit); 428 void dmsg_circuit_drop(dmsg_circuit_t *circuit); 429 void dmsg_circuit_drop_locked(dmsg_circuit_t *circuit); 430 431 int dmsg_circuit_route(dmsg_msg_t *msg); 432 433 /* 434 * Msg protocol functions 435 */ 436 void dmsg_msg_lnk_signal(dmsg_iocom_t *iocom); 437 void dmsg_msg_lnk(dmsg_msg_t *msg); 438 void dmsg_msg_dbg(dmsg_msg_t *msg); 439 void dmsg_shell_tree(dmsg_circuit_t *circuit, char *cmdbuf __unused); 440 int dmsg_debug_findspan(uint64_t msgid, dmsg_state_t **statep); 441 442 443 /* 444 * Crypto functions 445 */ 446 void dmsg_crypto_setup(void); 447 void dmsg_crypto_negotiate(dmsg_iocom_t *iocom); 448 void dmsg_crypto_decrypt(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq); 449 int dmsg_crypto_encrypt(dmsg_iocom_t *iocom, dmsg_ioq_t *ioq, 450 struct iovec *iov, int n, size_t *nactp); 451 452 /* 453 * Service daemon functions 454 */ 455 void *dmsg_master_service(void *data); 456 void dmsg_circuit_printf(dmsg_circuit_t *circuit, const char *ctl, ...) 457 __printflike(2, 3); 458 459 extern int DMsgDebugOpt; 460