1 /*
2 * Copyright 1995-2022 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.
5 *
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
10 */
11
12 #ifndef OSSL_SSL_LOCAL_H
13 # define OSSL_SSL_LOCAL_H
14
15 # include "e_os.h" /* struct timeval for DTLS */
16 # include <stdlib.h>
17 # include <time.h>
18 # include <string.h>
19 # include <errno.h>
20
21 # include <openssl/buffer.h>
22 # include <openssl/comp.h>
23 # include <openssl/bio.h>
24 # include <openssl/dsa.h>
25 # include <openssl/err.h>
26 # include <openssl/ssl.h>
27 # include <openssl/async.h>
28 # include <openssl/symhacks.h>
29 # include <openssl/ct.h>
30 # include "record/record.h"
31 # include "statem/statem.h"
32 # include "internal/packet.h"
33 # include "internal/dane.h"
34 # include "internal/refcount.h"
35 # include "internal/tsan_assist.h"
36 # include "internal/bio.h"
37 # include "internal/ktls.h"
38
39 # ifdef OPENSSL_BUILD_SHLIBSSL
40 # undef OPENSSL_EXTERN
41 # define OPENSSL_EXTERN OPENSSL_EXPORT
42 # endif
43
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))
48
49 /* NOTE - c is not incremented as per c2l */
50 # define c2ln(c,l1,l2,n) { \
51 c+=n; \
52 l1=l2=0; \
53 switch (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)))); \
62 } \
63 }
64
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))
69
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)++))))
74
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)++))))
83
84
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))
89
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))
96
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))
105
106 /* NOTE - c is not incremented as per l2c */
107 # define l2cn(l1,l2,c,n) { \
108 c+=n; \
109 switch (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); \
118 } \
119 }
120
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)
125
126 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
127 (((unsigned long)((c)[1]))<< 8)| \
128 (((unsigned long)((c)[2])) )),(c)+=3)
129
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)
133
134 # define TLS_MAX_VERSION_INTERNAL TLS1_3_VERSION
135 # define DTLS_MAX_VERSION_INTERNAL DTLS1_2_VERSION
136
137 /*
138 * DTLS version numbers are strange because they're inverted. Except for
139 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
140 */
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))
146
147
148 /*
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.
155 *
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.
160 */
161
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
167 /* synonym */
168 # define SSL_kEDH SSL_kDHE
169 /* ephemeral ECDH */
170 # define SSL_kECDHE 0x00000004U
171 /* synonym */
172 # define SSL_kEECDH SSL_kECDHE
173 /* PSK */
174 # define SSL_kPSK 0x00000008U
175 /* GOST key exchange */
176 # define SSL_kGOST 0x00000010U
177 /* SRP */
178 # define SSL_kSRP 0x00000020U
179
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
185
186 /* all PSK */
187
188 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
189
190 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
191 # define SSL_kANY 0x00000000U
192
193 /* Bits for algorithm_auth (server authentication) */
194 /* RSA auth */
195 # define SSL_aRSA 0x00000001U
196 /* DSS auth */
197 # define SSL_aDSS 0x00000002U
198 /* no auth (i.e. use ADH or AECDH) */
199 # define SSL_aNULL 0x00000004U
200 /* ECDSA auth*/
201 # define SSL_aECDSA 0x00000008U
202 /* PSK auth */
203 # define SSL_aPSK 0x00000010U
204 /* GOST R 34.10-2001 signature auth */
205 # define SSL_aGOST01 0x00000020U
206 /* SRP auth */
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 */
213 #define SSL_aCERT \
214 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
215
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
241
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)
252
253 /* Bits for algorithm_mac (symmetric authentication) */
254
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
268
269 /*
270 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
271 * sure to update this constant too
272 */
273
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
289
290 #define SSL_MD_NUM_IDX SSL_MAX_DIGEST
291
292 /* Bits for algorithm2 (handshake digests and other extra flags) */
293
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
303
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)
313
314 /*
315 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
316 * goes into algorithm2)
317 */
318 # define TLS1_STREAM_MAC 0x10000
319 /*
320 * TLSTREE cipher/mac key derivation from draft-smyshlyaev-tls12-gost-suites
321 * (currently this also goes into algorithm2)
322 */
323 # define TLS1_TLSTREE 0x20000
324
325 # define SSL_STRONG_MASK 0x0000001FU
326 # define SSL_DEFAULT_MASK 0X00000020U
327
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
334
335 /* we have used 0000003f - 26 bits left to go */
336
337 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
338 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
339
340 /* Check if an SSL structure is using QUIC (which uses TLSv1.3) */
341 # ifndef OPENSSL_NO_QUIC
342 # define SSL_IS_QUIC(s) (s->quic_method != NULL)
343 # else
344 # define SSL_IS_QUIC(s) 0
345 # endif
346
347 /* Check if an SSL structure is using DTLS */
348 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
349
350 /* Check if we are using TLSv1.3 */
351 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
352 && (s)->method->version >= TLS1_3_VERSION \
353 && (s)->method->version != TLS_ANY_VERSION)
354
355 # define SSL_TREAT_AS_TLS13(s) \
356 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_CONNECTING \
357 || (s)->early_data_state == SSL_EARLY_DATA_CONNECT_RETRY \
358 || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
359 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY \
360 || (s)->hello_retry_request == SSL_HRR_PENDING)
361
362 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3.tmp.finish_md_len == 0 \
363 || (s)->s3.tmp.peer_finish_md_len == 0)
364
365 /* See if we need explicit IV */
366 # define SSL_USE_EXPLICIT_IV(s) \
367 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
368 /*
369 * See if we use signature algorithms extension and signature algorithm
370 * before signatures.
371 */
372 # define SSL_USE_SIGALGS(s) \
373 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
374 /*
375 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
376 * apply to others in future.
377 */
378 # define SSL_USE_TLS1_2_CIPHERS(s) \
379 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
380 /*
381 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
382 * flags because it may not be set to correct version yet.
383 */
384 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
385 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
386 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
387 /*
388 * Determine if a client should send signature algorithms extension:
389 * as with TLS1.2 cipher we can't rely on method flags.
390 */
391 # define SSL_CLIENT_USE_SIGALGS(s) \
392 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
393
394 # define IS_MAX_FRAGMENT_LENGTH_EXT_VALID(value) \
395 (((value) >= TLSEXT_max_fragment_length_512) && \
396 ((value) <= TLSEXT_max_fragment_length_4096))
397 # define USE_MAX_FRAGMENT_LENGTH_EXT(session) \
398 IS_MAX_FRAGMENT_LENGTH_EXT_VALID(session->ext.max_fragment_len_mode)
399 # define GET_MAX_FRAGMENT_LENGTH(session) \
400 (512U << (session->ext.max_fragment_len_mode - 1))
401
402 # define SSL_READ_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
403 # define SSL_WRITE_ETM(s) (s->s3.flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
404
405 /* Mostly for SSLv3 */
406 # define SSL_PKEY_RSA 0
407 # define SSL_PKEY_RSA_PSS_SIGN 1
408 # define SSL_PKEY_DSA_SIGN 2
409 # define SSL_PKEY_ECC 3
410 # define SSL_PKEY_GOST01 4
411 # define SSL_PKEY_GOST12_256 5
412 # define SSL_PKEY_GOST12_512 6
413 # define SSL_PKEY_ED25519 7
414 # define SSL_PKEY_ED448 8
415 # define SSL_PKEY_NUM 9
416
417 # define SSL_ENC_DES_IDX 0
418 # define SSL_ENC_3DES_IDX 1
419 # define SSL_ENC_RC4_IDX 2
420 # define SSL_ENC_RC2_IDX 3
421 # define SSL_ENC_IDEA_IDX 4
422 # define SSL_ENC_NULL_IDX 5
423 # define SSL_ENC_AES128_IDX 6
424 # define SSL_ENC_AES256_IDX 7
425 # define SSL_ENC_CAMELLIA128_IDX 8
426 # define SSL_ENC_CAMELLIA256_IDX 9
427 # define SSL_ENC_GOST89_IDX 10
428 # define SSL_ENC_SEED_IDX 11
429 # define SSL_ENC_AES128GCM_IDX 12
430 # define SSL_ENC_AES256GCM_IDX 13
431 # define SSL_ENC_AES128CCM_IDX 14
432 # define SSL_ENC_AES256CCM_IDX 15
433 # define SSL_ENC_AES128CCM8_IDX 16
434 # define SSL_ENC_AES256CCM8_IDX 17
435 # define SSL_ENC_GOST8912_IDX 18
436 # define SSL_ENC_CHACHA_IDX 19
437 # define SSL_ENC_ARIA128GCM_IDX 20
438 # define SSL_ENC_ARIA256GCM_IDX 21
439 # define SSL_ENC_MAGMA_IDX 22
440 # define SSL_ENC_KUZNYECHIK_IDX 23
441 # define SSL_ENC_NUM_IDX 24
442
443 /*-
444 * SSL_kRSA <- RSA_ENC
445 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
446 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
447 * SSL_aRSA <- RSA_ENC | RSA_SIGN
448 * SSL_aDSS <- DSA_SIGN
449 */
450
451 /*-
452 #define CERT_INVALID 0
453 #define CERT_PUBLIC_KEY 1
454 #define CERT_PRIVATE_KEY 2
455 */
456
457 /* Post-Handshake Authentication state */
458 typedef enum {
459 SSL_PHA_NONE = 0,
460 SSL_PHA_EXT_SENT, /* client-side only: extension sent */
461 SSL_PHA_EXT_RECEIVED, /* server-side only: extension received */
462 SSL_PHA_REQUEST_PENDING, /* server-side only: request pending */
463 SSL_PHA_REQUESTED /* request received by client, or sent by server */
464 } SSL_PHA_STATE;
465
466 /* CipherSuite length. SSLv3 and all TLS versions. */
467 # define TLS_CIPHER_LEN 2
468 /* used to hold info on the particular ciphers used */
469 struct ssl_cipher_st {
470 uint32_t valid;
471 const char *name; /* text name */
472 const char *stdname; /* RFC name */
473 uint32_t id; /* id, 4 bytes, first is version */
474 /*
475 * changed in 1.0.0: these four used to be portions of a single value
476 * 'algorithms'
477 */
478 uint32_t algorithm_mkey; /* key exchange algorithm */
479 uint32_t algorithm_auth; /* server authentication */
480 uint32_t algorithm_enc; /* symmetric encryption */
481 uint32_t algorithm_mac; /* symmetric authentication */
482 int min_tls; /* minimum SSL/TLS protocol version */
483 int max_tls; /* maximum SSL/TLS protocol version */
484 int min_dtls; /* minimum DTLS protocol version */
485 int max_dtls; /* maximum DTLS protocol version */
486 uint32_t algo_strength; /* strength and export flags */
487 uint32_t algorithm2; /* Extra flags */
488 int32_t strength_bits; /* Number of bits really used */
489 uint32_t alg_bits; /* Number of bits for algorithm */
490 };
491
492 /* Used to hold SSL/TLS functions */
493 struct ssl_method_st {
494 int version;
495 unsigned flags;
496 unsigned long mask;
497 int (*ssl_new) (SSL *s);
498 int (*ssl_clear) (SSL *s);
499 void (*ssl_free) (SSL *s);
500 int (*ssl_accept) (SSL *s);
501 int (*ssl_connect) (SSL *s);
502 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
503 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
504 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
505 int (*ssl_shutdown) (SSL *s);
506 int (*ssl_renegotiate) (SSL *s);
507 int (*ssl_renegotiate_check) (SSL *s, int);
508 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
509 unsigned char *buf, size_t len, int peek,
510 size_t *readbytes);
511 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
512 size_t *written);
513 int (*ssl_dispatch_alert) (SSL *s);
514 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
515 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
516 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
517 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
518 size_t *len);
519 size_t (*ssl_pending) (const SSL *s);
520 int (*num_ciphers) (void);
521 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
522 long (*get_timeout) (void);
523 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
524 int (*ssl_version) (void);
525 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
526 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
527 };
528
529 /*
530 * Matches the length of PSK_MAX_PSK_LEN. We keep it the same value for
531 * consistency, even in the event of OPENSSL_NO_PSK being defined.
532 */
533 # define TLS13_MAX_RESUMPTION_PSK_LENGTH 512
534
535 /*-
536 * Lets make this into an ASN.1 type structure as follows
537 * SSL_SESSION_ID ::= SEQUENCE {
538 * version INTEGER, -- structure version number
539 * SSLversion INTEGER, -- SSL version number
540 * Cipher OCTET STRING, -- the 3 byte cipher ID
541 * Session_ID OCTET STRING, -- the Session ID
542 * Master_key OCTET STRING, -- the master key
543 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
544 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
545 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
546 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
547 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
548 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
549 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
550 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
551 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
552 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
553 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
554 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
555 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
556 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
557 * }
558 * Look in ssl/ssl_asn1.c for more details
559 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
560 */
561 struct ssl_session_st {
562 int ssl_version; /* what ssl version session info is being kept
563 * in here? */
564 size_t master_key_length;
565
566 /* TLSv1.3 early_secret used for external PSKs */
567 unsigned char early_secret[EVP_MAX_MD_SIZE];
568 /*
569 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
570 * PSK
571 */
572 unsigned char master_key[TLS13_MAX_RESUMPTION_PSK_LENGTH];
573 /* session_id - valid? */
574 size_t session_id_length;
575 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
576 /*
577 * this is used to determine whether the session is being reused in the
578 * appropriate context. It is up to the application to set this, via
579 * SSL_new
580 */
581 size_t sid_ctx_length;
582 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
583 # ifndef OPENSSL_NO_PSK
584 char *psk_identity_hint;
585 char *psk_identity;
586 # endif
587 /*
588 * Used to indicate that session resumption is not allowed. Applications
589 * can also set this bit for a new session via not_resumable_session_cb
590 * to disable session caching and tickets.
591 */
592 int not_resumable;
593 /* This is the cert and type for the other end. */
594 X509 *peer;
595 /* Certificate chain peer sent. */
596 STACK_OF(X509) *peer_chain;
597 /*
598 * when app_verify_callback accepts a session where the peer's
599 * certificate is not ok, we must remember the error for session reuse:
600 */
601 long verify_result; /* only for servers */
602 CRYPTO_REF_COUNT references;
603 time_t timeout;
604 time_t time;
605 time_t calc_timeout;
606 int timeout_ovf;
607 unsigned int compress_meth; /* Need to lookup the method */
608 const SSL_CIPHER *cipher;
609 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
610 * load the 'cipher' structure */
611 unsigned int kex_group; /* TLS group from key exchange */
612 CRYPTO_EX_DATA ex_data; /* application specific data */
613 /*
614 * These are used to make removal of session-ids more efficient and to
615 * implement a maximum cache size.
616 */
617 struct ssl_session_st *prev, *next;
618
619 struct {
620 char *hostname;
621 /* RFC4507 info */
622 unsigned char *tick; /* Session ticket */
623 size_t ticklen; /* Session ticket length */
624 /* Session lifetime hint in seconds */
625 unsigned long tick_lifetime_hint;
626 uint32_t tick_age_add;
627 /* Max number of bytes that can be sent as early data */
628 uint32_t max_early_data;
629 /* The ALPN protocol selected for this session */
630 unsigned char *alpn_selected;
631 size_t alpn_selected_len;
632 /*
633 * Maximum Fragment Length as per RFC 4366.
634 * If this value does not contain RFC 4366 allowed values (1-4) then
635 * either the Maximum Fragment Length Negotiation failed or was not
636 * performed at all.
637 */
638 uint8_t max_fragment_len_mode;
639 } ext;
640 # ifndef OPENSSL_NO_SRP
641 char *srp_username;
642 # endif
643 unsigned char *ticket_appdata;
644 size_t ticket_appdata_len;
645 uint32_t flags;
646 SSL_CTX *owner;
647 CRYPTO_RWLOCK *lock;
648 };
649
650 /* Extended master secret support */
651 # define SSL_SESS_FLAG_EXTMS 0x1
652
653 # ifndef OPENSSL_NO_SRP
654
655 typedef struct srp_ctx_st {
656 /* param for all the callbacks */
657 void *SRP_cb_arg;
658 /* set client Hello login callback */
659 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
660 /* set SRP N/g param callback for verification */
661 int (*SRP_verify_param_callback) (SSL *, void *);
662 /* set SRP client passwd callback */
663 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
664 char *login;
665 BIGNUM *N, *g, *s, *B, *A;
666 BIGNUM *a, *b, *v;
667 char *info;
668 int strength;
669 unsigned long srp_Mask;
670 } SRP_CTX;
671
672 # endif
673
674 typedef enum {
675 SSL_EARLY_DATA_NONE = 0,
676 SSL_EARLY_DATA_CONNECT_RETRY,
677 SSL_EARLY_DATA_CONNECTING,
678 SSL_EARLY_DATA_WRITE_RETRY,
679 SSL_EARLY_DATA_WRITING,
680 SSL_EARLY_DATA_WRITE_FLUSH,
681 SSL_EARLY_DATA_UNAUTH_WRITING,
682 SSL_EARLY_DATA_FINISHED_WRITING,
683 SSL_EARLY_DATA_ACCEPT_RETRY,
684 SSL_EARLY_DATA_ACCEPTING,
685 SSL_EARLY_DATA_READ_RETRY,
686 SSL_EARLY_DATA_READING,
687 SSL_EARLY_DATA_FINISHED_READING
688 } SSL_EARLY_DATA_STATE;
689
690 /*
691 * We check that the amount of unreadable early data doesn't exceed
692 * max_early_data. max_early_data is given in plaintext bytes. However if it is
693 * unreadable then we only know the number of ciphertext bytes. We also don't
694 * know how much the overhead should be because it depends on the ciphersuite.
695 * We make a small allowance. We assume 5 records of actual data plus the end
696 * of early data alert record. Each record has a tag and a content type byte.
697 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
698 * content of the alert record either which is 2 bytes.
699 */
700 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
701
702 /*
703 * The allowance we have between the client's calculated ticket age and our own.
704 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
705 * client's age calculation is different by more than this than our own then we
706 * do not allow that ticket for early_data.
707 */
708 # define TICKET_AGE_ALLOWANCE (10 * 1000)
709
710 #define MAX_COMPRESSIONS_SIZE 255
711
712 struct ssl_comp_st {
713 int id;
714 const char *name;
715 COMP_METHOD *method;
716 };
717
718 typedef struct raw_extension_st {
719 /* Raw packet data for the extension */
720 PACKET data;
721 /* Set to 1 if the extension is present or 0 otherwise */
722 int present;
723 /* Set to 1 if we have already parsed the extension or 0 otherwise */
724 int parsed;
725 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
726 unsigned int type;
727 /* Track what order extensions are received in (0-based). */
728 size_t received_order;
729 } RAW_EXTENSION;
730
731 typedef struct {
732 unsigned int isv2;
733 unsigned int legacy_version;
734 unsigned char random[SSL3_RANDOM_SIZE];
735 size_t session_id_len;
736 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
737 size_t dtls_cookie_len;
738 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
739 PACKET ciphersuites;
740 size_t compressions_len;
741 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
742 PACKET extensions;
743 size_t pre_proc_exts_len;
744 RAW_EXTENSION *pre_proc_exts;
745 } CLIENTHELLO_MSG;
746
747 /*
748 * Extension index values NOTE: Any updates to these defines should be mirrored
749 * with equivalent updates to ext_defs in extensions.c
750 */
751 typedef enum tlsext_index_en {
752 TLSEXT_IDX_renegotiate,
753 TLSEXT_IDX_server_name,
754 TLSEXT_IDX_max_fragment_length,
755 TLSEXT_IDX_srp,
756 TLSEXT_IDX_ec_point_formats,
757 TLSEXT_IDX_supported_groups,
758 TLSEXT_IDX_session_ticket,
759 TLSEXT_IDX_status_request,
760 TLSEXT_IDX_next_proto_neg,
761 TLSEXT_IDX_application_layer_protocol_negotiation,
762 TLSEXT_IDX_use_srtp,
763 TLSEXT_IDX_encrypt_then_mac,
764 TLSEXT_IDX_signed_certificate_timestamp,
765 TLSEXT_IDX_extended_master_secret,
766 TLSEXT_IDX_signature_algorithms_cert,
767 TLSEXT_IDX_post_handshake_auth,
768 TLSEXT_IDX_signature_algorithms,
769 TLSEXT_IDX_supported_versions,
770 TLSEXT_IDX_psk_kex_modes,
771 TLSEXT_IDX_key_share,
772 TLSEXT_IDX_cookie,
773 TLSEXT_IDX_cryptopro_bug,
774 TLSEXT_IDX_early_data,
775 TLSEXT_IDX_certificate_authorities,
776 TLSEXT_IDX_quic_transport_parameters_draft,
777 TLSEXT_IDX_quic_transport_parameters,
778 TLSEXT_IDX_padding,
779 TLSEXT_IDX_psk,
780 /* Dummy index - must always be the last entry */
781 TLSEXT_IDX_num_builtins
782 } TLSEXT_INDEX;
783
784 DEFINE_LHASH_OF(SSL_SESSION);
785 /* Needed in ssl_cert.c */
786 DEFINE_LHASH_OF(X509_NAME);
787
788 # define TLSEXT_KEYNAME_LENGTH 16
789 # define TLSEXT_TICK_KEY_LENGTH 32
790
791 typedef struct ssl_ctx_ext_secure_st {
792 unsigned char tick_hmac_key[TLSEXT_TICK_KEY_LENGTH];
793 unsigned char tick_aes_key[TLSEXT_TICK_KEY_LENGTH];
794 } SSL_CTX_EXT_SECURE;
795
796 /*
797 * Helper function for HMAC
798 * The structure should be considered opaque, it will change once the low
799 * level deprecated calls are removed. At that point it can be replaced
800 * by EVP_MAC_CTX and most of the functions converted to macros or inlined
801 * directly.
802 */
803 typedef struct ssl_hmac_st {
804 EVP_MAC_CTX *ctx;
805 # ifndef OPENSSL_NO_DEPRECATED_3_0
806 HMAC_CTX *old_ctx;
807 # endif
808 } SSL_HMAC;
809
810 SSL_HMAC *ssl_hmac_new(const SSL_CTX *ctx);
811 void ssl_hmac_free(SSL_HMAC *ctx);
812 # ifndef OPENSSL_NO_DEPRECATED_3_0
813 HMAC_CTX *ssl_hmac_get0_HMAC_CTX(SSL_HMAC *ctx);
814 # endif
815 EVP_MAC_CTX *ssl_hmac_get0_EVP_MAC_CTX(SSL_HMAC *ctx);
816 int ssl_hmac_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
817 int ssl_hmac_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
818 int ssl_hmac_final(SSL_HMAC *ctx, unsigned char *md, size_t *len,
819 size_t max_size);
820 size_t ssl_hmac_size(const SSL_HMAC *ctx);
821
822 int ssl_get_EC_curve_nid(const EVP_PKEY *pkey);
823 __owur int tls13_set_encoded_pub_key(EVP_PKEY *pkey,
824 const unsigned char *enckey,
825 size_t enckeylen);
826
827 typedef struct tls_group_info_st {
828 char *tlsname; /* Curve Name as in TLS specs */
829 char *realname; /* Curve Name according to provider */
830 char *algorithm; /* Algorithm name to fetch */
831 unsigned int secbits; /* Bits of security (from SP800-57) */
832 uint16_t group_id; /* Group ID */
833 int mintls; /* Minimum TLS version, -1 unsupported */
834 int maxtls; /* Maximum TLS version (or 0 for undefined) */
835 int mindtls; /* Minimum DTLS version, -1 unsupported */
836 int maxdtls; /* Maximum DTLS version (or 0 for undefined) */
837 char is_kem; /* Mode for this Group: 0 is KEX, 1 is KEM */
838 } TLS_GROUP_INFO;
839
840 /* flags values */
841 # define TLS_GROUP_TYPE 0x0000000FU /* Mask for group type */
842 # define TLS_GROUP_CURVE_PRIME 0x00000001U
843 # define TLS_GROUP_CURVE_CHAR2 0x00000002U
844 # define TLS_GROUP_CURVE_CUSTOM 0x00000004U
845 # define TLS_GROUP_FFDHE 0x00000008U
846 # define TLS_GROUP_ONLY_FOR_TLS1_3 0x00000010U
847
848 # define TLS_GROUP_FFDHE_FOR_TLS1_3 (TLS_GROUP_FFDHE|TLS_GROUP_ONLY_FOR_TLS1_3)
849
850 struct ssl_ctx_st {
851 OSSL_LIB_CTX *libctx;
852
853 const SSL_METHOD *method;
854 STACK_OF(SSL_CIPHER) *cipher_list;
855 /* same as above but sorted for lookup */
856 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
857 /* TLSv1.3 specific ciphersuites */
858 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
859 struct x509_store_st /* X509_STORE */ *cert_store;
860 LHASH_OF(SSL_SESSION) *sessions;
861 /*
862 * Most session-ids that will be cached, default is
863 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
864 */
865 size_t session_cache_size;
866 struct ssl_session_st *session_cache_head;
867 struct ssl_session_st *session_cache_tail;
868 /*
869 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
870 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
871 * means only SSL_accept will cache SSL_SESSIONS.
872 */
873 uint32_t session_cache_mode;
874 /*
875 * If timeout is not 0, it is the default timeout value set when
876 * SSL_new() is called. This has been put in to make life easier to set
877 * things up
878 */
879 long session_timeout;
880 /*
881 * If this callback is not null, it will be called each time a session id
882 * is added to the cache. If this function returns 1, it means that the
883 * callback will do a SSL_SESSION_free() when it has finished using it.
884 * Otherwise, on 0, it means the callback has finished with it. If
885 * remove_session_cb is not null, it will be called when a session-id is
886 * removed from the cache. After the call, OpenSSL will
887 * SSL_SESSION_free() it.
888 */
889 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
890 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
891 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
892 const unsigned char *data, int len,
893 int *copy);
894 struct {
895 TSAN_QUALIFIER int sess_connect; /* SSL new conn - started */
896 TSAN_QUALIFIER int sess_connect_renegotiate; /* SSL reneg - requested */
897 TSAN_QUALIFIER int sess_connect_good; /* SSL new conne/reneg - finished */
898 TSAN_QUALIFIER int sess_accept; /* SSL new accept - started */
899 TSAN_QUALIFIER int sess_accept_renegotiate; /* SSL reneg - requested */
900 TSAN_QUALIFIER int sess_accept_good; /* SSL accept/reneg - finished */
901 TSAN_QUALIFIER int sess_miss; /* session lookup misses */
902 TSAN_QUALIFIER int sess_timeout; /* reuse attempt on timeouted session */
903 TSAN_QUALIFIER int sess_cache_full; /* session removed due to full cache */
904 TSAN_QUALIFIER int sess_hit; /* session reuse actually done */
905 TSAN_QUALIFIER int sess_cb_hit; /* session-id that was not in
906 * the cache was passed back via
907 * the callback. This indicates
908 * that the application is
909 * supplying session-id's from
910 * other processes - spooky
911 * :-) */
912 } stats;
913 #ifdef TSAN_REQUIRES_LOCKING
914 CRYPTO_RWLOCK *tsan_lock;
915 #endif
916
917 CRYPTO_REF_COUNT references;
918
919 /* if defined, these override the X509_verify_cert() calls */
920 int (*app_verify_callback) (X509_STORE_CTX *, void *);
921 void *app_verify_arg;
922 /*
923 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
924 * ('app_verify_callback' was called with just one argument)
925 */
926
927 /* Default password callback. */
928 pem_password_cb *default_passwd_callback;
929
930 /* Default password callback user data. */
931 void *default_passwd_callback_userdata;
932
933 /* get client cert callback */
934 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
935
936 /* cookie generate callback */
937 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
938 unsigned int *cookie_len);
939
940 /* verify cookie callback */
941 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
942 unsigned int cookie_len);
943
944 /* TLS1.3 app-controlled cookie generate callback */
945 int (*gen_stateless_cookie_cb) (SSL *ssl, unsigned char *cookie,
946 size_t *cookie_len);
947
948 /* TLS1.3 verify app-controlled cookie callback */
949 int (*verify_stateless_cookie_cb) (SSL *ssl, const unsigned char *cookie,
950 size_t cookie_len);
951
952 CRYPTO_EX_DATA ex_data;
953
954 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
955 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3-sha1' */
956
957 STACK_OF(X509) *extra_certs;
958 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
959
960 /* Default values used when no per-SSL value is defined follow */
961
962 /* used if SSL's info_callback is NULL */
963 void (*info_callback) (const SSL *ssl, int type, int val);
964
965 /*
966 * What we put in certificate_authorities extension for TLS 1.3
967 * (ClientHello and CertificateRequest) or just client cert requests for
968 * earlier versions. If client_ca_names is populated then it is only used
969 * for client cert requests, and in preference to ca_names.
970 */
971 STACK_OF(X509_NAME) *ca_names;
972 STACK_OF(X509_NAME) *client_ca_names;
973
974 /*
975 * Default values to use in SSL structures follow (these are copied by
976 * SSL_new)
977 */
978
979 uint64_t options;
980 uint32_t mode;
981 int min_proto_version;
982 int max_proto_version;
983 size_t max_cert_list;
984
985 struct cert_st /* CERT */ *cert;
986 int read_ahead;
987
988 /* callback that allows applications to peek at protocol messages */
989 void (*msg_callback) (int write_p, int version, int content_type,
990 const void *buf, size_t len, SSL *ssl, void *arg);
991 void *msg_callback_arg;
992
993 uint32_t verify_mode;
994 size_t sid_ctx_length;
995 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
996 /* called 'verify_callback' in the SSL */
997 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
998
999 /* Default generate session ID callback. */
1000 GEN_SESSION_CB generate_session_id;
1001
1002 X509_VERIFY_PARAM *param;
1003
1004 int quiet_shutdown;
1005
1006 # ifndef OPENSSL_NO_CT
1007 CTLOG_STORE *ctlog_store; /* CT Log Store */
1008 /*
1009 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1010 * If they are not, the connection should be aborted.
1011 */
1012 ssl_ct_validation_cb ct_validation_callback;
1013 void *ct_validation_callback_arg;
1014 # endif
1015
1016 /*
1017 * If we're using more than one pipeline how should we divide the data
1018 * up between the pipes?
1019 */
1020 size_t split_send_fragment;
1021 /*
1022 * Maximum amount of data to send in one fragment. actual record size can
1023 * be more than this due to padding and MAC overheads.
1024 */
1025 size_t max_send_fragment;
1026
1027 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1028 size_t max_pipelines;
1029
1030 /* The default read buffer length to use (0 means not set) */
1031 size_t default_read_buf_len;
1032
1033 # ifndef OPENSSL_NO_ENGINE
1034 /*
1035 * Engine to pass requests for client certs to
1036 */
1037 ENGINE *client_cert_engine;
1038 # endif
1039
1040 /* ClientHello callback. Mostly for extensions, but not entirely. */
1041 SSL_client_hello_cb_fn client_hello_cb;
1042 void *client_hello_cb_arg;
1043
1044 /* TLS extensions. */
1045 struct {
1046 /* TLS extensions servername callback */
1047 int (*servername_cb) (SSL *, int *, void *);
1048 void *servername_arg;
1049 /* RFC 4507 session ticket keys */
1050 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
1051 SSL_CTX_EXT_SECURE *secure;
1052 # ifndef OPENSSL_NO_DEPRECATED_3_0
1053 /* Callback to support customisation of ticket key setting */
1054 int (*ticket_key_cb) (SSL *ssl,
1055 unsigned char *name, unsigned char *iv,
1056 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
1057 #endif
1058 int (*ticket_key_evp_cb) (SSL *ssl,
1059 unsigned char *name, unsigned char *iv,
1060 EVP_CIPHER_CTX *ectx, EVP_MAC_CTX *hctx,
1061 int enc);
1062
1063 /* certificate status request info */
1064 /* Callback for status request */
1065 int (*status_cb) (SSL *ssl, void *arg);
1066 void *status_arg;
1067 /* ext status type used for CSR extension (OCSP Stapling) */
1068 int status_type;
1069 /* RFC 4366 Maximum Fragment Length Negotiation */
1070 uint8_t max_fragment_len_mode;
1071
1072 /* EC extension values inherited by SSL structure */
1073 size_t ecpointformats_len;
1074 unsigned char *ecpointformats;
1075
1076 size_t supportedgroups_len;
1077 uint16_t *supportedgroups;
1078
1079 uint16_t *supported_groups_default;
1080 size_t supported_groups_default_len;
1081 /*
1082 * ALPN information (we are in the process of transitioning from NPN to
1083 * ALPN.)
1084 */
1085
1086 /*-
1087 * For a server, this contains a callback function that allows the
1088 * server to select the protocol for the connection.
1089 * out: on successful return, this must point to the raw protocol
1090 * name (without the length prefix).
1091 * outlen: on successful return, this contains the length of |*out|.
1092 * in: points to the client's list of supported protocols in
1093 * wire-format.
1094 * inlen: the length of |in|.
1095 */
1096 int (*alpn_select_cb) (SSL *s,
1097 const unsigned char **out,
1098 unsigned char *outlen,
1099 const unsigned char *in,
1100 unsigned int inlen, void *arg);
1101 void *alpn_select_cb_arg;
1102
1103 /*
1104 * For a client, this contains the list of supported protocols in wire
1105 * format.
1106 */
1107 unsigned char *alpn;
1108 size_t alpn_len;
1109
1110 # ifndef OPENSSL_NO_NEXTPROTONEG
1111 /* Next protocol negotiation information */
1112
1113 /*
1114 * For a server, this contains a callback function by which the set of
1115 * advertised protocols can be provided.
1116 */
1117 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
1118 void *npn_advertised_cb_arg;
1119 /*
1120 * For a client, this contains a callback function that selects the next
1121 * protocol from the list provided by the server.
1122 */
1123 SSL_CTX_npn_select_cb_func npn_select_cb;
1124 void *npn_select_cb_arg;
1125 # endif
1126
1127 unsigned char cookie_hmac_key[SHA256_DIGEST_LENGTH];
1128 } ext;
1129
1130 # ifndef OPENSSL_NO_PSK
1131 SSL_psk_client_cb_func psk_client_callback;
1132 SSL_psk_server_cb_func psk_server_callback;
1133 # endif
1134 SSL_psk_find_session_cb_func psk_find_session_cb;
1135 SSL_psk_use_session_cb_func psk_use_session_cb;
1136
1137 # ifndef OPENSSL_NO_SRP
1138 SRP_CTX srp_ctx; /* ctx for SRP authentication */
1139 # endif
1140
1141 /* Shared DANE context */
1142 struct dane_ctx_st dane;
1143
1144 # ifndef OPENSSL_NO_SRTP
1145 /* SRTP profiles we are willing to do from RFC 5764 */
1146 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1147 # endif
1148 /*
1149 * Callback for disabling session caching and ticket support on a session
1150 * basis, depending on the chosen cipher.
1151 */
1152 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1153
1154 CRYPTO_RWLOCK *lock;
1155
1156 /*
1157 * Callback for logging key material for use with debugging tools like
1158 * Wireshark. The callback should log `line` followed by a newline.
1159 */
1160 SSL_CTX_keylog_cb_func keylog_callback;
1161
1162 /*
1163 * The maximum number of bytes advertised in session tickets that can be
1164 * sent as early data.
1165 */
1166 uint32_t max_early_data;
1167
1168 /*
1169 * The maximum number of bytes of early data that a server will tolerate
1170 * (which should be at least as much as max_early_data).
1171 */
1172 uint32_t recv_max_early_data;
1173
1174 /* TLS1.3 padding callback */
1175 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1176 void *record_padding_arg;
1177 size_t block_padding;
1178
1179 /* Session ticket appdata */
1180 SSL_CTX_generate_session_ticket_fn generate_ticket_cb;
1181 SSL_CTX_decrypt_session_ticket_fn decrypt_ticket_cb;
1182 void *ticket_cb_data;
1183
1184 /* The number of TLS1.3 tickets to automatically send */
1185 size_t num_tickets;
1186
1187 /* Callback to determine if early_data is acceptable or not */
1188 SSL_allow_early_data_cb_fn allow_early_data_cb;
1189 void *allow_early_data_cb_data;
1190
1191 /* Do we advertise Post-handshake auth support? */
1192 int pha_enabled;
1193
1194 /* Callback for SSL async handling */
1195 SSL_async_callback_fn async_cb;
1196 void *async_cb_arg;
1197
1198 char *propq;
1199
1200 int ssl_mac_pkey_id[SSL_MD_NUM_IDX];
1201 const EVP_CIPHER *ssl_cipher_methods[SSL_ENC_NUM_IDX];
1202 const EVP_MD *ssl_digest_methods[SSL_MD_NUM_IDX];
1203 size_t ssl_mac_secret_size[SSL_MD_NUM_IDX];
1204
1205 /* Cache of all sigalgs we know and whether they are available or not */
1206 struct sigalg_lookup_st *sigalg_lookup_cache;
1207
1208 TLS_GROUP_INFO *group_list;
1209 size_t group_list_len;
1210 size_t group_list_max_len;
1211
1212 /* masks of disabled algorithms */
1213 uint32_t disabled_enc_mask;
1214 uint32_t disabled_mac_mask;
1215 uint32_t disabled_mkey_mask;
1216 uint32_t disabled_auth_mask;
1217
1218 #ifndef OPENSSL_NO_QUIC
1219 const SSL_QUIC_METHOD *quic_method;
1220 #endif
1221 };
1222
1223 typedef struct cert_pkey_st CERT_PKEY;
1224
1225 #ifndef OPENSSL_NO_QUIC
1226 struct quic_data_st {
1227 struct quic_data_st *next;
1228 OSSL_ENCRYPTION_LEVEL level;
1229 size_t start; /* offset into quic_buf->data */
1230 size_t length;
1231 };
1232 typedef struct quic_data_st QUIC_DATA;
1233 int quic_set_encryption_secrets(SSL *ssl, OSSL_ENCRYPTION_LEVEL level);
1234 #endif
1235
1236 struct ssl_st {
1237 /*
1238 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1239 * DTLS1_VERSION)
1240 */
1241 int version;
1242 /* SSLv3 */
1243 const SSL_METHOD *method;
1244 /*
1245 * There are 2 BIO's even though they are normally both the same. This
1246 * is so data can be read and written to different handlers
1247 */
1248 /* used by SSL_read */
1249 BIO *rbio;
1250 /* used by SSL_write */
1251 BIO *wbio;
1252 /* used during session-id reuse to concatenate messages */
1253 BIO *bbio;
1254 /*
1255 * This holds a variable that indicates what we were doing when a 0 or -1
1256 * is returned. This is needed for non-blocking IO so we know what
1257 * request needs re-doing when in SSL_accept or SSL_connect
1258 */
1259 int rwstate;
1260 int (*handshake_func) (SSL *);
1261 /*
1262 * Imagine that here's a boolean member "init" that is switched as soon
1263 * as SSL_set_{accept/connect}_state is called for the first time, so
1264 * that "state" and "handshake_func" are properly initialized. But as
1265 * handshake_func is == 0 until then, we use this test instead of an
1266 * "init" member.
1267 */
1268 /* are we the server side? */
1269 int server;
1270 /*
1271 * Generate a new session or reuse an old one.
1272 * NB: For servers, the 'new' session may actually be a previously
1273 * cached session or even the previous session unless
1274 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1275 */
1276 int new_session;
1277 /* don't send shutdown packets */
1278 int quiet_shutdown;
1279 /* we have shut things down, 0x01 sent, 0x02 for received */
1280 int shutdown;
1281 /* where we are */
1282 OSSL_STATEM statem;
1283 SSL_EARLY_DATA_STATE early_data_state;
1284 BUF_MEM *init_buf; /* buffer used during init */
1285 void *init_msg; /* pointer to handshake message body, set by
1286 * ssl3_get_message() */
1287 size_t init_num; /* amount read/written */
1288 size_t init_off; /* amount read/written */
1289
1290 struct {
1291 long flags;
1292 size_t read_mac_secret_size;
1293 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1294 size_t write_mac_secret_size;
1295 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1296 unsigned char server_random[SSL3_RANDOM_SIZE];
1297 unsigned char client_random[SSL3_RANDOM_SIZE];
1298 /* flags for countermeasure against known-IV weakness */
1299 int need_empty_fragments;
1300 int empty_fragment_done;
1301 /* used during startup, digest all incoming/outgoing packets */
1302 BIO *handshake_buffer;
1303 /*
1304 * When handshake digest is determined, buffer is hashed and
1305 * freed and MD_CTX for the required digest is stored here.
1306 */
1307 EVP_MD_CTX *handshake_dgst;
1308 /*
1309 * Set whenever an expected ChangeCipherSpec message is processed.
1310 * Unset when the peer's Finished message is received.
1311 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1312 */
1313 int change_cipher_spec;
1314 int warn_alert;
1315 int fatal_alert;
1316 /*
1317 * we allow one fatal and one warning alert to be outstanding, send close
1318 * alert via the warning alert
1319 */
1320 int alert_dispatch;
1321 unsigned char send_alert[2];
1322 /*
1323 * This flag is set when we should renegotiate ASAP, basically when there
1324 * is no more data in the read or write buffers
1325 */
1326 int renegotiate;
1327 int total_renegotiations;
1328 int num_renegotiations;
1329 int in_read_app_data;
1330 struct {
1331 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1332 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1333 size_t finish_md_len;
1334 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1335 size_t peer_finish_md_len;
1336 size_t message_size;
1337 int message_type;
1338 /* used to hold the new cipher we are going to use */
1339 const SSL_CIPHER *new_cipher;
1340 EVP_PKEY *pkey; /* holds short lived key exchange key */
1341 /* used for certificate requests */
1342 int cert_req;
1343 /* Certificate types in certificate request message. */
1344 uint8_t *ctype;
1345 size_t ctype_len;
1346 /* Certificate authorities list peer sent */
1347 STACK_OF(X509_NAME) *peer_ca_names;
1348 size_t key_block_length;
1349 unsigned char *key_block;
1350 const EVP_CIPHER *new_sym_enc;
1351 const EVP_MD *new_hash;
1352 int new_mac_pkey_type;
1353 size_t new_mac_secret_size;
1354 # ifndef OPENSSL_NO_COMP
1355 const SSL_COMP *new_compression;
1356 # else
1357 char *new_compression;
1358 # endif
1359 int cert_request;
1360 /* Raw values of the cipher list from a client */
1361 unsigned char *ciphers_raw;
1362 size_t ciphers_rawlen;
1363 /* Temporary storage for premaster secret */
1364 unsigned char *pms;
1365 size_t pmslen;
1366 # ifndef OPENSSL_NO_PSK
1367 /* Temporary storage for PSK key */
1368 unsigned char *psk;
1369 size_t psklen;
1370 # endif
1371 /* Signature algorithm we actually use */
1372 const struct sigalg_lookup_st *sigalg;
1373 /* Pointer to certificate we use */
1374 CERT_PKEY *cert;
1375 /*
1376 * signature algorithms peer reports: e.g. supported signature
1377 * algorithms extension for server or as part of a certificate
1378 * request for client.
1379 * Keep track of the algorithms for TLS and X.509 usage separately.
1380 */
1381 uint16_t *peer_sigalgs;
1382 uint16_t *peer_cert_sigalgs;
1383 /* Size of above arrays */
1384 size_t peer_sigalgslen;
1385 size_t peer_cert_sigalgslen;
1386 /* Sigalg peer actually uses */
1387 const struct sigalg_lookup_st *peer_sigalg;
1388 /*
1389 * Set if corresponding CERT_PKEY can be used with current
1390 * SSL session: e.g. appropriate curve, signature algorithms etc.
1391 * If zero it can't be used at all.
1392 */
1393 uint32_t valid_flags[SSL_PKEY_NUM];
1394 /*
1395 * For servers the following masks are for the key and auth algorithms
1396 * that are supported by the certs below. For clients they are masks of
1397 * *disabled* algorithms based on the current session.
1398 */
1399 uint32_t mask_k;
1400 uint32_t mask_a;
1401 /*
1402 * The following are used by the client to see if a cipher is allowed or
1403 * not. It contains the minimum and maximum version the client's using
1404 * based on what it knows so far.
1405 */
1406 int min_ver;
1407 int max_ver;
1408 } tmp;
1409
1410 /* Connection binding to prevent renegotiation attacks */
1411 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1412 size_t previous_client_finished_len;
1413 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1414 size_t previous_server_finished_len;
1415 int send_connection_binding;
1416
1417 # ifndef OPENSSL_NO_NEXTPROTONEG
1418 /*
1419 * Set if we saw the Next Protocol Negotiation extension from our peer.
1420 */
1421 int npn_seen;
1422 # endif
1423
1424 /*
1425 * ALPN information (we are in the process of transitioning from NPN to
1426 * ALPN.)
1427 */
1428
1429 /*
1430 * In a server these point to the selected ALPN protocol after the
1431 * ClientHello has been processed. In a client these contain the protocol
1432 * that the server selected once the ServerHello has been processed.
1433 */
1434 unsigned char *alpn_selected;
1435 size_t alpn_selected_len;
1436 /* used by the server to know what options were proposed */
1437 unsigned char *alpn_proposed;
1438 size_t alpn_proposed_len;
1439 /* used by the client to know if it actually sent alpn */
1440 int alpn_sent;
1441
1442 /*
1443 * This is set to true if we believe that this is a version of Safari
1444 * running on OS X 10.6 or newer. We wish to know this because Safari on
1445 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1446 */
1447 char is_probably_safari;
1448
1449 /*
1450 * Track whether we did a key exchange this handshake or not, so
1451 * SSL_get_negotiated_group() knows whether to fall back to the
1452 * value in the SSL_SESSION.
1453 */
1454 char did_kex;
1455 /* For clients: peer temporary key */
1456 /* The group_id for the key exchange key */
1457 uint16_t group_id;
1458 EVP_PKEY *peer_tmp;
1459
1460 } s3;
1461
1462 struct dtls1_state_st *d1; /* DTLSv1 variables */
1463 /* callback that allows applications to peek at protocol messages */
1464 void (*msg_callback) (int write_p, int version, int content_type,
1465 const void *buf, size_t len, SSL *ssl, void *arg);
1466 void *msg_callback_arg;
1467 int hit; /* reusing a previous session */
1468 X509_VERIFY_PARAM *param;
1469 /* Per connection DANE state */
1470 SSL_DANE dane;
1471 /* crypto */
1472 STACK_OF(SSL_CIPHER) *peer_ciphers;
1473 STACK_OF(SSL_CIPHER) *cipher_list;
1474 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1475 /* TLSv1.3 specific ciphersuites */
1476 STACK_OF(SSL_CIPHER) *tls13_ciphersuites;
1477 /*
1478 * These are the ones being used, the ones in SSL_SESSION are the ones to
1479 * be 'copied' into these ones
1480 */
1481 uint32_t mac_flags;
1482 /*
1483 * The TLS1.3 secrets.
1484 */
1485 unsigned char early_secret[EVP_MAX_MD_SIZE];
1486 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1487 unsigned char master_secret[EVP_MAX_MD_SIZE];
1488 unsigned char resumption_master_secret[EVP_MAX_MD_SIZE];
1489 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1490 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1491 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1492 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1493 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1494 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1495 # ifndef OPENSSL_NO_QUIC
1496 unsigned char client_hand_traffic_secret[EVP_MAX_MD_SIZE];
1497 unsigned char server_hand_traffic_secret[EVP_MAX_MD_SIZE];
1498 unsigned char client_early_traffic_secret[EVP_MAX_MD_SIZE];
1499 # endif
1500 unsigned char exporter_master_secret[EVP_MAX_MD_SIZE];
1501 unsigned char early_exporter_master_secret[EVP_MAX_MD_SIZE];
1502 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1503 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1504 EVP_MD_CTX *read_hash; /* used for mac generation */
1505 COMP_CTX *compress; /* compression */
1506 COMP_CTX *expand; /* uncompress */
1507 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1508 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1509 EVP_MD_CTX *write_hash; /* used for mac generation */
1510 /* session info */
1511 /* client cert? */
1512 /* This is used to hold the server certificate used */
1513 struct cert_st /* CERT */ *cert;
1514
1515 /*
1516 * The hash of all messages prior to the CertificateVerify, and the length
1517 * of that hash.
1518 */
1519 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1520 size_t cert_verify_hash_len;
1521
1522 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1523 enum {SSL_HRR_NONE = 0, SSL_HRR_PENDING, SSL_HRR_COMPLETE}
1524 hello_retry_request;
1525
1526 /*
1527 * the session_id_context is used to ensure sessions are only reused in
1528 * the appropriate context
1529 */
1530 size_t sid_ctx_length;
1531 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1532 /* This can also be in the session once a session is established */
1533 SSL_SESSION *session;
1534 /* TLSv1.3 PSK session */
1535 SSL_SESSION *psksession;
1536 unsigned char *psksession_id;
1537 size_t psksession_id_len;
1538 /* Default generate session ID callback. */
1539 GEN_SESSION_CB generate_session_id;
1540 /*
1541 * The temporary TLSv1.3 session id. This isn't really a session id at all
1542 * but is a random value sent in the legacy session id field.
1543 */
1544 unsigned char tmp_session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1545 size_t tmp_session_id_len;
1546 /* Used in SSL3 */
1547 /*
1548 * 0 don't care about verify failure.
1549 * 1 fail if verify fails
1550 */
1551 uint32_t verify_mode;
1552 /* fail if callback returns 0 */
1553 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1554 /* optional informational callback */
1555 void (*info_callback) (const SSL *ssl, int type, int val);
1556 /* error bytes to be written */
1557 int error;
1558 /* actual code */
1559 int error_code;
1560 # ifndef OPENSSL_NO_PSK
1561 SSL_psk_client_cb_func psk_client_callback;
1562 SSL_psk_server_cb_func psk_server_callback;
1563 # endif
1564 SSL_psk_find_session_cb_func psk_find_session_cb;
1565 SSL_psk_use_session_cb_func psk_use_session_cb;
1566
1567 SSL_CTX *ctx;
1568 /* Verified chain of peer */
1569 STACK_OF(X509) *verified_chain;
1570 long verify_result;
1571 /* extra application data */
1572 CRYPTO_EX_DATA ex_data;
1573 /*
1574 * What we put in certificate_authorities extension for TLS 1.3
1575 * (ClientHello and CertificateRequest) or just client cert requests for
1576 * earlier versions. If client_ca_names is populated then it is only used
1577 * for client cert requests, and in preference to ca_names.
1578 */
1579 STACK_OF(X509_NAME) *ca_names;
1580 STACK_OF(X509_NAME) *client_ca_names;
1581 CRYPTO_REF_COUNT references;
1582 /* protocol behaviour */
1583 uint64_t options;
1584 /* API behaviour */
1585 uint32_t mode;
1586 int min_proto_version;
1587 int max_proto_version;
1588 size_t max_cert_list;
1589 int first_packet;
1590 /*
1591 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1592 * secret and SSLv3/TLS (<=1.2) rollback check
1593 */
1594 int client_version;
1595 /*
1596 * If we're using more than one pipeline how should we divide the data
1597 * up between the pipes?
1598 */
1599 size_t split_send_fragment;
1600 /*
1601 * Maximum amount of data to send in one fragment. actual record size can
1602 * be more than this due to padding and MAC overheads.
1603 */
1604 size_t max_send_fragment;
1605 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1606 size_t max_pipelines;
1607
1608 struct {
1609 /* Built-in extension flags */
1610 uint8_t extflags[TLSEXT_IDX_num_builtins];
1611 /* TLS extension debug callback */
1612 void (*debug_cb)(SSL *s, int client_server, int type,
1613 const unsigned char *data, int len, void *arg);
1614 void *debug_arg;
1615 char *hostname;
1616 /* certificate status request info */
1617 /* Status type or -1 if no status type */
1618 int status_type;
1619 /* Raw extension data, if seen */
1620 unsigned char *scts;
1621 /* Length of raw extension data, if seen */
1622 uint16_t scts_len;
1623 /* Expect OCSP CertificateStatus message */
1624 int status_expected;
1625
1626 struct {
1627 /* OCSP status request only */
1628 STACK_OF(OCSP_RESPID) *ids;
1629 X509_EXTENSIONS *exts;
1630 /* OCSP response received or to be sent */
1631 unsigned char *resp;
1632 size_t resp_len;
1633 } ocsp;
1634
1635 /* RFC4507 session ticket expected to be received or sent */
1636 int ticket_expected;
1637 /* TLS 1.3 tickets requested by the application. */
1638 int extra_tickets_expected;
1639 size_t ecpointformats_len;
1640 /* our list */
1641 unsigned char *ecpointformats;
1642
1643 size_t peer_ecpointformats_len;
1644 /* peer's list */
1645 unsigned char *peer_ecpointformats;
1646 size_t supportedgroups_len;
1647 /* our list */
1648 uint16_t *supportedgroups;
1649
1650 size_t peer_supportedgroups_len;
1651 /* peer's list */
1652 uint16_t *peer_supportedgroups;
1653
1654 /* TLS Session Ticket extension override */
1655 TLS_SESSION_TICKET_EXT *session_ticket;
1656 /* TLS Session Ticket extension callback */
1657 tls_session_ticket_ext_cb_fn session_ticket_cb;
1658 void *session_ticket_cb_arg;
1659 /* TLS pre-shared secret session resumption */
1660 tls_session_secret_cb_fn session_secret_cb;
1661 void *session_secret_cb_arg;
1662 /*
1663 * For a client, this contains the list of supported protocols in wire
1664 * format.
1665 */
1666 unsigned char *alpn;
1667 size_t alpn_len;
1668 /*
1669 * Next protocol negotiation. For the client, this is the protocol that
1670 * we sent in NextProtocol and is set when handling ServerHello
1671 * extensions. For a server, this is the client's selected_protocol from
1672 * NextProtocol and is set when handling the NextProtocol message, before
1673 * the Finished message.
1674 */
1675 unsigned char *npn;
1676 size_t npn_len;
1677
1678 /* The available PSK key exchange modes */
1679 int psk_kex_mode;
1680
1681 /* Set to one if we have negotiated ETM */
1682 int use_etm;
1683
1684 /* Are we expecting to receive early data? */
1685 int early_data;
1686 /* Is the session suitable for early data? */
1687 int early_data_ok;
1688
1689 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1690 unsigned char *tls13_cookie;
1691 size_t tls13_cookie_len;
1692 /* Have we received a cookie from the client? */
1693 int cookieok;
1694
1695 /*
1696 * Maximum Fragment Length as per RFC 4366.
1697 * If this member contains one of the allowed values (1-4)
1698 * then we should include Maximum Fragment Length Negotiation
1699 * extension in Client Hello.
1700 * Please note that value of this member does not have direct
1701 * effect. The actual (binding) value is stored in SSL_SESSION,
1702 * as this extension is optional on server side.
1703 */
1704 uint8_t max_fragment_len_mode;
1705
1706 /*
1707 * On the client side the number of ticket identities we sent in the
1708 * ClientHello. On the server side the identity of the ticket we
1709 * selected.
1710 */
1711 int tick_identity;
1712
1713 #ifndef OPENSSL_NO_QUIC
1714 uint8_t *quic_transport_params;
1715 size_t quic_transport_params_len;
1716 uint8_t *peer_quic_transport_params_draft;
1717 size_t peer_quic_transport_params_draft_len;
1718 uint8_t *peer_quic_transport_params;
1719 size_t peer_quic_transport_params_len;
1720 #endif
1721 } ext;
1722
1723 #ifndef OPENSSL_NO_QUIC
1724 OSSL_ENCRYPTION_LEVEL quic_read_level;
1725 OSSL_ENCRYPTION_LEVEL quic_write_level;
1726 OSSL_ENCRYPTION_LEVEL quic_latest_level_received;
1727 BUF_MEM *quic_buf; /* buffer incoming handshake messages */
1728 /*
1729 * defaults to 0, but can be set to:
1730 * - TLSEXT_TYPE_quic_transport_parameters_draft
1731 * - TLSEXT_TYPE_quic_transport_parameters
1732 * Client: if 0, send both
1733 * Server: if 0, use same version as client sent
1734 */
1735 int quic_transport_version;
1736 QUIC_DATA *quic_input_data_head;
1737 QUIC_DATA *quic_input_data_tail;
1738 size_t quic_next_record_start;
1739 const SSL_QUIC_METHOD *quic_method;
1740 #endif
1741 /*
1742 * Parsed form of the ClientHello, kept around across client_hello_cb
1743 * calls.
1744 */
1745 CLIENTHELLO_MSG *clienthello;
1746
1747 /*-
1748 * no further mod of servername
1749 * 0 : call the servername extension callback.
1750 * 1 : prepare 2, allow last ack just after in server callback.
1751 * 2 : don't call servername callback, no ack in server hello
1752 */
1753 int servername_done;
1754 # ifndef OPENSSL_NO_CT
1755 /*
1756 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1757 * If they are not, the connection should be aborted.
1758 */
1759 ssl_ct_validation_cb ct_validation_callback;
1760 /* User-supplied argument that is passed to the ct_validation_callback */
1761 void *ct_validation_callback_arg;
1762 /*
1763 * Consolidated stack of SCTs from all sources.
1764 * Lazily populated by CT_get_peer_scts(SSL*)
1765 */
1766 STACK_OF(SCT) *scts;
1767 /* Have we attempted to find/parse SCTs yet? */
1768 int scts_parsed;
1769 # endif
1770 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1771 # ifndef OPENSSL_NO_SRTP
1772 /* What we'll do */
1773 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1774 /* What's been chosen */
1775 SRTP_PROTECTION_PROFILE *srtp_profile;
1776 # endif
1777 /*-
1778 * 1 if we are renegotiating.
1779 * 2 if we are a server and are inside a handshake
1780 * (i.e. not just sending a HelloRequest)
1781 */
1782 int renegotiate;
1783 /* If sending a KeyUpdate is pending */
1784 int key_update;
1785 /* Post-handshake authentication state */
1786 SSL_PHA_STATE post_handshake_auth;
1787 int pha_enabled;
1788 uint8_t* pha_context;
1789 size_t pha_context_len;
1790 int certreqs_sent;
1791 EVP_MD_CTX *pha_dgst; /* this is just the digest through ClientFinished */
1792
1793 # ifndef OPENSSL_NO_SRP
1794 /* ctx for SRP authentication */
1795 SRP_CTX srp_ctx;
1796 # endif
1797 /*
1798 * Callback for disabling session caching and ticket support on a session
1799 * basis, depending on the chosen cipher.
1800 */
1801 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1802 RECORD_LAYER rlayer;
1803 /* Default password callback. */
1804 pem_password_cb *default_passwd_callback;
1805 /* Default password callback user data. */
1806 void *default_passwd_callback_userdata;
1807 /* Async Job info */
1808 ASYNC_JOB *job;
1809 ASYNC_WAIT_CTX *waitctx;
1810 size_t asyncrw;
1811
1812 /*
1813 * The maximum number of bytes advertised in session tickets that can be
1814 * sent as early data.
1815 */
1816 uint32_t max_early_data;
1817 /*
1818 * The maximum number of bytes of early data that a server will tolerate
1819 * (which should be at least as much as max_early_data).
1820 */
1821 uint32_t recv_max_early_data;
1822
1823 /*
1824 * The number of bytes of early data received so far. If we accepted early
1825 * data then this is a count of the plaintext bytes. If we rejected it then
1826 * this is a count of the ciphertext bytes.
1827 */
1828 uint32_t early_data_count;
1829
1830 /* TLS1.3 padding callback */
1831 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1832 void *record_padding_arg;
1833 size_t block_padding;
1834
1835 CRYPTO_RWLOCK *lock;
1836
1837 /* The number of TLS1.3 tickets to automatically send */
1838 size_t num_tickets;
1839 /* The number of TLS1.3 tickets actually sent so far */
1840 size_t sent_tickets;
1841 /* The next nonce value to use when we send a ticket on this connection */
1842 uint64_t next_ticket_nonce;
1843
1844 /* Callback to determine if early_data is acceptable or not */
1845 SSL_allow_early_data_cb_fn allow_early_data_cb;
1846 void *allow_early_data_cb_data;
1847
1848 /* Callback for SSL async handling */
1849 SSL_async_callback_fn async_cb;
1850 void *async_cb_arg;
1851
1852 /*
1853 * Signature algorithms shared by client and server: cached because these
1854 * are used most often.
1855 */
1856 const struct sigalg_lookup_st **shared_sigalgs;
1857 size_t shared_sigalgslen;
1858 };
1859
1860 /*
1861 * Structure containing table entry of values associated with the signature
1862 * algorithms (signature scheme) extension
1863 */
1864 typedef struct sigalg_lookup_st {
1865 /* TLS 1.3 signature scheme name */
1866 const char *name;
1867 /* Raw value used in extension */
1868 uint16_t sigalg;
1869 /* NID of hash algorithm or NID_undef if no hash */
1870 int hash;
1871 /* Index of hash algorithm or -1 if no hash algorithm */
1872 int hash_idx;
1873 /* NID of signature algorithm */
1874 int sig;
1875 /* Index of signature algorithm */
1876 int sig_idx;
1877 /* Combined hash and signature NID, if any */
1878 int sigandhash;
1879 /* Required public key curve (ECDSA only) */
1880 int curve;
1881 /* Whether this signature algorithm is actually available for use */
1882 int enabled;
1883 } SIGALG_LOOKUP;
1884
1885 /*
1886 * Structure containing table entry of certificate info corresponding to
1887 * CERT_PKEY entries
1888 */
1889 typedef struct {
1890 int nid; /* NID of public key algorithm */
1891 uint32_t amask; /* authmask corresponding to key type */
1892 } SSL_CERT_LOOKUP;
1893
1894 /* DTLS structures */
1895
1896 # ifndef OPENSSL_NO_SCTP
1897 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1898 # endif
1899
1900 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1901 # define DTLS1_MAX_MTU_OVERHEAD 48
1902
1903 /*
1904 * Flag used in message reuse to indicate the buffer contains the record
1905 * header as well as the handshake message header.
1906 */
1907 # define DTLS1_SKIP_RECORD_HEADER 2
1908
1909 struct dtls1_retransmit_state {
1910 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1911 EVP_MD_CTX *write_hash; /* used for mac generation */
1912 COMP_CTX *compress; /* compression */
1913 SSL_SESSION *session;
1914 unsigned short epoch;
1915 };
1916
1917 struct hm_header_st {
1918 unsigned char type;
1919 size_t msg_len;
1920 unsigned short seq;
1921 size_t frag_off;
1922 size_t frag_len;
1923 unsigned int is_ccs;
1924 struct dtls1_retransmit_state saved_retransmit_state;
1925 };
1926
1927 typedef struct hm_fragment_st {
1928 struct hm_header_st msg_header;
1929 unsigned char *fragment;
1930 unsigned char *reassembly;
1931 } hm_fragment;
1932
1933 typedef struct pqueue_st pqueue;
1934 typedef struct pitem_st pitem;
1935
1936 struct pitem_st {
1937 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1938 void *data;
1939 pitem *next;
1940 };
1941
1942 typedef struct pitem_st *piterator;
1943
1944 pitem *pitem_new(unsigned char *prio64be, void *data);
1945 void pitem_free(pitem *item);
1946 pqueue *pqueue_new(void);
1947 void pqueue_free(pqueue *pq);
1948 pitem *pqueue_insert(pqueue *pq, pitem *item);
1949 pitem *pqueue_peek(pqueue *pq);
1950 pitem *pqueue_pop(pqueue *pq);
1951 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1952 pitem *pqueue_iterator(pqueue *pq);
1953 pitem *pqueue_next(piterator *iter);
1954 size_t pqueue_size(pqueue *pq);
1955
1956 typedef struct dtls1_state_st {
1957 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1958 size_t cookie_len;
1959 unsigned int cookie_verified;
1960 /* handshake message numbers */
1961 unsigned short handshake_write_seq;
1962 unsigned short next_handshake_write_seq;
1963 unsigned short handshake_read_seq;
1964 /* Buffered handshake messages */
1965 pqueue *buffered_messages;
1966 /* Buffered (sent) handshake records */
1967 pqueue *sent_messages;
1968 size_t link_mtu; /* max on-the-wire DTLS packet size */
1969 size_t mtu; /* max DTLS packet size */
1970 struct hm_header_st w_msg_hdr;
1971 struct hm_header_st r_msg_hdr;
1972 /* Number of alerts received so far */
1973 unsigned int timeout_num_alerts;
1974 /*
1975 * Indicates when the last handshake msg sent will timeout
1976 */
1977 struct timeval next_timeout;
1978 /* Timeout duration */
1979 unsigned int timeout_duration_us;
1980
1981 unsigned int retransmitting;
1982 # ifndef OPENSSL_NO_SCTP
1983 int shutdown_received;
1984 # endif
1985
1986 DTLS_timer_cb timer_cb;
1987
1988 } DTLS1_STATE;
1989
1990 /*
1991 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1992 */
1993 # define EXPLICIT_PRIME_CURVE_TYPE 1
1994 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1995 # define NAMED_CURVE_TYPE 3
1996
1997 struct cert_pkey_st {
1998 X509 *x509;
1999 EVP_PKEY *privatekey;
2000 /* Chain for this certificate */
2001 STACK_OF(X509) *chain;
2002 /*-
2003 * serverinfo data for this certificate. The data is in TLS Extension
2004 * wire format, specifically it's a series of records like:
2005 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
2006 * uint16_t length;
2007 * uint8_t data[length];
2008 */
2009 unsigned char *serverinfo;
2010 size_t serverinfo_length;
2011 };
2012 /* Retrieve Suite B flags */
2013 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
2014 /* Uses to check strict mode: suite B modes are always strict */
2015 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
2016 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
2017
2018 typedef enum {
2019 ENDPOINT_CLIENT = 0,
2020 ENDPOINT_SERVER,
2021 ENDPOINT_BOTH
2022 } ENDPOINT;
2023
2024
2025 typedef struct {
2026 unsigned short ext_type;
2027 ENDPOINT role;
2028 /* The context which this extension applies to */
2029 unsigned int context;
2030 /*
2031 * Per-connection flags relating to this extension type: not used if
2032 * part of an SSL_CTX structure.
2033 */
2034 uint32_t ext_flags;
2035 SSL_custom_ext_add_cb_ex add_cb;
2036 SSL_custom_ext_free_cb_ex free_cb;
2037 void *add_arg;
2038 SSL_custom_ext_parse_cb_ex parse_cb;
2039 void *parse_arg;
2040 } custom_ext_method;
2041
2042 /* ext_flags values */
2043
2044 /*
2045 * Indicates an extension has been received. Used to check for unsolicited or
2046 * duplicate extensions.
2047 */
2048 # define SSL_EXT_FLAG_RECEIVED 0x1
2049 /*
2050 * Indicates an extension has been sent: used to enable sending of
2051 * corresponding ServerHello extension.
2052 */
2053 # define SSL_EXT_FLAG_SENT 0x2
2054
2055 typedef struct {
2056 custom_ext_method *meths;
2057 size_t meths_count;
2058 } custom_ext_methods;
2059
2060 typedef struct cert_st {
2061 /* Current active set */
2062 /*
2063 * ALWAYS points to an element of the pkeys array
2064 * Probably it would make more sense to store
2065 * an index, not a pointer.
2066 */
2067 CERT_PKEY *key;
2068
2069 EVP_PKEY *dh_tmp;
2070 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
2071 int dh_tmp_auto;
2072 /* Flags related to certificates */
2073 uint32_t cert_flags;
2074 CERT_PKEY pkeys[SSL_PKEY_NUM];
2075 /* Custom certificate types sent in certificate request message. */
2076 uint8_t *ctype;
2077 size_t ctype_len;
2078 /*
2079 * supported signature algorithms. When set on a client this is sent in
2080 * the client hello as the supported signature algorithms extension. For
2081 * servers it represents the signature algorithms we are willing to use.
2082 */
2083 uint16_t *conf_sigalgs;
2084 /* Size of above array */
2085 size_t conf_sigalgslen;
2086 /*
2087 * Client authentication signature algorithms, if not set then uses
2088 * conf_sigalgs. On servers these will be the signature algorithms sent
2089 * to the client in a certificate request for TLS 1.2. On a client this
2090 * represents the signature algorithms we are willing to use for client
2091 * authentication.
2092 */
2093 uint16_t *client_sigalgs;
2094 /* Size of above array */
2095 size_t client_sigalgslen;
2096 /*
2097 * Certificate setup callback: if set is called whenever a certificate
2098 * may be required (client or server). the callback can then examine any
2099 * appropriate parameters and setup any certificates required. This
2100 * allows advanced applications to select certificates on the fly: for
2101 * example based on supported signature algorithms or curves.
2102 */
2103 int (*cert_cb) (SSL *ssl, void *arg);
2104 void *cert_cb_arg;
2105 /*
2106 * Optional X509_STORE for chain building or certificate validation If
2107 * NULL the parent SSL_CTX store is used instead.
2108 */
2109 X509_STORE *chain_store;
2110 X509_STORE *verify_store;
2111 /* Custom extensions */
2112 custom_ext_methods custext;
2113 /* Security callback */
2114 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
2115 void *other, void *ex);
2116 /* Security level */
2117 int sec_level;
2118 void *sec_ex;
2119 # ifndef OPENSSL_NO_PSK
2120 /* If not NULL psk identity hint to use for servers */
2121 char *psk_identity_hint;
2122 # endif
2123 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
2124 CRYPTO_RWLOCK *lock;
2125 } CERT;
2126
2127 # define FP_ICC (int (*)(const void *,const void *))
2128
2129 /*
2130 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
2131 * of a mess of functions, but hell, think of it as an opaque structure :-)
2132 */
2133 typedef struct ssl3_enc_method {
2134 int (*enc) (SSL *, SSL3_RECORD *, size_t, int, SSL_MAC_BUF *, size_t);
2135 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
2136 int (*setup_key_block) (SSL *);
2137 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
2138 size_t, size_t *);
2139 int (*change_cipher_state) (SSL *, int);
2140 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
2141 const char *client_finished_label;
2142 size_t client_finished_label_len;
2143 const char *server_finished_label;
2144 size_t server_finished_label_len;
2145 int (*alert_value) (int);
2146 int (*export_keying_material) (SSL *, unsigned char *, size_t,
2147 const char *, size_t,
2148 const unsigned char *, size_t,
2149 int use_context);
2150 /* Various flags indicating protocol version requirements */
2151 uint32_t enc_flags;
2152 /* Set the handshake header */
2153 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
2154 /* Close construction of the handshake message */
2155 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
2156 /* Write out handshake message */
2157 int (*do_write) (SSL *s);
2158 } SSL3_ENC_METHOD;
2159
2160 # define ssl_set_handshake_header(s, pkt, htype) \
2161 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
2162 # define ssl_close_construct_packet(s, pkt, htype) \
2163 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
2164 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
2165
2166 /* Values for enc_flags */
2167
2168 /* Uses explicit IV for CBC mode */
2169 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
2170 /* Uses signature algorithms extension */
2171 # define SSL_ENC_FLAG_SIGALGS 0x2
2172 /* Uses SHA256 default PRF */
2173 # define SSL_ENC_FLAG_SHA256_PRF 0x4
2174 /* Is DTLS */
2175 # define SSL_ENC_FLAG_DTLS 0x8
2176 /*
2177 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
2178 * apply to others in future.
2179 */
2180 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
2181
2182 # ifndef OPENSSL_NO_COMP
2183 /* Used for holding the relevant compression methods loaded into SSL_CTX */
2184 typedef struct ssl3_comp_st {
2185 int comp_id; /* The identifier byte for this compression
2186 * type */
2187 char *name; /* Text name used for the compression type */
2188 COMP_METHOD *method; /* The method :-) */
2189 } SSL3_COMP;
2190 # endif
2191
2192 typedef enum downgrade_en {
2193 DOWNGRADE_NONE,
2194 DOWNGRADE_TO_1_2,
2195 DOWNGRADE_TO_1_1
2196 } DOWNGRADE;
2197
2198 /*
2199 * Dummy status type for the status_type extension. Indicates no status type
2200 * set
2201 */
2202 #define TLSEXT_STATUSTYPE_nothing -1
2203
2204 /* Sigalgs values */
2205 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
2206 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
2207 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
2208 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
2209 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
2210 #define TLSEXT_SIGALG_rsa_pss_rsae_sha256 0x0804
2211 #define TLSEXT_SIGALG_rsa_pss_rsae_sha384 0x0805
2212 #define TLSEXT_SIGALG_rsa_pss_rsae_sha512 0x0806
2213 #define TLSEXT_SIGALG_rsa_pss_pss_sha256 0x0809
2214 #define TLSEXT_SIGALG_rsa_pss_pss_sha384 0x080a
2215 #define TLSEXT_SIGALG_rsa_pss_pss_sha512 0x080b
2216 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
2217 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
2218 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
2219 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
2220 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
2221 #define TLSEXT_SIGALG_dsa_sha256 0x0402
2222 #define TLSEXT_SIGALG_dsa_sha384 0x0502
2223 #define TLSEXT_SIGALG_dsa_sha512 0x0602
2224 #define TLSEXT_SIGALG_dsa_sha224 0x0302
2225 #define TLSEXT_SIGALG_dsa_sha1 0x0202
2226 #define TLSEXT_SIGALG_gostr34102012_256_intrinsic 0x0840
2227 #define TLSEXT_SIGALG_gostr34102012_512_intrinsic 0x0841
2228 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
2229 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
2230 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
2231
2232 #define TLSEXT_SIGALG_ed25519 0x0807
2233 #define TLSEXT_SIGALG_ed448 0x0808
2234
2235 /* Known PSK key exchange modes */
2236 #define TLSEXT_KEX_MODE_KE 0x00
2237 #define TLSEXT_KEX_MODE_KE_DHE 0x01
2238
2239 /*
2240 * Internal representations of key exchange modes
2241 */
2242 #define TLSEXT_KEX_MODE_FLAG_NONE 0
2243 #define TLSEXT_KEX_MODE_FLAG_KE 1
2244 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
2245
2246 #define SSL_USE_PSS(s) (s->s3.tmp.peer_sigalg != NULL && \
2247 s->s3.tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
2248
2249 /* A dummy signature value not valid for TLSv1.2 signature algs */
2250 #define TLSEXT_signature_rsa_pss 0x0101
2251
2252 /* TLSv1.3 downgrade protection sentinel values */
2253 extern const unsigned char tls11downgrade[8];
2254 extern const unsigned char tls12downgrade[8];
2255
2256 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
2257
2258 __owur const SSL_METHOD *ssl_bad_method(int ver);
2259 __owur const SSL_METHOD *sslv3_method(void);
2260 __owur const SSL_METHOD *sslv3_server_method(void);
2261 __owur const SSL_METHOD *sslv3_client_method(void);
2262 __owur const SSL_METHOD *tlsv1_method(void);
2263 __owur const SSL_METHOD *tlsv1_server_method(void);
2264 __owur const SSL_METHOD *tlsv1_client_method(void);
2265 __owur const SSL_METHOD *tlsv1_1_method(void);
2266 __owur const SSL_METHOD *tlsv1_1_server_method(void);
2267 __owur const SSL_METHOD *tlsv1_1_client_method(void);
2268 __owur const SSL_METHOD *tlsv1_2_method(void);
2269 __owur const SSL_METHOD *tlsv1_2_server_method(void);
2270 __owur const SSL_METHOD *tlsv1_2_client_method(void);
2271 __owur const SSL_METHOD *tlsv1_3_method(void);
2272 __owur const SSL_METHOD *tlsv1_3_server_method(void);
2273 __owur const SSL_METHOD *tlsv1_3_client_method(void);
2274 __owur const SSL_METHOD *dtlsv1_method(void);
2275 __owur const SSL_METHOD *dtlsv1_server_method(void);
2276 __owur const SSL_METHOD *dtlsv1_client_method(void);
2277 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
2278 __owur const SSL_METHOD *dtlsv1_2_method(void);
2279 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
2280 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
2281
2282 extern const SSL3_ENC_METHOD TLSv1_enc_data;
2283 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
2284 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
2285 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
2286 extern const SSL3_ENC_METHOD SSLv3_enc_data;
2287 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
2288 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
2289
2290 /*
2291 * Flags for SSL methods
2292 */
2293 # define SSL_METHOD_NO_FIPS (1U<<0)
2294 # define SSL_METHOD_NO_SUITEB (1U<<1)
2295
2296 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
2297 s_connect, enc_data) \
2298 const SSL_METHOD *func_name(void) \
2299 { \
2300 static const SSL_METHOD func_name##_data= { \
2301 version, \
2302 flags, \
2303 mask, \
2304 tls1_new, \
2305 tls1_clear, \
2306 tls1_free, \
2307 s_accept, \
2308 s_connect, \
2309 ssl3_read, \
2310 ssl3_peek, \
2311 ssl3_write, \
2312 ssl3_shutdown, \
2313 ssl3_renegotiate, \
2314 ssl3_renegotiate_check, \
2315 ssl3_read_bytes, \
2316 ssl3_write_bytes, \
2317 ssl3_dispatch_alert, \
2318 ssl3_ctrl, \
2319 ssl3_ctx_ctrl, \
2320 ssl3_get_cipher_by_char, \
2321 ssl3_put_cipher_by_char, \
2322 ssl3_pending, \
2323 ssl3_num_ciphers, \
2324 ssl3_get_cipher, \
2325 tls1_default_timeout, \
2326 &enc_data, \
2327 ssl_undefined_void_function, \
2328 ssl3_callback_ctrl, \
2329 ssl3_ctx_callback_ctrl, \
2330 }; \
2331 return &func_name##_data; \
2332 }
2333
2334 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
2335 const SSL_METHOD *func_name(void) \
2336 { \
2337 static const SSL_METHOD func_name##_data= { \
2338 SSL3_VERSION, \
2339 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2340 SSL_OP_NO_SSLv3, \
2341 ssl3_new, \
2342 ssl3_clear, \
2343 ssl3_free, \
2344 s_accept, \
2345 s_connect, \
2346 ssl3_read, \
2347 ssl3_peek, \
2348 ssl3_write, \
2349 ssl3_shutdown, \
2350 ssl3_renegotiate, \
2351 ssl3_renegotiate_check, \
2352 ssl3_read_bytes, \
2353 ssl3_write_bytes, \
2354 ssl3_dispatch_alert, \
2355 ssl3_ctrl, \
2356 ssl3_ctx_ctrl, \
2357 ssl3_get_cipher_by_char, \
2358 ssl3_put_cipher_by_char, \
2359 ssl3_pending, \
2360 ssl3_num_ciphers, \
2361 ssl3_get_cipher, \
2362 ssl3_default_timeout, \
2363 &SSLv3_enc_data, \
2364 ssl_undefined_void_function, \
2365 ssl3_callback_ctrl, \
2366 ssl3_ctx_callback_ctrl, \
2367 }; \
2368 return &func_name##_data; \
2369 }
2370
2371 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2372 s_connect, enc_data) \
2373 const SSL_METHOD *func_name(void) \
2374 { \
2375 static const SSL_METHOD func_name##_data= { \
2376 version, \
2377 flags, \
2378 mask, \
2379 dtls1_new, \
2380 dtls1_clear, \
2381 dtls1_free, \
2382 s_accept, \
2383 s_connect, \
2384 ssl3_read, \
2385 ssl3_peek, \
2386 ssl3_write, \
2387 dtls1_shutdown, \
2388 ssl3_renegotiate, \
2389 ssl3_renegotiate_check, \
2390 dtls1_read_bytes, \
2391 dtls1_write_app_data_bytes, \
2392 dtls1_dispatch_alert, \
2393 dtls1_ctrl, \
2394 ssl3_ctx_ctrl, \
2395 ssl3_get_cipher_by_char, \
2396 ssl3_put_cipher_by_char, \
2397 ssl3_pending, \
2398 ssl3_num_ciphers, \
2399 ssl3_get_cipher, \
2400 dtls1_default_timeout, \
2401 &enc_data, \
2402 ssl_undefined_void_function, \
2403 ssl3_callback_ctrl, \
2404 ssl3_ctx_callback_ctrl, \
2405 }; \
2406 return &func_name##_data; \
2407 }
2408
2409 struct openssl_ssl_test_functions {
2410 int (*p_ssl_init_wbio_buffer) (SSL *s);
2411 int (*p_ssl3_setup_buffers) (SSL *s);
2412 };
2413
2414 const char *ssl_protocol_to_string(int version);
2415
2416 /* Returns true if certificate and private key for 'idx' are present */
ssl_has_cert(const SSL * s,int idx)2417 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2418 {
2419 if (idx < 0 || idx >= SSL_PKEY_NUM)
2420 return 0;
2421 return s->cert->pkeys[idx].x509 != NULL
2422 && s->cert->pkeys[idx].privatekey != NULL;
2423 }
2424
tls1_get_peer_groups(SSL * s,const uint16_t ** pgroups,size_t * pgroupslen)2425 static ossl_inline void tls1_get_peer_groups(SSL *s, const uint16_t **pgroups,
2426 size_t *pgroupslen)
2427 {
2428 *pgroups = s->ext.peer_supportedgroups;
2429 *pgroupslen = s->ext.peer_supportedgroups_len;
2430 }
2431
2432 # ifndef OPENSSL_UNIT_TEST
2433
2434 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2435 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2436 void ssl_clear_cipher_ctx(SSL *s);
2437 int ssl_clear_bad_session(SSL *s);
2438 __owur CERT *ssl_cert_new(void);
2439 __owur CERT *ssl_cert_dup(CERT *cert);
2440 void ssl_cert_clear_certs(CERT *c);
2441 void ssl_cert_free(CERT *c);
2442 __owur int ssl_generate_session_id(SSL *s, SSL_SESSION *ss);
2443 __owur int ssl_get_new_session(SSL *s, int session);
2444 __owur SSL_SESSION *lookup_sess_in_cache(SSL *s, const unsigned char *sess_id,
2445 size_t sess_id_len);
2446 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello);
2447 __owur SSL_SESSION *ssl_session_dup(const SSL_SESSION *src, int ticket);
2448 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2449 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2450 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2451 const SSL_CIPHER *const *bp);
2452 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(SSL_CTX *ctx,
2453 STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
2454 STACK_OF(SSL_CIPHER) **cipher_list,
2455 STACK_OF(SSL_CIPHER) **cipher_list_by_id,
2456 const char *rule_str,
2457 CERT *c);
2458 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites, int sslv2format);
2459 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2460 STACK_OF(SSL_CIPHER) **skp,
2461 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2462 int fatal);
2463 void ssl_update_cache(SSL *s, int mode);
2464 __owur int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
2465 const EVP_CIPHER **enc);
2466 __owur int ssl_cipher_get_evp(SSL_CTX *ctxc, const SSL_SESSION *s,
2467 const EVP_CIPHER **enc, const EVP_MD **md,
2468 int *mac_pkey_type, size_t *mac_secret_size,
2469 SSL_COMP **comp, int use_etm);
2470 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2471 size_t *int_overhead, size_t *blocksize,
2472 size_t *ext_overhead);
2473 __owur int ssl_cert_is_disabled(SSL_CTX *ctx, size_t idx);
2474 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2475 const unsigned char *ptr,
2476 int all);
2477 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2478 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2479 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2480 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2481 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2482 __owur int ssl_cert_set_current(CERT *c, long arg);
2483 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2484
2485 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2486 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2487 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2488 int ref);
2489 __owur int ssl_cert_get_cert_store(CERT *c, X509_STORE **pstore, int chain);
2490
2491 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2492 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2493 void *other);
2494 int ssl_get_security_level_bits(const SSL *s, const SSL_CTX *ctx, int *levelp);
2495
2496 __owur int ssl_cert_lookup_by_nid(int nid, size_t *pidx);
2497 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_pkey(const EVP_PKEY *pk,
2498 size_t *pidx);
2499 __owur const SSL_CERT_LOOKUP *ssl_cert_lookup_by_idx(size_t idx);
2500
2501 int ssl_undefined_function(SSL *s);
2502 __owur int ssl_undefined_void_function(void);
2503 __owur int ssl_undefined_const_function(const SSL *s);
2504 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2505 const unsigned char **serverinfo,
2506 size_t *serverinfo_length);
2507 void ssl_set_masks(SSL *s);
2508 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2509 __owur int ssl_x509err2alert(int type);
2510 void ssl_sort_cipher_list(void);
2511 int ssl_load_ciphers(SSL_CTX *ctx);
2512 __owur int ssl_setup_sig_algs(SSL_CTX *ctx);
2513 int ssl_load_groups(SSL_CTX *ctx);
2514 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2515 size_t len, DOWNGRADE dgrd);
2516 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2517 int free_pms);
2518 __owur EVP_PKEY *ssl_generate_pkey(SSL *s, EVP_PKEY *pm);
2519 __owur int ssl_gensecret(SSL *s, unsigned char *pms, size_t pmslen);
2520 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2521 int genmaster);
2522 __owur int ssl_decapsulate(SSL *s, EVP_PKEY *privkey,
2523 const unsigned char *ct, size_t ctlen,
2524 int gensecret);
2525 __owur int ssl_encapsulate(SSL *s, EVP_PKEY *pubkey,
2526 unsigned char **ctp, size_t *ctlenp,
2527 int gensecret);
2528 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2529 __owur int ssl_set_tmp_ecdh_groups(uint16_t **pext, size_t *pextlen,
2530 void *key);
2531 __owur unsigned int ssl_get_max_send_fragment(const SSL *ssl);
2532 __owur unsigned int ssl_get_split_send_fragment(const SSL *ssl);
2533
2534 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2535 __owur const SSL_CIPHER *ssl3_get_cipher_by_std_name(const char *stdname);
2536 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2537 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2538 size_t *len);
2539 int ssl3_init_finished_mac(SSL *s);
2540 __owur int ssl3_setup_key_block(SSL *s);
2541 __owur int ssl3_change_cipher_state(SSL *s, int which);
2542 void ssl3_cleanup_key_block(SSL *s);
2543 __owur int ssl3_do_write(SSL *s, int type);
2544 int ssl3_send_alert(SSL *s, int level, int desc);
2545 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2546 unsigned char *p, size_t len,
2547 size_t *secret_size);
2548 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2549 __owur int ssl3_num_ciphers(void);
2550 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2551 int ssl3_renegotiate(SSL *ssl);
2552 int ssl3_renegotiate_check(SSL *ssl, int initok);
2553 void ssl3_digest_master_key_set_params(const SSL_SESSION *session,
2554 OSSL_PARAM params[]);
2555 __owur int ssl3_dispatch_alert(SSL *s);
2556 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2557 unsigned char *p);
2558 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2559 void ssl3_free_digest_list(SSL *s);
2560 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2561 CERT_PKEY *cpk);
2562 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2563 STACK_OF(SSL_CIPHER) *clnt,
2564 STACK_OF(SSL_CIPHER) *srvr);
2565 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2566 __owur int ssl3_new(SSL *s);
2567 void ssl3_free(SSL *s);
2568 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2569 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2570 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2571 __owur int ssl3_shutdown(SSL *s);
2572 int ssl3_clear(SSL *s);
2573 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2574 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2575 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2576 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2577
2578 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2579 __owur long ssl3_default_timeout(void);
2580
2581 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2582 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2583 __owur int tls_setup_handshake(SSL *s);
2584 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2585 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2586 __owur int ssl3_handshake_write(SSL *s);
2587
2588 __owur int ssl_allow_compression(SSL *s);
2589
2590 __owur int ssl_version_supported(const SSL *s, int version,
2591 const SSL_METHOD **meth);
2592
2593 __owur int ssl_set_client_hello_version(SSL *s);
2594 __owur int ssl_check_version_downgrade(SSL *s);
2595 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2596 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2597 DOWNGRADE *dgrd);
2598 __owur int ssl_choose_client_version(SSL *s, int version,
2599 RAW_EXTENSION *extensions);
2600 __owur int ssl_get_min_max_version(const SSL *s, int *min_version,
2601 int *max_version, int *real_max);
2602
2603 __owur long tls1_default_timeout(void);
2604 __owur int dtls1_do_write(SSL *s, int type);
2605 void dtls1_set_message_header(SSL *s,
2606 unsigned char mt,
2607 size_t len,
2608 size_t frag_off, size_t frag_len);
2609
2610 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2611 size_t *written);
2612
2613 __owur int dtls1_read_failed(SSL *s, int code);
2614 __owur int dtls1_buffer_message(SSL *s, int ccs);
2615 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2616 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2617 int dtls1_retransmit_buffered_messages(SSL *s);
2618 void dtls1_clear_received_buffer(SSL *s);
2619 void dtls1_clear_sent_buffer(SSL *s);
2620 void dtls1_get_message_header(unsigned char *data,
2621 struct hm_header_st *msg_hdr);
2622 __owur long dtls1_default_timeout(void);
2623 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2624 __owur int dtls1_check_timeout_num(SSL *s);
2625 __owur int dtls1_handle_timeout(SSL *s);
2626 void dtls1_start_timer(SSL *s);
2627 void dtls1_stop_timer(SSL *s);
2628 __owur int dtls1_is_timer_expired(SSL *s);
2629 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2630 size_t cookie_len);
2631 __owur size_t dtls1_min_mtu(SSL *s);
2632 void dtls1_hm_fragment_free(hm_fragment *frag);
2633 __owur int dtls1_query_mtu(SSL *s);
2634
2635 __owur int tls1_new(SSL *s);
2636 void tls1_free(SSL *s);
2637 int tls1_clear(SSL *s);
2638
2639 __owur int dtls1_new(SSL *s);
2640 void dtls1_free(SSL *s);
2641 int dtls1_clear(SSL *s);
2642 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2643 __owur int dtls1_shutdown(SSL *s);
2644
2645 __owur int dtls1_dispatch_alert(SSL *s);
2646
2647 __owur int ssl_init_wbio_buffer(SSL *s);
2648 int ssl_free_wbio_buffer(SSL *s);
2649
2650 __owur int tls1_change_cipher_state(SSL *s, int which);
2651 __owur int tls1_setup_key_block(SSL *s);
2652 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2653 unsigned char *p);
2654 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2655 unsigned char *p, size_t len,
2656 size_t *secret_size);
2657 __owur int tls13_setup_key_block(SSL *s);
2658 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2659 unsigned char *p);
2660 __owur int tls13_change_cipher_state(SSL *s, int which);
2661 __owur int tls13_update_key(SSL *s, int send);
2662 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2663 const unsigned char *secret,
2664 const unsigned char *label, size_t labellen,
2665 const unsigned char *data, size_t datalen,
2666 unsigned char *out, size_t outlen, int fatal);
2667 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2668 const unsigned char *secret, unsigned char *key,
2669 size_t keylen);
2670 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2671 const unsigned char *secret, unsigned char *iv,
2672 size_t ivlen);
2673 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2674 const unsigned char *secret,
2675 unsigned char *fin, size_t finlen);
2676 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2677 const unsigned char *prevsecret,
2678 const unsigned char *insecret,
2679 size_t insecretlen,
2680 unsigned char *outsecret);
2681 __owur int tls13_generate_handshake_secret(SSL *s,
2682 const unsigned char *insecret,
2683 size_t insecretlen);
2684 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2685 unsigned char *prev, size_t prevlen,
2686 size_t *secret_size);
2687 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2688 const char *label, size_t llen,
2689 const unsigned char *p, size_t plen,
2690 int use_context);
2691 __owur int tls13_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2692 const char *label, size_t llen,
2693 const unsigned char *context,
2694 size_t contextlen, int use_context);
2695 __owur int tls13_export_keying_material_early(SSL *s, unsigned char *out,
2696 size_t olen, const char *label,
2697 size_t llen,
2698 const unsigned char *context,
2699 size_t contextlen);
2700 __owur int tls1_alert_code(int code);
2701 __owur int tls13_alert_code(int code);
2702 __owur int ssl3_alert_code(int code);
2703
2704 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2705
2706 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2707
2708 __owur const TLS_GROUP_INFO *tls1_group_id_lookup(SSL_CTX *ctx, uint16_t curve_id);
2709 __owur int tls1_group_id2nid(uint16_t group_id, int include_unknown);
2710 __owur uint16_t tls1_nid2group_id(int nid);
2711 __owur int tls1_check_group_id(SSL *s, uint16_t group_id, int check_own_curves);
2712 __owur uint16_t tls1_shared_group(SSL *s, int nmatch);
2713 __owur int tls1_set_groups(uint16_t **pext, size_t *pextlen,
2714 int *curves, size_t ncurves);
2715 __owur int tls1_set_groups_list(SSL_CTX *ctx, uint16_t **pext, size_t *pextlen,
2716 const char *str);
2717 __owur EVP_PKEY *ssl_generate_pkey_group(SSL *s, uint16_t id);
2718 __owur int tls_valid_group(SSL *s, uint16_t group_id, int minversion,
2719 int maxversion, int isec, int *okfortls13);
2720 __owur EVP_PKEY *ssl_generate_param_group(SSL *s, uint16_t id);
2721 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2722 size_t *num_formats);
2723 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2724
2725 __owur int tls_group_allowed(SSL *s, uint16_t curve, int op);
2726 void tls1_get_supported_groups(SSL *s, const uint16_t **pgroups,
2727 size_t *pgroupslen);
2728
2729 __owur int tls1_set_server_sigalgs(SSL *s);
2730
2731 __owur SSL_TICKET_STATUS tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2732 SSL_SESSION **ret);
2733 __owur SSL_TICKET_STATUS tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2734 size_t eticklen,
2735 const unsigned char *sess_id,
2736 size_t sesslen, SSL_SESSION **psess);
2737
2738 __owur int tls_use_ticket(SSL *s);
2739
2740 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2741
2742 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2743 __owur int tls1_set_raw_sigalgs(CERT *c, const uint16_t *psigs, size_t salglen,
2744 int client);
2745 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2746 int client);
2747 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2748 int idx);
2749 void tls1_set_cert_validity(SSL *s);
2750
2751 # ifndef OPENSSL_NO_CT
2752 __owur int ssl_validate_ct(SSL *s);
2753 # endif
2754
2755 __owur EVP_PKEY *ssl_get_auto_dh(SSL *s);
2756
2757 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2758 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2759 int vfy);
2760
2761 int tls_choose_sigalg(SSL *s, int fatalerrs);
2762
2763 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2764 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2765 __owur long ssl_get_algorithm2(SSL *s);
2766 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2767 const uint16_t *psig, size_t psiglen);
2768 __owur int tls1_save_u16(PACKET *pkt, uint16_t **pdest, size_t *pdestlen);
2769 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt, int cert);
2770 __owur int tls1_process_sigalgs(SSL *s);
2771 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2772 __owur int tls1_lookup_md(SSL_CTX *ctx, const SIGALG_LOOKUP *lu,
2773 const EVP_MD **pmd);
2774 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2775 __owur int tls_check_sigalg_curve(const SSL *s, int curve);
2776 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2777 __owur int ssl_set_client_disabled(SSL *s);
2778 __owur int ssl_cipher_disabled(const SSL *s, const SSL_CIPHER *c, int op, int echde);
2779
2780 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2781 size_t *hashlen);
2782 __owur const EVP_MD *ssl_md(SSL_CTX *ctx, int idx);
2783 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2784 __owur const EVP_MD *ssl_prf_md(SSL *s);
2785
2786 /*
2787 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2788 * with |ssl|, if logging is enabled. It returns one on success and zero on
2789 * failure. The entry is identified by the first 8 bytes of
2790 * |encrypted_premaster|.
2791 */
2792 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2793 const uint8_t *encrypted_premaster,
2794 size_t encrypted_premaster_len,
2795 const uint8_t *premaster,
2796 size_t premaster_len);
2797
2798 /*
2799 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2800 * logging is available. It returns one on success and zero on failure. It tags
2801 * the entry with |label|.
2802 */
2803 __owur int ssl_log_secret(SSL *ssl, const char *label,
2804 const uint8_t *secret, size_t secret_len);
2805
2806 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2807 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2808 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2809 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2810 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2811 #define CLIENT_APPLICATION_N_LABEL "CLIENT_TRAFFIC_SECRET_N"
2812 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2813 #define SERVER_APPLICATION_N_LABEL "SERVER_TRAFFIC_SECRET_N"
2814 #define EARLY_EXPORTER_SECRET_LABEL "EARLY_EXPORTER_SECRET"
2815 #define EXPORTER_SECRET_LABEL "EXPORTER_SECRET"
2816
2817 # ifndef OPENSSL_NO_KTLS
2818 /* ktls.c */
2819 int ktls_check_supported_cipher(const SSL *s, const EVP_CIPHER *c,
2820 const EVP_CIPHER_CTX *dd);
2821 int ktls_configure_crypto(const SSL *s, const EVP_CIPHER *c, EVP_CIPHER_CTX *dd,
2822 void *rl_sequence, ktls_crypto_info_t *crypto_info,
2823 unsigned char **rec_seq, unsigned char *iv,
2824 unsigned char *key, unsigned char *mac_key,
2825 size_t mac_secret_size);
2826 # endif
2827
2828 /* s3_cbc.c */
2829 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2830 __owur int ssl3_cbc_digest_record(const EVP_MD *md,
2831 unsigned char *md_out,
2832 size_t *md_out_size,
2833 const unsigned char *header,
2834 const unsigned char *data,
2835 size_t data_size,
2836 size_t data_plus_mac_plus_padding_size,
2837 const unsigned char *mac_secret,
2838 size_t mac_secret_length, char is_sslv3);
2839
2840 __owur int srp_generate_server_master_secret(SSL *s);
2841 __owur int srp_generate_client_master_secret(SSL *s);
2842 __owur int srp_verify_server_param(SSL *s);
2843
2844 /* statem/statem_srvr.c */
2845
2846 __owur int send_certificate_request(SSL *s);
2847
2848 /* statem/extensions_cust.c */
2849
2850 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2851 ENDPOINT role, unsigned int ext_type,
2852 size_t *idx);
2853
2854 void custom_ext_init(custom_ext_methods *meths);
2855
2856 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2857 const unsigned char *ext_data, size_t ext_size,
2858 X509 *x, size_t chainidx);
2859 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2860 size_t chainidx, int maxversion);
2861
2862 __owur int custom_exts_copy(custom_ext_methods *dst,
2863 const custom_ext_methods *src);
2864 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2865 const custom_ext_methods *src);
2866 void custom_exts_free(custom_ext_methods *exts);
2867
2868 void ssl_comp_free_compression_methods_int(void);
2869
2870 #ifndef OPENSSL_NO_QUIC
2871 __owur int SSL_clear_not_quic(SSL *s);
2872 __owur int SSL_clear_quic(SSL *s);
2873 #endif
2874
2875 /* ssl_mcnf.c */
2876 void ssl_ctx_system_config(SSL_CTX *ctx);
2877
2878 const EVP_CIPHER *ssl_evp_cipher_fetch(OSSL_LIB_CTX *libctx,
2879 int nid,
2880 const char *properties);
2881 int ssl_evp_cipher_up_ref(const EVP_CIPHER *cipher);
2882 void ssl_evp_cipher_free(const EVP_CIPHER *cipher);
2883 const EVP_MD *ssl_evp_md_fetch(OSSL_LIB_CTX *libctx,
2884 int nid,
2885 const char *properties);
2886 int ssl_evp_md_up_ref(const EVP_MD *md);
2887 void ssl_evp_md_free(const EVP_MD *md);
2888
2889 int tls_provider_set_tls_params(SSL *s, EVP_CIPHER_CTX *ctx,
2890 const EVP_CIPHER *ciph,
2891 const EVP_MD *md);
2892
2893 void tls_engine_finish(ENGINE *e);
2894 const EVP_CIPHER *tls_get_cipher_from_engine(int nid);
2895 const EVP_MD *tls_get_digest_from_engine(int nid);
2896 int tls_engine_load_ssl_client_cert(SSL *s, X509 **px509, EVP_PKEY **ppkey);
2897 int ssl_hmac_old_new(SSL_HMAC *ret);
2898 void ssl_hmac_old_free(SSL_HMAC *ctx);
2899 int ssl_hmac_old_init(SSL_HMAC *ctx, void *key, size_t len, char *md);
2900 int ssl_hmac_old_update(SSL_HMAC *ctx, const unsigned char *data, size_t len);
2901 int ssl_hmac_old_final(SSL_HMAC *ctx, unsigned char *md, size_t *len);
2902 size_t ssl_hmac_old_size(const SSL_HMAC *ctx);
2903
2904 int ssl_ctx_srp_ctx_free_intern(SSL_CTX *ctx);
2905 int ssl_ctx_srp_ctx_init_intern(SSL_CTX *ctx);
2906 int ssl_srp_ctx_free_intern(SSL *s);
2907 int ssl_srp_ctx_init_intern(SSL *s);
2908
2909 int ssl_srp_calc_a_param_intern(SSL *s);
2910 int ssl_srp_server_param_with_username_intern(SSL *s, int *ad);
2911
2912 void ssl_session_calculate_timeout(SSL_SESSION* ss);
2913
2914 # else /* OPENSSL_UNIT_TEST */
2915
2916 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2917 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2918
2919 # endif
2920
2921 /* Some helper routines to support TSAN operations safely */
ssl_tsan_lock(const SSL_CTX * ctx)2922 static ossl_unused ossl_inline int ssl_tsan_lock(const SSL_CTX *ctx)
2923 {
2924 #ifdef TSAN_REQUIRES_LOCKING
2925 if (!CRYPTO_THREAD_write_lock(ctx->tsan_lock))
2926 return 0;
2927 #endif
2928 return 1;
2929 }
2930
ssl_tsan_unlock(const SSL_CTX * ctx)2931 static ossl_unused ossl_inline void ssl_tsan_unlock(const SSL_CTX *ctx)
2932 {
2933 #ifdef TSAN_REQUIRES_LOCKING
2934 CRYPTO_THREAD_unlock(ctx->tsan_lock);
2935 #endif
2936 }
2937
ssl_tsan_counter(const SSL_CTX * ctx,TSAN_QUALIFIER int * stat)2938 static ossl_unused ossl_inline void ssl_tsan_counter(const SSL_CTX *ctx,
2939 TSAN_QUALIFIER int *stat)
2940 {
2941 if (ssl_tsan_lock(ctx)) {
2942 tsan_counter(stat);
2943 ssl_tsan_unlock(ctx);
2944 }
2945 }
2946
2947 #endif
2948