2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 /* ====================================================================
11 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12 * ECC cipher suite support in OpenSSL originally developed by
13 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
15 /* ====================================================================
16 * Copyright 2005 Nokia. All rights reserved.
18 * The portions of the attached software ("Contribution") is developed by
19 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
22 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24 * support (see RFC 4279) to OpenSSL.
26 * No patent licenses or other rights except those expressly stated in
27 * the OpenSSL open source license shall be deemed granted or received
28 * expressly, by implication, estoppel, or otherwise.
30 * No assurances are provided by Nokia that the Contribution does not
31 * infringe the patent or other intellectual property rights of any third
32 * party or that the license provides you with all the necessary rights
33 * to make use of the Contribution.
35 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
42 #ifndef HEADER_SSL_LOCL_H
43 # define HEADER_SSL_LOCL_H
50 # if defined(__unix) || defined(__unix__)
51 # include <sys/time.h> /* struct timeval for DTLS */
54 # include <openssl/buffer.h>
55 # include <openssl/comp.h>
56 # include <openssl/bio.h>
57 # include <openssl/stack.h>
58 # include <openssl/rsa.h>
59 # include <openssl/dsa.h>
60 # include <openssl/err.h>
61 # include <openssl/ssl.h>
62 # include <openssl/async.h>
63 # include <openssl/symhacks.h>
64 # include <openssl/ct.h>
65 # include "record/record.h"
66 # include "statem/statem.h"
67 # include "packet_locl.h"
68 # include "internal/dane.h"
70 # ifdef OPENSSL_BUILD_SHLIBSSL
71 # undef OPENSSL_EXTERN
72 # define OPENSSL_EXTERN OPENSSL_EXPORT
77 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
78 l|=(((unsigned long)(*((c)++)))<< 8), \
79 l|=(((unsigned long)(*((c)++)))<<16), \
80 l|=(((unsigned long)(*((c)++)))<<24))
82 /* NOTE - c is not incremented as per c2l */
83 # define c2ln(c,l1,l2,n) { \
87 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
88 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
89 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
90 case 5: l2|=((unsigned long)(*(--(c)))); \
91 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
92 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
93 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
94 case 1: l1|=((unsigned long)(*(--(c)))); \
98 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
99 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
100 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
101 *((c)++)=(unsigned char)(((l)>>24)&0xff))
103 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
104 l|=((unsigned long)(*((c)++)))<<16, \
105 l|=((unsigned long)(*((c)++)))<< 8, \
106 l|=((unsigned long)(*((c)++))))
108 # define n2l8(c,l) (l =((uint64_t)(*((c)++)))<<56, \
109 l|=((uint64_t)(*((c)++)))<<48, \
110 l|=((uint64_t)(*((c)++)))<<40, \
111 l|=((uint64_t)(*((c)++)))<<32, \
112 l|=((uint64_t)(*((c)++)))<<24, \
113 l|=((uint64_t)(*((c)++)))<<16, \
114 l|=((uint64_t)(*((c)++)))<< 8, \
115 l|=((uint64_t)(*((c)++))))
118 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
119 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
120 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
121 *((c)++)=(unsigned char)(((l) )&0xff))
123 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
124 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
125 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
126 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
127 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
128 *((c)++)=(unsigned char)(((l) )&0xff))
130 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
131 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
132 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
133 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
134 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
135 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
136 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
137 *((c)++)=(unsigned char)(((l) )&0xff))
139 /* NOTE - c is not incremented as per l2c */
140 # define l2cn(l1,l2,c,n) { \
143 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
144 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
145 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
146 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
147 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
148 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
149 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
150 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
154 # define n2s(c,s) ((s=(((unsigned int)((c)[0]))<< 8)| \
155 (((unsigned int)((c)[1])) )),(c)+=2)
156 # define s2n(s,c) (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
157 (c)[1]=(unsigned char)(((s) )&0xff)),(c)+=2)
159 # define n2l3(c,l) ((l =(((unsigned long)((c)[0]))<<16)| \
160 (((unsigned long)((c)[1]))<< 8)| \
161 (((unsigned long)((c)[2])) )),(c)+=3)
163 # define l2n3(l,c) (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
164 (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
165 (c)[2]=(unsigned char)(((l) )&0xff)),(c)+=3)
168 * DTLS version numbers are strange because they're inverted. Except for
169 * DTLS1_BAD_VER, which should be considered "lower" than the rest.
171 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
172 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
173 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
174 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
175 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
179 # define SSL_DECRYPT 0
180 # define SSL_ENCRYPT 1
182 # define TWO_BYTE_BIT 0x80
183 # define SEC_ESC_BIT 0x40
184 # define TWO_BYTE_MASK 0x7fff
185 # define THREE_BYTE_MASK 0x3fff
187 # define INC32(a) ((a)=((a)+1)&0xffffffffL)
188 # define DEC32(a) ((a)=((a)-1)&0xffffffffL)
189 # define MAX_MAC_SIZE 20 /* up from 16 for SSLv3 */
192 * Define the Bitmasks for SSL_CIPHER.algorithms.
193 * This bits are used packed as dense as possible. If new methods/ciphers
194 * etc will be added, the bits a likely to change, so this information
195 * is for internal library use only, even though SSL_CIPHER.algorithms
196 * can be publicly accessed.
197 * Use the according functions for cipher management instead.
199 * The bit mask handling in the selection and sorting scheme in
200 * ssl_create_cipher_list() has only limited capabilities, reflecting
201 * that the different entities within are mutually exclusive:
202 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
205 /* Bits for algorithm_mkey (key exchange algorithm) */
206 /* RSA key exchange */
207 # define SSL_kRSA 0x00000001U
208 /* tmp DH key no DH cert */
209 # define SSL_kDHE 0x00000002U
211 # define SSL_kEDH SSL_kDHE
213 # define SSL_kECDHE 0x00000004U
215 # define SSL_kEECDH SSL_kECDHE
217 # define SSL_kPSK 0x00000008U
218 /* GOST key exchange */
219 # define SSL_kGOST 0x00000010U
221 # define SSL_kSRP 0x00000020U
223 # define SSL_kRSAPSK 0x00000040U
224 # define SSL_kECDHEPSK 0x00000080U
225 # define SSL_kDHEPSK 0x00000100U
229 # define SSL_PSK (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
231 /* Bits for algorithm_auth (server authentication) */
233 # define SSL_aRSA 0x00000001U
235 # define SSL_aDSS 0x00000002U
236 /* no auth (i.e. use ADH or AECDH) */
237 # define SSL_aNULL 0x00000004U
239 # define SSL_aECDSA 0x00000008U
241 # define SSL_aPSK 0x00000010U
242 /* GOST R 34.10-2001 signature auth */
243 # define SSL_aGOST01 0x00000020U
245 # define SSL_aSRP 0x00000040U
246 /* GOST R 34.10-2012 signature auth */
247 # define SSL_aGOST12 0x00000080U
249 /* Bits for algorithm_enc (symmetric encryption) */
250 # define SSL_DES 0x00000001U
251 # define SSL_3DES 0x00000002U
252 # define SSL_RC4 0x00000004U
253 # define SSL_RC2 0x00000008U
254 # define SSL_IDEA 0x00000010U
255 # define SSL_eNULL 0x00000020U
256 # define SSL_AES128 0x00000040U
257 # define SSL_AES256 0x00000080U
258 # define SSL_CAMELLIA128 0x00000100U
259 # define SSL_CAMELLIA256 0x00000200U
260 # define SSL_eGOST2814789CNT 0x00000400U
261 # define SSL_SEED 0x00000800U
262 # define SSL_AES128GCM 0x00001000U
263 # define SSL_AES256GCM 0x00002000U
264 # define SSL_AES128CCM 0x00004000U
265 # define SSL_AES256CCM 0x00008000U
266 # define SSL_AES128CCM8 0x00010000U
267 # define SSL_AES256CCM8 0x00020000U
268 # define SSL_eGOST2814789CNT12 0x00040000U
269 # define SSL_CHACHA20POLY1305 0x00080000U
271 # define SSL_AESGCM (SSL_AES128GCM | SSL_AES256GCM)
272 # define SSL_AESCCM (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
273 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
274 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
275 # define SSL_CHACHA20 (SSL_CHACHA20POLY1305)
277 /* Bits for algorithm_mac (symmetric authentication) */
279 # define SSL_MD5 0x00000001U
280 # define SSL_SHA1 0x00000002U
281 # define SSL_GOST94 0x00000004U
282 # define SSL_GOST89MAC 0x00000008U
283 # define SSL_SHA256 0x00000010U
284 # define SSL_SHA384 0x00000020U
285 /* Not a real MAC, just an indication it is part of cipher */
286 # define SSL_AEAD 0x00000040U
287 # define SSL_GOST12_256 0x00000080U
288 # define SSL_GOST89MAC12 0x00000100U
289 # define SSL_GOST12_512 0x00000200U
292 * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
293 * sure to update this constant too
296 # define SSL_MD_MD5_IDX 0
297 # define SSL_MD_SHA1_IDX 1
298 # define SSL_MD_GOST94_IDX 2
299 # define SSL_MD_GOST89MAC_IDX 3
300 # define SSL_MD_SHA256_IDX 4
301 # define SSL_MD_SHA384_IDX 5
302 # define SSL_MD_GOST12_256_IDX 6
303 # define SSL_MD_GOST89MAC12_IDX 7
304 # define SSL_MD_GOST12_512_IDX 8
305 # define SSL_MD_MD5_SHA1_IDX 9
306 # define SSL_MD_SHA224_IDX 10
307 # define SSL_MD_SHA512_IDX 11
308 # define SSL_MAX_DIGEST 12
310 /* Bits for algorithm2 (handshake digests and other extra flags) */
312 /* Bits 0-7 are handshake MAC */
313 # define SSL_HANDSHAKE_MAC_MASK 0xFF
314 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
315 # define SSL_HANDSHAKE_MAC_SHA256 SSL_MD_SHA256_IDX
316 # define SSL_HANDSHAKE_MAC_SHA384 SSL_MD_SHA384_IDX
317 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
318 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
319 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
320 # define SSL_HANDSHAKE_MAC_DEFAULT SSL_HANDSHAKE_MAC_MD5_SHA1
322 /* Bits 8-15 bits are PRF */
323 # define TLS1_PRF_DGST_SHIFT 8
324 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
325 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
326 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
327 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
328 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
329 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
330 # define TLS1_PRF (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
333 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
334 * goes into algorithm2)
336 # define TLS1_STREAM_MAC 0x10000
338 # define SSL_STRONG_MASK 0x0000001FU
339 # define SSL_DEFAULT_MASK 0X00000020U
341 # define SSL_STRONG_NONE 0x00000001U
342 # define SSL_LOW 0x00000002U
343 # define SSL_MEDIUM 0x00000004U
344 # define SSL_HIGH 0x00000008U
345 # define SSL_FIPS 0x00000010U
346 # define SSL_NOT_DEFAULT 0x00000020U
348 /* we have used 0000003f - 26 bits left to go */
350 /* Check if an SSL structure is using DTLS */
351 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
352 /* See if we need explicit IV */
353 # define SSL_USE_EXPLICIT_IV(s) \
354 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
356 * See if we use signature algorithms extension and signature algorithm
359 # define SSL_USE_SIGALGS(s) \
360 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
362 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
363 * apply to others in future.
365 # define SSL_USE_TLS1_2_CIPHERS(s) \
366 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
368 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
369 * flags because it may not be set to correct version yet.
371 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
372 ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
373 (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
375 * Determine if a client should send signature algorithms extension:
376 * as with TLS1.2 cipher we can't rely on method flags.
378 # define SSL_CLIENT_USE_SIGALGS(s) \
379 SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
381 # define SSL_USE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC)
383 /* Mostly for SSLv3 */
384 # define SSL_PKEY_RSA_ENC 0
385 # define SSL_PKEY_RSA_SIGN 1
386 # define SSL_PKEY_DSA_SIGN 2
387 # define SSL_PKEY_ECC 3
388 # define SSL_PKEY_GOST01 4
389 # define SSL_PKEY_GOST12_256 5
390 # define SSL_PKEY_GOST12_512 6
391 # define SSL_PKEY_NUM 7
393 * Pseudo-constant. GOST cipher suites can use different certs for 1
394 * SSL_CIPHER. So let's see which one we have in fact.
396 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
399 * SSL_kRSA <- RSA_ENC
400 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
401 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
402 * SSL_aRSA <- RSA_ENC | RSA_SIGN
403 * SSL_aDSS <- DSA_SIGN
407 #define CERT_INVALID 0
408 #define CERT_PUBLIC_KEY 1
409 #define CERT_PRIVATE_KEY 2
412 /* CipherSuite length. SSLv3 and all TLS versions. */
413 # define TLS_CIPHER_LEN 2
414 /* used to hold info on the particular ciphers used */
415 struct ssl_cipher_st {
417 const char *name; /* text name */
418 uint32_t id; /* id, 4 bytes, first is version */
420 * changed in 1.0.0: these four used to be portions of a single value
423 uint32_t algorithm_mkey; /* key exchange algorithm */
424 uint32_t algorithm_auth; /* server authentication */
425 uint32_t algorithm_enc; /* symmetric encryption */
426 uint32_t algorithm_mac; /* symmetric authentication */
427 int min_tls; /* minimum SSL/TLS protocol version */
428 int max_tls; /* maximum SSL/TLS protocol version */
429 int min_dtls; /* minimum DTLS protocol version */
430 int max_dtls; /* maximum DTLS protocol version */
431 uint32_t algo_strength; /* strength and export flags */
432 uint32_t algorithm2; /* Extra flags */
433 int32_t strength_bits; /* Number of bits really used */
434 uint32_t alg_bits; /* Number of bits for algorithm */
437 /* Used to hold SSL/TLS functions */
438 struct ssl_method_st {
442 int (*ssl_new) (SSL *s);
443 void (*ssl_clear) (SSL *s);
444 void (*ssl_free) (SSL *s);
445 int (*ssl_accept) (SSL *s);
446 int (*ssl_connect) (SSL *s);
447 int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
448 int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
449 int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
450 int (*ssl_shutdown) (SSL *s);
451 int (*ssl_renegotiate) (SSL *s);
452 int (*ssl_renegotiate_check) (SSL *s);
453 int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
454 unsigned char *buf, size_t len, int peek,
456 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
458 int (*ssl_dispatch_alert) (SSL *s);
459 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
460 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
461 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
462 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
464 size_t (*ssl_pending) (const SSL *s);
465 int (*num_ciphers) (void);
466 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
467 long (*get_timeout) (void);
468 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
469 int (*ssl_version) (void);
470 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
471 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
475 * Lets make this into an ASN.1 type structure as follows
476 * SSL_SESSION_ID ::= SEQUENCE {
477 * version INTEGER, -- structure version number
478 * SSLversion INTEGER, -- SSL version number
479 * Cipher OCTET STRING, -- the 3 byte cipher ID
480 * Session_ID OCTET STRING, -- the Session ID
481 * Master_key OCTET STRING, -- the master key
482 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
483 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
484 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
485 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
486 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
487 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
488 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
489 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
490 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
491 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
492 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
493 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
494 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
495 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
497 * Look in ssl/ssl_asn1.c for more details
498 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
500 struct ssl_session_st {
501 int ssl_version; /* what ssl version session info is being kept
503 size_t master_key_length;
504 unsigned char master_key[SSL_MAX_MASTER_KEY_LENGTH];
505 /* session_id - valid? */
506 size_t session_id_length;
507 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
509 * this is used to determine whether the session is being reused in the
510 * appropriate context. It is up to the application to set this, via
513 size_t sid_ctx_length;
514 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
515 # ifndef OPENSSL_NO_PSK
516 char *psk_identity_hint;
520 * Used to indicate that session resumption is not allowed. Applications
521 * can also set this bit for a new session via not_resumable_session_cb
522 * to disable session caching and tickets.
525 /* This is the cert and type for the other end. */
528 /* Certificate chain peer sent */
529 STACK_OF(X509) *peer_chain;
531 * when app_verify_callback accepts a session where the peer's
532 * certificate is not ok, we must remember the error for session reuse:
534 long verify_result; /* only for servers */
538 unsigned int compress_meth; /* Need to lookup the method */
539 const SSL_CIPHER *cipher;
540 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used to
541 * load the 'cipher' structure */
542 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
543 CRYPTO_EX_DATA ex_data; /* application specific data */
545 * These are used to make removal of session-ids more efficient and to
546 * implement a maximum cache size.
548 struct ssl_session_st *prev, *next;
549 char *tlsext_hostname;
550 # ifndef OPENSSL_NO_EC
551 size_t tlsext_ecpointformatlist_length;
552 unsigned char *tlsext_ecpointformatlist; /* peer's list */
553 size_t tlsext_ellipticcurvelist_length;
554 unsigned char *tlsext_ellipticcurvelist; /* peer's list */
555 # endif /* OPENSSL_NO_EC */
557 unsigned char *tlsext_tick; /* Session ticket */
558 size_t tlsext_ticklen; /* Session ticket length */
559 unsigned long tlsext_tick_lifetime_hint; /* Session lifetime hint in
561 # ifndef OPENSSL_NO_SRP
568 /* Extended master secret support */
569 # define SSL_SESS_FLAG_EXTMS 0x1
571 # ifndef OPENSSL_NO_SRP
573 typedef struct srp_ctx_st {
574 /* param for all the callbacks */
576 /* set client Hello login callback */
577 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
578 /* set SRP N/g param callback for verification */
579 int (*SRP_verify_param_callback) (SSL *, void *);
580 /* set SRP client passwd callback */
581 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
583 BIGNUM *N, *g, *s, *B, *A;
587 unsigned long srp_Mask;
598 DEFINE_LHASH_OF(SSL_SESSION);
599 /* Needed in ssl_cert.c */
600 DEFINE_LHASH_OF(X509_NAME);
602 # define TLSEXT_KEYNAME_LENGTH 16
605 const SSL_METHOD *method;
606 STACK_OF(SSL_CIPHER) *cipher_list;
607 /* same as above but sorted for lookup */
608 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
609 struct x509_store_st /* X509_STORE */ *cert_store;
610 LHASH_OF(SSL_SESSION) *sessions;
612 * Most session-ids that will be cached, default is
613 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
615 size_t session_cache_size;
616 struct ssl_session_st *session_cache_head;
617 struct ssl_session_st *session_cache_tail;
619 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
620 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
621 * means only SSL_accept which cache SSL_SESSIONS.
623 uint32_t session_cache_mode;
625 * If timeout is not 0, it is the default timeout value set when
626 * SSL_new() is called. This has been put in to make life easier to set
629 long session_timeout;
631 * If this callback is not null, it will be called each time a session id
632 * is added to the cache. If this function returns 1, it means that the
633 * callback will do a SSL_SESSION_free() when it has finished using it.
634 * Otherwise, on 0, it means the callback has finished with it. If
635 * remove_session_cb is not null, it will be called when a session-id is
636 * removed from the cache. After the call, OpenSSL will
637 * SSL_SESSION_free() it.
639 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
640 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
641 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
642 const unsigned char *data, int len,
645 int sess_connect; /* SSL new conn - started */
646 int sess_connect_renegotiate; /* SSL reneg - requested */
647 int sess_connect_good; /* SSL new conne/reneg - finished */
648 int sess_accept; /* SSL new accept - started */
649 int sess_accept_renegotiate; /* SSL reneg - requested */
650 int sess_accept_good; /* SSL accept/reneg - finished */
651 int sess_miss; /* session lookup misses */
652 int sess_timeout; /* reuse attempt on timeouted session */
653 int sess_cache_full; /* session removed due to full cache */
654 int sess_hit; /* session reuse actually done */
655 int sess_cb_hit; /* session-id that was not in the cache was
656 * passed back via the callback. This
657 * indicates that the application is supplying
658 * session-id's from other processes - spooky
664 /* if defined, these override the X509_verify_cert() calls */
665 int (*app_verify_callback) (X509_STORE_CTX *, void *);
666 void *app_verify_arg;
668 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
669 * ('app_verify_callback' was called with just one argument)
672 /* Default password callback. */
673 pem_password_cb *default_passwd_callback;
675 /* Default password callback user data. */
676 void *default_passwd_callback_userdata;
678 /* get client cert callback */
679 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
681 /* cookie generate callback */
682 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
683 unsigned int *cookie_len);
685 /* verify cookie callback */
686 int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
687 unsigned int cookie_len);
689 CRYPTO_EX_DATA ex_data;
691 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
692 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
694 STACK_OF(X509) *extra_certs;
695 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
697 /* Default values used when no per-SSL value is defined follow */
699 /* used if SSL's info_callback is NULL */
700 void (*info_callback) (const SSL *ssl, int type, int val);
702 /* what we put in client cert requests */
703 STACK_OF(X509_NAME) *client_CA;
706 * Default values to use in SSL structures follow (these are copied by
712 int min_proto_version;
713 int max_proto_version;
714 size_t max_cert_list;
716 struct cert_st /* CERT */ *cert;
719 /* callback that allows applications to peek at protocol messages */
720 void (*msg_callback) (int write_p, int version, int content_type,
721 const void *buf, size_t len, SSL *ssl, void *arg);
722 void *msg_callback_arg;
724 uint32_t verify_mode;
725 size_t sid_ctx_length;
726 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
727 /* called 'verify_callback' in the SSL */
728 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
730 /* Default generate session ID callback. */
731 GEN_SESSION_CB generate_session_id;
733 X509_VERIFY_PARAM *param;
737 # ifndef OPENSSL_NO_CT
738 CTLOG_STORE *ctlog_store; /* CT Log Store */
740 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
741 * If they are not, the connection should be aborted.
743 ssl_ct_validation_cb ct_validation_callback;
744 void *ct_validation_callback_arg;
748 * If we're using more than one pipeline how should we divide the data
749 * up between the pipes?
751 size_t split_send_fragment;
753 * Maximum amount of data to send in one fragment. actual record size can
754 * be more than this due to padding and MAC overheads.
756 size_t max_send_fragment;
758 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
759 size_t max_pipelines;
761 /* The default read buffer length to use (0 means not set) */
762 size_t default_read_buf_len;
764 # ifndef OPENSSL_NO_ENGINE
766 * Engine to pass requests for client certs to
768 ENGINE *client_cert_engine;
771 /* TLS extensions servername callback */
772 int (*tlsext_servername_callback) (SSL *, int *, void *);
773 void *tlsext_servername_arg;
774 /* RFC 4507 session ticket keys */
775 unsigned char tlsext_tick_key_name[TLSEXT_KEYNAME_LENGTH];
776 unsigned char tlsext_tick_hmac_key[32];
777 unsigned char tlsext_tick_aes_key[32];
778 /* Callback to support customisation of ticket key setting */
779 int (*tlsext_ticket_key_cb) (SSL *ssl,
780 unsigned char *name, unsigned char *iv,
781 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
783 /* certificate status request info */
784 /* Callback for status request */
785 int (*tlsext_status_cb) (SSL *ssl, void *arg);
786 void *tlsext_status_arg;
788 # ifndef OPENSSL_NO_PSK
789 unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
791 unsigned int max_identity_len,
793 unsigned int max_psk_len);
794 unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
796 unsigned int max_psk_len);
799 # ifndef OPENSSL_NO_SRP
800 SRP_CTX srp_ctx; /* ctx for SRP authentication */
803 # ifndef OPENSSL_NO_NEXTPROTONEG
804 /* Next protocol negotiation information */
807 * For a server, this contains a callback function by which the set of
808 * advertised protocols can be provided.
810 int (*next_protos_advertised_cb) (SSL *s, const unsigned char **buf,
811 unsigned int *len, void *arg);
812 void *next_protos_advertised_cb_arg;
814 * For a client, this contains a callback function that selects the next
815 * protocol from the list provided by the server.
817 int (*next_proto_select_cb) (SSL *s, unsigned char **out,
818 unsigned char *outlen,
819 const unsigned char *in,
820 unsigned int inlen, void *arg);
821 void *next_proto_select_cb_arg;
825 * ALPN information (we are in the process of transitioning from NPN to
830 * For a server, this contains a callback function that allows the
831 * server to select the protocol for the connection.
832 * out: on successful return, this must point to the raw protocol
833 * name (without the length prefix).
834 * outlen: on successful return, this contains the length of |*out|.
835 * in: points to the client's list of supported protocols in
837 * inlen: the length of |in|.
839 int (*alpn_select_cb) (SSL *s,
840 const unsigned char **out,
841 unsigned char *outlen,
842 const unsigned char *in,
843 unsigned int inlen, void *arg);
844 void *alpn_select_cb_arg;
847 * For a client, this contains the list of supported protocols in wire
850 unsigned char *alpn_client_proto_list;
851 size_t alpn_client_proto_list_len;
853 /* Shared DANE context */
854 struct dane_ctx_st dane;
856 /* SRTP profiles we are willing to do from RFC 5764 */
857 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
859 * Callback for disabling session caching and ticket support on a session
860 * basis, depending on the chosen cipher.
862 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
863 # ifndef OPENSSL_NO_EC
864 /* EC extension values inherited by SSL structure */
865 size_t tlsext_ecpointformatlist_length;
866 unsigned char *tlsext_ecpointformatlist;
867 size_t tlsext_ellipticcurvelist_length;
868 unsigned char *tlsext_ellipticcurvelist;
869 # endif /* OPENSSL_NO_EC */
871 /* ext status type used for CSR extension (OCSP Stapling) */
872 int tlsext_status_type;
879 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
884 const SSL_METHOD *method;
886 * There are 2 BIO's even though they are normally both the same. This
887 * is so data can be read and written to different handlers
889 /* used by SSL_read */
891 /* used by SSL_write */
893 /* used during session-id reuse to concatenate messages */
896 * This holds a variable that indicates what we were doing when a 0 or -1
897 * is returned. This is needed for non-blocking IO so we know what
898 * request needs re-doing when in SSL_accept or SSL_connect
901 int (*handshake_func) (SSL *);
903 * Imagine that here's a boolean member "init" that is switched as soon
904 * as SSL_set_{accept/connect}_state is called for the first time, so
905 * that "state" and "handshake_func" are properly initialized. But as
906 * handshake_func is == 0 until then, we use this test instead of an
909 /* are we the server side? */
912 * Generate a new session or reuse an old one.
913 * NB: For servers, the 'new' session may actually be a previously
914 * cached session or even the previous session unless
915 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
918 /* don't send shutdown packets */
920 /* we have shut things down, 0x01 sent, 0x02 for received */
924 BUF_MEM *init_buf; /* buffer used during init */
925 void *init_msg; /* pointer to handshake message body, set by
926 * ssl3_get_message() */
927 size_t init_num; /* amount read/written */
928 size_t init_off; /* amount read/written */
929 struct ssl3_state_st *s3; /* SSLv3 variables */
930 struct dtls1_state_st *d1; /* DTLSv1 variables */
931 /* callback that allows applications to peek at protocol messages */
932 void (*msg_callback) (int write_p, int version, int content_type,
933 const void *buf, size_t len, SSL *ssl, void *arg);
934 void *msg_callback_arg;
935 int hit; /* reusing a previous session */
936 X509_VERIFY_PARAM *param;
937 /* Per connection DANE state */
940 STACK_OF(SSL_CIPHER) *cipher_list;
941 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
943 * These are the ones being used, the ones in SSL_SESSION are the ones to
944 * be 'copied' into these ones
948 * The TLS1.3 early_secret and handshake_secret. The master_secret is stored
951 unsigned char early_secret[EVP_MAX_MD_SIZE];
952 unsigned char handshake_secret[EVP_MAX_MD_SIZE];
953 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
954 EVP_MD_CTX *read_hash; /* used for mac generation */
955 COMP_CTX *compress; /* compression */
956 COMP_CTX *expand; /* uncompress */
957 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
958 EVP_MD_CTX *write_hash; /* used for mac generation */
961 /* This is used to hold the server certificate used */
962 struct cert_st /* CERT */ *cert;
964 * the session_id_context is used to ensure sessions are only reused in
965 * the appropriate context
967 size_t sid_ctx_length;
968 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
969 /* This can also be in the session once a session is established */
970 SSL_SESSION *session;
971 /* Default generate session ID callback. */
972 GEN_SESSION_CB generate_session_id;
975 * 0 don't care about verify failure.
976 * 1 fail if verify fails
978 uint32_t verify_mode;
979 /* fail if callback returns 0 */
980 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
981 /* optional informational callback */
982 void (*info_callback) (const SSL *ssl, int type, int val);
983 /* error bytes to be written */
987 # ifndef OPENSSL_NO_PSK
988 unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
990 unsigned int max_identity_len,
992 unsigned int max_psk_len);
993 unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
995 unsigned int max_psk_len);
998 /* Verified chain of peer */
999 STACK_OF(X509) *verified_chain;
1001 /* extra application data */
1002 CRYPTO_EX_DATA ex_data;
1003 /* for server side, keep the list of CA_dn we can use */
1004 STACK_OF(X509_NAME) *client_CA;
1006 /* protocol behaviour */
1010 int min_proto_version;
1011 int max_proto_version;
1012 size_t max_cert_list;
1014 /* what was passed, used for SSLv3/TLS rollback check */
1017 * If we're using more than one pipeline how should we divide the data
1018 * up between the pipes?
1020 size_t split_send_fragment;
1022 * Maximum amount of data to send in one fragment. actual record size can
1023 * be more than this due to padding and MAC overheads.
1025 size_t max_send_fragment;
1026 /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1027 size_t max_pipelines;
1028 /* TLS extension debug callback */
1029 void (*tlsext_debug_cb) (SSL *s, int client_server, int type,
1030 const unsigned char *data, int len, void *arg);
1031 void *tlsext_debug_arg;
1032 char *tlsext_hostname;
1034 * no further mod of servername
1035 * 0 : call the servername extension callback.
1036 * 1 : prepare 2, allow last ack just after in server callback.
1037 * 2 : don't call servername callback, no ack in server hello
1039 int servername_done;
1040 /* certificate status request info */
1041 /* Status type or -1 if no status type */
1042 int tlsext_status_type;
1043 # ifndef OPENSSL_NO_CT
1045 * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1046 * If they are not, the connection should be aborted.
1048 ssl_ct_validation_cb ct_validation_callback;
1049 /* User-supplied argument tha tis passed to the ct_validation_callback */
1050 void *ct_validation_callback_arg;
1052 * Consolidated stack of SCTs from all sources.
1053 * Lazily populated by CT_get_peer_scts(SSL*)
1055 STACK_OF(SCT) *scts;
1056 /* Raw extension data, if seen */
1057 unsigned char *tlsext_scts;
1058 /* Length of raw extension data, if seen */
1059 uint16_t tlsext_scts_len;
1060 /* Have we attempted to find/parse SCTs yet? */
1063 /* Expect OCSP CertificateStatus message */
1064 int tlsext_status_expected;
1065 /* OCSP status request only */
1066 STACK_OF(OCSP_RESPID) *tlsext_ocsp_ids;
1067 X509_EXTENSIONS *tlsext_ocsp_exts;
1068 /* OCSP response received or to be sent */
1069 unsigned char *tlsext_ocsp_resp;
1070 size_t tlsext_ocsp_resplen;
1071 /* RFC4507 session ticket expected to be received or sent */
1072 int tlsext_ticket_expected;
1073 # ifndef OPENSSL_NO_EC
1074 size_t tlsext_ecpointformatlist_length;
1076 unsigned char *tlsext_ecpointformatlist;
1077 size_t tlsext_ellipticcurvelist_length;
1079 unsigned char *tlsext_ellipticcurvelist;
1080 # endif /* OPENSSL_NO_EC */
1081 /* TLS Session Ticket extension override */
1082 TLS_SESSION_TICKET_EXT *tlsext_session_ticket;
1083 /* TLS Session Ticket extension callback */
1084 tls_session_ticket_ext_cb_fn tls_session_ticket_ext_cb;
1085 void *tls_session_ticket_ext_cb_arg;
1086 /* TLS pre-shared secret session resumption */
1087 tls_session_secret_cb_fn tls_session_secret_cb;
1088 void *tls_session_secret_cb_arg;
1089 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
1090 # ifndef OPENSSL_NO_NEXTPROTONEG
1092 * Next protocol negotiation. For the client, this is the protocol that
1093 * we sent in NextProtocol and is set when handling ServerHello
1094 * extensions. For a server, this is the client's selected_protocol from
1095 * NextProtocol and is set when handling the NextProtocol message, before
1096 * the Finished message.
1098 unsigned char *next_proto_negotiated;
1099 size_t next_proto_negotiated_len;
1101 # define session_ctx initial_ctx
1103 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1104 /* What's been chosen */
1105 SRTP_PROTECTION_PROFILE *srtp_profile;
1107 * Is use of the Heartbeat extension negotiated?
1110 * 2: enabled, but not allowed to send Requests
1112 unsigned int tlsext_heartbeat;
1113 /* Indicates if a HeartbeatRequest is in flight */
1114 unsigned int tlsext_hb_pending;
1115 /* HeartbeatRequest sequence number */
1116 unsigned int tlsext_hb_seq;
1118 * For a client, this contains the list of supported protocols in wire
1121 unsigned char *alpn_client_proto_list;
1122 size_t alpn_client_proto_list_len;
1124 * 1 if we are renegotiating.
1125 * 2 if we are a server and are inside a handshake
1126 * (i.e. not just sending a HelloRequest)
1129 # ifndef OPENSSL_NO_SRP
1130 /* ctx for SRP authentication */
1134 * Callback for disabling session caching and ticket support on a session
1135 * basis, depending on the chosen cipher.
1137 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1138 RECORD_LAYER rlayer;
1139 /* Default password callback. */
1140 pem_password_cb *default_passwd_callback;
1141 /* Default password callback user data. */
1142 void *default_passwd_callback_userdata;
1143 /* Async Job info */
1145 ASYNC_WAIT_CTX *waitctx;
1148 CRYPTO_RWLOCK *lock;
1151 typedef struct ssl3_state_st {
1153 size_t read_mac_secret_size;
1154 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1155 size_t write_mac_secret_size;
1156 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1157 unsigned char server_random[SSL3_RANDOM_SIZE];
1158 unsigned char client_random[SSL3_RANDOM_SIZE];
1159 /* flags for countermeasure against known-IV weakness */
1160 int need_empty_fragments;
1161 int empty_fragment_done;
1162 /* used during startup, digest all incoming/outgoing packets */
1163 BIO *handshake_buffer;
1165 * When handshake digest is determined, buffer is hashed and
1166 * freed and MD_CTX for the required digest is stored here.
1168 EVP_MD_CTX *handshake_dgst;
1170 * Set whenever an expected ChangeCipherSpec message is processed.
1171 * Unset when the peer's Finished message is received.
1172 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1174 int change_cipher_spec;
1178 * we allow one fatal and one warning alert to be outstanding, send close
1179 * alert via the warning alert
1182 unsigned char send_alert[2];
1184 * This flag is set when we should renegotiate ASAP, basically when there
1185 * is no more data in the read or write buffers
1188 int total_renegotiations;
1189 int num_renegotiations;
1190 int in_read_app_data;
1192 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1193 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1194 size_t finish_md_len;
1195 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1196 size_t peer_finish_md_len;
1197 size_t message_size;
1199 /* used to hold the new cipher we are going to use */
1200 const SSL_CIPHER *new_cipher;
1201 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1202 EVP_PKEY *pkey; /* holds short lived DH/ECDH key */
1204 /* used for certificate requests */
1207 char ctype[SSL3_CT_NUMBER];
1208 STACK_OF(X509_NAME) *ca_names;
1209 size_t key_block_length;
1210 unsigned char *key_block;
1211 const EVP_CIPHER *new_sym_enc;
1212 const EVP_MD *new_hash;
1213 int new_mac_pkey_type;
1214 size_t new_mac_secret_size;
1215 # ifndef OPENSSL_NO_COMP
1216 const SSL_COMP *new_compression;
1218 char *new_compression;
1221 /* Raw values of the cipher list from a client */
1222 unsigned char *ciphers_raw;
1223 size_t ciphers_rawlen;
1224 /* Temporary storage for premaster secret */
1227 # ifndef OPENSSL_NO_PSK
1228 /* Temporary storage for PSK key */
1233 * signature algorithms peer reports: e.g. supported signature
1234 * algorithms extension for server or as part of a certificate
1235 * request for client.
1237 unsigned char *peer_sigalgs;
1238 /* Size of above array */
1239 size_t peer_sigalgslen;
1240 /* Digest peer uses for signing */
1241 const EVP_MD *peer_md;
1242 /* Array of digests used for signing */
1243 const EVP_MD *md[SSL_PKEY_NUM];
1245 * Set if corresponding CERT_PKEY can be used with current
1246 * SSL session: e.g. appropriate curve, signature algorithms etc.
1247 * If zero it can't be used at all.
1249 uint32_t valid_flags[SSL_PKEY_NUM];
1251 * For servers the following masks are for the key and auth algorithms
1252 * that are supported by the certs below. For clients they are masks of
1253 * *disabled* algorithms based on the current session.
1258 * The following are used by the client to see if a cipher is allowed or
1259 * not. It contains the minimum and maximum version the client's using
1260 * based on what it knows so far.
1266 /* Connection binding to prevent renegotiation attacks */
1267 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1268 size_t previous_client_finished_len;
1269 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1270 size_t previous_server_finished_len;
1271 int send_connection_binding; /* TODOEKR */
1273 # ifndef OPENSSL_NO_NEXTPROTONEG
1275 * Set if we saw the Next Protocol Negotiation extension from our peer.
1277 int next_proto_neg_seen;
1281 * ALPN information (we are in the process of transitioning from NPN to
1286 * In a server these point to the selected ALPN protocol after the
1287 * ClientHello has been processed. In a client these contain the protocol
1288 * that the server selected once the ServerHello has been processed.
1290 unsigned char *alpn_selected;
1291 size_t alpn_selected_len;
1292 /* used by the server to know what options were proposed */
1293 unsigned char *alpn_proposed;
1294 size_t alpn_proposed_len;
1295 /* used by the client to know if it actually sent alpn */
1298 # ifndef OPENSSL_NO_EC
1300 * This is set to true if we believe that this is a version of Safari
1301 * running on OS X 10.6 or newer. We wish to know this because Safari on
1302 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1304 char is_probably_safari;
1305 # endif /* !OPENSSL_NO_EC */
1307 /* For clients: peer temporary key */
1308 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1314 /* DTLS structures */
1316 # ifndef OPENSSL_NO_SCTP
1317 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1320 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1321 # define DTLS1_MAX_MTU_OVERHEAD 48
1324 * Flag used in message reuse to indicate the buffer contains the record
1325 * header as well as the the handshake message header.
1327 # define DTLS1_SKIP_RECORD_HEADER 2
1329 struct dtls1_retransmit_state {
1330 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1331 EVP_MD_CTX *write_hash; /* used for mac generation */
1332 COMP_CTX *compress; /* compression */
1333 SSL_SESSION *session;
1334 unsigned short epoch;
1337 struct hm_header_st {
1343 unsigned int is_ccs;
1344 struct dtls1_retransmit_state saved_retransmit_state;
1347 struct dtls1_timeout_st {
1348 /* Number of read timeouts so far */
1349 unsigned int read_timeouts;
1350 /* Number of write timeouts so far */
1351 unsigned int write_timeouts;
1352 /* Number of alerts received so far */
1353 unsigned int num_alerts;
1356 typedef struct hm_fragment_st {
1357 struct hm_header_st msg_header;
1358 unsigned char *fragment;
1359 unsigned char *reassembly;
1362 typedef struct pqueue_st pqueue;
1363 typedef struct pitem_st pitem;
1366 unsigned char priority[8]; /* 64-bit value in big-endian encoding */
1371 typedef struct pitem_st *piterator;
1373 pitem *pitem_new(unsigned char *prio64be, void *data);
1374 void pitem_free(pitem *item);
1375 pqueue *pqueue_new(void);
1376 void pqueue_free(pqueue *pq);
1377 pitem *pqueue_insert(pqueue *pq, pitem *item);
1378 pitem *pqueue_peek(pqueue *pq);
1379 pitem *pqueue_pop(pqueue *pq);
1380 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1381 pitem *pqueue_iterator(pqueue *pq);
1382 pitem *pqueue_next(piterator *iter);
1383 size_t pqueue_size(pqueue *pq);
1385 typedef struct dtls1_state_st {
1386 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1388 unsigned int cookie_verified;
1389 /* handshake message numbers */
1390 unsigned short handshake_write_seq;
1391 unsigned short next_handshake_write_seq;
1392 unsigned short handshake_read_seq;
1393 /* Buffered handshake messages */
1394 pqueue *buffered_messages;
1395 /* Buffered (sent) handshake records */
1396 pqueue *sent_messages;
1397 size_t link_mtu; /* max on-the-wire DTLS packet size */
1398 size_t mtu; /* max DTLS packet size */
1399 struct hm_header_st w_msg_hdr;
1400 struct hm_header_st r_msg_hdr;
1401 struct dtls1_timeout_st timeout;
1403 * Indicates when the last handshake msg or heartbeat sent will timeout
1405 struct timeval next_timeout;
1406 /* Timeout duration */
1407 unsigned short timeout_duration;
1408 unsigned int retransmitting;
1409 # ifndef OPENSSL_NO_SCTP
1410 int shutdown_received;
1414 # ifndef OPENSSL_NO_EC
1416 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1418 # define EXPLICIT_PRIME_CURVE_TYPE 1
1419 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1420 # define NAMED_CURVE_TYPE 3
1421 # endif /* OPENSSL_NO_EC */
1423 typedef struct cert_pkey_st {
1425 EVP_PKEY *privatekey;
1426 /* Chain for this certificate */
1427 STACK_OF(X509) *chain;
1429 * serverinfo data for this certificate. The data is in TLS Extension
1430 * wire format, specifically it's a series of records like:
1431 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1433 * uint8_t data[length];
1435 unsigned char *serverinfo;
1436 size_t serverinfo_length;
1438 /* Retrieve Suite B flags */
1439 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1440 /* Uses to check strict mode: suite B modes are always strict */
1441 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1442 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1445 unsigned short ext_type;
1447 * Per-connection flags relating to this extension type: not used if
1448 * part of an SSL_CTX structure.
1451 custom_ext_add_cb add_cb;
1452 custom_ext_free_cb free_cb;
1454 custom_ext_parse_cb parse_cb;
1456 } custom_ext_method;
1458 /* ext_flags values */
1461 * Indicates an extension has been received. Used to check for unsolicited or
1462 * duplicate extensions.
1464 # define SSL_EXT_FLAG_RECEIVED 0x1
1466 * Indicates an extension has been sent: used to enable sending of
1467 * corresponding ServerHello extension.
1469 # define SSL_EXT_FLAG_SENT 0x2
1472 custom_ext_method *meths;
1474 } custom_ext_methods;
1476 typedef struct cert_st {
1477 /* Current active set */
1479 * ALWAYS points to an element of the pkeys array
1480 * Probably it would make more sense to store
1481 * an index, not a pointer.
1484 # ifndef OPENSSL_NO_DH
1486 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1489 /* Flags related to certificates */
1490 uint32_t cert_flags;
1491 CERT_PKEY pkeys[SSL_PKEY_NUM];
1493 * Certificate types (received or sent) in certificate request message.
1494 * On receive this is only set if number of certificate types exceeds
1497 unsigned char *ctypes;
1500 * supported signature algorithms. When set on a client this is sent in
1501 * the client hello as the supported signature algorithms extension. For
1502 * servers it represents the signature algorithms we are willing to use.
1504 unsigned char *conf_sigalgs;
1505 /* Size of above array */
1506 size_t conf_sigalgslen;
1508 * Client authentication signature algorithms, if not set then uses
1509 * conf_sigalgs. On servers these will be the signature algorithms sent
1510 * to the client in a cerificate request for TLS 1.2. On a client this
1511 * represents the signature algortithms we are willing to use for client
1514 unsigned char *client_sigalgs;
1515 /* Size of above array */
1516 size_t client_sigalgslen;
1518 * Signature algorithms shared by client and server: cached because these
1519 * are used most often.
1521 TLS_SIGALGS *shared_sigalgs;
1522 size_t shared_sigalgslen;
1524 * Certificate setup callback: if set is called whenever a certificate
1525 * may be required (client or server). the callback can then examine any
1526 * appropriate parameters and setup any certificates required. This
1527 * allows advanced applications to select certificates on the fly: for
1528 * example based on supported signature algorithms or curves.
1530 int (*cert_cb) (SSL *ssl, void *arg);
1533 * Optional X509_STORE for chain building or certificate validation If
1534 * NULL the parent SSL_CTX store is used instead.
1536 X509_STORE *chain_store;
1537 X509_STORE *verify_store;
1538 /* Custom extension methods for server and client */
1539 custom_ext_methods cli_ext;
1540 custom_ext_methods srv_ext;
1541 /* Security callback */
1542 int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1543 void *other, void *ex);
1544 /* Security level */
1547 # ifndef OPENSSL_NO_PSK
1548 /* If not NULL psk identity hint to use for servers */
1549 char *psk_identity_hint;
1551 int references; /* >1 only if SSL_copy_session_id is used */
1552 CRYPTO_RWLOCK *lock;
1555 /* Structure containing decoded values of signature algorithms extension */
1556 struct tls_sigalgs_st {
1557 /* NID of hash algorithm */
1559 /* NID of signature algorithm */
1561 /* Combined hash and signature NID */
1562 int signandhash_nid;
1563 /* Raw values used in extension */
1564 unsigned char rsign;
1565 unsigned char rhash;
1568 # define FP_ICC (int (*)(const void *,const void *))
1571 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1572 * of a mess of functions, but hell, think of it as an opaque structure :-)
1574 typedef struct ssl3_enc_method {
1575 int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1576 int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1577 int (*setup_key_block) (SSL *);
1578 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1580 int (*change_cipher_state) (SSL *, int);
1581 size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1582 const char *client_finished_label;
1583 size_t client_finished_label_len;
1584 const char *server_finished_label;
1585 size_t server_finished_label_len;
1586 int (*alert_value) (int);
1587 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1588 const char *, size_t,
1589 const unsigned char *, size_t,
1591 /* Various flags indicating protocol version requirements */
1593 /* Set the handshake header */
1594 int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1595 /* Close construction of the handshake message */
1596 int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1597 /* Write out handshake message */
1598 int (*do_write) (SSL *s);
1601 # define ssl_set_handshake_header(s, pkt, htype) \
1602 s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1603 # define ssl_close_construct_packet(s, pkt, htype) \
1604 s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1605 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1607 /* Values for enc_flags */
1609 /* Uses explicit IV for CBC mode */
1610 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1611 /* Uses signature algorithms extension */
1612 # define SSL_ENC_FLAG_SIGALGS 0x2
1613 /* Uses SHA256 default PRF */
1614 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1616 # define SSL_ENC_FLAG_DTLS 0x8
1618 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1619 * apply to others in future.
1621 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1623 # ifndef OPENSSL_NO_COMP
1624 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1625 typedef struct ssl3_comp_st {
1626 int comp_id; /* The identifier byte for this compression
1628 char *name; /* Text name used for the compression type */
1629 COMP_METHOD *method; /* The method :-) */
1633 typedef struct raw_extension_st {
1638 #define MAX_COMPRESSIONS_SIZE 255
1642 unsigned int legacy_version;
1643 unsigned char random[SSL3_RANDOM_SIZE];
1644 size_t session_id_len;
1645 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1646 size_t dtls_cookie_len;
1647 unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
1648 PACKET ciphersuites;
1649 size_t compressions_len;
1650 unsigned char compressions[MAX_COMPRESSIONS_SIZE];
1652 size_t num_extensions;
1653 RAW_EXTENSION *pre_proc_exts;
1656 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1658 __owur const SSL_METHOD *ssl_bad_method(int ver);
1659 __owur const SSL_METHOD *sslv3_method(void);
1660 __owur const SSL_METHOD *sslv3_server_method(void);
1661 __owur const SSL_METHOD *sslv3_client_method(void);
1662 __owur const SSL_METHOD *tlsv1_method(void);
1663 __owur const SSL_METHOD *tlsv1_server_method(void);
1664 __owur const SSL_METHOD *tlsv1_client_method(void);
1665 __owur const SSL_METHOD *tlsv1_1_method(void);
1666 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1667 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1668 __owur const SSL_METHOD *tlsv1_2_method(void);
1669 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1670 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1671 __owur const SSL_METHOD *tlsv1_3_method(void);
1672 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1673 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1674 __owur const SSL_METHOD *dtlsv1_method(void);
1675 __owur const SSL_METHOD *dtlsv1_server_method(void);
1676 __owur const SSL_METHOD *dtlsv1_client_method(void);
1677 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1678 __owur const SSL_METHOD *dtlsv1_2_method(void);
1679 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1680 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1682 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1683 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1684 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1685 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1686 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1687 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1688 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1691 * Flags for SSL methods
1693 # define SSL_METHOD_NO_FIPS (1U<<0)
1694 # define SSL_METHOD_NO_SUITEB (1U<<1)
1696 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1697 s_connect, enc_data) \
1698 const SSL_METHOD *func_name(void) \
1700 static const SSL_METHOD func_name##_data= { \
1714 ssl3_renegotiate_check, \
1717 ssl3_dispatch_alert, \
1720 ssl3_get_cipher_by_char, \
1721 ssl3_put_cipher_by_char, \
1725 tls1_default_timeout, \
1727 ssl_undefined_void_function, \
1728 ssl3_callback_ctrl, \
1729 ssl3_ctx_callback_ctrl, \
1731 return &func_name##_data; \
1734 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1735 const SSL_METHOD *func_name(void) \
1737 static const SSL_METHOD func_name##_data= { \
1739 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1751 ssl3_renegotiate_check, \
1754 ssl3_dispatch_alert, \
1757 ssl3_get_cipher_by_char, \
1758 ssl3_put_cipher_by_char, \
1762 ssl3_default_timeout, \
1764 ssl_undefined_void_function, \
1765 ssl3_callback_ctrl, \
1766 ssl3_ctx_callback_ctrl, \
1768 return &func_name##_data; \
1771 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1772 s_connect, enc_data) \
1773 const SSL_METHOD *func_name(void) \
1775 static const SSL_METHOD func_name##_data= { \
1789 ssl3_renegotiate_check, \
1791 dtls1_write_app_data_bytes, \
1792 dtls1_dispatch_alert, \
1795 ssl3_get_cipher_by_char, \
1796 ssl3_put_cipher_by_char, \
1800 dtls1_default_timeout, \
1802 ssl_undefined_void_function, \
1803 ssl3_callback_ctrl, \
1804 ssl3_ctx_callback_ctrl, \
1806 return &func_name##_data; \
1809 struct openssl_ssl_test_functions {
1810 int (*p_ssl_init_wbio_buffer) (SSL *s);
1811 int (*p_ssl3_setup_buffers) (SSL *s);
1812 # ifndef OPENSSL_NO_HEARTBEATS
1813 int (*p_dtls1_process_heartbeat) (SSL *s,
1814 unsigned char *p, unsigned int length);
1818 const char *ssl_protocol_to_string(int version);
1820 # ifndef OPENSSL_UNIT_TEST
1822 void ssl_clear_cipher_ctx(SSL *s);
1823 int ssl_clear_bad_session(SSL *s);
1824 __owur CERT *ssl_cert_new(void);
1825 __owur CERT *ssl_cert_dup(CERT *cert);
1826 void ssl_cert_clear_certs(CERT *c);
1827 void ssl_cert_free(CERT *c);
1828 __owur int ssl_get_new_session(SSL *s, int session);
1829 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello);
1830 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
1831 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1832 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
1833 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1834 const SSL_CIPHER *const *bp);
1835 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
1836 STACK_OF(SSL_CIPHER) **pref,
1837 STACK_OF(SSL_CIPHER)
1839 const char *rule_str,
1841 void ssl_update_cache(SSL *s, int mode);
1842 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
1843 const EVP_MD **md, int *mac_pkey_type,
1844 size_t *mac_secret_size, SSL_COMP **comp,
1846 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1847 size_t *int_overhead, size_t *blocksize,
1848 size_t *ext_overhead);
1849 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
1850 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
1851 const unsigned char *ptr);
1852 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
1853 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
1854 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
1855 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
1856 __owur int ssl_cert_select_current(CERT *c, X509 *x);
1857 __owur int ssl_cert_set_current(CERT *c, long arg);
1858 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
1859 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
1861 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
1862 __owur int ssl_add_cert_chain(SSL *s, WPACKET *pkt, CERT_PKEY *cpk);
1863 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
1864 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
1867 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
1868 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
1871 int ssl_undefined_function(SSL *s);
1872 __owur int ssl_undefined_void_function(void);
1873 __owur int ssl_undefined_const_function(const SSL *s);
1874 __owur CERT_PKEY *ssl_get_server_send_pkey(SSL *s);
1875 __owur int ssl_get_server_cert_serverinfo(SSL *s,
1876 const unsigned char **serverinfo,
1877 size_t *serverinfo_length);
1878 __owur EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *c,
1879 const EVP_MD **pmd);
1880 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
1881 void ssl_set_masks(SSL *s);
1882 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
1883 __owur int ssl_verify_alarm_type(long type);
1884 void ssl_sort_cipher_list(void);
1885 void ssl_load_ciphers(void);
1886 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
1888 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
1890 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
1891 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey);
1892 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
1894 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
1895 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
1897 int ssl3_init_finished_mac(SSL *s);
1898 __owur int ssl3_setup_key_block(SSL *s);
1899 __owur int ssl3_change_cipher_state(SSL *s, int which);
1900 void ssl3_cleanup_key_block(SSL *s);
1901 __owur int ssl3_do_write(SSL *s, int type);
1902 int ssl3_send_alert(SSL *s, int level, int desc);
1903 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
1904 unsigned char *p, size_t len,
1905 size_t *secret_size);
1906 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
1907 __owur int ssl3_num_ciphers(void);
1908 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
1909 int ssl3_renegotiate(SSL *ssl);
1910 int ssl3_renegotiate_check(SSL *ssl);
1911 __owur int ssl3_dispatch_alert(SSL *s);
1912 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
1914 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
1915 void ssl3_free_digest_list(SSL *s);
1916 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
1918 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
1919 STACK_OF(SSL_CIPHER) *clnt,
1920 STACK_OF(SSL_CIPHER) *srvr);
1921 __owur int ssl3_digest_cached_records(SSL *s, int keep);
1922 __owur int ssl3_new(SSL *s);
1923 void ssl3_free(SSL *s);
1924 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
1925 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
1926 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
1927 __owur int ssl3_shutdown(SSL *s);
1928 void ssl3_clear(SSL *s);
1929 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
1930 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
1931 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
1932 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
1934 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
1935 __owur long ssl3_default_timeout(void);
1937 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
1938 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
1939 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
1940 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
1941 __owur int ssl3_handshake_write(SSL *s);
1943 __owur int ssl_allow_compression(SSL *s);
1945 __owur int ssl_version_supported(const SSL *s, int version);
1947 __owur int ssl_set_client_hello_version(SSL *s);
1948 __owur int ssl_check_version_downgrade(SSL *s);
1949 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
1950 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello);
1951 __owur int ssl_choose_client_version(SSL *s, int version);
1952 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
1955 __owur long tls1_default_timeout(void);
1956 __owur int dtls1_do_write(SSL *s, int type);
1957 void dtls1_set_message_header(SSL *s,
1960 size_t frag_off, size_t frag_len);
1962 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
1965 __owur int dtls1_read_failed(SSL *s, int code);
1966 __owur int dtls1_buffer_message(SSL *s, int ccs);
1967 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
1968 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
1969 int dtls1_retransmit_buffered_messages(SSL *s);
1970 void dtls1_clear_received_buffer(SSL *s);
1971 void dtls1_clear_sent_buffer(SSL *s);
1972 void dtls1_get_message_header(unsigned char *data,
1973 struct hm_header_st *msg_hdr);
1974 __owur long dtls1_default_timeout(void);
1975 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
1976 __owur int dtls1_check_timeout_num(SSL *s);
1977 __owur int dtls1_handle_timeout(SSL *s);
1978 void dtls1_start_timer(SSL *s);
1979 void dtls1_stop_timer(SSL *s);
1980 __owur int dtls1_is_timer_expired(SSL *s);
1981 void dtls1_double_timeout(SSL *s);
1982 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
1984 __owur int dtls1_send_newsession_ticket(SSL *s);
1985 __owur size_t dtls1_min_mtu(SSL *s);
1986 void dtls1_hm_fragment_free(hm_fragment *frag);
1987 __owur int dtls1_query_mtu(SSL *s);
1989 __owur int tls1_new(SSL *s);
1990 void tls1_free(SSL *s);
1991 void tls1_clear(SSL *s);
1992 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
1993 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
1995 __owur int dtls1_new(SSL *s);
1996 void dtls1_free(SSL *s);
1997 void dtls1_clear(SSL *s);
1998 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
1999 __owur int dtls1_shutdown(SSL *s);
2001 __owur int dtls1_dispatch_alert(SSL *s);
2003 __owur int ssl_init_wbio_buffer(SSL *s);
2004 void ssl_free_wbio_buffer(SSL *s);
2006 __owur int tls1_change_cipher_state(SSL *s, int which);
2007 __owur int tls1_setup_key_block(SSL *s);
2008 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2010 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2011 unsigned char *p, size_t len,
2012 size_t *secret_size);
2013 __owur int tls13_derive_secret(SSL *s, const unsigned char *insecret,
2014 const unsigned char *label, size_t labellen,
2015 unsigned char *secret);
2016 __owur int tls13_derive_key(SSL *s, const unsigned char *secret,
2017 unsigned char *key, size_t keylen);
2018 __owur int tls13_derive_iv(SSL *s, const unsigned char *secret,
2019 unsigned char *iv, size_t ivlen);
2020 __owur int tls13_generate_early_secret(SSL *s, const unsigned char *insecret,
2021 size_t insecretlen);
2022 __owur int tls13_generate_handshake_secret(SSL *s,
2023 const unsigned char *insecret,
2024 size_t insecretlen);
2025 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2026 unsigned char *prev, size_t prevlen,
2027 size_t *secret_size);
2028 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2029 const char *label, size_t llen,
2030 const unsigned char *p, size_t plen,
2032 __owur int tls1_alert_code(int code);
2033 __owur int ssl3_alert_code(int code);
2034 __owur int ssl_ok(SSL *s);
2036 # ifndef OPENSSL_NO_EC
2037 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2040 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2042 # ifndef OPENSSL_NO_EC
2043 /* Flags values from tls1_ec_curve_id2nid() */
2044 /* Mask for curve type */
2045 # define TLS_CURVE_TYPE 0x3
2046 # define TLS_CURVE_PRIME 0x0
2047 # define TLS_CURVE_CHAR2 0x1
2048 # define TLS_CURVE_CUSTOM 0x2
2049 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2050 __owur int tls1_ec_nid2curve_id(int nid);
2051 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2052 __owur int tls1_shared_curve(SSL *s, int nmatch);
2053 __owur int tls1_set_curves(unsigned char **pext, size_t *pextlen,
2054 int *curves, size_t ncurves);
2055 __owur int tls1_set_curves_list(unsigned char **pext, size_t *pextlen,
2057 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2058 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2059 # endif /* OPENSSL_NO_EC */
2061 __owur int tls1_shared_list(SSL *s,
2062 const unsigned char *l1, size_t l1len,
2063 const unsigned char *l2, size_t l2len, int nmatch);
2064 __owur int ssl_add_clienthello_tlsext(SSL *s, WPACKET *pkt, int *al);
2065 __owur int ssl_add_serverhello_tlsext(SSL *s, WPACKET *pkt, int *al);
2066 __owur int ssl_parse_clienthello_tlsext(SSL *s, CLIENTHELLO_MSG *hello);
2067 void ssl_set_default_md(SSL *s);
2068 __owur int tls1_set_server_sigalgs(SSL *s);
2069 __owur int ssl_check_clienthello_tlsext_late(SSL *s, int *al);
2070 __owur int ssl_parse_serverhello_tlsext(SSL *s, PACKET *pkt);
2071 __owur int ssl_prepare_clienthello_tlsext(SSL *s);
2072 __owur int ssl_prepare_serverhello_tlsext(SSL *s);
2074 # ifndef OPENSSL_NO_HEARTBEATS
2075 __owur int dtls1_heartbeat(SSL *s);
2076 __owur int dtls1_process_heartbeat(SSL *s, unsigned char *p,
2080 __owur RAW_EXTENSION *tls_get_extension_by_type(RAW_EXTENSION *exts,
2083 __owur int tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2085 __owur int tls_check_client_ems_support(SSL *s, const CLIENTHELLO_MSG *hello);
2087 __owur int tls12_get_sigandhash(WPACKET *pkt, const EVP_PKEY *pk,
2089 __owur int tls12_get_sigid(const EVP_PKEY *pk);
2090 __owur const EVP_MD *tls12_get_hash(unsigned char hash_alg);
2091 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2093 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2094 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2096 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2098 void tls1_set_cert_validity(SSL *s);
2100 # ifndef OPENSSL_NO_CT
2101 __owur int ssl_validate_ct(SSL *s);
2104 # ifndef OPENSSL_NO_DH
2105 __owur DH *ssl_get_auto_dh(SSL *s);
2108 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2109 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2112 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2113 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2114 __owur int ssl_add_serverhello_renegotiate_ext(SSL *s, WPACKET *pkt);
2115 __owur int ssl_parse_serverhello_renegotiate_ext(SSL *s, PACKET *pkt, int *al);
2116 __owur int ssl_parse_clienthello_renegotiate_ext(SSL *s, PACKET *pkt, int *al);
2117 __owur long ssl_get_algorithm2(SSL *s);
2118 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2119 const unsigned char *psig, size_t psiglen);
2120 __owur int tls1_save_sigalgs(SSL *s, const unsigned char *data, size_t dsize);
2121 __owur int tls1_process_sigalgs(SSL *s);
2122 __owur size_t tls12_get_psigalgs(SSL *s, const unsigned char **psigs);
2123 __owur int tls12_check_peer_sigalg(const EVP_MD **pmd, SSL *s,
2124 const unsigned char *sig, EVP_PKEY *pkey);
2125 void ssl_set_client_disabled(SSL *s);
2126 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2128 __owur int ssl_parse_clienthello_use_srtp_ext(SSL *s, PACKET *pkt, int *al);
2129 __owur int ssl_parse_serverhello_use_srtp_ext(SSL *s, PACKET *pkt, int *al);
2131 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2133 __owur const EVP_MD *ssl_md(int idx);
2134 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2135 __owur const EVP_MD *ssl_prf_md(SSL *s);
2138 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2139 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2140 unsigned char *md_out,
2141 size_t *md_out_size,
2142 const unsigned char header[13],
2143 const unsigned char *data,
2144 size_t data_plus_mac_size,
2145 size_t data_plus_mac_plus_padding_size,
2146 const unsigned char *mac_secret,
2147 size_t mac_secret_length, char is_sslv3);
2149 __owur int tls_fips_digest_extra(const EVP_CIPHER_CTX *cipher_ctx,
2150 EVP_MD_CTX *mac_ctx, const unsigned char *data,
2151 size_t data_len, size_t orig_len);
2153 __owur int srp_generate_server_master_secret(SSL *s);
2154 __owur int srp_generate_client_master_secret(SSL *s);
2155 __owur int srp_verify_server_param(SSL *s, int *al);
2159 void custom_ext_init(custom_ext_methods *meths);
2161 __owur int custom_ext_parse(SSL *s, int server,
2162 unsigned int ext_type,
2163 const unsigned char *ext_data, size_t ext_size,
2165 __owur int custom_ext_add(SSL *s, int server, WPACKET *pkt, int *al);
2167 __owur int custom_exts_copy(custom_ext_methods *dst,
2168 const custom_ext_methods *src);
2169 void custom_exts_free(custom_ext_methods *exts);
2171 void ssl_comp_free_compression_methods_int(void);
2175 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2176 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2177 # define dtls1_process_heartbeat SSL_test_functions()->p_dtls1_process_heartbeat