ssl/ssl_locl.h

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