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
78 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
79 l|=(((unsigned long)(*((c)++)))<< 8), \
80 l|=(((unsigned long)(*((c)++)))<<16), \
81 l|=(((unsigned long)(*((c)++)))<<24))
83 /* NOTE - c is not incremented as per c2l */
84 # define c2ln(c,l1,l2,n) { \
88 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
89 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
90 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
91 case 5: l2|=((unsigned long)(*(--(c)))); \
92 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
93 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
94 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
95 case 1: l1|=((unsigned long)(*(--(c)))); \
99 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
100 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
101 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
102 *((c)++)=(unsigned char)(((l)>>24)&0xff))
104 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
105 l|=((unsigned long)(*((c)++)))<<16, \
106 l|=((unsigned long)(*((c)++)))<< 8, \
107 l|=((unsigned long)(*((c)++))))
109 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
110 l|=((uint64_t)(*((c)++)))<<48, \
111 l|=((uint64_t)(*((c)++)))<<40, \
112 l|=((uint64_t)(*((c)++)))<<32, \
113 l|=((uint64_t)(*((c)++)))<<24, \
114 l|=((uint64_t)(*((c)++)))<<16, \
115 l|=((uint64_t)(*((c)++)))<< 8, \
116 l|=((uint64_t)(*((c)++))))
119 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
120 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
121 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
122 *((c)++)=(unsigned char)(((l) )&0xff))
124 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
125 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
126 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
127 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
128 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
129 *((c)++)=(unsigned char)(((l) )&0xff))
131 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
132 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
133 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
134 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
135 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
136 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
137 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
138 *((c)++)=(unsigned char)(((l) )&0xff))
140 /* NOTE - c is not incremented as per l2c */
141 # define l2cn(l1,l2,c,n) { \
144 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
145 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
146 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
147 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
148 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
149 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
150 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
151 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
155 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
156 (((unsigned int)((c)[1])) )),(c)+=2)
157 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
158 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
160 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
161 (((unsigned long)((c)[1]))<< 8)| \
162 (((unsigned long)((c)[2])) )),(c)+=3)
164 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
165 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
166 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
169 * DTLS version numbers are strange because they're inverted. Except for
170 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
172 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
173 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
174 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
175 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
176 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
180 # define SSL_DECRYPT 0
181 # define SSL_ENCRYPT 1
183 # define TWO_BYTE_BIT 0x80
184 # define SEC_ESC_BIT 0x40
185 # define TWO_BYTE_MASK 0x7fff
186 # define THREE_BYTE_MASK 0x3fff
188 # define INC32(a) ((a)=((a)+1)&0xffffffffL)
189 # define DEC32(a) ((a)=((a)-1)&0xffffffffL)
190 # define MAX_MAC_SIZE 20 /* up from 16 for SSLv3 */
193 * Define the Bitmasks for SSL_CIPHER.algorithms.
194 * This bits are used packed as dense as possible. If new methods/ciphers
195 * etc will be added, the bits a likely to change, so this information
196 * is for internal library use only, even though SSL_CIPHER.algorithms
197 * can be publicly accessed.
198 * Use the according functions for cipher management instead.
200 * The bit mask handling in the selection and sorting scheme in
201 * ssl_create_cipher_list() has only limited capabilities, reflecting
202 * that the different entities within are mutually exclusive:
203 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
206 /* Bits for algorithm_mkey (key exchange algorithm) */
207 /* RSA key exchange */
208 # define SSL_kRSA 0x00000001U
209 /* tmp DH key no DH cert */
210 # define SSL_kDHE 0x00000002U
212 # define SSL_kEDH SSL_kDHE
214 # define SSL_kECDHE 0x00000004U
216 # define SSL_kEECDH SSL_kECDHE
218 # define SSL_kPSK 0x00000008U
219 /* GOST key exchange */
220 # define SSL_kGOST 0x00000010U
222 # define SSL_kSRP 0x00000020U
224 # define SSL_kRSAPSK 0x00000040U
225 # define SSL_kECDHEPSK 0x00000080U
226 # define SSL_kDHEPSK 0x00000100U
230 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
232 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
233 # define SSL_kANY 0x00000000U
235 /* Bits for algorithm_auth (server authentication) */
237 # define SSL_aRSA 0x00000001U
239 # define SSL_aDSS 0x00000002U
240 /* no auth (i.e. use ADH or AECDH) */
241 # define SSL_aNULL 0x00000004U
243 # define SSL_aECDSA 0x00000008U
245 # define SSL_aPSK 0x00000010U
246 /* GOST R 34.10-2001 signature auth */
247 # define SSL_aGOST01 0x00000020U
249 # define SSL_aSRP 0x00000040U
250 /* GOST R 34.10-2012 signature auth */
251 # define SSL_aGOST12 0x00000080U
252 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
253 # define SSL_aANY 0x00000000U
255 /* Bits for algorithm_enc (symmetric encryption) */
256 # define SSL_DES 0x00000001U
257 # define SSL_3DES 0x00000002U
258 # define SSL_RC4 0x00000004U
259 # define SSL_RC2 0x00000008U
260 # define SSL_IDEA 0x00000010U
261 # define SSL_eNULL 0x00000020U
262 # define SSL_AES128 0x00000040U
263 # define SSL_AES256 0x00000080U
264 # define SSL_CAMELLIA128 0x00000100U
265 # define SSL_CAMELLIA256 0x00000200U
266 # define SSL_eGOST2814789CNT 0x00000400U
267 # define SSL_SEED 0x00000800U
268 # define SSL_AES128GCM 0x00001000U
269 # define SSL_AES256GCM 0x00002000U
270 # define SSL_AES128CCM 0x00004000U
271 # define SSL_AES256CCM 0x00008000U
272 # define SSL_AES128CCM8 0x00010000U
273 # define SSL_AES256CCM8 0x00020000U
274 # define SSL_eGOST2814789CNT12 0x00040000U
275 # define SSL_CHACHA20POLY1305 0x00080000U
277 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
278 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
279 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
280 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
281 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
283 /* Bits for algorithm_mac (symmetric authentication) */
285 # define SSL_MD5 0x00000001U
286 # define SSL_SHA1 0x00000002U
287 # define SSL_GOST94 0x00000004U
288 # define SSL_GOST89MAC 0x00000008U
289 # define SSL_SHA256 0x00000010U
290 # define SSL_SHA384 0x00000020U
291 /* Not a real MAC, just an indication it is part of cipher */
292 # define SSL_AEAD 0x00000040U
293 # define SSL_GOST12_256 0x00000080U
294 # define SSL_GOST89MAC12 0x00000100U
295 # define SSL_GOST12_512 0x00000200U
298 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
299 * sure to update this constant too
302 # define SSL_MD_MD5_IDX 0
303 # define SSL_MD_SHA1_IDX 1
304 # define SSL_MD_GOST94_IDX 2
305 # define SSL_MD_GOST89MAC_IDX 3
306 # define SSL_MD_SHA256_IDX 4
307 # define SSL_MD_SHA384_IDX 5
308 # define SSL_MD_GOST12_256_IDX 6
309 # define SSL_MD_GOST89MAC12_IDX 7
310 # define SSL_MD_GOST12_512_IDX 8
311 # define SSL_MD_MD5_SHA1_IDX 9
312 # define SSL_MD_SHA224_IDX 10
313 # define SSL_MD_SHA512_IDX 11
314 # define SSL_MAX_DIGEST 12
316 /* Bits for algorithm2 (handshake digests and other extra flags) */
318 /* Bits 0-7 are handshake MAC */
319 # define SSL_HANDSHAKE_MAC_MASK 0xFF
320 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
321 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
322 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
323 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
324 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
325 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
326 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
328 /* Bits 8-15 bits are PRF */
329 # define TLS1_PRF_DGST_SHIFT 8
330 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
331 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
332 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
333 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
334 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
335 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
336 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
339 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
340 * goes into algorithm2)
342 # define TLS1_STREAM_MAC 0x10000
344 # define SSL_STRONG_MASK 0x0000001FU
345 # define SSL_DEFAULT_MASK 0X00000020U
347 # define SSL_STRONG_NONE 0x00000001U
348 # define SSL_LOW 0x00000002U
349 # define SSL_MEDIUM 0x00000004U
350 # define SSL_HIGH 0x00000008U
351 # define SSL_FIPS 0x00000010U
352 # define SSL_NOT_DEFAULT 0x00000020U
354 /* we have used 0000003f - 26 bits left to go */
356 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
357 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
359 /* Check if an SSL structure is using DTLS */
360 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
362 /* Check if we are using TLSv1.3 */
363 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
364 && (s)->method->version >= TLS1_3_VERSION \
365 && (s)->method->version != TLS_ANY_VERSION)
367 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
369 /* See if we need explicit IV */
370 # define SSL_USE_EXPLICIT_IV(s) \
371 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
373 * See if we use signature algorithms extension and signature algorithm
376 # define SSL_USE_SIGALGS(s) \
377 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
379 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
380 * apply to others in future.
382 # define SSL_USE_TLS1_2_CIPHERS(s) \
383 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
385 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
386 * flags because it may not be set to correct version yet.
388 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
389 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
390 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
392 * Determine if a client should send signature algorithms extension:
393 * as with TLS1.2 cipher we can't rely on method flags.
395 # define SSL_CLIENT_USE_SIGALGS(s) \
396 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
398 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
399 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
401 /* Mostly for SSLv3 */
402 # define SSL_PKEY_RSA 0
403 # define SSL_PKEY_DSA_SIGN 1
404 # define SSL_PKEY_ECC 2
405 # define SSL_PKEY_GOST01 3
406 # define SSL_PKEY_GOST12_256 4
407 # define SSL_PKEY_GOST12_512 5
408 # define SSL_PKEY_NUM 6
410 * Pseudo-constant. GOST cipher suites can use different certs for 1
411 * SSL_CIPHER. So let's see which one we have in fact.
413 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
416 * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
419 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
422 * SSL_kRSA <- RSA_ENC
423 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
424 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
425 * SSL_aRSA <- RSA_ENC | RSA_SIGN
426 * SSL_aDSS <- DSA_SIGN
430 #define CERT_INVALID 0
431 #define CERT_PUBLIC_KEY 1
432 #define CERT_PRIVATE_KEY 2
435 /* CipherSuite length. SSLv3 and all TLS versions. */
436 # define TLS_CIPHER_LEN 2
437 /* used to hold info on the particular ciphers used */
438 struct ssl_cipher_st {
440 const char *name; /* text name */
441 uint32_t id; /* id, 4 bytes, first is version */
443 * changed in 1.0.0: these four used to be portions of a single value
446 uint32_t algorithm_mkey; /* key exchange algorithm */
447 uint32_t algorithm_auth; /* server authentication */
448 uint32_t algorithm_enc; /* symmetric encryption */
449 uint32_t algorithm_mac; /* symmetric authentication */
450 int min_tls; /* minimum SSL/TLS protocol version */
451 int max_tls; /* maximum SSL/TLS protocol version */
452 int min_dtls; /* minimum DTLS protocol version */
453 int max_dtls; /* maximum DTLS protocol version */
454 uint32_t algo_strength; /* strength and export flags */
455 uint32_t algorithm2; /* Extra flags */
456 int32_t strength_bits; /* Number of bits really used */
457 uint32_t alg_bits; /* Number of bits for algorithm */
460 /* Used to hold SSL/TLS functions */
461 struct ssl_method_st {
465 int (*ssl_new) (SSL *s);
466 void (*ssl_clear) (SSL *s);
467 void (*ssl_free) (SSL *s);
468 int (*ssl_accept) (SSL *s);
469 int (*ssl_connect) (SSL *s);
470 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
471 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
472 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
473 int (*ssl_shutdown) (SSL *s);
474 int (*ssl_renegotiate) (SSL *s);
475 int (*ssl_renegotiate_check) (SSL *s, int);
476 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
477 unsigned char *buf, size_t len, int peek,
479 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
481 int (*ssl_dispatch_alert) (SSL *s);
482 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
483 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
484 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
485 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
487 size_t (*ssl_pending) (const SSL *s);
488 int (*num_ciphers) (void);
489 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
490 long (*get_timeout) (void);
491 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
492 int (*ssl_version) (void);
493 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
494 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
498 * Lets make this into an ASN.1 type structure as follows
499 * SSL_SESSION_ID ::= SEQUENCE {
500 * version INTEGER, -- structure version number
501 * SSLversion INTEGER, -- SSL version number
502 * Cipher OCTET STRING, -- the 3 byte cipher ID
503 * Session_ID OCTET STRING, -- the Session ID
504 * Master_key OCTET STRING, -- the master key
505 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
506 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
507 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
508 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
509 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
510 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
511 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
512 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
513 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
514 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
515 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
516 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
517 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
518 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
520 * Look in ssl/ssl_asn1.c for more details
521 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
523 struct ssl_session_st {
524 int ssl_version; /* what ssl version session info is being kept
526 size_t master_key_length;
529 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
532 unsigned char master_key[TLS13_MAX_RESUMPTION_MASTER_LENGTH];
533 /* session_id - valid? */
534 size_t session_id_length;
535 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
537 * this is used to determine whether the session is being reused in the
538 * appropriate context. It is up to the application to set this, via
541 size_t sid_ctx_length;
542 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
543 # ifndef OPENSSL_NO_PSK
544 char *psk_identity_hint;
548 * Used to indicate that session resumption is not allowed. Applications
549 * can also set this bit for a new session via not_resumable_session_cb
550 * to disable session caching and tickets.
553 /* This is the cert and type for the other end. */
556 /* Certificate chain peer sent */
557 STACK_OF(X509) *peer_chain;
559 * when app_verify_callback accepts a session where the peer's
560 * certificate is not ok, we must remember the error for session reuse:
562 long verify_result; /* only for servers */
563 CRYPTO_REF_COUNT references;
566 unsigned int compress_meth; /* Need to lookup the method */
567 const SSL_CIPHER *cipher;
568 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
569 * load the 'cipher' structure */
570 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
571 CRYPTO_EX_DATA ex_data; /* application specific data */
573 * These are used to make removal of session-ids more efficient and to
574 * implement a maximum cache size.
576 struct ssl_session_st *prev, *next;
580 # ifndef OPENSSL_NO_EC
581 size_t ecpointformats_len;
582 unsigned char *ecpointformats; /* peer's list */
583 size_t supportedgroups_len;
584 unsigned char *supportedgroups; /* peer's list */
585 # endif /* OPENSSL_NO_EC */
587 unsigned char *tick; /* Session ticket */
588 size_t ticklen; /* Session ticket length */
589 /* Session lifetime hint in seconds */
590 unsigned long tick_lifetime_hint;
591 uint32_t tick_age_add;
594 # ifndef OPENSSL_NO_SRP
601 /* Extended master secret support */
602 # define SSL_SESS_FLAG_EXTMS 0x1
604 # ifndef OPENSSL_NO_SRP
606 typedef struct srp_ctx_st {
607 /* param for all the callbacks */
609 /* set client Hello login callback */
610 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
611 /* set SRP N/g param callback for verification */
612 int (*SRP_verify_param_callback) (SSL *, void *);
613 /* set SRP client passwd callback */
614 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
616 BIGNUM *N, *g, *s, *B, *A;
620 unsigned long srp_Mask;
631 DEFINE_LHASH_OF(SSL_SESSION);
632 /* Needed in ssl_cert.c */
633 DEFINE_LHASH_OF(X509_NAME);
635 # define TLSEXT_KEYNAME_LENGTH 16
638 const SSL_METHOD *method;
639 STACK_OF(SSL_CIPHER) *cipher_list;
640 /* same as above but sorted for lookup */
641 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
642 struct x509_store_st /* X509_STORE */ *cert_store;
643 LHASH_OF(SSL_SESSION) *sessions;
645 * Most session-ids that will be cached, default is
646 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
648 size_t session_cache_size;
649 struct ssl_session_st *session_cache_head;
650 struct ssl_session_st *session_cache_tail;
652 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
653 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
654 * means only SSL_accept which cache SSL_SESSIONS.
656 uint32_t session_cache_mode;
658 * If timeout is not 0, it is the default timeout value set when
659 * SSL_new() is called. This has been put in to make life easier to set
662 long session_timeout;
664 * If this callback is not null, it will be called each time a session id
665 * is added to the cache. If this function returns 1, it means that the
666 * callback will do a SSL_SESSION_free() when it has finished using it.
667 * Otherwise, on 0, it means the callback has finished with it. If
668 * remove_session_cb is not null, it will be called when a session-id is
669 * removed from the cache. After the call, OpenSSL will
670 * SSL_SESSION_free() it.
672 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
673 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
674 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
675 const unsigned char *data, int len,
678 int sess_connect; /* SSL new conn - started */
679 int sess_connect_renegotiate; /* SSL reneg - requested */
680 int sess_connect_good; /* SSL new conne/reneg - finished */
681 int sess_accept; /* SSL new accept - started */
682 int sess_accept_renegotiate; /* SSL reneg - requested */
683 int sess_accept_good; /* SSL accept/reneg - finished */
684 int sess_miss; /* session lookup misses */
685 int sess_timeout; /* reuse attempt on timeouted session */
686 int sess_cache_full; /* session removed due to full cache */
687 int sess_hit; /* session reuse actually done */
688 int sess_cb_hit; /* session-id that was not in the cache was
689 * passed back via the callback. This
690 * indicates that the application is supplying
691 * session-id's from other processes - spooky
695 CRYPTO_REF_COUNT references;
697 /* if defined, these override the X509_verify_cert() calls */
698 int (*app_verify_callback) (X509_STORE_CTX *, void *);
699 void *app_verify_arg;
701 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
702 * ('app_verify_callback' was called with just one argument)
705 /* Default password callback. */
706 pem_password_cb *default_passwd_callback;
708 /* Default password callback user data. */
709 void *default_passwd_callback_userdata;
711 /* get client cert callback */
712 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
714 /* cookie generate callback */
715 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
716 unsigned int *cookie_len);
718 /* verify cookie callback */
719 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
720 unsigned int cookie_len);
722 CRYPTO_EX_DATA ex_data;
724 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
725 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
727 STACK_OF(X509) *extra_certs;
728 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
730 /* Default values used when no per-SSL value is defined follow */
732 /* used if SSL's info_callback is NULL */
733 void (*info_callback) (const SSL *ssl, int type, int val);
735 /* what we put in client cert requests */
736 STACK_OF(X509_NAME) *client_CA;
739 * Default values to use in SSL structures follow (these are copied by
745 int min_proto_version;
746 int max_proto_version;
747 size_t max_cert_list;
749 struct cert_st /* CERT */ *cert;
752 /* callback that allows applications to peek at protocol messages */
753 void (*msg_callback) (int write_p, int version, int content_type,
754 const void *buf, size_t len, SSL *ssl, void *arg);
755 void *msg_callback_arg;
757 uint32_t verify_mode;
758 size_t sid_ctx_length;
759 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
760 /* called 'verify_callback' in the SSL */
761 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
763 /* Default generate session ID callback. */
764 GEN_SESSION_CB generate_session_id;
766 X509_VERIFY_PARAM *param;
770 # ifndef OPENSSL_NO_CT
771 CTLOG_STORE *ctlog_store; /* CT Log Store */
773 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
774 * If they are not, the connection should be aborted.
776 ssl_ct_validation_cb ct_validation_callback;
777 void *ct_validation_callback_arg;
781 * If we're using more than one pipeline how should we divide the data
782 * up between the pipes?
784 size_t split_send_fragment;
786 * Maximum amount of data to send in one fragment. actual record size can
787 * be more than this due to padding and MAC overheads.
789 size_t max_send_fragment;
791 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
792 size_t max_pipelines;
794 /* The default read buffer length to use (0 means not set) */
795 size_t default_read_buf_len;
797 # ifndef OPENSSL_NO_ENGINE
799 * Engine to pass requests for client certs to
801 ENGINE *client_cert_engine;
804 /* TLS extensions. */
806 /* TLS extensions servername callback */
807 int (*servername_cb) (SSL *, int *, void *);
808 void *servername_arg;
809 /* RFC 4507 session ticket keys */
810 unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
811 unsigned char tick_hmac_key[32];
812 unsigned char tick_aes_key[32];
813 /* Callback to support customisation of ticket key setting */
814 int (*ticket_key_cb) (SSL *ssl,
815 unsigned char *name, unsigned char *iv,
816 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
818 /* certificate status request info */
819 /* Callback for status request */
820 int (*status_cb) (SSL *ssl, void *arg);
822 /* ext status type used for CSR extension (OCSP Stapling) */
825 # ifndef OPENSSL_NO_EC
826 /* EC extension values inherited by SSL structure */
827 size_t ecpointformats_len;
828 unsigned char *ecpointformats;
829 size_t supportedgroups_len;
830 unsigned char *supportedgroups;
831 # endif /* OPENSSL_NO_EC */
834 * ALPN information (we are in the process of transitioning from NPN to
839 * For a server, this contains a callback function that allows the
840 * server to select the protocol for the connection.
841 * out: on successful return, this must point to the raw protocol
842 * name (without the length prefix).
843 * outlen: on successful return, this contains the length of |*out|.
844 * in: points to the client's list of supported protocols in
846 * inlen: the length of |in|.
848 int (*alpn_select_cb) (SSL *s,
849 const unsigned char **out,
850 unsigned char *outlen,
851 const unsigned char *in,
852 unsigned int inlen, void *arg);
853 void *alpn_select_cb_arg;
856 * For a client, this contains the list of supported protocols in wire
862 # ifndef OPENSSL_NO_NEXTPROTONEG
863 /* Next protocol negotiation information */
866 * For a server, this contains a callback function by which the set of
867 * advertised protocols can be provided.
869 SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
870 void *npn_advertised_cb_arg;
872 * For a client, this contains a callback function that selects the next
873 * protocol from the list provided by the server.
875 SSL_CTX_npn_select_cb_func npn_select_cb;
876 void *npn_select_cb_arg;
880 # ifndef OPENSSL_NO_PSK
881 SSL_psk_client_cb_func psk_client_callback;
882 SSL_psk_server_cb_func psk_server_callback;
885 # ifndef OPENSSL_NO_SRP
886 SRP_CTX srp_ctx; /* ctx for SRP authentication */
889 /* Shared DANE context */
890 struct dane_ctx_st dane;
892 /* SRTP profiles we are willing to do from RFC 5764 */
893 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
895 * Callback for disabling session caching and ticket support on a session
896 * basis, depending on the chosen cipher.
898 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
903 * Callback for logging key material for use with debugging tools like
904 * Wireshark. The callback should log `line` followed by a newline.
906 SSL_CTX_keylog_cb_func keylog_callback;
911 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
916 const SSL_METHOD *method;
918 * There are 2 BIO's even though they are normally both the same. This
919 * is so data can be read and written to different handlers
921 /* used by SSL_read */
923 /* used by SSL_write */
925 /* used during session-id reuse to concatenate messages */
928 * This holds a variable that indicates what we were doing when a 0 or -1
929 * is returned. This is needed for non-blocking IO so we know what
930 * request needs re-doing when in SSL_accept or SSL_connect
933 int (*handshake_func) (SSL *);
935 * Imagine that here's a boolean member "init" that is switched as soon
936 * as SSL_set_{accept/connect}_state is called for the first time, so
937 * that "state" and "handshake_func" are properly initialized. But as
938 * handshake_func is == 0 until then, we use this test instead of an
941 /* are we the server side? */
944 * Generate a new session or reuse an old one.
945 * NB: For servers, the 'new' session may actually be a previously
946 * cached session or even the previous session unless
947 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
950 /* don't send shutdown packets */
952 /* we have shut things down, 0x01 sent, 0x02 for received */
956 BUF_MEM *init_buf; /* buffer used during init */
957 void *init_msg; /* pointer to handshake message body, set by
958 * ssl3_get_message() */
959 size_t init_num; /* amount read/written */
960 size_t init_off; /* amount read/written */
961 struct ssl3_state_st *s3; /* SSLv3 variables */
962 struct dtls1_state_st *d1; /* DTLSv1 variables */
963 /* callback that allows applications to peek at protocol messages */
964 void (*msg_callback) (int write_p, int version, int content_type,
965 const void *buf, size_t len, SSL *ssl, void *arg);
966 void *msg_callback_arg;
967 int hit; /* reusing a previous session */
968 X509_VERIFY_PARAM *param;
969 /* Per connection DANE state */
972 STACK_OF(SSL_CIPHER) *cipher_list;
973 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
975 * These are the ones being used, the ones in SSL_SESSION are the ones to
976 * be 'copied' into these ones
980 * The TLS1.3 secrets. The resumption master secret is stored in the
983 unsigned char early_secret[EVP_MAX_MD_SIZE];
984 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
985 unsigned char master_secret[EVP_MAX_MD_SIZE];
986 unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
987 unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
988 unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
989 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
990 unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
991 EVP_MD_CTX *read_hash; /* used for mac generation */
992 COMP_CTX *compress; /* compression */
993 COMP_CTX *expand; /* uncompress */
994 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
995 unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
996 EVP_MD_CTX *write_hash; /* used for mac generation */
999 /* This is used to hold the server certificate used */
1000 struct cert_st /* CERT */ *cert;
1003 * The hash of all messages prior to the CertificateVerify, and the length
1006 unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1007 size_t cert_verify_hash_len;
1009 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1010 int hello_retry_request;
1013 * the session_id_context is used to ensure sessions are only reused in
1014 * the appropriate context
1016 size_t sid_ctx_length;
1017 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1018 /* This can also be in the session once a session is established */
1019 SSL_SESSION *session;
1020 /* Default generate session ID callback. */
1021 GEN_SESSION_CB generate_session_id;
1024 * 0 don't care about verify failure.
1025 * 1 fail if verify fails
1027 uint32_t verify_mode;
1028 /* fail if callback returns 0 */
1029 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1030 /* optional informational callback */
1031 void (*info_callback) (const SSL *ssl, int type, int val);
1032 /* error bytes to be written */
1036 # ifndef OPENSSL_NO_PSK
1037 SSL_psk_client_cb_func psk_client_callback;
1038 SSL_psk_server_cb_func psk_server_callback;
1041 /* Verified chain of peer */
1042 STACK_OF(X509) *verified_chain;
1044 /* extra application data */
1045 CRYPTO_EX_DATA ex_data;
1046 /* for server side, keep the list of CA_dn we can use */
1047 STACK_OF(X509_NAME) *client_CA;
1048 CRYPTO_REF_COUNT references;
1049 /* protocol behaviour */
1053 int min_proto_version;
1054 int max_proto_version;
1055 size_t max_cert_list;
1058 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1059 * secret and SSLv3/TLS (<=1.2) rollback check
1063 * If we're using more than one pipeline how should we divide the data
1064 * up between the pipes?
1066 size_t split_send_fragment;
1068 * Maximum amount of data to send in one fragment. actual record size can
1069 * be more than this due to padding and MAC overheads.
1071 size_t max_send_fragment;
1072 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1073 size_t max_pipelines;
1076 /* TLS extension debug callback */
1077 void (*debug_cb)(SSL *s, int client_server, int type,
1078 const unsigned char *data, int len, void *arg);
1081 /* certificate status request info */
1082 /* Status type or -1 if no status type */
1084 /* Raw extension data, if seen */
1085 unsigned char *scts;
1086 /* Length of raw extension data, if seen */
1088 /* Expect OCSP CertificateStatus message */
1089 int status_expected;
1092 /* OCSP status request only */
1093 STACK_OF(OCSP_RESPID) *ids;
1094 X509_EXTENSIONS *exts;
1095 /* OCSP response received or to be sent */
1096 unsigned char *resp;
1100 /* RFC4507 session ticket expected to be received or sent */
1101 int ticket_expected;
1102 # ifndef OPENSSL_NO_EC
1103 size_t ecpointformats_len;
1105 unsigned char *ecpointformats;
1106 size_t supportedgroups_len;
1108 unsigned char *supportedgroups;
1109 # endif /* OPENSSL_NO_EC */
1110 /* TLS Session Ticket extension override */
1111 TLS_SESSION_TICKET_EXT *session_ticket;
1112 /* TLS Session Ticket extension callback */
1113 tls_session_ticket_ext_cb_fn session_ticket_cb;
1114 void *session_ticket_cb_arg;
1115 /* TLS pre-shared secret session resumption */
1116 tls_session_secret_cb_fn session_secret_cb;
1117 void *session_secret_cb_arg;
1119 * For a client, this contains the list of supported protocols in wire
1122 unsigned char *alpn;
1125 * Next protocol negotiation. For the client, this is the protocol that
1126 * we sent in NextProtocol and is set when handling ServerHello
1127 * extensions. For a server, this is the client's selected_protocol from
1128 * NextProtocol and is set when handling the NextProtocol message, before
1129 * the Finished message.
1134 /* The available PSK key exchange modes */
1137 /* Set to one if we have negotiated ETM */
1142 * no further mod of servername
1143 * 0 : call the servername extension callback.
1144 * 1 : prepare 2, allow last ack just after in server callback.
1145 * 2 : don't call servername callback, no ack in server hello
1147 int servername_done;
1148 # ifndef OPENSSL_NO_CT
1150 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1151 * If they are not, the connection should be aborted.
1153 ssl_ct_validation_cb ct_validation_callback;
1154 /* User-supplied argument that is passed to the ct_validation_callback */
1155 void *ct_validation_callback_arg;
1157 * Consolidated stack of SCTs from all sources.
1158 * Lazily populated by CT_get_peer_scts(SSL*)
1160 STACK_OF(SCT) *scts;
1161 /* Have we attempted to find/parse SCTs yet? */
1164 SSL_CTX *session_ctx; /* initial ctx, used to store sessions */
1166 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1167 /* What's been chosen */
1168 SRTP_PROTECTION_PROFILE *srtp_profile;
1170 * 1 if we are renegotiating.
1171 * 2 if we are a server and are inside a handshake
1172 * (i.e. not just sending a HelloRequest)
1175 # ifndef OPENSSL_NO_SRP
1176 /* ctx for SRP authentication */
1180 * Callback for disabling session caching and ticket support on a session
1181 * basis, depending on the chosen cipher.
1183 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1184 RECORD_LAYER rlayer;
1185 /* Default password callback. */
1186 pem_password_cb *default_passwd_callback;
1187 /* Default password callback user data. */
1188 void *default_passwd_callback_userdata;
1189 /* Async Job info */
1191 ASYNC_WAIT_CTX *waitctx;
1194 CRYPTO_RWLOCK *lock;
1198 * Structure containing table entry of values associated with the signature
1199 * algorithms (signature scheme) extension
1201 typedef struct sigalg_lookup_st {
1202 /* TLS 1.3 signature scheme name */
1204 /* Raw value used in extension */
1206 /* NID of hash algorithm */
1208 /* Index of hash algorithm */
1210 /* NID of signature algorithm */
1212 /* Index of signature algorithm */
1214 /* Combined hash and signature NID, if any */
1216 /* Required public key curve (ECDSA only) */
1220 typedef struct cert_pkey_st CERT_PKEY;
1222 typedef struct ssl3_state_st {
1224 size_t read_mac_secret_size;
1225 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1226 size_t write_mac_secret_size;
1227 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1228 unsigned char server_random[SSL3_RANDOM_SIZE];
1229 unsigned char client_random[SSL3_RANDOM_SIZE];
1230 /* flags for countermeasure against known-IV weakness */
1231 int need_empty_fragments;
1232 int empty_fragment_done;
1233 /* used during startup, digest all incoming/outgoing packets */
1234 BIO *handshake_buffer;
1236 * When handshake digest is determined, buffer is hashed and
1237 * freed and MD_CTX for the required digest is stored here.
1239 EVP_MD_CTX *handshake_dgst;
1241 * Set whenever an expected ChangeCipherSpec message is processed.
1242 * Unset when the peer's Finished message is received.
1243 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1245 int change_cipher_spec;
1249 * we allow one fatal and one warning alert to be outstanding, send close
1250 * alert via the warning alert
1253 unsigned char send_alert[2];
1255 * This flag is set when we should renegotiate ASAP, basically when there
1256 * is no more data in the read or write buffers
1259 int total_renegotiations;
1260 int num_renegotiations;
1261 int in_read_app_data;
1263 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1264 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1265 size_t finish_md_len;
1266 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1267 size_t peer_finish_md_len;
1268 size_t message_size;
1270 /* used to hold the new cipher we are going to use */
1271 const SSL_CIPHER *new_cipher;
1272 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1273 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1275 /* used for certificate requests */
1278 char ctype[SSL3_CT_NUMBER];
1279 STACK_OF(X509_NAME) *ca_names;
1280 size_t key_block_length;
1281 unsigned char *key_block;
1282 const EVP_CIPHER *new_sym_enc;
1283 const EVP_MD *new_hash;
1284 int new_mac_pkey_type;
1285 size_t new_mac_secret_size;
1286 # ifndef OPENSSL_NO_COMP
1287 const SSL_COMP *new_compression;
1289 char *new_compression;
1292 /* Raw values of the cipher list from a client */
1293 unsigned char *ciphers_raw;
1294 size_t ciphers_rawlen;
1295 /* Temporary storage for premaster secret */
1298 # ifndef OPENSSL_NO_PSK
1299 /* Temporary storage for PSK key */
1303 /* Signature algorithm we actually use */
1304 const SIGALG_LOOKUP *sigalg;
1305 /* Pointer to certificate we use */
1308 * signature algorithms peer reports: e.g. supported signature
1309 * algorithms extension for server or as part of a certificate
1310 * request for client.
1312 uint16_t *peer_sigalgs;
1313 /* Size of above array */
1314 size_t peer_sigalgslen;
1315 /* Sigalg peer actualy uses */
1316 const SIGALG_LOOKUP *peer_sigalg;
1317 /* Array of digests used for signing */
1318 const EVP_MD *md[SSL_PKEY_NUM];
1320 * Set if corresponding CERT_PKEY can be used with current
1321 * SSL session: e.g. appropriate curve, signature algorithms etc.
1322 * If zero it can't be used at all.
1324 uint32_t valid_flags[SSL_PKEY_NUM];
1326 * For servers the following masks are for the key and auth algorithms
1327 * that are supported by the certs below. For clients they are masks of
1328 * *disabled* algorithms based on the current session.
1333 * The following are used by the client to see if a cipher is allowed or
1334 * not. It contains the minimum and maximum version the client's using
1335 * based on what it knows so far.
1341 /* Connection binding to prevent renegotiation attacks */
1342 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1343 size_t previous_client_finished_len;
1344 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1345 size_t previous_server_finished_len;
1346 int send_connection_binding; /* TODOEKR */
1348 # ifndef OPENSSL_NO_NEXTPROTONEG
1350 * Set if we saw the Next Protocol Negotiation extension from our peer.
1356 * ALPN information (we are in the process of transitioning from NPN to
1361 * In a server these point to the selected ALPN protocol after the
1362 * ClientHello has been processed. In a client these contain the protocol
1363 * that the server selected once the ServerHello has been processed.
1365 unsigned char *alpn_selected;
1366 size_t alpn_selected_len;
1367 /* used by the server to know what options were proposed */
1368 unsigned char *alpn_proposed;
1369 size_t alpn_proposed_len;
1370 /* used by the client to know if it actually sent alpn */
1373 # ifndef OPENSSL_NO_EC
1375 * This is set to true if we believe that this is a version of Safari
1376 * running on OS X 10.6 or newer. We wish to know this because Safari on
1377 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1379 char is_probably_safari;
1380 # endif /* !OPENSSL_NO_EC */
1382 /* For clients: peer temporary key */
1383 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1384 /* The group_id for the DH/ECDH key */
1385 unsigned int group_id;
1391 /* DTLS structures */
1393 # ifndef OPENSSL_NO_SCTP
1394 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1397 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1398 # define DTLS1_MAX_MTU_OVERHEAD 48
1401 * Flag used in message reuse to indicate the buffer contains the record
1402 * header as well as the the handshake message header.
1404 # define DTLS1_SKIP_RECORD_HEADER 2
1406 struct dtls1_retransmit_state {
1407 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1408 EVP_MD_CTX *write_hash; /* used for mac generation */
1409 COMP_CTX *compress; /* compression */
1410 SSL_SESSION *session;
1411 unsigned short epoch;
1414 struct hm_header_st {
1420 unsigned int is_ccs;
1421 struct dtls1_retransmit_state saved_retransmit_state;
1424 struct dtls1_timeout_st {
1425 /* Number of read timeouts so far */
1426 unsigned int read_timeouts;
1427 /* Number of write timeouts so far */
1428 unsigned int write_timeouts;
1429 /* Number of alerts received so far */
1430 unsigned int num_alerts;
1433 typedef struct hm_fragment_st {
1434 struct hm_header_st msg_header;
1435 unsigned char *fragment;
1436 unsigned char *reassembly;
1439 typedef struct pqueue_st pqueue;
1440 typedef struct pitem_st pitem;
1443 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1448 typedef struct pitem_st *piterator;
1450 pitem *pitem_new(unsigned char *prio64be, void *data);
1451 void pitem_free(pitem *item);
1452 pqueue *pqueue_new(void);
1453 void pqueue_free(pqueue *pq);
1454 pitem *pqueue_insert(pqueue *pq, pitem *item);
1455 pitem *pqueue_peek(pqueue *pq);
1456 pitem *pqueue_pop(pqueue *pq);
1457 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1458 pitem *pqueue_iterator(pqueue *pq);
1459 pitem *pqueue_next(piterator *iter);
1460 size_t pqueue_size(pqueue *pq);
1462 typedef struct dtls1_state_st {
1463 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1465 unsigned int cookie_verified;
1466 /* handshake message numbers */
1467 unsigned short handshake_write_seq;
1468 unsigned short next_handshake_write_seq;
1469 unsigned short handshake_read_seq;
1470 /* Buffered handshake messages */
1471 pqueue *buffered_messages;
1472 /* Buffered (sent) handshake records */
1473 pqueue *sent_messages;
1474 size_t link_mtu; /* max on-the-wire DTLS packet size */
1475 size_t mtu; /* max DTLS packet size */
1476 struct hm_header_st w_msg_hdr;
1477 struct hm_header_st r_msg_hdr;
1478 struct dtls1_timeout_st timeout;
1480 * Indicates when the last handshake msg sent will timeout
1482 struct timeval next_timeout;
1483 /* Timeout duration */
1484 unsigned short timeout_duration;
1485 unsigned int retransmitting;
1486 # ifndef OPENSSL_NO_SCTP
1487 int shutdown_received;
1491 # ifndef OPENSSL_NO_EC
1493 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1495 # define EXPLICIT_PRIME_CURVE_TYPE 1
1496 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1497 # define NAMED_CURVE_TYPE 3
1498 # endif /* OPENSSL_NO_EC */
1500 struct cert_pkey_st {
1502 EVP_PKEY *privatekey;
1503 /* Chain for this certificate */
1504 STACK_OF(X509) *chain;
1506 * serverinfo data for this certificate. The data is in TLS Extension
1507 * wire format, specifically it's a series of records like:
1508 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1510 * uint8_t data[length];
1512 unsigned char *serverinfo;
1513 size_t serverinfo_length;
1515 /* Retrieve Suite B flags */
1516 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1517 /* Uses to check strict mode: suite B modes are always strict */
1518 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1519 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1522 unsigned short ext_type;
1524 * Per-connection flags relating to this extension type: not used if
1525 * part of an SSL_CTX structure.
1528 custom_ext_add_cb add_cb;
1529 custom_ext_free_cb free_cb;
1531 custom_ext_parse_cb parse_cb;
1533 } custom_ext_method;
1535 /* ext_flags values */
1538 * Indicates an extension has been received. Used to check for unsolicited or
1539 * duplicate extensions.
1541 # define SSL_EXT_FLAG_RECEIVED 0x1
1543 * Indicates an extension has been sent: used to enable sending of
1544 * corresponding ServerHello extension.
1546 # define SSL_EXT_FLAG_SENT 0x2
1549 custom_ext_method *meths;
1551 } custom_ext_methods;
1553 typedef struct cert_st {
1554 /* Current active set */
1556 * ALWAYS points to an element of the pkeys array
1557 * Probably it would make more sense to store
1558 * an index, not a pointer.
1561 # ifndef OPENSSL_NO_DH
1563 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1566 /* Flags related to certificates */
1567 uint32_t cert_flags;
1568 CERT_PKEY pkeys[SSL_PKEY_NUM];
1570 * Certificate types (received or sent) in certificate request message.
1571 * On receive this is only set if number of certificate types exceeds
1574 unsigned char *ctypes;
1577 * supported signature algorithms. When set on a client this is sent in
1578 * the client hello as the supported signature algorithms extension. For
1579 * servers it represents the signature algorithms we are willing to use.
1581 uint16_t *conf_sigalgs;
1582 /* Size of above array */
1583 size_t conf_sigalgslen;
1585 * Client authentication signature algorithms, if not set then uses
1586 * conf_sigalgs. On servers these will be the signature algorithms sent
1587 * to the client in a certificate request for TLS 1.2. On a client this
1588 * represents the signature algorithms we are willing to use for client
1591 uint16_t *client_sigalgs;
1592 /* Size of above array */
1593 size_t client_sigalgslen;
1595 * Signature algorithms shared by client and server: cached because these
1596 * are used most often.
1598 const SIGALG_LOOKUP **shared_sigalgs;
1599 size_t shared_sigalgslen;
1601 * Certificate setup callback: if set is called whenever a certificate
1602 * may be required (client or server). the callback can then examine any
1603 * appropriate parameters and setup any certificates required. This
1604 * allows advanced applications to select certificates on the fly: for
1605 * example based on supported signature algorithms or curves.
1607 int (*cert_cb) (SSL *ssl, void *arg);
1610 * Optional X509_STORE for chain building or certificate validation If
1611 * NULL the parent SSL_CTX store is used instead.
1613 X509_STORE *chain_store;
1614 X509_STORE *verify_store;
1615 /* Custom extension methods for server and client */
1616 custom_ext_methods cli_ext;
1617 custom_ext_methods srv_ext;
1618 /* Security callback */
1619 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1620 void *other, void *ex);
1621 /* Security level */
1624 # ifndef OPENSSL_NO_PSK
1625 /* If not NULL psk identity hint to use for servers */
1626 char *psk_identity_hint;
1628 CRYPTO_REF_COUNT references; /* >1 only if SSL_copy_session_id is used */
1629 CRYPTO_RWLOCK *lock;
1632 # define FP_ICC (int (*)(const void *,const void *))
1635 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1636 * of a mess of functions, but hell, think of it as an opaque structure :-)
1638 typedef struct ssl3_enc_method {
1639 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1640 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1641 int (*setup_key_block) (SSL *);
1642 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1644 int (*change_cipher_state) (SSL *, int);
1645 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1646 const char *client_finished_label;
1647 size_t client_finished_label_len;
1648 const char *server_finished_label;
1649 size_t server_finished_label_len;
1650 int (*alert_value) (int);
1651 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1652 const char *, size_t,
1653 const unsigned char *, size_t,
1655 /* Various flags indicating protocol version requirements */
1657 /* Set the handshake header */
1658 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1659 /* Close construction of the handshake message */
1660 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1661 /* Write out handshake message */
1662 int (*do_write) (SSL *s);
1665 # define ssl_set_handshake_header(s, pkt, htype) \
1666 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1667 # define ssl_close_construct_packet(s, pkt, htype) \
1668 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1669 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1671 /* Values for enc_flags */
1673 /* Uses explicit IV for CBC mode */
1674 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1675 /* Uses signature algorithms extension */
1676 # define SSL_ENC_FLAG_SIGALGS 0x2
1677 /* Uses SHA256 default PRF */
1678 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1680 # define SSL_ENC_FLAG_DTLS 0x8
1682 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1683 * apply to others in future.
1685 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1687 # ifndef OPENSSL_NO_COMP
1688 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1689 typedef struct ssl3_comp_st {
1690 int comp_id; /* The identifier byte for this compression
1692 char *name; /* Text name used for the compression type */
1693 COMP_METHOD *method; /* The method :-) */
1697 typedef struct raw_extension_st {
1698 /* Raw packet data for the extension */
1700 /* Set to 1 if the extension is present or 0 otherwise */
1702 /* Set to 1 if we have already parsed the extension or 0 otherwise */
1704 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
1709 * Extension index values NOTE: Any updates to these defines should be mirrored
1710 * with equivalent updates to ext_defs in extensions.c
1712 typedef enum tlsext_index_en {
1713 TLSEXT_IDX_renegotiate,
1714 TLSEXT_IDX_server_name,
1716 TLSEXT_IDX_ec_point_formats,
1717 TLSEXT_IDX_supported_groups,
1718 TLSEXT_IDX_session_ticket,
1719 TLSEXT_IDX_signature_algorithms,
1720 TLSEXT_IDX_status_request,
1721 TLSEXT_IDX_next_proto_neg,
1722 TLSEXT_IDX_application_layer_protocol_negotiation,
1723 TLSEXT_IDX_use_srtp,
1724 TLSEXT_IDX_encrypt_then_mac,
1725 TLSEXT_IDX_signed_certificate_timestamp,
1726 TLSEXT_IDX_extended_master_secret,
1727 TLSEXT_IDX_supported_versions,
1728 TLSEXT_IDX_psk_kex_modes,
1729 TLSEXT_IDX_key_share,
1730 TLSEXT_IDX_cryptopro_bug,
1736 * Dummy status type for the status_type extension. Indicates no status type
1739 #define TLSEXT_STATUSTYPE_nothing -1
1741 /* Sigalgs values */
1742 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1743 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1744 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1745 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1746 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1747 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1748 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1749 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1750 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1751 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1752 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1753 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1754 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1755 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1756 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1757 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1758 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1759 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1761 /* Known PSK key exchange modes */
1762 #define TLSEXT_KEX_MODE_KE 0x00
1763 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1766 * Internal representations of key exchange modes
1768 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1769 #define TLSEXT_KEX_MODE_FLAG_KE 1
1770 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1772 /* An invalid index into the TLSv1.3 PSK identities */
1773 #define TLSEXT_PSK_BAD_IDENTITY -1
1775 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1776 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1778 /* A dummy signature value not valid for TLSv1.2 signature algs */
1779 #define TLSEXT_signature_rsa_pss 0x0101
1782 #define MAX_COMPRESSIONS_SIZE 255
1786 unsigned int legacy_version;
1787 unsigned char random[SSL3_RANDOM_SIZE];
1788 size_t session_id_len;
1789 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1790 size_t dtls_cookie_len;
1791 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
1792 PACKET ciphersuites;
1793 size_t compressions_len;
1794 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
1796 RAW_EXTENSION *pre_proc_exts;
1799 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1801 __owur const SSL_METHOD *ssl_bad_method(int ver);
1802 __owur const SSL_METHOD *sslv3_method(void);
1803 __owur const SSL_METHOD *sslv3_server_method(void);
1804 __owur const SSL_METHOD *sslv3_client_method(void);
1805 __owur const SSL_METHOD *tlsv1_method(void);
1806 __owur const SSL_METHOD *tlsv1_server_method(void);
1807 __owur const SSL_METHOD *tlsv1_client_method(void);
1808 __owur const SSL_METHOD *tlsv1_1_method(void);
1809 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1810 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1811 __owur const SSL_METHOD *tlsv1_2_method(void);
1812 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1813 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1814 __owur const SSL_METHOD *tlsv1_3_method(void);
1815 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1816 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1817 __owur const SSL_METHOD *dtlsv1_method(void);
1818 __owur const SSL_METHOD *dtlsv1_server_method(void);
1819 __owur const SSL_METHOD *dtlsv1_client_method(void);
1820 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1821 __owur const SSL_METHOD *dtlsv1_2_method(void);
1822 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1823 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1825 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1826 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1827 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1828 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1829 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1830 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1831 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1834 * Flags for SSL methods
1836 # define SSL_METHOD_NO_FIPS (1U<<0)
1837 # define SSL_METHOD_NO_SUITEB (1U<<1)
1839 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1840 s_connect, enc_data) \
1841 const SSL_METHOD *func_name(void) \
1843 static const SSL_METHOD func_name##_data= { \
1857 ssl3_renegotiate_check, \
1860 ssl3_dispatch_alert, \
1863 ssl3_get_cipher_by_char, \
1864 ssl3_put_cipher_by_char, \
1868 tls1_default_timeout, \
1870 ssl_undefined_void_function, \
1871 ssl3_callback_ctrl, \
1872 ssl3_ctx_callback_ctrl, \
1874 return &func_name##_data; \
1877 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1878 const SSL_METHOD *func_name(void) \
1880 static const SSL_METHOD func_name##_data= { \
1882 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1894 ssl3_renegotiate_check, \
1897 ssl3_dispatch_alert, \
1900 ssl3_get_cipher_by_char, \
1901 ssl3_put_cipher_by_char, \
1905 ssl3_default_timeout, \
1907 ssl_undefined_void_function, \
1908 ssl3_callback_ctrl, \
1909 ssl3_ctx_callback_ctrl, \
1911 return &func_name##_data; \
1914 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1915 s_connect, enc_data) \
1916 const SSL_METHOD *func_name(void) \
1918 static const SSL_METHOD func_name##_data= { \
1932 ssl3_renegotiate_check, \
1934 dtls1_write_app_data_bytes, \
1935 dtls1_dispatch_alert, \
1938 ssl3_get_cipher_by_char, \
1939 ssl3_put_cipher_by_char, \
1943 dtls1_default_timeout, \
1945 ssl_undefined_void_function, \
1946 ssl3_callback_ctrl, \
1947 ssl3_ctx_callback_ctrl, \
1949 return &func_name##_data; \
1952 struct openssl_ssl_test_functions {
1953 int (*p_ssl_init_wbio_buffer) (SSL *s);
1954 int (*p_ssl3_setup_buffers) (SSL *s);
1957 const char *ssl_protocol_to_string(int version);
1959 /* Returns true if certificate and private key for 'idx' are present */
1960 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
1962 if (idx < 0 || idx >= SSL_PKEY_NUM)
1964 return s->cert->pkeys[idx].x509 != NULL
1965 && s->cert->pkeys[idx].privatekey != NULL;
1968 # ifndef OPENSSL_UNIT_TEST
1970 void ssl_clear_cipher_ctx(SSL *s);
1971 int ssl_clear_bad_session(SSL *s);
1972 __owur CERT *ssl_cert_new(void);
1973 __owur CERT *ssl_cert_dup(CERT *cert);
1974 void ssl_cert_clear_certs(CERT *c);
1975 void ssl_cert_free(CERT *c);
1976 __owur int ssl_get_new_session(SSL *s, int session);
1977 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
1978 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
1979 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1980 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
1981 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1982 const SSL_CIPHER *const *bp);
1983 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
1984 STACK_OF(SSL_CIPHER) **pref,
1985 STACK_OF(SSL_CIPHER)
1987 const char *rule_str,
1989 void ssl_update_cache(SSL *s, int mode);
1990 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
1991 const EVP_MD **md, int *mac_pkey_type,
1992 size_t *mac_secret_size, SSL_COMP **comp,
1994 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1995 size_t *int_overhead, size_t *blocksize,
1996 size_t *ext_overhead);
1997 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
1998 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
1999 const unsigned char *ptr);
2000 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2001 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2002 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2003 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2004 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2005 __owur int ssl_cert_set_current(CERT *c, long arg);
2006 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2007 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2009 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2010 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2011 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2014 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2015 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2018 int ssl_undefined_function(SSL *s);
2019 __owur int ssl_undefined_void_function(void);
2020 __owur int ssl_undefined_const_function(const SSL *s);
2021 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2022 const unsigned char **serverinfo,
2023 size_t *serverinfo_length);
2024 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2025 void ssl_set_masks(SSL *s);
2026 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2027 __owur int ssl_verify_alarm_type(long type);
2028 void ssl_sort_cipher_list(void);
2029 void ssl_load_ciphers(void);
2030 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2032 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2034 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2035 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2037 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2039 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2040 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2041 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2043 int ssl3_init_finished_mac(SSL *s);
2044 __owur int ssl3_setup_key_block(SSL *s);
2045 __owur int ssl3_change_cipher_state(SSL *s, int which);
2046 void ssl3_cleanup_key_block(SSL *s);
2047 __owur int ssl3_do_write(SSL *s, int type);
2048 int ssl3_send_alert(SSL *s, int level, int desc);
2049 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2050 unsigned char *p, size_t len,
2051 size_t *secret_size);
2052 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2053 __owur int ssl3_num_ciphers(void);
2054 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2055 int ssl3_renegotiate(SSL *ssl);
2056 int ssl3_renegotiate_check(SSL *ssl, int initok);
2057 __owur int ssl3_dispatch_alert(SSL *s);
2058 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2060 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2061 void ssl3_free_digest_list(SSL *s);
2062 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2063 CERT_PKEY *cpk, int *al);
2064 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2065 STACK_OF(SSL_CIPHER) *clnt,
2066 STACK_OF(SSL_CIPHER) *srvr);
2067 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2068 __owur int ssl3_new(SSL *s);
2069 void ssl3_free(SSL *s);
2070 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2071 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2072 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2073 __owur int ssl3_shutdown(SSL *s);
2074 void ssl3_clear(SSL *s);
2075 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2076 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2077 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2078 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2080 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2081 __owur long ssl3_default_timeout(void);
2083 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2084 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2085 __owur int tls_setup_handshake(SSL *s);
2086 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2087 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2088 __owur int ssl3_handshake_write(SSL *s);
2090 __owur int ssl_allow_compression(SSL *s);
2092 __owur int ssl_version_supported(const SSL *s, int version);
2094 __owur int ssl_set_client_hello_version(SSL *s);
2095 __owur int ssl_check_version_downgrade(SSL *s);
2096 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2097 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello);
2098 __owur int ssl_choose_client_version(SSL *s, int version);
2099 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
2102 __owur long tls1_default_timeout(void);
2103 __owur int dtls1_do_write(SSL *s, int type);
2104 void dtls1_set_message_header(SSL *s,
2107 size_t frag_off, size_t frag_len);
2109 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2112 __owur int dtls1_read_failed(SSL *s, int code);
2113 __owur int dtls1_buffer_message(SSL *s, int ccs);
2114 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2115 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2116 int dtls1_retransmit_buffered_messages(SSL *s);
2117 void dtls1_clear_received_buffer(SSL *s);
2118 void dtls1_clear_sent_buffer(SSL *s);
2119 void dtls1_get_message_header(unsigned char *data,
2120 struct hm_header_st *msg_hdr);
2121 __owur long dtls1_default_timeout(void);
2122 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2123 __owur int dtls1_check_timeout_num(SSL *s);
2124 __owur int dtls1_handle_timeout(SSL *s);
2125 void dtls1_start_timer(SSL *s);
2126 void dtls1_stop_timer(SSL *s);
2127 __owur int dtls1_is_timer_expired(SSL *s);
2128 void dtls1_double_timeout(SSL *s);
2129 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2131 __owur int dtls1_send_newsession_ticket(SSL *s);
2132 __owur size_t dtls1_min_mtu(SSL *s);
2133 void dtls1_hm_fragment_free(hm_fragment *frag);
2134 __owur int dtls1_query_mtu(SSL *s);
2136 __owur int tls1_new(SSL *s);
2137 void tls1_free(SSL *s);
2138 void tls1_clear(SSL *s);
2139 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2140 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2142 __owur int dtls1_new(SSL *s);
2143 void dtls1_free(SSL *s);
2144 void dtls1_clear(SSL *s);
2145 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2146 __owur int dtls1_shutdown(SSL *s);
2148 __owur int dtls1_dispatch_alert(SSL *s);
2150 __owur int ssl_init_wbio_buffer(SSL *s);
2151 void ssl_free_wbio_buffer(SSL *s);
2153 __owur int tls1_change_cipher_state(SSL *s, int which);
2154 __owur int tls1_setup_key_block(SSL *s);
2155 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2157 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2158 unsigned char *p, size_t len,
2159 size_t *secret_size);
2160 __owur int tls13_setup_key_block(SSL *s);
2161 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2163 __owur int tls13_change_cipher_state(SSL *s, int which);
2164 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2165 const unsigned char *secret,
2166 const unsigned char *label, size_t labellen,
2167 const unsigned char *hash,
2168 unsigned char *out, size_t outlen);
2169 __owur int tls13_derive_key(SSL *s, const unsigned char *secret,
2170 unsigned char *key, size_t keylen);
2171 __owur int tls13_derive_iv(SSL *s, const unsigned char *secret,
2172 unsigned char *iv, size_t ivlen);
2173 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2174 const unsigned char *secret,
2175 unsigned char *fin, size_t finlen);
2176 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2177 const unsigned char *prevsecret,
2178 const unsigned char *insecret,
2180 unsigned char *outsecret);
2181 __owur int tls13_generate_handshake_secret(SSL *s,
2182 const unsigned char *insecret,
2183 size_t insecretlen);
2184 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2185 unsigned char *prev, size_t prevlen,
2186 size_t *secret_size);
2187 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2188 const char *label, size_t llen,
2189 const unsigned char *p, size_t plen,
2191 __owur int tls1_alert_code(int code);
2192 __owur int tls13_alert_code(int code);
2193 __owur int ssl3_alert_code(int code);
2194 __owur int ssl_ok(SSL *s);
2196 # ifndef OPENSSL_NO_EC
2197 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2200 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2202 # ifndef OPENSSL_NO_EC
2203 /* Flags values from tls1_ec_curve_id2nid() */
2204 /* Mask for curve type */
2205 # define TLS_CURVE_TYPE 0x3
2206 # define TLS_CURVE_PRIME 0x0
2207 # define TLS_CURVE_CHAR2 0x1
2208 # define TLS_CURVE_CUSTOM 0x2
2210 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2212 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2213 __owur int tls1_ec_nid2curve_id(int nid);
2214 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2215 __owur int tls1_shared_group(SSL *s, int nmatch);
2216 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2217 int *curves, size_t ncurves);
2218 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2220 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2221 size_t *num_formats);
2222 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2223 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2224 # endif /* OPENSSL_NO_EC */
2226 __owur int tls1_shared_list(SSL *s,
2227 const unsigned char *l1, size_t l1len,
2228 const unsigned char *l2, size_t l2len, int nmatch);
2229 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2230 __owur int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2231 size_t *num_curves);
2233 void ssl_set_default_md(SSL *s);
2234 __owur int tls1_set_server_sigalgs(SSL *s);
2236 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2237 typedef enum ticket_en {
2238 /* fatal error, malloc failure */
2239 TICKET_FATAL_ERR_MALLOC,
2240 /* fatal error, either from parsing or decrypting the ticket */
2241 TICKET_FATAL_ERR_OTHER,
2242 /* No ticket present */
2244 /* Empty ticket present */
2246 /* the ticket couldn't be decrypted */
2248 /* a ticket was successfully decrypted */
2250 /* same as above but the ticket needs to be reneewed */
2251 TICKET_SUCCESS_RENEW
2254 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2256 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2258 const unsigned char *sess_id,
2259 size_t sesslen, SSL_SESSION **psess);
2261 __owur int tls_use_ticket(SSL *s);
2263 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2265 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2266 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2268 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2270 void tls1_set_cert_validity(SSL *s);
2272 # ifndef OPENSSL_NO_CT
2273 __owur int ssl_validate_ct(SSL *s);
2276 # ifndef OPENSSL_NO_DH
2277 __owur DH *ssl_get_auto_dh(SSL *s);
2280 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2281 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2284 int tls_choose_sigalg(SSL *s, int *al);
2286 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2287 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2288 __owur long ssl_get_algorithm2(SSL *s);
2289 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2290 const uint16_t *psig, size_t psiglen);
2291 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2292 __owur int tls1_process_sigalgs(SSL *s);
2293 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2294 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2295 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2296 void ssl_set_client_disabled(SSL *s);
2297 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2299 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2301 __owur const EVP_MD *ssl_md(int idx);
2302 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2303 __owur const EVP_MD *ssl_prf_md(SSL *s);
2306 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2307 * with |ssl|, if logging is enabled. It returns one on success and zero on
2308 * failure. The entry is identified by the first 8 bytes of
2309 * |encrypted_premaster|.
2311 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2312 const uint8_t *encrypted_premaster,
2313 size_t encrypted_premaster_len,
2314 const uint8_t *premaster,
2315 size_t premaster_len);
2318 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2319 * logging is available. It returns one on success and zero on failure. It tags
2320 * the entry with |label|.
2322 __owur int ssl_log_secret(SSL *ssl, const char *label,
2323 const uint8_t *secret, size_t secret_len);
2325 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2326 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2327 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2328 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2329 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2332 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2333 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2334 unsigned char *md_out,
2335 size_t *md_out_size,
2336 const unsigned char header[13],
2337 const unsigned char *data,
2338 size_t data_plus_mac_size,
2339 size_t data_plus_mac_plus_padding_size,
2340 const unsigned char *mac_secret,
2341 size_t mac_secret_length, char is_sslv3);
2343 __owur int tls_fips_digest_extra(const EVP_CIPHER_CTX *cipher_ctx,
2344 EVP_MD_CTX *mac_ctx, const unsigned char *data,
2345 size_t data_len, size_t orig_len);
2347 __owur int srp_generate_server_master_secret(SSL *s);
2348 __owur int srp_generate_client_master_secret(SSL *s);
2349 __owur int srp_verify_server_param(SSL *s, int *al);
2353 void custom_ext_init(custom_ext_methods *meths);
2355 __owur int custom_ext_parse(SSL *s, int server,
2356 unsigned int ext_type,
2357 const unsigned char *ext_data, size_t ext_size,
2359 __owur int custom_ext_add(SSL *s, int server, WPACKET *pkt, int *al);
2361 __owur int custom_exts_copy(custom_ext_methods *dst,
2362 const custom_ext_methods *src);
2363 void custom_exts_free(custom_ext_methods *exts);
2365 void ssl_comp_free_compression_methods_int(void);
2369 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2370 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers