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 /* Check if an SSL structure is using DTLS */
352 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
354 /* Check if we are using TLSv1.3 */
355 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
356 && (s)->method->version >= TLS1_3_VERSION \
357 && (s)->method->version != TLS_ANY_VERSION)
359 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
361 /* See if we need explicit IV */
362 # define SSL_USE_EXPLICIT_IV(s) \
363 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
365 * See if we use signature algorithms extension and signature algorithm
368 # define SSL_USE_SIGALGS(s) \
369 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
371 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
372 * apply to others in future.
374 # define SSL_USE_TLS1_2_CIPHERS(s) \
375 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
377 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
378 * flags because it may not be set to correct version yet.
380 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
381 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
382 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
384 * Determine if a client should send signature algorithms extension:
385 * as with TLS1.2 cipher we can't rely on method flags.
387 # define SSL_CLIENT_USE_SIGALGS(s) \
388 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
390 # define SSL_USE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC)
392 /* Mostly for SSLv3 */
393 # define SSL_PKEY_RSA_ENC 0
394 # define SSL_PKEY_RSA_SIGN 1
395 # define SSL_PKEY_DSA_SIGN 2
396 # define SSL_PKEY_ECC 3
397 # define SSL_PKEY_GOST01 4
398 # define SSL_PKEY_GOST12_256 5
399 # define SSL_PKEY_GOST12_512 6
400 # define SSL_PKEY_NUM 7
402 * Pseudo-constant. GOST cipher suites can use different certs for 1
403 * SSL_CIPHER. So let's see which one we have in fact.
405 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
408 * SSL_kRSA <- RSA_ENC
409 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
410 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
411 * SSL_aRSA <- RSA_ENC | RSA_SIGN
412 * SSL_aDSS <- DSA_SIGN
416 #define CERT_INVALID 0
417 #define CERT_PUBLIC_KEY 1
418 #define CERT_PRIVATE_KEY 2
421 /* CipherSuite length. SSLv3 and all TLS versions. */
422 # define TLS_CIPHER_LEN 2
423 /* used to hold info on the particular ciphers used */
424 struct ssl_cipher_st
{
426 const char *name
; /* text name */
427 uint32_t id
; /* id, 4 bytes, first is version */
429 * changed in 1.0.0: these four used to be portions of a single value
432 uint32_t algorithm_mkey
; /* key exchange algorithm */
433 uint32_t algorithm_auth
; /* server authentication */
434 uint32_t algorithm_enc
; /* symmetric encryption */
435 uint32_t algorithm_mac
; /* symmetric authentication */
436 int min_tls
; /* minimum SSL/TLS protocol version */
437 int max_tls
; /* maximum SSL/TLS protocol version */
438 int min_dtls
; /* minimum DTLS protocol version */
439 int max_dtls
; /* maximum DTLS protocol version */
440 uint32_t algo_strength
; /* strength and export flags */
441 uint32_t algorithm2
; /* Extra flags */
442 int32_t strength_bits
; /* Number of bits really used */
443 uint32_t alg_bits
; /* Number of bits for algorithm */
446 /* Used to hold SSL/TLS functions */
447 struct ssl_method_st
{
451 int (*ssl_new
) (SSL
*s
);
452 void (*ssl_clear
) (SSL
*s
);
453 void (*ssl_free
) (SSL
*s
);
454 int (*ssl_accept
) (SSL
*s
);
455 int (*ssl_connect
) (SSL
*s
);
456 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
457 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
458 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
459 int (*ssl_shutdown
) (SSL
*s
);
460 int (*ssl_renegotiate
) (SSL
*s
);
461 int (*ssl_renegotiate_check
) (SSL
*s
, int);
462 int (*ssl_read_bytes
) (SSL
*s
, int type
, int *recvd_type
,
463 unsigned char *buf
, size_t len
, int peek
,
465 int (*ssl_write_bytes
) (SSL
*s
, int type
, const void *buf_
, size_t len
,
467 int (*ssl_dispatch_alert
) (SSL
*s
);
468 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
469 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
470 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
471 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
473 size_t (*ssl_pending
) (const SSL
*s
);
474 int (*num_ciphers
) (void);
475 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
476 long (*get_timeout
) (void);
477 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
478 int (*ssl_version
) (void);
479 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
480 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
484 * Lets make this into an ASN.1 type structure as follows
485 * SSL_SESSION_ID ::= SEQUENCE {
486 * version INTEGER, -- structure version number
487 * SSLversion INTEGER, -- SSL version number
488 * Cipher OCTET STRING, -- the 3 byte cipher ID
489 * Session_ID OCTET STRING, -- the Session ID
490 * Master_key OCTET STRING, -- the master key
491 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
492 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
493 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
494 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
495 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
496 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
497 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
498 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
499 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
500 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
501 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
502 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
503 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
504 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
506 * Look in ssl/ssl_asn1.c for more details
507 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
509 struct ssl_session_st
{
510 int ssl_version
; /* what ssl version session info is being kept
512 size_t master_key_length
;
513 unsigned char master_key
[SSL_MAX_MASTER_KEY_LENGTH
];
514 /* session_id - valid? */
515 size_t session_id_length
;
516 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
518 * this is used to determine whether the session is being reused in the
519 * appropriate context. It is up to the application to set this, via
522 size_t sid_ctx_length
;
523 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
524 # ifndef OPENSSL_NO_PSK
525 char *psk_identity_hint
;
529 * Used to indicate that session resumption is not allowed. Applications
530 * can also set this bit for a new session via not_resumable_session_cb
531 * to disable session caching and tickets.
534 /* This is the cert and type for the other end. */
537 /* Certificate chain peer sent */
538 STACK_OF(X509
) *peer_chain
;
540 * when app_verify_callback accepts a session where the peer's
541 * certificate is not ok, we must remember the error for session reuse:
543 long verify_result
; /* only for servers */
544 CRYPTO_REF_COUNT references
;
547 unsigned int compress_meth
; /* Need to lookup the method */
548 const SSL_CIPHER
*cipher
;
549 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
550 * load the 'cipher' structure */
551 STACK_OF(SSL_CIPHER
) *ciphers
; /* shared ciphers? */
552 CRYPTO_EX_DATA ex_data
; /* application specific data */
554 * These are used to make removal of session-ids more efficient and to
555 * implement a maximum cache size.
557 struct ssl_session_st
*prev
, *next
;
561 # ifndef OPENSSL_NO_EC
562 size_t ecpointformats_len
;
563 unsigned char *ecpointformats
; /* peer's list */
564 size_t supportedgroups_len
;
565 unsigned char *supportedgroups
; /* peer's list */
566 # endif /* OPENSSL_NO_EC */
568 unsigned char *tick
; /* Session ticket */
569 size_t ticklen
; /* Session ticket length */
570 /* Session lifetime hint in seconds */
571 unsigned long tick_lifetime_hint
;
573 # ifndef OPENSSL_NO_SRP
580 /* Extended master secret support */
581 # define SSL_SESS_FLAG_EXTMS 0x1
583 # ifndef OPENSSL_NO_SRP
585 typedef struct srp_ctx_st
{
586 /* param for all the callbacks */
588 /* set client Hello login callback */
589 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
590 /* set SRP N/g param callback for verification */
591 int (*SRP_verify_param_callback
) (SSL
*, void *);
592 /* set SRP client passwd callback */
593 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
595 BIGNUM
*N
, *g
, *s
, *B
, *A
;
599 unsigned long srp_Mask
;
610 DEFINE_LHASH_OF(SSL_SESSION
);
611 /* Needed in ssl_cert.c */
612 DEFINE_LHASH_OF(X509_NAME
);
614 # define TLSEXT_KEYNAME_LENGTH 16
617 const SSL_METHOD
*method
;
618 STACK_OF(SSL_CIPHER
) *cipher_list
;
619 /* same as above but sorted for lookup */
620 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
621 struct x509_store_st
/* X509_STORE */ *cert_store
;
622 LHASH_OF(SSL_SESSION
) *sessions
;
624 * Most session-ids that will be cached, default is
625 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
627 size_t session_cache_size
;
628 struct ssl_session_st
*session_cache_head
;
629 struct ssl_session_st
*session_cache_tail
;
631 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
632 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
633 * means only SSL_accept which cache SSL_SESSIONS.
635 uint32_t session_cache_mode
;
637 * If timeout is not 0, it is the default timeout value set when
638 * SSL_new() is called. This has been put in to make life easier to set
641 long session_timeout
;
643 * If this callback is not null, it will be called each time a session id
644 * is added to the cache. If this function returns 1, it means that the
645 * callback will do a SSL_SESSION_free() when it has finished using it.
646 * Otherwise, on 0, it means the callback has finished with it. If
647 * remove_session_cb is not null, it will be called when a session-id is
648 * removed from the cache. After the call, OpenSSL will
649 * SSL_SESSION_free() it.
651 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
652 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
653 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
654 const unsigned char *data
, int len
,
657 int sess_connect
; /* SSL new conn - started */
658 int sess_connect_renegotiate
; /* SSL reneg - requested */
659 int sess_connect_good
; /* SSL new conne/reneg - finished */
660 int sess_accept
; /* SSL new accept - started */
661 int sess_accept_renegotiate
; /* SSL reneg - requested */
662 int sess_accept_good
; /* SSL accept/reneg - finished */
663 int sess_miss
; /* session lookup misses */
664 int sess_timeout
; /* reuse attempt on timeouted session */
665 int sess_cache_full
; /* session removed due to full cache */
666 int sess_hit
; /* session reuse actually done */
667 int sess_cb_hit
; /* session-id that was not in the cache was
668 * passed back via the callback. This
669 * indicates that the application is supplying
670 * session-id's from other processes - spooky
674 CRYPTO_REF_COUNT references
;
676 /* if defined, these override the X509_verify_cert() calls */
677 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
678 void *app_verify_arg
;
680 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
681 * ('app_verify_callback' was called with just one argument)
684 /* Default password callback. */
685 pem_password_cb
*default_passwd_callback
;
687 /* Default password callback user data. */
688 void *default_passwd_callback_userdata
;
690 /* get client cert callback */
691 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
693 /* cookie generate callback */
694 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
695 unsigned int *cookie_len
);
697 /* verify cookie callback */
698 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
699 unsigned int cookie_len
);
701 CRYPTO_EX_DATA ex_data
;
703 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
704 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3->sha1' */
706 STACK_OF(X509
) *extra_certs
;
707 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
709 /* Default values used when no per-SSL value is defined follow */
711 /* used if SSL's info_callback is NULL */
712 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
714 /* what we put in client cert requests */
715 STACK_OF(X509_NAME
) *client_CA
;
718 * Default values to use in SSL structures follow (these are copied by
724 int min_proto_version
;
725 int max_proto_version
;
726 size_t max_cert_list
;
728 struct cert_st
/* CERT */ *cert
;
731 /* callback that allows applications to peek at protocol messages */
732 void (*msg_callback
) (int write_p
, int version
, int content_type
,
733 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
734 void *msg_callback_arg
;
736 uint32_t verify_mode
;
737 size_t sid_ctx_length
;
738 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
739 /* called 'verify_callback' in the SSL */
740 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
742 /* Default generate session ID callback. */
743 GEN_SESSION_CB generate_session_id
;
745 X509_VERIFY_PARAM
*param
;
749 # ifndef OPENSSL_NO_CT
750 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
752 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
753 * If they are not, the connection should be aborted.
755 ssl_ct_validation_cb ct_validation_callback
;
756 void *ct_validation_callback_arg
;
760 * If we're using more than one pipeline how should we divide the data
761 * up between the pipes?
763 size_t split_send_fragment
;
765 * Maximum amount of data to send in one fragment. actual record size can
766 * be more than this due to padding and MAC overheads.
768 size_t max_send_fragment
;
770 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
771 size_t max_pipelines
;
773 /* The default read buffer length to use (0 means not set) */
774 size_t default_read_buf_len
;
776 # ifndef OPENSSL_NO_ENGINE
778 * Engine to pass requests for client certs to
780 ENGINE
*client_cert_engine
;
783 /* TLS extensions. */
785 /* TLS extensions servername callback */
786 int (*servername_cb
) (SSL
*, int *, void *);
787 void *servername_arg
;
788 /* RFC 4507 session ticket keys */
789 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
790 unsigned char tick_hmac_key
[32];
791 unsigned char tick_aes_key
[32];
792 /* Callback to support customisation of ticket key setting */
793 int (*ticket_key_cb
) (SSL
*ssl
,
794 unsigned char *name
, unsigned char *iv
,
795 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
797 /* certificate status request info */
798 /* Callback for status request */
799 int (*status_cb
) (SSL
*ssl
, void *arg
);
801 /* ext status type used for CSR extension (OCSP Stapling) */
804 # ifndef OPENSSL_NO_EC
805 /* EC extension values inherited by SSL structure */
806 size_t ecpointformats_len
;
807 unsigned char *ecpointformats
;
808 size_t supportedgroups_len
;
809 unsigned char *supportedgroups
;
810 # endif /* OPENSSL_NO_EC */
813 * ALPN information (we are in the process of transitioning from NPN to
818 * For a server, this contains a callback function that allows the
819 * server to select the protocol for the connection.
820 * out: on successful return, this must point to the raw protocol
821 * name (without the length prefix).
822 * outlen: on successful return, this contains the length of |*out|.
823 * in: points to the client's list of supported protocols in
825 * inlen: the length of |in|.
827 int (*alpn_select_cb
) (SSL
*s
,
828 const unsigned char **out
,
829 unsigned char *outlen
,
830 const unsigned char *in
,
831 unsigned int inlen
, void *arg
);
832 void *alpn_select_cb_arg
;
835 * For a client, this contains the list of supported protocols in wire
841 # ifndef OPENSSL_NO_NEXTPROTONEG
842 /* Next protocol negotiation information */
845 * For a server, this contains a callback function by which the set of
846 * advertised protocols can be provided.
848 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
849 void *npn_advertised_cb_arg
;
851 * For a client, this contains a callback function that selects the next
852 * protocol from the list provided by the server.
854 SSL_CTX_npn_select_cb_func npn_select_cb
;
855 void *npn_select_cb_arg
;
859 # ifndef OPENSSL_NO_PSK
860 SSL_psk_client_cb_func psk_client_callback
;
861 SSL_psk_server_cb_func psk_server_callback
;
864 # ifndef OPENSSL_NO_SRP
865 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
868 /* Shared DANE context */
869 struct dane_ctx_st dane
;
871 /* SRTP profiles we are willing to do from RFC 5764 */
872 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
874 * Callback for disabling session caching and ticket support on a session
875 * basis, depending on the chosen cipher.
877 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
882 * Callback for logging key material for use with debugging tools like
883 * Wireshark. The callback should log `line` followed by a newline.
885 SSL_CTX_keylog_cb_func keylog_callback
;
890 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
895 const SSL_METHOD
*method
;
897 * There are 2 BIO's even though they are normally both the same. This
898 * is so data can be read and written to different handlers
900 /* used by SSL_read */
902 /* used by SSL_write */
904 /* used during session-id reuse to concatenate messages */
907 * This holds a variable that indicates what we were doing when a 0 or -1
908 * is returned. This is needed for non-blocking IO so we know what
909 * request needs re-doing when in SSL_accept or SSL_connect
912 int (*handshake_func
) (SSL
*);
914 * Imagine that here's a boolean member "init" that is switched as soon
915 * as SSL_set_{accept/connect}_state is called for the first time, so
916 * that "state" and "handshake_func" are properly initialized. But as
917 * handshake_func is == 0 until then, we use this test instead of an
920 /* are we the server side? */
923 * Generate a new session or reuse an old one.
924 * NB: For servers, the 'new' session may actually be a previously
925 * cached session or even the previous session unless
926 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
929 /* don't send shutdown packets */
931 /* we have shut things down, 0x01 sent, 0x02 for received */
935 BUF_MEM
*init_buf
; /* buffer used during init */
936 void *init_msg
; /* pointer to handshake message body, set by
937 * ssl3_get_message() */
938 size_t init_num
; /* amount read/written */
939 size_t init_off
; /* amount read/written */
940 struct ssl3_state_st
*s3
; /* SSLv3 variables */
941 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
942 /* callback that allows applications to peek at protocol messages */
943 void (*msg_callback
) (int write_p
, int version
, int content_type
,
944 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
945 void *msg_callback_arg
;
946 int hit
; /* reusing a previous session */
947 X509_VERIFY_PARAM
*param
;
948 /* Per connection DANE state */
951 STACK_OF(SSL_CIPHER
) *cipher_list
;
952 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
954 * These are the ones being used, the ones in SSL_SESSION are the ones to
955 * be 'copied' into these ones
959 * The TLS1.3 early_secret and handshake_secret. The master_secret is stored
962 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
963 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
964 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
965 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
966 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
967 EVP_CIPHER_CTX
*enc_read_ctx
; /* cryptographic state */
968 unsigned char read_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static read IV */
969 EVP_MD_CTX
*read_hash
; /* used for mac generation */
970 COMP_CTX
*compress
; /* compression */
971 COMP_CTX
*expand
; /* uncompress */
972 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
973 unsigned char write_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static write IV */
974 EVP_MD_CTX
*write_hash
; /* used for mac generation */
977 /* This is used to hold the server certificate used */
978 struct cert_st
/* CERT */ *cert
;
981 * The hash of all messages prior to the CertificateVerify, and the length
984 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
985 size_t cert_verify_hash_len
;
988 * the session_id_context is used to ensure sessions are only reused in
989 * the appropriate context
991 size_t sid_ctx_length
;
992 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
993 /* This can also be in the session once a session is established */
994 SSL_SESSION
*session
;
995 /* Default generate session ID callback. */
996 GEN_SESSION_CB generate_session_id
;
999 * 0 don't care about verify failure.
1000 * 1 fail if verify fails
1002 uint32_t verify_mode
;
1003 /* fail if callback returns 0 */
1004 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1005 /* optional informational callback */
1006 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1007 /* error bytes to be written */
1011 # ifndef OPENSSL_NO_PSK
1012 SSL_psk_client_cb_func psk_client_callback
;
1013 SSL_psk_server_cb_func psk_server_callback
;
1016 /* Verified chain of peer */
1017 STACK_OF(X509
) *verified_chain
;
1019 /* extra application data */
1020 CRYPTO_EX_DATA ex_data
;
1021 /* for server side, keep the list of CA_dn we can use */
1022 STACK_OF(X509_NAME
) *client_CA
;
1023 CRYPTO_REF_COUNT references
;
1024 /* protocol behaviour */
1028 int min_proto_version
;
1029 int max_proto_version
;
1030 size_t max_cert_list
;
1033 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1034 * secret and SSLv3/TLS (<=1.2) rollback check
1038 * If we're using more than one pipeline how should we divide the data
1039 * up between the pipes?
1041 size_t split_send_fragment
;
1043 * Maximum amount of data to send in one fragment. actual record size can
1044 * be more than this due to padding and MAC overheads.
1046 size_t max_send_fragment
;
1047 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1048 size_t max_pipelines
;
1051 /* TLS extension debug callback */
1052 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1053 const unsigned char *data
, int len
, void *arg
);
1056 /* certificate status request info */
1057 /* Status type or -1 if no status type */
1059 /* Raw extension data, if seen */
1060 unsigned char *scts
;
1061 /* Length of raw extension data, if seen */
1063 /* Expect OCSP CertificateStatus message */
1064 int status_expected
;
1067 /* OCSP status request only */
1068 STACK_OF(OCSP_RESPID
) *ids
;
1069 X509_EXTENSIONS
*exts
;
1070 /* OCSP response received or to be sent */
1071 unsigned char *resp
;
1075 /* RFC4507 session ticket expected to be received or sent */
1076 int ticket_expected
;
1077 # ifndef OPENSSL_NO_EC
1078 size_t ecpointformats_len
;
1080 unsigned char *ecpointformats
;
1081 size_t supportedgroups_len
;
1083 unsigned char *supportedgroups
;
1084 # endif /* OPENSSL_NO_EC */
1085 /* TLS Session Ticket extension override */
1086 TLS_SESSION_TICKET_EXT
*session_ticket
;
1087 /* TLS Session Ticket extension callback */
1088 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1089 void *session_ticket_cb_arg
;
1090 /* TLS pre-shared secret session resumption */
1091 tls_session_secret_cb_fn session_secret_cb
;
1092 void *session_secret_cb_arg
;
1094 * For a client, this contains the list of supported protocols in wire
1097 unsigned char *alpn
;
1100 * Next protocol negotiation. For the client, this is the protocol that
1101 * we sent in NextProtocol and is set when handling ServerHello
1102 * extensions. For a server, this is the client's selected_protocol from
1103 * NextProtocol and is set when handling the NextProtocol message, before
1104 * the Finished message.
1109 /* The selected PSK key exchange mode */
1114 * no further mod of servername
1115 * 0 : call the servername extension callback.
1116 * 1 : prepare 2, allow last ack just after in server callback.
1117 * 2 : don't call servername callback, no ack in server hello
1119 int servername_done
;
1120 # ifndef OPENSSL_NO_CT
1122 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1123 * If they are not, the connection should be aborted.
1125 ssl_ct_validation_cb ct_validation_callback
;
1126 /* User-supplied argument that is passed to the ct_validation_callback */
1127 void *ct_validation_callback_arg
;
1129 * Consolidated stack of SCTs from all sources.
1130 * Lazily populated by CT_get_peer_scts(SSL*)
1132 STACK_OF(SCT
) *scts
;
1133 /* Have we attempted to find/parse SCTs yet? */
1136 SSL_CTX
*initial_ctx
; /* initial ctx, used to store sessions */
1137 # ifndef OPENSSL_NO_NEXTPROTONEG
1139 # define session_ctx initial_ctx
1141 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1142 /* What's been chosen */
1143 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1145 * 1 if we are renegotiating.
1146 * 2 if we are a server and are inside a handshake
1147 * (i.e. not just sending a HelloRequest)
1150 # ifndef OPENSSL_NO_SRP
1151 /* ctx for SRP authentication */
1155 * Callback for disabling session caching and ticket support on a session
1156 * basis, depending on the chosen cipher.
1158 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1159 RECORD_LAYER rlayer
;
1160 /* Default password callback. */
1161 pem_password_cb
*default_passwd_callback
;
1162 /* Default password callback user data. */
1163 void *default_passwd_callback_userdata
;
1164 /* Async Job info */
1166 ASYNC_WAIT_CTX
*waitctx
;
1169 CRYPTO_RWLOCK
*lock
;
1172 typedef struct ssl3_state_st
{
1174 size_t read_mac_secret_size
;
1175 unsigned char read_mac_secret
[EVP_MAX_MD_SIZE
];
1176 size_t write_mac_secret_size
;
1177 unsigned char write_mac_secret
[EVP_MAX_MD_SIZE
];
1178 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1179 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1180 /* flags for countermeasure against known-IV weakness */
1181 int need_empty_fragments
;
1182 int empty_fragment_done
;
1183 /* used during startup, digest all incoming/outgoing packets */
1184 BIO
*handshake_buffer
;
1186 * When handshake digest is determined, buffer is hashed and
1187 * freed and MD_CTX for the required digest is stored here.
1189 EVP_MD_CTX
*handshake_dgst
;
1191 * Set whenever an expected ChangeCipherSpec message is processed.
1192 * Unset when the peer's Finished message is received.
1193 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1195 int change_cipher_spec
;
1199 * we allow one fatal and one warning alert to be outstanding, send close
1200 * alert via the warning alert
1203 unsigned char send_alert
[2];
1205 * This flag is set when we should renegotiate ASAP, basically when there
1206 * is no more data in the read or write buffers
1209 int total_renegotiations
;
1210 int num_renegotiations
;
1211 int in_read_app_data
;
1213 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1214 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1215 size_t finish_md_len
;
1216 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1217 size_t peer_finish_md_len
;
1218 size_t message_size
;
1220 /* used to hold the new cipher we are going to use */
1221 const SSL_CIPHER
*new_cipher
;
1222 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1223 EVP_PKEY
*pkey
; /* holds short lived DH/ECDH key */
1225 /* used for certificate requests */
1228 char ctype
[SSL3_CT_NUMBER
];
1229 STACK_OF(X509_NAME
) *ca_names
;
1230 size_t key_block_length
;
1231 unsigned char *key_block
;
1232 const EVP_CIPHER
*new_sym_enc
;
1233 const EVP_MD
*new_hash
;
1234 int new_mac_pkey_type
;
1235 size_t new_mac_secret_size
;
1236 # ifndef OPENSSL_NO_COMP
1237 const SSL_COMP
*new_compression
;
1239 char *new_compression
;
1242 /* Raw values of the cipher list from a client */
1243 unsigned char *ciphers_raw
;
1244 size_t ciphers_rawlen
;
1245 /* Temporary storage for premaster secret */
1248 # ifndef OPENSSL_NO_PSK
1249 /* Temporary storage for PSK key */
1254 * signature algorithms peer reports: e.g. supported signature
1255 * algorithms extension for server or as part of a certificate
1256 * request for client.
1258 unsigned int *peer_sigalgs
;
1259 /* Size of above array */
1260 size_t peer_sigalgslen
;
1261 /* Digest peer uses for signing */
1262 const EVP_MD
*peer_md
;
1263 /* Array of digests used for signing */
1264 const EVP_MD
*md
[SSL_PKEY_NUM
];
1266 * Set if corresponding CERT_PKEY can be used with current
1267 * SSL session: e.g. appropriate curve, signature algorithms etc.
1268 * If zero it can't be used at all.
1270 uint32_t valid_flags
[SSL_PKEY_NUM
];
1272 * For servers the following masks are for the key and auth algorithms
1273 * that are supported by the certs below. For clients they are masks of
1274 * *disabled* algorithms based on the current session.
1279 * The following are used by the client to see if a cipher is allowed or
1280 * not. It contains the minimum and maximum version the client's using
1281 * based on what it knows so far.
1287 /* Connection binding to prevent renegotiation attacks */
1288 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1289 size_t previous_client_finished_len
;
1290 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1291 size_t previous_server_finished_len
;
1292 int send_connection_binding
; /* TODOEKR */
1294 # ifndef OPENSSL_NO_NEXTPROTONEG
1296 * Set if we saw the Next Protocol Negotiation extension from our peer.
1302 * ALPN information (we are in the process of transitioning from NPN to
1307 * In a server these point to the selected ALPN protocol after the
1308 * ClientHello has been processed. In a client these contain the protocol
1309 * that the server selected once the ServerHello has been processed.
1311 unsigned char *alpn_selected
;
1312 size_t alpn_selected_len
;
1313 /* used by the server to know what options were proposed */
1314 unsigned char *alpn_proposed
;
1315 size_t alpn_proposed_len
;
1316 /* used by the client to know if it actually sent alpn */
1319 # ifndef OPENSSL_NO_EC
1321 * This is set to true if we believe that this is a version of Safari
1322 * running on OS X 10.6 or newer. We wish to know this because Safari on
1323 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1325 char is_probably_safari
;
1326 # endif /* !OPENSSL_NO_EC */
1328 /* For clients: peer temporary key */
1329 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1330 /* The group_id for the DH/ECDH key */
1331 unsigned int group_id
;
1337 /* DTLS structures */
1339 # ifndef OPENSSL_NO_SCTP
1340 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1343 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1344 # define DTLS1_MAX_MTU_OVERHEAD 48
1347 * Flag used in message reuse to indicate the buffer contains the record
1348 * header as well as the the handshake message header.
1350 # define DTLS1_SKIP_RECORD_HEADER 2
1352 struct dtls1_retransmit_state
{
1353 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1354 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1355 COMP_CTX
*compress
; /* compression */
1356 SSL_SESSION
*session
;
1357 unsigned short epoch
;
1360 struct hm_header_st
{
1366 unsigned int is_ccs
;
1367 struct dtls1_retransmit_state saved_retransmit_state
;
1370 struct dtls1_timeout_st
{
1371 /* Number of read timeouts so far */
1372 unsigned int read_timeouts
;
1373 /* Number of write timeouts so far */
1374 unsigned int write_timeouts
;
1375 /* Number of alerts received so far */
1376 unsigned int num_alerts
;
1379 typedef struct hm_fragment_st
{
1380 struct hm_header_st msg_header
;
1381 unsigned char *fragment
;
1382 unsigned char *reassembly
;
1385 typedef struct pqueue_st pqueue
;
1386 typedef struct pitem_st pitem
;
1389 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1394 typedef struct pitem_st
*piterator
;
1396 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1397 void pitem_free(pitem
*item
);
1398 pqueue
*pqueue_new(void);
1399 void pqueue_free(pqueue
*pq
);
1400 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1401 pitem
*pqueue_peek(pqueue
*pq
);
1402 pitem
*pqueue_pop(pqueue
*pq
);
1403 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1404 pitem
*pqueue_iterator(pqueue
*pq
);
1405 pitem
*pqueue_next(piterator
*iter
);
1406 size_t pqueue_size(pqueue
*pq
);
1408 typedef struct dtls1_state_st
{
1409 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1411 unsigned int cookie_verified
;
1412 /* handshake message numbers */
1413 unsigned short handshake_write_seq
;
1414 unsigned short next_handshake_write_seq
;
1415 unsigned short handshake_read_seq
;
1416 /* Buffered handshake messages */
1417 pqueue
*buffered_messages
;
1418 /* Buffered (sent) handshake records */
1419 pqueue
*sent_messages
;
1420 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1421 size_t mtu
; /* max DTLS packet size */
1422 struct hm_header_st w_msg_hdr
;
1423 struct hm_header_st r_msg_hdr
;
1424 struct dtls1_timeout_st timeout
;
1426 * Indicates when the last handshake msg sent will timeout
1428 struct timeval next_timeout
;
1429 /* Timeout duration */
1430 unsigned short timeout_duration
;
1431 unsigned int retransmitting
;
1432 # ifndef OPENSSL_NO_SCTP
1433 int shutdown_received
;
1437 # ifndef OPENSSL_NO_EC
1439 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1441 # define EXPLICIT_PRIME_CURVE_TYPE 1
1442 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1443 # define NAMED_CURVE_TYPE 3
1444 # endif /* OPENSSL_NO_EC */
1446 typedef struct cert_pkey_st
{
1448 EVP_PKEY
*privatekey
;
1449 /* Chain for this certificate */
1450 STACK_OF(X509
) *chain
;
1452 * serverinfo data for this certificate. The data is in TLS Extension
1453 * wire format, specifically it's a series of records like:
1454 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1456 * uint8_t data[length];
1458 unsigned char *serverinfo
;
1459 size_t serverinfo_length
;
1461 /* Retrieve Suite B flags */
1462 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1463 /* Uses to check strict mode: suite B modes are always strict */
1464 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1465 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1468 unsigned short ext_type
;
1470 * Per-connection flags relating to this extension type: not used if
1471 * part of an SSL_CTX structure.
1474 custom_ext_add_cb add_cb
;
1475 custom_ext_free_cb free_cb
;
1477 custom_ext_parse_cb parse_cb
;
1479 } custom_ext_method
;
1481 /* ext_flags values */
1484 * Indicates an extension has been received. Used to check for unsolicited or
1485 * duplicate extensions.
1487 # define SSL_EXT_FLAG_RECEIVED 0x1
1489 * Indicates an extension has been sent: used to enable sending of
1490 * corresponding ServerHello extension.
1492 # define SSL_EXT_FLAG_SENT 0x2
1495 custom_ext_method
*meths
;
1497 } custom_ext_methods
;
1499 typedef struct cert_st
{
1500 /* Current active set */
1502 * ALWAYS points to an element of the pkeys array
1503 * Probably it would make more sense to store
1504 * an index, not a pointer.
1507 # ifndef OPENSSL_NO_DH
1509 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
1512 /* Flags related to certificates */
1513 uint32_t cert_flags
;
1514 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
1516 * Certificate types (received or sent) in certificate request message.
1517 * On receive this is only set if number of certificate types exceeds
1520 unsigned char *ctypes
;
1523 * supported signature algorithms. When set on a client this is sent in
1524 * the client hello as the supported signature algorithms extension. For
1525 * servers it represents the signature algorithms we are willing to use.
1527 unsigned int *conf_sigalgs
;
1528 /* Size of above array */
1529 size_t conf_sigalgslen
;
1531 * Client authentication signature algorithms, if not set then uses
1532 * conf_sigalgs. On servers these will be the signature algorithms sent
1533 * to the client in a certificate request for TLS 1.2. On a client this
1534 * represents the signature algorithms we are willing to use for client
1537 unsigned int *client_sigalgs
;
1538 /* Size of above array */
1539 size_t client_sigalgslen
;
1541 * Signature algorithms shared by client and server: cached because these
1542 * are used most often.
1544 TLS_SIGALGS
*shared_sigalgs
;
1545 size_t shared_sigalgslen
;
1547 * Certificate setup callback: if set is called whenever a certificate
1548 * may be required (client or server). the callback can then examine any
1549 * appropriate parameters and setup any certificates required. This
1550 * allows advanced applications to select certificates on the fly: for
1551 * example based on supported signature algorithms or curves.
1553 int (*cert_cb
) (SSL
*ssl
, void *arg
);
1556 * Optional X509_STORE for chain building or certificate validation If
1557 * NULL the parent SSL_CTX store is used instead.
1559 X509_STORE
*chain_store
;
1560 X509_STORE
*verify_store
;
1561 /* Custom extension methods for server and client */
1562 custom_ext_methods cli_ext
;
1563 custom_ext_methods srv_ext
;
1564 /* Security callback */
1565 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1566 void *other
, void *ex
);
1567 /* Security level */
1570 # ifndef OPENSSL_NO_PSK
1571 /* If not NULL psk identity hint to use for servers */
1572 char *psk_identity_hint
;
1574 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
1575 CRYPTO_RWLOCK
*lock
;
1578 /* Structure containing decoded values of signature algorithms extension */
1579 struct tls_sigalgs_st
{
1580 /* NID of hash algorithm */
1582 /* NID of signature algorithm */
1584 /* Combined hash and signature NID */
1585 int signandhash_nid
;
1586 /* Raw value used in extension */
1587 unsigned int rsigalg
;
1590 # define FP_ICC (int (*)(const void *,const void *))
1593 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1594 * of a mess of functions, but hell, think of it as an opaque structure :-)
1596 typedef struct ssl3_enc_method
{
1597 int (*enc
) (SSL
*, SSL3_RECORD
*, size_t, int);
1598 int (*mac
) (SSL
*, SSL3_RECORD
*, unsigned char *, int);
1599 int (*setup_key_block
) (SSL
*);
1600 int (*generate_master_secret
) (SSL
*, unsigned char *, unsigned char *,
1602 int (*change_cipher_state
) (SSL
*, int);
1603 size_t (*final_finish_mac
) (SSL
*, const char *, size_t, unsigned char *);
1604 const char *client_finished_label
;
1605 size_t client_finished_label_len
;
1606 const char *server_finished_label
;
1607 size_t server_finished_label_len
;
1608 int (*alert_value
) (int);
1609 int (*export_keying_material
) (SSL
*, unsigned char *, size_t,
1610 const char *, size_t,
1611 const unsigned char *, size_t,
1613 /* Various flags indicating protocol version requirements */
1615 /* Set the handshake header */
1616 int (*set_handshake_header
) (SSL
*s
, WPACKET
*pkt
, int type
);
1617 /* Close construction of the handshake message */
1618 int (*close_construct_packet
) (SSL
*s
, WPACKET
*pkt
, int htype
);
1619 /* Write out handshake message */
1620 int (*do_write
) (SSL
*s
);
1623 # define ssl_set_handshake_header(s, pkt, htype) \
1624 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1625 # define ssl_close_construct_packet(s, pkt, htype) \
1626 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1627 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1629 /* Values for enc_flags */
1631 /* Uses explicit IV for CBC mode */
1632 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1633 /* Uses signature algorithms extension */
1634 # define SSL_ENC_FLAG_SIGALGS 0x2
1635 /* Uses SHA256 default PRF */
1636 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1638 # define SSL_ENC_FLAG_DTLS 0x8
1640 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1641 * apply to others in future.
1643 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1645 # ifndef OPENSSL_NO_COMP
1646 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1647 typedef struct ssl3_comp_st
{
1648 int comp_id
; /* The identifier byte for this compression
1650 char *name
; /* Text name used for the compression type */
1651 COMP_METHOD
*method
; /* The method :-) */
1655 typedef struct raw_extension_st
{
1656 /* Raw packet data for the extension */
1658 /* Set to 1 if the extension is present or 0 otherwise */
1660 /* Set to 1 if we have already parsed the extension or 0 otherwise */
1662 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
1667 * Extension index values NOTE: Any updates to these defines should be mirrored
1668 * with equivalent updates to ext_defs in extensions.c
1670 typedef enum tlsext_index_en
{
1671 TLSEXT_IDX_renegotiate
,
1672 TLSEXT_IDX_server_name
,
1674 TLSEXT_IDX_ec_point_formats
,
1675 TLSEXT_IDX_supported_groups
,
1676 TLSEXT_IDX_session_ticket
,
1677 TLSEXT_IDX_signature_algorithms
,
1678 TLSEXT_IDX_status_request
,
1679 TLSEXT_IDX_next_proto_neg
,
1680 TLSEXT_IDX_application_layer_protocol_negotiation
,
1681 TLSEXT_IDX_use_srtp
,
1682 TLSEXT_IDX_encrypt_then_mac
,
1683 TLSEXT_IDX_signed_certificate_timestamp
,
1684 TLSEXT_IDX_extended_master_secret
,
1685 TLSEXT_IDX_supported_versions
,
1686 TLSEXT_IDX_psk_kex_modes
,
1687 TLSEXT_IDX_key_share
,
1688 TLSEXT_IDX_cryptopro_bug
,
1693 * Dummy status type for the status_type extension. Indicates no status type
1696 #define TLSEXT_STATUSTYPE_nothing -1
1698 /* Sigalgs values */
1699 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1700 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1701 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1702 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1703 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1704 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1705 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1706 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1707 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1708 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1709 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1710 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1711 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1712 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1713 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1714 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1715 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1716 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1718 /* Known PSK key exchange modes */
1719 #define TLSEXT_KEX_MODE_KE 0x00
1720 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1723 * Internal representations of key exchange modes
1725 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1726 #define TLSEXT_KEX_MODE_FLAG_KE 1
1727 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1729 #define SIGID_IS_PSS(sigid) ((sigid) == TLSEXT_SIGALG_rsa_pss_sha256 \
1730 || (sigid) == TLSEXT_SIGALG_rsa_pss_sha384 \
1731 || (sigid) == TLSEXT_SIGALG_rsa_pss_sha512)
1734 /* A dummy signature value not valid for TLSv1.2 signature algs */
1735 #define TLSEXT_signature_rsa_pss 0x0101
1738 #define MAX_COMPRESSIONS_SIZE 255
1742 unsigned int legacy_version
;
1743 unsigned char random
[SSL3_RANDOM_SIZE
];
1744 size_t session_id_len
;
1745 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
1746 size_t dtls_cookie_len
;
1747 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
1748 PACKET ciphersuites
;
1749 size_t compressions_len
;
1750 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
1752 RAW_EXTENSION
*pre_proc_exts
;
1755 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
1757 __owur
const SSL_METHOD
*ssl_bad_method(int ver
);
1758 __owur
const SSL_METHOD
*sslv3_method(void);
1759 __owur
const SSL_METHOD
*sslv3_server_method(void);
1760 __owur
const SSL_METHOD
*sslv3_client_method(void);
1761 __owur
const SSL_METHOD
*tlsv1_method(void);
1762 __owur
const SSL_METHOD
*tlsv1_server_method(void);
1763 __owur
const SSL_METHOD
*tlsv1_client_method(void);
1764 __owur
const SSL_METHOD
*tlsv1_1_method(void);
1765 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
1766 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
1767 __owur
const SSL_METHOD
*tlsv1_2_method(void);
1768 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
1769 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
1770 __owur
const SSL_METHOD
*tlsv1_3_method(void);
1771 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
1772 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
1773 __owur
const SSL_METHOD
*dtlsv1_method(void);
1774 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
1775 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
1776 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
1777 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
1778 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
1779 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
1781 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
1782 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
1783 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
1784 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
1785 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
1786 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
1787 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
1790 * Flags for SSL methods
1792 # define SSL_METHOD_NO_FIPS (1U<<0)
1793 # define SSL_METHOD_NO_SUITEB (1U<<1)
1795 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1796 s_connect, enc_data) \
1797 const SSL_METHOD *func_name(void) \
1799 static const SSL_METHOD func_name##_data= { \
1813 ssl3_renegotiate_check, \
1816 ssl3_dispatch_alert, \
1819 ssl3_get_cipher_by_char, \
1820 ssl3_put_cipher_by_char, \
1824 tls1_default_timeout, \
1826 ssl_undefined_void_function, \
1827 ssl3_callback_ctrl, \
1828 ssl3_ctx_callback_ctrl, \
1830 return &func_name##_data; \
1833 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1834 const SSL_METHOD *func_name(void) \
1836 static const SSL_METHOD func_name##_data= { \
1838 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1850 ssl3_renegotiate_check, \
1853 ssl3_dispatch_alert, \
1856 ssl3_get_cipher_by_char, \
1857 ssl3_put_cipher_by_char, \
1861 ssl3_default_timeout, \
1863 ssl_undefined_void_function, \
1864 ssl3_callback_ctrl, \
1865 ssl3_ctx_callback_ctrl, \
1867 return &func_name##_data; \
1870 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1871 s_connect, enc_data) \
1872 const SSL_METHOD *func_name(void) \
1874 static const SSL_METHOD func_name##_data= { \
1888 ssl3_renegotiate_check, \
1890 dtls1_write_app_data_bytes, \
1891 dtls1_dispatch_alert, \
1894 ssl3_get_cipher_by_char, \
1895 ssl3_put_cipher_by_char, \
1899 dtls1_default_timeout, \
1901 ssl_undefined_void_function, \
1902 ssl3_callback_ctrl, \
1903 ssl3_ctx_callback_ctrl, \
1905 return &func_name##_data; \
1908 struct openssl_ssl_test_functions
{
1909 int (*p_ssl_init_wbio_buffer
) (SSL
*s
);
1910 int (*p_ssl3_setup_buffers
) (SSL
*s
);
1913 const char *ssl_protocol_to_string(int version
);
1915 # ifndef OPENSSL_UNIT_TEST
1917 void ssl_clear_cipher_ctx(SSL
*s
);
1918 int ssl_clear_bad_session(SSL
*s
);
1919 __owur CERT
*ssl_cert_new(void);
1920 __owur CERT
*ssl_cert_dup(CERT
*cert
);
1921 void ssl_cert_clear_certs(CERT
*c
);
1922 void ssl_cert_free(CERT
*c
);
1923 __owur
int ssl_get_new_session(SSL
*s
, int session
);
1924 __owur
int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
);
1925 __owur SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
);
1926 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
1927 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
1928 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
1929 const SSL_CIPHER
*const *bp
);
1930 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
1931 STACK_OF(SSL_CIPHER
) **pref
,
1932 STACK_OF(SSL_CIPHER
)
1934 const char *rule_str
,
1936 void ssl_update_cache(SSL
*s
, int mode
);
1937 __owur
int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
1938 const EVP_MD
**md
, int *mac_pkey_type
,
1939 size_t *mac_secret_size
, SSL_COMP
**comp
,
1941 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
1942 size_t *int_overhead
, size_t *blocksize
,
1943 size_t *ext_overhead
);
1944 __owur
int ssl_cipher_get_cert_index(const SSL_CIPHER
*c
);
1945 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
,
1946 const unsigned char *ptr
);
1947 __owur
int ssl_cert_set0_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
1948 __owur
int ssl_cert_set1_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
1949 __owur
int ssl_cert_add0_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
1950 __owur
int ssl_cert_add1_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
1951 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
1952 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
1953 __owur X509
*ssl_cert_get0_next_certificate(CERT
*c
, int first
);
1954 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
1956 __owur
int ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
);
1957 __owur
int ssl_build_cert_chain(SSL
*s
, SSL_CTX
*ctx
, int flags
);
1958 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
1961 __owur
int ssl_security(const SSL
*s
, int op
, int bits
, int nid
, void *other
);
1962 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1965 int ssl_undefined_function(SSL
*s
);
1966 __owur
int ssl_undefined_void_function(void);
1967 __owur
int ssl_undefined_const_function(const SSL
*s
);
1968 __owur CERT_PKEY
*ssl_get_server_send_pkey(SSL
*s
);
1969 __owur
int ssl_get_server_cert_serverinfo(SSL
*s
,
1970 const unsigned char **serverinfo
,
1971 size_t *serverinfo_length
);
1972 __owur EVP_PKEY
*ssl_get_sign_pkey(SSL
*s
, const SSL_CIPHER
*c
,
1973 const EVP_MD
**pmd
);
1974 __owur
int ssl_cert_type(const X509
*x
, const EVP_PKEY
*pkey
);
1975 void ssl_set_masks(SSL
*s
);
1976 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
1977 __owur
int ssl_verify_alarm_type(long type
);
1978 void ssl_sort_cipher_list(void);
1979 void ssl_load_ciphers(void);
1980 __owur
int ssl_fill_hello_random(SSL
*s
, int server
, unsigned char *field
,
1982 __owur
int ssl_generate_master_secret(SSL
*s
, unsigned char *pms
, size_t pmslen
,
1984 __owur EVP_PKEY
*ssl_generate_pkey(EVP_PKEY
*pm
);
1985 __owur
int ssl_derive(SSL
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
1987 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
1989 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
1990 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
1992 int ssl3_init_finished_mac(SSL
*s
);
1993 __owur
int ssl3_setup_key_block(SSL
*s
);
1994 __owur
int ssl3_change_cipher_state(SSL
*s
, int which
);
1995 void ssl3_cleanup_key_block(SSL
*s
);
1996 __owur
int ssl3_do_write(SSL
*s
, int type
);
1997 int ssl3_send_alert(SSL
*s
, int level
, int desc
);
1998 __owur
int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
1999 unsigned char *p
, size_t len
,
2000 size_t *secret_size
);
2001 __owur
int ssl3_get_req_cert_type(SSL
*s
, WPACKET
*pkt
);
2002 __owur
int ssl3_num_ciphers(void);
2003 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2004 int ssl3_renegotiate(SSL
*ssl
);
2005 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2006 __owur
int ssl3_dispatch_alert(SSL
*s
);
2007 __owur
size_t ssl3_final_finish_mac(SSL
*s
, const char *sender
, size_t slen
,
2009 __owur
int ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, size_t len
);
2010 void ssl3_free_digest_list(SSL
*s
);
2011 __owur
unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
,
2012 CERT_PKEY
*cpk
, int *al
);
2013 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,
2014 STACK_OF(SSL_CIPHER
) *clnt
,
2015 STACK_OF(SSL_CIPHER
) *srvr
);
2016 __owur
int ssl3_digest_cached_records(SSL
*s
, int keep
);
2017 __owur
int ssl3_new(SSL
*s
);
2018 void ssl3_free(SSL
*s
);
2019 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2020 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2021 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2022 __owur
int ssl3_shutdown(SSL
*s
);
2023 void ssl3_clear(SSL
*s
);
2024 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2025 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2026 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2027 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2029 __owur
int ssl3_do_change_cipher_spec(SSL
*ssl
);
2030 __owur
long ssl3_default_timeout(void);
2032 __owur
int ssl3_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2033 __owur
int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2034 __owur
int tls_setup_handshake(SSL
*s
);
2035 __owur
int dtls1_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2036 __owur
int dtls1_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2037 __owur
int ssl3_handshake_write(SSL
*s
);
2039 __owur
int ssl_allow_compression(SSL
*s
);
2041 __owur
int ssl_version_supported(const SSL
*s
, int version
);
2043 __owur
int ssl_set_client_hello_version(SSL
*s
);
2044 __owur
int ssl_check_version_downgrade(SSL
*s
);
2045 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2046 __owur
int ssl_choose_server_version(SSL
*s
, CLIENTHELLO_MSG
*hello
);
2047 __owur
int ssl_choose_client_version(SSL
*s
, int version
);
2048 int ssl_get_client_min_max_version(const SSL
*s
, int *min_version
,
2051 __owur
long tls1_default_timeout(void);
2052 __owur
int dtls1_do_write(SSL
*s
, int type
);
2053 void dtls1_set_message_header(SSL
*s
,
2056 size_t frag_off
, size_t frag_len
);
2058 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf_
, size_t len
,
2061 __owur
int dtls1_read_failed(SSL
*s
, int code
);
2062 __owur
int dtls1_buffer_message(SSL
*s
, int ccs
);
2063 __owur
int dtls1_retransmit_message(SSL
*s
, unsigned short seq
, int *found
);
2064 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2065 int dtls1_retransmit_buffered_messages(SSL
*s
);
2066 void dtls1_clear_received_buffer(SSL
*s
);
2067 void dtls1_clear_sent_buffer(SSL
*s
);
2068 void dtls1_get_message_header(unsigned char *data
,
2069 struct hm_header_st
*msg_hdr
);
2070 __owur
long dtls1_default_timeout(void);
2071 __owur
struct timeval
*dtls1_get_timeout(SSL
*s
, struct timeval
*timeleft
);
2072 __owur
int dtls1_check_timeout_num(SSL
*s
);
2073 __owur
int dtls1_handle_timeout(SSL
*s
);
2074 void dtls1_start_timer(SSL
*s
);
2075 void dtls1_stop_timer(SSL
*s
);
2076 __owur
int dtls1_is_timer_expired(SSL
*s
);
2077 void dtls1_double_timeout(SSL
*s
);
2078 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2080 __owur
int dtls1_send_newsession_ticket(SSL
*s
);
2081 __owur
size_t dtls1_min_mtu(SSL
*s
);
2082 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2083 __owur
int dtls1_query_mtu(SSL
*s
);
2085 __owur
int tls1_new(SSL
*s
);
2086 void tls1_free(SSL
*s
);
2087 void tls1_clear(SSL
*s
);
2088 long tls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2089 long tls1_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2091 __owur
int dtls1_new(SSL
*s
);
2092 void dtls1_free(SSL
*s
);
2093 void dtls1_clear(SSL
*s
);
2094 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2095 __owur
int dtls1_shutdown(SSL
*s
);
2097 __owur
int dtls1_dispatch_alert(SSL
*s
);
2099 __owur
int ssl_init_wbio_buffer(SSL
*s
);
2100 void ssl_free_wbio_buffer(SSL
*s
);
2102 __owur
int tls1_change_cipher_state(SSL
*s
, int which
);
2103 __owur
int tls1_setup_key_block(SSL
*s
);
2104 __owur
size_t tls1_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2106 __owur
int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
2107 unsigned char *p
, size_t len
,
2108 size_t *secret_size
);
2109 __owur
int tls13_setup_key_block(SSL
*s
);
2110 __owur
size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2112 __owur
int tls13_change_cipher_state(SSL
*s
, int which
);
2113 __owur
int tls13_hkdf_expand(SSL
*s
, const unsigned char *secret
,
2114 const unsigned char *label
, size_t labellen
,
2115 const unsigned char *hash
,
2116 unsigned char *out
, size_t outlen
);
2117 __owur
int tls13_derive_key(SSL
*s
, const unsigned char *secret
,
2118 unsigned char *key
, size_t keylen
);
2119 __owur
int tls13_derive_iv(SSL
*s
, const unsigned char *secret
,
2120 unsigned char *iv
, size_t ivlen
);
2121 __owur
int tls13_generate_early_secret(SSL
*s
, const unsigned char *insecret
,
2122 size_t insecretlen
);
2123 __owur
int tls13_generate_handshake_secret(SSL
*s
,
2124 const unsigned char *insecret
,
2125 size_t insecretlen
);
2126 __owur
int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
2127 unsigned char *prev
, size_t prevlen
,
2128 size_t *secret_size
);
2129 __owur
int tls1_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2130 const char *label
, size_t llen
,
2131 const unsigned char *p
, size_t plen
,
2133 __owur
int tls1_alert_code(int code
);
2134 __owur
int tls13_alert_code(int code
);
2135 __owur
int ssl3_alert_code(int code
);
2136 __owur
int ssl_ok(SSL
*s
);
2138 # ifndef OPENSSL_NO_EC
2139 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
);
2142 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2144 # ifndef OPENSSL_NO_EC
2145 /* Flags values from tls1_ec_curve_id2nid() */
2146 /* Mask for curve type */
2147 # define TLS_CURVE_TYPE 0x3
2148 # define TLS_CURVE_PRIME 0x0
2149 # define TLS_CURVE_CHAR2 0x1
2150 # define TLS_CURVE_CUSTOM 0x2
2151 __owur
int tls1_ec_curve_id2nid(int curve_id
, unsigned int *pflags
);
2152 __owur
int tls1_ec_nid2curve_id(int nid
);
2153 __owur
int tls1_check_curve(SSL
*s
, const unsigned char *p
, size_t len
);
2154 __owur
int tls1_shared_group(SSL
*s
, int nmatch
);
2155 __owur
int tls1_set_groups(unsigned char **pext
, size_t *pextlen
,
2156 int *curves
, size_t ncurves
);
2157 __owur
int tls1_set_groups_list(unsigned char **pext
, size_t *pextlen
,
2159 void tls1_get_formatlist(SSL
*s
, const unsigned char **pformats
,
2160 size_t *num_formats
);
2161 __owur
int tls1_check_ec_tmp_key(SSL
*s
, unsigned long id
);
2162 __owur EVP_PKEY
*ssl_generate_pkey_curve(int id
);
2163 # endif /* OPENSSL_NO_EC */
2165 __owur
int tls1_shared_list(SSL
*s
,
2166 const unsigned char *l1
, size_t l1len
,
2167 const unsigned char *l2
, size_t l2len
, int nmatch
);
2168 __owur
int tls_curve_allowed(SSL
*s
, const unsigned char *curve
, int op
);
2169 __owur
int tls1_get_curvelist(SSL
*s
, int sess
, const unsigned char **pcurves
,
2170 size_t *num_curves
);
2172 void ssl_set_default_md(SSL
*s
);
2173 __owur
int tls1_set_server_sigalgs(SSL
*s
);
2174 __owur
int tls_get_ticket_from_client(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2176 __owur
int tls_use_ticket(SSL
*s
);
2178 __owur
int tls12_get_sigandhash(SSL
*s
, WPACKET
*pkt
, const EVP_PKEY
*pk
,
2179 const EVP_MD
*md
, int *ispss
);
2180 __owur
const EVP_MD
*tls12_get_hash(int hash_nid
);
2181 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL
*s
, int op
);
2183 __owur
int tls1_set_sigalgs_list(CERT
*c
, const char *str
, int client
);
2184 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2186 int tls1_check_chain(SSL
*s
, X509
*x
, EVP_PKEY
*pk
, STACK_OF(X509
) *chain
,
2188 void tls1_set_cert_validity(SSL
*s
);
2190 # ifndef OPENSSL_NO_CT
2191 __owur
int ssl_validate_ct(SSL
*s
);
2194 # ifndef OPENSSL_NO_DH
2195 __owur DH
*ssl_get_auto_dh(SSL
*s
);
2198 __owur
int ssl_security_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
, int is_ee
);
2199 __owur
int ssl_security_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
, X509
*ex
,
2202 __owur EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
);
2203 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
);
2204 __owur
long ssl_get_algorithm2(SSL
*s
);
2205 __owur
int tls12_copy_sigalgs(SSL
*s
, WPACKET
*pkt
,
2206 const unsigned int *psig
, size_t psiglen
);
2207 __owur
int tls1_save_sigalgs(SSL
*s
, PACKET
*pkt
);
2208 __owur
int tls1_process_sigalgs(SSL
*s
);
2209 __owur
size_t tls12_get_psigalgs(SSL
*s
, int sent
, const unsigned int **psigs
);
2210 __owur
int tls12_check_peer_sigalg(const EVP_MD
**pmd
, SSL
*s
, unsigned int sig
,
2212 void ssl_set_client_disabled(SSL
*s
);
2213 __owur
int ssl_cipher_disabled(SSL
*s
, const SSL_CIPHER
*c
, int op
);
2215 __owur
int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
2217 __owur
const EVP_MD
*ssl_md(int idx
);
2218 __owur
const EVP_MD
*ssl_handshake_md(SSL
*s
);
2219 __owur
const EVP_MD
*ssl_prf_md(SSL
*s
);
2222 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2223 * with |ssl|, if logging is enabled. It returns one on success and zero on
2224 * failure. The entry is identified by the first 8 bytes of
2225 * |encrypted_premaster|.
2227 __owur
int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
2228 const uint8_t *encrypted_premaster
,
2229 size_t encrypted_premaster_len
,
2230 const uint8_t *premaster
,
2231 size_t premaster_len
);
2233 /* ssl_log_master_secret logs |master| to the SSL_CTX associated with |ssl|, if
2234 * logging is enabled. It returns one on success and zero on failure. The entry
2235 * is identified by |client_random|.
2237 __owur
int ssl_log_master_secret(SSL
*ssl
, const uint8_t *client_random
,
2238 size_t client_random_len
,
2239 const uint8_t *master
, size_t master_len
);
2242 __owur
char ssl3_cbc_record_digest_supported(const EVP_MD_CTX
*ctx
);
2243 __owur
int ssl3_cbc_digest_record(const EVP_MD_CTX
*ctx
,
2244 unsigned char *md_out
,
2245 size_t *md_out_size
,
2246 const unsigned char header
[13],
2247 const unsigned char *data
,
2248 size_t data_plus_mac_size
,
2249 size_t data_plus_mac_plus_padding_size
,
2250 const unsigned char *mac_secret
,
2251 size_t mac_secret_length
, char is_sslv3
);
2253 __owur
int tls_fips_digest_extra(const EVP_CIPHER_CTX
*cipher_ctx
,
2254 EVP_MD_CTX
*mac_ctx
, const unsigned char *data
,
2255 size_t data_len
, size_t orig_len
);
2257 __owur
int srp_generate_server_master_secret(SSL
*s
);
2258 __owur
int srp_generate_client_master_secret(SSL
*s
);
2259 __owur
int srp_verify_server_param(SSL
*s
, int *al
);
2263 void custom_ext_init(custom_ext_methods
*meths
);
2265 __owur
int custom_ext_parse(SSL
*s
, int server
,
2266 unsigned int ext_type
,
2267 const unsigned char *ext_data
, size_t ext_size
,
2269 __owur
int custom_ext_add(SSL
*s
, int server
, WPACKET
*pkt
, int *al
);
2271 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2272 const custom_ext_methods
*src
);
2273 void custom_exts_free(custom_ext_methods
*exts
);
2275 void ssl_comp_free_compression_methods_int(void);
2279 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2280 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers