ssl/ssl_locl.h

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