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