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