2 * Copyright 1995-2024 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 #ifndef OSSL_SSL_LOCAL_H
13 # define OSSL_SSL_LOCAL_H
15 # include "internal/e_os.h" /* struct timeval for DTLS */
19 # include "internal/common.h" /* for HAS_PREFIX */
21 # include <openssl/buffer.h>
22 # include <openssl/bio.h>
23 # include <openssl/comp.h>
24 # include <openssl/dsa.h>
25 # include <openssl/err.h>
26 # include <openssl/ssl.h>
27 # include <openssl/async.h>
28 # include <openssl/symhacks.h>
29 # include <openssl/ct.h>
30 # include "internal/recordmethod.h"
31 # include "internal/statem.h"
32 # include "internal/packet.h"
33 # include "internal/dane.h"
34 # include "internal/refcount.h"
35 # include "internal/tsan_assist.h"
36 # include "internal/bio.h"
37 # include "internal/ktls.h"
38 # include "internal/time.h"
39 # include "internal/ssl.h"
40 # include "internal/cryptlib.h"
41 # include "record/record.h"
43 # ifdef OPENSSL_BUILD_SHLIBSSL
44 # undef OPENSSL_EXTERN
45 # define OPENSSL_EXTERN OPENSSL_EXPORT
48 # define TLS_MAX_VERSION_INTERNAL TLS1_3_VERSION
49 # define DTLS_MAX_VERSION_INTERNAL DTLS1_2_VERSION
52 * DTLS version numbers are strange because they're inverted. Except for
53 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
55 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
56 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
57 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
58 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
59 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
61 # define SSL_AD_NO_ALERT -1
64 * Define the Bitmasks for SSL_CIPHER.algorithms.
65 * This bits are used packed as dense as possible. If new methods/ciphers
66 * etc will be added, the bits a likely to change, so this information
67 * is for internal library use only, even though SSL_CIPHER.algorithms
68 * can be publicly accessed.
69 * Use the according functions for cipher management instead.
71 * The bit mask handling in the selection and sorting scheme in
72 * ssl_create_cipher_list() has only limited capabilities, reflecting
73 * that the different entities within are mutually exclusive:
74 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
77 /* Bits for algorithm_mkey (key exchange algorithm) */
78 /* RSA key exchange */
79 # define SSL_kRSA 0x00000001U
80 /* tmp DH key no DH cert */
81 # define SSL_kDHE 0x00000002U
83 # define SSL_kEDH SSL_kDHE
85 # define SSL_kECDHE 0x00000004U
87 # define SSL_kEECDH SSL_kECDHE
89 # define SSL_kPSK 0x00000008U
90 /* GOST key exchange */
91 # define SSL_kGOST 0x00000010U
93 # define SSL_kSRP 0x00000020U
95 # define SSL_kRSAPSK 0x00000040U
96 # define SSL_kECDHEPSK 0x00000080U
97 # define SSL_kDHEPSK 0x00000100U
98 /* GOST KDF key exchange, draft-smyshlyaev-tls12-gost-suites */
99 # define SSL_kGOST18 0x00000200U
103 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
105 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
106 # define SSL_kANY 0x00000000U
108 /* Bits for algorithm_auth (server authentication) */
110 # define SSL_aRSA 0x00000001U
112 # define SSL_aDSS 0x00000002U
113 /* no auth (i.e. use ADH or AECDH) */
114 # define SSL_aNULL 0x00000004U
116 # define SSL_aECDSA 0x00000008U
118 # define SSL_aPSK 0x00000010U
119 /* GOST R 34.10-2001 signature auth */
120 # define SSL_aGOST01 0x00000020U
122 # define SSL_aSRP 0x00000040U
123 /* GOST R 34.10-2012 signature auth */
124 # define SSL_aGOST12 0x00000080U
125 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
126 # define SSL_aANY 0x00000000U
127 /* All bits requiring a certificate */
129 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
131 /* Bits for algorithm_enc (symmetric encryption) */
132 # define SSL_DES 0x00000001U
133 # define SSL_3DES 0x00000002U
134 # define SSL_RC4 0x00000004U
135 # define SSL_RC2 0x00000008U
136 # define SSL_IDEA 0x00000010U
137 # define SSL_eNULL 0x00000020U
138 # define SSL_AES128 0x00000040U
139 # define SSL_AES256 0x00000080U
140 # define SSL_CAMELLIA128 0x00000100U
141 # define SSL_CAMELLIA256 0x00000200U
142 # define SSL_eGOST2814789CNT 0x00000400U
143 # define SSL_SEED 0x00000800U
144 # define SSL_AES128GCM 0x00001000U
145 # define SSL_AES256GCM 0x00002000U
146 # define SSL_AES128CCM 0x00004000U
147 # define SSL_AES256CCM 0x00008000U
148 # define SSL_AES128CCM8 0x00010000U
149 # define SSL_AES256CCM8 0x00020000U
150 # define SSL_eGOST2814789CNT12 0x00040000U
151 # define SSL_CHACHA20POLY1305 0x00080000U
152 # define SSL_ARIA128GCM 0x00100000U
153 # define SSL_ARIA256GCM 0x00200000U
154 # define SSL_MAGMA 0x00400000U
155 # define SSL_KUZNYECHIK 0x00800000U
157 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
158 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
159 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
160 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
161 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
162 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
163 # define SSL_ARIA (SSL_ARIAGCM)
164 # define SSL_CBC (SSL_DES | SSL_3DES | SSL_RC2 | SSL_IDEA \
165 | SSL_AES128 | SSL_AES256 | SSL_CAMELLIA128 \
166 | SSL_CAMELLIA256 | SSL_SEED)
168 /* Bits for algorithm_mac (symmetric authentication) */
170 # define SSL_MD5 0x00000001U
171 # define SSL_SHA1 0x00000002U
172 # define SSL_GOST94 0x00000004U
173 # define SSL_GOST89MAC 0x00000008U
174 # define SSL_SHA256 0x00000010U
175 # define SSL_SHA384 0x00000020U
176 /* Not a real MAC, just an indication it is part of cipher */
177 # define SSL_AEAD 0x00000040U
178 # define SSL_GOST12_256 0x00000080U
179 # define SSL_GOST89MAC12 0x00000100U
180 # define SSL_GOST12_512 0x00000200U
181 # define SSL_MAGMAOMAC 0x00000400U
182 # define SSL_KUZNYECHIKOMAC 0x00000800U
185 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
186 * sure to update this constant too
189 # define SSL_MD_MD5_IDX 0
190 # define SSL_MD_SHA1_IDX 1
191 # define SSL_MD_GOST94_IDX 2
192 # define SSL_MD_GOST89MAC_IDX 3
193 # define SSL_MD_SHA256_IDX 4
194 # define SSL_MD_SHA384_IDX 5
195 # define SSL_MD_GOST12_256_IDX 6
196 # define SSL_MD_GOST89MAC12_IDX 7
197 # define SSL_MD_GOST12_512_IDX 8
198 # define SSL_MD_MD5_SHA1_IDX 9
199 # define SSL_MD_SHA224_IDX 10
200 # define SSL_MD_SHA512_IDX 11
201 # define SSL_MD_MAGMAOMAC_IDX 12
202 # define SSL_MD_KUZNYECHIKOMAC_IDX 13
203 # define SSL_MAX_DIGEST 14
205 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
207 /* Bits for algorithm2 (handshake digests and other extra flags) */
209 /* Bits 0-7 are handshake MAC */
210 # define SSL_HANDSHAKE_MAC_MASK 0xFF
211 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
212 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
213 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
214 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
215 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
216 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
217 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
219 /* Bits 8-15 bits are PRF */
220 # define TLS1_PRF_DGST_SHIFT 8
221 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
222 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
223 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
224 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
225 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
226 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
227 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
230 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
231 * goes into algorithm2)
233 # define TLS1_STREAM_MAC 0x10000
235 * TLSTREE cipher/mac key derivation from draft-smyshlyaev-tls12-gost-suites
236 * (currently this also goes into algorithm2)
238 # define TLS1_TLSTREE 0x20000
240 /* Ciphersuite supported in QUIC */
241 # define SSL_QUIC 0x00040000U
243 # define SSL_STRONG_MASK 0x0000001FU
244 # define SSL_DEFAULT_MASK 0X00000020U
246 # define SSL_STRONG_NONE 0x00000001U
247 # define SSL_LOW 0x00000002U
248 # define SSL_MEDIUM 0x00000004U
249 # define SSL_HIGH 0x00000008U
250 # define SSL_FIPS 0x00000010U
251 # define SSL_NOT_DEFAULT 0x00000020U
253 /* we have used 0000003f - 26 bits left to go */
255 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
256 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
258 /* Check if an SSL structure is using DTLS */
259 # define SSL_CONNECTION_IS_DTLS(s) \
260 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
262 /* Check if we are using TLSv1.3 */
263 # define SSL_CONNECTION_IS_TLS13(s) (!SSL_CONNECTION_IS_DTLS(s) \
264 && SSL_CONNECTION_GET_SSL(s)->method->version >= TLS1_3_VERSION \
265 && SSL_CONNECTION_GET_SSL(s)->method->version != TLS_ANY_VERSION)
267 # define SSL_CONNECTION_TREAT_AS_TLS13(s) \
268 (SSL_CONNECTION_IS_TLS13(s) \
269 || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
270 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
271 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
272 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
273 || (s)->hello_retry_request == SSL_HRR_PENDING)
275 # define SSL_IS_FIRST_HANDSHAKE(s) ((s)->s3.tmp.finish_md_len == 0 \
276 || (s)->s3.tmp.peer_finish_md_len == 0)
279 * See if we use signature algorithms extension and signature algorithm
282 # define SSL_USE_SIGALGS(s) \
283 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
285 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
286 * apply to others in future.
288 # define SSL_USE_TLS1_2_CIPHERS(s) \
289 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
291 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
292 * flags because it may not be set to correct version yet.
294 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
295 ((!SSL_CONNECTION_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
296 (SSL_CONNECTION_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
298 * Determine if a client should send signature algorithms extension:
299 * as with TLS1.2 cipher we can't rely on method flags.
301 # define SSL_CLIENT_USE_SIGALGS(s) \
302 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
304 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
305 (((value) >= TLSEXT_max_fragment_length_512) && \
306 ((value) <= TLSEXT_max_fragment_length_4096))
307 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
308 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
309 # define GET_MAX_FRAGMENT_LENGTH(session) \
310 (512U << (session->ext.max_fragment_len_mode - 1))
312 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
313 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
315 # define SSL_IS_QUIC_HANDSHAKE(s) (((s)->s3.flags & TLS1_FLAGS_QUIC) != 0)
317 /* alert_dispatch values */
319 /* No alert pending */
320 # define SSL_ALERT_DISPATCH_NONE 0
322 # define SSL_ALERT_DISPATCH_PENDING 1
323 /* Pending alert write needs to be retried */
324 # define SSL_ALERT_DISPATCH_RETRY 2
326 /* Mostly for SSLv3 */
327 # define SSL_PKEY_RSA 0
328 # define SSL_PKEY_RSA_PSS_SIGN 1
329 # define SSL_PKEY_DSA_SIGN 2
330 # define SSL_PKEY_ECC 3
331 # define SSL_PKEY_GOST01 4
332 # define SSL_PKEY_GOST12_256 5
333 # define SSL_PKEY_GOST12_512 6
334 # define SSL_PKEY_ED25519 7
335 # define SSL_PKEY_ED448 8
336 # define SSL_PKEY_NUM 9
338 # define SSL_ENC_DES_IDX 0
339 # define SSL_ENC_3DES_IDX 1
340 # define SSL_ENC_RC4_IDX 2
341 # define SSL_ENC_RC2_IDX 3
342 # define SSL_ENC_IDEA_IDX 4
343 # define SSL_ENC_NULL_IDX 5
344 # define SSL_ENC_AES128_IDX 6
345 # define SSL_ENC_AES256_IDX 7
346 # define SSL_ENC_CAMELLIA128_IDX 8
347 # define SSL_ENC_CAMELLIA256_IDX 9
348 # define SSL_ENC_GOST89_IDX 10
349 # define SSL_ENC_SEED_IDX 11
350 # define SSL_ENC_AES128GCM_IDX 12
351 # define SSL_ENC_AES256GCM_IDX 13
352 # define SSL_ENC_AES128CCM_IDX 14
353 # define SSL_ENC_AES256CCM_IDX 15
354 # define SSL_ENC_AES128CCM8_IDX 16
355 # define SSL_ENC_AES256CCM8_IDX 17
356 # define SSL_ENC_GOST8912_IDX 18
357 # define SSL_ENC_CHACHA_IDX 19
358 # define SSL_ENC_ARIA128GCM_IDX 20
359 # define SSL_ENC_ARIA256GCM_IDX 21
360 # define SSL_ENC_MAGMA_IDX 22
361 # define SSL_ENC_KUZNYECHIK_IDX 23
362 # define SSL_ENC_NUM_IDX 24
365 * SSL_kRSA <- RSA_ENC
366 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
367 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
368 * SSL_aRSA <- RSA_ENC | RSA_SIGN
369 * SSL_aDSS <- DSA_SIGN
373 #define CERT_INVALID 0
374 #define CERT_PUBLIC_KEY 1
375 #define CERT_PRIVATE_KEY 2
378 /* Certificate Type State */
379 # define OSSL_CERT_TYPE_CTOS_NONE 0
380 # define OSSL_CERT_TYPE_CTOS_GOOD 1
381 # define OSSL_CERT_TYPE_CTOS_ERROR 2
383 /* Post-Handshake Authentication state */
386 SSL_PHA_EXT_SENT
, /* client-side only: extension sent */
387 SSL_PHA_EXT_RECEIVED
, /* server-side only: extension received */
388 SSL_PHA_REQUEST_PENDING
, /* server-side only: request pending */
389 SSL_PHA_REQUESTED
/* request received by client, or sent by server */
392 /* CipherSuite length. SSLv3 and all TLS versions. */
393 # define TLS_CIPHER_LEN 2
394 /* used to hold info on the particular ciphers used */
395 struct ssl_cipher_st
{
397 const char *name
; /* text name */
398 const char *stdname
; /* RFC name */
399 uint32_t id
; /* id, 4 bytes, first is version */
401 * changed in 1.0.0: these four used to be portions of a single value
404 uint32_t algorithm_mkey
; /* key exchange algorithm */
405 uint32_t algorithm_auth
; /* server authentication */
406 uint32_t algorithm_enc
; /* symmetric encryption */
407 uint32_t algorithm_mac
; /* symmetric authentication */
408 int min_tls
; /* minimum SSL/TLS protocol version */
409 int max_tls
; /* maximum SSL/TLS protocol version */
410 int min_dtls
; /* minimum DTLS protocol version */
411 int max_dtls
; /* maximum DTLS protocol version */
412 uint32_t algo_strength
; /* strength and export flags */
413 uint32_t algorithm2
; /* Extra flags */
414 int32_t strength_bits
; /* Number of bits really used */
415 uint32_t alg_bits
; /* Number of bits for algorithm */
418 /* Used to hold SSL/TLS functions */
419 struct ssl_method_st
{
423 SSL
*(*ssl_new
) (SSL_CTX
*ctx
);
424 void (*ssl_free
) (SSL
*s
);
425 int (*ssl_reset
) (SSL
*s
);
426 int (*ssl_init
) (SSL
*s
);
427 int (*ssl_clear
) (SSL
*s
);
428 void (*ssl_deinit
) (SSL
*s
);
429 int (*ssl_accept
) (SSL
*s
);
430 int (*ssl_connect
) (SSL
*s
);
431 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
432 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
433 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
434 int (*ssl_shutdown
) (SSL
*s
);
435 int (*ssl_renegotiate
) (SSL
*s
);
436 int (*ssl_renegotiate_check
) (SSL
*s
, int);
437 int (*ssl_read_bytes
) (SSL
*s
, uint8_t type
, uint8_t *recvd_type
,
438 unsigned char *buf
, size_t len
, int peek
,
440 int (*ssl_write_bytes
) (SSL
*s
, uint8_t type
, const void *buf_
, size_t len
,
442 int (*ssl_dispatch_alert
) (SSL
*s
);
443 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
444 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
445 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
446 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
448 size_t (*ssl_pending
) (const SSL
*s
);
449 int (*num_ciphers
) (void);
450 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
451 OSSL_TIME (*get_timeout
) (void);
452 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
453 int (*ssl_version
) (void);
454 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
455 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
459 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
460 * consistency, even in the event of OPENSSL_NO_PSK being defined.
462 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 512
465 * Lets make this into an ASN.1 type structure as follows
466 * SSL_SESSION_ID ::= SEQUENCE {
467 * version INTEGER, -- structure version number
468 * SSLversion INTEGER, -- SSL version number
469 * Cipher OCTET STRING, -- the 3 byte cipher ID
470 * Session_ID OCTET STRING, -- the Session ID
471 * Master_key OCTET STRING, -- the master key
472 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
473 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
474 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
475 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
476 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
477 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
478 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
479 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
480 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
481 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
482 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
483 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
484 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
485 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
487 * Look in ssl/ssl_asn1.c for more details
488 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
490 struct ssl_session_st
{
491 int ssl_version
; /* what ssl version session info is being kept
493 size_t master_key_length
;
495 /* TLSv1.3 early_secret used for external PSKs */
496 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
498 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
501 unsigned char master_key
[TLS13_MAX_RESUMPTION_PSK_LENGTH
];
502 /* session_id - valid? */
503 size_t session_id_length
;
504 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
506 * this is used to determine whether the session is being reused in the
507 * appropriate context. It is up to the application to set this, via
510 size_t sid_ctx_length
;
511 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
512 # ifndef OPENSSL_NO_PSK
513 char *psk_identity_hint
;
517 * Used to indicate that session resumption is not allowed. Applications
518 * can also set this bit for a new session via not_resumable_session_cb
519 * to disable session caching and tickets.
522 /* Peer raw public key, if available */
524 /* This is the cert and type for the other end. */
526 /* Certificate chain peer sent. */
527 STACK_OF(X509
) *peer_chain
;
529 * when app_verify_callback accepts a session where the peer's
530 * certificate is not ok, we must remember the error for session reuse:
532 long verify_result
; /* only for servers */
533 CRYPTO_REF_COUNT references
;
536 OSSL_TIME calc_timeout
;
537 unsigned int compress_meth
; /* Need to lookup the method */
538 const SSL_CIPHER
*cipher
;
539 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
540 * load the 'cipher' structure */
541 unsigned int kex_group
; /* TLS group from key exchange */
542 CRYPTO_EX_DATA ex_data
; /* application specific data */
544 * These are used to make removal of session-ids more efficient and to
545 * implement a maximum cache size.
547 struct ssl_session_st
*prev
, *next
;
552 unsigned char *tick
; /* Session ticket */
553 size_t ticklen
; /* Session ticket length */
554 /* Session lifetime hint in seconds */
555 unsigned long tick_lifetime_hint
;
556 uint32_t tick_age_add
;
557 /* Max number of bytes that can be sent as early data */
558 uint32_t max_early_data
;
559 /* The ALPN protocol selected for this session */
560 unsigned char *alpn_selected
;
561 size_t alpn_selected_len
;
563 * Maximum Fragment Length as per RFC 4366.
564 * If this value does not contain RFC 4366 allowed values (1-4) then
565 * either the Maximum Fragment Length Negotiation failed or was not
568 uint8_t max_fragment_len_mode
;
570 # ifndef OPENSSL_NO_SRP
573 unsigned char *ticket_appdata
;
574 size_t ticket_appdata_len
;
579 /* Extended master secret support */
580 # define SSL_SESS_FLAG_EXTMS 0x1
582 # ifndef OPENSSL_NO_SRP
584 typedef struct srp_ctx_st
{
585 /* param for all the callbacks */
587 /* set client Hello login callback */
588 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
589 /* set SRP N/g param callback for verification */
590 int (*SRP_verify_param_callback
) (SSL
*, void *);
591 /* set SRP client passwd callback */
592 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
594 BIGNUM
*N
, *g
, *s
, *B
, *A
;
598 unsigned long srp_Mask
;
604 SSL_EARLY_DATA_NONE
= 0,
605 SSL_EARLY_DATA_CONNECT_RETRY
,
606 SSL_EARLY_DATA_CONNECTING
,
607 SSL_EARLY_DATA_WRITE_RETRY
,
608 SSL_EARLY_DATA_WRITING
,
609 SSL_EARLY_DATA_WRITE_FLUSH
,
610 SSL_EARLY_DATA_UNAUTH_WRITING
,
611 SSL_EARLY_DATA_FINISHED_WRITING
,
612 SSL_EARLY_DATA_ACCEPT_RETRY
,
613 SSL_EARLY_DATA_ACCEPTING
,
614 SSL_EARLY_DATA_READ_RETRY
,
615 SSL_EARLY_DATA_READING
,
616 SSL_EARLY_DATA_FINISHED_READING
617 } SSL_EARLY_DATA_STATE
;
620 * We check that the amount of unreadable early data doesn't exceed
621 * max_early_data. max_early_data is given in plaintext bytes. However if it is
622 * unreadable then we only know the number of ciphertext bytes. We also don't
623 * know how much the overhead should be because it depends on the ciphersuite.
624 * We make a small allowance. We assume 5 records of actual data plus the end
625 * of early data alert record. Each record has a tag and a content type byte.
626 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
627 * content of the alert record either which is 2 bytes.
629 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
632 * The allowance we have between the client's calculated ticket age and our own.
633 * We allow for 10 seconds. If a ticket is presented and the
634 * client's age calculation is different by more than this than our own then we
635 * do not allow that ticket for early_data.
637 # define TICKET_AGE_ALLOWANCE ossl_seconds2time(10)
639 #define MAX_COMPRESSIONS_SIZE 255
642 typedef struct raw_extension_st
{
643 /* Raw packet data for the extension */
645 /* Set to 1 if the extension is present or 0 otherwise */
647 /* Set to 1 if we have already parsed the extension or 0 otherwise */
649 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
651 /* Track what order extensions are received in (0-based). */
652 size_t received_order
;
657 unsigned int legacy_version
;
658 unsigned char random
[SSL3_RANDOM_SIZE
];
659 size_t session_id_len
;
660 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
661 size_t dtls_cookie_len
;
662 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
664 size_t compressions_len
;
665 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
667 size_t pre_proc_exts_len
;
668 RAW_EXTENSION
*pre_proc_exts
;
672 * Extension index values NOTE: Any updates to these defines should be mirrored
673 * with equivalent updates to ext_defs in extensions.c
675 typedef enum tlsext_index_en
{
676 TLSEXT_IDX_renegotiate
,
677 TLSEXT_IDX_server_name
,
678 TLSEXT_IDX_max_fragment_length
,
680 TLSEXT_IDX_ec_point_formats
,
681 TLSEXT_IDX_supported_groups
,
682 TLSEXT_IDX_session_ticket
,
683 TLSEXT_IDX_status_request
,
684 TLSEXT_IDX_next_proto_neg
,
685 TLSEXT_IDX_application_layer_protocol_negotiation
,
687 TLSEXT_IDX_encrypt_then_mac
,
688 TLSEXT_IDX_signed_certificate_timestamp
,
689 TLSEXT_IDX_extended_master_secret
,
690 TLSEXT_IDX_signature_algorithms_cert
,
691 TLSEXT_IDX_post_handshake_auth
,
692 TLSEXT_IDX_client_cert_type
,
693 TLSEXT_IDX_server_cert_type
,
694 TLSEXT_IDX_signature_algorithms
,
695 TLSEXT_IDX_supported_versions
,
696 TLSEXT_IDX_psk_kex_modes
,
697 TLSEXT_IDX_key_share
,
699 TLSEXT_IDX_cryptopro_bug
,
700 TLSEXT_IDX_compress_certificate
,
701 TLSEXT_IDX_early_data
,
702 TLSEXT_IDX_certificate_authorities
,
705 /* Dummy index - must always be the last entry */
706 TLSEXT_IDX_num_builtins
709 DEFINE_LHASH_OF_EX(SSL_SESSION
);
710 /* Needed in ssl_cert.c */
711 DEFINE_LHASH_OF_EX(X509_NAME
);
713 # define TLSEXT_KEYNAME_LENGTH 16
714 # define TLSEXT_TICK_KEY_LENGTH 32
716 typedef struct ssl_ctx_ext_secure_st
{
717 unsigned char tick_hmac_key
[TLSEXT_TICK_KEY_LENGTH
];
718 unsigned char tick_aes_key
[TLSEXT_TICK_KEY_LENGTH
];
719 } SSL_CTX_EXT_SECURE
;
722 * Helper function for HMAC
723 * The structure should be considered opaque, it will change once the low
724 * level deprecated calls are removed. At that point it can be replaced
725 * by EVP_MAC_CTX and most of the functions converted to macros or inlined
728 typedef struct ssl_hmac_st
{
730 # ifndef OPENSSL_NO_DEPRECATED_3_0
735 SSL_HMAC
*ssl_hmac_new(const SSL_CTX
*ctx
);
736 void ssl_hmac_free(SSL_HMAC
*ctx
);
737 # ifndef OPENSSL_NO_DEPRECATED_3_0
738 HMAC_CTX
*ssl_hmac_get0_HMAC_CTX(SSL_HMAC
*ctx
);
740 EVP_MAC_CTX
*ssl_hmac_get0_EVP_MAC_CTX(SSL_HMAC
*ctx
);
741 int ssl_hmac_init(SSL_HMAC
*ctx
, void *key
, size_t len
, char *md
);
742 int ssl_hmac_update(SSL_HMAC
*ctx
, const unsigned char *data
, size_t len
);
743 int ssl_hmac_final(SSL_HMAC
*ctx
, unsigned char *md
, size_t *len
,
745 size_t ssl_hmac_size(const SSL_HMAC
*ctx
);
747 int ssl_get_EC_curve_nid(const EVP_PKEY
*pkey
);
748 __owur
int tls13_set_encoded_pub_key(EVP_PKEY
*pkey
,
749 const unsigned char *enckey
,
752 typedef struct tls_group_info_st
{
753 char *tlsname
; /* Curve Name as in TLS specs */
754 char *realname
; /* Curve Name according to provider */
755 char *algorithm
; /* Algorithm name to fetch */
756 unsigned int secbits
; /* Bits of security (from SP800-57) */
757 uint16_t group_id
; /* Group ID */
758 int mintls
; /* Minimum TLS version, -1 unsupported */
759 int maxtls
; /* Maximum TLS version (or 0 for undefined) */
760 int mindtls
; /* Minimum DTLS version, -1 unsupported */
761 int maxdtls
; /* Maximum DTLS version (or 0 for undefined) */
762 char is_kem
; /* Mode for this Group: 0 is KEX, 1 is KEM */
765 typedef struct tls_sigalg_info_st
{
766 char *name
; /* name as in IANA TLS specs */
767 uint16_t code_point
; /* IANA-specified code point of sigalg-name */
768 char *sigalg_name
; /* (combined) sigalg name */
769 char *sigalg_oid
; /* (combined) sigalg OID */
770 char *sig_name
; /* pure signature algorithm name */
771 char *sig_oid
; /* pure signature algorithm OID */
772 char *hash_name
; /* hash algorithm name */
773 char *hash_oid
; /* hash algorithm OID */
774 char *keytype
; /* keytype name */
775 char *keytype_oid
; /* keytype OID */
776 unsigned int secbits
; /* Bits of security (from SP800-57) */
777 int mintls
; /* Minimum TLS version, -1 unsupported */
778 int maxtls
; /* Maximum TLS version (or 0 for undefined) */
782 * Structure containing table entry of certificate info corresponding to
786 int nid
; /* NID of public key algorithm */
787 uint32_t amask
; /* authmask corresponding to key type */
791 # define TLS_GROUP_TYPE 0x0000000FU /* Mask for group type */
792 # define TLS_GROUP_CURVE_PRIME 0x00000001U
793 # define TLS_GROUP_CURVE_CHAR2 0x00000002U
794 # define TLS_GROUP_CURVE_CUSTOM 0x00000004U
795 # define TLS_GROUP_FFDHE 0x00000008U
796 # define TLS_GROUP_ONLY_FOR_TLS1_3 0x00000010U
798 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
801 OSSL_LIB_CTX
*libctx
;
803 const SSL_METHOD
*method
;
804 STACK_OF(SSL_CIPHER
) *cipher_list
;
805 /* same as above but sorted for lookup */
806 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
807 /* TLSv1.3 specific ciphersuites */
808 STACK_OF(SSL_CIPHER
) *tls13_ciphersuites
;
809 struct x509_store_st
/* X509_STORE */ *cert_store
;
810 LHASH_OF(SSL_SESSION
) *sessions
;
812 * Most session-ids that will be cached, default is
813 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
815 size_t session_cache_size
;
816 struct ssl_session_st
*session_cache_head
;
817 struct ssl_session_st
*session_cache_tail
;
819 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
820 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
821 * means only SSL_accept will cache SSL_SESSIONS.
823 uint32_t session_cache_mode
;
825 * If timeout is not 0, it is the default timeout value set when
826 * SSL_new() is called. This has been put in to make life easier to set
829 OSSL_TIME session_timeout
;
831 * If this callback is not null, it will be called each time a session id
832 * is added to the cache. If this function returns 1, it means that the
833 * callback will do a SSL_SESSION_free() when it has finished using it.
834 * Otherwise, on 0, it means the callback has finished with it. If
835 * remove_session_cb is not null, it will be called when a session-id is
836 * removed from the cache. After the call, OpenSSL will
837 * SSL_SESSION_free() it.
839 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
840 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
841 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
842 const unsigned char *data
, int len
,
845 TSAN_QUALIFIER
int sess_connect
; /* SSL new conn - started */
846 TSAN_QUALIFIER
int sess_connect_renegotiate
; /* SSL reneg - requested */
847 TSAN_QUALIFIER
int sess_connect_good
; /* SSL new conne/reneg - finished */
848 TSAN_QUALIFIER
int sess_accept
; /* SSL new accept - started */
849 TSAN_QUALIFIER
int sess_accept_renegotiate
; /* SSL reneg - requested */
850 TSAN_QUALIFIER
int sess_accept_good
; /* SSL accept/reneg - finished */
851 TSAN_QUALIFIER
int sess_miss
; /* session lookup misses */
852 TSAN_QUALIFIER
int sess_timeout
; /* reuse attempt on timeouted session */
853 TSAN_QUALIFIER
int sess_cache_full
; /* session removed due to full cache */
854 TSAN_QUALIFIER
int sess_hit
; /* session reuse actually done */
855 TSAN_QUALIFIER
int sess_cb_hit
; /* session-id that was not in
856 * the cache was passed back via
857 * the callback. This indicates
858 * that the application is
859 * supplying session-id's from
860 * other processes - spooky
863 #ifdef TSAN_REQUIRES_LOCKING
864 CRYPTO_RWLOCK
*tsan_lock
;
867 CRYPTO_REF_COUNT references
;
869 /* if defined, these override the X509_verify_cert() calls */
870 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
871 void *app_verify_arg
;
873 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
874 * ('app_verify_callback' was called with just one argument)
877 /* Default password callback. */
878 pem_password_cb
*default_passwd_callback
;
880 /* Default password callback user data. */
881 void *default_passwd_callback_userdata
;
883 /* get client cert callback */
884 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
886 /* cookie generate callback */
887 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
888 unsigned int *cookie_len
);
890 /* verify cookie callback */
891 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
892 unsigned int cookie_len
);
894 /* TLS1.3 app-controlled cookie generate callback */
895 int (*gen_stateless_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
898 /* TLS1.3 verify app-controlled cookie callback */
899 int (*verify_stateless_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
902 CRYPTO_EX_DATA ex_data
;
904 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
905 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3-sha1' */
907 STACK_OF(X509
) *extra_certs
;
908 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
910 /* Default values used when no per-SSL value is defined follow */
912 /* used if SSL's info_callback is NULL */
913 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
916 * What we put in certificate_authorities extension for TLS 1.3
917 * (ClientHello and CertificateRequest) or just client cert requests for
918 * earlier versions. If client_ca_names is populated then it is only used
919 * for client cert requests, and in preference to ca_names.
921 STACK_OF(X509_NAME
) *ca_names
;
922 STACK_OF(X509_NAME
) *client_ca_names
;
925 * Default values to use in SSL structures follow (these are copied by
931 int min_proto_version
;
932 int max_proto_version
;
933 size_t max_cert_list
;
935 struct cert_st
/* CERT */ *cert
;
936 SSL_CERT_LOOKUP
*ssl_cert_info
;
939 /* callback that allows applications to peek at protocol messages */
940 ossl_msg_cb msg_callback
;
941 void *msg_callback_arg
;
943 uint32_t verify_mode
;
944 size_t sid_ctx_length
;
945 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
946 /* called 'verify_callback' in the SSL */
947 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
949 /* Default generate session ID callback. */
950 GEN_SESSION_CB generate_session_id
;
952 X509_VERIFY_PARAM
*param
;
956 # ifndef OPENSSL_NO_CT
957 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
959 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
960 * If they are not, the connection should be aborted.
962 ssl_ct_validation_cb ct_validation_callback
;
963 void *ct_validation_callback_arg
;
967 * If we're using more than one pipeline how should we divide the data
968 * up between the pipes?
970 size_t split_send_fragment
;
972 * Maximum amount of data to send in one fragment. actual record size can
973 * be more than this due to padding and MAC overheads.
975 size_t max_send_fragment
;
977 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
978 size_t max_pipelines
;
980 /* The default read buffer length to use (0 means not set) */
981 size_t default_read_buf_len
;
983 # ifndef OPENSSL_NO_ENGINE
985 * Engine to pass requests for client certs to
987 ENGINE
*client_cert_engine
;
990 /* ClientHello callback. Mostly for extensions, but not entirely. */
991 SSL_client_hello_cb_fn client_hello_cb
;
992 void *client_hello_cb_arg
;
994 /* TLS extensions. */
996 /* TLS extensions servername callback */
997 int (*servername_cb
) (SSL
*, int *, void *);
998 void *servername_arg
;
999 /* RFC 4507 session ticket keys */
1000 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
1001 SSL_CTX_EXT_SECURE
*secure
;
1002 # ifndef OPENSSL_NO_DEPRECATED_3_0
1003 /* Callback to support customisation of ticket key setting */
1004 int (*ticket_key_cb
) (SSL
*ssl
,
1005 unsigned char *name
, unsigned char *iv
,
1006 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
1008 int (*ticket_key_evp_cb
) (SSL
*ssl
,
1009 unsigned char *name
, unsigned char *iv
,
1010 EVP_CIPHER_CTX
*ectx
, EVP_MAC_CTX
*hctx
,
1013 /* certificate status request info */
1014 /* Callback for status request */
1015 int (*status_cb
) (SSL
*ssl
, void *arg
);
1017 /* ext status type used for CSR extension (OCSP Stapling) */
1019 /* RFC 4366 Maximum Fragment Length Negotiation */
1020 uint8_t max_fragment_len_mode
;
1022 /* EC extension values inherited by SSL structure */
1023 size_t ecpointformats_len
;
1024 unsigned char *ecpointformats
;
1026 size_t supportedgroups_len
;
1027 uint16_t *supportedgroups
;
1029 uint16_t *supported_groups_default
;
1030 size_t supported_groups_default_len
;
1032 * ALPN information (we are in the process of transitioning from NPN to
1037 * For a server, this contains a callback function that allows the
1038 * server to select the protocol for the connection.
1039 * out: on successful return, this must point to the raw protocol
1040 * name (without the length prefix).
1041 * outlen: on successful return, this contains the length of |*out|.
1042 * in: points to the client's list of supported protocols in
1044 * inlen: the length of |in|.
1046 int (*alpn_select_cb
) (SSL
*s
,
1047 const unsigned char **out
,
1048 unsigned char *outlen
,
1049 const unsigned char *in
,
1050 unsigned int inlen
, void *arg
);
1051 void *alpn_select_cb_arg
;
1054 * For a client, this contains the list of supported protocols in wire
1057 unsigned char *alpn
;
1060 # ifndef OPENSSL_NO_NEXTPROTONEG
1061 /* Next protocol negotiation information */
1064 * For a server, this contains a callback function by which the set of
1065 * advertised protocols can be provided.
1067 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
1068 void *npn_advertised_cb_arg
;
1070 * For a client, this contains a callback function that selects the next
1071 * protocol from the list provided by the server.
1073 SSL_CTX_npn_select_cb_func npn_select_cb
;
1074 void *npn_select_cb_arg
;
1077 unsigned char cookie_hmac_key
[SHA256_DIGEST_LENGTH
];
1080 # ifndef OPENSSL_NO_PSK
1081 SSL_psk_client_cb_func psk_client_callback
;
1082 SSL_psk_server_cb_func psk_server_callback
;
1084 SSL_psk_find_session_cb_func psk_find_session_cb
;
1085 SSL_psk_use_session_cb_func psk_use_session_cb
;
1087 # ifndef OPENSSL_NO_SRP
1088 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
1091 /* Shared DANE context */
1092 struct dane_ctx_st dane
;
1094 # ifndef OPENSSL_NO_SRTP
1095 /* SRTP profiles we are willing to do from RFC 5764 */
1096 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1099 * Callback for disabling session caching and ticket support on a session
1100 * basis, depending on the chosen cipher.
1102 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1104 CRYPTO_RWLOCK
*lock
;
1107 * Callback for logging key material for use with debugging tools like
1108 * Wireshark. The callback should log `line` followed by a newline.
1110 SSL_CTX_keylog_cb_func keylog_callback
;
1113 * The maximum number of bytes advertised in session tickets that can be
1114 * sent as early data.
1116 uint32_t max_early_data
;
1119 * The maximum number of bytes of early data that a server will tolerate
1120 * (which should be at least as much as max_early_data).
1122 uint32_t recv_max_early_data
;
1124 /* TLS1.3 padding callback */
1125 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1126 void *record_padding_arg
;
1127 size_t block_padding
;
1129 /* Session ticket appdata */
1130 SSL_CTX_generate_session_ticket_fn generate_ticket_cb
;
1131 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb
;
1132 void *ticket_cb_data
;
1134 /* The number of TLS1.3 tickets to automatically send */
1137 /* Callback to determine if early_data is acceptable or not */
1138 SSL_allow_early_data_cb_fn allow_early_data_cb
;
1139 void *allow_early_data_cb_data
;
1141 /* Do we advertise Post-handshake auth support? */
1144 /* Callback for SSL async handling */
1145 SSL_async_callback_fn async_cb
;
1150 int ssl_mac_pkey_id
[SSL_MD_NUM_IDX
];
1151 const EVP_CIPHER
*ssl_cipher_methods
[SSL_ENC_NUM_IDX
];
1152 const EVP_MD
*ssl_digest_methods
[SSL_MD_NUM_IDX
];
1153 size_t ssl_mac_secret_size
[SSL_MD_NUM_IDX
];
1155 size_t tls12_sigalgs_len
;
1156 /* Cache of all sigalgs we know and whether they are available or not */
1157 struct sigalg_lookup_st
*sigalg_lookup_cache
;
1158 /* List of all sigalgs (code points) available, incl. from providers */
1159 uint16_t *tls12_sigalgs
;
1161 TLS_GROUP_INFO
*group_list
;
1162 size_t group_list_len
;
1163 size_t group_list_max_len
;
1165 TLS_SIGALG_INFO
*sigalg_list
;
1166 size_t sigalg_list_len
;
1167 size_t sigalg_list_max_len
;
1169 /* masks of disabled algorithms */
1170 uint32_t disabled_enc_mask
;
1171 uint32_t disabled_mac_mask
;
1172 uint32_t disabled_mkey_mask
;
1173 uint32_t disabled_auth_mask
;
1175 #ifndef OPENSSL_NO_COMP_ALG
1176 /* certificate compression preferences */
1177 int cert_comp_prefs
[TLSEXT_comp_cert_limit
];
1180 /* Certificate Type stuff - for RPK vs X.509 */
1181 unsigned char *client_cert_type
;
1182 size_t client_cert_type_len
;
1183 unsigned char *server_cert_type
;
1184 size_t server_cert_type_len
;
1186 # ifndef OPENSSL_NO_QLOG
1187 char *qlog_title
; /* Session title for qlog */
1191 typedef struct cert_pkey_st CERT_PKEY
;
1193 #define SSL_TYPE_SSL_CONNECTION 0
1194 #define SSL_TYPE_QUIC_CONNECTION 1
1195 #define SSL_TYPE_QUIC_XSO 2
1200 const SSL_METHOD
*defltmeth
;
1201 const SSL_METHOD
*method
;
1202 CRYPTO_REF_COUNT references
;
1203 CRYPTO_RWLOCK
*lock
;
1204 /* extra application data */
1205 CRYPTO_EX_DATA ex_data
;
1208 struct ssl_connection_st
{
1209 /* type identifier and common data */
1212 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1217 * There are 2 BIO's even though they are normally both the same. This
1218 * is so data can be read and written to different handlers
1220 /* used by SSL_read */
1222 /* used by SSL_write */
1224 /* used during session-id reuse to concatenate messages */
1227 * This holds a variable that indicates what we were doing when a 0 or -1
1228 * is returned. This is needed for non-blocking IO so we know what
1229 * request needs re-doing when in SSL_accept or SSL_connect
1232 int (*handshake_func
) (SSL
*);
1234 * Imagine that here's a boolean member "init" that is switched as soon
1235 * as SSL_set_{accept/connect}_state is called for the first time, so
1236 * that "state" and "handshake_func" are properly initialized. But as
1237 * handshake_func is == 0 until then, we use this test instead of an
1240 /* are we the server side? */
1243 * Generate a new session or reuse an old one.
1244 * NB: For servers, the 'new' session may actually be a previously
1245 * cached session or even the previous session unless
1246 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1249 /* don't send shutdown packets */
1251 /* we have shut things down, 0x01 sent, 0x02 for received */
1253 /* Timestamps used to calculate the handshake RTT */
1254 OSSL_TIME ts_msg_write
;
1255 OSSL_TIME ts_msg_read
;
1258 SSL_EARLY_DATA_STATE early_data_state
;
1259 BUF_MEM
*init_buf
; /* buffer used during init */
1260 void *init_msg
; /* pointer to handshake message body, set by
1261 * tls_get_message_header() */
1262 size_t init_num
; /* amount read/written */
1263 size_t init_off
; /* amount read/written */
1265 size_t ssl_pkey_num
;
1269 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1270 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1272 /* used during startup, digest all incoming/outgoing packets */
1273 BIO
*handshake_buffer
;
1275 * When handshake digest is determined, buffer is hashed and
1276 * freed and MD_CTX for the required digest is stored here.
1278 EVP_MD_CTX
*handshake_dgst
;
1280 * Set whenever an expected ChangeCipherSpec message is processed.
1281 * Unset when the peer's Finished message is received.
1282 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1284 int change_cipher_spec
;
1288 * we allow one fatal and one warning alert to be outstanding, send close
1289 * alert via the warning alert
1292 unsigned char send_alert
[2];
1294 * This flag is set when we should renegotiate ASAP, basically when there
1295 * is no more data in the read or write buffers
1298 int total_renegotiations
;
1299 int num_renegotiations
;
1300 int in_read_app_data
;
1303 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1304 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1305 size_t finish_md_len
;
1306 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1307 size_t peer_finish_md_len
;
1308 size_t message_size
;
1310 /* used to hold the new cipher we are going to use */
1311 const SSL_CIPHER
*new_cipher
;
1312 EVP_PKEY
*pkey
; /* holds short lived key exchange key */
1313 /* used for certificate requests */
1315 /* Certificate types in certificate request message. */
1318 /* Certificate authorities list peer sent */
1319 STACK_OF(X509_NAME
) *peer_ca_names
;
1320 size_t key_block_length
;
1321 unsigned char *key_block
;
1322 const EVP_CIPHER
*new_sym_enc
;
1323 const EVP_MD
*new_hash
;
1324 int new_mac_pkey_type
;
1325 size_t new_mac_secret_size
;
1326 # ifndef OPENSSL_NO_COMP
1327 const SSL_COMP
*new_compression
;
1329 char *new_compression
;
1332 /* Raw values of the cipher list from a client */
1333 unsigned char *ciphers_raw
;
1334 size_t ciphers_rawlen
;
1335 /* Temporary storage for premaster secret */
1338 # ifndef OPENSSL_NO_PSK
1339 /* Temporary storage for PSK key */
1343 /* Signature algorithm we actually use */
1344 const struct sigalg_lookup_st
*sigalg
;
1345 /* Pointer to certificate we use */
1348 * signature algorithms peer reports: e.g. supported signature
1349 * algorithms extension for server or as part of a certificate
1350 * request for client.
1351 * Keep track of the algorithms for TLS and X.509 usage separately.
1353 uint16_t *peer_sigalgs
;
1354 uint16_t *peer_cert_sigalgs
;
1355 /* Size of above arrays */
1356 size_t peer_sigalgslen
;
1357 size_t peer_cert_sigalgslen
;
1358 /* Sigalg peer actually uses */
1359 const struct sigalg_lookup_st
*peer_sigalg
;
1361 * Set if corresponding CERT_PKEY can be used with current
1362 * SSL session: e.g. appropriate curve, signature algorithms etc.
1363 * If zero it can't be used at all.
1365 uint32_t *valid_flags
;
1367 * For servers the following masks are for the key and auth algorithms
1368 * that are supported by the certs below. For clients they are masks of
1369 * *disabled* algorithms based on the current session.
1374 * The following are used by the client to see if a cipher is allowed or
1375 * not. It contains the minimum and maximum version the client's using
1376 * based on what it knows so far.
1382 /* Connection binding to prevent renegotiation attacks */
1383 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1384 size_t previous_client_finished_len
;
1385 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1386 size_t previous_server_finished_len
;
1387 int send_connection_binding
;
1389 # ifndef OPENSSL_NO_NEXTPROTONEG
1391 * Set if we saw the Next Protocol Negotiation extension from our peer.
1397 * ALPN information (we are in the process of transitioning from NPN to
1402 * In a server these point to the selected ALPN protocol after the
1403 * ClientHello has been processed. In a client these contain the protocol
1404 * that the server selected once the ServerHello has been processed.
1406 unsigned char *alpn_selected
;
1407 size_t alpn_selected_len
;
1408 /* used by the server to know what options were proposed */
1409 unsigned char *alpn_proposed
;
1410 size_t alpn_proposed_len
;
1411 /* used by the client to know if it actually sent alpn */
1415 * This is set to true if we believe that this is a version of Safari
1416 * running on OS X 10.6 or newer. We wish to know this because Safari on
1417 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1419 char is_probably_safari
;
1422 * Track whether we did a key exchange this handshake or not, so
1423 * SSL_get_negotiated_group() knows whether to fall back to the
1424 * value in the SSL_SESSION.
1427 /* For clients: peer temporary key */
1428 /* The group_id for the key exchange key */
1434 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
1435 /* callback that allows applications to peek at protocol messages */
1436 void (*msg_callback
) (int write_p
, int version
, int content_type
,
1437 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
1438 void *msg_callback_arg
;
1439 int hit
; /* reusing a previous session */
1440 X509_VERIFY_PARAM
*param
;
1441 /* Per connection DANE state */
1444 STACK_OF(SSL_CIPHER
) *peer_ciphers
;
1445 STACK_OF(SSL_CIPHER
) *cipher_list
;
1446 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
1447 /* TLSv1.3 specific ciphersuites */
1448 STACK_OF(SSL_CIPHER
) *tls13_ciphersuites
;
1450 * These are the ones being used, the ones in SSL_SESSION are the ones to
1451 * be 'copied' into these ones
1455 * The TLS1.3 secrets.
1457 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
1458 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
1459 unsigned char master_secret
[EVP_MAX_MD_SIZE
];
1460 unsigned char resumption_master_secret
[EVP_MAX_MD_SIZE
];
1461 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
1462 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
1463 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
1464 unsigned char handshake_traffic_hash
[EVP_MAX_MD_SIZE
];
1465 unsigned char client_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1466 unsigned char server_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1467 unsigned char exporter_master_secret
[EVP_MAX_MD_SIZE
];
1468 unsigned char early_exporter_master_secret
[EVP_MAX_MD_SIZE
];
1472 /* This is used to hold the server certificate used */
1473 struct cert_st
/* CERT */ *cert
;
1476 * The hash of all messages prior to the CertificateVerify, and the length
1479 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
1480 size_t cert_verify_hash_len
;
1482 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1483 enum {SSL_HRR_NONE
= 0, SSL_HRR_PENDING
, SSL_HRR_COMPLETE
}
1484 hello_retry_request
;
1487 * the session_id_context is used to ensure sessions are only reused in
1488 * the appropriate context
1490 size_t sid_ctx_length
;
1491 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
1492 /* This can also be in the session once a session is established */
1493 SSL_SESSION
*session
;
1494 /* TLSv1.3 PSK session */
1495 SSL_SESSION
*psksession
;
1496 unsigned char *psksession_id
;
1497 size_t psksession_id_len
;
1498 /* Default generate session ID callback. */
1499 GEN_SESSION_CB generate_session_id
;
1501 * The temporary TLSv1.3 session id. This isn't really a session id at all
1502 * but is a random value sent in the legacy session id field.
1504 unsigned char tmp_session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
1505 size_t tmp_session_id_len
;
1508 * 0 don't care about verify failure.
1509 * 1 fail if verify fails
1511 uint32_t verify_mode
;
1512 /* fail if callback returns 0 */
1513 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1514 /* optional informational callback */
1515 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1516 /* error bytes to be written */
1520 # ifndef OPENSSL_NO_PSK
1521 SSL_psk_client_cb_func psk_client_callback
;
1522 SSL_psk_server_cb_func psk_server_callback
;
1524 SSL_psk_find_session_cb_func psk_find_session_cb
;
1525 SSL_psk_use_session_cb_func psk_use_session_cb
;
1527 /* Verified chain of peer */
1528 STACK_OF(X509
) *verified_chain
;
1531 * What we put in certificate_authorities extension for TLS 1.3
1532 * (ClientHello and CertificateRequest) or just client cert requests for
1533 * earlier versions. If client_ca_names is populated then it is only used
1534 * for client cert requests, and in preference to ca_names.
1536 STACK_OF(X509_NAME
) *ca_names
;
1537 STACK_OF(X509_NAME
) *client_ca_names
;
1538 /* protocol behaviour */
1542 int min_proto_version
;
1543 int max_proto_version
;
1544 size_t max_cert_list
;
1547 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1548 * secret and SSLv3/TLS (<=1.2) rollback check
1552 * If we're using more than one pipeline how should we divide the data
1553 * up between the pipes?
1555 size_t split_send_fragment
;
1557 * Maximum amount of data to send in one fragment. actual record size can
1558 * be more than this due to padding and MAC overheads.
1560 size_t max_send_fragment
;
1561 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1562 size_t max_pipelines
;
1565 /* Built-in extension flags */
1566 uint8_t extflags
[TLSEXT_IDX_num_builtins
];
1567 /* TLS extension debug callback */
1568 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1569 const unsigned char *data
, int len
, void *arg
);
1572 /* certificate status request info */
1573 /* Status type or -1 if no status type */
1575 /* Raw extension data, if seen */
1576 unsigned char *scts
;
1577 /* Length of raw extension data, if seen */
1579 /* Expect OCSP CertificateStatus message */
1580 int status_expected
;
1583 /* OCSP status request only */
1584 STACK_OF(OCSP_RESPID
) *ids
;
1585 X509_EXTENSIONS
*exts
;
1586 /* OCSP response received or to be sent */
1587 unsigned char *resp
;
1591 /* RFC4507 session ticket expected to be received or sent */
1592 int ticket_expected
;
1593 /* TLS 1.3 tickets requested by the application. */
1594 int extra_tickets_expected
;
1595 size_t ecpointformats_len
;
1597 unsigned char *ecpointformats
;
1599 size_t peer_ecpointformats_len
;
1601 unsigned char *peer_ecpointformats
;
1602 size_t supportedgroups_len
;
1604 uint16_t *supportedgroups
;
1606 size_t peer_supportedgroups_len
;
1608 uint16_t *peer_supportedgroups
;
1610 /* TLS Session Ticket extension override */
1611 TLS_SESSION_TICKET_EXT
*session_ticket
;
1612 /* TLS Session Ticket extension callback */
1613 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1614 void *session_ticket_cb_arg
;
1615 /* TLS pre-shared secret session resumption */
1616 tls_session_secret_cb_fn session_secret_cb
;
1617 void *session_secret_cb_arg
;
1619 * For a client, this contains the list of supported protocols in wire
1622 unsigned char *alpn
;
1625 * Next protocol negotiation. For the client, this is the protocol that
1626 * we sent in NextProtocol and is set when handling ServerHello
1627 * extensions. For a server, this is the client's selected_protocol from
1628 * NextProtocol and is set when handling the NextProtocol message, before
1629 * the Finished message.
1634 /* The available PSK key exchange modes */
1637 /* Set to one if we have negotiated ETM */
1640 /* Are we expecting to receive early data? */
1642 /* Is the session suitable for early data? */
1645 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1646 unsigned char *tls13_cookie
;
1647 size_t tls13_cookie_len
;
1648 /* Have we received a cookie from the client? */
1652 * Maximum Fragment Length as per RFC 4366.
1653 * If this member contains one of the allowed values (1-4)
1654 * then we should include Maximum Fragment Length Negotiation
1655 * extension in Client Hello.
1656 * Please note that value of this member does not have direct
1657 * effect. The actual (binding) value is stored in SSL_SESSION,
1658 * as this extension is optional on server side.
1660 uint8_t max_fragment_len_mode
;
1663 * On the client side the number of ticket identities we sent in the
1664 * ClientHello. On the server side the identity of the ticket we
1669 /* This is the list of algorithms the peer supports that we also support */
1670 int compress_certificate_from_peer
[TLSEXT_comp_cert_limit
];
1671 /* indicate that we sent the extension, so we'll accept it */
1672 int compress_certificate_sent
;
1674 uint8_t client_cert_type
;
1675 uint8_t client_cert_type_ctos
;
1676 uint8_t server_cert_type
;
1677 uint8_t server_cert_type_ctos
;
1681 * Parsed form of the ClientHello, kept around across client_hello_cb
1684 CLIENTHELLO_MSG
*clienthello
;
1687 * no further mod of servername
1688 * 0 : call the servername extension callback.
1689 * 1 : prepare 2, allow last ack just after in server callback.
1690 * 2 : don't call servername callback, no ack in server hello
1692 int servername_done
;
1693 # ifndef OPENSSL_NO_CT
1695 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1696 * If they are not, the connection should be aborted.
1698 ssl_ct_validation_cb ct_validation_callback
;
1699 /* User-supplied argument that is passed to the ct_validation_callback */
1700 void *ct_validation_callback_arg
;
1702 * Consolidated stack of SCTs from all sources.
1703 * Lazily populated by CT_get_peer_scts(SSL*)
1705 STACK_OF(SCT
) *scts
;
1706 /* Have we attempted to find/parse SCTs yet? */
1709 SSL_CTX
*session_ctx
; /* initial ctx, used to store sessions */
1710 # ifndef OPENSSL_NO_SRTP
1712 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1713 /* What's been chosen */
1714 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1717 * 1 if we are renegotiating.
1718 * 2 if we are a server and are inside a handshake
1719 * (i.e. not just sending a HelloRequest)
1722 /* If sending a KeyUpdate is pending */
1724 /* Post-handshake authentication state */
1725 SSL_PHA_STATE post_handshake_auth
;
1727 uint8_t* pha_context
;
1728 size_t pha_context_len
;
1730 EVP_MD_CTX
*pha_dgst
; /* this is just the digest through ClientFinished */
1732 # ifndef OPENSSL_NO_SRP
1733 /* ctx for SRP authentication */
1737 * Callback for disabling session caching and ticket support on a session
1738 * basis, depending on the chosen cipher.
1740 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1742 /* Record layer data */
1743 RECORD_LAYER rlayer
;
1745 /* Default password callback. */
1746 pem_password_cb
*default_passwd_callback
;
1747 /* Default password callback user data. */
1748 void *default_passwd_callback_userdata
;
1749 /* Async Job info */
1751 ASYNC_WAIT_CTX
*waitctx
;
1755 * The maximum number of bytes advertised in session tickets that can be
1756 * sent as early data.
1758 uint32_t max_early_data
;
1760 * The maximum number of bytes of early data that a server will tolerate
1761 * (which should be at least as much as max_early_data).
1763 uint32_t recv_max_early_data
;
1766 * The number of bytes of early data received so far. If we accepted early
1767 * data then this is a count of the plaintext bytes. If we rejected it then
1768 * this is a count of the ciphertext bytes.
1770 uint32_t early_data_count
;
1772 /* The number of TLS1.3 tickets to automatically send */
1774 /* The number of TLS1.3 tickets actually sent so far */
1775 size_t sent_tickets
;
1776 /* The next nonce value to use when we send a ticket on this connection */
1777 uint64_t next_ticket_nonce
;
1779 /* Callback to determine if early_data is acceptable or not */
1780 SSL_allow_early_data_cb_fn allow_early_data_cb
;
1781 void *allow_early_data_cb_data
;
1783 /* Callback for SSL async handling */
1784 SSL_async_callback_fn async_cb
;
1788 * Signature algorithms shared by client and server: cached because these
1789 * are used most often.
1791 const struct sigalg_lookup_st
**shared_sigalgs
;
1792 size_t shared_sigalgslen
;
1794 #ifndef OPENSSL_NO_COMP_ALG
1795 /* certificate compression preferences */
1796 int cert_comp_prefs
[TLSEXT_comp_cert_limit
];
1799 /* Certificate Type stuff - for RPK vs X.509 */
1800 unsigned char *client_cert_type
;
1801 size_t client_cert_type_len
;
1802 unsigned char *server_cert_type
;
1803 size_t server_cert_type_len
;
1806 # define SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, c) \
1807 ((ssl) == NULL ? NULL \
1808 : ((ssl)->type == SSL_TYPE_SSL_CONNECTION \
1809 ? (c SSL_CONNECTION *)(ssl) \
1811 # define SSL_CONNECTION_NO_CONST
1812 # define SSL_CONNECTION_FROM_SSL_ONLY(ssl) \
1813 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1814 # define SSL_CONNECTION_FROM_CONST_SSL_ONLY(ssl) \
1815 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1816 # define SSL_CONNECTION_GET_CTX(sc) ((sc)->ssl.ctx)
1817 # define SSL_CONNECTION_GET_SSL(sc) (&(sc)->ssl)
1818 # ifndef OPENSSL_NO_QUIC
1819 # include "quic/quic_local.h"
1820 # define SSL_CONNECTION_FROM_SSL_int(ssl, c) \
1821 ((ssl) == NULL ? NULL \
1822 : ((ssl)->type == SSL_TYPE_SSL_CONNECTION \
1823 ? (c SSL_CONNECTION *)(ssl) \
1824 : ((ssl)->type == SSL_TYPE_QUIC_CONNECTION \
1825 ? (c SSL_CONNECTION *)((c QUIC_CONNECTION *)(ssl))->tls \
1827 # define SSL_CONNECTION_FROM_SSL(ssl) \
1828 SSL_CONNECTION_FROM_SSL_int(ssl, SSL_CONNECTION_NO_CONST)
1829 # define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1830 SSL_CONNECTION_FROM_SSL_int(ssl, const)
1832 # define SSL_CONNECTION_FROM_SSL(ssl) \
1833 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1834 # define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1835 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1839 * Structure containing table entry of values associated with the signature
1840 * algorithms (signature scheme) extension
1842 typedef struct sigalg_lookup_st
{
1843 /* TLS 1.3 signature scheme name */
1845 /* Raw value used in extension */
1847 /* NID of hash algorithm or NID_undef if no hash */
1849 /* Index of hash algorithm or -1 if no hash algorithm */
1851 /* NID of signature algorithm */
1853 /* Index of signature algorithm */
1855 /* Combined hash and signature NID, if any */
1857 /* Required public key curve (ECDSA only) */
1859 /* Whether this signature algorithm is actually available for use */
1863 /* DTLS structures */
1865 # ifndef OPENSSL_NO_SCTP
1866 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1869 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1870 # define DTLS1_MAX_MTU_OVERHEAD 48
1873 * Flag used in message reuse to indicate the buffer contains the record
1874 * header as well as the handshake message header.
1876 # define DTLS1_SKIP_RECORD_HEADER 2
1878 struct dtls1_retransmit_state
{
1879 const OSSL_RECORD_METHOD
*wrlmethod
;
1880 OSSL_RECORD_LAYER
*wrl
;
1883 struct hm_header_st
{
1889 unsigned int is_ccs
;
1890 struct dtls1_retransmit_state saved_retransmit_state
;
1893 typedef struct hm_fragment_st
{
1894 struct hm_header_st msg_header
;
1895 unsigned char *fragment
;
1896 unsigned char *reassembly
;
1899 typedef struct pqueue_st pqueue
;
1900 typedef struct pitem_st pitem
;
1903 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1908 typedef struct pitem_st
*piterator
;
1910 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1911 void pitem_free(pitem
*item
);
1912 pqueue
*pqueue_new(void);
1913 void pqueue_free(pqueue
*pq
);
1914 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1915 pitem
*pqueue_peek(pqueue
*pq
);
1916 pitem
*pqueue_pop(pqueue
*pq
);
1917 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1918 pitem
*pqueue_iterator(pqueue
*pq
);
1919 pitem
*pqueue_next(piterator
*iter
);
1920 size_t pqueue_size(pqueue
*pq
);
1922 typedef struct dtls1_state_st
{
1923 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1925 unsigned int cookie_verified
;
1926 /* handshake message numbers */
1927 unsigned short handshake_write_seq
;
1928 unsigned short next_handshake_write_seq
;
1929 unsigned short handshake_read_seq
;
1930 /* Buffered handshake messages */
1931 pqueue
*buffered_messages
;
1932 /* Buffered (sent) handshake records */
1933 pqueue
*sent_messages
;
1934 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1935 size_t mtu
; /* max DTLS packet size */
1936 struct hm_header_st w_msg_hdr
;
1937 struct hm_header_st r_msg_hdr
;
1938 /* Number of alerts received so far */
1939 unsigned int timeout_num_alerts
;
1941 * Indicates when the last handshake msg sent will timeout
1943 OSSL_TIME next_timeout
;
1944 /* Timeout duration */
1945 unsigned int timeout_duration_us
;
1947 unsigned int retransmitting
;
1948 # ifndef OPENSSL_NO_SCTP
1949 int shutdown_received
;
1952 DTLS_timer_cb timer_cb
;
1957 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1959 # define EXPLICIT_PRIME_CURVE_TYPE 1
1960 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1961 # define NAMED_CURVE_TYPE 3
1963 # ifndef OPENSSL_NO_COMP_ALG
1964 struct ossl_comp_cert_st
{
1965 unsigned char *data
;
1968 CRYPTO_REF_COUNT references
;
1971 typedef struct ossl_comp_cert_st OSSL_COMP_CERT
;
1973 void OSSL_COMP_CERT_free(OSSL_COMP_CERT
*c
);
1974 int OSSL_COMP_CERT_up_ref(OSSL_COMP_CERT
*c
);
1977 struct cert_pkey_st
{
1979 EVP_PKEY
*privatekey
;
1980 /* Chain for this certificate */
1981 STACK_OF(X509
) *chain
;
1983 * serverinfo data for this certificate. The data is in TLS Extension
1984 * wire format, specifically it's a series of records like:
1985 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1987 * uint8_t data[length];
1989 unsigned char *serverinfo
;
1990 size_t serverinfo_length
;
1991 # ifndef OPENSSL_NO_COMP_ALG
1992 /* Compressed certificate data - index 0 is unused */
1993 OSSL_COMP_CERT
*comp_cert
[TLSEXT_comp_cert_limit
];
1997 /* Retrieve Suite B flags */
1998 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1999 /* Uses to check strict mode: suite B modes are always strict */
2000 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
2001 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
2004 ENDPOINT_CLIENT
= 0,
2011 unsigned short ext_type
;
2013 /* The context which this extension applies to */
2014 unsigned int context
;
2016 * Per-connection flags relating to this extension type: not used if
2017 * part of an SSL_CTX structure.
2020 SSL_custom_ext_add_cb_ex add_cb
;
2021 SSL_custom_ext_free_cb_ex free_cb
;
2023 SSL_custom_ext_parse_cb_ex parse_cb
;
2025 } custom_ext_method
;
2027 /* ext_flags values */
2030 * Indicates an extension has been received. Used to check for unsolicited or
2031 * duplicate extensions.
2033 # define SSL_EXT_FLAG_RECEIVED 0x1
2035 * Indicates an extension has been sent: used to enable sending of
2036 * corresponding ServerHello extension.
2038 # define SSL_EXT_FLAG_SENT 0x2
2041 custom_ext_method
*meths
;
2043 } custom_ext_methods
;
2045 typedef struct cert_st
{
2046 /* Current active set */
2048 * ALWAYS points to an element of the pkeys array
2049 * Probably it would make more sense to store
2050 * an index, not a pointer.
2055 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
2057 /* Flags related to certificates */
2058 uint32_t cert_flags
;
2060 size_t ssl_pkey_num
;
2061 /* Custom certificate types sent in certificate request message. */
2065 * supported signature algorithms. When set on a client this is sent in
2066 * the client hello as the supported signature algorithms extension. For
2067 * servers it represents the signature algorithms we are willing to use.
2069 uint16_t *conf_sigalgs
;
2070 /* Size of above array */
2071 size_t conf_sigalgslen
;
2073 * Client authentication signature algorithms, if not set then uses
2074 * conf_sigalgs. On servers these will be the signature algorithms sent
2075 * to the client in a certificate request for TLS 1.2. On a client this
2076 * represents the signature algorithms we are willing to use for client
2079 uint16_t *client_sigalgs
;
2080 /* Size of above array */
2081 size_t client_sigalgslen
;
2083 * Certificate setup callback: if set is called whenever a certificate
2084 * may be required (client or server). the callback can then examine any
2085 * appropriate parameters and setup any certificates required. This
2086 * allows advanced applications to select certificates on the fly: for
2087 * example based on supported signature algorithms or curves.
2089 int (*cert_cb
) (SSL
*ssl
, void *arg
);
2092 * Optional X509_STORE for chain building or certificate validation If
2093 * NULL the parent SSL_CTX store is used instead.
2095 X509_STORE
*chain_store
;
2096 X509_STORE
*verify_store
;
2097 /* Custom extensions */
2098 custom_ext_methods custext
;
2099 /* Security callback */
2100 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
2101 void *other
, void *ex
);
2102 /* Security level */
2105 # ifndef OPENSSL_NO_PSK
2106 /* If not NULL psk identity hint to use for servers */
2107 char *psk_identity_hint
;
2109 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
2112 # define FP_ICC (int (*)(const void *,const void *))
2115 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
2116 * of a mess of functions, but hell, think of it as an opaque structure :-)
2118 typedef struct ssl3_enc_method
{
2119 int (*setup_key_block
) (SSL_CONNECTION
*);
2120 int (*generate_master_secret
) (SSL_CONNECTION
*, unsigned char *,
2121 unsigned char *, size_t, size_t *);
2122 int (*change_cipher_state
) (SSL_CONNECTION
*, int);
2123 size_t (*final_finish_mac
) (SSL_CONNECTION
*, const char *, size_t,
2125 const char *client_finished_label
;
2126 size_t client_finished_label_len
;
2127 const char *server_finished_label
;
2128 size_t server_finished_label_len
;
2129 int (*alert_value
) (int);
2130 int (*export_keying_material
) (SSL_CONNECTION
*, unsigned char *, size_t,
2131 const char *, size_t,
2132 const unsigned char *, size_t,
2134 /* Various flags indicating protocol version requirements */
2136 /* Set the handshake header */
2137 int (*set_handshake_header
) (SSL_CONNECTION
*s
, WPACKET
*pkt
, int type
);
2138 /* Close construction of the handshake message */
2139 int (*close_construct_packet
) (SSL_CONNECTION
*s
, WPACKET
*pkt
, int htype
);
2140 /* Write out handshake message */
2141 int (*do_write
) (SSL_CONNECTION
*s
);
2144 # define ssl_set_handshake_header(s, pkt, htype) \
2145 SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2146 # define ssl_close_construct_packet(s, pkt, htype) \
2147 SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2148 # define ssl_do_write(s) SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->do_write(s)
2150 /* Values for enc_flags */
2152 /* Uses signature algorithms extension */
2153 # define SSL_ENC_FLAG_SIGALGS 0x2
2154 /* Uses SHA256 default PRF */
2155 # define SSL_ENC_FLAG_SHA256_PRF 0x4
2157 # define SSL_ENC_FLAG_DTLS 0x8
2159 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2160 * apply to others in future.
2162 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2164 typedef enum downgrade_en
{
2171 * Dummy status type for the status_type extension. Indicates no status type
2174 #define TLSEXT_STATUSTYPE_nothing -1
2176 /* Sigalgs values */
2177 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2178 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2179 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2180 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2181 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2182 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2183 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2184 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2185 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2186 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2187 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2188 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2189 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2190 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2191 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2192 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2193 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2194 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2195 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2196 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2197 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2198 #define TLSEXT_SIGALG_gostr34102012_256_intrinsic 0x0840
2199 #define TLSEXT_SIGALG_gostr34102012_512_intrinsic 0x0841
2200 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2201 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2202 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2204 #define TLSEXT_SIGALG_ed25519 0x0807
2205 #define TLSEXT_SIGALG_ed448 0x0808
2206 #define TLSEXT_SIGALG_ecdsa_brainpoolP256r1_sha256 0x081a
2207 #define TLSEXT_SIGALG_ecdsa_brainpoolP384r1_sha384 0x081b
2208 #define TLSEXT_SIGALG_ecdsa_brainpoolP512r1_sha512 0x081c
2210 /* Known PSK key exchange modes */
2211 #define TLSEXT_KEX_MODE_KE 0x00
2212 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2215 * Internal representations of key exchange modes
2217 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2218 #define TLSEXT_KEX_MODE_FLAG_KE 1
2219 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2221 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2222 s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2224 /* A dummy signature value not valid for TLSv1.2 signature algs */
2225 #define TLSEXT_signature_rsa_pss 0x0101
2227 /* TLSv1.3 downgrade protection sentinel values */
2228 extern const unsigned char tls11downgrade
[8];
2229 extern const unsigned char tls12downgrade
[8];
2231 extern const SSL3_ENC_METHOD ssl3_undef_enc_method
;
2233 __owur
const SSL_METHOD
*sslv3_method(void);
2234 __owur
const SSL_METHOD
*sslv3_server_method(void);
2235 __owur
const SSL_METHOD
*sslv3_client_method(void);
2236 __owur
const SSL_METHOD
*tlsv1_method(void);
2237 __owur
const SSL_METHOD
*tlsv1_server_method(void);
2238 __owur
const SSL_METHOD
*tlsv1_client_method(void);
2239 __owur
const SSL_METHOD
*tlsv1_1_method(void);
2240 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
2241 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
2242 __owur
const SSL_METHOD
*tlsv1_2_method(void);
2243 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
2244 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
2245 __owur
const SSL_METHOD
*tlsv1_3_method(void);
2246 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
2247 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
2248 __owur
const SSL_METHOD
*dtlsv1_method(void);
2249 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
2250 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
2251 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
2252 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
2253 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
2254 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
2256 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
2257 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
2258 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
2259 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
2260 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
2261 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
2262 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
2265 * Flags for SSL methods
2267 # define SSL_METHOD_NO_FIPS (1U<<0)
2268 # define SSL_METHOD_NO_SUITEB (1U<<1)
2270 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2271 s_connect, enc_data) \
2272 const SSL_METHOD *func_name(void) \
2274 static const SSL_METHOD func_name##_data= { \
2278 ossl_ssl_connection_new, \
2279 ossl_ssl_connection_free, \
2280 ossl_ssl_connection_reset, \
2291 ssl3_renegotiate_check, \
2294 ssl3_dispatch_alert, \
2297 ssl3_get_cipher_by_char, \
2298 ssl3_put_cipher_by_char, \
2302 tls1_default_timeout, \
2304 ssl_undefined_void_function, \
2305 ssl3_callback_ctrl, \
2306 ssl3_ctx_callback_ctrl, \
2308 return &func_name##_data; \
2311 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2312 const SSL_METHOD *func_name(void) \
2314 static const SSL_METHOD func_name##_data= { \
2316 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2318 ossl_ssl_connection_new, \
2319 ossl_ssl_connection_free, \
2320 ossl_ssl_connection_reset, \
2331 ssl3_renegotiate_check, \
2334 ssl3_dispatch_alert, \
2337 ssl3_get_cipher_by_char, \
2338 ssl3_put_cipher_by_char, \
2342 ssl3_default_timeout, \
2344 ssl_undefined_void_function, \
2345 ssl3_callback_ctrl, \
2346 ssl3_ctx_callback_ctrl, \
2348 return &func_name##_data; \
2351 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2352 s_connect, enc_data) \
2353 const SSL_METHOD *func_name(void) \
2355 static const SSL_METHOD func_name##_data= { \
2359 ossl_ssl_connection_new, \
2360 ossl_ssl_connection_free, \
2361 ossl_ssl_connection_reset, \
2372 ssl3_renegotiate_check, \
2374 dtls1_write_app_data_bytes, \
2375 dtls1_dispatch_alert, \
2378 ssl3_get_cipher_by_char, \
2379 ssl3_put_cipher_by_char, \
2383 dtls1_default_timeout, \
2385 ssl_undefined_void_function, \
2386 ssl3_callback_ctrl, \
2387 ssl3_ctx_callback_ctrl, \
2389 return &func_name##_data; \
2392 struct openssl_ssl_test_functions
{
2393 int (*p_ssl_init_wbio_buffer
) (SSL_CONNECTION
*s
);
2396 const char *ssl_protocol_to_string(int version
);
2398 static ossl_inline
int tls12_rpk_and_privkey(const SSL_CONNECTION
*sc
, int idx
)
2401 * This is to check for special cases when using RPK with just
2402 * a private key, and NO CERTIFICATE
2404 return ((sc
->server
&& sc
->ext
.server_cert_type
== TLSEXT_cert_type_rpk
)
2405 || (!sc
->server
&& sc
->ext
.client_cert_type
== TLSEXT_cert_type_rpk
))
2406 && sc
->cert
->pkeys
[idx
].privatekey
!= NULL
2407 && sc
->cert
->pkeys
[idx
].x509
== NULL
;
2410 static ossl_inline
int ssl_has_cert_type(const SSL_CONNECTION
*sc
, unsigned char ct
)
2416 ptr
= sc
->server_cert_type
;
2417 len
= sc
->server_cert_type_len
;
2419 ptr
= sc
->client_cert_type
;
2420 len
= sc
->client_cert_type_len
;
2426 return memchr(ptr
, ct
, len
) != NULL
;
2429 /* Returns true if certificate and private key for 'idx' are present */
2430 static ossl_inline
int ssl_has_cert(const SSL_CONNECTION
*s
, int idx
)
2432 if (idx
< 0 || idx
>= (int)s
->ssl_pkey_num
)
2435 /* If RPK is enabled for this SSL... only require private key */
2436 if (ssl_has_cert_type(s
, TLSEXT_cert_type_rpk
))
2437 return s
->cert
->pkeys
[idx
].privatekey
!= NULL
;
2439 return s
->cert
->pkeys
[idx
].x509
!= NULL
2440 && s
->cert
->pkeys
[idx
].privatekey
!= NULL
;
2443 static ossl_inline
void tls1_get_peer_groups(SSL_CONNECTION
*s
,
2444 const uint16_t **pgroups
,
2447 *pgroups
= s
->ext
.peer_supportedgroups
;
2448 *pgroupslen
= s
->ext
.peer_supportedgroups_len
;
2451 # ifndef OPENSSL_UNIT_TEST
2453 __owur
int ossl_ssl_init(SSL
*ssl
, SSL_CTX
*ctx
, const SSL_METHOD
*method
,
2455 __owur SSL
*ossl_ssl_connection_new_int(SSL_CTX
*ctx
, const SSL_METHOD
*method
);
2456 __owur SSL
*ossl_ssl_connection_new(SSL_CTX
*ctx
);
2457 void ossl_ssl_connection_free(SSL
*ssl
);
2458 __owur
int ossl_ssl_connection_reset(SSL
*ssl
);
2460 __owur
int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
);
2461 __owur
int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
,
2462 uint64_t flags
, size_t *written
);
2463 int ssl_clear_bad_session(SSL_CONNECTION
*s
);
2464 __owur CERT
*ssl_cert_new(size_t ssl_pkey_num
);
2465 __owur CERT
*ssl_cert_dup(CERT
*cert
);
2466 void ssl_cert_clear_certs(CERT
*c
);
2467 void ssl_cert_free(CERT
*c
);
2468 __owur
int ssl_generate_session_id(SSL_CONNECTION
*s
, SSL_SESSION
*ss
);
2469 __owur
int ssl_get_new_session(SSL_CONNECTION
*s
, int session
);
2470 __owur SSL_SESSION
*lookup_sess_in_cache(SSL_CONNECTION
*s
,
2471 const unsigned char *sess_id
,
2472 size_t sess_id_len
);
2473 __owur
int ssl_get_prev_session(SSL_CONNECTION
*s
, CLIENTHELLO_MSG
*hello
);
2474 __owur SSL_SESSION
*ssl_session_dup(const SSL_SESSION
*src
, int ticket
);
2475 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
2476 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
2477 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2478 const SSL_CIPHER
*const *bp
);
2479 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(SSL_CTX
*ctx
,
2480 STACK_OF(SSL_CIPHER
) *tls13_ciphersuites
,
2481 STACK_OF(SSL_CIPHER
) **cipher_list
,
2482 STACK_OF(SSL_CIPHER
) **cipher_list_by_id
,
2483 const char *rule_str
,
2485 __owur
int ssl_cache_cipherlist(SSL_CONNECTION
*s
, PACKET
*cipher_suites
,
2487 __owur
int ossl_bytes_to_cipher_list(SSL_CONNECTION
*s
, PACKET
*cipher_suites
,
2488 STACK_OF(SSL_CIPHER
) **skp
,
2489 STACK_OF(SSL_CIPHER
) **scsvs
, int sslv2format
,
2491 void ssl_update_cache(SSL_CONNECTION
*s
, int mode
);
2492 __owur
int ssl_cipher_get_evp_cipher(SSL_CTX
*ctx
, const SSL_CIPHER
*sslc
,
2493 const EVP_CIPHER
**enc
);
2494 __owur
int ssl_cipher_get_evp_md_mac(SSL_CTX
*ctx
, const SSL_CIPHER
*sslc
,
2496 int *mac_pkey_type
, size_t *mac_secret_size
);
2497 __owur
int ssl_cipher_get_evp(SSL_CTX
*ctxc
, const SSL_SESSION
*s
,
2498 const EVP_CIPHER
**enc
, const EVP_MD
**md
,
2499 int *mac_pkey_type
, size_t *mac_secret_size
,
2500 SSL_COMP
**comp
, int use_etm
);
2501 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
2502 size_t *int_overhead
, size_t *blocksize
,
2503 size_t *ext_overhead
);
2504 __owur
int ssl_cert_is_disabled(SSL_CTX
*ctx
, size_t idx
);
2505 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL_CONNECTION
*ssl
,
2506 const unsigned char *ptr
,
2508 __owur
int ssl_cert_set0_chain(SSL_CONNECTION
*s
, SSL_CTX
*ctx
,
2509 STACK_OF(X509
) *chain
);
2510 __owur
int ssl_cert_set1_chain(SSL_CONNECTION
*s
, SSL_CTX
*ctx
,
2511 STACK_OF(X509
) *chain
);
2512 __owur
int ssl_cert_add0_chain_cert(SSL_CONNECTION
*s
, SSL_CTX
*ctx
, X509
*x
);
2513 __owur
int ssl_cert_add1_chain_cert(SSL_CONNECTION
*s
, SSL_CTX
*ctx
, X509
*x
);
2514 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
2515 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
2516 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
2518 __owur
int ssl_verify_cert_chain(SSL_CONNECTION
*s
, STACK_OF(X509
) *sk
);
2519 __owur
int ssl_verify_rpk(SSL_CONNECTION
*s
, EVP_PKEY
*rpk
);
2520 __owur
int ssl_build_cert_chain(SSL_CONNECTION
*s
, SSL_CTX
*ctx
, int flags
);
2521 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
2523 __owur
int ssl_cert_get_cert_store(CERT
*c
, X509_STORE
**pstore
, int chain
);
2525 __owur
int ssl_security(const SSL_CONNECTION
*s
, int op
, int bits
, int nid
,
2527 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
2529 int ssl_get_security_level_bits(const SSL
*s
, const SSL_CTX
*ctx
, int *levelp
);
2531 __owur
int ssl_cert_lookup_by_nid(int nid
, size_t *pidx
, SSL_CTX
*ctx
);
2532 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_pkey(const EVP_PKEY
*pk
,
2535 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_idx(size_t idx
, SSL_CTX
*ctx
);
2537 int ssl_undefined_function(SSL
*s
);
2538 __owur
int ssl_undefined_void_function(void);
2539 __owur
int ssl_undefined_const_function(const SSL
*s
);
2540 __owur
int ssl_get_server_cert_serverinfo(SSL_CONNECTION
*s
,
2541 const unsigned char **serverinfo
,
2542 size_t *serverinfo_length
);
2543 void ssl_set_masks(SSL_CONNECTION
*s
);
2544 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL_CONNECTION
*sc
);
2545 __owur
int ssl_x509err2alert(int type
);
2546 void ssl_sort_cipher_list(void);
2547 int ssl_load_ciphers(SSL_CTX
*ctx
);
2548 __owur
int ssl_setup_sigalgs(SSL_CTX
*ctx
);
2549 int ssl_load_groups(SSL_CTX
*ctx
);
2550 int ssl_load_sigalgs(SSL_CTX
*ctx
);
2551 __owur
int ssl_fill_hello_random(SSL_CONNECTION
*s
, int server
,
2552 unsigned char *field
, size_t len
,
2554 __owur
int ssl_generate_master_secret(SSL_CONNECTION
*s
, unsigned char *pms
,
2555 size_t pmslen
, int free_pms
);
2556 __owur EVP_PKEY
*ssl_generate_pkey(SSL_CONNECTION
*s
, EVP_PKEY
*pm
);
2557 __owur
int ssl_gensecret(SSL_CONNECTION
*s
, unsigned char *pms
, size_t pmslen
);
2558 __owur
int ssl_derive(SSL_CONNECTION
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
2560 __owur
int ssl_decapsulate(SSL_CONNECTION
*s
, EVP_PKEY
*privkey
,
2561 const unsigned char *ct
, size_t ctlen
,
2563 __owur
int ssl_encapsulate(SSL_CONNECTION
*s
, EVP_PKEY
*pubkey
,
2564 unsigned char **ctp
, size_t *ctlenp
,
2566 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
2567 __owur
int ssl_set_tmp_ecdh_groups(uint16_t **pext
, size_t *pextlen
,
2569 __owur
unsigned int ssl_get_max_send_fragment(const SSL_CONNECTION
*sc
);
2570 __owur
unsigned int ssl_get_split_send_fragment(const SSL_CONNECTION
*sc
);
2572 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_id(uint32_t id
);
2573 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_std_name(const char *stdname
);
2574 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
2575 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
2577 int ssl3_init_finished_mac(SSL_CONNECTION
*s
);
2578 __owur
int ssl3_setup_key_block(SSL_CONNECTION
*s
);
2579 __owur
int ssl3_change_cipher_state(SSL_CONNECTION
*s
, int which
);
2580 void ssl3_cleanup_key_block(SSL_CONNECTION
*s
);
2581 __owur
int ssl3_do_write(SSL_CONNECTION
*s
, uint8_t type
);
2582 int ssl3_send_alert(SSL_CONNECTION
*s
, int level
, int desc
);
2583 __owur
int ssl3_generate_master_secret(SSL_CONNECTION
*s
, unsigned char *out
,
2584 unsigned char *p
, size_t len
,
2585 size_t *secret_size
);
2586 __owur
int ssl3_get_req_cert_type(SSL_CONNECTION
*s
, WPACKET
*pkt
);
2587 __owur
int ssl3_num_ciphers(void);
2588 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2589 int ssl3_renegotiate(SSL
*ssl
);
2590 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2591 void ssl3_digest_master_key_set_params(const SSL_SESSION
*session
,
2592 OSSL_PARAM params
[]);
2593 __owur
int ssl3_dispatch_alert(SSL
*s
);
2594 __owur
size_t ssl3_final_finish_mac(SSL_CONNECTION
*s
, const char *sender
,
2595 size_t slen
, unsigned char *p
);
2596 __owur
int ssl3_finish_mac(SSL_CONNECTION
*s
, const unsigned char *buf
,
2598 void ssl3_free_digest_list(SSL_CONNECTION
*s
);
2599 __owur
unsigned long ssl3_output_cert_chain(SSL_CONNECTION
*s
, WPACKET
*pkt
,
2600 CERT_PKEY
*cpk
, int for_comp
);
2601 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL_CONNECTION
*s
,
2602 STACK_OF(SSL_CIPHER
) *clnt
,
2603 STACK_OF(SSL_CIPHER
) *srvr
);
2604 __owur
int ssl3_digest_cached_records(SSL_CONNECTION
*s
, int keep
);
2605 __owur
int ssl3_new(SSL
*s
);
2606 void ssl3_free(SSL
*s
);
2607 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2608 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2609 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2610 __owur
int ssl3_shutdown(SSL
*s
);
2611 int ssl3_clear(SSL
*s
);
2612 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2613 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2614 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2615 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2617 __owur
int ssl3_do_change_cipher_spec(SSL_CONNECTION
*s
);
2618 __owur OSSL_TIME
ssl3_default_timeout(void);
2620 __owur
int ssl3_set_handshake_header(SSL_CONNECTION
*s
, WPACKET
*pkt
,
2622 __owur
int tls_close_construct_packet(SSL_CONNECTION
*s
, WPACKET
*pkt
, int htype
);
2623 __owur
int tls_setup_handshake(SSL_CONNECTION
*s
);
2624 __owur
int dtls1_set_handshake_header(SSL_CONNECTION
*s
, WPACKET
*pkt
, int htype
);
2625 __owur
int dtls1_close_construct_packet(SSL_CONNECTION
*s
, WPACKET
*pkt
, int htype
);
2626 __owur
int ssl3_handshake_write(SSL_CONNECTION
*s
);
2628 __owur
int ssl_allow_compression(SSL_CONNECTION
*s
);
2630 __owur
int ssl_version_cmp(const SSL_CONNECTION
*s
, int versiona
, int versionb
);
2631 __owur
int ssl_version_supported(const SSL_CONNECTION
*s
, int version
,
2632 const SSL_METHOD
**meth
);
2634 __owur
int ssl_set_client_hello_version(SSL_CONNECTION
*s
);
2635 __owur
int ssl_check_version_downgrade(SSL_CONNECTION
*s
);
2636 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2637 __owur
int ssl_choose_server_version(SSL_CONNECTION
*s
, CLIENTHELLO_MSG
*hello
,
2639 __owur
int ssl_choose_client_version(SSL_CONNECTION
*s
, int version
,
2640 RAW_EXTENSION
*extensions
);
2641 __owur
int ssl_get_min_max_version(const SSL_CONNECTION
*s
, int *min_version
,
2642 int *max_version
, int *real_max
);
2644 __owur OSSL_TIME
tls1_default_timeout(void);
2645 __owur
int dtls1_do_write(SSL_CONNECTION
*s
, uint8_t type
);
2646 void dtls1_set_message_header(SSL_CONNECTION
*s
,
2649 size_t frag_off
, size_t frag_len
);
2651 int dtls1_write_app_data_bytes(SSL
*s
, uint8_t type
, const void *buf_
,
2652 size_t len
, size_t *written
);
2654 __owur
int dtls1_read_failed(SSL_CONNECTION
*s
, int code
);
2655 __owur
int dtls1_buffer_message(SSL_CONNECTION
*s
, int ccs
);
2656 __owur
int dtls1_retransmit_message(SSL_CONNECTION
*s
, unsigned short seq
,
2658 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2659 int dtls1_retransmit_buffered_messages(SSL_CONNECTION
*s
);
2660 void dtls1_clear_received_buffer(SSL_CONNECTION
*s
);
2661 void dtls1_clear_sent_buffer(SSL_CONNECTION
*s
);
2662 void dtls1_get_message_header(const unsigned char *data
,
2663 struct hm_header_st
*msg_hdr
);
2664 __owur OSSL_TIME
dtls1_default_timeout(void);
2665 __owur
int dtls1_get_timeout(const SSL_CONNECTION
*s
, OSSL_TIME
*timeleft
);
2666 __owur
int dtls1_check_timeout_num(SSL_CONNECTION
*s
);
2667 __owur
int dtls1_handle_timeout(SSL_CONNECTION
*s
);
2668 void dtls1_start_timer(SSL_CONNECTION
*s
);
2669 void dtls1_stop_timer(SSL_CONNECTION
*s
);
2670 __owur
int dtls1_is_timer_expired(SSL_CONNECTION
*s
);
2671 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2673 __owur
size_t dtls1_min_mtu(SSL_CONNECTION
*s
);
2674 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2675 __owur
int dtls1_query_mtu(SSL_CONNECTION
*s
);
2677 __owur
int tls1_new(SSL
*s
);
2678 void tls1_free(SSL
*s
);
2679 int tls1_clear(SSL
*s
);
2681 __owur
int dtls1_new(SSL
*s
);
2682 void dtls1_free(SSL
*s
);
2683 int dtls1_clear(SSL
*s
);
2684 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2685 __owur
int dtls1_shutdown(SSL
*s
);
2687 __owur
int dtls1_dispatch_alert(SSL
*s
);
2689 __owur
int ssl_init_wbio_buffer(SSL_CONNECTION
*s
);
2690 int ssl_free_wbio_buffer(SSL_CONNECTION
*s
);
2692 __owur
int tls1_change_cipher_state(SSL_CONNECTION
*s
, int which
);
2693 __owur
int tls1_setup_key_block(SSL_CONNECTION
*s
);
2694 __owur
size_t tls1_final_finish_mac(SSL_CONNECTION
*s
, const char *str
,
2695 size_t slen
, unsigned char *p
);
2696 __owur
int tls1_generate_master_secret(SSL_CONNECTION
*s
, unsigned char *out
,
2697 unsigned char *p
, size_t len
,
2698 size_t *secret_size
);
2699 __owur
int tls13_setup_key_block(SSL_CONNECTION
*s
);
2700 __owur
size_t tls13_final_finish_mac(SSL_CONNECTION
*s
, const char *str
, size_t slen
,
2702 __owur
int tls13_change_cipher_state(SSL_CONNECTION
*s
, int which
);
2703 __owur
int tls13_update_key(SSL_CONNECTION
*s
, int send
);
2704 __owur
int tls13_hkdf_expand(SSL_CONNECTION
*s
,
2706 const unsigned char *secret
,
2707 const unsigned char *label
, size_t labellen
,
2708 const unsigned char *data
, size_t datalen
,
2709 unsigned char *out
, size_t outlen
, int fatal
);
2710 __owur
int tls13_hkdf_expand_ex(OSSL_LIB_CTX
*libctx
, const char *propq
,
2712 const unsigned char *secret
,
2713 const unsigned char *label
, size_t labellen
,
2714 const unsigned char *data
, size_t datalen
,
2715 unsigned char *out
, size_t outlen
,
2717 __owur
int tls13_derive_key(SSL_CONNECTION
*s
, const EVP_MD
*md
,
2718 const unsigned char *secret
, unsigned char *key
,
2720 __owur
int tls13_derive_iv(SSL_CONNECTION
*s
, const EVP_MD
*md
,
2721 const unsigned char *secret
, unsigned char *iv
,
2723 __owur
int tls13_derive_finishedkey(SSL_CONNECTION
*s
, const EVP_MD
*md
,
2724 const unsigned char *secret
,
2725 unsigned char *fin
, size_t finlen
);
2726 int tls13_generate_secret(SSL_CONNECTION
*s
, const EVP_MD
*md
,
2727 const unsigned char *prevsecret
,
2728 const unsigned char *insecret
,
2730 unsigned char *outsecret
);
2731 __owur
int tls13_generate_handshake_secret(SSL_CONNECTION
*s
,
2732 const unsigned char *insecret
,
2733 size_t insecretlen
);
2734 __owur
int tls13_generate_master_secret(SSL_CONNECTION
*s
, unsigned char *out
,
2735 unsigned char *prev
, size_t prevlen
,
2736 size_t *secret_size
);
2737 __owur
int tls1_export_keying_material(SSL_CONNECTION
*s
,
2738 unsigned char *out
, size_t olen
,
2739 const char *label
, size_t llen
,
2740 const unsigned char *p
, size_t plen
,
2742 __owur
int tls13_export_keying_material(SSL_CONNECTION
*s
,
2743 unsigned char *out
, size_t olen
,
2744 const char *label
, size_t llen
,
2745 const unsigned char *context
,
2746 size_t contextlen
, int use_context
);
2747 __owur
int tls13_export_keying_material_early(SSL_CONNECTION
*s
,
2748 unsigned char *out
, size_t olen
,
2749 const char *label
, size_t llen
,
2750 const unsigned char *context
,
2752 __owur
int tls1_alert_code(int code
);
2753 __owur
int tls13_alert_code(int code
);
2754 __owur
int ssl3_alert_code(int code
);
2756 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL_CONNECTION
*s
);
2758 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2760 __owur
const TLS_GROUP_INFO
*tls1_group_id_lookup(SSL_CTX
*ctx
, uint16_t curve_id
);
2761 __owur
const char *tls1_group_id2name(SSL_CTX
*ctx
, uint16_t group_id
);
2762 __owur
int tls1_group_id2nid(uint16_t group_id
, int include_unknown
);
2763 __owur
uint16_t tls1_nid2group_id(int nid
);
2764 __owur
int tls1_check_group_id(SSL_CONNECTION
*s
, uint16_t group_id
,
2765 int check_own_curves
);
2766 __owur
uint16_t tls1_shared_group(SSL_CONNECTION
*s
, int nmatch
);
2767 __owur
int tls1_set_groups(uint16_t **pext
, size_t *pextlen
,
2768 int *curves
, size_t ncurves
);
2769 __owur
int tls1_set_groups_list(SSL_CTX
*ctx
, uint16_t **pext
, size_t *pextlen
,
2771 __owur EVP_PKEY
*ssl_generate_pkey_group(SSL_CONNECTION
*s
, uint16_t id
);
2772 __owur
int tls_valid_group(SSL_CONNECTION
*s
, uint16_t group_id
, int minversion
,
2773 int maxversion
, int isec
, int *okfortls13
);
2774 __owur EVP_PKEY
*ssl_generate_param_group(SSL_CONNECTION
*s
, uint16_t id
);
2775 void tls1_get_formatlist(SSL_CONNECTION
*s
, const unsigned char **pformats
,
2776 size_t *num_formats
);
2777 __owur
int tls1_check_ec_tmp_key(SSL_CONNECTION
*s
, unsigned long id
);
2779 __owur
int tls_group_allowed(SSL_CONNECTION
*s
, uint16_t curve
, int op
);
2780 void tls1_get_supported_groups(SSL_CONNECTION
*s
, const uint16_t **pgroups
,
2781 size_t *pgroupslen
);
2783 __owur
int tls1_set_server_sigalgs(SSL_CONNECTION
*s
);
2785 __owur SSL_TICKET_STATUS
tls_get_ticket_from_client(SSL_CONNECTION
*s
,
2786 CLIENTHELLO_MSG
*hello
,
2788 __owur SSL_TICKET_STATUS
tls_decrypt_ticket(SSL_CONNECTION
*s
,
2789 const unsigned char *etick
,
2791 const unsigned char *sess_id
,
2792 size_t sesslen
, SSL_SESSION
**psess
);
2794 __owur
int tls_use_ticket(SSL_CONNECTION
*s
);
2796 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL_CONNECTION
*s
, int op
);
2798 __owur
int tls1_set_sigalgs_list(SSL_CTX
*ctx
, CERT
*c
, const char *str
, int client
);
2799 __owur
int tls1_set_raw_sigalgs(CERT
*c
, const uint16_t *psigs
, size_t salglen
,
2801 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2803 int tls1_check_chain(SSL_CONNECTION
*s
, X509
*x
, EVP_PKEY
*pk
,
2804 STACK_OF(X509
) *chain
, int idx
);
2805 void tls1_set_cert_validity(SSL_CONNECTION
*s
);
2807 # ifndef OPENSSL_NO_CT
2808 __owur
int ssl_validate_ct(SSL_CONNECTION
*s
);
2811 __owur EVP_PKEY
*ssl_get_auto_dh(SSL_CONNECTION
*s
);
2813 __owur
int ssl_security_cert(SSL_CONNECTION
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
,
2815 __owur
int ssl_security_cert_chain(SSL_CONNECTION
*s
, STACK_OF(X509
) *sk
,
2818 int tls_choose_sigalg(SSL_CONNECTION
*s
, int fatalerrs
);
2820 __owur
long ssl_get_algorithm2(SSL_CONNECTION
*s
);
2821 __owur
int tls12_copy_sigalgs(SSL_CONNECTION
*s
, WPACKET
*pkt
,
2822 const uint16_t *psig
, size_t psiglen
);
2823 __owur
int tls1_save_u16(PACKET
*pkt
, uint16_t **pdest
, size_t *pdestlen
);
2824 __owur
int tls1_save_sigalgs(SSL_CONNECTION
*s
, PACKET
*pkt
, int cert
);
2825 __owur
int tls1_process_sigalgs(SSL_CONNECTION
*s
);
2826 __owur
int tls1_set_peer_legacy_sigalg(SSL_CONNECTION
*s
, const EVP_PKEY
*pkey
);
2827 __owur
int tls1_lookup_md(SSL_CTX
*ctx
, const SIGALG_LOOKUP
*lu
,
2828 const EVP_MD
**pmd
);
2829 __owur
size_t tls12_get_psigalgs(SSL_CONNECTION
*s
, int sent
,
2830 const uint16_t **psigs
);
2831 __owur
int tls_check_sigalg_curve(const SSL_CONNECTION
*s
, int curve
);
2832 __owur
int tls12_check_peer_sigalg(SSL_CONNECTION
*s
, uint16_t, EVP_PKEY
*pkey
);
2833 __owur
int ssl_set_client_disabled(SSL_CONNECTION
*s
);
2834 __owur
int ssl_cipher_disabled(const SSL_CONNECTION
*s
, const SSL_CIPHER
*c
,
2837 __owur
int ssl_handshake_hash(SSL_CONNECTION
*s
,
2838 unsigned char *out
, size_t outlen
,
2840 __owur
const EVP_MD
*ssl_md(SSL_CTX
*ctx
, int idx
);
2841 int ssl_get_md_idx(int md_nid
);
2842 __owur
const EVP_MD
*ssl_handshake_md(SSL_CONNECTION
*s
);
2843 __owur
const EVP_MD
*ssl_prf_md(SSL_CONNECTION
*s
);
2846 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2847 * with |ssl|, if logging is enabled. It returns one on success and zero on
2848 * failure. The entry is identified by the first 8 bytes of
2849 * |encrypted_premaster|.
2851 __owur
int ssl_log_rsa_client_key_exchange(SSL_CONNECTION
*s
,
2852 const uint8_t *encrypted_premaster
,
2853 size_t encrypted_premaster_len
,
2854 const uint8_t *premaster
,
2855 size_t premaster_len
);
2858 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2859 * logging is available. It returns one on success and zero on failure. It tags
2860 * the entry with |label|.
2862 __owur
int ssl_log_secret(SSL_CONNECTION
*s
, const char *label
,
2863 const uint8_t *secret
, size_t secret_len
);
2865 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2866 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2867 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2868 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2869 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2870 #define CLIENT_APPLICATION_N_LABEL "CLIENT_TRAFFIC_SECRET_N"
2871 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2872 #define SERVER_APPLICATION_N_LABEL "SERVER_TRAFFIC_SECRET_N"
2873 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2874 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2876 __owur
int srp_generate_server_master_secret(SSL_CONNECTION
*s
);
2877 __owur
int srp_generate_client_master_secret(SSL_CONNECTION
*s
);
2878 __owur
int srp_verify_server_param(SSL_CONNECTION
*s
);
2880 /* statem/statem_srvr.c */
2882 __owur
int send_certificate_request(SSL_CONNECTION
*s
);
2884 /* statem/extensions_cust.c */
2886 custom_ext_method
*custom_ext_find(const custom_ext_methods
*exts
,
2887 ENDPOINT role
, unsigned int ext_type
,
2890 void custom_ext_init(custom_ext_methods
*meths
);
2892 int ossl_tls_add_custom_ext_intern(SSL_CTX
*ctx
, custom_ext_methods
*exts
,
2893 ENDPOINT role
, unsigned int ext_type
,
2894 unsigned int context
,
2895 SSL_custom_ext_add_cb_ex add_cb
,
2896 SSL_custom_ext_free_cb_ex free_cb
,
2898 SSL_custom_ext_parse_cb_ex parse_cb
,
2900 __owur
int custom_ext_parse(SSL_CONNECTION
*s
, unsigned int context
,
2901 unsigned int ext_type
,
2902 const unsigned char *ext_data
, size_t ext_size
,
2903 X509
*x
, size_t chainidx
);
2904 __owur
int custom_ext_add(SSL_CONNECTION
*s
, int context
, WPACKET
*pkt
, X509
*x
,
2905 size_t chainidx
, int maxversion
);
2907 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2908 const custom_ext_methods
*src
);
2909 __owur
int custom_exts_copy_flags(custom_ext_methods
*dst
,
2910 const custom_ext_methods
*src
);
2911 void custom_exts_free(custom_ext_methods
*exts
);
2913 void ssl_comp_free_compression_methods_int(void);
2916 int ssl_ctx_system_config(SSL_CTX
*ctx
);
2918 const EVP_CIPHER
*ssl_evp_cipher_fetch(OSSL_LIB_CTX
*libctx
,
2920 const char *properties
);
2921 int ssl_evp_cipher_up_ref(const EVP_CIPHER
*cipher
);
2922 void ssl_evp_cipher_free(const EVP_CIPHER
*cipher
);
2923 const EVP_MD
*ssl_evp_md_fetch(OSSL_LIB_CTX
*libctx
,
2925 const char *properties
);
2926 int ssl_evp_md_up_ref(const EVP_MD
*md
);
2927 void ssl_evp_md_free(const EVP_MD
*md
);
2929 void tls_engine_finish(ENGINE
*e
);
2930 const EVP_CIPHER
*tls_get_cipher_from_engine(int nid
);
2931 const EVP_MD
*tls_get_digest_from_engine(int nid
);
2932 int tls_engine_load_ssl_client_cert(SSL_CONNECTION
*s
, X509
**px509
,
2934 int ssl_hmac_old_new(SSL_HMAC
*ret
);
2935 void ssl_hmac_old_free(SSL_HMAC
*ctx
);
2936 int ssl_hmac_old_init(SSL_HMAC
*ctx
, void *key
, size_t len
, char *md
);
2937 int ssl_hmac_old_update(SSL_HMAC
*ctx
, const unsigned char *data
, size_t len
);
2938 int ssl_hmac_old_final(SSL_HMAC
*ctx
, unsigned char *md
, size_t *len
);
2939 size_t ssl_hmac_old_size(const SSL_HMAC
*ctx
);
2941 int ssl_ctx_srp_ctx_free_intern(SSL_CTX
*ctx
);
2942 int ssl_ctx_srp_ctx_init_intern(SSL_CTX
*ctx
);
2943 int ssl_srp_ctx_free_intern(SSL_CONNECTION
*s
);
2944 int ssl_srp_ctx_init_intern(SSL_CONNECTION
*s
);
2946 int ssl_srp_calc_a_param_intern(SSL_CONNECTION
*s
);
2947 int ssl_srp_server_param_with_username_intern(SSL_CONNECTION
*s
, int *ad
);
2949 void ssl_session_calculate_timeout(SSL_SESSION
*ss
);
2951 # else /* OPENSSL_UNIT_TEST */
2953 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2957 /* Some helper routines to support TSAN operations safely */
2958 static ossl_unused ossl_inline
int ssl_tsan_lock(const SSL_CTX
*ctx
)
2960 #ifdef TSAN_REQUIRES_LOCKING
2961 if (!CRYPTO_THREAD_write_lock(ctx
->tsan_lock
))
2967 static ossl_unused ossl_inline
void ssl_tsan_unlock(const SSL_CTX
*ctx
)
2969 #ifdef TSAN_REQUIRES_LOCKING
2970 CRYPTO_THREAD_unlock(ctx
->tsan_lock
);
2974 static ossl_unused ossl_inline
void ssl_tsan_counter(const SSL_CTX
*ctx
,
2975 TSAN_QUALIFIER
int *stat
)
2977 if (ssl_tsan_lock(ctx
)) {
2979 ssl_tsan_unlock(ctx
);
2983 int ossl_comp_has_alg(int a
);
2984 size_t ossl_calculate_comp_expansion(int alg
, size_t length
);
2986 void ossl_ssl_set_custom_record_layer(SSL_CONNECTION
*s
,
2987 const OSSL_RECORD_METHOD
*meth
,
2990 long ossl_ctrl_internal(SSL
*s
, int cmd
, long larg
, void *parg
, int no_quic
);
2993 * Options which no longer have any effect, but which can be implemented
2994 * as no-ops for QUIC.
2996 #define OSSL_LEGACY_SSL_OPTIONS \
2997 (SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG | \
2998 SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER | \
2999 SSL_OP_SSLEAY_080_CLIENT_DH_BUG | \
3000 SSL_OP_TLS_D5_BUG | \
3001 SSL_OP_TLS_BLOCK_PADDING_BUG | \
3002 SSL_OP_MSIE_SSLV2_RSA_PADDING | \
3003 SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG | \
3004 SSL_OP_MICROSOFT_SESS_ID_BUG | \
3005 SSL_OP_NETSCAPE_CHALLENGE_BUG | \
3006 SSL_OP_PKCS1_CHECK_1 | \
3007 SSL_OP_PKCS1_CHECK_2 | \
3008 SSL_OP_SINGLE_DH_USE | \
3009 SSL_OP_SINGLE_ECDH_USE | \
3010 SSL_OP_EPHEMERAL_RSA )
3012 /* This option is undefined in public headers with no-dtls1-method. */
3013 #ifndef SSL_OP_CISCO_ANYCONNECT
3014 # define SSL_OP_CISCO_ANYCONNECT 0
3017 * Options which are no-ops under QUIC or TLSv1.3 and which are therefore
3018 * allowed but ignored under QUIC.
3020 #define OSSL_TLS1_2_OPTIONS \
3021 (SSL_OP_CRYPTOPRO_TLSEXT_BUG | \
3022 SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS | \
3023 SSL_OP_ALLOW_CLIENT_RENEGOTIATION | \
3024 SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION | \
3025 SSL_OP_NO_COMPRESSION | \
3028 SSL_OP_NO_TLSv1_1 | \
3029 SSL_OP_NO_TLSv1_2 | \
3030 SSL_OP_NO_DTLSv1 | \
3031 SSL_OP_NO_DTLSv1_2 | \
3032 SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION | \
3033 SSL_OP_CISCO_ANYCONNECT | \
3034 SSL_OP_NO_RENEGOTIATION | \
3035 SSL_OP_NO_EXTENDED_MASTER_SECRET | \
3036 SSL_OP_NO_ENCRYPT_THEN_MAC | \
3037 SSL_OP_COOKIE_EXCHANGE | \
3038 SSL_OP_LEGACY_SERVER_CONNECT | \
3039 SSL_OP_IGNORE_UNEXPECTED_EOF )
3041 /* Total mask of connection-level options permitted or ignored under QUIC. */
3042 #define OSSL_QUIC_PERMITTED_OPTIONS_CONN \
3043 (OSSL_LEGACY_SSL_OPTIONS | \
3044 OSSL_TLS1_2_OPTIONS | \
3045 SSL_OP_CIPHER_SERVER_PREFERENCE | \
3046 SSL_OP_DISABLE_TLSEXT_CA_NAMES | \
3047 SSL_OP_NO_TX_CERTIFICATE_COMPRESSION | \
3048 SSL_OP_NO_RX_CERTIFICATE_COMPRESSION | \
3049 SSL_OP_PRIORITIZE_CHACHA | \
3050 SSL_OP_NO_QUERY_MTU | \
3051 SSL_OP_NO_TICKET | \
3052 SSL_OP_NO_ANTI_REPLAY )
3054 /* Total mask of stream-level options permitted or ignored under QUIC. */
3055 #define OSSL_QUIC_PERMITTED_OPTIONS_STREAM \
3056 (OSSL_LEGACY_SSL_OPTIONS | \
3057 OSSL_TLS1_2_OPTIONS | \
3058 SSL_OP_CLEANSE_PLAINTEXT )
3060 /* Total mask of options permitted on either connections or streams. */
3061 #define OSSL_QUIC_PERMITTED_OPTIONS \
3062 (OSSL_QUIC_PERMITTED_OPTIONS_CONN | \
3063 OSSL_QUIC_PERMITTED_OPTIONS_STREAM)