ssl/ssl_local.h

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