]> git.ipfire.org Git - thirdparty/openssl.git/blob - ssl/ssl_locl.h
Add TLSv1.3 server side external PSK support
[thirdparty/openssl.git] / ssl / ssl_locl.h
1 /*
2 * Copyright 1995-2016 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 OpenSSL license (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
10 */
11
12 #ifndef HEADER_SSL_LOCL_H
13 # define HEADER_SSL_LOCL_H
14 # include <stdlib.h>
15 # include <time.h>
16 # include <string.h>
17 # include <errno.h>
18
19 # include "e_os.h"
20 # if defined(__unix) || defined(__unix__)
21 # include <sys/time.h> /* struct timeval for DTLS */
22 # endif
23
24 # include <openssl/buffer.h>
25 # include <openssl/comp.h>
26 # include <openssl/bio.h>
27 # include <openssl/stack.h>
28 # include <openssl/rsa.h>
29 # include <openssl/dsa.h>
30 # include <openssl/err.h>
31 # include <openssl/ssl.h>
32 # include <openssl/async.h>
33 # include <openssl/symhacks.h>
34 # include <openssl/ct.h>
35 # include "record/record.h"
36 # include "statem/statem.h"
37 # include "packet_locl.h"
38 # include "internal/dane.h"
39 # include "internal/refcount.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 /*
137 * DTLS version numbers are strange because they're inverted. Except for
138 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
139 */
140 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
141 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
142 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
143 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
144 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
145
146
147 /*
148 * Define the Bitmasks for SSL_CIPHER.algorithms.
149 * This bits are used packed as dense as possible. If new methods/ciphers
150 * etc will be added, the bits a likely to change, so this information
151 * is for internal library use only, even though SSL_CIPHER.algorithms
152 * can be publicly accessed.
153 * Use the according functions for cipher management instead.
154 *
155 * The bit mask handling in the selection and sorting scheme in
156 * ssl_create_cipher_list() has only limited capabilities, reflecting
157 * that the different entities within are mutually exclusive:
158 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
159 */
160
161 /* Bits for algorithm_mkey (key exchange algorithm) */
162 /* RSA key exchange */
163 # define SSL_kRSA 0x00000001U
164 /* tmp DH key no DH cert */
165 # define SSL_kDHE 0x00000002U
166 /* synonym */
167 # define SSL_kEDH SSL_kDHE
168 /* ephemeral ECDH */
169 # define SSL_kECDHE 0x00000004U
170 /* synonym */
171 # define SSL_kEECDH SSL_kECDHE
172 /* PSK */
173 # define SSL_kPSK 0x00000008U
174 /* GOST key exchange */
175 # define SSL_kGOST 0x00000010U
176 /* SRP */
177 # define SSL_kSRP 0x00000020U
178
179 # define SSL_kRSAPSK 0x00000040U
180 # define SSL_kECDHEPSK 0x00000080U
181 # define SSL_kDHEPSK 0x00000100U
182
183 /* all PSK */
184
185 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
186
187 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
188 # define SSL_kANY 0x00000000U
189
190 /* Bits for algorithm_auth (server authentication) */
191 /* RSA auth */
192 # define SSL_aRSA 0x00000001U
193 /* DSS auth */
194 # define SSL_aDSS 0x00000002U
195 /* no auth (i.e. use ADH or AECDH) */
196 # define SSL_aNULL 0x00000004U
197 /* ECDSA auth*/
198 # define SSL_aECDSA 0x00000008U
199 /* PSK auth */
200 # define SSL_aPSK 0x00000010U
201 /* GOST R 34.10-2001 signature auth */
202 # define SSL_aGOST01 0x00000020U
203 /* SRP auth */
204 # define SSL_aSRP 0x00000040U
205 /* GOST R 34.10-2012 signature auth */
206 # define SSL_aGOST12 0x00000080U
207 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
208 # define SSL_aANY 0x00000000U
209
210 /* Bits for algorithm_enc (symmetric encryption) */
211 # define SSL_DES 0x00000001U
212 # define SSL_3DES 0x00000002U
213 # define SSL_RC4 0x00000004U
214 # define SSL_RC2 0x00000008U
215 # define SSL_IDEA 0x00000010U
216 # define SSL_eNULL 0x00000020U
217 # define SSL_AES128 0x00000040U
218 # define SSL_AES256 0x00000080U
219 # define SSL_CAMELLIA128 0x00000100U
220 # define SSL_CAMELLIA256 0x00000200U
221 # define SSL_eGOST2814789CNT 0x00000400U
222 # define SSL_SEED 0x00000800U
223 # define SSL_AES128GCM 0x00001000U
224 # define SSL_AES256GCM 0x00002000U
225 # define SSL_AES128CCM 0x00004000U
226 # define SSL_AES256CCM 0x00008000U
227 # define SSL_AES128CCM8 0x00010000U
228 # define SSL_AES256CCM8 0x00020000U
229 # define SSL_eGOST2814789CNT12 0x00040000U
230 # define SSL_CHACHA20POLY1305 0x00080000U
231
232 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
233 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
234 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
235 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
236 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
237
238 /* Bits for algorithm_mac (symmetric authentication) */
239
240 # define SSL_MD5 0x00000001U
241 # define SSL_SHA1 0x00000002U
242 # define SSL_GOST94 0x00000004U
243 # define SSL_GOST89MAC 0x00000008U
244 # define SSL_SHA256 0x00000010U
245 # define SSL_SHA384 0x00000020U
246 /* Not a real MAC, just an indication it is part of cipher */
247 # define SSL_AEAD 0x00000040U
248 # define SSL_GOST12_256 0x00000080U
249 # define SSL_GOST89MAC12 0x00000100U
250 # define SSL_GOST12_512 0x00000200U
251
252 /*
253 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
254 * sure to update this constant too
255 */
256
257 # define SSL_MD_MD5_IDX 0
258 # define SSL_MD_SHA1_IDX 1
259 # define SSL_MD_GOST94_IDX 2
260 # define SSL_MD_GOST89MAC_IDX 3
261 # define SSL_MD_SHA256_IDX 4
262 # define SSL_MD_SHA384_IDX 5
263 # define SSL_MD_GOST12_256_IDX 6
264 # define SSL_MD_GOST89MAC12_IDX 7
265 # define SSL_MD_GOST12_512_IDX 8
266 # define SSL_MD_MD5_SHA1_IDX 9
267 # define SSL_MD_SHA224_IDX 10
268 # define SSL_MD_SHA512_IDX 11
269 # define SSL_MAX_DIGEST 12
270
271 /* Bits for algorithm2 (handshake digests and other extra flags) */
272
273 /* Bits 0-7 are handshake MAC */
274 # define SSL_HANDSHAKE_MAC_MASK 0xFF
275 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
276 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
277 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
278 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
279 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
280 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
281 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
282
283 /* Bits 8-15 bits are PRF */
284 # define TLS1_PRF_DGST_SHIFT 8
285 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
286 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
287 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
288 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
289 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
290 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
291 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
292
293 /*
294 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
295 * goes into algorithm2)
296 */
297 # define TLS1_STREAM_MAC 0x10000
298
299 # define SSL_STRONG_MASK 0x0000001FU
300 # define SSL_DEFAULT_MASK 0X00000020U
301
302 # define SSL_STRONG_NONE 0x00000001U
303 # define SSL_LOW 0x00000002U
304 # define SSL_MEDIUM 0x00000004U
305 # define SSL_HIGH 0x00000008U
306 # define SSL_FIPS 0x00000010U
307 # define SSL_NOT_DEFAULT 0x00000020U
308
309 /* we have used 0000003f - 26 bits left to go */
310
311 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
312 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
313
314 /* Check if an SSL structure is using DTLS */
315 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
316
317 /* Check if we are using TLSv1.3 */
318 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
319 && (s)->method->version >= TLS1_3_VERSION \
320 && (s)->method->version != TLS_ANY_VERSION)
321
322 # define SSL_TREAT_AS_TLS13(s) \
323 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
324 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY)
325
326 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
327
328 /* See if we need explicit IV */
329 # define SSL_USE_EXPLICIT_IV(s) \
330 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
331 /*
332 * See if we use signature algorithms extension and signature algorithm
333 * before signatures.
334 */
335 # define SSL_USE_SIGALGS(s) \
336 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
337 /*
338 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
339 * apply to others in future.
340 */
341 # define SSL_USE_TLS1_2_CIPHERS(s) \
342 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
343 /*
344 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
345 * flags because it may not be set to correct version yet.
346 */
347 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
348 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
349 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
350 /*
351 * Determine if a client should send signature algorithms extension:
352 * as with TLS1.2 cipher we can't rely on method flags.
353 */
354 # define SSL_CLIENT_USE_SIGALGS(s) \
355 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
356
357 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
358 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
359
360 /* Mostly for SSLv3 */
361 # define SSL_PKEY_RSA 0
362 # define SSL_PKEY_DSA_SIGN 1
363 # define SSL_PKEY_ECC 2
364 # define SSL_PKEY_GOST01 3
365 # define SSL_PKEY_GOST12_256 4
366 # define SSL_PKEY_GOST12_512 5
367 # define SSL_PKEY_ED25519 6
368 # define SSL_PKEY_NUM 7
369 /*
370 * Pseudo-constant. GOST cipher suites can use different certs for 1
371 * SSL_CIPHER. So let's see which one we have in fact.
372 */
373 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
374
375 /*
376 * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
377 */
378
379 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
380
381 /*-
382 * SSL_kRSA <- RSA_ENC
383 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
384 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
385 * SSL_aRSA <- RSA_ENC | RSA_SIGN
386 * SSL_aDSS <- DSA_SIGN
387 */
388
389 /*-
390 #define CERT_INVALID 0
391 #define CERT_PUBLIC_KEY 1
392 #define CERT_PRIVATE_KEY 2
393 */
394
395 /* CipherSuite length. SSLv3 and all TLS versions. */
396 # define TLS_CIPHER_LEN 2
397 /* used to hold info on the particular ciphers used */
398 struct ssl_cipher_st {
399 uint32_t valid;
400 const char *name; /* text name */
401 uint32_t id; /* id, 4 bytes, first is version */
402 /*
403 * changed in 1.0.0: these four used to be portions of a single value
404 * 'algorithms'
405 */
406 uint32_t algorithm_mkey; /* key exchange algorithm */
407 uint32_t algorithm_auth; /* server authentication */
408 uint32_t algorithm_enc; /* symmetric encryption */
409 uint32_t algorithm_mac; /* symmetric authentication */
410 int min_tls; /* minimum SSL/TLS protocol version */
411 int max_tls; /* maximum SSL/TLS protocol version */
412 int min_dtls; /* minimum DTLS protocol version */
413 int max_dtls; /* maximum DTLS protocol version */
414 uint32_t algo_strength; /* strength and export flags */
415 uint32_t algorithm2; /* Extra flags */
416 int32_t strength_bits; /* Number of bits really used */
417 uint32_t alg_bits; /* Number of bits for algorithm */
418 };
419
420 /* Used to hold SSL/TLS functions */
421 struct ssl_method_st {
422 int version;
423 unsigned flags;
424 unsigned long mask;
425 int (*ssl_new) (SSL *s);
426 int (*ssl_clear) (SSL *s);
427 void (*ssl_free) (SSL *s);
428 int (*ssl_accept) (SSL *s);
429 int (*ssl_connect) (SSL *s);
430 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
431 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
432 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
433 int (*ssl_shutdown) (SSL *s);
434 int (*ssl_renegotiate) (SSL *s);
435 int (*ssl_renegotiate_check) (SSL *s, int);
436 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
437 unsigned char *buf, size_t len, int peek,
438 size_t *readbytes);
439 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
440 size_t *written);
441 int (*ssl_dispatch_alert) (SSL *s);
442 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
443 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
444 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
445 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
446 size_t *len);
447 size_t (*ssl_pending) (const SSL *s);
448 int (*num_ciphers) (void);
449 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
450 long (*get_timeout) (void);
451 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
452 int (*ssl_version) (void);
453 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
454 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
455 };
456
457 /*-
458 * Lets make this into an ASN.1 type structure as follows
459 * SSL_SESSION_ID ::= SEQUENCE {
460 * version INTEGER, -- structure version number
461 * SSLversion INTEGER, -- SSL version number
462 * Cipher OCTET STRING, -- the 3 byte cipher ID
463 * Session_ID OCTET STRING, -- the Session ID
464 * Master_key OCTET STRING, -- the master key
465 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
466 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
467 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
468 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
469 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
470 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
471 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
472 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
473 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
474 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
475 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
476 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
477 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
478 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
479 * }
480 * Look in ssl/ssl_asn1.c for more details
481 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
482 */
483 struct ssl_session_st {
484 int ssl_version; /* what ssl version session info is being kept
485 * in here? */
486 size_t master_key_length;
487
488 /*
489 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
490 * master secret
491 */
492 unsigned char master_key[TLS13_MAX_RESUMPTION_MASTER_LENGTH];
493 /* session_id - valid? */
494 size_t session_id_length;
495 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
496 /*
497 * this is used to determine whether the session is being reused in the
498 * appropriate context. It is up to the application to set this, via
499 * SSL_new
500 */
501 size_t sid_ctx_length;
502 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
503 # ifndef OPENSSL_NO_PSK
504 char *psk_identity_hint;
505 char *psk_identity;
506 # endif
507 /*
508 * Used to indicate that session resumption is not allowed. Applications
509 * can also set this bit for a new session via not_resumable_session_cb
510 * to disable session caching and tickets.
511 */
512 int not_resumable;
513 /* This is the cert and type for the other end. */
514 X509 *peer;
515 int peer_type;
516 /* Certificate chain peer sent. */
517 STACK_OF(X509) *peer_chain;
518 /*
519 * when app_verify_callback accepts a session where the peer's
520 * certificate is not ok, we must remember the error for session reuse:
521 */
522 long verify_result; /* only for servers */
523 CRYPTO_REF_COUNT references;
524 long timeout;
525 long time;
526 unsigned int compress_meth; /* Need to lookup the method */
527 const SSL_CIPHER *cipher;
528 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
529 * load the 'cipher' structure */
530 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
531 CRYPTO_EX_DATA ex_data; /* application specific data */
532 /*
533 * These are used to make removal of session-ids more efficient and to
534 * implement a maximum cache size.
535 */
536 struct ssl_session_st *prev, *next;
537
538 struct {
539 char *hostname;
540 # ifndef OPENSSL_NO_EC
541 size_t ecpointformats_len;
542 unsigned char *ecpointformats; /* peer's list */
543 size_t supportedgroups_len;
544 unsigned char *supportedgroups; /* peer's list */
545 # endif /* OPENSSL_NO_EC */
546 /* RFC4507 info */
547 unsigned char *tick; /* Session ticket */
548 size_t ticklen; /* Session ticket length */
549 /* Session lifetime hint in seconds */
550 unsigned long tick_lifetime_hint;
551 uint32_t tick_age_add;
552 int tick_identity;
553 /* Max number of bytes that can be sent as early data */
554 uint32_t max_early_data;
555 /* The ALPN protocol selected for this session */
556 unsigned char *alpn_selected;
557 size_t alpn_selected_len;
558 } ext;
559 # ifndef OPENSSL_NO_SRP
560 char *srp_username;
561 # endif
562 uint32_t flags;
563 CRYPTO_RWLOCK *lock;
564 };
565
566 /* Extended master secret support */
567 # define SSL_SESS_FLAG_EXTMS 0x1
568
569 # ifndef OPENSSL_NO_SRP
570
571 typedef struct srp_ctx_st {
572 /* param for all the callbacks */
573 void *SRP_cb_arg;
574 /* set client Hello login callback */
575 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
576 /* set SRP N/g param callback for verification */
577 int (*SRP_verify_param_callback) (SSL *, void *);
578 /* set SRP client passwd callback */
579 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
580 char *login;
581 BIGNUM *N, *g, *s, *B, *A;
582 BIGNUM *a, *b, *v;
583 char *info;
584 int strength;
585 unsigned long srp_Mask;
586 } SRP_CTX;
587
588 # endif
589
590 typedef enum {
591 SSL_EARLY_DATA_NONE = 0,
592 SSL_EARLY_DATA_CONNECT_RETRY,
593 SSL_EARLY_DATA_CONNECTING,
594 SSL_EARLY_DATA_WRITE_RETRY,
595 SSL_EARLY_DATA_WRITING,
596 SSL_EARLY_DATA_UNAUTH_WRITING,
597 SSL_EARLY_DATA_FINISHED_WRITING,
598 SSL_EARLY_DATA_ACCEPT_RETRY,
599 SSL_EARLY_DATA_ACCEPTING,
600 SSL_EARLY_DATA_READ_RETRY,
601 SSL_EARLY_DATA_READING,
602 SSL_EARLY_DATA_FINISHED_READING
603 } SSL_EARLY_DATA_STATE;
604
605 /*
606 * We check that the amount of unreadable early data doesn't exceed
607 * max_early_data. max_early_data is given in plaintext bytes. However if it is
608 * unreadable then we only know the number of ciphertext bytes. We also don't
609 * know how much the overhead should be because it depends on the ciphersuite.
610 * We make a small allowance. We assume 5 records of actual data plus the end
611 * of early data alert record. Each record has a tag and a content type byte.
612 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
613 * content of the alert record either which is 2 bytes.
614 */
615 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
616
617 /*
618 * The allowance we have between the client's calculated ticket age and our own.
619 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
620 * client's age calculation is different by more than this than our own then we
621 * do not allow that ticket for early_data.
622 */
623 # define TICKET_AGE_ALLOWANCE (10 * 1000)
624
625 #define MAX_COMPRESSIONS_SIZE 255
626
627 struct ssl_comp_st {
628 int id;
629 const char *name;
630 COMP_METHOD *method;
631 };
632
633 typedef struct raw_extension_st {
634 /* Raw packet data for the extension */
635 PACKET data;
636 /* Set to 1 if the extension is present or 0 otherwise */
637 int present;
638 /* Set to 1 if we have already parsed the extension or 0 otherwise */
639 int parsed;
640 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
641 unsigned int type;
642 /* Track what order extensions are received in (0-based). */
643 size_t received_order;
644 } RAW_EXTENSION;
645
646 typedef struct {
647 unsigned int isv2;
648 unsigned int legacy_version;
649 unsigned char random[SSL3_RANDOM_SIZE];
650 size_t session_id_len;
651 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
652 size_t dtls_cookie_len;
653 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
654 PACKET ciphersuites;
655 size_t compressions_len;
656 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
657 PACKET extensions;
658 size_t pre_proc_exts_len;
659 RAW_EXTENSION *pre_proc_exts;
660 } CLIENTHELLO_MSG;
661
662 /*
663 * Extension index values NOTE: Any updates to these defines should be mirrored
664 * with equivalent updates to ext_defs in extensions.c
665 */
666 typedef enum tlsext_index_en {
667 TLSEXT_IDX_renegotiate,
668 TLSEXT_IDX_server_name,
669 TLSEXT_IDX_srp,
670 TLSEXT_IDX_ec_point_formats,
671 TLSEXT_IDX_supported_groups,
672 TLSEXT_IDX_session_ticket,
673 TLSEXT_IDX_signature_algorithms,
674 TLSEXT_IDX_status_request,
675 TLSEXT_IDX_next_proto_neg,
676 TLSEXT_IDX_application_layer_protocol_negotiation,
677 TLSEXT_IDX_use_srtp,
678 TLSEXT_IDX_encrypt_then_mac,
679 TLSEXT_IDX_signed_certificate_timestamp,
680 TLSEXT_IDX_extended_master_secret,
681 TLSEXT_IDX_supported_versions,
682 TLSEXT_IDX_psk_kex_modes,
683 TLSEXT_IDX_key_share,
684 TLSEXT_IDX_cookie,
685 TLSEXT_IDX_cryptopro_bug,
686 TLSEXT_IDX_early_data,
687 TLSEXT_IDX_certificate_authorities,
688 TLSEXT_IDX_padding,
689 TLSEXT_IDX_psk,
690 /* Dummy index - must always be the last entry */
691 TLSEXT_IDX_num_builtins
692 } TLSEXT_INDEX;
693
694 DEFINE_LHASH_OF(SSL_SESSION);
695 /* Needed in ssl_cert.c */
696 DEFINE_LHASH_OF(X509_NAME);
697
698 # define TLSEXT_KEYNAME_LENGTH 16
699
700 struct ssl_ctx_st {
701 const SSL_METHOD *method;
702 STACK_OF(SSL_CIPHER) *cipher_list;
703 /* same as above but sorted for lookup */
704 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
705 struct x509_store_st /* X509_STORE */ *cert_store;
706 LHASH_OF(SSL_SESSION) *sessions;
707 /*
708 * Most session-ids that will be cached, default is
709 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
710 */
711 size_t session_cache_size;
712 struct ssl_session_st *session_cache_head;
713 struct ssl_session_st *session_cache_tail;
714 /*
715 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
716 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
717 * means only SSL_accept which cache SSL_SESSIONS.
718 */
719 uint32_t session_cache_mode;
720 /*
721 * If timeout is not 0, it is the default timeout value set when
722 * SSL_new() is called. This has been put in to make life easier to set
723 * things up
724 */
725 long session_timeout;
726 /*
727 * If this callback is not null, it will be called each time a session id
728 * is added to the cache. If this function returns 1, it means that the
729 * callback will do a SSL_SESSION_free() when it has finished using it.
730 * Otherwise, on 0, it means the callback has finished with it. If
731 * remove_session_cb is not null, it will be called when a session-id is
732 * removed from the cache. After the call, OpenSSL will
733 * SSL_SESSION_free() it.
734 */
735 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
736 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
737 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
738 const unsigned char *data, int len,
739 int *copy);
740 struct {
741 int sess_connect; /* SSL new conn - started */
742 int sess_connect_renegotiate; /* SSL reneg - requested */
743 int sess_connect_good; /* SSL new conne/reneg - finished */
744 int sess_accept; /* SSL new accept - started */
745 int sess_accept_renegotiate; /* SSL reneg - requested */
746 int sess_accept_good; /* SSL accept/reneg - finished */
747 int sess_miss; /* session lookup misses */
748 int sess_timeout; /* reuse attempt on timeouted session */
749 int sess_cache_full; /* session removed due to full cache */
750 int sess_hit; /* session reuse actually done */
751 int sess_cb_hit; /* session-id that was not in the cache was
752 * passed back via the callback. This
753 * indicates that the application is supplying
754 * session-id's from other processes - spooky
755 * :-) */
756 } stats;
757
758 CRYPTO_REF_COUNT references;
759
760 /* if defined, these override the X509_verify_cert() calls */
761 int (*app_verify_callback) (X509_STORE_CTX *, void *);
762 void *app_verify_arg;
763 /*
764 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
765 * ('app_verify_callback' was called with just one argument)
766 */
767
768 /* Default password callback. */
769 pem_password_cb *default_passwd_callback;
770
771 /* Default password callback user data. */
772 void *default_passwd_callback_userdata;
773
774 /* get client cert callback */
775 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
776
777 /* cookie generate callback */
778 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
779 unsigned int *cookie_len);
780
781 /* verify cookie callback */
782 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
783 unsigned int cookie_len);
784
785 CRYPTO_EX_DATA ex_data;
786
787 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
788 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
789
790 STACK_OF(X509) *extra_certs;
791 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
792
793 /* Default values used when no per-SSL value is defined follow */
794
795 /* used if SSL's info_callback is NULL */
796 void (*info_callback) (const SSL *ssl, int type, int val);
797
798 /*
799 * What we put in certificate_authorities extension for TLS 1.3
800 * (ClientHello and CertificateRequest) or just client cert requests for
801 * earlier versions.
802 */
803 STACK_OF(X509_NAME) *ca_names;
804
805 /*
806 * Default values to use in SSL structures follow (these are copied by
807 * SSL_new)
808 */
809
810 uint32_t options;
811 uint32_t mode;
812 int min_proto_version;
813 int max_proto_version;
814 size_t max_cert_list;
815
816 struct cert_st /* CERT */ *cert;
817 int read_ahead;
818
819 /* callback that allows applications to peek at protocol messages */
820 void (*msg_callback) (int write_p, int version, int content_type,
821 const void *buf, size_t len, SSL *ssl, void *arg);
822 void *msg_callback_arg;
823
824 uint32_t verify_mode;
825 size_t sid_ctx_length;
826 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
827 /* called 'verify_callback' in the SSL */
828 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
829
830 /* Default generate session ID callback. */
831 GEN_SESSION_CB generate_session_id;
832
833 X509_VERIFY_PARAM *param;
834
835 int quiet_shutdown;
836
837 # ifndef OPENSSL_NO_CT
838 CTLOG_STORE *ctlog_store; /* CT Log Store */
839 /*
840 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
841 * If they are not, the connection should be aborted.
842 */
843 ssl_ct_validation_cb ct_validation_callback;
844 void *ct_validation_callback_arg;
845 # endif
846
847 /*
848 * If we're using more than one pipeline how should we divide the data
849 * up between the pipes?
850 */
851 size_t split_send_fragment;
852 /*
853 * Maximum amount of data to send in one fragment. actual record size can
854 * be more than this due to padding and MAC overheads.
855 */
856 size_t max_send_fragment;
857
858 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
859 size_t max_pipelines;
860
861 /* The default read buffer length to use (0 means not set) */
862 size_t default_read_buf_len;
863
864 # ifndef OPENSSL_NO_ENGINE
865 /*
866 * Engine to pass requests for client certs to
867 */
868 ENGINE *client_cert_engine;
869 # endif
870
871 /* Early callback. Mostly for extensions, but not entirely. */
872 SSL_early_cb_fn early_cb;
873 void *early_cb_arg;
874
875 /* TLS extensions. */
876 struct {
877 /* TLS extensions servername callback */
878 int (*servername_cb) (SSL *, int *, void *);
879 void *servername_arg;
880 /* RFC 4507 session ticket keys */
881 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
882 unsigned char tick_hmac_key[32];
883 unsigned char tick_aes_key[32];
884 /* Callback to support customisation of ticket key setting */
885 int (*ticket_key_cb) (SSL *ssl,
886 unsigned char *name, unsigned char *iv,
887 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
888
889 /* certificate status request info */
890 /* Callback for status request */
891 int (*status_cb) (SSL *ssl, void *arg);
892 void *status_arg;
893 /* ext status type used for CSR extension (OCSP Stapling) */
894 int status_type;
895
896 # ifndef OPENSSL_NO_EC
897 /* EC extension values inherited by SSL structure */
898 size_t ecpointformats_len;
899 unsigned char *ecpointformats;
900 size_t supportedgroups_len;
901 unsigned char *supportedgroups;
902 # endif /* OPENSSL_NO_EC */
903
904 /*
905 * ALPN information (we are in the process of transitioning from NPN to
906 * ALPN.)
907 */
908
909 /*-
910 * For a server, this contains a callback function that allows the
911 * server to select the protocol for the connection.
912 * out: on successful return, this must point to the raw protocol
913 * name (without the length prefix).
914 * outlen: on successful return, this contains the length of |*out|.
915 * in: points to the client's list of supported protocols in
916 * wire-format.
917 * inlen: the length of |in|.
918 */
919 int (*alpn_select_cb) (SSL *s,
920 const unsigned char **out,
921 unsigned char *outlen,
922 const unsigned char *in,
923 unsigned int inlen, void *arg);
924 void *alpn_select_cb_arg;
925
926 /*
927 * For a client, this contains the list of supported protocols in wire
928 * format.
929 */
930 unsigned char *alpn;
931 size_t alpn_len;
932
933 # ifndef OPENSSL_NO_NEXTPROTONEG
934 /* Next protocol negotiation information */
935
936 /*
937 * For a server, this contains a callback function by which the set of
938 * advertised protocols can be provided.
939 */
940 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
941 void *npn_advertised_cb_arg;
942 /*
943 * For a client, this contains a callback function that selects the next
944 * protocol from the list provided by the server.
945 */
946 SSL_CTX_npn_select_cb_func npn_select_cb;
947 void *npn_select_cb_arg;
948 # endif
949 } ext;
950
951 # ifndef OPENSSL_NO_PSK
952 SSL_psk_client_cb_func psk_client_callback;
953 SSL_psk_server_cb_func psk_server_callback;
954 # endif
955 SSL_psk_find_session_cb_func psk_find_session_cb;
956
957 # ifndef OPENSSL_NO_SRP
958 SRP_CTX srp_ctx; /* ctx for SRP authentication */
959 # endif
960
961 /* Shared DANE context */
962 struct dane_ctx_st dane;
963
964 /* SRTP profiles we are willing to do from RFC 5764 */
965 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
966 /*
967 * Callback for disabling session caching and ticket support on a session
968 * basis, depending on the chosen cipher.
969 */
970 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
971
972 CRYPTO_RWLOCK *lock;
973
974 /*
975 * Callback for logging key material for use with debugging tools like
976 * Wireshark. The callback should log `line` followed by a newline.
977 */
978 SSL_CTX_keylog_cb_func keylog_callback;
979
980 /* The maximum number of bytes that can be sent as early data */
981 uint32_t max_early_data;
982
983 /* TLS1.3 padding callback */
984 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
985 void *record_padding_arg;
986 size_t block_padding;
987 };
988
989 struct ssl_st {
990 /*
991 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
992 * DTLS1_VERSION)
993 */
994 int version;
995 /* SSLv3 */
996 const SSL_METHOD *method;
997 /*
998 * There are 2 BIO's even though they are normally both the same. This
999 * is so data can be read and written to different handlers
1000 */
1001 /* used by SSL_read */
1002 BIO *rbio;
1003 /* used by SSL_write */
1004 BIO *wbio;
1005 /* used during session-id reuse to concatenate messages */
1006 BIO *bbio;
1007 /*
1008 * This holds a variable that indicates what we were doing when a 0 or -1
1009 * is returned. This is needed for non-blocking IO so we know what
1010 * request needs re-doing when in SSL_accept or SSL_connect
1011 */
1012 int rwstate;
1013 int (*handshake_func) (SSL *);
1014 /*
1015 * Imagine that here's a boolean member "init" that is switched as soon
1016 * as SSL_set_{accept/connect}_state is called for the first time, so
1017 * that "state" and "handshake_func" are properly initialized. But as
1018 * handshake_func is == 0 until then, we use this test instead of an
1019 * "init" member.
1020 */
1021 /* are we the server side? */
1022 int server;
1023 /*
1024 * Generate a new session or reuse an old one.
1025 * NB: For servers, the 'new' session may actually be a previously
1026 * cached session or even the previous session unless
1027 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1028 */
1029 int new_session;
1030 /* don't send shutdown packets */
1031 int quiet_shutdown;
1032 /* we have shut things down, 0x01 sent, 0x02 for received */
1033 int shutdown;
1034 /* where we are */
1035 OSSL_STATEM statem;
1036 SSL_EARLY_DATA_STATE early_data_state;
1037 BUF_MEM *init_buf; /* buffer used during init */
1038 void *init_msg; /* pointer to handshake message body, set by
1039 * ssl3_get_message() */
1040 size_t init_num; /* amount read/written */
1041 size_t init_off; /* amount read/written */
1042 struct ssl3_state_st *s3; /* SSLv3 variables */
1043 struct dtls1_state_st *d1; /* DTLSv1 variables */
1044 /* callback that allows applications to peek at protocol messages */
1045 void (*msg_callback) (int write_p, int version, int content_type,
1046 const void *buf, size_t len, SSL *ssl, void *arg);
1047 void *msg_callback_arg;
1048 int hit; /* reusing a previous session */
1049 X509_VERIFY_PARAM *param;
1050 /* Per connection DANE state */
1051 SSL_DANE dane;
1052 /* crypto */
1053 STACK_OF(SSL_CIPHER) *cipher_list;
1054 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1055 /*
1056 * These are the ones being used, the ones in SSL_SESSION are the ones to
1057 * be 'copied' into these ones
1058 */
1059 uint32_t mac_flags;
1060 /*
1061 * The TLS1.3 secrets. The resumption master secret is stored in the
1062 * session.
1063 */
1064 unsigned char early_secret[EVP_MAX_MD_SIZE];
1065 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1066 unsigned char master_secret[EVP_MAX_MD_SIZE];
1067 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1068 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1069 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1070 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1071 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1072 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1073 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1074 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1075 EVP_MD_CTX *read_hash; /* used for mac generation */
1076 COMP_CTX *compress; /* compression */
1077 COMP_CTX *expand; /* uncompress */
1078 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1079 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1080 EVP_MD_CTX *write_hash; /* used for mac generation */
1081 /* Count of how many KeyUpdate messages we have received */
1082 unsigned int key_update_count;
1083 /* session info */
1084 /* client cert? */
1085 /* This is used to hold the server certificate used */
1086 struct cert_st /* CERT */ *cert;
1087
1088 /*
1089 * The hash of all messages prior to the CertificateVerify, and the length
1090 * of that hash.
1091 */
1092 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1093 size_t cert_verify_hash_len;
1094
1095 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1096 int hello_retry_request;
1097
1098 /*
1099 * the session_id_context is used to ensure sessions are only reused in
1100 * the appropriate context
1101 */
1102 size_t sid_ctx_length;
1103 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1104 /* This can also be in the session once a session is established */
1105 SSL_SESSION *session;
1106 /* Default generate session ID callback. */
1107 GEN_SESSION_CB generate_session_id;
1108 /* Used in SSL3 */
1109 /*
1110 * 0 don't care about verify failure.
1111 * 1 fail if verify fails
1112 */
1113 uint32_t verify_mode;
1114 /* fail if callback returns 0 */
1115 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1116 /* optional informational callback */
1117 void (*info_callback) (const SSL *ssl, int type, int val);
1118 /* error bytes to be written */
1119 int error;
1120 /* actual code */
1121 int error_code;
1122 # ifndef OPENSSL_NO_PSK
1123 SSL_psk_client_cb_func psk_client_callback;
1124 SSL_psk_server_cb_func psk_server_callback;
1125 # endif
1126 SSL_psk_find_session_cb_func psk_find_session_cb;
1127 SSL_CTX *ctx;
1128 /* Verified chain of peer */
1129 STACK_OF(X509) *verified_chain;
1130 long verify_result;
1131 /* extra application data */
1132 CRYPTO_EX_DATA ex_data;
1133 /* for server side, keep the list of CA_dn we can use */
1134 STACK_OF(X509_NAME) *ca_names;
1135 CRYPTO_REF_COUNT references;
1136 /* protocol behaviour */
1137 uint32_t options;
1138 /* API behaviour */
1139 uint32_t mode;
1140 int min_proto_version;
1141 int max_proto_version;
1142 size_t max_cert_list;
1143 int first_packet;
1144 /*
1145 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1146 * secret and SSLv3/TLS (<=1.2) rollback check
1147 */
1148 int client_version;
1149 /*
1150 * If we're using more than one pipeline how should we divide the data
1151 * up between the pipes?
1152 */
1153 size_t split_send_fragment;
1154 /*
1155 * Maximum amount of data to send in one fragment. actual record size can
1156 * be more than this due to padding and MAC overheads.
1157 */
1158 size_t max_send_fragment;
1159 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1160 size_t max_pipelines;
1161
1162 struct {
1163 /* Built-in extension flags */
1164 uint8_t extflags[TLSEXT_IDX_num_builtins];
1165 /* TLS extension debug callback */
1166 void (*debug_cb)(SSL *s, int client_server, int type,
1167 const unsigned char *data, int len, void *arg);
1168 void *debug_arg;
1169 char *hostname;
1170 /* certificate status request info */
1171 /* Status type or -1 if no status type */
1172 int status_type;
1173 /* Raw extension data, if seen */
1174 unsigned char *scts;
1175 /* Length of raw extension data, if seen */
1176 uint16_t scts_len;
1177 /* Expect OCSP CertificateStatus message */
1178 int status_expected;
1179
1180 struct {
1181 /* OCSP status request only */
1182 STACK_OF(OCSP_RESPID) *ids;
1183 X509_EXTENSIONS *exts;
1184 /* OCSP response received or to be sent */
1185 unsigned char *resp;
1186 size_t resp_len;
1187 } ocsp;
1188
1189 /* RFC4507 session ticket expected to be received or sent */
1190 int ticket_expected;
1191 # ifndef OPENSSL_NO_EC
1192 size_t ecpointformats_len;
1193 /* our list */
1194 unsigned char *ecpointformats;
1195 size_t supportedgroups_len;
1196 /* our list */
1197 unsigned char *supportedgroups;
1198 # endif /* OPENSSL_NO_EC */
1199 /* TLS Session Ticket extension override */
1200 TLS_SESSION_TICKET_EXT *session_ticket;
1201 /* TLS Session Ticket extension callback */
1202 tls_session_ticket_ext_cb_fn session_ticket_cb;
1203 void *session_ticket_cb_arg;
1204 /* TLS pre-shared secret session resumption */
1205 tls_session_secret_cb_fn session_secret_cb;
1206 void *session_secret_cb_arg;
1207 /*
1208 * For a client, this contains the list of supported protocols in wire
1209 * format.
1210 */
1211 unsigned char *alpn;
1212 size_t alpn_len;
1213 /*
1214 * Next protocol negotiation. For the client, this is the protocol that
1215 * we sent in NextProtocol and is set when handling ServerHello
1216 * extensions. For a server, this is the client's selected_protocol from
1217 * NextProtocol and is set when handling the NextProtocol message, before
1218 * the Finished message.
1219 */
1220 unsigned char *npn;
1221 size_t npn_len;
1222
1223 /* The available PSK key exchange modes */
1224 int psk_kex_mode;
1225
1226 /* Set to one if we have negotiated ETM */
1227 int use_etm;
1228
1229 /* Are we expecting to receive early data? */
1230 int early_data;
1231 /* Is the session suitable for early data? */
1232 int early_data_ok;
1233
1234 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1235 unsigned char *tls13_cookie;
1236 size_t tls13_cookie_len;
1237 } ext;
1238
1239 /* Parsed form of the ClientHello, kept around across early_cb calls. */
1240 CLIENTHELLO_MSG *clienthello;
1241
1242 /*-
1243 * no further mod of servername
1244 * 0 : call the servername extension callback.
1245 * 1 : prepare 2, allow last ack just after in server callback.
1246 * 2 : don't call servername callback, no ack in server hello
1247 */
1248 int servername_done;
1249 # ifndef OPENSSL_NO_CT
1250 /*
1251 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1252 * If they are not, the connection should be aborted.
1253 */
1254 ssl_ct_validation_cb ct_validation_callback;
1255 /* User-supplied argument that is passed to the ct_validation_callback */
1256 void *ct_validation_callback_arg;
1257 /*
1258 * Consolidated stack of SCTs from all sources.
1259 * Lazily populated by CT_get_peer_scts(SSL*)
1260 */
1261 STACK_OF(SCT) *scts;
1262 /* Have we attempted to find/parse SCTs yet? */
1263 int scts_parsed;
1264 # endif
1265 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1266 /* What we'll do */
1267 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1268 /* What's been chosen */
1269 SRTP_PROTECTION_PROFILE *srtp_profile;
1270 /*-
1271 * 1 if we are renegotiating.
1272 * 2 if we are a server and are inside a handshake
1273 * (i.e. not just sending a HelloRequest)
1274 */
1275 int renegotiate;
1276 /* If sending a KeyUpdate is pending */
1277 int key_update;
1278 # ifndef OPENSSL_NO_SRP
1279 /* ctx for SRP authentication */
1280 SRP_CTX srp_ctx;
1281 # endif
1282 /*
1283 * Callback for disabling session caching and ticket support on a session
1284 * basis, depending on the chosen cipher.
1285 */
1286 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1287 RECORD_LAYER rlayer;
1288 /* Default password callback. */
1289 pem_password_cb *default_passwd_callback;
1290 /* Default password callback user data. */
1291 void *default_passwd_callback_userdata;
1292 /* Async Job info */
1293 ASYNC_JOB *job;
1294 ASYNC_WAIT_CTX *waitctx;
1295 size_t asyncrw;
1296
1297 /* The maximum number of plaintext bytes that can be sent as early data */
1298 uint32_t max_early_data;
1299 /*
1300 * The number of bytes of early data received so far. If we accepted early
1301 * data then this is a count of the plaintext bytes. If we rejected it then
1302 * this is a count of the ciphertext bytes.
1303 */
1304 uint32_t early_data_count;
1305
1306 /* TLS1.3 padding callback */
1307 size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1308 void *record_padding_arg;
1309 size_t block_padding;
1310
1311 CRYPTO_RWLOCK *lock;
1312 };
1313
1314 /*
1315 * Structure containing table entry of values associated with the signature
1316 * algorithms (signature scheme) extension
1317 */
1318 typedef struct sigalg_lookup_st {
1319 /* TLS 1.3 signature scheme name */
1320 const char *name;
1321 /* Raw value used in extension */
1322 uint16_t sigalg;
1323 /* NID of hash algorithm or NID_undef if no hash */
1324 int hash;
1325 /* Index of hash algorithm or -1 if no hash algorithm */
1326 int hash_idx;
1327 /* NID of signature algorithm */
1328 int sig;
1329 /* Index of signature algorithm */
1330 int sig_idx;
1331 /* Combined hash and signature NID, if any */
1332 int sigandhash;
1333 /* Required public key curve (ECDSA only) */
1334 int curve;
1335 } SIGALG_LOOKUP;
1336
1337 typedef struct cert_pkey_st CERT_PKEY;
1338
1339 typedef struct ssl3_state_st {
1340 long flags;
1341 size_t read_mac_secret_size;
1342 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1343 size_t write_mac_secret_size;
1344 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1345 unsigned char server_random[SSL3_RANDOM_SIZE];
1346 unsigned char client_random[SSL3_RANDOM_SIZE];
1347 /* flags for countermeasure against known-IV weakness */
1348 int need_empty_fragments;
1349 int empty_fragment_done;
1350 /* used during startup, digest all incoming/outgoing packets */
1351 BIO *handshake_buffer;
1352 /*
1353 * When handshake digest is determined, buffer is hashed and
1354 * freed and MD_CTX for the required digest is stored here.
1355 */
1356 EVP_MD_CTX *handshake_dgst;
1357 /*
1358 * Set whenever an expected ChangeCipherSpec message is processed.
1359 * Unset when the peer's Finished message is received.
1360 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1361 */
1362 int change_cipher_spec;
1363 int warn_alert;
1364 int fatal_alert;
1365 /*
1366 * we allow one fatal and one warning alert to be outstanding, send close
1367 * alert via the warning alert
1368 */
1369 int alert_dispatch;
1370 unsigned char send_alert[2];
1371 /*
1372 * This flag is set when we should renegotiate ASAP, basically when there
1373 * is no more data in the read or write buffers
1374 */
1375 int renegotiate;
1376 int total_renegotiations;
1377 int num_renegotiations;
1378 int in_read_app_data;
1379 struct {
1380 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1381 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1382 size_t finish_md_len;
1383 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1384 size_t peer_finish_md_len;
1385 size_t message_size;
1386 int message_type;
1387 /* used to hold the new cipher we are going to use */
1388 const SSL_CIPHER *new_cipher;
1389 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1390 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1391 # endif
1392 /* used for certificate requests */
1393 int cert_req;
1394 /* Certificate types in certificate request message. */
1395 uint8_t *ctype;
1396 size_t ctype_len;
1397 /* Certificate authorities list peer sent */
1398 STACK_OF(X509_NAME) *peer_ca_names;
1399 size_t key_block_length;
1400 unsigned char *key_block;
1401 const EVP_CIPHER *new_sym_enc;
1402 const EVP_MD *new_hash;
1403 int new_mac_pkey_type;
1404 size_t new_mac_secret_size;
1405 # ifndef OPENSSL_NO_COMP
1406 const SSL_COMP *new_compression;
1407 # else
1408 char *new_compression;
1409 # endif
1410 int cert_request;
1411 /* Raw values of the cipher list from a client */
1412 unsigned char *ciphers_raw;
1413 size_t ciphers_rawlen;
1414 /* Temporary storage for premaster secret */
1415 unsigned char *pms;
1416 size_t pmslen;
1417 # ifndef OPENSSL_NO_PSK
1418 /* Temporary storage for PSK key */
1419 unsigned char *psk;
1420 size_t psklen;
1421 # endif
1422 /* Signature algorithm we actually use */
1423 const SIGALG_LOOKUP *sigalg;
1424 /* Pointer to certificate we use */
1425 CERT_PKEY *cert;
1426 /*
1427 * signature algorithms peer reports: e.g. supported signature
1428 * algorithms extension for server or as part of a certificate
1429 * request for client.
1430 */
1431 uint16_t *peer_sigalgs;
1432 /* Size of above array */
1433 size_t peer_sigalgslen;
1434 /* Sigalg peer actualy uses */
1435 const SIGALG_LOOKUP *peer_sigalg;
1436 /*
1437 * Set if corresponding CERT_PKEY can be used with current
1438 * SSL session: e.g. appropriate curve, signature algorithms etc.
1439 * If zero it can't be used at all.
1440 */
1441 uint32_t valid_flags[SSL_PKEY_NUM];
1442 /*
1443 * For servers the following masks are for the key and auth algorithms
1444 * that are supported by the certs below. For clients they are masks of
1445 * *disabled* algorithms based on the current session.
1446 */
1447 uint32_t mask_k;
1448 uint32_t mask_a;
1449 /*
1450 * The following are used by the client to see if a cipher is allowed or
1451 * not. It contains the minimum and maximum version the client's using
1452 * based on what it knows so far.
1453 */
1454 int min_ver;
1455 int max_ver;
1456 } tmp;
1457
1458 /* Connection binding to prevent renegotiation attacks */
1459 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1460 size_t previous_client_finished_len;
1461 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1462 size_t previous_server_finished_len;
1463 int send_connection_binding; /* TODOEKR */
1464
1465 # ifndef OPENSSL_NO_NEXTPROTONEG
1466 /*
1467 * Set if we saw the Next Protocol Negotiation extension from our peer.
1468 */
1469 int npn_seen;
1470 # endif
1471
1472 /*
1473 * ALPN information (we are in the process of transitioning from NPN to
1474 * ALPN.)
1475 */
1476
1477 /*
1478 * In a server these point to the selected ALPN protocol after the
1479 * ClientHello has been processed. In a client these contain the protocol
1480 * that the server selected once the ServerHello has been processed.
1481 */
1482 unsigned char *alpn_selected;
1483 size_t alpn_selected_len;
1484 /* used by the server to know what options were proposed */
1485 unsigned char *alpn_proposed;
1486 size_t alpn_proposed_len;
1487 /* used by the client to know if it actually sent alpn */
1488 int alpn_sent;
1489
1490 # ifndef OPENSSL_NO_EC
1491 /*
1492 * This is set to true if we believe that this is a version of Safari
1493 * running on OS X 10.6 or newer. We wish to know this because Safari on
1494 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1495 */
1496 char is_probably_safari;
1497 # endif /* !OPENSSL_NO_EC */
1498
1499 /* For clients: peer temporary key */
1500 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1501 /* The group_id for the DH/ECDH key */
1502 unsigned int group_id;
1503 EVP_PKEY *peer_tmp;
1504 # endif
1505
1506 } SSL3_STATE;
1507
1508 /* DTLS structures */
1509
1510 # ifndef OPENSSL_NO_SCTP
1511 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1512 # endif
1513
1514 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1515 # define DTLS1_MAX_MTU_OVERHEAD 48
1516
1517 /*
1518 * Flag used in message reuse to indicate the buffer contains the record
1519 * header as well as the the handshake message header.
1520 */
1521 # define DTLS1_SKIP_RECORD_HEADER 2
1522
1523 struct dtls1_retransmit_state {
1524 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1525 EVP_MD_CTX *write_hash; /* used for mac generation */
1526 COMP_CTX *compress; /* compression */
1527 SSL_SESSION *session;
1528 unsigned short epoch;
1529 };
1530
1531 struct hm_header_st {
1532 unsigned char type;
1533 size_t msg_len;
1534 unsigned short seq;
1535 size_t frag_off;
1536 size_t frag_len;
1537 unsigned int is_ccs;
1538 struct dtls1_retransmit_state saved_retransmit_state;
1539 };
1540
1541 struct dtls1_timeout_st {
1542 /* Number of read timeouts so far */
1543 unsigned int read_timeouts;
1544 /* Number of write timeouts so far */
1545 unsigned int write_timeouts;
1546 /* Number of alerts received so far */
1547 unsigned int num_alerts;
1548 };
1549
1550 typedef struct hm_fragment_st {
1551 struct hm_header_st msg_header;
1552 unsigned char *fragment;
1553 unsigned char *reassembly;
1554 } hm_fragment;
1555
1556 typedef struct pqueue_st pqueue;
1557 typedef struct pitem_st pitem;
1558
1559 struct pitem_st {
1560 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1561 void *data;
1562 pitem *next;
1563 };
1564
1565 typedef struct pitem_st *piterator;
1566
1567 pitem *pitem_new(unsigned char *prio64be, void *data);
1568 void pitem_free(pitem *item);
1569 pqueue *pqueue_new(void);
1570 void pqueue_free(pqueue *pq);
1571 pitem *pqueue_insert(pqueue *pq, pitem *item);
1572 pitem *pqueue_peek(pqueue *pq);
1573 pitem *pqueue_pop(pqueue *pq);
1574 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1575 pitem *pqueue_iterator(pqueue *pq);
1576 pitem *pqueue_next(piterator *iter);
1577 size_t pqueue_size(pqueue *pq);
1578
1579 typedef struct dtls1_state_st {
1580 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1581 size_t cookie_len;
1582 unsigned int cookie_verified;
1583 /* handshake message numbers */
1584 unsigned short handshake_write_seq;
1585 unsigned short next_handshake_write_seq;
1586 unsigned short handshake_read_seq;
1587 /* Buffered handshake messages */
1588 pqueue *buffered_messages;
1589 /* Buffered (sent) handshake records */
1590 pqueue *sent_messages;
1591 size_t link_mtu; /* max on-the-wire DTLS packet size */
1592 size_t mtu; /* max DTLS packet size */
1593 struct hm_header_st w_msg_hdr;
1594 struct hm_header_st r_msg_hdr;
1595 struct dtls1_timeout_st timeout;
1596 /*
1597 * Indicates when the last handshake msg sent will timeout
1598 */
1599 struct timeval next_timeout;
1600 /* Timeout duration */
1601 unsigned short timeout_duration;
1602 unsigned int retransmitting;
1603 # ifndef OPENSSL_NO_SCTP
1604 int shutdown_received;
1605 # endif
1606 } DTLS1_STATE;
1607
1608 # ifndef OPENSSL_NO_EC
1609 /*
1610 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1611 */
1612 # define EXPLICIT_PRIME_CURVE_TYPE 1
1613 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1614 # define NAMED_CURVE_TYPE 3
1615 # endif /* OPENSSL_NO_EC */
1616
1617 struct cert_pkey_st {
1618 X509 *x509;
1619 EVP_PKEY *privatekey;
1620 /* Chain for this certificate */
1621 STACK_OF(X509) *chain;
1622 /*-
1623 * serverinfo data for this certificate. The data is in TLS Extension
1624 * wire format, specifically it's a series of records like:
1625 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1626 * uint16_t length;
1627 * uint8_t data[length];
1628 */
1629 unsigned char *serverinfo;
1630 size_t serverinfo_length;
1631 };
1632 /* Retrieve Suite B flags */
1633 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1634 /* Uses to check strict mode: suite B modes are always strict */
1635 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1636 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1637
1638 typedef enum {
1639 ENDPOINT_CLIENT = 0,
1640 ENDPOINT_SERVER,
1641 ENDPOINT_BOTH
1642 } ENDPOINT;
1643
1644
1645 typedef struct {
1646 unsigned short ext_type;
1647 ENDPOINT role;
1648 /* The context which this extension applies to */
1649 unsigned int context;
1650 /*
1651 * Per-connection flags relating to this extension type: not used if
1652 * part of an SSL_CTX structure.
1653 */
1654 uint32_t ext_flags;
1655 SSL_custom_ext_add_cb_ex add_cb;
1656 SSL_custom_ext_free_cb_ex free_cb;
1657 void *add_arg;
1658 SSL_custom_ext_parse_cb_ex parse_cb;
1659 void *parse_arg;
1660 } custom_ext_method;
1661
1662 /* ext_flags values */
1663
1664 /*
1665 * Indicates an extension has been received. Used to check for unsolicited or
1666 * duplicate extensions.
1667 */
1668 # define SSL_EXT_FLAG_RECEIVED 0x1
1669 /*
1670 * Indicates an extension has been sent: used to enable sending of
1671 * corresponding ServerHello extension.
1672 */
1673 # define SSL_EXT_FLAG_SENT 0x2
1674
1675 typedef struct {
1676 custom_ext_method *meths;
1677 size_t meths_count;
1678 } custom_ext_methods;
1679
1680 typedef struct cert_st {
1681 /* Current active set */
1682 /*
1683 * ALWAYS points to an element of the pkeys array
1684 * Probably it would make more sense to store
1685 * an index, not a pointer.
1686 */
1687 CERT_PKEY *key;
1688 # ifndef OPENSSL_NO_DH
1689 EVP_PKEY *dh_tmp;
1690 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1691 int dh_tmp_auto;
1692 # endif
1693 /* Flags related to certificates */
1694 uint32_t cert_flags;
1695 CERT_PKEY pkeys[SSL_PKEY_NUM];
1696 /* Custom certificate types sent in certificate request message. */
1697 uint8_t *ctype;
1698 size_t ctype_len;
1699 /*
1700 * supported signature algorithms. When set on a client this is sent in
1701 * the client hello as the supported signature algorithms extension. For
1702 * servers it represents the signature algorithms we are willing to use.
1703 */
1704 uint16_t *conf_sigalgs;
1705 /* Size of above array */
1706 size_t conf_sigalgslen;
1707 /*
1708 * Client authentication signature algorithms, if not set then uses
1709 * conf_sigalgs. On servers these will be the signature algorithms sent
1710 * to the client in a certificate request for TLS 1.2. On a client this
1711 * represents the signature algorithms we are willing to use for client
1712 * authentication.
1713 */
1714 uint16_t *client_sigalgs;
1715 /* Size of above array */
1716 size_t client_sigalgslen;
1717 /*
1718 * Signature algorithms shared by client and server: cached because these
1719 * are used most often.
1720 */
1721 const SIGALG_LOOKUP **shared_sigalgs;
1722 size_t shared_sigalgslen;
1723 /*
1724 * Certificate setup callback: if set is called whenever a certificate
1725 * may be required (client or server). the callback can then examine any
1726 * appropriate parameters and setup any certificates required. This
1727 * allows advanced applications to select certificates on the fly: for
1728 * example based on supported signature algorithms or curves.
1729 */
1730 int (*cert_cb) (SSL *ssl, void *arg);
1731 void *cert_cb_arg;
1732 /*
1733 * Optional X509_STORE for chain building or certificate validation If
1734 * NULL the parent SSL_CTX store is used instead.
1735 */
1736 X509_STORE *chain_store;
1737 X509_STORE *verify_store;
1738 /* Custom extensions */
1739 custom_ext_methods custext;
1740 /* Security callback */
1741 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1742 void *other, void *ex);
1743 /* Security level */
1744 int sec_level;
1745 void *sec_ex;
1746 # ifndef OPENSSL_NO_PSK
1747 /* If not NULL psk identity hint to use for servers */
1748 char *psk_identity_hint;
1749 # endif
1750 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1751 CRYPTO_RWLOCK *lock;
1752 } CERT;
1753
1754 # define FP_ICC (int (*)(const void *,const void *))
1755
1756 /*
1757 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1758 * of a mess of functions, but hell, think of it as an opaque structure :-)
1759 */
1760 typedef struct ssl3_enc_method {
1761 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1762 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1763 int (*setup_key_block) (SSL *);
1764 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1765 size_t, size_t *);
1766 int (*change_cipher_state) (SSL *, int);
1767 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1768 const char *client_finished_label;
1769 size_t client_finished_label_len;
1770 const char *server_finished_label;
1771 size_t server_finished_label_len;
1772 int (*alert_value) (int);
1773 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1774 const char *, size_t,
1775 const unsigned char *, size_t,
1776 int use_context);
1777 /* Various flags indicating protocol version requirements */
1778 uint32_t enc_flags;
1779 /* Set the handshake header */
1780 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1781 /* Close construction of the handshake message */
1782 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1783 /* Write out handshake message */
1784 int (*do_write) (SSL *s);
1785 } SSL3_ENC_METHOD;
1786
1787 # define ssl_set_handshake_header(s, pkt, htype) \
1788 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1789 # define ssl_close_construct_packet(s, pkt, htype) \
1790 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1791 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1792
1793 /* Values for enc_flags */
1794
1795 /* Uses explicit IV for CBC mode */
1796 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1797 /* Uses signature algorithms extension */
1798 # define SSL_ENC_FLAG_SIGALGS 0x2
1799 /* Uses SHA256 default PRF */
1800 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1801 /* Is DTLS */
1802 # define SSL_ENC_FLAG_DTLS 0x8
1803 /*
1804 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1805 * apply to others in future.
1806 */
1807 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1808
1809 # ifndef OPENSSL_NO_COMP
1810 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1811 typedef struct ssl3_comp_st {
1812 int comp_id; /* The identifier byte for this compression
1813 * type */
1814 char *name; /* Text name used for the compression type */
1815 COMP_METHOD *method; /* The method :-) */
1816 } SSL3_COMP;
1817 # endif
1818
1819 typedef enum downgrade_en {
1820 DOWNGRADE_NONE,
1821 DOWNGRADE_TO_1_2,
1822 DOWNGRADE_TO_1_1
1823 } DOWNGRADE;
1824
1825 /*
1826 * Dummy status type for the status_type extension. Indicates no status type
1827 * set
1828 */
1829 #define TLSEXT_STATUSTYPE_nothing -1
1830
1831 /* Sigalgs values */
1832 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1833 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1834 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1835 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
1836 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1837 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1838 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1839 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1840 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1841 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1842 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1843 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
1844 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1845 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1846 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1847 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1848 #define TLSEXT_SIGALG_dsa_sha224 0x0302
1849 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1850 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1851 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1852 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1853
1854 #define TLSEXT_SIGALG_ed25519 0x0807
1855
1856 /* Known PSK key exchange modes */
1857 #define TLSEXT_KEX_MODE_KE 0x00
1858 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1859
1860 /*
1861 * Internal representations of key exchange modes
1862 */
1863 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1864 #define TLSEXT_KEX_MODE_FLAG_KE 1
1865 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1866
1867 /* An invalid index into the TLSv1.3 PSK identities */
1868 #define TLSEXT_PSK_BAD_IDENTITY -1
1869
1870 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1871 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1872
1873 /* A dummy signature value not valid for TLSv1.2 signature algs */
1874 #define TLSEXT_signature_rsa_pss 0x0101
1875
1876 /* TLSv1.3 downgrade protection sentinel values */
1877 extern const unsigned char tls11downgrade[8];
1878 extern const unsigned char tls12downgrade[8];
1879
1880 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1881
1882 __owur const SSL_METHOD *ssl_bad_method(int ver);
1883 __owur const SSL_METHOD *sslv3_method(void);
1884 __owur const SSL_METHOD *sslv3_server_method(void);
1885 __owur const SSL_METHOD *sslv3_client_method(void);
1886 __owur const SSL_METHOD *tlsv1_method(void);
1887 __owur const SSL_METHOD *tlsv1_server_method(void);
1888 __owur const SSL_METHOD *tlsv1_client_method(void);
1889 __owur const SSL_METHOD *tlsv1_1_method(void);
1890 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1891 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1892 __owur const SSL_METHOD *tlsv1_2_method(void);
1893 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1894 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1895 __owur const SSL_METHOD *tlsv1_3_method(void);
1896 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1897 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1898 __owur const SSL_METHOD *dtlsv1_method(void);
1899 __owur const SSL_METHOD *dtlsv1_server_method(void);
1900 __owur const SSL_METHOD *dtlsv1_client_method(void);
1901 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1902 __owur const SSL_METHOD *dtlsv1_2_method(void);
1903 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1904 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1905
1906 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1907 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1908 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1909 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1910 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1911 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1912 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1913
1914 /*
1915 * Flags for SSL methods
1916 */
1917 # define SSL_METHOD_NO_FIPS (1U<<0)
1918 # define SSL_METHOD_NO_SUITEB (1U<<1)
1919
1920 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1921 s_connect, enc_data) \
1922 const SSL_METHOD *func_name(void) \
1923 { \
1924 static const SSL_METHOD func_name##_data= { \
1925 version, \
1926 flags, \
1927 mask, \
1928 tls1_new, \
1929 tls1_clear, \
1930 tls1_free, \
1931 s_accept, \
1932 s_connect, \
1933 ssl3_read, \
1934 ssl3_peek, \
1935 ssl3_write, \
1936 ssl3_shutdown, \
1937 ssl3_renegotiate, \
1938 ssl3_renegotiate_check, \
1939 ssl3_read_bytes, \
1940 ssl3_write_bytes, \
1941 ssl3_dispatch_alert, \
1942 ssl3_ctrl, \
1943 ssl3_ctx_ctrl, \
1944 ssl3_get_cipher_by_char, \
1945 ssl3_put_cipher_by_char, \
1946 ssl3_pending, \
1947 ssl3_num_ciphers, \
1948 ssl3_get_cipher, \
1949 tls1_default_timeout, \
1950 &enc_data, \
1951 ssl_undefined_void_function, \
1952 ssl3_callback_ctrl, \
1953 ssl3_ctx_callback_ctrl, \
1954 }; \
1955 return &func_name##_data; \
1956 }
1957
1958 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1959 const SSL_METHOD *func_name(void) \
1960 { \
1961 static const SSL_METHOD func_name##_data= { \
1962 SSL3_VERSION, \
1963 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1964 SSL_OP_NO_SSLv3, \
1965 ssl3_new, \
1966 ssl3_clear, \
1967 ssl3_free, \
1968 s_accept, \
1969 s_connect, \
1970 ssl3_read, \
1971 ssl3_peek, \
1972 ssl3_write, \
1973 ssl3_shutdown, \
1974 ssl3_renegotiate, \
1975 ssl3_renegotiate_check, \
1976 ssl3_read_bytes, \
1977 ssl3_write_bytes, \
1978 ssl3_dispatch_alert, \
1979 ssl3_ctrl, \
1980 ssl3_ctx_ctrl, \
1981 ssl3_get_cipher_by_char, \
1982 ssl3_put_cipher_by_char, \
1983 ssl3_pending, \
1984 ssl3_num_ciphers, \
1985 ssl3_get_cipher, \
1986 ssl3_default_timeout, \
1987 &SSLv3_enc_data, \
1988 ssl_undefined_void_function, \
1989 ssl3_callback_ctrl, \
1990 ssl3_ctx_callback_ctrl, \
1991 }; \
1992 return &func_name##_data; \
1993 }
1994
1995 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1996 s_connect, enc_data) \
1997 const SSL_METHOD *func_name(void) \
1998 { \
1999 static const SSL_METHOD func_name##_data= { \
2000 version, \
2001 flags, \
2002 mask, \
2003 dtls1_new, \
2004 dtls1_clear, \
2005 dtls1_free, \
2006 s_accept, \
2007 s_connect, \
2008 ssl3_read, \
2009 ssl3_peek, \
2010 ssl3_write, \
2011 dtls1_shutdown, \
2012 ssl3_renegotiate, \
2013 ssl3_renegotiate_check, \
2014 dtls1_read_bytes, \
2015 dtls1_write_app_data_bytes, \
2016 dtls1_dispatch_alert, \
2017 dtls1_ctrl, \
2018 ssl3_ctx_ctrl, \
2019 ssl3_get_cipher_by_char, \
2020 ssl3_put_cipher_by_char, \
2021 ssl3_pending, \
2022 ssl3_num_ciphers, \
2023 ssl3_get_cipher, \
2024 dtls1_default_timeout, \
2025 &enc_data, \
2026 ssl_undefined_void_function, \
2027 ssl3_callback_ctrl, \
2028 ssl3_ctx_callback_ctrl, \
2029 }; \
2030 return &func_name##_data; \
2031 }
2032
2033 struct openssl_ssl_test_functions {
2034 int (*p_ssl_init_wbio_buffer) (SSL *s);
2035 int (*p_ssl3_setup_buffers) (SSL *s);
2036 };
2037
2038 const char *ssl_protocol_to_string(int version);
2039
2040 /* Returns true if certificate and private key for 'idx' are present */
2041 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2042 {
2043 if (idx < 0 || idx >= SSL_PKEY_NUM)
2044 return 0;
2045 return s->cert->pkeys[idx].x509 != NULL
2046 && s->cert->pkeys[idx].privatekey != NULL;
2047 }
2048
2049 # ifndef OPENSSL_UNIT_TEST
2050
2051 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2052 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2053 void ssl_clear_cipher_ctx(SSL *s);
2054 int ssl_clear_bad_session(SSL *s);
2055 __owur CERT *ssl_cert_new(void);
2056 __owur CERT *ssl_cert_dup(CERT *cert);
2057 void ssl_cert_clear_certs(CERT *c);
2058 void ssl_cert_free(CERT *c);
2059 __owur int ssl_get_new_session(SSL *s, int session);
2060 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
2061 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2062 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2063 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2064 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2065 const SSL_CIPHER *const *bp);
2066 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2067 STACK_OF(SSL_CIPHER) **pref,
2068 STACK_OF(SSL_CIPHER)
2069 **sorted,
2070 const char *rule_str,
2071 CERT *c);
2072 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites,
2073 int sslv2format, int *al);
2074 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2075 STACK_OF(SSL_CIPHER) **skp,
2076 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2077 int *al);
2078 void ssl_update_cache(SSL *s, int mode);
2079 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2080 const EVP_MD **md, int *mac_pkey_type,
2081 size_t *mac_secret_size, SSL_COMP **comp,
2082 int use_etm);
2083 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2084 size_t *int_overhead, size_t *blocksize,
2085 size_t *ext_overhead);
2086 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2087 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2088 const unsigned char *ptr,
2089 int all);
2090 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2091 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2092 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2093 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2094 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2095 __owur int ssl_cert_set_current(CERT *c, long arg);
2096 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2097 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2098
2099 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2100 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2101 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2102 int ref);
2103
2104 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2105 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2106 void *other);
2107
2108 int ssl_undefined_function(SSL *s);
2109 __owur int ssl_undefined_void_function(void);
2110 __owur int ssl_undefined_const_function(const SSL *s);
2111 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2112 const unsigned char **serverinfo,
2113 size_t *serverinfo_length);
2114 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2115 void ssl_set_masks(SSL *s);
2116 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2117 __owur int ssl_verify_alarm_type(long type);
2118 void ssl_sort_cipher_list(void);
2119 int ssl_load_ciphers(void);
2120 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2121 size_t len, DOWNGRADE dgrd);
2122 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2123 int free_pms);
2124 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2125 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2126 int genmaster);
2127 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2128
2129 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2130 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2131 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2132 size_t *len);
2133 int ssl3_init_finished_mac(SSL *s);
2134 __owur int ssl3_setup_key_block(SSL *s);
2135 __owur int ssl3_change_cipher_state(SSL *s, int which);
2136 void ssl3_cleanup_key_block(SSL *s);
2137 __owur int ssl3_do_write(SSL *s, int type);
2138 int ssl3_send_alert(SSL *s, int level, int desc);
2139 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2140 unsigned char *p, size_t len,
2141 size_t *secret_size);
2142 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2143 __owur int ssl3_num_ciphers(void);
2144 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2145 int ssl3_renegotiate(SSL *ssl);
2146 int ssl3_renegotiate_check(SSL *ssl, int initok);
2147 __owur int ssl3_dispatch_alert(SSL *s);
2148 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2149 unsigned char *p);
2150 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2151 void ssl3_free_digest_list(SSL *s);
2152 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2153 CERT_PKEY *cpk, int *al);
2154 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2155 STACK_OF(SSL_CIPHER) *clnt,
2156 STACK_OF(SSL_CIPHER) *srvr);
2157 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2158 __owur int ssl3_new(SSL *s);
2159 void ssl3_free(SSL *s);
2160 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2161 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2162 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2163 __owur int ssl3_shutdown(SSL *s);
2164 int ssl3_clear(SSL *s);
2165 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2166 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2167 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2168 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2169
2170 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2171 __owur long ssl3_default_timeout(void);
2172
2173 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2174 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2175 __owur int tls_setup_handshake(SSL *s);
2176 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2177 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2178 __owur int ssl3_handshake_write(SSL *s);
2179
2180 __owur int ssl_allow_compression(SSL *s);
2181
2182 __owur int ssl_version_supported(const SSL *s, int version);
2183
2184 __owur int ssl_set_client_hello_version(SSL *s);
2185 __owur int ssl_check_version_downgrade(SSL *s);
2186 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2187 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2188 DOWNGRADE *dgrd);
2189 __owur int ssl_choose_client_version(SSL *s, int version, int checkdgrd,
2190 int *al);
2191 int ssl_get_min_max_version(const SSL *s, int *min_version, int *max_version);
2192
2193 __owur long tls1_default_timeout(void);
2194 __owur int dtls1_do_write(SSL *s, int type);
2195 void dtls1_set_message_header(SSL *s,
2196 unsigned char mt,
2197 size_t len,
2198 size_t frag_off, size_t frag_len);
2199
2200 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2201 size_t *written);
2202
2203 __owur int dtls1_read_failed(SSL *s, int code);
2204 __owur int dtls1_buffer_message(SSL *s, int ccs);
2205 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2206 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2207 int dtls1_retransmit_buffered_messages(SSL *s);
2208 void dtls1_clear_received_buffer(SSL *s);
2209 void dtls1_clear_sent_buffer(SSL *s);
2210 void dtls1_get_message_header(unsigned char *data,
2211 struct hm_header_st *msg_hdr);
2212 __owur long dtls1_default_timeout(void);
2213 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2214 __owur int dtls1_check_timeout_num(SSL *s);
2215 __owur int dtls1_handle_timeout(SSL *s);
2216 void dtls1_start_timer(SSL *s);
2217 void dtls1_stop_timer(SSL *s);
2218 __owur int dtls1_is_timer_expired(SSL *s);
2219 void dtls1_double_timeout(SSL *s);
2220 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2221 size_t cookie_len);
2222 __owur int dtls1_send_newsession_ticket(SSL *s);
2223 __owur size_t dtls1_min_mtu(SSL *s);
2224 void dtls1_hm_fragment_free(hm_fragment *frag);
2225 __owur int dtls1_query_mtu(SSL *s);
2226
2227 __owur int tls1_new(SSL *s);
2228 void tls1_free(SSL *s);
2229 int tls1_clear(SSL *s);
2230 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2231 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2232
2233 __owur int dtls1_new(SSL *s);
2234 void dtls1_free(SSL *s);
2235 int dtls1_clear(SSL *s);
2236 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2237 __owur int dtls1_shutdown(SSL *s);
2238
2239 __owur int dtls1_dispatch_alert(SSL *s);
2240
2241 __owur int ssl_init_wbio_buffer(SSL *s);
2242 int ssl_free_wbio_buffer(SSL *s);
2243
2244 __owur int tls1_change_cipher_state(SSL *s, int which);
2245 __owur int tls1_setup_key_block(SSL *s);
2246 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2247 unsigned char *p);
2248 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2249 unsigned char *p, size_t len,
2250 size_t *secret_size);
2251 __owur int tls13_setup_key_block(SSL *s);
2252 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2253 unsigned char *p);
2254 __owur int tls13_change_cipher_state(SSL *s, int which);
2255 __owur int tls13_update_key(SSL *s, int send);
2256 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2257 const unsigned char *secret,
2258 const unsigned char *label, size_t labellen,
2259 const unsigned char *hash,
2260 unsigned char *out, size_t outlen);
2261 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2262 const unsigned char *secret, unsigned char *key,
2263 size_t keylen);
2264 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2265 const unsigned char *secret, unsigned char *iv,
2266 size_t ivlen);
2267 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2268 const unsigned char *secret,
2269 unsigned char *fin, size_t finlen);
2270 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2271 const unsigned char *prevsecret,
2272 const unsigned char *insecret,
2273 size_t insecretlen,
2274 unsigned char *outsecret);
2275 __owur int tls13_generate_handshake_secret(SSL *s,
2276 const unsigned char *insecret,
2277 size_t insecretlen);
2278 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2279 unsigned char *prev, size_t prevlen,
2280 size_t *secret_size);
2281 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2282 const char *label, size_t llen,
2283 const unsigned char *p, size_t plen,
2284 int use_context);
2285 __owur int tls1_alert_code(int code);
2286 __owur int tls13_alert_code(int code);
2287 __owur int ssl3_alert_code(int code);
2288
2289 # ifndef OPENSSL_NO_EC
2290 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2291 # endif
2292
2293 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2294
2295 # ifndef OPENSSL_NO_EC
2296 /* Flags values from tls1_ec_curve_id2nid() */
2297 /* Mask for curve type */
2298 # define TLS_CURVE_TYPE 0x3
2299 # define TLS_CURVE_PRIME 0x0
2300 # define TLS_CURVE_CHAR2 0x1
2301 # define TLS_CURVE_CUSTOM 0x2
2302
2303 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2304
2305 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2306 __owur int tls1_ec_nid2curve_id(int nid);
2307 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2308 __owur int tls1_shared_group(SSL *s, int nmatch);
2309 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2310 int *curves, size_t ncurves);
2311 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2312 const char *str);
2313 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2314 size_t *num_formats);
2315 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2316 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2317 # endif /* OPENSSL_NO_EC */
2318
2319 __owur int tls1_shared_list(SSL *s,
2320 const unsigned char *l1, size_t l1len,
2321 const unsigned char *l2, size_t l2len, int nmatch);
2322 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2323 __owur int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2324 size_t *num_curves);
2325
2326 void ssl_set_default_md(SSL *s);
2327 __owur int tls1_set_server_sigalgs(SSL *s);
2328
2329 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2330 typedef enum ticket_en {
2331 /* fatal error, malloc failure */
2332 TICKET_FATAL_ERR_MALLOC,
2333 /* fatal error, either from parsing or decrypting the ticket */
2334 TICKET_FATAL_ERR_OTHER,
2335 /* No ticket present */
2336 TICKET_NONE,
2337 /* Empty ticket present */
2338 TICKET_EMPTY,
2339 /* the ticket couldn't be decrypted */
2340 TICKET_NO_DECRYPT,
2341 /* a ticket was successfully decrypted */
2342 TICKET_SUCCESS,
2343 /* same as above but the ticket needs to be reneewed */
2344 TICKET_SUCCESS_RENEW
2345 } TICKET_RETURN;
2346
2347 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2348 SSL_SESSION **ret);
2349 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2350 size_t eticklen,
2351 const unsigned char *sess_id,
2352 size_t sesslen, SSL_SESSION **psess);
2353
2354 __owur int tls_use_ticket(SSL *s);
2355
2356 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2357
2358 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2359 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2360 int client);
2361 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2362 int idx);
2363 void tls1_set_cert_validity(SSL *s);
2364
2365 # ifndef OPENSSL_NO_CT
2366 __owur int ssl_validate_ct(SSL *s);
2367 # endif
2368
2369 # ifndef OPENSSL_NO_DH
2370 __owur DH *ssl_get_auto_dh(SSL *s);
2371 # endif
2372
2373 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2374 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2375 int vfy);
2376
2377 int tls_choose_sigalg(SSL *s, int *al);
2378
2379 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2380 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2381 __owur long ssl_get_algorithm2(SSL *s);
2382 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2383 const uint16_t *psig, size_t psiglen);
2384 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2385 __owur int tls1_process_sigalgs(SSL *s);
2386 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2387 __owur int tls1_lookup_md(const SIGALG_LOOKUP *lu, const EVP_MD **pmd);
2388 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2389 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2390 void ssl_set_client_disabled(SSL *s);
2391 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op, int echde);
2392
2393 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2394 size_t *hashlen);
2395 __owur const EVP_MD *ssl_md(int idx);
2396 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2397 __owur const EVP_MD *ssl_prf_md(SSL *s);
2398
2399 /*
2400 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2401 * with |ssl|, if logging is enabled. It returns one on success and zero on
2402 * failure. The entry is identified by the first 8 bytes of
2403 * |encrypted_premaster|.
2404 */
2405 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2406 const uint8_t *encrypted_premaster,
2407 size_t encrypted_premaster_len,
2408 const uint8_t *premaster,
2409 size_t premaster_len);
2410
2411 /*
2412 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2413 * logging is available. It returns one on success and zero on failure. It tags
2414 * the entry with |label|.
2415 */
2416 __owur int ssl_log_secret(SSL *ssl, const char *label,
2417 const uint8_t *secret, size_t secret_len);
2418
2419 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2420 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2421 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2422 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2423 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2424 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2425
2426 /* s3_cbc.c */
2427 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2428 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2429 unsigned char *md_out,
2430 size_t *md_out_size,
2431 const unsigned char header[13],
2432 const unsigned char *data,
2433 size_t data_plus_mac_size,
2434 size_t data_plus_mac_plus_padding_size,
2435 const unsigned char *mac_secret,
2436 size_t mac_secret_length, char is_sslv3);
2437
2438 __owur int srp_generate_server_master_secret(SSL *s);
2439 __owur int srp_generate_client_master_secret(SSL *s);
2440 __owur int srp_verify_server_param(SSL *s, int *al);
2441
2442 /* statem/extensions_cust.c */
2443
2444 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2445 ENDPOINT role, unsigned int ext_type,
2446 size_t *idx);
2447
2448 void custom_ext_init(custom_ext_methods *meths);
2449
2450 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2451 const unsigned char *ext_data, size_t ext_size,
2452 X509 *x, size_t chainidx, int *al);
2453 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2454 size_t chainidx, int maxversion, int *al);
2455
2456 __owur int custom_exts_copy(custom_ext_methods *dst,
2457 const custom_ext_methods *src);
2458 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2459 const custom_ext_methods *src);
2460 void custom_exts_free(custom_ext_methods *exts);
2461
2462 void ssl_comp_free_compression_methods_int(void);
2463
2464 # else /* OPENSSL_UNIT_TEST */
2465
2466 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2467 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2468
2469 # endif
2470 #endif