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_WRITING \
327 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY)
329 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0 \
330 || (s)->s3->tmp.peer_finish_md_len == 0)
332 /* See if we need explicit IV */
333 # define SSL_USE_EXPLICIT_IV(s) \
334 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
336 * See if we use signature algorithms extension and signature algorithm
339 # define SSL_USE_SIGALGS(s) \
340 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
342 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
343 * apply to others in future.
345 # define SSL_USE_TLS1_2_CIPHERS(s) \
346 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
348 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
349 * flags because it may not be set to correct version yet.
351 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
352 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
353 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
355 * Determine if a client should send signature algorithms extension:
356 * as with TLS1.2 cipher we can't rely on method flags.
358 # define SSL_CLIENT_USE_SIGALGS(s) \
359 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
361 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
362 (((value) >= TLSEXT_max_fragment_length_512) && \
363 ((value) <= TLSEXT_max_fragment_length_4096))
364 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
365 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
366 # define GET_MAX_FRAGMENT_LENGTH(session) \
367 (512U << (session->ext.max_fragment_len_mode - 1))
369 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
370 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
372 /* Mostly for SSLv3 */
373 # define SSL_PKEY_RSA 0
374 # define SSL_PKEY_RSA_PSS_SIGN 1
375 # define SSL_PKEY_DSA_SIGN 2
376 # define SSL_PKEY_ECC 3
377 # define SSL_PKEY_GOST01 4
378 # define SSL_PKEY_GOST12_256 5
379 # define SSL_PKEY_GOST12_512 6
380 # define SSL_PKEY_ED25519 7
381 # define SSL_PKEY_NUM 8
383 * Pseudo-constant. GOST cipher suites can use different certs for 1
384 * SSL_CIPHER. So let's see which one we have in fact.
386 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
389 * SSL_kRSA <- RSA_ENC
390 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
391 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
392 * SSL_aRSA <- RSA_ENC | RSA_SIGN
393 * SSL_aDSS <- DSA_SIGN
397 #define CERT_INVALID 0
398 #define CERT_PUBLIC_KEY 1
399 #define CERT_PRIVATE_KEY 2
402 /* CipherSuite length. SSLv3 and all TLS versions. */
403 # define TLS_CIPHER_LEN 2
404 /* used to hold info on the particular ciphers used */
405 struct ssl_cipher_st
{
407 const char *name
; /* text name */
408 const char *stdname
; /* RFC name */
409 uint32_t id
; /* id, 4 bytes, first is version */
411 * changed in 1.0.0: these four used to be portions of a single value
414 uint32_t algorithm_mkey
; /* key exchange algorithm */
415 uint32_t algorithm_auth
; /* server authentication */
416 uint32_t algorithm_enc
; /* symmetric encryption */
417 uint32_t algorithm_mac
; /* symmetric authentication */
418 int min_tls
; /* minimum SSL/TLS protocol version */
419 int max_tls
; /* maximum SSL/TLS protocol version */
420 int min_dtls
; /* minimum DTLS protocol version */
421 int max_dtls
; /* maximum DTLS protocol version */
422 uint32_t algo_strength
; /* strength and export flags */
423 uint32_t algorithm2
; /* Extra flags */
424 int32_t strength_bits
; /* Number of bits really used */
425 uint32_t alg_bits
; /* Number of bits for algorithm */
428 /* Used to hold SSL/TLS functions */
429 struct ssl_method_st
{
433 int (*ssl_new
) (SSL
*s
);
434 int (*ssl_clear
) (SSL
*s
);
435 void (*ssl_free
) (SSL
*s
);
436 int (*ssl_accept
) (SSL
*s
);
437 int (*ssl_connect
) (SSL
*s
);
438 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
439 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
440 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
441 int (*ssl_shutdown
) (SSL
*s
);
442 int (*ssl_renegotiate
) (SSL
*s
);
443 int (*ssl_renegotiate_check
) (SSL
*s
, int);
444 int (*ssl_read_bytes
) (SSL
*s
, int type
, int *recvd_type
,
445 unsigned char *buf
, size_t len
, int peek
,
447 int (*ssl_write_bytes
) (SSL
*s
, int type
, const void *buf_
, size_t len
,
449 int (*ssl_dispatch_alert
) (SSL
*s
);
450 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
451 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
452 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
453 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
455 size_t (*ssl_pending
) (const SSL
*s
);
456 int (*num_ciphers
) (void);
457 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
458 long (*get_timeout
) (void);
459 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
460 int (*ssl_version
) (void);
461 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
462 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
466 * Lets make this into an ASN.1 type structure as follows
467 * SSL_SESSION_ID ::= SEQUENCE {
468 * version INTEGER, -- structure version number
469 * SSLversion INTEGER, -- SSL version number
470 * Cipher OCTET STRING, -- the 3 byte cipher ID
471 * Session_ID OCTET STRING, -- the Session ID
472 * Master_key OCTET STRING, -- the master key
473 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
474 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
475 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
476 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
477 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
478 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
479 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
480 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
481 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
482 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
483 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
484 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
485 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
486 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
488 * Look in ssl/ssl_asn1.c for more details
489 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
491 struct ssl_session_st
{
492 int ssl_version
; /* what ssl version session info is being kept
494 size_t master_key_length
;
496 /* TLSv1.3 early_secret used for external PSKs */
497 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
499 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
502 unsigned char master_key
[TLS13_MAX_RESUMPTION_MASTER_LENGTH
];
503 /* session_id - valid? */
504 size_t session_id_length
;
505 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
507 * this is used to determine whether the session is being reused in the
508 * appropriate context. It is up to the application to set this, via
511 size_t sid_ctx_length
;
512 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
513 # ifndef OPENSSL_NO_PSK
514 char *psk_identity_hint
;
518 * Used to indicate that session resumption is not allowed. Applications
519 * can also set this bit for a new session via not_resumable_session_cb
520 * to disable session caching and tickets.
523 /* This is the cert and type for the other end. */
526 /* Certificate chain peer sent. */
527 STACK_OF(X509
) *peer_chain
;
529 * when app_verify_callback accepts a session where the peer's
530 * certificate is not ok, we must remember the error for session reuse:
532 long verify_result
; /* only for servers */
533 CRYPTO_REF_COUNT references
;
536 unsigned int compress_meth
; /* Need to lookup the method */
537 const SSL_CIPHER
*cipher
;
538 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
539 * load the 'cipher' structure */
540 STACK_OF(SSL_CIPHER
) *ciphers
; /* shared ciphers? */
541 CRYPTO_EX_DATA ex_data
; /* application specific data */
543 * These are used to make removal of session-ids more efficient and to
544 * implement a maximum cache size.
546 struct ssl_session_st
*prev
, *next
;
550 # ifndef OPENSSL_NO_EC
551 size_t ecpointformats_len
;
552 unsigned char *ecpointformats
; /* peer's list */
553 # endif /* OPENSSL_NO_EC */
554 size_t supportedgroups_len
;
555 uint16_t *supportedgroups
; /* peer's list */
557 unsigned char *tick
; /* Session ticket */
558 size_t ticklen
; /* Session ticket length */
559 /* Session lifetime hint in seconds */
560 unsigned long tick_lifetime_hint
;
561 uint32_t tick_age_add
;
562 unsigned char *tick_nonce
;
563 size_t tick_nonce_len
;
565 /* Max number of bytes that can be sent as early data */
566 uint32_t max_early_data
;
567 /* The ALPN protocol selected for this session */
568 unsigned char *alpn_selected
;
569 size_t alpn_selected_len
;
571 * Maximum Fragment Length as per RFC 4366.
572 * If this value does not contain RFC 4366 allowed values (1-4) then
573 * either the Maximum Fragment Length Negotiation failed or was not
576 uint8_t max_fragment_len_mode
;
578 # ifndef OPENSSL_NO_SRP
585 /* Extended master secret support */
586 # define SSL_SESS_FLAG_EXTMS 0x1
588 # ifndef OPENSSL_NO_SRP
590 typedef struct srp_ctx_st
{
591 /* param for all the callbacks */
593 /* set client Hello login callback */
594 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
595 /* set SRP N/g param callback for verification */
596 int (*SRP_verify_param_callback
) (SSL
*, void *);
597 /* set SRP client passwd callback */
598 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
600 BIGNUM
*N
, *g
, *s
, *B
, *A
;
604 unsigned long srp_Mask
;
610 SSL_EARLY_DATA_NONE
= 0,
611 SSL_EARLY_DATA_CONNECT_RETRY
,
612 SSL_EARLY_DATA_CONNECTING
,
613 SSL_EARLY_DATA_WRITE_RETRY
,
614 SSL_EARLY_DATA_WRITING
,
615 SSL_EARLY_DATA_UNAUTH_WRITING
,
616 SSL_EARLY_DATA_FINISHED_WRITING
,
617 SSL_EARLY_DATA_ACCEPT_RETRY
,
618 SSL_EARLY_DATA_ACCEPTING
,
619 SSL_EARLY_DATA_READ_RETRY
,
620 SSL_EARLY_DATA_READING
,
621 SSL_EARLY_DATA_FINISHED_READING
622 } SSL_EARLY_DATA_STATE
;
625 * We check that the amount of unreadable early data doesn't exceed
626 * max_early_data. max_early_data is given in plaintext bytes. However if it is
627 * unreadable then we only know the number of ciphertext bytes. We also don't
628 * know how much the overhead should be because it depends on the ciphersuite.
629 * We make a small allowance. We assume 5 records of actual data plus the end
630 * of early data alert record. Each record has a tag and a content type byte.
631 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
632 * content of the alert record either which is 2 bytes.
634 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
637 * The allowance we have between the client's calculated ticket age and our own.
638 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
639 * client's age calculation is different by more than this than our own then we
640 * do not allow that ticket for early_data.
642 # define TICKET_AGE_ALLOWANCE (10 * 1000)
644 #define MAX_COMPRESSIONS_SIZE 255
652 typedef struct raw_extension_st
{
653 /* Raw packet data for the extension */
655 /* Set to 1 if the extension is present or 0 otherwise */
657 /* Set to 1 if we have already parsed the extension or 0 otherwise */
659 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
661 /* Track what order extensions are received in (0-based). */
662 size_t received_order
;
667 unsigned int legacy_version
;
668 unsigned char random
[SSL3_RANDOM_SIZE
];
669 size_t session_id_len
;
670 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
671 size_t dtls_cookie_len
;
672 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
674 size_t compressions_len
;
675 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
677 size_t pre_proc_exts_len
;
678 RAW_EXTENSION
*pre_proc_exts
;
682 * Extension index values NOTE: Any updates to these defines should be mirrored
683 * with equivalent updates to ext_defs in extensions.c
685 typedef enum tlsext_index_en
{
686 TLSEXT_IDX_renegotiate
,
687 TLSEXT_IDX_server_name
,
688 TLSEXT_IDX_max_fragment_length
,
690 TLSEXT_IDX_ec_point_formats
,
691 TLSEXT_IDX_supported_groups
,
692 TLSEXT_IDX_session_ticket
,
693 TLSEXT_IDX_status_request
,
694 TLSEXT_IDX_next_proto_neg
,
695 TLSEXT_IDX_application_layer_protocol_negotiation
,
697 TLSEXT_IDX_encrypt_then_mac
,
698 TLSEXT_IDX_signed_certificate_timestamp
,
699 TLSEXT_IDX_extended_master_secret
,
700 TLSEXT_IDX_signature_algorithms
,
701 TLSEXT_IDX_supported_versions
,
702 TLSEXT_IDX_psk_kex_modes
,
703 TLSEXT_IDX_key_share
,
705 TLSEXT_IDX_cryptopro_bug
,
706 TLSEXT_IDX_early_data
,
707 TLSEXT_IDX_certificate_authorities
,
710 /* Dummy index - must always be the last entry */
711 TLSEXT_IDX_num_builtins
714 DEFINE_LHASH_OF(SSL_SESSION
);
715 /* Needed in ssl_cert.c */
716 DEFINE_LHASH_OF(X509_NAME
);
718 # define TLSEXT_KEYNAME_LENGTH 16
721 const SSL_METHOD
*method
;
722 STACK_OF(SSL_CIPHER
) *cipher_list
;
723 /* same as above but sorted for lookup */
724 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
725 struct x509_store_st
/* X509_STORE */ *cert_store
;
726 LHASH_OF(SSL_SESSION
) *sessions
;
728 * Most session-ids that will be cached, default is
729 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
731 size_t session_cache_size
;
732 struct ssl_session_st
*session_cache_head
;
733 struct ssl_session_st
*session_cache_tail
;
735 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
736 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
737 * means only SSL_accept will cache SSL_SESSIONS.
739 uint32_t session_cache_mode
;
741 * If timeout is not 0, it is the default timeout value set when
742 * SSL_new() is called. This has been put in to make life easier to set
745 long session_timeout
;
747 * If this callback is not null, it will be called each time a session id
748 * is added to the cache. If this function returns 1, it means that the
749 * callback will do a SSL_SESSION_free() when it has finished using it.
750 * Otherwise, on 0, it means the callback has finished with it. If
751 * remove_session_cb is not null, it will be called when a session-id is
752 * removed from the cache. After the call, OpenSSL will
753 * SSL_SESSION_free() it.
755 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
756 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
757 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
758 const unsigned char *data
, int len
,
761 int sess_connect
; /* SSL new conn - started */
762 int sess_connect_renegotiate
; /* SSL reneg - requested */
763 int sess_connect_good
; /* SSL new conne/reneg - finished */
764 int sess_accept
; /* SSL new accept - started */
765 int sess_accept_renegotiate
; /* SSL reneg - requested */
766 int sess_accept_good
; /* SSL accept/reneg - finished */
767 int sess_miss
; /* session lookup misses */
768 int sess_timeout
; /* reuse attempt on timeouted session */
769 int sess_cache_full
; /* session removed due to full cache */
770 int sess_hit
; /* session reuse actually done */
771 int sess_cb_hit
; /* session-id that was not in the cache was
772 * passed back via the callback. This
773 * indicates that the application is supplying
774 * session-id's from other processes - spooky
778 CRYPTO_REF_COUNT references
;
780 /* if defined, these override the X509_verify_cert() calls */
781 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
782 void *app_verify_arg
;
784 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
785 * ('app_verify_callback' was called with just one argument)
788 /* Default password callback. */
789 pem_password_cb
*default_passwd_callback
;
791 /* Default password callback user data. */
792 void *default_passwd_callback_userdata
;
794 /* get client cert callback */
795 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
797 /* cookie generate callback */
798 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
799 unsigned int *cookie_len
);
801 /* verify cookie callback */
802 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
803 unsigned int cookie_len
);
805 CRYPTO_EX_DATA ex_data
;
807 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
808 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3->sha1' */
810 STACK_OF(X509
) *extra_certs
;
811 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
813 /* Default values used when no per-SSL value is defined follow */
815 /* used if SSL's info_callback is NULL */
816 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
819 * What we put in certificate_authorities extension for TLS 1.3
820 * (ClientHello and CertificateRequest) or just client cert requests for
823 STACK_OF(X509_NAME
) *ca_names
;
826 * Default values to use in SSL structures follow (these are copied by
832 int min_proto_version
;
833 int max_proto_version
;
834 size_t max_cert_list
;
836 struct cert_st
/* CERT */ *cert
;
839 /* callback that allows applications to peek at protocol messages */
840 void (*msg_callback
) (int write_p
, int version
, int content_type
,
841 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
842 void *msg_callback_arg
;
844 uint32_t verify_mode
;
845 size_t sid_ctx_length
;
846 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
847 /* called 'verify_callback' in the SSL */
848 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
850 /* Default generate session ID callback. */
851 GEN_SESSION_CB generate_session_id
;
853 X509_VERIFY_PARAM
*param
;
857 # ifndef OPENSSL_NO_CT
858 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
860 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
861 * If they are not, the connection should be aborted.
863 ssl_ct_validation_cb ct_validation_callback
;
864 void *ct_validation_callback_arg
;
868 * If we're using more than one pipeline how should we divide the data
869 * up between the pipes?
871 size_t split_send_fragment
;
873 * Maximum amount of data to send in one fragment. actual record size can
874 * be more than this due to padding and MAC overheads.
876 size_t max_send_fragment
;
878 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
879 size_t max_pipelines
;
881 /* The default read buffer length to use (0 means not set) */
882 size_t default_read_buf_len
;
884 # ifndef OPENSSL_NO_ENGINE
886 * Engine to pass requests for client certs to
888 ENGINE
*client_cert_engine
;
891 /* ClientHello callback. Mostly for extensions, but not entirely. */
892 SSL_client_hello_cb_fn client_hello_cb
;
893 void *client_hello_cb_arg
;
895 /* TLS extensions. */
897 /* TLS extensions servername callback */
898 int (*servername_cb
) (SSL
*, int *, void *);
899 void *servername_arg
;
900 /* RFC 4507 session ticket keys */
901 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
902 unsigned char tick_hmac_key
[32];
903 unsigned char tick_aes_key
[32];
904 /* Callback to support customisation of ticket key setting */
905 int (*ticket_key_cb
) (SSL
*ssl
,
906 unsigned char *name
, unsigned char *iv
,
907 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
909 /* certificate status request info */
910 /* Callback for status request */
911 int (*status_cb
) (SSL
*ssl
, void *arg
);
913 /* ext status type used for CSR extension (OCSP Stapling) */
915 /* RFC 4366 Maximum Fragment Length Negotiation */
916 uint8_t max_fragment_len_mode
;
918 # ifndef OPENSSL_NO_EC
919 /* EC extension values inherited by SSL structure */
920 size_t ecpointformats_len
;
921 unsigned char *ecpointformats
;
922 size_t supportedgroups_len
;
923 uint16_t *supportedgroups
;
924 # endif /* OPENSSL_NO_EC */
927 * ALPN information (we are in the process of transitioning from NPN to
932 * For a server, this contains a callback function that allows the
933 * server to select the protocol for the connection.
934 * out: on successful return, this must point to the raw protocol
935 * name (without the length prefix).
936 * outlen: on successful return, this contains the length of |*out|.
937 * in: points to the client's list of supported protocols in
939 * inlen: the length of |in|.
941 int (*alpn_select_cb
) (SSL
*s
,
942 const unsigned char **out
,
943 unsigned char *outlen
,
944 const unsigned char *in
,
945 unsigned int inlen
, void *arg
);
946 void *alpn_select_cb_arg
;
949 * For a client, this contains the list of supported protocols in wire
955 # ifndef OPENSSL_NO_NEXTPROTONEG
956 /* Next protocol negotiation information */
959 * For a server, this contains a callback function by which the set of
960 * advertised protocols can be provided.
962 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
963 void *npn_advertised_cb_arg
;
965 * For a client, this contains a callback function that selects the next
966 * protocol from the list provided by the server.
968 SSL_CTX_npn_select_cb_func npn_select_cb
;
969 void *npn_select_cb_arg
;
973 # ifndef OPENSSL_NO_PSK
974 SSL_psk_client_cb_func psk_client_callback
;
975 SSL_psk_server_cb_func psk_server_callback
;
977 SSL_psk_find_session_cb_func psk_find_session_cb
;
978 SSL_psk_use_session_cb_func psk_use_session_cb
;
980 # ifndef OPENSSL_NO_SRP
981 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
984 /* Shared DANE context */
985 struct dane_ctx_st dane
;
987 /* SRTP profiles we are willing to do from RFC 5764 */
988 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
990 * Callback for disabling session caching and ticket support on a session
991 * basis, depending on the chosen cipher.
993 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
998 * Callback for logging key material for use with debugging tools like
999 * Wireshark. The callback should log `line` followed by a newline.
1001 SSL_CTX_keylog_cb_func keylog_callback
;
1003 /* The maximum number of bytes that can be sent as early data */
1004 uint32_t max_early_data
;
1006 /* TLS1.3 padding callback */
1007 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1008 void *record_padding_arg
;
1009 size_t block_padding
;
1014 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1019 const SSL_METHOD
*method
;
1021 * There are 2 BIO's even though they are normally both the same. This
1022 * is so data can be read and written to different handlers
1024 /* used by SSL_read */
1026 /* used by SSL_write */
1028 /* used during session-id reuse to concatenate messages */
1031 * This holds a variable that indicates what we were doing when a 0 or -1
1032 * is returned. This is needed for non-blocking IO so we know what
1033 * request needs re-doing when in SSL_accept or SSL_connect
1036 int (*handshake_func
) (SSL
*);
1038 * Imagine that here's a boolean member "init" that is switched as soon
1039 * as SSL_set_{accept/connect}_state is called for the first time, so
1040 * that "state" and "handshake_func" are properly initialized. But as
1041 * handshake_func is == 0 until then, we use this test instead of an
1044 /* are we the server side? */
1047 * Generate a new session or reuse an old one.
1048 * NB: For servers, the 'new' session may actually be a previously
1049 * cached session or even the previous session unless
1050 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1053 /* don't send shutdown packets */
1055 /* we have shut things down, 0x01 sent, 0x02 for received */
1059 SSL_EARLY_DATA_STATE early_data_state
;
1060 BUF_MEM
*init_buf
; /* buffer used during init */
1061 void *init_msg
; /* pointer to handshake message body, set by
1062 * ssl3_get_message() */
1063 size_t init_num
; /* amount read/written */
1064 size_t init_off
; /* amount read/written */
1065 struct ssl3_state_st
*s3
; /* SSLv3 variables */
1066 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
1067 /* callback that allows applications to peek at protocol messages */
1068 void (*msg_callback
) (int write_p
, int version
, int content_type
,
1069 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
1070 void *msg_callback_arg
;
1071 int hit
; /* reusing a previous session */
1072 X509_VERIFY_PARAM
*param
;
1073 /* Per connection DANE state */
1076 STACK_OF(SSL_CIPHER
) *cipher_list
;
1077 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
1079 * These are the ones being used, the ones in SSL_SESSION are the ones to
1080 * be 'copied' into these ones
1084 * The TLS1.3 secrets. The resumption master secret is stored in the
1087 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
1088 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
1089 unsigned char master_secret
[EVP_MAX_MD_SIZE
];
1090 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
1091 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
1092 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
1093 unsigned char handshake_traffic_hash
[EVP_MAX_MD_SIZE
];
1094 unsigned char client_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1095 unsigned char server_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1096 unsigned char exporter_master_secret
[EVP_MAX_MD_SIZE
];
1097 EVP_CIPHER_CTX
*enc_read_ctx
; /* cryptographic state */
1098 unsigned char read_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static read IV */
1099 EVP_MD_CTX
*read_hash
; /* used for mac generation */
1100 COMP_CTX
*compress
; /* compression */
1101 COMP_CTX
*expand
; /* uncompress */
1102 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1103 unsigned char write_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static write IV */
1104 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1105 /* Count of how many KeyUpdate messages we have received */
1106 unsigned int key_update_count
;
1109 /* This is used to hold the server certificate used */
1110 struct cert_st
/* CERT */ *cert
;
1113 * The hash of all messages prior to the CertificateVerify, and the length
1116 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
1117 size_t cert_verify_hash_len
;
1119 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1120 enum {SSL_HRR_NONE
= 0, SSL_HRR_PENDING
, SSL_HRR_COMPLETE
}
1121 hello_retry_request
;
1124 * the session_id_context is used to ensure sessions are only reused in
1125 * the appropriate context
1127 size_t sid_ctx_length
;
1128 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
1129 /* This can also be in the session once a session is established */
1130 SSL_SESSION
*session
;
1131 /* TLSv1.3 PSK session */
1132 SSL_SESSION
*psksession
;
1133 unsigned char *psksession_id
;
1134 size_t psksession_id_len
;
1135 /* Default generate session ID callback. */
1136 GEN_SESSION_CB generate_session_id
;
1138 * The temporary TLSv1.3 session id. This isn't really a session id at all
1139 * but is a random value sent in the legacy session id field.
1141 unsigned char tmp_session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
1142 size_t tmp_session_id_len
;
1145 * 0 don't care about verify failure.
1146 * 1 fail if verify fails
1148 uint32_t verify_mode
;
1149 /* fail if callback returns 0 */
1150 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1151 /* optional informational callback */
1152 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1153 /* error bytes to be written */
1157 # ifndef OPENSSL_NO_PSK
1158 SSL_psk_client_cb_func psk_client_callback
;
1159 SSL_psk_server_cb_func psk_server_callback
;
1161 SSL_psk_find_session_cb_func psk_find_session_cb
;
1162 SSL_psk_use_session_cb_func psk_use_session_cb
;
1164 /* Verified chain of peer */
1165 STACK_OF(X509
) *verified_chain
;
1167 /* extra application data */
1168 CRYPTO_EX_DATA ex_data
;
1169 /* for server side, keep the list of CA_dn we can use */
1170 STACK_OF(X509_NAME
) *ca_names
;
1171 CRYPTO_REF_COUNT references
;
1172 /* protocol behaviour */
1176 int min_proto_version
;
1177 int max_proto_version
;
1178 size_t max_cert_list
;
1181 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1182 * secret and SSLv3/TLS (<=1.2) rollback check
1186 * If we're using more than one pipeline how should we divide the data
1187 * up between the pipes?
1189 size_t split_send_fragment
;
1191 * Maximum amount of data to send in one fragment. actual record size can
1192 * be more than this due to padding and MAC overheads.
1194 size_t max_send_fragment
;
1195 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1196 size_t max_pipelines
;
1199 /* Built-in extension flags */
1200 uint8_t extflags
[TLSEXT_IDX_num_builtins
];
1201 /* TLS extension debug callback */
1202 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1203 const unsigned char *data
, int len
, void *arg
);
1206 /* certificate status request info */
1207 /* Status type or -1 if no status type */
1209 /* Raw extension data, if seen */
1210 unsigned char *scts
;
1211 /* Length of raw extension data, if seen */
1213 /* Expect OCSP CertificateStatus message */
1214 int status_expected
;
1217 /* OCSP status request only */
1218 STACK_OF(OCSP_RESPID
) *ids
;
1219 X509_EXTENSIONS
*exts
;
1220 /* OCSP response received or to be sent */
1221 unsigned char *resp
;
1225 /* RFC4507 session ticket expected to be received or sent */
1226 int ticket_expected
;
1227 # ifndef OPENSSL_NO_EC
1228 size_t ecpointformats_len
;
1230 unsigned char *ecpointformats
;
1231 # endif /* OPENSSL_NO_EC */
1232 size_t supportedgroups_len
;
1234 uint16_t *supportedgroups
;
1235 /* TLS Session Ticket extension override */
1236 TLS_SESSION_TICKET_EXT
*session_ticket
;
1237 /* TLS Session Ticket extension callback */
1238 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1239 void *session_ticket_cb_arg
;
1240 /* TLS pre-shared secret session resumption */
1241 tls_session_secret_cb_fn session_secret_cb
;
1242 void *session_secret_cb_arg
;
1244 * For a client, this contains the list of supported protocols in wire
1247 unsigned char *alpn
;
1250 * Next protocol negotiation. For the client, this is the protocol that
1251 * we sent in NextProtocol and is set when handling ServerHello
1252 * extensions. For a server, this is the client's selected_protocol from
1253 * NextProtocol and is set when handling the NextProtocol message, before
1254 * the Finished message.
1259 /* The available PSK key exchange modes */
1262 /* Set to one if we have negotiated ETM */
1265 /* Are we expecting to receive early data? */
1267 /* Is the session suitable for early data? */
1270 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1271 unsigned char *tls13_cookie
;
1272 size_t tls13_cookie_len
;
1274 * Maximum Fragment Length as per RFC 4366.
1275 * If this member contains one of the allowed values (1-4)
1276 * then we should include Maximum Fragment Length Negotiation
1277 * extension in Client Hello.
1278 * Please note that value of this member does not have direct
1279 * effect. The actual (binding) value is stored in SSL_SESSION,
1280 * as this extension is optional on server side.
1282 uint8_t max_fragment_len_mode
;
1286 * Parsed form of the ClientHello, kept around across client_hello_cb
1289 CLIENTHELLO_MSG
*clienthello
;
1292 * no further mod of servername
1293 * 0 : call the servername extension callback.
1294 * 1 : prepare 2, allow last ack just after in server callback.
1295 * 2 : don't call servername callback, no ack in server hello
1297 int servername_done
;
1298 # ifndef OPENSSL_NO_CT
1300 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1301 * If they are not, the connection should be aborted.
1303 ssl_ct_validation_cb ct_validation_callback
;
1304 /* User-supplied argument that is passed to the ct_validation_callback */
1305 void *ct_validation_callback_arg
;
1307 * Consolidated stack of SCTs from all sources.
1308 * Lazily populated by CT_get_peer_scts(SSL*)
1310 STACK_OF(SCT
) *scts
;
1311 /* Have we attempted to find/parse SCTs yet? */
1314 SSL_CTX
*session_ctx
; /* initial ctx, used to store sessions */
1316 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1317 /* What's been chosen */
1318 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1320 * 1 if we are renegotiating.
1321 * 2 if we are a server and are inside a handshake
1322 * (i.e. not just sending a HelloRequest)
1325 /* If sending a KeyUpdate is pending */
1327 # ifndef OPENSSL_NO_SRP
1328 /* ctx for SRP authentication */
1332 * Callback for disabling session caching and ticket support on a session
1333 * basis, depending on the chosen cipher.
1335 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1336 RECORD_LAYER rlayer
;
1337 /* Default password callback. */
1338 pem_password_cb
*default_passwd_callback
;
1339 /* Default password callback user data. */
1340 void *default_passwd_callback_userdata
;
1341 /* Async Job info */
1343 ASYNC_WAIT_CTX
*waitctx
;
1346 /* The maximum number of plaintext bytes that can be sent as early data */
1347 uint32_t max_early_data
;
1349 * The number of bytes of early data received so far. If we accepted early
1350 * data then this is a count of the plaintext bytes. If we rejected it then
1351 * this is a count of the ciphertext bytes.
1353 uint32_t early_data_count
;
1355 /* TLS1.3 padding callback */
1356 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1357 void *record_padding_arg
;
1358 size_t block_padding
;
1360 CRYPTO_RWLOCK
*lock
;
1365 * Structure containing table entry of values associated with the signature
1366 * algorithms (signature scheme) extension
1368 typedef struct sigalg_lookup_st
{
1369 /* TLS 1.3 signature scheme name */
1371 /* Raw value used in extension */
1373 /* NID of hash algorithm or NID_undef if no hash */
1375 /* Index of hash algorithm or -1 if no hash algorithm */
1377 /* NID of signature algorithm */
1379 /* Index of signature algorithm */
1381 /* Combined hash and signature NID, if any */
1383 /* Required public key curve (ECDSA only) */
1387 typedef struct tls_group_info_st
{
1388 int nid
; /* Curve NID */
1389 int secbits
; /* Bits of security (from SP800-57) */
1390 uint16_t flags
; /* Flags: currently just group type */
1394 # define TLS_CURVE_TYPE 0x3 /* Mask for group type */
1395 # define TLS_CURVE_PRIME 0x0
1396 # define TLS_CURVE_CHAR2 0x1
1397 # define TLS_CURVE_CUSTOM 0x2
1399 typedef struct cert_pkey_st CERT_PKEY
;
1402 * Structure containing table entry of certificate info corresponding to
1406 int nid
; /* NID of pubic key algorithm */
1407 uint32_t amask
; /* authmask corresponding to key type */
1410 typedef struct ssl3_state_st
{
1412 size_t read_mac_secret_size
;
1413 unsigned char read_mac_secret
[EVP_MAX_MD_SIZE
];
1414 size_t write_mac_secret_size
;
1415 unsigned char write_mac_secret
[EVP_MAX_MD_SIZE
];
1416 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1417 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1418 /* flags for countermeasure against known-IV weakness */
1419 int need_empty_fragments
;
1420 int empty_fragment_done
;
1421 /* used during startup, digest all incoming/outgoing packets */
1422 BIO
*handshake_buffer
;
1424 * When handshake digest is determined, buffer is hashed and
1425 * freed and MD_CTX for the required digest is stored here.
1427 EVP_MD_CTX
*handshake_dgst
;
1429 * Set whenever an expected ChangeCipherSpec message is processed.
1430 * Unset when the peer's Finished message is received.
1431 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1433 int change_cipher_spec
;
1437 * we allow one fatal and one warning alert to be outstanding, send close
1438 * alert via the warning alert
1441 unsigned char send_alert
[2];
1443 * This flag is set when we should renegotiate ASAP, basically when there
1444 * is no more data in the read or write buffers
1447 int total_renegotiations
;
1448 int num_renegotiations
;
1449 int in_read_app_data
;
1451 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1452 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1453 size_t finish_md_len
;
1454 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1455 size_t peer_finish_md_len
;
1456 size_t message_size
;
1458 /* used to hold the new cipher we are going to use */
1459 const SSL_CIPHER
*new_cipher
;
1460 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1461 EVP_PKEY
*pkey
; /* holds short lived DH/ECDH key */
1463 /* used for certificate requests */
1465 /* Certificate types in certificate request message. */
1468 /* Certificate authorities list peer sent */
1469 STACK_OF(X509_NAME
) *peer_ca_names
;
1470 size_t key_block_length
;
1471 unsigned char *key_block
;
1472 const EVP_CIPHER
*new_sym_enc
;
1473 const EVP_MD
*new_hash
;
1474 int new_mac_pkey_type
;
1475 size_t new_mac_secret_size
;
1476 # ifndef OPENSSL_NO_COMP
1477 const SSL_COMP
*new_compression
;
1479 char *new_compression
;
1482 /* Raw values of the cipher list from a client */
1483 unsigned char *ciphers_raw
;
1484 size_t ciphers_rawlen
;
1485 /* Temporary storage for premaster secret */
1488 # ifndef OPENSSL_NO_PSK
1489 /* Temporary storage for PSK key */
1493 /* Signature algorithm we actually use */
1494 const SIGALG_LOOKUP
*sigalg
;
1495 /* Pointer to certificate we use */
1498 * signature algorithms peer reports: e.g. supported signature
1499 * algorithms extension for server or as part of a certificate
1500 * request for client.
1502 uint16_t *peer_sigalgs
;
1503 /* Size of above array */
1504 size_t peer_sigalgslen
;
1505 /* Sigalg peer actually uses */
1506 const SIGALG_LOOKUP
*peer_sigalg
;
1508 * Set if corresponding CERT_PKEY can be used with current
1509 * SSL session: e.g. appropriate curve, signature algorithms etc.
1510 * If zero it can't be used at all.
1512 uint32_t valid_flags
[SSL_PKEY_NUM
];
1514 * For servers the following masks are for the key and auth algorithms
1515 * that are supported by the certs below. For clients they are masks of
1516 * *disabled* algorithms based on the current session.
1521 * The following are used by the client to see if a cipher is allowed or
1522 * not. It contains the minimum and maximum version the client's using
1523 * based on what it knows so far.
1529 /* Connection binding to prevent renegotiation attacks */
1530 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1531 size_t previous_client_finished_len
;
1532 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1533 size_t previous_server_finished_len
;
1534 int send_connection_binding
; /* TODOEKR */
1536 # ifndef OPENSSL_NO_NEXTPROTONEG
1538 * Set if we saw the Next Protocol Negotiation extension from our peer.
1544 * ALPN information (we are in the process of transitioning from NPN to
1549 * In a server these point to the selected ALPN protocol after the
1550 * ClientHello has been processed. In a client these contain the protocol
1551 * that the server selected once the ServerHello has been processed.
1553 unsigned char *alpn_selected
;
1554 size_t alpn_selected_len
;
1555 /* used by the server to know what options were proposed */
1556 unsigned char *alpn_proposed
;
1557 size_t alpn_proposed_len
;
1558 /* used by the client to know if it actually sent alpn */
1561 # ifndef OPENSSL_NO_EC
1563 * This is set to true if we believe that this is a version of Safari
1564 * running on OS X 10.6 or newer. We wish to know this because Safari on
1565 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1567 char is_probably_safari
;
1568 # endif /* !OPENSSL_NO_EC */
1570 /* For clients: peer temporary key */
1571 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1572 /* The group_id for the DH/ECDH key */
1579 /* DTLS structures */
1581 # ifndef OPENSSL_NO_SCTP
1582 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1585 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1586 # define DTLS1_MAX_MTU_OVERHEAD 48
1589 * Flag used in message reuse to indicate the buffer contains the record
1590 * header as well as the the handshake message header.
1592 # define DTLS1_SKIP_RECORD_HEADER 2
1594 struct dtls1_retransmit_state
{
1595 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1596 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1597 COMP_CTX
*compress
; /* compression */
1598 SSL_SESSION
*session
;
1599 unsigned short epoch
;
1602 struct hm_header_st
{
1608 unsigned int is_ccs
;
1609 struct dtls1_retransmit_state saved_retransmit_state
;
1612 struct dtls1_timeout_st
{
1613 /* Number of read timeouts so far */
1614 unsigned int read_timeouts
;
1615 /* Number of write timeouts so far */
1616 unsigned int write_timeouts
;
1617 /* Number of alerts received so far */
1618 unsigned int num_alerts
;
1621 typedef struct hm_fragment_st
{
1622 struct hm_header_st msg_header
;
1623 unsigned char *fragment
;
1624 unsigned char *reassembly
;
1627 typedef struct pqueue_st pqueue
;
1628 typedef struct pitem_st pitem
;
1631 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1636 typedef struct pitem_st
*piterator
;
1638 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1639 void pitem_free(pitem
*item
);
1640 pqueue
*pqueue_new(void);
1641 void pqueue_free(pqueue
*pq
);
1642 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1643 pitem
*pqueue_peek(pqueue
*pq
);
1644 pitem
*pqueue_pop(pqueue
*pq
);
1645 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1646 pitem
*pqueue_iterator(pqueue
*pq
);
1647 pitem
*pqueue_next(piterator
*iter
);
1648 size_t pqueue_size(pqueue
*pq
);
1650 typedef struct dtls1_state_st
{
1651 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1653 unsigned int cookie_verified
;
1654 /* handshake message numbers */
1655 unsigned short handshake_write_seq
;
1656 unsigned short next_handshake_write_seq
;
1657 unsigned short handshake_read_seq
;
1658 /* Buffered handshake messages */
1659 pqueue
*buffered_messages
;
1660 /* Buffered (sent) handshake records */
1661 pqueue
*sent_messages
;
1662 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1663 size_t mtu
; /* max DTLS packet size */
1664 struct hm_header_st w_msg_hdr
;
1665 struct hm_header_st r_msg_hdr
;
1666 struct dtls1_timeout_st timeout
;
1668 * Indicates when the last handshake msg sent will timeout
1670 struct timeval next_timeout
;
1671 /* Timeout duration */
1672 unsigned int timeout_duration_us
;
1674 unsigned int retransmitting
;
1675 # ifndef OPENSSL_NO_SCTP
1676 int shutdown_received
;
1679 DTLS_timer_cb timer_cb
;
1683 # ifndef OPENSSL_NO_EC
1685 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1687 # define EXPLICIT_PRIME_CURVE_TYPE 1
1688 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1689 # define NAMED_CURVE_TYPE 3
1690 # endif /* OPENSSL_NO_EC */
1692 struct cert_pkey_st
{
1694 EVP_PKEY
*privatekey
;
1695 /* Chain for this certificate */
1696 STACK_OF(X509
) *chain
;
1698 * serverinfo data for this certificate. The data is in TLS Extension
1699 * wire format, specifically it's a series of records like:
1700 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1702 * uint8_t data[length];
1704 unsigned char *serverinfo
;
1705 size_t serverinfo_length
;
1707 /* Retrieve Suite B flags */
1708 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1709 /* Uses to check strict mode: suite B modes are always strict */
1710 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1711 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1714 ENDPOINT_CLIENT
= 0,
1721 unsigned short ext_type
;
1723 /* The context which this extension applies to */
1724 unsigned int context
;
1726 * Per-connection flags relating to this extension type: not used if
1727 * part of an SSL_CTX structure.
1730 SSL_custom_ext_add_cb_ex add_cb
;
1731 SSL_custom_ext_free_cb_ex free_cb
;
1733 SSL_custom_ext_parse_cb_ex parse_cb
;
1735 } custom_ext_method
;
1737 /* ext_flags values */
1740 * Indicates an extension has been received. Used to check for unsolicited or
1741 * duplicate extensions.
1743 # define SSL_EXT_FLAG_RECEIVED 0x1
1745 * Indicates an extension has been sent: used to enable sending of
1746 * corresponding ServerHello extension.
1748 # define SSL_EXT_FLAG_SENT 0x2
1751 custom_ext_method
*meths
;
1753 } custom_ext_methods
;
1755 typedef struct cert_st
{
1756 /* Current active set */
1758 * ALWAYS points to an element of the pkeys array
1759 * Probably it would make more sense to store
1760 * an index, not a pointer.
1763 # ifndef OPENSSL_NO_DH
1765 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
1768 /* Flags related to certificates */
1769 uint32_t cert_flags
;
1770 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
1771 /* Custom certificate types sent in certificate request message. */
1775 * supported signature algorithms. When set on a client this is sent in
1776 * the client hello as the supported signature algorithms extension. For
1777 * servers it represents the signature algorithms we are willing to use.
1779 uint16_t *conf_sigalgs
;
1780 /* Size of above array */
1781 size_t conf_sigalgslen
;
1783 * Client authentication signature algorithms, if not set then uses
1784 * conf_sigalgs. On servers these will be the signature algorithms sent
1785 * to the client in a certificate request for TLS 1.2. On a client this
1786 * represents the signature algorithms we are willing to use for client
1789 uint16_t *client_sigalgs
;
1790 /* Size of above array */
1791 size_t client_sigalgslen
;
1793 * Signature algorithms shared by client and server: cached because these
1794 * are used most often.
1796 const SIGALG_LOOKUP
**shared_sigalgs
;
1797 size_t shared_sigalgslen
;
1799 * Certificate setup callback: if set is called whenever a certificate
1800 * may be required (client or server). the callback can then examine any
1801 * appropriate parameters and setup any certificates required. This
1802 * allows advanced applications to select certificates on the fly: for
1803 * example based on supported signature algorithms or curves.
1805 int (*cert_cb
) (SSL
*ssl
, void *arg
);
1808 * Optional X509_STORE for chain building or certificate validation If
1809 * NULL the parent SSL_CTX store is used instead.
1811 X509_STORE
*chain_store
;
1812 X509_STORE
*verify_store
;
1813 /* Custom extensions */
1814 custom_ext_methods custext
;
1815 /* Security callback */
1816 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1817 void *other
, void *ex
);
1818 /* Security level */
1821 # ifndef OPENSSL_NO_PSK
1822 /* If not NULL psk identity hint to use for servers */
1823 char *psk_identity_hint
;
1825 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
1826 CRYPTO_RWLOCK
*lock
;
1829 # define FP_ICC (int (*)(const void *,const void *))
1832 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1833 * of a mess of functions, but hell, think of it as an opaque structure :-)
1835 typedef struct ssl3_enc_method
{
1836 int (*enc
) (SSL
*, SSL3_RECORD
*, size_t, int);
1837 int (*mac
) (SSL
*, SSL3_RECORD
*, unsigned char *, int);
1838 int (*setup_key_block
) (SSL
*);
1839 int (*generate_master_secret
) (SSL
*, unsigned char *, unsigned char *,
1841 int (*change_cipher_state
) (SSL
*, int);
1842 size_t (*final_finish_mac
) (SSL
*, const char *, size_t, unsigned char *);
1843 const char *client_finished_label
;
1844 size_t client_finished_label_len
;
1845 const char *server_finished_label
;
1846 size_t server_finished_label_len
;
1847 int (*alert_value
) (int);
1848 int (*export_keying_material
) (SSL
*, unsigned char *, size_t,
1849 const char *, size_t,
1850 const unsigned char *, size_t,
1852 /* Various flags indicating protocol version requirements */
1854 /* Set the handshake header */
1855 int (*set_handshake_header
) (SSL
*s
, WPACKET
*pkt
, int type
);
1856 /* Close construction of the handshake message */
1857 int (*close_construct_packet
) (SSL
*s
, WPACKET
*pkt
, int htype
);
1858 /* Write out handshake message */
1859 int (*do_write
) (SSL
*s
);
1862 # define ssl_set_handshake_header(s, pkt, htype) \
1863 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1864 # define ssl_close_construct_packet(s, pkt, htype) \
1865 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1866 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1868 /* Values for enc_flags */
1870 /* Uses explicit IV for CBC mode */
1871 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1872 /* Uses signature algorithms extension */
1873 # define SSL_ENC_FLAG_SIGALGS 0x2
1874 /* Uses SHA256 default PRF */
1875 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1877 # define SSL_ENC_FLAG_DTLS 0x8
1879 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1880 * apply to others in future.
1882 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1884 # ifndef OPENSSL_NO_COMP
1885 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1886 typedef struct ssl3_comp_st
{
1887 int comp_id
; /* The identifier byte for this compression
1889 char *name
; /* Text name used for the compression type */
1890 COMP_METHOD
*method
; /* The method :-) */
1894 typedef enum downgrade_en
{
1901 * Dummy status type for the status_type extension. Indicates no status type
1904 #define TLSEXT_STATUSTYPE_nothing -1
1906 /* Sigalgs values */
1907 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1908 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1909 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1910 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
1911 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1912 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1913 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1914 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1915 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1916 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1917 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1918 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
1919 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1920 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1921 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1922 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1923 #define TLSEXT_SIGALG_dsa_sha224 0x0302
1924 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1925 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1926 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1927 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1929 #define TLSEXT_SIGALG_ed25519 0x0807
1931 /* Known PSK key exchange modes */
1932 #define TLSEXT_KEX_MODE_KE 0x00
1933 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1936 * Internal representations of key exchange modes
1938 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1939 #define TLSEXT_KEX_MODE_FLAG_KE 1
1940 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1942 /* An invalid index into the TLSv1.3 PSK identities */
1943 #define TLSEXT_PSK_BAD_IDENTITY -1
1945 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1946 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1948 /* A dummy signature value not valid for TLSv1.2 signature algs */
1949 #define TLSEXT_signature_rsa_pss 0x0101
1951 /* TLSv1.3 downgrade protection sentinel values */
1952 extern const unsigned char tls11downgrade
[8];
1953 extern const unsigned char tls12downgrade
[8];
1955 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
1957 __owur
const SSL_METHOD
*ssl_bad_method(int ver
);
1958 __owur
const SSL_METHOD
*sslv3_method(void);
1959 __owur
const SSL_METHOD
*sslv3_server_method(void);
1960 __owur
const SSL_METHOD
*sslv3_client_method(void);
1961 __owur
const SSL_METHOD
*tlsv1_method(void);
1962 __owur
const SSL_METHOD
*tlsv1_server_method(void);
1963 __owur
const SSL_METHOD
*tlsv1_client_method(void);
1964 __owur
const SSL_METHOD
*tlsv1_1_method(void);
1965 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
1966 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
1967 __owur
const SSL_METHOD
*tlsv1_2_method(void);
1968 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
1969 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
1970 __owur
const SSL_METHOD
*tlsv1_3_method(void);
1971 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
1972 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
1973 __owur
const SSL_METHOD
*dtlsv1_method(void);
1974 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
1975 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
1976 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
1977 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
1978 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
1979 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
1981 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
1982 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
1983 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
1984 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
1985 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
1986 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
1987 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
1990 * Flags for SSL methods
1992 # define SSL_METHOD_NO_FIPS (1U<<0)
1993 # define SSL_METHOD_NO_SUITEB (1U<<1)
1995 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1996 s_connect, enc_data) \
1997 const SSL_METHOD *func_name(void) \
1999 static const SSL_METHOD func_name##_data= { \
2013 ssl3_renegotiate_check, \
2016 ssl3_dispatch_alert, \
2019 ssl3_get_cipher_by_char, \
2020 ssl3_put_cipher_by_char, \
2024 tls1_default_timeout, \
2026 ssl_undefined_void_function, \
2027 ssl3_callback_ctrl, \
2028 ssl3_ctx_callback_ctrl, \
2030 return &func_name##_data; \
2033 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2034 const SSL_METHOD *func_name(void) \
2036 static const SSL_METHOD func_name##_data= { \
2038 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2050 ssl3_renegotiate_check, \
2053 ssl3_dispatch_alert, \
2056 ssl3_get_cipher_by_char, \
2057 ssl3_put_cipher_by_char, \
2061 ssl3_default_timeout, \
2063 ssl_undefined_void_function, \
2064 ssl3_callback_ctrl, \
2065 ssl3_ctx_callback_ctrl, \
2067 return &func_name##_data; \
2070 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2071 s_connect, enc_data) \
2072 const SSL_METHOD *func_name(void) \
2074 static const SSL_METHOD func_name##_data= { \
2088 ssl3_renegotiate_check, \
2090 dtls1_write_app_data_bytes, \
2091 dtls1_dispatch_alert, \
2094 ssl3_get_cipher_by_char, \
2095 ssl3_put_cipher_by_char, \
2099 dtls1_default_timeout, \
2101 ssl_undefined_void_function, \
2102 ssl3_callback_ctrl, \
2103 ssl3_ctx_callback_ctrl, \
2105 return &func_name##_data; \
2108 struct openssl_ssl_test_functions
{
2109 int (*p_ssl_init_wbio_buffer
) (SSL
*s
);
2110 int (*p_ssl3_setup_buffers
) (SSL
*s
);
2113 const char *ssl_protocol_to_string(int version
);
2115 /* Returns true if certificate and private key for 'idx' are present */
2116 static ossl_inline
int ssl_has_cert(const SSL
*s
, int idx
)
2118 if (idx
< 0 || idx
>= SSL_PKEY_NUM
)
2120 return s
->cert
->pkeys
[idx
].x509
!= NULL
2121 && s
->cert
->pkeys
[idx
].privatekey
!= NULL
;
2124 static ossl_inline
void tls1_get_peer_groups(SSL
*s
, const uint16_t **pgroups
,
2127 *pgroups
= s
->session
->ext
.supportedgroups
;
2128 *pgroupslen
= s
->session
->ext
.supportedgroups_len
;
2131 # ifndef OPENSSL_UNIT_TEST
2133 __owur
int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
);
2134 __owur
int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
);
2135 void ssl_clear_cipher_ctx(SSL
*s
);
2136 int ssl_clear_bad_session(SSL
*s
);
2137 __owur CERT
*ssl_cert_new(void);
2138 __owur CERT
*ssl_cert_dup(CERT
*cert
);
2139 void ssl_cert_clear_certs(CERT
*c
);
2140 void ssl_cert_free(CERT
*c
);
2141 __owur
int ssl_generate_session_id(SSL
*s
, SSL_SESSION
*ss
);
2142 __owur
int ssl_get_new_session(SSL
*s
, int session
);
2143 __owur
int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
);
2144 __owur SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
);
2145 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
2146 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
2147 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2148 const SSL_CIPHER
*const *bp
);
2149 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
2150 STACK_OF(SSL_CIPHER
) **pref
,
2151 STACK_OF(SSL_CIPHER
)
2153 const char *rule_str
,
2155 __owur
int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
, int sslv2format
);
2156 __owur
int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
2157 STACK_OF(SSL_CIPHER
) **skp
,
2158 STACK_OF(SSL_CIPHER
) **scsvs
, int sslv2format
,
2160 void ssl_update_cache(SSL
*s
, int mode
);
2161 __owur
int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
2162 const EVP_MD
**md
, int *mac_pkey_type
,
2163 size_t *mac_secret_size
, SSL_COMP
**comp
,
2165 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
2166 size_t *int_overhead
, size_t *blocksize
,
2167 size_t *ext_overhead
);
2168 __owur
int ssl_cert_is_disabled(size_t idx
);
2169 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
,
2170 const unsigned char *ptr
,
2172 __owur
int ssl_cert_set0_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2173 __owur
int ssl_cert_set1_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2174 __owur
int ssl_cert_add0_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2175 __owur
int ssl_cert_add1_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2176 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
2177 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
2178 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
2180 __owur
int ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
);
2181 __owur
int ssl_build_cert_chain(SSL
*s
, SSL_CTX
*ctx
, int flags
);
2182 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
2185 __owur
int ssl_randbytes(SSL
*s
, unsigned char *buf
, size_t num
);
2186 __owur
int ssl_security(const SSL
*s
, int op
, int bits
, int nid
, void *other
);
2187 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
2190 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_pkey(const EVP_PKEY
*pk
,
2192 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_idx(size_t idx
);
2194 int ssl_undefined_function(SSL
*s
);
2195 __owur
int ssl_undefined_void_function(void);
2196 __owur
int ssl_undefined_const_function(const SSL
*s
);
2197 __owur
int ssl_get_server_cert_serverinfo(SSL
*s
,
2198 const unsigned char **serverinfo
,
2199 size_t *serverinfo_length
);
2200 void ssl_set_masks(SSL
*s
);
2201 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
2202 __owur
int ssl_verify_alarm_type(long type
);
2203 void ssl_sort_cipher_list(void);
2204 int ssl_load_ciphers(void);
2205 __owur
int ssl_fill_hello_random(SSL
*s
, int server
, unsigned char *field
,
2206 size_t len
, DOWNGRADE dgrd
);
2207 __owur
int ssl_generate_master_secret(SSL
*s
, unsigned char *pms
, size_t pmslen
,
2209 __owur EVP_PKEY
*ssl_generate_pkey(EVP_PKEY
*pm
);
2210 __owur
int ssl_derive(SSL
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
2212 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
2213 __owur
unsigned int ssl_get_max_send_fragment(const SSL
*ssl
);
2214 __owur
unsigned int ssl_get_split_send_fragment(const SSL
*ssl
);
2216 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_id(uint32_t id
);
2217 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_std_name(const char *stdname
);
2218 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
2219 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
2221 int ssl3_init_finished_mac(SSL
*s
);
2222 __owur
int ssl3_setup_key_block(SSL
*s
);
2223 __owur
int ssl3_change_cipher_state(SSL
*s
, int which
);
2224 void ssl3_cleanup_key_block(SSL
*s
);
2225 __owur
int ssl3_do_write(SSL
*s
, int type
);
2226 int ssl3_send_alert(SSL
*s
, int level
, int desc
);
2227 __owur
int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
2228 unsigned char *p
, size_t len
,
2229 size_t *secret_size
);
2230 __owur
int ssl3_get_req_cert_type(SSL
*s
, WPACKET
*pkt
);
2231 __owur
int ssl3_num_ciphers(void);
2232 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2233 int ssl3_renegotiate(SSL
*ssl
);
2234 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2235 __owur
int ssl3_dispatch_alert(SSL
*s
);
2236 __owur
size_t ssl3_final_finish_mac(SSL
*s
, const char *sender
, size_t slen
,
2238 __owur
int ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, size_t len
);
2239 void ssl3_free_digest_list(SSL
*s
);
2240 __owur
unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
,
2242 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,
2243 STACK_OF(SSL_CIPHER
) *clnt
,
2244 STACK_OF(SSL_CIPHER
) *srvr
);
2245 __owur
int ssl3_digest_cached_records(SSL
*s
, int keep
);
2246 __owur
int ssl3_new(SSL
*s
);
2247 void ssl3_free(SSL
*s
);
2248 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2249 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2250 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2251 __owur
int ssl3_shutdown(SSL
*s
);
2252 int ssl3_clear(SSL
*s
);
2253 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2254 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2255 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2256 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2258 __owur
int ssl3_do_change_cipher_spec(SSL
*ssl
);
2259 __owur
long ssl3_default_timeout(void);
2261 __owur
int ssl3_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2262 __owur
int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2263 __owur
int tls_setup_handshake(SSL
*s
);
2264 __owur
int dtls1_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2265 __owur
int dtls1_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2266 __owur
int ssl3_handshake_write(SSL
*s
);
2268 __owur
int ssl_allow_compression(SSL
*s
);
2270 __owur
int ssl_version_supported(const SSL
*s
, int version
);
2272 __owur
int ssl_set_client_hello_version(SSL
*s
);
2273 __owur
int ssl_check_version_downgrade(SSL
*s
);
2274 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2275 __owur
int ssl_choose_server_version(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2277 __owur
int ssl_choose_client_version(SSL
*s
, int version
,
2278 RAW_EXTENSION
*extensions
);
2279 int ssl_get_min_max_version(const SSL
*s
, int *min_version
, int *max_version
);
2281 __owur
long tls1_default_timeout(void);
2282 __owur
int dtls1_do_write(SSL
*s
, int type
);
2283 void dtls1_set_message_header(SSL
*s
,
2286 size_t frag_off
, size_t frag_len
);
2288 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf_
, size_t len
,
2291 __owur
int dtls1_read_failed(SSL
*s
, int code
);
2292 __owur
int dtls1_buffer_message(SSL
*s
, int ccs
);
2293 __owur
int dtls1_retransmit_message(SSL
*s
, unsigned short seq
, int *found
);
2294 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2295 int dtls1_retransmit_buffered_messages(SSL
*s
);
2296 void dtls1_clear_received_buffer(SSL
*s
);
2297 void dtls1_clear_sent_buffer(SSL
*s
);
2298 void dtls1_get_message_header(unsigned char *data
,
2299 struct hm_header_st
*msg_hdr
);
2300 __owur
long dtls1_default_timeout(void);
2301 __owur
struct timeval
*dtls1_get_timeout(SSL
*s
, struct timeval
*timeleft
);
2302 __owur
int dtls1_check_timeout_num(SSL
*s
);
2303 __owur
int dtls1_handle_timeout(SSL
*s
);
2304 void dtls1_start_timer(SSL
*s
);
2305 void dtls1_stop_timer(SSL
*s
);
2306 __owur
int dtls1_is_timer_expired(SSL
*s
);
2307 void dtls1_double_timeout(SSL
*s
);
2308 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2310 __owur
size_t dtls1_min_mtu(SSL
*s
);
2311 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2312 __owur
int dtls1_query_mtu(SSL
*s
);
2314 __owur
int tls1_new(SSL
*s
);
2315 void tls1_free(SSL
*s
);
2316 int tls1_clear(SSL
*s
);
2318 __owur
int dtls1_new(SSL
*s
);
2319 void dtls1_free(SSL
*s
);
2320 int dtls1_clear(SSL
*s
);
2321 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2322 __owur
int dtls1_shutdown(SSL
*s
);
2324 __owur
int dtls1_dispatch_alert(SSL
*s
);
2326 __owur
int ssl_init_wbio_buffer(SSL
*s
);
2327 int ssl_free_wbio_buffer(SSL
*s
);
2329 __owur
int tls1_change_cipher_state(SSL
*s
, int which
);
2330 __owur
int tls1_setup_key_block(SSL
*s
);
2331 __owur
size_t tls1_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2333 __owur
int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
2334 unsigned char *p
, size_t len
,
2335 size_t *secret_size
);
2336 __owur
int tls13_setup_key_block(SSL
*s
);
2337 __owur
size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2339 __owur
int tls13_change_cipher_state(SSL
*s
, int which
);
2340 __owur
int tls13_update_key(SSL
*s
, int send
);
2341 __owur
int tls13_hkdf_expand(SSL
*s
, const EVP_MD
*md
,
2342 const unsigned char *secret
,
2343 const unsigned char *label
, size_t labellen
,
2344 const unsigned char *data
, size_t datalen
,
2345 unsigned char *out
, size_t outlen
);
2346 __owur
int tls13_derive_key(SSL
*s
, const EVP_MD
*md
,
2347 const unsigned char *secret
, unsigned char *key
,
2349 __owur
int tls13_derive_iv(SSL
*s
, const EVP_MD
*md
,
2350 const unsigned char *secret
, unsigned char *iv
,
2352 __owur
int tls13_derive_finishedkey(SSL
*s
, const EVP_MD
*md
,
2353 const unsigned char *secret
,
2354 unsigned char *fin
, size_t finlen
);
2355 int tls13_generate_secret(SSL
*s
, const EVP_MD
*md
,
2356 const unsigned char *prevsecret
,
2357 const unsigned char *insecret
,
2359 unsigned char *outsecret
);
2360 __owur
int tls13_generate_handshake_secret(SSL
*s
,
2361 const unsigned char *insecret
,
2362 size_t insecretlen
);
2363 __owur
int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
2364 unsigned char *prev
, size_t prevlen
,
2365 size_t *secret_size
);
2366 __owur
int tls1_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2367 const char *label
, size_t llen
,
2368 const unsigned char *p
, size_t plen
,
2370 __owur
int tls13_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2371 const char *label
, size_t llen
,
2372 const unsigned char *context
,
2373 size_t contextlen
, int use_context
);
2374 __owur
int tls1_alert_code(int code
);
2375 __owur
int tls13_alert_code(int code
);
2376 __owur
int ssl3_alert_code(int code
);
2378 # ifndef OPENSSL_NO_EC
2379 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
);
2382 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2384 # ifndef OPENSSL_NO_EC
2386 __owur
const TLS_GROUP_INFO
*tls1_group_id_lookup(uint16_t curve_id
);
2387 __owur
int tls1_check_group_id(SSL
*s
, uint16_t group_id
);
2388 __owur
uint16_t tls1_shared_group(SSL
*s
, int nmatch
);
2389 __owur
int tls1_set_groups(uint16_t **pext
, size_t *pextlen
,
2390 int *curves
, size_t ncurves
);
2391 __owur
int tls1_set_groups_list(uint16_t **pext
, size_t *pextlen
,
2393 void tls1_get_formatlist(SSL
*s
, const unsigned char **pformats
,
2394 size_t *num_formats
);
2395 __owur
int tls1_check_ec_tmp_key(SSL
*s
, unsigned long id
);
2396 __owur EVP_PKEY
*ssl_generate_pkey_group(SSL
*s
, uint16_t id
);
2397 __owur EVP_PKEY
*ssl_generate_param_group(uint16_t id
);
2398 # endif /* OPENSSL_NO_EC */
2400 __owur
int tls_curve_allowed(SSL
*s
, uint16_t curve
, int op
);
2401 void tls1_get_supported_groups(SSL
*s
, const uint16_t **pgroups
,
2402 size_t *pgroupslen
);
2404 __owur
int tls1_set_server_sigalgs(SSL
*s
);
2406 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2407 typedef enum ticket_en
{
2408 /* fatal error, malloc failure */
2409 TICKET_FATAL_ERR_MALLOC
,
2410 /* fatal error, either from parsing or decrypting the ticket */
2411 TICKET_FATAL_ERR_OTHER
,
2412 /* No ticket present */
2414 /* Empty ticket present */
2416 /* the ticket couldn't be decrypted */
2418 /* a ticket was successfully decrypted */
2420 /* same as above but the ticket needs to be renewed */
2421 TICKET_SUCCESS_RENEW
2424 __owur TICKET_RETURN
tls_get_ticket_from_client(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2426 __owur TICKET_RETURN
tls_decrypt_ticket(SSL
*s
, const unsigned char *etick
,
2428 const unsigned char *sess_id
,
2429 size_t sesslen
, SSL_SESSION
**psess
);
2431 __owur
int tls_use_ticket(SSL
*s
);
2433 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL
*s
, int op
);
2435 __owur
int tls1_set_sigalgs_list(CERT
*c
, const char *str
, int client
);
2436 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2438 int tls1_check_chain(SSL
*s
, X509
*x
, EVP_PKEY
*pk
, STACK_OF(X509
) *chain
,
2440 void tls1_set_cert_validity(SSL
*s
);
2442 # ifndef OPENSSL_NO_CT
2443 __owur
int ssl_validate_ct(SSL
*s
);
2446 # ifndef OPENSSL_NO_DH
2447 __owur DH
*ssl_get_auto_dh(SSL
*s
);
2450 __owur
int ssl_security_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
, int is_ee
);
2451 __owur
int ssl_security_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
, X509
*ex
,
2454 int tls_choose_sigalg(SSL
*s
, int fatalerrs
);
2456 __owur EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
);
2457 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
);
2458 __owur
long ssl_get_algorithm2(SSL
*s
);
2459 __owur
int tls12_copy_sigalgs(SSL
*s
, WPACKET
*pkt
,
2460 const uint16_t *psig
, size_t psiglen
);
2461 __owur
int tls1_save_u16(PACKET
*pkt
, uint16_t **pdest
, size_t *pdestlen
);
2462 __owur
int tls1_save_sigalgs(SSL
*s
, PACKET
*pkt
);
2463 __owur
int tls1_process_sigalgs(SSL
*s
);
2464 __owur
int tls1_set_peer_legacy_sigalg(SSL
*s
, const EVP_PKEY
*pkey
);
2465 __owur
int tls1_lookup_md(const SIGALG_LOOKUP
*lu
, const EVP_MD
**pmd
);
2466 __owur
size_t tls12_get_psigalgs(SSL
*s
, int sent
, const uint16_t **psigs
);
2467 __owur
int tls12_check_peer_sigalg(SSL
*s
, uint16_t, EVP_PKEY
*pkey
);
2468 void ssl_set_client_disabled(SSL
*s
);
2469 __owur
int ssl_cipher_disabled(SSL
*s
, const SSL_CIPHER
*c
, int op
, int echde
);
2471 __owur
int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
2473 __owur
const EVP_MD
*ssl_md(int idx
);
2474 __owur
const EVP_MD
*ssl_handshake_md(SSL
*s
);
2475 __owur
const EVP_MD
*ssl_prf_md(SSL
*s
);
2478 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2479 * with |ssl|, if logging is enabled. It returns one on success and zero on
2480 * failure. The entry is identified by the first 8 bytes of
2481 * |encrypted_premaster|.
2483 __owur
int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
2484 const uint8_t *encrypted_premaster
,
2485 size_t encrypted_premaster_len
,
2486 const uint8_t *premaster
,
2487 size_t premaster_len
);
2490 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2491 * logging is available. It returns one on success and zero on failure. It tags
2492 * the entry with |label|.
2494 __owur
int ssl_log_secret(SSL
*ssl
, const char *label
,
2495 const uint8_t *secret
, size_t secret_len
);
2497 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2498 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2499 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2500 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2501 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2502 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2505 __owur
char ssl3_cbc_record_digest_supported(const EVP_MD_CTX
*ctx
);
2506 __owur
int ssl3_cbc_digest_record(const EVP_MD_CTX
*ctx
,
2507 unsigned char *md_out
,
2508 size_t *md_out_size
,
2509 const unsigned char header
[13],
2510 const unsigned char *data
,
2511 size_t data_plus_mac_size
,
2512 size_t data_plus_mac_plus_padding_size
,
2513 const unsigned char *mac_secret
,
2514 size_t mac_secret_length
, char is_sslv3
);
2516 __owur
int srp_generate_server_master_secret(SSL
*s
);
2517 __owur
int srp_generate_client_master_secret(SSL
*s
);
2518 __owur
int srp_verify_server_param(SSL
*s
);
2520 /* statem/extensions_cust.c */
2522 custom_ext_method
*custom_ext_find(const custom_ext_methods
*exts
,
2523 ENDPOINT role
, unsigned int ext_type
,
2526 void custom_ext_init(custom_ext_methods
*meths
);
2528 __owur
int custom_ext_parse(SSL
*s
, unsigned int context
, unsigned int ext_type
,
2529 const unsigned char *ext_data
, size_t ext_size
,
2530 X509
*x
, size_t chainidx
);
2531 __owur
int custom_ext_add(SSL
*s
, int context
, WPACKET
*pkt
, X509
*x
,
2532 size_t chainidx
, int maxversion
);
2534 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2535 const custom_ext_methods
*src
);
2536 __owur
int custom_exts_copy_flags(custom_ext_methods
*dst
,
2537 const custom_ext_methods
*src
);
2538 void custom_exts_free(custom_ext_methods
*exts
);
2540 void ssl_comp_free_compression_methods_int(void);
2542 # else /* OPENSSL_UNIT_TEST */
2544 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2545 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers