ssl/ssl_locl.h

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