2 * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
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 "record/record.h"
31 # include "internal/recordmethod.h"
32 # include "statem/statem.h"
33 # include "internal/packet.h"
34 # include "internal/dane.h"
35 # include "internal/refcount.h"
36 # include "internal/tsan_assist.h"
37 # include "internal/bio.h"
38 # include "internal/ktls.h"
39 # include "internal/time.h"
41 # ifdef OPENSSL_BUILD_SHLIBSSL
42 # undef OPENSSL_EXTERN
43 # define OPENSSL_EXTERN OPENSSL_EXPORT
46 # define TLS_MAX_VERSION_INTERNAL TLS1_3_VERSION
47 # define DTLS_MAX_VERSION_INTERNAL DTLS1_2_VERSION
50 * DTLS version numbers are strange because they're inverted. Except for
51 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
53 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
54 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
55 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
56 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
57 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
59 # define SSL_AD_NO_ALERT -1
62 * Define the Bitmasks for SSL_CIPHER.algorithms.
63 * This bits are used packed as dense as possible. If new methods/ciphers
64 * etc will be added, the bits a likely to change, so this information
65 * is for internal library use only, even though SSL_CIPHER.algorithms
66 * can be publicly accessed.
67 * Use the according functions for cipher management instead.
69 * The bit mask handling in the selection and sorting scheme in
70 * ssl_create_cipher_list() has only limited capabilities, reflecting
71 * that the different entities within are mutually exclusive:
72 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
75 /* Bits for algorithm_mkey (key exchange algorithm) */
76 /* RSA key exchange */
77 # define SSL_kRSA 0x00000001U
78 /* tmp DH key no DH cert */
79 # define SSL_kDHE 0x00000002U
81 # define SSL_kEDH SSL_kDHE
83 # define SSL_kECDHE 0x00000004U
85 # define SSL_kEECDH SSL_kECDHE
87 # define SSL_kPSK 0x00000008U
88 /* GOST key exchange */
89 # define SSL_kGOST 0x00000010U
91 # define SSL_kSRP 0x00000020U
93 # define SSL_kRSAPSK 0x00000040U
94 # define SSL_kECDHEPSK 0x00000080U
95 # define SSL_kDHEPSK 0x00000100U
96 /* GOST KDF key exchange, draft-smyshlyaev-tls12-gost-suites */
97 # define SSL_kGOST18 0x00000200U
101 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
103 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
104 # define SSL_kANY 0x00000000U
106 /* Bits for algorithm_auth (server authentication) */
108 # define SSL_aRSA 0x00000001U
110 # define SSL_aDSS 0x00000002U
111 /* no auth (i.e. use ADH or AECDH) */
112 # define SSL_aNULL 0x00000004U
114 # define SSL_aECDSA 0x00000008U
116 # define SSL_aPSK 0x00000010U
117 /* GOST R 34.10-2001 signature auth */
118 # define SSL_aGOST01 0x00000020U
120 # define SSL_aSRP 0x00000040U
121 /* GOST R 34.10-2012 signature auth */
122 # define SSL_aGOST12 0x00000080U
123 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
124 # define SSL_aANY 0x00000000U
125 /* All bits requiring a certificate */
127 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
129 /* Bits for algorithm_enc (symmetric encryption) */
130 # define SSL_DES 0x00000001U
131 # define SSL_3DES 0x00000002U
132 # define SSL_RC4 0x00000004U
133 # define SSL_RC2 0x00000008U
134 # define SSL_IDEA 0x00000010U
135 # define SSL_eNULL 0x00000020U
136 # define SSL_AES128 0x00000040U
137 # define SSL_AES256 0x00000080U
138 # define SSL_CAMELLIA128 0x00000100U
139 # define SSL_CAMELLIA256 0x00000200U
140 # define SSL_eGOST2814789CNT 0x00000400U
141 # define SSL_SEED 0x00000800U
142 # define SSL_AES128GCM 0x00001000U
143 # define SSL_AES256GCM 0x00002000U
144 # define SSL_AES128CCM 0x00004000U
145 # define SSL_AES256CCM 0x00008000U
146 # define SSL_AES128CCM8 0x00010000U
147 # define SSL_AES256CCM8 0x00020000U
148 # define SSL_eGOST2814789CNT12 0x00040000U
149 # define SSL_CHACHA20POLY1305 0x00080000U
150 # define SSL_ARIA128GCM 0x00100000U
151 # define SSL_ARIA256GCM 0x00200000U
152 # define SSL_MAGMA 0x00400000U
153 # define SSL_KUZNYECHIK 0x00800000U
155 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
156 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
157 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
158 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
159 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
160 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
161 # define SSL_ARIA (SSL_ARIAGCM)
162 # define SSL_CBC (SSL_DES | SSL_3DES | SSL_RC2 | SSL_IDEA \
163 | SSL_AES128 | SSL_AES256 | SSL_CAMELLIA128 \
164 | SSL_CAMELLIA256 | SSL_SEED)
166 /* Bits for algorithm_mac (symmetric authentication) */
168 # define SSL_MD5 0x00000001U
169 # define SSL_SHA1 0x00000002U
170 # define SSL_GOST94 0x00000004U
171 # define SSL_GOST89MAC 0x00000008U
172 # define SSL_SHA256 0x00000010U
173 # define SSL_SHA384 0x00000020U
174 /* Not a real MAC, just an indication it is part of cipher */
175 # define SSL_AEAD 0x00000040U
176 # define SSL_GOST12_256 0x00000080U
177 # define SSL_GOST89MAC12 0x00000100U
178 # define SSL_GOST12_512 0x00000200U
179 # define SSL_MAGMAOMAC 0x00000400U
180 # define SSL_KUZNYECHIKOMAC 0x00000800U
183 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
184 * sure to update this constant too
187 # define SSL_MD_MD5_IDX 0
188 # define SSL_MD_SHA1_IDX 1
189 # define SSL_MD_GOST94_IDX 2
190 # define SSL_MD_GOST89MAC_IDX 3
191 # define SSL_MD_SHA256_IDX 4
192 # define SSL_MD_SHA384_IDX 5
193 # define SSL_MD_GOST12_256_IDX 6
194 # define SSL_MD_GOST89MAC12_IDX 7
195 # define SSL_MD_GOST12_512_IDX 8
196 # define SSL_MD_MD5_SHA1_IDX 9
197 # define SSL_MD_SHA224_IDX 10
198 # define SSL_MD_SHA512_IDX 11
199 # define SSL_MD_MAGMAOMAC_IDX 12
200 # define SSL_MD_KUZNYECHIKOMAC_IDX 13
201 # define SSL_MAX_DIGEST 14
203 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
205 /* Bits for algorithm2 (handshake digests and other extra flags) */
207 /* Bits 0-7 are handshake MAC */
208 # define SSL_HANDSHAKE_MAC_MASK 0xFF
209 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
210 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
211 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
212 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
213 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
214 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
215 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
217 /* Bits 8-15 bits are PRF */
218 # define TLS1_PRF_DGST_SHIFT 8
219 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
220 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
221 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
222 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
223 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
224 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
225 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
228 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
229 * goes into algorithm2)
231 # define TLS1_STREAM_MAC 0x10000
233 * TLSTREE cipher/mac key derivation from draft-smyshlyaev-tls12-gost-suites
234 * (currently this also goes into algorithm2)
236 # define TLS1_TLSTREE 0x20000
238 # define SSL_STRONG_MASK 0x0000001FU
239 # define SSL_DEFAULT_MASK 0X00000020U
241 # define SSL_STRONG_NONE 0x00000001U
242 # define SSL_LOW 0x00000002U
243 # define SSL_MEDIUM 0x00000004U
244 # define SSL_HIGH 0x00000008U
245 # define SSL_FIPS 0x00000010U
246 # define SSL_NOT_DEFAULT 0x00000020U
248 /* we have used 0000003f - 26 bits left to go */
250 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
251 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
253 /* Check if an SSL structure is using DTLS */
254 # define SSL_CONNECTION_IS_DTLS(s) \
255 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
257 /* Check if we are using TLSv1.3 */
258 # define SSL_CONNECTION_IS_TLS13(s) (!SSL_CONNECTION_IS_DTLS(s) \
259 && SSL_CONNECTION_GET_SSL(s)->method->version >= TLS1_3_VERSION \
260 && SSL_CONNECTION_GET_SSL(s)->method->version != TLS_ANY_VERSION)
262 # define SSL_CONNECTION_TREAT_AS_TLS13(s) \
263 (SSL_CONNECTION_IS_TLS13(s) \
264 || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
265 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
266 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
267 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
268 || (s)->hello_retry_request == SSL_HRR_PENDING)
270 # define SSL_IS_FIRST_HANDSHAKE(s) ((s)->s3.tmp.finish_md_len == 0 \
271 || (s)->s3.tmp.peer_finish_md_len == 0)
273 /* See if we need explicit IV */
274 # define SSL_USE_EXPLICIT_IV(s) \
275 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
277 * See if we use signature algorithms extension and signature algorithm
280 # define SSL_USE_SIGALGS(s) \
281 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
283 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
284 * apply to others in future.
286 # define SSL_USE_TLS1_2_CIPHERS(s) \
287 (SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
289 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
290 * flags because it may not be set to correct version yet.
292 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
293 ((!SSL_CONNECTION_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
294 (SSL_CONNECTION_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
296 * Determine if a client should send signature algorithms extension:
297 * as with TLS1.2 cipher we can't rely on method flags.
299 # define SSL_CLIENT_USE_SIGALGS(s) \
300 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
302 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
303 (((value) >= TLSEXT_max_fragment_length_512) && \
304 ((value) <= TLSEXT_max_fragment_length_4096))
305 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
306 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
307 # define GET_MAX_FRAGMENT_LENGTH(session) \
308 (512U << (session->ext.max_fragment_len_mode - 1))
310 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
311 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
313 /* alert_dispatch values */
315 /* No alert pending */
316 # define SSL_ALERT_DISPATCH_NONE 0
318 # define SSL_ALERT_DISPATCH_PENDING 1
319 /* Pending alert write needs to be retried */
320 # define SSL_ALERT_DISPATCH_RETRY 2
322 /* Mostly for SSLv3 */
323 # define SSL_PKEY_RSA 0
324 # define SSL_PKEY_RSA_PSS_SIGN 1
325 # define SSL_PKEY_DSA_SIGN 2
326 # define SSL_PKEY_ECC 3
327 # define SSL_PKEY_GOST01 4
328 # define SSL_PKEY_GOST12_256 5
329 # define SSL_PKEY_GOST12_512 6
330 # define SSL_PKEY_ED25519 7
331 # define SSL_PKEY_ED448 8
332 # define SSL_PKEY_NUM 9
334 # define SSL_ENC_DES_IDX 0
335 # define SSL_ENC_3DES_IDX 1
336 # define SSL_ENC_RC4_IDX 2
337 # define SSL_ENC_RC2_IDX 3
338 # define SSL_ENC_IDEA_IDX 4
339 # define SSL_ENC_NULL_IDX 5
340 # define SSL_ENC_AES128_IDX 6
341 # define SSL_ENC_AES256_IDX 7
342 # define SSL_ENC_CAMELLIA128_IDX 8
343 # define SSL_ENC_CAMELLIA256_IDX 9
344 # define SSL_ENC_GOST89_IDX 10
345 # define SSL_ENC_SEED_IDX 11
346 # define SSL_ENC_AES128GCM_IDX 12
347 # define SSL_ENC_AES256GCM_IDX 13
348 # define SSL_ENC_AES128CCM_IDX 14
349 # define SSL_ENC_AES256CCM_IDX 15
350 # define SSL_ENC_AES128CCM8_IDX 16
351 # define SSL_ENC_AES256CCM8_IDX 17
352 # define SSL_ENC_GOST8912_IDX 18
353 # define SSL_ENC_CHACHA_IDX 19
354 # define SSL_ENC_ARIA128GCM_IDX 20
355 # define SSL_ENC_ARIA256GCM_IDX 21
356 # define SSL_ENC_MAGMA_IDX 22
357 # define SSL_ENC_KUZNYECHIK_IDX 23
358 # define SSL_ENC_NUM_IDX 24
361 * SSL_kRSA <- RSA_ENC
362 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
363 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
364 * SSL_aRSA <- RSA_ENC | RSA_SIGN
365 * SSL_aDSS <- DSA_SIGN
369 #define CERT_INVALID 0
370 #define CERT_PUBLIC_KEY 1
371 #define CERT_PRIVATE_KEY 2
374 /* Post-Handshake Authentication state */
377 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
378 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
379 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
380 SSL_PHA_REQUESTED /* request received by client, or sent by server */
383 /* CipherSuite length. SSLv3 and all TLS versions. */
384 # define TLS_CIPHER_LEN 2
385 /* used to hold info on the particular ciphers used */
386 struct ssl_cipher_st {
388 const char *name; /* text name */
389 const char *stdname; /* RFC name */
390 uint32_t id; /* id, 4 bytes, first is version */
392 * changed in 1.0.0: these four used to be portions of a single value
395 uint32_t algorithm_mkey; /* key exchange algorithm */
396 uint32_t algorithm_auth; /* server authentication */
397 uint32_t algorithm_enc; /* symmetric encryption */
398 uint32_t algorithm_mac; /* symmetric authentication */
399 int min_tls; /* minimum SSL/TLS protocol version */
400 int max_tls; /* maximum SSL/TLS protocol version */
401 int min_dtls; /* minimum DTLS protocol version */
402 int max_dtls; /* maximum DTLS protocol version */
403 uint32_t algo_strength; /* strength and export flags */
404 uint32_t algorithm2; /* Extra flags */
405 int32_t strength_bits; /* Number of bits really used */
406 uint32_t alg_bits; /* Number of bits for algorithm */
409 /* Used to hold SSL/TLS functions */
410 struct ssl_method_st {
414 SSL *(*ssl_new) (SSL_CTX *ctx);
415 void (*ssl_free) (SSL *s);
416 int (*ssl_reset) (SSL *s);
417 int (*ssl_init) (SSL *s);
418 int (*ssl_clear) (SSL *s);
419 void (*ssl_deinit) (SSL *s);
420 int (*ssl_accept) (SSL *s);
421 int (*ssl_connect) (SSL *s);
422 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
423 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
424 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
425 int (*ssl_shutdown) (SSL *s);
426 int (*ssl_renegotiate) (SSL *s);
427 int (*ssl_renegotiate_check) (SSL *s, int);
428 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
429 unsigned char *buf, size_t len, int peek,
431 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
433 int (*ssl_dispatch_alert) (SSL *s);
434 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
435 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
436 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
437 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
439 size_t (*ssl_pending) (const SSL *s);
440 int (*num_ciphers) (void);
441 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
442 OSSL_TIME (*get_timeout) (void);
443 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
444 int (*ssl_version) (void);
445 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
446 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
450 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
451 * consistency, even in the event of OPENSSL_NO_PSK being defined.
453 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 512
456 * Lets make this into an ASN.1 type structure as follows
457 * SSL_SESSION_ID ::= SEQUENCE {
458 * version INTEGER, -- structure version number
459 * SSLversion INTEGER, -- SSL version number
460 * Cipher OCTET STRING, -- the 3 byte cipher ID
461 * Session_ID OCTET STRING, -- the Session ID
462 * Master_key OCTET STRING, -- the master key
463 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
464 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
465 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
466 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
467 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
468 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
469 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
470 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
471 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
472 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
473 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
474 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
475 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
476 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
478 * Look in ssl/ssl_asn1.c for more details
479 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
481 struct ssl_session_st {
482 int ssl_version; /* what ssl version session info is being kept
484 size_t master_key_length;
486 /* TLSv1.3 early_secret used for external PSKs */
487 unsigned char early_secret[EVP_MAX_MD_SIZE];
489 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
492 unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
493 /* session_id - valid? */
494 size_t session_id_length;
495 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
497 * this is used to determine whether the session is being reused in the
498 * appropriate context. It is up to the application to set this, via
501 size_t sid_ctx_length;
502 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
503 # ifndef OPENSSL_NO_PSK
504 char *psk_identity_hint;
508 * Used to indicate that session resumption is not allowed. Applications
509 * can also set this bit for a new session via not_resumable_session_cb
510 * to disable session caching and tickets.
513 /* This is the cert and type for the other end. */
515 /* Certificate chain peer sent. */
516 STACK_OF(X509) *peer_chain;
518 * when app_verify_callback accepts a session where the peer's
519 * certificate is not ok, we must remember the error for session reuse:
521 long verify_result; /* only for servers */
522 CRYPTO_REF_COUNT references;
525 OSSL_TIME calc_timeout;
526 unsigned int compress_meth; /* Need to lookup the method */
527 const SSL_CIPHER *cipher;
528 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
529 * load the 'cipher' structure */
530 unsigned int kex_group; /* TLS group from key exchange */
531 CRYPTO_EX_DATA ex_data; /* application specific data */
533 * These are used to make removal of session-ids more efficient and to
534 * implement a maximum cache size.
536 struct ssl_session_st *prev, *next;
541 unsigned char *tick; /* Session ticket */
542 size_t ticklen; /* Session ticket length */
543 /* Session lifetime hint in seconds */
544 unsigned long tick_lifetime_hint;
545 uint32_t tick_age_add;
546 /* Max number of bytes that can be sent as early data */
547 uint32_t max_early_data;
548 /* The ALPN protocol selected for this session */
549 unsigned char *alpn_selected;
550 size_t alpn_selected_len;
552 * Maximum Fragment Length as per RFC 4366.
553 * If this value does not contain RFC 4366 allowed values (1-4) then
554 * either the Maximum Fragment Length Negotiation failed or was not
557 uint8_t max_fragment_len_mode;
559 # ifndef OPENSSL_NO_SRP
562 unsigned char *ticket_appdata;
563 size_t ticket_appdata_len;
569 /* Extended master secret support */
570 # define SSL_SESS_FLAG_EXTMS 0x1
572 # ifndef OPENSSL_NO_SRP
574 typedef struct srp_ctx_st {
575 /* param for all the callbacks */
577 /* set client Hello login callback */
578 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
579 /* set SRP N/g param callback for verification */
580 int (*SRP_verify_param_callback) (SSL *, void *);
581 /* set SRP client passwd callback */
582 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
584 BIGNUM *N, *g, *s, *B, *A;
588 unsigned long srp_Mask;
594 SSL_EARLY_DATA_NONE = 0,
595 SSL_EARLY_DATA_CONNECT_RETRY,
596 SSL_EARLY_DATA_CONNECTING,
597 SSL_EARLY_DATA_WRITE_RETRY,
598 SSL_EARLY_DATA_WRITING,
599 SSL_EARLY_DATA_WRITE_FLUSH,
600 SSL_EARLY_DATA_UNAUTH_WRITING,
601 SSL_EARLY_DATA_FINISHED_WRITING,
602 SSL_EARLY_DATA_ACCEPT_RETRY,
603 SSL_EARLY_DATA_ACCEPTING,
604 SSL_EARLY_DATA_READ_RETRY,
605 SSL_EARLY_DATA_READING,
606 SSL_EARLY_DATA_FINISHED_READING
607 } SSL_EARLY_DATA_STATE;
610 * We check that the amount of unreadable early data doesn't exceed
611 * max_early_data. max_early_data is given in plaintext bytes. However if it is
612 * unreadable then we only know the number of ciphertext bytes. We also don't
613 * know how much the overhead should be because it depends on the ciphersuite.
614 * We make a small allowance. We assume 5 records of actual data plus the end
615 * of early data alert record. Each record has a tag and a content type byte.
616 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
617 * content of the alert record either which is 2 bytes.
619 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
622 * The allowance we have between the client's calculated ticket age and our own.
623 * We allow for 10 seconds. If a ticket is presented and the
624 * client's age calculation is different by more than this than our own then we
625 * do not allow that ticket for early_data.
627 # define TICKET_AGE_ALLOWANCE ossl_seconds2time(10)
629 #define MAX_COMPRESSIONS_SIZE 255
637 typedef struct raw_extension_st {
638 /* Raw packet data for the extension */
640 /* Set to 1 if the extension is present or 0 otherwise */
642 /* Set to 1 if we have already parsed the extension or 0 otherwise */
644 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
646 /* Track what order extensions are received in (0-based). */
647 size_t received_order;
652 unsigned int legacy_version;
653 unsigned char random[SSL3_RANDOM_SIZE];
654 size_t session_id_len;
655 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
656 size_t dtls_cookie_len;
657 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
659 size_t compressions_len;
660 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
662 size_t pre_proc_exts_len;
663 RAW_EXTENSION *pre_proc_exts;
667 * Extension index values NOTE: Any updates to these defines should be mirrored
668 * with equivalent updates to ext_defs in extensions.c
670 typedef enum tlsext_index_en {
671 TLSEXT_IDX_renegotiate,
672 TLSEXT_IDX_server_name,
673 TLSEXT_IDX_max_fragment_length,
675 TLSEXT_IDX_ec_point_formats,
676 TLSEXT_IDX_supported_groups,
677 TLSEXT_IDX_session_ticket,
678 TLSEXT_IDX_status_request,
679 TLSEXT_IDX_next_proto_neg,
680 TLSEXT_IDX_application_layer_protocol_negotiation,
682 TLSEXT_IDX_encrypt_then_mac,
683 TLSEXT_IDX_signed_certificate_timestamp,
684 TLSEXT_IDX_extended_master_secret,
685 TLSEXT_IDX_signature_algorithms_cert,
686 TLSEXT_IDX_post_handshake_auth,
687 TLSEXT_IDX_signature_algorithms,
688 TLSEXT_IDX_supported_versions,
689 TLSEXT_IDX_psk_kex_modes,
690 TLSEXT_IDX_key_share,
692 TLSEXT_IDX_cryptopro_bug,
693 TLSEXT_IDX_compress_certificate,
694 TLSEXT_IDX_early_data,
695 TLSEXT_IDX_certificate_authorities,
698 /* Dummy index - must always be the last entry */
699 TLSEXT_IDX_num_builtins
702 DEFINE_LHASH_OF_EX(SSL_SESSION);
703 /* Needed in ssl_cert.c */
704 DEFINE_LHASH_OF_EX(X509_NAME);
706 # define TLSEXT_KEYNAME_LENGTH 16
707 # define TLSEXT_TICK_KEY_LENGTH 32
709 typedef struct ssl_ctx_ext_secure_st {
710 unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
711 unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
712 } SSL_CTX_EXT_SECURE;
715 * Helper function for HMAC
716 * The structure should be considered opaque, it will change once the low
717 * level deprecated calls are removed. At that point it can be replaced
718 * by EVP_MAC_CTX and most of the functions converted to macros or inlined
721 typedef struct ssl_hmac_st {
723 # ifndef OPENSSL_NO_DEPRECATED_3_0
728 SSL_HMAC *ssl_hmac_new(const SSL_CTX *ctx);
729 void ssl_hmac_free(SSL_HMAC *ctx);
730 # ifndef OPENSSL_NO_DEPRECATED_3_0
731 HMAC_CTX *ssl_hmac_get0_HMAC_CTX(SSL_HMAC *ctx);
733 EVP_MAC_CTX *ssl_hmac_get0_EVP_MAC_CTX(SSL_HMAC *ctx);
734 int ssl_hmac_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
735 int ssl_hmac_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
736 int ssl_hmac_final(SSL_HMAC *ctx, unsigned char *md, size_t *len,
738 size_t ssl_hmac_size(const SSL_HMAC *ctx);
740 int ssl_get_EC_curve_nid(const EVP_PKEY *pkey);
741 __owur int tls13_set_encoded_pub_key(EVP_PKEY *pkey,
742 const unsigned char *enckey,
745 typedef struct tls_group_info_st {
746 char *tlsname; /* Curve Name as in TLS specs */
747 char *realname; /* Curve Name according to provider */
748 char *algorithm; /* Algorithm name to fetch */
749 unsigned int secbits; /* Bits of security (from SP800-57) */
750 uint16_t group_id; /* Group ID */
751 int mintls; /* Minimum TLS version, -1 unsupported */
752 int maxtls; /* Maximum TLS version (or 0 for undefined) */
753 int mindtls; /* Minimum DTLS version, -1 unsupported */
754 int maxdtls; /* Maximum DTLS version (or 0 for undefined) */
755 char is_kem; /* Mode for this Group: 0 is KEX, 1 is KEM */
759 # define TLS_GROUP_TYPE 0x0000000FU /* Mask for group type */
760 # define TLS_GROUP_CURVE_PRIME 0x00000001U
761 # define TLS_GROUP_CURVE_CHAR2 0x00000002U
762 # define TLS_GROUP_CURVE_CUSTOM 0x00000004U
763 # define TLS_GROUP_FFDHE 0x00000008U
764 # define TLS_GROUP_ONLY_FOR_TLS1_3 0x00000010U
766 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
769 OSSL_LIB_CTX *libctx;
771 const SSL_METHOD *method;
772 STACK_OF(SSL_CIPHER) *cipher_list;
773 /* same as above but sorted for lookup */
774 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
775 /* TLSv1.3 specific ciphersuites */
776 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
777 struct x509_store_st /* X509_STORE */ *cert_store;
778 LHASH_OF(SSL_SESSION) *sessions;
780 * Most session-ids that will be cached, default is
781 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
783 size_t session_cache_size;
784 struct ssl_session_st *session_cache_head;
785 struct ssl_session_st *session_cache_tail;
787 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
788 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
789 * means only SSL_accept will cache SSL_SESSIONS.
791 uint32_t session_cache_mode;
793 * If timeout is not 0, it is the default timeout value set when
794 * SSL_new() is called. This has been put in to make life easier to set
797 OSSL_TIME session_timeout;
799 * If this callback is not null, it will be called each time a session id
800 * is added to the cache. If this function returns 1, it means that the
801 * callback will do a SSL_SESSION_free() when it has finished using it.
802 * Otherwise, on 0, it means the callback has finished with it. If
803 * remove_session_cb is not null, it will be called when a session-id is
804 * removed from the cache. After the call, OpenSSL will
805 * SSL_SESSION_free() it.
807 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
808 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
809 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
810 const unsigned char *data, int len,
813 TSAN_QUALIFIER int sess_connect; /* SSL new conn - started */
814 TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
815 TSAN_QUALIFIER int sess_connect_good; /* SSL new conne/reneg - finished */
816 TSAN_QUALIFIER int sess_accept; /* SSL new accept - started */
817 TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
818 TSAN_QUALIFIER int sess_accept_good; /* SSL accept/reneg - finished */
819 TSAN_QUALIFIER int sess_miss; /* session lookup misses */
820 TSAN_QUALIFIER int sess_timeout; /* reuse attempt on timeouted session */
821 TSAN_QUALIFIER int sess_cache_full; /* session removed due to full cache */
822 TSAN_QUALIFIER int sess_hit; /* session reuse actually done */
823 TSAN_QUALIFIER int sess_cb_hit; /* session-id that was not in
824 * the cache was passed back via
825 * the callback. This indicates
826 * that the application is
827 * supplying session-id's from
828 * other processes - spooky
831 #ifdef TSAN_REQUIRES_LOCKING
832 CRYPTO_RWLOCK *tsan_lock;
835 CRYPTO_REF_COUNT references;
837 /* if defined, these override the X509_verify_cert() calls */
838 int (*app_verify_callback) (X509_STORE_CTX *, void *);
839 void *app_verify_arg;
841 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
842 * ('app_verify_callback' was called with just one argument)
845 /* Default password callback. */
846 pem_password_cb *default_passwd_callback;
848 /* Default password callback user data. */
849 void *default_passwd_callback_userdata;
851 /* get client cert callback */
852 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
854 /* cookie generate callback */
855 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
856 unsigned int *cookie_len);
858 /* verify cookie callback */
859 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
860 unsigned int cookie_len);
862 /* TLS1.3 app-controlled cookie generate callback */
863 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
866 /* TLS1.3 verify app-controlled cookie callback */
867 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
870 CRYPTO_EX_DATA ex_data;
872 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
873 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3-sha1' */
875 STACK_OF(X509) *extra_certs;
876 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
878 /* Default values used when no per-SSL value is defined follow */
880 /* used if SSL's info_callback is NULL */
881 void (*info_callback) (const SSL *ssl, int type, int val);
884 * What we put in certificate_authorities extension for TLS 1.3
885 * (ClientHello and CertificateRequest) or just client cert requests for
886 * earlier versions. If client_ca_names is populated then it is only used
887 * for client cert requests, and in preference to ca_names.
889 STACK_OF(X509_NAME) *ca_names;
890 STACK_OF(X509_NAME) *client_ca_names;
893 * Default values to use in SSL structures follow (these are copied by
899 int min_proto_version;
900 int max_proto_version;
901 size_t max_cert_list;
903 struct cert_st /* CERT */ *cert;
906 /* callback that allows applications to peek at protocol messages */
907 void (*msg_callback) (int write_p, int version, int content_type,
908 const void *buf, size_t len, SSL *ssl, void *arg);
909 void *msg_callback_arg;
911 uint32_t verify_mode;
912 size_t sid_ctx_length;
913 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
914 /* called 'verify_callback' in the SSL */
915 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
917 /* Default generate session ID callback. */
918 GEN_SESSION_CB generate_session_id;
920 X509_VERIFY_PARAM *param;
924 # ifndef OPENSSL_NO_CT
925 CTLOG_STORE *ctlog_store; /* CT Log Store */
927 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
928 * If they are not, the connection should be aborted.
930 ssl_ct_validation_cb ct_validation_callback;
931 void *ct_validation_callback_arg;
935 * If we're using more than one pipeline how should we divide the data
936 * up between the pipes?
938 size_t split_send_fragment;
940 * Maximum amount of data to send in one fragment. actual record size can
941 * be more than this due to padding and MAC overheads.
943 size_t max_send_fragment;
945 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
946 size_t max_pipelines;
948 /* The default read buffer length to use (0 means not set) */
949 size_t default_read_buf_len;
951 # ifndef OPENSSL_NO_ENGINE
953 * Engine to pass requests for client certs to
955 ENGINE *client_cert_engine;
958 /* ClientHello callback. Mostly for extensions, but not entirely. */
959 SSL_client_hello_cb_fn client_hello_cb;
960 void *client_hello_cb_arg;
962 /* TLS extensions. */
964 /* TLS extensions servername callback */
965 int (*servername_cb) (SSL *, int *, void *);
966 void *servername_arg;
967 /* RFC 4507 session ticket keys */
968 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
969 SSL_CTX_EXT_SECURE *secure;
970 # ifndef OPENSSL_NO_DEPRECATED_3_0
971 /* Callback to support customisation of ticket key setting */
972 int (*ticket_key_cb) (SSL *ssl,
973 unsigned char *name, unsigned char *iv,
974 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
976 int (*ticket_key_evp_cb) (SSL *ssl,
977 unsigned char *name, unsigned char *iv,
978 EVP_CIPHER_CTX *ectx, EVP_MAC_CTX *hctx,
981 /* certificate status request info */
982 /* Callback for status request */
983 int (*status_cb) (SSL *ssl, void *arg);
985 /* ext status type used for CSR extension (OCSP Stapling) */
987 /* RFC 4366 Maximum Fragment Length Negotiation */
988 uint8_t max_fragment_len_mode;
990 /* EC extension values inherited by SSL structure */
991 size_t ecpointformats_len;
992 unsigned char *ecpointformats;
994 size_t supportedgroups_len;
995 uint16_t *supportedgroups;
997 uint16_t *supported_groups_default;
998 size_t supported_groups_default_len;
1000 * ALPN information (we are in the process of transitioning from NPN to
1005 * For a server, this contains a callback function that allows the
1006 * server to select the protocol for the connection.
1007 * out: on successful return, this must point to the raw protocol
1008 * name (without the length prefix).
1009 * outlen: on successful return, this contains the length of |*out|.
1010 * in: points to the client's list of supported protocols in
1012 * inlen: the length of |in|.
1014 int (*alpn_select_cb) (SSL *s,
1015 const unsigned char **out,
1016 unsigned char *outlen,
1017 const unsigned char *in,
1018 unsigned int inlen, void *arg);
1019 void *alpn_select_cb_arg;
1022 * For a client, this contains the list of supported protocols in wire
1025 unsigned char *alpn;
1028 # ifndef OPENSSL_NO_NEXTPROTONEG
1029 /* Next protocol negotiation information */
1032 * For a server, this contains a callback function by which the set of
1033 * advertised protocols can be provided.
1035 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
1036 void *npn_advertised_cb_arg;
1038 * For a client, this contains a callback function that selects the next
1039 * protocol from the list provided by the server.
1041 SSL_CTX_npn_select_cb_func npn_select_cb;
1042 void *npn_select_cb_arg;
1045 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1048 # ifndef OPENSSL_NO_PSK
1049 SSL_psk_client_cb_func psk_client_callback;
1050 SSL_psk_server_cb_func psk_server_callback;
1052 SSL_psk_find_session_cb_func psk_find_session_cb;
1053 SSL_psk_use_session_cb_func psk_use_session_cb;
1055 # ifndef OPENSSL_NO_SRP
1056 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1059 /* Shared DANE context */
1060 struct dane_ctx_st dane;
1062 # ifndef OPENSSL_NO_SRTP
1063 /* SRTP profiles we are willing to do from RFC 5764 */
1064 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1067 * Callback for disabling session caching and ticket support on a session
1068 * basis, depending on the chosen cipher.
1070 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1072 CRYPTO_RWLOCK *lock;
1075 * Callback for logging key material for use with debugging tools like
1076 * Wireshark. The callback should log `line` followed by a newline.
1078 SSL_CTX_keylog_cb_func keylog_callback;
1081 * The maximum number of bytes advertised in session tickets that can be
1082 * sent as early data.
1084 uint32_t max_early_data;
1087 * The maximum number of bytes of early data that a server will tolerate
1088 * (which should be at least as much as max_early_data).
1090 uint32_t recv_max_early_data;
1092 /* TLS1.3 padding callback */
1093 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1094 void *record_padding_arg;
1095 size_t block_padding;
1097 /* Session ticket appdata */
1098 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1099 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1100 void *ticket_cb_data;
1102 /* The number of TLS1.3 tickets to automatically send */
1105 /* Callback to determine if early_data is acceptable or not */
1106 SSL_allow_early_data_cb_fn allow_early_data_cb;
1107 void *allow_early_data_cb_data;
1109 /* Do we advertise Post-handshake auth support? */
1112 /* Callback for SSL async handling */
1113 SSL_async_callback_fn async_cb;
1118 int ssl_mac_pkey_id[SSL_MD_NUM_IDX];
1119 const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
1120 const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX];
1121 size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
1123 /* Cache of all sigalgs we know and whether they are available or not */
1124 struct sigalg_lookup_st *sigalg_lookup_cache;
1126 TLS_GROUP_INFO *group_list;
1127 size_t group_list_len;
1128 size_t group_list_max_len;
1130 /* masks of disabled algorithms */
1131 uint32_t disabled_enc_mask;
1132 uint32_t disabled_mac_mask;
1133 uint32_t disabled_mkey_mask;
1134 uint32_t disabled_auth_mask;
1136 #ifndef OPENSSL_NO_COMP_ALG
1137 /* certificate compression preferences */
1138 int cert_comp_prefs[TLSEXT_comp_cert_limit];
1142 typedef struct cert_pkey_st CERT_PKEY;
1144 #define SSL_TYPE_SSL_CONNECTION 0
1145 #define SSL_TYPE_QUIC_CONNECTION 1
1146 #define SSL_TYPE_QUIC_STREAM 2
1151 const SSL_METHOD *defltmeth;
1152 const SSL_METHOD *method;
1153 CRYPTO_REF_COUNT references;
1154 CRYPTO_RWLOCK *lock;
1155 /* extra application data */
1156 CRYPTO_EX_DATA ex_data;
1159 struct ssl_connection_st {
1160 /* type identifier and common data */
1163 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1168 * There are 2 BIO's even though they are normally both the same. This
1169 * is so data can be read and written to different handlers
1171 /* used by SSL_read */
1173 /* used by SSL_write */
1175 /* used during session-id reuse to concatenate messages */
1178 * This holds a variable that indicates what we were doing when a 0 or -1
1179 * is returned. This is needed for non-blocking IO so we know what
1180 * request needs re-doing when in SSL_accept or SSL_connect
1183 int (*handshake_func) (SSL *);
1185 * Imagine that here's a boolean member "init" that is switched as soon
1186 * as SSL_set_{accept/connect}_state is called for the first time, so
1187 * that "state" and "handshake_func" are properly initialized. But as
1188 * handshake_func is == 0 until then, we use this test instead of an
1191 /* are we the server side? */
1194 * Generate a new session or reuse an old one.
1195 * NB: For servers, the 'new' session may actually be a previously
1196 * cached session or even the previous session unless
1197 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1200 /* don't send shutdown packets */
1202 /* we have shut things down, 0x01 sent, 0x02 for received */
1206 SSL_EARLY_DATA_STATE early_data_state;
1207 BUF_MEM *init_buf; /* buffer used during init */
1208 void *init_msg; /* pointer to handshake message body, set by
1209 * ssl3_get_message() */
1210 size_t init_num; /* amount read/written */
1211 size_t init_off; /* amount read/written */
1215 unsigned char server_random[SSL3_RANDOM_SIZE];
1216 unsigned char client_random[SSL3_RANDOM_SIZE];
1218 /* used during startup, digest all incoming/outgoing packets */
1219 BIO *handshake_buffer;
1221 * When handshake digest is determined, buffer is hashed and
1222 * freed and MD_CTX for the required digest is stored here.
1224 EVP_MD_CTX *handshake_dgst;
1226 * Set whenever an expected ChangeCipherSpec message is processed.
1227 * Unset when the peer's Finished message is received.
1228 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1230 int change_cipher_spec;
1234 * we allow one fatal and one warning alert to be outstanding, send close
1235 * alert via the warning alert
1238 unsigned char send_alert[2];
1240 * This flag is set when we should renegotiate ASAP, basically when there
1241 * is no more data in the read or write buffers
1244 int total_renegotiations;
1245 int num_renegotiations;
1246 int in_read_app_data;
1248 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1249 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1250 size_t finish_md_len;
1251 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1252 size_t peer_finish_md_len;
1253 size_t message_size;
1255 /* used to hold the new cipher we are going to use */
1256 const SSL_CIPHER *new_cipher;
1257 EVP_PKEY *pkey; /* holds short lived key exchange key */
1258 /* used for certificate requests */
1260 /* Certificate types in certificate request message. */
1263 /* Certificate authorities list peer sent */
1264 STACK_OF(X509_NAME) *peer_ca_names;
1265 size_t key_block_length;
1266 unsigned char *key_block;
1267 const EVP_CIPHER *new_sym_enc;
1268 const EVP_MD *new_hash;
1269 int new_mac_pkey_type;
1270 size_t new_mac_secret_size;
1271 # ifndef OPENSSL_NO_COMP
1272 const SSL_COMP *new_compression;
1274 char *new_compression;
1277 /* Raw values of the cipher list from a client */
1278 unsigned char *ciphers_raw;
1279 size_t ciphers_rawlen;
1280 /* Temporary storage for premaster secret */
1283 # ifndef OPENSSL_NO_PSK
1284 /* Temporary storage for PSK key */
1288 /* Signature algorithm we actually use */
1289 const struct sigalg_lookup_st *sigalg;
1290 /* Pointer to certificate we use */
1293 * signature algorithms peer reports: e.g. supported signature
1294 * algorithms extension for server or as part of a certificate
1295 * request for client.
1296 * Keep track of the algorithms for TLS and X.509 usage separately.
1298 uint16_t *peer_sigalgs;
1299 uint16_t *peer_cert_sigalgs;
1300 /* Size of above arrays */
1301 size_t peer_sigalgslen;
1302 size_t peer_cert_sigalgslen;
1303 /* Sigalg peer actually uses */
1304 const struct sigalg_lookup_st *peer_sigalg;
1306 * Set if corresponding CERT_PKEY can be used with current
1307 * SSL session: e.g. appropriate curve, signature algorithms etc.
1308 * If zero it can't be used at all.
1310 uint32_t valid_flags[SSL_PKEY_NUM];
1312 * For servers the following masks are for the key and auth algorithms
1313 * that are supported by the certs below. For clients they are masks of
1314 * *disabled* algorithms based on the current session.
1319 * The following are used by the client to see if a cipher is allowed or
1320 * not. It contains the minimum and maximum version the client's using
1321 * based on what it knows so far.
1327 /* Connection binding to prevent renegotiation attacks */
1328 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1329 size_t previous_client_finished_len;
1330 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1331 size_t previous_server_finished_len;
1332 int send_connection_binding;
1334 # ifndef OPENSSL_NO_NEXTPROTONEG
1336 * Set if we saw the Next Protocol Negotiation extension from our peer.
1342 * ALPN information (we are in the process of transitioning from NPN to
1347 * In a server these point to the selected ALPN protocol after the
1348 * ClientHello has been processed. In a client these contain the protocol
1349 * that the server selected once the ServerHello has been processed.
1351 unsigned char *alpn_selected;
1352 size_t alpn_selected_len;
1353 /* used by the server to know what options were proposed */
1354 unsigned char *alpn_proposed;
1355 size_t alpn_proposed_len;
1356 /* used by the client to know if it actually sent alpn */
1360 * This is set to true if we believe that this is a version of Safari
1361 * running on OS X 10.6 or newer. We wish to know this because Safari on
1362 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1364 char is_probably_safari;
1367 * Track whether we did a key exchange this handshake or not, so
1368 * SSL_get_negotiated_group() knows whether to fall back to the
1369 * value in the SSL_SESSION.
1372 /* For clients: peer temporary key */
1373 /* The group_id for the key exchange key */
1379 struct dtls1_state_st *d1; /* DTLSv1 variables */
1380 /* callback that allows applications to peek at protocol messages */
1381 void (*msg_callback) (int write_p, int version, int content_type,
1382 const void *buf, size_t len, SSL *ssl, void *arg);
1383 void *msg_callback_arg;
1384 int hit; /* reusing a previous session */
1385 X509_VERIFY_PARAM *param;
1386 /* Per connection DANE state */
1389 STACK_OF(SSL_CIPHER) *peer_ciphers;
1390 STACK_OF(SSL_CIPHER) *cipher_list;
1391 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1392 /* TLSv1.3 specific ciphersuites */
1393 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1395 * These are the ones being used, the ones in SSL_SESSION are the ones to
1396 * be 'copied' into these ones
1400 * The TLS1.3 secrets.
1402 unsigned char early_secret[EVP_MAX_MD_SIZE];
1403 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1404 unsigned char master_secret[EVP_MAX_MD_SIZE];
1405 unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1406 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1407 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1408 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1409 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1410 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1411 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1412 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1413 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1417 /* This is used to hold the server certificate used */
1418 struct cert_st /* CERT */ *cert;
1421 * The hash of all messages prior to the CertificateVerify, and the length
1424 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1425 size_t cert_verify_hash_len;
1427 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1428 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1429 hello_retry_request;
1432 * the session_id_context is used to ensure sessions are only reused in
1433 * the appropriate context
1435 size_t sid_ctx_length;
1436 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1437 /* This can also be in the session once a session is established */
1438 SSL_SESSION *session;
1439 /* TLSv1.3 PSK session */
1440 SSL_SESSION *psksession;
1441 unsigned char *psksession_id;
1442 size_t psksession_id_len;
1443 /* Default generate session ID callback. */
1444 GEN_SESSION_CB generate_session_id;
1446 * The temporary TLSv1.3 session id. This isn't really a session id at all
1447 * but is a random value sent in the legacy session id field.
1449 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1450 size_t tmp_session_id_len;
1453 * 0 don't care about verify failure.
1454 * 1 fail if verify fails
1456 uint32_t verify_mode;
1457 /* fail if callback returns 0 */
1458 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1459 /* optional informational callback */
1460 void (*info_callback) (const SSL *ssl, int type, int val);
1461 /* error bytes to be written */
1465 # ifndef OPENSSL_NO_PSK
1466 SSL_psk_client_cb_func psk_client_callback;
1467 SSL_psk_server_cb_func psk_server_callback;
1469 SSL_psk_find_session_cb_func psk_find_session_cb;
1470 SSL_psk_use_session_cb_func psk_use_session_cb;
1472 /* Verified chain of peer */
1473 STACK_OF(X509) *verified_chain;
1476 * What we put in certificate_authorities extension for TLS 1.3
1477 * (ClientHello and CertificateRequest) or just client cert requests for
1478 * earlier versions. If client_ca_names is populated then it is only used
1479 * for client cert requests, and in preference to ca_names.
1481 STACK_OF(X509_NAME) *ca_names;
1482 STACK_OF(X509_NAME) *client_ca_names;
1483 /* protocol behaviour */
1487 int min_proto_version;
1488 int max_proto_version;
1489 size_t max_cert_list;
1492 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1493 * secret and SSLv3/TLS (<=1.2) rollback check
1497 * If we're using more than one pipeline how should we divide the data
1498 * up between the pipes?
1500 size_t split_send_fragment;
1502 * Maximum amount of data to send in one fragment. actual record size can
1503 * be more than this due to padding and MAC overheads.
1505 size_t max_send_fragment;
1506 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1507 size_t max_pipelines;
1510 /* Built-in extension flags */
1511 uint8_t extflags[TLSEXT_IDX_num_builtins];
1512 /* TLS extension debug callback */
1513 void (*debug_cb)(SSL *s, int client_server, int type,
1514 const unsigned char *data, int len, void *arg);
1517 /* certificate status request info */
1518 /* Status type or -1 if no status type */
1520 /* Raw extension data, if seen */
1521 unsigned char *scts;
1522 /* Length of raw extension data, if seen */
1524 /* Expect OCSP CertificateStatus message */
1525 int status_expected;
1528 /* OCSP status request only */
1529 STACK_OF(OCSP_RESPID) *ids;
1530 X509_EXTENSIONS *exts;
1531 /* OCSP response received or to be sent */
1532 unsigned char *resp;
1536 /* RFC4507 session ticket expected to be received or sent */
1537 int ticket_expected;
1538 /* TLS 1.3 tickets requested by the application. */
1539 int extra_tickets_expected;
1540 size_t ecpointformats_len;
1542 unsigned char *ecpointformats;
1544 size_t peer_ecpointformats_len;
1546 unsigned char *peer_ecpointformats;
1547 size_t supportedgroups_len;
1549 uint16_t *supportedgroups;
1551 size_t peer_supportedgroups_len;
1553 uint16_t *peer_supportedgroups;
1555 /* TLS Session Ticket extension override */
1556 TLS_SESSION_TICKET_EXT *session_ticket;
1557 /* TLS Session Ticket extension callback */
1558 tls_session_ticket_ext_cb_fn session_ticket_cb;
1559 void *session_ticket_cb_arg;
1560 /* TLS pre-shared secret session resumption */
1561 tls_session_secret_cb_fn session_secret_cb;
1562 void *session_secret_cb_arg;
1564 * For a client, this contains the list of supported protocols in wire
1567 unsigned char *alpn;
1570 * Next protocol negotiation. For the client, this is the protocol that
1571 * we sent in NextProtocol and is set when handling ServerHello
1572 * extensions. For a server, this is the client's selected_protocol from
1573 * NextProtocol and is set when handling the NextProtocol message, before
1574 * the Finished message.
1579 /* The available PSK key exchange modes */
1582 /* Set to one if we have negotiated ETM */
1585 /* Are we expecting to receive early data? */
1587 /* Is the session suitable for early data? */
1590 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1591 unsigned char *tls13_cookie;
1592 size_t tls13_cookie_len;
1593 /* Have we received a cookie from the client? */
1597 * Maximum Fragment Length as per RFC 4366.
1598 * If this member contains one of the allowed values (1-4)
1599 * then we should include Maximum Fragment Length Negotiation
1600 * extension in Client Hello.
1601 * Please note that value of this member does not have direct
1602 * effect. The actual (binding) value is stored in SSL_SESSION,
1603 * as this extension is optional on server side.
1605 uint8_t max_fragment_len_mode;
1608 * On the client side the number of ticket identities we sent in the
1609 * ClientHello. On the server side the identity of the ticket we
1614 /* This is the list of algorithms the peer supports that we also support */
1615 int compress_certificate_from_peer[TLSEXT_comp_cert_limit];
1616 /* indicate that we sent the extension, so we'll accept it */
1617 int compress_certificate_sent;
1621 * Parsed form of the ClientHello, kept around across client_hello_cb
1624 CLIENTHELLO_MSG *clienthello;
1627 * no further mod of servername
1628 * 0 : call the servername extension callback.
1629 * 1 : prepare 2, allow last ack just after in server callback.
1630 * 2 : don't call servername callback, no ack in server hello
1632 int servername_done;
1633 # ifndef OPENSSL_NO_CT
1635 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1636 * If they are not, the connection should be aborted.
1638 ssl_ct_validation_cb ct_validation_callback;
1639 /* User-supplied argument that is passed to the ct_validation_callback */
1640 void *ct_validation_callback_arg;
1642 * Consolidated stack of SCTs from all sources.
1643 * Lazily populated by CT_get_peer_scts(SSL*)
1645 STACK_OF(SCT) *scts;
1646 /* Have we attempted to find/parse SCTs yet? */
1649 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1650 # ifndef OPENSSL_NO_SRTP
1652 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1653 /* What's been chosen */
1654 SRTP_PROTECTION_PROFILE *srtp_profile;
1657 * 1 if we are renegotiating.
1658 * 2 if we are a server and are inside a handshake
1659 * (i.e. not just sending a HelloRequest)
1662 /* If sending a KeyUpdate is pending */
1664 /* Post-handshake authentication state */
1665 SSL_PHA_STATE post_handshake_auth;
1667 uint8_t* pha_context;
1668 size_t pha_context_len;
1670 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1672 # ifndef OPENSSL_NO_SRP
1673 /* ctx for SRP authentication */
1677 * Callback for disabling session caching and ticket support on a session
1678 * basis, depending on the chosen cipher.
1680 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1682 /* Record layer data */
1683 RECORD_LAYER rlayer;
1685 /* Default password callback. */
1686 pem_password_cb *default_passwd_callback;
1687 /* Default password callback user data. */
1688 void *default_passwd_callback_userdata;
1689 /* Async Job info */
1691 ASYNC_WAIT_CTX *waitctx;
1695 * The maximum number of bytes advertised in session tickets that can be
1696 * sent as early data.
1698 uint32_t max_early_data;
1700 * The maximum number of bytes of early data that a server will tolerate
1701 * (which should be at least as much as max_early_data).
1703 uint32_t recv_max_early_data;
1706 * The number of bytes of early data received so far. If we accepted early
1707 * data then this is a count of the plaintext bytes. If we rejected it then
1708 * this is a count of the ciphertext bytes.
1710 uint32_t early_data_count;
1712 /* The number of TLS1.3 tickets to automatically send */
1714 /* The number of TLS1.3 tickets actually sent so far */
1715 size_t sent_tickets;
1716 /* The next nonce value to use when we send a ticket on this connection */
1717 uint64_t next_ticket_nonce;
1719 /* Callback to determine if early_data is acceptable or not */
1720 SSL_allow_early_data_cb_fn allow_early_data_cb;
1721 void *allow_early_data_cb_data;
1723 /* Callback for SSL async handling */
1724 SSL_async_callback_fn async_cb;
1728 * Signature algorithms shared by client and server: cached because these
1729 * are used most often.
1731 const struct sigalg_lookup_st **shared_sigalgs;
1732 size_t shared_sigalgslen;
1734 #ifndef OPENSSL_NO_COMP_ALG
1735 /* certificate compression preferences */
1736 int cert_comp_prefs[TLSEXT_comp_cert_limit];
1740 # define SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, c) \
1741 ((ssl) == NULL ? NULL \
1742 : ((ssl)->type == SSL_TYPE_SSL_CONNECTION \
1743 ? (c SSL_CONNECTION *)(ssl) \
1745 # define SSL_CONNECTION_NO_CONST
1746 # define SSL_CONNECTION_FROM_SSL_ONLY(ssl) \
1747 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1748 # define SSL_CONNECTION_FROM_CONST_SSL_ONLY(ssl) \
1749 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1750 # define SSL_CONNECTION_GET_CTX(sc) ((sc)->ssl.ctx)
1751 # define SSL_CONNECTION_GET_SSL(sc) (&(sc)->ssl)
1752 # ifndef OPENSSL_NO_QUIC
1753 # include "quic/quic_local.h"
1754 # define SSL_CONNECTION_FROM_SSL_int(ssl, c) \
1755 ((ssl) == NULL ? NULL \
1756 : ((ssl)->type == SSL_TYPE_SSL_CONNECTION \
1757 ? (c SSL_CONNECTION *)(ssl) \
1758 : ((ssl)->type == SSL_TYPE_QUIC_CONNECTION \
1759 ? (c SSL_CONNECTION *)((c QUIC_CONNECTION *)(ssl))->tls \
1761 # define SSL_CONNECTION_FROM_SSL(ssl) \
1762 SSL_CONNECTION_FROM_SSL_int(ssl, SSL_CONNECTION_NO_CONST)
1763 # define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1764 SSL_CONNECTION_FROM_SSL_int(ssl, const)
1766 # define SSL_CONNECTION_FROM_SSL(ssl) \
1767 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, SSL_CONNECTION_NO_CONST)
1768 # define SSL_CONNECTION_FROM_CONST_SSL(ssl) \
1769 SSL_CONNECTION_FROM_SSL_ONLY_int(ssl, const)
1773 * Structure containing table entry of values associated with the signature
1774 * algorithms (signature scheme) extension
1776 typedef struct sigalg_lookup_st {
1777 /* TLS 1.3 signature scheme name */
1779 /* Raw value used in extension */
1781 /* NID of hash algorithm or NID_undef if no hash */
1783 /* Index of hash algorithm or -1 if no hash algorithm */
1785 /* NID of signature algorithm */
1787 /* Index of signature algorithm */
1789 /* Combined hash and signature NID, if any */
1791 /* Required public key curve (ECDSA only) */
1793 /* Whether this signature algorithm is actually available for use */
1798 * Structure containing table entry of certificate info corresponding to
1802 int nid; /* NID of public key algorithm */
1803 uint32_t amask; /* authmask corresponding to key type */
1806 /* DTLS structures */
1808 # ifndef OPENSSL_NO_SCTP
1809 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1812 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1813 # define DTLS1_MAX_MTU_OVERHEAD 48
1816 * Flag used in message reuse to indicate the buffer contains the record
1817 * header as well as the handshake message header.
1819 # define DTLS1_SKIP_RECORD_HEADER 2
1821 struct dtls1_retransmit_state {
1822 const OSSL_RECORD_METHOD *wrlmethod;
1823 OSSL_RECORD_LAYER *wrl;
1826 struct hm_header_st {
1832 unsigned int is_ccs;
1833 struct dtls1_retransmit_state saved_retransmit_state;
1836 typedef struct hm_fragment_st {
1837 struct hm_header_st msg_header;
1838 unsigned char *fragment;
1839 unsigned char *reassembly;
1842 typedef struct pqueue_st pqueue;
1843 typedef struct pitem_st pitem;
1846 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1851 typedef struct pitem_st *piterator;
1853 pitem *pitem_new(unsigned char *prio64be, void *data);
1854 void pitem_free(pitem *item);
1855 pqueue *pqueue_new(void);
1856 void pqueue_free(pqueue *pq);
1857 pitem *pqueue_insert(pqueue *pq, pitem *item);
1858 pitem *pqueue_peek(pqueue *pq);
1859 pitem *pqueue_pop(pqueue *pq);
1860 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1861 pitem *pqueue_iterator(pqueue *pq);
1862 pitem *pqueue_next(piterator *iter);
1863 size_t pqueue_size(pqueue *pq);
1865 typedef struct dtls1_state_st {
1866 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1868 unsigned int cookie_verified;
1869 /* handshake message numbers */
1870 unsigned short handshake_write_seq;
1871 unsigned short next_handshake_write_seq;
1872 unsigned short handshake_read_seq;
1873 /* Buffered handshake messages */
1874 pqueue *buffered_messages;
1875 /* Buffered (sent) handshake records */
1876 pqueue *sent_messages;
1877 size_t link_mtu; /* max on-the-wire DTLS packet size */
1878 size_t mtu; /* max DTLS packet size */
1879 struct hm_header_st w_msg_hdr;
1880 struct hm_header_st r_msg_hdr;
1881 /* Number of alerts received so far */
1882 unsigned int timeout_num_alerts;
1884 * Indicates when the last handshake msg sent will timeout
1886 OSSL_TIME next_timeout;
1887 /* Timeout duration */
1888 unsigned int timeout_duration_us;
1890 unsigned int retransmitting;
1891 # ifndef OPENSSL_NO_SCTP
1892 int shutdown_received;
1895 DTLS_timer_cb timer_cb;
1900 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1902 # define EXPLICIT_PRIME_CURVE_TYPE 1
1903 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1904 # define NAMED_CURVE_TYPE 3
1906 # ifndef OPENSSL_NO_COMP_ALG
1907 struct ossl_comp_cert_st {
1908 unsigned char *data;
1911 CRYPTO_REF_COUNT references;
1912 CRYPTO_RWLOCK *lock;
1915 typedef struct ossl_comp_cert_st OSSL_COMP_CERT;
1917 void OSSL_COMP_CERT_free(OSSL_COMP_CERT *c);
1918 int OSSL_COMP_CERT_up_ref(OSSL_COMP_CERT *c);
1921 struct cert_pkey_st {
1923 EVP_PKEY *privatekey;
1924 /* Chain for this certificate */
1925 STACK_OF(X509) *chain;
1927 * serverinfo data for this certificate. The data is in TLS Extension
1928 * wire format, specifically it's a series of records like:
1929 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1931 * uint8_t data[length];
1933 unsigned char *serverinfo;
1934 size_t serverinfo_length;
1935 # ifndef OPENSSL_NO_COMP_ALG
1936 /* Compressed certificate data - index 0 is unused */
1937 OSSL_COMP_CERT *comp_cert[TLSEXT_comp_cert_limit];
1941 /* Retrieve Suite B flags */
1942 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1943 /* Uses to check strict mode: suite B modes are always strict */
1944 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1945 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1948 ENDPOINT_CLIENT = 0,
1955 unsigned short ext_type;
1957 /* The context which this extension applies to */
1958 unsigned int context;
1960 * Per-connection flags relating to this extension type: not used if
1961 * part of an SSL_CTX structure.
1964 SSL_custom_ext_add_cb_ex add_cb;
1965 SSL_custom_ext_free_cb_ex free_cb;
1967 SSL_custom_ext_parse_cb_ex parse_cb;
1969 } custom_ext_method;
1971 /* ext_flags values */
1974 * Indicates an extension has been received. Used to check for unsolicited or
1975 * duplicate extensions.
1977 # define SSL_EXT_FLAG_RECEIVED 0x1
1979 * Indicates an extension has been sent: used to enable sending of
1980 * corresponding ServerHello extension.
1982 # define SSL_EXT_FLAG_SENT 0x2
1985 custom_ext_method *meths;
1987 } custom_ext_methods;
1989 typedef struct cert_st {
1990 /* Current active set */
1992 * ALWAYS points to an element of the pkeys array
1993 * Probably it would make more sense to store
1994 * an index, not a pointer.
1999 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
2001 /* Flags related to certificates */
2002 uint32_t cert_flags;
2003 CERT_PKEY pkeys[SSL_PKEY_NUM];
2004 /* Custom certificate types sent in certificate request message. */
2008 * supported signature algorithms. When set on a client this is sent in
2009 * the client hello as the supported signature algorithms extension. For
2010 * servers it represents the signature algorithms we are willing to use.
2012 uint16_t *conf_sigalgs;
2013 /* Size of above array */
2014 size_t conf_sigalgslen;
2016 * Client authentication signature algorithms, if not set then uses
2017 * conf_sigalgs. On servers these will be the signature algorithms sent
2018 * to the client in a certificate request for TLS 1.2. On a client this
2019 * represents the signature algorithms we are willing to use for client
2022 uint16_t *client_sigalgs;
2023 /* Size of above array */
2024 size_t client_sigalgslen;
2026 * Certificate setup callback: if set is called whenever a certificate
2027 * may be required (client or server). the callback can then examine any
2028 * appropriate parameters and setup any certificates required. This
2029 * allows advanced applications to select certificates on the fly: for
2030 * example based on supported signature algorithms or curves.
2032 int (*cert_cb) (SSL *ssl, void *arg);
2035 * Optional X509_STORE for chain building or certificate validation If
2036 * NULL the parent SSL_CTX store is used instead.
2038 X509_STORE *chain_store;
2039 X509_STORE *verify_store;
2040 /* Custom extensions */
2041 custom_ext_methods custext;
2042 /* Security callback */
2043 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
2044 void *other, void *ex);
2045 /* Security level */
2048 # ifndef OPENSSL_NO_PSK
2049 /* If not NULL psk identity hint to use for servers */
2050 char *psk_identity_hint;
2052 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
2053 CRYPTO_RWLOCK *lock;
2056 # define FP_ICC (int (*)(const void *,const void *))
2059 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
2060 * of a mess of functions, but hell, think of it as an opaque structure :-)
2062 typedef struct ssl3_enc_method {
2063 int (*setup_key_block) (SSL_CONNECTION *);
2064 int (*generate_master_secret) (SSL_CONNECTION *, unsigned char *,
2065 unsigned char *, size_t, size_t *);
2066 int (*change_cipher_state) (SSL_CONNECTION *, int);
2067 size_t (*final_finish_mac) (SSL_CONNECTION *, const char *, size_t,
2069 const char *client_finished_label;
2070 size_t client_finished_label_len;
2071 const char *server_finished_label;
2072 size_t server_finished_label_len;
2073 int (*alert_value) (int);
2074 int (*export_keying_material) (SSL_CONNECTION *, unsigned char *, size_t,
2075 const char *, size_t,
2076 const unsigned char *, size_t,
2078 /* Various flags indicating protocol version requirements */
2080 /* Set the handshake header */
2081 int (*set_handshake_header) (SSL_CONNECTION *s, WPACKET *pkt, int type);
2082 /* Close construction of the handshake message */
2083 int (*close_construct_packet) (SSL_CONNECTION *s, WPACKET *pkt, int htype);
2084 /* Write out handshake message */
2085 int (*do_write) (SSL_CONNECTION *s);
2088 # define ssl_set_handshake_header(s, pkt, htype) \
2089 SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2090 # define ssl_close_construct_packet(s, pkt, htype) \
2091 SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2092 # define ssl_do_write(s) SSL_CONNECTION_GET_SSL(s)->method->ssl3_enc->do_write(s)
2094 /* Values for enc_flags */
2096 /* Uses explicit IV for CBC mode */
2097 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
2098 /* Uses signature algorithms extension */
2099 # define SSL_ENC_FLAG_SIGALGS 0x2
2100 /* Uses SHA256 default PRF */
2101 # define SSL_ENC_FLAG_SHA256_PRF 0x4
2103 # define SSL_ENC_FLAG_DTLS 0x8
2105 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2106 * apply to others in future.
2108 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2110 # ifndef OPENSSL_NO_COMP
2111 /* Used for holding the relevant compression methods loaded into SSL_CTX */
2112 typedef struct ssl3_comp_st {
2113 int comp_id; /* The identifier byte for this compression
2115 char *name; /* Text name used for the compression type */
2116 COMP_METHOD *method; /* The method :-) */
2120 typedef enum downgrade_en {
2127 * Dummy status type for the status_type extension. Indicates no status type
2130 #define TLSEXT_STATUSTYPE_nothing -1
2132 /* Sigalgs values */
2133 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2134 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2135 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2136 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2137 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2138 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2139 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2140 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2141 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2142 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2143 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2144 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2145 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2146 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2147 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2148 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2149 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2150 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2151 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2152 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2153 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2154 #define TLSEXT_SIGALG_gostr34102012_256_intrinsic 0x0840
2155 #define TLSEXT_SIGALG_gostr34102012_512_intrinsic 0x0841
2156 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2157 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2158 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2160 #define TLSEXT_SIGALG_ed25519 0x0807
2161 #define TLSEXT_SIGALG_ed448 0x0808
2162 #define TLSEXT_SIGALG_ecdsa_brainpoolP256r1_sha256 0x081a
2163 #define TLSEXT_SIGALG_ecdsa_brainpoolP384r1_sha384 0x081b
2164 #define TLSEXT_SIGALG_ecdsa_brainpoolP512r1_sha512 0x081c
2166 /* Known PSK key exchange modes */
2167 #define TLSEXT_KEX_MODE_KE 0x00
2168 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2171 * Internal representations of key exchange modes
2173 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2174 #define TLSEXT_KEX_MODE_FLAG_KE 1
2175 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2177 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2178 s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2180 /* A dummy signature value not valid for TLSv1.2 signature algs */
2181 #define TLSEXT_signature_rsa_pss 0x0101
2183 /* TLSv1.3 downgrade protection sentinel values */
2184 extern const unsigned char tls11downgrade[8];
2185 extern const unsigned char tls12downgrade[8];
2187 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2189 __owur const SSL_METHOD *ssl_bad_method(int ver);
2190 __owur const SSL_METHOD *sslv3_method(void);
2191 __owur const SSL_METHOD *sslv3_server_method(void);
2192 __owur const SSL_METHOD *sslv3_client_method(void);
2193 __owur const SSL_METHOD *tlsv1_method(void);
2194 __owur const SSL_METHOD *tlsv1_server_method(void);
2195 __owur const SSL_METHOD *tlsv1_client_method(void);
2196 __owur const SSL_METHOD *tlsv1_1_method(void);
2197 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2198 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2199 __owur const SSL_METHOD *tlsv1_2_method(void);
2200 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2201 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2202 __owur const SSL_METHOD *tlsv1_3_method(void);
2203 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2204 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2205 __owur const SSL_METHOD *dtlsv1_method(void);
2206 __owur const SSL_METHOD *dtlsv1_server_method(void);
2207 __owur const SSL_METHOD *dtlsv1_client_method(void);
2208 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2209 __owur const SSL_METHOD *dtlsv1_2_method(void);
2210 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2211 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2213 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2214 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2215 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2216 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2217 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2218 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2219 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2222 * Flags for SSL methods
2224 # define SSL_METHOD_NO_FIPS (1U<<0)
2225 # define SSL_METHOD_NO_SUITEB (1U<<1)
2227 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2228 s_connect, enc_data) \
2229 const SSL_METHOD *func_name(void) \
2231 static const SSL_METHOD func_name##_data= { \
2235 ossl_ssl_connection_new, \
2236 ossl_ssl_connection_free, \
2237 ossl_ssl_connection_reset, \
2248 ssl3_renegotiate_check, \
2251 ssl3_dispatch_alert, \
2254 ssl3_get_cipher_by_char, \
2255 ssl3_put_cipher_by_char, \
2259 tls1_default_timeout, \
2261 ssl_undefined_void_function, \
2262 ssl3_callback_ctrl, \
2263 ssl3_ctx_callback_ctrl, \
2265 return &func_name##_data; \
2268 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2269 const SSL_METHOD *func_name(void) \
2271 static const SSL_METHOD func_name##_data= { \
2273 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2275 ossl_ssl_connection_new, \
2276 ossl_ssl_connection_free, \
2277 ossl_ssl_connection_reset, \
2288 ssl3_renegotiate_check, \
2291 ssl3_dispatch_alert, \
2294 ssl3_get_cipher_by_char, \
2295 ssl3_put_cipher_by_char, \
2299 ssl3_default_timeout, \
2301 ssl_undefined_void_function, \
2302 ssl3_callback_ctrl, \
2303 ssl3_ctx_callback_ctrl, \
2305 return &func_name##_data; \
2308 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2309 s_connect, enc_data) \
2310 const SSL_METHOD *func_name(void) \
2312 static const SSL_METHOD func_name##_data= { \
2316 ossl_ssl_connection_new, \
2317 ossl_ssl_connection_free, \
2318 ossl_ssl_connection_reset, \
2329 ssl3_renegotiate_check, \
2331 dtls1_write_app_data_bytes, \
2332 dtls1_dispatch_alert, \
2335 ssl3_get_cipher_by_char, \
2336 ssl3_put_cipher_by_char, \
2340 dtls1_default_timeout, \
2342 ssl_undefined_void_function, \
2343 ssl3_callback_ctrl, \
2344 ssl3_ctx_callback_ctrl, \
2346 return &func_name##_data; \
2349 struct openssl_ssl_test_functions {
2350 int (*p_ssl_init_wbio_buffer) (SSL_CONNECTION *s);
2353 const char *ssl_protocol_to_string(int version);
2355 /* Returns true if certificate and private key for 'idx' are present */
2356 static ossl_inline int ssl_has_cert(const SSL_CONNECTION *s, int idx)
2358 if (idx < 0 || idx >= SSL_PKEY_NUM)
2360 return s->cert->pkeys[idx].x509 != NULL
2361 && s->cert->pkeys[idx].privatekey != NULL;
2364 static ossl_inline void tls1_get_peer_groups(SSL_CONNECTION *s,
2365 const uint16_t **pgroups,
2368 *pgroups = s->ext.peer_supportedgroups;
2369 *pgroupslen = s->ext.peer_supportedgroups_len;
2372 # ifndef OPENSSL_UNIT_TEST
2374 __owur int ossl_ssl_init(SSL *ssl, SSL_CTX *ctx, const SSL_METHOD *method,
2376 __owur SSL *ossl_ssl_connection_new_int(SSL_CTX *ctx, const SSL_METHOD *method);
2377 __owur SSL *ossl_ssl_connection_new(SSL_CTX *ctx);
2378 void ossl_ssl_connection_free(SSL *ssl);
2379 __owur int ossl_ssl_connection_reset(SSL *ssl);
2381 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2382 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2383 int ssl_clear_bad_session(SSL_CONNECTION *s);
2384 __owur CERT *ssl_cert_new(void);
2385 __owur CERT *ssl_cert_dup(CERT *cert);
2386 void ssl_cert_clear_certs(CERT *c);
2387 void ssl_cert_free(CERT *c);
2388 __owur int ssl_generate_session_id(SSL_CONNECTION *s, SSL_SESSION *ss);
2389 __owur int ssl_get_new_session(SSL_CONNECTION *s, int session);
2390 __owur SSL_SESSION *lookup_sess_in_cache(SSL_CONNECTION *s,
2391 const unsigned char *sess_id,
2392 size_t sess_id_len);
2393 __owur int ssl_get_prev_session(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello);
2394 __owur SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket);
2395 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2396 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2397 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2398 const SSL_CIPHER *const *bp);
2399 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(SSL_CTX *ctx,
2400 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2401 STACK_OF(SSL_CIPHER) **cipher_list,
2402 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2403 const char *rule_str,
2405 __owur int ssl_cache_cipherlist(SSL_CONNECTION *s, PACKET *cipher_suites,
2407 __owur int ossl_bytes_to_cipher_list(SSL_CONNECTION *s, PACKET *cipher_suites,
2408 STACK_OF(SSL_CIPHER) **skp,
2409 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2411 void ssl_update_cache(SSL_CONNECTION *s, int mode);
2412 __owur int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
2413 const EVP_CIPHER **enc);
2414 __owur int ssl_cipher_get_evp(SSL_CTX *ctxc, const SSL_SESSION *s,
2415 const EVP_CIPHER **enc, const EVP_MD **md,
2416 int *mac_pkey_type, size_t *mac_secret_size,
2417 SSL_COMP **comp, int use_etm);
2418 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2419 size_t *int_overhead, size_t *blocksize,
2420 size_t *ext_overhead);
2421 __owur int ssl_cert_is_disabled(SSL_CTX *ctx, size_t idx);
2422 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL_CONNECTION *ssl,
2423 const unsigned char *ptr,
2425 __owur int ssl_cert_set0_chain(SSL_CONNECTION *s, SSL_CTX *ctx,
2426 STACK_OF(X509) *chain);
2427 __owur int ssl_cert_set1_chain(SSL_CONNECTION *s, SSL_CTX *ctx,
2428 STACK_OF(X509) *chain);
2429 __owur int ssl_cert_add0_chain_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x);
2430 __owur int ssl_cert_add1_chain_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x);
2431 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2432 __owur int ssl_cert_set_current(CERT *c, long arg);
2433 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2435 __owur int ssl_verify_cert_chain(SSL_CONNECTION *s, STACK_OF(X509) *sk);
2436 __owur int ssl_build_cert_chain(SSL_CONNECTION *s, SSL_CTX *ctx, int flags);
2437 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2439 __owur int ssl_cert_get_cert_store(CERT *c, X509_STORE **pstore, int chain);
2441 __owur int ssl_security(const SSL_CONNECTION *s, int op, int bits, int nid,
2443 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2445 int ssl_get_security_level_bits(const SSL *s, const SSL_CTX *ctx, int *levelp);
2447 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx);
2448 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2450 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2452 int ssl_undefined_function(SSL *s);
2453 __owur int ssl_undefined_void_function(void);
2454 __owur int ssl_undefined_const_function(const SSL *s);
2455 __owur int ssl_get_server_cert_serverinfo(SSL_CONNECTION *s,
2456 const unsigned char **serverinfo,
2457 size_t *serverinfo_length);
2458 void ssl_set_masks(SSL_CONNECTION *s);
2459 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL_CONNECTION *sc);
2460 __owur int ssl_x509err2alert(int type);
2461 void ssl_sort_cipher_list(void);
2462 int ssl_load_ciphers(SSL_CTX *ctx);
2463 __owur int ssl_setup_sig_algs(SSL_CTX *ctx);
2464 int ssl_load_groups(SSL_CTX *ctx);
2465 __owur int ssl_fill_hello_random(SSL_CONNECTION *s, int server,
2466 unsigned char *field, size_t len,
2468 __owur int ssl_generate_master_secret(SSL_CONNECTION *s, unsigned char *pms,
2469 size_t pmslen, int free_pms);
2470 __owur EVP_PKEY *ssl_generate_pkey(SSL_CONNECTION *s, EVP_PKEY *pm);
2471 __owur int ssl_gensecret(SSL_CONNECTION *s, unsigned char *pms, size_t pmslen);
2472 __owur int ssl_derive(SSL_CONNECTION *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2474 __owur int ssl_decapsulate(SSL_CONNECTION *s, EVP_PKEY *privkey,
2475 const unsigned char *ct, size_t ctlen,
2477 __owur int ssl_encapsulate(SSL_CONNECTION *s, EVP_PKEY *pubkey,
2478 unsigned char **ctp, size_t *ctlenp,
2480 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2481 __owur int ssl_set_tmp_ecdh_groups(uint16_t **pext, size_t *pextlen,
2483 __owur unsigned int ssl_get_max_send_fragment(const SSL_CONNECTION *sc);
2484 __owur unsigned int ssl_get_split_send_fragment(const SSL_CONNECTION *sc);
2486 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2487 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2488 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2489 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2491 int ssl3_init_finished_mac(SSL_CONNECTION *s);
2492 __owur int ssl3_setup_key_block(SSL_CONNECTION *s);
2493 __owur int ssl3_change_cipher_state(SSL_CONNECTION *s, int which);
2494 void ssl3_cleanup_key_block(SSL_CONNECTION *s);
2495 __owur int ssl3_do_write(SSL_CONNECTION *s, int type);
2496 int ssl3_send_alert(SSL_CONNECTION *s, int level, int desc);
2497 __owur int ssl3_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2498 unsigned char *p, size_t len,
2499 size_t *secret_size);
2500 __owur int ssl3_get_req_cert_type(SSL_CONNECTION *s, WPACKET *pkt);
2501 __owur int ssl3_num_ciphers(void);
2502 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2503 int ssl3_renegotiate(SSL *ssl);
2504 int ssl3_renegotiate_check(SSL *ssl, int initok);
2505 void ssl3_digest_master_key_set_params(const SSL_SESSION *session,
2506 OSSL_PARAM params[]);
2507 __owur int ssl3_dispatch_alert(SSL *s);
2508 __owur size_t ssl3_final_finish_mac(SSL_CONNECTION *s, const char *sender,
2509 size_t slen, unsigned char *p);
2510 __owur int ssl3_finish_mac(SSL_CONNECTION *s, const unsigned char *buf,
2512 void ssl3_free_digest_list(SSL_CONNECTION *s);
2513 __owur unsigned long ssl3_output_cert_chain(SSL_CONNECTION *s, WPACKET *pkt,
2514 CERT_PKEY *cpk, int for_comp);
2515 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL_CONNECTION *s,
2516 STACK_OF(SSL_CIPHER) *clnt,
2517 STACK_OF(SSL_CIPHER) *srvr);
2518 __owur int ssl3_digest_cached_records(SSL_CONNECTION *s, int keep);
2519 __owur int ssl3_new(SSL *s);
2520 void ssl3_free(SSL *s);
2521 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2522 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2523 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2524 __owur int ssl3_shutdown(SSL *s);
2525 int ssl3_clear(SSL *s);
2526 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2527 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2528 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2529 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2531 __owur int ssl3_do_change_cipher_spec(SSL_CONNECTION *s);
2532 __owur OSSL_TIME ssl3_default_timeout(void);
2534 __owur int ssl3_set_handshake_header(SSL_CONNECTION *s, WPACKET *pkt,
2536 __owur int tls_close_construct_packet(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2537 __owur int tls_setup_handshake(SSL_CONNECTION *s);
2538 __owur int dtls1_set_handshake_header(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2539 __owur int dtls1_close_construct_packet(SSL_CONNECTION *s, WPACKET *pkt, int htype);
2540 __owur int ssl3_handshake_write(SSL_CONNECTION *s);
2542 __owur int ssl_allow_compression(SSL_CONNECTION *s);
2544 __owur int ssl_version_supported(const SSL_CONNECTION *s, int version,
2545 const SSL_METHOD **meth);
2547 __owur int ssl_set_client_hello_version(SSL_CONNECTION *s);
2548 __owur int ssl_check_version_downgrade(SSL_CONNECTION *s);
2549 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2550 __owur int ssl_choose_server_version(SSL_CONNECTION *s, CLIENTHELLO_MSG *hello,
2552 __owur int ssl_choose_client_version(SSL_CONNECTION *s, int version,
2553 RAW_EXTENSION *extensions);
2554 __owur int ssl_get_min_max_version(const SSL_CONNECTION *s, int *min_version,
2555 int *max_version, int *real_max);
2557 __owur OSSL_TIME tls1_default_timeout(void);
2558 __owur int dtls1_do_write(SSL_CONNECTION *s, int type);
2559 void dtls1_set_message_header(SSL_CONNECTION *s,
2562 size_t frag_off, size_t frag_len);
2564 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2567 __owur int dtls1_read_failed(SSL_CONNECTION *s, int code);
2568 __owur int dtls1_buffer_message(SSL_CONNECTION *s, int ccs);
2569 __owur int dtls1_retransmit_message(SSL_CONNECTION *s, unsigned short seq,
2571 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2572 int dtls1_retransmit_buffered_messages(SSL_CONNECTION *s);
2573 void dtls1_clear_received_buffer(SSL_CONNECTION *s);
2574 void dtls1_clear_sent_buffer(SSL_CONNECTION *s);
2575 void dtls1_get_message_header(unsigned char *data,
2576 struct hm_header_st *msg_hdr);
2577 __owur OSSL_TIME dtls1_default_timeout(void);
2578 __owur OSSL_TIME *dtls1_get_timeout(SSL_CONNECTION *s, OSSL_TIME *timeleft);
2579 __owur int dtls1_check_timeout_num(SSL_CONNECTION *s);
2580 __owur int dtls1_handle_timeout(SSL_CONNECTION *s);
2581 void dtls1_start_timer(SSL_CONNECTION *s);
2582 void dtls1_stop_timer(SSL_CONNECTION *s);
2583 __owur int dtls1_is_timer_expired(SSL_CONNECTION *s);
2584 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2586 __owur size_t dtls1_min_mtu(SSL_CONNECTION *s);
2587 void dtls1_hm_fragment_free(hm_fragment *frag);
2588 __owur int dtls1_query_mtu(SSL_CONNECTION *s);
2590 __owur int tls1_new(SSL *s);
2591 void tls1_free(SSL *s);
2592 int tls1_clear(SSL *s);
2594 __owur int dtls1_new(SSL *s);
2595 void dtls1_free(SSL *s);
2596 int dtls1_clear(SSL *s);
2597 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2598 __owur int dtls1_shutdown(SSL *s);
2600 __owur int dtls1_dispatch_alert(SSL *s);
2602 __owur int ssl_init_wbio_buffer(SSL_CONNECTION *s);
2603 int ssl_free_wbio_buffer(SSL_CONNECTION *s);
2605 __owur int tls1_change_cipher_state(SSL_CONNECTION *s, int which);
2606 __owur int tls1_setup_key_block(SSL_CONNECTION *s);
2607 __owur size_t tls1_final_finish_mac(SSL_CONNECTION *s, const char *str,
2608 size_t slen, unsigned char *p);
2609 __owur int tls1_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2610 unsigned char *p, size_t len,
2611 size_t *secret_size);
2612 __owur int tls13_setup_key_block(SSL_CONNECTION *s);
2613 __owur size_t tls13_final_finish_mac(SSL_CONNECTION *s, const char *str, size_t slen,
2615 __owur int tls13_change_cipher_state(SSL_CONNECTION *s, int which);
2616 __owur int tls13_update_key(SSL_CONNECTION *s, int send);
2617 __owur int tls13_hkdf_expand(SSL_CONNECTION *s,
2619 const unsigned char *secret,
2620 const unsigned char *label, size_t labellen,
2621 const unsigned char *data, size_t datalen,
2622 unsigned char *out, size_t outlen, int fatal);
2623 __owur int tls13_hkdf_expand_ex(OSSL_LIB_CTX *libctx, const char *propq,
2625 const unsigned char *secret,
2626 const unsigned char *label, size_t labellen,
2627 const unsigned char *data, size_t datalen,
2628 unsigned char *out, size_t outlen,
2630 __owur int tls13_derive_key(SSL_CONNECTION *s, const EVP_MD *md,
2631 const unsigned char *secret, unsigned char *key,
2633 __owur int tls13_derive_iv(SSL_CONNECTION *s, const EVP_MD *md,
2634 const unsigned char *secret, unsigned char *iv,
2636 __owur int tls13_derive_finishedkey(SSL_CONNECTION *s, const EVP_MD *md,
2637 const unsigned char *secret,
2638 unsigned char *fin, size_t finlen);
2639 int tls13_generate_secret(SSL_CONNECTION *s, const EVP_MD *md,
2640 const unsigned char *prevsecret,
2641 const unsigned char *insecret,
2643 unsigned char *outsecret);
2644 __owur int tls13_generate_handshake_secret(SSL_CONNECTION *s,
2645 const unsigned char *insecret,
2646 size_t insecretlen);
2647 __owur int tls13_generate_master_secret(SSL_CONNECTION *s, unsigned char *out,
2648 unsigned char *prev, size_t prevlen,
2649 size_t *secret_size);
2650 __owur int tls1_export_keying_material(SSL_CONNECTION *s,
2651 unsigned char *out, size_t olen,
2652 const char *label, size_t llen,
2653 const unsigned char *p, size_t plen,
2655 __owur int tls13_export_keying_material(SSL_CONNECTION *s,
2656 unsigned char *out, size_t olen,
2657 const char *label, size_t llen,
2658 const unsigned char *context,
2659 size_t contextlen, int use_context);
2660 __owur int tls13_export_keying_material_early(SSL_CONNECTION *s,
2661 unsigned char *out, size_t olen,
2662 const char *label, size_t llen,
2663 const unsigned char *context,
2665 __owur int tls1_alert_code(int code);
2666 __owur int tls13_alert_code(int code);
2667 __owur int ssl3_alert_code(int code);
2669 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL_CONNECTION *s);
2671 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2673 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(SSL_CTX *ctx, uint16_t curve_id);
2674 __owur int tls1_group_id2nid(uint16_t group_id, int include_unknown);
2675 __owur uint16_t tls1_nid2group_id(int nid);
2676 __owur int tls1_check_group_id(SSL_CONNECTION *s, uint16_t group_id,
2677 int check_own_curves);
2678 __owur uint16_t tls1_shared_group(SSL_CONNECTION *s, int nmatch);
2679 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2680 int *curves, size_t ncurves);
2681 __owur int tls1_set_groups_list(SSL_CTX *ctx, uint16_t **pext, size_t *pextlen,
2683 __owur EVP_PKEY *ssl_generate_pkey_group(SSL_CONNECTION *s, uint16_t id);
2684 __owur int tls_valid_group(SSL_CONNECTION *s, uint16_t group_id, int minversion,
2685 int maxversion, int isec, int *okfortls13);
2686 __owur EVP_PKEY *ssl_generate_param_group(SSL_CONNECTION *s, uint16_t id);
2687 void tls1_get_formatlist(SSL_CONNECTION *s, const unsigned char **pformats,
2688 size_t *num_formats);
2689 __owur int tls1_check_ec_tmp_key(SSL_CONNECTION *s, unsigned long id);
2691 __owur int tls_group_allowed(SSL_CONNECTION *s, uint16_t curve, int op);
2692 void tls1_get_supported_groups(SSL_CONNECTION *s, const uint16_t **pgroups,
2693 size_t *pgroupslen);
2695 __owur int tls1_set_server_sigalgs(SSL_CONNECTION *s);
2697 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL_CONNECTION *s,
2698 CLIENTHELLO_MSG *hello,
2700 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL_CONNECTION *s,
2701 const unsigned char *etick,
2703 const unsigned char *sess_id,
2704 size_t sesslen, SSL_SESSION **psess);
2706 __owur int tls_use_ticket(SSL_CONNECTION *s);
2708 void ssl_set_sig_mask(uint32_t *pmask_a, SSL_CONNECTION *s, int op);
2710 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2711 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2713 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2715 int tls1_check_chain(SSL_CONNECTION *s, X509 *x, EVP_PKEY *pk,
2716 STACK_OF(X509) *chain, int idx);
2717 void tls1_set_cert_validity(SSL_CONNECTION *s);
2719 # ifndef OPENSSL_NO_CT
2720 __owur int ssl_validate_ct(SSL_CONNECTION *s);
2723 __owur EVP_PKEY *ssl_get_auto_dh(SSL_CONNECTION *s);
2725 __owur int ssl_security_cert(SSL_CONNECTION *s, SSL_CTX *ctx, X509 *x, int vfy,
2727 __owur int ssl_security_cert_chain(SSL_CONNECTION *s, STACK_OF(X509) *sk,
2730 int tls_choose_sigalg(SSL_CONNECTION *s, int fatalerrs);
2732 __owur long ssl_get_algorithm2(SSL_CONNECTION *s);
2733 __owur int tls12_copy_sigalgs(SSL_CONNECTION *s, WPACKET *pkt,
2734 const uint16_t *psig, size_t psiglen);
2735 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2736 __owur int tls1_save_sigalgs(SSL_CONNECTION *s, PACKET *pkt, int cert);
2737 __owur int tls1_process_sigalgs(SSL_CONNECTION *s);
2738 __owur int tls1_set_peer_legacy_sigalg(SSL_CONNECTION *s, const EVP_PKEY *pkey);
2739 __owur int tls1_lookup_md(SSL_CTX *ctx, const SIGALG_LOOKUP *lu,
2740 const EVP_MD **pmd);
2741 __owur size_t tls12_get_psigalgs(SSL_CONNECTION *s, int sent,
2742 const uint16_t **psigs);
2743 __owur int tls_check_sigalg_curve(const SSL_CONNECTION *s, int curve);
2744 __owur int tls12_check_peer_sigalg(SSL_CONNECTION *s, uint16_t, EVP_PKEY *pkey);
2745 __owur int ssl_set_client_disabled(SSL_CONNECTION *s);
2746 __owur int ssl_cipher_disabled(const SSL_CONNECTION *s, const SSL_CIPHER *c,
2749 __owur int ssl_handshake_hash(SSL_CONNECTION *s,
2750 unsigned char *out, size_t outlen,
2752 __owur const EVP_MD *ssl_md(SSL_CTX *ctx, int idx);
2753 __owur const EVP_MD *ssl_handshake_md(SSL_CONNECTION *s);
2754 __owur const EVP_MD *ssl_prf_md(SSL_CONNECTION *s);
2757 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2758 * with |ssl|, if logging is enabled. It returns one on success and zero on
2759 * failure. The entry is identified by the first 8 bytes of
2760 * |encrypted_premaster|.
2762 __owur int ssl_log_rsa_client_key_exchange(SSL_CONNECTION *s,
2763 const uint8_t *encrypted_premaster,
2764 size_t encrypted_premaster_len,
2765 const uint8_t *premaster,
2766 size_t premaster_len);
2769 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2770 * logging is available. It returns one on success and zero on failure. It tags
2771 * the entry with |label|.
2773 __owur int ssl_log_secret(SSL_CONNECTION *s, const char *label,
2774 const uint8_t *secret, size_t secret_len);
2776 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2777 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2778 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2779 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2780 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2781 #define CLIENT_APPLICATION_N_LABEL "CLIENT_TRAFFIC_SECRET_N"
2782 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2783 #define SERVER_APPLICATION_N_LABEL "SERVER_TRAFFIC_SECRET_N"
2784 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2785 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2787 __owur int srp_generate_server_master_secret(SSL_CONNECTION *s);
2788 __owur int srp_generate_client_master_secret(SSL_CONNECTION *s);
2789 __owur int srp_verify_server_param(SSL_CONNECTION *s);
2791 /* statem/statem_srvr.c */
2793 __owur int send_certificate_request(SSL_CONNECTION *s);
2795 /* statem/extensions_cust.c */
2797 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2798 ENDPOINT role, unsigned int ext_type,
2801 void custom_ext_init(custom_ext_methods *meths);
2803 int ossl_tls_add_custom_ext_intern(SSL_CTX *ctx, custom_ext_methods *exts,
2804 ENDPOINT role, unsigned int ext_type,
2805 unsigned int context,
2806 SSL_custom_ext_add_cb_ex add_cb,
2807 SSL_custom_ext_free_cb_ex free_cb,
2809 SSL_custom_ext_parse_cb_ex parse_cb,
2811 __owur int custom_ext_parse(SSL_CONNECTION *s, unsigned int context,
2812 unsigned int ext_type,
2813 const unsigned char *ext_data, size_t ext_size,
2814 X509 *x, size_t chainidx);
2815 __owur int custom_ext_add(SSL_CONNECTION *s, int context, WPACKET *pkt, X509 *x,
2816 size_t chainidx, int maxversion);
2818 __owur int custom_exts_copy(custom_ext_methods *dst,
2819 const custom_ext_methods *src);
2820 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2821 const custom_ext_methods *src);
2822 void custom_exts_free(custom_ext_methods *exts);
2824 void ssl_comp_free_compression_methods_int(void);
2827 void ssl_ctx_system_config(SSL_CTX *ctx);
2829 const EVP_CIPHER *ssl_evp_cipher_fetch(OSSL_LIB_CTX *libctx,
2831 const char *properties);
2832 int ssl_evp_cipher_up_ref(const EVP_CIPHER *cipher);
2833 void ssl_evp_cipher_free(const EVP_CIPHER *cipher);
2834 const EVP_MD *ssl_evp_md_fetch(OSSL_LIB_CTX *libctx,
2836 const char *properties);
2837 int ssl_evp_md_up_ref(const EVP_MD *md);
2838 void ssl_evp_md_free(const EVP_MD *md);
2840 int tls_provider_set_tls_params(SSL_CONNECTION *s, EVP_CIPHER_CTX *ctx,
2841 const EVP_CIPHER *ciph,
2844 void tls_engine_finish(ENGINE *e);
2845 const EVP_CIPHER *tls_get_cipher_from_engine(int nid);
2846 const EVP_MD *tls_get_digest_from_engine(int nid);
2847 int tls_engine_load_ssl_client_cert(SSL_CONNECTION *s, X509 **px509,
2849 int ssl_hmac_old_new(SSL_HMAC *ret);
2850 void ssl_hmac_old_free(SSL_HMAC *ctx);
2851 int ssl_hmac_old_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
2852 int ssl_hmac_old_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
2853 int ssl_hmac_old_final(SSL_HMAC *ctx, unsigned char *md, size_t *len);
2854 size_t ssl_hmac_old_size(const SSL_HMAC *ctx);
2856 int ssl_ctx_srp_ctx_free_intern(SSL_CTX *ctx);
2857 int ssl_ctx_srp_ctx_init_intern(SSL_CTX *ctx);
2858 int ssl_srp_ctx_free_intern(SSL_CONNECTION *s);
2859 int ssl_srp_ctx_init_intern(SSL_CONNECTION *s);
2861 int ssl_srp_calc_a_param_intern(SSL_CONNECTION *s);
2862 int ssl_srp_server_param_with_username_intern(SSL_CONNECTION *s, int *ad);
2864 void ssl_session_calculate_timeout(SSL_SESSION *ss);
2866 # else /* OPENSSL_UNIT_TEST */
2868 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2872 /* Some helper routines to support TSAN operations safely */
2873 static ossl_unused ossl_inline int ssl_tsan_lock(const SSL_CTX *ctx)
2875 #ifdef TSAN_REQUIRES_LOCKING
2876 if (!CRYPTO_THREAD_write_lock(ctx->tsan_lock))
2882 static ossl_unused ossl_inline void ssl_tsan_unlock(const SSL_CTX *ctx)
2884 #ifdef TSAN_REQUIRES_LOCKING
2885 CRYPTO_THREAD_unlock(ctx->tsan_lock);
2889 static ossl_unused ossl_inline void ssl_tsan_counter(const SSL_CTX *ctx,
2890 TSAN_QUALIFIER int *stat)
2892 if (ssl_tsan_lock(ctx)) {
2894 ssl_tsan_unlock(ctx);
2898 int ossl_comp_has_alg(int a);
2899 size_t ossl_calculate_comp_expansion(int alg, size_t length);
2901 void ossl_ssl_set_custom_record_layer(SSL_CONNECTION *s,
2902 const OSSL_RECORD_METHOD *meth,