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