2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4 * Copyright 2005 Nokia. All rights reserved.
6 * Licensed under the OpenSSL license (the "License"). You may not use
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
12 #ifndef HEADER_SSL_LOCL_H
13 # define HEADER_SSL_LOCL_H
20 # if defined(__unix) || defined(__unix__)
21 # include <sys/time.h> /* struct timeval for DTLS */
24 # include <openssl/buffer.h>
25 # include <openssl/comp.h>
26 # include <openssl/bio.h>
27 # include <openssl/stack.h>
28 # include <openssl/rsa.h>
29 # include <openssl/dsa.h>
30 # include <openssl/err.h>
31 # include <openssl/ssl.h>
32 # include <openssl/async.h>
33 # include <openssl/symhacks.h>
34 # include <openssl/ct.h>
35 # include "record/record.h"
36 # include "statem/statem.h"
37 # include "packet_locl.h"
38 # include "internal/dane.h"
39 # include "internal/refcount.h"
41 # ifdef OPENSSL_BUILD_SHLIBSSL
42 # undef OPENSSL_EXTERN
43 # define OPENSSL_EXTERN OPENSSL_EXPORT
46 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
47 l|=(((unsigned long)(*((c)++)))<< 8), \
48 l|=(((unsigned long)(*((c)++)))<<16), \
49 l|=(((unsigned long)(*((c)++)))<<24))
51 /* NOTE - c is not incremented as per c2l */
52 # define c2ln(c,l1,l2,n) { \
56 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
57 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
58 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
59 case 5: l2|=((unsigned long)(*(--(c)))); \
60 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
61 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
62 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
63 case 1: l1|=((unsigned long)(*(--(c)))); \
67 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
68 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
69 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
70 *((c)++)=(unsigned char)(((l)>>24)&0xff))
72 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
73 l|=((unsigned long)(*((c)++)))<<16, \
74 l|=((unsigned long)(*((c)++)))<< 8, \
75 l|=((unsigned long)(*((c)++))))
77 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
78 l|=((uint64_t)(*((c)++)))<<48, \
79 l|=((uint64_t)(*((c)++)))<<40, \
80 l|=((uint64_t)(*((c)++)))<<32, \
81 l|=((uint64_t)(*((c)++)))<<24, \
82 l|=((uint64_t)(*((c)++)))<<16, \
83 l|=((uint64_t)(*((c)++)))<< 8, \
84 l|=((uint64_t)(*((c)++))))
87 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
88 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
89 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
90 *((c)++)=(unsigned char)(((l) )&0xff))
92 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
93 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
94 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
95 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
96 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
97 *((c)++)=(unsigned char)(((l) )&0xff))
99 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
101 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
102 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
103 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
104 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
105 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
106 *((c)++)=(unsigned char)(((l) )&0xff))
108 /* NOTE - c is not incremented as per l2c */
109 # define l2cn(l1,l2,c,n) { \
112 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
113 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
114 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
115 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
116 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
117 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
118 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
119 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
123 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
124 (((unsigned int)((c)[1])) )),(c)+=2)
125 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
126 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
128 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
129 (((unsigned long)((c)[1]))<< 8)| \
130 (((unsigned long)((c)[2])) )),(c)+=3)
132 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
133 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
134 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
137 * DTLS version numbers are strange because they're inverted. Except for
138 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
140 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
141 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
142 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
143 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
144 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
148 * Define the Bitmasks for SSL_CIPHER.algorithms.
149 * This bits are used packed as dense as possible. If new methods/ciphers
150 * etc will be added, the bits a likely to change, so this information
151 * is for internal library use only, even though SSL_CIPHER.algorithms
152 * can be publicly accessed.
153 * Use the according functions for cipher management instead.
155 * The bit mask handling in the selection and sorting scheme in
156 * ssl_create_cipher_list() has only limited capabilities, reflecting
157 * that the different entities within are mutually exclusive:
158 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
161 /* Bits for algorithm_mkey (key exchange algorithm) */
162 /* RSA key exchange */
163 # define SSL_kRSA 0x00000001U
164 /* tmp DH key no DH cert */
165 # define SSL_kDHE 0x00000002U
167 # define SSL_kEDH SSL_kDHE
169 # define SSL_kECDHE 0x00000004U
171 # define SSL_kEECDH SSL_kECDHE
173 # define SSL_kPSK 0x00000008U
174 /* GOST key exchange */
175 # define SSL_kGOST 0x00000010U
177 # define SSL_kSRP 0x00000020U
179 # define SSL_kRSAPSK 0x00000040U
180 # define SSL_kECDHEPSK 0x00000080U
181 # define SSL_kDHEPSK 0x00000100U
185 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
187 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
188 # define SSL_kANY 0x00000000U
190 /* Bits for algorithm_auth (server authentication) */
192 # define SSL_aRSA 0x00000001U
194 # define SSL_aDSS 0x00000002U
195 /* no auth (i.e. use ADH or AECDH) */
196 # define SSL_aNULL 0x00000004U
198 # define SSL_aECDSA 0x00000008U
200 # define SSL_aPSK 0x00000010U
201 /* GOST R 34.10-2001 signature auth */
202 # define SSL_aGOST01 0x00000020U
204 # define SSL_aSRP 0x00000040U
205 /* GOST R 34.10-2012 signature auth */
206 # define SSL_aGOST12 0x00000080U
207 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
208 # define SSL_aANY 0x00000000U
209 /* All bits requiring a certificate */
211 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
213 /* Bits for algorithm_enc (symmetric encryption) */
214 # define SSL_DES 0x00000001U
215 # define SSL_3DES 0x00000002U
216 # define SSL_RC4 0x00000004U
217 # define SSL_RC2 0x00000008U
218 # define SSL_IDEA 0x00000010U
219 # define SSL_eNULL 0x00000020U
220 # define SSL_AES128 0x00000040U
221 # define SSL_AES256 0x00000080U
222 # define SSL_CAMELLIA128 0x00000100U
223 # define SSL_CAMELLIA256 0x00000200U
224 # define SSL_eGOST2814789CNT 0x00000400U
225 # define SSL_SEED 0x00000800U
226 # define SSL_AES128GCM 0x00001000U
227 # define SSL_AES256GCM 0x00002000U
228 # define SSL_AES128CCM 0x00004000U
229 # define SSL_AES256CCM 0x00008000U
230 # define SSL_AES128CCM8 0x00010000U
231 # define SSL_AES256CCM8 0x00020000U
232 # define SSL_eGOST2814789CNT12 0x00040000U
233 # define SSL_CHACHA20POLY1305 0x00080000U
235 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
236 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
237 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
238 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
239 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
241 /* Bits for algorithm_mac (symmetric authentication) */
243 # define SSL_MD5 0x00000001U
244 # define SSL_SHA1 0x00000002U
245 # define SSL_GOST94 0x00000004U
246 # define SSL_GOST89MAC 0x00000008U
247 # define SSL_SHA256 0x00000010U
248 # define SSL_SHA384 0x00000020U
249 /* Not a real MAC, just an indication it is part of cipher */
250 # define SSL_AEAD 0x00000040U
251 # define SSL_GOST12_256 0x00000080U
252 # define SSL_GOST89MAC12 0x00000100U
253 # define SSL_GOST12_512 0x00000200U
256 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
257 * sure to update this constant too
260 # define SSL_MD_MD5_IDX 0
261 # define SSL_MD_SHA1_IDX 1
262 # define SSL_MD_GOST94_IDX 2
263 # define SSL_MD_GOST89MAC_IDX 3
264 # define SSL_MD_SHA256_IDX 4
265 # define SSL_MD_SHA384_IDX 5
266 # define SSL_MD_GOST12_256_IDX 6
267 # define SSL_MD_GOST89MAC12_IDX 7
268 # define SSL_MD_GOST12_512_IDX 8
269 # define SSL_MD_MD5_SHA1_IDX 9
270 # define SSL_MD_SHA224_IDX 10
271 # define SSL_MD_SHA512_IDX 11
272 # define SSL_MAX_DIGEST 12
274 /* Bits for algorithm2 (handshake digests and other extra flags) */
276 /* Bits 0-7 are handshake MAC */
277 # define SSL_HANDSHAKE_MAC_MASK 0xFF
278 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
279 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
280 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
281 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
282 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
283 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
284 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
286 /* Bits 8-15 bits are PRF */
287 # define TLS1_PRF_DGST_SHIFT 8
288 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
289 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
290 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
291 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
292 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
293 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
294 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
297 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
298 * goes into algorithm2)
300 # define TLS1_STREAM_MAC 0x10000
302 # define SSL_STRONG_MASK 0x0000001FU
303 # define SSL_DEFAULT_MASK 0X00000020U
305 # define SSL_STRONG_NONE 0x00000001U
306 # define SSL_LOW 0x00000002U
307 # define SSL_MEDIUM 0x00000004U
308 # define SSL_HIGH 0x00000008U
309 # define SSL_FIPS 0x00000010U
310 # define SSL_NOT_DEFAULT 0x00000020U
312 /* we have used 0000003f - 26 bits left to go */
314 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
315 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
317 /* Check if an SSL structure is using DTLS */
318 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
320 /* Check if we are using TLSv1.3 */
321 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
322 && (s)->method->version >= TLS1_3_VERSION \
323 && (s)->method->version != TLS_ANY_VERSION)
325 # define SSL_TREAT_AS_TLS13(s) \
326 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
327 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY)
329 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
331 /* See if we need explicit IV */
332 # define SSL_USE_EXPLICIT_IV(s) \
333 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
335 * See if we use signature algorithms extension and signature algorithm
338 # define SSL_USE_SIGALGS(s) \
339 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
341 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
342 * apply to others in future.
344 # define SSL_USE_TLS1_2_CIPHERS(s) \
345 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
347 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
348 * flags because it may not be set to correct version yet.
350 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
351 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
352 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
354 * Determine if a client should send signature algorithms extension:
355 * as with TLS1.2 cipher we can't rely on method flags.
357 # define SSL_CLIENT_USE_SIGALGS(s) \
358 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
360 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
361 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
363 /* Mostly for SSLv3 */
364 # define SSL_PKEY_RSA 0
365 # define SSL_PKEY_DSA_SIGN 1
366 # define SSL_PKEY_ECC 2
367 # define SSL_PKEY_GOST01 3
368 # define SSL_PKEY_GOST12_256 4
369 # define SSL_PKEY_GOST12_512 5
370 # define SSL_PKEY_ED25519 6
371 # define SSL_PKEY_NUM 7
373 * Pseudo-constant. GOST cipher suites can use different certs for 1
374 * SSL_CIPHER. So let's see which one we have in fact.
376 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
379 * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
382 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
385 * SSL_kRSA <- RSA_ENC
386 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
387 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
388 * SSL_aRSA <- RSA_ENC | RSA_SIGN
389 * SSL_aDSS <- DSA_SIGN
393 #define CERT_INVALID 0
394 #define CERT_PUBLIC_KEY 1
395 #define CERT_PRIVATE_KEY 2
398 /* CipherSuite length. SSLv3 and all TLS versions. */
399 # define TLS_CIPHER_LEN 2
400 /* used to hold info on the particular ciphers used */
401 struct ssl_cipher_st
{
403 const char *name
; /* text name */
404 uint32_t id
; /* id, 4 bytes, first is version */
406 * changed in 1.0.0: these four used to be portions of a single value
409 uint32_t algorithm_mkey
; /* key exchange algorithm */
410 uint32_t algorithm_auth
; /* server authentication */
411 uint32_t algorithm_enc
; /* symmetric encryption */
412 uint32_t algorithm_mac
; /* symmetric authentication */
413 int min_tls
; /* minimum SSL/TLS protocol version */
414 int max_tls
; /* maximum SSL/TLS protocol version */
415 int min_dtls
; /* minimum DTLS protocol version */
416 int max_dtls
; /* maximum DTLS protocol version */
417 uint32_t algo_strength
; /* strength and export flags */
418 uint32_t algorithm2
; /* Extra flags */
419 int32_t strength_bits
; /* Number of bits really used */
420 uint32_t alg_bits
; /* Number of bits for algorithm */
423 /* Used to hold SSL/TLS functions */
424 struct ssl_method_st
{
428 int (*ssl_new
) (SSL
*s
);
429 int (*ssl_clear
) (SSL
*s
);
430 void (*ssl_free
) (SSL
*s
);
431 int (*ssl_accept
) (SSL
*s
);
432 int (*ssl_connect
) (SSL
*s
);
433 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
434 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
435 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
436 int (*ssl_shutdown
) (SSL
*s
);
437 int (*ssl_renegotiate
) (SSL
*s
);
438 int (*ssl_renegotiate_check
) (SSL
*s
, int);
439 int (*ssl_read_bytes
) (SSL
*s
, int type
, int *recvd_type
,
440 unsigned char *buf
, size_t len
, int peek
,
442 int (*ssl_write_bytes
) (SSL
*s
, int type
, const void *buf_
, size_t len
,
444 int (*ssl_dispatch_alert
) (SSL
*s
);
445 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
446 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
447 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
448 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
450 size_t (*ssl_pending
) (const SSL
*s
);
451 int (*num_ciphers
) (void);
452 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
453 long (*get_timeout
) (void);
454 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
455 int (*ssl_version
) (void);
456 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
457 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
461 * Lets make this into an ASN.1 type structure as follows
462 * SSL_SESSION_ID ::= SEQUENCE {
463 * version INTEGER, -- structure version number
464 * SSLversion INTEGER, -- SSL version number
465 * Cipher OCTET STRING, -- the 3 byte cipher ID
466 * Session_ID OCTET STRING, -- the Session ID
467 * Master_key OCTET STRING, -- the master key
468 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
469 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
470 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
471 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
472 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
473 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
474 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
475 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
476 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
477 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
478 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
479 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
480 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
481 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
483 * Look in ssl/ssl_asn1.c for more details
484 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
486 struct ssl_session_st
{
487 int ssl_version
; /* what ssl version session info is being kept
489 size_t master_key_length
;
491 /* TLSv1.3 early_secret used for external PSKs */
492 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
494 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
497 unsigned char master_key
[TLS13_MAX_RESUMPTION_MASTER_LENGTH
];
498 /* session_id - valid? */
499 size_t session_id_length
;
500 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
502 * this is used to determine whether the session is being reused in the
503 * appropriate context. It is up to the application to set this, via
506 size_t sid_ctx_length
;
507 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
508 # ifndef OPENSSL_NO_PSK
509 char *psk_identity_hint
;
513 * Used to indicate that session resumption is not allowed. Applications
514 * can also set this bit for a new session via not_resumable_session_cb
515 * to disable session caching and tickets.
518 /* This is the cert and type for the other end. */
521 /* Certificate chain peer sent. */
522 STACK_OF(X509
) *peer_chain
;
524 * when app_verify_callback accepts a session where the peer's
525 * certificate is not ok, we must remember the error for session reuse:
527 long verify_result
; /* only for servers */
528 CRYPTO_REF_COUNT references
;
531 unsigned int compress_meth
; /* Need to lookup the method */
532 const SSL_CIPHER
*cipher
;
533 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
534 * load the 'cipher' structure */
535 STACK_OF(SSL_CIPHER
) *ciphers
; /* shared ciphers? */
536 CRYPTO_EX_DATA ex_data
; /* application specific data */
538 * These are used to make removal of session-ids more efficient and to
539 * implement a maximum cache size.
541 struct ssl_session_st
*prev
, *next
;
545 # ifndef OPENSSL_NO_EC
546 size_t ecpointformats_len
;
547 unsigned char *ecpointformats
; /* peer's list */
548 size_t supportedgroups_len
;
549 unsigned char *supportedgroups
; /* peer's list */
550 # endif /* OPENSSL_NO_EC */
552 unsigned char *tick
; /* Session ticket */
553 size_t ticklen
; /* Session ticket length */
554 /* Session lifetime hint in seconds */
555 unsigned long tick_lifetime_hint
;
556 uint32_t tick_age_add
;
557 unsigned char *tick_nonce
;
558 size_t tick_nonce_len
;
560 /* Max number of bytes that can be sent as early data */
561 uint32_t max_early_data
;
562 /* The ALPN protocol selected for this session */
563 unsigned char *alpn_selected
;
564 size_t alpn_selected_len
;
566 # ifndef OPENSSL_NO_SRP
573 /* Extended master secret support */
574 # define SSL_SESS_FLAG_EXTMS 0x1
576 # ifndef OPENSSL_NO_SRP
578 typedef struct srp_ctx_st
{
579 /* param for all the callbacks */
581 /* set client Hello login callback */
582 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
583 /* set SRP N/g param callback for verification */
584 int (*SRP_verify_param_callback
) (SSL
*, void *);
585 /* set SRP client passwd callback */
586 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
588 BIGNUM
*N
, *g
, *s
, *B
, *A
;
592 unsigned long srp_Mask
;
598 SSL_EARLY_DATA_NONE
= 0,
599 SSL_EARLY_DATA_CONNECT_RETRY
,
600 SSL_EARLY_DATA_CONNECTING
,
601 SSL_EARLY_DATA_WRITE_RETRY
,
602 SSL_EARLY_DATA_WRITING
,
603 SSL_EARLY_DATA_UNAUTH_WRITING
,
604 SSL_EARLY_DATA_FINISHED_WRITING
,
605 SSL_EARLY_DATA_ACCEPT_RETRY
,
606 SSL_EARLY_DATA_ACCEPTING
,
607 SSL_EARLY_DATA_READ_RETRY
,
608 SSL_EARLY_DATA_READING
,
609 SSL_EARLY_DATA_FINISHED_READING
610 } SSL_EARLY_DATA_STATE
;
613 * We check that the amount of unreadable early data doesn't exceed
614 * max_early_data. max_early_data is given in plaintext bytes. However if it is
615 * unreadable then we only know the number of ciphertext bytes. We also don't
616 * know how much the overhead should be because it depends on the ciphersuite.
617 * We make a small allowance. We assume 5 records of actual data plus the end
618 * of early data alert record. Each record has a tag and a content type byte.
619 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
620 * content of the alert record either which is 2 bytes.
622 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
625 * The allowance we have between the client's calculated ticket age and our own.
626 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
627 * client's age calculation is different by more than this than our own then we
628 * do not allow that ticket for early_data.
630 # define TICKET_AGE_ALLOWANCE (10 * 1000)
632 #define MAX_COMPRESSIONS_SIZE 255
640 typedef struct raw_extension_st
{
641 /* Raw packet data for the extension */
643 /* Set to 1 if the extension is present or 0 otherwise */
645 /* Set to 1 if we have already parsed the extension or 0 otherwise */
647 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
649 /* Track what order extensions are received in (0-based). */
650 size_t received_order
;
655 unsigned int legacy_version
;
656 unsigned char random
[SSL3_RANDOM_SIZE
];
657 size_t session_id_len
;
658 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
659 size_t dtls_cookie_len
;
660 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
662 size_t compressions_len
;
663 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
665 size_t pre_proc_exts_len
;
666 RAW_EXTENSION
*pre_proc_exts
;
670 * Extension index values NOTE: Any updates to these defines should be mirrored
671 * with equivalent updates to ext_defs in extensions.c
673 typedef enum tlsext_index_en
{
674 TLSEXT_IDX_renegotiate
,
675 TLSEXT_IDX_server_name
,
677 TLSEXT_IDX_ec_point_formats
,
678 TLSEXT_IDX_supported_groups
,
679 TLSEXT_IDX_session_ticket
,
680 TLSEXT_IDX_signature_algorithms
,
681 TLSEXT_IDX_status_request
,
682 TLSEXT_IDX_next_proto_neg
,
683 TLSEXT_IDX_application_layer_protocol_negotiation
,
685 TLSEXT_IDX_encrypt_then_mac
,
686 TLSEXT_IDX_signed_certificate_timestamp
,
687 TLSEXT_IDX_extended_master_secret
,
688 TLSEXT_IDX_supported_versions
,
689 TLSEXT_IDX_psk_kex_modes
,
690 TLSEXT_IDX_key_share
,
692 TLSEXT_IDX_cryptopro_bug
,
693 TLSEXT_IDX_early_data
,
694 TLSEXT_IDX_certificate_authorities
,
697 /* Dummy index - must always be the last entry */
698 TLSEXT_IDX_num_builtins
701 DEFINE_LHASH_OF(SSL_SESSION
);
702 /* Needed in ssl_cert.c */
703 DEFINE_LHASH_OF(X509_NAME
);
705 # define TLSEXT_KEYNAME_LENGTH 16
708 const SSL_METHOD
*method
;
709 STACK_OF(SSL_CIPHER
) *cipher_list
;
710 /* same as above but sorted for lookup */
711 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
712 struct x509_store_st
/* X509_STORE */ *cert_store
;
713 LHASH_OF(SSL_SESSION
) *sessions
;
715 * Most session-ids that will be cached, default is
716 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
718 size_t session_cache_size
;
719 struct ssl_session_st
*session_cache_head
;
720 struct ssl_session_st
*session_cache_tail
;
722 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
723 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
724 * means only SSL_accept which cache SSL_SESSIONS.
726 uint32_t session_cache_mode
;
728 * If timeout is not 0, it is the default timeout value set when
729 * SSL_new() is called. This has been put in to make life easier to set
732 long session_timeout
;
734 * If this callback is not null, it will be called each time a session id
735 * is added to the cache. If this function returns 1, it means that the
736 * callback will do a SSL_SESSION_free() when it has finished using it.
737 * Otherwise, on 0, it means the callback has finished with it. If
738 * remove_session_cb is not null, it will be called when a session-id is
739 * removed from the cache. After the call, OpenSSL will
740 * SSL_SESSION_free() it.
742 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
743 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
744 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
745 const unsigned char *data
, int len
,
748 int sess_connect
; /* SSL new conn - started */
749 int sess_connect_renegotiate
; /* SSL reneg - requested */
750 int sess_connect_good
; /* SSL new conne/reneg - finished */
751 int sess_accept
; /* SSL new accept - started */
752 int sess_accept_renegotiate
; /* SSL reneg - requested */
753 int sess_accept_good
; /* SSL accept/reneg - finished */
754 int sess_miss
; /* session lookup misses */
755 int sess_timeout
; /* reuse attempt on timeouted session */
756 int sess_cache_full
; /* session removed due to full cache */
757 int sess_hit
; /* session reuse actually done */
758 int sess_cb_hit
; /* session-id that was not in the cache was
759 * passed back via the callback. This
760 * indicates that the application is supplying
761 * session-id's from other processes - spooky
765 CRYPTO_REF_COUNT references
;
767 /* if defined, these override the X509_verify_cert() calls */
768 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
769 void *app_verify_arg
;
771 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
772 * ('app_verify_callback' was called with just one argument)
775 /* Default password callback. */
776 pem_password_cb
*default_passwd_callback
;
778 /* Default password callback user data. */
779 void *default_passwd_callback_userdata
;
781 /* get client cert callback */
782 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
784 /* cookie generate callback */
785 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
786 unsigned int *cookie_len
);
788 /* verify cookie callback */
789 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
790 unsigned int cookie_len
);
792 CRYPTO_EX_DATA ex_data
;
794 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
795 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3->sha1' */
797 STACK_OF(X509
) *extra_certs
;
798 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
800 /* Default values used when no per-SSL value is defined follow */
802 /* used if SSL's info_callback is NULL */
803 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
806 * What we put in certificate_authorities extension for TLS 1.3
807 * (ClientHello and CertificateRequest) or just client cert requests for
810 STACK_OF(X509_NAME
) *ca_names
;
813 * Default values to use in SSL structures follow (these are copied by
819 int min_proto_version
;
820 int max_proto_version
;
821 size_t max_cert_list
;
823 struct cert_st
/* CERT */ *cert
;
826 /* callback that allows applications to peek at protocol messages */
827 void (*msg_callback
) (int write_p
, int version
, int content_type
,
828 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
829 void *msg_callback_arg
;
831 uint32_t verify_mode
;
832 size_t sid_ctx_length
;
833 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
834 /* called 'verify_callback' in the SSL */
835 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
837 /* Default generate session ID callback. */
838 GEN_SESSION_CB generate_session_id
;
840 X509_VERIFY_PARAM
*param
;
844 # ifndef OPENSSL_NO_CT
845 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
847 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
848 * If they are not, the connection should be aborted.
850 ssl_ct_validation_cb ct_validation_callback
;
851 void *ct_validation_callback_arg
;
855 * If we're using more than one pipeline how should we divide the data
856 * up between the pipes?
858 size_t split_send_fragment
;
860 * Maximum amount of data to send in one fragment. actual record size can
861 * be more than this due to padding and MAC overheads.
863 size_t max_send_fragment
;
865 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
866 size_t max_pipelines
;
868 /* The default read buffer length to use (0 means not set) */
869 size_t default_read_buf_len
;
871 # ifndef OPENSSL_NO_ENGINE
873 * Engine to pass requests for client certs to
875 ENGINE
*client_cert_engine
;
878 /* Early callback. Mostly for extensions, but not entirely. */
879 SSL_early_cb_fn early_cb
;
882 /* TLS extensions. */
884 /* TLS extensions servername callback */
885 int (*servername_cb
) (SSL
*, int *, void *);
886 void *servername_arg
;
887 /* RFC 4507 session ticket keys */
888 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
889 unsigned char tick_hmac_key
[32];
890 unsigned char tick_aes_key
[32];
891 /* Callback to support customisation of ticket key setting */
892 int (*ticket_key_cb
) (SSL
*ssl
,
893 unsigned char *name
, unsigned char *iv
,
894 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
896 /* certificate status request info */
897 /* Callback for status request */
898 int (*status_cb
) (SSL
*ssl
, void *arg
);
900 /* ext status type used for CSR extension (OCSP Stapling) */
903 # ifndef OPENSSL_NO_EC
904 /* EC extension values inherited by SSL structure */
905 size_t ecpointformats_len
;
906 unsigned char *ecpointformats
;
907 size_t supportedgroups_len
;
908 unsigned char *supportedgroups
;
909 # endif /* OPENSSL_NO_EC */
912 * ALPN information (we are in the process of transitioning from NPN to
917 * For a server, this contains a callback function that allows the
918 * server to select the protocol for the connection.
919 * out: on successful return, this must point to the raw protocol
920 * name (without the length prefix).
921 * outlen: on successful return, this contains the length of |*out|.
922 * in: points to the client's list of supported protocols in
924 * inlen: the length of |in|.
926 int (*alpn_select_cb
) (SSL
*s
,
927 const unsigned char **out
,
928 unsigned char *outlen
,
929 const unsigned char *in
,
930 unsigned int inlen
, void *arg
);
931 void *alpn_select_cb_arg
;
934 * For a client, this contains the list of supported protocols in wire
940 # ifndef OPENSSL_NO_NEXTPROTONEG
941 /* Next protocol negotiation information */
944 * For a server, this contains a callback function by which the set of
945 * advertised protocols can be provided.
947 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
948 void *npn_advertised_cb_arg
;
950 * For a client, this contains a callback function that selects the next
951 * protocol from the list provided by the server.
953 SSL_CTX_npn_select_cb_func npn_select_cb
;
954 void *npn_select_cb_arg
;
958 # ifndef OPENSSL_NO_PSK
959 SSL_psk_client_cb_func psk_client_callback
;
960 SSL_psk_server_cb_func psk_server_callback
;
962 SSL_psk_find_session_cb_func psk_find_session_cb
;
963 SSL_psk_use_session_cb_func psk_use_session_cb
;
965 # ifndef OPENSSL_NO_SRP
966 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
969 /* Shared DANE context */
970 struct dane_ctx_st dane
;
972 /* SRTP profiles we are willing to do from RFC 5764 */
973 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
975 * Callback for disabling session caching and ticket support on a session
976 * basis, depending on the chosen cipher.
978 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
983 * Callback for logging key material for use with debugging tools like
984 * Wireshark. The callback should log `line` followed by a newline.
986 SSL_CTX_keylog_cb_func keylog_callback
;
988 /* The maximum number of bytes that can be sent as early data */
989 uint32_t max_early_data
;
991 /* TLS1.3 padding callback */
992 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
993 void *record_padding_arg
;
994 size_t block_padding
;
999 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1004 const SSL_METHOD
*method
;
1006 * There are 2 BIO's even though they are normally both the same. This
1007 * is so data can be read and written to different handlers
1009 /* used by SSL_read */
1011 /* used by SSL_write */
1013 /* used during session-id reuse to concatenate messages */
1016 * This holds a variable that indicates what we were doing when a 0 or -1
1017 * is returned. This is needed for non-blocking IO so we know what
1018 * request needs re-doing when in SSL_accept or SSL_connect
1021 int (*handshake_func
) (SSL
*);
1023 * Imagine that here's a boolean member "init" that is switched as soon
1024 * as SSL_set_{accept/connect}_state is called for the first time, so
1025 * that "state" and "handshake_func" are properly initialized. But as
1026 * handshake_func is == 0 until then, we use this test instead of an
1029 /* are we the server side? */
1032 * Generate a new session or reuse an old one.
1033 * NB: For servers, the 'new' session may actually be a previously
1034 * cached session or even the previous session unless
1035 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1038 /* don't send shutdown packets */
1040 /* we have shut things down, 0x01 sent, 0x02 for received */
1044 SSL_EARLY_DATA_STATE early_data_state
;
1045 BUF_MEM
*init_buf
; /* buffer used during init */
1046 void *init_msg
; /* pointer to handshake message body, set by
1047 * ssl3_get_message() */
1048 size_t init_num
; /* amount read/written */
1049 size_t init_off
; /* amount read/written */
1050 struct ssl3_state_st
*s3
; /* SSLv3 variables */
1051 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
1052 /* callback that allows applications to peek at protocol messages */
1053 void (*msg_callback
) (int write_p
, int version
, int content_type
,
1054 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
1055 void *msg_callback_arg
;
1056 int hit
; /* reusing a previous session */
1057 X509_VERIFY_PARAM
*param
;
1058 /* Per connection DANE state */
1061 STACK_OF(SSL_CIPHER
) *cipher_list
;
1062 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
1064 * These are the ones being used, the ones in SSL_SESSION are the ones to
1065 * be 'copied' into these ones
1069 * The TLS1.3 secrets. The resumption master secret is stored in the
1072 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
1073 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
1074 unsigned char master_secret
[EVP_MAX_MD_SIZE
];
1075 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
1076 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
1077 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
1078 unsigned char handshake_traffic_hash
[EVP_MAX_MD_SIZE
];
1079 unsigned char client_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1080 unsigned char server_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1081 unsigned char exporter_master_secret
[EVP_MAX_MD_SIZE
];
1082 EVP_CIPHER_CTX
*enc_read_ctx
; /* cryptographic state */
1083 unsigned char read_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static read IV */
1084 EVP_MD_CTX
*read_hash
; /* used for mac generation */
1085 COMP_CTX
*compress
; /* compression */
1086 COMP_CTX
*expand
; /* uncompress */
1087 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1088 unsigned char write_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static write IV */
1089 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1090 /* Count of how many KeyUpdate messages we have received */
1091 unsigned int key_update_count
;
1094 /* This is used to hold the server certificate used */
1095 struct cert_st
/* CERT */ *cert
;
1098 * The hash of all messages prior to the CertificateVerify, and the length
1101 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
1102 size_t cert_verify_hash_len
;
1104 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1105 int hello_retry_request
;
1108 * the session_id_context is used to ensure sessions are only reused in
1109 * the appropriate context
1111 size_t sid_ctx_length
;
1112 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
1113 /* This can also be in the session once a session is established */
1114 SSL_SESSION
*session
;
1115 /* TLSv1.3 PSK session */
1116 SSL_SESSION
*psksession
;
1117 /* Default generate session ID callback. */
1118 GEN_SESSION_CB generate_session_id
;
1121 * 0 don't care about verify failure.
1122 * 1 fail if verify fails
1124 uint32_t verify_mode
;
1125 /* fail if callback returns 0 */
1126 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1127 /* optional informational callback */
1128 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1129 /* error bytes to be written */
1133 # ifndef OPENSSL_NO_PSK
1134 SSL_psk_client_cb_func psk_client_callback
;
1135 SSL_psk_server_cb_func psk_server_callback
;
1137 SSL_psk_find_session_cb_func psk_find_session_cb
;
1138 SSL_psk_use_session_cb_func psk_use_session_cb
;
1140 /* Verified chain of peer */
1141 STACK_OF(X509
) *verified_chain
;
1143 /* extra application data */
1144 CRYPTO_EX_DATA ex_data
;
1145 /* for server side, keep the list of CA_dn we can use */
1146 STACK_OF(X509_NAME
) *ca_names
;
1147 CRYPTO_REF_COUNT references
;
1148 /* protocol behaviour */
1152 int min_proto_version
;
1153 int max_proto_version
;
1154 size_t max_cert_list
;
1157 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1158 * secret and SSLv3/TLS (<=1.2) rollback check
1162 * If we're using more than one pipeline how should we divide the data
1163 * up between the pipes?
1165 size_t split_send_fragment
;
1167 * Maximum amount of data to send in one fragment. actual record size can
1168 * be more than this due to padding and MAC overheads.
1170 size_t max_send_fragment
;
1171 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1172 size_t max_pipelines
;
1175 /* Built-in extension flags */
1176 uint8_t extflags
[TLSEXT_IDX_num_builtins
];
1177 /* TLS extension debug callback */
1178 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1179 const unsigned char *data
, int len
, void *arg
);
1182 /* certificate status request info */
1183 /* Status type or -1 if no status type */
1185 /* Raw extension data, if seen */
1186 unsigned char *scts
;
1187 /* Length of raw extension data, if seen */
1189 /* Expect OCSP CertificateStatus message */
1190 int status_expected
;
1193 /* OCSP status request only */
1194 STACK_OF(OCSP_RESPID
) *ids
;
1195 X509_EXTENSIONS
*exts
;
1196 /* OCSP response received or to be sent */
1197 unsigned char *resp
;
1201 /* RFC4507 session ticket expected to be received or sent */
1202 int ticket_expected
;
1203 # ifndef OPENSSL_NO_EC
1204 size_t ecpointformats_len
;
1206 unsigned char *ecpointformats
;
1207 size_t supportedgroups_len
;
1209 unsigned char *supportedgroups
;
1210 # endif /* OPENSSL_NO_EC */
1211 /* TLS Session Ticket extension override */
1212 TLS_SESSION_TICKET_EXT
*session_ticket
;
1213 /* TLS Session Ticket extension callback */
1214 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1215 void *session_ticket_cb_arg
;
1216 /* TLS pre-shared secret session resumption */
1217 tls_session_secret_cb_fn session_secret_cb
;
1218 void *session_secret_cb_arg
;
1220 * For a client, this contains the list of supported protocols in wire
1223 unsigned char *alpn
;
1226 * Next protocol negotiation. For the client, this is the protocol that
1227 * we sent in NextProtocol and is set when handling ServerHello
1228 * extensions. For a server, this is the client's selected_protocol from
1229 * NextProtocol and is set when handling the NextProtocol message, before
1230 * the Finished message.
1235 /* The available PSK key exchange modes */
1238 /* Set to one if we have negotiated ETM */
1241 /* Are we expecting to receive early data? */
1243 /* Is the session suitable for early data? */
1246 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1247 unsigned char *tls13_cookie
;
1248 size_t tls13_cookie_len
;
1251 /* Parsed form of the ClientHello, kept around across early_cb calls. */
1252 CLIENTHELLO_MSG
*clienthello
;
1255 * no further mod of servername
1256 * 0 : call the servername extension callback.
1257 * 1 : prepare 2, allow last ack just after in server callback.
1258 * 2 : don't call servername callback, no ack in server hello
1260 int servername_done
;
1261 # ifndef OPENSSL_NO_CT
1263 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1264 * If they are not, the connection should be aborted.
1266 ssl_ct_validation_cb ct_validation_callback
;
1267 /* User-supplied argument that is passed to the ct_validation_callback */
1268 void *ct_validation_callback_arg
;
1270 * Consolidated stack of SCTs from all sources.
1271 * Lazily populated by CT_get_peer_scts(SSL*)
1273 STACK_OF(SCT
) *scts
;
1274 /* Have we attempted to find/parse SCTs yet? */
1277 SSL_CTX
*session_ctx
; /* initial ctx, used to store sessions */
1279 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1280 /* What's been chosen */
1281 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1283 * 1 if we are renegotiating.
1284 * 2 if we are a server and are inside a handshake
1285 * (i.e. not just sending a HelloRequest)
1288 /* If sending a KeyUpdate is pending */
1290 # ifndef OPENSSL_NO_SRP
1291 /* ctx for SRP authentication */
1295 * Callback for disabling session caching and ticket support on a session
1296 * basis, depending on the chosen cipher.
1298 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1299 RECORD_LAYER rlayer
;
1300 /* Default password callback. */
1301 pem_password_cb
*default_passwd_callback
;
1302 /* Default password callback user data. */
1303 void *default_passwd_callback_userdata
;
1304 /* Async Job info */
1306 ASYNC_WAIT_CTX
*waitctx
;
1309 /* The maximum number of plaintext bytes that can be sent as early data */
1310 uint32_t max_early_data
;
1312 * The number of bytes of early data received so far. If we accepted early
1313 * data then this is a count of the plaintext bytes. If we rejected it then
1314 * this is a count of the ciphertext bytes.
1316 uint32_t early_data_count
;
1318 /* TLS1.3 padding callback */
1319 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1320 void *record_padding_arg
;
1321 size_t block_padding
;
1323 CRYPTO_RWLOCK
*lock
;
1327 * Structure containing table entry of values associated with the signature
1328 * algorithms (signature scheme) extension
1330 typedef struct sigalg_lookup_st
{
1331 /* TLS 1.3 signature scheme name */
1333 /* Raw value used in extension */
1335 /* NID of hash algorithm or NID_undef if no hash */
1337 /* Index of hash algorithm or -1 if no hash algorithm */
1339 /* NID of signature algorithm */
1341 /* Index of signature algorithm */
1343 /* Combined hash and signature NID, if any */
1345 /* Required public key curve (ECDSA only) */
1349 typedef struct cert_pkey_st CERT_PKEY
;
1352 * Structure containing table entry of certificate info corresponding to
1356 int nid
; /* NID of pubic key algorithm */
1357 uint32_t amask
; /* authmask corresponding to key type */
1360 typedef struct ssl3_state_st
{
1362 size_t read_mac_secret_size
;
1363 unsigned char read_mac_secret
[EVP_MAX_MD_SIZE
];
1364 size_t write_mac_secret_size
;
1365 unsigned char write_mac_secret
[EVP_MAX_MD_SIZE
];
1366 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1367 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1368 /* flags for countermeasure against known-IV weakness */
1369 int need_empty_fragments
;
1370 int empty_fragment_done
;
1371 /* used during startup, digest all incoming/outgoing packets */
1372 BIO
*handshake_buffer
;
1374 * When handshake digest is determined, buffer is hashed and
1375 * freed and MD_CTX for the required digest is stored here.
1377 EVP_MD_CTX
*handshake_dgst
;
1379 * Set whenever an expected ChangeCipherSpec message is processed.
1380 * Unset when the peer's Finished message is received.
1381 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1383 int change_cipher_spec
;
1387 * we allow one fatal and one warning alert to be outstanding, send close
1388 * alert via the warning alert
1391 unsigned char send_alert
[2];
1393 * This flag is set when we should renegotiate ASAP, basically when there
1394 * is no more data in the read or write buffers
1397 int total_renegotiations
;
1398 int num_renegotiations
;
1399 int in_read_app_data
;
1401 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1402 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1403 size_t finish_md_len
;
1404 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1405 size_t peer_finish_md_len
;
1406 size_t message_size
;
1408 /* used to hold the new cipher we are going to use */
1409 const SSL_CIPHER
*new_cipher
;
1410 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1411 EVP_PKEY
*pkey
; /* holds short lived DH/ECDH key */
1413 /* used for certificate requests */
1415 /* Certificate types in certificate request message. */
1418 /* Certificate authorities list peer sent */
1419 STACK_OF(X509_NAME
) *peer_ca_names
;
1420 size_t key_block_length
;
1421 unsigned char *key_block
;
1422 const EVP_CIPHER
*new_sym_enc
;
1423 const EVP_MD
*new_hash
;
1424 int new_mac_pkey_type
;
1425 size_t new_mac_secret_size
;
1426 # ifndef OPENSSL_NO_COMP
1427 const SSL_COMP
*new_compression
;
1429 char *new_compression
;
1432 /* Raw values of the cipher list from a client */
1433 unsigned char *ciphers_raw
;
1434 size_t ciphers_rawlen
;
1435 /* Temporary storage for premaster secret */
1438 # ifndef OPENSSL_NO_PSK
1439 /* Temporary storage for PSK key */
1443 /* Signature algorithm we actually use */
1444 const SIGALG_LOOKUP
*sigalg
;
1445 /* Pointer to certificate we use */
1448 * signature algorithms peer reports: e.g. supported signature
1449 * algorithms extension for server or as part of a certificate
1450 * request for client.
1452 uint16_t *peer_sigalgs
;
1453 /* Size of above array */
1454 size_t peer_sigalgslen
;
1455 /* Sigalg peer actualy uses */
1456 const SIGALG_LOOKUP
*peer_sigalg
;
1458 * Set if corresponding CERT_PKEY can be used with current
1459 * SSL session: e.g. appropriate curve, signature algorithms etc.
1460 * If zero it can't be used at all.
1462 uint32_t valid_flags
[SSL_PKEY_NUM
];
1464 * For servers the following masks are for the key and auth algorithms
1465 * that are supported by the certs below. For clients they are masks of
1466 * *disabled* algorithms based on the current session.
1471 * The following are used by the client to see if a cipher is allowed or
1472 * not. It contains the minimum and maximum version the client's using
1473 * based on what it knows so far.
1479 /* Connection binding to prevent renegotiation attacks */
1480 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1481 size_t previous_client_finished_len
;
1482 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1483 size_t previous_server_finished_len
;
1484 int send_connection_binding
; /* TODOEKR */
1486 # ifndef OPENSSL_NO_NEXTPROTONEG
1488 * Set if we saw the Next Protocol Negotiation extension from our peer.
1494 * ALPN information (we are in the process of transitioning from NPN to
1499 * In a server these point to the selected ALPN protocol after the
1500 * ClientHello has been processed. In a client these contain the protocol
1501 * that the server selected once the ServerHello has been processed.
1503 unsigned char *alpn_selected
;
1504 size_t alpn_selected_len
;
1505 /* used by the server to know what options were proposed */
1506 unsigned char *alpn_proposed
;
1507 size_t alpn_proposed_len
;
1508 /* used by the client to know if it actually sent alpn */
1511 # ifndef OPENSSL_NO_EC
1513 * This is set to true if we believe that this is a version of Safari
1514 * running on OS X 10.6 or newer. We wish to know this because Safari on
1515 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1517 char is_probably_safari
;
1518 # endif /* !OPENSSL_NO_EC */
1520 /* For clients: peer temporary key */
1521 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1522 /* The group_id for the DH/ECDH key */
1523 unsigned int group_id
;
1529 /* DTLS structures */
1531 # ifndef OPENSSL_NO_SCTP
1532 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1535 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1536 # define DTLS1_MAX_MTU_OVERHEAD 48
1539 * Flag used in message reuse to indicate the buffer contains the record
1540 * header as well as the the handshake message header.
1542 # define DTLS1_SKIP_RECORD_HEADER 2
1544 struct dtls1_retransmit_state
{
1545 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1546 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1547 COMP_CTX
*compress
; /* compression */
1548 SSL_SESSION
*session
;
1549 unsigned short epoch
;
1552 struct hm_header_st
{
1558 unsigned int is_ccs
;
1559 struct dtls1_retransmit_state saved_retransmit_state
;
1562 struct dtls1_timeout_st
{
1563 /* Number of read timeouts so far */
1564 unsigned int read_timeouts
;
1565 /* Number of write timeouts so far */
1566 unsigned int write_timeouts
;
1567 /* Number of alerts received so far */
1568 unsigned int num_alerts
;
1571 typedef struct hm_fragment_st
{
1572 struct hm_header_st msg_header
;
1573 unsigned char *fragment
;
1574 unsigned char *reassembly
;
1577 typedef struct pqueue_st pqueue
;
1578 typedef struct pitem_st pitem
;
1581 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1586 typedef struct pitem_st
*piterator
;
1588 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1589 void pitem_free(pitem
*item
);
1590 pqueue
*pqueue_new(void);
1591 void pqueue_free(pqueue
*pq
);
1592 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1593 pitem
*pqueue_peek(pqueue
*pq
);
1594 pitem
*pqueue_pop(pqueue
*pq
);
1595 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1596 pitem
*pqueue_iterator(pqueue
*pq
);
1597 pitem
*pqueue_next(piterator
*iter
);
1598 size_t pqueue_size(pqueue
*pq
);
1600 typedef struct dtls1_state_st
{
1601 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1603 unsigned int cookie_verified
;
1604 /* handshake message numbers */
1605 unsigned short handshake_write_seq
;
1606 unsigned short next_handshake_write_seq
;
1607 unsigned short handshake_read_seq
;
1608 /* Buffered handshake messages */
1609 pqueue
*buffered_messages
;
1610 /* Buffered (sent) handshake records */
1611 pqueue
*sent_messages
;
1612 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1613 size_t mtu
; /* max DTLS packet size */
1614 struct hm_header_st w_msg_hdr
;
1615 struct hm_header_st r_msg_hdr
;
1616 struct dtls1_timeout_st timeout
;
1618 * Indicates when the last handshake msg sent will timeout
1620 struct timeval next_timeout
;
1621 /* Timeout duration */
1622 unsigned short timeout_duration
;
1623 unsigned int retransmitting
;
1624 # ifndef OPENSSL_NO_SCTP
1625 int shutdown_received
;
1629 # ifndef OPENSSL_NO_EC
1631 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1633 # define EXPLICIT_PRIME_CURVE_TYPE 1
1634 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1635 # define NAMED_CURVE_TYPE 3
1636 # endif /* OPENSSL_NO_EC */
1638 struct cert_pkey_st
{
1640 EVP_PKEY
*privatekey
;
1641 /* Chain for this certificate */
1642 STACK_OF(X509
) *chain
;
1644 * serverinfo data for this certificate. The data is in TLS Extension
1645 * wire format, specifically it's a series of records like:
1646 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1648 * uint8_t data[length];
1650 unsigned char *serverinfo
;
1651 size_t serverinfo_length
;
1653 /* Retrieve Suite B flags */
1654 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1655 /* Uses to check strict mode: suite B modes are always strict */
1656 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1657 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1660 ENDPOINT_CLIENT
= 0,
1667 unsigned short ext_type
;
1669 /* The context which this extension applies to */
1670 unsigned int context
;
1672 * Per-connection flags relating to this extension type: not used if
1673 * part of an SSL_CTX structure.
1676 SSL_custom_ext_add_cb_ex add_cb
;
1677 SSL_custom_ext_free_cb_ex free_cb
;
1679 SSL_custom_ext_parse_cb_ex parse_cb
;
1681 } custom_ext_method
;
1683 /* ext_flags values */
1686 * Indicates an extension has been received. Used to check for unsolicited or
1687 * duplicate extensions.
1689 # define SSL_EXT_FLAG_RECEIVED 0x1
1691 * Indicates an extension has been sent: used to enable sending of
1692 * corresponding ServerHello extension.
1694 # define SSL_EXT_FLAG_SENT 0x2
1697 custom_ext_method
*meths
;
1699 } custom_ext_methods
;
1701 typedef struct cert_st
{
1702 /* Current active set */
1704 * ALWAYS points to an element of the pkeys array
1705 * Probably it would make more sense to store
1706 * an index, not a pointer.
1709 # ifndef OPENSSL_NO_DH
1711 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
1714 /* Flags related to certificates */
1715 uint32_t cert_flags
;
1716 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
1717 /* Custom certificate types sent in certificate request message. */
1721 * supported signature algorithms. When set on a client this is sent in
1722 * the client hello as the supported signature algorithms extension. For
1723 * servers it represents the signature algorithms we are willing to use.
1725 uint16_t *conf_sigalgs
;
1726 /* Size of above array */
1727 size_t conf_sigalgslen
;
1729 * Client authentication signature algorithms, if not set then uses
1730 * conf_sigalgs. On servers these will be the signature algorithms sent
1731 * to the client in a certificate request for TLS 1.2. On a client this
1732 * represents the signature algorithms we are willing to use for client
1735 uint16_t *client_sigalgs
;
1736 /* Size of above array */
1737 size_t client_sigalgslen
;
1739 * Signature algorithms shared by client and server: cached because these
1740 * are used most often.
1742 const SIGALG_LOOKUP
**shared_sigalgs
;
1743 size_t shared_sigalgslen
;
1745 * Certificate setup callback: if set is called whenever a certificate
1746 * may be required (client or server). the callback can then examine any
1747 * appropriate parameters and setup any certificates required. This
1748 * allows advanced applications to select certificates on the fly: for
1749 * example based on supported signature algorithms or curves.
1751 int (*cert_cb
) (SSL
*ssl
, void *arg
);
1754 * Optional X509_STORE for chain building or certificate validation If
1755 * NULL the parent SSL_CTX store is used instead.
1757 X509_STORE
*chain_store
;
1758 X509_STORE
*verify_store
;
1759 /* Custom extensions */
1760 custom_ext_methods custext
;
1761 /* Security callback */
1762 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1763 void *other
, void *ex
);
1764 /* Security level */
1767 # ifndef OPENSSL_NO_PSK
1768 /* If not NULL psk identity hint to use for servers */
1769 char *psk_identity_hint
;
1771 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
1772 CRYPTO_RWLOCK
*lock
;
1775 # define FP_ICC (int (*)(const void *,const void *))
1778 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1779 * of a mess of functions, but hell, think of it as an opaque structure :-)
1781 typedef struct ssl3_enc_method
{
1782 int (*enc
) (SSL
*, SSL3_RECORD
*, size_t, int);
1783 int (*mac
) (SSL
*, SSL3_RECORD
*, unsigned char *, int);
1784 int (*setup_key_block
) (SSL
*);
1785 int (*generate_master_secret
) (SSL
*, unsigned char *, unsigned char *,
1787 int (*change_cipher_state
) (SSL
*, int);
1788 size_t (*final_finish_mac
) (SSL
*, const char *, size_t, unsigned char *);
1789 const char *client_finished_label
;
1790 size_t client_finished_label_len
;
1791 const char *server_finished_label
;
1792 size_t server_finished_label_len
;
1793 int (*alert_value
) (int);
1794 int (*export_keying_material
) (SSL
*, unsigned char *, size_t,
1795 const char *, size_t,
1796 const unsigned char *, size_t,
1798 /* Various flags indicating protocol version requirements */
1800 /* Set the handshake header */
1801 int (*set_handshake_header
) (SSL
*s
, WPACKET
*pkt
, int type
);
1802 /* Close construction of the handshake message */
1803 int (*close_construct_packet
) (SSL
*s
, WPACKET
*pkt
, int htype
);
1804 /* Write out handshake message */
1805 int (*do_write
) (SSL
*s
);
1808 # define ssl_set_handshake_header(s, pkt, htype) \
1809 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1810 # define ssl_close_construct_packet(s, pkt, htype) \
1811 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1812 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1814 /* Values for enc_flags */
1816 /* Uses explicit IV for CBC mode */
1817 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1818 /* Uses signature algorithms extension */
1819 # define SSL_ENC_FLAG_SIGALGS 0x2
1820 /* Uses SHA256 default PRF */
1821 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1823 # define SSL_ENC_FLAG_DTLS 0x8
1825 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1826 * apply to others in future.
1828 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1830 # ifndef OPENSSL_NO_COMP
1831 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1832 typedef struct ssl3_comp_st
{
1833 int comp_id
; /* The identifier byte for this compression
1835 char *name
; /* Text name used for the compression type */
1836 COMP_METHOD
*method
; /* The method :-) */
1840 typedef enum downgrade_en
{
1847 * Dummy status type for the status_type extension. Indicates no status type
1850 #define TLSEXT_STATUSTYPE_nothing -1
1852 /* Sigalgs values */
1853 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1854 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1855 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1856 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
1857 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1858 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1859 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1860 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1861 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1862 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1863 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1864 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
1865 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1866 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1867 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1868 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1869 #define TLSEXT_SIGALG_dsa_sha224 0x0302
1870 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1871 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1872 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1873 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1875 #define TLSEXT_SIGALG_ed25519 0x0807
1877 /* Known PSK key exchange modes */
1878 #define TLSEXT_KEX_MODE_KE 0x00
1879 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1882 * Internal representations of key exchange modes
1884 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1885 #define TLSEXT_KEX_MODE_FLAG_KE 1
1886 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1888 /* An invalid index into the TLSv1.3 PSK identities */
1889 #define TLSEXT_PSK_BAD_IDENTITY -1
1891 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1892 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1894 /* A dummy signature value not valid for TLSv1.2 signature algs */
1895 #define TLSEXT_signature_rsa_pss 0x0101
1897 /* TLSv1.3 downgrade protection sentinel values */
1898 extern const unsigned char tls11downgrade
[8];
1899 extern const unsigned char tls12downgrade
[8];
1901 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
1903 __owur
const SSL_METHOD
*ssl_bad_method(int ver
);
1904 __owur
const SSL_METHOD
*sslv3_method(void);
1905 __owur
const SSL_METHOD
*sslv3_server_method(void);
1906 __owur
const SSL_METHOD
*sslv3_client_method(void);
1907 __owur
const SSL_METHOD
*tlsv1_method(void);
1908 __owur
const SSL_METHOD
*tlsv1_server_method(void);
1909 __owur
const SSL_METHOD
*tlsv1_client_method(void);
1910 __owur
const SSL_METHOD
*tlsv1_1_method(void);
1911 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
1912 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
1913 __owur
const SSL_METHOD
*tlsv1_2_method(void);
1914 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
1915 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
1916 __owur
const SSL_METHOD
*tlsv1_3_method(void);
1917 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
1918 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
1919 __owur
const SSL_METHOD
*dtlsv1_method(void);
1920 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
1921 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
1922 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
1923 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
1924 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
1925 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
1927 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
1928 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
1929 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
1930 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
1931 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
1932 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
1933 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
1936 * Flags for SSL methods
1938 # define SSL_METHOD_NO_FIPS (1U<<0)
1939 # define SSL_METHOD_NO_SUITEB (1U<<1)
1941 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1942 s_connect, enc_data) \
1943 const SSL_METHOD *func_name(void) \
1945 static const SSL_METHOD func_name##_data= { \
1959 ssl3_renegotiate_check, \
1962 ssl3_dispatch_alert, \
1965 ssl3_get_cipher_by_char, \
1966 ssl3_put_cipher_by_char, \
1970 tls1_default_timeout, \
1972 ssl_undefined_void_function, \
1973 ssl3_callback_ctrl, \
1974 ssl3_ctx_callback_ctrl, \
1976 return &func_name##_data; \
1979 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1980 const SSL_METHOD *func_name(void) \
1982 static const SSL_METHOD func_name##_data= { \
1984 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1996 ssl3_renegotiate_check, \
1999 ssl3_dispatch_alert, \
2002 ssl3_get_cipher_by_char, \
2003 ssl3_put_cipher_by_char, \
2007 ssl3_default_timeout, \
2009 ssl_undefined_void_function, \
2010 ssl3_callback_ctrl, \
2011 ssl3_ctx_callback_ctrl, \
2013 return &func_name##_data; \
2016 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2017 s_connect, enc_data) \
2018 const SSL_METHOD *func_name(void) \
2020 static const SSL_METHOD func_name##_data= { \
2034 ssl3_renegotiate_check, \
2036 dtls1_write_app_data_bytes, \
2037 dtls1_dispatch_alert, \
2040 ssl3_get_cipher_by_char, \
2041 ssl3_put_cipher_by_char, \
2045 dtls1_default_timeout, \
2047 ssl_undefined_void_function, \
2048 ssl3_callback_ctrl, \
2049 ssl3_ctx_callback_ctrl, \
2051 return &func_name##_data; \
2054 struct openssl_ssl_test_functions
{
2055 int (*p_ssl_init_wbio_buffer
) (SSL
*s
);
2056 int (*p_ssl3_setup_buffers
) (SSL
*s
);
2059 const char *ssl_protocol_to_string(int version
);
2061 /* Returns true if certificate and private key for 'idx' are present */
2062 static ossl_inline
int ssl_has_cert(const SSL
*s
, int idx
)
2064 if (idx
< 0 || idx
>= SSL_PKEY_NUM
)
2066 return s
->cert
->pkeys
[idx
].x509
!= NULL
2067 && s
->cert
->pkeys
[idx
].privatekey
!= NULL
;
2070 # ifndef OPENSSL_UNIT_TEST
2072 __owur
int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
);
2073 __owur
int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
);
2074 void ssl_clear_cipher_ctx(SSL
*s
);
2075 int ssl_clear_bad_session(SSL
*s
);
2076 __owur CERT
*ssl_cert_new(void);
2077 __owur CERT
*ssl_cert_dup(CERT
*cert
);
2078 void ssl_cert_clear_certs(CERT
*c
);
2079 void ssl_cert_free(CERT
*c
);
2080 __owur
int ssl_get_new_session(SSL
*s
, int session
);
2081 __owur
int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
, int *al
);
2082 __owur SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
);
2083 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
2084 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
2085 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2086 const SSL_CIPHER
*const *bp
);
2087 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
2088 STACK_OF(SSL_CIPHER
) **pref
,
2089 STACK_OF(SSL_CIPHER
)
2091 const char *rule_str
,
2093 __owur
int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
,
2094 int sslv2format
, int *al
);
2095 __owur
int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
2096 STACK_OF(SSL_CIPHER
) **skp
,
2097 STACK_OF(SSL_CIPHER
) **scsvs
, int sslv2format
,
2099 void ssl_update_cache(SSL
*s
, int mode
);
2100 __owur
int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
2101 const EVP_MD
**md
, int *mac_pkey_type
,
2102 size_t *mac_secret_size
, SSL_COMP
**comp
,
2104 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
2105 size_t *int_overhead
, size_t *blocksize
,
2106 size_t *ext_overhead
);
2107 __owur
int ssl_cert_is_disabled(size_t idx
);
2108 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
,
2109 const unsigned char *ptr
,
2111 __owur
int ssl_cert_set0_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2112 __owur
int ssl_cert_set1_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2113 __owur
int ssl_cert_add0_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2114 __owur
int ssl_cert_add1_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2115 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
2116 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
2117 __owur X509
*ssl_cert_get0_next_certificate(CERT
*c
, int first
);
2118 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
2120 __owur
int ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
);
2121 __owur
int ssl_build_cert_chain(SSL
*s
, SSL_CTX
*ctx
, int flags
);
2122 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
2125 __owur
int ssl_security(const SSL
*s
, int op
, int bits
, int nid
, void *other
);
2126 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
2129 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_pkey(const EVP_PKEY
*pk
,
2131 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_idx(size_t idx
);
2133 int ssl_undefined_function(SSL
*s
);
2134 __owur
int ssl_undefined_void_function(void);
2135 __owur
int ssl_undefined_const_function(const SSL
*s
);
2136 __owur
int ssl_get_server_cert_serverinfo(SSL
*s
,
2137 const unsigned char **serverinfo
,
2138 size_t *serverinfo_length
);
2139 void ssl_set_masks(SSL
*s
);
2140 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
2141 __owur
int ssl_verify_alarm_type(long type
);
2142 void ssl_sort_cipher_list(void);
2143 int ssl_load_ciphers(void);
2144 __owur
int ssl_fill_hello_random(SSL
*s
, int server
, unsigned char *field
,
2145 size_t len
, DOWNGRADE dgrd
);
2146 __owur
int ssl_generate_master_secret(SSL
*s
, unsigned char *pms
, size_t pmslen
,
2148 __owur EVP_PKEY
*ssl_generate_pkey(EVP_PKEY
*pm
);
2149 __owur
int ssl_derive(SSL
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
2151 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
2153 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_id(uint32_t id
);
2154 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
2155 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
2157 int ssl3_init_finished_mac(SSL
*s
);
2158 __owur
int ssl3_setup_key_block(SSL
*s
);
2159 __owur
int ssl3_change_cipher_state(SSL
*s
, int which
);
2160 void ssl3_cleanup_key_block(SSL
*s
);
2161 __owur
int ssl3_do_write(SSL
*s
, int type
);
2162 int ssl3_send_alert(SSL
*s
, int level
, int desc
);
2163 __owur
int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
2164 unsigned char *p
, size_t len
,
2165 size_t *secret_size
);
2166 __owur
int ssl3_get_req_cert_type(SSL
*s
, WPACKET
*pkt
);
2167 __owur
int ssl3_num_ciphers(void);
2168 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2169 int ssl3_renegotiate(SSL
*ssl
);
2170 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2171 __owur
int ssl3_dispatch_alert(SSL
*s
);
2172 __owur
size_t ssl3_final_finish_mac(SSL
*s
, const char *sender
, size_t slen
,
2174 __owur
int ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, size_t len
);
2175 void ssl3_free_digest_list(SSL
*s
);
2176 __owur
unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
,
2177 CERT_PKEY
*cpk
, int *al
);
2178 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,
2179 STACK_OF(SSL_CIPHER
) *clnt
,
2180 STACK_OF(SSL_CIPHER
) *srvr
);
2181 __owur
int ssl3_digest_cached_records(SSL
*s
, int keep
);
2182 __owur
int ssl3_new(SSL
*s
);
2183 void ssl3_free(SSL
*s
);
2184 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2185 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2186 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2187 __owur
int ssl3_shutdown(SSL
*s
);
2188 int ssl3_clear(SSL
*s
);
2189 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2190 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2191 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2192 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2194 __owur
int ssl3_do_change_cipher_spec(SSL
*ssl
);
2195 __owur
long ssl3_default_timeout(void);
2197 __owur
int ssl3_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2198 __owur
int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2199 __owur
int tls_setup_handshake(SSL
*s
);
2200 __owur
int dtls1_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2201 __owur
int dtls1_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2202 __owur
int ssl3_handshake_write(SSL
*s
);
2204 __owur
int ssl_allow_compression(SSL
*s
);
2206 __owur
int ssl_version_supported(const SSL
*s
, int version
);
2208 __owur
int ssl_set_client_hello_version(SSL
*s
);
2209 __owur
int ssl_check_version_downgrade(SSL
*s
);
2210 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2211 __owur
int ssl_choose_server_version(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2213 __owur
int ssl_choose_client_version(SSL
*s
, int version
, int checkdgrd
,
2215 int ssl_get_min_max_version(const SSL
*s
, int *min_version
, int *max_version
);
2217 __owur
long tls1_default_timeout(void);
2218 __owur
int dtls1_do_write(SSL
*s
, int type
);
2219 void dtls1_set_message_header(SSL
*s
,
2222 size_t frag_off
, size_t frag_len
);
2224 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf_
, size_t len
,
2227 __owur
int dtls1_read_failed(SSL
*s
, int code
);
2228 __owur
int dtls1_buffer_message(SSL
*s
, int ccs
);
2229 __owur
int dtls1_retransmit_message(SSL
*s
, unsigned short seq
, int *found
);
2230 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2231 int dtls1_retransmit_buffered_messages(SSL
*s
);
2232 void dtls1_clear_received_buffer(SSL
*s
);
2233 void dtls1_clear_sent_buffer(SSL
*s
);
2234 void dtls1_get_message_header(unsigned char *data
,
2235 struct hm_header_st
*msg_hdr
);
2236 __owur
long dtls1_default_timeout(void);
2237 __owur
struct timeval
*dtls1_get_timeout(SSL
*s
, struct timeval
*timeleft
);
2238 __owur
int dtls1_check_timeout_num(SSL
*s
);
2239 __owur
int dtls1_handle_timeout(SSL
*s
);
2240 void dtls1_start_timer(SSL
*s
);
2241 void dtls1_stop_timer(SSL
*s
);
2242 __owur
int dtls1_is_timer_expired(SSL
*s
);
2243 void dtls1_double_timeout(SSL
*s
);
2244 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2246 __owur
int dtls1_send_newsession_ticket(SSL
*s
);
2247 __owur
size_t dtls1_min_mtu(SSL
*s
);
2248 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2249 __owur
int dtls1_query_mtu(SSL
*s
);
2251 __owur
int tls1_new(SSL
*s
);
2252 void tls1_free(SSL
*s
);
2253 int tls1_clear(SSL
*s
);
2254 long tls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2255 long tls1_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2257 __owur
int dtls1_new(SSL
*s
);
2258 void dtls1_free(SSL
*s
);
2259 int dtls1_clear(SSL
*s
);
2260 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2261 __owur
int dtls1_shutdown(SSL
*s
);
2263 __owur
int dtls1_dispatch_alert(SSL
*s
);
2265 __owur
int ssl_init_wbio_buffer(SSL
*s
);
2266 int ssl_free_wbio_buffer(SSL
*s
);
2268 __owur
int tls1_change_cipher_state(SSL
*s
, int which
);
2269 __owur
int tls1_setup_key_block(SSL
*s
);
2270 __owur
size_t tls1_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2272 __owur
int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
2273 unsigned char *p
, size_t len
,
2274 size_t *secret_size
);
2275 __owur
int tls13_setup_key_block(SSL
*s
);
2276 __owur
size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2278 __owur
int tls13_change_cipher_state(SSL
*s
, int which
);
2279 __owur
int tls13_update_key(SSL
*s
, int send
);
2280 __owur
int tls13_hkdf_expand(SSL
*s
, const EVP_MD
*md
,
2281 const unsigned char *secret
,
2282 const unsigned char *label
, size_t labellen
,
2283 const unsigned char *data
, size_t datalen
,
2284 unsigned char *out
, size_t outlen
);
2285 __owur
int tls13_derive_key(SSL
*s
, const EVP_MD
*md
,
2286 const unsigned char *secret
, unsigned char *key
,
2288 __owur
int tls13_derive_iv(SSL
*s
, const EVP_MD
*md
,
2289 const unsigned char *secret
, unsigned char *iv
,
2291 __owur
int tls13_derive_finishedkey(SSL
*s
, const EVP_MD
*md
,
2292 const unsigned char *secret
,
2293 unsigned char *fin
, size_t finlen
);
2294 int tls13_generate_secret(SSL
*s
, const EVP_MD
*md
,
2295 const unsigned char *prevsecret
,
2296 const unsigned char *insecret
,
2298 unsigned char *outsecret
);
2299 __owur
int tls13_generate_handshake_secret(SSL
*s
,
2300 const unsigned char *insecret
,
2301 size_t insecretlen
);
2302 __owur
int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
2303 unsigned char *prev
, size_t prevlen
,
2304 size_t *secret_size
);
2305 __owur
int tls1_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2306 const char *label
, size_t llen
,
2307 const unsigned char *p
, size_t plen
,
2309 __owur
int tls13_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2310 const char *label
, size_t llen
,
2311 const unsigned char *context
,
2312 size_t contextlen
, int use_context
);
2313 __owur
int tls1_alert_code(int code
);
2314 __owur
int tls13_alert_code(int code
);
2315 __owur
int ssl3_alert_code(int code
);
2317 # ifndef OPENSSL_NO_EC
2318 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
);
2321 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2323 # ifndef OPENSSL_NO_EC
2324 /* Flags values from tls1_ec_curve_id2nid() */
2325 /* Mask for curve type */
2326 # define TLS_CURVE_TYPE 0x3
2327 # define TLS_CURVE_PRIME 0x0
2328 # define TLS_CURVE_CHAR2 0x1
2329 # define TLS_CURVE_CUSTOM 0x2
2331 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2333 __owur
int tls1_ec_curve_id2nid(int curve_id
, unsigned int *pflags
);
2334 __owur
int tls1_ec_nid2curve_id(int nid
);
2335 __owur
int tls1_check_curve(SSL
*s
, const unsigned char *p
, size_t len
);
2336 __owur
int tls1_shared_group(SSL
*s
, int nmatch
);
2337 __owur
int tls1_set_groups(unsigned char **pext
, size_t *pextlen
,
2338 int *curves
, size_t ncurves
);
2339 __owur
int tls1_set_groups_list(unsigned char **pext
, size_t *pextlen
,
2341 void tls1_get_formatlist(SSL
*s
, const unsigned char **pformats
,
2342 size_t *num_formats
);
2343 __owur
int tls1_check_ec_tmp_key(SSL
*s
, unsigned long id
);
2344 __owur EVP_PKEY
*ssl_generate_pkey_curve(int id
);
2345 # endif /* OPENSSL_NO_EC */
2347 __owur
int tls1_shared_list(SSL
*s
,
2348 const unsigned char *l1
, size_t l1len
,
2349 const unsigned char *l2
, size_t l2len
, int nmatch
);
2350 __owur
int tls_curve_allowed(SSL
*s
, const unsigned char *curve
, int op
);
2351 __owur
int tls1_get_curvelist(SSL
*s
, int sess
, const unsigned char **pcurves
,
2352 size_t *num_curves
);
2354 void ssl_set_default_md(SSL
*s
);
2355 __owur
int tls1_set_server_sigalgs(SSL
*s
);
2357 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2358 typedef enum ticket_en
{
2359 /* fatal error, malloc failure */
2360 TICKET_FATAL_ERR_MALLOC
,
2361 /* fatal error, either from parsing or decrypting the ticket */
2362 TICKET_FATAL_ERR_OTHER
,
2363 /* No ticket present */
2365 /* Empty ticket present */
2367 /* the ticket couldn't be decrypted */
2369 /* a ticket was successfully decrypted */
2371 /* same as above but the ticket needs to be reneewed */
2372 TICKET_SUCCESS_RENEW
2375 __owur TICKET_RETURN
tls_get_ticket_from_client(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2377 __owur TICKET_RETURN
tls_decrypt_ticket(SSL
*s
, const unsigned char *etick
,
2379 const unsigned char *sess_id
,
2380 size_t sesslen
, SSL_SESSION
**psess
);
2382 __owur
int tls_use_ticket(SSL
*s
);
2384 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL
*s
, int op
);
2386 __owur
int tls1_set_sigalgs_list(CERT
*c
, const char *str
, int client
);
2387 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2389 int tls1_check_chain(SSL
*s
, X509
*x
, EVP_PKEY
*pk
, STACK_OF(X509
) *chain
,
2391 void tls1_set_cert_validity(SSL
*s
);
2393 # ifndef OPENSSL_NO_CT
2394 __owur
int ssl_validate_ct(SSL
*s
);
2397 # ifndef OPENSSL_NO_DH
2398 __owur DH
*ssl_get_auto_dh(SSL
*s
);
2401 __owur
int ssl_security_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
, int is_ee
);
2402 __owur
int ssl_security_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
, X509
*ex
,
2405 int tls_choose_sigalg(SSL
*s
, int *al
);
2407 __owur EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
);
2408 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
);
2409 __owur
long ssl_get_algorithm2(SSL
*s
);
2410 __owur
int tls12_copy_sigalgs(SSL
*s
, WPACKET
*pkt
,
2411 const uint16_t *psig
, size_t psiglen
);
2412 __owur
int tls1_save_sigalgs(SSL
*s
, PACKET
*pkt
);
2413 __owur
int tls1_process_sigalgs(SSL
*s
);
2414 __owur
int tls1_set_peer_legacy_sigalg(SSL
*s
, const EVP_PKEY
*pkey
);
2415 __owur
int tls1_lookup_md(const SIGALG_LOOKUP
*lu
, const EVP_MD
**pmd
);
2416 __owur
size_t tls12_get_psigalgs(SSL
*s
, int sent
, const uint16_t **psigs
);
2417 __owur
int tls12_check_peer_sigalg(SSL
*s
, uint16_t, EVP_PKEY
*pkey
);
2418 void ssl_set_client_disabled(SSL
*s
);
2419 __owur
int ssl_cipher_disabled(SSL
*s
, const SSL_CIPHER
*c
, int op
, int echde
);
2421 __owur
int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
2423 __owur
const EVP_MD
*ssl_md(int idx
);
2424 __owur
const EVP_MD
*ssl_handshake_md(SSL
*s
);
2425 __owur
const EVP_MD
*ssl_prf_md(SSL
*s
);
2428 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2429 * with |ssl|, if logging is enabled. It returns one on success and zero on
2430 * failure. The entry is identified by the first 8 bytes of
2431 * |encrypted_premaster|.
2433 __owur
int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
2434 const uint8_t *encrypted_premaster
,
2435 size_t encrypted_premaster_len
,
2436 const uint8_t *premaster
,
2437 size_t premaster_len
);
2440 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2441 * logging is available. It returns one on success and zero on failure. It tags
2442 * the entry with |label|.
2444 __owur
int ssl_log_secret(SSL
*ssl
, const char *label
,
2445 const uint8_t *secret
, size_t secret_len
);
2447 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2448 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2449 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2450 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2451 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2452 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2455 __owur
char ssl3_cbc_record_digest_supported(const EVP_MD_CTX
*ctx
);
2456 __owur
int ssl3_cbc_digest_record(const EVP_MD_CTX
*ctx
,
2457 unsigned char *md_out
,
2458 size_t *md_out_size
,
2459 const unsigned char header
[13],
2460 const unsigned char *data
,
2461 size_t data_plus_mac_size
,
2462 size_t data_plus_mac_plus_padding_size
,
2463 const unsigned char *mac_secret
,
2464 size_t mac_secret_length
, char is_sslv3
);
2466 __owur
int srp_generate_server_master_secret(SSL
*s
);
2467 __owur
int srp_generate_client_master_secret(SSL
*s
);
2468 __owur
int srp_verify_server_param(SSL
*s
, int *al
);
2470 /* statem/extensions_cust.c */
2472 custom_ext_method
*custom_ext_find(const custom_ext_methods
*exts
,
2473 ENDPOINT role
, unsigned int ext_type
,
2476 void custom_ext_init(custom_ext_methods
*meths
);
2478 __owur
int custom_ext_parse(SSL
*s
, unsigned int context
, unsigned int ext_type
,
2479 const unsigned char *ext_data
, size_t ext_size
,
2480 X509
*x
, size_t chainidx
, int *al
);
2481 __owur
int custom_ext_add(SSL
*s
, int context
, WPACKET
*pkt
, X509
*x
,
2482 size_t chainidx
, int maxversion
, int *al
);
2484 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2485 const custom_ext_methods
*src
);
2486 __owur
int custom_exts_copy_flags(custom_ext_methods
*dst
,
2487 const custom_ext_methods
*src
);
2488 void custom_exts_free(custom_ext_methods
*exts
);
2490 void ssl_comp_free_compression_methods_int(void);
2492 # else /* OPENSSL_UNIT_TEST */
2494 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2495 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers