ssl/ssl_locl.h

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