2 * Copyright 1995-2017 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)
331 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0 \
332 || (s)->s3->tmp.peer_finish_md_len == 0)
334 /* See if we need explicit IV */
335 # define SSL_USE_EXPLICIT_IV(s) \
336 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
338 * See if we use signature algorithms extension and signature algorithm
341 # define SSL_USE_SIGALGS(s) \
342 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
344 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
345 * apply to others in future.
347 # define SSL_USE_TLS1_2_CIPHERS(s) \
348 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
350 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
351 * flags because it may not be set to correct version yet.
353 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
354 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
355 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
357 * Determine if a client should send signature algorithms extension:
358 * as with TLS1.2 cipher we can't rely on method flags.
360 # define SSL_CLIENT_USE_SIGALGS(s) \
361 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
363 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
364 (((value) >= TLSEXT_max_fragment_length_512) && \
365 ((value) <= TLSEXT_max_fragment_length_4096))
366 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
367 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
368 # define GET_MAX_FRAGMENT_LENGTH(session) \
369 (512U << (session->ext.max_fragment_len_mode - 1))
371 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
372 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
374 /* Mostly for SSLv3 */
375 # define SSL_PKEY_RSA 0
376 # define SSL_PKEY_RSA_PSS_SIGN 1
377 # define SSL_PKEY_DSA_SIGN 2
378 # define SSL_PKEY_ECC 3
379 # define SSL_PKEY_GOST01 4
380 # define SSL_PKEY_GOST12_256 5
381 # define SSL_PKEY_GOST12_512 6
382 # define SSL_PKEY_ED25519 7
383 # define SSL_PKEY_NUM 8
385 * Pseudo-constant. GOST cipher suites can use different certs for 1
386 * SSL_CIPHER. So let's see which one we have in fact.
388 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
391 * SSL_kRSA <- RSA_ENC
392 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
393 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
394 * SSL_aRSA <- RSA_ENC | RSA_SIGN
395 * SSL_aDSS <- DSA_SIGN
399 #define CERT_INVALID 0
400 #define CERT_PUBLIC_KEY 1
401 #define CERT_PRIVATE_KEY 2
404 /* CipherSuite length. SSLv3 and all TLS versions. */
405 # define TLS_CIPHER_LEN 2
406 /* used to hold info on the particular ciphers used */
407 struct ssl_cipher_st
{
409 const char *name
; /* text name */
410 const char *stdname
; /* RFC name */
411 uint32_t id
; /* id, 4 bytes, first is version */
413 * changed in 1.0.0: these four used to be portions of a single value
416 uint32_t algorithm_mkey
; /* key exchange algorithm */
417 uint32_t algorithm_auth
; /* server authentication */
418 uint32_t algorithm_enc
; /* symmetric encryption */
419 uint32_t algorithm_mac
; /* symmetric authentication */
420 int min_tls
; /* minimum SSL/TLS protocol version */
421 int max_tls
; /* maximum SSL/TLS protocol version */
422 int min_dtls
; /* minimum DTLS protocol version */
423 int max_dtls
; /* maximum DTLS protocol version */
424 uint32_t algo_strength
; /* strength and export flags */
425 uint32_t algorithm2
; /* Extra flags */
426 int32_t strength_bits
; /* Number of bits really used */
427 uint32_t alg_bits
; /* Number of bits for algorithm */
430 /* Used to hold SSL/TLS functions */
431 struct ssl_method_st
{
435 int (*ssl_new
) (SSL
*s
);
436 int (*ssl_clear
) (SSL
*s
);
437 void (*ssl_free
) (SSL
*s
);
438 int (*ssl_accept
) (SSL
*s
);
439 int (*ssl_connect
) (SSL
*s
);
440 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
441 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
442 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
443 int (*ssl_shutdown
) (SSL
*s
);
444 int (*ssl_renegotiate
) (SSL
*s
);
445 int (*ssl_renegotiate_check
) (SSL
*s
, int);
446 int (*ssl_read_bytes
) (SSL
*s
, int type
, int *recvd_type
,
447 unsigned char *buf
, size_t len
, int peek
,
449 int (*ssl_write_bytes
) (SSL
*s
, int type
, const void *buf_
, size_t len
,
451 int (*ssl_dispatch_alert
) (SSL
*s
);
452 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
453 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
454 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
455 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
457 size_t (*ssl_pending
) (const SSL
*s
);
458 int (*num_ciphers
) (void);
459 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
460 long (*get_timeout
) (void);
461 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
462 int (*ssl_version
) (void);
463 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
464 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
468 * Lets make this into an ASN.1 type structure as follows
469 * SSL_SESSION_ID ::= SEQUENCE {
470 * version INTEGER, -- structure version number
471 * SSLversion INTEGER, -- SSL version number
472 * Cipher OCTET STRING, -- the 3 byte cipher ID
473 * Session_ID OCTET STRING, -- the Session ID
474 * Master_key OCTET STRING, -- the master key
475 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
476 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
477 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
478 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
479 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
480 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
481 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
482 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
483 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
484 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
485 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
486 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
487 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
488 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
490 * Look in ssl/ssl_asn1.c for more details
491 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
493 struct ssl_session_st
{
494 int ssl_version
; /* what ssl version session info is being kept
496 size_t master_key_length
;
498 /* TLSv1.3 early_secret used for external PSKs */
499 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
501 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
504 unsigned char master_key
[TLS13_MAX_RESUMPTION_MASTER_LENGTH
];
505 /* session_id - valid? */
506 size_t session_id_length
;
507 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
509 * this is used to determine whether the session is being reused in the
510 * appropriate context. It is up to the application to set this, via
513 size_t sid_ctx_length
;
514 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
515 # ifndef OPENSSL_NO_PSK
516 char *psk_identity_hint
;
520 * Used to indicate that session resumption is not allowed. Applications
521 * can also set this bit for a new session via not_resumable_session_cb
522 * to disable session caching and tickets.
525 /* This is the cert and type for the other end. */
528 /* Certificate chain peer sent. */
529 STACK_OF(X509
) *peer_chain
;
531 * when app_verify_callback accepts a session where the peer's
532 * certificate is not ok, we must remember the error for session reuse:
534 long verify_result
; /* only for servers */
535 CRYPTO_REF_COUNT references
;
538 unsigned int compress_meth
; /* Need to lookup the method */
539 const SSL_CIPHER
*cipher
;
540 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
541 * load the 'cipher' structure */
542 STACK_OF(SSL_CIPHER
) *ciphers
; /* shared ciphers? */
543 CRYPTO_EX_DATA ex_data
; /* application specific data */
545 * These are used to make removal of session-ids more efficient and to
546 * implement a maximum cache size.
548 struct ssl_session_st
*prev
, *next
;
552 # ifndef OPENSSL_NO_EC
553 size_t ecpointformats_len
;
554 unsigned char *ecpointformats
; /* peer's list */
555 # endif /* OPENSSL_NO_EC */
556 size_t supportedgroups_len
;
557 uint16_t *supportedgroups
; /* peer's list */
559 unsigned char *tick
; /* Session ticket */
560 size_t ticklen
; /* Session ticket length */
561 /* Session lifetime hint in seconds */
562 unsigned long tick_lifetime_hint
;
563 uint32_t tick_age_add
;
564 unsigned char *tick_nonce
;
565 size_t tick_nonce_len
;
567 /* Max number of bytes that can be sent as early data */
568 uint32_t max_early_data
;
569 /* The ALPN protocol selected for this session */
570 unsigned char *alpn_selected
;
571 size_t alpn_selected_len
;
573 * Maximum Fragment Length as per RFC 4366.
574 * If this value does not contain RFC 4366 allowed values (1-4) then
575 * either the Maximum Fragment Length Negotiation failed or was not
578 uint8_t max_fragment_len_mode
;
580 # ifndef OPENSSL_NO_SRP
587 /* Extended master secret support */
588 # define SSL_SESS_FLAG_EXTMS 0x1
590 # ifndef OPENSSL_NO_SRP
592 typedef struct srp_ctx_st
{
593 /* param for all the callbacks */
595 /* set client Hello login callback */
596 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
597 /* set SRP N/g param callback for verification */
598 int (*SRP_verify_param_callback
) (SSL
*, void *);
599 /* set SRP client passwd callback */
600 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
602 BIGNUM
*N
, *g
, *s
, *B
, *A
;
606 unsigned long srp_Mask
;
612 SSL_EARLY_DATA_NONE
= 0,
613 SSL_EARLY_DATA_CONNECT_RETRY
,
614 SSL_EARLY_DATA_CONNECTING
,
615 SSL_EARLY_DATA_WRITE_RETRY
,
616 SSL_EARLY_DATA_WRITING
,
617 SSL_EARLY_DATA_UNAUTH_WRITING
,
618 SSL_EARLY_DATA_FINISHED_WRITING
,
619 SSL_EARLY_DATA_ACCEPT_RETRY
,
620 SSL_EARLY_DATA_ACCEPTING
,
621 SSL_EARLY_DATA_READ_RETRY
,
622 SSL_EARLY_DATA_READING
,
623 SSL_EARLY_DATA_FINISHED_READING
624 } SSL_EARLY_DATA_STATE
;
627 * We check that the amount of unreadable early data doesn't exceed
628 * max_early_data. max_early_data is given in plaintext bytes. However if it is
629 * unreadable then we only know the number of ciphertext bytes. We also don't
630 * know how much the overhead should be because it depends on the ciphersuite.
631 * We make a small allowance. We assume 5 records of actual data plus the end
632 * of early data alert record. Each record has a tag and a content type byte.
633 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
634 * content of the alert record either which is 2 bytes.
636 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
639 * The allowance we have between the client's calculated ticket age and our own.
640 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
641 * client's age calculation is different by more than this than our own then we
642 * do not allow that ticket for early_data.
644 # define TICKET_AGE_ALLOWANCE (10 * 1000)
646 #define MAX_COMPRESSIONS_SIZE 255
654 typedef struct raw_extension_st
{
655 /* Raw packet data for the extension */
657 /* Set to 1 if the extension is present or 0 otherwise */
659 /* Set to 1 if we have already parsed the extension or 0 otherwise */
661 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
663 /* Track what order extensions are received in (0-based). */
664 size_t received_order
;
669 unsigned int legacy_version
;
670 unsigned char random
[SSL3_RANDOM_SIZE
];
671 size_t session_id_len
;
672 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
673 size_t dtls_cookie_len
;
674 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
676 size_t compressions_len
;
677 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
679 size_t pre_proc_exts_len
;
680 RAW_EXTENSION
*pre_proc_exts
;
684 * Extension index values NOTE: Any updates to these defines should be mirrored
685 * with equivalent updates to ext_defs in extensions.c
687 typedef enum tlsext_index_en
{
688 TLSEXT_IDX_renegotiate
,
689 TLSEXT_IDX_server_name
,
690 TLSEXT_IDX_max_fragment_length
,
692 TLSEXT_IDX_ec_point_formats
,
693 TLSEXT_IDX_supported_groups
,
694 TLSEXT_IDX_session_ticket
,
695 TLSEXT_IDX_status_request
,
696 TLSEXT_IDX_next_proto_neg
,
697 TLSEXT_IDX_application_layer_protocol_negotiation
,
699 TLSEXT_IDX_encrypt_then_mac
,
700 TLSEXT_IDX_signed_certificate_timestamp
,
701 TLSEXT_IDX_extended_master_secret
,
702 TLSEXT_IDX_signature_algorithms
,
703 TLSEXT_IDX_supported_versions
,
704 TLSEXT_IDX_psk_kex_modes
,
705 TLSEXT_IDX_key_share
,
707 TLSEXT_IDX_cryptopro_bug
,
708 TLSEXT_IDX_early_data
,
709 TLSEXT_IDX_certificate_authorities
,
712 /* Dummy index - must always be the last entry */
713 TLSEXT_IDX_num_builtins
716 DEFINE_LHASH_OF(SSL_SESSION
);
717 /* Needed in ssl_cert.c */
718 DEFINE_LHASH_OF(X509_NAME
);
720 # define TLSEXT_KEYNAME_LENGTH 16
723 const SSL_METHOD
*method
;
724 STACK_OF(SSL_CIPHER
) *cipher_list
;
725 /* same as above but sorted for lookup */
726 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
727 struct x509_store_st
/* X509_STORE */ *cert_store
;
728 LHASH_OF(SSL_SESSION
) *sessions
;
730 * Most session-ids that will be cached, default is
731 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
733 size_t session_cache_size
;
734 struct ssl_session_st
*session_cache_head
;
735 struct ssl_session_st
*session_cache_tail
;
737 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
738 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
739 * means only SSL_accept will cache SSL_SESSIONS.
741 uint32_t session_cache_mode
;
743 * If timeout is not 0, it is the default timeout value set when
744 * SSL_new() is called. This has been put in to make life easier to set
747 long session_timeout
;
749 * If this callback is not null, it will be called each time a session id
750 * is added to the cache. If this function returns 1, it means that the
751 * callback will do a SSL_SESSION_free() when it has finished using it.
752 * Otherwise, on 0, it means the callback has finished with it. If
753 * remove_session_cb is not null, it will be called when a session-id is
754 * removed from the cache. After the call, OpenSSL will
755 * SSL_SESSION_free() it.
757 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
758 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
759 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
760 const unsigned char *data
, int len
,
763 int sess_connect
; /* SSL new conn - started */
764 int sess_connect_renegotiate
; /* SSL reneg - requested */
765 int sess_connect_good
; /* SSL new conne/reneg - finished */
766 int sess_accept
; /* SSL new accept - started */
767 int sess_accept_renegotiate
; /* SSL reneg - requested */
768 int sess_accept_good
; /* SSL accept/reneg - finished */
769 int sess_miss
; /* session lookup misses */
770 int sess_timeout
; /* reuse attempt on timeouted session */
771 int sess_cache_full
; /* session removed due to full cache */
772 int sess_hit
; /* session reuse actually done */
773 int sess_cb_hit
; /* session-id that was not in the cache was
774 * passed back via the callback. This
775 * indicates that the application is supplying
776 * session-id's from other processes - spooky
780 CRYPTO_REF_COUNT references
;
782 /* if defined, these override the X509_verify_cert() calls */
783 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
784 void *app_verify_arg
;
786 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
787 * ('app_verify_callback' was called with just one argument)
790 /* Default password callback. */
791 pem_password_cb
*default_passwd_callback
;
793 /* Default password callback user data. */
794 void *default_passwd_callback_userdata
;
796 /* get client cert callback */
797 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
799 /* cookie generate callback */
800 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
801 unsigned int *cookie_len
);
803 /* verify cookie callback */
804 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
805 unsigned int cookie_len
);
807 CRYPTO_EX_DATA ex_data
;
809 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
810 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3->sha1' */
812 STACK_OF(X509
) *extra_certs
;
813 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
815 /* Default values used when no per-SSL value is defined follow */
817 /* used if SSL's info_callback is NULL */
818 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
821 * What we put in certificate_authorities extension for TLS 1.3
822 * (ClientHello and CertificateRequest) or just client cert requests for
825 STACK_OF(X509_NAME
) *ca_names
;
828 * Default values to use in SSL structures follow (these are copied by
834 int min_proto_version
;
835 int max_proto_version
;
836 size_t max_cert_list
;
838 struct cert_st
/* CERT */ *cert
;
841 /* callback that allows applications to peek at protocol messages */
842 void (*msg_callback
) (int write_p
, int version
, int content_type
,
843 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
844 void *msg_callback_arg
;
846 uint32_t verify_mode
;
847 size_t sid_ctx_length
;
848 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
849 /* called 'verify_callback' in the SSL */
850 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
852 /* Default generate session ID callback. */
853 GEN_SESSION_CB generate_session_id
;
855 X509_VERIFY_PARAM
*param
;
859 # ifndef OPENSSL_NO_CT
860 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
862 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
863 * If they are not, the connection should be aborted.
865 ssl_ct_validation_cb ct_validation_callback
;
866 void *ct_validation_callback_arg
;
870 * If we're using more than one pipeline how should we divide the data
871 * up between the pipes?
873 size_t split_send_fragment
;
875 * Maximum amount of data to send in one fragment. actual record size can
876 * be more than this due to padding and MAC overheads.
878 size_t max_send_fragment
;
880 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
881 size_t max_pipelines
;
883 /* The default read buffer length to use (0 means not set) */
884 size_t default_read_buf_len
;
886 # ifndef OPENSSL_NO_ENGINE
888 * Engine to pass requests for client certs to
890 ENGINE
*client_cert_engine
;
893 /* ClientHello callback. Mostly for extensions, but not entirely. */
894 SSL_client_hello_cb_fn client_hello_cb
;
895 void *client_hello_cb_arg
;
897 /* TLS extensions. */
899 /* TLS extensions servername callback */
900 int (*servername_cb
) (SSL
*, int *, void *);
901 void *servername_arg
;
902 /* RFC 4507 session ticket keys */
903 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
904 unsigned char tick_hmac_key
[32];
905 unsigned char tick_aes_key
[32];
906 /* Callback to support customisation of ticket key setting */
907 int (*ticket_key_cb
) (SSL
*ssl
,
908 unsigned char *name
, unsigned char *iv
,
909 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
911 /* certificate status request info */
912 /* Callback for status request */
913 int (*status_cb
) (SSL
*ssl
, void *arg
);
915 /* ext status type used for CSR extension (OCSP Stapling) */
917 /* RFC 4366 Maximum Fragment Length Negotiation */
918 uint8_t max_fragment_len_mode
;
920 # ifndef OPENSSL_NO_EC
921 /* EC extension values inherited by SSL structure */
922 size_t ecpointformats_len
;
923 unsigned char *ecpointformats
;
924 size_t supportedgroups_len
;
925 uint16_t *supportedgroups
;
926 # endif /* OPENSSL_NO_EC */
929 * ALPN information (we are in the process of transitioning from NPN to
934 * For a server, this contains a callback function that allows the
935 * server to select the protocol for the connection.
936 * out: on successful return, this must point to the raw protocol
937 * name (without the length prefix).
938 * outlen: on successful return, this contains the length of |*out|.
939 * in: points to the client's list of supported protocols in
941 * inlen: the length of |in|.
943 int (*alpn_select_cb
) (SSL
*s
,
944 const unsigned char **out
,
945 unsigned char *outlen
,
946 const unsigned char *in
,
947 unsigned int inlen
, void *arg
);
948 void *alpn_select_cb_arg
;
951 * For a client, this contains the list of supported protocols in wire
957 # ifndef OPENSSL_NO_NEXTPROTONEG
958 /* Next protocol negotiation information */
961 * For a server, this contains a callback function by which the set of
962 * advertised protocols can be provided.
964 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
965 void *npn_advertised_cb_arg
;
967 * For a client, this contains a callback function that selects the next
968 * protocol from the list provided by the server.
970 SSL_CTX_npn_select_cb_func npn_select_cb
;
971 void *npn_select_cb_arg
;
975 # ifndef OPENSSL_NO_PSK
976 SSL_psk_client_cb_func psk_client_callback
;
977 SSL_psk_server_cb_func psk_server_callback
;
979 SSL_psk_find_session_cb_func psk_find_session_cb
;
980 SSL_psk_use_session_cb_func psk_use_session_cb
;
982 # ifndef OPENSSL_NO_SRP
983 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
986 /* Shared DANE context */
987 struct dane_ctx_st dane
;
989 /* SRTP profiles we are willing to do from RFC 5764 */
990 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
992 * Callback for disabling session caching and ticket support on a session
993 * basis, depending on the chosen cipher.
995 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1000 * Callback for logging key material for use with debugging tools like
1001 * Wireshark. The callback should log `line` followed by a newline.
1003 SSL_CTX_keylog_cb_func keylog_callback
;
1005 /* The maximum number of bytes that can be sent as early data */
1006 uint32_t max_early_data
;
1008 /* TLS1.3 padding callback */
1009 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1010 void *record_padding_arg
;
1011 size_t block_padding
;
1016 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1021 const SSL_METHOD
*method
;
1023 * There are 2 BIO's even though they are normally both the same. This
1024 * is so data can be read and written to different handlers
1026 /* used by SSL_read */
1028 /* used by SSL_write */
1030 /* used during session-id reuse to concatenate messages */
1033 * This holds a variable that indicates what we were doing when a 0 or -1
1034 * is returned. This is needed for non-blocking IO so we know what
1035 * request needs re-doing when in SSL_accept or SSL_connect
1038 int (*handshake_func
) (SSL
*);
1040 * Imagine that here's a boolean member "init" that is switched as soon
1041 * as SSL_set_{accept/connect}_state is called for the first time, so
1042 * that "state" and "handshake_func" are properly initialized. But as
1043 * handshake_func is == 0 until then, we use this test instead of an
1046 /* are we the server side? */
1049 * Generate a new session or reuse an old one.
1050 * NB: For servers, the 'new' session may actually be a previously
1051 * cached session or even the previous session unless
1052 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1055 /* don't send shutdown packets */
1057 /* we have shut things down, 0x01 sent, 0x02 for received */
1061 SSL_EARLY_DATA_STATE early_data_state
;
1062 BUF_MEM
*init_buf
; /* buffer used during init */
1063 void *init_msg
; /* pointer to handshake message body, set by
1064 * ssl3_get_message() */
1065 size_t init_num
; /* amount read/written */
1066 size_t init_off
; /* amount read/written */
1067 struct ssl3_state_st
*s3
; /* SSLv3 variables */
1068 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
1069 /* callback that allows applications to peek at protocol messages */
1070 void (*msg_callback
) (int write_p
, int version
, int content_type
,
1071 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
1072 void *msg_callback_arg
;
1073 int hit
; /* reusing a previous session */
1074 X509_VERIFY_PARAM
*param
;
1075 /* Per connection DANE state */
1078 STACK_OF(SSL_CIPHER
) *cipher_list
;
1079 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
1081 * These are the ones being used, the ones in SSL_SESSION are the ones to
1082 * be 'copied' into these ones
1086 * The TLS1.3 secrets. The resumption master secret is stored in the
1089 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
1090 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
1091 unsigned char master_secret
[EVP_MAX_MD_SIZE
];
1092 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
1093 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
1094 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
1095 unsigned char handshake_traffic_hash
[EVP_MAX_MD_SIZE
];
1096 unsigned char client_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1097 unsigned char server_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1098 unsigned char exporter_master_secret
[EVP_MAX_MD_SIZE
];
1099 EVP_CIPHER_CTX
*enc_read_ctx
; /* cryptographic state */
1100 unsigned char read_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static read IV */
1101 EVP_MD_CTX
*read_hash
; /* used for mac generation */
1102 COMP_CTX
*compress
; /* compression */
1103 COMP_CTX
*expand
; /* uncompress */
1104 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1105 unsigned char write_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static write IV */
1106 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1107 /* Count of how many KeyUpdate messages we have received */
1108 unsigned int key_update_count
;
1111 /* This is used to hold the server certificate used */
1112 struct cert_st
/* CERT */ *cert
;
1115 * The hash of all messages prior to the CertificateVerify, and the length
1118 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
1119 size_t cert_verify_hash_len
;
1121 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1122 enum {SSL_HRR_NONE
= 0, SSL_HRR_PENDING
, SSL_HRR_COMPLETE
}
1123 hello_retry_request
;
1126 * the session_id_context is used to ensure sessions are only reused in
1127 * the appropriate context
1129 size_t sid_ctx_length
;
1130 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
1131 /* This can also be in the session once a session is established */
1132 SSL_SESSION
*session
;
1133 /* TLSv1.3 PSK session */
1134 SSL_SESSION
*psksession
;
1135 unsigned char *psksession_id
;
1136 size_t psksession_id_len
;
1137 /* Default generate session ID callback. */
1138 GEN_SESSION_CB generate_session_id
;
1140 * The temporary TLSv1.3 session id. This isn't really a session id at all
1141 * but is a random value sent in the legacy session id field.
1143 unsigned char tmp_session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
1144 size_t tmp_session_id_len
;
1147 * 0 don't care about verify failure.
1148 * 1 fail if verify fails
1150 uint32_t verify_mode
;
1151 /* fail if callback returns 0 */
1152 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1153 /* optional informational callback */
1154 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1155 /* error bytes to be written */
1159 # ifndef OPENSSL_NO_PSK
1160 SSL_psk_client_cb_func psk_client_callback
;
1161 SSL_psk_server_cb_func psk_server_callback
;
1163 SSL_psk_find_session_cb_func psk_find_session_cb
;
1164 SSL_psk_use_session_cb_func psk_use_session_cb
;
1166 /* Verified chain of peer */
1167 STACK_OF(X509
) *verified_chain
;
1169 /* extra application data */
1170 CRYPTO_EX_DATA ex_data
;
1171 /* for server side, keep the list of CA_dn we can use */
1172 STACK_OF(X509_NAME
) *ca_names
;
1173 CRYPTO_REF_COUNT references
;
1174 /* protocol behaviour */
1178 int min_proto_version
;
1179 int max_proto_version
;
1180 size_t max_cert_list
;
1183 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1184 * secret and SSLv3/TLS (<=1.2) rollback check
1188 * If we're using more than one pipeline how should we divide the data
1189 * up between the pipes?
1191 size_t split_send_fragment
;
1193 * Maximum amount of data to send in one fragment. actual record size can
1194 * be more than this due to padding and MAC overheads.
1196 size_t max_send_fragment
;
1197 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1198 size_t max_pipelines
;
1201 /* Built-in extension flags */
1202 uint8_t extflags
[TLSEXT_IDX_num_builtins
];
1203 /* TLS extension debug callback */
1204 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1205 const unsigned char *data
, int len
, void *arg
);
1208 /* certificate status request info */
1209 /* Status type or -1 if no status type */
1211 /* Raw extension data, if seen */
1212 unsigned char *scts
;
1213 /* Length of raw extension data, if seen */
1215 /* Expect OCSP CertificateStatus message */
1216 int status_expected
;
1219 /* OCSP status request only */
1220 STACK_OF(OCSP_RESPID
) *ids
;
1221 X509_EXTENSIONS
*exts
;
1222 /* OCSP response received or to be sent */
1223 unsigned char *resp
;
1227 /* RFC4507 session ticket expected to be received or sent */
1228 int ticket_expected
;
1229 # ifndef OPENSSL_NO_EC
1230 size_t ecpointformats_len
;
1232 unsigned char *ecpointformats
;
1233 # endif /* OPENSSL_NO_EC */
1234 size_t supportedgroups_len
;
1236 uint16_t *supportedgroups
;
1237 /* TLS Session Ticket extension override */
1238 TLS_SESSION_TICKET_EXT
*session_ticket
;
1239 /* TLS Session Ticket extension callback */
1240 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1241 void *session_ticket_cb_arg
;
1242 /* TLS pre-shared secret session resumption */
1243 tls_session_secret_cb_fn session_secret_cb
;
1244 void *session_secret_cb_arg
;
1246 * For a client, this contains the list of supported protocols in wire
1249 unsigned char *alpn
;
1252 * Next protocol negotiation. For the client, this is the protocol that
1253 * we sent in NextProtocol and is set when handling ServerHello
1254 * extensions. For a server, this is the client's selected_protocol from
1255 * NextProtocol and is set when handling the NextProtocol message, before
1256 * the Finished message.
1261 /* The available PSK key exchange modes */
1264 /* Set to one if we have negotiated ETM */
1267 /* Are we expecting to receive early data? */
1269 /* Is the session suitable for early data? */
1272 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1273 unsigned char *tls13_cookie
;
1274 size_t tls13_cookie_len
;
1276 * Maximum Fragment Length as per RFC 4366.
1277 * If this member contains one of the allowed values (1-4)
1278 * then we should include Maximum Fragment Length Negotiation
1279 * extension in Client Hello.
1280 * Please note that value of this member does not have direct
1281 * effect. The actual (binding) value is stored in SSL_SESSION,
1282 * as this extension is optional on server side.
1284 uint8_t max_fragment_len_mode
;
1288 * Parsed form of the ClientHello, kept around across client_hello_cb
1291 CLIENTHELLO_MSG
*clienthello
;
1294 * no further mod of servername
1295 * 0 : call the servername extension callback.
1296 * 1 : prepare 2, allow last ack just after in server callback.
1297 * 2 : don't call servername callback, no ack in server hello
1299 int servername_done
;
1300 # ifndef OPENSSL_NO_CT
1302 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1303 * If they are not, the connection should be aborted.
1305 ssl_ct_validation_cb ct_validation_callback
;
1306 /* User-supplied argument that is passed to the ct_validation_callback */
1307 void *ct_validation_callback_arg
;
1309 * Consolidated stack of SCTs from all sources.
1310 * Lazily populated by CT_get_peer_scts(SSL*)
1312 STACK_OF(SCT
) *scts
;
1313 /* Have we attempted to find/parse SCTs yet? */
1316 SSL_CTX
*session_ctx
; /* initial ctx, used to store sessions */
1318 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1319 /* What's been chosen */
1320 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1322 * 1 if we are renegotiating.
1323 * 2 if we are a server and are inside a handshake
1324 * (i.e. not just sending a HelloRequest)
1327 /* If sending a KeyUpdate is pending */
1329 # ifndef OPENSSL_NO_SRP
1330 /* ctx for SRP authentication */
1334 * Callback for disabling session caching and ticket support on a session
1335 * basis, depending on the chosen cipher.
1337 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1338 RECORD_LAYER rlayer
;
1339 /* Default password callback. */
1340 pem_password_cb
*default_passwd_callback
;
1341 /* Default password callback user data. */
1342 void *default_passwd_callback_userdata
;
1343 /* Async Job info */
1345 ASYNC_WAIT_CTX
*waitctx
;
1348 /* The maximum number of plaintext bytes that can be sent as early data */
1349 uint32_t max_early_data
;
1351 * The number of bytes of early data received so far. If we accepted early
1352 * data then this is a count of the plaintext bytes. If we rejected it then
1353 * this is a count of the ciphertext bytes.
1355 uint32_t early_data_count
;
1357 /* TLS1.3 padding callback */
1358 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1359 void *record_padding_arg
;
1360 size_t block_padding
;
1362 CRYPTO_RWLOCK
*lock
;
1367 * Structure containing table entry of values associated with the signature
1368 * algorithms (signature scheme) extension
1370 typedef struct sigalg_lookup_st
{
1371 /* TLS 1.3 signature scheme name */
1373 /* Raw value used in extension */
1375 /* NID of hash algorithm or NID_undef if no hash */
1377 /* Index of hash algorithm or -1 if no hash algorithm */
1379 /* NID of signature algorithm */
1381 /* Index of signature algorithm */
1383 /* Combined hash and signature NID, if any */
1385 /* Required public key curve (ECDSA only) */
1389 typedef struct tls_group_info_st
{
1390 int nid
; /* Curve NID */
1391 int secbits
; /* Bits of security (from SP800-57) */
1392 uint16_t flags
; /* Flags: currently just group type */
1396 # define TLS_CURVE_TYPE 0x3 /* Mask for group type */
1397 # define TLS_CURVE_PRIME 0x0
1398 # define TLS_CURVE_CHAR2 0x1
1399 # define TLS_CURVE_CUSTOM 0x2
1401 typedef struct cert_pkey_st CERT_PKEY
;
1404 * Structure containing table entry of certificate info corresponding to
1408 int nid
; /* NID of pubic key algorithm */
1409 uint32_t amask
; /* authmask corresponding to key type */
1412 typedef struct ssl3_state_st
{
1414 size_t read_mac_secret_size
;
1415 unsigned char read_mac_secret
[EVP_MAX_MD_SIZE
];
1416 size_t write_mac_secret_size
;
1417 unsigned char write_mac_secret
[EVP_MAX_MD_SIZE
];
1418 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1419 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1420 /* flags for countermeasure against known-IV weakness */
1421 int need_empty_fragments
;
1422 int empty_fragment_done
;
1423 /* used during startup, digest all incoming/outgoing packets */
1424 BIO
*handshake_buffer
;
1426 * When handshake digest is determined, buffer is hashed and
1427 * freed and MD_CTX for the required digest is stored here.
1429 EVP_MD_CTX
*handshake_dgst
;
1431 * Set whenever an expected ChangeCipherSpec message is processed.
1432 * Unset when the peer's Finished message is received.
1433 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1435 int change_cipher_spec
;
1439 * we allow one fatal and one warning alert to be outstanding, send close
1440 * alert via the warning alert
1443 unsigned char send_alert
[2];
1445 * This flag is set when we should renegotiate ASAP, basically when there
1446 * is no more data in the read or write buffers
1449 int total_renegotiations
;
1450 int num_renegotiations
;
1451 int in_read_app_data
;
1453 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1454 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1455 size_t finish_md_len
;
1456 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1457 size_t peer_finish_md_len
;
1458 size_t message_size
;
1460 /* used to hold the new cipher we are going to use */
1461 const SSL_CIPHER
*new_cipher
;
1462 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1463 EVP_PKEY
*pkey
; /* holds short lived DH/ECDH key */
1465 /* used for certificate requests */
1467 /* Certificate types in certificate request message. */
1470 /* Certificate authorities list peer sent */
1471 STACK_OF(X509_NAME
) *peer_ca_names
;
1472 size_t key_block_length
;
1473 unsigned char *key_block
;
1474 const EVP_CIPHER
*new_sym_enc
;
1475 const EVP_MD
*new_hash
;
1476 int new_mac_pkey_type
;
1477 size_t new_mac_secret_size
;
1478 # ifndef OPENSSL_NO_COMP
1479 const SSL_COMP
*new_compression
;
1481 char *new_compression
;
1484 /* Raw values of the cipher list from a client */
1485 unsigned char *ciphers_raw
;
1486 size_t ciphers_rawlen
;
1487 /* Temporary storage for premaster secret */
1490 # ifndef OPENSSL_NO_PSK
1491 /* Temporary storage for PSK key */
1495 /* Signature algorithm we actually use */
1496 const SIGALG_LOOKUP
*sigalg
;
1497 /* Pointer to certificate we use */
1500 * signature algorithms peer reports: e.g. supported signature
1501 * algorithms extension for server or as part of a certificate
1502 * request for client.
1504 uint16_t *peer_sigalgs
;
1505 /* Size of above array */
1506 size_t peer_sigalgslen
;
1507 /* Sigalg peer actually uses */
1508 const SIGALG_LOOKUP
*peer_sigalg
;
1510 * Set if corresponding CERT_PKEY can be used with current
1511 * SSL session: e.g. appropriate curve, signature algorithms etc.
1512 * If zero it can't be used at all.
1514 uint32_t valid_flags
[SSL_PKEY_NUM
];
1516 * For servers the following masks are for the key and auth algorithms
1517 * that are supported by the certs below. For clients they are masks of
1518 * *disabled* algorithms based on the current session.
1523 * The following are used by the client to see if a cipher is allowed or
1524 * not. It contains the minimum and maximum version the client's using
1525 * based on what it knows so far.
1531 /* Connection binding to prevent renegotiation attacks */
1532 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1533 size_t previous_client_finished_len
;
1534 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1535 size_t previous_server_finished_len
;
1536 int send_connection_binding
; /* TODOEKR */
1538 # ifndef OPENSSL_NO_NEXTPROTONEG
1540 * Set if we saw the Next Protocol Negotiation extension from our peer.
1546 * ALPN information (we are in the process of transitioning from NPN to
1551 * In a server these point to the selected ALPN protocol after the
1552 * ClientHello has been processed. In a client these contain the protocol
1553 * that the server selected once the ServerHello has been processed.
1555 unsigned char *alpn_selected
;
1556 size_t alpn_selected_len
;
1557 /* used by the server to know what options were proposed */
1558 unsigned char *alpn_proposed
;
1559 size_t alpn_proposed_len
;
1560 /* used by the client to know if it actually sent alpn */
1563 # ifndef OPENSSL_NO_EC
1565 * This is set to true if we believe that this is a version of Safari
1566 * running on OS X 10.6 or newer. We wish to know this because Safari on
1567 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1569 char is_probably_safari
;
1570 # endif /* !OPENSSL_NO_EC */
1572 /* For clients: peer temporary key */
1573 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1574 /* The group_id for the DH/ECDH key */
1581 /* DTLS structures */
1583 # ifndef OPENSSL_NO_SCTP
1584 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1587 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1588 # define DTLS1_MAX_MTU_OVERHEAD 48
1591 * Flag used in message reuse to indicate the buffer contains the record
1592 * header as well as the the handshake message header.
1594 # define DTLS1_SKIP_RECORD_HEADER 2
1596 struct dtls1_retransmit_state
{
1597 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1598 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1599 COMP_CTX
*compress
; /* compression */
1600 SSL_SESSION
*session
;
1601 unsigned short epoch
;
1604 struct hm_header_st
{
1610 unsigned int is_ccs
;
1611 struct dtls1_retransmit_state saved_retransmit_state
;
1614 struct dtls1_timeout_st
{
1615 /* Number of read timeouts so far */
1616 unsigned int read_timeouts
;
1617 /* Number of write timeouts so far */
1618 unsigned int write_timeouts
;
1619 /* Number of alerts received so far */
1620 unsigned int num_alerts
;
1623 typedef struct hm_fragment_st
{
1624 struct hm_header_st msg_header
;
1625 unsigned char *fragment
;
1626 unsigned char *reassembly
;
1629 typedef struct pqueue_st pqueue
;
1630 typedef struct pitem_st pitem
;
1633 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1638 typedef struct pitem_st
*piterator
;
1640 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1641 void pitem_free(pitem
*item
);
1642 pqueue
*pqueue_new(void);
1643 void pqueue_free(pqueue
*pq
);
1644 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1645 pitem
*pqueue_peek(pqueue
*pq
);
1646 pitem
*pqueue_pop(pqueue
*pq
);
1647 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1648 pitem
*pqueue_iterator(pqueue
*pq
);
1649 pitem
*pqueue_next(piterator
*iter
);
1650 size_t pqueue_size(pqueue
*pq
);
1652 typedef struct dtls1_state_st
{
1653 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1655 unsigned int cookie_verified
;
1656 /* handshake message numbers */
1657 unsigned short handshake_write_seq
;
1658 unsigned short next_handshake_write_seq
;
1659 unsigned short handshake_read_seq
;
1660 /* Buffered handshake messages */
1661 pqueue
*buffered_messages
;
1662 /* Buffered (sent) handshake records */
1663 pqueue
*sent_messages
;
1664 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1665 size_t mtu
; /* max DTLS packet size */
1666 struct hm_header_st w_msg_hdr
;
1667 struct hm_header_st r_msg_hdr
;
1668 struct dtls1_timeout_st timeout
;
1670 * Indicates when the last handshake msg sent will timeout
1672 struct timeval next_timeout
;
1673 /* Timeout duration */
1674 unsigned int timeout_duration_us
;
1676 unsigned int retransmitting
;
1677 # ifndef OPENSSL_NO_SCTP
1678 int shutdown_received
;
1681 DTLS_timer_cb timer_cb
;
1685 # ifndef OPENSSL_NO_EC
1687 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1689 # define EXPLICIT_PRIME_CURVE_TYPE 1
1690 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1691 # define NAMED_CURVE_TYPE 3
1692 # endif /* OPENSSL_NO_EC */
1694 struct cert_pkey_st
{
1696 EVP_PKEY
*privatekey
;
1697 /* Chain for this certificate */
1698 STACK_OF(X509
) *chain
;
1700 * serverinfo data for this certificate. The data is in TLS Extension
1701 * wire format, specifically it's a series of records like:
1702 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1704 * uint8_t data[length];
1706 unsigned char *serverinfo
;
1707 size_t serverinfo_length
;
1709 /* Retrieve Suite B flags */
1710 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1711 /* Uses to check strict mode: suite B modes are always strict */
1712 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1713 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1716 ENDPOINT_CLIENT
= 0,
1723 unsigned short ext_type
;
1725 /* The context which this extension applies to */
1726 unsigned int context
;
1728 * Per-connection flags relating to this extension type: not used if
1729 * part of an SSL_CTX structure.
1732 SSL_custom_ext_add_cb_ex add_cb
;
1733 SSL_custom_ext_free_cb_ex free_cb
;
1735 SSL_custom_ext_parse_cb_ex parse_cb
;
1737 } custom_ext_method
;
1739 /* ext_flags values */
1742 * Indicates an extension has been received. Used to check for unsolicited or
1743 * duplicate extensions.
1745 # define SSL_EXT_FLAG_RECEIVED 0x1
1747 * Indicates an extension has been sent: used to enable sending of
1748 * corresponding ServerHello extension.
1750 # define SSL_EXT_FLAG_SENT 0x2
1753 custom_ext_method
*meths
;
1755 } custom_ext_methods
;
1757 typedef struct cert_st
{
1758 /* Current active set */
1760 * ALWAYS points to an element of the pkeys array
1761 * Probably it would make more sense to store
1762 * an index, not a pointer.
1765 # ifndef OPENSSL_NO_DH
1767 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
1770 /* Flags related to certificates */
1771 uint32_t cert_flags
;
1772 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
1773 /* Custom certificate types sent in certificate request message. */
1777 * supported signature algorithms. When set on a client this is sent in
1778 * the client hello as the supported signature algorithms extension. For
1779 * servers it represents the signature algorithms we are willing to use.
1781 uint16_t *conf_sigalgs
;
1782 /* Size of above array */
1783 size_t conf_sigalgslen
;
1785 * Client authentication signature algorithms, if not set then uses
1786 * conf_sigalgs. On servers these will be the signature algorithms sent
1787 * to the client in a certificate request for TLS 1.2. On a client this
1788 * represents the signature algorithms we are willing to use for client
1791 uint16_t *client_sigalgs
;
1792 /* Size of above array */
1793 size_t client_sigalgslen
;
1795 * Signature algorithms shared by client and server: cached because these
1796 * are used most often.
1798 const SIGALG_LOOKUP
**shared_sigalgs
;
1799 size_t shared_sigalgslen
;
1801 * Certificate setup callback: if set is called whenever a certificate
1802 * may be required (client or server). the callback can then examine any
1803 * appropriate parameters and setup any certificates required. This
1804 * allows advanced applications to select certificates on the fly: for
1805 * example based on supported signature algorithms or curves.
1807 int (*cert_cb
) (SSL
*ssl
, void *arg
);
1810 * Optional X509_STORE for chain building or certificate validation If
1811 * NULL the parent SSL_CTX store is used instead.
1813 X509_STORE
*chain_store
;
1814 X509_STORE
*verify_store
;
1815 /* Custom extensions */
1816 custom_ext_methods custext
;
1817 /* Security callback */
1818 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1819 void *other
, void *ex
);
1820 /* Security level */
1823 # ifndef OPENSSL_NO_PSK
1824 /* If not NULL psk identity hint to use for servers */
1825 char *psk_identity_hint
;
1827 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
1828 CRYPTO_RWLOCK
*lock
;
1831 # define FP_ICC (int (*)(const void *,const void *))
1834 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1835 * of a mess of functions, but hell, think of it as an opaque structure :-)
1837 typedef struct ssl3_enc_method
{
1838 int (*enc
) (SSL
*, SSL3_RECORD
*, size_t, int);
1839 int (*mac
) (SSL
*, SSL3_RECORD
*, unsigned char *, int);
1840 int (*setup_key_block
) (SSL
*);
1841 int (*generate_master_secret
) (SSL
*, unsigned char *, unsigned char *,
1843 int (*change_cipher_state
) (SSL
*, int);
1844 size_t (*final_finish_mac
) (SSL
*, const char *, size_t, unsigned char *);
1845 const char *client_finished_label
;
1846 size_t client_finished_label_len
;
1847 const char *server_finished_label
;
1848 size_t server_finished_label_len
;
1849 int (*alert_value
) (int);
1850 int (*export_keying_material
) (SSL
*, unsigned char *, size_t,
1851 const char *, size_t,
1852 const unsigned char *, size_t,
1854 /* Various flags indicating protocol version requirements */
1856 /* Set the handshake header */
1857 int (*set_handshake_header
) (SSL
*s
, WPACKET
*pkt
, int type
);
1858 /* Close construction of the handshake message */
1859 int (*close_construct_packet
) (SSL
*s
, WPACKET
*pkt
, int htype
);
1860 /* Write out handshake message */
1861 int (*do_write
) (SSL
*s
);
1864 # define ssl_set_handshake_header(s, pkt, htype) \
1865 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1866 # define ssl_close_construct_packet(s, pkt, htype) \
1867 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1868 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1870 /* Values for enc_flags */
1872 /* Uses explicit IV for CBC mode */
1873 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1874 /* Uses signature algorithms extension */
1875 # define SSL_ENC_FLAG_SIGALGS 0x2
1876 /* Uses SHA256 default PRF */
1877 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1879 # define SSL_ENC_FLAG_DTLS 0x8
1881 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1882 * apply to others in future.
1884 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1886 # ifndef OPENSSL_NO_COMP
1887 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1888 typedef struct ssl3_comp_st
{
1889 int comp_id
; /* The identifier byte for this compression
1891 char *name
; /* Text name used for the compression type */
1892 COMP_METHOD
*method
; /* The method :-) */
1896 typedef enum downgrade_en
{
1903 * Dummy status type for the status_type extension. Indicates no status type
1906 #define TLSEXT_STATUSTYPE_nothing -1
1908 /* Sigalgs values */
1909 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1910 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1911 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1912 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
1913 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1914 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1915 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1916 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1917 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1918 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1919 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1920 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
1921 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1922 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1923 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1924 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1925 #define TLSEXT_SIGALG_dsa_sha224 0x0302
1926 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1927 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1928 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1929 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1931 #define TLSEXT_SIGALG_ed25519 0x0807
1933 /* Known PSK key exchange modes */
1934 #define TLSEXT_KEX_MODE_KE 0x00
1935 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1938 * Internal representations of key exchange modes
1940 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1941 #define TLSEXT_KEX_MODE_FLAG_KE 1
1942 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1944 /* An invalid index into the TLSv1.3 PSK identities */
1945 #define TLSEXT_PSK_BAD_IDENTITY -1
1947 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1948 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1950 /* A dummy signature value not valid for TLSv1.2 signature algs */
1951 #define TLSEXT_signature_rsa_pss 0x0101
1953 /* TLSv1.3 downgrade protection sentinel values */
1954 extern const unsigned char tls11downgrade
[8];
1955 extern const unsigned char tls12downgrade
[8];
1957 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
1959 __owur
const SSL_METHOD
*ssl_bad_method(int ver
);
1960 __owur
const SSL_METHOD
*sslv3_method(void);
1961 __owur
const SSL_METHOD
*sslv3_server_method(void);
1962 __owur
const SSL_METHOD
*sslv3_client_method(void);
1963 __owur
const SSL_METHOD
*tlsv1_method(void);
1964 __owur
const SSL_METHOD
*tlsv1_server_method(void);
1965 __owur
const SSL_METHOD
*tlsv1_client_method(void);
1966 __owur
const SSL_METHOD
*tlsv1_1_method(void);
1967 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
1968 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
1969 __owur
const SSL_METHOD
*tlsv1_2_method(void);
1970 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
1971 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
1972 __owur
const SSL_METHOD
*tlsv1_3_method(void);
1973 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
1974 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
1975 __owur
const SSL_METHOD
*dtlsv1_method(void);
1976 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
1977 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
1978 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
1979 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
1980 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
1981 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
1983 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
1984 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
1985 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
1986 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
1987 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
1988 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
1989 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
1992 * Flags for SSL methods
1994 # define SSL_METHOD_NO_FIPS (1U<<0)
1995 # define SSL_METHOD_NO_SUITEB (1U<<1)
1997 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1998 s_connect, enc_data) \
1999 const SSL_METHOD *func_name(void) \
2001 static const SSL_METHOD func_name##_data= { \
2015 ssl3_renegotiate_check, \
2018 ssl3_dispatch_alert, \
2021 ssl3_get_cipher_by_char, \
2022 ssl3_put_cipher_by_char, \
2026 tls1_default_timeout, \
2028 ssl_undefined_void_function, \
2029 ssl3_callback_ctrl, \
2030 ssl3_ctx_callback_ctrl, \
2032 return &func_name##_data; \
2035 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2036 const SSL_METHOD *func_name(void) \
2038 static const SSL_METHOD func_name##_data= { \
2040 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2052 ssl3_renegotiate_check, \
2055 ssl3_dispatch_alert, \
2058 ssl3_get_cipher_by_char, \
2059 ssl3_put_cipher_by_char, \
2063 ssl3_default_timeout, \
2065 ssl_undefined_void_function, \
2066 ssl3_callback_ctrl, \
2067 ssl3_ctx_callback_ctrl, \
2069 return &func_name##_data; \
2072 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2073 s_connect, enc_data) \
2074 const SSL_METHOD *func_name(void) \
2076 static const SSL_METHOD func_name##_data= { \
2090 ssl3_renegotiate_check, \
2092 dtls1_write_app_data_bytes, \
2093 dtls1_dispatch_alert, \
2096 ssl3_get_cipher_by_char, \
2097 ssl3_put_cipher_by_char, \
2101 dtls1_default_timeout, \
2103 ssl_undefined_void_function, \
2104 ssl3_callback_ctrl, \
2105 ssl3_ctx_callback_ctrl, \
2107 return &func_name##_data; \
2110 struct openssl_ssl_test_functions
{
2111 int (*p_ssl_init_wbio_buffer
) (SSL
*s
);
2112 int (*p_ssl3_setup_buffers
) (SSL
*s
);
2115 const char *ssl_protocol_to_string(int version
);
2117 /* Returns true if certificate and private key for 'idx' are present */
2118 static ossl_inline
int ssl_has_cert(const SSL
*s
, int idx
)
2120 if (idx
< 0 || idx
>= SSL_PKEY_NUM
)
2122 return s
->cert
->pkeys
[idx
].x509
!= NULL
2123 && s
->cert
->pkeys
[idx
].privatekey
!= NULL
;
2126 static ossl_inline
void tls1_get_peer_groups(SSL
*s
, const uint16_t **pgroups
,
2129 *pgroups
= s
->session
->ext
.supportedgroups
;
2130 *pgroupslen
= s
->session
->ext
.supportedgroups_len
;
2133 # ifndef OPENSSL_UNIT_TEST
2135 __owur
int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
);
2136 __owur
int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
);
2137 void ssl_clear_cipher_ctx(SSL
*s
);
2138 int ssl_clear_bad_session(SSL
*s
);
2139 __owur CERT
*ssl_cert_new(void);
2140 __owur CERT
*ssl_cert_dup(CERT
*cert
);
2141 void ssl_cert_clear_certs(CERT
*c
);
2142 void ssl_cert_free(CERT
*c
);
2143 __owur
int ssl_generate_session_id(SSL
*s
, SSL_SESSION
*ss
);
2144 __owur
int ssl_get_new_session(SSL
*s
, int session
);
2145 __owur
int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
);
2146 __owur SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
);
2147 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
2148 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
2149 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2150 const SSL_CIPHER
*const *bp
);
2151 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
2152 STACK_OF(SSL_CIPHER
) **pref
,
2153 STACK_OF(SSL_CIPHER
)
2155 const char *rule_str
,
2157 __owur
int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
, int sslv2format
);
2158 __owur
int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
2159 STACK_OF(SSL_CIPHER
) **skp
,
2160 STACK_OF(SSL_CIPHER
) **scsvs
, int sslv2format
,
2162 void ssl_update_cache(SSL
*s
, int mode
);
2163 __owur
int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
2164 const EVP_MD
**md
, int *mac_pkey_type
,
2165 size_t *mac_secret_size
, SSL_COMP
**comp
,
2167 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
2168 size_t *int_overhead
, size_t *blocksize
,
2169 size_t *ext_overhead
);
2170 __owur
int ssl_cert_is_disabled(size_t idx
);
2171 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
,
2172 const unsigned char *ptr
,
2174 __owur
int ssl_cert_set0_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2175 __owur
int ssl_cert_set1_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2176 __owur
int ssl_cert_add0_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2177 __owur
int ssl_cert_add1_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2178 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
2179 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
2180 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
2182 __owur
int ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
);
2183 __owur
int ssl_build_cert_chain(SSL
*s
, SSL_CTX
*ctx
, int flags
);
2184 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
2187 __owur
int ssl_randbytes(SSL
*s
, unsigned char *buf
, size_t num
);
2188 __owur
int ssl_security(const SSL
*s
, int op
, int bits
, int nid
, void *other
);
2189 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
2192 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_pkey(const EVP_PKEY
*pk
,
2194 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_idx(size_t idx
);
2196 int ssl_undefined_function(SSL
*s
);
2197 __owur
int ssl_undefined_void_function(void);
2198 __owur
int ssl_undefined_const_function(const SSL
*s
);
2199 __owur
int ssl_get_server_cert_serverinfo(SSL
*s
,
2200 const unsigned char **serverinfo
,
2201 size_t *serverinfo_length
);
2202 void ssl_set_masks(SSL
*s
);
2203 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
2204 __owur
int ssl_verify_alarm_type(long type
);
2205 void ssl_sort_cipher_list(void);
2206 int ssl_load_ciphers(void);
2207 __owur
int ssl_fill_hello_random(SSL
*s
, int server
, unsigned char *field
,
2208 size_t len
, DOWNGRADE dgrd
);
2209 __owur
int ssl_generate_master_secret(SSL
*s
, unsigned char *pms
, size_t pmslen
,
2211 __owur EVP_PKEY
*ssl_generate_pkey(EVP_PKEY
*pm
);
2212 __owur
int ssl_derive(SSL
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
2214 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
2215 __owur
unsigned int ssl_get_max_send_fragment(const SSL
*ssl
);
2216 __owur
unsigned int ssl_get_split_send_fragment(const SSL
*ssl
);
2218 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_id(uint32_t id
);
2219 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_std_name(const char *stdname
);
2220 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
2221 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
2223 int ssl3_init_finished_mac(SSL
*s
);
2224 __owur
int ssl3_setup_key_block(SSL
*s
);
2225 __owur
int ssl3_change_cipher_state(SSL
*s
, int which
);
2226 void ssl3_cleanup_key_block(SSL
*s
);
2227 __owur
int ssl3_do_write(SSL
*s
, int type
);
2228 int ssl3_send_alert(SSL
*s
, int level
, int desc
);
2229 __owur
int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
2230 unsigned char *p
, size_t len
,
2231 size_t *secret_size
);
2232 __owur
int ssl3_get_req_cert_type(SSL
*s
, WPACKET
*pkt
);
2233 __owur
int ssl3_num_ciphers(void);
2234 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2235 int ssl3_renegotiate(SSL
*ssl
);
2236 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2237 __owur
int ssl3_dispatch_alert(SSL
*s
);
2238 __owur
size_t ssl3_final_finish_mac(SSL
*s
, const char *sender
, size_t slen
,
2240 __owur
int ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, size_t len
);
2241 void ssl3_free_digest_list(SSL
*s
);
2242 __owur
unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
,
2244 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,
2245 STACK_OF(SSL_CIPHER
) *clnt
,
2246 STACK_OF(SSL_CIPHER
) *srvr
);
2247 __owur
int ssl3_digest_cached_records(SSL
*s
, int keep
);
2248 __owur
int ssl3_new(SSL
*s
);
2249 void ssl3_free(SSL
*s
);
2250 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2251 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2252 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2253 __owur
int ssl3_shutdown(SSL
*s
);
2254 int ssl3_clear(SSL
*s
);
2255 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2256 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2257 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2258 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2260 __owur
int ssl3_do_change_cipher_spec(SSL
*ssl
);
2261 __owur
long ssl3_default_timeout(void);
2263 __owur
int ssl3_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2264 __owur
int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2265 __owur
int tls_setup_handshake(SSL
*s
);
2266 __owur
int dtls1_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2267 __owur
int dtls1_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2268 __owur
int ssl3_handshake_write(SSL
*s
);
2270 __owur
int ssl_allow_compression(SSL
*s
);
2272 __owur
int ssl_version_supported(const SSL
*s
, int version
);
2274 __owur
int ssl_set_client_hello_version(SSL
*s
);
2275 __owur
int ssl_check_version_downgrade(SSL
*s
);
2276 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2277 __owur
int ssl_choose_server_version(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2279 __owur
int ssl_choose_client_version(SSL
*s
, int version
,
2280 RAW_EXTENSION
*extensions
);
2281 int ssl_get_min_max_version(const SSL
*s
, int *min_version
, int *max_version
);
2283 __owur
long tls1_default_timeout(void);
2284 __owur
int dtls1_do_write(SSL
*s
, int type
);
2285 void dtls1_set_message_header(SSL
*s
,
2288 size_t frag_off
, size_t frag_len
);
2290 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf_
, size_t len
,
2293 __owur
int dtls1_read_failed(SSL
*s
, int code
);
2294 __owur
int dtls1_buffer_message(SSL
*s
, int ccs
);
2295 __owur
int dtls1_retransmit_message(SSL
*s
, unsigned short seq
, int *found
);
2296 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2297 int dtls1_retransmit_buffered_messages(SSL
*s
);
2298 void dtls1_clear_received_buffer(SSL
*s
);
2299 void dtls1_clear_sent_buffer(SSL
*s
);
2300 void dtls1_get_message_header(unsigned char *data
,
2301 struct hm_header_st
*msg_hdr
);
2302 __owur
long dtls1_default_timeout(void);
2303 __owur
struct timeval
*dtls1_get_timeout(SSL
*s
, struct timeval
*timeleft
);
2304 __owur
int dtls1_check_timeout_num(SSL
*s
);
2305 __owur
int dtls1_handle_timeout(SSL
*s
);
2306 void dtls1_start_timer(SSL
*s
);
2307 void dtls1_stop_timer(SSL
*s
);
2308 __owur
int dtls1_is_timer_expired(SSL
*s
);
2309 void dtls1_double_timeout(SSL
*s
);
2310 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2312 __owur
size_t dtls1_min_mtu(SSL
*s
);
2313 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2314 __owur
int dtls1_query_mtu(SSL
*s
);
2316 __owur
int tls1_new(SSL
*s
);
2317 void tls1_free(SSL
*s
);
2318 int tls1_clear(SSL
*s
);
2320 __owur
int dtls1_new(SSL
*s
);
2321 void dtls1_free(SSL
*s
);
2322 int dtls1_clear(SSL
*s
);
2323 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2324 __owur
int dtls1_shutdown(SSL
*s
);
2326 __owur
int dtls1_dispatch_alert(SSL
*s
);
2328 __owur
int ssl_init_wbio_buffer(SSL
*s
);
2329 int ssl_free_wbio_buffer(SSL
*s
);
2331 __owur
int tls1_change_cipher_state(SSL
*s
, int which
);
2332 __owur
int tls1_setup_key_block(SSL
*s
);
2333 __owur
size_t tls1_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2335 __owur
int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
2336 unsigned char *p
, size_t len
,
2337 size_t *secret_size
);
2338 __owur
int tls13_setup_key_block(SSL
*s
);
2339 __owur
size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2341 __owur
int tls13_change_cipher_state(SSL
*s
, int which
);
2342 __owur
int tls13_update_key(SSL
*s
, int send
);
2343 __owur
int tls13_hkdf_expand(SSL
*s
, const EVP_MD
*md
,
2344 const unsigned char *secret
,
2345 const unsigned char *label
, size_t labellen
,
2346 const unsigned char *data
, size_t datalen
,
2347 unsigned char *out
, size_t outlen
);
2348 __owur
int tls13_derive_key(SSL
*s
, const EVP_MD
*md
,
2349 const unsigned char *secret
, unsigned char *key
,
2351 __owur
int tls13_derive_iv(SSL
*s
, const EVP_MD
*md
,
2352 const unsigned char *secret
, unsigned char *iv
,
2354 __owur
int tls13_derive_finishedkey(SSL
*s
, const EVP_MD
*md
,
2355 const unsigned char *secret
,
2356 unsigned char *fin
, size_t finlen
);
2357 int tls13_generate_secret(SSL
*s
, const EVP_MD
*md
,
2358 const unsigned char *prevsecret
,
2359 const unsigned char *insecret
,
2361 unsigned char *outsecret
);
2362 __owur
int tls13_generate_handshake_secret(SSL
*s
,
2363 const unsigned char *insecret
,
2364 size_t insecretlen
);
2365 __owur
int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
2366 unsigned char *prev
, size_t prevlen
,
2367 size_t *secret_size
);
2368 __owur
int tls1_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2369 const char *label
, size_t llen
,
2370 const unsigned char *p
, size_t plen
,
2372 __owur
int tls13_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2373 const char *label
, size_t llen
,
2374 const unsigned char *context
,
2375 size_t contextlen
, int use_context
);
2376 __owur
int tls1_alert_code(int code
);
2377 __owur
int tls13_alert_code(int code
);
2378 __owur
int ssl3_alert_code(int code
);
2380 # ifndef OPENSSL_NO_EC
2381 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
);
2384 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2386 # ifndef OPENSSL_NO_EC
2388 __owur
const TLS_GROUP_INFO
*tls1_group_id_lookup(uint16_t curve_id
);
2389 __owur
int tls1_check_group_id(SSL
*s
, uint16_t group_id
);
2390 __owur
uint16_t tls1_shared_group(SSL
*s
, int nmatch
);
2391 __owur
int tls1_set_groups(uint16_t **pext
, size_t *pextlen
,
2392 int *curves
, size_t ncurves
);
2393 __owur
int tls1_set_groups_list(uint16_t **pext
, size_t *pextlen
,
2395 void tls1_get_formatlist(SSL
*s
, const unsigned char **pformats
,
2396 size_t *num_formats
);
2397 __owur
int tls1_check_ec_tmp_key(SSL
*s
, unsigned long id
);
2398 __owur EVP_PKEY
*ssl_generate_pkey_group(SSL
*s
, uint16_t id
);
2399 __owur EVP_PKEY
*ssl_generate_param_group(uint16_t id
);
2400 # endif /* OPENSSL_NO_EC */
2402 __owur
int tls_curve_allowed(SSL
*s
, uint16_t curve
, int op
);
2403 void tls1_get_supported_groups(SSL
*s
, const uint16_t **pgroups
,
2404 size_t *pgroupslen
);
2406 __owur
int tls1_set_server_sigalgs(SSL
*s
);
2408 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2409 typedef enum ticket_en
{
2410 /* fatal error, malloc failure */
2411 TICKET_FATAL_ERR_MALLOC
,
2412 /* fatal error, either from parsing or decrypting the ticket */
2413 TICKET_FATAL_ERR_OTHER
,
2414 /* No ticket present */
2416 /* Empty ticket present */
2418 /* the ticket couldn't be decrypted */
2420 /* a ticket was successfully decrypted */
2422 /* same as above but the ticket needs to be renewed */
2423 TICKET_SUCCESS_RENEW
2426 __owur TICKET_RETURN
tls_get_ticket_from_client(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2428 __owur TICKET_RETURN
tls_decrypt_ticket(SSL
*s
, const unsigned char *etick
,
2430 const unsigned char *sess_id
,
2431 size_t sesslen
, SSL_SESSION
**psess
);
2433 __owur
int tls_use_ticket(SSL
*s
);
2435 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL
*s
, int op
);
2437 __owur
int tls1_set_sigalgs_list(CERT
*c
, const char *str
, int client
);
2438 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2440 int tls1_check_chain(SSL
*s
, X509
*x
, EVP_PKEY
*pk
, STACK_OF(X509
) *chain
,
2442 void tls1_set_cert_validity(SSL
*s
);
2444 # ifndef OPENSSL_NO_CT
2445 __owur
int ssl_validate_ct(SSL
*s
);
2448 # ifndef OPENSSL_NO_DH
2449 __owur DH
*ssl_get_auto_dh(SSL
*s
);
2452 __owur
int ssl_security_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
, int is_ee
);
2453 __owur
int ssl_security_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
, X509
*ex
,
2456 int tls_choose_sigalg(SSL
*s
, int fatalerrs
);
2458 __owur EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
);
2459 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
);
2460 __owur
long ssl_get_algorithm2(SSL
*s
);
2461 __owur
int tls12_copy_sigalgs(SSL
*s
, WPACKET
*pkt
,
2462 const uint16_t *psig
, size_t psiglen
);
2463 __owur
int tls1_save_u16(PACKET
*pkt
, uint16_t **pdest
, size_t *pdestlen
);
2464 __owur
int tls1_save_sigalgs(SSL
*s
, PACKET
*pkt
);
2465 __owur
int tls1_process_sigalgs(SSL
*s
);
2466 __owur
int tls1_set_peer_legacy_sigalg(SSL
*s
, const EVP_PKEY
*pkey
);
2467 __owur
int tls1_lookup_md(const SIGALG_LOOKUP
*lu
, const EVP_MD
**pmd
);
2468 __owur
size_t tls12_get_psigalgs(SSL
*s
, int sent
, const uint16_t **psigs
);
2469 __owur
int tls12_check_peer_sigalg(SSL
*s
, uint16_t, EVP_PKEY
*pkey
);
2470 void ssl_set_client_disabled(SSL
*s
);
2471 __owur
int ssl_cipher_disabled(SSL
*s
, const SSL_CIPHER
*c
, int op
, int echde
);
2473 __owur
int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
2475 __owur
const EVP_MD
*ssl_md(int idx
);
2476 __owur
const EVP_MD
*ssl_handshake_md(SSL
*s
);
2477 __owur
const EVP_MD
*ssl_prf_md(SSL
*s
);
2480 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2481 * with |ssl|, if logging is enabled. It returns one on success and zero on
2482 * failure. The entry is identified by the first 8 bytes of
2483 * |encrypted_premaster|.
2485 __owur
int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
2486 const uint8_t *encrypted_premaster
,
2487 size_t encrypted_premaster_len
,
2488 const uint8_t *premaster
,
2489 size_t premaster_len
);
2492 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2493 * logging is available. It returns one on success and zero on failure. It tags
2494 * the entry with |label|.
2496 __owur
int ssl_log_secret(SSL
*ssl
, const char *label
,
2497 const uint8_t *secret
, size_t secret_len
);
2499 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2500 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2501 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2502 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2503 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2504 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2507 __owur
char ssl3_cbc_record_digest_supported(const EVP_MD_CTX
*ctx
);
2508 __owur
int ssl3_cbc_digest_record(const EVP_MD_CTX
*ctx
,
2509 unsigned char *md_out
,
2510 size_t *md_out_size
,
2511 const unsigned char header
[13],
2512 const unsigned char *data
,
2513 size_t data_plus_mac_size
,
2514 size_t data_plus_mac_plus_padding_size
,
2515 const unsigned char *mac_secret
,
2516 size_t mac_secret_length
, char is_sslv3
);
2518 __owur
int srp_generate_server_master_secret(SSL
*s
);
2519 __owur
int srp_generate_client_master_secret(SSL
*s
);
2520 __owur
int srp_verify_server_param(SSL
*s
);
2522 /* statem/extensions_cust.c */
2524 custom_ext_method
*custom_ext_find(const custom_ext_methods
*exts
,
2525 ENDPOINT role
, unsigned int ext_type
,
2528 void custom_ext_init(custom_ext_methods
*meths
);
2530 __owur
int custom_ext_parse(SSL
*s
, unsigned int context
, unsigned int ext_type
,
2531 const unsigned char *ext_data
, size_t ext_size
,
2532 X509
*x
, size_t chainidx
);
2533 __owur
int custom_ext_add(SSL
*s
, int context
, WPACKET
*pkt
, X509
*x
,
2534 size_t chainidx
, int maxversion
);
2536 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2537 const custom_ext_methods
*src
);
2538 __owur
int custom_exts_copy_flags(custom_ext_methods
*dst
,
2539 const custom_ext_methods
*src
);
2540 void custom_exts_free(custom_ext_methods
*exts
);
2542 void ssl_comp_free_compression_methods_int(void);
2544 # else /* OPENSSL_UNIT_TEST */
2546 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2547 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers