ssl/ssl_locl.h

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