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