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