2 * Copyright 1995-2020 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 OSSL_SSL_LOCAL_H
13 # define OSSL_SSL_LOCAL_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
183 /* GOST KDF key exchange, draft-smyshlyaev-tls12-gost-suites */
184 # define SSL_kGOST18 0x00000200U
188 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
190 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
191 # define SSL_kANY 0x00000000U
193 /* Bits for algorithm_auth (server authentication) */
195 # define SSL_aRSA 0x00000001U
197 # define SSL_aDSS 0x00000002U
198 /* no auth (i.e. use ADH or AECDH) */
199 # define SSL_aNULL 0x00000004U
201 # define SSL_aECDSA 0x00000008U
203 # define SSL_aPSK 0x00000010U
204 /* GOST R 34.10-2001 signature auth */
205 # define SSL_aGOST01 0x00000020U
207 # define SSL_aSRP 0x00000040U
208 /* GOST R 34.10-2012 signature auth */
209 # define SSL_aGOST12 0x00000080U
210 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
211 # define SSL_aANY 0x00000000U
212 /* All bits requiring a certificate */
214 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
216 /* Bits for algorithm_enc (symmetric encryption) */
217 # define SSL_DES 0x00000001U
218 # define SSL_3DES 0x00000002U
219 # define SSL_RC4 0x00000004U
220 # define SSL_RC2 0x00000008U
221 # define SSL_IDEA 0x00000010U
222 # define SSL_eNULL 0x00000020U
223 # define SSL_AES128 0x00000040U
224 # define SSL_AES256 0x00000080U
225 # define SSL_CAMELLIA128 0x00000100U
226 # define SSL_CAMELLIA256 0x00000200U
227 # define SSL_eGOST2814789CNT 0x00000400U
228 # define SSL_SEED 0x00000800U
229 # define SSL_AES128GCM 0x00001000U
230 # define SSL_AES256GCM 0x00002000U
231 # define SSL_AES128CCM 0x00004000U
232 # define SSL_AES256CCM 0x00008000U
233 # define SSL_AES128CCM8 0x00010000U
234 # define SSL_AES256CCM8 0x00020000U
235 # define SSL_eGOST2814789CNT12 0x00040000U
236 # define SSL_CHACHA20POLY1305 0x00080000U
237 # define SSL_ARIA128GCM 0x00100000U
238 # define SSL_ARIA256GCM 0x00200000U
239 # define SSL_MAGMA 0x00400000U
240 # define SSL_KUZNYECHIK 0x00800000U
242 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
243 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
244 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
245 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
246 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
247 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
248 # define SSL_ARIA (SSL_ARIAGCM)
249 # define SSL_CBC (SSL_DES | SSL_3DES | SSL_RC2 | SSL_IDEA \
250 | SSL_AES128 | SSL_AES256 | SSL_CAMELLIA128 \
251 | SSL_CAMELLIA256 | SSL_SEED)
253 /* Bits for algorithm_mac (symmetric authentication) */
255 # define SSL_MD5 0x00000001U
256 # define SSL_SHA1 0x00000002U
257 # define SSL_GOST94 0x00000004U
258 # define SSL_GOST89MAC 0x00000008U
259 # define SSL_SHA256 0x00000010U
260 # define SSL_SHA384 0x00000020U
261 /* Not a real MAC, just an indication it is part of cipher */
262 # define SSL_AEAD 0x00000040U
263 # define SSL_GOST12_256 0x00000080U
264 # define SSL_GOST89MAC12 0x00000100U
265 # define SSL_GOST12_512 0x00000200U
266 # define SSL_MAGMAOMAC 0x00000400U
267 # define SSL_KUZNYECHIKOMAC 0x00000800U
270 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
271 * sure to update this constant too
274 # define SSL_MD_MD5_IDX 0
275 # define SSL_MD_SHA1_IDX 1
276 # define SSL_MD_GOST94_IDX 2
277 # define SSL_MD_GOST89MAC_IDX 3
278 # define SSL_MD_SHA256_IDX 4
279 # define SSL_MD_SHA384_IDX 5
280 # define SSL_MD_GOST12_256_IDX 6
281 # define SSL_MD_GOST89MAC12_IDX 7
282 # define SSL_MD_GOST12_512_IDX 8
283 # define SSL_MD_MD5_SHA1_IDX 9
284 # define SSL_MD_SHA224_IDX 10
285 # define SSL_MD_SHA512_IDX 11
286 # define SSL_MD_MAGMAOMAC_IDX 12
287 # define SSL_MD_KUZNYECHIKOMAC_IDX 13
288 # define SSL_MAX_DIGEST 14
290 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
292 /* Bits for algorithm2 (handshake digests and other extra flags) */
294 /* Bits 0-7 are handshake MAC */
295 # define SSL_HANDSHAKE_MAC_MASK 0xFF
296 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
297 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
298 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
299 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
300 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
301 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
302 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
304 /* Bits 8-15 bits are PRF */
305 # define TLS1_PRF_DGST_SHIFT 8
306 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
307 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
308 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
309 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
310 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
311 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
312 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
315 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
316 * goes into algorithm2)
318 # define TLS1_STREAM_MAC 0x10000
320 * TLSTREE cipher/mac key derivation from draft-smyshlyaev-tls12-gost-suites
321 * (currently this also goes into algorithm2)
323 # define TLS1_TLSTREE 0x20000
325 # define SSL_STRONG_MASK 0x0000001FU
326 # define SSL_DEFAULT_MASK 0X00000020U
328 # define SSL_STRONG_NONE 0x00000001U
329 # define SSL_LOW 0x00000002U
330 # define SSL_MEDIUM 0x00000004U
331 # define SSL_HIGH 0x00000008U
332 # define SSL_FIPS 0x00000010U
333 # define SSL_NOT_DEFAULT 0x00000020U
335 /* we have used 0000003f - 26 bits left to go */
337 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
338 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
340 /* Check if an SSL structure is using DTLS */
341 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
343 /* Check if we are using TLSv1.3 */
344 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
345 && (s)->method->version >= TLS1_3_VERSION \
346 && (s)->method->version != TLS_ANY_VERSION)
348 # define SSL_TREAT_AS_TLS13(s) \
349 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
350 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
351 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
352 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
353 || (s)->hello_retry_request == SSL_HRR_PENDING)
355 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3.tmp.finish_md_len == 0 \
356 || (s)->s3.tmp.peer_finish_md_len == 0)
358 /* See if we need explicit IV */
359 # define SSL_USE_EXPLICIT_IV(s) \
360 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
362 * See if we use signature algorithms extension and signature algorithm
365 # define SSL_USE_SIGALGS(s) \
366 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
368 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
369 * apply to others in future.
371 # define SSL_USE_TLS1_2_CIPHERS(s) \
372 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
374 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
375 * flags because it may not be set to correct version yet.
377 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
378 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
379 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
381 * Determine if a client should send signature algorithms extension:
382 * as with TLS1.2 cipher we can't rely on method flags.
384 # define SSL_CLIENT_USE_SIGALGS(s) \
385 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
387 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
388 (((value) >= TLSEXT_max_fragment_length_512) && \
389 ((value) <= TLSEXT_max_fragment_length_4096))
390 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
391 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
392 # define GET_MAX_FRAGMENT_LENGTH(session) \
393 (512U << (session->ext.max_fragment_len_mode - 1))
395 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
396 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
398 /* Mostly for SSLv3 */
399 # define SSL_PKEY_RSA 0
400 # define SSL_PKEY_RSA_PSS_SIGN 1
401 # define SSL_PKEY_DSA_SIGN 2
402 # define SSL_PKEY_ECC 3
403 # define SSL_PKEY_GOST01 4
404 # define SSL_PKEY_GOST12_256 5
405 # define SSL_PKEY_GOST12_512 6
406 # define SSL_PKEY_ED25519 7
407 # define SSL_PKEY_ED448 8
408 # define SSL_PKEY_NUM 9
410 # define SSL_ENC_DES_IDX 0
411 # define SSL_ENC_3DES_IDX 1
412 # define SSL_ENC_RC4_IDX 2
413 # define SSL_ENC_RC2_IDX 3
414 # define SSL_ENC_IDEA_IDX 4
415 # define SSL_ENC_NULL_IDX 5
416 # define SSL_ENC_AES128_IDX 6
417 # define SSL_ENC_AES256_IDX 7
418 # define SSL_ENC_CAMELLIA128_IDX 8
419 # define SSL_ENC_CAMELLIA256_IDX 9
420 # define SSL_ENC_GOST89_IDX 10
421 # define SSL_ENC_SEED_IDX 11
422 # define SSL_ENC_AES128GCM_IDX 12
423 # define SSL_ENC_AES256GCM_IDX 13
424 # define SSL_ENC_AES128CCM_IDX 14
425 # define SSL_ENC_AES256CCM_IDX 15
426 # define SSL_ENC_AES128CCM8_IDX 16
427 # define SSL_ENC_AES256CCM8_IDX 17
428 # define SSL_ENC_GOST8912_IDX 18
429 # define SSL_ENC_CHACHA_IDX 19
430 # define SSL_ENC_ARIA128GCM_IDX 20
431 # define SSL_ENC_ARIA256GCM_IDX 21
432 # define SSL_ENC_MAGMA_IDX 22
433 # define SSL_ENC_KUZNYECHIK_IDX 23
434 # define SSL_ENC_NUM_IDX 24
437 * SSL_kRSA <- RSA_ENC
438 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
439 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
440 * SSL_aRSA <- RSA_ENC | RSA_SIGN
441 * SSL_aDSS <- DSA_SIGN
445 #define CERT_INVALID 0
446 #define CERT_PUBLIC_KEY 1
447 #define CERT_PRIVATE_KEY 2
450 /* Post-Handshake Authentication state */
453 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
454 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
455 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
456 SSL_PHA_REQUESTED /* request received by client, or sent by server */
459 /* CipherSuite length. SSLv3 and all TLS versions. */
460 # define TLS_CIPHER_LEN 2
461 /* used to hold info on the particular ciphers used */
462 struct ssl_cipher_st {
464 const char *name; /* text name */
465 const char *stdname; /* RFC name */
466 uint32_t id; /* id, 4 bytes, first is version */
468 * changed in 1.0.0: these four used to be portions of a single value
471 uint32_t algorithm_mkey; /* key exchange algorithm */
472 uint32_t algorithm_auth; /* server authentication */
473 uint32_t algorithm_enc; /* symmetric encryption */
474 uint32_t algorithm_mac; /* symmetric authentication */
475 int min_tls; /* minimum SSL/TLS protocol version */
476 int max_tls; /* maximum SSL/TLS protocol version */
477 int min_dtls; /* minimum DTLS protocol version */
478 int max_dtls; /* maximum DTLS protocol version */
479 uint32_t algo_strength; /* strength and export flags */
480 uint32_t algorithm2; /* Extra flags */
481 int32_t strength_bits; /* Number of bits really used */
482 uint32_t alg_bits; /* Number of bits for algorithm */
485 /* Used to hold SSL/TLS functions */
486 struct ssl_method_st {
490 int (*ssl_new) (SSL *s);
491 int (*ssl_clear) (SSL *s);
492 void (*ssl_free) (SSL *s);
493 int (*ssl_accept) (SSL *s);
494 int (*ssl_connect) (SSL *s);
495 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
496 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
497 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
498 int (*ssl_shutdown) (SSL *s);
499 int (*ssl_renegotiate) (SSL *s);
500 int (*ssl_renegotiate_check) (SSL *s, int);
501 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
502 unsigned char *buf, size_t len, int peek,
504 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
506 int (*ssl_dispatch_alert) (SSL *s);
507 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
508 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
509 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
510 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
512 size_t (*ssl_pending) (const SSL *s);
513 int (*num_ciphers) (void);
514 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
515 long (*get_timeout) (void);
516 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
517 int (*ssl_version) (void);
518 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
519 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
523 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
524 * consistency, even in the event of OPENSSL_NO_PSK being defined.
526 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 256
529 * Lets make this into an ASN.1 type structure as follows
530 * SSL_SESSION_ID ::= SEQUENCE {
531 * version INTEGER, -- structure version number
532 * SSLversion INTEGER, -- SSL version number
533 * Cipher OCTET STRING, -- the 3 byte cipher ID
534 * Session_ID OCTET STRING, -- the Session ID
535 * Master_key OCTET STRING, -- the master key
536 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
537 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
538 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
539 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
540 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
541 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
542 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
543 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
544 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
545 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
546 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
547 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
548 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
549 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
551 * Look in ssl/ssl_asn1.c for more details
552 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
554 struct ssl_session_st {
555 int ssl_version; /* what ssl version session info is being kept
557 size_t master_key_length;
559 /* TLSv1.3 early_secret used for external PSKs */
560 unsigned char early_secret[EVP_MAX_MD_SIZE];
562 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
565 unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
566 /* session_id - valid? */
567 size_t session_id_length;
568 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
570 * this is used to determine whether the session is being reused in the
571 * appropriate context. It is up to the application to set this, via
574 size_t sid_ctx_length;
575 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
576 # ifndef OPENSSL_NO_PSK
577 char *psk_identity_hint;
581 * Used to indicate that session resumption is not allowed. Applications
582 * can also set this bit for a new session via not_resumable_session_cb
583 * to disable session caching and tickets.
586 /* This is the cert and type for the other end. */
589 /* Certificate chain peer sent. */
590 STACK_OF(X509) *peer_chain;
592 * when app_verify_callback accepts a session where the peer's
593 * certificate is not ok, we must remember the error for session reuse:
595 long verify_result; /* only for servers */
596 CRYPTO_REF_COUNT references;
599 unsigned int compress_meth; /* Need to lookup the method */
600 const SSL_CIPHER *cipher;
601 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
602 * load the 'cipher' structure */
603 CRYPTO_EX_DATA ex_data; /* application specific data */
605 * These are used to make removal of session-ids more efficient and to
606 * implement a maximum cache size.
608 struct ssl_session_st *prev, *next;
613 unsigned char *tick; /* Session ticket */
614 size_t ticklen; /* Session ticket length */
615 /* Session lifetime hint in seconds */
616 unsigned long tick_lifetime_hint;
617 uint32_t tick_age_add;
618 /* Max number of bytes that can be sent as early data */
619 uint32_t max_early_data;
620 /* The ALPN protocol selected for this session */
621 unsigned char *alpn_selected;
622 size_t alpn_selected_len;
624 * Maximum Fragment Length as per RFC 4366.
625 * If this value does not contain RFC 4366 allowed values (1-4) then
626 * either the Maximum Fragment Length Negotiation failed or was not
629 uint8_t max_fragment_len_mode;
631 # ifndef OPENSSL_NO_SRP
634 unsigned char *ticket_appdata;
635 size_t ticket_appdata_len;
640 /* Extended master secret support */
641 # define SSL_SESS_FLAG_EXTMS 0x1
643 # ifndef OPENSSL_NO_SRP
645 typedef struct srp_ctx_st {
646 /* param for all the callbacks */
648 /* set client Hello login callback */
649 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
650 /* set SRP N/g param callback for verification */
651 int (*SRP_verify_param_callback) (SSL *, void *);
652 /* set SRP client passwd callback */
653 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
655 BIGNUM *N, *g, *s, *B, *A;
659 unsigned long srp_Mask;
665 SSL_EARLY_DATA_NONE = 0,
666 SSL_EARLY_DATA_CONNECT_RETRY,
667 SSL_EARLY_DATA_CONNECTING,
668 SSL_EARLY_DATA_WRITE_RETRY,
669 SSL_EARLY_DATA_WRITING,
670 SSL_EARLY_DATA_WRITE_FLUSH,
671 SSL_EARLY_DATA_UNAUTH_WRITING,
672 SSL_EARLY_DATA_FINISHED_WRITING,
673 SSL_EARLY_DATA_ACCEPT_RETRY,
674 SSL_EARLY_DATA_ACCEPTING,
675 SSL_EARLY_DATA_READ_RETRY,
676 SSL_EARLY_DATA_READING,
677 SSL_EARLY_DATA_FINISHED_READING
678 } SSL_EARLY_DATA_STATE;
681 * We check that the amount of unreadable early data doesn't exceed
682 * max_early_data. max_early_data is given in plaintext bytes. However if it is
683 * unreadable then we only know the number of ciphertext bytes. We also don't
684 * know how much the overhead should be because it depends on the ciphersuite.
685 * We make a small allowance. We assume 5 records of actual data plus the end
686 * of early data alert record. Each record has a tag and a content type byte.
687 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
688 * content of the alert record either which is 2 bytes.
690 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
693 * The allowance we have between the client's calculated ticket age and our own.
694 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
695 * client's age calculation is different by more than this than our own then we
696 * do not allow that ticket for early_data.
698 # define TICKET_AGE_ALLOWANCE (10 * 1000)
700 #define MAX_COMPRESSIONS_SIZE 255
708 typedef struct raw_extension_st {
709 /* Raw packet data for the extension */
711 /* Set to 1 if the extension is present or 0 otherwise */
713 /* Set to 1 if we have already parsed the extension or 0 otherwise */
715 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
717 /* Track what order extensions are received in (0-based). */
718 size_t received_order;
723 unsigned int legacy_version;
724 unsigned char random[SSL3_RANDOM_SIZE];
725 size_t session_id_len;
726 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
727 size_t dtls_cookie_len;
728 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
730 size_t compressions_len;
731 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
733 size_t pre_proc_exts_len;
734 RAW_EXTENSION *pre_proc_exts;
738 * Extension index values NOTE: Any updates to these defines should be mirrored
739 * with equivalent updates to ext_defs in extensions.c
741 typedef enum tlsext_index_en {
742 TLSEXT_IDX_renegotiate,
743 TLSEXT_IDX_server_name,
744 TLSEXT_IDX_max_fragment_length,
746 TLSEXT_IDX_ec_point_formats,
747 TLSEXT_IDX_supported_groups,
748 TLSEXT_IDX_session_ticket,
749 TLSEXT_IDX_status_request,
750 TLSEXT_IDX_next_proto_neg,
751 TLSEXT_IDX_application_layer_protocol_negotiation,
753 TLSEXT_IDX_encrypt_then_mac,
754 TLSEXT_IDX_signed_certificate_timestamp,
755 TLSEXT_IDX_extended_master_secret,
756 TLSEXT_IDX_signature_algorithms_cert,
757 TLSEXT_IDX_post_handshake_auth,
758 TLSEXT_IDX_signature_algorithms,
759 TLSEXT_IDX_supported_versions,
760 TLSEXT_IDX_psk_kex_modes,
761 TLSEXT_IDX_key_share,
763 TLSEXT_IDX_cryptopro_bug,
764 TLSEXT_IDX_early_data,
765 TLSEXT_IDX_certificate_authorities,
768 /* Dummy index - must always be the last entry */
769 TLSEXT_IDX_num_builtins
772 DEFINE_LHASH_OF(SSL_SESSION);
773 /* Needed in ssl_cert.c */
774 DEFINE_LHASH_OF(X509_NAME);
776 # define TLSEXT_KEYNAME_LENGTH 16
777 # define TLSEXT_TICK_KEY_LENGTH 32
779 typedef struct ssl_ctx_ext_secure_st {
780 unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
781 unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
782 } SSL_CTX_EXT_SECURE;
785 * Helper function for HMAC
786 * The structure should be considered opaque, it will change once the low
787 * level deprecated calls are removed. At that point it can be replaced
788 * by EVP_MAC_CTX and most of the functions converted to macros or inlined
791 typedef struct ssl_hmac_st {
793 # ifndef OPENSSL_NO_DEPRECATED_3_0
798 SSL_HMAC *ssl_hmac_new(const SSL_CTX *ctx);
799 void ssl_hmac_free(SSL_HMAC *ctx);
800 # ifndef OPENSSL_NO_DEPRECATED_3_0
801 HMAC_CTX *ssl_hmac_get0_HMAC_CTX(SSL_HMAC *ctx);
803 EVP_MAC_CTX *ssl_hmac_get0_EVP_MAC_CTX(SSL_HMAC *ctx);
804 int ssl_hmac_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
805 int ssl_hmac_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
806 int ssl_hmac_final(SSL_HMAC *ctx, unsigned char *md, size_t *len,
808 size_t ssl_hmac_size(const SSL_HMAC *ctx);
810 typedef struct tls_group_info_st {
811 char *tlsname; /* Curve Name as in TLS specs */
812 char *realname; /* Curve Name according to provider */
813 char *algorithm; /* Algorithm name to fetch */
814 unsigned int secbits; /* Bits of security (from SP800-57) */
815 uint16_t group_id; /* Group ID */
816 int mintls; /* Minimum TLS version, -1 unsupported */
817 int maxtls; /* Maximum TLS version (or 0 for undefined) */
818 int mindtls; /* Minimum DTLS version, -1 unsupported */
819 int maxdtls; /* Maximum DTLS version (or 0 for undefined) */
823 # define TLS_GROUP_TYPE 0x0000000FU /* Mask for group type */
824 # define TLS_GROUP_CURVE_PRIME 0x00000001U
825 # define TLS_GROUP_CURVE_CHAR2 0x00000002U
826 # define TLS_GROUP_CURVE_CUSTOM 0x00000004U
827 # define TLS_GROUP_FFDHE 0x00000008U
828 # define TLS_GROUP_ONLY_FOR_TLS1_3 0x00000010U
830 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
835 const SSL_METHOD *method;
836 STACK_OF(SSL_CIPHER) *cipher_list;
837 /* same as above but sorted for lookup */
838 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
839 /* TLSv1.3 specific ciphersuites */
840 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
841 struct x509_store_st /* X509_STORE */ *cert_store;
842 LHASH_OF(SSL_SESSION) *sessions;
844 * Most session-ids that will be cached, default is
845 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
847 size_t session_cache_size;
848 struct ssl_session_st *session_cache_head;
849 struct ssl_session_st *session_cache_tail;
851 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
852 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
853 * means only SSL_accept will cache SSL_SESSIONS.
855 uint32_t session_cache_mode;
857 * If timeout is not 0, it is the default timeout value set when
858 * SSL_new() is called. This has been put in to make life easier to set
861 long session_timeout;
863 * If this callback is not null, it will be called each time a session id
864 * is added to the cache. If this function returns 1, it means that the
865 * callback will do a SSL_SESSION_free() when it has finished using it.
866 * Otherwise, on 0, it means the callback has finished with it. If
867 * remove_session_cb is not null, it will be called when a session-id is
868 * removed from the cache. After the call, OpenSSL will
869 * SSL_SESSION_free() it.
871 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
872 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
873 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
874 const unsigned char *data, int len,
877 TSAN_QUALIFIER int sess_connect; /* SSL new conn - started */
878 TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
879 TSAN_QUALIFIER int sess_connect_good; /* SSL new conne/reneg - finished */
880 TSAN_QUALIFIER int sess_accept; /* SSL new accept - started */
881 TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
882 TSAN_QUALIFIER int sess_accept_good; /* SSL accept/reneg - finished */
883 TSAN_QUALIFIER int sess_miss; /* session lookup misses */
884 TSAN_QUALIFIER int sess_timeout; /* reuse attempt on timeouted session */
885 TSAN_QUALIFIER int sess_cache_full; /* session removed due to full cache */
886 TSAN_QUALIFIER int sess_hit; /* session reuse actually done */
887 TSAN_QUALIFIER int sess_cb_hit; /* session-id that was not in
888 * the cache was passed back via
889 * the callback. This indicates
890 * that the application is
891 * supplying session-id's from
892 * other processes - spooky
896 CRYPTO_REF_COUNT references;
898 /* if defined, these override the X509_verify_cert() calls */
899 int (*app_verify_callback) (X509_STORE_CTX *, void *);
900 void *app_verify_arg;
902 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
903 * ('app_verify_callback' was called with just one argument)
906 /* Default password callback. */
907 pem_password_cb *default_passwd_callback;
909 /* Default password callback user data. */
910 void *default_passwd_callback_userdata;
912 /* get client cert callback */
913 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
915 /* cookie generate callback */
916 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
917 unsigned int *cookie_len);
919 /* verify cookie callback */
920 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
921 unsigned int cookie_len);
923 /* TLS1.3 app-controlled cookie generate callback */
924 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
927 /* TLS1.3 verify app-controlled cookie callback */
928 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
931 CRYPTO_EX_DATA ex_data;
933 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
934 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3-sha1' */
936 STACK_OF(X509) *extra_certs;
937 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
939 /* Default values used when no per-SSL value is defined follow */
941 /* used if SSL's info_callback is NULL */
942 void (*info_callback) (const SSL *ssl, int type, int val);
945 * What we put in certificate_authorities extension for TLS 1.3
946 * (ClientHello and CertificateRequest) or just client cert requests for
947 * earlier versions. If client_ca_names is populated then it is only used
948 * for client cert requests, and in preference to ca_names.
950 STACK_OF(X509_NAME) *ca_names;
951 STACK_OF(X509_NAME) *client_ca_names;
954 * Default values to use in SSL structures follow (these are copied by
960 int min_proto_version;
961 int max_proto_version;
962 size_t max_cert_list;
964 struct cert_st /* CERT */ *cert;
967 /* callback that allows applications to peek at protocol messages */
968 void (*msg_callback) (int write_p, int version, int content_type,
969 const void *buf, size_t len, SSL *ssl, void *arg);
970 void *msg_callback_arg;
972 uint32_t verify_mode;
973 size_t sid_ctx_length;
974 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
975 /* called 'verify_callback' in the SSL */
976 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
978 /* Default generate session ID callback. */
979 GEN_SESSION_CB generate_session_id;
981 X509_VERIFY_PARAM *param;
985 # ifndef OPENSSL_NO_CT
986 CTLOG_STORE *ctlog_store; /* CT Log Store */
988 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
989 * If they are not, the connection should be aborted.
991 ssl_ct_validation_cb ct_validation_callback;
992 void *ct_validation_callback_arg;
996 * If we're using more than one pipeline how should we divide the data
997 * up between the pipes?
999 size_t split_send_fragment;
1001 * Maximum amount of data to send in one fragment. actual record size can
1002 * be more than this due to padding and MAC overheads.
1004 size_t max_send_fragment;
1006 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1007 size_t max_pipelines;
1009 /* The default read buffer length to use (0 means not set) */
1010 size_t default_read_buf_len;
1012 # ifndef OPENSSL_NO_ENGINE
1014 * Engine to pass requests for client certs to
1016 ENGINE *client_cert_engine;
1019 /* ClientHello callback. Mostly for extensions, but not entirely. */
1020 SSL_client_hello_cb_fn client_hello_cb;
1021 void *client_hello_cb_arg;
1023 /* TLS extensions. */
1025 /* TLS extensions servername callback */
1026 int (*servername_cb) (SSL *, int *, void *);
1027 void *servername_arg;
1028 /* RFC 4507 session ticket keys */
1029 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
1030 SSL_CTX_EXT_SECURE *secure;
1031 # ifndef OPENSSL_NO_DEPRECATED_3_0
1032 /* Callback to support customisation of ticket key setting */
1033 int (*ticket_key_cb) (SSL *ssl,
1034 unsigned char *name, unsigned char *iv,
1035 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
1037 int (*ticket_key_evp_cb) (SSL *ssl,
1038 unsigned char *name, unsigned char *iv,
1039 EVP_CIPHER_CTX *ectx, EVP_MAC_CTX *hctx,
1042 /* certificate status request info */
1043 /* Callback for status request */
1044 int (*status_cb) (SSL *ssl, void *arg);
1046 /* ext status type used for CSR extension (OCSP Stapling) */
1048 /* RFC 4366 Maximum Fragment Length Negotiation */
1049 uint8_t max_fragment_len_mode;
1051 # ifndef OPENSSL_NO_EC
1052 /* EC extension values inherited by SSL structure */
1053 size_t ecpointformats_len;
1054 unsigned char *ecpointformats;
1055 # endif /* OPENSSL_NO_EC */
1057 size_t supportedgroups_len;
1058 uint16_t *supportedgroups;
1061 * ALPN information (we are in the process of transitioning from NPN to
1066 * For a server, this contains a callback function that allows the
1067 * server to select the protocol for the connection.
1068 * out: on successful return, this must point to the raw protocol
1069 * name (without the length prefix).
1070 * outlen: on successful return, this contains the length of |*out|.
1071 * in: points to the client's list of supported protocols in
1073 * inlen: the length of |in|.
1075 int (*alpn_select_cb) (SSL *s,
1076 const unsigned char **out,
1077 unsigned char *outlen,
1078 const unsigned char *in,
1079 unsigned int inlen, void *arg);
1080 void *alpn_select_cb_arg;
1083 * For a client, this contains the list of supported protocols in wire
1086 unsigned char *alpn;
1089 # ifndef OPENSSL_NO_NEXTPROTONEG
1090 /* Next protocol negotiation information */
1093 * For a server, this contains a callback function by which the set of
1094 * advertised protocols can be provided.
1096 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
1097 void *npn_advertised_cb_arg;
1099 * For a client, this contains a callback function that selects the next
1100 * protocol from the list provided by the server.
1102 SSL_CTX_npn_select_cb_func npn_select_cb;
1103 void *npn_select_cb_arg;
1106 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1109 # ifndef OPENSSL_NO_PSK
1110 SSL_psk_client_cb_func psk_client_callback;
1111 SSL_psk_server_cb_func psk_server_callback;
1113 SSL_psk_find_session_cb_func psk_find_session_cb;
1114 SSL_psk_use_session_cb_func psk_use_session_cb;
1116 # ifndef OPENSSL_NO_SRP
1117 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1120 /* Shared DANE context */
1121 struct dane_ctx_st dane;
1123 # ifndef OPENSSL_NO_SRTP
1124 /* SRTP profiles we are willing to do from RFC 5764 */
1125 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1128 * Callback for disabling session caching and ticket support on a session
1129 * basis, depending on the chosen cipher.
1131 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1133 CRYPTO_RWLOCK *lock;
1136 * Callback for logging key material for use with debugging tools like
1137 * Wireshark. The callback should log `line` followed by a newline.
1139 SSL_CTX_keylog_cb_func keylog_callback;
1142 * The maximum number of bytes advertised in session tickets that can be
1143 * sent as early data.
1145 uint32_t max_early_data;
1148 * The maximum number of bytes of early data that a server will tolerate
1149 * (which should be at least as much as max_early_data).
1151 uint32_t recv_max_early_data;
1153 /* TLS1.3 padding callback */
1154 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1155 void *record_padding_arg;
1156 size_t block_padding;
1158 /* Session ticket appdata */
1159 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1160 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1161 void *ticket_cb_data;
1163 /* The number of TLS1.3 tickets to automatically send */
1166 /* Callback to determine if early_data is acceptable or not */
1167 SSL_allow_early_data_cb_fn allow_early_data_cb;
1168 void *allow_early_data_cb_data;
1170 /* Do we advertise Post-handshake auth support? */
1173 /* Callback for SSL async handling */
1174 SSL_async_callback_fn async_cb;
1179 const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
1180 const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX];
1181 size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
1183 /* Cache of all sigalgs we know and whether they are available or not */
1184 struct sigalg_lookup_st *sigalg_lookup_cache;
1186 TLS_GROUP_INFO *group_list;
1187 size_t group_list_len;
1188 size_t group_list_max_len;
1191 typedef struct cert_pkey_st CERT_PKEY;
1195 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1200 const SSL_METHOD *method;
1202 * There are 2 BIO's even though they are normally both the same. This
1203 * is so data can be read and written to different handlers
1205 /* used by SSL_read */
1207 /* used by SSL_write */
1209 /* used during session-id reuse to concatenate messages */
1212 * This holds a variable that indicates what we were doing when a 0 or -1
1213 * is returned. This is needed for non-blocking IO so we know what
1214 * request needs re-doing when in SSL_accept or SSL_connect
1217 int (*handshake_func) (SSL *);
1219 * Imagine that here's a boolean member "init" that is switched as soon
1220 * as SSL_set_{accept/connect}_state is called for the first time, so
1221 * that "state" and "handshake_func" are properly initialized. But as
1222 * handshake_func is == 0 until then, we use this test instead of an
1225 /* are we the server side? */
1228 * Generate a new session or reuse an old one.
1229 * NB: For servers, the 'new' session may actually be a previously
1230 * cached session or even the previous session unless
1231 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1234 /* don't send shutdown packets */
1236 /* we have shut things down, 0x01 sent, 0x02 for received */
1240 SSL_EARLY_DATA_STATE early_data_state;
1241 BUF_MEM *init_buf; /* buffer used during init */
1242 void *init_msg; /* pointer to handshake message body, set by
1243 * ssl3_get_message() */
1244 size_t init_num; /* amount read/written */
1245 size_t init_off; /* amount read/written */
1249 size_t read_mac_secret_size;
1250 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1251 size_t write_mac_secret_size;
1252 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1253 unsigned char server_random[SSL3_RANDOM_SIZE];
1254 unsigned char client_random[SSL3_RANDOM_SIZE];
1255 /* flags for countermeasure against known-IV weakness */
1256 int need_empty_fragments;
1257 int empty_fragment_done;
1258 /* used during startup, digest all incoming/outgoing packets */
1259 BIO *handshake_buffer;
1261 * When handshake digest is determined, buffer is hashed and
1262 * freed and MD_CTX for the required digest is stored here.
1264 EVP_MD_CTX *handshake_dgst;
1266 * Set whenever an expected ChangeCipherSpec message is processed.
1267 * Unset when the peer's Finished message is received.
1268 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1270 int change_cipher_spec;
1274 * we allow one fatal and one warning alert to be outstanding, send close
1275 * alert via the warning alert
1278 unsigned char send_alert[2];
1280 * This flag is set when we should renegotiate ASAP, basically when there
1281 * is no more data in the read or write buffers
1284 int total_renegotiations;
1285 int num_renegotiations;
1286 int in_read_app_data;
1288 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1289 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1290 size_t finish_md_len;
1291 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1292 size_t peer_finish_md_len;
1293 size_t message_size;
1295 /* used to hold the new cipher we are going to use */
1296 const SSL_CIPHER *new_cipher;
1297 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1298 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1300 /* used for certificate requests */
1302 /* Certificate types in certificate request message. */
1305 /* Certificate authorities list peer sent */
1306 STACK_OF(X509_NAME) *peer_ca_names;
1307 size_t key_block_length;
1308 unsigned char *key_block;
1309 const EVP_CIPHER *new_sym_enc;
1310 const EVP_MD *new_hash;
1311 int new_mac_pkey_type;
1312 size_t new_mac_secret_size;
1313 # ifndef OPENSSL_NO_COMP
1314 const SSL_COMP *new_compression;
1316 char *new_compression;
1319 /* Raw values of the cipher list from a client */
1320 unsigned char *ciphers_raw;
1321 size_t ciphers_rawlen;
1322 /* Temporary storage for premaster secret */
1325 # ifndef OPENSSL_NO_PSK
1326 /* Temporary storage for PSK key */
1330 /* Signature algorithm we actually use */
1331 const struct sigalg_lookup_st *sigalg;
1332 /* Pointer to certificate we use */
1335 * signature algorithms peer reports: e.g. supported signature
1336 * algorithms extension for server or as part of a certificate
1337 * request for client.
1338 * Keep track of the algorithms for TLS and X.509 usage separately.
1340 uint16_t *peer_sigalgs;
1341 uint16_t *peer_cert_sigalgs;
1342 /* Size of above arrays */
1343 size_t peer_sigalgslen;
1344 size_t peer_cert_sigalgslen;
1345 /* Sigalg peer actually uses */
1346 const struct sigalg_lookup_st *peer_sigalg;
1348 * Set if corresponding CERT_PKEY can be used with current
1349 * SSL session: e.g. appropriate curve, signature algorithms etc.
1350 * If zero it can't be used at all.
1352 uint32_t valid_flags[SSL_PKEY_NUM];
1354 * For servers the following masks are for the key and auth algorithms
1355 * that are supported by the certs below. For clients they are masks of
1356 * *disabled* algorithms based on the current session.
1361 * The following are used by the client to see if a cipher is allowed or
1362 * not. It contains the minimum and maximum version the client's using
1363 * based on what it knows so far.
1369 /* Connection binding to prevent renegotiation attacks */
1370 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1371 size_t previous_client_finished_len;
1372 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1373 size_t previous_server_finished_len;
1374 int send_connection_binding; /* TODOEKR */
1376 # ifndef OPENSSL_NO_NEXTPROTONEG
1378 * Set if we saw the Next Protocol Negotiation extension from our peer.
1384 * ALPN information (we are in the process of transitioning from NPN to
1389 * In a server these point to the selected ALPN protocol after the
1390 * ClientHello has been processed. In a client these contain the protocol
1391 * that the server selected once the ServerHello has been processed.
1393 unsigned char *alpn_selected;
1394 size_t alpn_selected_len;
1395 /* used by the server to know what options were proposed */
1396 unsigned char *alpn_proposed;
1397 size_t alpn_proposed_len;
1398 /* used by the client to know if it actually sent alpn */
1401 # ifndef OPENSSL_NO_EC
1403 * This is set to true if we believe that this is a version of Safari
1404 * running on OS X 10.6 or newer. We wish to know this because Safari on
1405 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1407 char is_probably_safari;
1408 # endif /* !OPENSSL_NO_EC */
1410 /* For clients: peer temporary key */
1411 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1412 /* The group_id for the DH/ECDH key */
1419 struct dtls1_state_st *d1; /* DTLSv1 variables */
1420 /* callback that allows applications to peek at protocol messages */
1421 void (*msg_callback) (int write_p, int version, int content_type,
1422 const void *buf, size_t len, SSL *ssl, void *arg);
1423 void *msg_callback_arg;
1424 int hit; /* reusing a previous session */
1425 X509_VERIFY_PARAM *param;
1426 /* Per connection DANE state */
1429 STACK_OF(SSL_CIPHER) *peer_ciphers;
1430 STACK_OF(SSL_CIPHER) *cipher_list;
1431 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1432 /* TLSv1.3 specific ciphersuites */
1433 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1435 * These are the ones being used, the ones in SSL_SESSION are the ones to
1436 * be 'copied' into these ones
1440 * The TLS1.3 secrets.
1442 unsigned char early_secret[EVP_MAX_MD_SIZE];
1443 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1444 unsigned char master_secret[EVP_MAX_MD_SIZE];
1445 unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1446 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1447 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1448 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1449 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1450 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1451 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1452 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1453 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1454 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1455 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1456 EVP_MD_CTX *read_hash; /* used for mac generation */
1457 COMP_CTX *compress; /* compression */
1458 COMP_CTX *expand; /* uncompress */
1459 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1460 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1461 EVP_MD_CTX *write_hash; /* used for mac generation */
1464 /* This is used to hold the server certificate used */
1465 struct cert_st /* CERT */ *cert;
1468 * The hash of all messages prior to the CertificateVerify, and the length
1471 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1472 size_t cert_verify_hash_len;
1474 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1475 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1476 hello_retry_request;
1479 * the session_id_context is used to ensure sessions are only reused in
1480 * the appropriate context
1482 size_t sid_ctx_length;
1483 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1484 /* This can also be in the session once a session is established */
1485 SSL_SESSION *session;
1486 /* TLSv1.3 PSK session */
1487 SSL_SESSION *psksession;
1488 unsigned char *psksession_id;
1489 size_t psksession_id_len;
1490 /* Default generate session ID callback. */
1491 GEN_SESSION_CB generate_session_id;
1493 * The temporary TLSv1.3 session id. This isn't really a session id at all
1494 * but is a random value sent in the legacy session id field.
1496 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1497 size_t tmp_session_id_len;
1500 * 0 don't care about verify failure.
1501 * 1 fail if verify fails
1503 uint32_t verify_mode;
1504 /* fail if callback returns 0 */
1505 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1506 /* optional informational callback */
1507 void (*info_callback) (const SSL *ssl, int type, int val);
1508 /* error bytes to be written */
1512 # ifndef OPENSSL_NO_PSK
1513 SSL_psk_client_cb_func psk_client_callback;
1514 SSL_psk_server_cb_func psk_server_callback;
1516 SSL_psk_find_session_cb_func psk_find_session_cb;
1517 SSL_psk_use_session_cb_func psk_use_session_cb;
1520 /* Verified chain of peer */
1521 STACK_OF(X509) *verified_chain;
1523 /* extra application data */
1524 CRYPTO_EX_DATA ex_data;
1526 * What we put in certificate_authorities extension for TLS 1.3
1527 * (ClientHello and CertificateRequest) or just client cert requests for
1528 * earlier versions. If client_ca_names is populated then it is only used
1529 * for client cert requests, and in preference to ca_names.
1531 STACK_OF(X509_NAME) *ca_names;
1532 STACK_OF(X509_NAME) *client_ca_names;
1533 CRYPTO_REF_COUNT references;
1534 /* protocol behaviour */
1538 int min_proto_version;
1539 int max_proto_version;
1540 size_t max_cert_list;
1543 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1544 * secret and SSLv3/TLS (<=1.2) rollback check
1548 * If we're using more than one pipeline how should we divide the data
1549 * up between the pipes?
1551 size_t split_send_fragment;
1553 * Maximum amount of data to send in one fragment. actual record size can
1554 * be more than this due to padding and MAC overheads.
1556 size_t max_send_fragment;
1557 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1558 size_t max_pipelines;
1561 /* Built-in extension flags */
1562 uint8_t extflags[TLSEXT_IDX_num_builtins];
1563 /* TLS extension debug callback */
1564 void (*debug_cb)(SSL *s, int client_server, int type,
1565 const unsigned char *data, int len, void *arg);
1568 /* certificate status request info */
1569 /* Status type or -1 if no status type */
1571 /* Raw extension data, if seen */
1572 unsigned char *scts;
1573 /* Length of raw extension data, if seen */
1575 /* Expect OCSP CertificateStatus message */
1576 int status_expected;
1579 /* OCSP status request only */
1580 STACK_OF(OCSP_RESPID) *ids;
1581 X509_EXTENSIONS *exts;
1582 /* OCSP response received or to be sent */
1583 unsigned char *resp;
1587 /* RFC4507 session ticket expected to be received or sent */
1588 int ticket_expected;
1589 /* TLS 1.3 tickets requested by the application. */
1590 int extra_tickets_expected;
1591 # ifndef OPENSSL_NO_EC
1592 size_t ecpointformats_len;
1594 unsigned char *ecpointformats;
1596 size_t peer_ecpointformats_len;
1598 unsigned char *peer_ecpointformats;
1599 # endif /* OPENSSL_NO_EC */
1600 size_t supportedgroups_len;
1602 uint16_t *supportedgroups;
1604 size_t peer_supportedgroups_len;
1606 uint16_t *peer_supportedgroups;
1608 /* TLS Session Ticket extension override */
1609 TLS_SESSION_TICKET_EXT *session_ticket;
1610 /* TLS Session Ticket extension callback */
1611 tls_session_ticket_ext_cb_fn session_ticket_cb;
1612 void *session_ticket_cb_arg;
1613 /* TLS pre-shared secret session resumption */
1614 tls_session_secret_cb_fn session_secret_cb;
1615 void *session_secret_cb_arg;
1617 * For a client, this contains the list of supported protocols in wire
1620 unsigned char *alpn;
1623 * Next protocol negotiation. For the client, this is the protocol that
1624 * we sent in NextProtocol and is set when handling ServerHello
1625 * extensions. For a server, this is the client's selected_protocol from
1626 * NextProtocol and is set when handling the NextProtocol message, before
1627 * the Finished message.
1632 /* The available PSK key exchange modes */
1635 /* Set to one if we have negotiated ETM */
1638 /* Are we expecting to receive early data? */
1640 /* Is the session suitable for early data? */
1643 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1644 unsigned char *tls13_cookie;
1645 size_t tls13_cookie_len;
1646 /* Have we received a cookie from the client? */
1650 * Maximum Fragment Length as per RFC 4366.
1651 * If this member contains one of the allowed values (1-4)
1652 * then we should include Maximum Fragment Length Negotiation
1653 * extension in Client Hello.
1654 * Please note that value of this member does not have direct
1655 * effect. The actual (binding) value is stored in SSL_SESSION,
1656 * as this extension is optional on server side.
1658 uint8_t max_fragment_len_mode;
1661 * On the client side the number of ticket identities we sent in the
1662 * ClientHello. On the server side the identity of the ticket we
1669 * Parsed form of the ClientHello, kept around across client_hello_cb
1672 CLIENTHELLO_MSG *clienthello;
1675 * no further mod of servername
1676 * 0 : call the servername extension callback.
1677 * 1 : prepare 2, allow last ack just after in server callback.
1678 * 2 : don't call servername callback, no ack in server hello
1680 int servername_done;
1681 # ifndef OPENSSL_NO_CT
1683 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1684 * If they are not, the connection should be aborted.
1686 ssl_ct_validation_cb ct_validation_callback;
1687 /* User-supplied argument that is passed to the ct_validation_callback */
1688 void *ct_validation_callback_arg;
1690 * Consolidated stack of SCTs from all sources.
1691 * Lazily populated by CT_get_peer_scts(SSL*)
1693 STACK_OF(SCT) *scts;
1694 /* Have we attempted to find/parse SCTs yet? */
1697 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1698 # ifndef OPENSSL_NO_SRTP
1700 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1701 /* What's been chosen */
1702 SRTP_PROTECTION_PROFILE *srtp_profile;
1705 * 1 if we are renegotiating.
1706 * 2 if we are a server and are inside a handshake
1707 * (i.e. not just sending a HelloRequest)
1710 /* If sending a KeyUpdate is pending */
1712 /* Post-handshake authentication state */
1713 SSL_PHA_STATE post_handshake_auth;
1715 uint8_t* pha_context;
1716 size_t pha_context_len;
1718 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1720 # ifndef OPENSSL_NO_SRP
1721 /* ctx for SRP authentication */
1725 * Callback for disabling session caching and ticket support on a session
1726 * basis, depending on the chosen cipher.
1728 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1729 RECORD_LAYER rlayer;
1730 /* Default password callback. */
1731 pem_password_cb *default_passwd_callback;
1732 /* Default password callback user data. */
1733 void *default_passwd_callback_userdata;
1734 /* Async Job info */
1736 ASYNC_WAIT_CTX *waitctx;
1740 * The maximum number of bytes advertised in session tickets that can be
1741 * sent as early data.
1743 uint32_t max_early_data;
1745 * The maximum number of bytes of early data that a server will tolerate
1746 * (which should be at least as much as max_early_data).
1748 uint32_t recv_max_early_data;
1751 * The number of bytes of early data received so far. If we accepted early
1752 * data then this is a count of the plaintext bytes. If we rejected it then
1753 * this is a count of the ciphertext bytes.
1755 uint32_t early_data_count;
1757 /* TLS1.3 padding callback */
1758 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1759 void *record_padding_arg;
1760 size_t block_padding;
1762 CRYPTO_RWLOCK *lock;
1764 /* The number of TLS1.3 tickets to automatically send */
1766 /* The number of TLS1.3 tickets actually sent so far */
1767 size_t sent_tickets;
1768 /* The next nonce value to use when we send a ticket on this connection */
1769 uint64_t next_ticket_nonce;
1771 /* Callback to determine if early_data is acceptable or not */
1772 SSL_allow_early_data_cb_fn allow_early_data_cb;
1773 void *allow_early_data_cb_data;
1775 /* Callback for SSL async handling */
1776 SSL_async_callback_fn async_cb;
1780 * Signature algorithms shared by client and server: cached because these
1781 * are used most often.
1783 const struct sigalg_lookup_st **shared_sigalgs;
1784 size_t shared_sigalgslen;
1788 * Structure containing table entry of values associated with the signature
1789 * algorithms (signature scheme) extension
1791 typedef struct sigalg_lookup_st {
1792 /* TLS 1.3 signature scheme name */
1794 /* Raw value used in extension */
1796 /* NID of hash algorithm or NID_undef if no hash */
1798 /* Index of hash algorithm or -1 if no hash algorithm */
1800 /* NID of signature algorithm */
1802 /* Index of signature algorithm */
1804 /* Combined hash and signature NID, if any */
1806 /* Required public key curve (ECDSA only) */
1808 /* Whether this signature algorithm is actually available for use */
1813 * Structure containing table entry of certificate info corresponding to
1817 int nid; /* NID of public key algorithm */
1818 uint32_t amask; /* authmask corresponding to key type */
1821 /* DTLS structures */
1823 # ifndef OPENSSL_NO_SCTP
1824 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1827 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1828 # define DTLS1_MAX_MTU_OVERHEAD 48
1831 * Flag used in message reuse to indicate the buffer contains the record
1832 * header as well as the handshake message header.
1834 # define DTLS1_SKIP_RECORD_HEADER 2
1836 struct dtls1_retransmit_state {
1837 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1838 EVP_MD_CTX *write_hash; /* used for mac generation */
1839 COMP_CTX *compress; /* compression */
1840 SSL_SESSION *session;
1841 unsigned short epoch;
1844 struct hm_header_st {
1850 unsigned int is_ccs;
1851 struct dtls1_retransmit_state saved_retransmit_state;
1854 struct dtls1_timeout_st {
1855 /* Number of read timeouts so far */
1856 unsigned int read_timeouts;
1857 /* Number of write timeouts so far */
1858 unsigned int write_timeouts;
1859 /* Number of alerts received so far */
1860 unsigned int num_alerts;
1863 typedef struct hm_fragment_st {
1864 struct hm_header_st msg_header;
1865 unsigned char *fragment;
1866 unsigned char *reassembly;
1869 typedef struct pqueue_st pqueue;
1870 typedef struct pitem_st pitem;
1873 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1878 typedef struct pitem_st *piterator;
1880 pitem *pitem_new(unsigned char *prio64be, void *data);
1881 void pitem_free(pitem *item);
1882 pqueue *pqueue_new(void);
1883 void pqueue_free(pqueue *pq);
1884 pitem *pqueue_insert(pqueue *pq, pitem *item);
1885 pitem *pqueue_peek(pqueue *pq);
1886 pitem *pqueue_pop(pqueue *pq);
1887 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1888 pitem *pqueue_iterator(pqueue *pq);
1889 pitem *pqueue_next(piterator *iter);
1890 size_t pqueue_size(pqueue *pq);
1892 typedef struct dtls1_state_st {
1893 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1895 unsigned int cookie_verified;
1896 /* handshake message numbers */
1897 unsigned short handshake_write_seq;
1898 unsigned short next_handshake_write_seq;
1899 unsigned short handshake_read_seq;
1900 /* Buffered handshake messages */
1901 pqueue *buffered_messages;
1902 /* Buffered (sent) handshake records */
1903 pqueue *sent_messages;
1904 size_t link_mtu; /* max on-the-wire DTLS packet size */
1905 size_t mtu; /* max DTLS packet size */
1906 struct hm_header_st w_msg_hdr;
1907 struct hm_header_st r_msg_hdr;
1908 struct dtls1_timeout_st timeout;
1910 * Indicates when the last handshake msg sent will timeout
1912 struct timeval next_timeout;
1913 /* Timeout duration */
1914 unsigned int timeout_duration_us;
1916 unsigned int retransmitting;
1917 # ifndef OPENSSL_NO_SCTP
1918 int shutdown_received;
1921 DTLS_timer_cb timer_cb;
1925 # ifndef OPENSSL_NO_EC
1927 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1929 # define EXPLICIT_PRIME_CURVE_TYPE 1
1930 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1931 # define NAMED_CURVE_TYPE 3
1932 # endif /* OPENSSL_NO_EC */
1934 struct cert_pkey_st {
1936 EVP_PKEY *privatekey;
1937 /* Chain for this certificate */
1938 STACK_OF(X509) *chain;
1940 * serverinfo data for this certificate. The data is in TLS Extension
1941 * wire format, specifically it's a series of records like:
1942 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1944 * uint8_t data[length];
1946 unsigned char *serverinfo;
1947 size_t serverinfo_length;
1949 /* Retrieve Suite B flags */
1950 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1951 /* Uses to check strict mode: suite B modes are always strict */
1952 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1953 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1956 ENDPOINT_CLIENT = 0,
1963 unsigned short ext_type;
1965 /* The context which this extension applies to */
1966 unsigned int context;
1968 * Per-connection flags relating to this extension type: not used if
1969 * part of an SSL_CTX structure.
1972 SSL_custom_ext_add_cb_ex add_cb;
1973 SSL_custom_ext_free_cb_ex free_cb;
1975 SSL_custom_ext_parse_cb_ex parse_cb;
1977 } custom_ext_method;
1979 /* ext_flags values */
1982 * Indicates an extension has been received. Used to check for unsolicited or
1983 * duplicate extensions.
1985 # define SSL_EXT_FLAG_RECEIVED 0x1
1987 * Indicates an extension has been sent: used to enable sending of
1988 * corresponding ServerHello extension.
1990 # define SSL_EXT_FLAG_SENT 0x2
1993 custom_ext_method *meths;
1995 } custom_ext_methods;
1997 typedef struct cert_st {
1998 /* Current active set */
2000 * ALWAYS points to an element of the pkeys array
2001 * Probably it would make more sense to store
2002 * an index, not a pointer.
2005 # ifndef OPENSSL_NO_DH
2007 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
2010 /* Flags related to certificates */
2011 uint32_t cert_flags;
2012 CERT_PKEY pkeys[SSL_PKEY_NUM];
2013 /* Custom certificate types sent in certificate request message. */
2017 * supported signature algorithms. When set on a client this is sent in
2018 * the client hello as the supported signature algorithms extension. For
2019 * servers it represents the signature algorithms we are willing to use.
2021 uint16_t *conf_sigalgs;
2022 /* Size of above array */
2023 size_t conf_sigalgslen;
2025 * Client authentication signature algorithms, if not set then uses
2026 * conf_sigalgs. On servers these will be the signature algorithms sent
2027 * to the client in a certificate request for TLS 1.2. On a client this
2028 * represents the signature algorithms we are willing to use for client
2031 uint16_t *client_sigalgs;
2032 /* Size of above array */
2033 size_t client_sigalgslen;
2035 * Certificate setup callback: if set is called whenever a certificate
2036 * may be required (client or server). the callback can then examine any
2037 * appropriate parameters and setup any certificates required. This
2038 * allows advanced applications to select certificates on the fly: for
2039 * example based on supported signature algorithms or curves.
2041 int (*cert_cb) (SSL *ssl, void *arg);
2044 * Optional X509_STORE for chain building or certificate validation If
2045 * NULL the parent SSL_CTX store is used instead.
2047 X509_STORE *chain_store;
2048 X509_STORE *verify_store;
2049 /* Custom extensions */
2050 custom_ext_methods custext;
2051 /* Security callback */
2052 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
2053 void *other, void *ex);
2054 /* Security level */
2057 # ifndef OPENSSL_NO_PSK
2058 /* If not NULL psk identity hint to use for servers */
2059 char *psk_identity_hint;
2061 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
2062 CRYPTO_RWLOCK *lock;
2065 # define FP_ICC (int (*)(const void *,const void *))
2068 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
2069 * of a mess of functions, but hell, think of it as an opaque structure :-)
2071 typedef struct ssl3_enc_method {
2072 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
2073 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
2074 int (*setup_key_block) (SSL *);
2075 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
2077 int (*change_cipher_state) (SSL *, int);
2078 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
2079 const char *client_finished_label;
2080 size_t client_finished_label_len;
2081 const char *server_finished_label;
2082 size_t server_finished_label_len;
2083 int (*alert_value) (int);
2084 int (*export_keying_material) (SSL *, unsigned char *, size_t,
2085 const char *, size_t,
2086 const unsigned char *, size_t,
2088 /* Various flags indicating protocol version requirements */
2090 /* Set the handshake header */
2091 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
2092 /* Close construction of the handshake message */
2093 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
2094 /* Write out handshake message */
2095 int (*do_write) (SSL *s);
2098 # define ssl_set_handshake_header(s, pkt, htype) \
2099 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2100 # define ssl_close_construct_packet(s, pkt, htype) \
2101 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2102 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
2104 /* Values for enc_flags */
2106 /* Uses explicit IV for CBC mode */
2107 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
2108 /* Uses signature algorithms extension */
2109 # define SSL_ENC_FLAG_SIGALGS 0x2
2110 /* Uses SHA256 default PRF */
2111 # define SSL_ENC_FLAG_SHA256_PRF 0x4
2113 # define SSL_ENC_FLAG_DTLS 0x8
2115 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2116 * apply to others in future.
2118 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2120 # ifndef OPENSSL_NO_COMP
2121 /* Used for holding the relevant compression methods loaded into SSL_CTX */
2122 typedef struct ssl3_comp_st {
2123 int comp_id; /* The identifier byte for this compression
2125 char *name; /* Text name used for the compression type */
2126 COMP_METHOD *method; /* The method :-) */
2130 typedef enum downgrade_en {
2137 * Dummy status type for the status_type extension. Indicates no status type
2140 #define TLSEXT_STATUSTYPE_nothing -1
2142 /* Sigalgs values */
2143 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2144 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2145 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2146 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2147 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2148 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2149 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2150 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2151 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2152 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2153 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2154 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2155 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2156 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2157 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2158 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2159 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2160 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2161 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2162 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2163 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2164 #define TLSEXT_SIGALG_gostr34102012_256_intrinsic 0x0840
2165 #define TLSEXT_SIGALG_gostr34102012_512_intrinsic 0x0841
2166 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2167 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2168 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2170 #define TLSEXT_SIGALG_ed25519 0x0807
2171 #define TLSEXT_SIGALG_ed448 0x0808
2173 /* Known PSK key exchange modes */
2174 #define TLSEXT_KEX_MODE_KE 0x00
2175 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2178 * Internal representations of key exchange modes
2180 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2181 #define TLSEXT_KEX_MODE_FLAG_KE 1
2182 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2184 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2185 s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2187 /* A dummy signature value not valid for TLSv1.2 signature algs */
2188 #define TLSEXT_signature_rsa_pss 0x0101
2190 /* TLSv1.3 downgrade protection sentinel values */
2191 extern const unsigned char tls11downgrade[8];
2192 extern const unsigned char tls12downgrade[8];
2194 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2196 __owur const SSL_METHOD *ssl_bad_method(int ver);
2197 __owur const SSL_METHOD *sslv3_method(void);
2198 __owur const SSL_METHOD *sslv3_server_method(void);
2199 __owur const SSL_METHOD *sslv3_client_method(void);
2200 __owur const SSL_METHOD *tlsv1_method(void);
2201 __owur const SSL_METHOD *tlsv1_server_method(void);
2202 __owur const SSL_METHOD *tlsv1_client_method(void);
2203 __owur const SSL_METHOD *tlsv1_1_method(void);
2204 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2205 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2206 __owur const SSL_METHOD *tlsv1_2_method(void);
2207 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2208 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2209 __owur const SSL_METHOD *tlsv1_3_method(void);
2210 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2211 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2212 __owur const SSL_METHOD *dtlsv1_method(void);
2213 __owur const SSL_METHOD *dtlsv1_server_method(void);
2214 __owur const SSL_METHOD *dtlsv1_client_method(void);
2215 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2216 __owur const SSL_METHOD *dtlsv1_2_method(void);
2217 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2218 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2220 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2221 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2222 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2223 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2224 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2225 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2226 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2229 * Flags for SSL methods
2231 # define SSL_METHOD_NO_FIPS (1U<<0)
2232 # define SSL_METHOD_NO_SUITEB (1U<<1)
2234 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2235 s_connect, enc_data) \
2236 const SSL_METHOD *func_name(void) \
2238 static const SSL_METHOD func_name##_data= { \
2252 ssl3_renegotiate_check, \
2255 ssl3_dispatch_alert, \
2258 ssl3_get_cipher_by_char, \
2259 ssl3_put_cipher_by_char, \
2263 tls1_default_timeout, \
2265 ssl_undefined_void_function, \
2266 ssl3_callback_ctrl, \
2267 ssl3_ctx_callback_ctrl, \
2269 return &func_name##_data; \
2272 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2273 const SSL_METHOD *func_name(void) \
2275 static const SSL_METHOD func_name##_data= { \
2277 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2289 ssl3_renegotiate_check, \
2292 ssl3_dispatch_alert, \
2295 ssl3_get_cipher_by_char, \
2296 ssl3_put_cipher_by_char, \
2300 ssl3_default_timeout, \
2302 ssl_undefined_void_function, \
2303 ssl3_callback_ctrl, \
2304 ssl3_ctx_callback_ctrl, \
2306 return &func_name##_data; \
2309 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2310 s_connect, enc_data) \
2311 const SSL_METHOD *func_name(void) \
2313 static const SSL_METHOD func_name##_data= { \
2327 ssl3_renegotiate_check, \
2329 dtls1_write_app_data_bytes, \
2330 dtls1_dispatch_alert, \
2333 ssl3_get_cipher_by_char, \
2334 ssl3_put_cipher_by_char, \
2338 dtls1_default_timeout, \
2340 ssl_undefined_void_function, \
2341 ssl3_callback_ctrl, \
2342 ssl3_ctx_callback_ctrl, \
2344 return &func_name##_data; \
2347 struct openssl_ssl_test_functions {
2348 int (*p_ssl_init_wbio_buffer) (SSL *s);
2349 int (*p_ssl3_setup_buffers) (SSL *s);
2352 const char *ssl_protocol_to_string(int version);
2354 /* Returns true if certificate and private key for 'idx' are present */
2355 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2357 if (idx < 0 || idx >= SSL_PKEY_NUM)
2359 return s->cert->pkeys[idx].x509 != NULL
2360 && s->cert->pkeys[idx].privatekey != NULL;
2363 static ossl_inline void tls1_get_peer_groups(SSL *s, const uint16_t **pgroups,
2366 *pgroups = s->ext.peer_supportedgroups;
2367 *pgroupslen = s->ext.peer_supportedgroups_len;
2370 # ifndef OPENSSL_UNIT_TEST
2372 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2373 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2374 void ssl_clear_cipher_ctx(SSL *s);
2375 int ssl_clear_bad_session(SSL *s);
2376 __owur CERT *ssl_cert_new(void);
2377 __owur CERT *ssl_cert_dup(CERT *cert);
2378 void ssl_cert_clear_certs(CERT *c);
2379 void ssl_cert_free(CERT *c);
2380 __owur int ssl_generate_session_id(SSL *s, SSL_SESSION *ss);
2381 __owur int ssl_get_new_session(SSL *s, int session);
2382 __owur SSL_SESSION *lookup_sess_in_cache(SSL *s, const unsigned char *sess_id,
2383 size_t sess_id_len);
2384 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello);
2385 __owur SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket);
2386 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2387 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2388 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2389 const SSL_CIPHER *const *bp);
2390 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *ssl_method,
2391 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2392 STACK_OF(SSL_CIPHER) **cipher_list,
2393 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2394 const char *rule_str,
2396 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format);
2397 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2398 STACK_OF(SSL_CIPHER) **skp,
2399 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2401 void ssl_update_cache(SSL *s, int mode);
2402 __owur int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
2403 const EVP_CIPHER **enc);
2404 __owur int ssl_cipher_get_evp(SSL_CTX *ctxc, const SSL_SESSION *s,
2405 const EVP_CIPHER **enc, const EVP_MD **md,
2406 int *mac_pkey_type, size_t *mac_secret_size,
2407 SSL_COMP **comp, int use_etm);
2408 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2409 size_t *int_overhead, size_t *blocksize,
2410 size_t *ext_overhead);
2411 __owur int ssl_cert_is_disabled(size_t idx);
2412 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2413 const unsigned char *ptr,
2415 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2416 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2417 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2418 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2419 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2420 __owur int ssl_cert_set_current(CERT *c, long arg);
2421 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2423 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2424 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2425 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2428 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2429 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2432 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx);
2433 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2435 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2437 int ssl_undefined_function(SSL *s);
2438 __owur int ssl_undefined_void_function(void);
2439 __owur int ssl_undefined_const_function(const SSL *s);
2440 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2441 const unsigned char **serverinfo,
2442 size_t *serverinfo_length);
2443 void ssl_set_masks(SSL *s);
2444 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2445 __owur int ssl_x509err2alert(int type);
2446 void ssl_sort_cipher_list(void);
2447 int ssl_load_ciphers(SSL_CTX *ctx);
2448 __owur int ssl_setup_sig_algs(SSL_CTX *ctx);
2449 int ssl_load_groups(SSL_CTX *ctx);
2450 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2451 size_t len, DOWNGRADE dgrd);
2452 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2454 __owur EVP_PKEY *ssl_generate_pkey(SSL *s, EVP_PKEY *pm);
2455 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2457 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2458 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl);
2459 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl);
2461 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2462 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2463 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2464 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2466 int ssl3_init_finished_mac(SSL *s);
2467 __owur int ssl3_setup_key_block(SSL *s);
2468 __owur int ssl3_change_cipher_state(SSL *s, int which);
2469 void ssl3_cleanup_key_block(SSL *s);
2470 __owur int ssl3_do_write(SSL *s, int type);
2471 int ssl3_send_alert(SSL *s, int level, int desc);
2472 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2473 unsigned char *p, size_t len,
2474 size_t *secret_size);
2475 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2476 __owur int ssl3_num_ciphers(void);
2477 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2478 int ssl3_renegotiate(SSL *ssl);
2479 int ssl3_renegotiate_check(SSL *ssl, int initok);
2480 void ssl3_digest_master_key_set_params(const SSL_SESSION *session,
2481 OSSL_PARAM params[]);
2482 __owur int ssl3_dispatch_alert(SSL *s);
2483 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2485 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2486 void ssl3_free_digest_list(SSL *s);
2487 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2489 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2490 STACK_OF(SSL_CIPHER) *clnt,
2491 STACK_OF(SSL_CIPHER) *srvr);
2492 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2493 __owur int ssl3_new(SSL *s);
2494 void ssl3_free(SSL *s);
2495 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2496 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2497 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2498 __owur int ssl3_shutdown(SSL *s);
2499 int ssl3_clear(SSL *s);
2500 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2501 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2502 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2503 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2505 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2506 __owur long ssl3_default_timeout(void);
2508 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2509 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2510 __owur int tls_setup_handshake(SSL *s);
2511 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2512 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2513 __owur int ssl3_handshake_write(SSL *s);
2515 __owur int ssl_allow_compression(SSL *s);
2517 __owur int ssl_version_supported(const SSL *s, int version,
2518 const SSL_METHOD **meth);
2520 __owur int ssl_set_client_hello_version(SSL *s);
2521 __owur int ssl_check_version_downgrade(SSL *s);
2522 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2523 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2525 __owur int ssl_choose_client_version(SSL *s, int version,
2526 RAW_EXTENSION *extensions);
2527 __owur int ssl_get_min_max_version(const SSL *s, int *min_version,
2528 int *max_version, int *real_max);
2530 __owur long tls1_default_timeout(void);
2531 __owur int dtls1_do_write(SSL *s, int type);
2532 void dtls1_set_message_header(SSL *s,
2535 size_t frag_off, size_t frag_len);
2537 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2540 __owur int dtls1_read_failed(SSL *s, int code);
2541 __owur int dtls1_buffer_message(SSL *s, int ccs);
2542 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2543 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2544 int dtls1_retransmit_buffered_messages(SSL *s);
2545 void dtls1_clear_received_buffer(SSL *s);
2546 void dtls1_clear_sent_buffer(SSL *s);
2547 void dtls1_get_message_header(unsigned char *data,
2548 struct hm_header_st *msg_hdr);
2549 __owur long dtls1_default_timeout(void);
2550 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2551 __owur int dtls1_check_timeout_num(SSL *s);
2552 __owur int dtls1_handle_timeout(SSL *s);
2553 void dtls1_start_timer(SSL *s);
2554 void dtls1_stop_timer(SSL *s);
2555 __owur int dtls1_is_timer_expired(SSL *s);
2556 void dtls1_double_timeout(SSL *s);
2557 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2559 __owur size_t dtls1_min_mtu(SSL *s);
2560 void dtls1_hm_fragment_free(hm_fragment *frag);
2561 __owur int dtls1_query_mtu(SSL *s);
2563 __owur int tls1_new(SSL *s);
2564 void tls1_free(SSL *s);
2565 int tls1_clear(SSL *s);
2567 __owur int dtls1_new(SSL *s);
2568 void dtls1_free(SSL *s);
2569 int dtls1_clear(SSL *s);
2570 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2571 __owur int dtls1_shutdown(SSL *s);
2573 __owur int dtls1_dispatch_alert(SSL *s);
2575 __owur int ssl_init_wbio_buffer(SSL *s);
2576 int ssl_free_wbio_buffer(SSL *s);
2578 __owur int tls1_change_cipher_state(SSL *s, int which);
2579 __owur int tls1_setup_key_block(SSL *s);
2580 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2582 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2583 unsigned char *p, size_t len,
2584 size_t *secret_size);
2585 __owur int tls13_setup_key_block(SSL *s);
2586 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2588 __owur int tls13_change_cipher_state(SSL *s, int which);
2589 __owur int tls13_update_key(SSL *s, int send);
2590 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2591 const unsigned char *secret,
2592 const unsigned char *label, size_t labellen,
2593 const unsigned char *data, size_t datalen,
2594 unsigned char *out, size_t outlen, int fatal);
2595 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2596 const unsigned char *secret, unsigned char *key,
2598 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2599 const unsigned char *secret, unsigned char *iv,
2601 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2602 const unsigned char *secret,
2603 unsigned char *fin, size_t finlen);
2604 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2605 const unsigned char *prevsecret,
2606 const unsigned char *insecret,
2608 unsigned char *outsecret);
2609 __owur int tls13_generate_handshake_secret(SSL *s,
2610 const unsigned char *insecret,
2611 size_t insecretlen);
2612 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2613 unsigned char *prev, size_t prevlen,
2614 size_t *secret_size);
2615 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2616 const char *label, size_t llen,
2617 const unsigned char *p, size_t plen,
2619 __owur int tls13_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2620 const char *label, size_t llen,
2621 const unsigned char *context,
2622 size_t contextlen, int use_context);
2623 __owur int tls13_export_keying_material_early(SSL *s, unsigned char *out,
2624 size_t olen, const char *label,
2626 const unsigned char *context,
2628 __owur int tls1_alert_code(int code);
2629 __owur int tls13_alert_code(int code);
2630 __owur int ssl3_alert_code(int code);
2632 # ifndef OPENSSL_NO_EC
2633 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2636 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2638 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(SSL_CTX *ctx, uint16_t curve_id);
2639 __owur int tls1_group_id2nid(uint16_t group_id, int include_unknown);
2640 __owur int tls1_check_group_id(SSL *s, uint16_t group_id, int check_own_curves);
2641 __owur uint16_t tls1_shared_group(SSL *s, int nmatch);
2642 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2643 int *curves, size_t ncurves);
2644 __owur int tls1_set_groups_list(SSL_CTX *ctx, uint16_t **pext, size_t *pextlen,
2646 __owur EVP_PKEY *ssl_generate_pkey_group(SSL *s, uint16_t id);
2647 __owur int tls_valid_group(SSL *s, uint16_t group_id, int minversion,
2649 __owur EVP_PKEY *ssl_generate_param_group(SSL *s, uint16_t id);
2650 # ifndef OPENSSL_NO_EC
2651 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2652 size_t *num_formats);
2653 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2654 # endif /* OPENSSL_NO_EC */
2656 __owur int tls_group_allowed(SSL *s, uint16_t curve, int op);
2657 void tls1_get_supported_groups(SSL *s, const uint16_t **pgroups,
2658 size_t *pgroupslen);
2660 __owur int tls1_set_server_sigalgs(SSL *s);
2662 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2664 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2666 const unsigned char *sess_id,
2667 size_t sesslen, SSL_SESSION **psess);
2669 __owur int tls_use_ticket(SSL *s);
2671 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2673 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2674 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2676 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2678 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2680 void tls1_set_cert_validity(SSL *s);
2682 # ifndef OPENSSL_NO_CT
2683 __owur int ssl_validate_ct(SSL *s);
2686 # ifndef OPENSSL_NO_DH
2687 __owur DH *ssl_get_auto_dh(SSL *s);
2690 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2691 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2694 int tls_choose_sigalg(SSL *s, int fatalerrs);
2696 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2697 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2698 __owur long ssl_get_algorithm2(SSL *s);
2699 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2700 const uint16_t *psig, size_t psiglen);
2701 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2702 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt, int cert);
2703 __owur int tls1_process_sigalgs(SSL *s);
2704 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2705 __owur int tls1_lookup_md(SSL_CTX *ctx, const SIGALG_LOOKUP *lu,
2706 const EVP_MD **pmd);
2707 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2708 # ifndef OPENSSL_NO_EC
2709 __owur int tls_check_sigalg_curve(const SSL *s, int curve);
2711 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2712 __owur int ssl_set_client_disabled(SSL *s);
2713 __owur int ssl_cipher_disabled(const SSL *s, const SSL_CIPHER *c, int op, int echde);
2715 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2717 __owur const EVP_MD *ssl_md(SSL_CTX *ctx, int idx);
2718 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2719 __owur const EVP_MD *ssl_prf_md(SSL *s);
2722 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2723 * with |ssl|, if logging is enabled. It returns one on success and zero on
2724 * failure. The entry is identified by the first 8 bytes of
2725 * |encrypted_premaster|.
2727 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2728 const uint8_t *encrypted_premaster,
2729 size_t encrypted_premaster_len,
2730 const uint8_t *premaster,
2731 size_t premaster_len);
2734 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2735 * logging is available. It returns one on success and zero on failure. It tags
2736 * the entry with |label|.
2738 __owur int ssl_log_secret(SSL *ssl, const char *label,
2739 const uint8_t *secret, size_t secret_len);
2741 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2742 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2743 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2744 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2745 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2746 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2747 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2748 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2751 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2752 __owur int ssl3_cbc_digest_record(SSL *s,
2753 const EVP_MD_CTX *ctx,
2754 unsigned char *md_out,
2755 size_t *md_out_size,
2756 const unsigned char header[13],
2757 const unsigned char *data,
2758 size_t data_plus_mac_size,
2759 size_t data_plus_mac_plus_padding_size,
2760 const unsigned char *mac_secret,
2761 size_t mac_secret_length, char is_sslv3);
2763 __owur int srp_generate_server_master_secret(SSL *s);
2764 __owur int srp_generate_client_master_secret(SSL *s);
2765 __owur int srp_verify_server_param(SSL *s);
2767 /* statem/statem_srvr.c */
2769 __owur int send_certificate_request(SSL *s);
2771 /* statem/extensions_cust.c */
2773 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2774 ENDPOINT role, unsigned int ext_type,
2777 void custom_ext_init(custom_ext_methods *meths);
2779 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2780 const unsigned char *ext_data, size_t ext_size,
2781 X509 *x, size_t chainidx);
2782 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2783 size_t chainidx, int maxversion);
2785 __owur int custom_exts_copy(custom_ext_methods *dst,
2786 const custom_ext_methods *src);
2787 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2788 const custom_ext_methods *src);
2789 void custom_exts_free(custom_ext_methods *exts);
2791 void ssl_comp_free_compression_methods_int(void);
2794 void ssl_ctx_system_config(SSL_CTX *ctx);
2796 const EVP_CIPHER *ssl_evp_cipher_fetch(OPENSSL_CTX *libctx,
2798 const char *properties);
2799 int ssl_evp_cipher_up_ref(const EVP_CIPHER *cipher);
2800 void ssl_evp_cipher_free(const EVP_CIPHER *cipher);
2801 const EVP_MD *ssl_evp_md_fetch(OPENSSL_CTX *libctx,
2803 const char *properties);
2804 int ssl_evp_md_up_ref(const EVP_MD *md);
2805 void ssl_evp_md_free(const EVP_MD *md);
2808 # else /* OPENSSL_UNIT_TEST */
2810 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2811 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers