2 * Copyright 1995-2018 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_locl.h"
34 # include "internal/dane.h"
35 # include "internal/refcount.h"
37 # ifdef OPENSSL_BUILD_SHLIBSSL
38 # undef OPENSSL_EXTERN
39 # define OPENSSL_EXTERN OPENSSL_EXPORT
42 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
43 l|=(((unsigned long)(*((c)++)))<< 8), \
44 l|=(((unsigned long)(*((c)++)))<<16), \
45 l|=(((unsigned long)(*((c)++)))<<24))
47 /* NOTE - c is not incremented as per c2l */
48 # define c2ln(c,l1,l2,n) { \
52 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
53 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
54 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
55 case 5: l2|=((unsigned long)(*(--(c)))); \
56 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
57 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
58 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
59 case 1: l1|=((unsigned long)(*(--(c)))); \
63 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
64 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
65 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
66 *((c)++)=(unsigned char)(((l)>>24)&0xff))
68 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
69 l|=((unsigned long)(*((c)++)))<<16, \
70 l|=((unsigned long)(*((c)++)))<< 8, \
71 l|=((unsigned long)(*((c)++))))
73 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
74 l|=((uint64_t)(*((c)++)))<<48, \
75 l|=((uint64_t)(*((c)++)))<<40, \
76 l|=((uint64_t)(*((c)++)))<<32, \
77 l|=((uint64_t)(*((c)++)))<<24, \
78 l|=((uint64_t)(*((c)++)))<<16, \
79 l|=((uint64_t)(*((c)++)))<< 8, \
80 l|=((uint64_t)(*((c)++))))
83 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
84 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
85 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
86 *((c)++)=(unsigned char)(((l) )&0xff))
88 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
89 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
90 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
91 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
92 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
93 *((c)++)=(unsigned char)(((l) )&0xff))
95 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
96 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
97 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
98 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
99 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
101 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
102 *((c)++)=(unsigned char)(((l) )&0xff))
104 /* NOTE - c is not incremented as per l2c */
105 # define l2cn(l1,l2,c,n) { \
108 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
109 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
110 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
111 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
112 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
113 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
114 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
115 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
119 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
120 (((unsigned int)((c)[1])) )),(c)+=2)
121 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
122 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
124 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
125 (((unsigned long)((c)[1]))<< 8)| \
126 (((unsigned long)((c)[2])) )),(c)+=3)
128 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
129 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
130 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
133 * DTLS version numbers are strange because they're inverted. Except for
134 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
136 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
137 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
138 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
139 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
140 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
144 * Define the Bitmasks for SSL_CIPHER.algorithms.
145 * This bits are used packed as dense as possible. If new methods/ciphers
146 * etc will be added, the bits a likely to change, so this information
147 * is for internal library use only, even though SSL_CIPHER.algorithms
148 * can be publicly accessed.
149 * Use the according functions for cipher management instead.
151 * The bit mask handling in the selection and sorting scheme in
152 * ssl_create_cipher_list() has only limited capabilities, reflecting
153 * that the different entities within are mutually exclusive:
154 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
157 /* Bits for algorithm_mkey (key exchange algorithm) */
158 /* RSA key exchange */
159 # define SSL_kRSA 0x00000001U
160 /* tmp DH key no DH cert */
161 # define SSL_kDHE 0x00000002U
163 # define SSL_kEDH SSL_kDHE
165 # define SSL_kECDHE 0x00000004U
167 # define SSL_kEECDH SSL_kECDHE
169 # define SSL_kPSK 0x00000008U
170 /* GOST key exchange */
171 # define SSL_kGOST 0x00000010U
173 # define SSL_kSRP 0x00000020U
175 # define SSL_kRSAPSK 0x00000040U
176 # define SSL_kECDHEPSK 0x00000080U
177 # define SSL_kDHEPSK 0x00000100U
181 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
183 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
184 # define SSL_kANY 0x00000000U
186 /* Bits for algorithm_auth (server authentication) */
188 # define SSL_aRSA 0x00000001U
190 # define SSL_aDSS 0x00000002U
191 /* no auth (i.e. use ADH or AECDH) */
192 # define SSL_aNULL 0x00000004U
194 # define SSL_aECDSA 0x00000008U
196 # define SSL_aPSK 0x00000010U
197 /* GOST R 34.10-2001 signature auth */
198 # define SSL_aGOST01 0x00000020U
200 # define SSL_aSRP 0x00000040U
201 /* GOST R 34.10-2012 signature auth */
202 # define SSL_aGOST12 0x00000080U
203 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
204 # define SSL_aANY 0x00000000U
205 /* All bits requiring a certificate */
207 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
209 /* Bits for algorithm_enc (symmetric encryption) */
210 # define SSL_DES 0x00000001U
211 # define SSL_3DES 0x00000002U
212 # define SSL_RC4 0x00000004U
213 # define SSL_RC2 0x00000008U
214 # define SSL_IDEA 0x00000010U
215 # define SSL_eNULL 0x00000020U
216 # define SSL_AES128 0x00000040U
217 # define SSL_AES256 0x00000080U
218 # define SSL_CAMELLIA128 0x00000100U
219 # define SSL_CAMELLIA256 0x00000200U
220 # define SSL_eGOST2814789CNT 0x00000400U
221 # define SSL_SEED 0x00000800U
222 # define SSL_AES128GCM 0x00001000U
223 # define SSL_AES256GCM 0x00002000U
224 # define SSL_AES128CCM 0x00004000U
225 # define SSL_AES256CCM 0x00008000U
226 # define SSL_AES128CCM8 0x00010000U
227 # define SSL_AES256CCM8 0x00020000U
228 # define SSL_eGOST2814789CNT12 0x00040000U
229 # define SSL_CHACHA20POLY1305 0x00080000U
230 # define SSL_ARIA128GCM 0x00100000U
231 # define SSL_ARIA256GCM 0x00200000U
233 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
234 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
235 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
236 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
237 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
238 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
239 # define SSL_ARIA (SSL_ARIAGCM)
241 /* Bits for algorithm_mac (symmetric authentication) */
243 # define SSL_MD5 0x00000001U
244 # define SSL_SHA1 0x00000002U
245 # define SSL_GOST94 0x00000004U
246 # define SSL_GOST89MAC 0x00000008U
247 # define SSL_SHA256 0x00000010U
248 # define SSL_SHA384 0x00000020U
249 /* Not a real MAC, just an indication it is part of cipher */
250 # define SSL_AEAD 0x00000040U
251 # define SSL_GOST12_256 0x00000080U
252 # define SSL_GOST89MAC12 0x00000100U
253 # define SSL_GOST12_512 0x00000200U
256 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
257 * sure to update this constant too
260 # define SSL_MD_MD5_IDX 0
261 # define SSL_MD_SHA1_IDX 1
262 # define SSL_MD_GOST94_IDX 2
263 # define SSL_MD_GOST89MAC_IDX 3
264 # define SSL_MD_SHA256_IDX 4
265 # define SSL_MD_SHA384_IDX 5
266 # define SSL_MD_GOST12_256_IDX 6
267 # define SSL_MD_GOST89MAC12_IDX 7
268 # define SSL_MD_GOST12_512_IDX 8
269 # define SSL_MD_MD5_SHA1_IDX 9
270 # define SSL_MD_SHA224_IDX 10
271 # define SSL_MD_SHA512_IDX 11
272 # define SSL_MAX_DIGEST 12
274 /* Bits for algorithm2 (handshake digests and other extra flags) */
276 /* Bits 0-7 are handshake MAC */
277 # define SSL_HANDSHAKE_MAC_MASK 0xFF
278 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
279 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
280 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
281 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
282 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
283 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
284 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
286 /* Bits 8-15 bits are PRF */
287 # define TLS1_PRF_DGST_SHIFT 8
288 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
289 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
290 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
291 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
292 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
293 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
294 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
297 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
298 * goes into algorithm2)
300 # define TLS1_STREAM_MAC 0x10000
302 # define SSL_STRONG_MASK 0x0000001FU
303 # define SSL_DEFAULT_MASK 0X00000020U
305 # define SSL_STRONG_NONE 0x00000001U
306 # define SSL_LOW 0x00000002U
307 # define SSL_MEDIUM 0x00000004U
308 # define SSL_HIGH 0x00000008U
309 # define SSL_FIPS 0x00000010U
310 # define SSL_NOT_DEFAULT 0x00000020U
312 /* we have used 0000003f - 26 bits left to go */
314 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
315 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
317 /* Check if an SSL structure is using DTLS */
318 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
320 /* Check if we are using TLSv1.3 */
321 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
322 && (s)->method->version >= TLS1_3_VERSION \
323 && (s)->method->version != TLS_ANY_VERSION)
325 # define SSL_TREAT_AS_TLS13(s) \
326 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
327 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
328 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
329 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
330 || (s)->hello_retry_request == SSL_HRR_PENDING)
332 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0 \
333 || (s)->s3->tmp.peer_finish_md_len == 0)
335 /* See if we need explicit IV */
336 # define SSL_USE_EXPLICIT_IV(s) \
337 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
339 * See if we use signature algorithms extension and signature algorithm
342 # define SSL_USE_SIGALGS(s) \
343 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
345 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
346 * apply to others in future.
348 # define SSL_USE_TLS1_2_CIPHERS(s) \
349 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
351 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
352 * flags because it may not be set to correct version yet.
354 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
355 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
356 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
358 * Determine if a client should send signature algorithms extension:
359 * as with TLS1.2 cipher we can't rely on method flags.
361 # define SSL_CLIENT_USE_SIGALGS(s) \
362 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
364 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
365 (((value) >= TLSEXT_max_fragment_length_512) && \
366 ((value) <= TLSEXT_max_fragment_length_4096))
367 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
368 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
369 # define GET_MAX_FRAGMENT_LENGTH(session) \
370 (512U << (session->ext.max_fragment_len_mode - 1))
372 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
373 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
375 /* Mostly for SSLv3 */
376 # define SSL_PKEY_RSA 0
377 # define SSL_PKEY_RSA_PSS_SIGN 1
378 # define SSL_PKEY_DSA_SIGN 2
379 # define SSL_PKEY_ECC 3
380 # define SSL_PKEY_GOST01 4
381 # define SSL_PKEY_GOST12_256 5
382 # define SSL_PKEY_GOST12_512 6
383 # define SSL_PKEY_ED25519 7
384 # define SSL_PKEY_ED448 8
385 # define SSL_PKEY_NUM 9
387 * Pseudo-constant. GOST cipher suites can use different certs for 1
388 * SSL_CIPHER. So let's see which one we have in fact.
390 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
393 * SSL_kRSA <- RSA_ENC
394 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
395 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
396 * SSL_aRSA <- RSA_ENC | RSA_SIGN
397 * SSL_aDSS <- DSA_SIGN
401 #define CERT_INVALID 0
402 #define CERT_PUBLIC_KEY 1
403 #define CERT_PRIVATE_KEY 2
406 /* Post-Handshake Authentication state */
409 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
410 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
411 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
412 SSL_PHA_REQUESTED /* request received by client, or sent by server */
415 /* CipherSuite length. SSLv3 and all TLS versions. */
416 # define TLS_CIPHER_LEN 2
417 /* used to hold info on the particular ciphers used */
418 struct ssl_cipher_st {
420 const char *name; /* text name */
421 const char *stdname; /* RFC name */
422 uint32_t id; /* id, 4 bytes, first is version */
424 * changed in 1.0.0: these four used to be portions of a single value
427 uint32_t algorithm_mkey; /* key exchange algorithm */
428 uint32_t algorithm_auth; /* server authentication */
429 uint32_t algorithm_enc; /* symmetric encryption */
430 uint32_t algorithm_mac; /* symmetric authentication */
431 int min_tls; /* minimum SSL/TLS protocol version */
432 int max_tls; /* maximum SSL/TLS protocol version */
433 int min_dtls; /* minimum DTLS protocol version */
434 int max_dtls; /* maximum DTLS protocol version */
435 uint32_t algo_strength; /* strength and export flags */
436 uint32_t algorithm2; /* Extra flags */
437 int32_t strength_bits; /* Number of bits really used */
438 uint32_t alg_bits; /* Number of bits for algorithm */
441 /* Used to hold SSL/TLS functions */
442 struct ssl_method_st {
446 int (*ssl_new) (SSL *s);
447 int (*ssl_clear) (SSL *s);
448 void (*ssl_free) (SSL *s);
449 int (*ssl_accept) (SSL *s);
450 int (*ssl_connect) (SSL *s);
451 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
452 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
453 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
454 int (*ssl_shutdown) (SSL *s);
455 int (*ssl_renegotiate) (SSL *s);
456 int (*ssl_renegotiate_check) (SSL *s, int);
457 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
458 unsigned char *buf, size_t len, int peek,
460 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
462 int (*ssl_dispatch_alert) (SSL *s);
463 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
464 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
465 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
466 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
468 size_t (*ssl_pending) (const SSL *s);
469 int (*num_ciphers) (void);
470 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
471 long (*get_timeout) (void);
472 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
473 int (*ssl_version) (void);
474 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
475 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
479 * Lets make this into an ASN.1 type structure as follows
480 * SSL_SESSION_ID ::= SEQUENCE {
481 * version INTEGER, -- structure version number
482 * SSLversion INTEGER, -- SSL version number
483 * Cipher OCTET STRING, -- the 3 byte cipher ID
484 * Session_ID OCTET STRING, -- the Session ID
485 * Master_key OCTET STRING, -- the master key
486 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
487 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
488 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
489 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
490 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
491 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
492 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
493 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
494 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
495 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
496 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
497 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
498 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
499 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
501 * Look in ssl/ssl_asn1.c for more details
502 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
504 struct ssl_session_st {
505 int ssl_version; /* what ssl version session info is being kept
507 size_t master_key_length;
509 /* TLSv1.3 early_secret used for external PSKs */
510 unsigned char early_secret[EVP_MAX_MD_SIZE];
512 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
515 unsigned char master_key[TLS13_MAX_RESUMPTION_MASTER_LENGTH];
516 /* session_id - valid? */
517 size_t session_id_length;
518 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
520 * this is used to determine whether the session is being reused in the
521 * appropriate context. It is up to the application to set this, via
524 size_t sid_ctx_length;
525 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
526 # ifndef OPENSSL_NO_PSK
527 char *psk_identity_hint;
531 * Used to indicate that session resumption is not allowed. Applications
532 * can also set this bit for a new session via not_resumable_session_cb
533 * to disable session caching and tickets.
536 /* This is the cert and type for the other end. */
539 /* Certificate chain peer sent. */
540 STACK_OF(X509) *peer_chain;
542 * when app_verify_callback accepts a session where the peer's
543 * certificate is not ok, we must remember the error for session reuse:
545 long verify_result; /* only for servers */
546 CRYPTO_REF_COUNT references;
549 unsigned int compress_meth; /* Need to lookup the method */
550 const SSL_CIPHER *cipher;
551 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
552 * load the 'cipher' structure */
553 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
554 CRYPTO_EX_DATA ex_data; /* application specific data */
556 * These are used to make removal of session-ids more efficient and to
557 * implement a maximum cache size.
559 struct ssl_session_st *prev, *next;
563 # ifndef OPENSSL_NO_EC
564 size_t ecpointformats_len;
565 unsigned char *ecpointformats; /* peer's list */
566 # endif /* OPENSSL_NO_EC */
567 size_t supportedgroups_len;
568 uint16_t *supportedgroups; /* peer's list */
570 unsigned char *tick; /* Session ticket */
571 size_t ticklen; /* Session ticket length */
572 /* Session lifetime hint in seconds */
573 unsigned long tick_lifetime_hint;
574 uint32_t tick_age_add;
575 unsigned char *tick_nonce;
576 size_t tick_nonce_len;
578 /* Max number of bytes that can be sent as early data */
579 uint32_t max_early_data;
580 /* The ALPN protocol selected for this session */
581 unsigned char *alpn_selected;
582 size_t alpn_selected_len;
584 * Maximum Fragment Length as per RFC 4366.
585 * If this value does not contain RFC 4366 allowed values (1-4) then
586 * either the Maximum Fragment Length Negotiation failed or was not
589 uint8_t max_fragment_len_mode;
591 # ifndef OPENSSL_NO_SRP
594 unsigned char *ticket_appdata;
595 size_t ticket_appdata_len;
600 /* Extended master secret support */
601 # define SSL_SESS_FLAG_EXTMS 0x1
603 # ifndef OPENSSL_NO_SRP
605 typedef struct srp_ctx_st {
606 /* param for all the callbacks */
608 /* set client Hello login callback */
609 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
610 /* set SRP N/g param callback for verification */
611 int (*SRP_verify_param_callback) (SSL *, void *);
612 /* set SRP client passwd callback */
613 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
615 BIGNUM *N, *g, *s, *B, *A;
619 unsigned long srp_Mask;
625 SSL_EARLY_DATA_NONE = 0,
626 SSL_EARLY_DATA_CONNECT_RETRY,
627 SSL_EARLY_DATA_CONNECTING,
628 SSL_EARLY_DATA_WRITE_RETRY,
629 SSL_EARLY_DATA_WRITING,
630 SSL_EARLY_DATA_WRITE_FLUSH,
631 SSL_EARLY_DATA_UNAUTH_WRITING,
632 SSL_EARLY_DATA_FINISHED_WRITING,
633 SSL_EARLY_DATA_ACCEPT_RETRY,
634 SSL_EARLY_DATA_ACCEPTING,
635 SSL_EARLY_DATA_READ_RETRY,
636 SSL_EARLY_DATA_READING,
637 SSL_EARLY_DATA_FINISHED_READING
638 } SSL_EARLY_DATA_STATE;
641 * We check that the amount of unreadable early data doesn't exceed
642 * max_early_data. max_early_data is given in plaintext bytes. However if it is
643 * unreadable then we only know the number of ciphertext bytes. We also don't
644 * know how much the overhead should be because it depends on the ciphersuite.
645 * We make a small allowance. We assume 5 records of actual data plus the end
646 * of early data alert record. Each record has a tag and a content type byte.
647 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
648 * content of the alert record either which is 2 bytes.
650 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
653 * The allowance we have between the client's calculated ticket age and our own.
654 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
655 * client's age calculation is different by more than this than our own then we
656 * do not allow that ticket for early_data.
658 # define TICKET_AGE_ALLOWANCE (10 * 1000)
660 #define MAX_COMPRESSIONS_SIZE 255
668 typedef struct raw_extension_st {
669 /* Raw packet data for the extension */
671 /* Set to 1 if the extension is present or 0 otherwise */
673 /* Set to 1 if we have already parsed the extension or 0 otherwise */
675 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
677 /* Track what order extensions are received in (0-based). */
678 size_t received_order;
683 unsigned int legacy_version;
684 unsigned char random[SSL3_RANDOM_SIZE];
685 size_t session_id_len;
686 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
687 size_t dtls_cookie_len;
688 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
690 size_t compressions_len;
691 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
693 size_t pre_proc_exts_len;
694 RAW_EXTENSION *pre_proc_exts;
698 * Extension index values NOTE: Any updates to these defines should be mirrored
699 * with equivalent updates to ext_defs in extensions.c
701 typedef enum tlsext_index_en {
702 TLSEXT_IDX_renegotiate,
703 TLSEXT_IDX_server_name,
704 TLSEXT_IDX_max_fragment_length,
706 TLSEXT_IDX_ec_point_formats,
707 TLSEXT_IDX_supported_groups,
708 TLSEXT_IDX_session_ticket,
709 TLSEXT_IDX_status_request,
710 TLSEXT_IDX_next_proto_neg,
711 TLSEXT_IDX_application_layer_protocol_negotiation,
713 TLSEXT_IDX_encrypt_then_mac,
714 TLSEXT_IDX_signed_certificate_timestamp,
715 TLSEXT_IDX_extended_master_secret,
716 TLSEXT_IDX_signature_algorithms_cert,
717 TLSEXT_IDX_post_handshake_auth,
718 TLSEXT_IDX_signature_algorithms,
719 TLSEXT_IDX_supported_versions,
720 TLSEXT_IDX_psk_kex_modes,
721 TLSEXT_IDX_key_share,
723 TLSEXT_IDX_cryptopro_bug,
724 TLSEXT_IDX_early_data,
725 TLSEXT_IDX_certificate_authorities,
728 /* Dummy index - must always be the last entry */
729 TLSEXT_IDX_num_builtins
732 DEFINE_LHASH_OF(SSL_SESSION);
733 /* Needed in ssl_cert.c */
734 DEFINE_LHASH_OF(X509_NAME);
736 # define TLSEXT_KEYNAME_LENGTH 16
739 const SSL_METHOD *method;
740 STACK_OF(SSL_CIPHER) *cipher_list;
741 /* same as above but sorted for lookup */
742 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
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 int sess_connect; /* SSL new conn - started */
780 int sess_connect_renegotiate; /* SSL reneg - requested */
781 int sess_connect_good; /* SSL new conne/reneg - finished */
782 int sess_accept; /* SSL new accept - started */
783 int sess_accept_renegotiate; /* SSL reneg - requested */
784 int sess_accept_good; /* SSL accept/reneg - finished */
785 int sess_miss; /* session lookup misses */
786 int sess_timeout; /* reuse attempt on timeouted session */
787 int sess_cache_full; /* session removed due to full cache */
788 int sess_hit; /* session reuse actually done */
789 int sess_cb_hit; /* session-id that was not in the cache was
790 * passed back via the callback. This
791 * indicates that the application is supplying
792 * session-id's from other processes - spooky
796 CRYPTO_REF_COUNT references;
798 /* if defined, these override the X509_verify_cert() calls */
799 int (*app_verify_callback) (X509_STORE_CTX *, void *);
800 void *app_verify_arg;
802 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
803 * ('app_verify_callback' was called with just one argument)
806 /* Default password callback. */
807 pem_password_cb *default_passwd_callback;
809 /* Default password callback user data. */
810 void *default_passwd_callback_userdata;
812 /* get client cert callback */
813 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
815 /* cookie generate callback */
816 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
817 unsigned int *cookie_len);
819 /* verify cookie callback */
820 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
821 unsigned int cookie_len);
823 /* TLS1.3 app-controlled cookie generate callback */
824 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
827 /* TLS1.3 verify app-controlled cookie callback */
828 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
831 CRYPTO_EX_DATA ex_data;
833 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
834 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
836 STACK_OF(X509) *extra_certs;
837 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
839 /* Default values used when no per-SSL value is defined follow */
841 /* used if SSL's info_callback is NULL */
842 void (*info_callback) (const SSL *ssl, int type, int val);
845 * What we put in certificate_authorities extension for TLS 1.3
846 * (ClientHello and CertificateRequest) or just client cert requests for
849 STACK_OF(X509_NAME) *ca_names;
852 * Default values to use in SSL structures follow (these are copied by
858 int min_proto_version;
859 int max_proto_version;
860 size_t max_cert_list;
862 struct cert_st /* CERT */ *cert;
865 /* callback that allows applications to peek at protocol messages */
866 void (*msg_callback) (int write_p, int version, int content_type,
867 const void *buf, size_t len, SSL *ssl, void *arg);
868 void *msg_callback_arg;
870 uint32_t verify_mode;
871 size_t sid_ctx_length;
872 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
873 /* called 'verify_callback' in the SSL */
874 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
876 /* Default generate session ID callback. */
877 GEN_SESSION_CB generate_session_id;
879 X509_VERIFY_PARAM *param;
883 # ifndef OPENSSL_NO_CT
884 CTLOG_STORE *ctlog_store; /* CT Log Store */
886 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
887 * If they are not, the connection should be aborted.
889 ssl_ct_validation_cb ct_validation_callback;
890 void *ct_validation_callback_arg;
894 * If we're using more than one pipeline how should we divide the data
895 * up between the pipes?
897 size_t split_send_fragment;
899 * Maximum amount of data to send in one fragment. actual record size can
900 * be more than this due to padding and MAC overheads.
902 size_t max_send_fragment;
904 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
905 size_t max_pipelines;
907 /* The default read buffer length to use (0 means not set) */
908 size_t default_read_buf_len;
910 # ifndef OPENSSL_NO_ENGINE
912 * Engine to pass requests for client certs to
914 ENGINE *client_cert_engine;
917 /* ClientHello callback. Mostly for extensions, but not entirely. */
918 SSL_client_hello_cb_fn client_hello_cb;
919 void *client_hello_cb_arg;
921 /* TLS extensions. */
923 /* TLS extensions servername callback */
924 int (*servername_cb) (SSL *, int *, void *);
925 void *servername_arg;
926 /* RFC 4507 session ticket keys */
927 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
928 unsigned char tick_hmac_key[32];
929 unsigned char tick_aes_key[32];
930 /* Callback to support customisation of ticket key setting */
931 int (*ticket_key_cb) (SSL *ssl,
932 unsigned char *name, unsigned char *iv,
933 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
935 /* certificate status request info */
936 /* Callback for status request */
937 int (*status_cb) (SSL *ssl, void *arg);
939 /* ext status type used for CSR extension (OCSP Stapling) */
941 /* RFC 4366 Maximum Fragment Length Negotiation */
942 uint8_t max_fragment_len_mode;
944 # ifndef OPENSSL_NO_EC
945 /* EC extension values inherited by SSL structure */
946 size_t ecpointformats_len;
947 unsigned char *ecpointformats;
948 size_t supportedgroups_len;
949 uint16_t *supportedgroups;
950 # endif /* OPENSSL_NO_EC */
953 * ALPN information (we are in the process of transitioning from NPN to
958 * For a server, this contains a callback function that allows the
959 * server to select the protocol for the connection.
960 * out: on successful return, this must point to the raw protocol
961 * name (without the length prefix).
962 * outlen: on successful return, this contains the length of |*out|.
963 * in: points to the client's list of supported protocols in
965 * inlen: the length of |in|.
967 int (*alpn_select_cb) (SSL *s,
968 const unsigned char **out,
969 unsigned char *outlen,
970 const unsigned char *in,
971 unsigned int inlen, void *arg);
972 void *alpn_select_cb_arg;
975 * For a client, this contains the list of supported protocols in wire
981 # ifndef OPENSSL_NO_NEXTPROTONEG
982 /* Next protocol negotiation information */
985 * For a server, this contains a callback function by which the set of
986 * advertised protocols can be provided.
988 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
989 void *npn_advertised_cb_arg;
991 * For a client, this contains a callback function that selects the next
992 * protocol from the list provided by the server.
994 SSL_CTX_npn_select_cb_func npn_select_cb;
995 void *npn_select_cb_arg;
998 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1001 # ifndef OPENSSL_NO_PSK
1002 SSL_psk_client_cb_func psk_client_callback;
1003 SSL_psk_server_cb_func psk_server_callback;
1005 SSL_psk_find_session_cb_func psk_find_session_cb;
1006 SSL_psk_use_session_cb_func psk_use_session_cb;
1008 # ifndef OPENSSL_NO_SRP
1009 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1012 /* Shared DANE context */
1013 struct dane_ctx_st dane;
1015 /* SRTP profiles we are willing to do from RFC 5764 */
1016 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1018 * Callback for disabling session caching and ticket support on a session
1019 * basis, depending on the chosen cipher.
1021 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1023 CRYPTO_RWLOCK *lock;
1026 * Callback for logging key material for use with debugging tools like
1027 * Wireshark. The callback should log `line` followed by a newline.
1029 SSL_CTX_keylog_cb_func keylog_callback;
1031 /* The maximum number of bytes that can be sent as early data */
1032 uint32_t max_early_data;
1034 /* TLS1.3 padding callback */
1035 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1036 void *record_padding_arg;
1037 size_t block_padding;
1039 /* Session ticket appdata */
1040 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1041 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1042 void *ticket_cb_data;
1047 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1052 const SSL_METHOD *method;
1054 * There are 2 BIO's even though they are normally both the same. This
1055 * is so data can be read and written to different handlers
1057 /* used by SSL_read */
1059 /* used by SSL_write */
1061 /* used during session-id reuse to concatenate messages */
1064 * This holds a variable that indicates what we were doing when a 0 or -1
1065 * is returned. This is needed for non-blocking IO so we know what
1066 * request needs re-doing when in SSL_accept or SSL_connect
1069 int (*handshake_func) (SSL *);
1071 * Imagine that here's a boolean member "init" that is switched as soon
1072 * as SSL_set_{accept/connect}_state is called for the first time, so
1073 * that "state" and "handshake_func" are properly initialized. But as
1074 * handshake_func is == 0 until then, we use this test instead of an
1077 /* are we the server side? */
1080 * Generate a new session or reuse an old one.
1081 * NB: For servers, the 'new' session may actually be a previously
1082 * cached session or even the previous session unless
1083 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1086 /* don't send shutdown packets */
1088 /* we have shut things down, 0x01 sent, 0x02 for received */
1092 SSL_EARLY_DATA_STATE early_data_state;
1093 BUF_MEM *init_buf; /* buffer used during init */
1094 void *init_msg; /* pointer to handshake message body, set by
1095 * ssl3_get_message() */
1096 size_t init_num; /* amount read/written */
1097 size_t init_off; /* amount read/written */
1098 struct ssl3_state_st *s3; /* SSLv3 variables */
1099 struct dtls1_state_st *d1; /* DTLSv1 variables */
1100 /* callback that allows applications to peek at protocol messages */
1101 void (*msg_callback) (int write_p, int version, int content_type,
1102 const void *buf, size_t len, SSL *ssl, void *arg);
1103 void *msg_callback_arg;
1104 int hit; /* reusing a previous session */
1105 X509_VERIFY_PARAM *param;
1106 /* Per connection DANE state */
1109 STACK_OF(SSL_CIPHER) *cipher_list;
1110 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1112 * These are the ones being used, the ones in SSL_SESSION are the ones to
1113 * be 'copied' into these ones
1117 * The TLS1.3 secrets. The resumption master secret is stored in the
1120 unsigned char early_secret[EVP_MAX_MD_SIZE];
1121 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1122 unsigned char master_secret[EVP_MAX_MD_SIZE];
1123 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1124 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1125 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1126 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1127 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1128 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1129 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1130 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1131 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1132 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1133 EVP_MD_CTX *read_hash; /* used for mac generation */
1134 COMP_CTX *compress; /* compression */
1135 COMP_CTX *expand; /* uncompress */
1136 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1137 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1138 EVP_MD_CTX *write_hash; /* used for mac generation */
1139 /* Count of how many KeyUpdate messages we have received */
1140 unsigned int key_update_count;
1143 /* This is used to hold the server certificate used */
1144 struct cert_st /* CERT */ *cert;
1147 * The hash of all messages prior to the CertificateVerify, and the length
1150 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1151 size_t cert_verify_hash_len;
1153 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1154 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1155 hello_retry_request;
1158 * the session_id_context is used to ensure sessions are only reused in
1159 * the appropriate context
1161 size_t sid_ctx_length;
1162 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1163 /* This can also be in the session once a session is established */
1164 SSL_SESSION *session;
1165 /* TLSv1.3 PSK session */
1166 SSL_SESSION *psksession;
1167 unsigned char *psksession_id;
1168 size_t psksession_id_len;
1169 /* Default generate session ID callback. */
1170 GEN_SESSION_CB generate_session_id;
1172 * The temporary TLSv1.3 session id. This isn't really a session id at all
1173 * but is a random value sent in the legacy session id field.
1175 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1176 size_t tmp_session_id_len;
1179 * 0 don't care about verify failure.
1180 * 1 fail if verify fails
1182 uint32_t verify_mode;
1183 /* fail if callback returns 0 */
1184 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1185 /* optional informational callback */
1186 void (*info_callback) (const SSL *ssl, int type, int val);
1187 /* error bytes to be written */
1191 # ifndef OPENSSL_NO_PSK
1192 SSL_psk_client_cb_func psk_client_callback;
1193 SSL_psk_server_cb_func psk_server_callback;
1195 SSL_psk_find_session_cb_func psk_find_session_cb;
1196 SSL_psk_use_session_cb_func psk_use_session_cb;
1198 /* Verified chain of peer */
1199 STACK_OF(X509) *verified_chain;
1201 /* extra application data */
1202 CRYPTO_EX_DATA ex_data;
1203 /* for server side, keep the list of CA_dn we can use */
1204 STACK_OF(X509_NAME) *ca_names;
1205 CRYPTO_REF_COUNT references;
1206 /* protocol behaviour */
1210 int min_proto_version;
1211 int max_proto_version;
1212 size_t max_cert_list;
1215 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1216 * secret and SSLv3/TLS (<=1.2) rollback check
1220 * If we're using more than one pipeline how should we divide the data
1221 * up between the pipes?
1223 size_t split_send_fragment;
1225 * Maximum amount of data to send in one fragment. actual record size can
1226 * be more than this due to padding and MAC overheads.
1228 size_t max_send_fragment;
1229 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1230 size_t max_pipelines;
1233 /* Built-in extension flags */
1234 uint8_t extflags[TLSEXT_IDX_num_builtins];
1235 /* TLS extension debug callback */
1236 void (*debug_cb)(SSL *s, int client_server, int type,
1237 const unsigned char *data, int len, void *arg);
1240 /* certificate status request info */
1241 /* Status type or -1 if no status type */
1243 /* Raw extension data, if seen */
1244 unsigned char *scts;
1245 /* Length of raw extension data, if seen */
1247 /* Expect OCSP CertificateStatus message */
1248 int status_expected;
1251 /* OCSP status request only */
1252 STACK_OF(OCSP_RESPID) *ids;
1253 X509_EXTENSIONS *exts;
1254 /* OCSP response received or to be sent */
1255 unsigned char *resp;
1259 /* RFC4507 session ticket expected to be received or sent */
1260 int ticket_expected;
1261 # ifndef OPENSSL_NO_EC
1262 size_t ecpointformats_len;
1264 unsigned char *ecpointformats;
1265 # endif /* OPENSSL_NO_EC */
1266 size_t supportedgroups_len;
1268 uint16_t *supportedgroups;
1269 /* TLS Session Ticket extension override */
1270 TLS_SESSION_TICKET_EXT *session_ticket;
1271 /* TLS Session Ticket extension callback */
1272 tls_session_ticket_ext_cb_fn session_ticket_cb;
1273 void *session_ticket_cb_arg;
1274 /* TLS pre-shared secret session resumption */
1275 tls_session_secret_cb_fn session_secret_cb;
1276 void *session_secret_cb_arg;
1278 * For a client, this contains the list of supported protocols in wire
1281 unsigned char *alpn;
1284 * Next protocol negotiation. For the client, this is the protocol that
1285 * we sent in NextProtocol and is set when handling ServerHello
1286 * extensions. For a server, this is the client's selected_protocol from
1287 * NextProtocol and is set when handling the NextProtocol message, before
1288 * the Finished message.
1293 /* The available PSK key exchange modes */
1296 /* Set to one if we have negotiated ETM */
1299 /* Are we expecting to receive early data? */
1301 /* Is the session suitable for early data? */
1304 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1305 unsigned char *tls13_cookie;
1306 size_t tls13_cookie_len;
1307 /* Have we received a cookie from the client? */
1311 * Maximum Fragment Length as per RFC 4366.
1312 * If this member contains one of the allowed values (1-4)
1313 * then we should include Maximum Fragment Length Negotiation
1314 * extension in Client Hello.
1315 * Please note that value of this member does not have direct
1316 * effect. The actual (binding) value is stored in SSL_SESSION,
1317 * as this extension is optional on server side.
1319 uint8_t max_fragment_len_mode;
1323 * Parsed form of the ClientHello, kept around across client_hello_cb
1326 CLIENTHELLO_MSG *clienthello;
1329 * no further mod of servername
1330 * 0 : call the servername extension callback.
1331 * 1 : prepare 2, allow last ack just after in server callback.
1332 * 2 : don't call servername callback, no ack in server hello
1334 int servername_done;
1335 # ifndef OPENSSL_NO_CT
1337 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1338 * If they are not, the connection should be aborted.
1340 ssl_ct_validation_cb ct_validation_callback;
1341 /* User-supplied argument that is passed to the ct_validation_callback */
1342 void *ct_validation_callback_arg;
1344 * Consolidated stack of SCTs from all sources.
1345 * Lazily populated by CT_get_peer_scts(SSL*)
1347 STACK_OF(SCT) *scts;
1348 /* Have we attempted to find/parse SCTs yet? */
1351 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1353 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1354 /* What's been chosen */
1355 SRTP_PROTECTION_PROFILE *srtp_profile;
1357 * 1 if we are renegotiating.
1358 * 2 if we are a server and are inside a handshake
1359 * (i.e. not just sending a HelloRequest)
1362 /* If sending a KeyUpdate is pending */
1364 /* Post-handshake authentication state */
1365 SSL_PHA_STATE post_handshake_auth;
1367 uint8_t* pha_context;
1368 size_t pha_context_len;
1370 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1372 # ifndef OPENSSL_NO_SRP
1373 /* ctx for SRP authentication */
1377 * Callback for disabling session caching and ticket support on a session
1378 * basis, depending on the chosen cipher.
1380 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1381 RECORD_LAYER rlayer;
1382 /* Default password callback. */
1383 pem_password_cb *default_passwd_callback;
1384 /* Default password callback user data. */
1385 void *default_passwd_callback_userdata;
1386 /* Async Job info */
1388 ASYNC_WAIT_CTX *waitctx;
1391 /* The maximum number of plaintext bytes that can be sent as early data */
1392 uint32_t max_early_data;
1394 * The number of bytes of early data received so far. If we accepted early
1395 * data then this is a count of the plaintext bytes. If we rejected it then
1396 * this is a count of the ciphertext bytes.
1398 uint32_t early_data_count;
1400 /* TLS1.3 padding callback */
1401 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1402 void *record_padding_arg;
1403 size_t block_padding;
1405 CRYPTO_RWLOCK *lock;
1410 * Structure containing table entry of values associated with the signature
1411 * algorithms (signature scheme) extension
1413 typedef struct sigalg_lookup_st {
1414 /* TLS 1.3 signature scheme name */
1416 /* Raw value used in extension */
1418 /* NID of hash algorithm or NID_undef if no hash */
1420 /* Index of hash algorithm or -1 if no hash algorithm */
1422 /* NID of signature algorithm */
1424 /* Index of signature algorithm */
1426 /* Combined hash and signature NID, if any */
1428 /* Required public key curve (ECDSA only) */
1432 typedef struct tls_group_info_st {
1433 int nid; /* Curve NID */
1434 int secbits; /* Bits of security (from SP800-57) */
1435 uint16_t flags; /* Flags: currently just group type */
1439 # define TLS_CURVE_TYPE 0x3 /* Mask for group type */
1440 # define TLS_CURVE_PRIME 0x0
1441 # define TLS_CURVE_CHAR2 0x1
1442 # define TLS_CURVE_CUSTOM 0x2
1444 typedef struct cert_pkey_st CERT_PKEY;
1447 * Structure containing table entry of certificate info corresponding to
1451 int nid; /* NID of pubic key algorithm */
1452 uint32_t amask; /* authmask corresponding to key type */
1455 typedef struct ssl3_state_st {
1457 size_t read_mac_secret_size;
1458 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1459 size_t write_mac_secret_size;
1460 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1461 unsigned char server_random[SSL3_RANDOM_SIZE];
1462 unsigned char client_random[SSL3_RANDOM_SIZE];
1463 /* flags for countermeasure against known-IV weakness */
1464 int need_empty_fragments;
1465 int empty_fragment_done;
1466 /* used during startup, digest all incoming/outgoing packets */
1467 BIO *handshake_buffer;
1469 * When handshake digest is determined, buffer is hashed and
1470 * freed and MD_CTX for the required digest is stored here.
1472 EVP_MD_CTX *handshake_dgst;
1474 * Set whenever an expected ChangeCipherSpec message is processed.
1475 * Unset when the peer's Finished message is received.
1476 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1478 int change_cipher_spec;
1482 * we allow one fatal and one warning alert to be outstanding, send close
1483 * alert via the warning alert
1486 unsigned char send_alert[2];
1488 * This flag is set when we should renegotiate ASAP, basically when there
1489 * is no more data in the read or write buffers
1492 int total_renegotiations;
1493 int num_renegotiations;
1494 int in_read_app_data;
1496 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1497 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1498 size_t finish_md_len;
1499 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1500 size_t peer_finish_md_len;
1501 size_t message_size;
1503 /* used to hold the new cipher we are going to use */
1504 const SSL_CIPHER *new_cipher;
1505 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1506 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1508 /* used for certificate requests */
1510 /* Certificate types in certificate request message. */
1513 /* Certificate authorities list peer sent */
1514 STACK_OF(X509_NAME) *peer_ca_names;
1515 size_t key_block_length;
1516 unsigned char *key_block;
1517 const EVP_CIPHER *new_sym_enc;
1518 const EVP_MD *new_hash;
1519 int new_mac_pkey_type;
1520 size_t new_mac_secret_size;
1521 # ifndef OPENSSL_NO_COMP
1522 const SSL_COMP *new_compression;
1524 char *new_compression;
1527 /* Raw values of the cipher list from a client */
1528 unsigned char *ciphers_raw;
1529 size_t ciphers_rawlen;
1530 /* Temporary storage for premaster secret */
1533 # ifndef OPENSSL_NO_PSK
1534 /* Temporary storage for PSK key */
1538 /* Signature algorithm we actually use */
1539 const SIGALG_LOOKUP *sigalg;
1540 /* Pointer to certificate we use */
1543 * signature algorithms peer reports: e.g. supported signature
1544 * algorithms extension for server or as part of a certificate
1545 * request for client.
1546 * Keep track of the algorithms for TLS and X.509 usage separately.
1548 uint16_t *peer_sigalgs;
1549 uint16_t *peer_cert_sigalgs;
1550 /* Size of above arrays */
1551 size_t peer_sigalgslen;
1552 size_t peer_cert_sigalgslen;
1553 /* Sigalg peer actually uses */
1554 const SIGALG_LOOKUP *peer_sigalg;
1556 * Set if corresponding CERT_PKEY can be used with current
1557 * SSL session: e.g. appropriate curve, signature algorithms etc.
1558 * If zero it can't be used at all.
1560 uint32_t valid_flags[SSL_PKEY_NUM];
1562 * For servers the following masks are for the key and auth algorithms
1563 * that are supported by the certs below. For clients they are masks of
1564 * *disabled* algorithms based on the current session.
1569 * The following are used by the client to see if a cipher is allowed or
1570 * not. It contains the minimum and maximum version the client's using
1571 * based on what it knows so far.
1577 /* Connection binding to prevent renegotiation attacks */
1578 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1579 size_t previous_client_finished_len;
1580 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1581 size_t previous_server_finished_len;
1582 int send_connection_binding; /* TODOEKR */
1584 # ifndef OPENSSL_NO_NEXTPROTONEG
1586 * Set if we saw the Next Protocol Negotiation extension from our peer.
1592 * ALPN information (we are in the process of transitioning from NPN to
1597 * In a server these point to the selected ALPN protocol after the
1598 * ClientHello has been processed. In a client these contain the protocol
1599 * that the server selected once the ServerHello has been processed.
1601 unsigned char *alpn_selected;
1602 size_t alpn_selected_len;
1603 /* used by the server to know what options were proposed */
1604 unsigned char *alpn_proposed;
1605 size_t alpn_proposed_len;
1606 /* used by the client to know if it actually sent alpn */
1609 # ifndef OPENSSL_NO_EC
1611 * This is set to true if we believe that this is a version of Safari
1612 * running on OS X 10.6 or newer. We wish to know this because Safari on
1613 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1615 char is_probably_safari;
1616 # endif /* !OPENSSL_NO_EC */
1618 /* For clients: peer temporary key */
1619 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1620 /* The group_id for the DH/ECDH key */
1627 /* DTLS structures */
1629 # ifndef OPENSSL_NO_SCTP
1630 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1633 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1634 # define DTLS1_MAX_MTU_OVERHEAD 48
1637 * Flag used in message reuse to indicate the buffer contains the record
1638 * header as well as the handshake message header.
1640 # define DTLS1_SKIP_RECORD_HEADER 2
1642 struct dtls1_retransmit_state {
1643 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1644 EVP_MD_CTX *write_hash; /* used for mac generation */
1645 COMP_CTX *compress; /* compression */
1646 SSL_SESSION *session;
1647 unsigned short epoch;
1650 struct hm_header_st {
1656 unsigned int is_ccs;
1657 struct dtls1_retransmit_state saved_retransmit_state;
1660 struct dtls1_timeout_st {
1661 /* Number of read timeouts so far */
1662 unsigned int read_timeouts;
1663 /* Number of write timeouts so far */
1664 unsigned int write_timeouts;
1665 /* Number of alerts received so far */
1666 unsigned int num_alerts;
1669 typedef struct hm_fragment_st {
1670 struct hm_header_st msg_header;
1671 unsigned char *fragment;
1672 unsigned char *reassembly;
1675 typedef struct pqueue_st pqueue;
1676 typedef struct pitem_st pitem;
1679 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1684 typedef struct pitem_st *piterator;
1686 pitem *pitem_new(unsigned char *prio64be, void *data);
1687 void pitem_free(pitem *item);
1688 pqueue *pqueue_new(void);
1689 void pqueue_free(pqueue *pq);
1690 pitem *pqueue_insert(pqueue *pq, pitem *item);
1691 pitem *pqueue_peek(pqueue *pq);
1692 pitem *pqueue_pop(pqueue *pq);
1693 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1694 pitem *pqueue_iterator(pqueue *pq);
1695 pitem *pqueue_next(piterator *iter);
1696 size_t pqueue_size(pqueue *pq);
1698 typedef struct dtls1_state_st {
1699 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1701 unsigned int cookie_verified;
1702 /* handshake message numbers */
1703 unsigned short handshake_write_seq;
1704 unsigned short next_handshake_write_seq;
1705 unsigned short handshake_read_seq;
1706 /* Buffered handshake messages */
1707 pqueue *buffered_messages;
1708 /* Buffered (sent) handshake records */
1709 pqueue *sent_messages;
1710 size_t link_mtu; /* max on-the-wire DTLS packet size */
1711 size_t mtu; /* max DTLS packet size */
1712 struct hm_header_st w_msg_hdr;
1713 struct hm_header_st r_msg_hdr;
1714 struct dtls1_timeout_st timeout;
1716 * Indicates when the last handshake msg sent will timeout
1718 struct timeval next_timeout;
1719 /* Timeout duration */
1720 unsigned int timeout_duration_us;
1722 unsigned int retransmitting;
1723 # ifndef OPENSSL_NO_SCTP
1724 int shutdown_received;
1727 DTLS_timer_cb timer_cb;
1731 # ifndef OPENSSL_NO_EC
1733 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1735 # define EXPLICIT_PRIME_CURVE_TYPE 1
1736 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1737 # define NAMED_CURVE_TYPE 3
1738 # endif /* OPENSSL_NO_EC */
1740 struct cert_pkey_st {
1742 EVP_PKEY *privatekey;
1743 /* Chain for this certificate */
1744 STACK_OF(X509) *chain;
1746 * serverinfo data for this certificate. The data is in TLS Extension
1747 * wire format, specifically it's a series of records like:
1748 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1750 * uint8_t data[length];
1752 unsigned char *serverinfo;
1753 size_t serverinfo_length;
1755 /* Retrieve Suite B flags */
1756 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1757 /* Uses to check strict mode: suite B modes are always strict */
1758 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1759 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1762 ENDPOINT_CLIENT = 0,
1769 unsigned short ext_type;
1771 /* The context which this extension applies to */
1772 unsigned int context;
1774 * Per-connection flags relating to this extension type: not used if
1775 * part of an SSL_CTX structure.
1778 SSL_custom_ext_add_cb_ex add_cb;
1779 SSL_custom_ext_free_cb_ex free_cb;
1781 SSL_custom_ext_parse_cb_ex parse_cb;
1783 } custom_ext_method;
1785 /* ext_flags values */
1788 * Indicates an extension has been received. Used to check for unsolicited or
1789 * duplicate extensions.
1791 # define SSL_EXT_FLAG_RECEIVED 0x1
1793 * Indicates an extension has been sent: used to enable sending of
1794 * corresponding ServerHello extension.
1796 # define SSL_EXT_FLAG_SENT 0x2
1799 custom_ext_method *meths;
1801 } custom_ext_methods;
1803 typedef struct cert_st {
1804 /* Current active set */
1806 * ALWAYS points to an element of the pkeys array
1807 * Probably it would make more sense to store
1808 * an index, not a pointer.
1811 # ifndef OPENSSL_NO_DH
1813 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1816 /* Flags related to certificates */
1817 uint32_t cert_flags;
1818 CERT_PKEY pkeys[SSL_PKEY_NUM];
1819 /* Custom certificate types sent in certificate request message. */
1823 * supported signature algorithms. When set on a client this is sent in
1824 * the client hello as the supported signature algorithms extension. For
1825 * servers it represents the signature algorithms we are willing to use.
1827 uint16_t *conf_sigalgs;
1828 /* Size of above array */
1829 size_t conf_sigalgslen;
1831 * Client authentication signature algorithms, if not set then uses
1832 * conf_sigalgs. On servers these will be the signature algorithms sent
1833 * to the client in a certificate request for TLS 1.2. On a client this
1834 * represents the signature algorithms we are willing to use for client
1837 uint16_t *client_sigalgs;
1838 /* Size of above array */
1839 size_t client_sigalgslen;
1841 * Signature algorithms shared by client and server: cached because these
1842 * are used most often.
1844 const SIGALG_LOOKUP **shared_sigalgs;
1845 size_t shared_sigalgslen;
1847 * Certificate setup callback: if set is called whenever a certificate
1848 * may be required (client or server). the callback can then examine any
1849 * appropriate parameters and setup any certificates required. This
1850 * allows advanced applications to select certificates on the fly: for
1851 * example based on supported signature algorithms or curves.
1853 int (*cert_cb) (SSL *ssl, void *arg);
1856 * Optional X509_STORE for chain building or certificate validation If
1857 * NULL the parent SSL_CTX store is used instead.
1859 X509_STORE *chain_store;
1860 X509_STORE *verify_store;
1861 /* Custom extensions */
1862 custom_ext_methods custext;
1863 /* Security callback */
1864 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1865 void *other, void *ex);
1866 /* Security level */
1869 # ifndef OPENSSL_NO_PSK
1870 /* If not NULL psk identity hint to use for servers */
1871 char *psk_identity_hint;
1873 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1874 CRYPTO_RWLOCK *lock;
1877 # define FP_ICC (int (*)(const void *,const void *))
1880 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1881 * of a mess of functions, but hell, think of it as an opaque structure :-)
1883 typedef struct ssl3_enc_method {
1884 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1885 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1886 int (*setup_key_block) (SSL *);
1887 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1889 int (*change_cipher_state) (SSL *, int);
1890 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1891 const char *client_finished_label;
1892 size_t client_finished_label_len;
1893 const char *server_finished_label;
1894 size_t server_finished_label_len;
1895 int (*alert_value) (int);
1896 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1897 const char *, size_t,
1898 const unsigned char *, size_t,
1900 /* Various flags indicating protocol version requirements */
1902 /* Set the handshake header */
1903 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1904 /* Close construction of the handshake message */
1905 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1906 /* Write out handshake message */
1907 int (*do_write) (SSL *s);
1910 # define ssl_set_handshake_header(s, pkt, htype) \
1911 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1912 # define ssl_close_construct_packet(s, pkt, htype) \
1913 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1914 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1916 /* Values for enc_flags */
1918 /* Uses explicit IV for CBC mode */
1919 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1920 /* Uses signature algorithms extension */
1921 # define SSL_ENC_FLAG_SIGALGS 0x2
1922 /* Uses SHA256 default PRF */
1923 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1925 # define SSL_ENC_FLAG_DTLS 0x8
1927 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1928 * apply to others in future.
1930 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1932 # ifndef OPENSSL_NO_COMP
1933 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1934 typedef struct ssl3_comp_st {
1935 int comp_id; /* The identifier byte for this compression
1937 char *name; /* Text name used for the compression type */
1938 COMP_METHOD *method; /* The method :-) */
1942 typedef enum downgrade_en {
1949 * Dummy status type for the status_type extension. Indicates no status type
1952 #define TLSEXT_STATUSTYPE_nothing -1
1954 /* Sigalgs values */
1955 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1956 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1957 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1958 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
1959 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1960 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
1961 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
1962 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
1963 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
1964 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
1965 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
1966 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1967 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1968 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1969 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
1970 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1971 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1972 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1973 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1974 #define TLSEXT_SIGALG_dsa_sha224 0x0302
1975 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1976 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1977 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1978 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1980 #define TLSEXT_SIGALG_ed25519 0x0807
1981 #define TLSEXT_SIGALG_ed448 0x0808
1983 /* Known PSK key exchange modes */
1984 #define TLSEXT_KEX_MODE_KE 0x00
1985 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1988 * Internal representations of key exchange modes
1990 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1991 #define TLSEXT_KEX_MODE_FLAG_KE 1
1992 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1994 /* An invalid index into the TLSv1.3 PSK identities */
1995 #define TLSEXT_PSK_BAD_IDENTITY -1
1997 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1998 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2000 /* A dummy signature value not valid for TLSv1.2 signature algs */
2001 #define TLSEXT_signature_rsa_pss 0x0101
2003 /* TLSv1.3 downgrade protection sentinel values */
2004 extern const unsigned char tls11downgrade[8];
2005 extern const unsigned char tls12downgrade[8];
2007 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2009 __owur const SSL_METHOD *ssl_bad_method(int ver);
2010 __owur const SSL_METHOD *sslv3_method(void);
2011 __owur const SSL_METHOD *sslv3_server_method(void);
2012 __owur const SSL_METHOD *sslv3_client_method(void);
2013 __owur const SSL_METHOD *tlsv1_method(void);
2014 __owur const SSL_METHOD *tlsv1_server_method(void);
2015 __owur const SSL_METHOD *tlsv1_client_method(void);
2016 __owur const SSL_METHOD *tlsv1_1_method(void);
2017 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2018 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2019 __owur const SSL_METHOD *tlsv1_2_method(void);
2020 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2021 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2022 __owur const SSL_METHOD *tlsv1_3_method(void);
2023 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2024 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2025 __owur const SSL_METHOD *dtlsv1_method(void);
2026 __owur const SSL_METHOD *dtlsv1_server_method(void);
2027 __owur const SSL_METHOD *dtlsv1_client_method(void);
2028 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2029 __owur const SSL_METHOD *dtlsv1_2_method(void);
2030 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2031 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2033 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2034 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2035 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2036 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2037 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2038 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2039 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2042 * Flags for SSL methods
2044 # define SSL_METHOD_NO_FIPS (1U<<0)
2045 # define SSL_METHOD_NO_SUITEB (1U<<1)
2047 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2048 s_connect, enc_data) \
2049 const SSL_METHOD *func_name(void) \
2051 static const SSL_METHOD func_name##_data= { \
2065 ssl3_renegotiate_check, \
2068 ssl3_dispatch_alert, \
2071 ssl3_get_cipher_by_char, \
2072 ssl3_put_cipher_by_char, \
2076 tls1_default_timeout, \
2078 ssl_undefined_void_function, \
2079 ssl3_callback_ctrl, \
2080 ssl3_ctx_callback_ctrl, \
2082 return &func_name##_data; \
2085 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2086 const SSL_METHOD *func_name(void) \
2088 static const SSL_METHOD func_name##_data= { \
2090 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2102 ssl3_renegotiate_check, \
2105 ssl3_dispatch_alert, \
2108 ssl3_get_cipher_by_char, \
2109 ssl3_put_cipher_by_char, \
2113 ssl3_default_timeout, \
2115 ssl_undefined_void_function, \
2116 ssl3_callback_ctrl, \
2117 ssl3_ctx_callback_ctrl, \
2119 return &func_name##_data; \
2122 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2123 s_connect, enc_data) \
2124 const SSL_METHOD *func_name(void) \
2126 static const SSL_METHOD func_name##_data= { \
2140 ssl3_renegotiate_check, \
2142 dtls1_write_app_data_bytes, \
2143 dtls1_dispatch_alert, \
2146 ssl3_get_cipher_by_char, \
2147 ssl3_put_cipher_by_char, \
2151 dtls1_default_timeout, \
2153 ssl_undefined_void_function, \
2154 ssl3_callback_ctrl, \
2155 ssl3_ctx_callback_ctrl, \
2157 return &func_name##_data; \
2160 struct openssl_ssl_test_functions {
2161 int (*p_ssl_init_wbio_buffer) (SSL *s);
2162 int (*p_ssl3_setup_buffers) (SSL *s);
2165 const char *ssl_protocol_to_string(int version);
2167 /* Returns true if certificate and private key for 'idx' are present */
2168 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2170 if (idx < 0 || idx >= SSL_PKEY_NUM)
2172 return s->cert->pkeys[idx].x509 != NULL
2173 && s->cert->pkeys[idx].privatekey != NULL;
2176 static ossl_inline void tls1_get_peer_groups(SSL *s, const uint16_t **pgroups,
2179 *pgroups = s->session->ext.supportedgroups;
2180 *pgroupslen = s->session->ext.supportedgroups_len;
2183 # ifndef OPENSSL_UNIT_TEST
2185 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2186 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2187 void ssl_clear_cipher_ctx(SSL *s);
2188 int ssl_clear_bad_session(SSL *s);
2189 __owur CERT *ssl_cert_new(void);
2190 __owur CERT *ssl_cert_dup(CERT *cert);
2191 void ssl_cert_clear_certs(CERT *c);
2192 void ssl_cert_free(CERT *c);
2193 __owur int ssl_generate_session_id(SSL *s, SSL_SESSION *ss);
2194 __owur int ssl_get_new_session(SSL *s, int session);
2195 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello);
2196 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2197 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2198 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2199 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2200 const SSL_CIPHER *const *bp);
2201 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2202 STACK_OF(SSL_CIPHER) **pref,
2203 STACK_OF(SSL_CIPHER)
2205 const char *rule_str,
2207 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format);
2208 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2209 STACK_OF(SSL_CIPHER) **skp,
2210 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2212 void ssl_update_cache(SSL *s, int mode);
2213 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2214 const EVP_MD **md, int *mac_pkey_type,
2215 size_t *mac_secret_size, SSL_COMP **comp,
2217 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2218 size_t *int_overhead, size_t *blocksize,
2219 size_t *ext_overhead);
2220 __owur int ssl_cert_is_disabled(size_t idx);
2221 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2222 const unsigned char *ptr,
2224 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2225 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2226 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2227 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2228 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2229 __owur int ssl_cert_set_current(CERT *c, long arg);
2230 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2232 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2233 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2234 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2237 __owur int ssl_randbytes(SSL *s, unsigned char *buf, size_t num);
2238 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2239 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2242 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2244 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2246 int ssl_undefined_function(SSL *s);
2247 __owur int ssl_undefined_void_function(void);
2248 __owur int ssl_undefined_const_function(const SSL *s);
2249 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2250 const unsigned char **serverinfo,
2251 size_t *serverinfo_length);
2252 void ssl_set_masks(SSL *s);
2253 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2254 __owur int ssl_verify_alarm_type(long type);
2255 void ssl_sort_cipher_list(void);
2256 int ssl_load_ciphers(void);
2257 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2258 size_t len, DOWNGRADE dgrd);
2259 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2261 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2262 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2264 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2265 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl);
2266 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl);
2268 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2269 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2270 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2271 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2273 int ssl3_init_finished_mac(SSL *s);
2274 __owur int ssl3_setup_key_block(SSL *s);
2275 __owur int ssl3_change_cipher_state(SSL *s, int which);
2276 void ssl3_cleanup_key_block(SSL *s);
2277 __owur int ssl3_do_write(SSL *s, int type);
2278 int ssl3_send_alert(SSL *s, int level, int desc);
2279 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2280 unsigned char *p, size_t len,
2281 size_t *secret_size);
2282 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2283 __owur int ssl3_num_ciphers(void);
2284 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2285 int ssl3_renegotiate(SSL *ssl);
2286 int ssl3_renegotiate_check(SSL *ssl, int initok);
2287 __owur int ssl3_dispatch_alert(SSL *s);
2288 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2290 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2291 void ssl3_free_digest_list(SSL *s);
2292 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2294 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2295 STACK_OF(SSL_CIPHER) *clnt,
2296 STACK_OF(SSL_CIPHER) *srvr);
2297 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2298 __owur int ssl3_new(SSL *s);
2299 void ssl3_free(SSL *s);
2300 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2301 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2302 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2303 __owur int ssl3_shutdown(SSL *s);
2304 int ssl3_clear(SSL *s);
2305 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2306 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2307 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2308 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2310 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2311 __owur long ssl3_default_timeout(void);
2313 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2314 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2315 __owur int tls_setup_handshake(SSL *s);
2316 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2317 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2318 __owur int ssl3_handshake_write(SSL *s);
2320 __owur int ssl_allow_compression(SSL *s);
2322 __owur int ssl_version_supported(const SSL *s, int version);
2324 __owur int ssl_set_client_hello_version(SSL *s);
2325 __owur int ssl_check_version_downgrade(SSL *s);
2326 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2327 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2329 __owur int ssl_choose_client_version(SSL *s, int version,
2330 RAW_EXTENSION *extensions);
2331 __owur int ssl_get_min_max_version(const SSL *s, int *min_version,
2334 __owur long tls1_default_timeout(void);
2335 __owur int dtls1_do_write(SSL *s, int type);
2336 void dtls1_set_message_header(SSL *s,
2339 size_t frag_off, size_t frag_len);
2341 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2344 __owur int dtls1_read_failed(SSL *s, int code);
2345 __owur int dtls1_buffer_message(SSL *s, int ccs);
2346 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2347 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2348 int dtls1_retransmit_buffered_messages(SSL *s);
2349 void dtls1_clear_received_buffer(SSL *s);
2350 void dtls1_clear_sent_buffer(SSL *s);
2351 void dtls1_get_message_header(unsigned char *data,
2352 struct hm_header_st *msg_hdr);
2353 __owur long dtls1_default_timeout(void);
2354 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2355 __owur int dtls1_check_timeout_num(SSL *s);
2356 __owur int dtls1_handle_timeout(SSL *s);
2357 void dtls1_start_timer(SSL *s);
2358 void dtls1_stop_timer(SSL *s);
2359 __owur int dtls1_is_timer_expired(SSL *s);
2360 void dtls1_double_timeout(SSL *s);
2361 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2363 __owur size_t dtls1_min_mtu(SSL *s);
2364 void dtls1_hm_fragment_free(hm_fragment *frag);
2365 __owur int dtls1_query_mtu(SSL *s);
2367 __owur int tls1_new(SSL *s);
2368 void tls1_free(SSL *s);
2369 int tls1_clear(SSL *s);
2371 __owur int dtls1_new(SSL *s);
2372 void dtls1_free(SSL *s);
2373 int dtls1_clear(SSL *s);
2374 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2375 __owur int dtls1_shutdown(SSL *s);
2377 __owur int dtls1_dispatch_alert(SSL *s);
2379 __owur int ssl_init_wbio_buffer(SSL *s);
2380 int ssl_free_wbio_buffer(SSL *s);
2382 __owur int tls1_change_cipher_state(SSL *s, int which);
2383 __owur int tls1_setup_key_block(SSL *s);
2384 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2386 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2387 unsigned char *p, size_t len,
2388 size_t *secret_size);
2389 __owur int tls13_setup_key_block(SSL *s);
2390 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2392 __owur int tls13_change_cipher_state(SSL *s, int which);
2393 __owur int tls13_update_key(SSL *s, int send);
2394 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2395 const unsigned char *secret,
2396 const unsigned char *label, size_t labellen,
2397 const unsigned char *data, size_t datalen,
2398 unsigned char *out, size_t outlen);
2399 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2400 const unsigned char *secret, unsigned char *key,
2402 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2403 const unsigned char *secret, unsigned char *iv,
2405 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2406 const unsigned char *secret,
2407 unsigned char *fin, size_t finlen);
2408 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2409 const unsigned char *prevsecret,
2410 const unsigned char *insecret,
2412 unsigned char *outsecret);
2413 __owur int tls13_generate_handshake_secret(SSL *s,
2414 const unsigned char *insecret,
2415 size_t insecretlen);
2416 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2417 unsigned char *prev, size_t prevlen,
2418 size_t *secret_size);
2419 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2420 const char *label, size_t llen,
2421 const unsigned char *p, size_t plen,
2423 __owur int tls13_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2424 const char *label, size_t llen,
2425 const unsigned char *context,
2426 size_t contextlen, int use_context);
2427 __owur int tls13_export_keying_material_early(SSL *s, unsigned char *out,
2428 size_t olen, const char *label,
2430 const unsigned char *context,
2432 __owur int tls1_alert_code(int code);
2433 __owur int tls13_alert_code(int code);
2434 __owur int ssl3_alert_code(int code);
2436 # ifndef OPENSSL_NO_EC
2437 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2440 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2442 # ifndef OPENSSL_NO_EC
2444 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(uint16_t curve_id);
2445 __owur int tls1_check_group_id(SSL *s, uint16_t group_id);
2446 __owur uint16_t tls1_shared_group(SSL *s, int nmatch);
2447 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2448 int *curves, size_t ncurves);
2449 __owur int tls1_set_groups_list(uint16_t **pext, size_t *pextlen,
2451 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2452 size_t *num_formats);
2453 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2454 __owur EVP_PKEY *ssl_generate_pkey_group(SSL *s, uint16_t id);
2455 __owur EVP_PKEY *ssl_generate_param_group(uint16_t id);
2456 # endif /* OPENSSL_NO_EC */
2458 __owur int tls_curve_allowed(SSL *s, uint16_t curve, int op);
2459 void tls1_get_supported_groups(SSL *s, const uint16_t **pgroups,
2460 size_t *pgroupslen);
2462 __owur int tls1_set_server_sigalgs(SSL *s);
2464 __owur SSL_TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2466 __owur SSL_TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2468 const unsigned char *sess_id,
2469 size_t sesslen, SSL_SESSION **psess);
2471 __owur int tls_use_ticket(SSL *s);
2473 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2475 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2476 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2478 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2480 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2482 void tls1_set_cert_validity(SSL *s);
2484 # ifndef OPENSSL_NO_CT
2485 __owur int ssl_validate_ct(SSL *s);
2488 # ifndef OPENSSL_NO_DH
2489 __owur DH *ssl_get_auto_dh(SSL *s);
2492 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2493 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2496 int tls_choose_sigalg(SSL *s, int fatalerrs);
2498 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2499 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2500 __owur long ssl_get_algorithm2(SSL *s);
2501 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2502 const uint16_t *psig, size_t psiglen);
2503 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2504 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt, int cert);
2505 __owur int tls1_process_sigalgs(SSL *s);
2506 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2507 __owur int tls1_lookup_md(const SIGALG_LOOKUP *lu, const EVP_MD **pmd);
2508 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2509 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2510 __owur int ssl_set_client_disabled(SSL *s);
2511 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op, int echde);
2513 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2515 __owur const EVP_MD *ssl_md(int idx);
2516 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2517 __owur const EVP_MD *ssl_prf_md(SSL *s);
2520 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2521 * with |ssl|, if logging is enabled. It returns one on success and zero on
2522 * failure. The entry is identified by the first 8 bytes of
2523 * |encrypted_premaster|.
2525 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2526 const uint8_t *encrypted_premaster,
2527 size_t encrypted_premaster_len,
2528 const uint8_t *premaster,
2529 size_t premaster_len);
2532 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2533 * logging is available. It returns one on success and zero on failure. It tags
2534 * the entry with |label|.
2536 __owur int ssl_log_secret(SSL *ssl, const char *label,
2537 const uint8_t *secret, size_t secret_len);
2539 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2540 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2541 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2542 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2543 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2544 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2547 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2548 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2549 unsigned char *md_out,
2550 size_t *md_out_size,
2551 const unsigned char header[13],
2552 const unsigned char *data,
2553 size_t data_plus_mac_size,
2554 size_t data_plus_mac_plus_padding_size,
2555 const unsigned char *mac_secret,
2556 size_t mac_secret_length, char is_sslv3);
2558 __owur int srp_generate_server_master_secret(SSL *s);
2559 __owur int srp_generate_client_master_secret(SSL *s);
2560 __owur int srp_verify_server_param(SSL *s);
2562 /* statem/statem_srvr.c */
2564 __owur int send_certificate_request(SSL *s);
2566 /* statem/extensions_cust.c */
2568 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2569 ENDPOINT role, unsigned int ext_type,
2572 void custom_ext_init(custom_ext_methods *meths);
2574 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2575 const unsigned char *ext_data, size_t ext_size,
2576 X509 *x, size_t chainidx);
2577 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2578 size_t chainidx, int maxversion);
2580 __owur int custom_exts_copy(custom_ext_methods *dst,
2581 const custom_ext_methods *src);
2582 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2583 const custom_ext_methods *src);
2584 void custom_exts_free(custom_ext_methods *exts);
2586 void ssl_comp_free_compression_methods_int(void);
2588 # else /* OPENSSL_UNIT_TEST */
2590 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2591 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers