2 * Copyright 1995-2019 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 OpenSSL license (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 HEADER_SSL_LOCL_H
13 # define HEADER_SSL_LOCL_H
15 # include "e_os.h" /* struct timeval for DTLS */
21 # include <openssl/buffer.h>
22 # include <openssl/comp.h>
23 # include <openssl/bio.h>
24 # include <openssl/rsa.h>
25 # include <openssl/dsa.h>
26 # include <openssl/err.h>
27 # include <openssl/ssl.h>
28 # include <openssl/async.h>
29 # include <openssl/symhacks.h>
30 # include <openssl/ct.h>
31 # include "record/record.h"
32 # include "statem/statem.h"
33 # include "packet_local.h"
34 # include "internal/dane.h"
35 # include "internal/refcount.h"
36 # include "internal/tsan_assist.h"
38 # ifdef OPENSSL_BUILD_SHLIBSSL
39 # undef OPENSSL_EXTERN
40 # define OPENSSL_EXTERN OPENSSL_EXPORT
43 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
44 l|=(((unsigned long)(*((c)++)))<< 8), \
45 l|=(((unsigned long)(*((c)++)))<<16), \
46 l|=(((unsigned long)(*((c)++)))<<24))
48 /* NOTE - c is not incremented as per c2l */
49 # define c2ln(c,l1,l2,n) { \
53 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
54 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
55 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
56 case 5: l2|=((unsigned long)(*(--(c)))); \
57 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
58 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
59 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
60 case 1: l1|=((unsigned long)(*(--(c)))); \
64 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
65 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
66 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
67 *((c)++)=(unsigned char)(((l)>>24)&0xff))
69 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
70 l|=((unsigned long)(*((c)++)))<<16, \
71 l|=((unsigned long)(*((c)++)))<< 8, \
72 l|=((unsigned long)(*((c)++))))
74 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
75 l|=((uint64_t)(*((c)++)))<<48, \
76 l|=((uint64_t)(*((c)++)))<<40, \
77 l|=((uint64_t)(*((c)++)))<<32, \
78 l|=((uint64_t)(*((c)++)))<<24, \
79 l|=((uint64_t)(*((c)++)))<<16, \
80 l|=((uint64_t)(*((c)++)))<< 8, \
81 l|=((uint64_t)(*((c)++))))
84 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
85 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
86 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
87 *((c)++)=(unsigned char)(((l) )&0xff))
89 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
90 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
91 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
92 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
93 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
94 *((c)++)=(unsigned char)(((l) )&0xff))
96 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
97 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
98 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
99 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
101 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
102 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
103 *((c)++)=(unsigned char)(((l) )&0xff))
105 /* NOTE - c is not incremented as per l2c */
106 # define l2cn(l1,l2,c,n) { \
109 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
110 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
111 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
112 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
113 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
114 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
115 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
116 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
120 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
121 (((unsigned int)((c)[1])) )),(c)+=2)
122 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
123 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
125 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
126 (((unsigned long)((c)[1]))<< 8)| \
127 (((unsigned long)((c)[2])) )),(c)+=3)
129 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
130 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
131 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
134 * DTLS version numbers are strange because they're inverted. Except for
135 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
137 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
138 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
139 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
140 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
141 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
145 * Define the Bitmasks for SSL_CIPHER.algorithms.
146 * This bits are used packed as dense as possible. If new methods/ciphers
147 * etc will be added, the bits a likely to change, so this information
148 * is for internal library use only, even though SSL_CIPHER.algorithms
149 * can be publicly accessed.
150 * Use the according functions for cipher management instead.
152 * The bit mask handling in the selection and sorting scheme in
153 * ssl_create_cipher_list() has only limited capabilities, reflecting
154 * that the different entities within are mutually exclusive:
155 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
158 /* Bits for algorithm_mkey (key exchange algorithm) */
159 /* RSA key exchange */
160 # define SSL_kRSA 0x00000001U
161 /* tmp DH key no DH cert */
162 # define SSL_kDHE 0x00000002U
164 # define SSL_kEDH SSL_kDHE
166 # define SSL_kECDHE 0x00000004U
168 # define SSL_kEECDH SSL_kECDHE
170 # define SSL_kPSK 0x00000008U
171 /* GOST key exchange */
172 # define SSL_kGOST 0x00000010U
174 # define SSL_kSRP 0x00000020U
176 # define SSL_kRSAPSK 0x00000040U
177 # define SSL_kECDHEPSK 0x00000080U
178 # define SSL_kDHEPSK 0x00000100U
182 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
184 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
185 # define SSL_kANY 0x00000000U
187 /* Bits for algorithm_auth (server authentication) */
189 # define SSL_aRSA 0x00000001U
191 # define SSL_aDSS 0x00000002U
192 /* no auth (i.e. use ADH or AECDH) */
193 # define SSL_aNULL 0x00000004U
195 # define SSL_aECDSA 0x00000008U
197 # define SSL_aPSK 0x00000010U
198 /* GOST R 34.10-2001 signature auth */
199 # define SSL_aGOST01 0x00000020U
201 # define SSL_aSRP 0x00000040U
202 /* GOST R 34.10-2012 signature auth */
203 # define SSL_aGOST12 0x00000080U
204 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
205 # define SSL_aANY 0x00000000U
206 /* All bits requiring a certificate */
208 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
210 /* Bits for algorithm_enc (symmetric encryption) */
211 # define SSL_DES 0x00000001U
212 # define SSL_3DES 0x00000002U
213 # define SSL_RC4 0x00000004U
214 # define SSL_RC2 0x00000008U
215 # define SSL_IDEA 0x00000010U
216 # define SSL_eNULL 0x00000020U
217 # define SSL_AES128 0x00000040U
218 # define SSL_AES256 0x00000080U
219 # define SSL_CAMELLIA128 0x00000100U
220 # define SSL_CAMELLIA256 0x00000200U
221 # define SSL_eGOST2814789CNT 0x00000400U
222 # define SSL_SEED 0x00000800U
223 # define SSL_AES128GCM 0x00001000U
224 # define SSL_AES256GCM 0x00002000U
225 # define SSL_AES128CCM 0x00004000U
226 # define SSL_AES256CCM 0x00008000U
227 # define SSL_AES128CCM8 0x00010000U
228 # define SSL_AES256CCM8 0x00020000U
229 # define SSL_eGOST2814789CNT12 0x00040000U
230 # define SSL_CHACHA20POLY1305 0x00080000U
231 # define SSL_ARIA128GCM 0x00100000U
232 # define SSL_ARIA256GCM 0x00200000U
234 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
235 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
236 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
237 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
238 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
239 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
240 # define SSL_ARIA (SSL_ARIAGCM)
242 /* Bits for algorithm_mac (symmetric authentication) */
244 # define SSL_MD5 0x00000001U
245 # define SSL_SHA1 0x00000002U
246 # define SSL_GOST94 0x00000004U
247 # define SSL_GOST89MAC 0x00000008U
248 # define SSL_SHA256 0x00000010U
249 # define SSL_SHA384 0x00000020U
250 /* Not a real MAC, just an indication it is part of cipher */
251 # define SSL_AEAD 0x00000040U
252 # define SSL_GOST12_256 0x00000080U
253 # define SSL_GOST89MAC12 0x00000100U
254 # define SSL_GOST12_512 0x00000200U
257 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
258 * sure to update this constant too
261 # define SSL_MD_MD5_IDX 0
262 # define SSL_MD_SHA1_IDX 1
263 # define SSL_MD_GOST94_IDX 2
264 # define SSL_MD_GOST89MAC_IDX 3
265 # define SSL_MD_SHA256_IDX 4
266 # define SSL_MD_SHA384_IDX 5
267 # define SSL_MD_GOST12_256_IDX 6
268 # define SSL_MD_GOST89MAC12_IDX 7
269 # define SSL_MD_GOST12_512_IDX 8
270 # define SSL_MD_MD5_SHA1_IDX 9
271 # define SSL_MD_SHA224_IDX 10
272 # define SSL_MD_SHA512_IDX 11
273 # define SSL_MAX_DIGEST 12
275 /* Bits for algorithm2 (handshake digests and other extra flags) */
277 /* Bits 0-7 are handshake MAC */
278 # define SSL_HANDSHAKE_MAC_MASK 0xFF
279 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
280 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
281 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
282 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
283 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
284 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
285 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
287 /* Bits 8-15 bits are PRF */
288 # define TLS1_PRF_DGST_SHIFT 8
289 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
290 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
291 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
292 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
293 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
294 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
295 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
298 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
299 * goes into algorithm2)
301 # define TLS1_STREAM_MAC 0x10000
303 # define SSL_STRONG_MASK 0x0000001FU
304 # define SSL_DEFAULT_MASK 0X00000020U
306 # define SSL_STRONG_NONE 0x00000001U
307 # define SSL_LOW 0x00000002U
308 # define SSL_MEDIUM 0x00000004U
309 # define SSL_HIGH 0x00000008U
310 # define SSL_FIPS 0x00000010U
311 # define SSL_NOT_DEFAULT 0x00000020U
313 /* we have used 0000003f - 26 bits left to go */
315 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
316 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
318 /* Check if an SSL structure is using DTLS */
319 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
321 /* Check if we are using TLSv1.3 */
322 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
323 && (s)->method->version >= TLS1_3_VERSION \
324 && (s)->method->version != TLS_ANY_VERSION)
326 # define SSL_TREAT_AS_TLS13(s) \
327 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
328 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
329 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
330 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
331 || (s)->hello_retry_request == SSL_HRR_PENDING)
333 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0 \
334 || (s)->s3->tmp.peer_finish_md_len == 0)
336 /* See if we need explicit IV */
337 # define SSL_USE_EXPLICIT_IV(s) \
338 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
340 * See if we use signature algorithms extension and signature algorithm
343 # define SSL_USE_SIGALGS(s) \
344 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
346 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
347 * apply to others in future.
349 # define SSL_USE_TLS1_2_CIPHERS(s) \
350 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
352 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
353 * flags because it may not be set to correct version yet.
355 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
356 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
357 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
359 * Determine if a client should send signature algorithms extension:
360 * as with TLS1.2 cipher we can't rely on method flags.
362 # define SSL_CLIENT_USE_SIGALGS(s) \
363 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
365 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
366 (((value) >= TLSEXT_max_fragment_length_512) && \
367 ((value) <= TLSEXT_max_fragment_length_4096))
368 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
369 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
370 # define GET_MAX_FRAGMENT_LENGTH(session) \
371 (512U << (session->ext.max_fragment_len_mode - 1))
373 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
374 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
376 /* Mostly for SSLv3 */
377 # define SSL_PKEY_RSA 0
378 # define SSL_PKEY_RSA_PSS_SIGN 1
379 # define SSL_PKEY_DSA_SIGN 2
380 # define SSL_PKEY_ECC 3
381 # define SSL_PKEY_GOST01 4
382 # define SSL_PKEY_GOST12_256 5
383 # define SSL_PKEY_GOST12_512 6
384 # define SSL_PKEY_ED25519 7
385 # define SSL_PKEY_ED448 8
386 # define SSL_PKEY_NUM 9
389 * SSL_kRSA <- RSA_ENC
390 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
391 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
392 * SSL_aRSA <- RSA_ENC | RSA_SIGN
393 * SSL_aDSS <- DSA_SIGN
397 #define CERT_INVALID 0
398 #define CERT_PUBLIC_KEY 1
399 #define CERT_PRIVATE_KEY 2
402 /* Post-Handshake Authentication state */
405 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
406 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
407 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
408 SSL_PHA_REQUESTED /* request received by client, or sent by server */
411 /* CipherSuite length. SSLv3 and all TLS versions. */
412 # define TLS_CIPHER_LEN 2
413 /* used to hold info on the particular ciphers used */
414 struct ssl_cipher_st {
416 const char *name; /* text name */
417 const char *stdname; /* RFC name */
418 uint32_t id; /* id, 4 bytes, first is version */
420 * changed in 1.0.0: these four used to be portions of a single value
423 uint32_t algorithm_mkey; /* key exchange algorithm */
424 uint32_t algorithm_auth; /* server authentication */
425 uint32_t algorithm_enc; /* symmetric encryption */
426 uint32_t algorithm_mac; /* symmetric authentication */
427 int min_tls; /* minimum SSL/TLS protocol version */
428 int max_tls; /* maximum SSL/TLS protocol version */
429 int min_dtls; /* minimum DTLS protocol version */
430 int max_dtls; /* maximum DTLS protocol version */
431 uint32_t algo_strength; /* strength and export flags */
432 uint32_t algorithm2; /* Extra flags */
433 int32_t strength_bits; /* Number of bits really used */
434 uint32_t alg_bits; /* Number of bits for algorithm */
437 /* Used to hold SSL/TLS functions */
438 struct ssl_method_st {
442 int (*ssl_new) (SSL *s);
443 int (*ssl_clear) (SSL *s);
444 void (*ssl_free) (SSL *s);
445 int (*ssl_accept) (SSL *s);
446 int (*ssl_connect) (SSL *s);
447 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
448 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
449 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
450 int (*ssl_shutdown) (SSL *s);
451 int (*ssl_renegotiate) (SSL *s);
452 int (*ssl_renegotiate_check) (SSL *s, int);
453 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
454 unsigned char *buf, size_t len, int peek,
456 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
458 int (*ssl_dispatch_alert) (SSL *s);
459 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
460 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
461 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
462 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
464 size_t (*ssl_pending) (const SSL *s);
465 int (*num_ciphers) (void);
466 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
467 long (*get_timeout) (void);
468 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
469 int (*ssl_version) (void);
470 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
471 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
475 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
476 * consistency, even in the event of OPENSSL_NO_PSK being defined.
478 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 256
481 * Lets make this into an ASN.1 type structure as follows
482 * SSL_SESSION_ID ::= SEQUENCE {
483 * version INTEGER, -- structure version number
484 * SSLversion INTEGER, -- SSL version number
485 * Cipher OCTET STRING, -- the 3 byte cipher ID
486 * Session_ID OCTET STRING, -- the Session ID
487 * Master_key OCTET STRING, -- the master key
488 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
489 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
490 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
491 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
492 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
493 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
494 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
495 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
496 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
497 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
498 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
499 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
500 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
501 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
503 * Look in ssl/ssl_asn1.c for more details
504 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
506 struct ssl_session_st {
507 int ssl_version; /* what ssl version session info is being kept
509 size_t master_key_length;
511 /* TLSv1.3 early_secret used for external PSKs */
512 unsigned char early_secret[EVP_MAX_MD_SIZE];
514 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
517 unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
518 /* session_id - valid? */
519 size_t session_id_length;
520 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
522 * this is used to determine whether the session is being reused in the
523 * appropriate context. It is up to the application to set this, via
526 size_t sid_ctx_length;
527 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
528 # ifndef OPENSSL_NO_PSK
529 char *psk_identity_hint;
533 * Used to indicate that session resumption is not allowed. Applications
534 * can also set this bit for a new session via not_resumable_session_cb
535 * to disable session caching and tickets.
538 /* This is the cert and type for the other end. */
541 /* Certificate chain peer sent. */
542 STACK_OF(X509) *peer_chain;
544 * when app_verify_callback accepts a session where the peer's
545 * certificate is not ok, we must remember the error for session reuse:
547 long verify_result; /* only for servers */
548 CRYPTO_REF_COUNT references;
551 unsigned int compress_meth; /* Need to lookup the method */
552 const SSL_CIPHER *cipher;
553 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
554 * load the 'cipher' structure */
555 CRYPTO_EX_DATA ex_data; /* application specific data */
557 * These are used to make removal of session-ids more efficient and to
558 * implement a maximum cache size.
560 struct ssl_session_st *prev, *next;
565 unsigned char *tick; /* Session ticket */
566 size_t ticklen; /* Session ticket length */
567 /* Session lifetime hint in seconds */
568 unsigned long tick_lifetime_hint;
569 uint32_t tick_age_add;
570 /* Max number of bytes that can be sent as early data */
571 uint32_t max_early_data;
572 /* The ALPN protocol selected for this session */
573 unsigned char *alpn_selected;
574 size_t alpn_selected_len;
576 * Maximum Fragment Length as per RFC 4366.
577 * If this value does not contain RFC 4366 allowed values (1-4) then
578 * either the Maximum Fragment Length Negotiation failed or was not
581 uint8_t max_fragment_len_mode;
583 # ifndef OPENSSL_NO_SRP
586 unsigned char *ticket_appdata;
587 size_t ticket_appdata_len;
592 /* Extended master secret support */
593 # define SSL_SESS_FLAG_EXTMS 0x1
595 # ifndef OPENSSL_NO_SRP
597 typedef struct srp_ctx_st {
598 /* param for all the callbacks */
600 /* set client Hello login callback */
601 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
602 /* set SRP N/g param callback for verification */
603 int (*SRP_verify_param_callback) (SSL *, void *);
604 /* set SRP client passwd callback */
605 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
607 BIGNUM *N, *g, *s, *B, *A;
611 unsigned long srp_Mask;
617 SSL_EARLY_DATA_NONE = 0,
618 SSL_EARLY_DATA_CONNECT_RETRY,
619 SSL_EARLY_DATA_CONNECTING,
620 SSL_EARLY_DATA_WRITE_RETRY,
621 SSL_EARLY_DATA_WRITING,
622 SSL_EARLY_DATA_WRITE_FLUSH,
623 SSL_EARLY_DATA_UNAUTH_WRITING,
624 SSL_EARLY_DATA_FINISHED_WRITING,
625 SSL_EARLY_DATA_ACCEPT_RETRY,
626 SSL_EARLY_DATA_ACCEPTING,
627 SSL_EARLY_DATA_READ_RETRY,
628 SSL_EARLY_DATA_READING,
629 SSL_EARLY_DATA_FINISHED_READING
630 } SSL_EARLY_DATA_STATE;
633 * We check that the amount of unreadable early data doesn't exceed
634 * max_early_data. max_early_data is given in plaintext bytes. However if it is
635 * unreadable then we only know the number of ciphertext bytes. We also don't
636 * know how much the overhead should be because it depends on the ciphersuite.
637 * We make a small allowance. We assume 5 records of actual data plus the end
638 * of early data alert record. Each record has a tag and a content type byte.
639 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
640 * content of the alert record either which is 2 bytes.
642 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
645 * The allowance we have between the client's calculated ticket age and our own.
646 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
647 * client's age calculation is different by more than this than our own then we
648 * do not allow that ticket for early_data.
650 # define TICKET_AGE_ALLOWANCE (10 * 1000)
652 #define MAX_COMPRESSIONS_SIZE 255
660 typedef struct raw_extension_st {
661 /* Raw packet data for the extension */
663 /* Set to 1 if the extension is present or 0 otherwise */
665 /* Set to 1 if we have already parsed the extension or 0 otherwise */
667 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
669 /* Track what order extensions are received in (0-based). */
670 size_t received_order;
675 unsigned int legacy_version;
676 unsigned char random[SSL3_RANDOM_SIZE];
677 size_t session_id_len;
678 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
679 size_t dtls_cookie_len;
680 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
682 size_t compressions_len;
683 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
685 size_t pre_proc_exts_len;
686 RAW_EXTENSION *pre_proc_exts;
690 * Extension index values NOTE: Any updates to these defines should be mirrored
691 * with equivalent updates to ext_defs in extensions.c
693 typedef enum tlsext_index_en {
694 TLSEXT_IDX_renegotiate,
695 TLSEXT_IDX_server_name,
696 TLSEXT_IDX_max_fragment_length,
698 TLSEXT_IDX_ec_point_formats,
699 TLSEXT_IDX_supported_groups,
700 TLSEXT_IDX_session_ticket,
701 TLSEXT_IDX_status_request,
702 TLSEXT_IDX_next_proto_neg,
703 TLSEXT_IDX_application_layer_protocol_negotiation,
705 TLSEXT_IDX_encrypt_then_mac,
706 TLSEXT_IDX_signed_certificate_timestamp,
707 TLSEXT_IDX_extended_master_secret,
708 TLSEXT_IDX_signature_algorithms_cert,
709 TLSEXT_IDX_post_handshake_auth,
710 TLSEXT_IDX_signature_algorithms,
711 TLSEXT_IDX_supported_versions,
712 TLSEXT_IDX_psk_kex_modes,
713 TLSEXT_IDX_key_share,
715 TLSEXT_IDX_cryptopro_bug,
716 TLSEXT_IDX_early_data,
717 TLSEXT_IDX_certificate_authorities,
720 /* Dummy index - must always be the last entry */
721 TLSEXT_IDX_num_builtins
724 DEFINE_LHASH_OF(SSL_SESSION);
725 /* Needed in ssl_cert.c */
726 DEFINE_LHASH_OF(X509_NAME);
728 # define TLSEXT_KEYNAME_LENGTH 16
729 # define TLSEXT_TICK_KEY_LENGTH 32
731 typedef struct ssl_ctx_ext_secure_st {
732 unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
733 unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
734 } SSL_CTX_EXT_SECURE;
737 const SSL_METHOD *method;
738 STACK_OF(SSL_CIPHER) *cipher_list;
739 /* same as above but sorted for lookup */
740 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
741 /* TLSv1.3 specific ciphersuites */
742 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
743 struct x509_store_st /* X509_STORE */ *cert_store;
744 LHASH_OF(SSL_SESSION) *sessions;
746 * Most session-ids that will be cached, default is
747 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
749 size_t session_cache_size;
750 struct ssl_session_st *session_cache_head;
751 struct ssl_session_st *session_cache_tail;
753 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
754 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
755 * means only SSL_accept will cache SSL_SESSIONS.
757 uint32_t session_cache_mode;
759 * If timeout is not 0, it is the default timeout value set when
760 * SSL_new() is called. This has been put in to make life easier to set
763 long session_timeout;
765 * If this callback is not null, it will be called each time a session id
766 * is added to the cache. If this function returns 1, it means that the
767 * callback will do a SSL_SESSION_free() when it has finished using it.
768 * Otherwise, on 0, it means the callback has finished with it. If
769 * remove_session_cb is not null, it will be called when a session-id is
770 * removed from the cache. After the call, OpenSSL will
771 * SSL_SESSION_free() it.
773 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
774 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
775 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
776 const unsigned char *data, int len,
779 TSAN_QUALIFIER int sess_connect; /* SSL new conn - started */
780 TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
781 TSAN_QUALIFIER int sess_connect_good; /* SSL new conne/reneg - finished */
782 TSAN_QUALIFIER int sess_accept; /* SSL new accept - started */
783 TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
784 TSAN_QUALIFIER int sess_accept_good; /* SSL accept/reneg - finished */
785 TSAN_QUALIFIER int sess_miss; /* session lookup misses */
786 TSAN_QUALIFIER int sess_timeout; /* reuse attempt on timeouted session */
787 TSAN_QUALIFIER int sess_cache_full; /* session removed due to full cache */
788 TSAN_QUALIFIER int sess_hit; /* session reuse actually done */
789 TSAN_QUALIFIER int sess_cb_hit; /* session-id that was not in
790 * the cache was passed back via
791 * the callback. This indicates
792 * that the application is
793 * supplying session-id's from
794 * other processes - spooky
798 CRYPTO_REF_COUNT references;
800 /* if defined, these override the X509_verify_cert() calls */
801 int (*app_verify_callback) (X509_STORE_CTX *, void *);
802 void *app_verify_arg;
804 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
805 * ('app_verify_callback' was called with just one argument)
808 /* Default password callback. */
809 pem_password_cb *default_passwd_callback;
811 /* Default password callback user data. */
812 void *default_passwd_callback_userdata;
814 /* get client cert callback */
815 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
817 /* cookie generate callback */
818 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
819 unsigned int *cookie_len);
821 /* verify cookie callback */
822 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
823 unsigned int cookie_len);
825 /* TLS1.3 app-controlled cookie generate callback */
826 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
829 /* TLS1.3 verify app-controlled cookie callback */
830 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
833 CRYPTO_EX_DATA ex_data;
835 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
836 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
838 STACK_OF(X509) *extra_certs;
839 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
841 /* Default values used when no per-SSL value is defined follow */
843 /* used if SSL's info_callback is NULL */
844 void (*info_callback) (const SSL *ssl, int type, int val);
847 * What we put in certificate_authorities extension for TLS 1.3
848 * (ClientHello and CertificateRequest) or just client cert requests for
849 * earlier versions. If client_ca_names is populated then it is only used
850 * for client cert requests, and in preference to ca_names.
852 STACK_OF(X509_NAME) *ca_names;
853 STACK_OF(X509_NAME) *client_ca_names;
856 * Default values to use in SSL structures follow (these are copied by
862 int min_proto_version;
863 int max_proto_version;
864 size_t max_cert_list;
866 struct cert_st /* CERT */ *cert;
869 /* callback that allows applications to peek at protocol messages */
870 void (*msg_callback) (int write_p, int version, int content_type,
871 const void *buf, size_t len, SSL *ssl, void *arg);
872 void *msg_callback_arg;
874 uint32_t verify_mode;
875 size_t sid_ctx_length;
876 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
877 /* called 'verify_callback' in the SSL */
878 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
880 /* Default generate session ID callback. */
881 GEN_SESSION_CB generate_session_id;
883 X509_VERIFY_PARAM *param;
887 # ifndef OPENSSL_NO_CT
888 CTLOG_STORE *ctlog_store; /* CT Log Store */
890 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
891 * If they are not, the connection should be aborted.
893 ssl_ct_validation_cb ct_validation_callback;
894 void *ct_validation_callback_arg;
898 * If we're using more than one pipeline how should we divide the data
899 * up between the pipes?
901 size_t split_send_fragment;
903 * Maximum amount of data to send in one fragment. actual record size can
904 * be more than this due to padding and MAC overheads.
906 size_t max_send_fragment;
908 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
909 size_t max_pipelines;
911 /* The default read buffer length to use (0 means not set) */
912 size_t default_read_buf_len;
914 # ifndef OPENSSL_NO_ENGINE
916 * Engine to pass requests for client certs to
918 ENGINE *client_cert_engine;
921 /* ClientHello callback. Mostly for extensions, but not entirely. */
922 SSL_client_hello_cb_fn client_hello_cb;
923 void *client_hello_cb_arg;
925 /* TLS extensions. */
927 /* TLS extensions servername callback */
928 int (*servername_cb) (SSL *, int *, void *);
929 void *servername_arg;
930 /* RFC 4507 session ticket keys */
931 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
932 SSL_CTX_EXT_SECURE *secure;
933 /* Callback to support customisation of ticket key setting */
934 int (*ticket_key_cb) (SSL *ssl,
935 unsigned char *name, unsigned char *iv,
936 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
938 /* certificate status request info */
939 /* Callback for status request */
940 int (*status_cb) (SSL *ssl, void *arg);
942 /* ext status type used for CSR extension (OCSP Stapling) */
944 /* RFC 4366 Maximum Fragment Length Negotiation */
945 uint8_t max_fragment_len_mode;
947 # ifndef OPENSSL_NO_EC
948 /* EC extension values inherited by SSL structure */
949 size_t ecpointformats_len;
950 unsigned char *ecpointformats;
951 size_t supportedgroups_len;
952 uint16_t *supportedgroups;
953 # endif /* OPENSSL_NO_EC */
956 * ALPN information (we are in the process of transitioning from NPN to
961 * For a server, this contains a callback function that allows the
962 * server to select the protocol for the connection.
963 * out: on successful return, this must point to the raw protocol
964 * name (without the length prefix).
965 * outlen: on successful return, this contains the length of |*out|.
966 * in: points to the client's list of supported protocols in
968 * inlen: the length of |in|.
970 int (*alpn_select_cb) (SSL *s,
971 const unsigned char **out,
972 unsigned char *outlen,
973 const unsigned char *in,
974 unsigned int inlen, void *arg);
975 void *alpn_select_cb_arg;
978 * For a client, this contains the list of supported protocols in wire
984 # ifndef OPENSSL_NO_NEXTPROTONEG
985 /* Next protocol negotiation information */
988 * For a server, this contains a callback function by which the set of
989 * advertised protocols can be provided.
991 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
992 void *npn_advertised_cb_arg;
994 * For a client, this contains a callback function that selects the next
995 * protocol from the list provided by the server.
997 SSL_CTX_npn_select_cb_func npn_select_cb;
998 void *npn_select_cb_arg;
1001 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1004 # ifndef OPENSSL_NO_PSK
1005 SSL_psk_client_cb_func psk_client_callback;
1006 SSL_psk_server_cb_func psk_server_callback;
1008 SSL_psk_find_session_cb_func psk_find_session_cb;
1009 SSL_psk_use_session_cb_func psk_use_session_cb;
1011 # ifndef OPENSSL_NO_SRP
1012 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1015 /* Shared DANE context */
1016 struct dane_ctx_st dane;
1018 # ifndef OPENSSL_NO_SRTP
1019 /* SRTP profiles we are willing to do from RFC 5764 */
1020 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1023 * Callback for disabling session caching and ticket support on a session
1024 * basis, depending on the chosen cipher.
1026 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1028 CRYPTO_RWLOCK *lock;
1031 * Callback for logging key material for use with debugging tools like
1032 * Wireshark. The callback should log `line` followed by a newline.
1034 SSL_CTX_keylog_cb_func keylog_callback;
1037 * The maximum number of bytes advertised in session tickets that can be
1038 * sent as early data.
1040 uint32_t max_early_data;
1043 * The maximum number of bytes of early data that a server will tolerate
1044 * (which should be at least as much as max_early_data).
1046 uint32_t recv_max_early_data;
1048 /* TLS1.3 padding callback */
1049 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1050 void *record_padding_arg;
1051 size_t block_padding;
1053 /* Session ticket appdata */
1054 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1055 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1056 void *ticket_cb_data;
1058 /* The number of TLS1.3 tickets to automatically send */
1061 /* Callback to determine if early_data is acceptable or not */
1062 SSL_allow_early_data_cb_fn allow_early_data_cb;
1063 void *allow_early_data_cb_data;
1065 /* Do we advertise Post-handshake auth support? */
1071 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1076 const SSL_METHOD *method;
1078 * There are 2 BIO's even though they are normally both the same. This
1079 * is so data can be read and written to different handlers
1081 /* used by SSL_read */
1083 /* used by SSL_write */
1085 /* used during session-id reuse to concatenate messages */
1088 * This holds a variable that indicates what we were doing when a 0 or -1
1089 * is returned. This is needed for non-blocking IO so we know what
1090 * request needs re-doing when in SSL_accept or SSL_connect
1093 int (*handshake_func) (SSL *);
1095 * Imagine that here's a boolean member "init" that is switched as soon
1096 * as SSL_set_{accept/connect}_state is called for the first time, so
1097 * that "state" and "handshake_func" are properly initialized. But as
1098 * handshake_func is == 0 until then, we use this test instead of an
1101 /* are we the server side? */
1104 * Generate a new session or reuse an old one.
1105 * NB: For servers, the 'new' session may actually be a previously
1106 * cached session or even the previous session unless
1107 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1110 /* don't send shutdown packets */
1112 /* we have shut things down, 0x01 sent, 0x02 for received */
1116 SSL_EARLY_DATA_STATE early_data_state;
1117 BUF_MEM *init_buf; /* buffer used during init */
1118 void *init_msg; /* pointer to handshake message body, set by
1119 * ssl3_get_message() */
1120 size_t init_num; /* amount read/written */
1121 size_t init_off; /* amount read/written */
1122 struct ssl3_state_st *s3; /* SSLv3 variables */
1123 struct dtls1_state_st *d1; /* DTLSv1 variables */
1124 /* callback that allows applications to peek at protocol messages */
1125 void (*msg_callback) (int write_p, int version, int content_type,
1126 const void *buf, size_t len, SSL *ssl, void *arg);
1127 void *msg_callback_arg;
1128 int hit; /* reusing a previous session */
1129 X509_VERIFY_PARAM *param;
1130 /* Per connection DANE state */
1133 STACK_OF(SSL_CIPHER) *peer_ciphers;
1134 STACK_OF(SSL_CIPHER) *cipher_list;
1135 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1136 /* TLSv1.3 specific ciphersuites */
1137 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1139 * These are the ones being used, the ones in SSL_SESSION are the ones to
1140 * be 'copied' into these ones
1144 * The TLS1.3 secrets.
1146 unsigned char early_secret[EVP_MAX_MD_SIZE];
1147 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1148 unsigned char master_secret[EVP_MAX_MD_SIZE];
1149 unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1150 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1151 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1152 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1153 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1154 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1155 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1156 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1157 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1158 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1159 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1160 EVP_MD_CTX *read_hash; /* used for mac generation */
1161 COMP_CTX *compress; /* compression */
1162 COMP_CTX *expand; /* uncompress */
1163 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1164 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1165 EVP_MD_CTX *write_hash; /* used for mac generation */
1168 /* This is used to hold the server certificate used */
1169 struct cert_st /* CERT */ *cert;
1172 * The hash of all messages prior to the CertificateVerify, and the length
1175 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1176 size_t cert_verify_hash_len;
1178 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1179 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1180 hello_retry_request;
1183 * the session_id_context is used to ensure sessions are only reused in
1184 * the appropriate context
1186 size_t sid_ctx_length;
1187 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1188 /* This can also be in the session once a session is established */
1189 SSL_SESSION *session;
1190 /* TLSv1.3 PSK session */
1191 SSL_SESSION *psksession;
1192 unsigned char *psksession_id;
1193 size_t psksession_id_len;
1194 /* Default generate session ID callback. */
1195 GEN_SESSION_CB generate_session_id;
1197 * The temporary TLSv1.3 session id. This isn't really a session id at all
1198 * but is a random value sent in the legacy session id field.
1200 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1201 size_t tmp_session_id_len;
1204 * 0 don't care about verify failure.
1205 * 1 fail if verify fails
1207 uint32_t verify_mode;
1208 /* fail if callback returns 0 */
1209 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1210 /* optional informational callback */
1211 void (*info_callback) (const SSL *ssl, int type, int val);
1212 /* error bytes to be written */
1216 # ifndef OPENSSL_NO_PSK
1217 SSL_psk_client_cb_func psk_client_callback;
1218 SSL_psk_server_cb_func psk_server_callback;
1220 SSL_psk_find_session_cb_func psk_find_session_cb;
1221 SSL_psk_use_session_cb_func psk_use_session_cb;
1224 /* Verified chain of peer */
1225 STACK_OF(X509) *verified_chain;
1227 /* extra application data */
1228 CRYPTO_EX_DATA ex_data;
1230 * What we put in certificate_authorities extension for TLS 1.3
1231 * (ClientHello and CertificateRequest) or just client cert requests for
1232 * earlier versions. If client_ca_names is populated then it is only used
1233 * for client cert requests, and in preference to ca_names.
1235 STACK_OF(X509_NAME) *ca_names;
1236 STACK_OF(X509_NAME) *client_ca_names;
1237 CRYPTO_REF_COUNT references;
1238 /* protocol behaviour */
1242 int min_proto_version;
1243 int max_proto_version;
1244 size_t max_cert_list;
1247 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1248 * secret and SSLv3/TLS (<=1.2) rollback check
1252 * If we're using more than one pipeline how should we divide the data
1253 * up between the pipes?
1255 size_t split_send_fragment;
1257 * Maximum amount of data to send in one fragment. actual record size can
1258 * be more than this due to padding and MAC overheads.
1260 size_t max_send_fragment;
1261 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1262 size_t max_pipelines;
1265 /* Built-in extension flags */
1266 uint8_t extflags[TLSEXT_IDX_num_builtins];
1267 /* TLS extension debug callback */
1268 void (*debug_cb)(SSL *s, int client_server, int type,
1269 const unsigned char *data, int len, void *arg);
1272 /* certificate status request info */
1273 /* Status type or -1 if no status type */
1275 /* Raw extension data, if seen */
1276 unsigned char *scts;
1277 /* Length of raw extension data, if seen */
1279 /* Expect OCSP CertificateStatus message */
1280 int status_expected;
1283 /* OCSP status request only */
1284 STACK_OF(OCSP_RESPID) *ids;
1285 X509_EXTENSIONS *exts;
1286 /* OCSP response received or to be sent */
1287 unsigned char *resp;
1291 /* RFC4507 session ticket expected to be received or sent */
1292 int ticket_expected;
1293 # ifndef OPENSSL_NO_EC
1294 size_t ecpointformats_len;
1296 unsigned char *ecpointformats;
1298 size_t peer_ecpointformats_len;
1300 unsigned char *peer_ecpointformats;
1301 # endif /* OPENSSL_NO_EC */
1302 size_t supportedgroups_len;
1304 uint16_t *supportedgroups;
1306 size_t peer_supportedgroups_len;
1308 uint16_t *peer_supportedgroups;
1310 /* TLS Session Ticket extension override */
1311 TLS_SESSION_TICKET_EXT *session_ticket;
1312 /* TLS Session Ticket extension callback */
1313 tls_session_ticket_ext_cb_fn session_ticket_cb;
1314 void *session_ticket_cb_arg;
1315 /* TLS pre-shared secret session resumption */
1316 tls_session_secret_cb_fn session_secret_cb;
1317 void *session_secret_cb_arg;
1319 * For a client, this contains the list of supported protocols in wire
1322 unsigned char *alpn;
1325 * Next protocol negotiation. For the client, this is the protocol that
1326 * we sent in NextProtocol and is set when handling ServerHello
1327 * extensions. For a server, this is the client's selected_protocol from
1328 * NextProtocol and is set when handling the NextProtocol message, before
1329 * the Finished message.
1334 /* The available PSK key exchange modes */
1337 /* Set to one if we have negotiated ETM */
1340 /* Are we expecting to receive early data? */
1342 /* Is the session suitable for early data? */
1345 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1346 unsigned char *tls13_cookie;
1347 size_t tls13_cookie_len;
1348 /* Have we received a cookie from the client? */
1352 * Maximum Fragment Length as per RFC 4366.
1353 * If this member contains one of the allowed values (1-4)
1354 * then we should include Maximum Fragment Length Negotiation
1355 * extension in Client Hello.
1356 * Please note that value of this member does not have direct
1357 * effect. The actual (binding) value is stored in SSL_SESSION,
1358 * as this extension is optional on server side.
1360 uint8_t max_fragment_len_mode;
1363 * On the client side the number of ticket identities we sent in the
1364 * ClientHello. On the server side the identity of the ticket we
1371 * Parsed form of the ClientHello, kept around across client_hello_cb
1374 CLIENTHELLO_MSG *clienthello;
1377 * no further mod of servername
1378 * 0 : call the servername extension callback.
1379 * 1 : prepare 2, allow last ack just after in server callback.
1380 * 2 : don't call servername callback, no ack in server hello
1382 int servername_done;
1383 # ifndef OPENSSL_NO_CT
1385 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1386 * If they are not, the connection should be aborted.
1388 ssl_ct_validation_cb ct_validation_callback;
1389 /* User-supplied argument that is passed to the ct_validation_callback */
1390 void *ct_validation_callback_arg;
1392 * Consolidated stack of SCTs from all sources.
1393 * Lazily populated by CT_get_peer_scts(SSL*)
1395 STACK_OF(SCT) *scts;
1396 /* Have we attempted to find/parse SCTs yet? */
1399 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1400 # ifndef OPENSSL_NO_SRTP
1402 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1403 /* What's been chosen */
1404 SRTP_PROTECTION_PROFILE *srtp_profile;
1407 * 1 if we are renegotiating.
1408 * 2 if we are a server and are inside a handshake
1409 * (i.e. not just sending a HelloRequest)
1412 /* If sending a KeyUpdate is pending */
1414 /* Post-handshake authentication state */
1415 SSL_PHA_STATE post_handshake_auth;
1417 uint8_t* pha_context;
1418 size_t pha_context_len;
1420 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1422 # ifndef OPENSSL_NO_SRP
1423 /* ctx for SRP authentication */
1427 * Callback for disabling session caching and ticket support on a session
1428 * basis, depending on the chosen cipher.
1430 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1431 RECORD_LAYER rlayer;
1432 /* Default password callback. */
1433 pem_password_cb *default_passwd_callback;
1434 /* Default password callback user data. */
1435 void *default_passwd_callback_userdata;
1436 /* Async Job info */
1438 ASYNC_WAIT_CTX *waitctx;
1442 * The maximum number of bytes advertised in session tickets that can be
1443 * sent as early data.
1445 uint32_t max_early_data;
1447 * The maximum number of bytes of early data that a server will tolerate
1448 * (which should be at least as much as max_early_data).
1450 uint32_t recv_max_early_data;
1453 * The number of bytes of early data received so far. If we accepted early
1454 * data then this is a count of the plaintext bytes. If we rejected it then
1455 * this is a count of the ciphertext bytes.
1457 uint32_t early_data_count;
1459 /* TLS1.3 padding callback */
1460 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1461 void *record_padding_arg;
1462 size_t block_padding;
1464 CRYPTO_RWLOCK *lock;
1466 /* The number of TLS1.3 tickets to automatically send */
1468 /* The number of TLS1.3 tickets actually sent so far */
1469 size_t sent_tickets;
1470 /* The next nonce value to use when we send a ticket on this connection */
1471 uint64_t next_ticket_nonce;
1473 /* Callback to determine if early_data is acceptable or not */
1474 SSL_allow_early_data_cb_fn allow_early_data_cb;
1475 void *allow_early_data_cb_data;
1478 * Signature algorithms shared by client and server: cached because these
1479 * are used most often.
1481 const struct sigalg_lookup_st **shared_sigalgs;
1482 size_t shared_sigalgslen;
1486 * Structure containing table entry of values associated with the signature
1487 * algorithms (signature scheme) extension
1489 typedef struct sigalg_lookup_st {
1490 /* TLS 1.3 signature scheme name */
1492 /* Raw value used in extension */
1494 /* NID of hash algorithm or NID_undef if no hash */
1496 /* Index of hash algorithm or -1 if no hash algorithm */
1498 /* NID of signature algorithm */
1500 /* Index of signature algorithm */
1502 /* Combined hash and signature NID, if any */
1504 /* Required public key curve (ECDSA only) */
1508 typedef struct tls_group_info_st {
1509 int nid; /* Curve NID */
1510 int secbits; /* Bits of security (from SP800-57) */
1511 uint16_t flags; /* Flags: currently just group type */
1515 # define TLS_CURVE_TYPE 0x3 /* Mask for group type */
1516 # define TLS_CURVE_PRIME 0x0
1517 # define TLS_CURVE_CHAR2 0x1
1518 # define TLS_CURVE_CUSTOM 0x2
1520 typedef struct cert_pkey_st CERT_PKEY;
1523 * Structure containing table entry of certificate info corresponding to
1527 int nid; /* NID of public key algorithm */
1528 uint32_t amask; /* authmask corresponding to key type */
1531 typedef struct ssl3_state_st {
1533 size_t read_mac_secret_size;
1534 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1535 size_t write_mac_secret_size;
1536 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1537 unsigned char server_random[SSL3_RANDOM_SIZE];
1538 unsigned char client_random[SSL3_RANDOM_SIZE];
1539 /* flags for countermeasure against known-IV weakness */
1540 int need_empty_fragments;
1541 int empty_fragment_done;
1542 /* used during startup, digest all incoming/outgoing packets */
1543 BIO *handshake_buffer;
1545 * When handshake digest is determined, buffer is hashed and
1546 * freed and MD_CTX for the required digest is stored here.
1548 EVP_MD_CTX *handshake_dgst;
1550 * Set whenever an expected ChangeCipherSpec message is processed.
1551 * Unset when the peer's Finished message is received.
1552 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1554 int change_cipher_spec;
1558 * we allow one fatal and one warning alert to be outstanding, send close
1559 * alert via the warning alert
1562 unsigned char send_alert[2];
1564 * This flag is set when we should renegotiate ASAP, basically when there
1565 * is no more data in the read or write buffers
1568 int total_renegotiations;
1569 int num_renegotiations;
1570 int in_read_app_data;
1572 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1573 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1574 size_t finish_md_len;
1575 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1576 size_t peer_finish_md_len;
1577 size_t message_size;
1579 /* used to hold the new cipher we are going to use */
1580 const SSL_CIPHER *new_cipher;
1581 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1582 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1584 /* used for certificate requests */
1586 /* Certificate types in certificate request message. */
1589 /* Certificate authorities list peer sent */
1590 STACK_OF(X509_NAME) *peer_ca_names;
1591 size_t key_block_length;
1592 unsigned char *key_block;
1593 const EVP_CIPHER *new_sym_enc;
1594 const EVP_MD *new_hash;
1595 int new_mac_pkey_type;
1596 size_t new_mac_secret_size;
1597 # ifndef OPENSSL_NO_COMP
1598 const SSL_COMP *new_compression;
1600 char *new_compression;
1603 /* Raw values of the cipher list from a client */
1604 unsigned char *ciphers_raw;
1605 size_t ciphers_rawlen;
1606 /* Temporary storage for premaster secret */
1609 # ifndef OPENSSL_NO_PSK
1610 /* Temporary storage for PSK key */
1614 /* Signature algorithm we actually use */
1615 const SIGALG_LOOKUP *sigalg;
1616 /* Pointer to certificate we use */
1619 * signature algorithms peer reports: e.g. supported signature
1620 * algorithms extension for server or as part of a certificate
1621 * request for client.
1622 * Keep track of the algorithms for TLS and X.509 usage separately.
1624 uint16_t *peer_sigalgs;
1625 uint16_t *peer_cert_sigalgs;
1626 /* Size of above arrays */
1627 size_t peer_sigalgslen;
1628 size_t peer_cert_sigalgslen;
1629 /* Sigalg peer actually uses */
1630 const SIGALG_LOOKUP *peer_sigalg;
1632 * Set if corresponding CERT_PKEY can be used with current
1633 * SSL session: e.g. appropriate curve, signature algorithms etc.
1634 * If zero it can't be used at all.
1636 uint32_t valid_flags[SSL_PKEY_NUM];
1638 * For servers the following masks are for the key and auth algorithms
1639 * that are supported by the certs below. For clients they are masks of
1640 * *disabled* algorithms based on the current session.
1645 * The following are used by the client to see if a cipher is allowed or
1646 * not. It contains the minimum and maximum version the client's using
1647 * based on what it knows so far.
1653 /* Connection binding to prevent renegotiation attacks */
1654 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1655 size_t previous_client_finished_len;
1656 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1657 size_t previous_server_finished_len;
1658 int send_connection_binding; /* TODOEKR */
1660 # ifndef OPENSSL_NO_NEXTPROTONEG
1662 * Set if we saw the Next Protocol Negotiation extension from our peer.
1668 * ALPN information (we are in the process of transitioning from NPN to
1673 * In a server these point to the selected ALPN protocol after the
1674 * ClientHello has been processed. In a client these contain the protocol
1675 * that the server selected once the ServerHello has been processed.
1677 unsigned char *alpn_selected;
1678 size_t alpn_selected_len;
1679 /* used by the server to know what options were proposed */
1680 unsigned char *alpn_proposed;
1681 size_t alpn_proposed_len;
1682 /* used by the client to know if it actually sent alpn */
1685 # ifndef OPENSSL_NO_EC
1687 * This is set to true if we believe that this is a version of Safari
1688 * running on OS X 10.6 or newer. We wish to know this because Safari on
1689 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1691 char is_probably_safari;
1692 # endif /* !OPENSSL_NO_EC */
1694 /* For clients: peer temporary key */
1695 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1696 /* The group_id for the DH/ECDH key */
1703 /* DTLS structures */
1705 # ifndef OPENSSL_NO_SCTP
1706 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1709 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1710 # define DTLS1_MAX_MTU_OVERHEAD 48
1713 * Flag used in message reuse to indicate the buffer contains the record
1714 * header as well as the handshake message header.
1716 # define DTLS1_SKIP_RECORD_HEADER 2
1718 struct dtls1_retransmit_state {
1719 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1720 EVP_MD_CTX *write_hash; /* used for mac generation */
1721 COMP_CTX *compress; /* compression */
1722 SSL_SESSION *session;
1723 unsigned short epoch;
1726 struct hm_header_st {
1732 unsigned int is_ccs;
1733 struct dtls1_retransmit_state saved_retransmit_state;
1736 struct dtls1_timeout_st {
1737 /* Number of read timeouts so far */
1738 unsigned int read_timeouts;
1739 /* Number of write timeouts so far */
1740 unsigned int write_timeouts;
1741 /* Number of alerts received so far */
1742 unsigned int num_alerts;
1745 typedef struct hm_fragment_st {
1746 struct hm_header_st msg_header;
1747 unsigned char *fragment;
1748 unsigned char *reassembly;
1751 typedef struct pqueue_st pqueue;
1752 typedef struct pitem_st pitem;
1755 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1760 typedef struct pitem_st *piterator;
1762 pitem *pitem_new(unsigned char *prio64be, void *data);
1763 void pitem_free(pitem *item);
1764 pqueue *pqueue_new(void);
1765 void pqueue_free(pqueue *pq);
1766 pitem *pqueue_insert(pqueue *pq, pitem *item);
1767 pitem *pqueue_peek(pqueue *pq);
1768 pitem *pqueue_pop(pqueue *pq);
1769 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1770 pitem *pqueue_iterator(pqueue *pq);
1771 pitem *pqueue_next(piterator *iter);
1772 size_t pqueue_size(pqueue *pq);
1774 typedef struct dtls1_state_st {
1775 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1777 unsigned int cookie_verified;
1778 /* handshake message numbers */
1779 unsigned short handshake_write_seq;
1780 unsigned short next_handshake_write_seq;
1781 unsigned short handshake_read_seq;
1782 /* Buffered handshake messages */
1783 pqueue *buffered_messages;
1784 /* Buffered (sent) handshake records */
1785 pqueue *sent_messages;
1786 size_t link_mtu; /* max on-the-wire DTLS packet size */
1787 size_t mtu; /* max DTLS packet size */
1788 struct hm_header_st w_msg_hdr;
1789 struct hm_header_st r_msg_hdr;
1790 struct dtls1_timeout_st timeout;
1792 * Indicates when the last handshake msg sent will timeout
1794 struct timeval next_timeout;
1795 /* Timeout duration */
1796 unsigned int timeout_duration_us;
1798 unsigned int retransmitting;
1799 # ifndef OPENSSL_NO_SCTP
1800 int shutdown_received;
1803 DTLS_timer_cb timer_cb;
1807 # ifndef OPENSSL_NO_EC
1809 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1811 # define EXPLICIT_PRIME_CURVE_TYPE 1
1812 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1813 # define NAMED_CURVE_TYPE 3
1814 # endif /* OPENSSL_NO_EC */
1816 struct cert_pkey_st {
1818 EVP_PKEY *privatekey;
1819 /* Chain for this certificate */
1820 STACK_OF(X509) *chain;
1822 * serverinfo data for this certificate. The data is in TLS Extension
1823 * wire format, specifically it's a series of records like:
1824 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1826 * uint8_t data[length];
1828 unsigned char *serverinfo;
1829 size_t serverinfo_length;
1831 /* Retrieve Suite B flags */
1832 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1833 /* Uses to check strict mode: suite B modes are always strict */
1834 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1835 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1838 ENDPOINT_CLIENT = 0,
1845 unsigned short ext_type;
1847 /* The context which this extension applies to */
1848 unsigned int context;
1850 * Per-connection flags relating to this extension type: not used if
1851 * part of an SSL_CTX structure.
1854 SSL_custom_ext_add_cb_ex add_cb;
1855 SSL_custom_ext_free_cb_ex free_cb;
1857 SSL_custom_ext_parse_cb_ex parse_cb;
1859 } custom_ext_method;
1861 /* ext_flags values */
1864 * Indicates an extension has been received. Used to check for unsolicited or
1865 * duplicate extensions.
1867 # define SSL_EXT_FLAG_RECEIVED 0x1
1869 * Indicates an extension has been sent: used to enable sending of
1870 * corresponding ServerHello extension.
1872 # define SSL_EXT_FLAG_SENT 0x2
1875 custom_ext_method *meths;
1877 } custom_ext_methods;
1879 typedef struct cert_st {
1880 /* Current active set */
1882 * ALWAYS points to an element of the pkeys array
1883 * Probably it would make more sense to store
1884 * an index, not a pointer.
1887 # ifndef OPENSSL_NO_DH
1889 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1892 /* Flags related to certificates */
1893 uint32_t cert_flags;
1894 CERT_PKEY pkeys[SSL_PKEY_NUM];
1895 /* Custom certificate types sent in certificate request message. */
1899 * supported signature algorithms. When set on a client this is sent in
1900 * the client hello as the supported signature algorithms extension. For
1901 * servers it represents the signature algorithms we are willing to use.
1903 uint16_t *conf_sigalgs;
1904 /* Size of above array */
1905 size_t conf_sigalgslen;
1907 * Client authentication signature algorithms, if not set then uses
1908 * conf_sigalgs. On servers these will be the signature algorithms sent
1909 * to the client in a certificate request for TLS 1.2. On a client this
1910 * represents the signature algorithms we are willing to use for client
1913 uint16_t *client_sigalgs;
1914 /* Size of above array */
1915 size_t client_sigalgslen;
1917 * Certificate setup callback: if set is called whenever a certificate
1918 * may be required (client or server). the callback can then examine any
1919 * appropriate parameters and setup any certificates required. This
1920 * allows advanced applications to select certificates on the fly: for
1921 * example based on supported signature algorithms or curves.
1923 int (*cert_cb) (SSL *ssl, void *arg);
1926 * Optional X509_STORE for chain building or certificate validation If
1927 * NULL the parent SSL_CTX store is used instead.
1929 X509_STORE *chain_store;
1930 X509_STORE *verify_store;
1931 /* Custom extensions */
1932 custom_ext_methods custext;
1933 /* Security callback */
1934 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1935 void *other, void *ex);
1936 /* Security level */
1939 # ifndef OPENSSL_NO_PSK
1940 /* If not NULL psk identity hint to use for servers */
1941 char *psk_identity_hint;
1943 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1944 CRYPTO_RWLOCK *lock;
1947 # define FP_ICC (int (*)(const void *,const void *))
1950 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1951 * of a mess of functions, but hell, think of it as an opaque structure :-)
1953 typedef struct ssl3_enc_method {
1954 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1955 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1956 int (*setup_key_block) (SSL *);
1957 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1959 int (*change_cipher_state) (SSL *, int);
1960 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1961 const char *client_finished_label;
1962 size_t client_finished_label_len;
1963 const char *server_finished_label;
1964 size_t server_finished_label_len;
1965 int (*alert_value) (int);
1966 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1967 const char *, size_t,
1968 const unsigned char *, size_t,
1970 /* Various flags indicating protocol version requirements */
1972 /* Set the handshake header */
1973 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1974 /* Close construction of the handshake message */
1975 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1976 /* Write out handshake message */
1977 int (*do_write) (SSL *s);
1980 # define ssl_set_handshake_header(s, pkt, htype) \
1981 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1982 # define ssl_close_construct_packet(s, pkt, htype) \
1983 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1984 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1986 /* Values for enc_flags */
1988 /* Uses explicit IV for CBC mode */
1989 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1990 /* Uses signature algorithms extension */
1991 # define SSL_ENC_FLAG_SIGALGS 0x2
1992 /* Uses SHA256 default PRF */
1993 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1995 # define SSL_ENC_FLAG_DTLS 0x8
1997 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1998 * apply to others in future.
2000 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2002 # ifndef OPENSSL_NO_COMP
2003 /* Used for holding the relevant compression methods loaded into SSL_CTX */
2004 typedef struct ssl3_comp_st {
2005 int comp_id; /* The identifier byte for this compression
2007 char *name; /* Text name used for the compression type */
2008 COMP_METHOD *method; /* The method :-) */
2012 typedef enum downgrade_en {
2019 * Dummy status type for the status_type extension. Indicates no status type
2022 #define TLSEXT_STATUSTYPE_nothing -1
2024 /* Sigalgs values */
2025 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2026 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2027 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2028 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2029 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2030 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2031 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2032 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2033 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2034 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2035 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2036 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2037 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2038 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2039 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2040 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2041 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2042 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2043 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2044 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2045 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2046 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2047 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2048 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2050 #define TLSEXT_SIGALG_ed25519 0x0807
2051 #define TLSEXT_SIGALG_ed448 0x0808
2053 /* Known PSK key exchange modes */
2054 #define TLSEXT_KEX_MODE_KE 0x00
2055 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2058 * Internal representations of key exchange modes
2060 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2061 #define TLSEXT_KEX_MODE_FLAG_KE 1
2062 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2064 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
2065 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2067 /* A dummy signature value not valid for TLSv1.2 signature algs */
2068 #define TLSEXT_signature_rsa_pss 0x0101
2070 /* TLSv1.3 downgrade protection sentinel values */
2071 extern const unsigned char tls11downgrade[8];
2072 extern const unsigned char tls12downgrade[8];
2074 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2076 __owur const SSL_METHOD *ssl_bad_method(int ver);
2077 __owur const SSL_METHOD *sslv3_method(void);
2078 __owur const SSL_METHOD *sslv3_server_method(void);
2079 __owur const SSL_METHOD *sslv3_client_method(void);
2080 __owur const SSL_METHOD *tlsv1_method(void);
2081 __owur const SSL_METHOD *tlsv1_server_method(void);
2082 __owur const SSL_METHOD *tlsv1_client_method(void);
2083 __owur const SSL_METHOD *tlsv1_1_method(void);
2084 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2085 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2086 __owur const SSL_METHOD *tlsv1_2_method(void);
2087 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2088 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2089 __owur const SSL_METHOD *tlsv1_3_method(void);
2090 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2091 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2092 __owur const SSL_METHOD *dtlsv1_method(void);
2093 __owur const SSL_METHOD *dtlsv1_server_method(void);
2094 __owur const SSL_METHOD *dtlsv1_client_method(void);
2095 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2096 __owur const SSL_METHOD *dtlsv1_2_method(void);
2097 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2098 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2100 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2101 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2102 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2103 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2104 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2105 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2106 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2109 * Flags for SSL methods
2111 # define SSL_METHOD_NO_FIPS (1U<<0)
2112 # define SSL_METHOD_NO_SUITEB (1U<<1)
2114 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2115 s_connect, enc_data) \
2116 const SSL_METHOD *func_name(void) \
2118 static const SSL_METHOD func_name##_data= { \
2132 ssl3_renegotiate_check, \
2135 ssl3_dispatch_alert, \
2138 ssl3_get_cipher_by_char, \
2139 ssl3_put_cipher_by_char, \
2143 tls1_default_timeout, \
2145 ssl_undefined_void_function, \
2146 ssl3_callback_ctrl, \
2147 ssl3_ctx_callback_ctrl, \
2149 return &func_name##_data; \
2152 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2153 const SSL_METHOD *func_name(void) \
2155 static const SSL_METHOD func_name##_data= { \
2157 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2169 ssl3_renegotiate_check, \
2172 ssl3_dispatch_alert, \
2175 ssl3_get_cipher_by_char, \
2176 ssl3_put_cipher_by_char, \
2180 ssl3_default_timeout, \
2182 ssl_undefined_void_function, \
2183 ssl3_callback_ctrl, \
2184 ssl3_ctx_callback_ctrl, \
2186 return &func_name##_data; \
2189 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2190 s_connect, enc_data) \
2191 const SSL_METHOD *func_name(void) \
2193 static const SSL_METHOD func_name##_data= { \
2207 ssl3_renegotiate_check, \
2209 dtls1_write_app_data_bytes, \
2210 dtls1_dispatch_alert, \
2213 ssl3_get_cipher_by_char, \
2214 ssl3_put_cipher_by_char, \
2218 dtls1_default_timeout, \
2220 ssl_undefined_void_function, \
2221 ssl3_callback_ctrl, \
2222 ssl3_ctx_callback_ctrl, \
2224 return &func_name##_data; \
2227 struct openssl_ssl_test_functions {
2228 int (*p_ssl_init_wbio_buffer) (SSL *s);
2229 int (*p_ssl3_setup_buffers) (SSL *s);
2232 const char *ssl_protocol_to_string(int version);
2234 /* Returns true if certificate and private key for 'idx' are present */
2235 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2237 if (idx < 0 || idx >= SSL_PKEY_NUM)
2239 return s->cert->pkeys[idx].x509 != NULL
2240 && s->cert->pkeys[idx].privatekey != NULL;
2243 static ossl_inline void tls1_get_peer_groups(SSL *s, const uint16_t **pgroups,
2246 *pgroups = s->ext.peer_supportedgroups;
2247 *pgroupslen = s->ext.peer_supportedgroups_len;
2250 # ifndef OPENSSL_UNIT_TEST
2252 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2253 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2254 void ssl_clear_cipher_ctx(SSL *s);
2255 int ssl_clear_bad_session(SSL *s);
2256 __owur CERT *ssl_cert_new(void);
2257 __owur CERT *ssl_cert_dup(CERT *cert);
2258 void ssl_cert_clear_certs(CERT *c);
2259 void ssl_cert_free(CERT *c);
2260 __owur int ssl_generate_session_id(SSL *s, SSL_SESSION *ss);
2261 __owur int ssl_get_new_session(SSL *s, int session);
2262 __owur SSL_SESSION *lookup_sess_in_cache(SSL *s, const unsigned char *sess_id,
2263 size_t sess_id_len);
2264 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello);
2265 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2266 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2267 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2268 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2269 const SSL_CIPHER *const *bp);
2270 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
2271 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2272 STACK_OF(SSL_CIPHER) **cipher_list,
2273 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2274 const char *rule_str,
2276 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format);
2277 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2278 STACK_OF(SSL_CIPHER) **skp,
2279 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2281 void ssl_update_cache(SSL *s, int mode);
2282 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2283 const EVP_MD **md, int *mac_pkey_type,
2284 size_t *mac_secret_size, SSL_COMP **comp,
2286 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2287 size_t *int_overhead, size_t *blocksize,
2288 size_t *ext_overhead);
2289 __owur int ssl_cert_is_disabled(size_t idx);
2290 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2291 const unsigned char *ptr,
2293 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2294 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2295 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2296 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2297 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2298 __owur int ssl_cert_set_current(CERT *c, long arg);
2299 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2301 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2302 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2303 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2306 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2307 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2310 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx);
2311 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2313 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2315 int ssl_undefined_function(SSL *s);
2316 __owur int ssl_undefined_void_function(void);
2317 __owur int ssl_undefined_const_function(const SSL *s);
2318 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2319 const unsigned char **serverinfo,
2320 size_t *serverinfo_length);
2321 void ssl_set_masks(SSL *s);
2322 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2323 __owur int ssl_x509err2alert(int type);
2324 void ssl_sort_cipher_list(void);
2325 int ssl_load_ciphers(void);
2326 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2327 size_t len, DOWNGRADE dgrd);
2328 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2330 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2331 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2333 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2334 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl);
2335 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl);
2337 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2338 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2339 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2340 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2342 int ssl3_init_finished_mac(SSL *s);
2343 __owur int ssl3_setup_key_block(SSL *s);
2344 __owur int ssl3_change_cipher_state(SSL *s, int which);
2345 void ssl3_cleanup_key_block(SSL *s);
2346 __owur int ssl3_do_write(SSL *s, int type);
2347 int ssl3_send_alert(SSL *s, int level, int desc);
2348 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2349 unsigned char *p, size_t len,
2350 size_t *secret_size);
2351 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2352 __owur int ssl3_num_ciphers(void);
2353 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2354 int ssl3_renegotiate(SSL *ssl);
2355 int ssl3_renegotiate_check(SSL *ssl, int initok);
2356 __owur int ssl3_dispatch_alert(SSL *s);
2357 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2359 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2360 void ssl3_free_digest_list(SSL *s);
2361 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2363 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2364 STACK_OF(SSL_CIPHER) *clnt,
2365 STACK_OF(SSL_CIPHER) *srvr);
2366 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2367 __owur int ssl3_new(SSL *s);
2368 void ssl3_free(SSL *s);
2369 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2370 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2371 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2372 __owur int ssl3_shutdown(SSL *s);
2373 int ssl3_clear(SSL *s);
2374 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2375 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2376 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2377 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2379 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2380 __owur long ssl3_default_timeout(void);
2382 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2383 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2384 __owur int tls_setup_handshake(SSL *s);
2385 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2386 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2387 __owur int ssl3_handshake_write(SSL *s);
2389 __owur int ssl_allow_compression(SSL *s);
2391 __owur int ssl_version_supported(const SSL *s, int version,
2392 const SSL_METHOD **meth);
2394 __owur int ssl_set_client_hello_version(SSL *s);
2395 __owur int ssl_check_version_downgrade(SSL *s);
2396 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2397 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2399 __owur int ssl_choose_client_version(SSL *s, int version,
2400 RAW_EXTENSION *extensions);
2401 __owur int ssl_get_min_max_version(const SSL *s, int *min_version,
2402 int *max_version, int *real_max);
2404 __owur long tls1_default_timeout(void);
2405 __owur int dtls1_do_write(SSL *s, int type);
2406 void dtls1_set_message_header(SSL *s,
2409 size_t frag_off, size_t frag_len);
2411 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2414 __owur int dtls1_read_failed(SSL *s, int code);
2415 __owur int dtls1_buffer_message(SSL *s, int ccs);
2416 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2417 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2418 int dtls1_retransmit_buffered_messages(SSL *s);
2419 void dtls1_clear_received_buffer(SSL *s);
2420 void dtls1_clear_sent_buffer(SSL *s);
2421 void dtls1_get_message_header(unsigned char *data,
2422 struct hm_header_st *msg_hdr);
2423 __owur long dtls1_default_timeout(void);
2424 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2425 __owur int dtls1_check_timeout_num(SSL *s);
2426 __owur int dtls1_handle_timeout(SSL *s);
2427 void dtls1_start_timer(SSL *s);
2428 void dtls1_stop_timer(SSL *s);
2429 __owur int dtls1_is_timer_expired(SSL *s);
2430 void dtls1_double_timeout(SSL *s);
2431 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2433 __owur size_t dtls1_min_mtu(SSL *s);
2434 void dtls1_hm_fragment_free(hm_fragment *frag);
2435 __owur int dtls1_query_mtu(SSL *s);
2437 __owur int tls1_new(SSL *s);
2438 void tls1_free(SSL *s);
2439 int tls1_clear(SSL *s);
2441 __owur int dtls1_new(SSL *s);
2442 void dtls1_free(SSL *s);
2443 int dtls1_clear(SSL *s);
2444 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2445 __owur int dtls1_shutdown(SSL *s);
2447 __owur int dtls1_dispatch_alert(SSL *s);
2449 __owur int ssl_init_wbio_buffer(SSL *s);
2450 int ssl_free_wbio_buffer(SSL *s);
2452 __owur int tls1_change_cipher_state(SSL *s, int which);
2453 __owur int tls1_setup_key_block(SSL *s);
2454 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2456 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2457 unsigned char *p, size_t len,
2458 size_t *secret_size);
2459 __owur int tls13_setup_key_block(SSL *s);
2460 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2462 __owur int tls13_change_cipher_state(SSL *s, int which);
2463 __owur int tls13_update_key(SSL *s, int send);
2464 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2465 const unsigned char *secret,
2466 const unsigned char *label, size_t labellen,
2467 const unsigned char *data, size_t datalen,
2468 unsigned char *out, size_t outlen, int fatal);
2469 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2470 const unsigned char *secret, unsigned char *key,
2472 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2473 const unsigned char *secret, unsigned char *iv,
2475 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2476 const unsigned char *secret,
2477 unsigned char *fin, size_t finlen);
2478 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2479 const unsigned char *prevsecret,
2480 const unsigned char *insecret,
2482 unsigned char *outsecret);
2483 __owur int tls13_generate_handshake_secret(SSL *s,
2484 const unsigned char *insecret,
2485 size_t insecretlen);
2486 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2487 unsigned char *prev, size_t prevlen,
2488 size_t *secret_size);
2489 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2490 const char *label, size_t llen,
2491 const unsigned char *p, size_t plen,
2493 __owur int tls13_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2494 const char *label, size_t llen,
2495 const unsigned char *context,
2496 size_t contextlen, int use_context);
2497 __owur int tls13_export_keying_material_early(SSL *s, unsigned char *out,
2498 size_t olen, const char *label,
2500 const unsigned char *context,
2502 __owur int tls1_alert_code(int code);
2503 __owur int tls13_alert_code(int code);
2504 __owur int ssl3_alert_code(int code);
2506 # ifndef OPENSSL_NO_EC
2507 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2510 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2512 # ifndef OPENSSL_NO_EC
2514 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(uint16_t curve_id);
2515 __owur int tls1_check_group_id(SSL *s, uint16_t group_id, int check_own_curves);
2516 __owur uint16_t tls1_shared_group(SSL *s, int nmatch);
2517 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2518 int *curves, size_t ncurves);
2519 __owur int tls1_set_groups_list(uint16_t **pext, size_t *pextlen,
2521 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2522 size_t *num_formats);
2523 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2524 __owur EVP_PKEY *ssl_generate_pkey_group(SSL *s, uint16_t id);
2525 __owur EVP_PKEY *ssl_generate_param_group(uint16_t id);
2526 # endif /* OPENSSL_NO_EC */
2528 __owur int tls_curve_allowed(SSL *s, uint16_t curve, int op);
2529 void tls1_get_supported_groups(SSL *s, const uint16_t **pgroups,
2530 size_t *pgroupslen);
2532 __owur int tls1_set_server_sigalgs(SSL *s);
2534 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2536 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2538 const unsigned char *sess_id,
2539 size_t sesslen, SSL_SESSION **psess);
2541 __owur int tls_use_ticket(SSL *s);
2543 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2545 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2546 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2548 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2550 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2552 void tls1_set_cert_validity(SSL *s);
2554 # ifndef OPENSSL_NO_CT
2555 __owur int ssl_validate_ct(SSL *s);
2558 # ifndef OPENSSL_NO_DH
2559 __owur DH *ssl_get_auto_dh(SSL *s);
2562 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2563 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2566 int tls_choose_sigalg(SSL *s, int fatalerrs);
2568 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2569 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2570 __owur long ssl_get_algorithm2(SSL *s);
2571 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2572 const uint16_t *psig, size_t psiglen);
2573 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2574 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt, int cert);
2575 __owur int tls1_process_sigalgs(SSL *s);
2576 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2577 __owur int tls1_lookup_md(const SIGALG_LOOKUP *lu, const EVP_MD **pmd);
2578 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2579 # ifndef OPENSSL_NO_EC
2580 __owur int tls_check_sigalg_curve(const SSL *s, int curve);
2582 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2583 __owur int ssl_set_client_disabled(SSL *s);
2584 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op, int echde);
2586 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2588 __owur const EVP_MD *ssl_md(int idx);
2589 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2590 __owur const EVP_MD *ssl_prf_md(SSL *s);
2593 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2594 * with |ssl|, if logging is enabled. It returns one on success and zero on
2595 * failure. The entry is identified by the first 8 bytes of
2596 * |encrypted_premaster|.
2598 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2599 const uint8_t *encrypted_premaster,
2600 size_t encrypted_premaster_len,
2601 const uint8_t *premaster,
2602 size_t premaster_len);
2605 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2606 * logging is available. It returns one on success and zero on failure. It tags
2607 * the entry with |label|.
2609 __owur int ssl_log_secret(SSL *ssl, const char *label,
2610 const uint8_t *secret, size_t secret_len);
2612 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2613 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2614 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2615 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2616 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2617 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2618 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2619 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2622 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2623 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2624 unsigned char *md_out,
2625 size_t *md_out_size,
2626 const unsigned char header[13],
2627 const unsigned char *data,
2628 size_t data_plus_mac_size,
2629 size_t data_plus_mac_plus_padding_size,
2630 const unsigned char *mac_secret,
2631 size_t mac_secret_length, char is_sslv3);
2633 __owur int srp_generate_server_master_secret(SSL *s);
2634 __owur int srp_generate_client_master_secret(SSL *s);
2635 __owur int srp_verify_server_param(SSL *s);
2637 /* statem/statem_srvr.c */
2639 __owur int send_certificate_request(SSL *s);
2641 /* statem/extensions_cust.c */
2643 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2644 ENDPOINT role, unsigned int ext_type,
2647 void custom_ext_init(custom_ext_methods *meths);
2649 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2650 const unsigned char *ext_data, size_t ext_size,
2651 X509 *x, size_t chainidx);
2652 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2653 size_t chainidx, int maxversion);
2655 __owur int custom_exts_copy(custom_ext_methods *dst,
2656 const custom_ext_methods *src);
2657 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2658 const custom_ext_methods *src);
2659 void custom_exts_free(custom_ext_methods *exts);
2661 void ssl_comp_free_compression_methods_int(void);
2664 void ssl_ctx_system_config(SSL_CTX *ctx);
2666 # else /* OPENSSL_UNIT_TEST */
2668 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2669 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers