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