2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
42 #ifndef HEADER_SSL_LOCL_H
43 # define HEADER_SSL_LOCL_H
50 # if defined(__unix) || defined(__unix__)
51 # include <sys/time.h> /* struct timeval for DTLS */
54 # include <openssl/buffer.h>
55 # include <openssl/comp.h>
56 # include <openssl/bio.h>
57 # include <openssl/stack.h>
58 # include <openssl/rsa.h>
59 # include <openssl/dsa.h>
60 # include <openssl/err.h>
61 # include <openssl/ssl.h>
62 # include <openssl/async.h>
63 # include <openssl/symhacks.h>
64 # include <openssl/ct.h>
65 # include "record/record.h"
66 # include "statem/statem.h"
67 # include "packet_locl.h"
68 # include "internal/dane.h"
69 # include "internal/refcount.h"
71 # ifdef OPENSSL_BUILD_SHLIBSSL
72 # undef OPENSSL_EXTERN
73 # define OPENSSL_EXTERN OPENSSL_EXPORT
76 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
77 l|=(((unsigned long)(*((c)++)))<< 8), \
78 l|=(((unsigned long)(*((c)++)))<<16), \
79 l|=(((unsigned long)(*((c)++)))<<24))
81 /* NOTE - c is not incremented as per c2l */
82 # define c2ln(c,l1,l2,n) { \
86 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
87 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
88 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
89 case 5: l2|=((unsigned long)(*(--(c)))); \
90 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
91 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
92 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
93 case 1: l1|=((unsigned long)(*(--(c)))); \
97 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
98 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
99 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>24)&0xff))
102 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
103 l|=((unsigned long)(*((c)++)))<<16, \
104 l|=((unsigned long)(*((c)++)))<< 8, \
105 l|=((unsigned long)(*((c)++))))
107 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
108 l|=((uint64_t)(*((c)++)))<<48, \
109 l|=((uint64_t)(*((c)++)))<<40, \
110 l|=((uint64_t)(*((c)++)))<<32, \
111 l|=((uint64_t)(*((c)++)))<<24, \
112 l|=((uint64_t)(*((c)++)))<<16, \
113 l|=((uint64_t)(*((c)++)))<< 8, \
114 l|=((uint64_t)(*((c)++))))
117 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
118 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
119 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
120 *((c)++)=(unsigned char)(((l) )&0xff))
122 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
123 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
124 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
125 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
126 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
127 *((c)++)=(unsigned char)(((l) )&0xff))
129 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
130 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
131 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
132 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
133 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
134 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
135 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
136 *((c)++)=(unsigned char)(((l) )&0xff))
138 /* NOTE - c is not incremented as per l2c */
139 # define l2cn(l1,l2,c,n) { \
142 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
143 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
144 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
145 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
146 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
147 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
148 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
149 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
153 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
154 (((unsigned int)((c)[1])) )),(c)+=2)
155 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
156 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
158 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
159 (((unsigned long)((c)[1]))<< 8)| \
160 (((unsigned long)((c)[2])) )),(c)+=3)
162 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
163 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
164 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
167 * DTLS version numbers are strange because they're inverted. Except for
168 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
170 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
171 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
172 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
173 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
174 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
178 * Define the Bitmasks for SSL_CIPHER.algorithms.
179 * This bits are used packed as dense as possible. If new methods/ciphers
180 * etc will be added, the bits a likely to change, so this information
181 * is for internal library use only, even though SSL_CIPHER.algorithms
182 * can be publicly accessed.
183 * Use the according functions for cipher management instead.
185 * The bit mask handling in the selection and sorting scheme in
186 * ssl_create_cipher_list() has only limited capabilities, reflecting
187 * that the different entities within are mutually exclusive:
188 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
191 /* Bits for algorithm_mkey (key exchange algorithm) */
192 /* RSA key exchange */
193 # define SSL_kRSA 0x00000001U
194 /* tmp DH key no DH cert */
195 # define SSL_kDHE 0x00000002U
197 # define SSL_kEDH SSL_kDHE
199 # define SSL_kECDHE 0x00000004U
201 # define SSL_kEECDH SSL_kECDHE
203 # define SSL_kPSK 0x00000008U
204 /* GOST key exchange */
205 # define SSL_kGOST 0x00000010U
207 # define SSL_kSRP 0x00000020U
209 # define SSL_kRSAPSK 0x00000040U
210 # define SSL_kECDHEPSK 0x00000080U
211 # define SSL_kDHEPSK 0x00000100U
215 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
217 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
218 # define SSL_kANY 0x00000000U
220 /* Bits for algorithm_auth (server authentication) */
222 # define SSL_aRSA 0x00000001U
224 # define SSL_aDSS 0x00000002U
225 /* no auth (i.e. use ADH or AECDH) */
226 # define SSL_aNULL 0x00000004U
228 # define SSL_aECDSA 0x00000008U
230 # define SSL_aPSK 0x00000010U
231 /* GOST R 34.10-2001 signature auth */
232 # define SSL_aGOST01 0x00000020U
234 # define SSL_aSRP 0x00000040U
235 /* GOST R 34.10-2012 signature auth */
236 # define SSL_aGOST12 0x00000080U
237 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
238 # define SSL_aANY 0x00000000U
240 /* Bits for algorithm_enc (symmetric encryption) */
241 # define SSL_DES 0x00000001U
242 # define SSL_3DES 0x00000002U
243 # define SSL_RC4 0x00000004U
244 # define SSL_RC2 0x00000008U
245 # define SSL_IDEA 0x00000010U
246 # define SSL_eNULL 0x00000020U
247 # define SSL_AES128 0x00000040U
248 # define SSL_AES256 0x00000080U
249 # define SSL_CAMELLIA128 0x00000100U
250 # define SSL_CAMELLIA256 0x00000200U
251 # define SSL_eGOST2814789CNT 0x00000400U
252 # define SSL_SEED 0x00000800U
253 # define SSL_AES128GCM 0x00001000U
254 # define SSL_AES256GCM 0x00002000U
255 # define SSL_AES128CCM 0x00004000U
256 # define SSL_AES256CCM 0x00008000U
257 # define SSL_AES128CCM8 0x00010000U
258 # define SSL_AES256CCM8 0x00020000U
259 # define SSL_eGOST2814789CNT12 0x00040000U
260 # define SSL_CHACHA20POLY1305 0x00080000U
262 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
263 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
264 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
265 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
266 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
268 /* Bits for algorithm_mac (symmetric authentication) */
270 # define SSL_MD5 0x00000001U
271 # define SSL_SHA1 0x00000002U
272 # define SSL_GOST94 0x00000004U
273 # define SSL_GOST89MAC 0x00000008U
274 # define SSL_SHA256 0x00000010U
275 # define SSL_SHA384 0x00000020U
276 /* Not a real MAC, just an indication it is part of cipher */
277 # define SSL_AEAD 0x00000040U
278 # define SSL_GOST12_256 0x00000080U
279 # define SSL_GOST89MAC12 0x00000100U
280 # define SSL_GOST12_512 0x00000200U
283 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
284 * sure to update this constant too
287 # define SSL_MD_MD5_IDX 0
288 # define SSL_MD_SHA1_IDX 1
289 # define SSL_MD_GOST94_IDX 2
290 # define SSL_MD_GOST89MAC_IDX 3
291 # define SSL_MD_SHA256_IDX 4
292 # define SSL_MD_SHA384_IDX 5
293 # define SSL_MD_GOST12_256_IDX 6
294 # define SSL_MD_GOST89MAC12_IDX 7
295 # define SSL_MD_GOST12_512_IDX 8
296 # define SSL_MD_MD5_SHA1_IDX 9
297 # define SSL_MD_SHA224_IDX 10
298 # define SSL_MD_SHA512_IDX 11
299 # define SSL_MAX_DIGEST 12
301 /* Bits for algorithm2 (handshake digests and other extra flags) */
303 /* Bits 0-7 are handshake MAC */
304 # define SSL_HANDSHAKE_MAC_MASK 0xFF
305 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
306 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
307 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
308 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
309 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
310 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
311 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
313 /* Bits 8-15 bits are PRF */
314 # define TLS1_PRF_DGST_SHIFT 8
315 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
316 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
317 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
318 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
319 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
320 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
321 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
324 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
325 * goes into algorithm2)
327 # define TLS1_STREAM_MAC 0x10000
329 # define SSL_STRONG_MASK 0x0000001FU
330 # define SSL_DEFAULT_MASK 0X00000020U
332 # define SSL_STRONG_NONE 0x00000001U
333 # define SSL_LOW 0x00000002U
334 # define SSL_MEDIUM 0x00000004U
335 # define SSL_HIGH 0x00000008U
336 # define SSL_FIPS 0x00000010U
337 # define SSL_NOT_DEFAULT 0x00000020U
339 /* we have used 0000003f - 26 bits left to go */
341 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
342 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
344 /* Check if an SSL structure is using DTLS */
345 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
347 /* Check if we are using TLSv1.3 */
348 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
349 && (s)->method->version >= TLS1_3_VERSION \
350 && (s)->method->version != TLS_ANY_VERSION)
352 # define SSL_TREAT_AS_TLS13(s) \
353 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_WRITING)
355 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
357 /* See if we need explicit IV */
358 # define SSL_USE_EXPLICIT_IV(s) \
359 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
361 * See if we use signature algorithms extension and signature algorithm
364 # define SSL_USE_SIGALGS(s) \
365 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
367 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
368 * apply to others in future.
370 # define SSL_USE_TLS1_2_CIPHERS(s) \
371 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
373 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
374 * flags because it may not be set to correct version yet.
376 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
377 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
378 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
380 * Determine if a client should send signature algorithms extension:
381 * as with TLS1.2 cipher we can't rely on method flags.
383 # define SSL_CLIENT_USE_SIGALGS(s) \
384 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
386 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
387 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
389 /* Mostly for SSLv3 */
390 # define SSL_PKEY_RSA 0
391 # define SSL_PKEY_DSA_SIGN 1
392 # define SSL_PKEY_ECC 2
393 # define SSL_PKEY_GOST01 3
394 # define SSL_PKEY_GOST12_256 4
395 # define SSL_PKEY_GOST12_512 5
396 # define SSL_PKEY_NUM 6
398 * Pseudo-constant. GOST cipher suites can use different certs for 1
399 * SSL_CIPHER. So let's see which one we have in fact.
401 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
404 * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
407 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
410 * SSL_kRSA <- RSA_ENC
411 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
412 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
413 * SSL_aRSA <- RSA_ENC | RSA_SIGN
414 * SSL_aDSS <- DSA_SIGN
418 #define CERT_INVALID 0
419 #define CERT_PUBLIC_KEY 1
420 #define CERT_PRIVATE_KEY 2
423 /* CipherSuite length. SSLv3 and all TLS versions. */
424 # define TLS_CIPHER_LEN 2
425 /* used to hold info on the particular ciphers used */
426 struct ssl_cipher_st {
428 const char *name; /* text name */
429 uint32_t id; /* id, 4 bytes, first is version */
431 * changed in 1.0.0: these four used to be portions of a single value
434 uint32_t algorithm_mkey; /* key exchange algorithm */
435 uint32_t algorithm_auth; /* server authentication */
436 uint32_t algorithm_enc; /* symmetric encryption */
437 uint32_t algorithm_mac; /* symmetric authentication */
438 int min_tls; /* minimum SSL/TLS protocol version */
439 int max_tls; /* maximum SSL/TLS protocol version */
440 int min_dtls; /* minimum DTLS protocol version */
441 int max_dtls; /* maximum DTLS protocol version */
442 uint32_t algo_strength; /* strength and export flags */
443 uint32_t algorithm2; /* Extra flags */
444 int32_t strength_bits; /* Number of bits really used */
445 uint32_t alg_bits; /* Number of bits for algorithm */
448 /* Used to hold SSL/TLS functions */
449 struct ssl_method_st {
453 int (*ssl_new) (SSL *s);
454 void (*ssl_clear) (SSL *s);
455 void (*ssl_free) (SSL *s);
456 int (*ssl_accept) (SSL *s);
457 int (*ssl_connect) (SSL *s);
458 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
459 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
460 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
461 int (*ssl_shutdown) (SSL *s);
462 int (*ssl_renegotiate) (SSL *s);
463 int (*ssl_renegotiate_check) (SSL *s, int);
464 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
465 unsigned char *buf, size_t len, int peek,
467 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
469 int (*ssl_dispatch_alert) (SSL *s);
470 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
471 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
472 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
473 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
475 size_t (*ssl_pending) (const SSL *s);
476 int (*num_ciphers) (void);
477 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
478 long (*get_timeout) (void);
479 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
480 int (*ssl_version) (void);
481 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
482 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
486 * Lets make this into an ASN.1 type structure as follows
487 * SSL_SESSION_ID ::= SEQUENCE {
488 * version INTEGER, -- structure version number
489 * SSLversion INTEGER, -- SSL version number
490 * Cipher OCTET STRING, -- the 3 byte cipher ID
491 * Session_ID OCTET STRING, -- the Session ID
492 * Master_key OCTET STRING, -- the master key
493 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
494 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
495 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
496 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
497 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
498 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
499 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
500 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
501 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
502 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
503 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
504 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
505 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
506 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
508 * Look in ssl/ssl_asn1.c for more details
509 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
511 struct ssl_session_st {
512 int ssl_version; /* what ssl version session info is being kept
514 size_t master_key_length;
517 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
520 unsigned char master_key[TLS13_MAX_RESUMPTION_MASTER_LENGTH];
521 /* session_id - valid? */
522 size_t session_id_length;
523 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
525 * this is used to determine whether the session is being reused in the
526 * appropriate context. It is up to the application to set this, via
529 size_t sid_ctx_length;
530 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
531 # ifndef OPENSSL_NO_PSK
532 char *psk_identity_hint;
536 * Used to indicate that session resumption is not allowed. Applications
537 * can also set this bit for a new session via not_resumable_session_cb
538 * to disable session caching and tickets.
541 /* This is the cert and type for the other end. */
544 /* Certificate chain peer sent */
545 STACK_OF(X509) *peer_chain;
547 * when app_verify_callback accepts a session where the peer's
548 * certificate is not ok, we must remember the error for session reuse:
550 long verify_result; /* only for servers */
551 CRYPTO_REF_COUNT references;
554 unsigned int compress_meth; /* Need to lookup the method */
555 const SSL_CIPHER *cipher;
556 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
557 * load the 'cipher' structure */
558 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
559 CRYPTO_EX_DATA ex_data; /* application specific data */
561 * These are used to make removal of session-ids more efficient and to
562 * implement a maximum cache size.
564 struct ssl_session_st *prev, *next;
568 # ifndef OPENSSL_NO_EC
569 size_t ecpointformats_len;
570 unsigned char *ecpointformats; /* peer's list */
571 size_t supportedgroups_len;
572 unsigned char *supportedgroups; /* peer's list */
573 # endif /* OPENSSL_NO_EC */
575 unsigned char *tick; /* Session ticket */
576 size_t ticklen; /* Session ticket length */
577 /* Session lifetime hint in seconds */
578 unsigned long tick_lifetime_hint;
579 uint32_t tick_age_add;
581 /* Max number of bytes that can be sent as early data */
582 uint32_t max_early_data;
584 # ifndef OPENSSL_NO_SRP
591 /* Extended master secret support */
592 # define SSL_SESS_FLAG_EXTMS 0x1
594 # ifndef OPENSSL_NO_SRP
596 typedef struct srp_ctx_st {
597 /* param for all the callbacks */
599 /* set client Hello login callback */
600 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
601 /* set SRP N/g param callback for verification */
602 int (*SRP_verify_param_callback) (SSL *, void *);
603 /* set SRP client passwd callback */
604 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
606 BIGNUM *N, *g, *s, *B, *A;
610 unsigned long srp_Mask;
616 SSL_EARLY_DATA_NONE = 0,
617 SSL_EARLY_DATA_CONNECT_RETRY,
618 SSL_EARLY_DATA_CONNECTING,
619 SSL_EARLY_DATA_WRITE_RETRY,
620 SSL_EARLY_DATA_WRITING,
621 SSL_EARLY_DATA_FINISHED_WRITING,
622 SSL_EARLY_DATA_ACCEPT_RETRY,
623 SSL_EARLY_DATA_ACCEPTING,
624 SSL_EARLY_DATA_READ_RETRY,
625 SSL_EARLY_DATA_READING,
626 SSL_EARLY_DATA_FINISHED_READING
627 } SSL_EARLY_DATA_STATE;
629 #define MAX_COMPRESSIONS_SIZE 255
637 typedef struct raw_extension_st {
638 /* Raw packet data for the extension */
640 /* Set to 1 if the extension is present or 0 otherwise */
642 /* Set to 1 if we have already parsed the extension or 0 otherwise */
644 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
650 unsigned int legacy_version;
651 unsigned char random[SSL3_RANDOM_SIZE];
652 size_t session_id_len;
653 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
654 size_t dtls_cookie_len;
655 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
657 size_t compressions_len;
658 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
660 size_t pre_proc_exts_len;
661 RAW_EXTENSION *pre_proc_exts;
664 DEFINE_LHASH_OF(SSL_SESSION);
665 /* Needed in ssl_cert.c */
666 DEFINE_LHASH_OF(X509_NAME);
668 # define TLSEXT_KEYNAME_LENGTH 16
671 const SSL_METHOD *method;
672 STACK_OF(SSL_CIPHER) *cipher_list;
673 /* same as above but sorted for lookup */
674 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
675 struct x509_store_st /* X509_STORE */ *cert_store;
676 LHASH_OF(SSL_SESSION) *sessions;
678 * Most session-ids that will be cached, default is
679 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
681 size_t session_cache_size;
682 struct ssl_session_st *session_cache_head;
683 struct ssl_session_st *session_cache_tail;
685 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
686 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
687 * means only SSL_accept which cache SSL_SESSIONS.
689 uint32_t session_cache_mode;
691 * If timeout is not 0, it is the default timeout value set when
692 * SSL_new() is called. This has been put in to make life easier to set
695 long session_timeout;
697 * If this callback is not null, it will be called each time a session id
698 * is added to the cache. If this function returns 1, it means that the
699 * callback will do a SSL_SESSION_free() when it has finished using it.
700 * Otherwise, on 0, it means the callback has finished with it. If
701 * remove_session_cb is not null, it will be called when a session-id is
702 * removed from the cache. After the call, OpenSSL will
703 * SSL_SESSION_free() it.
705 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
706 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
707 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
708 const unsigned char *data, int len,
711 int sess_connect; /* SSL new conn - started */
712 int sess_connect_renegotiate; /* SSL reneg - requested */
713 int sess_connect_good; /* SSL new conne/reneg - finished */
714 int sess_accept; /* SSL new accept - started */
715 int sess_accept_renegotiate; /* SSL reneg - requested */
716 int sess_accept_good; /* SSL accept/reneg - finished */
717 int sess_miss; /* session lookup misses */
718 int sess_timeout; /* reuse attempt on timeouted session */
719 int sess_cache_full; /* session removed due to full cache */
720 int sess_hit; /* session reuse actually done */
721 int sess_cb_hit; /* session-id that was not in the cache was
722 * passed back via the callback. This
723 * indicates that the application is supplying
724 * session-id's from other processes - spooky
728 CRYPTO_REF_COUNT references;
730 /* if defined, these override the X509_verify_cert() calls */
731 int (*app_verify_callback) (X509_STORE_CTX *, void *);
732 void *app_verify_arg;
734 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
735 * ('app_verify_callback' was called with just one argument)
738 /* Default password callback. */
739 pem_password_cb *default_passwd_callback;
741 /* Default password callback user data. */
742 void *default_passwd_callback_userdata;
744 /* get client cert callback */
745 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
747 /* cookie generate callback */
748 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
749 unsigned int *cookie_len);
751 /* verify cookie callback */
752 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
753 unsigned int cookie_len);
755 CRYPTO_EX_DATA ex_data;
757 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
758 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
760 STACK_OF(X509) *extra_certs;
761 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
763 /* Default values used when no per-SSL value is defined follow */
765 /* used if SSL's info_callback is NULL */
766 void (*info_callback) (const SSL *ssl, int type, int val);
768 /* what we put in client cert requests */
769 STACK_OF(X509_NAME) *client_CA;
772 * Default values to use in SSL structures follow (these are copied by
778 int min_proto_version;
779 int max_proto_version;
780 size_t max_cert_list;
782 struct cert_st /* CERT */ *cert;
785 /* callback that allows applications to peek at protocol messages */
786 void (*msg_callback) (int write_p, int version, int content_type,
787 const void *buf, size_t len, SSL *ssl, void *arg);
788 void *msg_callback_arg;
790 uint32_t verify_mode;
791 size_t sid_ctx_length;
792 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
793 /* called 'verify_callback' in the SSL */
794 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
796 /* Default generate session ID callback. */
797 GEN_SESSION_CB generate_session_id;
799 X509_VERIFY_PARAM *param;
803 # ifndef OPENSSL_NO_CT
804 CTLOG_STORE *ctlog_store; /* CT Log Store */
806 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
807 * If they are not, the connection should be aborted.
809 ssl_ct_validation_cb ct_validation_callback;
810 void *ct_validation_callback_arg;
814 * If we're using more than one pipeline how should we divide the data
815 * up between the pipes?
817 size_t split_send_fragment;
819 * Maximum amount of data to send in one fragment. actual record size can
820 * be more than this due to padding and MAC overheads.
822 size_t max_send_fragment;
824 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
825 size_t max_pipelines;
827 /* The default read buffer length to use (0 means not set) */
828 size_t default_read_buf_len;
830 # ifndef OPENSSL_NO_ENGINE
832 * Engine to pass requests for client certs to
834 ENGINE *client_cert_engine;
837 /* Early callback. Mostly for extensions, but not entirely. */
838 SSL_early_cb_fn early_cb;
841 /* TLS extensions. */
843 /* TLS extensions servername callback */
844 int (*servername_cb) (SSL *, int *, void *);
845 void *servername_arg;
846 /* RFC 4507 session ticket keys */
847 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
848 unsigned char tick_hmac_key[32];
849 unsigned char tick_aes_key[32];
850 /* Callback to support customisation of ticket key setting */
851 int (*ticket_key_cb) (SSL *ssl,
852 unsigned char *name, unsigned char *iv,
853 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
855 /* certificate status request info */
856 /* Callback for status request */
857 int (*status_cb) (SSL *ssl, void *arg);
859 /* ext status type used for CSR extension (OCSP Stapling) */
862 # ifndef OPENSSL_NO_EC
863 /* EC extension values inherited by SSL structure */
864 size_t ecpointformats_len;
865 unsigned char *ecpointformats;
866 size_t supportedgroups_len;
867 unsigned char *supportedgroups;
868 # endif /* OPENSSL_NO_EC */
871 * ALPN information (we are in the process of transitioning from NPN to
876 * For a server, this contains a callback function that allows the
877 * server to select the protocol for the connection.
878 * out: on successful return, this must point to the raw protocol
879 * name (without the length prefix).
880 * outlen: on successful return, this contains the length of |*out|.
881 * in: points to the client's list of supported protocols in
883 * inlen: the length of |in|.
885 int (*alpn_select_cb) (SSL *s,
886 const unsigned char **out,
887 unsigned char *outlen,
888 const unsigned char *in,
889 unsigned int inlen, void *arg);
890 void *alpn_select_cb_arg;
893 * For a client, this contains the list of supported protocols in wire
899 # ifndef OPENSSL_NO_NEXTPROTONEG
900 /* Next protocol negotiation information */
903 * For a server, this contains a callback function by which the set of
904 * advertised protocols can be provided.
906 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
907 void *npn_advertised_cb_arg;
909 * For a client, this contains a callback function that selects the next
910 * protocol from the list provided by the server.
912 SSL_CTX_npn_select_cb_func npn_select_cb;
913 void *npn_select_cb_arg;
917 # ifndef OPENSSL_NO_PSK
918 SSL_psk_client_cb_func psk_client_callback;
919 SSL_psk_server_cb_func psk_server_callback;
922 # ifndef OPENSSL_NO_SRP
923 SRP_CTX srp_ctx; /* ctx for SRP authentication */
926 /* Shared DANE context */
927 struct dane_ctx_st dane;
929 /* SRTP profiles we are willing to do from RFC 5764 */
930 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
932 * Callback for disabling session caching and ticket support on a session
933 * basis, depending on the chosen cipher.
935 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
940 * Callback for logging key material for use with debugging tools like
941 * Wireshark. The callback should log `line` followed by a newline.
943 SSL_CTX_keylog_cb_func keylog_callback;
945 /* The maximum number of bytes that can be sent as early data */
946 uint32_t max_early_data;
951 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
956 const SSL_METHOD *method;
958 * There are 2 BIO's even though they are normally both the same. This
959 * is so data can be read and written to different handlers
961 /* used by SSL_read */
963 /* used by SSL_write */
965 /* used during session-id reuse to concatenate messages */
968 * This holds a variable that indicates what we were doing when a 0 or -1
969 * is returned. This is needed for non-blocking IO so we know what
970 * request needs re-doing when in SSL_accept or SSL_connect
973 int (*handshake_func) (SSL *);
975 * Imagine that here's a boolean member "init" that is switched as soon
976 * as SSL_set_{accept/connect}_state is called for the first time, so
977 * that "state" and "handshake_func" are properly initialized. But as
978 * handshake_func is == 0 until then, we use this test instead of an
981 /* are we the server side? */
984 * Generate a new session or reuse an old one.
985 * NB: For servers, the 'new' session may actually be a previously
986 * cached session or even the previous session unless
987 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
990 /* don't send shutdown packets */
992 /* we have shut things down, 0x01 sent, 0x02 for received */
996 SSL_EARLY_DATA_STATE early_data_state;
997 BUF_MEM *init_buf; /* buffer used during init */
998 void *init_msg; /* pointer to handshake message body, set by
999 * ssl3_get_message() */
1000 size_t init_num; /* amount read/written */
1001 size_t init_off; /* amount read/written */
1002 struct ssl3_state_st *s3; /* SSLv3 variables */
1003 struct dtls1_state_st *d1; /* DTLSv1 variables */
1004 /* callback that allows applications to peek at protocol messages */
1005 void (*msg_callback) (int write_p, int version, int content_type,
1006 const void *buf, size_t len, SSL *ssl, void *arg);
1007 void *msg_callback_arg;
1008 int hit; /* reusing a previous session */
1009 X509_VERIFY_PARAM *param;
1010 /* Per connection DANE state */
1013 STACK_OF(SSL_CIPHER) *cipher_list;
1014 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1016 * These are the ones being used, the ones in SSL_SESSION are the ones to
1017 * be 'copied' into these ones
1021 * The TLS1.3 secrets. The resumption master secret is stored in the
1024 unsigned char early_secret[EVP_MAX_MD_SIZE];
1025 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1026 unsigned char master_secret[EVP_MAX_MD_SIZE];
1027 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1028 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1029 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1030 unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1031 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1032 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1033 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1034 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1035 EVP_MD_CTX *read_hash; /* used for mac generation */
1036 COMP_CTX *compress; /* compression */
1037 COMP_CTX *expand; /* uncompress */
1038 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1039 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1040 EVP_MD_CTX *write_hash; /* used for mac generation */
1041 /* Count of how many KeyUpdate messages we have received */
1042 unsigned int key_update_count;
1045 /* This is used to hold the server certificate used */
1046 struct cert_st /* CERT */ *cert;
1049 * The hash of all messages prior to the CertificateVerify, and the length
1052 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1053 size_t cert_verify_hash_len;
1055 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1056 int hello_retry_request;
1059 * the session_id_context is used to ensure sessions are only reused in
1060 * the appropriate context
1062 size_t sid_ctx_length;
1063 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1064 /* This can also be in the session once a session is established */
1065 SSL_SESSION *session;
1066 /* Default generate session ID callback. */
1067 GEN_SESSION_CB generate_session_id;
1070 * 0 don't care about verify failure.
1071 * 1 fail if verify fails
1073 uint32_t verify_mode;
1074 /* fail if callback returns 0 */
1075 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1076 /* optional informational callback */
1077 void (*info_callback) (const SSL *ssl, int type, int val);
1078 /* error bytes to be written */
1082 # ifndef OPENSSL_NO_PSK
1083 SSL_psk_client_cb_func psk_client_callback;
1084 SSL_psk_server_cb_func psk_server_callback;
1087 /* Verified chain of peer */
1088 STACK_OF(X509) *verified_chain;
1090 /* extra application data */
1091 CRYPTO_EX_DATA ex_data;
1092 /* for server side, keep the list of CA_dn we can use */
1093 STACK_OF(X509_NAME) *client_CA;
1094 CRYPTO_REF_COUNT references;
1095 /* protocol behaviour */
1099 int min_proto_version;
1100 int max_proto_version;
1101 size_t max_cert_list;
1104 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1105 * secret and SSLv3/TLS (<=1.2) rollback check
1109 * If we're using more than one pipeline how should we divide the data
1110 * up between the pipes?
1112 size_t split_send_fragment;
1114 * Maximum amount of data to send in one fragment. actual record size can
1115 * be more than this due to padding and MAC overheads.
1117 size_t max_send_fragment;
1118 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1119 size_t max_pipelines;
1122 /* TLS extension debug callback */
1123 void (*debug_cb)(SSL *s, int client_server, int type,
1124 const unsigned char *data, int len, void *arg);
1127 /* certificate status request info */
1128 /* Status type or -1 if no status type */
1130 /* Raw extension data, if seen */
1131 unsigned char *scts;
1132 /* Length of raw extension data, if seen */
1134 /* Expect OCSP CertificateStatus message */
1135 int status_expected;
1138 /* OCSP status request only */
1139 STACK_OF(OCSP_RESPID) *ids;
1140 X509_EXTENSIONS *exts;
1141 /* OCSP response received or to be sent */
1142 unsigned char *resp;
1146 /* RFC4507 session ticket expected to be received or sent */
1147 int ticket_expected;
1148 # ifndef OPENSSL_NO_EC
1149 size_t ecpointformats_len;
1151 unsigned char *ecpointformats;
1152 size_t supportedgroups_len;
1154 unsigned char *supportedgroups;
1155 # endif /* OPENSSL_NO_EC */
1156 /* TLS Session Ticket extension override */
1157 TLS_SESSION_TICKET_EXT *session_ticket;
1158 /* TLS Session Ticket extension callback */
1159 tls_session_ticket_ext_cb_fn session_ticket_cb;
1160 void *session_ticket_cb_arg;
1161 /* TLS pre-shared secret session resumption */
1162 tls_session_secret_cb_fn session_secret_cb;
1163 void *session_secret_cb_arg;
1165 * For a client, this contains the list of supported protocols in wire
1168 unsigned char *alpn;
1171 * Next protocol negotiation. For the client, this is the protocol that
1172 * we sent in NextProtocol and is set when handling ServerHello
1173 * extensions. For a server, this is the client's selected_protocol from
1174 * NextProtocol and is set when handling the NextProtocol message, before
1175 * the Finished message.
1180 /* The available PSK key exchange modes */
1183 /* Set to one if we have negotiated ETM */
1186 /* Are we expecting to receive early data? */
1190 /* Parsed form of the ClientHello, kept around across early_cb calls. */
1191 CLIENTHELLO_MSG *clienthello;
1194 * no further mod of servername
1195 * 0 : call the servername extension callback.
1196 * 1 : prepare 2, allow last ack just after in server callback.
1197 * 2 : don't call servername callback, no ack in server hello
1199 int servername_done;
1200 # ifndef OPENSSL_NO_CT
1202 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1203 * If they are not, the connection should be aborted.
1205 ssl_ct_validation_cb ct_validation_callback;
1206 /* User-supplied argument that is passed to the ct_validation_callback */
1207 void *ct_validation_callback_arg;
1209 * Consolidated stack of SCTs from all sources.
1210 * Lazily populated by CT_get_peer_scts(SSL*)
1212 STACK_OF(SCT) *scts;
1213 /* Have we attempted to find/parse SCTs yet? */
1216 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1218 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1219 /* What's been chosen */
1220 SRTP_PROTECTION_PROFILE *srtp_profile;
1222 * 1 if we are renegotiating.
1223 * 2 if we are a server and are inside a handshake
1224 * (i.e. not just sending a HelloRequest)
1227 /* If sending a KeyUpdate is pending */
1229 # ifndef OPENSSL_NO_SRP
1230 /* ctx for SRP authentication */
1234 * Callback for disabling session caching and ticket support on a session
1235 * basis, depending on the chosen cipher.
1237 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1238 RECORD_LAYER rlayer;
1239 /* Default password callback. */
1240 pem_password_cb *default_passwd_callback;
1241 /* Default password callback user data. */
1242 void *default_passwd_callback_userdata;
1243 /* Async Job info */
1245 ASYNC_WAIT_CTX *waitctx;
1248 /* The maximum number of bytes that can be sent as early data */
1249 uint32_t max_early_data;
1251 CRYPTO_RWLOCK *lock;
1255 * Structure containing table entry of values associated with the signature
1256 * algorithms (signature scheme) extension
1258 typedef struct sigalg_lookup_st {
1259 /* TLS 1.3 signature scheme name */
1261 /* Raw value used in extension */
1263 /* NID of hash algorithm */
1265 /* Index of hash algorithm */
1267 /* NID of signature algorithm */
1269 /* Index of signature algorithm */
1271 /* Combined hash and signature NID, if any */
1273 /* Required public key curve (ECDSA only) */
1277 typedef struct cert_pkey_st CERT_PKEY;
1279 typedef struct ssl3_state_st {
1281 size_t read_mac_secret_size;
1282 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1283 size_t write_mac_secret_size;
1284 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1285 unsigned char server_random[SSL3_RANDOM_SIZE];
1286 unsigned char client_random[SSL3_RANDOM_SIZE];
1287 /* flags for countermeasure against known-IV weakness */
1288 int need_empty_fragments;
1289 int empty_fragment_done;
1290 /* used during startup, digest all incoming/outgoing packets */
1291 BIO *handshake_buffer;
1293 * When handshake digest is determined, buffer is hashed and
1294 * freed and MD_CTX for the required digest is stored here.
1296 EVP_MD_CTX *handshake_dgst;
1298 * Set whenever an expected ChangeCipherSpec message is processed.
1299 * Unset when the peer's Finished message is received.
1300 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1302 int change_cipher_spec;
1306 * we allow one fatal and one warning alert to be outstanding, send close
1307 * alert via the warning alert
1310 unsigned char send_alert[2];
1312 * This flag is set when we should renegotiate ASAP, basically when there
1313 * is no more data in the read or write buffers
1316 int total_renegotiations;
1317 int num_renegotiations;
1318 int in_read_app_data;
1320 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1321 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1322 size_t finish_md_len;
1323 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1324 size_t peer_finish_md_len;
1325 size_t message_size;
1327 /* used to hold the new cipher we are going to use */
1328 const SSL_CIPHER *new_cipher;
1329 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1330 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1332 /* used for certificate requests */
1334 /* Certificate types in certificate request message. */
1337 STACK_OF(X509_NAME) *ca_names;
1338 size_t key_block_length;
1339 unsigned char *key_block;
1340 const EVP_CIPHER *new_sym_enc;
1341 const EVP_MD *new_hash;
1342 int new_mac_pkey_type;
1343 size_t new_mac_secret_size;
1344 # ifndef OPENSSL_NO_COMP
1345 const SSL_COMP *new_compression;
1347 char *new_compression;
1350 /* Raw values of the cipher list from a client */
1351 unsigned char *ciphers_raw;
1352 size_t ciphers_rawlen;
1353 /* Temporary storage for premaster secret */
1356 # ifndef OPENSSL_NO_PSK
1357 /* Temporary storage for PSK key */
1361 /* Signature algorithm we actually use */
1362 const SIGALG_LOOKUP *sigalg;
1363 /* Pointer to certificate we use */
1366 * signature algorithms peer reports: e.g. supported signature
1367 * algorithms extension for server or as part of a certificate
1368 * request for client.
1370 uint16_t *peer_sigalgs;
1371 /* Size of above array */
1372 size_t peer_sigalgslen;
1373 /* Sigalg peer actualy uses */
1374 const SIGALG_LOOKUP *peer_sigalg;
1376 * Set if corresponding CERT_PKEY can be used with current
1377 * SSL session: e.g. appropriate curve, signature algorithms etc.
1378 * If zero it can't be used at all.
1380 uint32_t valid_flags[SSL_PKEY_NUM];
1382 * For servers the following masks are for the key and auth algorithms
1383 * that are supported by the certs below. For clients they are masks of
1384 * *disabled* algorithms based on the current session.
1389 * The following are used by the client to see if a cipher is allowed or
1390 * not. It contains the minimum and maximum version the client's using
1391 * based on what it knows so far.
1397 /* Connection binding to prevent renegotiation attacks */
1398 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1399 size_t previous_client_finished_len;
1400 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1401 size_t previous_server_finished_len;
1402 int send_connection_binding; /* TODOEKR */
1404 # ifndef OPENSSL_NO_NEXTPROTONEG
1406 * Set if we saw the Next Protocol Negotiation extension from our peer.
1412 * ALPN information (we are in the process of transitioning from NPN to
1417 * In a server these point to the selected ALPN protocol after the
1418 * ClientHello has been processed. In a client these contain the protocol
1419 * that the server selected once the ServerHello has been processed.
1421 unsigned char *alpn_selected;
1422 size_t alpn_selected_len;
1423 /* used by the server to know what options were proposed */
1424 unsigned char *alpn_proposed;
1425 size_t alpn_proposed_len;
1426 /* used by the client to know if it actually sent alpn */
1429 # ifndef OPENSSL_NO_EC
1431 * This is set to true if we believe that this is a version of Safari
1432 * running on OS X 10.6 or newer. We wish to know this because Safari on
1433 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1435 char is_probably_safari;
1436 # endif /* !OPENSSL_NO_EC */
1438 /* For clients: peer temporary key */
1439 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1440 /* The group_id for the DH/ECDH key */
1441 unsigned int group_id;
1447 /* DTLS structures */
1449 # ifndef OPENSSL_NO_SCTP
1450 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1453 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1454 # define DTLS1_MAX_MTU_OVERHEAD 48
1457 * Flag used in message reuse to indicate the buffer contains the record
1458 * header as well as the the handshake message header.
1460 # define DTLS1_SKIP_RECORD_HEADER 2
1462 struct dtls1_retransmit_state {
1463 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1464 EVP_MD_CTX *write_hash; /* used for mac generation */
1465 COMP_CTX *compress; /* compression */
1466 SSL_SESSION *session;
1467 unsigned short epoch;
1470 struct hm_header_st {
1476 unsigned int is_ccs;
1477 struct dtls1_retransmit_state saved_retransmit_state;
1480 struct dtls1_timeout_st {
1481 /* Number of read timeouts so far */
1482 unsigned int read_timeouts;
1483 /* Number of write timeouts so far */
1484 unsigned int write_timeouts;
1485 /* Number of alerts received so far */
1486 unsigned int num_alerts;
1489 typedef struct hm_fragment_st {
1490 struct hm_header_st msg_header;
1491 unsigned char *fragment;
1492 unsigned char *reassembly;
1495 typedef struct pqueue_st pqueue;
1496 typedef struct pitem_st pitem;
1499 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1504 typedef struct pitem_st *piterator;
1506 pitem *pitem_new(unsigned char *prio64be, void *data);
1507 void pitem_free(pitem *item);
1508 pqueue *pqueue_new(void);
1509 void pqueue_free(pqueue *pq);
1510 pitem *pqueue_insert(pqueue *pq, pitem *item);
1511 pitem *pqueue_peek(pqueue *pq);
1512 pitem *pqueue_pop(pqueue *pq);
1513 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1514 pitem *pqueue_iterator(pqueue *pq);
1515 pitem *pqueue_next(piterator *iter);
1516 size_t pqueue_size(pqueue *pq);
1518 typedef struct dtls1_state_st {
1519 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1521 unsigned int cookie_verified;
1522 /* handshake message numbers */
1523 unsigned short handshake_write_seq;
1524 unsigned short next_handshake_write_seq;
1525 unsigned short handshake_read_seq;
1526 /* Buffered handshake messages */
1527 pqueue *buffered_messages;
1528 /* Buffered (sent) handshake records */
1529 pqueue *sent_messages;
1530 size_t link_mtu; /* max on-the-wire DTLS packet size */
1531 size_t mtu; /* max DTLS packet size */
1532 struct hm_header_st w_msg_hdr;
1533 struct hm_header_st r_msg_hdr;
1534 struct dtls1_timeout_st timeout;
1536 * Indicates when the last handshake msg sent will timeout
1538 struct timeval next_timeout;
1539 /* Timeout duration */
1540 unsigned short timeout_duration;
1541 unsigned int retransmitting;
1542 # ifndef OPENSSL_NO_SCTP
1543 int shutdown_received;
1547 # ifndef OPENSSL_NO_EC
1549 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1551 # define EXPLICIT_PRIME_CURVE_TYPE 1
1552 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1553 # define NAMED_CURVE_TYPE 3
1554 # endif /* OPENSSL_NO_EC */
1556 struct cert_pkey_st {
1558 EVP_PKEY *privatekey;
1559 /* Chain for this certificate */
1560 STACK_OF(X509) *chain;
1562 * serverinfo data for this certificate. The data is in TLS Extension
1563 * wire format, specifically it's a series of records like:
1564 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1566 * uint8_t data[length];
1568 unsigned char *serverinfo;
1569 size_t serverinfo_length;
1571 /* Retrieve Suite B flags */
1572 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1573 /* Uses to check strict mode: suite B modes are always strict */
1574 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1575 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1578 unsigned short ext_type;
1580 * Per-connection flags relating to this extension type: not used if
1581 * part of an SSL_CTX structure.
1584 custom_ext_add_cb add_cb;
1585 custom_ext_free_cb free_cb;
1587 custom_ext_parse_cb parse_cb;
1589 } custom_ext_method;
1591 /* ext_flags values */
1594 * Indicates an extension has been received. Used to check for unsolicited or
1595 * duplicate extensions.
1597 # define SSL_EXT_FLAG_RECEIVED 0x1
1599 * Indicates an extension has been sent: used to enable sending of
1600 * corresponding ServerHello extension.
1602 # define SSL_EXT_FLAG_SENT 0x2
1605 custom_ext_method *meths;
1607 } custom_ext_methods;
1609 typedef struct cert_st {
1610 /* Current active set */
1612 * ALWAYS points to an element of the pkeys array
1613 * Probably it would make more sense to store
1614 * an index, not a pointer.
1617 # ifndef OPENSSL_NO_DH
1619 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1622 /* Flags related to certificates */
1623 uint32_t cert_flags;
1624 CERT_PKEY pkeys[SSL_PKEY_NUM];
1625 /* Custom certificate types sent in certificate request message. */
1629 * supported signature algorithms. When set on a client this is sent in
1630 * the client hello as the supported signature algorithms extension. For
1631 * servers it represents the signature algorithms we are willing to use.
1633 uint16_t *conf_sigalgs;
1634 /* Size of above array */
1635 size_t conf_sigalgslen;
1637 * Client authentication signature algorithms, if not set then uses
1638 * conf_sigalgs. On servers these will be the signature algorithms sent
1639 * to the client in a certificate request for TLS 1.2. On a client this
1640 * represents the signature algorithms we are willing to use for client
1643 uint16_t *client_sigalgs;
1644 /* Size of above array */
1645 size_t client_sigalgslen;
1647 * Signature algorithms shared by client and server: cached because these
1648 * are used most often.
1650 const SIGALG_LOOKUP **shared_sigalgs;
1651 size_t shared_sigalgslen;
1653 * Certificate setup callback: if set is called whenever a certificate
1654 * may be required (client or server). the callback can then examine any
1655 * appropriate parameters and setup any certificates required. This
1656 * allows advanced applications to select certificates on the fly: for
1657 * example based on supported signature algorithms or curves.
1659 int (*cert_cb) (SSL *ssl, void *arg);
1662 * Optional X509_STORE for chain building or certificate validation If
1663 * NULL the parent SSL_CTX store is used instead.
1665 X509_STORE *chain_store;
1666 X509_STORE *verify_store;
1667 /* Custom extension methods for server and client */
1668 custom_ext_methods cli_ext;
1669 custom_ext_methods srv_ext;
1670 /* Security callback */
1671 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1672 void *other, void *ex);
1673 /* Security level */
1676 # ifndef OPENSSL_NO_PSK
1677 /* If not NULL psk identity hint to use for servers */
1678 char *psk_identity_hint;
1680 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1681 CRYPTO_RWLOCK *lock;
1684 # define FP_ICC (int (*)(const void *,const void *))
1687 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1688 * of a mess of functions, but hell, think of it as an opaque structure :-)
1690 typedef struct ssl3_enc_method {
1691 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1692 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1693 int (*setup_key_block) (SSL *);
1694 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1696 int (*change_cipher_state) (SSL *, int);
1697 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1698 const char *client_finished_label;
1699 size_t client_finished_label_len;
1700 const char *server_finished_label;
1701 size_t server_finished_label_len;
1702 int (*alert_value) (int);
1703 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1704 const char *, size_t,
1705 const unsigned char *, size_t,
1707 /* Various flags indicating protocol version requirements */
1709 /* Set the handshake header */
1710 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1711 /* Close construction of the handshake message */
1712 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1713 /* Write out handshake message */
1714 int (*do_write) (SSL *s);
1717 # define ssl_set_handshake_header(s, pkt, htype) \
1718 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1719 # define ssl_close_construct_packet(s, pkt, htype) \
1720 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1721 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1723 /* Values for enc_flags */
1725 /* Uses explicit IV for CBC mode */
1726 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1727 /* Uses signature algorithms extension */
1728 # define SSL_ENC_FLAG_SIGALGS 0x2
1729 /* Uses SHA256 default PRF */
1730 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1732 # define SSL_ENC_FLAG_DTLS 0x8
1734 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1735 * apply to others in future.
1737 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1739 # ifndef OPENSSL_NO_COMP
1740 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1741 typedef struct ssl3_comp_st {
1742 int comp_id; /* The identifier byte for this compression
1744 char *name; /* Text name used for the compression type */
1745 COMP_METHOD *method; /* The method :-) */
1750 * Extension index values NOTE: Any updates to these defines should be mirrored
1751 * with equivalent updates to ext_defs in extensions.c
1753 typedef enum tlsext_index_en {
1754 TLSEXT_IDX_renegotiate,
1755 TLSEXT_IDX_server_name,
1757 TLSEXT_IDX_early_data_info,
1758 TLSEXT_IDX_early_data,
1759 TLSEXT_IDX_ec_point_formats,
1760 TLSEXT_IDX_supported_groups,
1761 TLSEXT_IDX_session_ticket,
1762 TLSEXT_IDX_signature_algorithms,
1763 TLSEXT_IDX_status_request,
1764 TLSEXT_IDX_next_proto_neg,
1765 TLSEXT_IDX_application_layer_protocol_negotiation,
1766 TLSEXT_IDX_use_srtp,
1767 TLSEXT_IDX_encrypt_then_mac,
1768 TLSEXT_IDX_signed_certificate_timestamp,
1769 TLSEXT_IDX_extended_master_secret,
1770 TLSEXT_IDX_supported_versions,
1771 TLSEXT_IDX_psk_kex_modes,
1772 TLSEXT_IDX_key_share,
1773 TLSEXT_IDX_cryptopro_bug,
1779 * Dummy status type for the status_type extension. Indicates no status type
1782 #define TLSEXT_STATUSTYPE_nothing -1
1784 /* Sigalgs values */
1785 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1786 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1787 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1788 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1789 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1790 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1791 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1792 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1793 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1794 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1795 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1796 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1797 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1798 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1799 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1800 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1801 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1802 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1804 /* Known PSK key exchange modes */
1805 #define TLSEXT_KEX_MODE_KE 0x00
1806 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1809 * Internal representations of key exchange modes
1811 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1812 #define TLSEXT_KEX_MODE_FLAG_KE 1
1813 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1815 /* An invalid index into the TLSv1.3 PSK identities */
1816 #define TLSEXT_PSK_BAD_IDENTITY -1
1818 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1819 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1821 /* A dummy signature value not valid for TLSv1.2 signature algs */
1822 #define TLSEXT_signature_rsa_pss 0x0101
1825 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1827 __owur const SSL_METHOD *ssl_bad_method(int ver);
1828 __owur const SSL_METHOD *sslv3_method(void);
1829 __owur const SSL_METHOD *sslv3_server_method(void);
1830 __owur const SSL_METHOD *sslv3_client_method(void);
1831 __owur const SSL_METHOD *tlsv1_method(void);
1832 __owur const SSL_METHOD *tlsv1_server_method(void);
1833 __owur const SSL_METHOD *tlsv1_client_method(void);
1834 __owur const SSL_METHOD *tlsv1_1_method(void);
1835 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1836 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1837 __owur const SSL_METHOD *tlsv1_2_method(void);
1838 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1839 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1840 __owur const SSL_METHOD *tlsv1_3_method(void);
1841 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1842 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1843 __owur const SSL_METHOD *dtlsv1_method(void);
1844 __owur const SSL_METHOD *dtlsv1_server_method(void);
1845 __owur const SSL_METHOD *dtlsv1_client_method(void);
1846 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1847 __owur const SSL_METHOD *dtlsv1_2_method(void);
1848 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1849 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1851 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1852 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1853 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1854 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1855 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1856 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1857 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1860 * Flags for SSL methods
1862 # define SSL_METHOD_NO_FIPS (1U<<0)
1863 # define SSL_METHOD_NO_SUITEB (1U<<1)
1865 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1866 s_connect, enc_data) \
1867 const SSL_METHOD *func_name(void) \
1869 static const SSL_METHOD func_name##_data= { \
1883 ssl3_renegotiate_check, \
1886 ssl3_dispatch_alert, \
1889 ssl3_get_cipher_by_char, \
1890 ssl3_put_cipher_by_char, \
1894 tls1_default_timeout, \
1896 ssl_undefined_void_function, \
1897 ssl3_callback_ctrl, \
1898 ssl3_ctx_callback_ctrl, \
1900 return &func_name##_data; \
1903 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1904 const SSL_METHOD *func_name(void) \
1906 static const SSL_METHOD func_name##_data= { \
1908 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1920 ssl3_renegotiate_check, \
1923 ssl3_dispatch_alert, \
1926 ssl3_get_cipher_by_char, \
1927 ssl3_put_cipher_by_char, \
1931 ssl3_default_timeout, \
1933 ssl_undefined_void_function, \
1934 ssl3_callback_ctrl, \
1935 ssl3_ctx_callback_ctrl, \
1937 return &func_name##_data; \
1940 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1941 s_connect, enc_data) \
1942 const SSL_METHOD *func_name(void) \
1944 static const SSL_METHOD func_name##_data= { \
1958 ssl3_renegotiate_check, \
1960 dtls1_write_app_data_bytes, \
1961 dtls1_dispatch_alert, \
1964 ssl3_get_cipher_by_char, \
1965 ssl3_put_cipher_by_char, \
1969 dtls1_default_timeout, \
1971 ssl_undefined_void_function, \
1972 ssl3_callback_ctrl, \
1973 ssl3_ctx_callback_ctrl, \
1975 return &func_name##_data; \
1978 struct openssl_ssl_test_functions {
1979 int (*p_ssl_init_wbio_buffer) (SSL *s);
1980 int (*p_ssl3_setup_buffers) (SSL *s);
1983 const char *ssl_protocol_to_string(int version);
1985 /* Returns true if certificate and private key for 'idx' are present */
1986 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
1988 if (idx < 0 || idx >= SSL_PKEY_NUM)
1990 return s->cert->pkeys[idx].x509 != NULL
1991 && s->cert->pkeys[idx].privatekey != NULL;
1994 # ifndef OPENSSL_UNIT_TEST
1996 int ssl_end_of_early_data_seen(SSL *s);
1997 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
1998 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
1999 void ssl_clear_cipher_ctx(SSL *s);
2000 int ssl_clear_bad_session(SSL *s);
2001 __owur CERT *ssl_cert_new(void);
2002 __owur CERT *ssl_cert_dup(CERT *cert);
2003 void ssl_cert_clear_certs(CERT *c);
2004 void ssl_cert_free(CERT *c);
2005 __owur int ssl_get_new_session(SSL *s, int session);
2006 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
2007 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2008 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2009 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2010 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2011 const SSL_CIPHER *const *bp);
2012 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2013 STACK_OF(SSL_CIPHER) **pref,
2014 STACK_OF(SSL_CIPHER)
2016 const char *rule_str,
2018 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites,
2019 int sslv2format, int *al);
2020 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2021 STACK_OF(SSL_CIPHER) **skp,
2022 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2024 void ssl_update_cache(SSL *s, int mode);
2025 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2026 const EVP_MD **md, int *mac_pkey_type,
2027 size_t *mac_secret_size, SSL_COMP **comp,
2029 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2030 size_t *int_overhead, size_t *blocksize,
2031 size_t *ext_overhead);
2032 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2033 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2034 const unsigned char *ptr,
2036 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2037 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2038 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2039 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2040 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2041 __owur int ssl_cert_set_current(CERT *c, long arg);
2042 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2043 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2045 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2046 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2047 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2050 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2051 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2054 int ssl_undefined_function(SSL *s);
2055 __owur int ssl_undefined_void_function(void);
2056 __owur int ssl_undefined_const_function(const SSL *s);
2057 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2058 const unsigned char **serverinfo,
2059 size_t *serverinfo_length);
2060 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2061 void ssl_set_masks(SSL *s);
2062 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2063 __owur int ssl_verify_alarm_type(long type);
2064 void ssl_sort_cipher_list(void);
2065 void ssl_load_ciphers(void);
2066 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2068 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2070 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2071 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2073 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2075 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2076 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2077 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2079 int ssl3_init_finished_mac(SSL *s);
2080 __owur int ssl3_setup_key_block(SSL *s);
2081 __owur int ssl3_change_cipher_state(SSL *s, int which);
2082 void ssl3_cleanup_key_block(SSL *s);
2083 __owur int ssl3_do_write(SSL *s, int type);
2084 int ssl3_send_alert(SSL *s, int level, int desc);
2085 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2086 unsigned char *p, size_t len,
2087 size_t *secret_size);
2088 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2089 __owur int ssl3_num_ciphers(void);
2090 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2091 int ssl3_renegotiate(SSL *ssl);
2092 int ssl3_renegotiate_check(SSL *ssl, int initok);
2093 __owur int ssl3_dispatch_alert(SSL *s);
2094 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2096 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2097 void ssl3_free_digest_list(SSL *s);
2098 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2099 CERT_PKEY *cpk, int *al);
2100 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2101 STACK_OF(SSL_CIPHER) *clnt,
2102 STACK_OF(SSL_CIPHER) *srvr);
2103 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2104 __owur int ssl3_new(SSL *s);
2105 void ssl3_free(SSL *s);
2106 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2107 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2108 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2109 __owur int ssl3_shutdown(SSL *s);
2110 void ssl3_clear(SSL *s);
2111 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2112 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2113 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2114 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2116 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2117 __owur long ssl3_default_timeout(void);
2119 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2120 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2121 __owur int tls_setup_handshake(SSL *s);
2122 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2123 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2124 __owur int ssl3_handshake_write(SSL *s);
2126 __owur int ssl_allow_compression(SSL *s);
2128 __owur int ssl_version_supported(const SSL *s, int version);
2130 __owur int ssl_set_client_hello_version(SSL *s);
2131 __owur int ssl_check_version_downgrade(SSL *s);
2132 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2133 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello);
2134 __owur int ssl_choose_client_version(SSL *s, int version);
2135 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
2138 __owur long tls1_default_timeout(void);
2139 __owur int dtls1_do_write(SSL *s, int type);
2140 void dtls1_set_message_header(SSL *s,
2143 size_t frag_off, size_t frag_len);
2145 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2148 __owur int dtls1_read_failed(SSL *s, int code);
2149 __owur int dtls1_buffer_message(SSL *s, int ccs);
2150 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2151 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2152 int dtls1_retransmit_buffered_messages(SSL *s);
2153 void dtls1_clear_received_buffer(SSL *s);
2154 void dtls1_clear_sent_buffer(SSL *s);
2155 void dtls1_get_message_header(unsigned char *data,
2156 struct hm_header_st *msg_hdr);
2157 __owur long dtls1_default_timeout(void);
2158 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2159 __owur int dtls1_check_timeout_num(SSL *s);
2160 __owur int dtls1_handle_timeout(SSL *s);
2161 void dtls1_start_timer(SSL *s);
2162 void dtls1_stop_timer(SSL *s);
2163 __owur int dtls1_is_timer_expired(SSL *s);
2164 void dtls1_double_timeout(SSL *s);
2165 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2167 __owur int dtls1_send_newsession_ticket(SSL *s);
2168 __owur size_t dtls1_min_mtu(SSL *s);
2169 void dtls1_hm_fragment_free(hm_fragment *frag);
2170 __owur int dtls1_query_mtu(SSL *s);
2172 __owur int tls1_new(SSL *s);
2173 void tls1_free(SSL *s);
2174 void tls1_clear(SSL *s);
2175 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2176 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2178 __owur int dtls1_new(SSL *s);
2179 void dtls1_free(SSL *s);
2180 void dtls1_clear(SSL *s);
2181 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2182 __owur int dtls1_shutdown(SSL *s);
2184 __owur int dtls1_dispatch_alert(SSL *s);
2186 __owur int ssl_init_wbio_buffer(SSL *s);
2187 void ssl_free_wbio_buffer(SSL *s);
2189 __owur int tls1_change_cipher_state(SSL *s, int which);
2190 __owur int tls1_setup_key_block(SSL *s);
2191 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2193 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2194 unsigned char *p, size_t len,
2195 size_t *secret_size);
2196 __owur int tls13_setup_key_block(SSL *s);
2197 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2199 __owur int tls13_change_cipher_state(SSL *s, int which);
2200 __owur int tls13_update_key(SSL *s, int send);
2201 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2202 const unsigned char *secret,
2203 const unsigned char *label, size_t labellen,
2204 const unsigned char *hash,
2205 unsigned char *out, size_t outlen);
2206 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2207 const unsigned char *secret, unsigned char *key,
2209 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2210 const unsigned char *secret, unsigned char *iv,
2212 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2213 const unsigned char *secret,
2214 unsigned char *fin, size_t finlen);
2215 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2216 const unsigned char *prevsecret,
2217 const unsigned char *insecret,
2219 unsigned char *outsecret);
2220 __owur int tls13_generate_handshake_secret(SSL *s,
2221 const unsigned char *insecret,
2222 size_t insecretlen);
2223 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2224 unsigned char *prev, size_t prevlen,
2225 size_t *secret_size);
2226 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2227 const char *label, size_t llen,
2228 const unsigned char *p, size_t plen,
2230 __owur int tls1_alert_code(int code);
2231 __owur int tls13_alert_code(int code);
2232 __owur int ssl3_alert_code(int code);
2234 # ifndef OPENSSL_NO_EC
2235 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2238 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2240 # ifndef OPENSSL_NO_EC
2241 /* Flags values from tls1_ec_curve_id2nid() */
2242 /* Mask for curve type */
2243 # define TLS_CURVE_TYPE 0x3
2244 # define TLS_CURVE_PRIME 0x0
2245 # define TLS_CURVE_CHAR2 0x1
2246 # define TLS_CURVE_CUSTOM 0x2
2248 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2250 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2251 __owur int tls1_ec_nid2curve_id(int nid);
2252 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2253 __owur int tls1_shared_group(SSL *s, int nmatch);
2254 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2255 int *curves, size_t ncurves);
2256 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2258 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2259 size_t *num_formats);
2260 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2261 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2262 # endif /* OPENSSL_NO_EC */
2264 __owur int tls1_shared_list(SSL *s,
2265 const unsigned char *l1, size_t l1len,
2266 const unsigned char *l2, size_t l2len, int nmatch);
2267 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2268 __owur int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2269 size_t *num_curves);
2271 void ssl_set_default_md(SSL *s);
2272 __owur int tls1_set_server_sigalgs(SSL *s);
2274 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2275 typedef enum ticket_en {
2276 /* fatal error, malloc failure */
2277 TICKET_FATAL_ERR_MALLOC,
2278 /* fatal error, either from parsing or decrypting the ticket */
2279 TICKET_FATAL_ERR_OTHER,
2280 /* No ticket present */
2282 /* Empty ticket present */
2284 /* the ticket couldn't be decrypted */
2286 /* a ticket was successfully decrypted */
2288 /* same as above but the ticket needs to be reneewed */
2289 TICKET_SUCCESS_RENEW
2292 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2294 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2296 const unsigned char *sess_id,
2297 size_t sesslen, SSL_SESSION **psess);
2299 __owur int tls_use_ticket(SSL *s);
2301 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2303 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2304 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2306 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2308 void tls1_set_cert_validity(SSL *s);
2310 # ifndef OPENSSL_NO_CT
2311 __owur int ssl_validate_ct(SSL *s);
2314 # ifndef OPENSSL_NO_DH
2315 __owur DH *ssl_get_auto_dh(SSL *s);
2318 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2319 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2322 int tls_choose_sigalg(SSL *s, int *al);
2324 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2325 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2326 __owur long ssl_get_algorithm2(SSL *s);
2327 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2328 const uint16_t *psig, size_t psiglen);
2329 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2330 __owur int tls1_process_sigalgs(SSL *s);
2331 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2332 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2333 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2334 void ssl_set_client_disabled(SSL *s);
2335 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2337 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2339 __owur const EVP_MD *ssl_md(int idx);
2340 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2341 __owur const EVP_MD *ssl_prf_md(SSL *s);
2344 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2345 * with |ssl|, if logging is enabled. It returns one on success and zero on
2346 * failure. The entry is identified by the first 8 bytes of
2347 * |encrypted_premaster|.
2349 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2350 const uint8_t *encrypted_premaster,
2351 size_t encrypted_premaster_len,
2352 const uint8_t *premaster,
2353 size_t premaster_len);
2356 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2357 * logging is available. It returns one on success and zero on failure. It tags
2358 * the entry with |label|.
2360 __owur int ssl_log_secret(SSL *ssl, const char *label,
2361 const uint8_t *secret, size_t secret_len);
2363 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2364 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2365 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2366 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2367 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2368 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2371 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2372 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2373 unsigned char *md_out,
2374 size_t *md_out_size,
2375 const unsigned char header[13],
2376 const unsigned char *data,
2377 size_t data_plus_mac_size,
2378 size_t data_plus_mac_plus_padding_size,
2379 const unsigned char *mac_secret,
2380 size_t mac_secret_length, char is_sslv3);
2382 __owur int srp_generate_server_master_secret(SSL *s);
2383 __owur int srp_generate_client_master_secret(SSL *s);
2384 __owur int srp_verify_server_param(SSL *s, int *al);
2388 void custom_ext_init(custom_ext_methods *meths);
2390 __owur int custom_ext_parse(SSL *s, int server,
2391 unsigned int ext_type,
2392 const unsigned char *ext_data, size_t ext_size,
2394 __owur int custom_ext_add(SSL *s, int server, WPACKET *pkt, int *al);
2396 __owur int custom_exts_copy(custom_ext_methods *dst,
2397 const custom_ext_methods *src);
2398 void custom_exts_free(custom_ext_methods *exts);
2400 void ssl_comp_free_compression_methods_int(void);
2402 # else /* OPENSSL_UNIT_TEST */
2404 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2405 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers