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