ssl/ssl_local.h

   1 /*
   2  * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
   4  * Copyright 2005 Nokia. All rights reserved.
   5  *
   6  * Licensed under the Apache License 2.0 (the "License").  You may not use
   7  * this file except in compliance with the License.  You can obtain a copy
   8  * in the file LICENSE in the source distribution or at
   9  * https://www.openssl.org/source/license.html
  10  */
  11
  12 #ifndef OSSL_SSL_LOCAL_H
  13 # define OSSL_SSL_LOCAL_H
  14
  15 # include "internal/e_os.h"              /* struct timeval for DTLS */
  16 # include <stdlib.h>
  17 # include <time.h>
  18 # include <errno.h>
  19 # include "internal/common.h" /* for HAS_PREFIX */
  20
  21 # include <openssl/buffer.h>
  22 # include <openssl/bio.h>
  23 # include <openssl/comp.h>
  24 # include <openssl/dsa.h>
  25 # include <openssl/err.h>
  26 # include <openssl/ssl.h>
  27 # include <openssl/async.h>
  28 # include <openssl/symhacks.h>
  29 # include <openssl/ct.h>
  30 # include "record/record.h"
  31 # include "record/recordmethod.h"
  32 # include "statem/statem.h"
  33 # include "internal/packet.h"
  34 # include "internal/dane.h"
  35 # include "internal/refcount.h"
  36 # include "internal/tsan_assist.h"
  37 # include "internal/bio.h"
  38 # include "internal/ktls.h"
  39 # include "internal/time.h"
  40
  41 # ifdef OPENSSL_BUILD_SHLIBSSL
  42 #  undef OPENSSL_EXTERN
  43 #  define OPENSSL_EXTERN OPENSSL_EXPORT
  44 # endif
  45
  46 # define c2l(c,l)        (l = ((unsigned long)(*((c)++)))     , \
  47                          l|=(((unsigned long)(*((c)++)))<< 8), \
  48                          l|=(((unsigned long)(*((c)++)))<<16), \
  49                          l|=(((unsigned long)(*((c)++)))<<24))
  50
  51 /* NOTE - c is not incremented as per c2l */
  52 # define c2ln(c,l1,l2,n) { \
  53                         c+=n; \
  54                         l1=l2=0; \
  55                         switch (n) { \
  56                         case 8: l2 =((unsigned long)(*(--(c))))<<24; \
  57                         case 7: l2|=((unsigned long)(*(--(c))))<<16; \
  58                         case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
  59                         case 5: l2|=((unsigned long)(*(--(c))));     \
  60                         case 4: l1 =((unsigned long)(*(--(c))))<<24; \
  61                         case 3: l1|=((unsigned long)(*(--(c))))<<16; \
  62                         case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
  63                         case 1: l1|=((unsigned long)(*(--(c))));     \
  64                                 } \
  65                         }
  66
  67 # define l2c(l,c)        (*((c)++)=(unsigned char)(((l)    )&0xff), \
  68                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
  69                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
  70                          *((c)++)=(unsigned char)(((l)>>24)&0xff))
  71
  72 # define n2l(c,l)        (l =((unsigned long)(*((c)++)))<<24, \
  73                          l|=((unsigned long)(*((c)++)))<<16, \
  74                          l|=((unsigned long)(*((c)++)))<< 8, \
  75                          l|=((unsigned long)(*((c)++))))
  76
  77 # define n2l8(c,l)       (l =((uint64_t)(*((c)++)))<<56, \
  78                          l|=((uint64_t)(*((c)++)))<<48, \
  79                          l|=((uint64_t)(*((c)++)))<<40, \
  80                          l|=((uint64_t)(*((c)++)))<<32, \
  81                          l|=((uint64_t)(*((c)++)))<<24, \
  82                          l|=((uint64_t)(*((c)++)))<<16, \
  83                          l|=((uint64_t)(*((c)++)))<< 8, \
  84                          l|=((uint64_t)(*((c)++))))
  85
  86
  87 # define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
  88                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
  89                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
  90                          *((c)++)=(unsigned char)(((l)    )&0xff))
  91
  92 # define l2n6(l,c)       (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
  93                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
  94                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
  95                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
  96                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
  97                          *((c)++)=(unsigned char)(((l)    )&0xff))
  98
  99 # define l2n8(l,c)       (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
 100                          *((c)++)=(unsigned char)(((l)>>48)&0xff), \
 101                          *((c)++)=(unsigned char)(((l)>>40)&0xff), \
 102                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
 103                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
 104                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
 105                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
 106                          *((c)++)=(unsigned char)(((l)    )&0xff))
 107
 108 /* NOTE - c is not incremented as per l2c */
 109 # define l2cn(l1,l2,c,n) { \
 110                         c+=n; \
 111                         switch (n) { \
 112                         case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
 113                         case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
 114                         case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
 115                         case 5: *(--(c))=(unsigned char)(((l2)    )&0xff); \
 116                         case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
 117                         case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
 118                         case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
 119                         case 1: *(--(c))=(unsigned char)(((l1)    )&0xff); \
 120                                 } \
 121                         }
 122
 123 # define n2s(c,s)        ((s=(((unsigned int)((c)[0]))<< 8)| \
 124                              (((unsigned int)((c)[1]))    )),(c)+=2)
 125 # define s2n(s,c)        (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
 126                            (c)[1]=(unsigned char)(((s)    )&0xff)),(c)+=2)
 127
 128 # define n2l3(c,l)       ((l =(((unsigned long)((c)[0]))<<16)| \
 129                               (((unsigned long)((c)[1]))<< 8)| \
 130                               (((unsigned long)((c)[2]))    )),(c)+=3)
 131
 132 # define l2n3(l,c)       (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
 133                            (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
 134                            (c)[2]=(unsigned char)(((l)    )&0xff)),(c)+=3)
 135
 136 # define TLS_MAX_VERSION_INTERNAL TLS1_3_VERSION
 137 # define DTLS_MAX_VERSION_INTERNAL DTLS1_2_VERSION
 138
 139 /*
 140  * DTLS version numbers are strange because they're inverted. Except for
 141  * DTLS1_BAD_VER, which should be considered "lower" than the rest.
 142  */
 143 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
 144 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
 145 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
 146 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
 147 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
 148
 149 # define SSL_AD_NO_ALERT    -1
 150
 151 /*
 152  * Define the Bitmasks for SSL_CIPHER.algorithms.
 153  * This bits are used packed as dense as possible. If new methods/ciphers
 154  * etc will be added, the bits a likely to change, so this information
 155  * is for internal library use only, even though SSL_CIPHER.algorithms
 156  * can be publicly accessed.
 157  * Use the according functions for cipher management instead.
 158  *
 159  * The bit mask handling in the selection and sorting scheme in
 160  * ssl_create_cipher_list() has only limited capabilities, reflecting
 161  * that the different entities within are mutually exclusive:
 162  * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
 163  */
 164
 165 /* Bits for algorithm_mkey (key exchange algorithm) */
 166 /* RSA key exchange */
 167 # define SSL_kRSA                0x00000001U
 168 /* tmp DH key no DH cert */
 169 # define SSL_kDHE                0x00000002U
 170 /* synonym */
 171 # define SSL_kEDH                SSL_kDHE
 172 /* ephemeral ECDH */
 173 # define SSL_kECDHE              0x00000004U
 174 /* synonym */
 175 # define SSL_kEECDH              SSL_kECDHE
 176 /* PSK */
 177 # define SSL_kPSK                0x00000008U
 178 /* GOST key exchange */
 179 # define SSL_kGOST               0x00000010U
 180 /* SRP */
 181 # define SSL_kSRP                0x00000020U
 182
 183 # define SSL_kRSAPSK             0x00000040U
 184 # define SSL_kECDHEPSK           0x00000080U
 185 # define SSL_kDHEPSK             0x00000100U
 186 /* GOST KDF key exchange, draft-smyshlyaev-tls12-gost-suites */
 187 # define SSL_kGOST18             0x00000200U
 188
 189 /* all PSK */
 190
 191 # define SSL_PSK     (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
 192
 193 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
 194 # define SSL_kANY                0x00000000U
 195
 196 /* Bits for algorithm_auth (server authentication) */
 197 /* RSA auth */
 198 # define SSL_aRSA                0x00000001U
 199 /* DSS auth */
 200 # define SSL_aDSS                0x00000002U
 201 /* no auth (i.e. use ADH or AECDH) */
 202 # define SSL_aNULL               0x00000004U
 203 /* ECDSA auth*/
 204 # define SSL_aECDSA              0x00000008U
 205 /* PSK auth */
 206 # define SSL_aPSK                0x00000010U
 207 /* GOST R 34.10-2001 signature auth */
 208 # define SSL_aGOST01             0x00000020U
 209 /* SRP auth */
 210 # define SSL_aSRP                0x00000040U
 211 /* GOST R 34.10-2012 signature auth */
 212 # define SSL_aGOST12             0x00000080U
 213 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
 214 # define SSL_aANY                0x00000000U
 215 /* All bits requiring a certificate */
 216 #define SSL_aCERT \
 217     (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
 218
 219 /* Bits for algorithm_enc (symmetric encryption) */
 220 # define SSL_DES                 0x00000001U
 221 # define SSL_3DES                0x00000002U
 222 # define SSL_RC4                 0x00000004U
 223 # define SSL_RC2                 0x00000008U
 224 # define SSL_IDEA                0x00000010U
 225 # define SSL_eNULL               0x00000020U
 226 # define SSL_AES128              0x00000040U
 227 # define SSL_AES256              0x00000080U
 228 # define SSL_CAMELLIA128         0x00000100U
 229 # define SSL_CAMELLIA256         0x00000200U
 230 # define SSL_eGOST2814789CNT     0x00000400U
 231 # define SSL_SEED                0x00000800U
 232 # define SSL_AES128GCM           0x00001000U
 233 # define SSL_AES256GCM           0x00002000U
 234 # define SSL_AES128CCM           0x00004000U
 235 # define SSL_AES256CCM           0x00008000U
 236 # define SSL_AES128CCM8          0x00010000U
 237 # define SSL_AES256CCM8          0x00020000U
 238 # define SSL_eGOST2814789CNT12   0x00040000U
 239 # define SSL_CHACHA20POLY1305    0x00080000U
 240 # define SSL_ARIA128GCM          0x00100000U
 241 # define SSL_ARIA256GCM          0x00200000U
 242 # define SSL_MAGMA               0x00400000U
 243 # define SSL_KUZNYECHIK          0x00800000U
 244
 245 # define SSL_AESGCM              (SSL_AES128GCM | SSL_AES256GCM)
 246 # define SSL_AESCCM              (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
 247 # define SSL_AES                 (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
 248 # define SSL_CAMELLIA            (SSL_CAMELLIA128|SSL_CAMELLIA256)
 249 # define SSL_CHACHA20            (SSL_CHACHA20POLY1305)
 250 # define SSL_ARIAGCM             (SSL_ARIA128GCM | SSL_ARIA256GCM)
 251 # define SSL_ARIA                (SSL_ARIAGCM)
 252 # define SSL_CBC                 (SSL_DES | SSL_3DES | SSL_RC2 | SSL_IDEA \
 253                                   | SSL_AES128 | SSL_AES256 | SSL_CAMELLIA128 \
 254                                   | SSL_CAMELLIA256 | SSL_SEED)
 255
 256 /* Bits for algorithm_mac (symmetric authentication) */
 257
 258 # define SSL_MD5                 0x00000001U
 259 # define SSL_SHA1                0x00000002U
 260 # define SSL_GOST94      0x00000004U
 261 # define SSL_GOST89MAC   0x00000008U
 262 # define SSL_SHA256              0x00000010U
 263 # define SSL_SHA384              0x00000020U
 264 /* Not a real MAC, just an indication it is part of cipher */
 265 # define SSL_AEAD                0x00000040U
 266 # define SSL_GOST12_256          0x00000080U
 267 # define SSL_GOST89MAC12         0x00000100U
 268 # define SSL_GOST12_512          0x00000200U
 269 # define SSL_MAGMAOMAC           0x00000400U
 270 # define SSL_KUZNYECHIKOMAC      0x00000800U
 271
 272 /*
 273  * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
 274  * sure to update this constant too
 275  */
 276
 277 # define SSL_MD_MD5_IDX  0
 278 # define SSL_MD_SHA1_IDX 1
 279 # define SSL_MD_GOST94_IDX 2
 280 # define SSL_MD_GOST89MAC_IDX 3
 281 # define SSL_MD_SHA256_IDX 4
 282 # define SSL_MD_SHA384_IDX 5
 283 # define SSL_MD_GOST12_256_IDX  6
 284 # define SSL_MD_GOST89MAC12_IDX 7
 285 # define SSL_MD_GOST12_512_IDX  8
 286 # define SSL_MD_MD5_SHA1_IDX 9
 287 # define SSL_MD_SHA224_IDX 10
 288 # define SSL_MD_SHA512_IDX 11
 289 # define SSL_MD_MAGMAOMAC_IDX 12
 290 # define SSL_MD_KUZNYECHIKOMAC_IDX 13
 291 # define SSL_MAX_DIGEST 14
 292
 293 #define SSL_MD_NUM_IDX  SSL_MAX_DIGEST
 294
 295 /* Bits for algorithm2 (handshake digests and other extra flags) */
 296
 297 /* Bits 0-7 are handshake MAC */
 298 # define SSL_HANDSHAKE_MAC_MASK  0xFF
 299 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
 300 # define SSL_HANDSHAKE_MAC_SHA256   SSL_MD_SHA256_IDX
 301 # define SSL_HANDSHAKE_MAC_SHA384   SSL_MD_SHA384_IDX
 302 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
 303 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
 304 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
 305 # define SSL_HANDSHAKE_MAC_DEFAULT  SSL_HANDSHAKE_MAC_MD5_SHA1
 306
 307 /* Bits 8-15 bits are PRF */
 308 # define TLS1_PRF_DGST_SHIFT 8
 309 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
 310 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
 311 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
 312 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
 313 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
 314 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
 315 # define TLS1_PRF            (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
 316
 317 /*
 318  * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
 319  * goes into algorithm2)
 320  */
 321 # define TLS1_STREAM_MAC 0x10000
 322 /*
 323  * TLSTREE cipher/mac key derivation from draft-smyshlyaev-tls12-gost-suites
 324  * (currently this also  goes into algorithm2)
 325  */
 326 # define TLS1_TLSTREE 0x20000
 327
 328 # define SSL_STRONG_MASK         0x0000001FU
 329 # define SSL_DEFAULT_MASK        0X00000020U
 330
 331 # define SSL_STRONG_NONE         0x00000001U
 332 # define SSL_LOW                 0x00000002U
 333 # define SSL_MEDIUM              0x00000004U
 334 # define SSL_HIGH                0x00000008U
 335 # define SSL_FIPS                0x00000010U
 336 # define SSL_NOT_DEFAULT         0x00000020U
 337
 338 /* we have used 0000003f - 26 bits left to go */
 339
 340 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
 341 # define SSL3_CK_CIPHERSUITE_FLAG                0x03000000
 342
 343 /* Check if an SSL structure is using DTLS */
 344 # define SSL_CONNECTION_IS_DTLS(s) \
 345     (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
 346
 347 /* Check if we are using TLSv1.3 */
 348 # define SSL_CONNECTION_IS_TLS13(s) (!SSL_CONNECTION_IS_DTLS(s) \
 349     && SSL_CONNECTION_GET_SSL(s)->method->version >= TLS1_3_VERSION \
 350     && SSL_CONNECTION_GET_SSL(s)->method->version != TLS_ANY_VERSION)
 351
 352 # define SSL_CONNECTION_TREAT_AS_TLS13(s) \
 353     (SSL_CONNECTION_IS_TLS13(s) \
 354      || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
 355      || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
 356      || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
 357      || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
 358      || (s)->hello_retry_request == SSL_HRR_PENDING)
 359
 360 # define SSL_IS_FIRST_HANDSHAKE(s) ((s)->s3.tmp.finish_md_len == 0 \
 361                                     || (s)->s3.tmp.peer_finish_md_len == 0)
 362
 363 /* See if we need explicit IV */
 364 # define SSL_USE_EXPLICIT_IV(s)  \
 365     (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
 366 /*
 367  * See if we use signature algorithms extension and signature algorithm
 368  * before signatures.
 369  */
 370 # define SSL_USE_SIGALGS(s)      \
 371     (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
 372 /*
 373  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
 374  * apply to others in future.
 375  */
 376 # define SSL_USE_TLS1_2_CIPHERS(s)       \
 377     (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
 378 /*
 379  * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
 380  * flags because it may not be set to correct version yet.
 381  */
 382 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s)        \
 383     ((!SSL_CONNECTION_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
 384      (SSL_CONNECTION_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
 385 /*
 386  * Determine if a client should send signature algorithms extension:
 387  * as with TLS1.2 cipher we can't rely on method flags.
 388  */
 389 # define SSL_CLIENT_USE_SIGALGS(s)        \
 390     SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
 391
 392 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
 393     (((value) >= TLSEXT_max_fragment_length_512) && \
 394      ((value) <= TLSEXT_max_fragment_length_4096))
 395 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
 396     IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
 397 # define GET_MAX_FRAGMENT_LENGTH(session) \
 398     (512U << (session->ext.max_fragment_len_mode - 1))
 399
 400 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
 401 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
 402
 403 /* alert_dispatch values */
 404
 405 /* No alert pending */
 406 # define SSL_ALERT_DISPATCH_NONE    0
 407 /* Alert pending */
 408 # define SSL_ALERT_DISPATCH_PENDING 1
 409 /* Pending alert write needs to be retried */
 410 # define SSL_ALERT_DISPATCH_RETRY   2
 411
 412 /* Mostly for SSLv3 */
 413 # define SSL_PKEY_RSA            0
 414 # define SSL_PKEY_RSA_PSS_SIGN   1
 415 # define SSL_PKEY_DSA_SIGN       2
 416 # define SSL_PKEY_ECC            3
 417 # define SSL_PKEY_GOST01         4
 418 # define SSL_PKEY_GOST12_256     5
 419 # define SSL_PKEY_GOST12_512     6
 420 # define SSL_PKEY_ED25519        7
 421 # define SSL_PKEY_ED448          8
 422 # define SSL_PKEY_NUM            9
 423
 424 # define SSL_ENC_DES_IDX         0
 425 # define SSL_ENC_3DES_IDX        1
 426 # define SSL_ENC_RC4_IDX         2
 427 # define SSL_ENC_RC2_IDX         3
 428 # define SSL_ENC_IDEA_IDX        4
 429 # define SSL_ENC_NULL_IDX        5
 430 # define SSL_ENC_AES128_IDX      6
 431 # define SSL_ENC_AES256_IDX      7
 432 # define SSL_ENC_CAMELLIA128_IDX 8
 433 # define SSL_ENC_CAMELLIA256_IDX 9
 434 # define SSL_ENC_GOST89_IDX      10
 435 # define SSL_ENC_SEED_IDX        11
 436 # define SSL_ENC_AES128GCM_IDX   12
 437 # define SSL_ENC_AES256GCM_IDX   13
 438 # define SSL_ENC_AES128CCM_IDX   14
 439 # define SSL_ENC_AES256CCM_IDX   15
 440 # define SSL_ENC_AES128CCM8_IDX  16
 441 # define SSL_ENC_AES256CCM8_IDX  17
 442 # define SSL_ENC_GOST8912_IDX    18
 443 # define SSL_ENC_CHACHA_IDX      19
 444 # define SSL_ENC_ARIA128GCM_IDX  20
 445 # define SSL_ENC_ARIA256GCM_IDX  21
 446 # define SSL_ENC_MAGMA_IDX       22
 447 # define SSL_ENC_KUZNYECHIK_IDX  23
 448 # define SSL_ENC_NUM_IDX         24
 449
 450 /*-
 451  * SSL_kRSA <- RSA_ENC
 452  * SSL_kDH  <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
 453  * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
 454  * SSL_aRSA <- RSA_ENC | RSA_SIGN
 455  * SSL_aDSS <- DSA_SIGN
 456  */
 457
 458 /*-
 459 #define CERT_INVALID            0
 460 #define CERT_PUBLIC_KEY         1
 461 #define CERT_PRIVATE_KEY        2
 462 */
 463
 464 /* Post-Handshake Authentication state */
 465 typedef enum {
 466     SSL_PHA_NONE = 0,
 467     SSL_PHA_EXT_SENT,        /* client-side only: extension sent */
 468     SSL_PHA_EXT_RECEIVED,    /* server-side only: extension received */
 469     SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
 470     SSL_PHA_REQUESTED        /* request received by client, or sent by server */
 471 } SSL_PHA_STATE;
 472
 473 /* CipherSuite length. SSLv3 and all TLS versions. */
 474 # define TLS_CIPHER_LEN 2
 475 /* used to hold info on the particular ciphers used */
 476 struct ssl_cipher_st {
 477     uint32_t valid;
 478     const char *name;           /* text name */
 479     const char *stdname;        /* RFC name */
 480     uint32_t id;                /* id, 4 bytes, first is version */
 481     /*
 482      * changed in 1.0.0: these four used to be portions of a single value
 483      * 'algorithms'
 484      */
 485     uint32_t algorithm_mkey;    /* key exchange algorithm */
 486     uint32_t algorithm_auth;    /* server authentication */
 487     uint32_t algorithm_enc;     /* symmetric encryption */
 488     uint32_t algorithm_mac;     /* symmetric authentication */
 489     int min_tls;                /* minimum SSL/TLS protocol version */
 490     int max_tls;                /* maximum SSL/TLS protocol version */
 491     int min_dtls;               /* minimum DTLS protocol version */
 492     int max_dtls;               /* maximum DTLS protocol version */
 493     uint32_t algo_strength;     /* strength and export flags */
 494     uint32_t algorithm2;        /* Extra flags */
 495     int32_t strength_bits;      /* Number of bits really used */
 496     uint32_t alg_bits;          /* Number of bits for algorithm */
 497 };
 498
 499 /* Used to hold SSL/TLS functions */
 500 struct ssl_method_st {
 501     int version;
 502     unsigned flags;
 503     unsigned long mask;
 504     SSL *(*ssl_new) (SSL_CTX *ctx);
 505     void (*ssl_free) (SSL *s);
 506     int (*ssl_reset) (SSL *s);
 507     int (*ssl_init) (SSL *s);
 508     int (*ssl_clear) (SSL *s);
 509     void (*ssl_deinit) (SSL *s);
 510     int (*ssl_accept) (SSL *s);
 511     int (*ssl_connect) (SSL *s);
 512     int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
 513     int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
 514     int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
 515     int (*ssl_shutdown) (SSL *s);
 516     int (*ssl_renegotiate) (SSL *s);
 517     int (*ssl_renegotiate_check) (SSL *s, int);
 518     int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
 519                            unsigned char *buf, size_t len, int peek,
 520                            size_t *readbytes);
 521     int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
 522                             size_t *written);
 523     int (*ssl_dispatch_alert) (SSL *s);
 524     long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
 525     long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
 526     const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
 527     int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
 528                                size_t *len);
 529     size_t (*ssl_pending) (const SSL *s);
 530     int (*num_ciphers) (void);
 531     const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
 532     OSSL_TIME (*get_timeout) (void);
 533     const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
 534     int (*ssl_version) (void);
 535     long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
 536     long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
 537 };
 538
 539 /*
 540  * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
 541  * consistency, even in the event of OPENSSL_NO_PSK being defined.
 542  */
 543 # define TLS13_MAX_RESUMPTION_PSK_LENGTH      512
 544
 545 /*-
 546  * Lets make this into an ASN.1 type structure as follows
 547  * SSL_SESSION_ID ::= SEQUENCE {
 548  *      version                 INTEGER,        -- structure version number
 549  *      SSLversion              INTEGER,        -- SSL version number
 550  *      Cipher                  OCTET STRING,   -- the 3 byte cipher ID
 551  *      Session_ID              OCTET STRING,   -- the Session ID
 552  *      Master_key              OCTET STRING,   -- the master key
 553  *      Key_Arg [ 0 ] IMPLICIT  OCTET STRING,   -- the optional Key argument
 554  *      Time [ 1 ] EXPLICIT     INTEGER,        -- optional Start Time
 555  *      Timeout [ 2 ] EXPLICIT  INTEGER,        -- optional Timeout ins seconds
 556  *      Peer [ 3 ] EXPLICIT     X509,           -- optional Peer Certificate
 557  *      Session_ID_context [ 4 ] EXPLICIT OCTET STRING,   -- the Session ID context
 558  *      Verify_result [ 5 ] EXPLICIT INTEGER,   -- X509_V_... code for `Peer'
 559  *      HostName [ 6 ] EXPLICIT OCTET STRING,   -- optional HostName from servername TLS extension
 560  *      PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
 561  *      PSK_identity [ 8 ] EXPLICIT OCTET STRING,  -- optional PSK identity
 562  *      Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
 563  *      Ticket [10]             EXPLICIT OCTET STRING, -- session ticket (clients only)
 564  *      Compression_meth [11]   EXPLICIT OCTET STRING, -- optional compression method
 565  *      SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
 566  *      flags [ 13 ] EXPLICIT INTEGER -- optional flags
 567  *      }
 568  * Look in ssl/ssl_asn1.c for more details
 569  * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
 570  */
 571 struct ssl_session_st {
 572     int ssl_version;            /* what ssl version session info is being kept
 573                                  * in here? */
 574     size_t master_key_length;
 575
 576     /* TLSv1.3 early_secret used for external PSKs */
 577     unsigned char early_secret[EVP_MAX_MD_SIZE];
 578     /*
 579      * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
 580      * PSK
 581      */
 582     unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
 583     /* session_id - valid? */
 584     size_t session_id_length;
 585     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
 586     /*
 587      * this is used to determine whether the session is being reused in the
 588      * appropriate context. It is up to the application to set this, via
 589      * SSL_new
 590      */
 591     size_t sid_ctx_length;
 592     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
 593 # ifndef OPENSSL_NO_PSK
 594     char *psk_identity_hint;
 595     char *psk_identity;
 596 # endif
 597     /*
 598      * Used to indicate that session resumption is not allowed. Applications
 599      * can also set this bit for a new session via not_resumable_session_cb
 600      * to disable session caching and tickets.
 601      */
 602     int not_resumable;
 603     /* This is the cert and type for the other end. */
 604     X509 *peer;
 605     /* Certificate chain peer sent. */
 606     STACK_OF(X509) *peer_chain;
 607     /*
 608      * when app_verify_callback accepts a session where the peer's
 609      * certificate is not ok, we must remember the error for session reuse:
 610      */
 611     long verify_result;         /* only for servers */
 612     CRYPTO_REF_COUNT references;
 613     OSSL_TIME timeout;
 614     OSSL_TIME time;
 615     OSSL_TIME calc_timeout;
 616     unsigned int compress_meth; /* Need to lookup the method */
 617     const SSL_CIPHER *cipher;
 618     unsigned long cipher_id;    /* when ASN.1 loaded, this needs to be used to
 619                                  * load the 'cipher' structure */
 620     unsigned int kex_group;      /* TLS group from key exchange */
 621     CRYPTO_EX_DATA ex_data;     /* application specific data */
 622     /*
 623      * These are used to make removal of session-ids more efficient and to
 624      * implement a maximum cache size.
 625      */
 626     struct ssl_session_st *prev, *next;
 627
 628     struct {
 629         char *hostname;
 630         /* RFC4507 info */
 631         unsigned char *tick; /* Session ticket */
 632         size_t ticklen;      /* Session ticket length */
 633         /* Session lifetime hint in seconds */
 634         unsigned long tick_lifetime_hint;
 635         uint32_t tick_age_add;
 636         /* Max number of bytes that can be sent as early data */
 637         uint32_t max_early_data;
 638         /* The ALPN protocol selected for this session */
 639         unsigned char *alpn_selected;
 640         size_t alpn_selected_len;
 641         /*
 642          * Maximum Fragment Length as per RFC 4366.
 643          * If this value does not contain RFC 4366 allowed values (1-4) then
 644          * either the Maximum Fragment Length Negotiation failed or was not
 645          * performed at all.
 646          */
 647         uint8_t max_fragment_len_mode;
 648     } ext;
 649 # ifndef OPENSSL_NO_SRP
 650     char *srp_username;
 651 # endif
 652     unsigned char *ticket_appdata;
 653     size_t ticket_appdata_len;
 654     uint32_t flags;
 655     SSL_CTX *owner;
 656     CRYPTO_RWLOCK *lock;
 657 };
 658
 659 /* Extended master secret support */
 660 # define SSL_SESS_FLAG_EXTMS             0x1
 661
 662 # ifndef OPENSSL_NO_SRP
 663
 664 typedef struct srp_ctx_st {
 665     /* param for all the callbacks */
 666     void *SRP_cb_arg;
 667     /* set client Hello login callback */
 668     int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
 669     /* set SRP N/g param callback for verification */
 670     int (*SRP_verify_param_callback) (SSL *, void *);
 671     /* set SRP client passwd callback */
 672     char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
 673     char *login;
 674     BIGNUM *N, *g, *s, *B, *A;
 675     BIGNUM *a, *b, *v;
 676     char *info;
 677     int strength;
 678     unsigned long srp_Mask;
 679 } SRP_CTX;
 680
 681 # endif
 682
 683 typedef enum {
 684     SSL_EARLY_DATA_NONE = 0,
 685     SSL_EARLY_DATA_CONNECT_RETRY,
 686     SSL_EARLY_DATA_CONNECTING,
 687     SSL_EARLY_DATA_WRITE_RETRY,
 688     SSL_EARLY_DATA_WRITING,
 689     SSL_EARLY_DATA_WRITE_FLUSH,
 690     SSL_EARLY_DATA_UNAUTH_WRITING,
 691     SSL_EARLY_DATA_FINISHED_WRITING,
 692     SSL_EARLY_DATA_ACCEPT_RETRY,
 693     SSL_EARLY_DATA_ACCEPTING,
 694     SSL_EARLY_DATA_READ_RETRY,
 695     SSL_EARLY_DATA_READING,
 696     SSL_EARLY_DATA_FINISHED_READING
 697 } SSL_EARLY_DATA_STATE;
 698
 699 /*
 700  * We check that the amount of unreadable early data doesn't exceed
 701  * max_early_data. max_early_data is given in plaintext bytes. However if it is
 702  * unreadable then we only know the number of ciphertext bytes. We also don't
 703  * know how much the overhead should be because it depends on the ciphersuite.
 704  * We make a small allowance. We assume 5 records of actual data plus the end
 705  * of early data alert record. Each record has a tag and a content type byte.
 706  * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
 707  * content of the alert record either which is 2 bytes.
 708  */
 709 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
 710
 711 /*
 712  * The allowance we have between the client's calculated ticket age and our own.
 713  * We allow for 10 seconds. If a ticket is presented and the
 714  * client's age calculation is different by more than this than our own then we
 715  * do not allow that ticket for early_data.
 716  */
 717 # define TICKET_AGE_ALLOWANCE   ossl_seconds2time(10)
 718
 719 #define MAX_COMPRESSIONS_SIZE   255
 720
 721 struct ssl_comp_st {
 722     int id;
 723     const char *name;
 724     COMP_METHOD *method;
 725 };
 726
 727 typedef struct raw_extension_st {
 728     /* Raw packet data for the extension */
 729     PACKET data;
 730     /* Set to 1 if the extension is present or 0 otherwise */
 731     int present;
 732     /* Set to 1 if we have already parsed the extension or 0 otherwise */
 733     int parsed;
 734     /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
 735     unsigned int type;
 736     /* Track what order extensions are received in (0-based). */
 737     size_t received_order;
 738 } RAW_EXTENSION;
 739
 740 typedef struct {
 741     unsigned int isv2;
 742     unsigned int legacy_version;
 743     unsigned char random[SSL3_RANDOM_SIZE];
 744     size_t session_id_len;
 745     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
 746     size_t dtls_cookie_len;
 747     unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
 748     PACKET ciphersuites;
 749     size_t compressions_len;
 750     unsigned char compressions[MAX_COMPRESSIONS_SIZE];
 751     PACKET extensions;
 752     size_t pre_proc_exts_len;
 753     RAW_EXTENSION *pre_proc_exts;
 754 } CLIENTHELLO_MSG;
 755
 756 /*
 757  * Extension index values NOTE: Any updates to these defines should be mirrored
 758  * with equivalent updates to ext_defs in extensions.c
 759  */
 760 typedef enum tlsext_index_en {
 761     TLSEXT_IDX_renegotiate,
 762     TLSEXT_IDX_server_name,
 763     TLSEXT_IDX_max_fragment_length,
 764     TLSEXT_IDX_srp,
 765     TLSEXT_IDX_ec_point_formats,
 766     TLSEXT_IDX_supported_groups,
 767     TLSEXT_IDX_session_ticket,
 768     TLSEXT_IDX_status_request,
 769     TLSEXT_IDX_next_proto_neg,
 770     TLSEXT_IDX_application_layer_protocol_negotiation,
 771     TLSEXT_IDX_use_srtp,
 772     TLSEXT_IDX_encrypt_then_mac,
 773     TLSEXT_IDX_signed_certificate_timestamp,
 774     TLSEXT_IDX_extended_master_secret,
 775     TLSEXT_IDX_signature_algorithms_cert,
 776     TLSEXT_IDX_post_handshake_auth,
 777     TLSEXT_IDX_signature_algorithms,
 778     TLSEXT_IDX_supported_versions,
 779     TLSEXT_IDX_psk_kex_modes,
 780     TLSEXT_IDX_key_share,
 781     TLSEXT_IDX_cookie,
 782     TLSEXT_IDX_cryptopro_bug,
 783     TLSEXT_IDX_compress_certificate,
 784     TLSEXT_IDX_early_data,
 785     TLSEXT_IDX_certificate_authorities,
 786     TLSEXT_IDX_padding,
 787     TLSEXT_IDX_psk,
 788     /* Dummy index - must always be the last entry */
 789     TLSEXT_IDX_num_builtins
 790 } TLSEXT_INDEX;
 791
 792 DEFINE_LHASH_OF_EX(SSL_SESSION);
 793 /* Needed in ssl_cert.c */
 794 DEFINE_LHASH_OF_EX(X509_NAME);
 795
 796 # define TLSEXT_KEYNAME_LENGTH  16
 797 # define TLSEXT_TICK_KEY_LENGTH 32
 798
 799 typedef struct ssl_ctx_ext_secure_st {
 800     unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
 801     unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
 802 } SSL_CTX_EXT_SECURE;
 803
 804 /*
 805  * Helper function for HMAC
 806  * The structure should be considered opaque, it will change once the low
 807  * level deprecated calls are removed.  At that point it can be replaced
 808  * by EVP_MAC_CTX and most of the functions converted to macros or inlined
 809  * directly.
 810  */
 811 typedef struct ssl_hmac_st {
 812     EVP_MAC_CTX *ctx;
 813 # ifndef OPENSSL_NO_DEPRECATED_3_0
 814     HMAC_CTX *old_ctx;
 815 # endif
 816 } SSL_HMAC;
 817
 818 SSL_HMAC *ssl_hmac_new(const SSL_CTX *ctx);
 819 void ssl_hmac_free(SSL_HMAC *ctx);
 820 # ifndef OPENSSL_NO_DEPRECATED_3_0
 821 HMAC_CTX *ssl_hmac_get0_HMAC_CTX(SSL_HMAC *ctx);
 822 # endif
 823 EVP_MAC_CTX *ssl_hmac_get0_EVP_MAC_CTX(SSL_HMAC *ctx);
 824 int ssl_hmac_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
 825 int ssl_hmac_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
 826 int ssl_hmac_final(SSL_HMAC *ctx, unsigned char *md, size_t *len,
 827                    size_t max_size);
 828 size_t ssl_hmac_size(const SSL_HMAC *ctx);
 829
 830 int ssl_get_EC_curve_nid(const EVP_PKEY *pkey);
 831 __owur int tls13_set_encoded_pub_key(EVP_PKEY *pkey,
 832                                      const unsigned char *enckey,
 833                                      size_t enckeylen);
 834
 835 typedef struct tls_group_info_st {
 836     char *tlsname;           /* Curve Name as in TLS specs */
 837     char *realname;          /* Curve Name according to provider */
 838     char *algorithm;         /* Algorithm name to fetch */
 839     unsigned int secbits;    /* Bits of security (from SP800-57) */
 840     uint16_t group_id;       /* Group ID */
 841     int mintls;              /* Minimum TLS version, -1 unsupported */
 842     int maxtls;              /* Maximum TLS version (or 0 for undefined) */
 843     int mindtls;             /* Minimum DTLS version, -1 unsupported */
 844     int maxdtls;             /* Maximum DTLS version (or 0 for undefined) */
 845     char is_kem;             /* Mode for this Group: 0 is KEX, 1 is KEM */
 846 } TLS_GROUP_INFO;
 847
 848 /* flags values */
 849 # define TLS_GROUP_TYPE             0x0000000FU /* Mask for group type */
 850 # define TLS_GROUP_CURVE_PRIME      0x00000001U
 851 # define TLS_GROUP_CURVE_CHAR2      0x00000002U
 852 # define TLS_GROUP_CURVE_CUSTOM     0x00000004U
 853 # define TLS_GROUP_FFDHE            0x00000008U
 854 # define TLS_GROUP_ONLY_FOR_TLS1_3  0x00000010U
 855
 856 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
 857
 858 struct ssl_ctx_st {
 859     OSSL_LIB_CTX *libctx;
 860
 861     const SSL_METHOD *method;
 862     STACK_OF(SSL_CIPHER) *cipher_list;
 863     /* same as above but sorted for lookup */
 864     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
 865     /* TLSv1.3 specific ciphersuites */
 866     STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
 867     struct x509_store_st /* X509_STORE */ *cert_store;
 868     LHASH_OF(SSL_SESSION) *sessions;
 869     /*
 870      * Most session-ids that will be cached, default is
 871      * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
 872      */
 873     size_t session_cache_size;
 874     struct ssl_session_st *session_cache_head;
 875     struct ssl_session_st *session_cache_tail;
 876     /*
 877      * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
 878      * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
 879      * means only SSL_accept will cache SSL_SESSIONS.
 880      */
 881     uint32_t session_cache_mode;
 882     /*
 883      * If timeout is not 0, it is the default timeout value set when
 884      * SSL_new() is called.  This has been put in to make life easier to set
 885      * things up
 886      */
 887     OSSL_TIME session_timeout;
 888     /*
 889      * If this callback is not null, it will be called each time a session id
 890      * is added to the cache.  If this function returns 1, it means that the
 891      * callback will do a SSL_SESSION_free() when it has finished using it.
 892      * Otherwise, on 0, it means the callback has finished with it. If
 893      * remove_session_cb is not null, it will be called when a session-id is
 894      * removed from the cache.  After the call, OpenSSL will
 895      * SSL_SESSION_free() it.
 896      */
 897     int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
 898     void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
 899     SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
 900                                     const unsigned char *data, int len,
 901                                     int *copy);
 902     struct {
 903         TSAN_QUALIFIER int sess_connect;       /* SSL new conn - started */
 904         TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
 905         TSAN_QUALIFIER int sess_connect_good;  /* SSL new conne/reneg - finished */
 906         TSAN_QUALIFIER int sess_accept;        /* SSL new accept - started */
 907         TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
 908         TSAN_QUALIFIER int sess_accept_good;   /* SSL accept/reneg - finished */
 909         TSAN_QUALIFIER int sess_miss;          /* session lookup misses */
 910         TSAN_QUALIFIER int sess_timeout;       /* reuse attempt on timeouted session */
 911         TSAN_QUALIFIER int sess_cache_full;    /* session removed due to full cache */
 912         TSAN_QUALIFIER int sess_hit;           /* session reuse actually done */
 913         TSAN_QUALIFIER int sess_cb_hit;        /* session-id that was not in
 914                                                 * the cache was passed back via
 915                                                 * the callback. This indicates
 916                                                 * that the application is
 917                                                 * supplying session-id's from
 918                                                 * other processes - spooky
 919                                                 * :-) */
 920     } stats;
 921 #ifdef TSAN_REQUIRES_LOCKING
 922     CRYPTO_RWLOCK *tsan_lock;
 923 #endif
 924
 925     CRYPTO_REF_COUNT references;
 926
 927     /* if defined, these override the X509_verify_cert() calls */
 928     int (*app_verify_callback) (X509_STORE_CTX *, void *);
 929     void *app_verify_arg;
 930     /*
 931      * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
 932      * ('app_verify_callback' was called with just one argument)
 933      */
 934
 935     /* Default password callback. */
 936     pem_password_cb *default_passwd_callback;
 937
 938     /* Default password callback user data. */
 939     void *default_passwd_callback_userdata;
 940
 941     /* get client cert callback */
 942     int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
 943
 944     /* cookie generate callback */
 945     int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
 946                               unsigned int *cookie_len);
 947
 948     /* verify cookie callback */
 949     int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
 950                                  unsigned int cookie_len);
 951
 952     /* TLS1.3 app-controlled cookie generate callback */
 953     int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
 954                                     size_t *cookie_len);
 955
 956     /* TLS1.3 verify app-controlled cookie callback */
 957     int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
 958                                        size_t cookie_len);
 959
 960     CRYPTO_EX_DATA ex_data;
 961
 962     const EVP_MD *md5;          /* For SSLv3/TLSv1 'ssl3-md5' */
 963     const EVP_MD *sha1;         /* For SSLv3/TLSv1 'ssl3-sha1' */
 964
 965     STACK_OF(X509) *extra_certs;
 966     STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
 967
 968     /* Default values used when no per-SSL value is defined follow */
 969
 970     /* used if SSL's info_callback is NULL */
 971     void (*info_callback) (const SSL *ssl, int type, int val);
 972
 973     /*
 974      * What we put in certificate_authorities extension for TLS 1.3
 975      * (ClientHello and CertificateRequest) or just client cert requests for
 976      * earlier versions. If client_ca_names is populated then it is only used
 977      * for client cert requests, and in preference to ca_names.
 978      */
 979     STACK_OF(X509_NAME) *ca_names;
 980     STACK_OF(X509_NAME) *client_ca_names;
 981
 982     /*
 983      * Default values to use in SSL structures follow (these are copied by
 984      * SSL_new)
 985      */
 986
 987     uint64_t options;
 988     uint32_t mode;
 989     int min_proto_version;
 990     int max_proto_version;
 991     size_t max_cert_list;
 992
 993     struct cert_st /* CERT */ *cert;
 994     int read_ahead;
 995
 996     /* callback that allows applications to peek at protocol messages */
 997     void (*msg_callback) (int write_p, int version, int content_type,
 998                           const void *buf, size_t len, SSL *ssl, void *arg);
 999     void *msg_callback_arg;
