2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the Apache License 2.0 (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 #ifndef 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 "internal/packet.h"
34 # include "internal/dane.h"
35 # include "internal/refcount.h"
36 # include "internal/tsan_assist.h"
37 # include "internal/bio.h"
39 # ifdef OPENSSL_BUILD_SHLIBSSL
40 # undef OPENSSL_EXTERN
41 # define OPENSSL_EXTERN OPENSSL_EXPORT
44 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
45 l|=(((unsigned long)(*((c)++)))<< 8), \
46 l|=(((unsigned long)(*((c)++)))<<16), \
47 l|=(((unsigned long)(*((c)++)))<<24))
49 /* NOTE - c is not incremented as per c2l */
50 # define c2ln(c,l1,l2,n) { \
54 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
55 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
56 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
57 case 5: l2|=((unsigned long)(*(--(c)))); \
58 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
59 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
60 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
61 case 1: l1|=((unsigned long)(*(--(c)))); \
65 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
66 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
67 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
68 *((c)++)=(unsigned char)(((l)>>24)&0xff))
70 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
71 l|=((unsigned long)(*((c)++)))<<16, \
72 l|=((unsigned long)(*((c)++)))<< 8, \
73 l|=((unsigned long)(*((c)++))))
75 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
76 l|=((uint64_t)(*((c)++)))<<48, \
77 l|=((uint64_t)(*((c)++)))<<40, \
78 l|=((uint64_t)(*((c)++)))<<32, \
79 l|=((uint64_t)(*((c)++)))<<24, \
80 l|=((uint64_t)(*((c)++)))<<16, \
81 l|=((uint64_t)(*((c)++)))<< 8, \
82 l|=((uint64_t)(*((c)++))))
85 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
86 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
87 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
88 *((c)++)=(unsigned char)(((l) )&0xff))
90 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
91 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
92 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
93 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
94 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
95 *((c)++)=(unsigned char)(((l) )&0xff))
97 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
98 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
99 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
101 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
102 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
103 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
104 *((c)++)=(unsigned char)(((l) )&0xff))
106 /* NOTE - c is not incremented as per l2c */
107 # define l2cn(l1,l2,c,n) { \
110 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
111 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
112 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
113 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
114 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
115 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
116 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
117 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
121 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
122 (((unsigned int)((c)[1])) )),(c)+=2)
123 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
124 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
126 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
127 (((unsigned long)((c)[1]))<< 8)| \
128 (((unsigned long)((c)[2])) )),(c)+=3)
130 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
131 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
132 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
134 # define TLS_MAX_VERSION_INTERNAL TLS1_3_VERSION
135 # define DTLS_MAX_VERSION_INTERNAL DTLS1_2_VERSION
138 * DTLS version numbers are strange because they're inverted. Except for
139 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
141 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
142 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
143 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
144 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
145 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
149 * Define the Bitmasks for SSL_CIPHER.algorithms.
150 * This bits are used packed as dense as possible. If new methods/ciphers
151 * etc will be added, the bits a likely to change, so this information
152 * is for internal library use only, even though SSL_CIPHER.algorithms
153 * can be publicly accessed.
154 * Use the according functions for cipher management instead.
156 * The bit mask handling in the selection and sorting scheme in
157 * ssl_create_cipher_list() has only limited capabilities, reflecting
158 * that the different entities within are mutually exclusive:
159 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
162 /* Bits for algorithm_mkey (key exchange algorithm) */
163 /* RSA key exchange */
164 # define SSL_kRSA 0x00000001U
165 /* tmp DH key no DH cert */
166 # define SSL_kDHE 0x00000002U
168 # define SSL_kEDH SSL_kDHE
170 # define SSL_kECDHE 0x00000004U
172 # define SSL_kEECDH SSL_kECDHE
174 # define SSL_kPSK 0x00000008U
175 /* GOST key exchange */
176 # define SSL_kGOST 0x00000010U
178 # define SSL_kSRP 0x00000020U
180 # define SSL_kRSAPSK 0x00000040U
181 # define SSL_kECDHEPSK 0x00000080U
182 # define SSL_kDHEPSK 0x00000100U
186 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
188 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
189 # define SSL_kANY 0x00000000U
191 /* Bits for algorithm_auth (server authentication) */
193 # define SSL_aRSA 0x00000001U
195 # define SSL_aDSS 0x00000002U
196 /* no auth (i.e. use ADH or AECDH) */
197 # define SSL_aNULL 0x00000004U
199 # define SSL_aECDSA 0x00000008U
201 # define SSL_aPSK 0x00000010U
202 /* GOST R 34.10-2001 signature auth */
203 # define SSL_aGOST01 0x00000020U
205 # define SSL_aSRP 0x00000040U
206 /* GOST R 34.10-2012 signature auth */
207 # define SSL_aGOST12 0x00000080U
208 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
209 # define SSL_aANY 0x00000000U
210 /* All bits requiring a certificate */
212 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
214 /* Bits for algorithm_enc (symmetric encryption) */
215 # define SSL_DES 0x00000001U
216 # define SSL_3DES 0x00000002U
217 # define SSL_RC4 0x00000004U
218 # define SSL_RC2 0x00000008U
219 # define SSL_IDEA 0x00000010U
220 # define SSL_eNULL 0x00000020U
221 # define SSL_AES128 0x00000040U
222 # define SSL_AES256 0x00000080U
223 # define SSL_CAMELLIA128 0x00000100U
224 # define SSL_CAMELLIA256 0x00000200U
225 # define SSL_eGOST2814789CNT 0x00000400U
226 # define SSL_SEED 0x00000800U
227 # define SSL_AES128GCM 0x00001000U
228 # define SSL_AES256GCM 0x00002000U
229 # define SSL_AES128CCM 0x00004000U
230 # define SSL_AES256CCM 0x00008000U
231 # define SSL_AES128CCM8 0x00010000U
232 # define SSL_AES256CCM8 0x00020000U
233 # define SSL_eGOST2814789CNT12 0x00040000U
234 # define SSL_CHACHA20POLY1305 0x00080000U
235 # define SSL_ARIA128GCM 0x00100000U
236 # define SSL_ARIA256GCM 0x00200000U
238 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
239 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
240 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
241 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
242 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
243 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
244 # define SSL_ARIA (SSL_ARIAGCM)
246 /* Bits for algorithm_mac (symmetric authentication) */
248 # define SSL_MD5 0x00000001U
249 # define SSL_SHA1 0x00000002U
250 # define SSL_GOST94 0x00000004U
251 # define SSL_GOST89MAC 0x00000008U
252 # define SSL_SHA256 0x00000010U
253 # define SSL_SHA384 0x00000020U
254 /* Not a real MAC, just an indication it is part of cipher */
255 # define SSL_AEAD 0x00000040U
256 # define SSL_GOST12_256 0x00000080U
257 # define SSL_GOST89MAC12 0x00000100U
258 # define SSL_GOST12_512 0x00000200U
261 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
262 * sure to update this constant too
265 # define SSL_MD_MD5_IDX 0
266 # define SSL_MD_SHA1_IDX 1
267 # define SSL_MD_GOST94_IDX 2
268 # define SSL_MD_GOST89MAC_IDX 3
269 # define SSL_MD_SHA256_IDX 4
270 # define SSL_MD_SHA384_IDX 5
271 # define SSL_MD_GOST12_256_IDX 6
272 # define SSL_MD_GOST89MAC12_IDX 7
273 # define SSL_MD_GOST12_512_IDX 8
274 # define SSL_MD_MD5_SHA1_IDX 9
275 # define SSL_MD_SHA224_IDX 10
276 # define SSL_MD_SHA512_IDX 11
277 # define SSL_MAX_DIGEST 12
279 /* Bits for algorithm2 (handshake digests and other extra flags) */
281 /* Bits 0-7 are handshake MAC */
282 # define SSL_HANDSHAKE_MAC_MASK 0xFF
283 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
284 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
285 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
286 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
287 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
288 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
289 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
291 /* Bits 8-15 bits are PRF */
292 # define TLS1_PRF_DGST_SHIFT 8
293 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
294 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
295 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
296 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
297 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
298 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
299 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
302 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
303 * goes into algorithm2)
305 # define TLS1_STREAM_MAC 0x10000
307 # define SSL_STRONG_MASK 0x0000001FU
308 # define SSL_DEFAULT_MASK 0X00000020U
310 # define SSL_STRONG_NONE 0x00000001U
311 # define SSL_LOW 0x00000002U
312 # define SSL_MEDIUM 0x00000004U
313 # define SSL_HIGH 0x00000008U
314 # define SSL_FIPS 0x00000010U
315 # define SSL_NOT_DEFAULT 0x00000020U
317 /* we have used 0000003f - 26 bits left to go */
319 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
320 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
322 /* Check if an SSL structure is using DTLS */
323 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
325 /* Check if we are using TLSv1.3 */
326 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
327 && (s)->method->version >= TLS1_3_VERSION \
328 && (s)->method->version != TLS_ANY_VERSION)
330 # define SSL_TREAT_AS_TLS13(s) \
331 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
332 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
333 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
334 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
335 || (s)->hello_retry_request == SSL_HRR_PENDING)
337 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3.tmp.finish_md_len == 0 \
338 || (s)->s3.tmp.peer_finish_md_len == 0)
340 /* See if we need explicit IV */
341 # define SSL_USE_EXPLICIT_IV(s) \
342 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
344 * See if we use signature algorithms extension and signature algorithm
347 # define SSL_USE_SIGALGS(s) \
348 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
350 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
351 * apply to others in future.
353 # define SSL_USE_TLS1_2_CIPHERS(s) \
354 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
356 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
357 * flags because it may not be set to correct version yet.
359 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
360 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
361 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
363 * Determine if a client should send signature algorithms extension:
364 * as with TLS1.2 cipher we can't rely on method flags.
366 # define SSL_CLIENT_USE_SIGALGS(s) \
367 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
369 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
370 (((value) >= TLSEXT_max_fragment_length_512) && \
371 ((value) <= TLSEXT_max_fragment_length_4096))
372 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
373 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
374 # define GET_MAX_FRAGMENT_LENGTH(session) \
375 (512U << (session->ext.max_fragment_len_mode - 1))
377 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
378 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
380 /* Mostly for SSLv3 */
381 # define SSL_PKEY_RSA 0
382 # define SSL_PKEY_RSA_PSS_SIGN 1
383 # define SSL_PKEY_DSA_SIGN 2
384 # define SSL_PKEY_ECC 3
385 # define SSL_PKEY_GOST01 4
386 # define SSL_PKEY_GOST12_256 5
387 # define SSL_PKEY_GOST12_512 6
388 # define SSL_PKEY_ED25519 7
389 # define SSL_PKEY_ED448 8
390 # define SSL_PKEY_NUM 9
393 * SSL_kRSA <- RSA_ENC
394 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
395 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
396 * SSL_aRSA <- RSA_ENC | RSA_SIGN
397 * SSL_aDSS <- DSA_SIGN
401 #define CERT_INVALID 0
402 #define CERT_PUBLIC_KEY 1
403 #define CERT_PRIVATE_KEY 2
406 /* Post-Handshake Authentication state */
409 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
410 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
411 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
412 SSL_PHA_REQUESTED /* request received by client, or sent by server */
415 /* CipherSuite length. SSLv3 and all TLS versions. */
416 # define TLS_CIPHER_LEN 2
417 /* used to hold info on the particular ciphers used */
418 struct ssl_cipher_st {
420 const char *name; /* text name */
421 const char *stdname; /* RFC name */
422 uint32_t id; /* id, 4 bytes, first is version */
424 * changed in 1.0.0: these four used to be portions of a single value
427 uint32_t algorithm_mkey; /* key exchange algorithm */
428 uint32_t algorithm_auth; /* server authentication */
429 uint32_t algorithm_enc; /* symmetric encryption */
430 uint32_t algorithm_mac; /* symmetric authentication */
431 int min_tls; /* minimum SSL/TLS protocol version */
432 int max_tls; /* maximum SSL/TLS protocol version */
433 int min_dtls; /* minimum DTLS protocol version */
434 int max_dtls; /* maximum DTLS protocol version */
435 uint32_t algo_strength; /* strength and export flags */
436 uint32_t algorithm2; /* Extra flags */
437 int32_t strength_bits; /* Number of bits really used */
438 uint32_t alg_bits; /* Number of bits for algorithm */
441 /* Used to hold SSL/TLS functions */
442 struct ssl_method_st {
446 int (*ssl_new) (SSL *s);
447 int (*ssl_clear) (SSL *s);
448 void (*ssl_free) (SSL *s);
449 int (*ssl_accept) (SSL *s);
450 int (*ssl_connect) (SSL *s);
451 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
452 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
453 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
454 int (*ssl_shutdown) (SSL *s);
455 int (*ssl_renegotiate) (SSL *s);
456 int (*ssl_renegotiate_check) (SSL *s, int);
457 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
458 unsigned char *buf, size_t len, int peek,
460 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
462 int (*ssl_dispatch_alert) (SSL *s);
463 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
464 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
465 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
466 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
468 size_t (*ssl_pending) (const SSL *s);
469 int (*num_ciphers) (void);
470 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
471 long (*get_timeout) (void);
472 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
473 int (*ssl_version) (void);
474 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
475 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
479 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
480 * consistency, even in the event of OPENSSL_NO_PSK being defined.
482 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 256
485 * Lets make this into an ASN.1 type structure as follows
486 * SSL_SESSION_ID ::= SEQUENCE {
487 * version INTEGER, -- structure version number
488 * SSLversion INTEGER, -- SSL version number
489 * Cipher OCTET STRING, -- the 3 byte cipher ID
490 * Session_ID OCTET STRING, -- the Session ID
491 * Master_key OCTET STRING, -- the master key
492 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
493 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
494 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
495 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
496 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
497 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
498 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
499 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
500 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
501 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
502 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
503 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
504 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
505 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
507 * Look in ssl/ssl_asn1.c for more details
508 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
510 struct ssl_session_st {
511 int ssl_version; /* what ssl version session info is being kept
513 size_t master_key_length;
515 /* TLSv1.3 early_secret used for external PSKs */
516 unsigned char early_secret[EVP_MAX_MD_SIZE];
518 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
521 unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
522 /* session_id - valid? */
523 size_t session_id_length;
524 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
526 * this is used to determine whether the session is being reused in the
527 * appropriate context. It is up to the application to set this, via
530 size_t sid_ctx_length;
531 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
532 # ifndef OPENSSL_NO_PSK
533 char *psk_identity_hint;
537 * Used to indicate that session resumption is not allowed. Applications
538 * can also set this bit for a new session via not_resumable_session_cb
539 * to disable session caching and tickets.
542 /* This is the cert and type for the other end. */
545 /* Certificate chain peer sent. */
546 STACK_OF(X509) *peer_chain;
548 * when app_verify_callback accepts a session where the peer's
549 * certificate is not ok, we must remember the error for session reuse:
551 long verify_result; /* only for servers */
552 CRYPTO_REF_COUNT references;
555 unsigned int compress_meth; /* Need to lookup the method */
556 const SSL_CIPHER *cipher;
557 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
558 * load the 'cipher' structure */
559 CRYPTO_EX_DATA ex_data; /* application specific data */
561 * These are used to make removal of session-ids more efficient and to
562 * implement a maximum cache size.
564 struct ssl_session_st *prev, *next;
569 unsigned char *tick; /* Session ticket */
570 size_t ticklen; /* Session ticket length */
571 /* Session lifetime hint in seconds */
572 unsigned long tick_lifetime_hint;
573 uint32_t tick_age_add;
574 /* Max number of bytes that can be sent as early data */
575 uint32_t max_early_data;
576 /* The ALPN protocol selected for this session */
577 unsigned char *alpn_selected;
578 size_t alpn_selected_len;
580 * Maximum Fragment Length as per RFC 4366.
581 * If this value does not contain RFC 4366 allowed values (1-4) then
582 * either the Maximum Fragment Length Negotiation failed or was not
585 uint8_t max_fragment_len_mode;
587 # ifndef OPENSSL_NO_SRP
590 unsigned char *ticket_appdata;
591 size_t ticket_appdata_len;
596 /* Extended master secret support */
597 # define SSL_SESS_FLAG_EXTMS 0x1
599 # ifndef OPENSSL_NO_SRP
601 typedef struct srp_ctx_st {
602 /* param for all the callbacks */
604 /* set client Hello login callback */
605 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
606 /* set SRP N/g param callback for verification */
607 int (*SRP_verify_param_callback) (SSL *, void *);
608 /* set SRP client passwd callback */
609 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
611 BIGNUM *N, *g, *s, *B, *A;
615 unsigned long srp_Mask;
621 SSL_EARLY_DATA_NONE = 0,
622 SSL_EARLY_DATA_CONNECT_RETRY,
623 SSL_EARLY_DATA_CONNECTING,
624 SSL_EARLY_DATA_WRITE_RETRY,
625 SSL_EARLY_DATA_WRITING,
626 SSL_EARLY_DATA_WRITE_FLUSH,
627 SSL_EARLY_DATA_UNAUTH_WRITING,
628 SSL_EARLY_DATA_FINISHED_WRITING,
629 SSL_EARLY_DATA_ACCEPT_RETRY,
630 SSL_EARLY_DATA_ACCEPTING,
631 SSL_EARLY_DATA_READ_RETRY,
632 SSL_EARLY_DATA_READING,
633 SSL_EARLY_DATA_FINISHED_READING
634 } SSL_EARLY_DATA_STATE;
637 * We check that the amount of unreadable early data doesn't exceed
638 * max_early_data. max_early_data is given in plaintext bytes. However if it is
639 * unreadable then we only know the number of ciphertext bytes. We also don't
640 * know how much the overhead should be because it depends on the ciphersuite.
641 * We make a small allowance. We assume 5 records of actual data plus the end
642 * of early data alert record. Each record has a tag and a content type byte.
643 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
644 * content of the alert record either which is 2 bytes.
646 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
649 * The allowance we have between the client's calculated ticket age and our own.
650 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
651 * client's age calculation is different by more than this than our own then we
652 * do not allow that ticket for early_data.
654 # define TICKET_AGE_ALLOWANCE (10 * 1000)
656 #define MAX_COMPRESSIONS_SIZE 255
664 typedef struct raw_extension_st {
665 /* Raw packet data for the extension */
667 /* Set to 1 if the extension is present or 0 otherwise */
669 /* Set to 1 if we have already parsed the extension or 0 otherwise */
671 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
673 /* Track what order extensions are received in (0-based). */
674 size_t received_order;
679 unsigned int legacy_version;
680 unsigned char random[SSL3_RANDOM_SIZE];
681 size_t session_id_len;
682 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
683 size_t dtls_cookie_len;
684 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
686 size_t compressions_len;
687 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
689 size_t pre_proc_exts_len;
690 RAW_EXTENSION *pre_proc_exts;
694 * Extension index values NOTE: Any updates to these defines should be mirrored
695 * with equivalent updates to ext_defs in extensions.c
697 typedef enum tlsext_index_en {
698 TLSEXT_IDX_renegotiate,
699 TLSEXT_IDX_server_name,
700 TLSEXT_IDX_max_fragment_length,
702 TLSEXT_IDX_ec_point_formats,
703 TLSEXT_IDX_supported_groups,
704 TLSEXT_IDX_session_ticket,
705 TLSEXT_IDX_status_request,
706 TLSEXT_IDX_next_proto_neg,
707 TLSEXT_IDX_application_layer_protocol_negotiation,
709 TLSEXT_IDX_encrypt_then_mac,
710 TLSEXT_IDX_signed_certificate_timestamp,
711 TLSEXT_IDX_extended_master_secret,
712 TLSEXT_IDX_signature_algorithms_cert,
713 TLSEXT_IDX_post_handshake_auth,
714 TLSEXT_IDX_signature_algorithms,
715 TLSEXT_IDX_supported_versions,
716 TLSEXT_IDX_psk_kex_modes,
717 TLSEXT_IDX_key_share,
719 TLSEXT_IDX_cryptopro_bug,
720 TLSEXT_IDX_early_data,
721 TLSEXT_IDX_certificate_authorities,
724 /* Dummy index - must always be the last entry */
725 TLSEXT_IDX_num_builtins
728 DEFINE_LHASH_OF(SSL_SESSION);
729 /* Needed in ssl_cert.c */
730 DEFINE_LHASH_OF(X509_NAME);
732 # define TLSEXT_KEYNAME_LENGTH 16
733 # define TLSEXT_TICK_KEY_LENGTH 32
735 typedef struct ssl_ctx_ext_secure_st {
736 unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
737 unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
738 } SSL_CTX_EXT_SECURE;
741 const SSL_METHOD *method;
742 STACK_OF(SSL_CIPHER) *cipher_list;
743 /* same as above but sorted for lookup */
744 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
745 /* TLSv1.3 specific ciphersuites */
746 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
747 struct x509_store_st /* X509_STORE */ *cert_store;
748 LHASH_OF(SSL_SESSION) *sessions;
750 * Most session-ids that will be cached, default is
751 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
753 size_t session_cache_size;
754 struct ssl_session_st *session_cache_head;
755 struct ssl_session_st *session_cache_tail;
757 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
758 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
759 * means only SSL_accept will cache SSL_SESSIONS.
761 uint32_t session_cache_mode;
763 * If timeout is not 0, it is the default timeout value set when
764 * SSL_new() is called. This has been put in to make life easier to set
767 long session_timeout;
769 * If this callback is not null, it will be called each time a session id
770 * is added to the cache. If this function returns 1, it means that the
771 * callback will do a SSL_SESSION_free() when it has finished using it.
772 * Otherwise, on 0, it means the callback has finished with it. If
773 * remove_session_cb is not null, it will be called when a session-id is
774 * removed from the cache. After the call, OpenSSL will
775 * SSL_SESSION_free() it.
777 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
778 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
779 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
780 const unsigned char *data, int len,
783 TSAN_QUALIFIER int sess_connect; /* SSL new conn - started */
784 TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
785 TSAN_QUALIFIER int sess_connect_good; /* SSL new conne/reneg - finished */
786 TSAN_QUALIFIER int sess_accept; /* SSL new accept - started */
787 TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
788 TSAN_QUALIFIER int sess_accept_good; /* SSL accept/reneg - finished */
789 TSAN_QUALIFIER int sess_miss; /* session lookup misses */
790 TSAN_QUALIFIER int sess_timeout; /* reuse attempt on timeouted session */
791 TSAN_QUALIFIER int sess_cache_full; /* session removed due to full cache */
792 TSAN_QUALIFIER int sess_hit; /* session reuse actually done */
793 TSAN_QUALIFIER int sess_cb_hit; /* session-id that was not in
794 * the cache was passed back via
795 * the callback. This indicates
796 * that the application is
797 * supplying session-id's from
798 * other processes - spooky
802 CRYPTO_REF_COUNT references;
804 /* if defined, these override the X509_verify_cert() calls */
805 int (*app_verify_callback) (X509_STORE_CTX *, void *);
806 void *app_verify_arg;
808 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
809 * ('app_verify_callback' was called with just one argument)
812 /* Default password callback. */
813 pem_password_cb *default_passwd_callback;
815 /* Default password callback user data. */
816 void *default_passwd_callback_userdata;
818 /* get client cert callback */
819 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
821 /* cookie generate callback */
822 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
823 unsigned int *cookie_len);
825 /* verify cookie callback */
826 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
827 unsigned int cookie_len);
829 /* TLS1.3 app-controlled cookie generate callback */
830 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
833 /* TLS1.3 verify app-controlled cookie callback */
834 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
837 CRYPTO_EX_DATA ex_data;
839 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
840 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
842 STACK_OF(X509) *extra_certs;
843 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
845 /* Default values used when no per-SSL value is defined follow */
847 /* used if SSL's info_callback is NULL */
848 void (*info_callback) (const SSL *ssl, int type, int val);
851 * What we put in certificate_authorities extension for TLS 1.3
852 * (ClientHello and CertificateRequest) or just client cert requests for
853 * earlier versions. If client_ca_names is populated then it is only used
854 * for client cert requests, and in preference to ca_names.
856 STACK_OF(X509_NAME) *ca_names;
857 STACK_OF(X509_NAME) *client_ca_names;
860 * Default values to use in SSL structures follow (these are copied by
866 int min_proto_version;
867 int max_proto_version;
868 size_t max_cert_list;
870 struct cert_st /* CERT */ *cert;
873 /* callback that allows applications to peek at protocol messages */
874 void (*msg_callback) (int write_p, int version, int content_type,
875 const void *buf, size_t len, SSL *ssl, void *arg);
876 void *msg_callback_arg;
878 uint32_t verify_mode;
879 size_t sid_ctx_length;
880 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
881 /* called 'verify_callback' in the SSL */
882 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
884 /* Default generate session ID callback. */
885 GEN_SESSION_CB generate_session_id;
887 X509_VERIFY_PARAM *param;
891 # ifndef OPENSSL_NO_CT
892 CTLOG_STORE *ctlog_store; /* CT Log Store */
894 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
895 * If they are not, the connection should be aborted.
897 ssl_ct_validation_cb ct_validation_callback;
898 void *ct_validation_callback_arg;
902 * If we're using more than one pipeline how should we divide the data
903 * up between the pipes?
905 size_t split_send_fragment;
907 * Maximum amount of data to send in one fragment. actual record size can
908 * be more than this due to padding and MAC overheads.
910 size_t max_send_fragment;
912 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
913 size_t max_pipelines;
915 /* The default read buffer length to use (0 means not set) */
916 size_t default_read_buf_len;
918 # ifndef OPENSSL_NO_ENGINE
920 * Engine to pass requests for client certs to
922 ENGINE *client_cert_engine;
925 /* ClientHello callback. Mostly for extensions, but not entirely. */
926 SSL_client_hello_cb_fn client_hello_cb;
927 void *client_hello_cb_arg;
929 /* TLS extensions. */
931 /* TLS extensions servername callback */
932 int (*servername_cb) (SSL *, int *, void *);
933 void *servername_arg;
934 /* RFC 4507 session ticket keys */
935 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
936 SSL_CTX_EXT_SECURE *secure;
937 /* Callback to support customisation of ticket key setting */
938 int (*ticket_key_cb) (SSL *ssl,
939 unsigned char *name, unsigned char *iv,
940 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
942 /* certificate status request info */
943 /* Callback for status request */
944 int (*status_cb) (SSL *ssl, void *arg);
946 /* ext status type used for CSR extension (OCSP Stapling) */
948 /* RFC 4366 Maximum Fragment Length Negotiation */
949 uint8_t max_fragment_len_mode;
951 # ifndef OPENSSL_NO_EC
952 /* EC extension values inherited by SSL structure */
953 size_t ecpointformats_len;
954 unsigned char *ecpointformats;
955 # endif /* OPENSSL_NO_EC */
957 size_t supportedgroups_len;
958 uint16_t *supportedgroups;
961 * ALPN information (we are in the process of transitioning from NPN to
966 * For a server, this contains a callback function that allows the
967 * server to select the protocol for the connection.
968 * out: on successful return, this must point to the raw protocol
969 * name (without the length prefix).
970 * outlen: on successful return, this contains the length of |*out|.
971 * in: points to the client's list of supported protocols in
973 * inlen: the length of |in|.
975 int (*alpn_select_cb) (SSL *s,
976 const unsigned char **out,
977 unsigned char *outlen,
978 const unsigned char *in,
979 unsigned int inlen, void *arg);
980 void *alpn_select_cb_arg;
983 * For a client, this contains the list of supported protocols in wire
989 # ifndef OPENSSL_NO_NEXTPROTONEG
990 /* Next protocol negotiation information */
993 * For a server, this contains a callback function by which the set of
994 * advertised protocols can be provided.
996 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
997 void *npn_advertised_cb_arg;
999 * For a client, this contains a callback function that selects the next
1000 * protocol from the list provided by the server.
1002 SSL_CTX_npn_select_cb_func npn_select_cb;
1003 void *npn_select_cb_arg;
1006 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1009 # ifndef OPENSSL_NO_PSK
1010 SSL_psk_client_cb_func psk_client_callback;
1011 SSL_psk_server_cb_func psk_server_callback;
1013 SSL_psk_find_session_cb_func psk_find_session_cb;
1014 SSL_psk_use_session_cb_func psk_use_session_cb;
1016 # ifndef OPENSSL_NO_SRP
1017 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1020 /* Shared DANE context */
1021 struct dane_ctx_st dane;
1023 # ifndef OPENSSL_NO_SRTP
1024 /* SRTP profiles we are willing to do from RFC 5764 */
1025 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1028 * Callback for disabling session caching and ticket support on a session
1029 * basis, depending on the chosen cipher.
1031 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1033 CRYPTO_RWLOCK *lock;
1036 * Callback for logging key material for use with debugging tools like
1037 * Wireshark. The callback should log `line` followed by a newline.
1039 SSL_CTX_keylog_cb_func keylog_callback;
1042 * The maximum number of bytes advertised in session tickets that can be
1043 * sent as early data.
1045 uint32_t max_early_data;
1048 * The maximum number of bytes of early data that a server will tolerate
1049 * (which should be at least as much as max_early_data).
1051 uint32_t recv_max_early_data;
1053 /* TLS1.3 padding callback */
1054 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1055 void *record_padding_arg;
1056 size_t block_padding;
1058 /* Session ticket appdata */
1059 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1060 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1061 void *ticket_cb_data;
1063 /* The number of TLS1.3 tickets to automatically send */
1066 /* Callback to determine if early_data is acceptable or not */
1067 SSL_allow_early_data_cb_fn allow_early_data_cb;
1068 void *allow_early_data_cb_data;
1070 /* Do we advertise Post-handshake auth support? */
1073 /* Callback for SSL async handling */
1074 SSL_async_callback_fn async_cb;
1078 typedef struct cert_pkey_st CERT_PKEY;
1082 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1087 const SSL_METHOD *method;
1089 * There are 2 BIO's even though they are normally both the same. This
1090 * is so data can be read and written to different handlers
1092 /* used by SSL_read */
1094 /* used by SSL_write */
1096 /* used during session-id reuse to concatenate messages */
1099 * This holds a variable that indicates what we were doing when a 0 or -1
1100 * is returned. This is needed for non-blocking IO so we know what
1101 * request needs re-doing when in SSL_accept or SSL_connect
1104 int (*handshake_func) (SSL *);
1106 * Imagine that here's a boolean member "init" that is switched as soon
1107 * as SSL_set_{accept/connect}_state is called for the first time, so
1108 * that "state" and "handshake_func" are properly initialized. But as
1109 * handshake_func is == 0 until then, we use this test instead of an
1112 /* are we the server side? */
1115 * Generate a new session or reuse an old one.
1116 * NB: For servers, the 'new' session may actually be a previously
1117 * cached session or even the previous session unless
1118 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1121 /* don't send shutdown packets */
1123 /* we have shut things down, 0x01 sent, 0x02 for received */
1127 SSL_EARLY_DATA_STATE early_data_state;
1128 BUF_MEM *init_buf; /* buffer used during init */
1129 void *init_msg; /* pointer to handshake message body, set by
1130 * ssl3_get_message() */
1131 size_t init_num; /* amount read/written */
1132 size_t init_off; /* amount read/written */
1136 size_t read_mac_secret_size;
1137 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1138 size_t write_mac_secret_size;
1139 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1140 unsigned char server_random[SSL3_RANDOM_SIZE];
1141 unsigned char client_random[SSL3_RANDOM_SIZE];
1142 /* flags for countermeasure against known-IV weakness */
1143 int need_empty_fragments;
1144 int empty_fragment_done;
1145 /* used during startup, digest all incoming/outgoing packets */
1146 BIO *handshake_buffer;
1148 * When handshake digest is determined, buffer is hashed and
1149 * freed and MD_CTX for the required digest is stored here.
1151 EVP_MD_CTX *handshake_dgst;
1153 * Set whenever an expected ChangeCipherSpec message is processed.
1154 * Unset when the peer's Finished message is received.
1155 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1157 int change_cipher_spec;
1161 * we allow one fatal and one warning alert to be outstanding, send close
1162 * alert via the warning alert
1165 unsigned char send_alert[2];
1167 * This flag is set when we should renegotiate ASAP, basically when there
1168 * is no more data in the read or write buffers
1171 int total_renegotiations;
1172 int num_renegotiations;
1173 int in_read_app_data;
1175 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1176 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1177 size_t finish_md_len;
1178 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1179 size_t peer_finish_md_len;
1180 size_t message_size;
1182 /* used to hold the new cipher we are going to use */
1183 const SSL_CIPHER *new_cipher;
1184 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1185 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1187 /* used for certificate requests */
1189 /* Certificate types in certificate request message. */
1192 /* Certificate authorities list peer sent */
1193 STACK_OF(X509_NAME) *peer_ca_names;
1194 size_t key_block_length;
1195 unsigned char *key_block;
1196 const EVP_CIPHER *new_sym_enc;
1197 const EVP_MD *new_hash;
1198 int new_mac_pkey_type;
1199 size_t new_mac_secret_size;
1200 # ifndef OPENSSL_NO_COMP
1201 const SSL_COMP *new_compression;
1203 char *new_compression;
1206 /* Raw values of the cipher list from a client */
1207 unsigned char *ciphers_raw;
1208 size_t ciphers_rawlen;
1209 /* Temporary storage for premaster secret */
1212 # ifndef OPENSSL_NO_PSK
1213 /* Temporary storage for PSK key */
1217 /* Signature algorithm we actually use */
1218 const struct sigalg_lookup_st *sigalg;
1219 /* Pointer to certificate we use */
1222 * signature algorithms peer reports: e.g. supported signature
1223 * algorithms extension for server or as part of a certificate
1224 * request for client.
1225 * Keep track of the algorithms for TLS and X.509 usage separately.
1227 uint16_t *peer_sigalgs;
1228 uint16_t *peer_cert_sigalgs;
1229 /* Size of above arrays */
1230 size_t peer_sigalgslen;
1231 size_t peer_cert_sigalgslen;
1232 /* Sigalg peer actually uses */
1233 const struct sigalg_lookup_st *peer_sigalg;
1235 * Set if corresponding CERT_PKEY can be used with current
1236 * SSL session: e.g. appropriate curve, signature algorithms etc.
1237 * If zero it can't be used at all.
1239 uint32_t valid_flags[SSL_PKEY_NUM];
1241 * For servers the following masks are for the key and auth algorithms
1242 * that are supported by the certs below. For clients they are masks of
1243 * *disabled* algorithms based on the current session.
1248 * The following are used by the client to see if a cipher is allowed or
1249 * not. It contains the minimum and maximum version the client's using
1250 * based on what it knows so far.
1256 /* Connection binding to prevent renegotiation attacks */
1257 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1258 size_t previous_client_finished_len;
1259 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1260 size_t previous_server_finished_len;
1261 int send_connection_binding; /* TODOEKR */
1263 # ifndef OPENSSL_NO_NEXTPROTONEG
1265 * Set if we saw the Next Protocol Negotiation extension from our peer.
1271 * ALPN information (we are in the process of transitioning from NPN to
1276 * In a server these point to the selected ALPN protocol after the
1277 * ClientHello has been processed. In a client these contain the protocol
1278 * that the server selected once the ServerHello has been processed.
1280 unsigned char *alpn_selected;
1281 size_t alpn_selected_len;
1282 /* used by the server to know what options were proposed */
1283 unsigned char *alpn_proposed;
1284 size_t alpn_proposed_len;
1285 /* used by the client to know if it actually sent alpn */
1288 # ifndef OPENSSL_NO_EC
1290 * This is set to true if we believe that this is a version of Safari
1291 * running on OS X 10.6 or newer. We wish to know this because Safari on
1292 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1294 char is_probably_safari;
1295 # endif /* !OPENSSL_NO_EC */
1297 /* For clients: peer temporary key */
1298 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1299 /* The group_id for the DH/ECDH key */
1306 struct dtls1_state_st *d1; /* DTLSv1 variables */
1307 /* callback that allows applications to peek at protocol messages */
1308 void (*msg_callback) (int write_p, int version, int content_type,
1309 const void *buf, size_t len, SSL *ssl, void *arg);
1310 void *msg_callback_arg;
1311 int hit; /* reusing a previous session */
1312 X509_VERIFY_PARAM *param;
1313 /* Per connection DANE state */
1316 STACK_OF(SSL_CIPHER) *peer_ciphers;
1317 STACK_OF(SSL_CIPHER) *cipher_list;
1318 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1319 /* TLSv1.3 specific ciphersuites */
1320 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1322 * These are the ones being used, the ones in SSL_SESSION are the ones to
1323 * be 'copied' into these ones
1327 * The TLS1.3 secrets.
1329 unsigned char early_secret[EVP_MAX_MD_SIZE];
1330 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1331 unsigned char master_secret[EVP_MAX_MD_SIZE];
1332 unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1333 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1334 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1335 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1336 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1337 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1338 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1339 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1340 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1341 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1342 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1343 EVP_MD_CTX *read_hash; /* used for mac generation */
1344 COMP_CTX *compress; /* compression */
1345 COMP_CTX *expand; /* uncompress */
1346 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1347 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1348 EVP_MD_CTX *write_hash; /* used for mac generation */
1351 /* This is used to hold the server certificate used */
1352 struct cert_st /* CERT */ *cert;
1355 * The hash of all messages prior to the CertificateVerify, and the length
1358 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1359 size_t cert_verify_hash_len;
1361 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1362 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1363 hello_retry_request;
1366 * the session_id_context is used to ensure sessions are only reused in
1367 * the appropriate context
1369 size_t sid_ctx_length;
1370 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1371 /* This can also be in the session once a session is established */
1372 SSL_SESSION *session;
1373 /* TLSv1.3 PSK session */
1374 SSL_SESSION *psksession;
1375 unsigned char *psksession_id;
1376 size_t psksession_id_len;
1377 /* Default generate session ID callback. */
1378 GEN_SESSION_CB generate_session_id;
1380 * The temporary TLSv1.3 session id. This isn't really a session id at all
1381 * but is a random value sent in the legacy session id field.
1383 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1384 size_t tmp_session_id_len;
1387 * 0 don't care about verify failure.
1388 * 1 fail if verify fails
1390 uint32_t verify_mode;
1391 /* fail if callback returns 0 */
1392 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1393 /* optional informational callback */
1394 void (*info_callback) (const SSL *ssl, int type, int val);
1395 /* error bytes to be written */
1399 # ifndef OPENSSL_NO_PSK
1400 SSL_psk_client_cb_func psk_client_callback;
1401 SSL_psk_server_cb_func psk_server_callback;
1403 SSL_psk_find_session_cb_func psk_find_session_cb;
1404 SSL_psk_use_session_cb_func psk_use_session_cb;
1407 /* Verified chain of peer */
1408 STACK_OF(X509) *verified_chain;
1410 /* extra application data */
1411 CRYPTO_EX_DATA ex_data;
1413 * What we put in certificate_authorities extension for TLS 1.3
1414 * (ClientHello and CertificateRequest) or just client cert requests for
1415 * earlier versions. If client_ca_names is populated then it is only used
1416 * for client cert requests, and in preference to ca_names.
1418 STACK_OF(X509_NAME) *ca_names;
1419 STACK_OF(X509_NAME) *client_ca_names;
1420 CRYPTO_REF_COUNT references;
1421 /* protocol behaviour */
1425 int min_proto_version;
1426 int max_proto_version;
1427 size_t max_cert_list;
1430 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1431 * secret and SSLv3/TLS (<=1.2) rollback check
1435 * If we're using more than one pipeline how should we divide the data
1436 * up between the pipes?
1438 size_t split_send_fragment;
1440 * Maximum amount of data to send in one fragment. actual record size can
1441 * be more than this due to padding and MAC overheads.
1443 size_t max_send_fragment;
1444 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1445 size_t max_pipelines;
1448 /* Built-in extension flags */
1449 uint8_t extflags[TLSEXT_IDX_num_builtins];
1450 /* TLS extension debug callback */
1451 void (*debug_cb)(SSL *s, int client_server, int type,
1452 const unsigned char *data, int len, void *arg);
1455 /* certificate status request info */
1456 /* Status type or -1 if no status type */
1458 /* Raw extension data, if seen */
1459 unsigned char *scts;
1460 /* Length of raw extension data, if seen */
1462 /* Expect OCSP CertificateStatus message */
1463 int status_expected;
1466 /* OCSP status request only */
1467 STACK_OF(OCSP_RESPID) *ids;
1468 X509_EXTENSIONS *exts;
1469 /* OCSP response received or to be sent */
1470 unsigned char *resp;
1474 /* RFC4507 session ticket expected to be received or sent */
1475 int ticket_expected;
1476 # ifndef OPENSSL_NO_EC
1477 size_t ecpointformats_len;
1479 unsigned char *ecpointformats;
1481 size_t peer_ecpointformats_len;
1483 unsigned char *peer_ecpointformats;
1484 # endif /* OPENSSL_NO_EC */
1485 size_t supportedgroups_len;
1487 uint16_t *supportedgroups;
1489 size_t peer_supportedgroups_len;
1491 uint16_t *peer_supportedgroups;
1493 /* TLS Session Ticket extension override */
1494 TLS_SESSION_TICKET_EXT *session_ticket;
1495 /* TLS Session Ticket extension callback */
1496 tls_session_ticket_ext_cb_fn session_ticket_cb;
1497 void *session_ticket_cb_arg;
1498 /* TLS pre-shared secret session resumption */
1499 tls_session_secret_cb_fn session_secret_cb;
1500 void *session_secret_cb_arg;
1502 * For a client, this contains the list of supported protocols in wire
1505 unsigned char *alpn;
1508 * Next protocol negotiation. For the client, this is the protocol that
1509 * we sent in NextProtocol and is set when handling ServerHello
1510 * extensions. For a server, this is the client's selected_protocol from
1511 * NextProtocol and is set when handling the NextProtocol message, before
1512 * the Finished message.
1517 /* The available PSK key exchange modes */
1520 /* Set to one if we have negotiated ETM */
1523 /* Are we expecting to receive early data? */
1525 /* Is the session suitable for early data? */
1528 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1529 unsigned char *tls13_cookie;
1530 size_t tls13_cookie_len;
1531 /* Have we received a cookie from the client? */
1535 * Maximum Fragment Length as per RFC 4366.
1536 * If this member contains one of the allowed values (1-4)
1537 * then we should include Maximum Fragment Length Negotiation
1538 * extension in Client Hello.
1539 * Please note that value of this member does not have direct
1540 * effect. The actual (binding) value is stored in SSL_SESSION,
1541 * as this extension is optional on server side.
1543 uint8_t max_fragment_len_mode;
1546 * On the client side the number of ticket identities we sent in the
1547 * ClientHello. On the server side the identity of the ticket we
1554 * Parsed form of the ClientHello, kept around across client_hello_cb
1557 CLIENTHELLO_MSG *clienthello;
1560 * no further mod of servername
1561 * 0 : call the servername extension callback.
1562 * 1 : prepare 2, allow last ack just after in server callback.
1563 * 2 : don't call servername callback, no ack in server hello
1565 int servername_done;
1566 # ifndef OPENSSL_NO_CT
1568 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1569 * If they are not, the connection should be aborted.
1571 ssl_ct_validation_cb ct_validation_callback;
1572 /* User-supplied argument that is passed to the ct_validation_callback */
1573 void *ct_validation_callback_arg;
1575 * Consolidated stack of SCTs from all sources.
1576 * Lazily populated by CT_get_peer_scts(SSL*)
1578 STACK_OF(SCT) *scts;
1579 /* Have we attempted to find/parse SCTs yet? */
1582 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1583 # ifndef OPENSSL_NO_SRTP
1585 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1586 /* What's been chosen */
1587 SRTP_PROTECTION_PROFILE *srtp_profile;
1590 * 1 if we are renegotiating.
1591 * 2 if we are a server and are inside a handshake
1592 * (i.e. not just sending a HelloRequest)
1595 /* If sending a KeyUpdate is pending */
1597 /* Post-handshake authentication state */
1598 SSL_PHA_STATE post_handshake_auth;
1600 uint8_t* pha_context;
1601 size_t pha_context_len;
1603 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1605 # ifndef OPENSSL_NO_SRP
1606 /* ctx for SRP authentication */
1610 * Callback for disabling session caching and ticket support on a session
1611 * basis, depending on the chosen cipher.
1613 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1614 RECORD_LAYER rlayer;
1615 /* Default password callback. */
1616 pem_password_cb *default_passwd_callback;
1617 /* Default password callback user data. */
1618 void *default_passwd_callback_userdata;
1619 /* Async Job info */
1621 ASYNC_WAIT_CTX *waitctx;
1625 * The maximum number of bytes advertised in session tickets that can be
1626 * sent as early data.
1628 uint32_t max_early_data;
1630 * The maximum number of bytes of early data that a server will tolerate
1631 * (which should be at least as much as max_early_data).
1633 uint32_t recv_max_early_data;
1636 * The number of bytes of early data received so far. If we accepted early
1637 * data then this is a count of the plaintext bytes. If we rejected it then
1638 * this is a count of the ciphertext bytes.
1640 uint32_t early_data_count;
1642 /* TLS1.3 padding callback */
1643 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1644 void *record_padding_arg;
1645 size_t block_padding;
1647 CRYPTO_RWLOCK *lock;
1649 /* The number of TLS1.3 tickets to automatically send */
1651 /* The number of TLS1.3 tickets actually sent so far */
1652 size_t sent_tickets;
1653 /* The next nonce value to use when we send a ticket on this connection */
1654 uint64_t next_ticket_nonce;
1656 /* Callback to determine if early_data is acceptable or not */
1657 SSL_allow_early_data_cb_fn allow_early_data_cb;
1658 void *allow_early_data_cb_data;
1660 /* Callback for SSL async handling */
1661 SSL_async_callback_fn async_cb;
1665 * Signature algorithms shared by client and server: cached because these
1666 * are used most often.
1668 const struct sigalg_lookup_st **shared_sigalgs;
1669 size_t shared_sigalgslen;
1673 * Structure containing table entry of values associated with the signature
1674 * algorithms (signature scheme) extension
1676 typedef struct sigalg_lookup_st {
1677 /* TLS 1.3 signature scheme name */
1679 /* Raw value used in extension */
1681 /* NID of hash algorithm or NID_undef if no hash */
1683 /* Index of hash algorithm or -1 if no hash algorithm */
1685 /* NID of signature algorithm */
1687 /* Index of signature algorithm */
1689 /* Combined hash and signature NID, if any */
1691 /* Required public key curve (ECDSA only) */
1695 typedef struct tls_group_info_st {
1696 int nid; /* Curve NID */
1697 int secbits; /* Bits of security (from SP800-57) */
1698 uint32_t flags; /* For group type and applicable TLS versions */
1699 uint16_t group_id; /* Group ID */
1703 # define TLS_GROUP_TYPE 0x0000000FU /* Mask for group type */
1704 # define TLS_GROUP_CURVE_PRIME 0x00000001U
1705 # define TLS_GROUP_CURVE_CHAR2 0x00000002U
1706 # define TLS_GROUP_CURVE_CUSTOM 0x00000004U
1707 # define TLS_GROUP_FFDHE 0x00000008U
1708 # define TLS_GROUP_ONLY_FOR_TLS1_3 0x00000010U
1710 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
1713 * Structure containing table entry of certificate info corresponding to
1717 int nid; /* NID of public key algorithm */
1718 uint32_t amask; /* authmask corresponding to key type */
1721 /* DTLS structures */
1723 # ifndef OPENSSL_NO_SCTP
1724 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1727 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1728 # define DTLS1_MAX_MTU_OVERHEAD 48
1731 * Flag used in message reuse to indicate the buffer contains the record
1732 * header as well as the handshake message header.
1734 # define DTLS1_SKIP_RECORD_HEADER 2
1736 struct dtls1_retransmit_state {
1737 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1738 EVP_MD_CTX *write_hash; /* used for mac generation */
1739 COMP_CTX *compress; /* compression */
1740 SSL_SESSION *session;
1741 unsigned short epoch;
1744 struct hm_header_st {
1750 unsigned int is_ccs;
1751 struct dtls1_retransmit_state saved_retransmit_state;
1754 struct dtls1_timeout_st {
1755 /* Number of read timeouts so far */
1756 unsigned int read_timeouts;
1757 /* Number of write timeouts so far */
1758 unsigned int write_timeouts;
1759 /* Number of alerts received so far */
1760 unsigned int num_alerts;
1763 typedef struct hm_fragment_st {
1764 struct hm_header_st msg_header;
1765 unsigned char *fragment;
1766 unsigned char *reassembly;
1769 typedef struct pqueue_st pqueue;
1770 typedef struct pitem_st pitem;
1773 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1778 typedef struct pitem_st *piterator;
1780 pitem *pitem_new(unsigned char *prio64be, void *data);
1781 void pitem_free(pitem *item);
1782 pqueue *pqueue_new(void);
1783 void pqueue_free(pqueue *pq);
1784 pitem *pqueue_insert(pqueue *pq, pitem *item);
1785 pitem *pqueue_peek(pqueue *pq);
1786 pitem *pqueue_pop(pqueue *pq);
1787 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1788 pitem *pqueue_iterator(pqueue *pq);
1789 pitem *pqueue_next(piterator *iter);
1790 size_t pqueue_size(pqueue *pq);
1792 typedef struct dtls1_state_st {
1793 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1795 unsigned int cookie_verified;
1796 /* handshake message numbers */
1797 unsigned short handshake_write_seq;
1798 unsigned short next_handshake_write_seq;
1799 unsigned short handshake_read_seq;
1800 /* Buffered handshake messages */
1801 pqueue *buffered_messages;
1802 /* Buffered (sent) handshake records */
1803 pqueue *sent_messages;
1804 size_t link_mtu; /* max on-the-wire DTLS packet size */
1805 size_t mtu; /* max DTLS packet size */
1806 struct hm_header_st w_msg_hdr;
1807 struct hm_header_st r_msg_hdr;
1808 struct dtls1_timeout_st timeout;
1810 * Indicates when the last handshake msg sent will timeout
1812 struct timeval next_timeout;
1813 /* Timeout duration */
1814 unsigned int timeout_duration_us;
1816 unsigned int retransmitting;
1817 # ifndef OPENSSL_NO_SCTP
1818 int shutdown_received;
1821 DTLS_timer_cb timer_cb;
1825 # ifndef OPENSSL_NO_EC
1827 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1829 # define EXPLICIT_PRIME_CURVE_TYPE 1
1830 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1831 # define NAMED_CURVE_TYPE 3
1832 # endif /* OPENSSL_NO_EC */
1834 struct cert_pkey_st {
1836 EVP_PKEY *privatekey;
1837 /* Chain for this certificate */
1838 STACK_OF(X509) *chain;
1840 * serverinfo data for this certificate. The data is in TLS Extension
1841 * wire format, specifically it's a series of records like:
1842 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1844 * uint8_t data[length];
1846 unsigned char *serverinfo;
1847 size_t serverinfo_length;
1849 /* Retrieve Suite B flags */
1850 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1851 /* Uses to check strict mode: suite B modes are always strict */
1852 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1853 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1856 ENDPOINT_CLIENT = 0,
1863 unsigned short ext_type;
1865 /* The context which this extension applies to */
1866 unsigned int context;
1868 * Per-connection flags relating to this extension type: not used if
1869 * part of an SSL_CTX structure.
1872 SSL_custom_ext_add_cb_ex add_cb;
1873 SSL_custom_ext_free_cb_ex free_cb;
1875 SSL_custom_ext_parse_cb_ex parse_cb;
1877 } custom_ext_method;
1879 /* ext_flags values */
1882 * Indicates an extension has been received. Used to check for unsolicited or
1883 * duplicate extensions.
1885 # define SSL_EXT_FLAG_RECEIVED 0x1
1887 * Indicates an extension has been sent: used to enable sending of
1888 * corresponding ServerHello extension.
1890 # define SSL_EXT_FLAG_SENT 0x2
1893 custom_ext_method *meths;
1895 } custom_ext_methods;
1897 typedef struct cert_st {
1898 /* Current active set */
1900 * ALWAYS points to an element of the pkeys array
1901 * Probably it would make more sense to store
1902 * an index, not a pointer.
1905 # ifndef OPENSSL_NO_DH
1907 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1910 /* Flags related to certificates */
1911 uint32_t cert_flags;
1912 CERT_PKEY pkeys[SSL_PKEY_NUM];
1913 /* Custom certificate types sent in certificate request message. */
1917 * supported signature algorithms. When set on a client this is sent in
1918 * the client hello as the supported signature algorithms extension. For
1919 * servers it represents the signature algorithms we are willing to use.
1921 uint16_t *conf_sigalgs;
1922 /* Size of above array */
1923 size_t conf_sigalgslen;
1925 * Client authentication signature algorithms, if not set then uses
1926 * conf_sigalgs. On servers these will be the signature algorithms sent
1927 * to the client in a certificate request for TLS 1.2. On a client this
1928 * represents the signature algorithms we are willing to use for client
1931 uint16_t *client_sigalgs;
1932 /* Size of above array */
1933 size_t client_sigalgslen;
1935 * Certificate setup callback: if set is called whenever a certificate
1936 * may be required (client or server). the callback can then examine any
1937 * appropriate parameters and setup any certificates required. This
1938 * allows advanced applications to select certificates on the fly: for
1939 * example based on supported signature algorithms or curves.
1941 int (*cert_cb) (SSL *ssl, void *arg);
1944 * Optional X509_STORE for chain building or certificate validation If
1945 * NULL the parent SSL_CTX store is used instead.
1947 X509_STORE *chain_store;
1948 X509_STORE *verify_store;
1949 /* Custom extensions */
1950 custom_ext_methods custext;
1951 /* Security callback */
1952 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1953 void *other, void *ex);
1954 /* Security level */
1957 # ifndef OPENSSL_NO_PSK
1958 /* If not NULL psk identity hint to use for servers */
1959 char *psk_identity_hint;
1961 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1962 CRYPTO_RWLOCK *lock;
1965 # define FP_ICC (int (*)(const void *,const void *))
1968 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1969 * of a mess of functions, but hell, think of it as an opaque structure :-)
1971 typedef struct ssl3_enc_method {
1972 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1973 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1974 int (*setup_key_block) (SSL *);
1975 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1977 int (*change_cipher_state) (SSL *, int);
1978 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1979 const char *client_finished_label;
1980 size_t client_finished_label_len;
1981 const char *server_finished_label;
1982 size_t server_finished_label_len;
1983 int (*alert_value) (int);
1984 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1985 const char *, size_t,
1986 const unsigned char *, size_t,
1988 /* Various flags indicating protocol version requirements */
1990 /* Set the handshake header */
1991 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1992 /* Close construction of the handshake message */
1993 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1994 /* Write out handshake message */
1995 int (*do_write) (SSL *s);
1998 # define ssl_set_handshake_header(s, pkt, htype) \
1999 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2000 # define ssl_close_construct_packet(s, pkt, htype) \
2001 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2002 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
2004 /* Values for enc_flags */
2006 /* Uses explicit IV for CBC mode */
2007 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
2008 /* Uses signature algorithms extension */
2009 # define SSL_ENC_FLAG_SIGALGS 0x2
2010 /* Uses SHA256 default PRF */
2011 # define SSL_ENC_FLAG_SHA256_PRF 0x4
2013 # define SSL_ENC_FLAG_DTLS 0x8
2015 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2016 * apply to others in future.
2018 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2020 # ifndef OPENSSL_NO_COMP
2021 /* Used for holding the relevant compression methods loaded into SSL_CTX */
2022 typedef struct ssl3_comp_st {
2023 int comp_id; /* The identifier byte for this compression
2025 char *name; /* Text name used for the compression type */
2026 COMP_METHOD *method; /* The method :-) */
2030 typedef enum downgrade_en {
2037 * Dummy status type for the status_type extension. Indicates no status type
2040 #define TLSEXT_STATUSTYPE_nothing -1
2042 /* Sigalgs values */
2043 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2044 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2045 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2046 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2047 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2048 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2049 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2050 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2051 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2052 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2053 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2054 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2055 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2056 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2057 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2058 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2059 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2060 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2061 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2062 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2063 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2064 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2065 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2066 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2068 #define TLSEXT_SIGALG_ed25519 0x0807
2069 #define TLSEXT_SIGALG_ed448 0x0808
2071 /* Known PSK key exchange modes */
2072 #define TLSEXT_KEX_MODE_KE 0x00
2073 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2076 * Internal representations of key exchange modes
2078 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2079 #define TLSEXT_KEX_MODE_FLAG_KE 1
2080 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2082 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2083 s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2085 /* A dummy signature value not valid for TLSv1.2 signature algs */
2086 #define TLSEXT_signature_rsa_pss 0x0101
2088 /* TLSv1.3 downgrade protection sentinel values */
2089 extern const unsigned char tls11downgrade[8];
2090 extern const unsigned char tls12downgrade[8];
2092 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2094 __owur const SSL_METHOD *ssl_bad_method(int ver);
2095 __owur const SSL_METHOD *sslv3_method(void);
2096 __owur const SSL_METHOD *sslv3_server_method(void);
2097 __owur const SSL_METHOD *sslv3_client_method(void);
2098 __owur const SSL_METHOD *tlsv1_method(void);
2099 __owur const SSL_METHOD *tlsv1_server_method(void);
2100 __owur const SSL_METHOD *tlsv1_client_method(void);
2101 __owur const SSL_METHOD *tlsv1_1_method(void);
2102 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2103 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2104 __owur const SSL_METHOD *tlsv1_2_method(void);
2105 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2106 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2107 __owur const SSL_METHOD *tlsv1_3_method(void);
2108 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2109 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2110 __owur const SSL_METHOD *dtlsv1_method(void);
2111 __owur const SSL_METHOD *dtlsv1_server_method(void);
2112 __owur const SSL_METHOD *dtlsv1_client_method(void);
2113 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2114 __owur const SSL_METHOD *dtlsv1_2_method(void);
2115 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2116 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2118 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2119 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2120 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2121 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2122 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2123 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2124 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2127 * Flags for SSL methods
2129 # define SSL_METHOD_NO_FIPS (1U<<0)
2130 # define SSL_METHOD_NO_SUITEB (1U<<1)
2132 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2133 s_connect, enc_data) \
2134 const SSL_METHOD *func_name(void) \
2136 static const SSL_METHOD func_name##_data= { \
2150 ssl3_renegotiate_check, \
2153 ssl3_dispatch_alert, \
2156 ssl3_get_cipher_by_char, \
2157 ssl3_put_cipher_by_char, \
2161 tls1_default_timeout, \
2163 ssl_undefined_void_function, \
2164 ssl3_callback_ctrl, \
2165 ssl3_ctx_callback_ctrl, \
2167 return &func_name##_data; \
2170 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2171 const SSL_METHOD *func_name(void) \
2173 static const SSL_METHOD func_name##_data= { \
2175 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2187 ssl3_renegotiate_check, \
2190 ssl3_dispatch_alert, \
2193 ssl3_get_cipher_by_char, \
2194 ssl3_put_cipher_by_char, \
2198 ssl3_default_timeout, \
2200 ssl_undefined_void_function, \
2201 ssl3_callback_ctrl, \
2202 ssl3_ctx_callback_ctrl, \
2204 return &func_name##_data; \
2207 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2208 s_connect, enc_data) \
2209 const SSL_METHOD *func_name(void) \
2211 static const SSL_METHOD func_name##_data= { \
2225 ssl3_renegotiate_check, \
2227 dtls1_write_app_data_bytes, \
2228 dtls1_dispatch_alert, \
2231 ssl3_get_cipher_by_char, \
2232 ssl3_put_cipher_by_char, \
2236 dtls1_default_timeout, \
2238 ssl_undefined_void_function, \
2239 ssl3_callback_ctrl, \
2240 ssl3_ctx_callback_ctrl, \
2242 return &func_name##_data; \
2245 struct openssl_ssl_test_functions {
2246 int (*p_ssl_init_wbio_buffer) (SSL *s);
2247 int (*p_ssl3_setup_buffers) (SSL *s);
2250 const char *ssl_protocol_to_string(int version);
2252 /* Returns true if certificate and private key for 'idx' are present */
2253 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2255 if (idx < 0 || idx >= SSL_PKEY_NUM)
2257 return s->cert->pkeys[idx].x509 != NULL
2258 && s->cert->pkeys[idx].privatekey != NULL;
2261 static ossl_inline void tls1_get_peer_groups(SSL *s, const uint16_t **pgroups,
2264 *pgroups = s->ext.peer_supportedgroups;
2265 *pgroupslen = s->ext.peer_supportedgroups_len;
2268 # ifndef OPENSSL_UNIT_TEST
2270 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2271 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2272 void ssl_clear_cipher_ctx(SSL *s);
2273 int ssl_clear_bad_session(SSL *s);
2274 __owur CERT *ssl_cert_new(void);
2275 __owur CERT *ssl_cert_dup(CERT *cert);
2276 void ssl_cert_clear_certs(CERT *c);
2277 void ssl_cert_free(CERT *c);
2278 __owur int ssl_generate_session_id(SSL *s, SSL_SESSION *ss);
2279 __owur int ssl_get_new_session(SSL *s, int session);
2280 __owur SSL_SESSION *lookup_sess_in_cache(SSL *s, const unsigned char *sess_id,
2281 size_t sess_id_len);
2282 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello);
2283 __owur SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket);
2284 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2285 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2286 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2287 const SSL_CIPHER *const *bp);
2288 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
2289 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2290 STACK_OF(SSL_CIPHER) **cipher_list,
2291 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2292 const char *rule_str,
2294 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format);
2295 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2296 STACK_OF(SSL_CIPHER) **skp,
2297 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2299 void ssl_update_cache(SSL *s, int mode);
2300 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2301 const EVP_MD **md, int *mac_pkey_type,
2302 size_t *mac_secret_size, SSL_COMP **comp,
2304 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2305 size_t *int_overhead, size_t *blocksize,
2306 size_t *ext_overhead);
2307 __owur int ssl_cert_is_disabled(size_t idx);
2308 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2309 const unsigned char *ptr,
2311 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2312 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2313 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2314 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2315 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2316 __owur int ssl_cert_set_current(CERT *c, long arg);
2317 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2319 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2320 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2321 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2324 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2325 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2328 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx);
2329 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2331 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2333 int ssl_undefined_function(SSL *s);
2334 __owur int ssl_undefined_void_function(void);
2335 __owur int ssl_undefined_const_function(const SSL *s);
2336 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2337 const unsigned char **serverinfo,
2338 size_t *serverinfo_length);
2339 void ssl_set_masks(SSL *s);
2340 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2341 __owur int ssl_x509err2alert(int type);
2342 void ssl_sort_cipher_list(void);
2343 int ssl_load_ciphers(void);
2344 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2345 size_t len, DOWNGRADE dgrd);
2346 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2348 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2349 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2351 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2352 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl);
2353 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl);
2355 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2356 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2357 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2358 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2360 int ssl3_init_finished_mac(SSL *s);
2361 __owur int ssl3_setup_key_block(SSL *s);
2362 __owur int ssl3_change_cipher_state(SSL *s, int which);
2363 void ssl3_cleanup_key_block(SSL *s);
2364 __owur int ssl3_do_write(SSL *s, int type);
2365 int ssl3_send_alert(SSL *s, int level, int desc);
2366 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2367 unsigned char *p, size_t len,
2368 size_t *secret_size);
2369 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2370 __owur int ssl3_num_ciphers(void);
2371 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2372 int ssl3_renegotiate(SSL *ssl);
2373 int ssl3_renegotiate_check(SSL *ssl, int initok);
2374 void ssl3_digest_master_key_set_params(const SSL_SESSION *session,
2375 OSSL_PARAM params[]);
2376 __owur int ssl3_dispatch_alert(SSL *s);
2377 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2379 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2380 void ssl3_free_digest_list(SSL *s);
2381 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2383 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2384 STACK_OF(SSL_CIPHER) *clnt,
2385 STACK_OF(SSL_CIPHER) *srvr);
2386 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2387 __owur int ssl3_new(SSL *s);
2388 void ssl3_free(SSL *s);
2389 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2390 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2391 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2392 __owur int ssl3_shutdown(SSL *s);
2393 int ssl3_clear(SSL *s);
2394 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2395 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2396 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2397 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2399 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2400 __owur long ssl3_default_timeout(void);
2402 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2403 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2404 __owur int tls_setup_handshake(SSL *s);
2405 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2406 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2407 __owur int ssl3_handshake_write(SSL *s);
2409 __owur int ssl_allow_compression(SSL *s);
2411 __owur int ssl_version_supported(const SSL *s, int version,
2412 const SSL_METHOD **meth);
2414 __owur int ssl_set_client_hello_version(SSL *s);
2415 __owur int ssl_check_version_downgrade(SSL *s);
2416 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2417 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2419 __owur int ssl_choose_client_version(SSL *s, int version,
2420 RAW_EXTENSION *extensions);
2421 __owur int ssl_get_min_max_version(const SSL *s, int *min_version,
2422 int *max_version, int *real_max);
2424 __owur long tls1_default_timeout(void);
2425 __owur int dtls1_do_write(SSL *s, int type);
2426 void dtls1_set_message_header(SSL *s,
2429 size_t frag_off, size_t frag_len);
2431 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2434 __owur int dtls1_read_failed(SSL *s, int code);
2435 __owur int dtls1_buffer_message(SSL *s, int ccs);
2436 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2437 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2438 int dtls1_retransmit_buffered_messages(SSL *s);
2439 void dtls1_clear_received_buffer(SSL *s);
2440 void dtls1_clear_sent_buffer(SSL *s);
2441 void dtls1_get_message_header(unsigned char *data,
2442 struct hm_header_st *msg_hdr);
2443 __owur long dtls1_default_timeout(void);
2444 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2445 __owur int dtls1_check_timeout_num(SSL *s);
2446 __owur int dtls1_handle_timeout(SSL *s);
2447 void dtls1_start_timer(SSL *s);
2448 void dtls1_stop_timer(SSL *s);
2449 __owur int dtls1_is_timer_expired(SSL *s);
2450 void dtls1_double_timeout(SSL *s);
2451 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2453 __owur size_t dtls1_min_mtu(SSL *s);
2454 void dtls1_hm_fragment_free(hm_fragment *frag);
2455 __owur int dtls1_query_mtu(SSL *s);
2457 __owur int tls1_new(SSL *s);
2458 void tls1_free(SSL *s);
2459 int tls1_clear(SSL *s);
2461 __owur int dtls1_new(SSL *s);
2462 void dtls1_free(SSL *s);
2463 int dtls1_clear(SSL *s);
2464 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2465 __owur int dtls1_shutdown(SSL *s);
2467 __owur int dtls1_dispatch_alert(SSL *s);
2469 __owur int ssl_init_wbio_buffer(SSL *s);
2470 int ssl_free_wbio_buffer(SSL *s);
2472 __owur int tls1_change_cipher_state(SSL *s, int which);
2473 __owur int tls1_setup_key_block(SSL *s);
2474 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2476 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2477 unsigned char *p, size_t len,
2478 size_t *secret_size);
2479 __owur int tls13_setup_key_block(SSL *s);
2480 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2482 __owur int tls13_change_cipher_state(SSL *s, int which);
2483 __owur int tls13_update_key(SSL *s, int send);
2484 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2485 const unsigned char *secret,
2486 const unsigned char *label, size_t labellen,
2487 const unsigned char *data, size_t datalen,
2488 unsigned char *out, size_t outlen, int fatal);
2489 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2490 const unsigned char *secret, unsigned char *key,
2492 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2493 const unsigned char *secret, unsigned char *iv,
2495 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2496 const unsigned char *secret,
2497 unsigned char *fin, size_t finlen);
2498 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2499 const unsigned char *prevsecret,
2500 const unsigned char *insecret,
2502 unsigned char *outsecret);
2503 __owur int tls13_generate_handshake_secret(SSL *s,
2504 const unsigned char *insecret,
2505 size_t insecretlen);
2506 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2507 unsigned char *prev, size_t prevlen,
2508 size_t *secret_size);
2509 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2510 const char *label, size_t llen,
2511 const unsigned char *p, size_t plen,
2513 __owur int tls13_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2514 const char *label, size_t llen,
2515 const unsigned char *context,
2516 size_t contextlen, int use_context);
2517 __owur int tls13_export_keying_material_early(SSL *s, unsigned char *out,
2518 size_t olen, const char *label,
2520 const unsigned char *context,
2522 __owur int tls1_alert_code(int code);
2523 __owur int tls13_alert_code(int code);
2524 __owur int ssl3_alert_code(int code);
2526 # ifndef OPENSSL_NO_EC
2527 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2530 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2532 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(uint16_t curve_id);
2533 __owur int tls1_check_group_id(SSL *s, uint16_t group_id, int check_own_curves);
2534 __owur uint16_t tls1_shared_group(SSL *s, int nmatch);
2535 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2536 int *curves, size_t ncurves);
2537 __owur int tls1_set_groups_list(uint16_t **pext, size_t *pextlen,
2539 __owur EVP_PKEY *ssl_generate_pkey_group(SSL *s, uint16_t id);
2540 __owur int tls_valid_group(SSL *s, uint16_t group_id, int version);
2541 __owur EVP_PKEY *ssl_generate_param_group(uint16_t id);
2542 # ifndef OPENSSL_NO_EC
2543 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2544 size_t *num_formats);
2545 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2546 # endif /* OPENSSL_NO_EC */
2548 __owur int tls_group_allowed(SSL *s, uint16_t curve, int op);
2549 void tls1_get_supported_groups(SSL *s, const uint16_t **pgroups,
2550 size_t *pgroupslen);
2552 __owur int tls1_set_server_sigalgs(SSL *s);
2554 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2556 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2558 const unsigned char *sess_id,
2559 size_t sesslen, SSL_SESSION **psess);
2561 __owur int tls_use_ticket(SSL *s);
2563 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2565 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2566 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2568 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2570 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2572 void tls1_set_cert_validity(SSL *s);
2574 # ifndef OPENSSL_NO_CT
2575 __owur int ssl_validate_ct(SSL *s);
2578 # ifndef OPENSSL_NO_DH
2579 __owur DH *ssl_get_auto_dh(SSL *s);
2582 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2583 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2586 int tls_choose_sigalg(SSL *s, int fatalerrs);
2588 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2589 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2590 __owur long ssl_get_algorithm2(SSL *s);
2591 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2592 const uint16_t *psig, size_t psiglen);
2593 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2594 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt, int cert);
2595 __owur int tls1_process_sigalgs(SSL *s);
2596 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2597 __owur int tls1_lookup_md(const SIGALG_LOOKUP *lu, const EVP_MD **pmd);
2598 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2599 # ifndef OPENSSL_NO_EC
2600 __owur int tls_check_sigalg_curve(const SSL *s, int curve);
2602 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2603 __owur int ssl_set_client_disabled(SSL *s);
2604 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op, int echde);
2606 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2608 __owur const EVP_MD *ssl_md(int idx);
2609 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2610 __owur const EVP_MD *ssl_prf_md(SSL *s);
2613 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2614 * with |ssl|, if logging is enabled. It returns one on success and zero on
2615 * failure. The entry is identified by the first 8 bytes of
2616 * |encrypted_premaster|.
2618 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2619 const uint8_t *encrypted_premaster,
2620 size_t encrypted_premaster_len,
2621 const uint8_t *premaster,
2622 size_t premaster_len);
2625 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2626 * logging is available. It returns one on success and zero on failure. It tags
2627 * the entry with |label|.
2629 __owur int ssl_log_secret(SSL *ssl, const char *label,
2630 const uint8_t *secret, size_t secret_len);
2632 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2633 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2634 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2635 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2636 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2637 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2638 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2639 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2642 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2643 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2644 unsigned char *md_out,
2645 size_t *md_out_size,
2646 const unsigned char header[13],
2647 const unsigned char *data,
2648 size_t data_plus_mac_size,
2649 size_t data_plus_mac_plus_padding_size,
2650 const unsigned char *mac_secret,
2651 size_t mac_secret_length, char is_sslv3);
2653 __owur int srp_generate_server_master_secret(SSL *s);
2654 __owur int srp_generate_client_master_secret(SSL *s);
2655 __owur int srp_verify_server_param(SSL *s);
2657 /* statem/statem_srvr.c */
2659 __owur int send_certificate_request(SSL *s);
2661 /* statem/extensions_cust.c */
2663 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2664 ENDPOINT role, unsigned int ext_type,
2667 void custom_ext_init(custom_ext_methods *meths);
2669 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2670 const unsigned char *ext_data, size_t ext_size,
2671 X509 *x, size_t chainidx);
2672 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2673 size_t chainidx, int maxversion);
2675 __owur int custom_exts_copy(custom_ext_methods *dst,
2676 const custom_ext_methods *src);
2677 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2678 const custom_ext_methods *src);
2679 void custom_exts_free(custom_ext_methods *exts);
2681 void ssl_comp_free_compression_methods_int(void);
2684 void ssl_ctx_system_config(SSL_CTX *ctx);
2686 # else /* OPENSSL_UNIT_TEST */
2688 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2689 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers