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