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