ssl/ssl_locl.h

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