2 * Copyright 1995-2023 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.
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
12 #ifndef OSSL_SSL_LOCAL_H
13 # define OSSL_SSL_LOCAL_H
15 # include "internal/e_os.h" /* struct timeval for DTLS */
19 # include "internal/common.h" /* for HAS_PREFIX */
21 # include <openssl/buffer.h>
22 # include <openssl/bio.h>
23 # include <openssl/comp.h>
24 # include <openssl/dsa.h>
25 # include <openssl/err.h>
26 # include <openssl/ssl.h>
27 # include <openssl/async.h>
28 # include <openssl/symhacks.h>
29 # include <openssl/ct.h>
30 # include "internal/recordmethod.h"
31 # include "internal/statem.h"
32 # include "internal/packet.h"
33 # include "internal/dane.h"
34 # include "internal/refcount.h"
35 # include "internal/tsan_assist.h"
36 # include "internal/bio.h"
37 # include "internal/ktls.h"
38 # include "internal/time.h"
39 # include "internal/ssl.h"
40 # include "record/record.h"
42 # ifdef OPENSSL_BUILD_SHLIBSSL
43 # undef OPENSSL_EXTERN
44 # define OPENSSL_EXTERN OPENSSL_EXPORT
47 # define TLS_MAX_VERSION_INTERNAL TLS1_3_VERSION
48 # define DTLS_MAX_VERSION_INTERNAL DTLS1_2_VERSION
51 * DTLS version numbers are strange because they're inverted. Except for
52 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
54 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
55 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
56 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
57 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
58 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
60 # define SSL_AD_NO_ALERT -1
63 * Define the Bitmasks for SSL_CIPHER.algorithms.
64 * This bits are used packed as dense as possible. If new methods/ciphers
65 * etc will be added, the bits a likely to change, so this information
66 * is for internal library use only, even though SSL_CIPHER.algorithms
67 * can be publicly accessed.
68 * Use the according functions for cipher management instead.
70 * The bit mask handling in the selection and sorting scheme in
71 * ssl_create_cipher_list() has only limited capabilities, reflecting
72 * that the different entities within are mutually exclusive:
73 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
76 /* Bits for algorithm_mkey (key exchange algorithm) */
77 /* RSA key exchange */
78 # define SSL_kRSA 0x00000001U
79 /* tmp DH key no DH cert */
80 # define SSL_kDHE 0x00000002U
82 # define SSL_kEDH SSL_kDHE
84 # define SSL_kECDHE 0x00000004U
86 # define SSL_kEECDH SSL_kECDHE
88 # define SSL_kPSK 0x00000008U
89 /* GOST key exchange */
90 # define SSL_kGOST 0x00000010U
92 # define SSL_kSRP 0x00000020U
94 # define SSL_kRSAPSK 0x00000040U
95 # define SSL_kECDHEPSK 0x00000080U
96 # define SSL_kDHEPSK 0x00000100U
97 /* GOST KDF key exchange, draft-smyshlyaev-tls12-gost-suites */
98 # define SSL_kGOST18 0x00000200U
102 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
104 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
105 # define SSL_kANY 0x00000000U
107 /* Bits for algorithm_auth (server authentication) */
109 # define SSL_aRSA 0x00000001U
111 # define SSL_aDSS 0x00000002U
112 /* no auth (i.e. use ADH or AECDH) */
113 # define SSL_aNULL 0x00000004U
115 # define SSL_aECDSA 0x00000008U
117 # define SSL_aPSK 0x00000010U
118 /* GOST R 34.10-2001 signature auth */
119 # define SSL_aGOST01 0x00000020U
121 # define SSL_aSRP 0x00000040U
122 /* GOST R 34.10-2012 signature auth */
123 # define SSL_aGOST12 0x00000080U
124 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
125 # define SSL_aANY 0x00000000U
126 /* All bits requiring a certificate */
128 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
130 /* Bits for algorithm_enc (symmetric encryption) */
131 # define SSL_DES 0x00000001U
132 # define SSL_3DES 0x00000002U
133 # define SSL_RC4 0x00000004U
134 # define SSL_RC2 0x00000008U
135 # define SSL_IDEA 0x00000010U
136 # define SSL_eNULL 0x00000020U
137 # define SSL_AES128 0x00000040U
138 # define SSL_AES256 0x00000080U
139 # define SSL_CAMELLIA128 0x00000100U
140 # define SSL_CAMELLIA256 0x00000200U
141 # define SSL_eGOST2814789CNT 0x00000400U
142 # define SSL_SEED 0x00000800U
143 # define SSL_AES128GCM 0x00001000U
144 # define SSL_AES256GCM 0x00002000U
145 # define SSL_AES128CCM 0x00004000U
146 # define SSL_AES256CCM 0x00008000U
147 # define SSL_AES128CCM8 0x00010000U
148 # define SSL_AES256CCM8 0x00020000U
149 # define SSL_eGOST2814789CNT12 0x00040000U
150 # define SSL_CHACHA20POLY1305 0x00080000U
151 # define SSL_ARIA128GCM 0x00100000U
152 # define SSL_ARIA256GCM 0x00200000U
153 # define SSL_MAGMA 0x00400000U
154 # define SSL_KUZNYECHIK 0x00800000U
156 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
157 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
158 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
159 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
160 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
161 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
162 # define SSL_ARIA (SSL_ARIAGCM)
163 # define SSL_CBC (SSL_DES | SSL_3DES | SSL_RC2 | SSL_IDEA \
164 | SSL_AES128 | SSL_AES256 | SSL_CAMELLIA128 \
165 | SSL_CAMELLIA256 | SSL_SEED)
167 /* Bits for algorithm_mac (symmetric authentication) */
169 # define SSL_MD5 0x00000001U
170 # define SSL_SHA1 0x00000002U
171 # define SSL_GOST94 0x00000004U
172 # define SSL_GOST89MAC 0x00000008U
173 # define SSL_SHA256 0x00000010U
174 # define SSL_SHA384 0x00000020U
175 /* Not a real MAC, just an indication it is part of cipher */
176 # define SSL_AEAD 0x00000040U
177 # define SSL_GOST12_256 0x00000080U
178 # define SSL_GOST89MAC12 0x00000100U
179 # define SSL_GOST12_512 0x00000200U
180 # define SSL_MAGMAOMAC 0x00000400U
181 # define SSL_KUZNYECHIKOMAC 0x00000800U
184 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
185 * sure to update this constant too
188 # define SSL_MD_MD5_IDX 0
189 # define SSL_MD_SHA1_IDX 1
190 # define SSL_MD_GOST94_IDX 2
191 # define SSL_MD_GOST89MAC_IDX 3
192 # define SSL_MD_SHA256_IDX 4
193 # define SSL_MD_SHA384_IDX 5
194 # define SSL_MD_GOST12_256_IDX 6
195 # define SSL_MD_GOST89MAC12_IDX 7
196 # define SSL_MD_GOST12_512_IDX 8
197 # define SSL_MD_MD5_SHA1_IDX 9
198 # define SSL_MD_SHA224_IDX 10
199 # define SSL_MD_SHA512_IDX 11
200 # define SSL_MD_MAGMAOMAC_IDX 12
201 # define SSL_MD_KUZNYECHIKOMAC_IDX 13
202 # define SSL_MAX_DIGEST 14
204 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
206 /* Bits for algorithm2 (handshake digests and other extra flags) */
208 /* Bits 0-7 are handshake MAC */
209 # define SSL_HANDSHAKE_MAC_MASK 0xFF
210 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
211 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
212 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
213 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
214 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
215 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
216 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
218 /* Bits 8-15 bits are PRF */
219 # define TLS1_PRF_DGST_SHIFT 8
220 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
221 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
222 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
223 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
224 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
225 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
226 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
229 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
230 * goes into algorithm2)
232 # define TLS1_STREAM_MAC 0x10000
234 * TLSTREE cipher/mac key derivation from draft-smyshlyaev-tls12-gost-suites
235 * (currently this also goes into algorithm2)
237 # define TLS1_TLSTREE 0x20000
239 /* Ciphersuite supported in QUIC */
240 # define SSL_QUIC 0x00040000U
242 # define SSL_STRONG_MASK 0x0000001FU
243 # define SSL_DEFAULT_MASK 0X00000020U
245 # define SSL_STRONG_NONE 0x00000001U
246 # define SSL_LOW 0x00000002U
247 # define SSL_MEDIUM 0x00000004U
248 # define SSL_HIGH 0x00000008U
249 # define SSL_FIPS 0x00000010U
250 # define SSL_NOT_DEFAULT 0x00000020U
252 /* we have used 0000003f - 26 bits left to go */
254 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
255 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
257 /* Check if an SSL structure is using DTLS */
258 # define SSL_CONNECTION_IS_DTLS(s) \
259 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
261 /* Check if we are using TLSv1.3 */
262 # define SSL_CONNECTION_IS_TLS13(s) (!SSL_CONNECTION_IS_DTLS(s) \
263 && SSL_CONNECTION_GET_SSL(s)->method->version >= TLS1_3_VERSION \
264 && SSL_CONNECTION_GET_SSL(s)->method->version != TLS_ANY_VERSION)
266 # define SSL_CONNECTION_TREAT_AS_TLS13(s) \
267 (SSL_CONNECTION_IS_TLS13(s) \
268 || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
269 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
270 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
271 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
272 || (s)->hello_retry_request == SSL_HRR_PENDING)
274 # define SSL_IS_FIRST_HANDSHAKE(s) ((s)->s3.tmp.finish_md_len == 0 \
275 || (s)->s3.tmp.peer_finish_md_len == 0)
277 /* See if we need explicit IV */
278 # define SSL_USE_EXPLICIT_IV(s) \
279 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
281 * See if we use signature algorithms extension and signature algorithm
284 # define SSL_USE_SIGALGS(s) \
285 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
287 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
288 * apply to others in future.
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)
293 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
294 * flags because it may not be set to correct version yet.
296 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
297 ((!SSL_CONNECTION_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
298 (SSL_CONNECTION_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
300 * Determine if a client should send signature algorithms extension:
301 * as with TLS1.2 cipher we can't rely on method flags.
303 # define SSL_CLIENT_USE_SIGALGS(s) \
304 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
306 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
307 (((value) >= TLSEXT_max_fragment_length_512) && \
308 ((value) <= TLSEXT_max_fragment_length_4096))
309 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
310 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
311 # define GET_MAX_FRAGMENT_LENGTH(session) \
312 (512U << (session->ext.max_fragment_len_mode - 1))
314 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
315 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
317 # define SSL_IS_QUIC_HANDSHAKE(s) (((s)->s3.flags & TLS1_FLAGS_QUIC) != 0)
319 /* alert_dispatch values */
321 /* No alert pending */
322 # define SSL_ALERT_DISPATCH_NONE 0
324 # define SSL_ALERT_DISPATCH_PENDING 1
325 /* Pending alert write needs to be retried */
326 # define SSL_ALERT_DISPATCH_RETRY 2
328 /* Mostly for SSLv3 */
329 # define SSL_PKEY_RSA 0
330 # define SSL_PKEY_RSA_PSS_SIGN 1
331 # define SSL_PKEY_DSA_SIGN 2
332 # define SSL_PKEY_ECC 3
333 # define SSL_PKEY_GOST01 4
334 # define SSL_PKEY_GOST12_256 5
335 # define SSL_PKEY_GOST12_512 6
336 # define SSL_PKEY_ED25519 7
337 # define SSL_PKEY_ED448 8
338 # define SSL_PKEY_NUM 9
340 # define SSL_ENC_DES_IDX 0
341 # define SSL_ENC_3DES_IDX 1
342 # define SSL_ENC_RC4_IDX 2
343 # define SSL_ENC_RC2_IDX 3
344 # define SSL_ENC_IDEA_IDX 4
345 # define SSL_ENC_NULL_IDX 5
346 # define SSL_ENC_AES128_IDX 6
347 # define SSL_ENC_AES256_IDX 7
348 # define SSL_ENC_CAMELLIA128_IDX 8
349 # define SSL_ENC_CAMELLIA256_IDX 9
350 # define SSL_ENC_GOST89_IDX 10
351 # define SSL_ENC_SEED_IDX 11
352 # define SSL_ENC_AES128GCM_IDX 12
353 # define SSL_ENC_AES256GCM_IDX 13
354 # define SSL_ENC_AES128CCM_IDX 14
355 # define SSL_ENC_AES256CCM_IDX 15
356 # define SSL_ENC_AES128CCM8_IDX 16
357 # define SSL_ENC_AES256CCM8_IDX 17
358 # define SSL_ENC_GOST8912_IDX 18
359 # define SSL_ENC_CHACHA_IDX 19
360 # define SSL_ENC_ARIA128GCM_IDX 20
361 # define SSL_ENC_ARIA256GCM_IDX 21
362 # define SSL_ENC_MAGMA_IDX 22
363 # define SSL_ENC_KUZNYECHIK_IDX 23
364 # define SSL_ENC_NUM_IDX 24
367 * SSL_kRSA <- RSA_ENC
368 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
369 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
370 * SSL_aRSA <- RSA_ENC | RSA_SIGN
371 * SSL_aDSS <- DSA_SIGN
375 #define CERT_INVALID 0
376 #define CERT_PUBLIC_KEY 1
377 #define CERT_PRIVATE_KEY 2
380 /* Certificate Type State */
381 # define OSSL_CERT_TYPE_CTOS_NONE 0
382 # define OSSL_CERT_TYPE_CTOS_GOOD 1
383 # define OSSL_CERT_TYPE_CTOS_ERROR 2
385 /* Post-Handshake Authentication state */
388 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
389 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
390 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
391 SSL_PHA_REQUESTED /* request received by client, or sent by server */
394 /* CipherSuite length. SSLv3 and all TLS versions. */
395 # define TLS_CIPHER_LEN 2
396 /* used to hold info on the particular ciphers used */
397 struct ssl_cipher_st {
399 const char *name; /* text name */
400 const char *stdname; /* RFC name */
401 uint32_t id; /* id, 4 bytes, first is version */
403 * changed in 1.0.0: these four used to be portions of a single value
406 uint32_t algorithm_mkey; /* key exchange algorithm */
407 uint32_t algorithm_auth; /* server authentication */
408 uint32_t algorithm_enc; /* symmetric encryption */
409 uint32_t algorithm_mac; /* symmetric authentication */
410 int min_tls; /* minimum SSL/TLS protocol version */
411 int max_tls; /* maximum SSL/TLS protocol version */
412 int min_dtls; /* minimum DTLS protocol version */
413 int max_dtls; /* maximum DTLS protocol version */
414 uint32_t algo_strength; /* strength and export flags */
415 uint32_t algorithm2; /* Extra flags */
416 int32_t strength_bits; /* Number of bits really used */
417 uint32_t alg_bits; /* Number of bits for algorithm */
420 /* Used to hold SSL/TLS functions */
421 struct ssl_method_st {
425 SSL *(*ssl_new) (SSL_CTX *ctx);
426 void (*ssl_free) (SSL *s);
427 int (*ssl_reset) (SSL *s);
428 int (*ssl_init) (SSL *s);
429 int (*ssl_clear) (SSL *s);
430 void (*ssl_deinit) (SSL *s);
431 int (*ssl_accept) (SSL *s);
432 int (*ssl_connect) (SSL *s);
433 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
434 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
435 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
436 int (*ssl_shutdown) (SSL *s);
437 int (*ssl_renegotiate) (SSL *s);
438 int (*ssl_renegotiate_check) (SSL *s, int);
439 int (*ssl_read_bytes) (SSL *s, uint8_t type, uint8_t *recvd_type,
440 unsigned char *buf, size_t len, int peek,
442 int (*ssl_write_bytes) (SSL *s, uint8_t type, const void *buf_, size_t len,
444 int (*ssl_dispatch_alert) (SSL *s);
445 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
446 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
447 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
448 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
450 size_t (*ssl_pending) (const SSL *s);
451 int (*num_ciphers) (void);
452 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
453 OSSL_TIME (*get_timeout) (void);
454 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
455 int (*ssl_version) (void);
456 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
457 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
461 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
462 * consistency, even in the event of OPENSSL_NO_PSK being defined.
464 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 512
467 * Lets make this into an ASN.1 type structure as follows
468 * SSL_SESSION_ID ::= SEQUENCE {
469 * version INTEGER, -- structure version number
470 * SSLversion INTEGER, -- SSL version number
471 * Cipher OCTET STRING, -- the 3 byte cipher ID
472 * Session_ID OCTET STRING, -- the Session ID
473 * Master_key OCTET STRING, -- the master key
474 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
475 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
476 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
477 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
478 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
479 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
480 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
481 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
482 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
483 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
484 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
485 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
486 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
487 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
489 * Look in ssl/ssl_asn1.c for more details
490 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
492 struct ssl_session_st {
493 int ssl_version; /* what ssl version session info is being kept
495 size_t master_key_length;
497 /* TLSv1.3 early_secret used for external PSKs */
498 unsigned char early_secret[EVP_MAX_MD_SIZE];
500 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
503 unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
504 /* session_id - valid? */
505 size_t session_id_length;
506 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
508 * this is used to determine whether the session is being reused in the
509 * appropriate context. It is up to the application to set this, via
512 size_t sid_ctx_length;
513 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
514 # ifndef OPENSSL_NO_PSK
515 char *psk_identity_hint;
519 * Used to indicate that session resumption is not allowed. Applications
520 * can also set this bit for a new session via not_resumable_session_cb
521 * to disable session caching and tickets.
524 /* Peer raw public key, if available */
526 /* This is the cert and type for the other end. */
528 /* Certificate chain peer sent. */
529 STACK_OF(X509) *peer_chain;
531 * when app_verify_callback accepts a session where the peer's
532 * certificate is not ok, we must remember the error for session reuse:
534 long verify_result; /* only for servers */
535 CRYPTO_REF_COUNT references;
538 OSSL_TIME calc_timeout;
539 unsigned int compress_meth; /* Need to lookup the method */
540 const SSL_CIPHER *cipher;
541 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
542 * load the 'cipher' structure */
543 unsigned int kex_group; /* TLS group from key exchange */
544 CRYPTO_EX_DATA ex_data; /* application specific data */
546 * These are used to make removal of session-ids more efficient and to
547 * implement a maximum cache size.
549 struct ssl_session_st *prev, *next;
554 unsigned char *tick; /* Session ticket */
555 size_t ticklen; /* Session ticket length */
556 /* Session lifetime hint in seconds */
557 unsigned long tick_lifetime_hint;
558 uint32_t tick_age_add;
559 /* Max number of bytes that can be sent as early data */
560 uint32_t max_early_data;
561 /* The ALPN protocol selected for this session */
562 unsigned char *alpn_selected;
563 size_t alpn_selected_len;
565 * Maximum Fragment Length as per RFC 4366.
566 * If this value does not contain RFC 4366 allowed values (1-4) then
567 * either the Maximum Fragment Length Negotiation failed or was not
570 uint8_t max_fragment_len_mode;
572 # ifndef OPENSSL_NO_SRP
575 unsigned char *ticket_appdata;
576 size_t ticket_appdata_len;
581 /* Extended master secret support */
582 # define SSL_SESS_FLAG_EXTMS 0x1
584 # ifndef OPENSSL_NO_SRP
586 typedef struct srp_ctx_st {
587 /* param for all the callbacks */
589 /* set client Hello login callback */
590 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
591 /* set SRP N/g param callback for verification */
592 int (*SRP_verify_param_callback) (SSL *, void *);
593 /* set SRP client passwd callback */
594 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
596 BIGNUM *N, *g, *s, *B, *A;
600 unsigned long srp_Mask;
606 SSL_EARLY_DATA_NONE = 0,
607 SSL_EARLY_DATA_CONNECT_RETRY,
608 SSL_EARLY_DATA_CONNECTING,
609 SSL_EARLY_DATA_WRITE_RETRY,
610 SSL_EARLY_DATA_WRITING,
611 SSL_EARLY_DATA_WRITE_FLUSH,
612 SSL_EARLY_DATA_UNAUTH_WRITING,
613 SSL_EARLY_DATA_FINISHED_WRITING,
614 SSL_EARLY_DATA_ACCEPT_RETRY,
615 SSL_EARLY_DATA_ACCEPTING,
616 SSL_EARLY_DATA_READ_RETRY,
617 SSL_EARLY_DATA_READING,
618 SSL_EARLY_DATA_FINISHED_READING
619 } SSL_EARLY_DATA_STATE;
622 * We check that the amount of unreadable early data doesn't exceed
623 * max_early_data. max_early_data is given in plaintext bytes. However if it is
624 * unreadable then we only know the number of ciphertext bytes. We also don't
625 * know how much the overhead should be because it depends on the ciphersuite.
626 * We make a small allowance. We assume 5 records of actual data plus the end
627 * of early data alert record. Each record has a tag and a content type byte.
628 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
629 * content of the alert record either which is 2 bytes.
631 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
634 * The allowance we have between the client's calculated ticket age and our own.
635 * We allow for 10 seconds. If a ticket is presented and the
636 * client's age calculation is different by more than this than our own then we
637 * do not allow that ticket for early_data.
639 # define TICKET_AGE_ALLOWANCE ossl_seconds2time(10)
641 #define MAX_COMPRESSIONS_SIZE 255
649 typedef struct raw_extension_st {
650 /* Raw packet data for the extension */
652 /* Set to 1 if the extension is present or 0 otherwise */
654 /* Set to 1 if we have already parsed the extension or 0 otherwise */
656 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
658 /* Track what order extensions are received in (0-based). */
659 size_t received_order;
664 unsigned int legacy_version;
665 unsigned char random[SSL3_RANDOM_SIZE];
666 size_t session_id_len;
667 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
668 size_t dtls_cookie_len;
669 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
671 size_t compressions_len;
672 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
674 size_t pre_proc_exts_len;
675 RAW_EXTENSION *pre_proc_exts;
679 * Extension index values NOTE: Any updates to these defines should be mirrored
680 * with equivalent updates to ext_defs in extensions.c
682 typedef enum tlsext_index_en {
683 TLSEXT_IDX_renegotiate,
684 TLSEXT_IDX_server_name,
685 TLSEXT_IDX_max_fragment_length,
687 TLSEXT_IDX_ec_point_formats,
688 TLSEXT_IDX_supported_groups,
689 TLSEXT_IDX_session_ticket,
690 TLSEXT_IDX_status_request,
691 TLSEXT_IDX_next_proto_neg,
692 TLSEXT_IDX_application_layer_protocol_negotiation,
694 TLSEXT_IDX_encrypt_then_mac,
695 TLSEXT_IDX_signed_certificate_timestamp,
696 TLSEXT_IDX_extended_master_secret,
697 TLSEXT_IDX_signature_algorithms_cert,
698 TLSEXT_IDX_post_handshake_auth,
699 TLSEXT_IDX_client_cert_type,
700 TLSEXT_IDX_server_cert_type,
701 TLSEXT_IDX_signature_algorithms,
702 TLSEXT_IDX_supported_versions,
703 TLSEXT_IDX_psk_kex_modes,
704 TLSEXT_IDX_key_share,
706 TLSEXT_IDX_cryptopro_bug,
707 TLSEXT_IDX_compress_certificate,
708 TLSEXT_IDX_early_data,
709 TLSEXT_IDX_certificate_authorities,
712 /* Dummy index - must always be the last entry */
713 TLSEXT_IDX_num_builtins
716 DEFINE_LHASH_OF_EX(SSL_SESSION);
717 /* Needed in ssl_cert.c */
718 DEFINE_LHASH_OF_EX(X509_NAME);
720 # define TLSEXT_KEYNAME_LENGTH 16
721 # define TLSEXT_TICK_KEY_LENGTH 32
723 typedef struct ssl_ctx_ext_secure_st {
724 unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
725 unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
726 } SSL_CTX_EXT_SECURE;
729 * Helper function for HMAC
730 * The structure should be considered opaque, it will change once the low
731 * level deprecated calls are removed. At that point it can be replaced
732 * by EVP_MAC_CTX and most of the functions converted to macros or inlined
735 typedef struct ssl_hmac_st {
737 # ifndef OPENSSL_NO_DEPRECATED_3_0
742 SSL_HMAC *ssl_hmac_new(const SSL_CTX *ctx);
743 void ssl_hmac_free(SSL_HMAC *ctx);
744 # ifndef OPENSSL_NO_DEPRECATED_3_0
745 HMAC_CTX *ssl_hmac_get0_HMAC_CTX(SSL_HMAC *ctx);
747 EVP_MAC_CTX *ssl_hmac_get0_EVP_MAC_CTX(SSL_HMAC *ctx);
748 int ssl_hmac_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
749 int ssl_hmac_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
750 int ssl_hmac_final(SSL_HMAC *ctx, unsigned char *md, size_t *len,
752 size_t ssl_hmac_size(const SSL_HMAC *ctx);
754 int ssl_get_EC_curve_nid(const EVP_PKEY *pkey);
755 __owur int tls13_set_encoded_pub_key(EVP_PKEY *pkey,
756 const unsigned char *enckey,
759 typedef struct tls_group_info_st {
760 char *tlsname; /* Curve Name as in TLS specs */
761 char *realname; /* Curve Name according to provider */
762 char *algorithm; /* Algorithm name to fetch */
763 unsigned int secbits; /* Bits of security (from SP800-57) */
764 uint16_t group_id; /* Group ID */
765 int mintls; /* Minimum TLS version, -1 unsupported */
766 int maxtls; /* Maximum TLS version (or 0 for undefined) */
767 int mindtls; /* Minimum DTLS version, -1 unsupported */
768 int maxdtls; /* Maximum DTLS version (or 0 for undefined) */
769 char is_kem; /* Mode for this Group: 0 is KEX, 1 is KEM */
772 typedef struct tls_sigalg_info_st {
773 char *name; /* name as in IANA TLS specs */
774 uint16_t code_point; /* IANA-specified code point of sigalg-name */
775 char *sigalg_name; /* (combined) sigalg name */
776 char *sigalg_oid; /* (combined) sigalg OID */
777 char *sig_name; /* pure signature algorithm name */
778 char *sig_oid; /* pure signature algorithm OID */
779 char *hash_name; /* hash algorithm name */
780 char *hash_oid; /* hash algorithm OID */
781 char *keytype; /* keytype name */
782 char *keytype_oid; /* keytype OID */
783 unsigned int secbits; /* Bits of security (from SP800-57) */
784 int mintls; /* Minimum TLS version, -1 unsupported */
785 int maxtls; /* Maximum TLS version (or 0 for undefined) */
789 * Structure containing table entry of certificate info corresponding to
793 int nid; /* NID of public key algorithm */
794 uint32_t amask; /* authmask corresponding to key type */
798 # define TLS_GROUP_TYPE 0x0000000FU /* Mask for group type */
799 # define TLS_GROUP_CURVE_PRIME 0x00000001U
800 # define TLS_GROUP_CURVE_CHAR2 0x00000002U
801 # define TLS_GROUP_CURVE_CUSTOM 0x00000004U
802 # define TLS_GROUP_FFDHE 0x00000008U
803 # define TLS_GROUP_ONLY_FOR_TLS1_3 0x00000010U
805 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
808 OSSL_LIB_CTX *libctx;
810 const SSL_METHOD *method;
811 STACK_OF(SSL_CIPHER) *cipher_list;
812 /* same as above but sorted for lookup */
813 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
814 /* TLSv1.3 specific ciphersuites */
815 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
816 struct x509_store_st /* X509_STORE */ *cert_store;
817 LHASH_OF(SSL_SESSION) *sessions;
819 * Most session-ids that will be cached, default is
820 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
822 size_t session_cache_size;
823 struct ssl_session_st *session_cache_head;
824 struct ssl_session_st *session_cache_tail;
826 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
827 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
828 * means only SSL_accept will cache SSL_SESSIONS.
830 uint32_t session_cache_mode;
832 * If timeout is not 0, it is the default timeout value set when
833 * SSL_new() is called. This has been put in to make life easier to set
836 OSSL_TIME session_timeout;
838 * If this callback is not null, it will be called each time a session id
839 * is added to the cache. If this function returns 1, it means that the
840 * callback will do a SSL_SESSION_free() when it has finished using it.
841 * Otherwise, on 0, it means the callback has finished with it. If
842 * remove_session_cb is not null, it will be called when a session-id is
843 * removed from the cache. After the call, OpenSSL will
844 * SSL_SESSION_free() it.
846 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
847 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
848 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
849 const unsigned char *data, int len,
852 TSAN_QUALIFIER int sess_connect; /* SSL new conn - started */
853 TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
854 TSAN_QUALIFIER int sess_connect_good; /* SSL new conne/reneg - finished */
855 TSAN_QUALIFIER int sess_accept; /* SSL new accept - started */
856 TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
857 TSAN_QUALIFIER int sess_accept_good; /* SSL accept/reneg - finished */
858 TSAN_QUALIFIER int sess_miss; /* session lookup misses */
859 TSAN_QUALIFIER int sess_timeout; /* reuse attempt on timeouted session */
860 TSAN_QUALIFIER int sess_cache_full; /* session removed due to full cache */
861 TSAN_QUALIFIER int sess_hit; /* session reuse actually done */
862 TSAN_QUALIFIER int sess_cb_hit; /* session-id that was not in
863 * the cache was passed back via
864 * the callback. This indicates
865 * that the application is
866 * supplying session-id's from
867 * other processes - spooky
870 #ifdef TSAN_REQUIRES_LOCKING
871 CRYPTO_RWLOCK *tsan_lock;
874 CRYPTO_REF_COUNT references;
876 /* if defined, these override the X509_verify_cert() calls */
877 int (*app_verify_callback) (X509_STORE_CTX *, void *);
878 void *app_verify_arg;
880 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
881 * ('app_verify_callback' was called with just one argument)
884 /* Default password callback. */
885 pem_password_cb *default_passwd_callback;
887 /* Default password callback user data. */
888 void *default_passwd_callback_userdata;
890 /* get client cert callback */
891 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
893 /* cookie generate callback */
894 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
895 unsigned int *cookie_len);
897 /* verify cookie callback */
898 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
899 unsigned int cookie_len);
901 /* TLS1.3 app-controlled cookie generate callback */
902 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
905 /* TLS1.3 verify app-controlled cookie callback */
906 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
909 CRYPTO_EX_DATA ex_data;
911 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
912 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3-sha1' */
914 STACK_OF(X509) *extra_certs;
915 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
917 /* Default values used when no per-SSL value is defined follow */
919 /* used if SSL's info_callback is NULL */
920 void (*info_callback) (const SSL *ssl, int type, int val);
923 * What we put in certificate_authorities extension for TLS 1.3
924 * (ClientHello and CertificateRequest) or just client cert requests for
925 * earlier versions. If client_ca_names is populated then it is only used
926 * for client cert requests, and in preference to ca_names.
928 STACK_OF(X509_NAME) *ca_names;
929 STACK_OF(X509_NAME) *client_ca_names;
932 * Default values to use in SSL structures follow (these are copied by
938 int min_proto_version;
939 int max_proto_version;
940 size_t max_cert_list;
942 struct cert_st /* CERT */ *cert;
943 SSL_CERT_LOOKUP *ssl_cert_info;
946 /* callback that allows applications to peek at protocol messages */
947 ossl_msg_cb msg_callback;
948 void *msg_callback_arg;
950 uint32_t verify_mode;
951 size_t sid_ctx_length;
952 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
953 /* called 'verify_callback' in the SSL */
954 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
956 /* Default generate session ID callback. */
957 GEN_SESSION_CB generate_session_id;
959 X509_VERIFY_PARAM *param;
963 # ifndef OPENSSL_NO_CT
964 CTLOG_STORE *ctlog_store; /* CT Log Store */
966 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
967 * If they are not, the connection should be aborted.
969 ssl_ct_validation_cb ct_validation_callback;
970 void *ct_validation_callback_arg;
974 * If we're using more than one pipeline how should we divide the data
975 * up between the pipes?
977 size_t split_send_fragment;
979 * Maximum amount of data to send in one fragment. actual record size can
980 * be more than this due to padding and MAC overheads.
982 size_t max_send_fragment;
984 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
985 size_t max_pipelines;
987 /* The default read buffer length to use (0 means not set) */
988 size_t default_read_buf_len;
990 # ifndef OPENSSL_NO_ENGINE
992 * Engine to pass requests for client certs to
994 ENGINE *client_cert_engine;
997 /* ClientHello callback. Mostly for extensions, but not entirely. */
998 SSL_client_hello_cb_fn client_hello_cb;
999 void *client_hello_cb_arg;
1001 /* TLS extensions. */
1003 /* TLS extensions servername callback */
1004 int (*servername_cb) (SSL *, int *, void *);
1005 void *servername_arg;
1006 /* RFC 4507 session ticket keys */
1007 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
1008 SSL_CTX_EXT_SECURE *secure;
1009 # ifndef OPENSSL_NO_DEPRECATED_3_0
1010 /* Callback to support customisation of ticket key setting */
1011 int (*ticket_key_cb) (SSL *ssl,
1012 unsigned char *name, unsigned char *iv,
1013 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
1015 int (*ticket_key_evp_cb) (SSL *ssl,
1016 unsigned char *name, unsigned char *iv,
1017 EVP_CIPHER_CTX *ectx, EVP_MAC_CTX *hctx,
1020 /* certificate status request info */
1021 /* Callback for status request */
1022 int (*status_cb) (SSL *ssl, void *arg);
1024 /* ext status type used for CSR extension (OCSP Stapling) */
1026 /* RFC 4366 Maximum Fragment Length Negotiation */
1027 uint8_t max_fragment_len_mode;
1029 /* EC extension values inherited by SSL structure */
1030 size_t ecpointformats_len;
1031 unsigned char *ecpointformats;
1033 size_t supportedgroups_len;
1034 uint16_t *supportedgroups;
1036 uint16_t *supported_groups_default;
1037 size_t supported_groups_default_len;
1039 * ALPN information (we are in the process of transitioning from NPN to
1044 * For a server, this contains a callback function that allows the
1045 * server to select the protocol for the connection.
1046 * out: on successful return, this must point to the raw protocol
1047 * name (without the length prefix).
1048 * outlen: on successful return, this contains the length of |*out|.
1049 * in: points to the client's list of supported protocols in
1051 * inlen: the length of |in|.
1053 int (*alpn_select_cb) (SSL *s,
1054 const unsigned char **out,
1055 unsigned char *outlen,
1056 const unsigned char *in,
1057 unsigned int inlen, void *arg);
1058 void *alpn_select_cb_arg;
1061 * For a client, this contains the list of supported protocols in wire
1064 unsigned char *alpn;
1067 # ifndef OPENSSL_NO_NEXTPROTONEG
1068 /* Next protocol negotiation information */
1071 * For a server, this contains a callback function by which the set of
1072 * advertised protocols can be provided.
1074 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
1075 void *npn_advertised_cb_arg;
1077 * For a client, this contains a callback function that selects the next
1078 * protocol from the list provided by the server.
1080 SSL_CTX_npn_select_cb_func npn_select_cb;
1081 void *npn_select_cb_arg;
1084 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1087 # ifndef OPENSSL_NO_PSK
1088 SSL_psk_client_cb_func psk_client_callback;
1089 SSL_psk_server_cb_func psk_server_callback;
1091 SSL_psk_find_session_cb_func psk_find_session_cb;
1092 SSL_psk_use_session_cb_func psk_use_session_cb;
1094 # ifndef OPENSSL_NO_SRP
1095 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1098 /* Shared DANE context */
1099 struct dane_ctx_st dane;
1101 # ifndef OPENSSL_NO_SRTP
1102 /* SRTP profiles we are willing to do from RFC 5764 */
1103 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1106 * Callback for disabling session caching and ticket support on a session
1107 * basis, depending on the chosen cipher.
1109 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1111 CRYPTO_RWLOCK *lock;
1114 * Callback for logging key material for use with debugging tools like
1115 * Wireshark. The callback should log `line` followed by a newline.
1117 SSL_CTX_keylog_cb_func keylog_callback;
1120 * The maximum number of bytes advertised in session tickets that can be
1121 * sent as early data.
1123 uint32_t max_early_data;
1126 * The maximum number of bytes of early data that a server will tolerate
1127 * (which should be at least as much as max_early_data).
1129 uint32_t recv_max_early_data;
1131 /* TLS1.3 padding callback */
1132 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1133 void *record_padding_arg;
1134 size_t block_padding;
1136 /* Session ticket appdata */
1137 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1138 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1139 void *ticket_cb_data;
1141 /* The number of TLS1.3 tickets to automatically send */
1144 /* Callback to determine if early_data is acceptable or not */
1145 SSL_allow_early_data_cb_fn allow_early_data_cb;
1146 void *allow_early_data_cb_data;
1148 /* Do we advertise Post-handshake auth support? */
1151 /* Callback for SSL async handling */
1152 SSL_async_callback_fn async_cb;
1157 int ssl_mac_pkey_id[SSL_MD_NUM_IDX];
1158 const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
1159 const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX];
1160 size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
1162 size_t tls12_sigalgs_len;
1163 /* Cache of all sigalgs we know and whether they are available or not */
1164 struct sigalg_lookup_st *sigalg_lookup_cache;
1165 /* List of all sigalgs (code points) available, incl. from providers */
1166 uint16_t *tls12_sigalgs;
1168 TLS_GROUP_INFO *group_list;
1169 size_t group_list_len;
1170 size_t group_list_max_len;
1172 TLS_SIGALG_INFO *sigalg_list;
1173 size_t sigalg_list_len;
1174 size_t sigalg_list_max_len;
1176 /* masks of disabled algorithms */
1177 uint32_t disabled_enc_mask;
1178 uint32_t disabled_mac_mask;
1179 uint32_t disabled_mkey_mask;
1180 uint32_t disabled_auth_mask;
1182 #ifndef OPENSSL_NO_COMP_ALG
1183 /* certificate compression preferences */
1184 int cert_comp_prefs[TLSEXT_comp_cert_limit];
1187 /* Certificate Type stuff - for RPK vs X.509 */
1188 unsigned char *client_cert_type;
1189 size_t client_cert_type_len;
1190 unsigned char *server_cert_type;
1191 size_t server_cert_type_len;
1194 typedef struct cert_pkey_st CERT_PKEY;
1196 #define SSL_TYPE_SSL_CONNECTION 0
1197 #define SSL_TYPE_QUIC_CONNECTION 1
1198 #define SSL_TYPE_QUIC_XSO 2
1203 const SSL_METHOD *defltmeth;
1204 const SSL_METHOD *method;
1205 CRYPTO_REF_COUNT references;
1206 CRYPTO_RWLOCK *lock;
1207 /* extra application data */
1208 CRYPTO_EX_DATA ex_data;
1211 struct ssl_connection_st {
1212 /* type identifier and common data */
1215 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1220 * There are 2 BIO's even though they are normally both the same. This
1221 * is so data can be read and written to different handlers
1223 /* used by SSL_read */
1225 /* used by SSL_write */
1227 /* used during session-id reuse to concatenate messages */
1230 * This holds a variable that indicates what we were doing when a 0 or -1
1231 * is returned. This is needed for non-blocking IO so we know what
1232 * request needs re-doing when in SSL_accept or SSL_connect
1235 int (*handshake_func) (SSL *);
1237 * Imagine that here's a boolean member "init" that is switched as soon
1238 * as SSL_set_{accept/connect}_state is called for the first time, so
1239 * that "state" and "handshake_func" are properly initialized. But as
1240 * handshake_func is == 0 until then, we use this test instead of an
1243 /* are we the server side? */
1246 * Generate a new session or reuse an old one.
1247 * NB: For servers, the 'new' session may actually be a previously
1248 * cached session or even the previous session unless
1249 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1252 /* don't send shutdown packets */
1254 /* we have shut things down, 0x01 sent, 0x02 for received */
1256 /* Timestamps used to calculate the handshake RTT */
1257 OSSL_TIME ts_msg_write;
1258 OSSL_TIME ts_msg_read;
1261 SSL_EARLY_DATA_STATE early_data_state;
1262 BUF_MEM *init_buf; /* buffer used during init */
1263 void *init_msg; /* pointer to handshake message body, set by
1264 * tls_get_message_header() */
1265 size_t init_num; /* amount read/written */
1266 size_t init_off; /* amount read/written */
1268 size_t ssl_pkey_num;
1272 unsigned char server_random[SSL3_RANDOM_SIZE];
1273 unsigned char client_random[SSL3_RANDOM_SIZE];
1275 /* used during startup, digest all incoming/outgoing packets */
1276 BIO *handshake_buffer;
1278 * When handshake digest is determined, buffer is hashed and
1279 * freed and MD_CTX for the required digest is stored here.
1281 EVP_MD_CTX *handshake_dgst;
1283 * Set whenever an expected ChangeCipherSpec message is processed.
1284 * Unset when the peer's Finished message is received.
1285 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1287 int change_cipher_spec;
1291 * we allow one fatal and one warning alert to be outstanding, send close
1292 * alert via the warning alert
1295 unsigned char send_alert[2];
1297 * This flag is set when we should renegotiate ASAP, basically when there
1298 * is no more data in the read or write buffers
1301 int total_renegotiations;
1302 int num_renegotiations;
1303 int in_read_app_data;
1306 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1307 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1308 size_t finish_md_len;
1309 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1310 size_t peer_finish_md_len;
1311 size_t message_size;
1313 /* used to hold the new cipher we are going to use */
1314 const SSL_CIPHER *new_cipher;
1315 EVP_PKEY *pkey; /* holds short lived key exchange key */
1316 /* used for certificate requests */
1318 /* Certificate types in certificate request message. */
1321 /* Certificate authorities list peer sent */
1322 STACK_OF(X509_NAME) *peer_ca_names;
1323 size_t key_block_length;
1324 unsigned char *key_block;
1325 const EVP_CIPHER *new_sym_enc;
1326 const EVP_MD *new_hash;
1327 int new_mac_pkey_type;
1328 size_t new_mac_secret_size;
1329 # ifndef OPENSSL_NO_COMP
1330 const SSL_COMP *new_compression;
1332 char *new_compression;
1335 /* Raw values of the cipher list from a client */
1336 unsigned char *ciphers_raw;
1337 size_t ciphers_rawlen;
1338 /* Temporary storage for premaster secret */
1341 # ifndef OPENSSL_NO_PSK
1342 /* Temporary storage for PSK key */
1346 /* Signature algorithm we actually use */
1347 const struct sigalg_lookup_st *sigalg;
1348 /* Pointer to certificate we use */
1351 * signature algorithms peer reports: e.g. supported signature
1352 * algorithms extension for server or as part of a certificate
1353 * request for client.
1354 * Keep track of the algorithms for TLS and X.509 usage separately.
1356 uint16_t *peer_sigalgs;
1357 uint16_t *peer_cert_sigalgs;
1358 /* Size of above arrays */
1359 size_t peer_sigalgslen;
1360 size_t peer_cert_sigalgslen;
1361 /* Sigalg peer actually uses */
1362 const struct sigalg_lookup_st *peer_sigalg;
1364 * Set if corresponding CERT_PKEY can be used with current
1365 * SSL session: e.g. appropriate curve, signature algorithms etc.
1366 * If zero it can't be used at all.
1368 uint32_t *valid_flags;
1370 * For servers the following masks are for the key and auth algorithms
1371 * that are supported by the certs below. For clients they are masks of
1372 * *disabled* algorithms based on the current session.
1377 * The following are used by the client to see if a cipher is allowed or
1378 * not. It contains the minimum and maximum version the client's using
1379 * based on what it knows so far.
1385 /* Connection binding to prevent renegotiation attacks */
1386 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1387 size_t previous_client_finished_len;
1388 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1389 size_t previous_server_finished_len;
1390 int send_connection_binding;
1392 # ifndef OPENSSL_NO_NEXTPROTONEG
1394 * Set if we saw the Next Protocol Negotiation extension from our peer.
1400 * ALPN information (we are in the process of transitioning from NPN to
1405 * In a server these point to the selected ALPN protocol after the
1406 * ClientHello has been processed. In a client these contain the protocol
1407 * that the server selected once the ServerHello has been processed.
1409 unsigned char *alpn_selected;
1410 size_t alpn_selected_len;
1411 /* used by the server to know what options were proposed */
1412 unsigned char *alpn_proposed;
1413 size_t alpn_proposed_len;
1414 /* used by the client to know if it actually sent alpn */
1418 * This is set to true if we believe that this is a version of Safari
1419 * running on OS X 10.6 or newer. We wish to know this because Safari on
1420 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1422 char is_probably_safari;
1425 * Track whether we did a key exchange this handshake or not, so
1426 * SSL_get_negotiated_group() knows whether to fall back to the
1427 * value in the SSL_SESSION.
1430 /* For clients: peer temporary key */
1431 /* The group_id for the key exchange key */
1437 struct dtls1_state_st *d1; /* DTLSv1 variables */
1438 /* callback that allows applications to peek at protocol messages */
1439 void (*msg_callback) (int write_p, int version, int content_type,
1440 const void *buf, size_t len, SSL *ssl, void *arg);
1441 void *msg_callback_arg;
1442 int hit; /* reusing a previous session */
1443 X509_VERIFY_PARAM *param;
1444 /* Per connection DANE state */
1447 STACK_OF(SSL_CIPHER) *peer_ciphers;
1448 STACK_OF(SSL_CIPHER) *cipher_list;
1449 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1450 /* TLSv1.3 specific ciphersuites */
1451 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1453 * These are the ones being used, the ones in SSL_SESSION are the ones to
1454 * be 'copied' into these ones
1458 * The TLS1.3 secrets.
1460 unsigned char early_secret[EVP_MAX_MD_SIZE];
1461 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1462 unsigned char master_secret[EVP_MAX_MD_SIZE];
1463 unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1464 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1465 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1466 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1467 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1468 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1469 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1470 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1471 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1475 /* This is used to hold the server certificate used */
1476 struct cert_st /* CERT */ *cert;
1479 * The hash of all messages prior to the CertificateVerify, and the length
1482 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1483 size_t cert_verify_hash_len;
1485 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1486 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1487 hello_retry_request;
1490 * the session_id_context is used to ensure sessions are only reused in
1491 * the appropriate context
1493 size_t sid_ctx_length;
1494 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1495 /* This can also be in the session once a session is established */
1496 SSL_SESSION *session;
1497 /* TLSv1.3 PSK session */
1498 SSL_SESSION *psksession;
1499 unsigned char *psksession_id;
1500 size_t psksession_id_len;
1501 /* Default generate session ID callback. */
1502 GEN_SESSION_CB generate_session_id;
1504 * The temporary TLSv1.3 session id. This isn't really a session id at all
1505 * but is a random value sent in the legacy session id field.
1507 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1508 size_t tmp_session_id_len;
1511 * 0 don't care about verify failure.
1512 * 1 fail if verify fails
1514 uint32_t verify_mode;
1515 /* fail if callback returns 0 */
1516 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1517 /* optional informational callback */
1518 void (*info_callback) (const SSL *ssl, int type, int val);
1519 /* error bytes to be written */
1523 # ifndef OPENSSL_NO_PSK
1524 SSL_psk_client_cb_func psk_client_callback;
1525 SSL_psk_server_cb_func psk_server_callback;
1527 SSL_psk_find_session_cb_func psk_find_session_cb;
1528 SSL_psk_use_session_cb_func psk_use_session_cb;
1530 /* Verified chain of peer */
1531 STACK_OF(X509) *verified_chain;
1534 * What we put in certificate_authorities extension for TLS 1.3
1535 * (ClientHello and CertificateRequest) or just client cert requests for
1536 * earlier versions. If client_ca_names is populated then it is only used
1537 * for client cert requests, and in preference to ca_names.
1539 STACK_OF(X509_NAME) *ca_names;
1540 STACK_OF(X509_NAME) *client_ca_names;
1541 /* protocol behaviour */
1545 int min_proto_version;
1546 int max_proto_version;
1547 size_t max_cert_list;
1550 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1551 * secret and SSLv3/TLS (<=1.2) rollback check
1555 * If we're using more than one pipeline how should we divide the data
1556 * up between the pipes?
1558 size_t split_send_fragment;
1560 * Maximum amount of data to send in one fragment. actual record size can
1561 * be more than this due to padding and MAC overheads.
1563 size_t max_send_fragment;
1564 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1565 size_t max_pipelines;
1568 /* Built-in extension flags */
1569 uint8_t extflags[TLSEXT_IDX_num_builtins];
1570 /* TLS extension debug callback */
1571 void (*debug_cb)(SSL *s, int client_server, int type,
1572 const unsigned char *data, int len, void *arg);
1575 /* certificate status request info */
1576 /* Status type or -1 if no status type */
1578 /* Raw extension data, if seen */
1579 unsigned char *scts;
1580 /* Length of raw extension data, if seen */
1582 /* Expect OCSP CertificateStatus message */
1583 int status_expected;
1586 /* OCSP status request only */
1587 STACK_OF(OCSP_RESPID) *ids;
1588 X509_EXTENSIONS *exts;
1589 /* OCSP response received or to be sent */
1590 unsigned char *resp;
1594 /* RFC4507 session ticket expected to be received or sent */
1595 int ticket_expected;
1596 /* TLS 1.3 tickets requested by the application. */
1597 int extra_tickets_expected;
1598 size_t ecpointformats_len;
1600 unsigned char *ecpointformats;
1602 size_t peer_ecpointformats_len;
1604 unsigned char *peer_ecpointformats;
1605 size_t supportedgroups_len;
1607 uint16_t *supportedgroups;
1609 size_t peer_supportedgroups_len;
1611 uint16_t *peer_supportedgroups;
1613 /* TLS Session Ticket extension override */
1614 TLS_SESSION_TICKET_EXT *session_ticket;
1615 /* TLS Session Ticket extension callback */
1616 tls_session_ticket_ext_cb_fn session_ticket_cb;
1617 void *session_ticket_cb_arg;
1618 /* TLS pre-shared secret session resumption */
1619 tls_session_secret_cb_fn session_secret_cb;
1620 void *session_secret_cb_arg;
1622 * For a client, this contains the list of supported protocols in wire
1625 unsigned char *alpn;
1628 * Next protocol negotiation. For the client, this is the protocol that
1629 * we sent in NextProtocol and is set when handling ServerHello
1630 * extensions. For a server, this is the client's selected_protocol from
1631 * NextProtocol and is set when handling the NextProtocol message, before
1632 * the Finished message.
1637 /* The available PSK key exchange modes */
1640 /* Set to one if we have negotiated ETM */
1643 /* Are we expecting to receive early data? */
1645 /* Is the session suitable for early data? */
1648 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1649 unsigned char *tls13_cookie;
1650 size_t tls13_cookie_len;
1651 /* Have we received a cookie from the client? */
1655 * Maximum Fragment Length as per RFC 4366.
1656 * If this member contains one of the allowed values (1-4)
1657 * then we should include Maximum Fragment Length Negotiation
1658 * extension in Client Hello.
1659 * Please note that value of this member does not have direct
1660 * effect. The actual (binding) value is stored in SSL_SESSION,
1661 * as this extension is optional on server side.
1663 uint8_t max_fragment_len_mode;
1666 * On the client side the number of ticket identities we sent in the
1667 * ClientHello. On the server side the identity of the ticket we
1672 /* This is the list of algorithms the peer supports that we also support */
1673 int compress_certificate_from_peer[TLSEXT_comp_cert_limit];
1674 /* indicate that we sent the extension, so we'll accept it */
1675 int compress_certificate_sent;
1677 uint8_t client_cert_type;
1678 uint8_t client_cert_type_ctos;
1679 uint8_t server_cert_type;
1680 uint8_t server_cert_type_ctos;
1684 * Parsed form of the ClientHello, kept around across client_hello_cb
1687 CLIENTHELLO_MSG *clienthello;
1690 * no further mod of servername
1691 * 0 : call the servername extension callback.
1692 * 1 : prepare 2, allow last ack just after in server callback.
1693 * 2 : don't call servername callback, no ack in server hello
1695 int servername_done;
1696 # ifndef OPENSSL_NO_CT
1698 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1699 * If they are not, the connection should be aborted.
1701 ssl_ct_validation_cb ct_validation_callback;
1702 /* User-supplied argument that is passed to the ct_validation_callback */
1703 void *ct_validation_callback_arg;
1705 * Consolidated stack of SCTs from all sources.
1706 * Lazily populated by CT_get_peer_scts(SSL*)
1708 STACK_OF(SCT) *scts;
1709 /* Have we attempted to find/parse SCTs yet? */
1712 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1713 # ifndef OPENSSL_NO_SRTP
1715 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1716 /* What's been chosen */
1717 SRTP_PROTECTION_PROFILE *srtp_profile;
1720 * 1 if we are renegotiating.
1721 * 2 if we are a server and are inside a handshake
1722 * (i.e. not just sending a HelloRequest)
1725 /* If sending a KeyUpdate is pending */
1727 /* Post-handshake authentication state */
1728 SSL_PHA_STATE post_handshake_auth;
1730 uint8_t* pha_context;
1731 size_t pha_context_len;
1733 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1735 # ifndef OPENSSL_NO_SRP
1736 /* ctx for SRP authentication */
1740 * Callback for disabling session caching and ticket support on a session
1741 * basis, depending on the chosen cipher.
1743 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1745 /* Record layer data */
1746 RECORD_LAYER rlayer;
1748 /* Default password callback. */
1749 pem_password_cb *default_passwd_callback;
1750 /* Default password callback user data. */
1751 void *default_passwd_callback_userdata;
1752 /* Async Job info */
1754 ASYNC_WAIT_CTX *waitctx;
1758 * The maximum number of bytes advertised in session tickets that can be
1759 * sent as early data.
1761 uint32_t max_early_data;
1763 * The maximum number of bytes of early data that a server will tolerate
1764 * (which should be at least as much as max_early_data).
1766 uint32_t recv_max_early_data;
1769 * The number of bytes of early data received so far. If we accepted early
1770 * data then this is a count of the plaintext bytes. If we rejected it then
1771 * this is a count of the ciphertext bytes.
1773 uint32_t early_data_count;
1775 /* The number of TLS1.3 tickets to automatically send */
1777 /* The number of TLS1.3 tickets actually sent so far */
1778 size_t sent_tickets;
1779 /* The next nonce value to use when we send a ticket on this connection */
1780 uint64_t next_ticket_nonce;
1782 /* Callback to determine if early_data is acceptable or not */
1783 SSL_allow_early_data_cb_fn allow_early_data_cb;
1784 void *allow_early_data_cb_data;
1786 /* Callback for SSL async handling */
1787 SSL_async_callback_fn async_cb;
1791 * Signature algorithms shared by client and server: cached because these
1792 * are used most often.
1794 const struct sigalg_lookup_st **shared_sigalgs;
1795 size_t shared_sigalgslen;
1797 #ifndef OPENSSL_NO_COMP_ALG
1798 /* certificate compression preferences */
1799 int cert_comp_prefs[TLSEXT_comp_cert_limit];
1802 /* Certificate Type stuff - for RPK vs X.509 */
1803 unsigned char *client_cert_type;
1804 size_t client_cert_type_len;
1805 unsigned char *server_cert_type;
1806 size_t server_cert_type_len;
1809 # define SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, c) \
1810 ((ssl) == NULL ? NULL \
1811 : ((ssl)->type == SSL_TYPE_SSL_CONNECTION \
1812 ? (c SSL_CONNECTION *)(ssl) \
1814 # define SSL_CONNECTION_NO_CONST
1815 # define SSL_CONNECTION_FROM_SSL_ONLY(ssl) \
1816 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1817 # define SSL_CONNECTION_FROM_CONST_SSL_ONLY(ssl) \
1818 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1819 # define SSL_CONNECTION_GET_CTX(sc) ((sc)->ssl.ctx)
1820 # define SSL_CONNECTION_GET_SSL(sc) (&(sc)->ssl)
1821 # ifndef OPENSSL_NO_QUIC
1822 # include "quic/quic_local.h"
1823 # define SSL_CONNECTION_FROM_SSL_int(ssl, c) \
1824 ((ssl) == NULL ? NULL \
1825 : ((ssl)->type == SSL_TYPE_SSL_CONNECTION \
1826 ? (c SSL_CONNECTION *)(ssl) \
1827 : ((ssl)->type == SSL_TYPE_QUIC_CONNECTION \
1828 ? (c SSL_CONNECTION *)((c QUIC_CONNECTION *)(ssl))->tls \
1830 # define SSL_CONNECTION_FROM_SSL(ssl) \
1831 SSL_CONNECTION_FROM_SSL_int(ssl, SSL_CONNECTION_NO_CONST)
1832 # define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1833 SSL_CONNECTION_FROM_SSL_int(ssl, const)
1835 # define SSL_CONNECTION_FROM_SSL(ssl) \
1836 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1837 # define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1838 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1842 * Structure containing table entry of values associated with the signature
1843 * algorithms (signature scheme) extension
1845 typedef struct sigalg_lookup_st {
1846 /* TLS 1.3 signature scheme name */
1848 /* Raw value used in extension */
1850 /* NID of hash algorithm or NID_undef if no hash */
1852 /* Index of hash algorithm or -1 if no hash algorithm */
1854 /* NID of signature algorithm */
1856 /* Index of signature algorithm */
1858 /* Combined hash and signature NID, if any */
1860 /* Required public key curve (ECDSA only) */
1862 /* Whether this signature algorithm is actually available for use */
1866 /* DTLS structures */
1868 # ifndef OPENSSL_NO_SCTP
1869 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1872 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1873 # define DTLS1_MAX_MTU_OVERHEAD 48
1876 * Flag used in message reuse to indicate the buffer contains the record
1877 * header as well as the handshake message header.
1879 # define DTLS1_SKIP_RECORD_HEADER 2
1881 struct dtls1_retransmit_state {
1882 const OSSL_RECORD_METHOD *wrlmethod;
1883 OSSL_RECORD_LAYER *wrl;
1886 struct hm_header_st {
1892 unsigned int is_ccs;
1893 struct dtls1_retransmit_state saved_retransmit_state;
1896 typedef struct hm_fragment_st {
1897 struct hm_header_st msg_header;
1898 unsigned char *fragment;
1899 unsigned char *reassembly;
1902 typedef struct pqueue_st pqueue;
1903 typedef struct pitem_st pitem;
1906 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1911 typedef struct pitem_st *piterator;
1913 pitem *pitem_new(unsigned char *prio64be, void *data);
1914 void pitem_free(pitem *item);
1915 pqueue *pqueue_new(void);
1916 void pqueue_free(pqueue *pq);
1917 pitem *pqueue_insert(pqueue *pq, pitem *item);
1918 pitem *pqueue_peek(pqueue *pq);
1919 pitem *pqueue_pop(pqueue *pq);
1920 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1921 pitem *pqueue_iterator(pqueue *pq);
1922 pitem *pqueue_next(piterator *iter);
1923 size_t pqueue_size(pqueue *pq);
1925 typedef struct dtls1_state_st {
1926 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1928 unsigned int cookie_verified;
1929 /* handshake message numbers */
1930 unsigned short handshake_write_seq;
1931 unsigned short next_handshake_write_seq;
1932 unsigned short handshake_read_seq;
1933 /* Buffered handshake messages */
1934 pqueue *buffered_messages;
1935 /* Buffered (sent) handshake records */
1936 pqueue *sent_messages;
1937 size_t link_mtu; /* max on-the-wire DTLS packet size */
1938 size_t mtu; /* max DTLS packet size */
1939 struct hm_header_st w_msg_hdr;
1940 struct hm_header_st r_msg_hdr;
1941 /* Number of alerts received so far */
1942 unsigned int timeout_num_alerts;
1944 * Indicates when the last handshake msg sent will timeout
1946 OSSL_TIME next_timeout;
1947 /* Timeout duration */
1948 unsigned int timeout_duration_us;
1950 unsigned int retransmitting;
1951 # ifndef OPENSSL_NO_SCTP
1952 int shutdown_received;
1955 DTLS_timer_cb timer_cb;
1960 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1962 # define EXPLICIT_PRIME_CURVE_TYPE 1
1963 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1964 # define NAMED_CURVE_TYPE 3
1966 # ifndef OPENSSL_NO_COMP_ALG
1967 struct ossl_comp_cert_st {
1968 unsigned char *data;
1971 CRYPTO_REF_COUNT references;
1974 typedef struct ossl_comp_cert_st OSSL_COMP_CERT;
1976 void OSSL_COMP_CERT_free(OSSL_COMP_CERT *c);
1977 int OSSL_COMP_CERT_up_ref(OSSL_COMP_CERT *c);
1980 struct cert_pkey_st {
1982 EVP_PKEY *privatekey;
1983 /* Chain for this certificate */
1984 STACK_OF(X509) *chain;
1986 * serverinfo data for this certificate. The data is in TLS Extension
1987 * wire format, specifically it's a series of records like:
1988 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1990 * uint8_t data[length];
1992 unsigned char *serverinfo;
1993 size_t serverinfo_length;
1994 # ifndef OPENSSL_NO_COMP_ALG
1995 /* Compressed certificate data - index 0 is unused */
1996 OSSL_COMP_CERT *comp_cert[TLSEXT_comp_cert_limit];
2000 /* Retrieve Suite B flags */
2001 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
2002 /* Uses to check strict mode: suite B modes are always strict */
2003 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
2004 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
2007 ENDPOINT_CLIENT = 0,
2014 unsigned short ext_type;
2016 /* The context which this extension applies to */
2017 unsigned int context;
2019 * Per-connection flags relating to this extension type: not used if
2020 * part of an SSL_CTX structure.
2023 SSL_custom_ext_add_cb_ex add_cb;
2024 SSL_custom_ext_free_cb_ex free_cb;
2026 SSL_custom_ext_parse_cb_ex parse_cb;
2028 } custom_ext_method;
2030 /* ext_flags values */
2033 * Indicates an extension has been received. Used to check for unsolicited or
2034 * duplicate extensions.
2036 # define SSL_EXT_FLAG_RECEIVED 0x1
2038 * Indicates an extension has been sent: used to enable sending of
2039 * corresponding ServerHello extension.
2041 # define SSL_EXT_FLAG_SENT 0x2
2044 custom_ext_method *meths;
2046 } custom_ext_methods;
2048 typedef struct cert_st {
2049 /* Current active set */
2051 * ALWAYS points to an element of the pkeys array
2052 * Probably it would make more sense to store
2053 * an index, not a pointer.
2058 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
2060 /* Flags related to certificates */
2061 uint32_t cert_flags;
2063 size_t ssl_pkey_num;
2064 /* Custom certificate types sent in certificate request message. */
2068 * supported signature algorithms. When set on a client this is sent in
2069 * the client hello as the supported signature algorithms extension. For
2070 * servers it represents the signature algorithms we are willing to use.
2072 uint16_t *conf_sigalgs;
2073 /* Size of above array */
2074 size_t conf_sigalgslen;
2076 * Client authentication signature algorithms, if not set then uses
2077 * conf_sigalgs. On servers these will be the signature algorithms sent
2078 * to the client in a certificate request for TLS 1.2. On a client this
2079 * represents the signature algorithms we are willing to use for client
2082 uint16_t *client_sigalgs;
2083 /* Size of above array */
2084 size_t client_sigalgslen;
2086 * Certificate setup callback: if set is called whenever a certificate
2087 * may be required (client or server). the callback can then examine any
2088 * appropriate parameters and setup any certificates required. This
2089 * allows advanced applications to select certificates on the fly: for
2090 * example based on supported signature algorithms or curves.
2092 int (*cert_cb) (SSL *ssl, void *arg);
2095 * Optional X509_STORE for chain building or certificate validation If
2096 * NULL the parent SSL_CTX store is used instead.
2098 X509_STORE *chain_store;
2099 X509_STORE *verify_store;
2100 /* Custom extensions */
2101 custom_ext_methods custext;
2102 /* Security callback */
2103 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
2104 void *other, void *ex);
2105 /* Security level */
2108 # ifndef OPENSSL_NO_PSK
2109 /* If not NULL psk identity hint to use for servers */
2110 char *psk_identity_hint;
2112 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
2115 # define FP_ICC (int (*)(const void *,const void *))
2118 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
2119 * of a mess of functions, but hell, think of it as an opaque structure :-)
2121 typedef struct ssl3_enc_method {
2122 int (*setup_key_block) (SSL_CONNECTION *);
2123 int (*generate_master_secret) (SSL_CONNECTION *, unsigned char *,
2124 unsigned char *, size_t, size_t *);
2125 int (*change_cipher_state) (SSL_CONNECTION *, int);
2126 size_t (*final_finish_mac) (SSL_CONNECTION *, const char *, size_t,
2128 const char *client_finished_label;
2129 size_t client_finished_label_len;
2130 const char *server_finished_label;
2131 size_t server_finished_label_len;
2132 int (*alert_value) (int);
2133 int (*export_keying_material) (SSL_CONNECTION *, unsigned char *, size_t,
2134 const char *, size_t,
2135 const unsigned char *, size_t,
2137 /* Various flags indicating protocol version requirements */
2139 /* Set the handshake header */
2140 int (*set_handshake_header) (SSL_CONNECTION *s, WPACKET *pkt, int type);
2141 /* Close construction of the handshake message */
2142 int (*close_construct_packet) (SSL_CONNECTION *s, WPACKET *pkt, int htype);
2143 /* Write out handshake message */
2144 int (*do_write) (SSL_CONNECTION *s);
2147 # define ssl_set_handshake_header(s, pkt, htype) \
2148 SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2149 # define ssl_close_construct_packet(s, pkt, htype) \
2150 SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2151 # define ssl_do_write(s) SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->do_write(s)
2153 /* Values for enc_flags */
2155 /* Uses explicit IV for CBC mode */
2156 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
2157 /* Uses signature algorithms extension */
2158 # define SSL_ENC_FLAG_SIGALGS 0x2
2159 /* Uses SHA256 default PRF */
2160 # define SSL_ENC_FLAG_SHA256_PRF 0x4
2162 # define SSL_ENC_FLAG_DTLS 0x8
2164 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2165 * apply to others in future.
2167 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2169 typedef enum downgrade_en {
2176 * Dummy status type for the status_type extension. Indicates no status type
2179 #define TLSEXT_STATUSTYPE_nothing -1
2181 /* Sigalgs values */
2182 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2183 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2184 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2185 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2186 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2187 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2188 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2189 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2190 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2191 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2192 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2193 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2194 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2195 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2196 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2197 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2198 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2199 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2200 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2201 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2202 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2203 #define TLSEXT_SIGALG_gostr34102012_256_intrinsic 0x0840
2204 #define TLSEXT_SIGALG_gostr34102012_512_intrinsic 0x0841
2205 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2206 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2207 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2209 #define TLSEXT_SIGALG_ed25519 0x0807
2210 #define TLSEXT_SIGALG_ed448 0x0808
2211 #define TLSEXT_SIGALG_ecdsa_brainpoolP256r1_sha256 0x081a
2212 #define TLSEXT_SIGALG_ecdsa_brainpoolP384r1_sha384 0x081b
2213 #define TLSEXT_SIGALG_ecdsa_brainpoolP512r1_sha512 0x081c
2215 /* Known PSK key exchange modes */
2216 #define TLSEXT_KEX_MODE_KE 0x00
2217 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2220 * Internal representations of key exchange modes
2222 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2223 #define TLSEXT_KEX_MODE_FLAG_KE 1
2224 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2226 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2227 s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2229 /* A dummy signature value not valid for TLSv1.2 signature algs */
2230 #define TLSEXT_signature_rsa_pss 0x0101
2232 /* TLSv1.3 downgrade protection sentinel values */
2233 extern const unsigned char tls11downgrade[8];
2234 extern const unsigned char tls12downgrade[8];
2236 extern const SSL3_ENC_METHOD ssl3_undef_enc_method;
2238 __owur const SSL_METHOD *sslv3_method(void);
2239 __owur const SSL_METHOD *sslv3_server_method(void);
2240 __owur const SSL_METHOD *sslv3_client_method(void);
2241 __owur const SSL_METHOD *tlsv1_method(void);
2242 __owur const SSL_METHOD *tlsv1_server_method(void);
2243 __owur const SSL_METHOD *tlsv1_client_method(void);
2244 __owur const SSL_METHOD *tlsv1_1_method(void);
2245 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2246 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2247 __owur const SSL_METHOD *tlsv1_2_method(void);
2248 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2249 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2250 __owur const SSL_METHOD *tlsv1_3_method(void);
2251 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2252 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2253 __owur const SSL_METHOD *dtlsv1_method(void);
2254 __owur const SSL_METHOD *dtlsv1_server_method(void);
2255 __owur const SSL_METHOD *dtlsv1_client_method(void);
2256 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2257 __owur const SSL_METHOD *dtlsv1_2_method(void);
2258 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2259 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2261 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2262 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2263 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2264 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2265 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2266 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2267 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2270 * Flags for SSL methods
2272 # define SSL_METHOD_NO_FIPS (1U<<0)
2273 # define SSL_METHOD_NO_SUITEB (1U<<1)
2275 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2276 s_connect, enc_data) \
2277 const SSL_METHOD *func_name(void) \
2279 static const SSL_METHOD func_name##_data= { \
2283 ossl_ssl_connection_new, \
2284 ossl_ssl_connection_free, \
2285 ossl_ssl_connection_reset, \
2296 ssl3_renegotiate_check, \
2299 ssl3_dispatch_alert, \
2302 ssl3_get_cipher_by_char, \
2303 ssl3_put_cipher_by_char, \
2307 tls1_default_timeout, \
2309 ssl_undefined_void_function, \
2310 ssl3_callback_ctrl, \
2311 ssl3_ctx_callback_ctrl, \
2313 return &func_name##_data; \
2316 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2317 const SSL_METHOD *func_name(void) \
2319 static const SSL_METHOD func_name##_data= { \
2321 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2323 ossl_ssl_connection_new, \
2324 ossl_ssl_connection_free, \
2325 ossl_ssl_connection_reset, \
2336 ssl3_renegotiate_check, \
2339 ssl3_dispatch_alert, \
2342 ssl3_get_cipher_by_char, \
2343 ssl3_put_cipher_by_char, \
2347 ssl3_default_timeout, \
2349 ssl_undefined_void_function, \
2350 ssl3_callback_ctrl, \
2351 ssl3_ctx_callback_ctrl, \
2353 return &func_name##_data; \
2356 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2357 s_connect, enc_data) \
2358 const SSL_METHOD *func_name(void) \
2360 static const SSL_METHOD func_name##_data= { \
2364 ossl_ssl_connection_new, \
2365 ossl_ssl_connection_free, \
2366 ossl_ssl_connection_reset, \
2377 ssl3_renegotiate_check, \
2379 dtls1_write_app_data_bytes, \
2380 dtls1_dispatch_alert, \
2383 ssl3_get_cipher_by_char, \
2384 ssl3_put_cipher_by_char, \
2388 dtls1_default_timeout, \
2390 ssl_undefined_void_function, \
2391 ssl3_callback_ctrl, \
2392 ssl3_ctx_callback_ctrl, \
2394 return &func_name##_data; \
2397 struct openssl_ssl_test_functions {
2398 int (*p_ssl_init_wbio_buffer) (SSL_CONNECTION *s);
2401 const char *ssl_protocol_to_string(int version);
2403 static ossl_inline int tls12_rpk_and_privkey(const SSL_CONNECTION *sc, int idx)
2406 * This is to check for special cases when using RPK with just
2407 * a private key, and NO CERTIFICATE
2409 return ((sc->server && sc->ext.server_cert_type == TLSEXT_cert_type_rpk)
2410 || (!sc->server && sc->ext.client_cert_type == TLSEXT_cert_type_rpk))
2411 && sc->cert->pkeys[idx].privatekey != NULL
2412 && sc->cert->pkeys[idx].x509 == NULL;
2415 static ossl_inline int ssl_has_cert_type(const SSL_CONNECTION *sc, unsigned char ct)
2421 ptr = sc->server_cert_type;
2422 len = sc->server_cert_type_len;
2424 ptr = sc->client_cert_type;
2425 len = sc->client_cert_type_len;
2431 return memchr(ptr, ct, len) != NULL;
2434 /* Returns true if certificate and private key for 'idx' are present */
2435 static ossl_inline int ssl_has_cert(const SSL_CONNECTION *s, int idx)
2437 if (idx < 0 || idx >= (int)s->ssl_pkey_num)
2440 /* If RPK is enabled for this SSL... only require private key */
2441 if (ssl_has_cert_type(s, TLSEXT_cert_type_rpk))
2442 return s->cert->pkeys[idx].privatekey != NULL;
2444 return s->cert->pkeys[idx].x509 != NULL
2445 && s->cert->pkeys[idx].privatekey != NULL;
2448 static ossl_inline void tls1_get_peer_groups(SSL_CONNECTION *s,
2449 const uint16_t **pgroups,
2452 *pgroups = s->ext.peer_supportedgroups;
2453 *pgroupslen = s->ext.peer_supportedgroups_len;
2456 # ifndef OPENSSL_UNIT_TEST
2458 __owur int ossl_ssl_init(SSL *ssl, SSL_CTX *ctx, const SSL_METHOD *method,
2460 __owur SSL *ossl_ssl_connection_new_int(SSL_CTX *ctx, const SSL_METHOD *method);
2461 __owur SSL *ossl_ssl_connection_new(SSL_CTX *ctx);
2462 void ossl_ssl_connection_free(SSL *ssl);
2463 __owur int ossl_ssl_connection_reset(SSL *ssl);
2465 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2466 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num,
2467 uint64_t flags, size_t *written);
2468 int ssl_clear_bad_session(SSL_CONNECTION *s);
2469 __owur CERT *ssl_cert_new(size_t ssl_pkey_num);
2470 __owur CERT *ssl_cert_dup(CERT *cert);
2471 void ssl_cert_clear_certs(CERT *c);
2472 void ssl_cert_free(CERT *c);
2473 __owur int ssl_generate_session_id(SSL_CONNECTION *s, SSL_SESSION *ss);
2474 __owur int ssl_get_new_session(SSL_CONNECTION *s, int session);
2475 __owur SSL_SESSION *lookup_sess_in_cache(SSL_CONNECTION *s,
2476 const unsigned char *sess_id,
2477 size_t sess_id_len);
2478 __owur int ssl_get_prev_session(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello);
2479 __owur SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket);
2480 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2481 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2482 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2483 const SSL_CIPHER *const *bp);
2484 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(SSL_CTX *ctx,
2485 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2486 STACK_OF(SSL_CIPHER) **cipher_list,
2487 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2488 const char *rule_str,
2490 __owur int ssl_cache_cipherlist(SSL_CONNECTION *s, PACKET *cipher_suites,
2492 __owur int ossl_bytes_to_cipher_list(SSL_CONNECTION *s, PACKET *cipher_suites,
2493 STACK_OF(SSL_CIPHER) **skp,
2494 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2496 void ssl_update_cache(SSL_CONNECTION *s, int mode);
2497 __owur int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
2498 const EVP_CIPHER **enc);
2499 __owur int ssl_cipher_get_evp(SSL_CTX *ctxc, const SSL_SESSION *s,
2500 const EVP_CIPHER **enc, const EVP_MD **md,
2501 int *mac_pkey_type, size_t *mac_secret_size,
2502 SSL_COMP **comp, int use_etm);
2503 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2504 size_t *int_overhead, size_t *blocksize,
2505 size_t *ext_overhead);
2506 __owur int ssl_cert_is_disabled(SSL_CTX *ctx, size_t idx);
2507 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL_CONNECTION *ssl,
2508 const unsigned char *ptr,
2510 __owur int ssl_cert_set0_chain(SSL_CONNECTION *s, SSL_CTX *ctx,
2511 STACK_OF(X509) *chain);
2512 __owur int ssl_cert_set1_chain(SSL_CONNECTION *s, SSL_CTX *ctx,
2513 STACK_OF(X509) *chain);
2514 __owur int ssl_cert_add0_chain_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x);
2515 __owur int ssl_cert_add1_chain_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x);
2516 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2517 __owur int ssl_cert_set_current(CERT *c, long arg);
2518 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2520 __owur int ssl_verify_cert_chain(SSL_CONNECTION *s, STACK_OF(X509) *sk);
2521 __owur int ssl_verify_rpk(SSL_CONNECTION *s, EVP_PKEY *rpk);
2522 __owur int ssl_build_cert_chain(SSL_CONNECTION *s, SSL_CTX *ctx, int flags);
2523 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2525 __owur int ssl_cert_get_cert_store(CERT *c, X509_STORE **pstore, int chain);
2527 __owur int ssl_security(const SSL_CONNECTION *s, int op, int bits, int nid,
2529 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2531 int ssl_get_security_level_bits(const SSL *s, const SSL_CTX *ctx, int *levelp);
2533 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx, SSL_CTX *ctx);
2534 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2537 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx, SSL_CTX *ctx);
2539 int ssl_undefined_function(SSL *s);
2540 __owur int ssl_undefined_void_function(void);
2541 __owur int ssl_undefined_const_function(const SSL *s);
2542 __owur int ssl_get_server_cert_serverinfo(SSL_CONNECTION *s,
2543 const unsigned char **serverinfo,
2544 size_t *serverinfo_length);
2545 void ssl_set_masks(SSL_CONNECTION *s);
2546 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL_CONNECTION *sc);
2547 __owur int ssl_x509err2alert(int type);
2548 void ssl_sort_cipher_list(void);
2549 int ssl_load_ciphers(SSL_CTX *ctx);
2550 __owur int ssl_setup_sigalgs(SSL_CTX *ctx);
2551 int ssl_load_groups(SSL_CTX *ctx);
2552 int ssl_load_sigalgs(SSL_CTX *ctx);
2553 __owur int ssl_fill_hello_random(SSL_CONNECTION *s, int server,
2554 unsigned char *field, size_t len,
2556 __owur int ssl_generate_master_secret(SSL_CONNECTION *s, unsigned char *pms,
2557 size_t pmslen, int free_pms);
2558 __owur EVP_PKEY *ssl_generate_pkey(SSL_CONNECTION *s, EVP_PKEY *pm);
2559 __owur int ssl_gensecret(SSL_CONNECTION *s, unsigned char *pms, size_t pmslen);
2560 __owur int ssl_derive(SSL_CONNECTION *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2562 __owur int ssl_decapsulate(SSL_CONNECTION *s, EVP_PKEY *privkey,
2563 const unsigned char *ct, size_t ctlen,
2565 __owur int ssl_encapsulate(SSL_CONNECTION *s, EVP_PKEY *pubkey,
2566 unsigned char **ctp, size_t *ctlenp,
2568 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2569 __owur int ssl_set_tmp_ecdh_groups(uint16_t **pext, size_t *pextlen,
2571 __owur unsigned int ssl_get_max_send_fragment(const SSL_CONNECTION *sc);
2572 __owur unsigned int ssl_get_split_send_fragment(const SSL_CONNECTION *sc);
2574 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2575 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2576 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2577 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2579 int ssl3_init_finished_mac(SSL_CONNECTION *s);
2580 __owur int ssl3_setup_key_block(SSL_CONNECTION *s);
2581 __owur int ssl3_change_cipher_state(SSL_CONNECTION *s, int which);
2582 void ssl3_cleanup_key_block(SSL_CONNECTION *s);
2583 __owur int ssl3_do_write(SSL_CONNECTION *s, uint8_t type);
2584 int ssl3_send_alert(SSL_CONNECTION *s, int level, int desc);
2585 __owur int ssl3_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2586 unsigned char *p, size_t len,
2587 size_t *secret_size);
2588 __owur int ssl3_get_req_cert_type(SSL_CONNECTION *s, WPACKET *pkt);
2589 __owur int ssl3_num_ciphers(void);
2590 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2591 int ssl3_renegotiate(SSL *ssl);
2592 int ssl3_renegotiate_check(SSL *ssl, int initok);
2593 void ssl3_digest_master_key_set_params(const SSL_SESSION *session,
2594 OSSL_PARAM params[]);
2595 __owur int ssl3_dispatch_alert(SSL *s);
2596 __owur size_t ssl3_final_finish_mac(SSL_CONNECTION *s, const char *sender,
2597 size_t slen, unsigned char *p);
2598 __owur int ssl3_finish_mac(SSL_CONNECTION *s, const unsigned char *buf,
2600 void ssl3_free_digest_list(SSL_CONNECTION *s);
2601 __owur unsigned long ssl3_output_cert_chain(SSL_CONNECTION *s, WPACKET *pkt,
2602 CERT_PKEY *cpk, int for_comp);
2603 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL_CONNECTION *s,
2604 STACK_OF(SSL_CIPHER) *clnt,
2605 STACK_OF(SSL_CIPHER) *srvr);
2606 __owur int ssl3_digest_cached_records(SSL_CONNECTION *s, int keep);
2607 __owur int ssl3_new(SSL *s);
2608 void ssl3_free(SSL *s);
2609 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2610 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2611 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2612 __owur int ssl3_shutdown(SSL *s);
2613 int ssl3_clear(SSL *s);
2614 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2615 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2616 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2617 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2619 __owur int ssl3_do_change_cipher_spec(SSL_CONNECTION *s);
2620 __owur OSSL_TIME ssl3_default_timeout(void);
2622 __owur int ssl3_set_handshake_header(SSL_CONNECTION *s, WPACKET *pkt,
2624 __owur int tls_close_construct_packet(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2625 __owur int tls_setup_handshake(SSL_CONNECTION *s);
2626 __owur int dtls1_set_handshake_header(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2627 __owur int dtls1_close_construct_packet(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2628 __owur int ssl3_handshake_write(SSL_CONNECTION *s);
2630 __owur int ssl_allow_compression(SSL_CONNECTION *s);
2632 __owur int ssl_version_cmp(const SSL_CONNECTION *s, int versiona, int versionb);
2633 __owur int ssl_version_supported(const SSL_CONNECTION *s, int version,
2634 const SSL_METHOD **meth);
2636 __owur int ssl_set_client_hello_version(SSL_CONNECTION *s);
2637 __owur int ssl_check_version_downgrade(SSL_CONNECTION *s);
2638 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2639 __owur int ssl_choose_server_version(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello,
2641 __owur int ssl_choose_client_version(SSL_CONNECTION *s, int version,
2642 RAW_EXTENSION *extensions);
2643 __owur int ssl_get_min_max_version(const SSL_CONNECTION *s, int *min_version,
2644 int *max_version, int *real_max);
2646 __owur OSSL_TIME tls1_default_timeout(void);
2647 __owur int dtls1_do_write(SSL_CONNECTION *s, uint8_t type);
2648 void dtls1_set_message_header(SSL_CONNECTION *s,
2651 size_t frag_off, size_t frag_len);
2653 int dtls1_write_app_data_bytes(SSL *s, uint8_t type, const void *buf_,
2654 size_t len, size_t *written);
2656 __owur int dtls1_read_failed(SSL_CONNECTION *s, int code);
2657 __owur int dtls1_buffer_message(SSL_CONNECTION *s, int ccs);
2658 __owur int dtls1_retransmit_message(SSL_CONNECTION *s, unsigned short seq,
2660 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2661 int dtls1_retransmit_buffered_messages(SSL_CONNECTION *s);
2662 void dtls1_clear_received_buffer(SSL_CONNECTION *s);
2663 void dtls1_clear_sent_buffer(SSL_CONNECTION *s);
2664 void dtls1_get_message_header(const unsigned char *data,
2665 struct hm_header_st *msg_hdr);
2666 __owur OSSL_TIME dtls1_default_timeout(void);
2667 __owur int dtls1_get_timeout(const SSL_CONNECTION *s, OSSL_TIME *timeleft);
2668 __owur int dtls1_check_timeout_num(SSL_CONNECTION *s);
2669 __owur int dtls1_handle_timeout(SSL_CONNECTION *s);
2670 void dtls1_start_timer(SSL_CONNECTION *s);
2671 void dtls1_stop_timer(SSL_CONNECTION *s);
2672 __owur int dtls1_is_timer_expired(SSL_CONNECTION *s);
2673 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2675 __owur size_t dtls1_min_mtu(SSL_CONNECTION *s);
2676 void dtls1_hm_fragment_free(hm_fragment *frag);
2677 __owur int dtls1_query_mtu(SSL_CONNECTION *s);
2679 __owur int tls1_new(SSL *s);
2680 void tls1_free(SSL *s);
2681 int tls1_clear(SSL *s);
2683 __owur int dtls1_new(SSL *s);
2684 void dtls1_free(SSL *s);
2685 int dtls1_clear(SSL *s);
2686 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2687 __owur int dtls1_shutdown(SSL *s);
2689 __owur int dtls1_dispatch_alert(SSL *s);
2691 __owur int ssl_init_wbio_buffer(SSL_CONNECTION *s);
2692 int ssl_free_wbio_buffer(SSL_CONNECTION *s);
2694 __owur int tls1_change_cipher_state(SSL_CONNECTION *s, int which);
2695 __owur int tls1_setup_key_block(SSL_CONNECTION *s);
2696 __owur size_t tls1_final_finish_mac(SSL_CONNECTION *s, const char *str,
2697 size_t slen, unsigned char *p);
2698 __owur int tls1_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2699 unsigned char *p, size_t len,
2700 size_t *secret_size);
2701 __owur int tls13_setup_key_block(SSL_CONNECTION *s);
2702 __owur size_t tls13_final_finish_mac(SSL_CONNECTION *s, const char *str, size_t slen,
2704 __owur int tls13_change_cipher_state(SSL_CONNECTION *s, int which);
2705 __owur int tls13_update_key(SSL_CONNECTION *s, int send);
2706 __owur int tls13_hkdf_expand(SSL_CONNECTION *s,
2708 const unsigned char *secret,
2709 const unsigned char *label, size_t labellen,
2710 const unsigned char *data, size_t datalen,
2711 unsigned char *out, size_t outlen, int fatal);
2712 __owur int tls13_hkdf_expand_ex(OSSL_LIB_CTX *libctx, const char *propq,
2714 const unsigned char *secret,
2715 const unsigned char *label, size_t labellen,
2716 const unsigned char *data, size_t datalen,
2717 unsigned char *out, size_t outlen,
2719 __owur int tls13_derive_key(SSL_CONNECTION *s, const EVP_MD *md,
2720 const unsigned char *secret, unsigned char *key,
2722 __owur int tls13_derive_iv(SSL_CONNECTION *s, const EVP_MD *md,
2723 const unsigned char *secret, unsigned char *iv,
2725 __owur int tls13_derive_finishedkey(SSL_CONNECTION *s, const EVP_MD *md,
2726 const unsigned char *secret,
2727 unsigned char *fin, size_t finlen);
2728 int tls13_generate_secret(SSL_CONNECTION *s, const EVP_MD *md,
2729 const unsigned char *prevsecret,
2730 const unsigned char *insecret,
2732 unsigned char *outsecret);
2733 __owur int tls13_generate_handshake_secret(SSL_CONNECTION *s,
2734 const unsigned char *insecret,
2735 size_t insecretlen);
2736 __owur int tls13_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2737 unsigned char *prev, size_t prevlen,
2738 size_t *secret_size);
2739 __owur int tls1_export_keying_material(SSL_CONNECTION *s,
2740 unsigned char *out, size_t olen,
2741 const char *label, size_t llen,
2742 const unsigned char *p, size_t plen,
2744 __owur int tls13_export_keying_material(SSL_CONNECTION *s,
2745 unsigned char *out, size_t olen,
2746 const char *label, size_t llen,
2747 const unsigned char *context,
2748 size_t contextlen, int use_context);
2749 __owur int tls13_export_keying_material_early(SSL_CONNECTION *s,
2750 unsigned char *out, size_t olen,
2751 const char *label, size_t llen,
2752 const unsigned char *context,
2754 __owur int tls1_alert_code(int code);
2755 __owur int tls13_alert_code(int code);
2756 __owur int ssl3_alert_code(int code);
2758 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL_CONNECTION *s);
2760 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2762 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(SSL_CTX *ctx, uint16_t curve_id);
2763 __owur const char *tls1_group_id2name(SSL_CTX *ctx, uint16_t group_id);
2764 __owur int tls1_group_id2nid(uint16_t group_id, int include_unknown);
2765 __owur uint16_t tls1_nid2group_id(int nid);
2766 __owur int tls1_check_group_id(SSL_CONNECTION *s, uint16_t group_id,
2767 int check_own_curves);
2768 __owur uint16_t tls1_shared_group(SSL_CONNECTION *s, int nmatch);
2769 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2770 int *curves, size_t ncurves);
2771 __owur int tls1_set_groups_list(SSL_CTX *ctx, uint16_t **pext, size_t *pextlen,
2773 __owur EVP_PKEY *ssl_generate_pkey_group(SSL_CONNECTION *s, uint16_t id);
2774 __owur int tls_valid_group(SSL_CONNECTION *s, uint16_t group_id, int minversion,
2775 int maxversion, int isec, int *okfortls13);
2776 __owur EVP_PKEY *ssl_generate_param_group(SSL_CONNECTION *s, uint16_t id);
2777 void tls1_get_formatlist(SSL_CONNECTION *s, const unsigned char **pformats,
2778 size_t *num_formats);
2779 __owur int tls1_check_ec_tmp_key(SSL_CONNECTION *s, unsigned long id);
2781 __owur int tls_group_allowed(SSL_CONNECTION *s, uint16_t curve, int op);
2782 void tls1_get_supported_groups(SSL_CONNECTION *s, const uint16_t **pgroups,
2783 size_t *pgroupslen);
2785 __owur int tls1_set_server_sigalgs(SSL_CONNECTION *s);
2787 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL_CONNECTION *s,
2788 CLIENTHELLO_MSG *hello,
2790 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL_CONNECTION *s,
2791 const unsigned char *etick,
2793 const unsigned char *sess_id,
2794 size_t sesslen, SSL_SESSION **psess);
2796 __owur int tls_use_ticket(SSL_CONNECTION *s);
2798 void ssl_set_sig_mask(uint32_t *pmask_a, SSL_CONNECTION *s, int op);
2800 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2801 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2803 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2805 int tls1_check_chain(SSL_CONNECTION *s, X509 *x, EVP_PKEY *pk,
2806 STACK_OF(X509) *chain, int idx);
2807 void tls1_set_cert_validity(SSL_CONNECTION *s);
2809 # ifndef OPENSSL_NO_CT
2810 __owur int ssl_validate_ct(SSL_CONNECTION *s);
2813 __owur EVP_PKEY *ssl_get_auto_dh(SSL_CONNECTION *s);
2815 __owur int ssl_security_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x, int vfy,
2817 __owur int ssl_security_cert_chain(SSL_CONNECTION *s, STACK_OF(X509) *sk,
2820 int tls_choose_sigalg(SSL_CONNECTION *s, int fatalerrs);
2822 __owur long ssl_get_algorithm2(SSL_CONNECTION *s);
2823 __owur int tls12_copy_sigalgs(SSL_CONNECTION *s, WPACKET *pkt,
2824 const uint16_t *psig, size_t psiglen);
2825 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2826 __owur int tls1_save_sigalgs(SSL_CONNECTION *s, PACKET *pkt, int cert);
2827 __owur int tls1_process_sigalgs(SSL_CONNECTION *s);
2828 __owur int tls1_set_peer_legacy_sigalg(SSL_CONNECTION *s, const EVP_PKEY *pkey);
2829 __owur int tls1_lookup_md(SSL_CTX *ctx, const SIGALG_LOOKUP *lu,
2830 const EVP_MD **pmd);
2831 __owur size_t tls12_get_psigalgs(SSL_CONNECTION *s, int sent,
2832 const uint16_t **psigs);
2833 __owur int tls_check_sigalg_curve(const SSL_CONNECTION *s, int curve);
2834 __owur int tls12_check_peer_sigalg(SSL_CONNECTION *s, uint16_t, EVP_PKEY *pkey);
2835 __owur int ssl_set_client_disabled(SSL_CONNECTION *s);
2836 __owur int ssl_cipher_disabled(const SSL_CONNECTION *s, const SSL_CIPHER *c,
2839 __owur int ssl_handshake_hash(SSL_CONNECTION *s,
2840 unsigned char *out, size_t outlen,
2842 __owur const EVP_MD *ssl_md(SSL_CTX *ctx, int idx);
2843 int ssl_get_md_idx(int md_nid);
2844 __owur const EVP_MD *ssl_handshake_md(SSL_CONNECTION *s);
2845 __owur const EVP_MD *ssl_prf_md(SSL_CONNECTION *s);
2848 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2849 * with |ssl|, if logging is enabled. It returns one on success and zero on
2850 * failure. The entry is identified by the first 8 bytes of
2851 * |encrypted_premaster|.
2853 __owur int ssl_log_rsa_client_key_exchange(SSL_CONNECTION *s,
2854 const uint8_t *encrypted_premaster,
2855 size_t encrypted_premaster_len,
2856 const uint8_t *premaster,
2857 size_t premaster_len);
2860 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2861 * logging is available. It returns one on success and zero on failure. It tags
2862 * the entry with |label|.
2864 __owur int ssl_log_secret(SSL_CONNECTION *s, const char *label,
2865 const uint8_t *secret, size_t secret_len);
2867 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2868 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2869 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2870 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2871 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2872 #define CLIENT_APPLICATION_N_LABEL "CLIENT_TRAFFIC_SECRET_N"
2873 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2874 #define SERVER_APPLICATION_N_LABEL "SERVER_TRAFFIC_SECRET_N"
2875 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2876 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2878 __owur int srp_generate_server_master_secret(SSL_CONNECTION *s);
2879 __owur int srp_generate_client_master_secret(SSL_CONNECTION *s);
2880 __owur int srp_verify_server_param(SSL_CONNECTION *s);
2882 /* statem/statem_srvr.c */
2884 __owur int send_certificate_request(SSL_CONNECTION *s);
2886 /* statem/extensions_cust.c */
2888 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2889 ENDPOINT role, unsigned int ext_type,
2892 void custom_ext_init(custom_ext_methods *meths);
2894 int ossl_tls_add_custom_ext_intern(SSL_CTX *ctx, custom_ext_methods *exts,
2895 ENDPOINT role, unsigned int ext_type,
2896 unsigned int context,
2897 SSL_custom_ext_add_cb_ex add_cb,
2898 SSL_custom_ext_free_cb_ex free_cb,
2900 SSL_custom_ext_parse_cb_ex parse_cb,
2902 __owur int custom_ext_parse(SSL_CONNECTION *s, unsigned int context,
2903 unsigned int ext_type,
2904 const unsigned char *ext_data, size_t ext_size,
2905 X509 *x, size_t chainidx);
2906 __owur int custom_ext_add(SSL_CONNECTION *s, int context, WPACKET *pkt, X509 *x,
2907 size_t chainidx, int maxversion);
2909 __owur int custom_exts_copy(custom_ext_methods *dst,
2910 const custom_ext_methods *src);
2911 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2912 const custom_ext_methods *src);
2913 void custom_exts_free(custom_ext_methods *exts);
2915 void ssl_comp_free_compression_methods_int(void);
2918 void ssl_ctx_system_config(SSL_CTX *ctx);
2920 const EVP_CIPHER *ssl_evp_cipher_fetch(OSSL_LIB_CTX *libctx,
2922 const char *properties);
2923 int ssl_evp_cipher_up_ref(const EVP_CIPHER *cipher);
2924 void ssl_evp_cipher_free(const EVP_CIPHER *cipher);
2925 const EVP_MD *ssl_evp_md_fetch(OSSL_LIB_CTX *libctx,
2927 const char *properties);
2928 int ssl_evp_md_up_ref(const EVP_MD *md);
2929 void ssl_evp_md_free(const EVP_MD *md);
2931 void tls_engine_finish(ENGINE *e);
2932 const EVP_CIPHER *tls_get_cipher_from_engine(int nid);
2933 const EVP_MD *tls_get_digest_from_engine(int nid);
2934 int tls_engine_load_ssl_client_cert(SSL_CONNECTION *s, X509 **px509,
2936 int ssl_hmac_old_new(SSL_HMAC *ret);
2937 void ssl_hmac_old_free(SSL_HMAC *ctx);
2938 int ssl_hmac_old_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
2939 int ssl_hmac_old_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
2940 int ssl_hmac_old_final(SSL_HMAC *ctx, unsigned char *md, size_t *len);
2941 size_t ssl_hmac_old_size(const SSL_HMAC *ctx);
2943 int ssl_ctx_srp_ctx_free_intern(SSL_CTX *ctx);
2944 int ssl_ctx_srp_ctx_init_intern(SSL_CTX *ctx);
2945 int ssl_srp_ctx_free_intern(SSL_CONNECTION *s);
2946 int ssl_srp_ctx_init_intern(SSL_CONNECTION *s);
2948 int ssl_srp_calc_a_param_intern(SSL_CONNECTION *s);
2949 int ssl_srp_server_param_with_username_intern(SSL_CONNECTION *s, int *ad);
2951 void ssl_session_calculate_timeout(SSL_SESSION *ss);
2953 # else /* OPENSSL_UNIT_TEST */
2955 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2959 /* Some helper routines to support TSAN operations safely */
2960 static ossl_unused ossl_inline int ssl_tsan_lock(const SSL_CTX *ctx)
2962 #ifdef TSAN_REQUIRES_LOCKING
2963 if (!CRYPTO_THREAD_write_lock(ctx->tsan_lock))
2969 static ossl_unused ossl_inline void ssl_tsan_unlock(const SSL_CTX *ctx)
2971 #ifdef TSAN_REQUIRES_LOCKING
2972 CRYPTO_THREAD_unlock(ctx->tsan_lock);
2976 static ossl_unused ossl_inline void ssl_tsan_counter(const SSL_CTX *ctx,
2977 TSAN_QUALIFIER int *stat)
2979 if (ssl_tsan_lock(ctx)) {
2981 ssl_tsan_unlock(ctx);
2985 int ossl_comp_has_alg(int a);
2986 size_t ossl_calculate_comp_expansion(int alg, size_t length);
2988 void ossl_ssl_set_custom_record_layer(SSL_CONNECTION *s,
2989 const OSSL_RECORD_METHOD *meth,
2992 long ossl_ctrl_internal(SSL *s, int cmd, long larg, void *parg, int no_quic);
2995 * Options which no longer have any effect, but which can be implemented
2996 * as no-ops for QUIC.
2998 #define OSSL_LEGACY_SSL_OPTIONS \
2999 (SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG | \
3000 SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER | \
3001 SSL_OP_SSLEAY_080_CLIENT_DH_BUG | \
3002 SSL_OP_TLS_D5_BUG | \
3003 SSL_OP_TLS_BLOCK_PADDING_BUG | \
3004 SSL_OP_MSIE_SSLV2_RSA_PADDING | \
3005 SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG | \
3006 SSL_OP_MICROSOFT_SESS_ID_BUG | \
3007 SSL_OP_NETSCAPE_CHALLENGE_BUG | \
3008 SSL_OP_PKCS1_CHECK_1 | \
3009 SSL_OP_PKCS1_CHECK_2 | \
3010 SSL_OP_SINGLE_DH_USE | \
3011 SSL_OP_SINGLE_ECDH_USE | \
3012 SSL_OP_EPHEMERAL_RSA )
3014 /* This option is undefined in public headers with no-dtls1-method. */
3015 #ifndef SSL_OP_CISCO_ANYCONNECT
3016 # define SSL_OP_CISCO_ANYCONNECT 0
3019 * Options which are no-ops under QUIC or TLSv1.3 and which are therefore
3020 * allowed but ignored under QUIC.
3022 #define OSSL_TLS1_2_OPTIONS \
3023 (SSL_OP_CRYPTOPRO_TLSEXT_BUG | \
3024 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS | \
3025 SSL_OP_ALLOW_CLIENT_RENEGOTIATION | \
3026 SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION | \
3027 SSL_OP_NO_COMPRESSION | \
3030 SSL_OP_NO_TLSv1_1 | \
3031 SSL_OP_NO_TLSv1_2 | \
3032 SSL_OP_NO_DTLSv1 | \
3033 SSL_OP_NO_DTLSv1_2 | \
3034 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | \
3035 SSL_OP_CISCO_ANYCONNECT | \
3036 SSL_OP_NO_RENEGOTIATION | \
3037 SSL_OP_NO_EXTENDED_MASTER_SECRET | \
3038 SSL_OP_NO_ENCRYPT_THEN_MAC | \
3039 SSL_OP_COOKIE_EXCHANGE | \
3040 SSL_OP_LEGACY_SERVER_CONNECT | \
3041 SSL_OP_IGNORE_UNEXPECTED_EOF )
3043 /* Total mask of connection-level options permitted or ignored under QUIC. */
3044 #define OSSL_QUIC_PERMITTED_OPTIONS_CONN \
3045 (OSSL_LEGACY_SSL_OPTIONS | \
3046 OSSL_TLS1_2_OPTIONS | \
3047 SSL_OP_CIPHER_SERVER_PREFERENCE | \
3048 SSL_OP_DISABLE_TLSEXT_CA_NAMES | \
3049 SSL_OP_NO_TX_CERTIFICATE_COMPRESSION | \
3050 SSL_OP_NO_RX_CERTIFICATE_COMPRESSION | \
3051 SSL_OP_PRIORITIZE_CHACHA | \
3052 SSL_OP_NO_QUERY_MTU | \
3053 SSL_OP_NO_TICKET | \
3054 SSL_OP_NO_ANTI_REPLAY )
3056 /* Total mask of stream-level options permitted or ignored under QUIC. */
3057 #define OSSL_QUIC_PERMITTED_OPTIONS_STREAM \
3058 (OSSL_LEGACY_SSL_OPTIONS | \
3059 OSSL_TLS1_2_OPTIONS | \
3060 SSL_OP_CLEANSE_PLAINTEXT )
3062 /* Total mask of options permitted on either connections or streams. */
3063 #define OSSL_QUIC_PERMITTED_OPTIONS \
3064 (OSSL_QUIC_PERMITTED_OPTIONS_CONN | \
3065 OSSL_QUIC_PERMITTED_OPTIONS_STREAM)