1 /* $OpenBSD: ssl_local.h,v 1.11 2023/11/29 13:39:34 tb Exp $ */ 2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 3 * All rights reserved. 4 * 5 * This package is an SSL implementation written 6 * by Eric Young (eay@cryptsoft.com). 7 * The implementation was written so as to conform with Netscapes SSL. 8 * 9 * This library is free for commercial and non-commercial use as long as 10 * the following conditions are aheared to. The following conditions 11 * apply to all code found in this distribution, be it the RC4, RSA, 12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13 * included with this distribution is covered by the same copyright terms 14 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15 * 16 * Copyright remains Eric Young's, and as such any Copyright notices in 17 * the code are not to be removed. 18 * If this package is used in a product, Eric Young should be given attribution 19 * as the author of the parts of the library used. 20 * This can be in the form of a textual message at program startup or 21 * in documentation (online or textual) provided with the package. 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 1. Redistributions of source code must retain the copyright 27 * notice, this list of conditions and the following disclaimer. 28 * 2. Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in the 30 * documentation and/or other materials provided with the distribution. 31 * 3. All advertising materials mentioning features or use of this software 32 * must display the following acknowledgement: 33 * "This product includes cryptographic software written by 34 * Eric Young (eay@cryptsoft.com)" 35 * The word 'cryptographic' can be left out if the rouines from the library 36 * being used are not cryptographic related :-). 37 * 4. If you include any Windows specific code (or a derivative thereof) from 38 * the apps directory (application code) you must include an acknowledgement: 39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40 * 41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51 * SUCH DAMAGE. 52 * 53 * The licence and distribution terms for any publically available version or 54 * derivative of this code cannot be changed. i.e. this code cannot simply be 55 * copied and put under another distribution licence 56 * [including the GNU Public Licence.] 57 */ 58 /* ==================================================================== 59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved. 60 * 61 * Redistribution and use in source and binary forms, with or without 62 * modification, are permitted provided that the following conditions 63 * are met: 64 * 65 * 1. Redistributions of source code must retain the above copyright 66 * notice, this list of conditions and the following disclaimer. 67 * 68 * 2. Redistributions in binary form must reproduce the above copyright 69 * notice, this list of conditions and the following disclaimer in 70 * the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3. All advertising materials mentioning features or use of this 74 * software must display the following acknowledgment: 75 * "This product includes software developed by the OpenSSL Project 76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 77 * 78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 79 * endorse or promote products derived from this software without 80 * prior written permission. For written permission, please contact 81 * openssl-core@openssl.org. 82 * 83 * 5. Products derived from this software may not be called "OpenSSL" 84 * nor may "OpenSSL" appear in their names without prior written 85 * permission of the OpenSSL Project. 86 * 87 * 6. Redistributions of any form whatsoever must retain the following 88 * acknowledgment: 89 * "This product includes software developed by the OpenSSL Project 90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)" 91 * 92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 103 * OF THE POSSIBILITY OF SUCH DAMAGE. 104 * ==================================================================== 105 * 106 * This product includes cryptographic software written by Eric Young 107 * (eay@cryptsoft.com). This product includes software written by Tim 108 * Hudson (tjh@cryptsoft.com). 109 * 110 */ 111 /* ==================================================================== 112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED. 113 * ECC cipher suite support in OpenSSL originally developed by 114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project. 115 */ 116 /* ==================================================================== 117 * Copyright 2005 Nokia. All rights reserved. 118 * 119 * The portions of the attached software ("Contribution") is developed by 120 * Nokia Corporation and is licensed pursuant to the OpenSSL open source 121 * license. 122 * 123 * The Contribution, originally written by Mika Kousa and Pasi Eronen of 124 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites 125 * support (see RFC 4279) to OpenSSL. 126 * 127 * No patent licenses or other rights except those expressly stated in 128 * the OpenSSL open source license shall be deemed granted or received 129 * expressly, by implication, estoppel, or otherwise. 130 * 131 * No assurances are provided by Nokia that the Contribution does not 132 * infringe the patent or other intellectual property rights of any third 133 * party or that the license provides you with all the necessary rights 134 * to make use of the Contribution. 135 * 136 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN 137 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA 138 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY 139 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR 140 * OTHERWISE. 141 */ 142 143 #ifndef HEADER_SSL_LOCL_H 144 #define HEADER_SSL_LOCL_H 145 146 #include <sys/types.h> 147 148 #include <errno.h> 149 #include <stdlib.h> 150 #include <string.h> 151 #include <time.h> 152 #include <unistd.h> 153 154 #include <openssl/opensslconf.h> 155 156 #include <openssl/bio.h> 157 #include <openssl/buffer.h> 158 #include <openssl/dsa.h> 159 #include <openssl/err.h> 160 #include <openssl/rsa.h> 161 #include <openssl/ssl.h> 162 #include <openssl/stack.h> 163 164 #include "bytestring.h" 165 #include "tls_content.h" 166 #include "tls13_internal.h" 167 168 __BEGIN_HIDDEN_DECLS 169 170 #define CTASSERT(x) extern char _ctassert[(x) ? 1 : -1 ] \ 171 __attribute__((__unused__)) 172 173 #ifndef LIBRESSL_HAS_DTLS1_2 174 #define LIBRESSL_HAS_DTLS1_2 175 #endif 176 177 /* LOCAL STUFF */ 178 179 #define SSL_DECRYPT 0 180 #define SSL_ENCRYPT 1 181 182 /* 183 * Define the Bitmasks for SSL_CIPHER.algorithms. 184 * This bits are used packed as dense as possible. If new methods/ciphers 185 * etc will be added, the bits a likely to change, so this information 186 * is for internal library use only, even though SSL_CIPHER.algorithms 187 * can be publicly accessed. 188 * Use the according functions for cipher management instead. 189 * 190 * The bit mask handling in the selection and sorting scheme in 191 * ssl_create_cipher_list() has only limited capabilities, reflecting 192 * that the different entities within are mutually exclusive: 193 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME. 194 */ 195 196 /* Bits for algorithm_mkey (key exchange algorithm) */ 197 #define SSL_kRSA 0x00000001L /* RSA key exchange */ 198 #define SSL_kDHE 0x00000008L /* tmp DH key no DH cert */ 199 #define SSL_kECDHE 0x00000080L /* ephemeral ECDH */ 200 #define SSL_kGOST 0x00000200L /* GOST key exchange */ 201 #define SSL_kTLS1_3 0x00000400L /* TLSv1.3 key exchange */ 202 203 /* Bits for algorithm_auth (server authentication) */ 204 #define SSL_aRSA 0x00000001L /* RSA auth */ 205 #define SSL_aDSS 0x00000002L /* DSS auth */ 206 #define SSL_aNULL 0x00000004L /* no auth (i.e. use ADH or AECDH) */ 207 #define SSL_aECDSA 0x00000040L /* ECDSA auth*/ 208 #define SSL_aGOST01 0x00000200L /* GOST R 34.10-2001 signature auth */ 209 #define SSL_aTLS1_3 0x00000400L /* TLSv1.3 authentication */ 210 211 /* Bits for algorithm_enc (symmetric encryption) */ 212 #define SSL_DES 0x00000001L 213 #define SSL_3DES 0x00000002L 214 #define SSL_RC4 0x00000004L 215 #define SSL_IDEA 0x00000008L 216 #define SSL_eNULL 0x00000010L 217 #define SSL_AES128 0x00000020L 218 #define SSL_AES256 0x00000040L 219 #define SSL_CAMELLIA128 0x00000080L 220 #define SSL_CAMELLIA256 0x00000100L 221 #define SSL_eGOST2814789CNT 0x00000200L 222 #define SSL_AES128GCM 0x00000400L 223 #define SSL_AES256GCM 0x00000800L 224 #define SSL_CHACHA20POLY1305 0x00001000L 225 226 #define SSL_AES (SSL_AES128|SSL_AES256|SSL_AES128GCM|SSL_AES256GCM) 227 #define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256) 228 229 230 /* Bits for algorithm_mac (symmetric authentication) */ 231 232 #define SSL_MD5 0x00000001L 233 #define SSL_SHA1 0x00000002L 234 #define SSL_GOST94 0x00000004L 235 #define SSL_GOST89MAC 0x00000008L 236 #define SSL_SHA256 0x00000010L 237 #define SSL_SHA384 0x00000020L 238 /* Not a real MAC, just an indication it is part of cipher */ 239 #define SSL_AEAD 0x00000040L 240 #define SSL_STREEBOG256 0x00000080L 241 242 /* Bits for algorithm_ssl (protocol version) */ 243 #define SSL_SSLV3 0x00000002L 244 #define SSL_TLSV1 SSL_SSLV3 /* for now */ 245 #define SSL_TLSV1_2 0x00000004L 246 #define SSL_TLSV1_3 0x00000008L 247 248 249 /* Bits for algorithm2 (handshake digests and other extra flags) */ 250 251 #define SSL_HANDSHAKE_MAC_MASK 0xff0 252 #define SSL_HANDSHAKE_MAC_MD5 0x010 253 #define SSL_HANDSHAKE_MAC_SHA 0x020 254 #define SSL_HANDSHAKE_MAC_GOST94 0x040 255 #define SSL_HANDSHAKE_MAC_SHA256 0x080 256 #define SSL_HANDSHAKE_MAC_SHA384 0x100 257 #define SSL_HANDSHAKE_MAC_STREEBOG256 0x200 258 #define SSL_HANDSHAKE_MAC_DEFAULT (SSL_HANDSHAKE_MAC_MD5 | SSL_HANDSHAKE_MAC_SHA) 259 260 #define SSL3_CK_ID 0x03000000 261 #define SSL3_CK_VALUE_MASK 0x0000ffff 262 263 #define TLS1_PRF_DGST_MASK (0xff << TLS1_PRF_DGST_SHIFT) 264 265 #define TLS1_PRF_DGST_SHIFT 10 266 #define TLS1_PRF_MD5 (SSL_HANDSHAKE_MAC_MD5 << TLS1_PRF_DGST_SHIFT) 267 #define TLS1_PRF_SHA1 (SSL_HANDSHAKE_MAC_SHA << TLS1_PRF_DGST_SHIFT) 268 #define TLS1_PRF_SHA256 (SSL_HANDSHAKE_MAC_SHA256 << TLS1_PRF_DGST_SHIFT) 269 #define TLS1_PRF_SHA384 (SSL_HANDSHAKE_MAC_SHA384 << TLS1_PRF_DGST_SHIFT) 270 #define TLS1_PRF_GOST94 (SSL_HANDSHAKE_MAC_GOST94 << TLS1_PRF_DGST_SHIFT) 271 #define TLS1_PRF_STREEBOG256 (SSL_HANDSHAKE_MAC_STREEBOG256 << TLS1_PRF_DGST_SHIFT) 272 #define TLS1_PRF (TLS1_PRF_MD5 | TLS1_PRF_SHA1) 273 274 /* 275 * Stream MAC for GOST ciphersuites from cryptopro draft 276 * (currently this also goes into algorithm2). 277 */ 278 #define TLS1_STREAM_MAC 0x04 279 280 /* 281 * SSL_CIPHER_ALGORITHM2_VARIABLE_NONCE_IN_RECORD is an algorithm2 flag that 282 * indicates that the variable part of the nonce is included as a prefix of 283 * the record (AES-GCM, for example, does this with an 8-byte variable nonce.) 284 */ 285 #define SSL_CIPHER_ALGORITHM2_VARIABLE_NONCE_IN_RECORD (1 << 22) 286 287 /* 288 * SSL_CIPHER_AEAD_FIXED_NONCE_LEN returns the number of bytes of fixed nonce 289 * for an SSL_CIPHER with an algorithm_mac of SSL_AEAD. 290 */ 291 #define SSL_CIPHER_AEAD_FIXED_NONCE_LEN(ssl_cipher) \ 292 (((ssl_cipher->algorithm2 >> 24) & 0xf) * 2) 293 294 /* 295 * Cipher strength information. 296 */ 297 #define SSL_STRONG_MASK 0x000001fcL 298 #define SSL_STRONG_NONE 0x00000004L 299 #define SSL_LOW 0x00000020L 300 #define SSL_MEDIUM 0x00000040L 301 #define SSL_HIGH 0x00000080L 302 303 /* 304 * The keylength (measured in RSA key bits, I guess) for temporary keys. 305 * Cipher argument is so that this can be variable in the future. 306 */ 307 #define SSL_C_PKEYLENGTH(c) 1024 308 309 /* See if we use signature algorithms extension. */ 310 #define SSL_USE_SIGALGS(s) \ 311 (s->method->enc_flags & SSL_ENC_FLAG_SIGALGS) 312 313 /* See if we use SHA256 default PRF. */ 314 #define SSL_USE_SHA256_PRF(s) \ 315 (s->method->enc_flags & SSL_ENC_FLAG_SHA256_PRF) 316 317 /* Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2. */ 318 #define SSL_USE_TLS1_2_CIPHERS(s) \ 319 (s->method->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS) 320 321 /* Allow TLS 1.3 ciphersuites only. */ 322 #define SSL_USE_TLS1_3_CIPHERS(s) \ 323 (s->method->enc_flags & SSL_ENC_FLAG_TLS1_3_CIPHERS) 324 325 #define SSL_PKEY_RSA 0 326 #define SSL_PKEY_ECC 1 327 #define SSL_PKEY_GOST01 2 328 #define SSL_PKEY_NUM 3 329 330 #define SSL_MAX_EMPTY_RECORDS 32 331 332 /* SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) | 333 * <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN) 334 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN) 335 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN 336 * SSL_aRSA <- RSA_ENC | RSA_SIGN 337 * SSL_aDSS <- DSA_SIGN 338 */ 339 340 /* From ECC-TLS draft, used in encoding the curve type in 341 * ECParameters 342 */ 343 #define EXPLICIT_PRIME_CURVE_TYPE 1 344 #define EXPLICIT_CHAR2_CURVE_TYPE 2 345 #define NAMED_CURVE_TYPE 3 346 347 typedef struct ssl_cert_pkey_st { 348 X509 *x509; 349 EVP_PKEY *privatekey; 350 STACK_OF(X509) *chain; 351 } SSL_CERT_PKEY; 352 353 typedef struct ssl_cert_st { 354 /* Current active set */ 355 /* ALWAYS points to an element of the pkeys array 356 * Probably it would make more sense to store 357 * an index, not a pointer. */ 358 SSL_CERT_PKEY *key; 359 360 SSL_CERT_PKEY pkeys[SSL_PKEY_NUM]; 361 362 /* The following masks are for the key and auth 363 * algorithms that are supported by the certs below */ 364 int valid; 365 unsigned long mask_k; 366 unsigned long mask_a; 367 368 DH *dhe_params; 369 DH *(*dhe_params_cb)(SSL *ssl, int is_export, int keysize); 370 int dhe_params_auto; 371 372 int (*security_cb)(const SSL *s, const SSL_CTX *ctx, int op, int bits, 373 int nid, void *other, void *ex_data); /* Not exposed in API. */ 374 int security_level; 375 void *security_ex_data; /* Not exposed in API. */ 376 377 int references; /* >1 only if SSL_copy_session_id is used */ 378 } SSL_CERT; 379 380 struct ssl_comp_st { 381 int id; 382 const char *name; 383 }; 384 385 struct ssl_cipher_st { 386 int valid; 387 const char *name; /* text name */ 388 unsigned long id; /* id, 4 bytes, first is version */ 389 390 unsigned long algorithm_mkey; /* key exchange algorithm */ 391 unsigned long algorithm_auth; /* server authentication */ 392 unsigned long algorithm_enc; /* symmetric encryption */ 393 unsigned long algorithm_mac; /* symmetric authentication */ 394 unsigned long algorithm_ssl; /* (major) protocol version */ 395 396 unsigned long algo_strength; /* strength and export flags */ 397 unsigned long algorithm2; /* Extra flags */ 398 int strength_bits; /* Number of bits really used */ 399 int alg_bits; /* Number of bits for algorithm */ 400 }; 401 402 struct ssl_method_st { 403 int dtls; 404 int server; 405 int version; 406 407 uint16_t min_tls_version; 408 uint16_t max_tls_version; 409 410 int (*ssl_new)(SSL *s); 411 void (*ssl_clear)(SSL *s); 412 void (*ssl_free)(SSL *s); 413 414 int (*ssl_accept)(SSL *s); 415 int (*ssl_connect)(SSL *s); 416 int (*ssl_shutdown)(SSL *s); 417 418 int (*ssl_renegotiate)(SSL *s); 419 int (*ssl_renegotiate_check)(SSL *s); 420 421 int (*ssl_pending)(const SSL *s); 422 int (*ssl_read_bytes)(SSL *s, int type, unsigned char *buf, int len, 423 int peek); 424 int (*ssl_write_bytes)(SSL *s, int type, const void *buf_, int len); 425 426 const SSL_CIPHER *(*get_cipher)(unsigned int ncipher); 427 428 unsigned int enc_flags; /* SSL_ENC_FLAG_* */ 429 }; 430 431 /* 432 * Let's make this into an ASN.1 type structure as follows 433 * SSL_SESSION_ID ::= SEQUENCE { 434 * version INTEGER, -- structure version number 435 * SSLversion INTEGER, -- SSL version number 436 * Cipher OCTET STRING, -- the 2 byte cipher ID 437 * Session_ID OCTET STRING, -- the Session ID 438 * Master_key OCTET STRING, -- the master key 439 * KRB5_principal OCTET STRING -- optional Kerberos principal 440 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time 441 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds 442 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate 443 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context 444 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer' 445 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension 446 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint 447 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity 448 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket 449 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only) 450 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method 451 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username 452 * } 453 * Look in ssl/ssl_asn1.c for more details 454 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-). 455 */ 456 struct ssl_session_st { 457 int ssl_version; /* what ssl version session info is 458 * being kept in here? */ 459 460 size_t master_key_length; 461 unsigned char master_key[SSL_MAX_MASTER_KEY_LENGTH]; 462 463 /* session_id - valid? */ 464 size_t session_id_length; 465 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH]; 466 467 /* this is used to determine whether the session is being reused in 468 * the appropriate context. It is up to the application to set this, 469 * via SSL_new */ 470 size_t sid_ctx_length; 471 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH]; 472 473 /* Peer provided leaf (end-entity) certificate. */ 474 X509 *peer_cert; 475 int peer_cert_type; 476 477 /* when app_verify_callback accepts a session where the peer's certificate 478 * is not ok, we must remember the error for session reuse: */ 479 long verify_result; /* only for servers */ 480 481 long timeout; 482 time_t time; 483 int references; 484 485 const SSL_CIPHER *cipher; 486 unsigned long cipher_id; /* when ASN.1 loaded, this 487 * needs to be used to load 488 * the 'cipher' structure */ 489 490 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */ 491 492 char *tlsext_hostname; 493 494 /* Session resumption - RFC 5077 and RFC 8446. */ 495 unsigned char *tlsext_tick; /* Session ticket */ 496 size_t tlsext_ticklen; /* Session ticket length */ 497 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */ 498 uint32_t tlsext_tick_age_add; /* TLSv1.3 ticket age obfuscation (in ms) */ 499 struct tls13_secret resumption_master_secret; 500 501 CRYPTO_EX_DATA ex_data; /* application specific data */ 502 503 /* These are used to make removal of session-ids more 504 * efficient and to implement a maximum cache size. */ 505 struct ssl_session_st *prev, *next; 506 507 /* Used to indicate that session resumption is not allowed. 508 * Applications can also set this bit for a new session via 509 * not_resumable_session_cb to disable session caching and tickets. */ 510 int not_resumable; 511 512 size_t tlsext_ecpointformatlist_length; 513 uint8_t *tlsext_ecpointformatlist; /* peer's list */ 514 size_t tlsext_supportedgroups_length; 515 uint16_t *tlsext_supportedgroups; /* peer's list */ 516 }; 517 518 struct ssl_sigalg; 519 520 typedef struct ssl_handshake_tls12_st { 521 /* Used when SSL_ST_FLUSH_DATA is entered. */ 522 int next_state; 523 524 /* Handshake message type and size. */ 525 int message_type; 526 unsigned long message_size; 527 528 /* Reuse current handshake message. */ 529 int reuse_message; 530 531 /* Client certificate requests. */ 532 int cert_request; 533 STACK_OF(X509_NAME) *ca_names; 534 535 /* Record-layer key block for TLS 1.2 and earlier. */ 536 struct tls12_key_block *key_block; 537 538 /* Transcript hash prior to sending certificate verify message. */ 539 uint8_t cert_verify[EVP_MAX_MD_SIZE]; 540 } SSL_HANDSHAKE_TLS12; 541 542 typedef struct ssl_handshake_tls13_st { 543 int use_legacy; 544 int hrr; 545 546 /* Client indicates psk_dhe_ke support in PskKeyExchangeMode. */ 547 int use_psk_dhe_ke; 548 549 /* Certificate selected for use (static pointer). */ 550 const SSL_CERT_PKEY *cpk; 551 552 /* Version proposed by peer server. */ 553 uint16_t server_version; 554 555 uint16_t server_group; 556 struct tls13_secrets *secrets; 557 558 uint8_t *cookie; 559 size_t cookie_len; 560 561 /* Preserved transcript hash. */ 562 uint8_t transcript_hash[EVP_MAX_MD_SIZE]; 563 size_t transcript_hash_len; 564 565 /* Legacy session ID. */ 566 uint8_t legacy_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH]; 567 size_t legacy_session_id_len; 568 569 /* ClientHello hash, used to validate following HelloRetryRequest */ 570 EVP_MD_CTX *clienthello_md_ctx; 571 unsigned char *clienthello_hash; 572 unsigned int clienthello_hash_len; 573 574 /* QUIC read buffer and read/write encryption levels. */ 575 struct tls_buffer *quic_read_buffer; 576 enum ssl_encryption_level_t quic_read_level; 577 enum ssl_encryption_level_t quic_write_level; 578 } SSL_HANDSHAKE_TLS13; 579 580 typedef struct ssl_handshake_st { 581 /* 582 * Minimum and maximum versions supported for this handshake. These are 583 * initialised at the start of a handshake based on the method in use 584 * and the current protocol version configuration. 585 */ 586 uint16_t our_min_tls_version; 587 uint16_t our_max_tls_version; 588 589 /* 590 * Version negotiated for this session. For a client this is set once 591 * the server selected version is parsed from the ServerHello (either 592 * from the legacy version or supported versions extension). For a 593 * server this is set once we select the version we will use with the 594 * client. 595 */ 596 uint16_t negotiated_tls_version; 597 598 /* 599 * Legacy version advertised by our peer. For a server this is the 600 * version specified by the client in the ClientHello message. For a 601 * client, this is the version provided in the ServerHello message. 602 */ 603 uint16_t peer_legacy_version; 604 605 /* 606 * Current handshake state - contains one of the SSL3_ST_* values and 607 * is used by the TLSv1.2 state machine, as well as being updated by 608 * the TLSv1.3 stack due to it being exposed externally. 609 */ 610 int state; 611 612 /* Cipher being negotiated in this handshake. */ 613 const SSL_CIPHER *cipher; 614 615 /* Extensions seen in this handshake. */ 616 uint32_t extensions_seen; 617 618 /* Signature algorithms selected for use (static pointers). */ 619 const struct ssl_sigalg *our_sigalg; 620 const struct ssl_sigalg *peer_sigalg; 621 622 /* sigalgs offered in this handshake in wire form */ 623 uint8_t *sigalgs; 624 size_t sigalgs_len; 625 626 /* Key share for ephemeral key exchange. */ 627 struct tls_key_share *key_share; 628 629 /* 630 * Copies of the verify data sent in our finished message and the 631 * verify data received in the finished message sent by our peer. 632 */ 633 uint8_t finished[EVP_MAX_MD_SIZE]; 634 size_t finished_len; 635 uint8_t peer_finished[EVP_MAX_MD_SIZE]; 636 size_t peer_finished_len; 637 638 /* List of certificates received from our peer. */ 639 STACK_OF(X509) *peer_certs; 640 STACK_OF(X509) *peer_certs_no_leaf; 641 642 /* Certificate chain resulting from X.509 verification. */ 643 STACK_OF(X509) *verified_chain; 644 645 SSL_HANDSHAKE_TLS12 tls12; 646 SSL_HANDSHAKE_TLS13 tls13; 647 } SSL_HANDSHAKE; 648 649 typedef struct tls_session_ticket_ext_st TLS_SESSION_TICKET_EXT; 650 651 /* TLS Session Ticket extension struct. */ 652 struct tls_session_ticket_ext_st { 653 unsigned short length; 654 void *data; 655 }; 656 657 struct tls12_key_block; 658 659 struct tls12_key_block *tls12_key_block_new(void); 660 void tls12_key_block_free(struct tls12_key_block *kb); 661 void tls12_key_block_client_write(struct tls12_key_block *kb, CBS *mac_key, 662 CBS *key, CBS *iv); 663 void tls12_key_block_server_write(struct tls12_key_block *kb, CBS *mac_key, 664 CBS *key, CBS *iv); 665 int tls12_key_block_generate(struct tls12_key_block *kb, SSL *s, 666 const EVP_AEAD *aead, const EVP_CIPHER *cipher, const EVP_MD *mac_hash); 667 668 struct tls12_record_layer; 669 670 struct tls12_record_layer *tls12_record_layer_new(void); 671 void tls12_record_layer_free(struct tls12_record_layer *rl); 672 void tls12_record_layer_alert(struct tls12_record_layer *rl, 673 uint8_t *alert_desc); 674 int tls12_record_layer_write_overhead(struct tls12_record_layer *rl, 675 size_t *overhead); 676 int tls12_record_layer_read_protected(struct tls12_record_layer *rl); 677 int tls12_record_layer_write_protected(struct tls12_record_layer *rl); 678 void tls12_record_layer_set_aead(struct tls12_record_layer *rl, 679 const EVP_AEAD *aead); 680 void tls12_record_layer_set_cipher_hash(struct tls12_record_layer *rl, 681 const EVP_CIPHER *cipher, const EVP_MD *handshake_hash, 682 const EVP_MD *mac_hash); 683 void tls12_record_layer_set_version(struct tls12_record_layer *rl, 684 uint16_t version); 685 void tls12_record_layer_set_initial_epoch(struct tls12_record_layer *rl, 686 uint16_t epoch); 687 uint16_t tls12_record_layer_read_epoch(struct tls12_record_layer *rl); 688 uint16_t tls12_record_layer_write_epoch(struct tls12_record_layer *rl); 689 int tls12_record_layer_use_write_epoch(struct tls12_record_layer *rl, 690 uint16_t epoch); 691 void tls12_record_layer_write_epoch_done(struct tls12_record_layer *rl, 692 uint16_t epoch); 693 void tls12_record_layer_clear_read_state(struct tls12_record_layer *rl); 694 void tls12_record_layer_clear_write_state(struct tls12_record_layer *rl); 695 void tls12_record_layer_reflect_seq_num(struct tls12_record_layer *rl); 696 int tls12_record_layer_change_read_cipher_state(struct tls12_record_layer *rl, 697 CBS *mac_key, CBS *key, CBS *iv); 698 int tls12_record_layer_change_write_cipher_state(struct tls12_record_layer *rl, 699 CBS *mac_key, CBS *key, CBS *iv); 700 int tls12_record_layer_open_record(struct tls12_record_layer *rl, 701 uint8_t *buf, size_t buf_len, struct tls_content *out); 702 int tls12_record_layer_seal_record(struct tls12_record_layer *rl, 703 uint8_t content_type, const uint8_t *content, size_t content_len, 704 CBB *out); 705 706 typedef void (ssl_info_callback_fn)(const SSL *s, int type, int val); 707 typedef void (ssl_msg_callback_fn)(int is_write, int version, int content_type, 708 const void *buf, size_t len, SSL *ssl, void *arg); 709 710 struct ssl_ctx_st { 711 const SSL_METHOD *method; 712 const SSL_QUIC_METHOD *quic_method; 713 714 STACK_OF(SSL_CIPHER) *cipher_list; 715 716 struct x509_store_st /* X509_STORE */ *cert_store; 717 718 /* If timeout is not 0, it is the default timeout value set 719 * when SSL_new() is called. This has been put in to make 720 * life easier to set things up */ 721 long session_timeout; 722 723 int references; 724 725 /* Default values to use in SSL structures follow (these are copied by SSL_new) */ 726 727 STACK_OF(X509) *extra_certs; 728 729 int verify_mode; 730 size_t sid_ctx_length; 731 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH]; 732 733 X509_VERIFY_PARAM *param; 734 735 /* 736 * XXX 737 * default_passwd_cb used by python and openvpn, need to keep it until we 738 * add an accessor 739 */ 740 /* Default password callback. */ 741 pem_password_cb *default_passwd_callback; 742 743 /* Default password callback user data. */ 744 void *default_passwd_callback_userdata; 745 746 uint16_t min_tls_version; 747 uint16_t max_tls_version; 748 749 /* 750 * These may be zero to imply minimum or maximum version supported by 751 * the method. 752 */ 753 uint16_t min_proto_version; 754 uint16_t max_proto_version; 755 756 unsigned long options; 757 unsigned long mode; 758 759 /* If this callback is not null, it will be called each 760 * time a session id is added to the cache. If this function 761 * returns 1, it means that the callback will do a 762 * SSL_SESSION_free() when it has finished using it. Otherwise, 763 * on 0, it means the callback has finished with it. 764 * If remove_session_cb is not null, it will be called when 765 * a session-id is removed from the cache. After the call, 766 * OpenSSL will SSL_SESSION_free() it. */ 767 int (*new_session_cb)(struct ssl_st *ssl, SSL_SESSION *sess); 768 void (*remove_session_cb)(struct ssl_ctx_st *ctx, SSL_SESSION *sess); 769 SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, 770 const unsigned char *data, int len, int *copy); 771 772 /* if defined, these override the X509_verify_cert() calls */ 773 int (*app_verify_callback)(X509_STORE_CTX *, void *); 774 void *app_verify_arg; 775 776 /* get client cert callback */ 777 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey); 778 779 /* cookie generate callback */ 780 int (*app_gen_cookie_cb)(SSL *ssl, unsigned char *cookie, 781 unsigned int *cookie_len); 782 783 /* verify cookie callback */ 784 int (*app_verify_cookie_cb)(SSL *ssl, const unsigned char *cookie, 785 unsigned int cookie_len); 786 787 ssl_info_callback_fn *info_callback; 788 789 /* callback that allows applications to peek at protocol messages */ 790 ssl_msg_callback_fn *msg_callback; 791 void *msg_callback_arg; 792 793 int (*default_verify_callback)(int ok,X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */ 794 795 /* Default generate session ID callback. */ 796 GEN_SESSION_CB generate_session_id; 797 798 /* TLS extensions servername callback */ 799 int (*tlsext_servername_callback)(SSL*, int *, void *); 800 void *tlsext_servername_arg; 801 802 /* Callback to support customisation of ticket key setting */ 803 int (*tlsext_ticket_key_cb)(SSL *ssl, unsigned char *name, 804 unsigned char *iv, EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc); 805 806 /* certificate status request info */ 807 /* Callback for status request */ 808 int (*tlsext_status_cb)(SSL *ssl, void *arg); 809 void *tlsext_status_arg; 810 811 struct lhash_st_SSL_SESSION *sessions; 812 813 /* Most session-ids that will be cached, default is 814 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */ 815 unsigned long session_cache_size; 816 struct ssl_session_st *session_cache_head; 817 struct ssl_session_st *session_cache_tail; 818 819 /* This can have one of 2 values, ored together, 820 * SSL_SESS_CACHE_CLIENT, 821 * SSL_SESS_CACHE_SERVER, 822 * Default is SSL_SESSION_CACHE_SERVER, which means only 823 * SSL_accept which cache SSL_SESSIONS. */ 824 int session_cache_mode; 825 826 struct { 827 int sess_connect; /* SSL new conn - started */ 828 int sess_connect_renegotiate;/* SSL reneg - requested */ 829 int sess_connect_good; /* SSL new conne/reneg - finished */ 830 int sess_accept; /* SSL new accept - started */ 831 int sess_accept_renegotiate;/* SSL reneg - requested */ 832 int sess_accept_good; /* SSL accept/reneg - finished */ 833 int sess_miss; /* session lookup misses */ 834 int sess_timeout; /* reuse attempt on timeouted session */ 835 int sess_cache_full; /* session removed due to full cache */ 836 int sess_hit; /* session reuse actually done */ 837 int sess_cb_hit; /* session-id that was not 838 * in the cache was 839 * passed back via the callback. This 840 * indicates that the application is 841 * supplying session-id's from other 842 * processes - spooky :-) */ 843 } stats; 844 845 CRYPTO_EX_DATA ex_data; 846 847 STACK_OF(SSL_CIPHER) *cipher_list_tls13; 848 849 SSL_CERT *cert; 850 851 /* Default values used when no per-SSL value is defined follow */ 852 853 /* what we put in client cert requests */ 854 STACK_OF(X509_NAME) *client_CA; 855 856 long max_cert_list; 857 858 int read_ahead; 859 860 int quiet_shutdown; 861 862 /* Maximum amount of data to send in one fragment. 863 * actual record size can be more than this due to 864 * padding and MAC overheads. 865 */ 866 unsigned int max_send_fragment; 867 868 /* RFC 4507 session ticket keys */ 869 unsigned char tlsext_tick_key_name[16]; 870 unsigned char tlsext_tick_hmac_key[16]; 871 unsigned char tlsext_tick_aes_key[16]; 872 873 /* SRTP profiles we are willing to do from RFC 5764 */ 874 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles; 875 876 /* 877 * ALPN information. 878 */ 879 880 /* 881 * Server callback function that allows the server to select the 882 * protocol for the connection. 883 * out: on successful return, this must point to the raw protocol 884 * name (without the length prefix). 885 * outlen: on successful return, this contains the length of out. 886 * in: points to the client's list of supported protocols in 887 * wire-format. 888 * inlen: the length of in. 889 */ 890 int (*alpn_select_cb)(SSL *s, const unsigned char **out, 891 unsigned char *outlen, const unsigned char *in, unsigned int inlen, 892 void *arg); 893 void *alpn_select_cb_arg; 894 895 /* Client list of supported protocols in wire format. */ 896 uint8_t *alpn_client_proto_list; 897 size_t alpn_client_proto_list_len; 898 899 size_t tlsext_ecpointformatlist_length; 900 uint8_t *tlsext_ecpointformatlist; /* our list */ 901 size_t tlsext_supportedgroups_length; 902 uint16_t *tlsext_supportedgroups; /* our list */ 903 SSL_CTX_keylog_cb_func keylog_callback; /* Unused. For OpenSSL compatibility. */ 904 size_t num_tickets; /* Unused, for OpenSSL compatibility */ 905 }; 906 907 struct ssl_st { 908 /* protocol version 909 * (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION, DTLS1_VERSION) 910 */ 911 int version; 912 913 const SSL_METHOD *method; 914 const SSL_QUIC_METHOD *quic_method; 915 916 /* There are 2 BIO's even though they are normally both the 917 * same. This is so data can be read and written to different 918 * handlers */ 919 920 BIO *rbio; /* used by SSL_read */ 921 BIO *wbio; /* used by SSL_write */ 922 BIO *bbio; /* used during session-id reuse to concatenate 923 * messages */ 924 int server; /* are we the server side? - mostly used by SSL_clear*/ 925 926 struct ssl3_state_st *s3; /* SSLv3 variables */ 927 struct dtls1_state_st *d1; /* DTLSv1 variables */ 928 929 X509_VERIFY_PARAM *param; 930 931 /* crypto */ 932 STACK_OF(SSL_CIPHER) *cipher_list; 933 934 /* This is used to hold the server certificate used */ 935 SSL_CERT *cert; 936 937 /* the session_id_context is used to ensure sessions are only reused 938 * in the appropriate context */ 939 size_t sid_ctx_length; 940 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH]; 941 942 /* This can also be in the session once a session is established */ 943 SSL_SESSION *session; 944 945 /* Used in SSL2 and SSL3 */ 946 int verify_mode; /* 0 don't care about verify failure. 947 * 1 fail if verify fails */ 948 int error; /* error bytes to be written */ 949 int error_code; /* actual code */ 950 951 SSL_CTX *ctx; 952 953 long verify_result; 954 955 int references; 956 957 int client_version; /* what was passed, used for 958 * SSLv3/TLS rollback check */ 959 960 unsigned int max_send_fragment; 961 962 const struct tls_extension **tlsext_build_order; 963 size_t tlsext_build_order_len; 964 965 char *tlsext_hostname; 966 967 /* certificate status request info */ 968 /* Status type or -1 if no status type */ 969 int tlsext_status_type; 970 971 SSL_CTX * initial_ctx; /* initial ctx, used to store sessions */ 972 #define session_ctx initial_ctx 973 974 struct tls13_ctx *tls13; 975 976 uint16_t min_tls_version; 977 uint16_t max_tls_version; 978 979 /* 980 * These may be zero to imply minimum or maximum version supported by 981 * the method. 982 */ 983 uint16_t min_proto_version; 984 uint16_t max_proto_version; 985 986 unsigned long options; /* protocol behaviour */ 987 unsigned long mode; /* API behaviour */ 988 989 /* Client list of supported protocols in wire format. */ 990 uint8_t *alpn_client_proto_list; 991 size_t alpn_client_proto_list_len; 992 993 /* QUIC transport params we will send */ 994 uint8_t *quic_transport_params; 995 size_t quic_transport_params_len; 996 997 /* XXX Callbacks */ 998 999 /* true when we are actually in SSL_accept() or SSL_connect() */ 1000 int in_handshake; 1001 int (*handshake_func)(SSL *); 1002 1003 ssl_info_callback_fn *info_callback; 1004 1005 /* callback that allows applications to peek at protocol messages */ 1006 ssl_msg_callback_fn *msg_callback; 1007 void *msg_callback_arg; 1008 1009 int (*verify_callback)(int ok,X509_STORE_CTX *ctx); /* fail if callback returns 0 */ 1010 1011 /* Default generate session ID callback. */ 1012 GEN_SESSION_CB generate_session_id; 1013 1014 /* TLS extension debug callback */ 1015 void (*tlsext_debug_cb)(SSL *s, int client_server, int type, 1016 unsigned char *data, int len, void *arg); 1017 void *tlsext_debug_arg; 1018 1019 /* TLS Session Ticket extension callback */ 1020 tls_session_ticket_ext_cb_fn tls_session_ticket_ext_cb; 1021 void *tls_session_ticket_ext_cb_arg; 1022 1023 /* TLS pre-shared secret session resumption */ 1024 tls_session_secret_cb_fn tls_session_secret_cb; 1025 void *tls_session_secret_cb_arg; 1026 1027 /* XXX non-callback */ 1028 1029 /* This holds a variable that indicates what we were doing 1030 * when a 0 or -1 is returned. This is needed for 1031 * non-blocking IO so we know what request needs re-doing when 1032 * in SSL_accept or SSL_connect */ 1033 int rwstate; 1034 1035 /* Imagine that here's a boolean member "init" that is 1036 * switched as soon as SSL_set_{accept/connect}_state 1037 * is called for the first time, so that "state" and 1038 * "handshake_func" are properly initialized. But as 1039 * handshake_func is == 0 until then, we use this 1040 * test instead of an "init" member. 1041 */ 1042 1043 int new_session;/* Generate a new session or reuse an old one. 1044 * NB: For servers, the 'new' session may actually be a previously 1045 * cached session or even the previous session unless 1046 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set */ 1047 int quiet_shutdown;/* don't send shutdown packets */ 1048 int shutdown; /* we have shut things down, 0x01 sent, 0x02 1049 * for received */ 1050 BUF_MEM *init_buf; /* buffer used during init */ 1051 void *init_msg; /* pointer to handshake message body, set by ssl3_get_message() */ 1052 int init_num; /* amount read/written */ 1053 int init_off; /* amount read/written */ 1054 1055 /* used internally to point at a raw packet */ 1056 unsigned char *packet; 1057 unsigned int packet_length; 1058 1059 int read_ahead; /* Read as many input bytes as possible 1060 * (for non-blocking reads) */ 1061 1062 int hit; /* reusing a previous session */ 1063 1064 STACK_OF(SSL_CIPHER) *cipher_list_tls13; 1065 1066 struct tls12_record_layer *rl; 1067 1068 /* session info */ 1069 1070 /* extra application data */ 1071 CRYPTO_EX_DATA ex_data; 1072 1073 /* client cert? */ 1074 /* for server side, keep the list of CA_dn we can use */ 1075 STACK_OF(X509_NAME) *client_CA; 1076 1077 /* set this flag to 1 and a sleep(1) is put into all SSL_read() 1078 * and SSL_write() calls, good for nbio debugging :-) */ 1079 int debug; 1080 long max_cert_list; 1081 int first_packet; 1082 1083 /* Expect OCSP CertificateStatus message */ 1084 int tlsext_status_expected; 1085 /* OCSP status request only */ 1086 STACK_OF(OCSP_RESPID) *tlsext_ocsp_ids; 1087 X509_EXTENSIONS *tlsext_ocsp_exts; 1088 1089 /* OCSP response received or to be sent */ 1090 unsigned char *tlsext_ocsp_resp; 1091 size_t tlsext_ocsp_resp_len; 1092 1093 /* RFC4507 session ticket expected to be received or sent */ 1094 int tlsext_ticket_expected; 1095 1096 size_t tlsext_ecpointformatlist_length; 1097 uint8_t *tlsext_ecpointformatlist; /* our list */ 1098 size_t tlsext_supportedgroups_length; 1099 uint16_t *tlsext_supportedgroups; /* our list */ 1100 1101 /* TLS Session Ticket extension override */ 1102 TLS_SESSION_TICKET_EXT *tlsext_session_ticket; 1103 1104 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles; /* What we'll do */ 1105 const SRTP_PROTECTION_PROFILE *srtp_profile; /* What's been chosen */ 1106 1107 int renegotiate;/* 1 if we are renegotiating. 1108 * 2 if we are a server and are inside a handshake 1109 * (i.e. not just sending a HelloRequest) */ 1110 1111 int rstate; /* where we are when reading */ 1112 1113 int mac_packet; 1114 1115 int empty_record_count; 1116 1117 size_t num_tickets; /* Unused, for OpenSSL compatibility */ 1118 }; 1119 1120 typedef struct ssl3_record_internal_st { 1121 int type; /* type of record */ 1122 unsigned int length; /* How many bytes available */ 1123 unsigned int padding_length; /* Number of padding bytes. */ 1124 unsigned int off; /* read/write offset into 'buf' */ 1125 unsigned char *data; /* pointer to the record data */ 1126 unsigned char *input; /* where the decode bytes are */ 1127 uint16_t epoch; /* epoch number, needed by DTLS1 */ 1128 unsigned char seq_num[8]; /* sequence number, needed by DTLS1 */ 1129 } SSL3_RECORD_INTERNAL; 1130 1131 typedef struct ssl3_buffer_internal_st { 1132 unsigned char *buf; /* at least SSL3_RT_MAX_PACKET_SIZE bytes, 1133 * see ssl3_setup_buffers() */ 1134 size_t len; /* buffer size */ 1135 int offset; /* where to 'copy from' */ 1136 int left; /* how many bytes left */ 1137 } SSL3_BUFFER_INTERNAL; 1138 1139 typedef struct ssl3_state_st { 1140 long flags; 1141 1142 unsigned char server_random[SSL3_RANDOM_SIZE]; 1143 unsigned char client_random[SSL3_RANDOM_SIZE]; 1144 1145 SSL3_BUFFER_INTERNAL rbuf; /* read IO goes into here */ 1146 SSL3_BUFFER_INTERNAL wbuf; /* write IO goes into here */ 1147 1148 SSL3_RECORD_INTERNAL rrec; /* each decoded record goes in here */ 1149 1150 struct tls_content *rcontent; /* Content from opened TLS records. */ 1151 1152 /* we allow one fatal and one warning alert to be outstanding, 1153 * send close alert via the warning alert */ 1154 int alert_dispatch; 1155 unsigned char send_alert[2]; 1156 1157 /* flags for countermeasure against known-IV weakness */ 1158 int need_empty_fragments; 1159 int empty_fragment_done; 1160 1161 /* Unprocessed Alert/Handshake protocol data. */ 1162 struct tls_buffer *alert_fragment; 1163 struct tls_buffer *handshake_fragment; 1164 1165 /* partial write - check the numbers match */ 1166 unsigned int wnum; /* number of bytes sent so far */ 1167 int wpend_tot; /* number bytes written */ 1168 int wpend_type; 1169 int wpend_ret; /* number of bytes submitted */ 1170 const unsigned char *wpend_buf; 1171 1172 /* Transcript of handshake messages that have been sent and received. */ 1173 struct tls_buffer *handshake_transcript; 1174 1175 /* Rolling hash of handshake messages. */ 1176 EVP_MD_CTX *handshake_hash; 1177 1178 /* this is set whenerver we see a change_cipher_spec message 1179 * come in when we are not looking for one */ 1180 int change_cipher_spec; 1181 1182 int warn_alert; 1183 int fatal_alert; 1184 1185 /* This flag is set when we should renegotiate ASAP, basically when 1186 * there is no more data in the read or write buffers */ 1187 int renegotiate; 1188 int total_renegotiations; 1189 int num_renegotiations; 1190 1191 int in_read_app_data; 1192 1193 SSL_HANDSHAKE hs; 1194 1195 /* Connection binding to prevent renegotiation attacks */ 1196 unsigned char previous_client_finished[EVP_MAX_MD_SIZE]; 1197 unsigned char previous_client_finished_len; 1198 unsigned char previous_server_finished[EVP_MAX_MD_SIZE]; 1199 unsigned char previous_server_finished_len; 1200 int send_connection_binding; /* TODOEKR */ 1201 1202 /* Set if we saw a Renegotiation Indication extension from our peer. */ 1203 int renegotiate_seen; 1204 1205 /* 1206 * ALPN information. 1207 * 1208 * In a server these point to the selected ALPN protocol after the 1209 * ClientHello has been processed. In a client these contain the 1210 * protocol that the server selected once the ServerHello has been 1211 * processed. 1212 */ 1213 uint8_t *alpn_selected; 1214 size_t alpn_selected_len; 1215 1216 /* Contains the QUIC transport params received from our peer. */ 1217 uint8_t *peer_quic_transport_params; 1218 size_t peer_quic_transport_params_len; 1219 } SSL3_STATE; 1220 1221 /* 1222 * Flag values for enc_flags. 1223 */ 1224 1225 /* Uses signature algorithms extension. */ 1226 #define SSL_ENC_FLAG_SIGALGS (1 << 1) 1227 1228 /* Uses SHA256 default PRF. */ 1229 #define SSL_ENC_FLAG_SHA256_PRF (1 << 2) 1230 1231 /* Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2. */ 1232 #define SSL_ENC_FLAG_TLS1_2_CIPHERS (1 << 4) 1233 1234 /* Allow TLS 1.3 ciphersuites only. */ 1235 #define SSL_ENC_FLAG_TLS1_3_CIPHERS (1 << 5) 1236 1237 #define TLSV1_ENC_FLAGS 0 1238 #define TLSV1_1_ENC_FLAGS 0 1239 #define TLSV1_2_ENC_FLAGS (SSL_ENC_FLAG_SIGALGS | \ 1240 SSL_ENC_FLAG_SHA256_PRF | \ 1241 SSL_ENC_FLAG_TLS1_2_CIPHERS) 1242 #define TLSV1_3_ENC_FLAGS (SSL_ENC_FLAG_SIGALGS | \ 1243 SSL_ENC_FLAG_TLS1_3_CIPHERS) 1244 1245 extern const SSL_CIPHER ssl3_ciphers[]; 1246 1247 const char *ssl_version_string(int ver); 1248 int ssl_version_set_min(const SSL_METHOD *meth, uint16_t proto_ver, 1249 uint16_t max_tls_ver, uint16_t *out_tls_ver, uint16_t *out_proto_ver); 1250 int ssl_version_set_max(const SSL_METHOD *meth, uint16_t proto_ver, 1251 uint16_t min_tls_ver, uint16_t *out_tls_ver, uint16_t *out_proto_ver); 1252 int ssl_enabled_tls_version_range(SSL *s, uint16_t *min_ver, uint16_t *max_ver); 1253 int ssl_supported_tls_version_range(SSL *s, uint16_t *min_ver, uint16_t *max_ver); 1254 uint16_t ssl_tls_version(uint16_t version); 1255 uint16_t ssl_effective_tls_version(SSL *s); 1256 int ssl_max_supported_version(SSL *s, uint16_t *max_ver); 1257 int ssl_max_legacy_version(SSL *s, uint16_t *max_ver); 1258 int ssl_max_shared_version(SSL *s, uint16_t peer_ver, uint16_t *max_ver); 1259 int ssl_check_version_from_server(SSL *s, uint16_t server_version); 1260 int ssl_legacy_stack_version(SSL *s, uint16_t version); 1261 int ssl_cipher_in_list(STACK_OF(SSL_CIPHER) *ciphers, const SSL_CIPHER *cipher); 1262 int ssl_cipher_allowed_in_tls_version_range(const SSL_CIPHER *cipher, 1263 uint16_t min_ver, uint16_t max_ver); 1264 1265 const SSL_METHOD *tls_legacy_method(void); 1266 const SSL_METHOD *ssl_get_method(uint16_t version); 1267 1268 void ssl_clear_cipher_state(SSL *s); 1269 int ssl_clear_bad_session(SSL *s); 1270 1271 void ssl_info_callback(const SSL *s, int type, int value); 1272 void ssl_msg_callback(SSL *s, int is_write, int content_type, 1273 const void *msg_buf, size_t msg_len); 1274 void ssl_msg_callback_cbs(SSL *s, int is_write, int content_type, CBS *cbs); 1275 1276 SSL_CERT *ssl_cert_new(void); 1277 SSL_CERT *ssl_cert_dup(SSL_CERT *cert); 1278 void ssl_cert_free(SSL_CERT *c); 1279 SSL_CERT *ssl_get0_cert(SSL_CTX *ctx, SSL *ssl); 1280 int ssl_cert_set0_chain(SSL_CTX *ctx, SSL *ssl, STACK_OF(X509) *chain); 1281 int ssl_cert_set1_chain(SSL_CTX *ctx, SSL *ssl, STACK_OF(X509) *chain); 1282 int ssl_cert_add0_chain_cert(SSL_CTX *ctx, SSL *ssl, X509 *cert); 1283 int ssl_cert_add1_chain_cert(SSL_CTX *ctx, SSL *ssl, X509 *cert); 1284 1285 int ssl_security_default_cb(const SSL *ssl, const SSL_CTX *ctx, int op, 1286 int bits, int nid, void *other, void *ex_data); 1287 1288 int ssl_security_cipher_check(const SSL *ssl, SSL_CIPHER *cipher); 1289 int ssl_security_shared_cipher(const SSL *ssl, SSL_CIPHER *cipher); 1290 int ssl_security_supported_cipher(const SSL *ssl, SSL_CIPHER *cipher); 1291 int ssl_ctx_security_dh(const SSL_CTX *ctx, DH *dh); 1292 int ssl_security_dh(const SSL *ssl, DH *dh); 1293 int ssl_security_sigalg_check(const SSL *ssl, const EVP_PKEY *pkey); 1294 int ssl_security_tickets(const SSL *ssl); 1295 int ssl_security_version(const SSL *ssl, int version); 1296 int ssl_security_cert(const SSL_CTX *ctx, const SSL *ssl, X509 *x509, 1297 int is_peer, int *out_error); 1298 int ssl_security_cert_chain(const SSL *ssl, STACK_OF(X509) *sk, 1299 X509 *x509, int *out_error); 1300 int ssl_security_shared_group(const SSL *ssl, uint16_t group_id); 1301 int ssl_security_supported_group(const SSL *ssl, uint16_t group_id); 1302 1303 SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int include_ticket); 1304 int ssl_get_new_session(SSL *s, int session); 1305 int ssl_get_prev_session(SSL *s, CBS *session_id, CBS *ext_block, 1306 int *alert); 1307 int ssl_cipher_list_to_bytes(SSL *s, STACK_OF(SSL_CIPHER) *ciphers, CBB *cbb); 1308 STACK_OF(SSL_CIPHER) *ssl_bytes_to_cipher_list(SSL *s, CBS *cbs); 1309 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth, 1310 STACK_OF(SSL_CIPHER) **pref, STACK_OF(SSL_CIPHER) *tls13, 1311 const char *rule_str, SSL_CERT *cert); 1312 int ssl_parse_ciphersuites(STACK_OF(SSL_CIPHER) **out_ciphers, const char *str); 1313 int ssl_merge_cipherlists(STACK_OF(SSL_CIPHER) *cipherlist, 1314 STACK_OF(SSL_CIPHER) *cipherlist_tls13, 1315 STACK_OF(SSL_CIPHER) **out_cipherlist); 1316 void ssl_update_cache(SSL *s, int mode); 1317 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc, 1318 const EVP_MD **md, int *mac_pkey_type, int *mac_secret_size); 1319 int ssl_cipher_get_evp_aead(const SSL_SESSION *s, const EVP_AEAD **aead); 1320 int ssl_get_handshake_evp_md(SSL *s, const EVP_MD **md); 1321 1322 int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk); 1323 int ssl_undefined_function(SSL *s); 1324 int ssl_undefined_void_function(void); 1325 int ssl_undefined_const_function(const SSL *s); 1326 SSL_CERT_PKEY *ssl_get_server_send_pkey(const SSL *s); 1327 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *c, const EVP_MD **pmd, 1328 const struct ssl_sigalg **sap); 1329 size_t ssl_dhe_params_auto_key_bits(SSL *s); 1330 int ssl_cert_type(EVP_PKEY *pkey); 1331 void ssl_set_cert_masks(SSL_CERT *c, const SSL_CIPHER *cipher); 1332 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s); 1333 int ssl_has_ecc_ciphers(SSL *s); 1334 int ssl_verify_alarm_type(long type); 1335 1336 int SSL_SESSION_ticket(SSL_SESSION *ss, unsigned char **out, size_t *out_len); 1337 1338 const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p); 1339 int ssl3_do_write(SSL *s, int type); 1340 int ssl3_send_alert(SSL *s, int level, int desc); 1341 int ssl3_get_req_cert_types(SSL *s, CBB *cbb); 1342 int ssl3_get_message(SSL *s, int st1, int stn, int mt, long max); 1343 int ssl3_num_ciphers(void); 1344 const SSL_CIPHER *ssl3_get_cipher(unsigned int u); 1345 const SSL_CIPHER *ssl3_get_cipher_by_id(unsigned long id); 1346 const SSL_CIPHER *ssl3_get_cipher_by_value(uint16_t value); 1347 uint16_t ssl3_cipher_get_value(const SSL_CIPHER *c); 1348 int ssl3_renegotiate(SSL *ssl); 1349 1350 int ssl3_renegotiate_check(SSL *ssl); 1351 1352 void ssl_force_want_read(SSL *s); 1353 1354 int ssl3_dispatch_alert(SSL *s); 1355 int ssl3_read_alert(SSL *s); 1356 int ssl3_read_change_cipher_spec(SSL *s); 1357 int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek); 1358 int ssl3_write_bytes(SSL *s, int type, const void *buf, int len); 1359 int ssl3_output_cert_chain(SSL *s, CBB *cbb, SSL_CERT_PKEY *cpk); 1360 SSL_CIPHER *ssl3_choose_cipher(SSL *ssl, STACK_OF(SSL_CIPHER) *clnt, 1361 STACK_OF(SSL_CIPHER) *srvr); 1362 int ssl3_setup_buffers(SSL *s); 1363 int ssl3_setup_init_buffer(SSL *s); 1364 void ssl3_release_init_buffer(SSL *s); 1365 int ssl3_setup_read_buffer(SSL *s); 1366 int ssl3_setup_write_buffer(SSL *s); 1367 void ssl3_release_buffer(SSL3_BUFFER_INTERNAL *b); 1368 void ssl3_release_read_buffer(SSL *s); 1369 void ssl3_release_write_buffer(SSL *s); 1370 int ssl3_new(SSL *s); 1371 void ssl3_free(SSL *s); 1372 int ssl3_accept(SSL *s); 1373 int ssl3_connect(SSL *s); 1374 int ssl3_read(SSL *s, void *buf, int len); 1375 int ssl3_peek(SSL *s, void *buf, int len); 1376 int ssl3_write(SSL *s, const void *buf, int len); 1377 int ssl3_shutdown(SSL *s); 1378 void ssl3_clear(SSL *s); 1379 long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg); 1380 long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg); 1381 long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp)(void)); 1382 long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp)(void)); 1383 int ssl3_pending(const SSL *s); 1384 1385 int ssl3_handshake_msg_hdr_len(SSL *s); 1386 int ssl3_handshake_msg_start(SSL *s, CBB *handshake, CBB *body, 1387 uint8_t msg_type); 1388 int ssl3_handshake_msg_finish(SSL *s, CBB *handshake); 1389 int ssl3_handshake_write(SSL *s); 1390 int ssl3_record_write(SSL *s, int type); 1391 1392 int ssl3_do_change_cipher_spec(SSL *ssl); 1393 1394 int ssl3_packet_read(SSL *s, int plen); 1395 int ssl3_packet_extend(SSL *s, int plen); 1396 int ssl_server_legacy_first_packet(SSL *s); 1397 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf, 1398 unsigned int len); 1399 1400 int ssl_kex_generate_dhe(DH *dh, DH *dh_params); 1401 int ssl_kex_generate_dhe_params_auto(DH *dh, size_t key_len); 1402 int ssl_kex_params_dhe(DH *dh, CBB *cbb); 1403 int ssl_kex_public_dhe(DH *dh, CBB *cbb); 1404 int ssl_kex_peer_params_dhe(DH *dh, CBS *cbs, int *decode_error, 1405 int *invalid_params); 1406 int ssl_kex_peer_public_dhe(DH *dh, CBS *cbs, int *decode_error, 1407 int *invalid_key); 1408 int ssl_kex_derive_dhe(DH *dh, DH *dh_peer, 1409 uint8_t **shared_key, size_t *shared_key_len); 1410 1411 int ssl_kex_dummy_ecdhe_x25519(EVP_PKEY *pkey); 1412 int ssl_kex_generate_ecdhe_ecp(EC_KEY *ecdh, int nid); 1413 int ssl_kex_public_ecdhe_ecp(EC_KEY *ecdh, CBB *cbb); 1414 int ssl_kex_peer_public_ecdhe_ecp(EC_KEY *ecdh, int nid, CBS *cbs); 1415 int ssl_kex_derive_ecdhe_ecp(EC_KEY *ecdh, EC_KEY *ecdh_peer, 1416 uint8_t **shared_key, size_t *shared_key_len); 1417 1418 int tls1_new(SSL *s); 1419 void tls1_free(SSL *s); 1420 void tls1_clear(SSL *s); 1421 1422 int ssl_init_wbio_buffer(SSL *s, int push); 1423 void ssl_free_wbio_buffer(SSL *s); 1424 1425 int tls1_transcript_hash_init(SSL *s); 1426 int tls1_transcript_hash_update(SSL *s, const unsigned char *buf, size_t len); 1427 int tls1_transcript_hash_value(SSL *s, unsigned char *out, size_t len, 1428 size_t *outlen); 1429 void tls1_transcript_hash_free(SSL *s); 1430 1431 int tls1_transcript_init(SSL *s); 1432 void tls1_transcript_free(SSL *s); 1433 void tls1_transcript_reset(SSL *s); 1434 int tls1_transcript_append(SSL *s, const unsigned char *buf, size_t len); 1435 int tls1_transcript_data(SSL *s, const unsigned char **data, size_t *len); 1436 void tls1_transcript_freeze(SSL *s); 1437 void tls1_transcript_unfreeze(SSL *s); 1438 int tls1_transcript_record(SSL *s, const unsigned char *buf, size_t len); 1439 1440 int tls1_PRF(SSL *s, const unsigned char *secret, size_t secret_len, 1441 const void *seed1, size_t seed1_len, const void *seed2, size_t seed2_len, 1442 const void *seed3, size_t seed3_len, const void *seed4, size_t seed4_len, 1443 const void *seed5, size_t seed5_len, unsigned char *out, size_t out_len); 1444 1445 void tls1_cleanup_key_block(SSL *s); 1446 int tls1_change_read_cipher_state(SSL *s); 1447 int tls1_change_write_cipher_state(SSL *s); 1448 int tls1_setup_key_block(SSL *s); 1449 int tls1_generate_key_block(SSL *s, uint8_t *key_block, size_t key_block_len); 1450 int ssl_ok(SSL *s); 1451 1452 int tls12_derive_finished(SSL *s); 1453 int tls12_derive_peer_finished(SSL *s); 1454 int tls12_derive_master_secret(SSL *s, uint8_t *premaster_secret, 1455 size_t premaster_secret_len); 1456 1457 int ssl_using_ecc_cipher(SSL *s); 1458 int ssl_check_srvr_ecc_cert_and_alg(SSL *s, X509 *x); 1459 1460 void tls1_get_formatlist(const SSL *s, int client_formats, 1461 const uint8_t **pformats, size_t *pformatslen); 1462 void tls1_get_group_list(const SSL *s, int client_groups, 1463 const uint16_t **pgroups, size_t *pgroupslen); 1464 1465 int tls1_set_groups(uint16_t **out_group_ids, size_t *out_group_ids_len, 1466 const int *groups, size_t ngroups); 1467 int tls1_set_group_list(uint16_t **out_group_ids, size_t *out_group_ids_len, 1468 const char *groups); 1469 1470 int tls1_ec_group_id2nid(uint16_t group_id, int *out_nid); 1471 int tls1_ec_group_id2bits(uint16_t group_id, int *out_bits); 1472 int tls1_ec_nid2group_id(int nid, uint16_t *out_group_id); 1473 int tls1_check_group(SSL *s, uint16_t group_id); 1474 int tls1_count_shared_groups(const SSL *ssl, size_t *out_count); 1475 int tls1_get_shared_group_by_index(const SSL *ssl, size_t index, int *out_nid); 1476 int tls1_get_supported_group(const SSL *s, int *out_nid); 1477 1478 int ssl_check_clienthello_tlsext_early(SSL *s); 1479 int ssl_check_clienthello_tlsext_late(SSL *s); 1480 int ssl_check_serverhello_tlsext(SSL *s); 1481 1482 #define TLS1_TICKET_FATAL_ERROR -1 1483 #define TLS1_TICKET_NONE 0 1484 #define TLS1_TICKET_EMPTY 1 1485 #define TLS1_TICKET_NOT_DECRYPTED 2 1486 #define TLS1_TICKET_DECRYPTED 3 1487 1488 int tls1_process_ticket(SSL *s, CBS *ext_block, int *alert, SSL_SESSION **ret); 1489 1490 int tls1_check_ec_server_key(SSL *s); 1491 1492 /* s3_cbc.c */ 1493 void ssl3_cbc_copy_mac(unsigned char *out, const SSL3_RECORD_INTERNAL *rec, 1494 unsigned int md_size, unsigned int orig_len); 1495 int ssl3_cbc_remove_padding(SSL3_RECORD_INTERNAL *rec, unsigned int eiv_len, 1496 unsigned int mac_size); 1497 char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx); 1498 int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx, unsigned char *md_out, 1499 size_t *md_out_size, const unsigned char header[13], 1500 const unsigned char *data, size_t data_plus_mac_size, 1501 size_t data_plus_mac_plus_padding_size, const unsigned char *mac_secret, 1502 unsigned int mac_secret_length); 1503 int SSL_state_func_code(int _state); 1504 1505 #define SSLerror(s, r) SSL_error_internal(s, r, __FILE__, __LINE__) 1506 #define SSLerrorx(r) ERR_PUT_error(ERR_LIB_SSL,(0xfff),(r),__FILE__,__LINE__) 1507 void SSL_error_internal(const SSL *s, int r, char *f, int l); 1508 1509 #ifndef OPENSSL_NO_SRTP 1510 1511 int srtp_find_profile_by_name(const char *profile_name, 1512 const SRTP_PROTECTION_PROFILE **pptr, unsigned int len); 1513 int srtp_find_profile_by_num(unsigned int profile_num, 1514 const SRTP_PROTECTION_PROFILE **pptr); 1515 1516 #endif /* OPENSSL_NO_SRTP */ 1517 1518 int tls_process_peer_certs(SSL *s, STACK_OF(X509) *peer_certs); 1519 1520 __END_HIDDEN_DECLS 1521 1522 #endif /* !HEADER_SSL_LOCL_H */ 1523