ssl/ssl_local.h

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