1000
1001     uint32_t verify_mode;
1002     size_t sid_ctx_length;
1003     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1004     /* called 'verify_callback' in the SSL */
1005     int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
1006
1007     /* Default generate session ID callback. */
1008     GEN_SESSION_CB generate_session_id;
1009
1010     X509_VERIFY_PARAM *param;
1011
1012     int quiet_shutdown;
1013
1014 # ifndef OPENSSL_NO_CT
1015     CTLOG_STORE *ctlog_store;   /* CT Log Store */
1016     /*
1017      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1018      * If they are not, the connection should be aborted.
1019      */
1020     ssl_ct_validation_cb ct_validation_callback;
1021     void *ct_validation_callback_arg;
1022 # endif
1023
1024     /*
1025      * If we're using more than one pipeline how should we divide the data
1026      * up between the pipes?
1027      */
1028     size_t split_send_fragment;
1029     /*
1030      * Maximum amount of data to send in one fragment. actual record size can
1031      * be more than this due to padding and MAC overheads.
1032      */
1033     size_t max_send_fragment;
1034
1035     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1036     size_t max_pipelines;
1037
1038     /* The default read buffer length to use (0 means not set) */
1039     size_t default_read_buf_len;
1040
1041 # ifndef OPENSSL_NO_ENGINE
1042     /*
1043      * Engine to pass requests for client certs to
1044      */
1045     ENGINE *client_cert_engine;
1046 # endif
1047
1048     /* ClientHello callback.  Mostly for extensions, but not entirely. */
1049     SSL_client_hello_cb_fn client_hello_cb;
1050     void *client_hello_cb_arg;
1051
1052     /* TLS extensions. */
1053     struct {
1054         /* TLS extensions servername callback */
1055         int (*servername_cb) (SSL *, int *, void *);
1056         void *servername_arg;
1057         /* RFC 4507 session ticket keys */
1058         unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
1059         SSL_CTX_EXT_SECURE *secure;
1060 # ifndef OPENSSL_NO_DEPRECATED_3_0
1061         /* Callback to support customisation of ticket key setting */
1062         int (*ticket_key_cb) (SSL *ssl,
1063                               unsigned char *name, unsigned char *iv,
1064                               EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
1065 #endif
1066         int (*ticket_key_evp_cb) (SSL *ssl,
1067                                   unsigned char *name, unsigned char *iv,
1068                                   EVP_CIPHER_CTX *ectx, EVP_MAC_CTX *hctx,
1069                                   int enc);
1070
1071         /* certificate status request info */
1072         /* Callback for status request */
1073         int (*status_cb) (SSL *ssl, void *arg);
1074         void *status_arg;
1075         /* ext status type used for CSR extension (OCSP Stapling) */
1076         int status_type;
1077         /* RFC 4366 Maximum Fragment Length Negotiation */
1078         uint8_t max_fragment_len_mode;
1079
1080         /* EC extension values inherited by SSL structure */
1081         size_t ecpointformats_len;
1082         unsigned char *ecpointformats;
1083
1084         size_t supportedgroups_len;
1085         uint16_t *supportedgroups;
1086
1087         uint16_t *supported_groups_default;
1088         size_t supported_groups_default_len;
1089         /*
1090          * ALPN information (we are in the process of transitioning from NPN to
1091          * ALPN.)
1092          */
1093
1094         /*-
1095          * For a server, this contains a callback function that allows the
1096          * server to select the protocol for the connection.
1097          *   out: on successful return, this must point to the raw protocol
1098          *        name (without the length prefix).
1099          *   outlen: on successful return, this contains the length of |*out|.
1100          *   in: points to the client's list of supported protocols in
1101          *       wire-format.
1102          *   inlen: the length of |in|.
1103          */
1104         int (*alpn_select_cb) (SSL *s,
1105                                const unsigned char **out,
1106                                unsigned char *outlen,
1107                                const unsigned char *in,
1108                                unsigned int inlen, void *arg);
1109         void *alpn_select_cb_arg;
1110
1111         /*
1112          * For a client, this contains the list of supported protocols in wire
1113          * format.
1114          */
1115         unsigned char *alpn;
1116         size_t alpn_len;
1117
1118 # ifndef OPENSSL_NO_NEXTPROTONEG
1119         /* Next protocol negotiation information */
1120
1121         /*
1122          * For a server, this contains a callback function by which the set of
1123          * advertised protocols can be provided.
1124          */
1125         SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
1126         void *npn_advertised_cb_arg;
1127         /*
1128          * For a client, this contains a callback function that selects the next
1129          * protocol from the list provided by the server.
1130          */
1131         SSL_CTX_npn_select_cb_func npn_select_cb;
1132         void *npn_select_cb_arg;
1133 # endif
1134
1135         unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1136     } ext;
1137
1138 # ifndef OPENSSL_NO_PSK
1139     SSL_psk_client_cb_func psk_client_callback;
1140     SSL_psk_server_cb_func psk_server_callback;
1141 # endif
1142     SSL_psk_find_session_cb_func psk_find_session_cb;
1143     SSL_psk_use_session_cb_func psk_use_session_cb;
1144
1145 # ifndef OPENSSL_NO_SRP
1146     SRP_CTX srp_ctx;            /* ctx for SRP authentication */
1147 # endif
1148
1149     /* Shared DANE context */
1150     struct dane_ctx_st dane;
1151
1152 # ifndef OPENSSL_NO_SRTP
1153     /* SRTP profiles we are willing to do from RFC 5764 */
1154     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1155 # endif
1156     /*
1157      * Callback for disabling session caching and ticket support on a session
1158      * basis, depending on the chosen cipher.
1159      */
1160     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1161
1162     CRYPTO_RWLOCK *lock;
1163
1164     /*
1165      * Callback for logging key material for use with debugging tools like
1166      * Wireshark. The callback should log `line` followed by a newline.
1167      */
1168     SSL_CTX_keylog_cb_func keylog_callback;
1169
1170     /*
1171      * The maximum number of bytes advertised in session tickets that can be
1172      * sent as early data.
1173      */
1174     uint32_t max_early_data;
1175
1176     /*
1177      * The maximum number of bytes of early data that a server will tolerate
1178      * (which should be at least as much as max_early_data).
1179      */
1180     uint32_t recv_max_early_data;
1181
1182     /* TLS1.3 padding callback */
1183     size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1184     void *record_padding_arg;
1185     size_t block_padding;
1186
1187     /* Session ticket appdata */
1188     SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1189     SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1190     void *ticket_cb_data;
1191
1192     /* The number of TLS1.3 tickets to automatically send */
1193     size_t num_tickets;
1194
1195     /* Callback to determine if early_data is acceptable or not */
1196     SSL_allow_early_data_cb_fn allow_early_data_cb;
1197     void *allow_early_data_cb_data;
1198
1199     /* Do we advertise Post-handshake auth support? */
1200     int pha_enabled;
1201
1202     /* Callback for SSL async handling */
1203     SSL_async_callback_fn async_cb;
1204     void *async_cb_arg;
1205
1206     char *propq;
1207
1208     int ssl_mac_pkey_id[SSL_MD_NUM_IDX];
1209     const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
1210     const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX];
1211     size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
1212
1213     /* Cache of all sigalgs we know and whether they are available or not */
1214     struct sigalg_lookup_st *sigalg_lookup_cache;
1215
1216     TLS_GROUP_INFO *group_list;
1217     size_t group_list_len;
1218     size_t group_list_max_len;
1219
1220     /* masks of disabled algorithms */
1221     uint32_t disabled_enc_mask;
1222     uint32_t disabled_mac_mask;
1223     uint32_t disabled_mkey_mask;
1224     uint32_t disabled_auth_mask;
1225
1226 #ifndef OPENSSL_NO_COMP_ALG
1227     /* certificate compression preferences */
1228     int cert_comp_prefs[TLSEXT_comp_cert_limit];
1229 #endif
1230 };
1231
1232 typedef struct cert_pkey_st CERT_PKEY;
1233
1234 #define SSL_TYPE_SSL_CONNECTION  0
1235 #define SSL_TYPE_QUIC_CONNECTION 1
1236 #define SSL_TYPE_QUIC_STREAM     2
1237
1238 struct ssl_st {
1239     int type;
1240     SSL_CTX *ctx;
1241     const SSL_METHOD *method;
1242     CRYPTO_REF_COUNT references;
1243     CRYPTO_RWLOCK *lock;
1244     /* extra application data */
1245     CRYPTO_EX_DATA ex_data;
1246 };
1247
1248 struct ssl_connection_st {
1249     /* type identifier and common data */
1250     struct ssl_st ssl;
1251 #ifndef OPENSSL_NO_QUIC
1252     /* pointer to parent SSL of QUIC_CONNECTION or self */
1253     struct ssl_st *user_ssl;
1254 #endif
1255     /*
1256      * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1257      * DTLS1_VERSION)
1258      */
1259     int version;
1260     /*
1261      * There are 2 BIO's even though they are normally both the same.  This
1262      * is so data can be read and written to different handlers
1263      */
1264     /* used by SSL_read */
1265     BIO *rbio;
1266     /* used by SSL_write */
1267     BIO *wbio;
1268     /* used during session-id reuse to concatenate messages */
1269     BIO *bbio;
1270     /*
1271      * This holds a variable that indicates what we were doing when a 0 or -1
1272      * is returned.  This is needed for non-blocking IO so we know what
1273      * request needs re-doing when in SSL_accept or SSL_connect
1274      */
1275     int rwstate;
1276     int (*handshake_func) (SSL *);
1277     /*
1278      * Imagine that here's a boolean member "init" that is switched as soon
1279      * as SSL_set_{accept/connect}_state is called for the first time, so
1280      * that "state" and "handshake_func" are properly initialized.  But as
1281      * handshake_func is == 0 until then, we use this test instead of an
1282      * "init" member.
1283      */
1284     /* are we the server side? */
1285     int server;
1286     /*
1287      * Generate a new session or reuse an old one.
1288      * NB: For servers, the 'new' session may actually be a previously
1289      * cached session or even the previous session unless
1290      * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1291      */
1292     int new_session;
1293     /* don't send shutdown packets */
1294     int quiet_shutdown;
1295     /* we have shut things down, 0x01 sent, 0x02 for received */
1296     int shutdown;
1297     /* where we are */
1298     OSSL_STATEM statem;
1299     SSL_EARLY_DATA_STATE early_data_state;
1300     BUF_MEM *init_buf;          /* buffer used during init */
1301     void *init_msg;             /* pointer to handshake message body, set by
1302                                  * ssl3_get_message() */
1303     size_t init_num;               /* amount read/written */
1304     size_t init_off;               /* amount read/written */
1305
1306     struct {
1307         long flags;
1308         unsigned char server_random[SSL3_RANDOM_SIZE];
1309         unsigned char client_random[SSL3_RANDOM_SIZE];
1310
1311         /* used during startup, digest all incoming/outgoing packets */
1312         BIO *handshake_buffer;
1313         /*
1314          * When handshake digest is determined, buffer is hashed and
1315          * freed and MD_CTX for the required digest is stored here.
1316          */
1317         EVP_MD_CTX *handshake_dgst;
1318         /*
1319          * Set whenever an expected ChangeCipherSpec message is processed.
1320          * Unset when the peer's Finished message is received.
1321          * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1322          */
1323         int change_cipher_spec;
1324         int warn_alert;
1325         int fatal_alert;
1326         /*
1327          * we allow one fatal and one warning alert to be outstanding, send close
1328          * alert via the warning alert
1329          */
1330         int alert_dispatch;
1331         unsigned char send_alert[2];
1332         /*
1333          * This flag is set when we should renegotiate ASAP, basically when there
1334          * is no more data in the read or write buffers
1335          */
1336         int renegotiate;
1337         int total_renegotiations;
1338         int num_renegotiations;
1339         int in_read_app_data;
1340         struct {
1341             /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1342             unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1343             size_t finish_md_len;
1344             unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1345             size_t peer_finish_md_len;
1346             size_t message_size;
1347             int message_type;
1348             /* used to hold the new cipher we are going to use */
1349             const SSL_CIPHER *new_cipher;
1350             EVP_PKEY *pkey;         /* holds short lived key exchange key */
1351             /* used for certificate requests */
1352             int cert_req;
1353             /* Certificate types in certificate request message. */
1354             uint8_t *ctype;
1355             size_t ctype_len;
1356             /* Certificate authorities list peer sent */
1357             STACK_OF(X509_NAME) *peer_ca_names;
1358             size_t key_block_length;
1359             unsigned char *key_block;
1360             const EVP_CIPHER *new_sym_enc;
1361             const EVP_MD *new_hash;
1362             int new_mac_pkey_type;
1363             size_t new_mac_secret_size;
1364 # ifndef OPENSSL_NO_COMP
1365             const SSL_COMP *new_compression;
1366 # else
1367             char *new_compression;
1368 # endif
1369             int cert_request;
1370             /* Raw values of the cipher list from a client */
1371             unsigned char *ciphers_raw;
1372             size_t ciphers_rawlen;
1373             /* Temporary storage for premaster secret */
1374             unsigned char *pms;
1375             size_t pmslen;
1376 # ifndef OPENSSL_NO_PSK
1377             /* Temporary storage for PSK key */
1378             unsigned char *psk;
1379             size_t psklen;
1380 # endif
1381             /* Signature algorithm we actually use */
1382             const struct sigalg_lookup_st *sigalg;
1383             /* Pointer to certificate we use */
1384             CERT_PKEY *cert;
1385             /*
1386              * signature algorithms peer reports: e.g. supported signature
1387              * algorithms extension for server or as part of a certificate
1388              * request for client.
1389              * Keep track of the algorithms for TLS and X.509 usage separately.
1390              */
1391             uint16_t *peer_sigalgs;
1392             uint16_t *peer_cert_sigalgs;
1393             /* Size of above arrays */
1394             size_t peer_sigalgslen;
1395             size_t peer_cert_sigalgslen;
1396             /* Sigalg peer actually uses */
1397             const struct sigalg_lookup_st *peer_sigalg;
1398             /*
1399              * Set if corresponding CERT_PKEY can be used with current
1400              * SSL session: e.g. appropriate curve, signature algorithms etc.
1401              * If zero it can't be used at all.
1402              */
1403             uint32_t valid_flags[SSL_PKEY_NUM];
1404             /*
1405              * For servers the following masks are for the key and auth algorithms
1406              * that are supported by the certs below. For clients they are masks of
1407              * *disabled* algorithms based on the current session.
1408              */
1409             uint32_t mask_k;
1410             uint32_t mask_a;
1411             /*
1412              * The following are used by the client to see if a cipher is allowed or
1413              * not.  It contains the minimum and maximum version the client's using
1414              * based on what it knows so far.
1415              */
1416             int min_ver;
1417             int max_ver;
1418         } tmp;
1419
1420         /* Connection binding to prevent renegotiation attacks */
1421         unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1422         size_t previous_client_finished_len;
1423         unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1424         size_t previous_server_finished_len;
1425         int send_connection_binding;
1426
1427 # ifndef OPENSSL_NO_NEXTPROTONEG
1428         /*
1429          * Set if we saw the Next Protocol Negotiation extension from our peer.
1430          */
1431         int npn_seen;
1432 # endif
1433
1434         /*
1435          * ALPN information (we are in the process of transitioning from NPN to
1436          * ALPN.)
1437          */
1438
1439         /*
1440          * In a server these point to the selected ALPN protocol after the
1441          * ClientHello has been processed. In a client these contain the protocol
1442          * that the server selected once the ServerHello has been processed.
1443          */
1444         unsigned char *alpn_selected;
1445         size_t alpn_selected_len;
1446         /* used by the server to know what options were proposed */
1447         unsigned char *alpn_proposed;
1448         size_t alpn_proposed_len;
1449         /* used by the client to know if it actually sent alpn */
1450         int alpn_sent;
1451
1452         /*
1453          * This is set to true if we believe that this is a version of Safari
1454          * running on OS X 10.6 or newer. We wish to know this because Safari on
1455          * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1456          */
1457         char is_probably_safari;
1458
1459         /*
1460          * Track whether we did a key exchange this handshake or not, so
1461          * SSL_get_negotiated_group() knows whether to fall back to the
1462          * value in the SSL_SESSION.
1463          */
1464         char did_kex;
1465         /* For clients: peer temporary key */
1466         /* The group_id for the key exchange key */
1467         uint16_t group_id;
1468         EVP_PKEY *peer_tmp;
1469
1470     } s3;
1471
1472     struct dtls1_state_st *d1;  /* DTLSv1 variables */
1473     /* callback that allows applications to peek at protocol messages */
1474     void (*msg_callback) (int write_p, int version, int content_type,
1475                           const void *buf, size_t len, SSL *ssl, void *arg);
1476     void *msg_callback_arg;
1477     int hit;                    /* reusing a previous session */
1478     X509_VERIFY_PARAM *param;
1479     /* Per connection DANE state */
1480     SSL_DANE dane;
1481     /* crypto */
1482     STACK_OF(SSL_CIPHER) *peer_ciphers;
1483     STACK_OF(SSL_CIPHER) *cipher_list;
1484     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1485     /* TLSv1.3 specific ciphersuites */
1486     STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1487     /*
1488      * These are the ones being used, the ones in SSL_SESSION are the ones to
1489      * be 'copied' into these ones
1490      */
1491     uint32_t mac_flags;
1492     /*
1493      * The TLS1.3 secrets.
1494      */
1495     unsigned char early_secret[EVP_MAX_MD_SIZE];
1496     unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1497     unsigned char master_secret[EVP_MAX_MD_SIZE];
1498     unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1499     unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1500     unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1501     unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1502     unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1503     unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1504     unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1505     unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1506     unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1507
1508     /* session info */
1509     /* client cert? */
1510     /* This is used to hold the server certificate used */
1511     struct cert_st /* CERT */ *cert;
1512
1513     /*
1514      * The hash of all messages prior to the CertificateVerify, and the length
1515      * of that hash.
1516      */
1517     unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1518     size_t cert_verify_hash_len;
1519
1520     /* Flag to indicate whether we should send a HelloRetryRequest or not */
1521     enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1522         hello_retry_request;
1523
1524     /*
1525      * the session_id_context is used to ensure sessions are only reused in
1526      * the appropriate context
1527      */
1528     size_t sid_ctx_length;
1529     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1530     /* This can also be in the session once a session is established */
1531     SSL_SESSION *session;
1532     /* TLSv1.3 PSK session */
1533     SSL_SESSION *psksession;
1534     unsigned char *psksession_id;
1535     size_t psksession_id_len;
1536     /* Default generate session ID callback. */
1537     GEN_SESSION_CB generate_session_id;
1538     /*
1539      * The temporary TLSv1.3 session id. This isn't really a session id at all
1540      * but is a random value sent in the legacy session id field.
1541      */
1542     unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1543     size_t tmp_session_id_len;
1544     /* Used in SSL3 */
1545     /*
1546      * 0 don't care about verify failure.
1547      * 1 fail if verify fails
1548      */
1549     uint32_t verify_mode;
1550     /* fail if callback returns 0 */
1551     int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1552     /* optional informational callback */
1553     void (*info_callback) (const SSL *ssl, int type, int val);
1554     /* error bytes to be written */
1555     int error;
1556     /* actual code */
1557     int error_code;
1558 # ifndef OPENSSL_NO_PSK
1559     SSL_psk_client_cb_func psk_client_callback;
1560     SSL_psk_server_cb_func psk_server_callback;
1561 # endif
1562     SSL_psk_find_session_cb_func psk_find_session_cb;
1563     SSL_psk_use_session_cb_func psk_use_session_cb;
1564
1565     /* Verified chain of peer */
1566     STACK_OF(X509) *verified_chain;
1567     long verify_result;
1568     /*
1569      * What we put in certificate_authorities extension for TLS 1.3
1570      * (ClientHello and CertificateRequest) or just client cert requests for
1571      * earlier versions. If client_ca_names is populated then it is only used
1572      * for client cert requests, and in preference to ca_names.
1573      */
1574     STACK_OF(X509_NAME) *ca_names;
1575     STACK_OF(X509_NAME) *client_ca_names;
1576     /* protocol behaviour */
1577     uint64_t options;
1578     /* API behaviour */
1579     uint32_t mode;
1580     int min_proto_version;
1581     int max_proto_version;
1582     size_t max_cert_list;
1583     int first_packet;
1584     /*
1585      * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1586      * secret and SSLv3/TLS (<=1.2) rollback check
1587      */
1588     int client_version;
1589     /*
1590      * If we're using more than one pipeline how should we divide the data
1591      * up between the pipes?
1592      */
1593     size_t split_send_fragment;
1594     /*
1595      * Maximum amount of data to send in one fragment. actual record size can
1596      * be more than this due to padding and MAC overheads.
1597      */
1598     size_t max_send_fragment;
1599     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1600     size_t max_pipelines;
1601
1602     struct {
1603         /* Built-in extension flags */
1604         uint8_t extflags[TLSEXT_IDX_num_builtins];
1605         /* TLS extension debug callback */
1606         void (*debug_cb)(SSL *s, int client_server, int type,
1607                          const unsigned char *data, int len, void *arg);
1608         void *debug_arg;
1609         char *hostname;
1610         /* certificate status request info */
1611         /* Status type or -1 if no status type */
1612         int status_type;
1613         /* Raw extension data, if seen */
1614         unsigned char *scts;
1615         /* Length of raw extension data, if seen */
1616         uint16_t scts_len;
1617         /* Expect OCSP CertificateStatus message */
1618         int status_expected;
1619
1620         struct {
1621             /* OCSP status request only */
1622             STACK_OF(OCSP_RESPID) *ids;
1623             X509_EXTENSIONS *exts;
1624             /* OCSP response received or to be sent */
1625             unsigned char *resp;
1626             size_t resp_len;
1627         } ocsp;
1628
1629         /* RFC4507 session ticket expected to be received or sent */
1630         int ticket_expected;
1631         /* TLS 1.3 tickets requested by the application. */
1632         int extra_tickets_expected;
1633         size_t ecpointformats_len;
1634         /* our list */
1635         unsigned char *ecpointformats;
1636
1637         size_t peer_ecpointformats_len;
1638         /* peer's list */
1639         unsigned char *peer_ecpointformats;
1640         size_t supportedgroups_len;
1641         /* our list */
1642         uint16_t *supportedgroups;
1643
1644         size_t peer_supportedgroups_len;
1645          /* peer's list */
1646         uint16_t *peer_supportedgroups;
1647
1648         /* TLS Session Ticket extension override */
1649         TLS_SESSION_TICKET_EXT *session_ticket;
1650         /* TLS Session Ticket extension callback */
1651         tls_session_ticket_ext_cb_fn session_ticket_cb;
1652         void *session_ticket_cb_arg;
1653         /* TLS pre-shared secret session resumption */
1654         tls_session_secret_cb_fn session_secret_cb;
1655         void *session_secret_cb_arg;
1656         /*
1657          * For a client, this contains the list of supported protocols in wire
1658          * format.
1659          */
1660         unsigned char *alpn;
1661         size_t alpn_len;
1662         /*
1663          * Next protocol negotiation. For the client, this is the protocol that
1664          * we sent in NextProtocol and is set when handling ServerHello
1665          * extensions. For a server, this is the client's selected_protocol from
1666          * NextProtocol and is set when handling the NextProtocol message, before
1667          * the Finished message.
1668          */
1669         unsigned char *npn;
1670         size_t npn_len;
1671
1672         /* The available PSK key exchange modes */
1673         int psk_kex_mode;
1674
1675         /* Set to one if we have negotiated ETM */
1676         int use_etm;
1677
1678         /* Are we expecting to receive early data? */
1679         int early_data;
1680         /* Is the session suitable for early data? */
1681         int early_data_ok;
1682
1683         /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1684         unsigned char *tls13_cookie;
1685         size_t tls13_cookie_len;
1686         /* Have we received a cookie from the client? */
1687         int cookieok;
1688
1689         /*
1690          * Maximum Fragment Length as per RFC 4366.
1691          * If this member contains one of the allowed values (1-4)
1692          * then we should include Maximum Fragment Length Negotiation
1693          * extension in Client Hello.
1694          * Please note that value of this member does not have direct
1695          * effect. The actual (binding) value is stored in SSL_SESSION,
1696          * as this extension is optional on server side.
1697          */
1698         uint8_t max_fragment_len_mode;
1699
1700         /*
1701          * On the client side the number of ticket identities we sent in the
1702          * ClientHello. On the server side the identity of the ticket we
1703          * selected.
1704          */
1705         int tick_identity;
1706
1707         /* This is the list of algorithms the peer supports that we also support */
1708         int compress_certificate_from_peer[TLSEXT_comp_cert_limit];
1709         /* indicate that we sent the extension, so we'll accept it */
1710         int compress_certificate_sent;
1711     } ext;
1712
1713     /*
1714      * Parsed form of the ClientHello, kept around across client_hello_cb
1715      * calls.
1716      */
1717     CLIENTHELLO_MSG *clienthello;
1718
1719     /*-
1720      * no further mod of servername
1721      * 0 : call the servername extension callback.
1722      * 1 : prepare 2, allow last ack just after in server callback.
1723      * 2 : don't call servername callback, no ack in server hello
1724      */
1725     int servername_done;
1726 # ifndef OPENSSL_NO_CT
1727     /*
1728      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1729      * If they are not, the connection should be aborted.
1730      */
1731     ssl_ct_validation_cb ct_validation_callback;
1732     /* User-supplied argument that is passed to the ct_validation_callback */
1733     void *ct_validation_callback_arg;
1734     /*
1735      * Consolidated stack of SCTs from all sources.
1736      * Lazily populated by CT_get_peer_scts(SSL*)
1737      */
1738     STACK_OF(SCT) *scts;
1739     /* Have we attempted to find/parse SCTs yet? */
1740     int scts_parsed;
1741 # endif
1742     SSL_CTX *session_ctx;       /* initial ctx, used to store sessions */
1743 # ifndef OPENSSL_NO_SRTP
1744     /* What we'll do */
1745     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1746     /* What's been chosen */
1747     SRTP_PROTECTION_PROFILE *srtp_profile;
1748 # endif
1749     /*-
1750      * 1 if we are renegotiating.
1751      * 2 if we are a server and are inside a handshake
1752      * (i.e. not just sending a HelloRequest)
1753      */
1754     int renegotiate;
1755     /* If sending a KeyUpdate is pending */
1756     int key_update;
1757     /* Post-handshake authentication state */
1758     SSL_PHA_STATE post_handshake_auth;
1759     int pha_enabled;
1760     uint8_t* pha_context;
1761     size_t pha_context_len;
1762     int certreqs_sent;
1763     EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1764
1765 # ifndef OPENSSL_NO_SRP
1766     /* ctx for SRP authentication */
1767     SRP_CTX srp_ctx;
1768 # endif
1769     /*
1770      * Callback for disabling session caching and ticket support on a session
1771      * basis, depending on the chosen cipher.
1772      */
1773     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1774
1775     /* Record layer data */
1776     RECORD_LAYER rlayer;
1777
1778     /* Default password callback. */
1779     pem_password_cb *default_passwd_callback;
1780     /* Default password callback user data. */
1781     void *default_passwd_callback_userdata;
1782     /* Async Job info */
1783     ASYNC_JOB *job;
1784     ASYNC_WAIT_CTX *waitctx;
1785     size_t asyncrw;
1786
1787     /*
1788      * The maximum number of bytes advertised in session tickets that can be
1789      * sent as early data.
1790      */
1791     uint32_t max_early_data;
1792     /*
1793      * The maximum number of bytes of early data that a server will tolerate
1794      * (which should be at least as much as max_early_data).
1795      */
1796     uint32_t recv_max_early_data;
1797
1798     /*
1799      * The number of bytes of early data received so far. If we accepted early
1800      * data then this is a count of the plaintext bytes. If we rejected it then
1801      * this is a count of the ciphertext bytes.
1802      */
1803     uint32_t early_data_count;
1804
1805     /* The number of TLS1.3 tickets to automatically send */
1806     size_t num_tickets;
1807     /* The number of TLS1.3 tickets actually sent so far */
1808     size_t sent_tickets;
1809     /* The next nonce value to use when we send a ticket on this connection */
1810     uint64_t next_ticket_nonce;
1811
1812     /* Callback to determine if early_data is acceptable or not */
1813     SSL_allow_early_data_cb_fn allow_early_data_cb;
1814     void *allow_early_data_cb_data;
1815
1816     /* Callback for SSL async handling */
1817     SSL_async_callback_fn async_cb;
1818     void *async_cb_arg;
1819
1820     /*
1821      * Signature algorithms shared by client and server: cached because these
1822      * are used most often.
1823      */
1824     const struct sigalg_lookup_st **shared_sigalgs;
1825     size_t shared_sigalgslen;
1826
1827 #ifndef OPENSSL_NO_COMP_ALG
1828     /* certificate compression preferences */
1829     int cert_comp_prefs[TLSEXT_comp_cert_limit];
1830 #endif
1831 };
1832
1833 # define SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, c) \
1834     ((ssl) == NULL ? NULL                         \
1835      : ((ssl)->type == SSL_TYPE_SSL_CONNECTION    \
1836        ? (c SSL_CONNECTION *)(ssl)                \
1837        : NULL))
1838 # define SSL_CONNECTION_NO_CONST
1839 # define SSL_CONNECTION_FROM_SSL_ONLY(ssl) \
1840     SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1841 # define SSL_CONNECTION_FROM_CONST_SSL_ONLY(ssl) \
1842     SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1843 # define SSL_CONNECTION_GET_CTX(sc) ((sc)->ssl.ctx)
1844 # ifndef OPENSSL_NO_QUIC
1845 #  include "quic/quic_local.h"
1846 #  define SSL_CONNECTION_FROM_SSL_int(ssl, c)                      \
1847     ((ssl) == NULL ? NULL                                          \
1848      : ((ssl)->type == SSL_TYPE_SSL_CONNECTION                     \
1849         ? (c SSL_CONNECTION *)(ssl)                                \
1850         : ((ssl)->type == SSL_TYPE_QUIC_CONNECTION                 \
1851            ? (c SSL_CONNECTION *)((c QUIC_CONNECTION *)(ssl))->tls \
1852            : NULL)))
1853 #  define SSL_CONNECTION_FROM_SSL(ssl) \
1854     SSL_CONNECTION_FROM_SSL_int(ssl, SSL_CONNECTION_NO_CONST)
1855 #  define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1856     SSL_CONNECTION_FROM_SSL_int(ssl, const)
1857 #  define SSL_CONNECTION_GET_SSL(sc) ((sc)->user_ssl)
1858 # else
1859 #  define SSL_CONNECTION_FROM_SSL(ssl) \
1860     SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1861 #  define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1862     SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1863 #  define SSL_CONNECTION_GET_SSL(sc) (&(sc)->ssl)
1864 # endif
1865
1866 /*
1867  * Structure containing table entry of values associated with the signature
1868  * algorithms (signature scheme) extension
1869 */
1870 typedef struct sigalg_lookup_st {
1871     /* TLS 1.3 signature scheme name */
1872     const char *name;
1873     /* Raw value used in extension */
1874     uint16_t sigalg;
1875     /* NID of hash algorithm or NID_undef if no hash */
1876     int hash;
1877     /* Index of hash algorithm or -1 if no hash algorithm */
1878     int hash_idx;
1879     /* NID of signature algorithm */
1880     int sig;
1881     /* Index of signature algorithm */
1882     int sig_idx;
1883     /* Combined hash and signature NID, if any */
1884     int sigandhash;
1885     /* Required public key curve (ECDSA only) */
1886     int curve;
1887     /* Whether this signature algorithm is actually available for use */
1888     int enabled;
1889 } SIGALG_LOOKUP;
1890
1891 /*
1892  * Structure containing table entry of certificate info corresponding to
1893  * CERT_PKEY entries
1894  */
1895 typedef struct {
1896     int nid; /* NID of public key algorithm */
1897     uint32_t amask; /* authmask corresponding to key type */
1898 } SSL_CERT_LOOKUP;
1899
1900 /* DTLS structures */
1901
1902 # ifndef OPENSSL_NO_SCTP
1903 #  define DTLS1_SCTP_AUTH_LABEL   "EXPORTER_DTLS_OVER_SCTP"
1904 # endif
1905
1906 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1907 # define DTLS1_MAX_MTU_OVERHEAD                   48
1908
1909 /*
1910  * Flag used in message reuse to indicate the buffer contains the record
1911  * header as well as the handshake message header.
1912  */
1913 # define DTLS1_SKIP_RECORD_HEADER                 2
1914
1915 struct dtls1_retransmit_state {
1916     const OSSL_RECORD_METHOD *wrlmethod;
1917     OSSL_RECORD_LAYER *wrl;
1918 };
1919
1920 struct hm_header_st {
1921     unsigned char type;
1922     size_t msg_len;
1923     unsigned short seq;
1924     size_t frag_off;
1925     size_t frag_len;
1926     unsigned int is_ccs;
1927     struct dtls1_retransmit_state saved_retransmit_state;
1928 };
1929
1930 typedef struct hm_fragment_st {
1931     struct hm_header_st msg_header;
1932     unsigned char *fragment;
1933     unsigned char *reassembly;
1934 } hm_fragment;
1935
1936 typedef struct pqueue_st pqueue;
1937 typedef struct pitem_st pitem;
1938
1939 struct pitem_st {
1940     unsigned char priority[8];  /* 64-bit value in big-endian encoding */
1941     void *data;
1942     pitem *next;
1943 };
1944
1945 typedef struct pitem_st *piterator;
1946
1947 pitem *pitem_new(unsigned char *prio64be, void *data);
1948 void pitem_free(pitem *item);
1949 pqueue *pqueue_new(void);
1950 void pqueue_free(pqueue *pq);
1951 pitem *pqueue_insert(pqueue *pq, pitem *item);
1952 pitem *pqueue_peek(pqueue *pq);
1953 pitem *pqueue_pop(pqueue *pq);
1954 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1955 pitem *pqueue_iterator(pqueue *pq);
1956 pitem *pqueue_next(piterator *iter);
1957 size_t pqueue_size(pqueue *pq);
1958
1959 typedef struct dtls1_state_st {
1960     unsigned char cookie[DTLS1_COOKIE_LENGTH];
1961     size_t cookie_len;
1962     unsigned int cookie_verified;
1963     /* handshake message numbers */
1964     unsigned short handshake_write_seq;
1965     unsigned short next_handshake_write_seq;
1966     unsigned short handshake_read_seq;
1967     /* Buffered handshake messages */
1968     pqueue *buffered_messages;
1969     /* Buffered (sent) handshake records */
1970     pqueue *sent_messages;
1971     size_t link_mtu;      /* max on-the-wire DTLS packet size */
1972     size_t mtu;           /* max DTLS packet size */
1973     struct hm_header_st w_msg_hdr;
1974     struct hm_header_st r_msg_hdr;
1975     /* Number of alerts received so far */
1976     unsigned int timeout_num_alerts;
1977     /*
1978      * Indicates when the last handshake msg sent will timeout
1979      */
1980     OSSL_TIME next_timeout;
1981     /* Timeout duration */
1982     unsigned int timeout_duration_us;
1983
1984     unsigned int retransmitting;
1985 # ifndef OPENSSL_NO_SCTP
1986     int shutdown_received;
1987 # endif
1988
1989     DTLS_timer_cb timer_cb;
1990
1991 } DTLS1_STATE;
1992
1993 /*
1994  * From ECC-TLS draft, used in encoding the curve type in ECParameters
1995  */
1996 #  define EXPLICIT_PRIME_CURVE_TYPE  1
1997 #  define EXPLICIT_CHAR2_CURVE_TYPE  2
1998 #  define NAMED_CURVE_TYPE           3
1999
2000 # ifndef OPENSSL_NO_COMP_ALG
2001 struct ossl_comp_cert_st {
2002     unsigned char *data;
2003     size_t len;
2004     size_t orig_len;
2005     CRYPTO_REF_COUNT references;
2006     CRYPTO_RWLOCK *lock;
2007     int alg;
2008 };
2009 typedef struct ossl_comp_cert_st OSSL_COMP_CERT;
2010
2011 void OSSL_COMP_CERT_free(OSSL_COMP_CERT *c);
2012 int OSSL_COMP_CERT_up_ref(OSSL_COMP_CERT *c);
2013 # endif
2014
2015 struct cert_pkey_st {
2016     X509 *x509;
2017     EVP_PKEY *privatekey;
2018     /* Chain for this certificate */
2019     STACK_OF(X509) *chain;
2020     /*-
2021      * serverinfo data for this certificate.  The data is in TLS Extension
2022      * wire format, specifically it's a series of records like:
2023      *   uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
2024      *   uint16_t length;
2025      *   uint8_t data[length];
2026      */
2027     unsigned char *serverinfo;
2028     size_t serverinfo_length;
2029 # ifndef OPENSSL_NO_COMP_ALG
2030     /* Compressed certificate data - index 0 is unused */
2031     OSSL_COMP_CERT *comp_cert[TLSEXT_comp_cert_limit];
2032     int cert_comp_used;
2033 # endif
2034 };
2035 /* Retrieve Suite B flags */
2036 # define tls1_suiteb(s)  (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
2037 /* Uses to check strict mode: suite B modes are always strict */
2038 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
2039         (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
2040
2041 typedef enum {
2042     ENDPOINT_CLIENT = 0,
2043     ENDPOINT_SERVER,
2044     ENDPOINT_BOTH
2045 } ENDPOINT;
2046
2047
2048 typedef struct {
2049     unsigned short ext_type;
2050     ENDPOINT role;
2051     /* The context which this extension applies to */
2052     unsigned int context;
2053     /*
2054      * Per-connection flags relating to this extension type: not used if
2055      * part of an SSL_CTX structure.
2056      */
2057     uint32_t ext_flags;
2058     SSL_custom_ext_add_cb_ex add_cb;
2059     SSL_custom_ext_free_cb_ex free_cb;
2060     void *add_arg;
2061     SSL_custom_ext_parse_cb_ex parse_cb;
2062     void *parse_arg;
2063 } custom_ext_method;
2064
2065 /* ext_flags values */
2066
2067 /*
2068  * Indicates an extension has been received. Used to check for unsolicited or
2069  * duplicate extensions.
2070  */
2071 # define SSL_EXT_FLAG_RECEIVED   0x1
2072 /*
2073  * Indicates an extension has been sent: used to enable sending of
2074  * corresponding ServerHello extension.
2075  */
2076 # define SSL_EXT_FLAG_SENT       0x2
2077
2078 typedef struct {
2079     custom_ext_method *meths;
2080     size_t meths_count;
2081 } custom_ext_methods;
2082
2083 typedef struct cert_st {
2084     /* Current active set */
2085     /*
2086      * ALWAYS points to an element of the pkeys array
2087      * Probably it would make more sense to store
2088      * an index, not a pointer.
2089      */
2090     CERT_PKEY *key;
2091
2092     EVP_PKEY *dh_tmp;
2093     DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
2094     int dh_tmp_auto;
2095     /* Flags related to certificates */
2096     uint32_t cert_flags;
2097     CERT_PKEY pkeys[SSL_PKEY_NUM];
2098     /* Custom certificate types sent in certificate request message. */
2099     uint8_t *ctype;
2100     size_t ctype_len;
2101     /*
2102      * supported signature algorithms. When set on a client this is sent in
2103      * the client hello as the supported signature algorithms extension. For
2104      * servers it represents the signature algorithms we are willing to use.
2105      */
2106     uint16_t *conf_sigalgs;
2107     /* Size of above array */
2108     size_t conf_sigalgslen;
2109     /*
2110      * Client authentication signature algorithms, if not set then uses
2111      * conf_sigalgs. On servers these will be the signature algorithms sent
2112      * to the client in a certificate request for TLS 1.2. On a client this
2113      * represents the signature algorithms we are willing to use for client
2114      * authentication.
2115      */
2116     uint16_t *client_sigalgs;
2117     /* Size of above array */
2118     size_t client_sigalgslen;
2119     /*
2120      * Certificate setup callback: if set is called whenever a certificate
2121      * may be required (client or server). the callback can then examine any
2122      * appropriate parameters and setup any certificates required. This
2123      * allows advanced applications to select certificates on the fly: for
2124      * example based on supported signature algorithms or curves.
2125      */
2126     int (*cert_cb) (SSL *ssl, void *arg);
2127     void *cert_cb_arg;
2128     /*
2129      * Optional X509_STORE for chain building or certificate validation If
2130      * NULL the parent SSL_CTX store is used instead.
2131      */
2132     X509_STORE *chain_store;
2133     X509_STORE *verify_store;
2134     /* Custom extensions */
2135     custom_ext_methods custext;
2136     /* Security callback */
2137     int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
2138                    void *other, void *ex);
2139     /* Security level */
2140     int sec_level;
2141     void *sec_ex;
2142 # ifndef OPENSSL_NO_PSK
2143     /* If not NULL psk identity hint to use for servers */
2144     char *psk_identity_hint;
2145 # endif
2146     CRYPTO_REF_COUNT references;             /* >1 only if SSL_copy_session_id is used */
2147     CRYPTO_RWLOCK *lock;
2148 } CERT;
2149
2150 # define FP_ICC  (int (*)(const void *,const void *))
2151
2152 /*
2153  * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
2154  * of a mess of functions, but hell, think of it as an opaque structure :-)
2155  */
2156 typedef struct ssl3_enc_method {
2157     int (*setup_key_block) (SSL_CONNECTION *);
2158     int (*generate_master_secret) (SSL_CONNECTION *, unsigned char *,
2159                                    unsigned char *, size_t, size_t *);
2160     int (*change_cipher_state) (SSL_CONNECTION *, int);
2161     size_t (*final_finish_mac) (SSL_CONNECTION *, const char *, size_t,
2162                                 unsigned char *);
2163     const char *client_finished_label;
2164     size_t client_finished_label_len;
2165     const char *server_finished_label;
2166     size_t server_finished_label_len;
2167     int (*alert_value) (int);
2168     int (*export_keying_material) (SSL_CONNECTION *, unsigned char *, size_t,
2169                                    const char *, size_t,
2170                                    const unsigned char *, size_t,
2171                                    int use_context);
2172     /* Various flags indicating protocol version requirements */
2173     uint32_t enc_flags;
2174     /* Set the handshake header */
2175     int (*set_handshake_header) (SSL_CONNECTION *s, WPACKET *pkt, int type);
2176     /* Close construction of the handshake message */
2177     int (*close_construct_packet) (SSL_CONNECTION *s, WPACKET *pkt, int htype);
2178     /* Write out handshake message */
2179     int (*do_write) (SSL_CONNECTION *s);
2180 } SSL3_ENC_METHOD;
2181
2182 # define ssl_set_handshake_header(s, pkt, htype) \
2183     SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2184 # define ssl_close_construct_packet(s, pkt, htype) \
2185     SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2186 # define ssl_do_write(s)  SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->do_write(s)
2187
2188 /* Values for enc_flags */
2189
2190 /* Uses explicit IV for CBC mode */
2191 # define SSL_ENC_FLAG_EXPLICIT_IV        0x1
2192 /* Uses signature algorithms extension */
2193 # define SSL_ENC_FLAG_SIGALGS            0x2
2194 /* Uses SHA256 default PRF */
2195 # define SSL_ENC_FLAG_SHA256_PRF         0x4
2196 /* Is DTLS */
2197 # define SSL_ENC_FLAG_DTLS               0x8
2198 /*
2199  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2200  * apply to others in future.
2201  */
2202 # define SSL_ENC_FLAG_TLS1_2_CIPHERS     0x10
2203
2204 # ifndef OPENSSL_NO_COMP
2205 /* Used for holding the relevant compression methods loaded into SSL_CTX */
2206 typedef struct ssl3_comp_st {
2207     int comp_id;                /* The identifier byte for this compression
2208                                  * type */
2209     char *name;                 /* Text name used for the compression type */
2210     COMP_METHOD *method;        /* The method :-) */
2211 } SSL3_COMP;
2212 # endif
2213
2214 typedef enum downgrade_en {
2215     DOWNGRADE_NONE,
2216     DOWNGRADE_TO_1_2,
2217     DOWNGRADE_TO_1_1
2218 } DOWNGRADE;
2219
2220 /*
2221  * Dummy status type for the status_type extension. Indicates no status type
2222  * set
2223  */
2224 #define TLSEXT_STATUSTYPE_nothing  -1
2225
2226 /* Sigalgs values */
2227 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256                    0x0403
2228 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384                    0x0503
2229 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512                    0x0603
2230 #define TLSEXT_SIGALG_ecdsa_sha224                              0x0303
2231 #define TLSEXT_SIGALG_ecdsa_sha1                                0x0203
2232 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256                       0x0804
2233 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384                       0x0805
2234 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512                       0x0806
2235 #define TLSEXT_SIGALG_rsa_pss_pss_sha256                        0x0809
2236 #define TLSEXT_SIGALG_rsa_pss_pss_sha384                        0x080a
2237 #define TLSEXT_SIGALG_rsa_pss_pss_sha512                        0x080b
2238 #define TLSEXT_SIGALG_rsa_pkcs1_sha256                          0x0401
2239 #define TLSEXT_SIGALG_rsa_pkcs1_sha384                          0x0501
2240 #define TLSEXT_SIGALG_rsa_pkcs1_sha512                          0x0601
2241 #define TLSEXT_SIGALG_rsa_pkcs1_sha224                          0x0301
2242 #define TLSEXT_SIGALG_rsa_pkcs1_sha1                            0x0201
2243 #define TLSEXT_SIGALG_dsa_sha256                                0x0402
2244 #define TLSEXT_SIGALG_dsa_sha384                                0x0502
2245 #define TLSEXT_SIGALG_dsa_sha512                                0x0602
2246 #define TLSEXT_SIGALG_dsa_sha224                                0x0302
2247 #define TLSEXT_SIGALG_dsa_sha1                                  0x0202
2248 #define TLSEXT_SIGALG_gostr34102012_256_intrinsic               0x0840
2249 #define TLSEXT_SIGALG_gostr34102012_512_intrinsic               0x0841
2250 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256       0xeeee
2251 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512       0xefef
2252 #define TLSEXT_SIGALG_gostr34102001_gostr3411                   0xeded
2253
2254 #define TLSEXT_SIGALG_ed25519                                   0x0807
2255 #define TLSEXT_SIGALG_ed448                                     0x0808
2256 #define TLSEXT_SIGALG_ecdsa_brainpoolP256r1_sha256              0x081a
2257 #define TLSEXT_SIGALG_ecdsa_brainpoolP384r1_sha384              0x081b
2258 #define TLSEXT_SIGALG_ecdsa_brainpoolP512r1_sha512              0x081c
2259
2260 /* Known PSK key exchange modes */
2261 #define TLSEXT_KEX_MODE_KE                                      0x00
2262 #define TLSEXT_KEX_MODE_KE_DHE                                  0x01
2263
2264 /*
2265  * Internal representations of key exchange modes
2266  */
2267 #define TLSEXT_KEX_MODE_FLAG_NONE                               0
2268 #define TLSEXT_KEX_MODE_FLAG_KE                                 1
2269 #define TLSEXT_KEX_MODE_FLAG_KE_DHE                             2
2270
2271 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2272                         s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2273
2274 /* A dummy signature value not valid for TLSv1.2 signature algs */
2275 #define TLSEXT_signature_rsa_pss                                0x0101
2276
2277 /* TLSv1.3 downgrade protection sentinel values */
2278 extern const unsigned char tls11downgrade[8];
2279 extern const unsigned char tls12downgrade[8];
2280
2281 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2282
2283 __owur const SSL_METHOD *ssl_bad_method(int ver);
2284 __owur const SSL_METHOD *sslv3_method(void);
2285 __owur const SSL_METHOD *sslv3_server_method(void);
2286 __owur const SSL_METHOD *sslv3_client_method(void);
2287 __owur const SSL_METHOD *tlsv1_method(void);
2288 __owur const SSL_METHOD *tlsv1_server_method(void);
2289 __owur const SSL_METHOD *tlsv1_client_method(void);
2290 __owur const SSL_METHOD *tlsv1_1_method(void);
2291 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2292 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2293 __owur const SSL_METHOD *tlsv1_2_method(void);
2294 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2295 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2296 __owur const SSL_METHOD *tlsv1_3_method(void);
2297 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2298 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2299 __owur const SSL_METHOD *dtlsv1_method(void);
2300 __owur const SSL_METHOD *dtlsv1_server_method(void);
2301 __owur const SSL_METHOD *dtlsv1_client_method(void);
2302 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2303 __owur const SSL_METHOD *dtlsv1_2_method(void);
2304 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2305 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2306
2307 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2308 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2309 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2310 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2311 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2312 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2313 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2314
2315 /*
2316  * Flags for SSL methods
2317  */
2318 # define SSL_METHOD_NO_FIPS      (1U<<0)
2319 # define SSL_METHOD_NO_SUITEB    (1U<<1)
2320
2321 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2322                                  s_connect, enc_data) \
2323 const SSL_METHOD *func_name(void)  \
2324         { \
2325         static const SSL_METHOD func_name##_data= { \
2326                 version, \
2327                 flags, \
2328                 mask, \
2329                 ossl_ssl_connection_new, \
2330                 ossl_ssl_connection_free, \
2331                 ossl_ssl_connection_reset, \
2332                 tls1_new, \
2333                 tls1_clear, \
2334                 tls1_free, \
2335                 s_accept, \
2336                 s_connect, \
2337                 ssl3_read, \
2338                 ssl3_peek, \
2339                 ssl3_write, \
2340                 ssl3_shutdown, \
2341                 ssl3_renegotiate, \
2342                 ssl3_renegotiate_check, \
2343                 ssl3_read_bytes, \
2344                 ssl3_write_bytes, \
2345                 ssl3_dispatch_alert, \
2346                 ssl3_ctrl, \
2347                 ssl3_ctx_ctrl, \
2348                 ssl3_get_cipher_by_char, \
2349                 ssl3_put_cipher_by_char, \
2350                 ssl3_pending, \
2351                 ssl3_num_ciphers, \
2352                 ssl3_get_cipher, \
2353                 tls1_default_timeout, \
2354                 &enc_data, \
2355                 ssl_undefined_void_function, \
2356                 ssl3_callback_ctrl, \
2357                 ssl3_ctx_callback_ctrl, \
2358         }; \
2359         return &func_name##_data; \
2360         }
2361
2362 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2363 const SSL_METHOD *func_name(void)  \
2364         { \
2365         static const SSL_METHOD func_name##_data= { \
2366                 SSL3_VERSION, \
2367                 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2368                 SSL_OP_NO_SSLv3, \
2369                 ossl_ssl_connection_new, \
2370                 ossl_ssl_connection_free, \
2371                 ossl_ssl_connection_reset, \
2372                 ssl3_new, \
2373                 ssl3_clear, \
2374                 ssl3_free, \
2375                 s_accept, \
2376                 s_connect, \
2377                 ssl3_read, \
2378                 ssl3_peek, \
2379                 ssl3_write, \
2380                 ssl3_shutdown, \
2381                 ssl3_renegotiate, \
2382                 ssl3_renegotiate_check, \
2383                 ssl3_read_bytes, \
2384                 ssl3_write_bytes, \
2385                 ssl3_dispatch_alert, \
2386                 ssl3_ctrl, \
2387                 ssl3_ctx_ctrl, \
2388                 ssl3_get_cipher_by_char, \
2389                 ssl3_put_cipher_by_char, \
2390                 ssl3_pending, \
2391                 ssl3_num_ciphers, \
2392                 ssl3_get_cipher, \
2393                 ssl3_default_timeout, \
2394                 &SSLv3_enc_data, \
2395                 ssl_undefined_void_function, \
2396                 ssl3_callback_ctrl, \
2397                 ssl3_ctx_callback_ctrl, \
2398         }; \
2399         return &func_name##_data; \
2400         }
2401
2402 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2403                                         s_connect, enc_data) \
2404 const SSL_METHOD *func_name(void)  \
2405         { \
2406         static const SSL_METHOD func_name##_data= { \
2407                 version, \
2408                 flags, \
2409                 mask, \
2410                 ossl_ssl_connection_new, \
2411                 ossl_ssl_connection_free, \
2412                 ossl_ssl_connection_reset, \
2413                 dtls1_new, \
2414                 dtls1_clear, \
2415                 dtls1_free, \
2416                 s_accept, \
2417                 s_connect, \
2418                 ssl3_read, \
2419                 ssl3_peek, \
2420                 ssl3_write, \
2421                 dtls1_shutdown, \
2422                 ssl3_renegotiate, \
2423                 ssl3_renegotiate_check, \
2424                 dtls1_read_bytes, \
2425                 dtls1_write_app_data_bytes, \
2426                 dtls1_dispatch_alert, \
2427                 dtls1_ctrl, \
2428                 ssl3_ctx_ctrl, \
2429                 ssl3_get_cipher_by_char, \
2430                 ssl3_put_cipher_by_char, \
2431                 ssl3_pending, \
2432                 ssl3_num_ciphers, \
2433                 ssl3_get_cipher, \
2434                 dtls1_default_timeout, \
2435                 &enc_data, \
2436                 ssl_undefined_void_function, \
2437                 ssl3_callback_ctrl, \
2438                 ssl3_ctx_callback_ctrl, \
2439         }; \
2440         return &func_name##_data; \
2441         }
2442
2443 struct openssl_ssl_test_functions {
2444     int (*p_ssl_init_wbio_buffer) (SSL_CONNECTION *s);
2445 };
2446
2447 const char *ssl_protocol_to_string(int version);
2448
2449 /* Returns true if certificate and private key for 'idx' are present */
2450 static ossl_inline int ssl_has_cert(const SSL_CONNECTION *s, int idx)
2451 {
2452     if (idx < 0 || idx >= SSL_PKEY_NUM)
2453         return 0;
2454     return s->cert->pkeys[idx].x509 != NULL
2455         && s->cert->pkeys[idx].privatekey != NULL;
2456 }
2457
2458 static ossl_inline void tls1_get_peer_groups(SSL_CONNECTION *s,
2459                                              const uint16_t **pgroups,
2460                                              size_t *pgroupslen)
2461 {
2462     *pgroups = s->ext.peer_supportedgroups;
2463     *pgroupslen = s->ext.peer_supportedgroups_len;
2464 }
2465
2466 # ifndef OPENSSL_UNIT_TEST
2467
2468 __owur int ossl_ssl_init(SSL *ssl, SSL_CTX *ctx, int type);
2469 __owur SSL *ossl_ssl_connection_new(SSL_CTX *ctx);
2470 void ossl_ssl_connection_free(SSL *ssl);
2471 __owur int ossl_ssl_connection_reset(SSL *ssl);
2472
2473 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2474 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2475 int ssl_clear_bad_session(SSL_CONNECTION *s);
2476 __owur CERT *ssl_cert_new(void);
2477 __owur CERT *ssl_cert_dup(CERT *cert);
2478 void ssl_cert_clear_certs(CERT *c);
2479 void ssl_cert_free(CERT *c);
2480 __owur int ssl_generate_session_id(SSL_CONNECTION *s, SSL_SESSION *ss);
2481 __owur int ssl_get_new_session(SSL_CONNECTION *s, int session);
2482 __owur SSL_SESSION *lookup_sess_in_cache(SSL_CONNECTION *s,
2483                                          const unsigned char *sess_id,
2484                                          size_t sess_id_len);
2485 __owur int ssl_get_prev_session(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello);
2486 __owur SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket);
2487 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2488 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2489 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2490                                  const SSL_CIPHER *const *bp);
2491 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(SSL_CTX *ctx,
2492                                                     STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2493                                                     STACK_OF(SSL_CIPHER) **cipher_list,
2494                                                     STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2495                                                     const char *rule_str,
2496                                                     CERT *c);
2497 __owur int ssl_cache_cipherlist(SSL_CONNECTION *s, PACKET *cipher_suites,
2498                                 int sslv2format);
2499 __owur int ossl_bytes_to_cipher_list(SSL_CONNECTION *s, PACKET *cipher_suites,
2500                                      STACK_OF(SSL_CIPHER) **skp,
2501                                      STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2502                                      int fatal);
2503 void ssl_update_cache(SSL_CONNECTION *s, int mode);
2504 __owur int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
2505                                      const EVP_CIPHER **enc);
2506 __owur int ssl_cipher_get_evp(SSL_CTX *ctxc, const SSL_SESSION *s,
2507                               const EVP_CIPHER **enc, const EVP_MD **md,
2508                               int *mac_pkey_type, size_t *mac_secret_size,
2509                               SSL_COMP **comp, int use_etm);
2510 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2511                                    size_t *int_overhead, size_t *blocksize,
2512                                    size_t *ext_overhead);
2513 __owur int ssl_cert_is_disabled(SSL_CTX *ctx, size_t idx);
2514 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL_CONNECTION *ssl,
2515                                                 const unsigned char *ptr,
2516                                                 int all);
2517 __owur int ssl_cert_set0_chain(SSL_CONNECTION *s, SSL_CTX *ctx,
2518                                STACK_OF(X509) *chain);
2519 __owur int ssl_cert_set1_chain(SSL_CONNECTION *s, SSL_CTX *ctx,
2520                                STACK_OF(X509) *chain);
2521 __owur int ssl_cert_add0_chain_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x);
2522 __owur int ssl_cert_add1_chain_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x);
2523 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2524 __owur int ssl_cert_set_current(CERT *c, long arg);
2525 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2526
2527 __owur int ssl_verify_cert_chain(SSL_CONNECTION *s, STACK_OF(X509) *sk);
2528 __owur int ssl_build_cert_chain(SSL_CONNECTION *s, SSL_CTX *ctx, int flags);
2529 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2530                                    int ref);
2531 __owur int ssl_cert_get_cert_store(CERT *c, X509_STORE **pstore, int chain);
2532
2533 __owur int ssl_security(const SSL_CONNECTION *s, int op, int bits, int nid,
2534                         void *other);
2535 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2536                             void *other);
2537 int ssl_get_security_level_bits(const SSL *s, const SSL_CTX *ctx, int *levelp);
2538
2539 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx);
2540 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2541                                                       size_t *pidx);
2542 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2543
2544 int ssl_undefined_function(SSL *s);
2545 __owur int ssl_undefined_void_function(void);
2546 __owur int ssl_undefined_const_function(const SSL *s);
2547 __owur int ssl_get_server_cert_serverinfo(SSL_CONNECTION *s,
2548                                           const unsigned char **serverinfo,
2549                                           size_t *serverinfo_length);
2550 void ssl_set_masks(SSL_CONNECTION *s);
2551 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL_CONNECTION *sc);
2552 __owur int ssl_x509err2alert(int type);
2553 void ssl_sort_cipher_list(void);
2554 int ssl_load_ciphers(SSL_CTX *ctx);
2555 __owur int ssl_setup_sig_algs(SSL_CTX *ctx);
2556 int ssl_load_groups(SSL_CTX *ctx);
2557 __owur int ssl_fill_hello_random(SSL_CONNECTION *s, int server,
2558                                  unsigned char *field, size_t len,
2559                                  DOWNGRADE dgrd);
2560 __owur int ssl_generate_master_secret(SSL_CONNECTION *s, unsigned char *pms,
2561                                       size_t pmslen, int free_pms);
2562 __owur EVP_PKEY *ssl_generate_pkey(SSL_CONNECTION *s, EVP_PKEY *pm);
2563 __owur int ssl_gensecret(SSL_CONNECTION *s, unsigned char *pms, size_t pmslen);
2564 __owur int ssl_derive(SSL_CONNECTION *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2565                       int genmaster);
2566 __owur int ssl_decapsulate(SSL_CONNECTION *s, EVP_PKEY *privkey,
2567                            const unsigned char *ct, size_t ctlen,
2568                            int gensecret);
2569 __owur int ssl_encapsulate(SSL_CONNECTION *s, EVP_PKEY *pubkey,
2570                            unsigned char **ctp, size_t *ctlenp,
2571                            int gensecret);
2572 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2573 __owur int ssl_set_tmp_ecdh_groups(uint16_t **pext, size_t *pextlen,
2574                                    void *key);
2575 __owur unsigned int ssl_get_max_send_fragment(const SSL_CONNECTION *sc);
2576 __owur unsigned int ssl_get_split_send_fragment(const SSL_CONNECTION *sc);
2577
2578 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2579 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2580 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2581 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2582                                    size_t *len);
2583 int ssl3_init_finished_mac(SSL_CONNECTION *s);
2584 __owur int ssl3_setup_key_block(SSL_CONNECTION *s);
2585 __owur int ssl3_change_cipher_state(SSL_CONNECTION *s, int which);
2586 void ssl3_cleanup_key_block(SSL_CONNECTION *s);
2587 __owur int ssl3_do_write(SSL_CONNECTION *s, int type);
2588 int ssl3_send_alert(SSL_CONNECTION *s, int level, int desc);
2589 __owur int ssl3_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2590                                        unsigned char *p, size_t len,
2591                                        size_t *secret_size);
2592 __owur int ssl3_get_req_cert_type(SSL_CONNECTION *s, WPACKET *pkt);
2593 __owur int ssl3_num_ciphers(void);
2594 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2595 int ssl3_renegotiate(SSL *ssl);
2596 int ssl3_renegotiate_check(SSL *ssl, int initok);
2597 void ssl3_digest_master_key_set_params(const SSL_SESSION *session,
2598                                        OSSL_PARAM params[]);
2599 __owur int ssl3_dispatch_alert(SSL *s);
2600 __owur size_t ssl3_final_finish_mac(SSL_CONNECTION *s, const char *sender,
2601                                     size_t slen, unsigned char *p);
2602 __owur int ssl3_finish_mac(SSL_CONNECTION *s, const unsigned char *buf,
2603                            size_t len);
2604 void ssl3_free_digest_list(SSL_CONNECTION *s);
2605 __owur unsigned long ssl3_output_cert_chain(SSL_CONNECTION *s, WPACKET *pkt,
2606                                             CERT_PKEY *cpk, int for_comp);
2607 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL_CONNECTION *s,
2608                                             STACK_OF(SSL_CIPHER) *clnt,
2609                                             STACK_OF(SSL_CIPHER) *srvr);
2610 __owur int ssl3_digest_cached_records(SSL_CONNECTION *s, int keep);
2611 __owur int ssl3_new(SSL *s);
2612 void ssl3_free(SSL *s);
2613 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2614 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2615 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2616 __owur int ssl3_shutdown(SSL *s);
2617 int ssl3_clear(SSL *s);
2618 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2619 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2620 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2621 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2622
2623 __owur int ssl3_do_change_cipher_spec(SSL_CONNECTION *s);
2624 __owur OSSL_TIME ssl3_default_timeout(void);
2625
2626 __owur int ssl3_set_handshake_header(SSL_CONNECTION *s, WPACKET *pkt,
2627                                      int htype);
2628 __owur int tls_close_construct_packet(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2629 __owur int tls_setup_handshake(SSL_CONNECTION *s);
2630 __owur int dtls1_set_handshake_header(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2631 __owur int dtls1_close_construct_packet(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2632 __owur int ssl3_handshake_write(SSL_CONNECTION *s);
2633
2634 __owur int ssl_allow_compression(SSL_CONNECTION *s);
2635
2636 __owur int ssl_version_supported(const SSL_CONNECTION *s, int version,
2637                                  const SSL_METHOD **meth);
2638
2639 __owur int ssl_set_client_hello_version(SSL_CONNECTION *s);
2640 __owur int ssl_check_version_downgrade(SSL_CONNECTION *s);
2641 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2642 __owur int ssl_choose_server_version(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello,
2643                                      DOWNGRADE *dgrd);
2644 __owur int ssl_choose_client_version(SSL_CONNECTION *s, int version,
2645                                      RAW_EXTENSION *extensions);
2646 __owur int ssl_get_min_max_version(const SSL_CONNECTION *s, int *min_version,
2647                                    int *max_version, int *real_max);
2648
2649 __owur OSSL_TIME tls1_default_timeout(void);
2650 __owur int dtls1_do_write(SSL_CONNECTION *s, int type);
2651 void dtls1_set_message_header(SSL_CONNECTION *s,
2652                               unsigned char mt,
2653                               size_t len,
2654                               size_t frag_off, size_t frag_len);
2655
2656 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2657                                size_t *written);
2658
2659 __owur int dtls1_read_failed(SSL_CONNECTION *s, int code);
2660 __owur int dtls1_buffer_message(SSL_CONNECTION *s, int ccs);
2661 __owur int dtls1_retransmit_message(SSL_CONNECTION *s, unsigned short seq,
2662                                     int *found);
2663 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2664 int dtls1_retransmit_buffered_messages(SSL_CONNECTION *s);
2665 void dtls1_clear_received_buffer(SSL_CONNECTION *s);
2666 void dtls1_clear_sent_buffer(SSL_CONNECTION *s);
2667 void dtls1_get_message_header(unsigned char *data,
2668                               struct hm_header_st *msg_hdr);
2669 __owur OSSL_TIME dtls1_default_timeout(void);
2670 __owur OSSL_TIME *dtls1_get_timeout(SSL_CONNECTION *s, OSSL_TIME *timeleft);
2671 __owur int dtls1_check_timeout_num(SSL_CONNECTION *s);
2672 __owur int dtls1_handle_timeout(SSL_CONNECTION *s);
2673 void dtls1_start_timer(SSL_CONNECTION *s);
2674 void dtls1_stop_timer(SSL_CONNECTION *s);
2675 __owur int dtls1_is_timer_expired(SSL_CONNECTION *s);
2676 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2677                                          size_t cookie_len);
2678 __owur size_t dtls1_min_mtu(SSL_CONNECTION *s);
2679 void dtls1_hm_fragment_free(hm_fragment *frag);
2680 __owur int dtls1_query_mtu(SSL_CONNECTION *s);
2681
2682 __owur int tls1_new(SSL *s);
2683 void tls1_free(SSL *s);
2684 int tls1_clear(SSL *s);
2685
2686 __owur int dtls1_new(SSL *s);
2687 void dtls1_free(SSL *s);
2688 int dtls1_clear(SSL *s);
2689 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2690 __owur int dtls1_shutdown(SSL *s);
2691
2692 __owur int dtls1_dispatch_alert(SSL *s);
2693
2694 __owur int ssl_init_wbio_buffer(SSL_CONNECTION *s);
2695 int ssl_free_wbio_buffer(SSL_CONNECTION *s);
2696
2697 __owur int tls1_change_cipher_state(SSL_CONNECTION *s, int which);
2698 __owur int tls1_setup_key_block(SSL_CONNECTION *s);
2699 __owur size_t tls1_final_finish_mac(SSL_CONNECTION *s, const char *str,
2700                                     size_t slen, unsigned char *p);
2701 __owur int tls1_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2702                                        unsigned char *p, size_t len,
2703                                        size_t *secret_size);
2704 __owur int tls13_setup_key_block(SSL_CONNECTION *s);
2705 __owur size_t tls13_final_finish_mac(SSL_CONNECTION *s, const char *str, size_t slen,
2706                                      unsigned char *p);
2707 __owur int tls13_change_cipher_state(SSL_CONNECTION *s, int which);
2708 __owur int tls13_update_key(SSL_CONNECTION *s, int send);
2709 __owur int tls13_hkdf_expand(SSL_CONNECTION *s,
2710                              const EVP_MD *md,
2711                              const unsigned char *secret,
2712                              const unsigned char *label, size_t labellen,
2713                              const unsigned char *data, size_t datalen,
2714                              unsigned char *out, size_t outlen, int fatal);
2715 __owur int tls13_hkdf_expand_ex(OSSL_LIB_CTX *libctx, const char *propq,
2716                                 const EVP_MD *md,
2717                                 const unsigned char *secret,
2718                                 const unsigned char *label, size_t labellen,
2719                                 const unsigned char *data, size_t datalen,
2720                                 unsigned char *out, size_t outlen,
2721                                 int raise_error);
2722 __owur int tls13_derive_key(SSL_CONNECTION *s, const EVP_MD *md,
2723                             const unsigned char *secret, unsigned char *key,
2724                             size_t keylen);
2725 __owur int tls13_derive_iv(SSL_CONNECTION *s, const EVP_MD *md,
2726                            const unsigned char *secret, unsigned char *iv,
2727                            size_t ivlen);
2728 __owur int tls13_derive_finishedkey(SSL_CONNECTION *s, const EVP_MD *md,
2729                                     const unsigned char *secret,
2730                                     unsigned char *fin, size_t finlen);
2731 int tls13_generate_secret(SSL_CONNECTION *s, const EVP_MD *md,
2732                           const unsigned char *prevsecret,
2733                           const unsigned char *insecret,
2734                           size_t insecretlen,
2735                           unsigned char *outsecret);
2736 __owur int tls13_generate_handshake_secret(SSL_CONNECTION *s,
2737                                            const unsigned char *insecret,
2738                                            size_t insecretlen);
2739 __owur int tls13_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2740                                         unsigned char *prev, size_t prevlen,
2741                                         size_t *secret_size);
2742 __owur int tls1_export_keying_material(SSL_CONNECTION *s,
2743                                        unsigned char *out, size_t olen,
2744                                        const char *label, size_t llen,
2745                                        const unsigned char *p, size_t plen,
2746                                        int use_context);
2747 __owur int tls13_export_keying_material(SSL_CONNECTION *s,
2748                                         unsigned char *out, size_t olen,
2749                                         const char *label, size_t llen,
2750                                         const unsigned char *context,
2751                                         size_t contextlen, int use_context);
2752 __owur int tls13_export_keying_material_early(SSL_CONNECTION *s,
2753                                               unsigned char *out, size_t olen,
2754                                               const char *label, size_t llen,
2755                                               const unsigned char *context,
2756                                               size_t contextlen);
2757 __owur int tls1_alert_code(int code);
2758 __owur int tls13_alert_code(int code);
2759 __owur int ssl3_alert_code(int code);
2760
2761 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL_CONNECTION *s);
2762
2763 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2764
2765 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(SSL_CTX *ctx, uint16_t curve_id);
2766 __owur int tls1_group_id2nid(uint16_t group_id, int include_unknown);
2767 __owur uint16_t tls1_nid2group_id(int nid);
2768 __owur int tls1_check_group_id(SSL_CONNECTION *s, uint16_t group_id,
2769                                int check_own_curves);
2770 __owur uint16_t tls1_shared_group(SSL_CONNECTION *s, int nmatch);
2771 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2772                            int *curves, size_t ncurves);
2773 __owur int tls1_set_groups_list(SSL_CTX *ctx, uint16_t **pext, size_t *pextlen,
2774                                 const char *str);
2775 __owur EVP_PKEY *ssl_generate_pkey_group(SSL_CONNECTION *s, uint16_t id);
2776 __owur int tls_valid_group(SSL_CONNECTION *s, uint16_t group_id, int minversion,
2777                            int maxversion, int isec, int *okfortls13);
2778 __owur EVP_PKEY *ssl_generate_param_group(SSL_CONNECTION *s, uint16_t id);
2779 void tls1_get_formatlist(SSL_CONNECTION *s, const unsigned char **pformats,
2780                          size_t *num_formats);
2781 __owur int tls1_check_ec_tmp_key(SSL_CONNECTION *s, unsigned long id);
2782
2783 __owur int tls_group_allowed(SSL_CONNECTION *s, uint16_t curve, int op);
2784 void tls1_get_supported_groups(SSL_CONNECTION *s, const uint16_t **pgroups,
2785                                size_t *pgroupslen);
2786
2787 __owur int tls1_set_server_sigalgs(SSL_CONNECTION *s);
2788
2789 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL_CONNECTION *s,
2790                                                     CLIENTHELLO_MSG *hello,
2791                                                     SSL_SESSION **ret);
2792 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL_CONNECTION *s,
2793                                             const unsigned char *etick,
2794                                             size_t eticklen,
2795                                             const unsigned char *sess_id,
2796                                             size_t sesslen, SSL_SESSION **psess);
2797
2798 __owur int tls_use_ticket(SSL_CONNECTION *s);
2799
2800 void ssl_set_sig_mask(uint32_t *pmask_a, SSL_CONNECTION *s, int op);
2801
2802 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2803 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2804                                 int client);
2805 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2806                             int client);
2807 int tls1_check_chain(SSL_CONNECTION *s, X509 *x, EVP_PKEY *pk,
2808                      STACK_OF(X509) *chain, int idx);
2809 void tls1_set_cert_validity(SSL_CONNECTION *s);
2810
2811 #  ifndef OPENSSL_NO_CT
2812 __owur int ssl_validate_ct(SSL_CONNECTION *s);
2813 #  endif
2814
2815 __owur EVP_PKEY *ssl_get_auto_dh(SSL_CONNECTION *s);
2816
2817 __owur int ssl_security_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x, int vfy,
2818                              int is_ee);
2819 __owur int ssl_security_cert_chain(SSL_CONNECTION *s, STACK_OF(X509) *sk,
2820                                    X509 *ex, int vfy);
2821
2822 int tls_choose_sigalg(SSL_CONNECTION *s, int fatalerrs);
2823
2824 __owur long ssl_get_algorithm2(SSL_CONNECTION *s);
2825 __owur int tls12_copy_sigalgs(SSL_CONNECTION *s, WPACKET *pkt,
2826                               const uint16_t *psig, size_t psiglen);
2827 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2828 __owur int tls1_save_sigalgs(SSL_CONNECTION *s, PACKET *pkt, int cert);
2829 __owur int tls1_process_sigalgs(SSL_CONNECTION *s);
2830 __owur int tls1_set_peer_legacy_sigalg(SSL_CONNECTION *s, const EVP_PKEY *pkey);
2831 __owur int tls1_lookup_md(SSL_CTX *ctx, const SIGALG_LOOKUP *lu,
2832                           const EVP_MD **pmd);
2833 __owur size_t tls12_get_psigalgs(SSL_CONNECTION *s, int sent,
2834                                  const uint16_t **psigs);
2835 __owur int tls_check_sigalg_curve(const SSL_CONNECTION *s, int curve);
2836 __owur int tls12_check_peer_sigalg(SSL_CONNECTION *s, uint16_t, EVP_PKEY *pkey);
2837 __owur int ssl_set_client_disabled(SSL_CONNECTION *s);
2838 __owur int ssl_cipher_disabled(const SSL_CONNECTION *s, const SSL_CIPHER *c,
2839                                int op, int echde);
2840
2841 __owur int ssl_handshake_hash(SSL_CONNECTION *s,
2842                               unsigned char *out, size_t outlen,
2843                               size_t *hashlen);
2844 __owur const EVP_MD *ssl_md(SSL_CTX *ctx, int idx);
2845 __owur const EVP_MD *ssl_handshake_md(SSL_CONNECTION *s);
2846 __owur const EVP_MD *ssl_prf_md(SSL_CONNECTION *s);
2847
2848 /*
2849  * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2850  * with |ssl|, if logging is enabled. It returns one on success and zero on
2851  * failure. The entry is identified by the first 8 bytes of
2852  * |encrypted_premaster|.
2853  */
2854 __owur int ssl_log_rsa_client_key_exchange(SSL_CONNECTION *s,
2855                                            const uint8_t *encrypted_premaster,
2856                                            size_t encrypted_premaster_len,
2857                                            const uint8_t *premaster,
2858                                            size_t premaster_len);
2859
2860 /*
2861  * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2862  * logging is available. It returns one on success and zero on failure. It tags
2863  * the entry with |label|.
2864  */
2865 __owur int ssl_log_secret(SSL_CONNECTION *s, const char *label,
2866                           const uint8_t *secret, size_t secret_len);
2867
2868 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2869 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2870 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2871 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2872 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2873 #define CLIENT_APPLICATION_N_LABEL "CLIENT_TRAFFIC_SECRET_N"
2874 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2875 #define SERVER_APPLICATION_N_LABEL "SERVER_TRAFFIC_SECRET_N"
2876 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2877 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2878
2879 __owur int srp_generate_server_master_secret(SSL_CONNECTION *s);
2880 __owur int srp_generate_client_master_secret(SSL_CONNECTION *s);
2881 __owur int srp_verify_server_param(SSL_CONNECTION *s);
2882
2883 /* statem/statem_srvr.c */
2884
2885 __owur int send_certificate_request(SSL_CONNECTION *s);
2886
2887 /* statem/extensions_cust.c */
2888
2889 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2890                                    ENDPOINT role, unsigned int ext_type,
2891                                    size_t *idx);
2892
2893 void custom_ext_init(custom_ext_methods *meths);
2894
2895 __owur int custom_ext_parse(SSL_CONNECTION *s, unsigned int context,
2896                             unsigned int ext_type,
2897                             const unsigned char *ext_data, size_t ext_size,
2898                             X509 *x, size_t chainidx);
2899 __owur int custom_ext_add(SSL_CONNECTION *s, int context, WPACKET *pkt, X509 *x,
2900                           size_t chainidx, int maxversion);
2901
2902 __owur int custom_exts_copy(custom_ext_methods *dst,
2903                             const custom_ext_methods *src);
2904 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2905                                   const custom_ext_methods *src);
2906 void custom_exts_free(custom_ext_methods *exts);
2907
2908 void ssl_comp_free_compression_methods_int(void);
2909
2910 /* ssl_mcnf.c */
2911 void ssl_ctx_system_config(SSL_CTX *ctx);
2912
2913 const EVP_CIPHER *ssl_evp_cipher_fetch(OSSL_LIB_CTX *libctx,
2914                                        int nid,
2915                                        const char *properties);
2916 int ssl_evp_cipher_up_ref(const EVP_CIPHER *cipher);
2917 void ssl_evp_cipher_free(const EVP_CIPHER *cipher);
2918 const EVP_MD *ssl_evp_md_fetch(OSSL_LIB_CTX *libctx,
2919                                int nid,
2920                                const char *properties);
2921 int ssl_evp_md_up_ref(const EVP_MD *md);
2922 void ssl_evp_md_free(const EVP_MD *md);
2923
2924 int tls_provider_set_tls_params(SSL_CONNECTION *s, EVP_CIPHER_CTX *ctx,
2925                                 const EVP_CIPHER *ciph,
2926                                 const EVP_MD *md);
2927
2928 void tls_engine_finish(ENGINE *e);
2929 const EVP_CIPHER *tls_get_cipher_from_engine(int nid);
2930 const EVP_MD *tls_get_digest_from_engine(int nid);
2931 int tls_engine_load_ssl_client_cert(SSL_CONNECTION *s, X509 **px509,
2932                                     EVP_PKEY **ppkey);
2933 int ssl_hmac_old_new(SSL_HMAC *ret);
2934 void ssl_hmac_old_free(SSL_HMAC *ctx);
2935 int ssl_hmac_old_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
2936 int ssl_hmac_old_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
2937 int ssl_hmac_old_final(SSL_HMAC *ctx, unsigned char *md, size_t *len);
2938 size_t ssl_hmac_old_size(const SSL_HMAC *ctx);
2939
2940 int ssl_ctx_srp_ctx_free_intern(SSL_CTX *ctx);
2941 int ssl_ctx_srp_ctx_init_intern(SSL_CTX *ctx);
2942 int ssl_srp_ctx_free_intern(SSL_CONNECTION *s);
2943 int ssl_srp_ctx_init_intern(SSL_CONNECTION *s);
2944
2945 int ssl_srp_calc_a_param_intern(SSL_CONNECTION *s);
2946 int ssl_srp_server_param_with_username_intern(SSL_CONNECTION *s, int *ad);
2947
2948 void ssl_session_calculate_timeout(SSL_SESSION *ss);
2949
2950 # else /* OPENSSL_UNIT_TEST */
2951
2952 #  define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2953
2954 # endif
2955
2956 /* Some helper routines to support TSAN operations safely */
2957 static ossl_unused ossl_inline int ssl_tsan_lock(const SSL_CTX *ctx)
2958 {
2959 #ifdef TSAN_REQUIRES_LOCKING
2960     if (!CRYPTO_THREAD_write_lock(ctx->tsan_lock))
2961         return 0;
2962 #endif
2963     return 1;
2964 }
2965
2966 static ossl_unused ossl_inline void ssl_tsan_unlock(const SSL_CTX *ctx)
2967 {
2968 #ifdef TSAN_REQUIRES_LOCKING
2969     CRYPTO_THREAD_unlock(ctx->tsan_lock);
2970 #endif
2971 }
2972
2973 static ossl_unused ossl_inline void ssl_tsan_counter(const SSL_CTX *ctx,
2974                                                      TSAN_QUALIFIER int *stat)
2975 {
2976     if (ssl_tsan_lock(ctx)) {
2977         tsan_counter(stat);
2978         ssl_tsan_unlock(ctx);
2979     }
2980 }
2981
2982 int ossl_comp_has_alg(int a);
2983 size_t ossl_calculate_comp_expansion(int alg, size_t length);
2984
2985 #endif