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