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