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_STATE;
624 #define MAX_COMPRESSIONS_SIZE 255
632 typedef struct raw_extension_st {
633 /* Raw packet data for the extension */
635 /* Set to 1 if the extension is present or 0 otherwise */
637 /* Set to 1 if we have already parsed the extension or 0 otherwise */
639 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
645 unsigned int legacy_version;
646 unsigned char random[SSL3_RANDOM_SIZE];
647 size_t session_id_len;
648 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
649 size_t dtls_cookie_len;
650 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
652 size_t compressions_len;
653 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
655 size_t pre_proc_exts_len;
656 RAW_EXTENSION *pre_proc_exts;
659 DEFINE_LHASH_OF(SSL_SESSION);
660 /* Needed in ssl_cert.c */
661 DEFINE_LHASH_OF(X509_NAME);
663 # define TLSEXT_KEYNAME_LENGTH 16
666 const SSL_METHOD *method;
667 STACK_OF(SSL_CIPHER) *cipher_list;
668 /* same as above but sorted for lookup */
669 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
670 struct x509_store_st /* X509_STORE */ *cert_store;
671 LHASH_OF(SSL_SESSION) *sessions;
673 * Most session-ids that will be cached, default is
674 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
676 size_t session_cache_size;
677 struct ssl_session_st *session_cache_head;
678 struct ssl_session_st *session_cache_tail;
680 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
681 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
682 * means only SSL_accept which cache SSL_SESSIONS.
684 uint32_t session_cache_mode;
686 * If timeout is not 0, it is the default timeout value set when
687 * SSL_new() is called. This has been put in to make life easier to set
690 long session_timeout;
692 * If this callback is not null, it will be called each time a session id
693 * is added to the cache. If this function returns 1, it means that the
694 * callback will do a SSL_SESSION_free() when it has finished using it.
695 * Otherwise, on 0, it means the callback has finished with it. If
696 * remove_session_cb is not null, it will be called when a session-id is
697 * removed from the cache. After the call, OpenSSL will
698 * SSL_SESSION_free() it.
700 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
701 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
702 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
703 const unsigned char *data, int len,
706 int sess_connect; /* SSL new conn - started */
707 int sess_connect_renegotiate; /* SSL reneg - requested */
708 int sess_connect_good; /* SSL new conne/reneg - finished */
709 int sess_accept; /* SSL new accept - started */
710 int sess_accept_renegotiate; /* SSL reneg - requested */
711 int sess_accept_good; /* SSL accept/reneg - finished */
712 int sess_miss; /* session lookup misses */
713 int sess_timeout; /* reuse attempt on timeouted session */
714 int sess_cache_full; /* session removed due to full cache */
715 int sess_hit; /* session reuse actually done */
716 int sess_cb_hit; /* session-id that was not in the cache was
717 * passed back via the callback. This
718 * indicates that the application is supplying
719 * session-id's from other processes - spooky
723 CRYPTO_REF_COUNT references;
725 /* if defined, these override the X509_verify_cert() calls */
726 int (*app_verify_callback) (X509_STORE_CTX *, void *);
727 void *app_verify_arg;
729 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
730 * ('app_verify_callback' was called with just one argument)
733 /* Default password callback. */
734 pem_password_cb *default_passwd_callback;
736 /* Default password callback user data. */
737 void *default_passwd_callback_userdata;
739 /* get client cert callback */
740 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
742 /* cookie generate callback */
743 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
744 unsigned int *cookie_len);
746 /* verify cookie callback */
747 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
748 unsigned int cookie_len);
750 CRYPTO_EX_DATA ex_data;
752 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
753 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
755 STACK_OF(X509) *extra_certs;
756 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
758 /* Default values used when no per-SSL value is defined follow */
760 /* used if SSL's info_callback is NULL */
761 void (*info_callback) (const SSL *ssl, int type, int val);
763 /* what we put in client cert requests */
764 STACK_OF(X509_NAME) *client_CA;
767 * Default values to use in SSL structures follow (these are copied by
773 int min_proto_version;
774 int max_proto_version;
775 size_t max_cert_list;
777 struct cert_st /* CERT */ *cert;
780 /* callback that allows applications to peek at protocol messages */
781 void (*msg_callback) (int write_p, int version, int content_type,
782 const void *buf, size_t len, SSL *ssl, void *arg);
783 void *msg_callback_arg;
785 uint32_t verify_mode;
786 size_t sid_ctx_length;
787 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
788 /* called 'verify_callback' in the SSL */
789 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
791 /* Default generate session ID callback. */
792 GEN_SESSION_CB generate_session_id;
794 X509_VERIFY_PARAM *param;
798 # ifndef OPENSSL_NO_CT
799 CTLOG_STORE *ctlog_store; /* CT Log Store */
801 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
802 * If they are not, the connection should be aborted.
804 ssl_ct_validation_cb ct_validation_callback;
805 void *ct_validation_callback_arg;
809 * If we're using more than one pipeline how should we divide the data
810 * up between the pipes?
812 size_t split_send_fragment;
814 * Maximum amount of data to send in one fragment. actual record size can
815 * be more than this due to padding and MAC overheads.
817 size_t max_send_fragment;
819 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
820 size_t max_pipelines;
822 /* The default read buffer length to use (0 means not set) */
823 size_t default_read_buf_len;
825 # ifndef OPENSSL_NO_ENGINE
827 * Engine to pass requests for client certs to
829 ENGINE *client_cert_engine;
832 /* Early callback. Mostly for extensions, but not entirely. */
833 SSL_early_cb_fn early_cb;
836 /* TLS extensions. */
838 /* TLS extensions servername callback */
839 int (*servername_cb) (SSL *, int *, void *);
840 void *servername_arg;
841 /* RFC 4507 session ticket keys */
842 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
843 unsigned char tick_hmac_key[32];
844 unsigned char tick_aes_key[32];
845 /* Callback to support customisation of ticket key setting */
846 int (*ticket_key_cb) (SSL *ssl,
847 unsigned char *name, unsigned char *iv,
848 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
850 /* certificate status request info */
851 /* Callback for status request */
852 int (*status_cb) (SSL *ssl, void *arg);
854 /* ext status type used for CSR extension (OCSP Stapling) */
857 # ifndef OPENSSL_NO_EC
858 /* EC extension values inherited by SSL structure */
859 size_t ecpointformats_len;
860 unsigned char *ecpointformats;
861 size_t supportedgroups_len;
862 unsigned char *supportedgroups;
863 # endif /* OPENSSL_NO_EC */
866 * ALPN information (we are in the process of transitioning from NPN to
871 * For a server, this contains a callback function that allows the
872 * server to select the protocol for the connection.
873 * out: on successful return, this must point to the raw protocol
874 * name (without the length prefix).
875 * outlen: on successful return, this contains the length of |*out|.
876 * in: points to the client's list of supported protocols in
878 * inlen: the length of |in|.
880 int (*alpn_select_cb) (SSL *s,
881 const unsigned char **out,
882 unsigned char *outlen,
883 const unsigned char *in,
884 unsigned int inlen, void *arg);
885 void *alpn_select_cb_arg;
888 * For a client, this contains the list of supported protocols in wire
894 # ifndef OPENSSL_NO_NEXTPROTONEG
895 /* Next protocol negotiation information */
898 * For a server, this contains a callback function by which the set of
899 * advertised protocols can be provided.
901 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
902 void *npn_advertised_cb_arg;
904 * For a client, this contains a callback function that selects the next
905 * protocol from the list provided by the server.
907 SSL_CTX_npn_select_cb_func npn_select_cb;
908 void *npn_select_cb_arg;
912 # ifndef OPENSSL_NO_PSK
913 SSL_psk_client_cb_func psk_client_callback;
914 SSL_psk_server_cb_func psk_server_callback;
917 # ifndef OPENSSL_NO_SRP
918 SRP_CTX srp_ctx; /* ctx for SRP authentication */
921 /* Shared DANE context */
922 struct dane_ctx_st dane;
924 /* SRTP profiles we are willing to do from RFC 5764 */
925 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
927 * Callback for disabling session caching and ticket support on a session
928 * basis, depending on the chosen cipher.
930 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
935 * Callback for logging key material for use with debugging tools like
936 * Wireshark. The callback should log `line` followed by a newline.
938 SSL_CTX_keylog_cb_func keylog_callback;
940 /* The maximum number of bytes that can be sent as early data */
941 uint32_t max_early_data;
946 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
951 const SSL_METHOD *method;
953 * There are 2 BIO's even though they are normally both the same. This
954 * is so data can be read and written to different handlers
956 /* used by SSL_read */
958 /* used by SSL_write */
960 /* used during session-id reuse to concatenate messages */
963 * This holds a variable that indicates what we were doing when a 0 or -1
964 * is returned. This is needed for non-blocking IO so we know what
965 * request needs re-doing when in SSL_accept or SSL_connect
968 int (*handshake_func) (SSL *);
970 * Imagine that here's a boolean member "init" that is switched as soon
971 * as SSL_set_{accept/connect}_state is called for the first time, so
972 * that "state" and "handshake_func" are properly initialized. But as
973 * handshake_func is == 0 until then, we use this test instead of an
976 /* are we the server side? */
979 * Generate a new session or reuse an old one.
980 * NB: For servers, the 'new' session may actually be a previously
981 * cached session or even the previous session unless
982 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
985 /* don't send shutdown packets */
987 /* we have shut things down, 0x01 sent, 0x02 for received */
991 SSL_EARLY_DATA_STATE early_data_state;
992 BUF_MEM *init_buf; /* buffer used during init */
993 void *init_msg; /* pointer to handshake message body, set by
994 * ssl3_get_message() */
995 size_t init_num; /* amount read/written */
996 size_t init_off; /* amount read/written */
997 struct ssl3_state_st *s3; /* SSLv3 variables */
998 struct dtls1_state_st *d1; /* DTLSv1 variables */
999 /* callback that allows applications to peek at protocol messages */
1000 void (*msg_callback) (int write_p, int version, int content_type,
1001 const void *buf, size_t len, SSL *ssl, void *arg);
1002 void *msg_callback_arg;
1003 int hit; /* reusing a previous session */
1004 X509_VERIFY_PARAM *param;
1005 /* Per connection DANE state */
1008 STACK_OF(SSL_CIPHER) *cipher_list;
1009 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1011 * These are the ones being used, the ones in SSL_SESSION are the ones to
1012 * be 'copied' into these ones
1016 * The TLS1.3 secrets. The resumption master secret is stored in the
1019 unsigned char early_secret[EVP_MAX_MD_SIZE];
1020 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1021 unsigned char master_secret[EVP_MAX_MD_SIZE];
1022 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1023 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1024 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1025 unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1026 unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1027 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1028 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1029 EVP_MD_CTX *read_hash; /* used for mac generation */
1030 COMP_CTX *compress; /* compression */
1031 COMP_CTX *expand; /* uncompress */
1032 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1033 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1034 EVP_MD_CTX *write_hash; /* used for mac generation */
1035 /* Count of how many KeyUpdate messages we have received */
1036 unsigned int key_update_count;
1039 /* This is used to hold the server certificate used */
1040 struct cert_st /* CERT */ *cert;
1043 * The hash of all messages prior to the CertificateVerify, and the length
1046 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1047 size_t cert_verify_hash_len;
1049 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1050 int hello_retry_request;
1053 * the session_id_context is used to ensure sessions are only reused in
1054 * the appropriate context
1056 size_t sid_ctx_length;
1057 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1058 /* This can also be in the session once a session is established */
1059 SSL_SESSION *session;
1060 /* Default generate session ID callback. */
1061 GEN_SESSION_CB generate_session_id;
1064 * 0 don't care about verify failure.
1065 * 1 fail if verify fails
1067 uint32_t verify_mode;
1068 /* fail if callback returns 0 */
1069 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1070 /* optional informational callback */
1071 void (*info_callback) (const SSL *ssl, int type, int val);
1072 /* error bytes to be written */
1076 # ifndef OPENSSL_NO_PSK
1077 SSL_psk_client_cb_func psk_client_callback;
1078 SSL_psk_server_cb_func psk_server_callback;
1081 /* Verified chain of peer */
1082 STACK_OF(X509) *verified_chain;
1084 /* extra application data */
1085 CRYPTO_EX_DATA ex_data;
1086 /* for server side, keep the list of CA_dn we can use */
1087 STACK_OF(X509_NAME) *client_CA;
1088 CRYPTO_REF_COUNT references;
1089 /* protocol behaviour */
1093 int min_proto_version;
1094 int max_proto_version;
1095 size_t max_cert_list;
1098 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1099 * secret and SSLv3/TLS (<=1.2) rollback check
1103 * If we're using more than one pipeline how should we divide the data
1104 * up between the pipes?
1106 size_t split_send_fragment;
1108 * Maximum amount of data to send in one fragment. actual record size can
1109 * be more than this due to padding and MAC overheads.
1111 size_t max_send_fragment;
1112 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1113 size_t max_pipelines;
1116 /* TLS extension debug callback */
1117 void (*debug_cb)(SSL *s, int client_server, int type,
1118 const unsigned char *data, int len, void *arg);
1121 /* certificate status request info */
1122 /* Status type or -1 if no status type */
1124 /* Raw extension data, if seen */
1125 unsigned char *scts;
1126 /* Length of raw extension data, if seen */
1128 /* Expect OCSP CertificateStatus message */
1129 int status_expected;
1132 /* OCSP status request only */
1133 STACK_OF(OCSP_RESPID) *ids;
1134 X509_EXTENSIONS *exts;
1135 /* OCSP response received or to be sent */
1136 unsigned char *resp;
1140 /* RFC4507 session ticket expected to be received or sent */
1141 int ticket_expected;
1142 # ifndef OPENSSL_NO_EC
1143 size_t ecpointformats_len;
1145 unsigned char *ecpointformats;
1146 size_t supportedgroups_len;
1148 unsigned char *supportedgroups;
1149 # endif /* OPENSSL_NO_EC */
1150 /* TLS Session Ticket extension override */
1151 TLS_SESSION_TICKET_EXT *session_ticket;
1152 /* TLS Session Ticket extension callback */
1153 tls_session_ticket_ext_cb_fn session_ticket_cb;
1154 void *session_ticket_cb_arg;
1155 /* TLS pre-shared secret session resumption */
1156 tls_session_secret_cb_fn session_secret_cb;
1157 void *session_secret_cb_arg;
1159 * For a client, this contains the list of supported protocols in wire
1162 unsigned char *alpn;
1165 * Next protocol negotiation. For the client, this is the protocol that
1166 * we sent in NextProtocol and is set when handling ServerHello
1167 * extensions. For a server, this is the client's selected_protocol from
1168 * NextProtocol and is set when handling the NextProtocol message, before
1169 * the Finished message.
1174 /* The available PSK key exchange modes */
1177 /* Set to one if we have negotiated ETM */
1181 /* Parsed form of the ClientHello, kept around across early_cb calls. */
1182 CLIENTHELLO_MSG *clienthello;
1185 * no further mod of servername
1186 * 0 : call the servername extension callback.
1187 * 1 : prepare 2, allow last ack just after in server callback.
1188 * 2 : don't call servername callback, no ack in server hello
1190 int servername_done;
1191 # ifndef OPENSSL_NO_CT
1193 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1194 * If they are not, the connection should be aborted.
1196 ssl_ct_validation_cb ct_validation_callback;
1197 /* User-supplied argument that is passed to the ct_validation_callback */
1198 void *ct_validation_callback_arg;
1200 * Consolidated stack of SCTs from all sources.
1201 * Lazily populated by CT_get_peer_scts(SSL*)
1203 STACK_OF(SCT) *scts;
1204 /* Have we attempted to find/parse SCTs yet? */
1207 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1209 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1210 /* What's been chosen */
1211 SRTP_PROTECTION_PROFILE *srtp_profile;
1213 * 1 if we are renegotiating.
1214 * 2 if we are a server and are inside a handshake
1215 * (i.e. not just sending a HelloRequest)
1218 /* If sending a KeyUpdate is pending */
1220 # ifndef OPENSSL_NO_SRP
1221 /* ctx for SRP authentication */
1225 * Callback for disabling session caching and ticket support on a session
1226 * basis, depending on the chosen cipher.
1228 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1229 RECORD_LAYER rlayer;
1230 /* Default password callback. */
1231 pem_password_cb *default_passwd_callback;
1232 /* Default password callback user data. */
1233 void *default_passwd_callback_userdata;
1234 /* Async Job info */
1236 ASYNC_WAIT_CTX *waitctx;
1239 /* The maximum number of bytes that can be sent as early data */
1240 uint32_t max_early_data;
1242 CRYPTO_RWLOCK *lock;
1246 * Structure containing table entry of values associated with the signature
1247 * algorithms (signature scheme) extension
1249 typedef struct sigalg_lookup_st {
1250 /* TLS 1.3 signature scheme name */
1252 /* Raw value used in extension */
1254 /* NID of hash algorithm */
1256 /* Index of hash algorithm */
1258 /* NID of signature algorithm */
1260 /* Index of signature algorithm */
1262 /* Combined hash and signature NID, if any */
1264 /* Required public key curve (ECDSA only) */
1268 typedef struct cert_pkey_st CERT_PKEY;
1270 typedef struct ssl3_state_st {
1272 size_t read_mac_secret_size;
1273 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1274 size_t write_mac_secret_size;
1275 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1276 unsigned char server_random[SSL3_RANDOM_SIZE];
1277 unsigned char client_random[SSL3_RANDOM_SIZE];
1278 /* flags for countermeasure against known-IV weakness */
1279 int need_empty_fragments;
1280 int empty_fragment_done;
1281 /* used during startup, digest all incoming/outgoing packets */
1282 BIO *handshake_buffer;
1284 * When handshake digest is determined, buffer is hashed and
1285 * freed and MD_CTX for the required digest is stored here.
1287 EVP_MD_CTX *handshake_dgst;
1289 * Set whenever an expected ChangeCipherSpec message is processed.
1290 * Unset when the peer's Finished message is received.
1291 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1293 int change_cipher_spec;
1297 * we allow one fatal and one warning alert to be outstanding, send close
1298 * alert via the warning alert
1301 unsigned char send_alert[2];
1303 * This flag is set when we should renegotiate ASAP, basically when there
1304 * is no more data in the read or write buffers
1307 int total_renegotiations;
1308 int num_renegotiations;
1309 int in_read_app_data;
1311 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1312 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1313 size_t finish_md_len;
1314 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1315 size_t peer_finish_md_len;
1316 size_t message_size;
1318 /* used to hold the new cipher we are going to use */
1319 const SSL_CIPHER *new_cipher;
1320 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1321 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1323 /* used for certificate requests */
1325 /* Certificate types in certificate request message. */
1328 STACK_OF(X509_NAME) *ca_names;
1329 size_t key_block_length;
1330 unsigned char *key_block;
1331 const EVP_CIPHER *new_sym_enc;
1332 const EVP_MD *new_hash;
1333 int new_mac_pkey_type;
1334 size_t new_mac_secret_size;
1335 # ifndef OPENSSL_NO_COMP
1336 const SSL_COMP *new_compression;
1338 char *new_compression;
1341 /* Raw values of the cipher list from a client */
1342 unsigned char *ciphers_raw;
1343 size_t ciphers_rawlen;
1344 /* Temporary storage for premaster secret */
1347 # ifndef OPENSSL_NO_PSK
1348 /* Temporary storage for PSK key */
1352 /* Signature algorithm we actually use */
1353 const SIGALG_LOOKUP *sigalg;
1354 /* Pointer to certificate we use */
1357 * signature algorithms peer reports: e.g. supported signature
1358 * algorithms extension for server or as part of a certificate
1359 * request for client.
1361 uint16_t *peer_sigalgs;
1362 /* Size of above array */
1363 size_t peer_sigalgslen;
1364 /* Sigalg peer actualy uses */
1365 const SIGALG_LOOKUP *peer_sigalg;
1367 * Set if corresponding CERT_PKEY can be used with current
1368 * SSL session: e.g. appropriate curve, signature algorithms etc.
1369 * If zero it can't be used at all.
1371 uint32_t valid_flags[SSL_PKEY_NUM];
1373 * For servers the following masks are for the key and auth algorithms
1374 * that are supported by the certs below. For clients they are masks of
1375 * *disabled* algorithms based on the current session.
1380 * The following are used by the client to see if a cipher is allowed or
1381 * not. It contains the minimum and maximum version the client's using
1382 * based on what it knows so far.
1388 /* Connection binding to prevent renegotiation attacks */
1389 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1390 size_t previous_client_finished_len;
1391 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1392 size_t previous_server_finished_len;
1393 int send_connection_binding; /* TODOEKR */
1395 # ifndef OPENSSL_NO_NEXTPROTONEG
1397 * Set if we saw the Next Protocol Negotiation extension from our peer.
1403 * ALPN information (we are in the process of transitioning from NPN to
1408 * In a server these point to the selected ALPN protocol after the
1409 * ClientHello has been processed. In a client these contain the protocol
1410 * that the server selected once the ServerHello has been processed.
1412 unsigned char *alpn_selected;
1413 size_t alpn_selected_len;
1414 /* used by the server to know what options were proposed */
1415 unsigned char *alpn_proposed;
1416 size_t alpn_proposed_len;
1417 /* used by the client to know if it actually sent alpn */
1420 # ifndef OPENSSL_NO_EC
1422 * This is set to true if we believe that this is a version of Safari
1423 * running on OS X 10.6 or newer. We wish to know this because Safari on
1424 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1426 char is_probably_safari;
1427 # endif /* !OPENSSL_NO_EC */
1429 /* For clients: peer temporary key */
1430 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1431 /* The group_id for the DH/ECDH key */
1432 unsigned int group_id;
1438 /* DTLS structures */
1440 # ifndef OPENSSL_NO_SCTP
1441 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1444 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1445 # define DTLS1_MAX_MTU_OVERHEAD 48
1448 * Flag used in message reuse to indicate the buffer contains the record
1449 * header as well as the the handshake message header.
1451 # define DTLS1_SKIP_RECORD_HEADER 2
1453 struct dtls1_retransmit_state {
1454 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1455 EVP_MD_CTX *write_hash; /* used for mac generation */
1456 COMP_CTX *compress; /* compression */
1457 SSL_SESSION *session;
1458 unsigned short epoch;
1461 struct hm_header_st {
1467 unsigned int is_ccs;
1468 struct dtls1_retransmit_state saved_retransmit_state;
1471 struct dtls1_timeout_st {
1472 /* Number of read timeouts so far */
1473 unsigned int read_timeouts;
1474 /* Number of write timeouts so far */
1475 unsigned int write_timeouts;
1476 /* Number of alerts received so far */
1477 unsigned int num_alerts;
1480 typedef struct hm_fragment_st {
1481 struct hm_header_st msg_header;
1482 unsigned char *fragment;
1483 unsigned char *reassembly;
1486 typedef struct pqueue_st pqueue;
1487 typedef struct pitem_st pitem;
1490 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1495 typedef struct pitem_st *piterator;
1497 pitem *pitem_new(unsigned char *prio64be, void *data);
1498 void pitem_free(pitem *item);
1499 pqueue *pqueue_new(void);
1500 void pqueue_free(pqueue *pq);
1501 pitem *pqueue_insert(pqueue *pq, pitem *item);
1502 pitem *pqueue_peek(pqueue *pq);
1503 pitem *pqueue_pop(pqueue *pq);
1504 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1505 pitem *pqueue_iterator(pqueue *pq);
1506 pitem *pqueue_next(piterator *iter);
1507 size_t pqueue_size(pqueue *pq);
1509 typedef struct dtls1_state_st {
1510 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1512 unsigned int cookie_verified;
1513 /* handshake message numbers */
1514 unsigned short handshake_write_seq;
1515 unsigned short next_handshake_write_seq;
1516 unsigned short handshake_read_seq;
1517 /* Buffered handshake messages */
1518 pqueue *buffered_messages;
1519 /* Buffered (sent) handshake records */
1520 pqueue *sent_messages;
1521 size_t link_mtu; /* max on-the-wire DTLS packet size */
1522 size_t mtu; /* max DTLS packet size */
1523 struct hm_header_st w_msg_hdr;
1524 struct hm_header_st r_msg_hdr;
1525 struct dtls1_timeout_st timeout;
1527 * Indicates when the last handshake msg sent will timeout
1529 struct timeval next_timeout;
1530 /* Timeout duration */
1531 unsigned short timeout_duration;
1532 unsigned int retransmitting;
1533 # ifndef OPENSSL_NO_SCTP
1534 int shutdown_received;
1538 # ifndef OPENSSL_NO_EC
1540 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1542 # define EXPLICIT_PRIME_CURVE_TYPE 1
1543 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1544 # define NAMED_CURVE_TYPE 3
1545 # endif /* OPENSSL_NO_EC */
1547 struct cert_pkey_st {
1549 EVP_PKEY *privatekey;
1550 /* Chain for this certificate */
1551 STACK_OF(X509) *chain;
1553 * serverinfo data for this certificate. The data is in TLS Extension
1554 * wire format, specifically it's a series of records like:
1555 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1557 * uint8_t data[length];
1559 unsigned char *serverinfo;
1560 size_t serverinfo_length;
1562 /* Retrieve Suite B flags */
1563 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1564 /* Uses to check strict mode: suite B modes are always strict */
1565 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1566 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1569 unsigned short ext_type;
1571 * Per-connection flags relating to this extension type: not used if
1572 * part of an SSL_CTX structure.
1575 custom_ext_add_cb add_cb;
1576 custom_ext_free_cb free_cb;
1578 custom_ext_parse_cb parse_cb;
1580 } custom_ext_method;
1582 /* ext_flags values */
1585 * Indicates an extension has been received. Used to check for unsolicited or
1586 * duplicate extensions.
1588 # define SSL_EXT_FLAG_RECEIVED 0x1
1590 * Indicates an extension has been sent: used to enable sending of
1591 * corresponding ServerHello extension.
1593 # define SSL_EXT_FLAG_SENT 0x2
1596 custom_ext_method *meths;
1598 } custom_ext_methods;
1600 typedef struct cert_st {
1601 /* Current active set */
1603 * ALWAYS points to an element of the pkeys array
1604 * Probably it would make more sense to store
1605 * an index, not a pointer.
1608 # ifndef OPENSSL_NO_DH
1610 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1613 /* Flags related to certificates */
1614 uint32_t cert_flags;
1615 CERT_PKEY pkeys[SSL_PKEY_NUM];
1616 /* Custom certificate types sent in certificate request message. */
1620 * supported signature algorithms. When set on a client this is sent in
1621 * the client hello as the supported signature algorithms extension. For
1622 * servers it represents the signature algorithms we are willing to use.
1624 uint16_t *conf_sigalgs;
1625 /* Size of above array */
1626 size_t conf_sigalgslen;
1628 * Client authentication signature algorithms, if not set then uses
1629 * conf_sigalgs. On servers these will be the signature algorithms sent
1630 * to the client in a certificate request for TLS 1.2. On a client this
1631 * represents the signature algorithms we are willing to use for client
1634 uint16_t *client_sigalgs;
1635 /* Size of above array */
1636 size_t client_sigalgslen;
1638 * Signature algorithms shared by client and server: cached because these
1639 * are used most often.
1641 const SIGALG_LOOKUP **shared_sigalgs;
1642 size_t shared_sigalgslen;
1644 * Certificate setup callback: if set is called whenever a certificate
1645 * may be required (client or server). the callback can then examine any
1646 * appropriate parameters and setup any certificates required. This
1647 * allows advanced applications to select certificates on the fly: for
1648 * example based on supported signature algorithms or curves.
1650 int (*cert_cb) (SSL *ssl, void *arg);
1653 * Optional X509_STORE for chain building or certificate validation If
1654 * NULL the parent SSL_CTX store is used instead.
1656 X509_STORE *chain_store;
1657 X509_STORE *verify_store;
1658 /* Custom extension methods for server and client */
1659 custom_ext_methods cli_ext;
1660 custom_ext_methods srv_ext;
1661 /* Security callback */
1662 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1663 void *other, void *ex);
1664 /* Security level */
1667 # ifndef OPENSSL_NO_PSK
1668 /* If not NULL psk identity hint to use for servers */
1669 char *psk_identity_hint;
1671 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1672 CRYPTO_RWLOCK *lock;
1675 # define FP_ICC (int (*)(const void *,const void *))
1678 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1679 * of a mess of functions, but hell, think of it as an opaque structure :-)
1681 typedef struct ssl3_enc_method {
1682 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1683 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1684 int (*setup_key_block) (SSL *);
1685 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1687 int (*change_cipher_state) (SSL *, int);
1688 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1689 const char *client_finished_label;
1690 size_t client_finished_label_len;
1691 const char *server_finished_label;
1692 size_t server_finished_label_len;
1693 int (*alert_value) (int);
1694 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1695 const char *, size_t,
1696 const unsigned char *, size_t,
1698 /* Various flags indicating protocol version requirements */
1700 /* Set the handshake header */
1701 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1702 /* Close construction of the handshake message */
1703 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1704 /* Write out handshake message */
1705 int (*do_write) (SSL *s);
1708 # define ssl_set_handshake_header(s, pkt, htype) \
1709 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1710 # define ssl_close_construct_packet(s, pkt, htype) \
1711 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1712 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1714 /* Values for enc_flags */
1716 /* Uses explicit IV for CBC mode */
1717 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1718 /* Uses signature algorithms extension */
1719 # define SSL_ENC_FLAG_SIGALGS 0x2
1720 /* Uses SHA256 default PRF */
1721 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1723 # define SSL_ENC_FLAG_DTLS 0x8
1725 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1726 * apply to others in future.
1728 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1730 # ifndef OPENSSL_NO_COMP
1731 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1732 typedef struct ssl3_comp_st {
1733 int comp_id; /* The identifier byte for this compression
1735 char *name; /* Text name used for the compression type */
1736 COMP_METHOD *method; /* The method :-) */
1741 * Extension index values NOTE: Any updates to these defines should be mirrored
1742 * with equivalent updates to ext_defs in extensions.c
1744 typedef enum tlsext_index_en {
1745 TLSEXT_IDX_renegotiate,
1746 TLSEXT_IDX_server_name,
1748 TLSEXT_IDX_early_data_info,
1749 TLSEXT_IDX_early_data,
1750 TLSEXT_IDX_ec_point_formats,
1751 TLSEXT_IDX_supported_groups,
1752 TLSEXT_IDX_session_ticket,
1753 TLSEXT_IDX_signature_algorithms,
1754 TLSEXT_IDX_status_request,
1755 TLSEXT_IDX_next_proto_neg,
1756 TLSEXT_IDX_application_layer_protocol_negotiation,
1757 TLSEXT_IDX_use_srtp,
1758 TLSEXT_IDX_encrypt_then_mac,
1759 TLSEXT_IDX_signed_certificate_timestamp,
1760 TLSEXT_IDX_extended_master_secret,
1761 TLSEXT_IDX_supported_versions,
1762 TLSEXT_IDX_psk_kex_modes,
1763 TLSEXT_IDX_key_share,
1764 TLSEXT_IDX_cryptopro_bug,
1770 * Dummy status type for the status_type extension. Indicates no status type
1773 #define TLSEXT_STATUSTYPE_nothing -1
1775 /* Sigalgs values */
1776 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1777 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1778 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1779 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1780 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1781 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1782 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1783 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1784 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1785 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1786 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1787 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1788 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1789 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1790 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1791 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1792 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1793 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1795 /* Known PSK key exchange modes */
1796 #define TLSEXT_KEX_MODE_KE 0x00
1797 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1800 * Internal representations of key exchange modes
1802 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1803 #define TLSEXT_KEX_MODE_FLAG_KE 1
1804 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1806 /* An invalid index into the TLSv1.3 PSK identities */
1807 #define TLSEXT_PSK_BAD_IDENTITY -1
1809 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1810 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1812 /* A dummy signature value not valid for TLSv1.2 signature algs */
1813 #define TLSEXT_signature_rsa_pss 0x0101
1816 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1818 __owur const SSL_METHOD *ssl_bad_method(int ver);
1819 __owur const SSL_METHOD *sslv3_method(void);
1820 __owur const SSL_METHOD *sslv3_server_method(void);
1821 __owur const SSL_METHOD *sslv3_client_method(void);
1822 __owur const SSL_METHOD *tlsv1_method(void);
1823 __owur const SSL_METHOD *tlsv1_server_method(void);
1824 __owur const SSL_METHOD *tlsv1_client_method(void);
1825 __owur const SSL_METHOD *tlsv1_1_method(void);
1826 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1827 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1828 __owur const SSL_METHOD *tlsv1_2_method(void);
1829 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1830 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1831 __owur const SSL_METHOD *tlsv1_3_method(void);
1832 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1833 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1834 __owur const SSL_METHOD *dtlsv1_method(void);
1835 __owur const SSL_METHOD *dtlsv1_server_method(void);
1836 __owur const SSL_METHOD *dtlsv1_client_method(void);
1837 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1838 __owur const SSL_METHOD *dtlsv1_2_method(void);
1839 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1840 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1842 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1843 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1844 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1845 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1846 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1847 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1848 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1851 * Flags for SSL methods
1853 # define SSL_METHOD_NO_FIPS (1U<<0)
1854 # define SSL_METHOD_NO_SUITEB (1U<<1)
1856 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1857 s_connect, enc_data) \
1858 const SSL_METHOD *func_name(void) \
1860 static const SSL_METHOD func_name##_data= { \
1874 ssl3_renegotiate_check, \
1877 ssl3_dispatch_alert, \
1880 ssl3_get_cipher_by_char, \
1881 ssl3_put_cipher_by_char, \
1885 tls1_default_timeout, \
1887 ssl_undefined_void_function, \
1888 ssl3_callback_ctrl, \
1889 ssl3_ctx_callback_ctrl, \
1891 return &func_name##_data; \
1894 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1895 const SSL_METHOD *func_name(void) \
1897 static const SSL_METHOD func_name##_data= { \
1899 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1911 ssl3_renegotiate_check, \
1914 ssl3_dispatch_alert, \
1917 ssl3_get_cipher_by_char, \
1918 ssl3_put_cipher_by_char, \
1922 ssl3_default_timeout, \
1924 ssl_undefined_void_function, \
1925 ssl3_callback_ctrl, \
1926 ssl3_ctx_callback_ctrl, \
1928 return &func_name##_data; \
1931 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1932 s_connect, enc_data) \
1933 const SSL_METHOD *func_name(void) \
1935 static const SSL_METHOD func_name##_data= { \
1949 ssl3_renegotiate_check, \
1951 dtls1_write_app_data_bytes, \
1952 dtls1_dispatch_alert, \
1955 ssl3_get_cipher_by_char, \
1956 ssl3_put_cipher_by_char, \
1960 dtls1_default_timeout, \
1962 ssl_undefined_void_function, \
1963 ssl3_callback_ctrl, \
1964 ssl3_ctx_callback_ctrl, \
1966 return &func_name##_data; \
1969 struct openssl_ssl_test_functions {
1970 int (*p_ssl_init_wbio_buffer) (SSL *s);
1971 int (*p_ssl3_setup_buffers) (SSL *s);
1974 const char *ssl_protocol_to_string(int version);
1976 /* Returns true if certificate and private key for 'idx' are present */
1977 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
1979 if (idx < 0 || idx >= SSL_PKEY_NUM)
1981 return s->cert->pkeys[idx].x509 != NULL
1982 && s->cert->pkeys[idx].privatekey != NULL;
1985 # ifndef OPENSSL_UNIT_TEST
1987 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
1988 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
1989 void ssl_clear_cipher_ctx(SSL *s);
1990 int ssl_clear_bad_session(SSL *s);
1991 __owur CERT *ssl_cert_new(void);
1992 __owur CERT *ssl_cert_dup(CERT *cert);
1993 void ssl_cert_clear_certs(CERT *c);
1994 void ssl_cert_free(CERT *c);
1995 __owur int ssl_get_new_session(SSL *s, int session);
1996 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
1997 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
1998 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1999 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2000 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2001 const SSL_CIPHER *const *bp);
2002 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2003 STACK_OF(SSL_CIPHER) **pref,
2004 STACK_OF(SSL_CIPHER)
2006 const char *rule_str,
2008 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites,
2009 int sslv2format, int *al);
2010 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2011 STACK_OF(SSL_CIPHER) **skp,
2012 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2014 void ssl_update_cache(SSL *s, int mode);
2015 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2016 const EVP_MD **md, int *mac_pkey_type,
2017 size_t *mac_secret_size, SSL_COMP **comp,
2019 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2020 size_t *int_overhead, size_t *blocksize,
2021 size_t *ext_overhead);
2022 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2023 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2024 const unsigned char *ptr,
2026 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2027 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2028 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2029 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2030 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2031 __owur int ssl_cert_set_current(CERT *c, long arg);
2032 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2033 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2035 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2036 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2037 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2040 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2041 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2044 int ssl_undefined_function(SSL *s);
2045 __owur int ssl_undefined_void_function(void);
2046 __owur int ssl_undefined_const_function(const SSL *s);
2047 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2048 const unsigned char **serverinfo,
2049 size_t *serverinfo_length);
2050 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2051 void ssl_set_masks(SSL *s);
2052 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2053 __owur int ssl_verify_alarm_type(long type);
2054 void ssl_sort_cipher_list(void);
2055 void ssl_load_ciphers(void);
2056 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2058 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2060 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2061 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2063 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2065 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2066 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2067 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2069 int ssl3_init_finished_mac(SSL *s);
2070 __owur int ssl3_setup_key_block(SSL *s);
2071 __owur int ssl3_change_cipher_state(SSL *s, int which);
2072 void ssl3_cleanup_key_block(SSL *s);
2073 __owur int ssl3_do_write(SSL *s, int type);
2074 int ssl3_send_alert(SSL *s, int level, int desc);
2075 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2076 unsigned char *p, size_t len,
2077 size_t *secret_size);
2078 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2079 __owur int ssl3_num_ciphers(void);
2080 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2081 int ssl3_renegotiate(SSL *ssl);
2082 int ssl3_renegotiate_check(SSL *ssl, int initok);
2083 __owur int ssl3_dispatch_alert(SSL *s);
2084 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2086 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2087 void ssl3_free_digest_list(SSL *s);
2088 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2089 CERT_PKEY *cpk, int *al);
2090 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2091 STACK_OF(SSL_CIPHER) *clnt,
2092 STACK_OF(SSL_CIPHER) *srvr);
2093 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2094 __owur int ssl3_new(SSL *s);
2095 void ssl3_free(SSL *s);
2096 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2097 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2098 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2099 __owur int ssl3_shutdown(SSL *s);
2100 void ssl3_clear(SSL *s);
2101 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2102 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2103 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2104 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2106 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2107 __owur long ssl3_default_timeout(void);
2109 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2110 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2111 __owur int tls_setup_handshake(SSL *s);
2112 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2113 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2114 __owur int ssl3_handshake_write(SSL *s);
2116 __owur int ssl_allow_compression(SSL *s);
2118 __owur int ssl_version_supported(const SSL *s, int version);
2120 __owur int ssl_set_client_hello_version(SSL *s);
2121 __owur int ssl_check_version_downgrade(SSL *s);
2122 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2123 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello);
2124 __owur int ssl_choose_client_version(SSL *s, int version);
2125 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
2128 __owur long tls1_default_timeout(void);
2129 __owur int dtls1_do_write(SSL *s, int type);
2130 void dtls1_set_message_header(SSL *s,
2133 size_t frag_off, size_t frag_len);
2135 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2138 __owur int dtls1_read_failed(SSL *s, int code);
2139 __owur int dtls1_buffer_message(SSL *s, int ccs);
2140 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2141 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2142 int dtls1_retransmit_buffered_messages(SSL *s);
2143 void dtls1_clear_received_buffer(SSL *s);
2144 void dtls1_clear_sent_buffer(SSL *s);
2145 void dtls1_get_message_header(unsigned char *data,
2146 struct hm_header_st *msg_hdr);
2147 __owur long dtls1_default_timeout(void);
2148 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2149 __owur int dtls1_check_timeout_num(SSL *s);
2150 __owur int dtls1_handle_timeout(SSL *s);
2151 void dtls1_start_timer(SSL *s);
2152 void dtls1_stop_timer(SSL *s);
2153 __owur int dtls1_is_timer_expired(SSL *s);
2154 void dtls1_double_timeout(SSL *s);
2155 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2157 __owur int dtls1_send_newsession_ticket(SSL *s);
2158 __owur size_t dtls1_min_mtu(SSL *s);
2159 void dtls1_hm_fragment_free(hm_fragment *frag);
2160 __owur int dtls1_query_mtu(SSL *s);
2162 __owur int tls1_new(SSL *s);
2163 void tls1_free(SSL *s);
2164 void tls1_clear(SSL *s);
2165 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2166 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2168 __owur int dtls1_new(SSL *s);
2169 void dtls1_free(SSL *s);
2170 void dtls1_clear(SSL *s);
2171 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2172 __owur int dtls1_shutdown(SSL *s);
2174 __owur int dtls1_dispatch_alert(SSL *s);
2176 __owur int ssl_init_wbio_buffer(SSL *s);
2177 void ssl_free_wbio_buffer(SSL *s);
2179 __owur int tls1_change_cipher_state(SSL *s, int which);
2180 __owur int tls1_setup_key_block(SSL *s);
2181 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2183 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2184 unsigned char *p, size_t len,
2185 size_t *secret_size);
2186 __owur int tls13_setup_key_block(SSL *s);
2187 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2189 __owur int tls13_change_cipher_state(SSL *s, int which);
2190 __owur int tls13_update_key(SSL *s, int send);
2191 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2192 const unsigned char *secret,
2193 const unsigned char *label, size_t labellen,
2194 const unsigned char *hash,
2195 unsigned char *out, size_t outlen);
2196 __owur int tls13_derive_key(SSL *s, const unsigned char *secret,
2197 unsigned char *key, size_t keylen);
2198 __owur int tls13_derive_iv(SSL *s, const unsigned char *secret,
2199 unsigned char *iv, size_t ivlen);
2200 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2201 const unsigned char *secret,
2202 unsigned char *fin, size_t finlen);
2203 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2204 const unsigned char *prevsecret,
2205 const unsigned char *insecret,
2207 unsigned char *outsecret);
2208 __owur int tls13_generate_handshake_secret(SSL *s,
2209 const unsigned char *insecret,
2210 size_t insecretlen);
2211 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2212 unsigned char *prev, size_t prevlen,
2213 size_t *secret_size);
2214 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2215 const char *label, size_t llen,
2216 const unsigned char *p, size_t plen,
2218 __owur int tls1_alert_code(int code);
2219 __owur int tls13_alert_code(int code);
2220 __owur int ssl3_alert_code(int code);
2222 # ifndef OPENSSL_NO_EC
2223 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2226 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2228 # ifndef OPENSSL_NO_EC
2229 /* Flags values from tls1_ec_curve_id2nid() */
2230 /* Mask for curve type */
2231 # define TLS_CURVE_TYPE 0x3
2232 # define TLS_CURVE_PRIME 0x0
2233 # define TLS_CURVE_CHAR2 0x1
2234 # define TLS_CURVE_CUSTOM 0x2
2236 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2238 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2239 __owur int tls1_ec_nid2curve_id(int nid);
2240 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2241 __owur int tls1_shared_group(SSL *s, int nmatch);
2242 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2243 int *curves, size_t ncurves);
2244 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2246 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2247 size_t *num_formats);
2248 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2249 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2250 # endif /* OPENSSL_NO_EC */
2252 __owur int tls1_shared_list(SSL *s,
2253 const unsigned char *l1, size_t l1len,
2254 const unsigned char *l2, size_t l2len, int nmatch);
2255 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2256 __owur int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2257 size_t *num_curves);
2259 void ssl_set_default_md(SSL *s);
2260 __owur int tls1_set_server_sigalgs(SSL *s);
2262 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2263 typedef enum ticket_en {
2264 /* fatal error, malloc failure */
2265 TICKET_FATAL_ERR_MALLOC,
2266 /* fatal error, either from parsing or decrypting the ticket */
2267 TICKET_FATAL_ERR_OTHER,
2268 /* No ticket present */
2270 /* Empty ticket present */
2272 /* the ticket couldn't be decrypted */
2274 /* a ticket was successfully decrypted */
2276 /* same as above but the ticket needs to be reneewed */
2277 TICKET_SUCCESS_RENEW
2280 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2282 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2284 const unsigned char *sess_id,
2285 size_t sesslen, SSL_SESSION **psess);
2287 __owur int tls_use_ticket(SSL *s);
2289 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2291 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2292 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2294 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2296 void tls1_set_cert_validity(SSL *s);
2298 # ifndef OPENSSL_NO_CT
2299 __owur int ssl_validate_ct(SSL *s);
2302 # ifndef OPENSSL_NO_DH
2303 __owur DH *ssl_get_auto_dh(SSL *s);
2306 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2307 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2310 int tls_choose_sigalg(SSL *s, int *al);
2312 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2313 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2314 __owur long ssl_get_algorithm2(SSL *s);
2315 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2316 const uint16_t *psig, size_t psiglen);
2317 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2318 __owur int tls1_process_sigalgs(SSL *s);
2319 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2320 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2321 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2322 void ssl_set_client_disabled(SSL *s);
2323 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2325 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2327 __owur const EVP_MD *ssl_md(int idx);
2328 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2329 __owur const EVP_MD *ssl_prf_md(SSL *s);
2332 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2333 * with |ssl|, if logging is enabled. It returns one on success and zero on
2334 * failure. The entry is identified by the first 8 bytes of
2335 * |encrypted_premaster|.
2337 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2338 const uint8_t *encrypted_premaster,
2339 size_t encrypted_premaster_len,
2340 const uint8_t *premaster,
2341 size_t premaster_len);
2344 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2345 * logging is available. It returns one on success and zero on failure. It tags
2346 * the entry with |label|.
2348 __owur int ssl_log_secret(SSL *ssl, const char *label,
2349 const uint8_t *secret, size_t secret_len);
2351 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2352 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2353 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2354 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2355 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2358 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2359 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2360 unsigned char *md_out,
2361 size_t *md_out_size,
2362 const unsigned char header[13],
2363 const unsigned char *data,
2364 size_t data_plus_mac_size,
2365 size_t data_plus_mac_plus_padding_size,
2366 const unsigned char *mac_secret,
2367 size_t mac_secret_length, char is_sslv3);
2369 __owur int srp_generate_server_master_secret(SSL *s);
2370 __owur int srp_generate_client_master_secret(SSL *s);
2371 __owur int srp_verify_server_param(SSL *s, int *al);
2375 void custom_ext_init(custom_ext_methods *meths);
2377 __owur int custom_ext_parse(SSL *s, int server,
2378 unsigned int ext_type,
2379 const unsigned char *ext_data, size_t ext_size,
2381 __owur int custom_ext_add(SSL *s, int server, WPACKET *pkt, int *al);
2383 __owur int custom_exts_copy(custom_ext_methods *dst,
2384 const custom_ext_methods *src);
2385 void custom_exts_free(custom_ext_methods *exts);
2387 void ssl_comp_free_compression_methods_int(void);
2389 # else /* OPENSSL_UNIT_TEST */
2391 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2392 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers