2 * Copyright 1995-2017 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
15 # include "e_os.h" /* struct timeval for DTLS */
21 # include <openssl/buffer.h>
22 # include <openssl/comp.h>
23 # include <openssl/bio.h>
24 # include <openssl/stack.h>
25 # include <openssl/rsa.h>
26 # include <openssl/dsa.h>
27 # include <openssl/err.h>
28 # include <openssl/ssl.h>
29 # include <openssl/async.h>
30 # include <openssl/symhacks.h>
31 # include <openssl/ct.h>
32 # include "record/record.h"
33 # include "statem/statem.h"
34 # include "packet_locl.h"
35 # include "internal/dane.h"
36 # include "internal/refcount.h"
38 # ifdef OPENSSL_BUILD_SHLIBSSL
39 # undef OPENSSL_EXTERN
40 # define OPENSSL_EXTERN OPENSSL_EXPORT
43 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
44 l|=(((unsigned long)(*((c)++)))<< 8), \
45 l|=(((unsigned long)(*((c)++)))<<16), \
46 l|=(((unsigned long)(*((c)++)))<<24))
48 /* NOTE - c is not incremented as per c2l */
49 # define c2ln(c,l1,l2,n) { \
53 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
54 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
55 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
56 case 5: l2|=((unsigned long)(*(--(c)))); \
57 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
58 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
59 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
60 case 1: l1|=((unsigned long)(*(--(c)))); \
64 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
65 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
66 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
67 *((c)++)=(unsigned char)(((l)>>24)&0xff))
69 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
70 l|=((unsigned long)(*((c)++)))<<16, \
71 l|=((unsigned long)(*((c)++)))<< 8, \
72 l|=((unsigned long)(*((c)++))))
74 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
75 l|=((uint64_t)(*((c)++)))<<48, \
76 l|=((uint64_t)(*((c)++)))<<40, \
77 l|=((uint64_t)(*((c)++)))<<32, \
78 l|=((uint64_t)(*((c)++)))<<24, \
79 l|=((uint64_t)(*((c)++)))<<16, \
80 l|=((uint64_t)(*((c)++)))<< 8, \
81 l|=((uint64_t)(*((c)++))))
84 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
85 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
86 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
87 *((c)++)=(unsigned char)(((l) )&0xff))
89 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
90 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
91 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
92 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
93 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
94 *((c)++)=(unsigned char)(((l) )&0xff))
96 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
97 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
98 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
99 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
101 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
102 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
103 *((c)++)=(unsigned char)(((l) )&0xff))
105 /* NOTE - c is not incremented as per l2c */
106 # define l2cn(l1,l2,c,n) { \
109 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
110 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
111 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
112 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
113 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
114 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
115 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
116 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
120 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
121 (((unsigned int)((c)[1])) )),(c)+=2)
122 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
123 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
125 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
126 (((unsigned long)((c)[1]))<< 8)| \
127 (((unsigned long)((c)[2])) )),(c)+=3)
129 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
130 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
131 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
134 * DTLS version numbers are strange because they're inverted. Except for
135 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
137 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
138 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
139 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
140 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
141 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
145 * Define the Bitmasks for SSL_CIPHER.algorithms.
146 * This bits are used packed as dense as possible. If new methods/ciphers
147 * etc will be added, the bits a likely to change, so this information
148 * is for internal library use only, even though SSL_CIPHER.algorithms
149 * can be publicly accessed.
150 * Use the according functions for cipher management instead.
152 * The bit mask handling in the selection and sorting scheme in
153 * ssl_create_cipher_list() has only limited capabilities, reflecting
154 * that the different entities within are mutually exclusive:
155 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
158 /* Bits for algorithm_mkey (key exchange algorithm) */
159 /* RSA key exchange */
160 # define SSL_kRSA 0x00000001U
161 /* tmp DH key no DH cert */
162 # define SSL_kDHE 0x00000002U
164 # define SSL_kEDH SSL_kDHE
166 # define SSL_kECDHE 0x00000004U
168 # define SSL_kEECDH SSL_kECDHE
170 # define SSL_kPSK 0x00000008U
171 /* GOST key exchange */
172 # define SSL_kGOST 0x00000010U
174 # define SSL_kSRP 0x00000020U
176 # define SSL_kRSAPSK 0x00000040U
177 # define SSL_kECDHEPSK 0x00000080U
178 # define SSL_kDHEPSK 0x00000100U
182 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
184 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
185 # define SSL_kANY 0x00000000U
187 /* Bits for algorithm_auth (server authentication) */
189 # define SSL_aRSA 0x00000001U
191 # define SSL_aDSS 0x00000002U
192 /* no auth (i.e. use ADH or AECDH) */
193 # define SSL_aNULL 0x00000004U
195 # define SSL_aECDSA 0x00000008U
197 # define SSL_aPSK 0x00000010U
198 /* GOST R 34.10-2001 signature auth */
199 # define SSL_aGOST01 0x00000020U
201 # define SSL_aSRP 0x00000040U
202 /* GOST R 34.10-2012 signature auth */
203 # define SSL_aGOST12 0x00000080U
204 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
205 # define SSL_aANY 0x00000000U
206 /* All bits requiring a certificate */
208 (SSL_aRSA | SSL_aDSS | SSL_aECDSA | SSL_aGOST01 | SSL_aGOST12)
210 /* Bits for algorithm_enc (symmetric encryption) */
211 # define SSL_DES 0x00000001U
212 # define SSL_3DES 0x00000002U
213 # define SSL_RC4 0x00000004U
214 # define SSL_RC2 0x00000008U
215 # define SSL_IDEA 0x00000010U
216 # define SSL_eNULL 0x00000020U
217 # define SSL_AES128 0x00000040U
218 # define SSL_AES256 0x00000080U
219 # define SSL_CAMELLIA128 0x00000100U
220 # define SSL_CAMELLIA256 0x00000200U
221 # define SSL_eGOST2814789CNT 0x00000400U
222 # define SSL_SEED 0x00000800U
223 # define SSL_AES128GCM 0x00001000U
224 # define SSL_AES256GCM 0x00002000U
225 # define SSL_AES128CCM 0x00004000U
226 # define SSL_AES256CCM 0x00008000U
227 # define SSL_AES128CCM8 0x00010000U
228 # define SSL_AES256CCM8 0x00020000U
229 # define SSL_eGOST2814789CNT12 0x00040000U
230 # define SSL_CHACHA20POLY1305 0x00080000U
231 # define SSL_ARIA128GCM 0x00100000U
232 # define SSL_ARIA256GCM 0x00200000U
234 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
235 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
236 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
237 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
238 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
239 # define SSL_ARIAGCM (SSL_ARIA128GCM | SSL_ARIA256GCM)
240 # define SSL_ARIA (SSL_ARIAGCM)
242 /* Bits for algorithm_mac (symmetric authentication) */
244 # define SSL_MD5 0x00000001U
245 # define SSL_SHA1 0x00000002U
246 # define SSL_GOST94 0x00000004U
247 # define SSL_GOST89MAC 0x00000008U
248 # define SSL_SHA256 0x00000010U
249 # define SSL_SHA384 0x00000020U
250 /* Not a real MAC, just an indication it is part of cipher */
251 # define SSL_AEAD 0x00000040U
252 # define SSL_GOST12_256 0x00000080U
253 # define SSL_GOST89MAC12 0x00000100U
254 # define SSL_GOST12_512 0x00000200U
257 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
258 * sure to update this constant too
261 # define SSL_MD_MD5_IDX 0
262 # define SSL_MD_SHA1_IDX 1
263 # define SSL_MD_GOST94_IDX 2
264 # define SSL_MD_GOST89MAC_IDX 3
265 # define SSL_MD_SHA256_IDX 4
266 # define SSL_MD_SHA384_IDX 5
267 # define SSL_MD_GOST12_256_IDX 6
268 # define SSL_MD_GOST89MAC12_IDX 7
269 # define SSL_MD_GOST12_512_IDX 8
270 # define SSL_MD_MD5_SHA1_IDX 9
271 # define SSL_MD_SHA224_IDX 10
272 # define SSL_MD_SHA512_IDX 11
273 # define SSL_MAX_DIGEST 12
275 /* Bits for algorithm2 (handshake digests and other extra flags) */
277 /* Bits 0-7 are handshake MAC */
278 # define SSL_HANDSHAKE_MAC_MASK 0xFF
279 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
280 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
281 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
282 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
283 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
284 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
285 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
287 /* Bits 8-15 bits are PRF */
288 # define TLS1_PRF_DGST_SHIFT 8
289 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
290 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
291 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
292 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
293 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
294 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
295 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
298 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
299 * goes into algorithm2)
301 # define TLS1_STREAM_MAC 0x10000
303 # define SSL_STRONG_MASK 0x0000001FU
304 # define SSL_DEFAULT_MASK 0X00000020U
306 # define SSL_STRONG_NONE 0x00000001U
307 # define SSL_LOW 0x00000002U
308 # define SSL_MEDIUM 0x00000004U
309 # define SSL_HIGH 0x00000008U
310 # define SSL_FIPS 0x00000010U
311 # define SSL_NOT_DEFAULT 0x00000020U
313 /* we have used 0000003f - 26 bits left to go */
315 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
316 # define SSL3_CK_CIPHERSUITE_FLAG 0x03000000
318 /* Check if an SSL structure is using DTLS */
319 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
321 /* Check if we are using TLSv1.3 */
322 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
323 && (s)->method->version >= TLS1_3_VERSION \
324 && (s)->method->version != TLS_ANY_VERSION)
326 # define SSL_TREAT_AS_TLS13(s) \
327 (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
328 || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY)
330 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
332 /* See if we need explicit IV */
333 # define SSL_USE_EXPLICIT_IV(s) \
334 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
336 * See if we use signature algorithms extension and signature algorithm
339 # define SSL_USE_SIGALGS(s) \
340 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
342 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
343 * apply to others in future.
345 # define SSL_USE_TLS1_2_CIPHERS(s) \
346 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
348 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
349 * flags because it may not be set to correct version yet.
351 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
352 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
353 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
355 * Determine if a client should send signature algorithms extension:
356 * as with TLS1.2 cipher we can't rely on method flags.
358 # define SSL_CLIENT_USE_SIGALGS(s) \
359 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
361 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
362 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
364 /* Mostly for SSLv3 */
365 # define SSL_PKEY_RSA 0
366 # define SSL_PKEY_DSA_SIGN 1
367 # define SSL_PKEY_ECC 2
368 # define SSL_PKEY_GOST01 3
369 # define SSL_PKEY_GOST12_256 4
370 # define SSL_PKEY_GOST12_512 5
371 # define SSL_PKEY_ED25519 6
372 # define SSL_PKEY_NUM 7
374 * Pseudo-constant. GOST cipher suites can use different certs for 1
375 * SSL_CIPHER. So let's see which one we have in fact.
377 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
380 * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
383 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
386 * SSL_kRSA <- RSA_ENC
387 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
388 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
389 * SSL_aRSA <- RSA_ENC | RSA_SIGN
390 * SSL_aDSS <- DSA_SIGN
394 #define CERT_INVALID 0
395 #define CERT_PUBLIC_KEY 1
396 #define CERT_PRIVATE_KEY 2
399 /* CipherSuite length. SSLv3 and all TLS versions. */
400 # define TLS_CIPHER_LEN 2
401 /* used to hold info on the particular ciphers used */
402 struct ssl_cipher_st
{
404 const char *name
; /* text name */
405 const char *stdname
; /* RFC name */
406 uint32_t id
; /* id, 4 bytes, first is version */
408 * changed in 1.0.0: these four used to be portions of a single value
411 uint32_t algorithm_mkey
; /* key exchange algorithm */
412 uint32_t algorithm_auth
; /* server authentication */
413 uint32_t algorithm_enc
; /* symmetric encryption */
414 uint32_t algorithm_mac
; /* symmetric authentication */
415 int min_tls
; /* minimum SSL/TLS protocol version */
416 int max_tls
; /* maximum SSL/TLS protocol version */
417 int min_dtls
; /* minimum DTLS protocol version */
418 int max_dtls
; /* maximum DTLS protocol version */
419 uint32_t algo_strength
; /* strength and export flags */
420 uint32_t algorithm2
; /* Extra flags */
421 int32_t strength_bits
; /* Number of bits really used */
422 uint32_t alg_bits
; /* Number of bits for algorithm */
425 /* Used to hold SSL/TLS functions */
426 struct ssl_method_st
{
430 int (*ssl_new
) (SSL
*s
);
431 int (*ssl_clear
) (SSL
*s
);
432 void (*ssl_free
) (SSL
*s
);
433 int (*ssl_accept
) (SSL
*s
);
434 int (*ssl_connect
) (SSL
*s
);
435 int (*ssl_read
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
436 int (*ssl_peek
) (SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
437 int (*ssl_write
) (SSL
*s
, const void *buf
, size_t len
, size_t *written
);
438 int (*ssl_shutdown
) (SSL
*s
);
439 int (*ssl_renegotiate
) (SSL
*s
);
440 int (*ssl_renegotiate_check
) (SSL
*s
, int);
441 int (*ssl_read_bytes
) (SSL
*s
, int type
, int *recvd_type
,
442 unsigned char *buf
, size_t len
, int peek
,
444 int (*ssl_write_bytes
) (SSL
*s
, int type
, const void *buf_
, size_t len
,
446 int (*ssl_dispatch_alert
) (SSL
*s
);
447 long (*ssl_ctrl
) (SSL
*s
, int cmd
, long larg
, void *parg
);
448 long (*ssl_ctx_ctrl
) (SSL_CTX
*ctx
, int cmd
, long larg
, void *parg
);
449 const SSL_CIPHER
*(*get_cipher_by_char
) (const unsigned char *ptr
);
450 int (*put_cipher_by_char
) (const SSL_CIPHER
*cipher
, WPACKET
*pkt
,
452 size_t (*ssl_pending
) (const SSL
*s
);
453 int (*num_ciphers
) (void);
454 const SSL_CIPHER
*(*get_cipher
) (unsigned ncipher
);
455 long (*get_timeout
) (void);
456 const struct ssl3_enc_method
*ssl3_enc
; /* Extra SSLv3/TLS stuff */
457 int (*ssl_version
) (void);
458 long (*ssl_callback_ctrl
) (SSL
*s
, int cb_id
, void (*fp
) (void));
459 long (*ssl_ctx_callback_ctrl
) (SSL_CTX
*s
, int cb_id
, void (*fp
) (void));
463 * Lets make this into an ASN.1 type structure as follows
464 * SSL_SESSION_ID ::= SEQUENCE {
465 * version INTEGER, -- structure version number
466 * SSLversion INTEGER, -- SSL version number
467 * Cipher OCTET STRING, -- the 3 byte cipher ID
468 * Session_ID OCTET STRING, -- the Session ID
469 * Master_key OCTET STRING, -- the master key
470 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
471 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
472 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
473 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
474 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
475 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
476 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
477 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
478 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
479 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
480 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
481 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
482 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
483 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
485 * Look in ssl/ssl_asn1.c for more details
486 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
488 struct ssl_session_st
{
489 int ssl_version
; /* what ssl version session info is being kept
491 size_t master_key_length
;
493 /* TLSv1.3 early_secret used for external PSKs */
494 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
496 * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
499 unsigned char master_key
[TLS13_MAX_RESUMPTION_MASTER_LENGTH
];
500 /* session_id - valid? */
501 size_t session_id_length
;
502 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
504 * this is used to determine whether the session is being reused in the
505 * appropriate context. It is up to the application to set this, via
508 size_t sid_ctx_length
;
509 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
510 # ifndef OPENSSL_NO_PSK
511 char *psk_identity_hint
;
515 * Used to indicate that session resumption is not allowed. Applications
516 * can also set this bit for a new session via not_resumable_session_cb
517 * to disable session caching and tickets.
520 /* This is the cert and type for the other end. */
523 /* Certificate chain peer sent. */
524 STACK_OF(X509
) *peer_chain
;
526 * when app_verify_callback accepts a session where the peer's
527 * certificate is not ok, we must remember the error for session reuse:
529 long verify_result
; /* only for servers */
530 CRYPTO_REF_COUNT references
;
533 unsigned int compress_meth
; /* Need to lookup the method */
534 const SSL_CIPHER
*cipher
;
535 unsigned long cipher_id
; /* when ASN.1 loaded, this needs to be used to
536 * load the 'cipher' structure */
537 STACK_OF(SSL_CIPHER
) *ciphers
; /* shared ciphers? */
538 CRYPTO_EX_DATA ex_data
; /* application specific data */
540 * These are used to make removal of session-ids more efficient and to
541 * implement a maximum cache size.
543 struct ssl_session_st
*prev
, *next
;
547 # ifndef OPENSSL_NO_EC
548 size_t ecpointformats_len
;
549 unsigned char *ecpointformats
; /* peer's list */
550 size_t supportedgroups_len
;
551 unsigned char *supportedgroups
; /* peer's list */
552 # endif /* OPENSSL_NO_EC */
554 unsigned char *tick
; /* Session ticket */
555 size_t ticklen
; /* Session ticket length */
556 /* Session lifetime hint in seconds */
557 unsigned long tick_lifetime_hint
;
558 uint32_t tick_age_add
;
559 unsigned char *tick_nonce
;
560 size_t tick_nonce_len
;
562 /* Max number of bytes that can be sent as early data */
563 uint32_t max_early_data
;
564 /* The ALPN protocol selected for this session */
565 unsigned char *alpn_selected
;
566 size_t alpn_selected_len
;
568 # ifndef OPENSSL_NO_SRP
575 /* Extended master secret support */
576 # define SSL_SESS_FLAG_EXTMS 0x1
578 # ifndef OPENSSL_NO_SRP
580 typedef struct srp_ctx_st
{
581 /* param for all the callbacks */
583 /* set client Hello login callback */
584 int (*TLS_ext_srp_username_callback
) (SSL
*, int *, void *);
585 /* set SRP N/g param callback for verification */
586 int (*SRP_verify_param_callback
) (SSL
*, void *);
587 /* set SRP client passwd callback */
588 char *(*SRP_give_srp_client_pwd_callback
) (SSL
*, void *);
590 BIGNUM
*N
, *g
, *s
, *B
, *A
;
594 unsigned long srp_Mask
;
600 SSL_EARLY_DATA_NONE
= 0,
601 SSL_EARLY_DATA_CONNECT_RETRY
,
602 SSL_EARLY_DATA_CONNECTING
,
603 SSL_EARLY_DATA_WRITE_RETRY
,
604 SSL_EARLY_DATA_WRITING
,
605 SSL_EARLY_DATA_UNAUTH_WRITING
,
606 SSL_EARLY_DATA_FINISHED_WRITING
,
607 SSL_EARLY_DATA_ACCEPT_RETRY
,
608 SSL_EARLY_DATA_ACCEPTING
,
609 SSL_EARLY_DATA_READ_RETRY
,
610 SSL_EARLY_DATA_READING
,
611 SSL_EARLY_DATA_FINISHED_READING
612 } SSL_EARLY_DATA_STATE
;
615 * We check that the amount of unreadable early data doesn't exceed
616 * max_early_data. max_early_data is given in plaintext bytes. However if it is
617 * unreadable then we only know the number of ciphertext bytes. We also don't
618 * know how much the overhead should be because it depends on the ciphersuite.
619 * We make a small allowance. We assume 5 records of actual data plus the end
620 * of early data alert record. Each record has a tag and a content type byte.
621 * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
622 * content of the alert record either which is 2 bytes.
624 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
627 * The allowance we have between the client's calculated ticket age and our own.
628 * We allow for 10 seconds (units are in ms). If a ticket is presented and the
629 * client's age calculation is different by more than this than our own then we
630 * do not allow that ticket for early_data.
632 # define TICKET_AGE_ALLOWANCE (10 * 1000)
634 #define MAX_COMPRESSIONS_SIZE 255
642 typedef struct raw_extension_st
{
643 /* Raw packet data for the extension */
645 /* Set to 1 if the extension is present or 0 otherwise */
647 /* Set to 1 if we have already parsed the extension or 0 otherwise */
649 /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
651 /* Track what order extensions are received in (0-based). */
652 size_t received_order
;
657 unsigned int legacy_version
;
658 unsigned char random
[SSL3_RANDOM_SIZE
];
659 size_t session_id_len
;
660 unsigned char session_id
[SSL_MAX_SSL_SESSION_ID_LENGTH
];
661 size_t dtls_cookie_len
;
662 unsigned char dtls_cookie
[DTLS1_COOKIE_LENGTH
];
664 size_t compressions_len
;
665 unsigned char compressions
[MAX_COMPRESSIONS_SIZE
];
667 size_t pre_proc_exts_len
;
668 RAW_EXTENSION
*pre_proc_exts
;
672 * Extension index values NOTE: Any updates to these defines should be mirrored
673 * with equivalent updates to ext_defs in extensions.c
675 typedef enum tlsext_index_en
{
676 TLSEXT_IDX_renegotiate
,
677 TLSEXT_IDX_server_name
,
679 TLSEXT_IDX_ec_point_formats
,
680 TLSEXT_IDX_supported_groups
,
681 TLSEXT_IDX_session_ticket
,
682 TLSEXT_IDX_status_request
,
683 TLSEXT_IDX_next_proto_neg
,
684 TLSEXT_IDX_application_layer_protocol_negotiation
,
686 TLSEXT_IDX_encrypt_then_mac
,
687 TLSEXT_IDX_signed_certificate_timestamp
,
688 TLSEXT_IDX_extended_master_secret
,
689 TLSEXT_IDX_signature_algorithms
,
690 TLSEXT_IDX_supported_versions
,
691 TLSEXT_IDX_psk_kex_modes
,
692 TLSEXT_IDX_key_share
,
694 TLSEXT_IDX_cryptopro_bug
,
695 TLSEXT_IDX_early_data
,
696 TLSEXT_IDX_certificate_authorities
,
699 /* Dummy index - must always be the last entry */
700 TLSEXT_IDX_num_builtins
703 DEFINE_LHASH_OF(SSL_SESSION
);
704 /* Needed in ssl_cert.c */
705 DEFINE_LHASH_OF(X509_NAME
);
707 # define TLSEXT_KEYNAME_LENGTH 16
710 const SSL_METHOD
*method
;
711 STACK_OF(SSL_CIPHER
) *cipher_list
;
712 /* same as above but sorted for lookup */
713 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
714 struct x509_store_st
/* X509_STORE */ *cert_store
;
715 LHASH_OF(SSL_SESSION
) *sessions
;
717 * Most session-ids that will be cached, default is
718 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
720 size_t session_cache_size
;
721 struct ssl_session_st
*session_cache_head
;
722 struct ssl_session_st
*session_cache_tail
;
724 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
725 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
726 * means only SSL_accept which cache SSL_SESSIONS.
728 uint32_t session_cache_mode
;
730 * If timeout is not 0, it is the default timeout value set when
731 * SSL_new() is called. This has been put in to make life easier to set
734 long session_timeout
;
736 * If this callback is not null, it will be called each time a session id
737 * is added to the cache. If this function returns 1, it means that the
738 * callback will do a SSL_SESSION_free() when it has finished using it.
739 * Otherwise, on 0, it means the callback has finished with it. If
740 * remove_session_cb is not null, it will be called when a session-id is
741 * removed from the cache. After the call, OpenSSL will
742 * SSL_SESSION_free() it.
744 int (*new_session_cb
) (struct ssl_st
*ssl
, SSL_SESSION
*sess
);
745 void (*remove_session_cb
) (struct ssl_ctx_st
*ctx
, SSL_SESSION
*sess
);
746 SSL_SESSION
*(*get_session_cb
) (struct ssl_st
*ssl
,
747 const unsigned char *data
, int len
,
750 int sess_connect
; /* SSL new conn - started */
751 int sess_connect_renegotiate
; /* SSL reneg - requested */
752 int sess_connect_good
; /* SSL new conne/reneg - finished */
753 int sess_accept
; /* SSL new accept - started */
754 int sess_accept_renegotiate
; /* SSL reneg - requested */
755 int sess_accept_good
; /* SSL accept/reneg - finished */
756 int sess_miss
; /* session lookup misses */
757 int sess_timeout
; /* reuse attempt on timeouted session */
758 int sess_cache_full
; /* session removed due to full cache */
759 int sess_hit
; /* session reuse actually done */
760 int sess_cb_hit
; /* session-id that was not in the cache was
761 * passed back via the callback. This
762 * indicates that the application is supplying
763 * session-id's from other processes - spooky
767 CRYPTO_REF_COUNT references
;
769 /* if defined, these override the X509_verify_cert() calls */
770 int (*app_verify_callback
) (X509_STORE_CTX
*, void *);
771 void *app_verify_arg
;
773 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
774 * ('app_verify_callback' was called with just one argument)
777 /* Default password callback. */
778 pem_password_cb
*default_passwd_callback
;
780 /* Default password callback user data. */
781 void *default_passwd_callback_userdata
;
783 /* get client cert callback */
784 int (*client_cert_cb
) (SSL
*ssl
, X509
**x509
, EVP_PKEY
**pkey
);
786 /* cookie generate callback */
787 int (*app_gen_cookie_cb
) (SSL
*ssl
, unsigned char *cookie
,
788 unsigned int *cookie_len
);
790 /* verify cookie callback */
791 int (*app_verify_cookie_cb
) (SSL
*ssl
, const unsigned char *cookie
,
792 unsigned int cookie_len
);
794 CRYPTO_EX_DATA ex_data
;
796 const EVP_MD
*md5
; /* For SSLv3/TLSv1 'ssl3-md5' */
797 const EVP_MD
*sha1
; /* For SSLv3/TLSv1 'ssl3->sha1' */
799 STACK_OF(X509
) *extra_certs
;
800 STACK_OF(SSL_COMP
) *comp_methods
; /* stack of SSL_COMP, SSLv3/TLSv1 */
802 /* Default values used when no per-SSL value is defined follow */
804 /* used if SSL's info_callback is NULL */
805 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
808 * What we put in certificate_authorities extension for TLS 1.3
809 * (ClientHello and CertificateRequest) or just client cert requests for
812 STACK_OF(X509_NAME
) *ca_names
;
815 * Default values to use in SSL structures follow (these are copied by
821 int min_proto_version
;
822 int max_proto_version
;
823 size_t max_cert_list
;
825 struct cert_st
/* CERT */ *cert
;
828 /* callback that allows applications to peek at protocol messages */
829 void (*msg_callback
) (int write_p
, int version
, int content_type
,
830 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
831 void *msg_callback_arg
;
833 uint32_t verify_mode
;
834 size_t sid_ctx_length
;
835 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
836 /* called 'verify_callback' in the SSL */
837 int (*default_verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
839 /* Default generate session ID callback. */
840 GEN_SESSION_CB generate_session_id
;
842 X509_VERIFY_PARAM
*param
;
846 # ifndef OPENSSL_NO_CT
847 CTLOG_STORE
*ctlog_store
; /* CT Log Store */
849 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
850 * If they are not, the connection should be aborted.
852 ssl_ct_validation_cb ct_validation_callback
;
853 void *ct_validation_callback_arg
;
857 * If we're using more than one pipeline how should we divide the data
858 * up between the pipes?
860 size_t split_send_fragment
;
862 * Maximum amount of data to send in one fragment. actual record size can
863 * be more than this due to padding and MAC overheads.
865 size_t max_send_fragment
;
867 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
868 size_t max_pipelines
;
870 /* The default read buffer length to use (0 means not set) */
871 size_t default_read_buf_len
;
873 # ifndef OPENSSL_NO_ENGINE
875 * Engine to pass requests for client certs to
877 ENGINE
*client_cert_engine
;
880 /* ClientHello callback. Mostly for extensions, but not entirely. */
881 SSL_client_hello_cb_fn client_hello_cb
;
882 void *client_hello_cb_arg
;
884 /* TLS extensions. */
886 /* TLS extensions servername callback */
887 int (*servername_cb
) (SSL
*, int *, void *);
888 void *servername_arg
;
889 /* RFC 4507 session ticket keys */
890 unsigned char tick_key_name
[TLSEXT_KEYNAME_LENGTH
];
891 unsigned char tick_hmac_key
[32];
892 unsigned char tick_aes_key
[32];
893 /* Callback to support customisation of ticket key setting */
894 int (*ticket_key_cb
) (SSL
*ssl
,
895 unsigned char *name
, unsigned char *iv
,
896 EVP_CIPHER_CTX
*ectx
, HMAC_CTX
*hctx
, int enc
);
898 /* certificate status request info */
899 /* Callback for status request */
900 int (*status_cb
) (SSL
*ssl
, void *arg
);
902 /* ext status type used for CSR extension (OCSP Stapling) */
905 # ifndef OPENSSL_NO_EC
906 /* EC extension values inherited by SSL structure */
907 size_t ecpointformats_len
;
908 unsigned char *ecpointformats
;
909 size_t supportedgroups_len
;
910 unsigned char *supportedgroups
;
911 # endif /* OPENSSL_NO_EC */
914 * ALPN information (we are in the process of transitioning from NPN to
919 * For a server, this contains a callback function that allows the
920 * server to select the protocol for the connection.
921 * out: on successful return, this must point to the raw protocol
922 * name (without the length prefix).
923 * outlen: on successful return, this contains the length of |*out|.
924 * in: points to the client's list of supported protocols in
926 * inlen: the length of |in|.
928 int (*alpn_select_cb
) (SSL
*s
,
929 const unsigned char **out
,
930 unsigned char *outlen
,
931 const unsigned char *in
,
932 unsigned int inlen
, void *arg
);
933 void *alpn_select_cb_arg
;
936 * For a client, this contains the list of supported protocols in wire
942 # ifndef OPENSSL_NO_NEXTPROTONEG
943 /* Next protocol negotiation information */
946 * For a server, this contains a callback function by which the set of
947 * advertised protocols can be provided.
949 SSL_CTX_npn_advertised_cb_func npn_advertised_cb
;
950 void *npn_advertised_cb_arg
;
952 * For a client, this contains a callback function that selects the next
953 * protocol from the list provided by the server.
955 SSL_CTX_npn_select_cb_func npn_select_cb
;
956 void *npn_select_cb_arg
;
960 # ifndef OPENSSL_NO_PSK
961 SSL_psk_client_cb_func psk_client_callback
;
962 SSL_psk_server_cb_func psk_server_callback
;
964 SSL_psk_find_session_cb_func psk_find_session_cb
;
965 SSL_psk_use_session_cb_func psk_use_session_cb
;
967 # ifndef OPENSSL_NO_SRP
968 SRP_CTX srp_ctx
; /* ctx for SRP authentication */
971 /* Shared DANE context */
972 struct dane_ctx_st dane
;
974 /* SRTP profiles we are willing to do from RFC 5764 */
975 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
977 * Callback for disabling session caching and ticket support on a session
978 * basis, depending on the chosen cipher.
980 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
985 * Callback for logging key material for use with debugging tools like
986 * Wireshark. The callback should log `line` followed by a newline.
988 SSL_CTX_keylog_cb_func keylog_callback
;
990 /* The maximum number of bytes that can be sent as early data */
991 uint32_t max_early_data
;
993 /* TLS1.3 padding callback */
994 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
995 void *record_padding_arg
;
996 size_t block_padding
;
1001 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1006 const SSL_METHOD
*method
;
1008 * There are 2 BIO's even though they are normally both the same. This
1009 * is so data can be read and written to different handlers
1011 /* used by SSL_read */
1013 /* used by SSL_write */
1015 /* used during session-id reuse to concatenate messages */
1018 * This holds a variable that indicates what we were doing when a 0 or -1
1019 * is returned. This is needed for non-blocking IO so we know what
1020 * request needs re-doing when in SSL_accept or SSL_connect
1023 int (*handshake_func
) (SSL
*);
1025 * Imagine that here's a boolean member "init" that is switched as soon
1026 * as SSL_set_{accept/connect}_state is called for the first time, so
1027 * that "state" and "handshake_func" are properly initialized. But as
1028 * handshake_func is == 0 until then, we use this test instead of an
1031 /* are we the server side? */
1034 * Generate a new session or reuse an old one.
1035 * NB: For servers, the 'new' session may actually be a previously
1036 * cached session or even the previous session unless
1037 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1040 /* don't send shutdown packets */
1042 /* we have shut things down, 0x01 sent, 0x02 for received */
1046 SSL_EARLY_DATA_STATE early_data_state
;
1047 BUF_MEM
*init_buf
; /* buffer used during init */
1048 void *init_msg
; /* pointer to handshake message body, set by
1049 * ssl3_get_message() */
1050 size_t init_num
; /* amount read/written */
1051 size_t init_off
; /* amount read/written */
1052 struct ssl3_state_st
*s3
; /* SSLv3 variables */
1053 struct dtls1_state_st
*d1
; /* DTLSv1 variables */
1054 /* callback that allows applications to peek at protocol messages */
1055 void (*msg_callback
) (int write_p
, int version
, int content_type
,
1056 const void *buf
, size_t len
, SSL
*ssl
, void *arg
);
1057 void *msg_callback_arg
;
1058 int hit
; /* reusing a previous session */
1059 X509_VERIFY_PARAM
*param
;
1060 /* Per connection DANE state */
1063 STACK_OF(SSL_CIPHER
) *cipher_list
;
1064 STACK_OF(SSL_CIPHER
) *cipher_list_by_id
;
1066 * These are the ones being used, the ones in SSL_SESSION are the ones to
1067 * be 'copied' into these ones
1071 * The TLS1.3 secrets. The resumption master secret is stored in the
1074 unsigned char early_secret
[EVP_MAX_MD_SIZE
];
1075 unsigned char handshake_secret
[EVP_MAX_MD_SIZE
];
1076 unsigned char master_secret
[EVP_MAX_MD_SIZE
];
1077 unsigned char client_finished_secret
[EVP_MAX_MD_SIZE
];
1078 unsigned char server_finished_secret
[EVP_MAX_MD_SIZE
];
1079 unsigned char server_finished_hash
[EVP_MAX_MD_SIZE
];
1080 unsigned char handshake_traffic_hash
[EVP_MAX_MD_SIZE
];
1081 unsigned char client_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1082 unsigned char server_app_traffic_secret
[EVP_MAX_MD_SIZE
];
1083 unsigned char exporter_master_secret
[EVP_MAX_MD_SIZE
];
1084 EVP_CIPHER_CTX
*enc_read_ctx
; /* cryptographic state */
1085 unsigned char read_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static read IV */
1086 EVP_MD_CTX
*read_hash
; /* used for mac generation */
1087 COMP_CTX
*compress
; /* compression */
1088 COMP_CTX
*expand
; /* uncompress */
1089 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1090 unsigned char write_iv
[EVP_MAX_IV_LENGTH
]; /* TLSv1.3 static write IV */
1091 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1092 /* Count of how many KeyUpdate messages we have received */
1093 unsigned int key_update_count
;
1096 /* This is used to hold the server certificate used */
1097 struct cert_st
/* CERT */ *cert
;
1100 * The hash of all messages prior to the CertificateVerify, and the length
1103 unsigned char cert_verify_hash
[EVP_MAX_MD_SIZE
];
1104 size_t cert_verify_hash_len
;
1106 /* Flag to indicate whether we should send a HelloRetryRequest or not */
1107 int hello_retry_request
;
1110 * the session_id_context is used to ensure sessions are only reused in
1111 * the appropriate context
1113 size_t sid_ctx_length
;
1114 unsigned char sid_ctx
[SSL_MAX_SID_CTX_LENGTH
];
1115 /* This can also be in the session once a session is established */
1116 SSL_SESSION
*session
;
1117 /* TLSv1.3 PSK session */
1118 SSL_SESSION
*psksession
;
1119 unsigned char *psksession_id
;
1120 size_t psksession_id_len
;
1121 /* Default generate session ID callback. */
1122 GEN_SESSION_CB generate_session_id
;
1125 * 0 don't care about verify failure.
1126 * 1 fail if verify fails
1128 uint32_t verify_mode
;
1129 /* fail if callback returns 0 */
1130 int (*verify_callback
) (int ok
, X509_STORE_CTX
*ctx
);
1131 /* optional informational callback */
1132 void (*info_callback
) (const SSL
*ssl
, int type
, int val
);
1133 /* error bytes to be written */
1137 # ifndef OPENSSL_NO_PSK
1138 SSL_psk_client_cb_func psk_client_callback
;
1139 SSL_psk_server_cb_func psk_server_callback
;
1141 SSL_psk_find_session_cb_func psk_find_session_cb
;
1142 SSL_psk_use_session_cb_func psk_use_session_cb
;
1144 /* Verified chain of peer */
1145 STACK_OF(X509
) *verified_chain
;
1147 /* extra application data */
1148 CRYPTO_EX_DATA ex_data
;
1149 /* for server side, keep the list of CA_dn we can use */
1150 STACK_OF(X509_NAME
) *ca_names
;
1151 CRYPTO_REF_COUNT references
;
1152 /* protocol behaviour */
1156 int min_proto_version
;
1157 int max_proto_version
;
1158 size_t max_cert_list
;
1161 * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1162 * secret and SSLv3/TLS (<=1.2) rollback check
1166 * If we're using more than one pipeline how should we divide the data
1167 * up between the pipes?
1169 size_t split_send_fragment
;
1171 * Maximum amount of data to send in one fragment. actual record size can
1172 * be more than this due to padding and MAC overheads.
1174 size_t max_send_fragment
;
1175 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1176 size_t max_pipelines
;
1179 /* Built-in extension flags */
1180 uint8_t extflags
[TLSEXT_IDX_num_builtins
];
1181 /* TLS extension debug callback */
1182 void (*debug_cb
)(SSL
*s
, int client_server
, int type
,
1183 const unsigned char *data
, int len
, void *arg
);
1186 /* certificate status request info */
1187 /* Status type or -1 if no status type */
1189 /* Raw extension data, if seen */
1190 unsigned char *scts
;
1191 /* Length of raw extension data, if seen */
1193 /* Expect OCSP CertificateStatus message */
1194 int status_expected
;
1197 /* OCSP status request only */
1198 STACK_OF(OCSP_RESPID
) *ids
;
1199 X509_EXTENSIONS
*exts
;
1200 /* OCSP response received or to be sent */
1201 unsigned char *resp
;
1205 /* RFC4507 session ticket expected to be received or sent */
1206 int ticket_expected
;
1207 # ifndef OPENSSL_NO_EC
1208 size_t ecpointformats_len
;
1210 unsigned char *ecpointformats
;
1211 size_t supportedgroups_len
;
1213 unsigned char *supportedgroups
;
1214 # endif /* OPENSSL_NO_EC */
1215 /* TLS Session Ticket extension override */
1216 TLS_SESSION_TICKET_EXT
*session_ticket
;
1217 /* TLS Session Ticket extension callback */
1218 tls_session_ticket_ext_cb_fn session_ticket_cb
;
1219 void *session_ticket_cb_arg
;
1220 /* TLS pre-shared secret session resumption */
1221 tls_session_secret_cb_fn session_secret_cb
;
1222 void *session_secret_cb_arg
;
1224 * For a client, this contains the list of supported protocols in wire
1227 unsigned char *alpn
;
1230 * Next protocol negotiation. For the client, this is the protocol that
1231 * we sent in NextProtocol and is set when handling ServerHello
1232 * extensions. For a server, this is the client's selected_protocol from
1233 * NextProtocol and is set when handling the NextProtocol message, before
1234 * the Finished message.
1239 /* The available PSK key exchange modes */
1242 /* Set to one if we have negotiated ETM */
1245 /* Are we expecting to receive early data? */
1247 /* Is the session suitable for early data? */
1250 /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1251 unsigned char *tls13_cookie
;
1252 size_t tls13_cookie_len
;
1256 * Parsed form of the ClientHello, kept around across client_hello_cb
1259 CLIENTHELLO_MSG
*clienthello
;
1262 * no further mod of servername
1263 * 0 : call the servername extension callback.
1264 * 1 : prepare 2, allow last ack just after in server callback.
1265 * 2 : don't call servername callback, no ack in server hello
1267 int servername_done
;
1268 # ifndef OPENSSL_NO_CT
1270 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1271 * If they are not, the connection should be aborted.
1273 ssl_ct_validation_cb ct_validation_callback
;
1274 /* User-supplied argument that is passed to the ct_validation_callback */
1275 void *ct_validation_callback_arg
;
1277 * Consolidated stack of SCTs from all sources.
1278 * Lazily populated by CT_get_peer_scts(SSL*)
1280 STACK_OF(SCT
) *scts
;
1281 /* Have we attempted to find/parse SCTs yet? */
1284 SSL_CTX
*session_ctx
; /* initial ctx, used to store sessions */
1286 STACK_OF(SRTP_PROTECTION_PROFILE
) *srtp_profiles
;
1287 /* What's been chosen */
1288 SRTP_PROTECTION_PROFILE
*srtp_profile
;
1290 * 1 if we are renegotiating.
1291 * 2 if we are a server and are inside a handshake
1292 * (i.e. not just sending a HelloRequest)
1295 /* If sending a KeyUpdate is pending */
1297 # ifndef OPENSSL_NO_SRP
1298 /* ctx for SRP authentication */
1302 * Callback for disabling session caching and ticket support on a session
1303 * basis, depending on the chosen cipher.
1305 int (*not_resumable_session_cb
) (SSL
*ssl
, int is_forward_secure
);
1306 RECORD_LAYER rlayer
;
1307 /* Default password callback. */
1308 pem_password_cb
*default_passwd_callback
;
1309 /* Default password callback user data. */
1310 void *default_passwd_callback_userdata
;
1311 /* Async Job info */
1313 ASYNC_WAIT_CTX
*waitctx
;
1316 /* The maximum number of plaintext bytes that can be sent as early data */
1317 uint32_t max_early_data
;
1319 * The number of bytes of early data received so far. If we accepted early
1320 * data then this is a count of the plaintext bytes. If we rejected it then
1321 * this is a count of the ciphertext bytes.
1323 uint32_t early_data_count
;
1325 /* TLS1.3 padding callback */
1326 size_t (*record_padding_cb
)(SSL
*s
, int type
, size_t len
, void *arg
);
1327 void *record_padding_arg
;
1328 size_t block_padding
;
1330 CRYPTO_RWLOCK
*lock
;
1335 * Structure containing table entry of values associated with the signature
1336 * algorithms (signature scheme) extension
1338 typedef struct sigalg_lookup_st
{
1339 /* TLS 1.3 signature scheme name */
1341 /* Raw value used in extension */
1343 /* NID of hash algorithm or NID_undef if no hash */
1345 /* Index of hash algorithm or -1 if no hash algorithm */
1347 /* NID of signature algorithm */
1349 /* Index of signature algorithm */
1351 /* Combined hash and signature NID, if any */
1353 /* Required public key curve (ECDSA only) */
1357 typedef struct cert_pkey_st CERT_PKEY
;
1360 * Structure containing table entry of certificate info corresponding to
1364 int nid
; /* NID of pubic key algorithm */
1365 uint32_t amask
; /* authmask corresponding to key type */
1368 typedef struct ssl3_state_st
{
1370 size_t read_mac_secret_size
;
1371 unsigned char read_mac_secret
[EVP_MAX_MD_SIZE
];
1372 size_t write_mac_secret_size
;
1373 unsigned char write_mac_secret
[EVP_MAX_MD_SIZE
];
1374 unsigned char server_random
[SSL3_RANDOM_SIZE
];
1375 unsigned char client_random
[SSL3_RANDOM_SIZE
];
1376 /* flags for countermeasure against known-IV weakness */
1377 int need_empty_fragments
;
1378 int empty_fragment_done
;
1379 /* used during startup, digest all incoming/outgoing packets */
1380 BIO
*handshake_buffer
;
1382 * When handshake digest is determined, buffer is hashed and
1383 * freed and MD_CTX for the required digest is stored here.
1385 EVP_MD_CTX
*handshake_dgst
;
1387 * Set whenever an expected ChangeCipherSpec message is processed.
1388 * Unset when the peer's Finished message is received.
1389 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1391 int change_cipher_spec
;
1395 * we allow one fatal and one warning alert to be outstanding, send close
1396 * alert via the warning alert
1399 unsigned char send_alert
[2];
1401 * This flag is set when we should renegotiate ASAP, basically when there
1402 * is no more data in the read or write buffers
1405 int total_renegotiations
;
1406 int num_renegotiations
;
1407 int in_read_app_data
;
1409 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1410 unsigned char finish_md
[EVP_MAX_MD_SIZE
* 2];
1411 size_t finish_md_len
;
1412 unsigned char peer_finish_md
[EVP_MAX_MD_SIZE
* 2];
1413 size_t peer_finish_md_len
;
1414 size_t message_size
;
1416 /* used to hold the new cipher we are going to use */
1417 const SSL_CIPHER
*new_cipher
;
1418 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1419 EVP_PKEY
*pkey
; /* holds short lived DH/ECDH key */
1421 /* used for certificate requests */
1423 /* Certificate types in certificate request message. */
1426 /* Certificate authorities list peer sent */
1427 STACK_OF(X509_NAME
) *peer_ca_names
;
1428 size_t key_block_length
;
1429 unsigned char *key_block
;
1430 const EVP_CIPHER
*new_sym_enc
;
1431 const EVP_MD
*new_hash
;
1432 int new_mac_pkey_type
;
1433 size_t new_mac_secret_size
;
1434 # ifndef OPENSSL_NO_COMP
1435 const SSL_COMP
*new_compression
;
1437 char *new_compression
;
1440 /* Raw values of the cipher list from a client */
1441 unsigned char *ciphers_raw
;
1442 size_t ciphers_rawlen
;
1443 /* Temporary storage for premaster secret */
1446 # ifndef OPENSSL_NO_PSK
1447 /* Temporary storage for PSK key */
1451 /* Signature algorithm we actually use */
1452 const SIGALG_LOOKUP
*sigalg
;
1453 /* Pointer to certificate we use */
1456 * signature algorithms peer reports: e.g. supported signature
1457 * algorithms extension for server or as part of a certificate
1458 * request for client.
1460 uint16_t *peer_sigalgs
;
1461 /* Size of above array */
1462 size_t peer_sigalgslen
;
1463 /* Sigalg peer actualy uses */
1464 const SIGALG_LOOKUP
*peer_sigalg
;
1466 * Set if corresponding CERT_PKEY can be used with current
1467 * SSL session: e.g. appropriate curve, signature algorithms etc.
1468 * If zero it can't be used at all.
1470 uint32_t valid_flags
[SSL_PKEY_NUM
];
1472 * For servers the following masks are for the key and auth algorithms
1473 * that are supported by the certs below. For clients they are masks of
1474 * *disabled* algorithms based on the current session.
1479 * The following are used by the client to see if a cipher is allowed or
1480 * not. It contains the minimum and maximum version the client's using
1481 * based on what it knows so far.
1487 /* Connection binding to prevent renegotiation attacks */
1488 unsigned char previous_client_finished
[EVP_MAX_MD_SIZE
];
1489 size_t previous_client_finished_len
;
1490 unsigned char previous_server_finished
[EVP_MAX_MD_SIZE
];
1491 size_t previous_server_finished_len
;
1492 int send_connection_binding
; /* TODOEKR */
1494 # ifndef OPENSSL_NO_NEXTPROTONEG
1496 * Set if we saw the Next Protocol Negotiation extension from our peer.
1502 * ALPN information (we are in the process of transitioning from NPN to
1507 * In a server these point to the selected ALPN protocol after the
1508 * ClientHello has been processed. In a client these contain the protocol
1509 * that the server selected once the ServerHello has been processed.
1511 unsigned char *alpn_selected
;
1512 size_t alpn_selected_len
;
1513 /* used by the server to know what options were proposed */
1514 unsigned char *alpn_proposed
;
1515 size_t alpn_proposed_len
;
1516 /* used by the client to know if it actually sent alpn */
1519 # ifndef OPENSSL_NO_EC
1521 * This is set to true if we believe that this is a version of Safari
1522 * running on OS X 10.6 or newer. We wish to know this because Safari on
1523 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1525 char is_probably_safari
;
1526 # endif /* !OPENSSL_NO_EC */
1528 /* For clients: peer temporary key */
1529 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1530 /* The group_id for the DH/ECDH key */
1531 unsigned int group_id
;
1537 /* DTLS structures */
1539 # ifndef OPENSSL_NO_SCTP
1540 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1543 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1544 # define DTLS1_MAX_MTU_OVERHEAD 48
1547 * Flag used in message reuse to indicate the buffer contains the record
1548 * header as well as the the handshake message header.
1550 # define DTLS1_SKIP_RECORD_HEADER 2
1552 struct dtls1_retransmit_state
{
1553 EVP_CIPHER_CTX
*enc_write_ctx
; /* cryptographic state */
1554 EVP_MD_CTX
*write_hash
; /* used for mac generation */
1555 COMP_CTX
*compress
; /* compression */
1556 SSL_SESSION
*session
;
1557 unsigned short epoch
;
1560 struct hm_header_st
{
1566 unsigned int is_ccs
;
1567 struct dtls1_retransmit_state saved_retransmit_state
;
1570 struct dtls1_timeout_st
{
1571 /* Number of read timeouts so far */
1572 unsigned int read_timeouts
;
1573 /* Number of write timeouts so far */
1574 unsigned int write_timeouts
;
1575 /* Number of alerts received so far */
1576 unsigned int num_alerts
;
1579 typedef struct hm_fragment_st
{
1580 struct hm_header_st msg_header
;
1581 unsigned char *fragment
;
1582 unsigned char *reassembly
;
1585 typedef struct pqueue_st pqueue
;
1586 typedef struct pitem_st pitem
;
1589 unsigned char priority
[8]; /* 64-bit value in big-endian encoding */
1594 typedef struct pitem_st
*piterator
;
1596 pitem
*pitem_new(unsigned char *prio64be
, void *data
);
1597 void pitem_free(pitem
*item
);
1598 pqueue
*pqueue_new(void);
1599 void pqueue_free(pqueue
*pq
);
1600 pitem
*pqueue_insert(pqueue
*pq
, pitem
*item
);
1601 pitem
*pqueue_peek(pqueue
*pq
);
1602 pitem
*pqueue_pop(pqueue
*pq
);
1603 pitem
*pqueue_find(pqueue
*pq
, unsigned char *prio64be
);
1604 pitem
*pqueue_iterator(pqueue
*pq
);
1605 pitem
*pqueue_next(piterator
*iter
);
1606 size_t pqueue_size(pqueue
*pq
);
1608 typedef struct dtls1_state_st
{
1609 unsigned char cookie
[DTLS1_COOKIE_LENGTH
];
1611 unsigned int cookie_verified
;
1612 /* handshake message numbers */
1613 unsigned short handshake_write_seq
;
1614 unsigned short next_handshake_write_seq
;
1615 unsigned short handshake_read_seq
;
1616 /* Buffered handshake messages */
1617 pqueue
*buffered_messages
;
1618 /* Buffered (sent) handshake records */
1619 pqueue
*sent_messages
;
1620 size_t link_mtu
; /* max on-the-wire DTLS packet size */
1621 size_t mtu
; /* max DTLS packet size */
1622 struct hm_header_st w_msg_hdr
;
1623 struct hm_header_st r_msg_hdr
;
1624 struct dtls1_timeout_st timeout
;
1626 * Indicates when the last handshake msg sent will timeout
1628 struct timeval next_timeout
;
1629 /* Timeout duration */
1630 unsigned int timeout_duration_us
;
1632 unsigned int retransmitting
;
1633 # ifndef OPENSSL_NO_SCTP
1634 int shutdown_received
;
1637 DTLS_timer_cb timer_cb
;
1641 # ifndef OPENSSL_NO_EC
1643 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1645 # define EXPLICIT_PRIME_CURVE_TYPE 1
1646 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1647 # define NAMED_CURVE_TYPE 3
1648 # endif /* OPENSSL_NO_EC */
1650 struct cert_pkey_st
{
1652 EVP_PKEY
*privatekey
;
1653 /* Chain for this certificate */
1654 STACK_OF(X509
) *chain
;
1656 * serverinfo data for this certificate. The data is in TLS Extension
1657 * wire format, specifically it's a series of records like:
1658 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1660 * uint8_t data[length];
1662 unsigned char *serverinfo
;
1663 size_t serverinfo_length
;
1665 /* Retrieve Suite B flags */
1666 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1667 /* Uses to check strict mode: suite B modes are always strict */
1668 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1669 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1672 ENDPOINT_CLIENT
= 0,
1679 unsigned short ext_type
;
1681 /* The context which this extension applies to */
1682 unsigned int context
;
1684 * Per-connection flags relating to this extension type: not used if
1685 * part of an SSL_CTX structure.
1688 SSL_custom_ext_add_cb_ex add_cb
;
1689 SSL_custom_ext_free_cb_ex free_cb
;
1691 SSL_custom_ext_parse_cb_ex parse_cb
;
1693 } custom_ext_method
;
1695 /* ext_flags values */
1698 * Indicates an extension has been received. Used to check for unsolicited or
1699 * duplicate extensions.
1701 # define SSL_EXT_FLAG_RECEIVED 0x1
1703 * Indicates an extension has been sent: used to enable sending of
1704 * corresponding ServerHello extension.
1706 # define SSL_EXT_FLAG_SENT 0x2
1709 custom_ext_method
*meths
;
1711 } custom_ext_methods
;
1713 typedef struct cert_st
{
1714 /* Current active set */
1716 * ALWAYS points to an element of the pkeys array
1717 * Probably it would make more sense to store
1718 * an index, not a pointer.
1721 # ifndef OPENSSL_NO_DH
1723 DH
*(*dh_tmp_cb
) (SSL
*ssl
, int is_export
, int keysize
);
1726 /* Flags related to certificates */
1727 uint32_t cert_flags
;
1728 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
1729 /* Custom certificate types sent in certificate request message. */
1733 * supported signature algorithms. When set on a client this is sent in
1734 * the client hello as the supported signature algorithms extension. For
1735 * servers it represents the signature algorithms we are willing to use.
1737 uint16_t *conf_sigalgs
;
1738 /* Size of above array */
1739 size_t conf_sigalgslen
;
1741 * Client authentication signature algorithms, if not set then uses
1742 * conf_sigalgs. On servers these will be the signature algorithms sent
1743 * to the client in a certificate request for TLS 1.2. On a client this
1744 * represents the signature algorithms we are willing to use for client
1747 uint16_t *client_sigalgs
;
1748 /* Size of above array */
1749 size_t client_sigalgslen
;
1751 * Signature algorithms shared by client and server: cached because these
1752 * are used most often.
1754 const SIGALG_LOOKUP
**shared_sigalgs
;
1755 size_t shared_sigalgslen
;
1757 * Certificate setup callback: if set is called whenever a certificate
1758 * may be required (client or server). the callback can then examine any
1759 * appropriate parameters and setup any certificates required. This
1760 * allows advanced applications to select certificates on the fly: for
1761 * example based on supported signature algorithms or curves.
1763 int (*cert_cb
) (SSL
*ssl
, void *arg
);
1766 * Optional X509_STORE for chain building or certificate validation If
1767 * NULL the parent SSL_CTX store is used instead.
1769 X509_STORE
*chain_store
;
1770 X509_STORE
*verify_store
;
1771 /* Custom extensions */
1772 custom_ext_methods custext
;
1773 /* Security callback */
1774 int (*sec_cb
) (const SSL
*s
, const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
1775 void *other
, void *ex
);
1776 /* Security level */
1779 # ifndef OPENSSL_NO_PSK
1780 /* If not NULL psk identity hint to use for servers */
1781 char *psk_identity_hint
;
1783 CRYPTO_REF_COUNT references
; /* >1 only if SSL_copy_session_id is used */
1784 CRYPTO_RWLOCK
*lock
;
1787 # define FP_ICC (int (*)(const void *,const void *))
1790 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1791 * of a mess of functions, but hell, think of it as an opaque structure :-)
1793 typedef struct ssl3_enc_method
{
1794 int (*enc
) (SSL
*, SSL3_RECORD
*, size_t, int);
1795 int (*mac
) (SSL
*, SSL3_RECORD
*, unsigned char *, int);
1796 int (*setup_key_block
) (SSL
*);
1797 int (*generate_master_secret
) (SSL
*, unsigned char *, unsigned char *,
1799 int (*change_cipher_state
) (SSL
*, int);
1800 size_t (*final_finish_mac
) (SSL
*, const char *, size_t, unsigned char *);
1801 const char *client_finished_label
;
1802 size_t client_finished_label_len
;
1803 const char *server_finished_label
;
1804 size_t server_finished_label_len
;
1805 int (*alert_value
) (int);
1806 int (*export_keying_material
) (SSL
*, unsigned char *, size_t,
1807 const char *, size_t,
1808 const unsigned char *, size_t,
1810 /* Various flags indicating protocol version requirements */
1812 /* Set the handshake header */
1813 int (*set_handshake_header
) (SSL
*s
, WPACKET
*pkt
, int type
);
1814 /* Close construction of the handshake message */
1815 int (*close_construct_packet
) (SSL
*s
, WPACKET
*pkt
, int htype
);
1816 /* Write out handshake message */
1817 int (*do_write
) (SSL
*s
);
1820 # define ssl_set_handshake_header(s, pkt, htype) \
1821 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1822 # define ssl_close_construct_packet(s, pkt, htype) \
1823 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1824 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1826 /* Values for enc_flags */
1828 /* Uses explicit IV for CBC mode */
1829 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1830 /* Uses signature algorithms extension */
1831 # define SSL_ENC_FLAG_SIGALGS 0x2
1832 /* Uses SHA256 default PRF */
1833 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1835 # define SSL_ENC_FLAG_DTLS 0x8
1837 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1838 * apply to others in future.
1840 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1842 # ifndef OPENSSL_NO_COMP
1843 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1844 typedef struct ssl3_comp_st
{
1845 int comp_id
; /* The identifier byte for this compression
1847 char *name
; /* Text name used for the compression type */
1848 COMP_METHOD
*method
; /* The method :-) */
1852 typedef enum downgrade_en
{
1859 * Dummy status type for the status_type extension. Indicates no status type
1862 #define TLSEXT_STATUSTYPE_nothing -1
1864 /* Sigalgs values */
1865 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256 0x0403
1866 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384 0x0503
1867 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512 0x0603
1868 #define TLSEXT_SIGALG_ecdsa_sha224 0x0303
1869 #define TLSEXT_SIGALG_ecdsa_sha1 0x0203
1870 #define TLSEXT_SIGALG_rsa_pss_sha256 0x0804
1871 #define TLSEXT_SIGALG_rsa_pss_sha384 0x0805
1872 #define TLSEXT_SIGALG_rsa_pss_sha512 0x0806
1873 #define TLSEXT_SIGALG_rsa_pkcs1_sha256 0x0401
1874 #define TLSEXT_SIGALG_rsa_pkcs1_sha384 0x0501
1875 #define TLSEXT_SIGALG_rsa_pkcs1_sha512 0x0601
1876 #define TLSEXT_SIGALG_rsa_pkcs1_sha224 0x0301
1877 #define TLSEXT_SIGALG_rsa_pkcs1_sha1 0x0201
1878 #define TLSEXT_SIGALG_dsa_sha256 0x0402
1879 #define TLSEXT_SIGALG_dsa_sha384 0x0502
1880 #define TLSEXT_SIGALG_dsa_sha512 0x0602
1881 #define TLSEXT_SIGALG_dsa_sha224 0x0302
1882 #define TLSEXT_SIGALG_dsa_sha1 0x0202
1883 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256 0xeeee
1884 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512 0xefef
1885 #define TLSEXT_SIGALG_gostr34102001_gostr3411 0xeded
1887 #define TLSEXT_SIGALG_ed25519 0x0807
1889 /* Known PSK key exchange modes */
1890 #define TLSEXT_KEX_MODE_KE 0x00
1891 #define TLSEXT_KEX_MODE_KE_DHE 0x01
1894 * Internal representations of key exchange modes
1896 #define TLSEXT_KEX_MODE_FLAG_NONE 0
1897 #define TLSEXT_KEX_MODE_FLAG_KE 1
1898 #define TLSEXT_KEX_MODE_FLAG_KE_DHE 2
1900 /* An invalid index into the TLSv1.3 PSK identities */
1901 #define TLSEXT_PSK_BAD_IDENTITY -1
1903 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1904 s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1906 /* A dummy signature value not valid for TLSv1.2 signature algs */
1907 #define TLSEXT_signature_rsa_pss 0x0101
1909 /* TLSv1.3 downgrade protection sentinel values */
1910 extern const unsigned char tls11downgrade
[8];
1911 extern const unsigned char tls12downgrade
[8];
1913 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
1915 __owur
const SSL_METHOD
*ssl_bad_method(int ver
);
1916 __owur
const SSL_METHOD
*sslv3_method(void);
1917 __owur
const SSL_METHOD
*sslv3_server_method(void);
1918 __owur
const SSL_METHOD
*sslv3_client_method(void);
1919 __owur
const SSL_METHOD
*tlsv1_method(void);
1920 __owur
const SSL_METHOD
*tlsv1_server_method(void);
1921 __owur
const SSL_METHOD
*tlsv1_client_method(void);
1922 __owur
const SSL_METHOD
*tlsv1_1_method(void);
1923 __owur
const SSL_METHOD
*tlsv1_1_server_method(void);
1924 __owur
const SSL_METHOD
*tlsv1_1_client_method(void);
1925 __owur
const SSL_METHOD
*tlsv1_2_method(void);
1926 __owur
const SSL_METHOD
*tlsv1_2_server_method(void);
1927 __owur
const SSL_METHOD
*tlsv1_2_client_method(void);
1928 __owur
const SSL_METHOD
*tlsv1_3_method(void);
1929 __owur
const SSL_METHOD
*tlsv1_3_server_method(void);
1930 __owur
const SSL_METHOD
*tlsv1_3_client_method(void);
1931 __owur
const SSL_METHOD
*dtlsv1_method(void);
1932 __owur
const SSL_METHOD
*dtlsv1_server_method(void);
1933 __owur
const SSL_METHOD
*dtlsv1_client_method(void);
1934 __owur
const SSL_METHOD
*dtls_bad_ver_client_method(void);
1935 __owur
const SSL_METHOD
*dtlsv1_2_method(void);
1936 __owur
const SSL_METHOD
*dtlsv1_2_server_method(void);
1937 __owur
const SSL_METHOD
*dtlsv1_2_client_method(void);
1939 extern const SSL3_ENC_METHOD TLSv1_enc_data
;
1940 extern const SSL3_ENC_METHOD TLSv1_1_enc_data
;
1941 extern const SSL3_ENC_METHOD TLSv1_2_enc_data
;
1942 extern const SSL3_ENC_METHOD TLSv1_3_enc_data
;
1943 extern const SSL3_ENC_METHOD SSLv3_enc_data
;
1944 extern const SSL3_ENC_METHOD DTLSv1_enc_data
;
1945 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data
;
1948 * Flags for SSL methods
1950 # define SSL_METHOD_NO_FIPS (1U<<0)
1951 # define SSL_METHOD_NO_SUITEB (1U<<1)
1953 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1954 s_connect, enc_data) \
1955 const SSL_METHOD *func_name(void) \
1957 static const SSL_METHOD func_name##_data= { \
1971 ssl3_renegotiate_check, \
1974 ssl3_dispatch_alert, \
1977 ssl3_get_cipher_by_char, \
1978 ssl3_put_cipher_by_char, \
1982 tls1_default_timeout, \
1984 ssl_undefined_void_function, \
1985 ssl3_callback_ctrl, \
1986 ssl3_ctx_callback_ctrl, \
1988 return &func_name##_data; \
1991 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1992 const SSL_METHOD *func_name(void) \
1994 static const SSL_METHOD func_name##_data= { \
1996 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
2008 ssl3_renegotiate_check, \
2011 ssl3_dispatch_alert, \
2014 ssl3_get_cipher_by_char, \
2015 ssl3_put_cipher_by_char, \
2019 ssl3_default_timeout, \
2021 ssl_undefined_void_function, \
2022 ssl3_callback_ctrl, \
2023 ssl3_ctx_callback_ctrl, \
2025 return &func_name##_data; \
2028 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2029 s_connect, enc_data) \
2030 const SSL_METHOD *func_name(void) \
2032 static const SSL_METHOD func_name##_data= { \
2046 ssl3_renegotiate_check, \
2048 dtls1_write_app_data_bytes, \
2049 dtls1_dispatch_alert, \
2052 ssl3_get_cipher_by_char, \
2053 ssl3_put_cipher_by_char, \
2057 dtls1_default_timeout, \
2059 ssl_undefined_void_function, \
2060 ssl3_callback_ctrl, \
2061 ssl3_ctx_callback_ctrl, \
2063 return &func_name##_data; \
2066 struct openssl_ssl_test_functions
{
2067 int (*p_ssl_init_wbio_buffer
) (SSL
*s
);
2068 int (*p_ssl3_setup_buffers
) (SSL
*s
);
2071 const char *ssl_protocol_to_string(int version
);
2073 /* Returns true if certificate and private key for 'idx' are present */
2074 static ossl_inline
int ssl_has_cert(const SSL
*s
, int idx
)
2076 if (idx
< 0 || idx
>= SSL_PKEY_NUM
)
2078 return s
->cert
->pkeys
[idx
].x509
!= NULL
2079 && s
->cert
->pkeys
[idx
].privatekey
!= NULL
;
2082 # ifndef OPENSSL_UNIT_TEST
2084 __owur
int ssl_read_internal(SSL
*s
, void *buf
, size_t num
, size_t *readbytes
);
2085 __owur
int ssl_write_internal(SSL
*s
, const void *buf
, size_t num
, size_t *written
);
2086 void ssl_clear_cipher_ctx(SSL
*s
);
2087 int ssl_clear_bad_session(SSL
*s
);
2088 __owur CERT
*ssl_cert_new(void);
2089 __owur CERT
*ssl_cert_dup(CERT
*cert
);
2090 void ssl_cert_clear_certs(CERT
*c
);
2091 void ssl_cert_free(CERT
*c
);
2092 __owur
int ssl_get_new_session(SSL
*s
, int session
);
2093 __owur
int ssl_get_prev_session(SSL
*s
, CLIENTHELLO_MSG
*hello
, int *al
);
2094 __owur SSL_SESSION
*ssl_session_dup(SSL_SESSION
*src
, int ticket
);
2095 __owur
int ssl_cipher_id_cmp(const SSL_CIPHER
*a
, const SSL_CIPHER
*b
);
2096 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER
, SSL_CIPHER
, ssl_cipher_id
);
2097 __owur
int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
*const *ap
,
2098 const SSL_CIPHER
*const *bp
);
2099 __owur
STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
2100 STACK_OF(SSL_CIPHER
) **pref
,
2101 STACK_OF(SSL_CIPHER
)
2103 const char *rule_str
,
2105 __owur
int ssl_cache_cipherlist(SSL
*s
, PACKET
*cipher_suites
,
2106 int sslv2format
, int *al
);
2107 __owur
int bytes_to_cipher_list(SSL
*s
, PACKET
*cipher_suites
,
2108 STACK_OF(SSL_CIPHER
) **skp
,
2109 STACK_OF(SSL_CIPHER
) **scsvs
, int sslv2format
,
2111 void ssl_update_cache(SSL
*s
, int mode
);
2112 __owur
int ssl_cipher_get_evp(const SSL_SESSION
*s
, const EVP_CIPHER
**enc
,
2113 const EVP_MD
**md
, int *mac_pkey_type
,
2114 size_t *mac_secret_size
, SSL_COMP
**comp
,
2116 __owur
int ssl_cipher_get_overhead(const SSL_CIPHER
*c
, size_t *mac_overhead
,
2117 size_t *int_overhead
, size_t *blocksize
,
2118 size_t *ext_overhead
);
2119 __owur
int ssl_cert_is_disabled(size_t idx
);
2120 __owur
const SSL_CIPHER
*ssl_get_cipher_by_char(SSL
*ssl
,
2121 const unsigned char *ptr
,
2123 __owur
int ssl_cert_set0_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2124 __owur
int ssl_cert_set1_chain(SSL
*s
, SSL_CTX
*ctx
, STACK_OF(X509
) *chain
);
2125 __owur
int ssl_cert_add0_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2126 __owur
int ssl_cert_add1_chain_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
);
2127 __owur
int ssl_cert_select_current(CERT
*c
, X509
*x
);
2128 __owur
int ssl_cert_set_current(CERT
*c
, long arg
);
2129 void ssl_cert_set_cert_cb(CERT
*c
, int (*cb
) (SSL
*ssl
, void *arg
), void *arg
);
2131 __owur
int ssl_verify_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
);
2132 __owur
int ssl_build_cert_chain(SSL
*s
, SSL_CTX
*ctx
, int flags
);
2133 __owur
int ssl_cert_set_cert_store(CERT
*c
, X509_STORE
*store
, int chain
,
2136 __owur
int ssl_randbytes(SSL
*s
, unsigned char *buf
, size_t num
);
2137 __owur
int ssl_security(const SSL
*s
, int op
, int bits
, int nid
, void *other
);
2138 __owur
int ssl_ctx_security(const SSL_CTX
*ctx
, int op
, int bits
, int nid
,
2141 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_pkey(const EVP_PKEY
*pk
,
2143 __owur
const SSL_CERT_LOOKUP
*ssl_cert_lookup_by_idx(size_t idx
);
2145 int ssl_undefined_function(SSL
*s
);
2146 __owur
int ssl_undefined_void_function(void);
2147 __owur
int ssl_undefined_const_function(const SSL
*s
);
2148 __owur
int ssl_get_server_cert_serverinfo(SSL
*s
,
2149 const unsigned char **serverinfo
,
2150 size_t *serverinfo_length
);
2151 void ssl_set_masks(SSL
*s
);
2152 __owur
STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
2153 __owur
int ssl_verify_alarm_type(long type
);
2154 void ssl_sort_cipher_list(void);
2155 int ssl_load_ciphers(void);
2156 __owur
int ssl_fill_hello_random(SSL
*s
, int server
, unsigned char *field
,
2157 size_t len
, DOWNGRADE dgrd
);
2158 __owur
int ssl_generate_master_secret(SSL
*s
, unsigned char *pms
, size_t pmslen
,
2160 __owur EVP_PKEY
*ssl_generate_pkey(EVP_PKEY
*pm
);
2161 __owur
int ssl_derive(SSL
*s
, EVP_PKEY
*privkey
, EVP_PKEY
*pubkey
,
2163 __owur EVP_PKEY
*ssl_dh_to_pkey(DH
*dh
);
2165 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_id(uint32_t id
);
2166 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_std_name(const char *stdname
);
2167 __owur
const SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
2168 __owur
int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
, WPACKET
*pkt
,
2170 int ssl3_init_finished_mac(SSL
*s
);
2171 __owur
int ssl3_setup_key_block(SSL
*s
);
2172 __owur
int ssl3_change_cipher_state(SSL
*s
, int which
);
2173 void ssl3_cleanup_key_block(SSL
*s
);
2174 __owur
int ssl3_do_write(SSL
*s
, int type
);
2175 int ssl3_send_alert(SSL
*s
, int level
, int desc
);
2176 __owur
int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
2177 unsigned char *p
, size_t len
,
2178 size_t *secret_size
);
2179 __owur
int ssl3_get_req_cert_type(SSL
*s
, WPACKET
*pkt
);
2180 __owur
int ssl3_num_ciphers(void);
2181 __owur
const SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
2182 int ssl3_renegotiate(SSL
*ssl
);
2183 int ssl3_renegotiate_check(SSL
*ssl
, int initok
);
2184 __owur
int ssl3_dispatch_alert(SSL
*s
);
2185 __owur
size_t ssl3_final_finish_mac(SSL
*s
, const char *sender
, size_t slen
,
2187 __owur
int ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, size_t len
);
2188 void ssl3_free_digest_list(SSL
*s
);
2189 __owur
unsigned long ssl3_output_cert_chain(SSL
*s
, WPACKET
*pkt
,
2190 CERT_PKEY
*cpk
, int *al
);
2191 __owur
const SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,
2192 STACK_OF(SSL_CIPHER
) *clnt
,
2193 STACK_OF(SSL_CIPHER
) *srvr
);
2194 __owur
int ssl3_digest_cached_records(SSL
*s
, int keep
);
2195 __owur
int ssl3_new(SSL
*s
);
2196 void ssl3_free(SSL
*s
);
2197 __owur
int ssl3_read(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2198 __owur
int ssl3_peek(SSL
*s
, void *buf
, size_t len
, size_t *readbytes
);
2199 __owur
int ssl3_write(SSL
*s
, const void *buf
, size_t len
, size_t *written
);
2200 __owur
int ssl3_shutdown(SSL
*s
);
2201 int ssl3_clear(SSL
*s
);
2202 __owur
long ssl3_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2203 __owur
long ssl3_ctx_ctrl(SSL_CTX
*s
, int cmd
, long larg
, void *parg
);
2204 __owur
long ssl3_callback_ctrl(SSL
*s
, int cmd
, void (*fp
) (void));
2205 __owur
long ssl3_ctx_callback_ctrl(SSL_CTX
*s
, int cmd
, void (*fp
) (void));
2207 __owur
int ssl3_do_change_cipher_spec(SSL
*ssl
);
2208 __owur
long ssl3_default_timeout(void);
2210 __owur
int ssl3_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2211 __owur
int tls_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2212 __owur
int tls_setup_handshake(SSL
*s
);
2213 __owur
int dtls1_set_handshake_header(SSL
*s
, WPACKET
*pkt
, int htype
);
2214 __owur
int dtls1_close_construct_packet(SSL
*s
, WPACKET
*pkt
, int htype
);
2215 __owur
int ssl3_handshake_write(SSL
*s
);
2217 __owur
int ssl_allow_compression(SSL
*s
);
2219 __owur
int ssl_version_supported(const SSL
*s
, int version
);
2221 __owur
int ssl_set_client_hello_version(SSL
*s
);
2222 __owur
int ssl_check_version_downgrade(SSL
*s
);
2223 __owur
int ssl_set_version_bound(int method_version
, int version
, int *bound
);
2224 __owur
int ssl_choose_server_version(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2226 __owur
int ssl_choose_client_version(SSL
*s
, int version
, int checkdgrd
,
2228 int ssl_get_min_max_version(const SSL
*s
, int *min_version
, int *max_version
);
2230 __owur
long tls1_default_timeout(void);
2231 __owur
int dtls1_do_write(SSL
*s
, int type
);
2232 void dtls1_set_message_header(SSL
*s
,
2235 size_t frag_off
, size_t frag_len
);
2237 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf_
, size_t len
,
2240 __owur
int dtls1_read_failed(SSL
*s
, int code
);
2241 __owur
int dtls1_buffer_message(SSL
*s
, int ccs
);
2242 __owur
int dtls1_retransmit_message(SSL
*s
, unsigned short seq
, int *found
);
2243 __owur
int dtls1_get_queue_priority(unsigned short seq
, int is_ccs
);
2244 int dtls1_retransmit_buffered_messages(SSL
*s
);
2245 void dtls1_clear_received_buffer(SSL
*s
);
2246 void dtls1_clear_sent_buffer(SSL
*s
);
2247 void dtls1_get_message_header(unsigned char *data
,
2248 struct hm_header_st
*msg_hdr
);
2249 __owur
long dtls1_default_timeout(void);
2250 __owur
struct timeval
*dtls1_get_timeout(SSL
*s
, struct timeval
*timeleft
);
2251 __owur
int dtls1_check_timeout_num(SSL
*s
);
2252 __owur
int dtls1_handle_timeout(SSL
*s
);
2253 void dtls1_start_timer(SSL
*s
);
2254 void dtls1_stop_timer(SSL
*s
);
2255 __owur
int dtls1_is_timer_expired(SSL
*s
);
2256 void dtls1_double_timeout(SSL
*s
);
2257 __owur
int dtls_raw_hello_verify_request(WPACKET
*pkt
, unsigned char *cookie
,
2259 __owur
size_t dtls1_min_mtu(SSL
*s
);
2260 void dtls1_hm_fragment_free(hm_fragment
*frag
);
2261 __owur
int dtls1_query_mtu(SSL
*s
);
2263 __owur
int tls1_new(SSL
*s
);
2264 void tls1_free(SSL
*s
);
2265 int tls1_clear(SSL
*s
);
2267 __owur
int dtls1_new(SSL
*s
);
2268 void dtls1_free(SSL
*s
);
2269 int dtls1_clear(SSL
*s
);
2270 long dtls1_ctrl(SSL
*s
, int cmd
, long larg
, void *parg
);
2271 __owur
int dtls1_shutdown(SSL
*s
);
2273 __owur
int dtls1_dispatch_alert(SSL
*s
);
2275 __owur
int ssl_init_wbio_buffer(SSL
*s
);
2276 int ssl_free_wbio_buffer(SSL
*s
);
2278 __owur
int tls1_change_cipher_state(SSL
*s
, int which
);
2279 __owur
int tls1_setup_key_block(SSL
*s
);
2280 __owur
size_t tls1_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2282 __owur
int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
2283 unsigned char *p
, size_t len
,
2284 size_t *secret_size
);
2285 __owur
int tls13_setup_key_block(SSL
*s
);
2286 __owur
size_t tls13_final_finish_mac(SSL
*s
, const char *str
, size_t slen
,
2288 __owur
int tls13_change_cipher_state(SSL
*s
, int which
);
2289 __owur
int tls13_update_key(SSL
*s
, int send
);
2290 __owur
int tls13_hkdf_expand(SSL
*s
, const EVP_MD
*md
,
2291 const unsigned char *secret
,
2292 const unsigned char *label
, size_t labellen
,
2293 const unsigned char *data
, size_t datalen
,
2294 unsigned char *out
, size_t outlen
);
2295 __owur
int tls13_derive_key(SSL
*s
, const EVP_MD
*md
,
2296 const unsigned char *secret
, unsigned char *key
,
2298 __owur
int tls13_derive_iv(SSL
*s
, const EVP_MD
*md
,
2299 const unsigned char *secret
, unsigned char *iv
,
2301 __owur
int tls13_derive_finishedkey(SSL
*s
, const EVP_MD
*md
,
2302 const unsigned char *secret
,
2303 unsigned char *fin
, size_t finlen
);
2304 int tls13_generate_secret(SSL
*s
, const EVP_MD
*md
,
2305 const unsigned char *prevsecret
,
2306 const unsigned char *insecret
,
2308 unsigned char *outsecret
);
2309 __owur
int tls13_generate_handshake_secret(SSL
*s
,
2310 const unsigned char *insecret
,
2311 size_t insecretlen
);
2312 __owur
int tls13_generate_master_secret(SSL
*s
, unsigned char *out
,
2313 unsigned char *prev
, size_t prevlen
,
2314 size_t *secret_size
);
2315 __owur
int tls1_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2316 const char *label
, size_t llen
,
2317 const unsigned char *p
, size_t plen
,
2319 __owur
int tls13_export_keying_material(SSL
*s
, unsigned char *out
, size_t olen
,
2320 const char *label
, size_t llen
,
2321 const unsigned char *context
,
2322 size_t contextlen
, int use_context
);
2323 __owur
int tls1_alert_code(int code
);
2324 __owur
int tls13_alert_code(int code
);
2325 __owur
int ssl3_alert_code(int code
);
2327 # ifndef OPENSSL_NO_EC
2328 __owur
int ssl_check_srvr_ecc_cert_and_alg(X509
*x
, SSL
*s
);
2331 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
2333 # ifndef OPENSSL_NO_EC
2334 /* Flags values from tls1_ec_curve_id2nid() */
2335 /* Mask for curve type */
2336 # define TLS_CURVE_TYPE 0x3
2337 # define TLS_CURVE_PRIME 0x0
2338 # define TLS_CURVE_CHAR2 0x1
2339 # define TLS_CURVE_CUSTOM 0x2
2341 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2343 __owur
int tls1_ec_curve_id2nid(int curve_id
, unsigned int *pflags
);
2344 __owur
int tls1_ec_nid2curve_id(int nid
);
2345 __owur
int tls1_check_curve(SSL
*s
, const unsigned char *p
, size_t len
);
2346 __owur
int tls1_shared_group(SSL
*s
, int nmatch
);
2347 __owur
int tls1_set_groups(unsigned char **pext
, size_t *pextlen
,
2348 int *curves
, size_t ncurves
);
2349 __owur
int tls1_set_groups_list(unsigned char **pext
, size_t *pextlen
,
2351 void tls1_get_formatlist(SSL
*s
, const unsigned char **pformats
,
2352 size_t *num_formats
);
2353 __owur
int tls1_check_ec_tmp_key(SSL
*s
, unsigned long id
);
2354 __owur EVP_PKEY
*ssl_generate_pkey_curve(int id
);
2355 # endif /* OPENSSL_NO_EC */
2357 __owur
int tls_curve_allowed(SSL
*s
, const unsigned char *curve
, int op
);
2358 __owur
int tls1_get_curvelist(SSL
*s
, int sess
, const unsigned char **pcurves
,
2359 size_t *num_curves
);
2361 __owur
int tls1_set_server_sigalgs(SSL
*s
);
2363 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2364 typedef enum ticket_en
{
2365 /* fatal error, malloc failure */
2366 TICKET_FATAL_ERR_MALLOC
,
2367 /* fatal error, either from parsing or decrypting the ticket */
2368 TICKET_FATAL_ERR_OTHER
,
2369 /* No ticket present */
2371 /* Empty ticket present */
2373 /* the ticket couldn't be decrypted */
2375 /* a ticket was successfully decrypted */
2377 /* same as above but the ticket needs to be renewed */
2378 TICKET_SUCCESS_RENEW
2381 __owur TICKET_RETURN
tls_get_ticket_from_client(SSL
*s
, CLIENTHELLO_MSG
*hello
,
2383 __owur TICKET_RETURN
tls_decrypt_ticket(SSL
*s
, const unsigned char *etick
,
2385 const unsigned char *sess_id
,
2386 size_t sesslen
, SSL_SESSION
**psess
);
2388 __owur
int tls_use_ticket(SSL
*s
);
2390 void ssl_set_sig_mask(uint32_t *pmask_a
, SSL
*s
, int op
);
2392 __owur
int tls1_set_sigalgs_list(CERT
*c
, const char *str
, int client
);
2393 __owur
int tls1_set_sigalgs(CERT
*c
, const int *salg
, size_t salglen
,
2395 int tls1_check_chain(SSL
*s
, X509
*x
, EVP_PKEY
*pk
, STACK_OF(X509
) *chain
,
2397 void tls1_set_cert_validity(SSL
*s
);
2399 # ifndef OPENSSL_NO_CT
2400 __owur
int ssl_validate_ct(SSL
*s
);
2403 # ifndef OPENSSL_NO_DH
2404 __owur DH
*ssl_get_auto_dh(SSL
*s
);
2407 __owur
int ssl_security_cert(SSL
*s
, SSL_CTX
*ctx
, X509
*x
, int vfy
, int is_ee
);
2408 __owur
int ssl_security_cert_chain(SSL
*s
, STACK_OF(X509
) *sk
, X509
*ex
,
2411 int tls_choose_sigalg(SSL
*s
, int *al
);
2413 __owur EVP_MD_CTX
*ssl_replace_hash(EVP_MD_CTX
**hash
, const EVP_MD
*md
);
2414 void ssl_clear_hash_ctx(EVP_MD_CTX
**hash
);
2415 __owur
long ssl_get_algorithm2(SSL
*s
);
2416 __owur
int tls12_copy_sigalgs(SSL
*s
, WPACKET
*pkt
,
2417 const uint16_t *psig
, size_t psiglen
);
2418 __owur
int tls1_save_sigalgs(SSL
*s
, PACKET
*pkt
);
2419 __owur
int tls1_process_sigalgs(SSL
*s
);
2420 __owur
int tls1_set_peer_legacy_sigalg(SSL
*s
, const EVP_PKEY
*pkey
);
2421 __owur
int tls1_lookup_md(const SIGALG_LOOKUP
*lu
, const EVP_MD
**pmd
);
2422 __owur
size_t tls12_get_psigalgs(SSL
*s
, int sent
, const uint16_t **psigs
);
2423 __owur
int tls12_check_peer_sigalg(SSL
*s
, uint16_t, EVP_PKEY
*pkey
);
2424 void ssl_set_client_disabled(SSL
*s
);
2425 __owur
int ssl_cipher_disabled(SSL
*s
, const SSL_CIPHER
*c
, int op
, int echde
);
2427 __owur
int ssl_handshake_hash(SSL
*s
, unsigned char *out
, size_t outlen
,
2429 __owur
const EVP_MD
*ssl_md(int idx
);
2430 __owur
const EVP_MD
*ssl_handshake_md(SSL
*s
);
2431 __owur
const EVP_MD
*ssl_prf_md(SSL
*s
);
2434 * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2435 * with |ssl|, if logging is enabled. It returns one on success and zero on
2436 * failure. The entry is identified by the first 8 bytes of
2437 * |encrypted_premaster|.
2439 __owur
int ssl_log_rsa_client_key_exchange(SSL
*ssl
,
2440 const uint8_t *encrypted_premaster
,
2441 size_t encrypted_premaster_len
,
2442 const uint8_t *premaster
,
2443 size_t premaster_len
);
2446 * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2447 * logging is available. It returns one on success and zero on failure. It tags
2448 * the entry with |label|.
2450 __owur
int ssl_log_secret(SSL
*ssl
, const char *label
,
2451 const uint8_t *secret
, size_t secret_len
);
2453 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2454 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2455 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2456 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2457 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2458 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2461 __owur
char ssl3_cbc_record_digest_supported(const EVP_MD_CTX
*ctx
);
2462 __owur
int ssl3_cbc_digest_record(const EVP_MD_CTX
*ctx
,
2463 unsigned char *md_out
,
2464 size_t *md_out_size
,
2465 const unsigned char header
[13],
2466 const unsigned char *data
,
2467 size_t data_plus_mac_size
,
2468 size_t data_plus_mac_plus_padding_size
,
2469 const unsigned char *mac_secret
,
2470 size_t mac_secret_length
, char is_sslv3
);
2472 __owur
int srp_generate_server_master_secret(SSL
*s
);
2473 __owur
int srp_generate_client_master_secret(SSL
*s
);
2474 __owur
int srp_verify_server_param(SSL
*s
, int *al
);
2476 /* statem/extensions_cust.c */
2478 custom_ext_method
*custom_ext_find(const custom_ext_methods
*exts
,
2479 ENDPOINT role
, unsigned int ext_type
,
2482 void custom_ext_init(custom_ext_methods
*meths
);
2484 __owur
int custom_ext_parse(SSL
*s
, unsigned int context
, unsigned int ext_type
,
2485 const unsigned char *ext_data
, size_t ext_size
,
2486 X509
*x
, size_t chainidx
, int *al
);
2487 __owur
int custom_ext_add(SSL
*s
, int context
, WPACKET
*pkt
, X509
*x
,
2488 size_t chainidx
, int maxversion
, int *al
);
2490 __owur
int custom_exts_copy(custom_ext_methods
*dst
,
2491 const custom_ext_methods
*src
);
2492 __owur
int custom_exts_copy_flags(custom_ext_methods
*dst
,
2493 const custom_ext_methods
*src
);
2494 void custom_exts_free(custom_ext_methods
*exts
);
2496 void ssl_comp_free_compression_methods_int(void);
2498 # else /* OPENSSL_UNIT_TEST */
2500 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2501 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers