ssl/ssl_local.h

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