ssl/ssl_local.h

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