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 /* Bits for algorithm_auth (server authentication) */
234 # define SSL_aRSA 0x00000001U
236 # define SSL_aDSS 0x00000002U
237 /* no auth (i.e. use ADH or AECDH) */
238 # define SSL_aNULL 0x00000004U
240 # define SSL_aECDSA 0x00000008U
242 # define SSL_aPSK 0x00000010U
243 /* GOST R 34.10-2001 signature auth */
244 # define SSL_aGOST01 0x00000020U
246 # define SSL_aSRP 0x00000040U
247 /* GOST R 34.10-2012 signature auth */
248 # define SSL_aGOST12 0x00000080U
250 /* Bits for algorithm_enc (symmetric encryption) */
251 # define SSL_DES 0x00000001U
252 # define SSL_3DES 0x00000002U
253 # define SSL_RC4 0x00000004U
254 # define SSL_RC2 0x00000008U
255 # define SSL_IDEA 0x00000010U
256 # define SSL_eNULL 0x00000020U
257 # define SSL_AES128 0x00000040U
258 # define SSL_AES256 0x00000080U
259 # define SSL_CAMELLIA128 0x00000100U
260 # define SSL_CAMELLIA256 0x00000200U
261 # define SSL_eGOST2814789CNT 0x00000400U
262 # define SSL_SEED 0x00000800U
263 # define SSL_AES128GCM 0x00001000U
264 # define SSL_AES256GCM 0x00002000U
265 # define SSL_AES128CCM 0x00004000U
266 # define SSL_AES256CCM 0x00008000U
267 # define SSL_AES128CCM8 0x00010000U
268 # define SSL_AES256CCM8 0x00020000U
269 # define SSL_eGOST2814789CNT12 0x00040000U
270 # define SSL_CHACHA20POLY1305 0x00080000U
272 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
273 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
274 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
275 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
276 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
278 /* Bits for algorithm_mac (symmetric authentication) */
280 # define SSL_MD5 0x00000001U
281 # define SSL_SHA1 0x00000002U
282 # define SSL_GOST94 0x00000004U
283 # define SSL_GOST89MAC 0x00000008U
284 # define SSL_SHA256 0x00000010U
285 # define SSL_SHA384 0x00000020U
286 /* Not a real MAC, just an indication it is part of cipher */
287 # define SSL_AEAD 0x00000040U
288 # define SSL_GOST12_256 0x00000080U
289 # define SSL_GOST89MAC12 0x00000100U
290 # define SSL_GOST12_512 0x00000200U
293 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
294 * sure to update this constant too
297 # define SSL_MD_MD5_IDX 0
298 # define SSL_MD_SHA1_IDX 1
299 # define SSL_MD_GOST94_IDX 2
300 # define SSL_MD_GOST89MAC_IDX 3
301 # define SSL_MD_SHA256_IDX 4
302 # define SSL_MD_SHA384_IDX 5
303 # define SSL_MD_GOST12_256_IDX 6
304 # define SSL_MD_GOST89MAC12_IDX 7
305 # define SSL_MD_GOST12_512_IDX 8
306 # define SSL_MD_MD5_SHA1_IDX 9
307 # define SSL_MD_SHA224_IDX 10
308 # define SSL_MD_SHA512_IDX 11
309 # define SSL_MAX_DIGEST 12
311 /* Bits for algorithm2 (handshake digests and other extra flags) */
313 /* Bits 0-7 are handshake MAC */
314 # define SSL_HANDSHAKE_MAC_MASK 0xFF
315 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
316 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
317 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
318 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
319 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
320 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
321 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
323 /* Bits 8-15 bits are PRF */
324 # define TLS1_PRF_DGST_SHIFT 8
325 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
326 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
327 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
328 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
329 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
330 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
331 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
334 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
335 * goes into algorithm2)
337 # define TLS1_STREAM_MAC 0x10000
339 # define SSL_STRONG_MASK 0x0000001FU
340 # define SSL_DEFAULT_MASK 0X00000020U
342 # define SSL_STRONG_NONE 0x00000001U
343 # define SSL_LOW 0x00000002U
344 # define SSL_MEDIUM 0x00000004U
345 # define SSL_HIGH 0x00000008U
346 # define SSL_FIPS 0x00000010U
347 # define SSL_NOT_DEFAULT 0x00000020U
349 /* we have used 0000003f - 26 bits left to go */
351 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
352 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
354 /* Check if an SSL structure is using DTLS */
355 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
357 /* Check if we are using TLSv1.3 */
358 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
359 && (s)->method->version >= TLS1_3_VERSION \
360 && (s)->method->version != TLS_ANY_VERSION)
362 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
364 /* See if we need explicit IV */
365 # define SSL_USE_EXPLICIT_IV(s) \
366 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
368 * See if we use signature algorithms extension and signature algorithm
371 # define SSL_USE_SIGALGS(s) \
372 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
374 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
375 * apply to others in future.
377 # define SSL_USE_TLS1_2_CIPHERS(s) \
378 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
380 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
381 * flags because it may not be set to correct version yet.
383 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
384 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
385 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
387 * Determine if a client should send signature algorithms extension:
388 * as with TLS1.2 cipher we can't rely on method flags.
390 # define SSL_CLIENT_USE_SIGALGS(s) \
391 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
393 # define SSL_USE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC)
395 /* Mostly for SSLv3 */
396 # define SSL_PKEY_RSA_ENC 0
397 # define SSL_PKEY_RSA_SIGN 1
398 # define SSL_PKEY_DSA_SIGN 2
399 # define SSL_PKEY_ECC 3
400 # define SSL_PKEY_GOST01 4
401 # define SSL_PKEY_GOST12_256 5
402 # define SSL_PKEY_GOST12_512 6
403 # define SSL_PKEY_NUM 7
405 * Pseudo-constant. GOST cipher suites can use different certs for 1
406 * SSL_CIPHER. So let's see which one we have in fact.
408 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
411 * SSL_kRSA <- RSA_ENC
412 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
413 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
414 * SSL_aRSA <- RSA_ENC | RSA_SIGN
415 * SSL_aDSS <- DSA_SIGN
419 #define CERT_INVALID 0
420 #define CERT_PUBLIC_KEY 1
421 #define CERT_PRIVATE_KEY 2
424 /* CipherSuite length. SSLv3 and all TLS versions. */
425 # define TLS_CIPHER_LEN 2
426 /* used to hold info on the particular ciphers used */
427 struct ssl_cipher_st
{
429 const char *name
; /* text name */
430 uint32_t id
; /* id, 4 bytes, first is version */
432 * changed in 1.0.0: these four used to be portions of a single value
435 uint32_t algorithm_mkey
; /* key exchange algorithm */
436 uint32_t algorithm_auth
; /* server authentication */
437 uint32_t algorithm_enc
; /* symmetric encryption */
438 uint32_t algorithm_mac
; /* symmetric authentication */
439 int min_tls
; /* minimum SSL/TLS protocol version */
440 int max_tls
; /* maximum SSL/TLS protocol version */
441 int min_dtls
; /* minimum DTLS protocol version */
442 int max_dtls
; /* maximum DTLS protocol version */
443 uint32_t algo_strength
; /* strength and export flags */
444 uint32_t algorithm2
; /* Extra flags */
445 int32_t strength_bits
; /* Number of bits really used */
446 uint32_t alg_bits
; /* Number of bits for algorithm */
449 /* Used to hold SSL/TLS functions */
450 struct ssl_method_st
{
454 int (*ssl_new
) (SSL
*s
);
455 void (*ssl_clear
) (SSL
*s
);
456 void (*ssl_free
) (SSL
*s
);
457 int (*ssl_accept
) (SSL
*s
);
458 int (*ssl_connect
) (SSL
*s
);
459 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
460 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
461 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
462 int (*ssl_shutdown
) (SSL
*s
);
463 int (*ssl_renegotiate
) (SSL
*s
);
464 int (*ssl_renegotiate_check
) (SSL
*s
, int);
465 int (*ssl_read_bytes
) (SSL
*s
, int type
, int *recvd_type
,
466 unsigned char *buf
, size_t len
, int peek
,
468 int (*ssl_write_bytes
) (SSL
*s
, int type
, const void *buf_
, size_t len
,
470 int (*ssl_dispatch_alert
) (SSL
*s
);
471 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
472 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
473 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
474 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
476 size_t (*ssl_pending
) (const SSL
*s
);
477 int (*num_ciphers
) (void);
478 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
479 long (*get_timeout
) (void);
480 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
481 int (*ssl_version
) (void);
482 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
483 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
487 * Lets make this into an ASN.1 type structure as follows
488 * SSL_SESSION_ID ::= SEQUENCE {
489 * version INTEGER, -- structure version number
490 * SSLversion INTEGER, -- SSL version number
491 * Cipher OCTET STRING, -- the 3 byte cipher ID
492 * Session_ID OCTET STRING, -- the Session ID
493 * Master_key OCTET STRING, -- the master key
494 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
495 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
496 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
497 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
498 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
499 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
500 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
501 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
502 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
503 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
504 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
505 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
506 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
507 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
509 * Look in ssl/ssl_asn1.c for more details
510 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
512 struct ssl_session_st
{
513 int ssl_version
; /* what ssl version session info is being kept
515 size_t master_key_length
;
518 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
521 unsigned char master_key
[TLS13_MAX_RESUMPTION_MASTER_LENGTH
];
522 /* session_id - valid? */
523 size_t session_id_length
;
524 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
526 * this is used to determine whether the session is being reused in the
527 * appropriate context. It is up to the application to set this, via
530 size_t sid_ctx_length
;
531 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
532 # ifndef OPENSSL_NO_PSK
533 char *psk_identity_hint
;
537 * Used to indicate that session resumption is not allowed. Applications
538 * can also set this bit for a new session via not_resumable_session_cb
539 * to disable session caching and tickets.
542 /* This is the cert and type for the other end. */
545 /* Certificate chain peer sent */
546 STACK_OF(X509
) *peer_chain
;
548 * when app_verify_callback accepts a session where the peer's
549 * certificate is not ok, we must remember the error for session reuse:
551 long verify_result
; /* only for servers */
552 CRYPTO_REF_COUNT references
;
555 unsigned int compress_meth
; /* Need to lookup the method */
556 const SSL_CIPHER
*cipher
;
557 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
558 * load the 'cipher' structure */
559 STACK_OF(SSL_CIPHER
) *ciphers
; /* shared ciphers? */
560 CRYPTO_EX_DATA ex_data
; /* application specific data */
562 * These are used to make removal of session-ids more efficient and to
563 * implement a maximum cache size.
565 struct ssl_session_st
*prev
, *next
;
569 # ifndef OPENSSL_NO_EC
570 size_t ecpointformats_len
;
571 unsigned char *ecpointformats
; /* peer's list */
572 size_t supportedgroups_len
;
573 unsigned char *supportedgroups
; /* peer's list */
574 # endif /* OPENSSL_NO_EC */
576 unsigned char *tick
; /* Session ticket */
577 size_t ticklen
; /* Session ticket length */
578 /* Session lifetime hint in seconds */
579 unsigned long tick_lifetime_hint
;
580 uint32_t tick_age_add
;
583 # ifndef OPENSSL_NO_SRP
590 /* Extended master secret support */
591 # define SSL_SESS_FLAG_EXTMS 0x1
593 # ifndef OPENSSL_NO_SRP
595 typedef struct srp_ctx_st
{
596 /* param for all the callbacks */
598 /* set client Hello login callback */
599 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
600 /* set SRP N/g param callback for verification */
601 int (*SRP_verify_param_callback
) (SSL
*, void *);
602 /* set SRP client passwd callback */
603 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
605 BIGNUM
*N
, *g
, *s
, *B
, *A
;
609 unsigned long srp_Mask
;
620 DEFINE_LHASH_OF(SSL_SESSION
);
621 /* Needed in ssl_cert.c */
622 DEFINE_LHASH_OF(X509_NAME
);
624 # define TLSEXT_KEYNAME_LENGTH 16
627 const SSL_METHOD
*method
;
628 STACK_OF(SSL_CIPHER
) *cipher_list
;
629 /* same as above but sorted for lookup */
630 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
631 struct x509_store_st
/* X509_STORE */ *cert_store
;
632 LHASH_OF(SSL_SESSION
) *sessions
;
634 * Most session-ids that will be cached, default is
635 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
637 size_t session_cache_size
;
638 struct ssl_session_st
*session_cache_head
;
639 struct ssl_session_st
*session_cache_tail
;
641 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
642 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
643 * means only SSL_accept which cache SSL_SESSIONS.
645 uint32_t session_cache_mode
;
647 * If timeout is not 0, it is the default timeout value set when
648 * SSL_new() is called. This has been put in to make life easier to set
651 long session_timeout
;
653 * If this callback is not null, it will be called each time a session id
654 * is added to the cache. If this function returns 1, it means that the
655 * callback will do a SSL_SESSION_free() when it has finished using it.
656 * Otherwise, on 0, it means the callback has finished with it. If
657 * remove_session_cb is not null, it will be called when a session-id is
658 * removed from the cache. After the call, OpenSSL will
659 * SSL_SESSION_free() it.
661 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
662 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
663 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
664 const unsigned char *data
, int len
,
667 int sess_connect
; /* SSL new conn - started */
668 int sess_connect_renegotiate
; /* SSL reneg - requested */
669 int sess_connect_good
; /* SSL new conne/reneg - finished */
670 int sess_accept
; /* SSL new accept - started */
671 int sess_accept_renegotiate
; /* SSL reneg - requested */
672 int sess_accept_good
; /* SSL accept/reneg - finished */
673 int sess_miss
; /* session lookup misses */
674 int sess_timeout
; /* reuse attempt on timeouted session */
675 int sess_cache_full
; /* session removed due to full cache */
676 int sess_hit
; /* session reuse actually done */
677 int sess_cb_hit
; /* session-id that was not in the cache was
678 * passed back via the callback. This
679 * indicates that the application is supplying
680 * session-id's from other processes - spooky
684 CRYPTO_REF_COUNT references
;
686 /* if defined, these override the X509_verify_cert() calls */
687 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
688 void *app_verify_arg
;
690 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
691 * ('app_verify_callback' was called with just one argument)
694 /* Default password callback. */
695 pem_password_cb
*default_passwd_callback
;
697 /* Default password callback user data. */
698 void *default_passwd_callback_userdata
;
700 /* get client cert callback */
701 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
703 /* cookie generate callback */
704 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
705 unsigned int *cookie_len
);
707 /* verify cookie callback */
708 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
709 unsigned int cookie_len
);
711 CRYPTO_EX_DATA ex_data
;
713 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
714 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3->sha1' */
716 STACK_OF(X509
) *extra_certs
;
717 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
719 /* Default values used when no per-SSL value is defined follow */
721 /* used if SSL's info_callback is NULL */
722 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
724 /* what we put in client cert requests */
725 STACK_OF(X509_NAME
) *client_CA
;
728 * Default values to use in SSL structures follow (these are copied by
734 int min_proto_version
;
735 int max_proto_version
;
736 size_t max_cert_list
;
738 struct cert_st
/* CERT */ *cert
;
741 /* callback that allows applications to peek at protocol messages */
742 void (*msg_callback
) (int write_p
, int version
, int content_type
,
743 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
744 void *msg_callback_arg
;
746 uint32_t verify_mode
;
747 size_t sid_ctx_length
;
748 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
749 /* called 'verify_callback' in the SSL */
750 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
752 /* Default generate session ID callback. */
753 GEN_SESSION_CB generate_session_id
;
755 X509_VERIFY_PARAM
*param
;
759 # ifndef OPENSSL_NO_CT
760 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
762 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
763 * If they are not, the connection should be aborted.
765 ssl_ct_validation_cb ct_validation_callback
;
766 void *ct_validation_callback_arg
;
770 * If we're using more than one pipeline how should we divide the data
771 * up between the pipes?
773 size_t split_send_fragment
;
775 * Maximum amount of data to send in one fragment. actual record size can
776 * be more than this due to padding and MAC overheads.
778 size_t max_send_fragment
;
780 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
781 size_t max_pipelines
;
783 /* The default read buffer length to use (0 means not set) */
784 size_t default_read_buf_len
;
786 # ifndef OPENSSL_NO_ENGINE
788 * Engine to pass requests for client certs to
790 ENGINE
*client_cert_engine
;
793 /* TLS extensions. */
795 /* TLS extensions servername callback */
796 int (*servername_cb
) (SSL
*, int *, void *);
797 void *servername_arg
;
798 /* RFC 4507 session ticket keys */
799 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
800 unsigned char tick_hmac_key
[32];
801 unsigned char tick_aes_key
[32];
802 /* Callback to support customisation of ticket key setting */
803 int (*ticket_key_cb
) (SSL
*ssl
,
804 unsigned char *name
, unsigned char *iv
,
805 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
807 /* certificate status request info */
808 /* Callback for status request */
809 int (*status_cb
) (SSL
*ssl
, void *arg
);
811 /* ext status type used for CSR extension (OCSP Stapling) */
814 # ifndef OPENSSL_NO_EC
815 /* EC extension values inherited by SSL structure */
816 size_t ecpointformats_len
;
817 unsigned char *ecpointformats
;
818 size_t supportedgroups_len
;
819 unsigned char *supportedgroups
;
820 # endif /* OPENSSL_NO_EC */
823 * ALPN information (we are in the process of transitioning from NPN to
828 * For a server, this contains a callback function that allows the
829 * server to select the protocol for the connection.
830 * out: on successful return, this must point to the raw protocol
831 * name (without the length prefix).
832 * outlen: on successful return, this contains the length of |*out|.
833 * in: points to the client's list of supported protocols in
835 * inlen: the length of |in|.
837 int (*alpn_select_cb
) (SSL
*s
,
838 const unsigned char **out
,
839 unsigned char *outlen
,
840 const unsigned char *in
,
841 unsigned int inlen
, void *arg
);
842 void *alpn_select_cb_arg
;
845 * For a client, this contains the list of supported protocols in wire
851 # ifndef OPENSSL_NO_NEXTPROTONEG
852 /* Next protocol negotiation information */
855 * For a server, this contains a callback function by which the set of
856 * advertised protocols can be provided.
858 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
859 void *npn_advertised_cb_arg
;
861 * For a client, this contains a callback function that selects the next
862 * protocol from the list provided by the server.
864 SSL_CTX_npn_select_cb_func npn_select_cb
;
865 void *npn_select_cb_arg
;
869 # ifndef OPENSSL_NO_PSK
870 SSL_psk_client_cb_func psk_client_callback
;
871 SSL_psk_server_cb_func psk_server_callback
;
874 # ifndef OPENSSL_NO_SRP
875 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
878 /* Shared DANE context */
879 struct dane_ctx_st dane
;
881 /* SRTP profiles we are willing to do from RFC 5764 */
882 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
884 * Callback for disabling session caching and ticket support on a session
885 * basis, depending on the chosen cipher.
887 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
892 * Callback for logging key material for use with debugging tools like
893 * Wireshark. The callback should log `line` followed by a newline.
895 SSL_CTX_keylog_cb_func keylog_callback
;
900 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
905 const SSL_METHOD
*method
;
907 * There are 2 BIO's even though they are normally both the same. This
908 * is so data can be read and written to different handlers
910 /* used by SSL_read */
912 /* used by SSL_write */
914 /* used during session-id reuse to concatenate messages */
917 * This holds a variable that indicates what we were doing when a 0 or -1
918 * is returned. This is needed for non-blocking IO so we know what
919 * request needs re-doing when in SSL_accept or SSL_connect
922 int (*handshake_func
) (SSL
*);
924 * Imagine that here's a boolean member "init" that is switched as soon
925 * as SSL_set_{accept/connect}_state is called for the first time, so
926 * that "state" and "handshake_func" are properly initialized. But as
927 * handshake_func is == 0 until then, we use this test instead of an
930 /* are we the server side? */
933 * Generate a new session or reuse an old one.
934 * NB: For servers, the 'new' session may actually be a previously
935 * cached session or even the previous session unless
936 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
939 /* don't send shutdown packets */
941 /* we have shut things down, 0x01 sent, 0x02 for received */
945 BUF_MEM
*init_buf
; /* buffer used during init */
946 void *init_msg
; /* pointer to handshake message body, set by
947 * ssl3_get_message() */
948 size_t init_num
; /* amount read/written */
949 size_t init_off
; /* amount read/written */
950 struct ssl3_state_st
*s3
; /* SSLv3 variables */
951 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
952 /* callback that allows applications to peek at protocol messages */
953 void (*msg_callback
) (int write_p
, int version
, int content_type
,
954 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
955 void *msg_callback_arg
;
956 int hit
; /* reusing a previous session */
957 X509_VERIFY_PARAM
*param
;
958 /* Per connection DANE state */
961 STACK_OF(SSL_CIPHER
) *cipher_list
;
962 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
964 * These are the ones being used, the ones in SSL_SESSION are the ones to
965 * be 'copied' into these ones
969 * The TLS1.3 secrets. The resumption master secret is stored in the
972 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
973 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
974 unsigned char master_secret
[EVP_MAX_MD_SIZE
];
975 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
976 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
977 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
978 EVP_CIPHER_CTX
*enc_read_ctx
; /* cryptographic state */
979 unsigned char read_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static read IV */
980 EVP_MD_CTX
*read_hash
; /* used for mac generation */
981 COMP_CTX
*compress
; /* compression */
982 COMP_CTX
*expand
; /* uncompress */
983 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
984 unsigned char write_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static write IV */
985 EVP_MD_CTX
*write_hash
; /* used for mac generation */
988 /* This is used to hold the server certificate used */
989 struct cert_st
/* CERT */ *cert
;
992 * The hash of all messages prior to the CertificateVerify, and the length
995 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
996 size_t cert_verify_hash_len
;
999 * the session_id_context is used to ensure sessions are only reused in
1000 * the appropriate context
1002 size_t sid_ctx_length
;
1003 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
1004 /* This can also be in the session once a session is established */
1005 SSL_SESSION
*session
;
1006 /* Default generate session ID callback. */
1007 GEN_SESSION_CB generate_session_id
;
1010 * 0 don't care about verify failure.
1011 * 1 fail if verify fails
1013 uint32_t verify_mode
;
1014 /* fail if callback returns 0 */
1015 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1016 /* optional informational callback */
1017 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1018 /* error bytes to be written */
1022 # ifndef OPENSSL_NO_PSK
1023 SSL_psk_client_cb_func psk_client_callback
;
1024 SSL_psk_server_cb_func psk_server_callback
;
1027 /* Verified chain of peer */
1028 STACK_OF(X509
) *verified_chain
;
1030 /* extra application data */
1031 CRYPTO_EX_DATA ex_data
;
1032 /* for server side, keep the list of CA_dn we can use */
1033 STACK_OF(X509_NAME
) *client_CA
;
1034 CRYPTO_REF_COUNT references
;
1035 /* protocol behaviour */
1039 int min_proto_version
;
1040 int max_proto_version
;
1041 size_t max_cert_list
;
1044 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1045 * secret and SSLv3/TLS (<=1.2) rollback check
1049 * If we're using more than one pipeline how should we divide the data
1050 * up between the pipes?
1052 size_t split_send_fragment
;
1054 * Maximum amount of data to send in one fragment. actual record size can
1055 * be more than this due to padding and MAC overheads.
1057 size_t max_send_fragment
;
1058 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1059 size_t max_pipelines
;
1062 /* TLS extension debug callback */
1063 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1064 const unsigned char *data
, int len
, void *arg
);
1067 /* certificate status request info */
1068 /* Status type or -1 if no status type */
1070 /* Raw extension data, if seen */
1071 unsigned char *scts
;
1072 /* Length of raw extension data, if seen */
1074 /* Expect OCSP CertificateStatus message */
1075 int status_expected
;
1078 /* OCSP status request only */
1079 STACK_OF(OCSP_RESPID
) *ids
;
1080 X509_EXTENSIONS
*exts
;
1081 /* OCSP response received or to be sent */
1082 unsigned char *resp
;
1086 /* RFC4507 session ticket expected to be received or sent */
1087 int ticket_expected
;
1088 # ifndef OPENSSL_NO_EC
1089 size_t ecpointformats_len
;
1091 unsigned char *ecpointformats
;
1092 size_t supportedgroups_len
;
1094 unsigned char *supportedgroups
;
1095 # endif /* OPENSSL_NO_EC */
1096 /* TLS Session Ticket extension override */
1097 TLS_SESSION_TICKET_EXT
*session_ticket
;
1098 /* TLS Session Ticket extension callback */
1099 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1100 void *session_ticket_cb_arg
;
1101 /* TLS pre-shared secret session resumption */
1102 tls_session_secret_cb_fn session_secret_cb
;
1103 void *session_secret_cb_arg
;
1105 * For a client, this contains the list of supported protocols in wire
1108 unsigned char *alpn
;
1111 * Next protocol negotiation. For the client, this is the protocol that
1112 * we sent in NextProtocol and is set when handling ServerHello
1113 * extensions. For a server, this is the client's selected_protocol from
1114 * NextProtocol and is set when handling the NextProtocol message, before
1115 * the Finished message.
1120 /* The available PSK key exchange modes */
1125 * no further mod of servername
1126 * 0 : call the servername extension callback.
1127 * 1 : prepare 2, allow last ack just after in server callback.
1128 * 2 : don't call servername callback, no ack in server hello
1130 int servername_done
;
1131 # ifndef OPENSSL_NO_CT
1133 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1134 * If they are not, the connection should be aborted.
1136 ssl_ct_validation_cb ct_validation_callback
;
1137 /* User-supplied argument that is passed to the ct_validation_callback */
1138 void *ct_validation_callback_arg
;
1140 * Consolidated stack of SCTs from all sources.
1141 * Lazily populated by CT_get_peer_scts(SSL*)
1143 STACK_OF(SCT
) *scts
;
1144 /* Have we attempted to find/parse SCTs yet? */
1147 SSL_CTX
*initial_ctx
; /* initial ctx, used to store sessions */
1148 # ifndef OPENSSL_NO_NEXTPROTONEG
1150 # define session_ctx initial_ctx
1152 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1153 /* What's been chosen */
1154 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1156 * 1 if we are renegotiating.
1157 * 2 if we are a server and are inside a handshake
1158 * (i.e. not just sending a HelloRequest)
1161 # ifndef OPENSSL_NO_SRP
1162 /* ctx for SRP authentication */
1166 * Callback for disabling session caching and ticket support on a session
1167 * basis, depending on the chosen cipher.
1169 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1170 RECORD_LAYER rlayer
;
1171 /* Default password callback. */
1172 pem_password_cb
*default_passwd_callback
;
1173 /* Default password callback user data. */
1174 void *default_passwd_callback_userdata
;
1175 /* Async Job info */
1177 ASYNC_WAIT_CTX
*waitctx
;
1180 CRYPTO_RWLOCK
*lock
;
1184 * Structure containing table entry of values associated with the signature
1185 * algorithms (signature scheme) extension
1187 typedef struct sigalg_lookup_st
{
1188 /* TLS 1.3 signature scheme name */
1190 /* Raw value used in extension */
1192 /* NID of hash algorithm */
1194 /* NID of signature algorithm */
1196 /* Combined hash and signature NID, if any */
1198 /* Required public key curve (ECDSA only) */
1202 typedef struct ssl3_state_st
{
1204 size_t read_mac_secret_size
;
1205 unsigned char read_mac_secret
[EVP_MAX_MD_SIZE
];
1206 size_t write_mac_secret_size
;
1207 unsigned char write_mac_secret
[EVP_MAX_MD_SIZE
];
1208 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1209 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1210 /* flags for countermeasure against known-IV weakness */
1211 int need_empty_fragments
;
1212 int empty_fragment_done
;
1213 /* used during startup, digest all incoming/outgoing packets */
1214 BIO
*handshake_buffer
;
1216 * When handshake digest is determined, buffer is hashed and
1217 * freed and MD_CTX for the required digest is stored here.
1219 EVP_MD_CTX
*handshake_dgst
;
1221 * Set whenever an expected ChangeCipherSpec message is processed.
1222 * Unset when the peer's Finished message is received.
1223 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1225 int change_cipher_spec
;
1229 * we allow one fatal and one warning alert to be outstanding, send close
1230 * alert via the warning alert
1233 unsigned char send_alert
[2];
1235 * This flag is set when we should renegotiate ASAP, basically when there
1236 * is no more data in the read or write buffers
1239 int total_renegotiations
;
1240 int num_renegotiations
;
1241 int in_read_app_data
;
1243 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1244 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1245 size_t finish_md_len
;
1246 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1247 size_t peer_finish_md_len
;
1248 size_t message_size
;
1250 /* used to hold the new cipher we are going to use */
1251 const SSL_CIPHER
*new_cipher
;
1252 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1253 EVP_PKEY
*pkey
; /* holds short lived DH/ECDH key */
1255 /* used for certificate requests */
1258 char ctype
[SSL3_CT_NUMBER
];
1259 STACK_OF(X509_NAME
) *ca_names
;
1260 size_t key_block_length
;
1261 unsigned char *key_block
;
1262 const EVP_CIPHER
*new_sym_enc
;
1263 const EVP_MD
*new_hash
;
1264 int new_mac_pkey_type
;
1265 size_t new_mac_secret_size
;
1266 # ifndef OPENSSL_NO_COMP
1267 const SSL_COMP
*new_compression
;
1269 char *new_compression
;
1272 /* Raw values of the cipher list from a client */
1273 unsigned char *ciphers_raw
;
1274 size_t ciphers_rawlen
;
1275 /* Temporary storage for premaster secret */
1278 # ifndef OPENSSL_NO_PSK
1279 /* Temporary storage for PSK key */
1284 * signature algorithms peer reports: e.g. supported signature
1285 * algorithms extension for server or as part of a certificate
1286 * request for client.
1288 uint16_t *peer_sigalgs
;
1289 /* Size of above array */
1290 size_t peer_sigalgslen
;
1291 /* Sigalg peer actualy uses */
1292 const SIGALG_LOOKUP
*peer_sigalg
;
1293 /* Digest peer uses for signing */
1294 const EVP_MD
*peer_md
;
1295 /* Array of digests used for signing */
1296 const EVP_MD
*md
[SSL_PKEY_NUM
];
1298 * Set if corresponding CERT_PKEY can be used with current
1299 * SSL session: e.g. appropriate curve, signature algorithms etc.
1300 * If zero it can't be used at all.
1302 uint32_t valid_flags
[SSL_PKEY_NUM
];
1304 * For servers the following masks are for the key and auth algorithms
1305 * that are supported by the certs below. For clients they are masks of
1306 * *disabled* algorithms based on the current session.
1311 * The following are used by the client to see if a cipher is allowed or
1312 * not. It contains the minimum and maximum version the client's using
1313 * based on what it knows so far.
1319 /* Connection binding to prevent renegotiation attacks */
1320 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1321 size_t previous_client_finished_len
;
1322 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1323 size_t previous_server_finished_len
;
1324 int send_connection_binding
; /* TODOEKR */
1326 # ifndef OPENSSL_NO_NEXTPROTONEG
1328 * Set if we saw the Next Protocol Negotiation extension from our peer.
1334 * ALPN information (we are in the process of transitioning from NPN to
1339 * In a server these point to the selected ALPN protocol after the
1340 * ClientHello has been processed. In a client these contain the protocol
1341 * that the server selected once the ServerHello has been processed.
1343 unsigned char *alpn_selected
;
1344 size_t alpn_selected_len
;
1345 /* used by the server to know what options were proposed */
1346 unsigned char *alpn_proposed
;
1347 size_t alpn_proposed_len
;
1348 /* used by the client to know if it actually sent alpn */
1351 # ifndef OPENSSL_NO_EC
1353 * This is set to true if we believe that this is a version of Safari
1354 * running on OS X 10.6 or newer. We wish to know this because Safari on
1355 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1357 char is_probably_safari
;
1358 # endif /* !OPENSSL_NO_EC */
1360 /* For clients: peer temporary key */
1361 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1362 /* The group_id for the DH/ECDH key */
1363 unsigned int group_id
;
1369 /* DTLS structures */
1371 # ifndef OPENSSL_NO_SCTP
1372 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1375 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1376 # define DTLS1_MAX_MTU_OVERHEAD 48
1379 * Flag used in message reuse to indicate the buffer contains the record
1380 * header as well as the the handshake message header.
1382 # define DTLS1_SKIP_RECORD_HEADER 2
1384 struct dtls1_retransmit_state
{
1385 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1386 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1387 COMP_CTX
*compress
; /* compression */
1388 SSL_SESSION
*session
;
1389 unsigned short epoch
;
1392 struct hm_header_st
{
1398 unsigned int is_ccs
;
1399 struct dtls1_retransmit_state saved_retransmit_state
;
1402 struct dtls1_timeout_st
{
1403 /* Number of read timeouts so far */
1404 unsigned int read_timeouts
;
1405 /* Number of write timeouts so far */
1406 unsigned int write_timeouts
;
1407 /* Number of alerts received so far */
1408 unsigned int num_alerts
;
1411 typedef struct hm_fragment_st
{
1412 struct hm_header_st msg_header
;
1413 unsigned char *fragment
;
1414 unsigned char *reassembly
;
1417 typedef struct pqueue_st pqueue
;
1418 typedef struct pitem_st pitem
;
1421 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1426 typedef struct pitem_st
*piterator
;
1428 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1429 void pitem_free(pitem
*item
);
1430 pqueue
*pqueue_new(void);
1431 void pqueue_free(pqueue
*pq
);
1432 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1433 pitem
*pqueue_peek(pqueue
*pq
);
1434 pitem
*pqueue_pop(pqueue
*pq
);
1435 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1436 pitem
*pqueue_iterator(pqueue
*pq
);
1437 pitem
*pqueue_next(piterator
*iter
);
1438 size_t pqueue_size(pqueue
*pq
);
1440 typedef struct dtls1_state_st
{
1441 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1443 unsigned int cookie_verified
;
1444 /* handshake message numbers */
1445 unsigned short handshake_write_seq
;
1446 unsigned short next_handshake_write_seq
;
1447 unsigned short handshake_read_seq
;
1448 /* Buffered handshake messages */
1449 pqueue
*buffered_messages
;
1450 /* Buffered (sent) handshake records */
1451 pqueue
*sent_messages
;
1452 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1453 size_t mtu
; /* max DTLS packet size */
1454 struct hm_header_st w_msg_hdr
;
1455 struct hm_header_st r_msg_hdr
;
1456 struct dtls1_timeout_st timeout
;
1458 * Indicates when the last handshake msg sent will timeout
1460 struct timeval next_timeout
;
1461 /* Timeout duration */
1462 unsigned short timeout_duration
;
1463 unsigned int retransmitting
;
1464 # ifndef OPENSSL_NO_SCTP
1465 int shutdown_received
;
1469 # ifndef OPENSSL_NO_EC
1471 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1473 # define EXPLICIT_PRIME_CURVE_TYPE 1
1474 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1475 # define NAMED_CURVE_TYPE 3
1476 # endif /* OPENSSL_NO_EC */
1478 typedef struct cert_pkey_st
{
1480 EVP_PKEY
*privatekey
;
1481 /* Chain for this certificate */
1482 STACK_OF(X509
) *chain
;
1484 * serverinfo data for this certificate. The data is in TLS Extension
1485 * wire format, specifically it's a series of records like:
1486 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1488 * uint8_t data[length];
1490 unsigned char *serverinfo
;
1491 size_t serverinfo_length
;
1493 /* Retrieve Suite B flags */
1494 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1495 /* Uses to check strict mode: suite B modes are always strict */
1496 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1497 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1500 unsigned short ext_type
;
1502 * Per-connection flags relating to this extension type: not used if
1503 * part of an SSL_CTX structure.
1506 custom_ext_add_cb add_cb
;
1507 custom_ext_free_cb free_cb
;
1509 custom_ext_parse_cb parse_cb
;
1511 } custom_ext_method
;
1513 /* ext_flags values */
1516 * Indicates an extension has been received. Used to check for unsolicited or
1517 * duplicate extensions.
1519 # define SSL_EXT_FLAG_RECEIVED 0x1
1521 * Indicates an extension has been sent: used to enable sending of
1522 * corresponding ServerHello extension.
1524 # define SSL_EXT_FLAG_SENT 0x2
1527 custom_ext_method
*meths
;
1529 } custom_ext_methods
;
1531 typedef struct cert_st
{
1532 /* Current active set */
1534 * ALWAYS points to an element of the pkeys array
1535 * Probably it would make more sense to store
1536 * an index, not a pointer.
1539 # ifndef OPENSSL_NO_DH
1541 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
1544 /* Flags related to certificates */
1545 uint32_t cert_flags
;
1546 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
1548 * Certificate types (received or sent) in certificate request message.
1549 * On receive this is only set if number of certificate types exceeds
1552 unsigned char *ctypes
;
1555 * supported signature algorithms. When set on a client this is sent in
1556 * the client hello as the supported signature algorithms extension. For
1557 * servers it represents the signature algorithms we are willing to use.
1559 uint16_t *conf_sigalgs
;
1560 /* Size of above array */
1561 size_t conf_sigalgslen
;
1563 * Client authentication signature algorithms, if not set then uses
1564 * conf_sigalgs. On servers these will be the signature algorithms sent
1565 * to the client in a certificate request for TLS 1.2. On a client this
1566 * represents the signature algorithms we are willing to use for client
1569 uint16_t *client_sigalgs
;
1570 /* Size of above array */
1571 size_t client_sigalgslen
;
1573 * Signature algorithms shared by client and server: cached because these
1574 * are used most often.
1576 const SIGALG_LOOKUP
**shared_sigalgs
;
1577 size_t shared_sigalgslen
;
1579 * Certificate setup callback: if set is called whenever a certificate
1580 * may be required (client or server). the callback can then examine any
1581 * appropriate parameters and setup any certificates required. This
1582 * allows advanced applications to select certificates on the fly: for
1583 * example based on supported signature algorithms or curves.
1585 int (*cert_cb
) (SSL
*ssl
, void *arg
);
1588 * Optional X509_STORE for chain building or certificate validation If
1589 * NULL the parent SSL_CTX store is used instead.
1591 X509_STORE
*chain_store
;
1592 X509_STORE
*verify_store
;
1593 /* Custom extension methods for server and client */
1594 custom_ext_methods cli_ext
;
1595 custom_ext_methods srv_ext
;
1596 /* Security callback */
1597 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1598 void *other
, void *ex
);
1599 /* Security level */
1602 # ifndef OPENSSL_NO_PSK
1603 /* If not NULL psk identity hint to use for servers */
1604 char *psk_identity_hint
;
1606 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
1607 CRYPTO_RWLOCK
*lock
;
1610 # define FP_ICC (int (*)(const void *,const void *))
1613 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1614 * of a mess of functions, but hell, think of it as an opaque structure :-)
1616 typedef struct ssl3_enc_method
{
1617 int (*enc
) (SSL
*, SSL3_RECORD
*, size_t, int);
1618 int (*mac
) (SSL
*, SSL3_RECORD
*, unsigned char *, int);
1619 int (*setup_key_block
) (SSL
*);
1620 int (*generate_master_secret
) (SSL
*, unsigned char *, unsigned char *,
1622 int (*change_cipher_state
) (SSL
*, int);
1623 size_t (*final_finish_mac
) (SSL
*, const char *, size_t, unsigned char *);
1624 const char *client_finished_label
;
1625 size_t client_finished_label_len
;
1626 const char *server_finished_label
;
1627 size_t server_finished_label_len
;
1628 int (*alert_value
) (int);
1629 int (*export_keying_material
) (SSL
*, unsigned char *, size_t,
1630 const char *, size_t,
1631 const unsigned char *, size_t,
1633 /* Various flags indicating protocol version requirements */
1635 /* Set the handshake header */
1636 int (*set_handshake_header
) (SSL
*s
, WPACKET
*pkt
, int type
);
1637 /* Close construction of the handshake message */
1638 int (*close_construct_packet
) (SSL
*s
, WPACKET
*pkt
, int htype
);
1639 /* Write out handshake message */
1640 int (*do_write
) (SSL
*s
);
1643 # define ssl_set_handshake_header(s, pkt, htype) \
1644 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1645 # define ssl_close_construct_packet(s, pkt, htype) \
1646 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1647 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1649 /* Values for enc_flags */
1651 /* Uses explicit IV for CBC mode */
1652 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1653 /* Uses signature algorithms extension */
1654 # define SSL_ENC_FLAG_SIGALGS 0x2
1655 /* Uses SHA256 default PRF */
1656 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1658 # define SSL_ENC_FLAG_DTLS 0x8
1660 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1661 * apply to others in future.
1663 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1665 # ifndef OPENSSL_NO_COMP
1666 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1667 typedef struct ssl3_comp_st
{
1668 int comp_id
; /* The identifier byte for this compression
1670 char *name
; /* Text name used for the compression type */
1671 COMP_METHOD
*method
; /* The method :-) */
1675 typedef struct raw_extension_st
{
1676 /* Raw packet data for the extension */
1678 /* Set to 1 if the extension is present or 0 otherwise */
1680 /* Set to 1 if we have already parsed the extension or 0 otherwise */
1682 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
1687 * Extension index values NOTE: Any updates to these defines should be mirrored
1688 * with equivalent updates to ext_defs in extensions.c
1690 typedef enum tlsext_index_en
{
1691 TLSEXT_IDX_renegotiate
,
1692 TLSEXT_IDX_server_name
,
1694 TLSEXT_IDX_ec_point_formats
,
1695 TLSEXT_IDX_supported_groups
,
1696 TLSEXT_IDX_session_ticket
,
1697 TLSEXT_IDX_signature_algorithms
,
1698 TLSEXT_IDX_status_request
,
1699 TLSEXT_IDX_next_proto_neg
,
1700 TLSEXT_IDX_application_layer_protocol_negotiation
,
1701 TLSEXT_IDX_use_srtp
,
1702 TLSEXT_IDX_encrypt_then_mac
,
1703 TLSEXT_IDX_signed_certificate_timestamp
,
1704 TLSEXT_IDX_extended_master_secret
,
1705 TLSEXT_IDX_supported_versions
,
1706 TLSEXT_IDX_psk_kex_modes
,
1707 TLSEXT_IDX_key_share
,
1708 TLSEXT_IDX_cryptopro_bug
,
1714 * Dummy status type for the status_type extension. Indicates no status type
1717 #define TLSEXT_STATUSTYPE_nothing -1
1719 /* Sigalgs values */
1720 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1721 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1722 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1723 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1724 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1725 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1726 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1727 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1728 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1729 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1730 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1731 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1732 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1733 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1734 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1735 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1736 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1737 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1739 /* Known PSK key exchange modes */
1740 #define TLSEXT_KEX_MODE_KE 0x00
1741 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1744 * Internal representations of key exchange modes
1746 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1747 #define TLSEXT_KEX_MODE_FLAG_KE 1
1748 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1750 /* An invalid index into the TLSv1.3 PSK identities */
1751 #define TLSEXT_PSK_BAD_IDENTITY -1
1753 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1754 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1756 /* A dummy signature value not valid for TLSv1.2 signature algs */
1757 #define TLSEXT_signature_rsa_pss 0x0101
1760 #define MAX_COMPRESSIONS_SIZE 255
1764 unsigned int legacy_version
;
1765 unsigned char random
[SSL3_RANDOM_SIZE
];
1766 size_t session_id_len
;
1767 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
1768 size_t dtls_cookie_len
;
1769 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
1770 PACKET ciphersuites
;
1771 size_t compressions_len
;
1772 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
1774 RAW_EXTENSION
*pre_proc_exts
;
1777 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
1779 __owur
const SSL_METHOD
*ssl_bad_method(int ver
);
1780 __owur
const SSL_METHOD
*sslv3_method(void);
1781 __owur
const SSL_METHOD
*sslv3_server_method(void);
1782 __owur
const SSL_METHOD
*sslv3_client_method(void);
1783 __owur
const SSL_METHOD
*tlsv1_method(void);
1784 __owur
const SSL_METHOD
*tlsv1_server_method(void);
1785 __owur
const SSL_METHOD
*tlsv1_client_method(void);
1786 __owur
const SSL_METHOD
*tlsv1_1_method(void);
1787 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
1788 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
1789 __owur
const SSL_METHOD
*tlsv1_2_method(void);
1790 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
1791 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
1792 __owur
const SSL_METHOD
*tlsv1_3_method(void);
1793 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
1794 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
1795 __owur
const SSL_METHOD
*dtlsv1_method(void);
1796 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
1797 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
1798 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
1799 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
1800 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
1801 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
1803 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
1804 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
1805 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
1806 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
1807 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
1808 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
1809 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
1812 * Flags for SSL methods
1814 # define SSL_METHOD_NO_FIPS (1U<<0)
1815 # define SSL_METHOD_NO_SUITEB (1U<<1)
1817 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1818 s_connect, enc_data) \
1819 const SSL_METHOD *func_name(void) \
1821 static const SSL_METHOD func_name##_data= { \
1835 ssl3_renegotiate_check, \
1838 ssl3_dispatch_alert, \
1841 ssl3_get_cipher_by_char, \
1842 ssl3_put_cipher_by_char, \
1846 tls1_default_timeout, \
1848 ssl_undefined_void_function, \
1849 ssl3_callback_ctrl, \
1850 ssl3_ctx_callback_ctrl, \
1852 return &func_name##_data; \
1855 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1856 const SSL_METHOD *func_name(void) \
1858 static const SSL_METHOD func_name##_data= { \
1860 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1872 ssl3_renegotiate_check, \
1875 ssl3_dispatch_alert, \
1878 ssl3_get_cipher_by_char, \
1879 ssl3_put_cipher_by_char, \
1883 ssl3_default_timeout, \
1885 ssl_undefined_void_function, \
1886 ssl3_callback_ctrl, \
1887 ssl3_ctx_callback_ctrl, \
1889 return &func_name##_data; \
1892 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1893 s_connect, enc_data) \
1894 const SSL_METHOD *func_name(void) \
1896 static const SSL_METHOD func_name##_data= { \
1910 ssl3_renegotiate_check, \
1912 dtls1_write_app_data_bytes, \
1913 dtls1_dispatch_alert, \
1916 ssl3_get_cipher_by_char, \
1917 ssl3_put_cipher_by_char, \
1921 dtls1_default_timeout, \
1923 ssl_undefined_void_function, \
1924 ssl3_callback_ctrl, \
1925 ssl3_ctx_callback_ctrl, \
1927 return &func_name##_data; \
1930 struct openssl_ssl_test_functions
{
1931 int (*p_ssl_init_wbio_buffer
) (SSL
*s
);
1932 int (*p_ssl3_setup_buffers
) (SSL
*s
);
1935 const char *ssl_protocol_to_string(int version
);
1937 # ifndef OPENSSL_UNIT_TEST
1939 void ssl_clear_cipher_ctx(SSL
*s
);
1940 int ssl_clear_bad_session(SSL
*s
);
1941 __owur CERT
*ssl_cert_new(void);
1942 __owur CERT
*ssl_cert_dup(CERT
*cert
);
1943 void ssl_cert_clear_certs(CERT
*c
);
1944 void ssl_cert_free(CERT
*c
);
1945 __owur
int ssl_get_new_session(SSL
*s
, int session
);
1946 __owur
int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
, int *al
);
1947 __owur SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
);
1948 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
1949 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
1950 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
1951 const SSL_CIPHER
*const *bp
);
1952 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
1953 STACK_OF(SSL_CIPHER
) **pref
,
1954 STACK_OF(SSL_CIPHER
)
1956 const char *rule_str
,
1958 void ssl_update_cache(SSL
*s
, int mode
);
1959 __owur
int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
1960 const EVP_MD
**md
, int *mac_pkey_type
,
1961 size_t *mac_secret_size
, SSL_COMP
**comp
,
1963 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
1964 size_t *int_overhead
, size_t *blocksize
,
1965 size_t *ext_overhead
);
1966 __owur
int ssl_cipher_get_cert_index(const SSL_CIPHER
*c
);
1967 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
,
1968 const unsigned char *ptr
);
1969 __owur
int ssl_cert_set0_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
1970 __owur
int ssl_cert_set1_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
1971 __owur
int ssl_cert_add0_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
1972 __owur
int ssl_cert_add1_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
1973 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
1974 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
1975 __owur X509
*ssl_cert_get0_next_certificate(CERT
*c
, int first
);
1976 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
1978 __owur
int ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
);
1979 __owur
int ssl_build_cert_chain(SSL
*s
, SSL_CTX
*ctx
, int flags
);
1980 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
1983 __owur
int ssl_security(const SSL
*s
, int op
, int bits
, int nid
, void *other
);
1984 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1987 int ssl_undefined_function(SSL
*s
);
1988 __owur
int ssl_undefined_void_function(void);
1989 __owur
int ssl_undefined_const_function(const SSL
*s
);
1990 __owur CERT_PKEY
*ssl_get_server_send_pkey(SSL
*s
);
1991 __owur
int ssl_get_server_cert_serverinfo(SSL
*s
,
1992 const unsigned char **serverinfo
,
1993 size_t *serverinfo_length
);
1994 __owur EVP_PKEY
*ssl_get_sign_pkey(SSL
*s
, const SSL_CIPHER
*c
,
1995 const EVP_MD
**pmd
);
1996 __owur
int ssl_cert_type(const X509
*x
, const EVP_PKEY
*pkey
);
1997 void ssl_set_masks(SSL
*s
);
1998 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
1999 __owur
int ssl_verify_alarm_type(long type
);
2000 void ssl_sort_cipher_list(void);
2001 void ssl_load_ciphers(void);
2002 __owur
int ssl_fill_hello_random(SSL
*s
, int server
, unsigned char *field
,
2004 __owur
int ssl_generate_master_secret(SSL
*s
, unsigned char *pms
, size_t pmslen
,
2006 __owur EVP_PKEY
*ssl_generate_pkey(EVP_PKEY
*pm
);
2007 __owur
int ssl_derive(SSL
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
2009 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
2011 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_id(uint32_t id
);
2012 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
2013 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
2015 int ssl3_init_finished_mac(SSL
*s
);
2016 __owur
int ssl3_setup_key_block(SSL
*s
);
2017 __owur
int ssl3_change_cipher_state(SSL
*s
, int which
);
2018 void ssl3_cleanup_key_block(SSL
*s
);
2019 __owur
int ssl3_do_write(SSL
*s
, int type
);
2020 int ssl3_send_alert(SSL
*s
, int level
, int desc
);
2021 __owur
int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
2022 unsigned char *p
, size_t len
,
2023 size_t *secret_size
);
2024 __owur
int ssl3_get_req_cert_type(SSL
*s
, WPACKET
*pkt
);
2025 __owur
int ssl3_num_ciphers(void);
2026 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2027 int ssl3_renegotiate(SSL
*ssl
);
2028 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2029 __owur
int ssl3_dispatch_alert(SSL
*s
);
2030 __owur
size_t ssl3_final_finish_mac(SSL
*s
, const char *sender
, size_t slen
,
2032 __owur
int ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, size_t len
);
2033 void ssl3_free_digest_list(SSL
*s
);
2034 __owur
unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
,
2035 CERT_PKEY
*cpk
, int *al
);
2036 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,
2037 STACK_OF(SSL_CIPHER
) *clnt
,
2038 STACK_OF(SSL_CIPHER
) *srvr
);
2039 __owur
int ssl3_digest_cached_records(SSL
*s
, int keep
);
2040 __owur
int ssl3_new(SSL
*s
);
2041 void ssl3_free(SSL
*s
);
2042 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2043 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2044 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2045 __owur
int ssl3_shutdown(SSL
*s
);
2046 void ssl3_clear(SSL
*s
);
2047 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2048 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2049 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2050 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2052 __owur
int ssl3_do_change_cipher_spec(SSL
*ssl
);
2053 __owur
long ssl3_default_timeout(void);
2055 __owur
int ssl3_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2056 __owur
int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2057 __owur
int tls_setup_handshake(SSL
*s
);
2058 __owur
int dtls1_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2059 __owur
int dtls1_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2060 __owur
int ssl3_handshake_write(SSL
*s
);
2062 __owur
int ssl_allow_compression(SSL
*s
);
2064 __owur
int ssl_version_supported(const SSL
*s
, int version
);
2066 __owur
int ssl_set_client_hello_version(SSL
*s
);
2067 __owur
int ssl_check_version_downgrade(SSL
*s
);
2068 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2069 __owur
int ssl_choose_server_version(SSL
*s
, CLIENTHELLO_MSG
*hello
);
2070 __owur
int ssl_choose_client_version(SSL
*s
, int version
);
2071 int ssl_get_client_min_max_version(const SSL
*s
, int *min_version
,
2074 __owur
long tls1_default_timeout(void);
2075 __owur
int dtls1_do_write(SSL
*s
, int type
);
2076 void dtls1_set_message_header(SSL
*s
,
2079 size_t frag_off
, size_t frag_len
);
2081 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf_
, size_t len
,
2084 __owur
int dtls1_read_failed(SSL
*s
, int code
);
2085 __owur
int dtls1_buffer_message(SSL
*s
, int ccs
);
2086 __owur
int dtls1_retransmit_message(SSL
*s
, unsigned short seq
, int *found
);
2087 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2088 int dtls1_retransmit_buffered_messages(SSL
*s
);
2089 void dtls1_clear_received_buffer(SSL
*s
);
2090 void dtls1_clear_sent_buffer(SSL
*s
);
2091 void dtls1_get_message_header(unsigned char *data
,
2092 struct hm_header_st
*msg_hdr
);
2093 __owur
long dtls1_default_timeout(void);
2094 __owur
struct timeval
*dtls1_get_timeout(SSL
*s
, struct timeval
*timeleft
);
2095 __owur
int dtls1_check_timeout_num(SSL
*s
);
2096 __owur
int dtls1_handle_timeout(SSL
*s
);
2097 void dtls1_start_timer(SSL
*s
);
2098 void dtls1_stop_timer(SSL
*s
);
2099 __owur
int dtls1_is_timer_expired(SSL
*s
);
2100 void dtls1_double_timeout(SSL
*s
);
2101 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2103 __owur
int dtls1_send_newsession_ticket(SSL
*s
);
2104 __owur
size_t dtls1_min_mtu(SSL
*s
);
2105 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2106 __owur
int dtls1_query_mtu(SSL
*s
);
2108 __owur
int tls1_new(SSL
*s
);
2109 void tls1_free(SSL
*s
);
2110 void tls1_clear(SSL
*s
);
2111 long tls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2112 long tls1_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2114 __owur
int dtls1_new(SSL
*s
);
2115 void dtls1_free(SSL
*s
);
2116 void dtls1_clear(SSL
*s
);
2117 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2118 __owur
int dtls1_shutdown(SSL
*s
);
2120 __owur
int dtls1_dispatch_alert(SSL
*s
);
2122 __owur
int ssl_init_wbio_buffer(SSL
*s
);
2123 void ssl_free_wbio_buffer(SSL
*s
);
2125 __owur
int tls1_change_cipher_state(SSL
*s
, int which
);
2126 __owur
int tls1_setup_key_block(SSL
*s
);
2127 __owur
size_t tls1_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2129 __owur
int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
2130 unsigned char *p
, size_t len
,
2131 size_t *secret_size
);
2132 __owur
int tls13_setup_key_block(SSL
*s
);
2133 __owur
size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2135 __owur
int tls13_change_cipher_state(SSL
*s
, int which
);
2136 __owur
int tls13_hkdf_expand(SSL
*s
, const EVP_MD
*md
,
2137 const unsigned char *secret
,
2138 const unsigned char *label
, size_t labellen
,
2139 const unsigned char *hash
,
2140 unsigned char *out
, size_t outlen
);
2141 __owur
int tls13_derive_key(SSL
*s
, const unsigned char *secret
,
2142 unsigned char *key
, size_t keylen
);
2143 __owur
int tls13_derive_iv(SSL
*s
, const unsigned char *secret
,
2144 unsigned char *iv
, size_t ivlen
);
2145 __owur
int tls13_derive_finishedkey(SSL
*s
, const EVP_MD
*md
,
2146 const unsigned char *secret
,
2147 unsigned char *fin
, size_t finlen
);
2148 int tls13_generate_secret(SSL
*s
, const EVP_MD
*md
,
2149 const unsigned char *prevsecret
,
2150 const unsigned char *insecret
,
2152 unsigned char *outsecret
);
2153 __owur
int tls13_generate_handshake_secret(SSL
*s
,
2154 const unsigned char *insecret
,
2155 size_t insecretlen
);
2156 __owur
int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
2157 unsigned char *prev
, size_t prevlen
,
2158 size_t *secret_size
);
2159 __owur
int tls1_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2160 const char *label
, size_t llen
,
2161 const unsigned char *p
, size_t plen
,
2163 __owur
int tls1_alert_code(int code
);
2164 __owur
int tls13_alert_code(int code
);
2165 __owur
int ssl3_alert_code(int code
);
2166 __owur
int ssl_ok(SSL
*s
);
2168 # ifndef OPENSSL_NO_EC
2169 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
);
2172 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2174 # ifndef OPENSSL_NO_EC
2175 /* Flags values from tls1_ec_curve_id2nid() */
2176 /* Mask for curve type */
2177 # define TLS_CURVE_TYPE 0x3
2178 # define TLS_CURVE_PRIME 0x0
2179 # define TLS_CURVE_CHAR2 0x1
2180 # define TLS_CURVE_CUSTOM 0x2
2181 __owur
int tls1_ec_curve_id2nid(int curve_id
, unsigned int *pflags
);
2182 __owur
int tls1_ec_nid2curve_id(int nid
);
2183 __owur
int tls1_check_curve(SSL
*s
, const unsigned char *p
, size_t len
);
2184 __owur
int tls1_shared_group(SSL
*s
, int nmatch
);
2185 __owur
int tls1_set_groups(unsigned char **pext
, size_t *pextlen
,
2186 int *curves
, size_t ncurves
);
2187 __owur
int tls1_set_groups_list(unsigned char **pext
, size_t *pextlen
,
2189 void tls1_get_formatlist(SSL
*s
, const unsigned char **pformats
,
2190 size_t *num_formats
);
2191 __owur
int tls1_check_ec_tmp_key(SSL
*s
, unsigned long id
);
2192 __owur EVP_PKEY
*ssl_generate_pkey_curve(int id
);
2193 # endif /* OPENSSL_NO_EC */
2195 __owur
int tls1_shared_list(SSL
*s
,
2196 const unsigned char *l1
, size_t l1len
,
2197 const unsigned char *l2
, size_t l2len
, int nmatch
);
2198 __owur
int tls_curve_allowed(SSL
*s
, const unsigned char *curve
, int op
);
2199 __owur
int tls1_get_curvelist(SSL
*s
, int sess
, const unsigned char **pcurves
,
2200 size_t *num_curves
);
2202 void ssl_set_default_md(SSL
*s
);
2203 __owur
int tls1_set_server_sigalgs(SSL
*s
);
2205 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2206 typedef enum ticket_en
{
2207 /* fatal error, malloc failure */
2208 TICKET_FATAL_ERR_MALLOC
,
2209 /* fatal error, either from parsing or decrypting the ticket */
2210 TICKET_FATAL_ERR_OTHER
,
2211 /* No ticket present */
2213 /* Empty ticket present */
2215 /* the ticket couldn't be decrypted */
2217 /* a ticket was successfully decrypted */
2219 /* same as above but the ticket needs to be reneewed */
2220 TICKET_SUCCESS_RENEW
2223 __owur TICKET_RETURN
tls_get_ticket_from_client(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2225 __owur TICKET_RETURN
tls_decrypt_ticket(SSL
*s
, const unsigned char *etick
,
2227 const unsigned char *sess_id
,
2228 size_t sesslen
, SSL_SESSION
**psess
);
2230 __owur
int tls_use_ticket(SSL
*s
);
2232 __owur
int tls12_get_sigandhash(SSL
*s
, WPACKET
*pkt
, const EVP_PKEY
*pk
,
2233 const EVP_MD
*md
, int *ispss
);
2234 __owur
const EVP_MD
*tls12_get_hash(int hash_nid
);
2235 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL
*s
, int op
);
2237 __owur
int tls1_set_sigalgs_list(CERT
*c
, const char *str
, int client
);
2238 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2240 int tls1_check_chain(SSL
*s
, X509
*x
, EVP_PKEY
*pk
, STACK_OF(X509
) *chain
,
2242 void tls1_set_cert_validity(SSL
*s
);
2244 # ifndef OPENSSL_NO_CT
2245 __owur
int ssl_validate_ct(SSL
*s
);
2248 # ifndef OPENSSL_NO_DH
2249 __owur DH
*ssl_get_auto_dh(SSL
*s
);
2252 __owur
int ssl_security_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
, int is_ee
);
2253 __owur
int ssl_security_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
, X509
*ex
,
2256 __owur EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
);
2257 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
);
2258 __owur
long ssl_get_algorithm2(SSL
*s
);
2259 __owur
int tls12_copy_sigalgs(SSL
*s
, WPACKET
*pkt
,
2260 const uint16_t *psig
, size_t psiglen
);
2261 __owur
int tls1_save_sigalgs(SSL
*s
, PACKET
*pkt
);
2262 __owur
int tls1_process_sigalgs(SSL
*s
);
2263 __owur
size_t tls12_get_psigalgs(SSL
*s
, int sent
, const uint16_t **psigs
);
2264 __owur
int tls12_check_peer_sigalg(SSL
*s
, uint16_t, EVP_PKEY
*pkey
);
2265 void ssl_set_client_disabled(SSL
*s
);
2266 __owur
int ssl_cipher_disabled(SSL
*s
, const SSL_CIPHER
*c
, int op
);
2268 __owur
int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
2270 __owur
const EVP_MD
*ssl_md(int idx
);
2271 __owur
const EVP_MD
*ssl_handshake_md(SSL
*s
);
2272 __owur
const EVP_MD
*ssl_prf_md(SSL
*s
);
2275 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2276 * with |ssl|, if logging is enabled. It returns one on success and zero on
2277 * failure. The entry is identified by the first 8 bytes of
2278 * |encrypted_premaster|.
2280 __owur
int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
2281 const uint8_t *encrypted_premaster
,
2282 size_t encrypted_premaster_len
,
2283 const uint8_t *premaster
,
2284 size_t premaster_len
);
2286 /* ssl_log_master_secret logs |master| to the SSL_CTX associated with |ssl|, if
2287 * logging is enabled. It returns one on success and zero on failure. The entry
2288 * is identified by |client_random|.
2290 __owur
int ssl_log_master_secret(SSL
*ssl
, const uint8_t *client_random
,
2291 size_t client_random_len
,
2292 const uint8_t *master
, size_t master_len
);
2295 __owur
char ssl3_cbc_record_digest_supported(const EVP_MD_CTX
*ctx
);
2296 __owur
int ssl3_cbc_digest_record(const EVP_MD_CTX
*ctx
,
2297 unsigned char *md_out
,
2298 size_t *md_out_size
,
2299 const unsigned char header
[13],
2300 const unsigned char *data
,
2301 size_t data_plus_mac_size
,
2302 size_t data_plus_mac_plus_padding_size
,
2303 const unsigned char *mac_secret
,
2304 size_t mac_secret_length
, char is_sslv3
);
2306 __owur
int tls_fips_digest_extra(const EVP_CIPHER_CTX
*cipher_ctx
,
2307 EVP_MD_CTX
*mac_ctx
, const unsigned char *data
,
2308 size_t data_len
, size_t orig_len
);
2310 __owur
int srp_generate_server_master_secret(SSL
*s
);
2311 __owur
int srp_generate_client_master_secret(SSL
*s
);
2312 __owur
int srp_verify_server_param(SSL
*s
, int *al
);
2316 void custom_ext_init(custom_ext_methods
*meths
);
2318 __owur
int custom_ext_parse(SSL
*s
, int server
,
2319 unsigned int ext_type
,
2320 const unsigned char *ext_data
, size_t ext_size
,
2322 __owur
int custom_ext_add(SSL
*s
, int server
, WPACKET
*pkt
, int *al
);
2324 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2325 const custom_ext_methods
*src
);
2326 void custom_exts_free(custom_ext_methods
*exts
);
2328 void ssl_comp_free_compression_methods_int(void);
2332 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2333 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers