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