2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
58 /* ====================================================================
59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
111 /* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113 * ECC cipher suite support in OpenSSL originally developed by
114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
116 /* ====================================================================
117 * Copyright 2005 Nokia. All rights reserved.
119 * The portions of the attached software ("Contribution") is developed by
120 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
123 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
124 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
125 * support (see RFC 4279) to OpenSSL.
127 * No patent licenses or other rights except those expressly stated in
128 * the OpenSSL open source license shall be deemed granted or received
129 * expressly, by implication, estoppel, or otherwise.
131 * No assurances are provided by Nokia that the Contribution does not
132 * infringe the patent or other intellectual property rights of any third
133 * party or that the license provides you with all the necessary rights
134 * to make use of the Contribution.
136 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
137 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
138 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
139 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
143 #ifndef HEADER_SSL_LOCL_H
144 # define HEADER_SSL_LOCL_H
152 # include <openssl/buffer.h>
153 # ifndef OPENSSL_NO_COMP
154 # include <openssl/comp.h>
156 # include <openssl/bio.h>
157 # include <openssl/stack.h>
158 # ifndef OPENSSL_NO_RSA
159 # include <openssl/rsa.h>
161 # ifndef OPENSSL_NO_DSA
162 # include <openssl/dsa.h>
164 # include <openssl/err.h>
165 # include <openssl/ssl.h>
166 # include <openssl/symhacks.h>
168 #include "record/record.h"
170 # ifdef OPENSSL_BUILD_SHLIBSSL
171 # undef OPENSSL_EXTERN
172 # define OPENSSL_EXTERN OPENSSL_EXPORT
177 # define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
178 l|=(((unsigned long)(*((c)++)))<< 8), \
179 l|=(((unsigned long)(*((c)++)))<<16), \
180 l|=(((unsigned long)(*((c)++)))<<24))
182 /* NOTE - c is not incremented as per c2l */
183 # define c2ln(c,l1,l2,n) { \
187 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
188 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
189 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
190 case 5: l2|=((unsigned long)(*(--(c)))); \
191 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
192 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
193 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
194 case 1: l1|=((unsigned long)(*(--(c)))); \
198 # define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
199 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
200 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
201 *((c)++)=(unsigned char)(((l)>>24)&0xff))
203 # define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
204 l|=((unsigned long)(*((c)++)))<<16, \
205 l|=((unsigned long)(*((c)++)))<< 8, \
206 l|=((unsigned long)(*((c)++))))
208 # define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
209 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
210 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
211 *((c)++)=(unsigned char)(((l) )&0xff))
213 # define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
214 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
215 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
216 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
217 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
218 *((c)++)=(unsigned char)(((l) )&0xff))
220 # define l2n8(l,c) (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
221 *((c)++)=(unsigned char)(((l)>>48)&0xff), \
222 *((c)++)=(unsigned char)(((l)>>40)&0xff), \
223 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
224 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
225 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
226 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
227 *((c)++)=(unsigned char)(((l) )&0xff))
229 # define n2l6(c,l) (l =((BN_ULLONG)(*((c)++)))<<40, \
230 l|=((BN_ULLONG)(*((c)++)))<<32, \
231 l|=((BN_ULLONG)(*((c)++)))<<24, \
232 l|=((BN_ULLONG)(*((c)++)))<<16, \
233 l|=((BN_ULLONG)(*((c)++)))<< 8, \
234 l|=((BN_ULLONG)(*((c)++))))
236 /* NOTE - c is not incremented as per l2c */
237 # define l2cn(l1,l2,c,n) { \
240 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
241 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
242 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
243 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
244 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
245 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
246 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
247 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
251 # define n2s(c,s) ((s=(((unsigned int)(c[0]))<< 8)| \
252 (((unsigned int)(c[1])) )),c+=2)
253 # define s2n(s,c) ((c[0]=(unsigned char)(((s)>> 8)&0xff), \
254 c[1]=(unsigned char)(((s) )&0xff)),c+=2)
256 # define n2l3(c,l) ((l =(((unsigned long)(c[0]))<<16)| \
257 (((unsigned long)(c[1]))<< 8)| \
258 (((unsigned long)(c[2])) )),c+=3)
260 # define l2n3(l,c) ((c[0]=(unsigned char)(((l)>>16)&0xff), \
261 c[1]=(unsigned char)(((l)>> 8)&0xff), \
262 c[2]=(unsigned char)(((l) )&0xff)),c+=3)
266 # define SSL_DECRYPT 0
267 # define SSL_ENCRYPT 1
269 # define TWO_BYTE_BIT 0x80
270 # define SEC_ESC_BIT 0x40
271 # define TWO_BYTE_MASK 0x7fff
272 # define THREE_BYTE_MASK 0x3fff
274 # define INC32(a) ((a)=((a)+1)&0xffffffffL)
275 # define DEC32(a) ((a)=((a)-1)&0xffffffffL)
276 # define MAX_MAC_SIZE 20 /* up from 16 for SSLv3 */
279 * Define the Bitmasks for SSL_CIPHER.algorithms.
280 * This bits are used packed as dense as possible. If new methods/ciphers
281 * etc will be added, the bits a likely to change, so this information
282 * is for internal library use only, even though SSL_CIPHER.algorithms
283 * can be publicly accessed.
284 * Use the according functions for cipher management instead.
286 * The bit mask handling in the selection and sorting scheme in
287 * ssl_create_cipher_list() has only limited capabilities, reflecting
288 * that the different entities within are mutually exclusive:
289 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
292 /* Bits for algorithm_mkey (key exchange algorithm) */
293 /* RSA key exchange */
294 # define SSL_kRSA 0x00000001L
295 /* DH cert, RSA CA cert */
296 # define SSL_kDHr 0x00000002L
297 /* DH cert, DSA CA cert */
298 # define SSL_kDHd 0x00000004L
299 /* tmp DH key no DH cert */
300 # define SSL_kDHE 0x00000008L
302 # define SSL_kEDH SSL_kDHE
303 /* Kerberos5 key exchange */
304 # define SSL_kKRB5 0x00000010L
305 /* ECDH cert, RSA CA cert */
306 # define SSL_kECDHr 0x00000020L
307 /* ECDH cert, ECDSA CA cert */
308 # define SSL_kECDHe 0x00000040L
310 # define SSL_kECDHE 0x00000080L
312 # define SSL_kEECDH SSL_kECDHE
314 # define SSL_kPSK 0x00000100L
315 /* GOST key exchange */
316 # define SSL_kGOST 0x00000200L
318 # define SSL_kSRP 0x00000400L
320 /* Bits for algorithm_auth (server authentication) */
322 # define SSL_aRSA 0x00000001L
324 # define SSL_aDSS 0x00000002L
325 /* no auth (i.e. use ADH or AECDH) */
326 # define SSL_aNULL 0x00000004L
327 /* Fixed DH auth (kDHd or kDHr) */
328 # define SSL_aDH 0x00000008L
329 /* Fixed ECDH auth (kECDHe or kECDHr) */
330 # define SSL_aECDH 0x00000010L
332 # define SSL_aKRB5 0x00000020L
334 # define SSL_aECDSA 0x00000040L
336 # define SSL_aPSK 0x00000080L
337 /* GOST R 34.10-94 signature auth */
338 # define SSL_aGOST94 0x00000100L
339 /* GOST R 34.10-2001 signature auth */
340 # define SSL_aGOST01 0x00000200L
342 # define SSL_aSRP 0x00000400L
344 /* Bits for algorithm_enc (symmetric encryption) */
345 # define SSL_DES 0x00000001L
346 # define SSL_3DES 0x00000002L
347 # define SSL_RC4 0x00000004L
348 # define SSL_RC2 0x00000008L
349 # define SSL_IDEA 0x00000010L
350 # define SSL_eNULL 0x00000020L
351 # define SSL_AES128 0x00000040L
352 # define SSL_AES256 0x00000080L
353 # define SSL_CAMELLIA128 0x00000100L
354 # define SSL_CAMELLIA256 0x00000200L
355 # define SSL_eGOST2814789CNT 0x00000400L
356 # define SSL_SEED 0x00000800L
357 # define SSL_AES128GCM 0x00001000L
358 # define SSL_AES256GCM 0x00002000L
360 # define SSL_AES (SSL_AES128|SSL_AES256|SSL_AES128GCM|SSL_AES256GCM)
361 # define SSL_CAMELLIA (SSL_CAMELLIA128|SSL_CAMELLIA256)
363 /* Bits for algorithm_mac (symmetric authentication) */
365 # define SSL_MD5 0x00000001L
366 # define SSL_SHA1 0x00000002L
367 # define SSL_GOST94 0x00000004L
368 # define SSL_GOST89MAC 0x00000008L
369 # define SSL_SHA256 0x00000010L
370 # define SSL_SHA384 0x00000020L
371 /* Not a real MAC, just an indication it is part of cipher */
372 # define SSL_AEAD 0x00000040L
374 /* Bits for algorithm_ssl (protocol version) */
375 # define SSL_SSLV3 0x00000002L
376 # define SSL_TLSV1 SSL_SSLV3/* for now */
377 # define SSL_TLSV1_2 0x00000004L
379 /* Bits for algorithm2 (handshake digests and other extra flags) */
381 # define SSL_HANDSHAKE_MAC_MD5 0x10
382 # define SSL_HANDSHAKE_MAC_SHA 0x20
383 # define SSL_HANDSHAKE_MAC_GOST94 0x40
384 # define SSL_HANDSHAKE_MAC_SHA256 0x80
385 # define SSL_HANDSHAKE_MAC_SHA384 0x100
386 # define SSL_HANDSHAKE_MAC_DEFAULT (SSL_HANDSHAKE_MAC_MD5 | SSL_HANDSHAKE_MAC_SHA)
389 * When adding new digest in the ssl_ciph.c and increment SSM_MD_NUM_IDX make
390 * sure to update this constant too
392 # define SSL_MAX_DIGEST 6
394 # define TLS1_PRF_DGST_SHIFT 10
395 # define TLS1_PRF_MD5 (SSL_HANDSHAKE_MAC_MD5 << TLS1_PRF_DGST_SHIFT)
396 # define TLS1_PRF_SHA1 (SSL_HANDSHAKE_MAC_SHA << TLS1_PRF_DGST_SHIFT)
397 # define TLS1_PRF_SHA256 (SSL_HANDSHAKE_MAC_SHA256 << TLS1_PRF_DGST_SHIFT)
398 # define TLS1_PRF_SHA384 (SSL_HANDSHAKE_MAC_SHA384 << TLS1_PRF_DGST_SHIFT)
399 # define TLS1_PRF_GOST94 (SSL_HANDSHAKE_MAC_GOST94 << TLS1_PRF_DGST_SHIFT)
400 # define TLS1_PRF (TLS1_PRF_MD5 | TLS1_PRF_SHA1)
403 * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
404 * goes into algorithm2)
406 # define TLS1_STREAM_MAC 0x04
409 * Export and cipher strength information. For each cipher we have to decide
410 * whether it is exportable or not. This information is likely to change
411 * over time, since the export control rules are no static technical issue.
413 * Independent of the export flag the cipher strength is sorted into classes.
414 * SSL_EXP40 was denoting the 40bit US export limit of past times, which now
415 * is at 56bit (SSL_EXP56). If the exportable cipher class is going to change
416 * again (eg. to 64bit) the use of "SSL_EXP*" becomes blurred even more,
417 * since SSL_EXP64 could be similar to SSL_LOW.
418 * For this reason SSL_MICRO and SSL_MINI macros are included to widen the
419 * namespace of SSL_LOW-SSL_HIGH to lower values. As development of speed
420 * and ciphers goes, another extension to SSL_SUPER and/or SSL_ULTRA would
423 # define SSL_EXP_MASK 0x00000003L
424 # define SSL_STRONG_MASK 0x000001fcL
426 # define SSL_NOT_EXP 0x00000001L
427 # define SSL_EXPORT 0x00000002L
429 # define SSL_STRONG_NONE 0x00000004L
430 # define SSL_EXP40 0x00000008L
431 # define SSL_MICRO (SSL_EXP40)
432 # define SSL_EXP56 0x00000010L
433 # define SSL_MINI (SSL_EXP56)
434 # define SSL_LOW 0x00000020L
435 # define SSL_MEDIUM 0x00000040L
436 # define SSL_HIGH 0x00000080L
437 # define SSL_FIPS 0x00000100L
439 /* we have used 000001ff - 23 bits left to go */
442 * Macros to check the export status and cipher strength for export ciphers.
443 * Even though the macros for EXPORT and EXPORT40/56 have similar names,
444 * their meaning is different:
445 * *_EXPORT macros check the 'exportable' status.
446 * *_EXPORT40/56 macros are used to check whether a certain cipher strength
448 * Since the SSL_IS_EXPORT* and SSL_EXPORT* macros depend on the correct
449 * algorithm structure element to be passed (algorithms, algo_strength) and no
450 * typechecking can be done as they are all of type unsigned long, their
451 * direct usage is discouraged.
452 * Use the SSL_C_* macros instead.
454 # define SSL_IS_EXPORT(a) ((a)&SSL_EXPORT)
455 # define SSL_IS_EXPORT56(a) ((a)&SSL_EXP56)
456 # define SSL_IS_EXPORT40(a) ((a)&SSL_EXP40)
457 # define SSL_C_IS_EXPORT(c) SSL_IS_EXPORT((c)->algo_strength)
458 # define SSL_C_IS_EXPORT56(c) SSL_IS_EXPORT56((c)->algo_strength)
459 # define SSL_C_IS_EXPORT40(c) SSL_IS_EXPORT40((c)->algo_strength)
461 # define SSL_EXPORT_KEYLENGTH(a,s) (SSL_IS_EXPORT40(s) ? 5 : \
462 (a) == SSL_DES ? 8 : 7)
463 # define SSL_EXPORT_PKEYLENGTH(a) (SSL_IS_EXPORT40(a) ? 512 : 1024)
464 # define SSL_C_EXPORT_KEYLENGTH(c) SSL_EXPORT_KEYLENGTH((c)->algorithm_enc, \
466 # define SSL_C_EXPORT_PKEYLENGTH(c) SSL_EXPORT_PKEYLENGTH((c)->algo_strength)
468 /* Check if an SSL structure is using DTLS */
469 # define SSL_IS_DTLS(s) (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
470 /* See if we need explicit IV */
471 # define SSL_USE_EXPLICIT_IV(s) \
472 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
474 * See if we use signature algorithms extension and signature algorithm
477 # define SSL_USE_SIGALGS(s) \
478 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
480 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
481 * apply to others in future.
483 # define SSL_USE_TLS1_2_CIPHERS(s) \
484 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
486 * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
487 * flags because it may not be set to correct version yet.
489 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s) \
490 ((SSL_IS_DTLS(s) && s->client_version <= DTLS1_2_VERSION) || \
491 (!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION))
493 # ifdef TLSEXT_TYPE_encrypt_then_mac
494 # define SSL_USE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC)
496 # define SSL_USE_ETM(s) (0)
499 /* Mostly for SSLv3 */
500 # define SSL_PKEY_RSA_ENC 0
501 # define SSL_PKEY_RSA_SIGN 1
502 # define SSL_PKEY_DSA_SIGN 2
503 # define SSL_PKEY_DH_RSA 3
504 # define SSL_PKEY_DH_DSA 4
505 # define SSL_PKEY_ECC 5
506 # define SSL_PKEY_GOST94 6
507 # define SSL_PKEY_GOST01 7
508 # define SSL_PKEY_NUM 8
511 * SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
512 * <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
513 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
514 * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
515 * SSL_aRSA <- RSA_ENC | RSA_SIGN
516 * SSL_aDSS <- DSA_SIGN
520 #define CERT_INVALID 0
521 #define CERT_PUBLIC_KEY 1
522 #define CERT_PRIVATE_KEY 2
525 /* used to hold info on the particular ciphers used */
526 struct ssl_cipher_st {
528 const char *name; /* text name */
529 unsigned long id; /* id, 4 bytes, first is version */
531 * changed in 0.9.9: these four used to be portions of a single value
534 unsigned long algorithm_mkey; /* key exchange algorithm */
535 unsigned long algorithm_auth; /* server authentication */
536 unsigned long algorithm_enc; /* symmetric encryption */
537 unsigned long algorithm_mac; /* symmetric authentication */
538 unsigned long algorithm_ssl; /* (major) protocol version */
539 unsigned long algo_strength; /* strength and export flags */
540 unsigned long algorithm2; /* Extra flags */
541 int strength_bits; /* Number of bits really used */
542 int alg_bits; /* Number of bits for algorithm */
545 /* Used to hold functions for SSLv2 or SSLv3/TLSv1 functions */
546 struct ssl_method_st {
548 int (*ssl_new) (SSL *s);
549 void (*ssl_clear) (SSL *s);
550 void (*ssl_free) (SSL *s);
551 int (*ssl_accept) (SSL *s);
552 int (*ssl_connect) (SSL *s);
553 int (*ssl_read) (SSL *s, void *buf, int len);
554 int (*ssl_peek) (SSL *s, void *buf, int len);
555 int (*ssl_write) (SSL *s, const void *buf, int len);
556 int (*ssl_shutdown) (SSL *s);
557 int (*ssl_renegotiate) (SSL *s);
558 int (*ssl_renegotiate_check) (SSL *s);
559 long (*ssl_get_message) (SSL *s, int st1, int stn, int mt, long
561 int (*ssl_read_bytes) (SSL *s, int type, unsigned char *buf, int len,
563 int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, int len);
564 int (*ssl_dispatch_alert) (SSL *s);
565 long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
566 long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
567 const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
568 int (*put_cipher_by_char) (const SSL_CIPHER *cipher, unsigned char *ptr);
569 int (*ssl_pending) (const SSL *s);
570 int (*num_ciphers) (void);
571 const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
572 const struct ssl_method_st *(*get_ssl_method) (int version);
573 long (*get_timeout) (void);
574 const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
575 int (*ssl_version) (void);
576 long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
577 long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
581 * Lets make this into an ASN.1 type structure as follows
582 * SSL_SESSION_ID ::= SEQUENCE {
583 * version INTEGER, -- structure version number
584 * SSLversion INTEGER, -- SSL version number
585 * Cipher OCTET STRING, -- the 3 byte cipher ID
586 * Session_ID OCTET STRING, -- the Session ID
587 * Master_key OCTET STRING, -- the master key
588 * KRB5_principal OCTET STRING -- optional Kerberos principal
589 * Key_Arg [ 0 ] IMPLICIT OCTET STRING, -- the optional Key argument
590 * Time [ 1 ] EXPLICIT INTEGER, -- optional Start Time
591 * Timeout [ 2 ] EXPLICIT INTEGER, -- optional Timeout ins seconds
592 * Peer [ 3 ] EXPLICIT X509, -- optional Peer Certificate
593 * Session_ID_context [ 4 ] EXPLICIT OCTET STRING, -- the Session ID context
594 * Verify_result [ 5 ] EXPLICIT INTEGER, -- X509_V_... code for `Peer'
595 * HostName [ 6 ] EXPLICIT OCTET STRING, -- optional HostName from servername TLS extension
596 * PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
597 * PSK_identity [ 8 ] EXPLICIT OCTET STRING, -- optional PSK identity
598 * Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
599 * Ticket [10] EXPLICIT OCTET STRING, -- session ticket (clients only)
600 * Compression_meth [11] EXPLICIT OCTET STRING, -- optional compression method
601 * SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
602 * flags [ 13 ] EXPLICIT INTEGER -- optional flags
604 * Look in ssl/ssl_asn1.c for more details
605 * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
607 struct ssl_session_st {
608 int ssl_version; /* what ssl version session info is being
610 int master_key_length;
611 unsigned char master_key[SSL_MAX_MASTER_KEY_LENGTH];
612 /* session_id - valid? */
613 unsigned int session_id_length;
614 unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
616 * this is used to determine whether the session is being reused in the
617 * appropriate context. It is up to the application to set this, via
620 unsigned int sid_ctx_length;
621 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
622 # ifndef OPENSSL_NO_KRB5
623 unsigned int krb5_client_princ_len;
624 unsigned char krb5_client_princ[SSL_MAX_KRB5_PRINCIPAL_LENGTH];
625 # endif /* OPENSSL_NO_KRB5 */
626 # ifndef OPENSSL_NO_PSK
627 char *psk_identity_hint;
631 * Used to indicate that session resumption is not allowed. Applications
632 * can also set this bit for a new session via not_resumable_session_cb
633 * to disable session caching and tickets.
636 /* The cert is the certificate used to establish this connection */
637 struct sess_cert_st /* SESS_CERT */ *sess_cert;
639 * This is the cert for the other end. On clients, it will be the same as
640 * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is
641 * not retained in the external representation of sessions, see
646 * when app_verify_callback accepts a session where the peer's
647 * certificate is not ok, we must remember the error for session reuse:
649 long verify_result; /* only for servers */
653 unsigned int compress_meth; /* Need to lookup the method */
654 const SSL_CIPHER *cipher;
655 unsigned long cipher_id; /* when ASN.1 loaded, this needs to be used
656 * to load the 'cipher' structure */
657 STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
658 CRYPTO_EX_DATA ex_data; /* application specific data */
660 * These are used to make removal of session-ids more efficient and to
661 * implement a maximum cache size.
663 struct ssl_session_st *prev, *next;
664 # ifndef OPENSSL_NO_TLSEXT
665 char *tlsext_hostname;
666 # ifndef OPENSSL_NO_EC
667 size_t tlsext_ecpointformatlist_length;
668 unsigned char *tlsext_ecpointformatlist; /* peer's list */
669 size_t tlsext_ellipticcurvelist_length;
670 unsigned char *tlsext_ellipticcurvelist; /* peer's list */
671 # endif /* OPENSSL_NO_EC */
673 unsigned char *tlsext_tick; /* Session ticket */
674 size_t tlsext_ticklen; /* Session ticket length */
675 unsigned long tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
677 # ifndef OPENSSL_NO_SRP
683 /* Extended master secret support */
684 # define SSL_SESS_FLAG_EXTMS 0x1
687 # ifndef OPENSSL_NO_SRP
689 typedef struct srp_ctx_st {
690 /* param for all the callbacks */
692 /* set client Hello login callback */
693 int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
694 /* set SRP N/g param callback for verification */
695 int (*SRP_verify_param_callback) (SSL *, void *);
696 /* set SRP client passwd callback */
697 char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
699 BIGNUM *N, *g, *s, *B, *A;
703 unsigned long srp_Mask;
708 typedef struct ssl_comp_st SSL_COMP;
716 DECLARE_STACK_OF(SSL_COMP)
717 DECLARE_LHASH_OF(SSL_SESSION);
720 const SSL_METHOD *method;
721 STACK_OF(SSL_CIPHER) *cipher_list;
722 /* same as above but sorted for lookup */
723 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
724 struct x509_store_st /* X509_STORE */ *cert_store;
725 LHASH_OF(SSL_SESSION) *sessions;
727 * Most session-ids that will be cached, default is
728 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
730 unsigned long session_cache_size;
731 struct ssl_session_st *session_cache_head;
732 struct ssl_session_st *session_cache_tail;
734 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
735 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
736 * means only SSL_accept which cache SSL_SESSIONS.
738 int session_cache_mode;
740 * If timeout is not 0, it is the default timeout value set when
741 * SSL_new() is called. This has been put in to make life easier to set
744 long session_timeout;
746 * If this callback is not null, it will be called each time a session id
747 * is added to the cache. If this function returns 1, it means that the
748 * callback will do a SSL_SESSION_free() when it has finished using it.
749 * Otherwise, on 0, it means the callback has finished with it. If
750 * remove_session_cb is not null, it will be called when a session-id is
751 * removed from the cache. After the call, OpenSSL will
752 * SSL_SESSION_free() it.
754 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
755 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
756 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
757 unsigned char *data, int len, int *copy);
759 int sess_connect; /* SSL new conn - started */
760 int sess_connect_renegotiate; /* SSL reneg - requested */
761 int sess_connect_good; /* SSL new conne/reneg - finished */
762 int sess_accept; /* SSL new accept - started */
763 int sess_accept_renegotiate; /* SSL reneg - requested */
764 int sess_accept_good; /* SSL accept/reneg - finished */
765 int sess_miss; /* session lookup misses */
766 int sess_timeout; /* reuse attempt on timeouted session */
767 int sess_cache_full; /* session removed due to full cache */
768 int sess_hit; /* session reuse actually done */
769 int sess_cb_hit; /* session-id that was not in the cache was
770 * passed back via the callback. This
771 * indicates that the application is
772 * supplying session-id's from other
773 * processes - spooky :-) */
778 /* if defined, these override the X509_verify_cert() calls */
779 int (*app_verify_callback) (X509_STORE_CTX *, void *);
780 void *app_verify_arg;
782 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
783 * ('app_verify_callback' was called with just one argument)
786 /* Default password callback. */
787 pem_password_cb *default_passwd_callback;
789 /* Default password callback user data. */
790 void *default_passwd_callback_userdata;
792 /* get client cert callback */
793 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
795 /* cookie generate callback */
796 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
797 unsigned int *cookie_len);
799 /* verify cookie callback */
800 int (*app_verify_cookie_cb) (SSL *ssl, unsigned char *cookie,
801 unsigned int cookie_len);
803 CRYPTO_EX_DATA ex_data;
805 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
806 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
808 STACK_OF(X509) *extra_certs;
809 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
811 /* Default values used when no per-SSL value is defined follow */
813 /* used if SSL's info_callback is NULL */
814 void (*info_callback) (const SSL *ssl, int type, int val);
816 /* what we put in client cert requests */
817 STACK_OF(X509_NAME) *client_CA;
820 * Default values to use in SSL structures follow (these are copied by
824 unsigned long options;
828 struct cert_st /* CERT */ *cert;
831 /* callback that allows applications to peek at protocol messages */
832 void (*msg_callback) (int write_p, int version, int content_type,
833 const void *buf, size_t len, SSL *ssl, void *arg);
834 void *msg_callback_arg;
837 unsigned int sid_ctx_length;
838 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
839 /* called 'verify_callback' in the SSL */
840 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
842 /* Default generate session ID callback. */
843 GEN_SESSION_CB generate_session_id;
845 X509_VERIFY_PARAM *param;
850 * Maximum amount of data to send in one fragment. actual record size can
851 * be more than this due to padding and MAC overheads.
853 unsigned int max_send_fragment;
855 # ifndef OPENSSL_NO_ENGINE
857 * Engine to pass requests for client certs to
859 ENGINE *client_cert_engine;
862 # ifndef OPENSSL_NO_TLSEXT
863 /* TLS extensions servername callback */
864 int (*tlsext_servername_callback) (SSL *, int *, void *);
865 void *tlsext_servername_arg;
866 /* RFC 4507 session ticket keys */
867 unsigned char tlsext_tick_key_name[16];
868 unsigned char tlsext_tick_hmac_key[16];
869 unsigned char tlsext_tick_aes_key[16];
870 /* Callback to support customisation of ticket key setting */
871 int (*tlsext_ticket_key_cb) (SSL *ssl,
872 unsigned char *name, unsigned char *iv,
873 EVP_CIPHER_CTX *ectx,
874 HMAC_CTX *hctx, int enc);
876 /* certificate status request info */
877 /* Callback for status request */
878 int (*tlsext_status_cb) (SSL *ssl, void *arg);
879 void *tlsext_status_arg;
882 # ifndef OPENSSL_NO_PSK
883 char *psk_identity_hint;
884 unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
886 unsigned int max_identity_len,
888 unsigned int max_psk_len);
889 unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
891 unsigned int max_psk_len);
894 # ifndef OPENSSL_NO_SRP
895 SRP_CTX srp_ctx; /* ctx for SRP authentication */
898 # ifndef OPENSSL_NO_TLSEXT
900 # ifndef OPENSSL_NO_NEXTPROTONEG
901 /* Next protocol negotiation information */
902 /* (for experimental NPN extension). */
905 * For a server, this contains a callback function by which the set of
906 * advertised protocols can be provided.
908 int (*next_protos_advertised_cb) (SSL *s, const unsigned char **buf,
909 unsigned int *len, void *arg);
910 void *next_protos_advertised_cb_arg;
912 * For a client, this contains a callback function that selects the next
913 * protocol from the list provided by the server.
915 int (*next_proto_select_cb) (SSL *s, unsigned char **out,
916 unsigned char *outlen,
917 const unsigned char *in,
918 unsigned int inlen, void *arg);
919 void *next_proto_select_cb_arg;
923 * ALPN information (we are in the process of transitioning from NPN to
928 * For a server, this contains a callback function that allows the
929 * server to select the protocol for the connection.
930 * out: on successful return, this must point to the raw protocol
931 * name (without the length prefix).
932 * outlen: on successful return, this contains the length of |*out|.
933 * in: points to the client's list of supported protocols in
935 * inlen: the length of |in|.
937 int (*alpn_select_cb) (SSL *s,
938 const unsigned char **out,
939 unsigned char *outlen,
940 const unsigned char *in,
941 unsigned int inlen, void *arg);
942 void *alpn_select_cb_arg;
945 * For a client, this contains the list of supported protocols in wire
948 unsigned char *alpn_client_proto_list;
949 unsigned alpn_client_proto_list_len;
951 /* SRTP profiles we are willing to do from RFC 5764 */
952 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
955 * Callback for disabling session caching and ticket support on a session
956 * basis, depending on the chosen cipher.
958 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
959 # ifndef OPENSSL_NO_EC
960 /* EC extension values inherited by SSL structure */
961 size_t tlsext_ecpointformatlist_length;
962 unsigned char *tlsext_ecpointformatlist;
963 size_t tlsext_ellipticcurvelist_length;
964 unsigned char *tlsext_ellipticcurvelist;
965 # endif /* OPENSSL_NO_EC */
971 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
975 /* SSL_ST_CONNECT or SSL_ST_ACCEPT */
978 const SSL_METHOD *method;
980 * There are 2 BIO's even though they are normally both the same. This
981 * is so data can be read and written to different handlers
983 /* used by SSL_read */
985 /* used by SSL_write */
987 /* used during session-id reuse to concatenate messages */
990 * This holds a variable that indicates what we were doing when a 0 or -1
991 * is returned. This is needed for non-blocking IO so we know what
992 * request needs re-doing when in SSL_accept or SSL_connect
995 /* true when we are actually in SSL_accept() or SSL_connect() */
997 int (*handshake_func) (SSL *);
999 * Imagine that here's a boolean member "init" that is switched as soon
1000 * as SSL_set_{accept/connect}_state is called for the first time, so
1001 * that "state" and "handshake_func" are properly initialized. But as
1002 * handshake_func is == 0 until then, we use this test instead of an
1005 /* are we the server side? - mostly used by SSL_clear */
1008 * Generate a new session or reuse an old one.
1009 * NB: For servers, the 'new' session may actually be a previously
1010 * cached session or even the previous session unless
1011 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1014 /* don't send shutdown packets */
1016 /* we have shut things down, 0x01 sent, 0x02 for received */
1020 BUF_MEM *init_buf; /* buffer used during init */
1021 void *init_msg; /* pointer to handshake message body, set by
1022 * ssl3_get_message() */
1023 int init_num; /* amount read/written */
1024 int init_off; /* amount read/written */
1026 struct ssl3_state_st *s3; /* SSLv3 variables */
1027 struct dtls1_state_st *d1; /* DTLSv1 variables */
1029 /* callback that allows applications to peek at protocol messages */
1030 void (*msg_callback) (int write_p, int version, int content_type,
1031 const void *buf, size_t len, SSL *ssl, void *arg);
1032 void *msg_callback_arg;
1033 int hit; /* reusing a previous session */
1034 X509_VERIFY_PARAM *param;
1036 STACK_OF(SSL_CIPHER) *cipher_list;
1037 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1039 * These are the ones being used, the ones in SSL_SESSION are the ones to
1040 * be 'copied' into these ones
1043 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1044 EVP_MD_CTX *read_hash; /* used for mac generation */
1045 COMP_CTX *compress; /* compression */
1046 COMP_CTX *expand; /* uncompress */
1047 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1048 EVP_MD_CTX *write_hash; /* used for mac generation */
1051 /* This is used to hold the server certificate used */
1052 struct cert_st /* CERT */ *cert;
1054 * the session_id_context is used to ensure sessions are only reused in
1055 * the appropriate context
1057 unsigned int sid_ctx_length;
1058 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1059 /* This can also be in the session once a session is established */
1060 SSL_SESSION *session;
1061 /* Default generate session ID callback. */
1062 GEN_SESSION_CB generate_session_id;
1065 * 0 don't care about verify failure.
1066 * 1 fail if verify fails
1069 /* fail if callback returns 0 */
1070 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1071 /* optional informational callback */
1072 void (*info_callback) (const SSL *ssl, int type, int val);
1073 /* error bytes to be written */
1077 # ifndef OPENSSL_NO_KRB5
1078 /* Kerberos 5 context */
1080 # endif /* OPENSSL_NO_KRB5 */
1081 # ifndef OPENSSL_NO_PSK
1082 unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
1084 unsigned int max_identity_len,
1086 unsigned int max_psk_len);
1087 unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
1089 unsigned int max_psk_len);
1093 * set this flag to 1 and a sleep(1) is put into all SSL_read() and
1094 * SSL_write() calls, good for nbio debuging :-)
1097 /* extra application data */
1099 CRYPTO_EX_DATA ex_data;
1100 /* for server side, keep the list of CA_dn we can use */
1101 STACK_OF(X509_NAME) *client_CA;
1103 /* protocol behaviour */
1104 unsigned long options;
1109 /* what was passed, used for SSLv3/TLS rollback check */
1111 unsigned int max_send_fragment;
1112 # ifndef OPENSSL_NO_TLSEXT
1113 /* TLS extension debug callback */
1114 void (*tlsext_debug_cb) (SSL *s, int client_server, int type,
1115 unsigned char *data, int len, void *arg);
1116 void *tlsext_debug_arg;
1117 char *tlsext_hostname;
1119 * no further mod of servername
1120 * 0 : call the servername extension callback.
1121 * 1 : prepare 2, allow last ack just after in server callback.
1122 * 2 : don't call servername callback, no ack in server hello
1124 int servername_done;
1125 /* certificate status request info */
1126 /* Status type or -1 if no status type */
1127 int tlsext_status_type;
1128 /* Expect OCSP CertificateStatus message */
1129 int tlsext_status_expected;
1130 /* OCSP status request only */
1131 STACK_OF(OCSP_RESPID) *tlsext_ocsp_ids;
1132 X509_EXTENSIONS *tlsext_ocsp_exts;
1133 /* OCSP response received or to be sent */
1134 unsigned char *tlsext_ocsp_resp;
1135 int tlsext_ocsp_resplen;
1136 /* RFC4507 session ticket expected to be received or sent */
1137 int tlsext_ticket_expected;
1138 # ifndef OPENSSL_NO_EC
1139 size_t tlsext_ecpointformatlist_length;
1141 unsigned char *tlsext_ecpointformatlist;
1142 size_t tlsext_ellipticcurvelist_length;
1144 unsigned char *tlsext_ellipticcurvelist;
1145 # endif /* OPENSSL_NO_EC */
1146 /* TLS Session Ticket extension override */
1147 TLS_SESSION_TICKET_EXT *tlsext_session_ticket;
1148 /* TLS Session Ticket extension callback */
1149 tls_session_ticket_ext_cb_fn tls_session_ticket_ext_cb;
1150 void *tls_session_ticket_ext_cb_arg;
1151 /* TLS pre-shared secret session resumption */
1152 tls_session_secret_cb_fn tls_session_secret_cb;
1153 void *tls_session_secret_cb_arg;
1154 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
1155 # ifndef OPENSSL_NO_NEXTPROTONEG
1157 * Next protocol negotiation. For the client, this is the protocol that
1158 * we sent in NextProtocol and is set when handling ServerHello
1159 * extensions. For a server, this is the client's selected_protocol from
1160 * NextProtocol and is set when handling the NextProtocol message, before
1161 * the Finished message.
1163 unsigned char *next_proto_negotiated;
1164 unsigned char next_proto_negotiated_len;
1166 # define session_ctx initial_ctx
1168 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1169 /* What's been chosen */
1170 SRTP_PROTECTION_PROFILE *srtp_profile;
1172 * Is use of the Heartbeat extension negotiated?
1175 * 2: enabled, but not allowed to send Requests
1177 unsigned int tlsext_heartbeat;
1178 /* Indicates if a HeartbeatRequest is in flight */
1179 unsigned int tlsext_hb_pending;
1180 /* HeartbeatRequest sequence number */
1181 unsigned int tlsext_hb_seq;
1183 * For a client, this contains the list of supported protocols in wire
1186 unsigned char *alpn_client_proto_list;
1187 unsigned alpn_client_proto_list_len;
1189 # define session_ctx ctx
1190 # endif /* OPENSSL_NO_TLSEXT */
1192 * 1 if we are renegotiating.
1193 * 2 if we are a server and are inside a handshake
1194 * (i.e. not just sending a HelloRequest)
1197 # ifndef OPENSSL_NO_SRP
1198 /* ctx for SRP authentication */
1202 * Callback for disabling session caching and ticket support on a session
1203 * basis, depending on the chosen cipher.
1205 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1207 RECORD_LAYER rlayer;
1211 typedef struct ssl3_state_st {
1213 int delay_buf_pop_ret;
1214 int read_mac_secret_size;
1215 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1216 int write_mac_secret_size;
1217 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1218 unsigned char server_random[SSL3_RANDOM_SIZE];
1219 unsigned char client_random[SSL3_RANDOM_SIZE];
1220 /* flags for countermeasure against known-IV weakness */
1221 int need_empty_fragments;
1222 int empty_fragment_done;
1223 /* The value of 'extra' when the buffers were initialized */
1225 /* used during startup, digest all incoming/outgoing packets */
1226 BIO *handshake_buffer;
1228 * When set of handshake digests is determined, buffer is hashed and
1229 * freed and MD_CTX-es for all required digests are stored in this array
1231 EVP_MD_CTX **handshake_dgst;
1233 * Set whenever an expected ChangeCipherSpec message is processed.
1234 * Unset when the peer's Finished message is received.
1235 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1237 int change_cipher_spec;
1241 * we allow one fatal and one warning alert to be outstanding, send close
1242 * alert via the warning alert
1245 unsigned char send_alert[2];
1247 * This flag is set when we should renegotiate ASAP, basically when there
1248 * is no more data in the read or write buffers
1251 int total_renegotiations;
1252 int num_renegotiations;
1253 int in_read_app_data;
1255 /* actually only needs to be 16+20 */
1256 unsigned char cert_verify_md[EVP_MAX_MD_SIZE * 2];
1257 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1258 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1260 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1261 int peer_finish_md_len;
1262 unsigned long message_size;
1264 /* used to hold the new cipher we are going to use */
1265 const SSL_CIPHER *new_cipher;
1266 # ifndef OPENSSL_NO_DH
1269 # ifndef OPENSSL_NO_EC
1270 EC_KEY *ecdh; /* holds short lived ECDH key */
1272 /* used when SSL_ST_FLUSH_DATA is entered */
1275 /* used for certificate requests */
1278 char ctype[SSL3_CT_NUMBER];
1279 STACK_OF(X509_NAME) *ca_names;
1281 int key_block_length;
1282 unsigned char *key_block;
1283 const EVP_CIPHER *new_sym_enc;
1284 const EVP_MD *new_hash;
1285 int new_mac_pkey_type;
1286 int new_mac_secret_size;
1287 # ifndef OPENSSL_NO_COMP
1288 const SSL_COMP *new_compression;
1290 char *new_compression;
1295 /* Connection binding to prevent renegotiation attacks */
1296 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1297 unsigned char previous_client_finished_len;
1298 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1299 unsigned char previous_server_finished_len;
1300 int send_connection_binding; /* TODOEKR */
1302 # ifndef OPENSSL_NO_NEXTPROTONEG
1304 * Set if we saw the Next Protocol Negotiation extension from our peer.
1306 int next_proto_neg_seen;
1309 # ifndef OPENSSL_NO_TLSEXT
1312 * ALPN information (we are in the process of transitioning from NPN to
1317 * In a server these point to the selected ALPN protocol after the
1318 * ClientHello has been processed. In a client these contain the protocol
1319 * that the server selected once the ServerHello has been processed.
1321 unsigned char *alpn_selected;
1322 unsigned alpn_selected_len;
1324 # ifndef OPENSSL_NO_EC
1326 * This is set to true if we believe that this is a version of Safari
1327 * running on OS X 10.6 or newer. We wish to know this because Safari on
1328 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1330 char is_probably_safari;
1331 # endif /* !OPENSSL_NO_EC */
1333 # endif /* !OPENSSL_NO_TLSEXT */
1337 /* DTLS structures */
1339 # ifndef OPENSSL_NO_SCTP
1340 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1343 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1344 # define DTLS1_MAX_MTU_OVERHEAD 48
1346 struct dtls1_retransmit_state {
1347 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1348 EVP_MD_CTX *write_hash; /* used for mac generation */
1349 COMP_CTX *compress; /* compression */
1350 SSL_SESSION *session;
1351 unsigned short epoch;
1354 struct hm_header_st {
1356 unsigned long msg_len;
1358 unsigned long frag_off;
1359 unsigned long frag_len;
1360 unsigned int is_ccs;
1361 struct dtls1_retransmit_state saved_retransmit_state;
1364 struct ccs_header_st {
1369 struct dtls1_timeout_st {
1370 /* Number of read timeouts so far */
1371 unsigned int read_timeouts;
1372 /* Number of write timeouts so far */
1373 unsigned int write_timeouts;
1374 /* Number of alerts received so far */
1375 unsigned int num_alerts;
1378 typedef struct hm_fragment_st {
1379 struct hm_header_st msg_header;
1380 unsigned char *fragment;
1381 unsigned char *reassembly;
1384 typedef struct dtls1_state_st {
1385 unsigned int send_cookie;
1386 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1387 unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
1388 unsigned int cookie_len;
1390 /* handshake message numbers */
1391 unsigned short handshake_write_seq;
1392 unsigned short next_handshake_write_seq;
1393 unsigned short handshake_read_seq;
1395 /* Buffered handshake messages */
1396 pqueue buffered_messages;
1397 /* Buffered (sent) handshake records */
1398 pqueue sent_messages;
1400 /* Is set when listening for new connections with dtls1_listen() */
1401 unsigned int listen;
1402 unsigned int link_mtu; /* max on-the-wire DTLS packet size */
1403 unsigned int mtu; /* max DTLS packet size */
1404 struct hm_header_st w_msg_hdr;
1405 struct hm_header_st r_msg_hdr;
1406 struct dtls1_timeout_st timeout;
1408 * Indicates when the last handshake msg or heartbeat sent will timeout
1410 struct timeval next_timeout;
1411 /* Timeout duration */
1412 unsigned short timeout_duration;
1414 unsigned int retransmitting;
1416 * Set when the handshake is ready to process peer's ChangeCipherSpec message.
1417 * Cleared after the message has been processed.
1419 unsigned int change_cipher_spec_ok;
1420 # ifndef OPENSSL_NO_SCTP
1421 /* used when SSL_ST_XX_FLUSH is entered */
1423 int shutdown_received;
1429 # ifndef OPENSSL_NO_EC
1431 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1433 # define EXPLICIT_PRIME_CURVE_TYPE 1
1434 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1435 # define NAMED_CURVE_TYPE 3
1436 # endif /* OPENSSL_NO_EC */
1438 typedef struct cert_pkey_st {
1440 EVP_PKEY *privatekey;
1441 /* Digest to use when signing */
1442 const EVP_MD *digest;
1443 /* Chain for this certificate */
1444 STACK_OF(X509) *chain;
1445 # ifndef OPENSSL_NO_TLSEXT
1447 * serverinfo data for this certificate. The data is in TLS Extension
1448 * wire format, specifically it's a series of records like:
1449 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1451 * uint8_t data[length];
1453 unsigned char *serverinfo;
1454 size_t serverinfo_length;
1457 * Set if CERT_PKEY can be used with current SSL session: e.g.
1458 * appropriate curve, signature algorithms etc. If zero it can't be used
1463 /* Retrieve Suite B flags */
1464 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1465 /* Uses to check strict mode: suite B modes are always strict */
1466 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1467 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1470 unsigned short ext_type;
1472 * Per-connection flags relating to this extension type: not used if
1473 * part of an SSL_CTX structure.
1475 unsigned short ext_flags;
1476 custom_ext_add_cb add_cb;
1477 custom_ext_free_cb free_cb;
1479 custom_ext_parse_cb parse_cb;
1481 } custom_ext_method;
1483 /* ext_flags values */
1486 * Indicates an extension has been received. Used to check for unsolicited or
1487 * duplicate extensions.
1489 # define SSL_EXT_FLAG_RECEIVED 0x1
1491 * Indicates an extension has been sent: used to enable sending of
1492 * corresponding ServerHello extension.
1494 # define SSL_EXT_FLAG_SENT 0x2
1497 custom_ext_method *meths;
1499 } custom_ext_methods;
1501 typedef struct cert_st {
1502 /* Current active set */
1504 * ALWAYS points to an element of the pkeys array
1505 * Probably it would make more sense to store
1506 * an index, not a pointer.
1510 * For servers the following masks are for the key and auth algorithms
1511 * that are supported by the certs below. For clients they are masks of
1512 * *disabled* algorithms based on the current session.
1515 unsigned long mask_k;
1516 unsigned long mask_a;
1517 unsigned long export_mask_k;
1518 unsigned long export_mask_a;
1520 unsigned long mask_ssl;
1521 # ifndef OPENSSL_NO_RSA
1523 RSA *(*rsa_tmp_cb) (SSL *ssl, int is_export, int keysize);
1525 # ifndef OPENSSL_NO_DH
1527 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1530 # ifndef OPENSSL_NO_EC
1532 /* Callback for generating ephemeral ECDH keys */
1533 EC_KEY *(*ecdh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1534 /* Select ECDH parameters automatically */
1537 /* Flags related to certificates */
1538 unsigned int cert_flags;
1539 CERT_PKEY pkeys[SSL_PKEY_NUM];
1541 * Certificate types (received or sent) in certificate request message.
1542 * On receive this is only set if number of certificate types exceeds
1545 unsigned char *ctypes;
1547 /* Temporary storage for premaster secret */
1551 * signature algorithms peer reports: e.g. supported signature algorithms
1552 * extension for server or as part of a certificate request for client.
1554 unsigned char *peer_sigalgs;
1555 /* Size of above array */
1556 size_t peer_sigalgslen;
1558 * suppported signature algorithms. When set on a client this is sent in
1559 * the client hello as the supported signature algorithms extension. For
1560 * servers it represents the signature algorithms we are willing to use.
1562 unsigned char *conf_sigalgs;
1563 /* Size of above array */
1564 size_t conf_sigalgslen;
1566 * Client authentication signature algorithms, if not set then uses
1567 * conf_sigalgs. On servers these will be the signature algorithms sent
1568 * to the client in a cerificate request for TLS 1.2. On a client this
1569 * represents the signature algortithms we are willing to use for client
1572 unsigned char *client_sigalgs;
1573 /* Size of above array */
1574 size_t client_sigalgslen;
1576 * Signature algorithms shared by client and server: cached because these
1577 * are used most often.
1579 TLS_SIGALGS *shared_sigalgs;
1580 size_t shared_sigalgslen;
1582 * Certificate setup callback: if set is called whenever a certificate
1583 * may be required (client or server). the callback can then examine any
1584 * appropriate parameters and setup any certificates required. This
1585 * allows advanced applications to select certificates on the fly: for
1586 * example based on supported signature algorithms or curves.
1588 int (*cert_cb) (SSL *ssl, void *arg);
1591 * Optional X509_STORE for chain building or certificate validation If
1592 * NULL the parent SSL_CTX store is used instead.
1594 X509_STORE *chain_store;
1595 X509_STORE *verify_store;
1596 /* Raw values of the cipher list from a client */
1597 unsigned char *ciphers_raw;
1598 size_t ciphers_rawlen;
1599 /* Custom extension methods for server and client */
1600 custom_ext_methods cli_ext;
1601 custom_ext_methods srv_ext;
1602 /* Security callback */
1603 int (*sec_cb) (SSL *s, SSL_CTX *ctx, int op, int bits, int nid,
1604 void *other, void *ex);
1605 /* Security level */
1608 int references; /* >1 only if SSL_copy_session_id is used */
1611 typedef struct sess_cert_st {
1612 STACK_OF(X509) *cert_chain; /* as received from peer */
1613 /* The 'peer_...' members are used only by clients. */
1615 CERT_PKEY *peer_key; /* points to an element of peer_pkeys (never
1617 CERT_PKEY peer_pkeys[SSL_PKEY_NUM];
1619 * Obviously we don't have the private keys of these, so maybe we
1620 * shouldn't even use the CERT_PKEY type here.
1622 # ifndef OPENSSL_NO_RSA
1623 RSA *peer_rsa_tmp; /* not used for SSL 2 */
1625 # ifndef OPENSSL_NO_DH
1626 DH *peer_dh_tmp; /* not used for SSL 2 */
1628 # ifndef OPENSSL_NO_EC
1629 EC_KEY *peer_ecdh_tmp;
1631 int references; /* actually always 1 at the moment */
1633 /* Structure containing decoded values of signature algorithms extension */
1634 struct tls_sigalgs_st {
1635 /* NID of hash algorithm */
1637 /* NID of signature algorithm */
1639 /* Combined hash and signature NID */
1640 int signandhash_nid;
1641 /* Raw values used in extension */
1642 unsigned char rsign;
1643 unsigned char rhash;
1654 * #define ABORT_DEBUG
1657 * #define PKT_DEBUG 1
1663 * #define DES_OFB_DEBUG
1672 * #define IDEA_DEBUG
1675 # define FP_ICC (int (*)(const void *,const void *))
1676 # define ssl_put_cipher_by_char(ssl,ciph,ptr) \
1677 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
1680 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1681 * of a mess of functions, but hell, think of it as an opaque structure :-)
1683 typedef struct ssl3_enc_method {
1684 int (*enc) (SSL *, int);
1685 int (*mac) (SSL *, unsigned char *, int);
1686 int (*setup_key_block) (SSL *);
1687 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1689 int (*change_cipher_state) (SSL *, int);
1690 int (*final_finish_mac) (SSL *, const char *, int, unsigned char *);
1691 int finish_mac_length;
1692 int (*cert_verify_mac) (SSL *, int, unsigned char *);
1693 const char *client_finished_label;
1694 int client_finished_label_len;
1695 const char *server_finished_label;
1696 int server_finished_label_len;
1697 int (*alert_value) (int);
1698 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1699 const char *, size_t,
1700 const unsigned char *, size_t,
1702 /* Various flags indicating protocol version requirements */
1703 unsigned int enc_flags;
1704 /* Handshake header length */
1706 /* Set the handshake header */
1707 int (*set_handshake_header) (SSL *s, int type, unsigned long len);
1708 /* Write out handshake message */
1709 int (*do_write) (SSL *s);
1712 # define SSL_HM_HEADER_LENGTH(s) s->method->ssl3_enc->hhlen
1713 # define ssl_handshake_start(s) \
1714 (((unsigned char *)s->init_buf->data) + s->method->ssl3_enc->hhlen)
1715 # define ssl_set_handshake_header(s, htype, len) \
1716 s->method->ssl3_enc->set_handshake_header(s, htype, len)
1717 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1719 /* Values for enc_flags */
1721 /* Uses explicit IV for CBC mode */
1722 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1723 /* Uses signature algorithms extension */
1724 # define SSL_ENC_FLAG_SIGALGS 0x2
1725 /* Uses SHA256 default PRF */
1726 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1728 # define SSL_ENC_FLAG_DTLS 0x8
1730 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1731 * apply to others in future.
1733 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1735 # ifndef OPENSSL_NO_COMP
1736 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1737 typedef struct ssl3_comp_st {
1738 int comp_id; /* The identifier byte for this compression
1740 char *name; /* Text name used for the compression type */
1741 COMP_METHOD *method; /* The method :-) */
1745 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1746 OPENSSL_EXTERN const SSL_CIPHER ssl3_ciphers[];
1748 SSL_METHOD *ssl_bad_method(int ver);
1750 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1751 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1752 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1753 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1754 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1755 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1757 # define IMPLEMENT_tls_meth_func(version, func_name, s_accept, s_connect, \
1758 s_get_meth, enc_data) \
1759 const SSL_METHOD *func_name(void) \
1761 static const SSL_METHOD func_name##_data= { \
1773 ssl3_renegotiate_check, \
1777 ssl3_dispatch_alert, \
1780 ssl3_get_cipher_by_char, \
1781 ssl3_put_cipher_by_char, \
1786 tls1_default_timeout, \
1788 ssl_undefined_void_function, \
1789 ssl3_callback_ctrl, \
1790 ssl3_ctx_callback_ctrl, \
1792 return &func_name##_data; \
1795 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect, s_get_meth) \
1796 const SSL_METHOD *func_name(void) \
1798 static const SSL_METHOD func_name##_data= { \
1810 ssl3_renegotiate_check, \
1814 ssl3_dispatch_alert, \
1817 ssl3_get_cipher_by_char, \
1818 ssl3_put_cipher_by_char, \
1823 ssl3_default_timeout, \
1825 ssl_undefined_void_function, \
1826 ssl3_callback_ctrl, \
1827 ssl3_ctx_callback_ctrl, \
1829 return &func_name##_data; \
1832 # define IMPLEMENT_ssl23_meth_func(func_name, s_accept, s_connect, s_get_meth) \
1833 const SSL_METHOD *func_name(void) \
1835 static const SSL_METHOD func_name##_data= { \
1845 ssl_undefined_function, \
1846 ssl_undefined_function, \
1851 ssl3_dispatch_alert, \
1854 ssl23_get_cipher_by_char, \
1855 ssl23_put_cipher_by_char, \
1856 ssl_undefined_const_function, \
1857 ssl23_num_ciphers, \
1860 ssl23_default_timeout, \
1861 &TLSv1_2_enc_data, \
1862 ssl_undefined_void_function, \
1863 ssl3_callback_ctrl, \
1864 ssl3_ctx_callback_ctrl, \
1866 return &func_name##_data; \
1869 # define IMPLEMENT_dtls1_meth_func(version, func_name, s_accept, s_connect, \
1870 s_get_meth, enc_data) \
1871 const SSL_METHOD *func_name(void) \
1873 static const SSL_METHOD func_name##_data= { \
1885 ssl3_renegotiate_check, \
1886 dtls1_get_message, \
1888 dtls1_write_app_data_bytes, \
1889 dtls1_dispatch_alert, \
1892 ssl3_get_cipher_by_char, \
1893 ssl3_put_cipher_by_char, \
1898 dtls1_default_timeout, \
1900 ssl_undefined_void_function, \
1901 ssl3_callback_ctrl, \
1902 ssl3_ctx_callback_ctrl, \
1904 return &func_name##_data; \
1907 struct openssl_ssl_test_functions {
1908 int (*p_ssl_init_wbio_buffer) (SSL *s, int push);
1909 int (*p_ssl3_setup_buffers) (SSL *s);
1910 int (*p_tls1_process_heartbeat) (SSL *s,
1911 unsigned char *p, unsigned int length);
1912 int (*p_dtls1_process_heartbeat) (SSL *s,
1913 unsigned char *p, unsigned int length);
1916 # ifndef OPENSSL_UNIT_TEST
1918 void ssl_clear_cipher_ctx(SSL *s);
1919 int ssl_clear_bad_session(SSL *s);
1920 __owur CERT *ssl_cert_new(void);
1921 __owur CERT *ssl_cert_dup(CERT *cert);
1922 void ssl_cert_set_default_md(CERT *cert);
1923 void ssl_cert_clear_certs(CERT *c);
1924 void ssl_cert_free(CERT *c);
1925 __owur SESS_CERT *ssl_sess_cert_new(void);
1926 void ssl_sess_cert_free(SESS_CERT *sc);
1927 __owur int ssl_set_peer_cert_type(SESS_CERT *c, int type);
1928 __owur int ssl_get_new_session(SSL *s, int session);
1929 __owur int ssl_get_prev_session(SSL *s, unsigned char *session, int len,
1930 const unsigned char *limit);
1931 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1932 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
1933 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1934 const SSL_CIPHER *const *bp);
1935 __owur STACK_OF(SSL_CIPHER) *ssl_bytes_to_cipher_list(SSL *s, unsigned char *p,
1937 STACK_OF(SSL_CIPHER) **skp);
1938 __owur int ssl_cipher_list_to_bytes(SSL *s, STACK_OF(SSL_CIPHER) *sk,
1940 int (*put_cb) (const SSL_CIPHER *,
1942 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
1943 STACK_OF(SSL_CIPHER) **pref,
1944 STACK_OF(SSL_CIPHER) **sorted,
1945 const char *rule_str, CERT *c);
1946 void ssl_update_cache(SSL *s, int mode);
1947 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
1948 const EVP_MD **md, int *mac_pkey_type,
1949 int *mac_secret_size, SSL_COMP **comp, int use_etm);
1950 __owur int ssl_get_handshake_digest(int i, long *mask, const EVP_MD **md);
1951 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
1952 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr);
1953 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
1954 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
1955 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
1956 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
1957 __owur int ssl_cert_select_current(CERT *c, X509 *x);
1958 __owur int ssl_cert_set_current(CERT *c, long arg);
1959 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
1960 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg),
1963 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
1964 __owur int ssl_add_cert_chain(SSL *s, CERT_PKEY *cpk, unsigned long *l);
1965 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
1966 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain, int ref);
1968 __owur int ssl_security(SSL *s, int op, int bits, int nid, void *other);
1969 __owur int ssl_ctx_security(SSL_CTX *ctx, int op, int bits, int nid, void *other);
1971 int ssl_undefined_function(SSL *s);
1972 __owur int ssl_undefined_void_function(void);
1973 __owur int ssl_undefined_const_function(const SSL *s);
1974 __owur CERT_PKEY *ssl_get_server_send_pkey(const SSL *s);
1975 # ifndef OPENSSL_NO_TLSEXT
1976 __owur int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
1977 size_t *serverinfo_length);
1979 __owur EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *c, const EVP_MD **pmd);
1980 __owur int ssl_cert_type(X509 *x, EVP_PKEY *pkey);
1981 void ssl_set_cert_masks(CERT *c, const SSL_CIPHER *cipher);
1982 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
1983 __owur int ssl_verify_alarm_type(long type);
1984 void ssl_load_ciphers(void);
1985 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field, int len);
1987 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
1988 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
1989 void ssl3_init_finished_mac(SSL *s);
1990 __owur int ssl3_send_server_certificate(SSL *s);
1991 __owur int ssl3_send_newsession_ticket(SSL *s);
1992 __owur int ssl3_send_cert_status(SSL *s);
1993 __owur int ssl3_get_finished(SSL *s, int state_a, int state_b);
1994 __owur int ssl3_setup_key_block(SSL *s);
1995 __owur int ssl3_send_change_cipher_spec(SSL *s, int state_a, int state_b);
1996 __owur int ssl3_change_cipher_state(SSL *s, int which);
1997 void ssl3_cleanup_key_block(SSL *s);
1998 __owur int ssl3_do_write(SSL *s, int type);
1999 int ssl3_send_alert(SSL *s, int level, int desc);
2000 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2001 unsigned char *p, int len);
2002 __owur int ssl3_get_req_cert_type(SSL *s, unsigned char *p);
2003 __owur long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
2004 __owur int ssl3_send_finished(SSL *s, int a, int b, const char *sender, int slen);
2005 __owur int ssl3_num_ciphers(void);
2006 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2007 int ssl3_renegotiate(SSL *ssl);
2008 int ssl3_renegotiate_check(SSL *ssl);
2009 __owur int ssl3_dispatch_alert(SSL *s);
2010 __owur int ssl3_final_finish_mac(SSL *s, const char *sender, int slen,
2012 __owur int ssl3_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
2013 void ssl3_finish_mac(SSL *s, const unsigned char *buf, int len);
2014 void ssl3_free_digest_list(SSL *s);
2015 __owur unsigned long ssl3_output_cert_chain(SSL *s, CERT_PKEY *cpk);
2016 __owur SSL_CIPHER *ssl3_choose_cipher(SSL *ssl, STACK_OF(SSL_CIPHER) *clnt,
2017 STACK_OF(SSL_CIPHER) *srvr);
2018 __owur int ssl3_digest_cached_records(SSL *s);
2019 __owur int ssl3_new(SSL *s);
2020 void ssl3_free(SSL *s);
2021 __owur int ssl3_accept(SSL *s);
2022 __owur int ssl3_connect(SSL *s);
2023 __owur int ssl3_read(SSL *s, void *buf, int len);
2024 __owur int ssl3_peek(SSL *s, void *buf, int len);
2025 __owur int ssl3_write(SSL *s, const void *buf, int len);
2026 __owur int ssl3_shutdown(SSL *s);
2027 void ssl3_clear(SSL *s);
2028 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2029 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2030 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2031 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2033 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2034 __owur long ssl3_default_timeout(void);
2036 __owur int ssl3_set_handshake_header(SSL *s, int htype, unsigned long len);
2037 __owur int ssl3_handshake_write(SSL *s);
2039 __owur int ssl23_num_ciphers(void);
2040 __owur const SSL_CIPHER *ssl23_get_cipher(unsigned int u);
2041 __owur int ssl23_read(SSL *s, void *buf, int len);
2042 __owur int ssl23_peek(SSL *s, void *buf, int len);
2043 __owur int ssl23_write(SSL *s, const void *buf, int len);
2044 __owur int ssl23_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
2045 __owur const SSL_CIPHER *ssl23_get_cipher_by_char(const unsigned char *p);
2046 __owur long ssl23_default_timeout(void);
2048 __owur int ssl_allow_compression(SSL *s);
2050 __owur long tls1_default_timeout(void);
2051 __owur int dtls1_do_write(SSL *s, int type);
2052 void dtls1_set_message_header(SSL *s,
2053 unsigned char *p, unsigned char mt,
2055 unsigned long frag_off,
2056 unsigned long frag_len);
2058 __owur int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf, int len);
2060 __owur int dtls1_send_change_cipher_spec(SSL *s, int a, int b);
2061 __owur int dtls1_read_failed(SSL *s, int code);
2062 __owur int dtls1_buffer_message(SSL *s, int ccs);
2063 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq,
2064 unsigned long frag_off, int *found);
2065 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2066 int dtls1_retransmit_buffered_messages(SSL *s);
2067 void dtls1_clear_record_buffer(SSL *s);
2068 void dtls1_get_message_header(unsigned char *data,
2069 struct hm_header_st *msg_hdr);
2070 void dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr);
2071 __owur long dtls1_default_timeout(void);
2072 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2073 __owur int dtls1_check_timeout_num(SSL *s);
2074 __owur int dtls1_handle_timeout(SSL *s);
2075 __owur const SSL_CIPHER *dtls1_get_cipher(unsigned int u);
2076 void dtls1_start_timer(SSL *s);
2077 void dtls1_stop_timer(SSL *s);
2078 __owur int dtls1_is_timer_expired(SSL *s);
2079 void dtls1_double_timeout(SSL *s);
2080 __owur int dtls1_send_newsession_ticket(SSL *s);
2081 __owur unsigned int dtls1_min_mtu(SSL *s);
2082 __owur unsigned int dtls1_link_min_mtu(void);
2083 void dtls1_hm_fragment_free(hm_fragment *frag);
2085 /* some client-only functions */
2086 __owur int ssl3_client_hello(SSL *s);
2087 __owur int ssl3_get_server_hello(SSL *s);
2088 __owur int ssl3_get_certificate_request(SSL *s);
2089 __owur int ssl3_get_new_session_ticket(SSL *s);
2090 __owur int ssl3_get_cert_status(SSL *s);
2091 __owur int ssl3_get_server_done(SSL *s);
2092 __owur int ssl3_send_client_verify(SSL *s);
2093 __owur int ssl3_send_client_certificate(SSL *s);
2094 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
2095 __owur int ssl3_send_client_key_exchange(SSL *s);
2096 __owur int ssl3_get_key_exchange(SSL *s);
2097 __owur int ssl3_get_server_certificate(SSL *s);
2098 __owur int ssl3_check_cert_and_algorithm(SSL *s);
2099 # ifndef OPENSSL_NO_TLSEXT
2100 # ifndef OPENSSL_NO_NEXTPROTONEG
2101 __owur int ssl3_send_next_proto(SSL *s);
2105 int dtls1_client_hello(SSL *s);
2107 /* some server-only functions */
2108 __owur int ssl3_get_client_hello(SSL *s);
2109 __owur int ssl3_send_server_hello(SSL *s);
2110 __owur int ssl3_send_hello_request(SSL *s);
2111 __owur int ssl3_send_server_key_exchange(SSL *s);
2112 __owur int ssl3_send_certificate_request(SSL *s);
2113 __owur int ssl3_send_server_done(SSL *s);
2114 __owur int ssl3_get_client_certificate(SSL *s);
2115 __owur int ssl3_get_client_key_exchange(SSL *s);
2116 __owur int ssl3_get_cert_verify(SSL *s);
2117 # ifndef OPENSSL_NO_NEXTPROTONEG
2118 __owur int ssl3_get_next_proto(SSL *s);
2121 __owur int ssl23_accept(SSL *s);
2122 __owur int ssl23_connect(SSL *s);
2124 __owur int tls1_new(SSL *s);
2125 void tls1_free(SSL *s);
2126 void tls1_clear(SSL *s);
2127 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2128 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2130 __owur int dtls1_new(SSL *s);
2131 __owur int dtls1_accept(SSL *s);
2132 __owur int dtls1_connect(SSL *s);
2133 void dtls1_free(SSL *s);
2134 void dtls1_clear(SSL *s);
2135 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2136 __owur int dtls1_shutdown(SSL *s);
2138 __owur long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
2139 __owur int dtls1_dispatch_alert(SSL *s);
2141 __owur int ssl_init_wbio_buffer(SSL *s, int push);
2142 void ssl_free_wbio_buffer(SSL *s);
2144 __owur int tls1_change_cipher_state(SSL *s, int which);
2145 __owur int tls1_setup_key_block(SSL *s);
2146 __owur int tls1_final_finish_mac(SSL *s,
2147 const char *str, int slen, unsigned char *p);
2148 __owur int tls1_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
2149 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2150 unsigned char *p, int len);
2151 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2152 const char *label, size_t llen,
2153 const unsigned char *p, size_t plen,
2155 __owur int tls1_alert_code(int code);
2156 __owur int ssl3_alert_code(int code);
2157 __owur int ssl_ok(SSL *s);
2159 # ifndef OPENSSL_NO_EC
2160 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2163 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2165 # ifndef OPENSSL_NO_EC
2166 __owur int tls1_ec_curve_id2nid(int curve_id);
2167 __owur int tls1_ec_nid2curve_id(int nid);
2168 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2169 __owur int tls1_shared_curve(SSL *s, int nmatch);
2170 __owur int tls1_set_curves(unsigned char **pext, size_t *pextlen,
2171 int *curves, size_t ncurves);
2172 __owur int tls1_set_curves_list(unsigned char **pext, size_t *pextlen,
2174 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2175 # endif /* OPENSSL_NO_EC */
2177 # ifndef OPENSSL_NO_TLSEXT
2178 __owur int tls1_shared_list(SSL *s,
2179 const unsigned char *l1, size_t l1len,
2180 const unsigned char *l2, size_t l2len, int nmatch);
2181 __owur unsigned char *ssl_add_clienthello_tlsext(SSL *s, unsigned char *buf,
2182 unsigned char *limit, int *al);
2183 __owur unsigned char *ssl_add_serverhello_tlsext(SSL *s, unsigned char *buf,
2184 unsigned char *limit, int *al);
2185 __owur int ssl_parse_clienthello_tlsext(SSL *s, unsigned char **data,
2186 unsigned char *d, int n);
2187 __owur int tls1_set_server_sigalgs(SSL *s);
2188 __owur int ssl_check_clienthello_tlsext_late(SSL *s);
2189 __owur int ssl_parse_serverhello_tlsext(SSL *s, unsigned char **data,
2190 unsigned char *d, int n);
2191 __owur int ssl_prepare_clienthello_tlsext(SSL *s);
2192 __owur int ssl_prepare_serverhello_tlsext(SSL *s);
2194 # ifndef OPENSSL_NO_HEARTBEATS
2195 __owur int tls1_heartbeat(SSL *s);
2196 __owur int dtls1_heartbeat(SSL *s);
2197 __owur int tls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length);
2198 __owur int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length);
2201 __owur int tls1_process_ticket(SSL *s, unsigned char *session_id, int len,
2202 const unsigned char *limit, SSL_SESSION **ret);
2204 __owur int tls12_get_sigandhash(unsigned char *p, const EVP_PKEY *pk,
2206 __owur int tls12_get_sigid(const EVP_PKEY *pk);
2207 __owur const EVP_MD *tls12_get_hash(unsigned char hash_alg);
2208 void ssl_set_sig_mask(unsigned long *pmask_a, SSL *s, int op);
2210 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2211 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen, int client);
2212 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2214 void tls1_set_cert_validity(SSL *s);
2217 # ifndef OPENSSL_NO_DH
2218 __owur DH *ssl_get_auto_dh(SSL *s);
2221 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2222 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex, int vfy);
2224 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2225 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2226 __owur int ssl_add_serverhello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
2228 __owur int ssl_parse_serverhello_renegotiate_ext(SSL *s, unsigned char *d, int len,
2230 __owur int ssl_add_clienthello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
2232 __owur int ssl_parse_clienthello_renegotiate_ext(SSL *s, unsigned char *d, int len,
2234 __owur long ssl_get_algorithm2(SSL *s);
2235 __owur size_t tls12_copy_sigalgs(SSL *s, unsigned char *out,
2236 const unsigned char *psig, size_t psiglen);
2237 __owur int tls1_save_sigalgs(SSL *s, const unsigned char *data, int dsize);
2238 __owur int tls1_process_sigalgs(SSL *s);
2239 __owur size_t tls12_get_psigalgs(SSL *s, const unsigned char **psigs);
2240 __owur int tls12_check_peer_sigalg(const EVP_MD **pmd, SSL *s,
2241 const unsigned char *sig, EVP_PKEY *pkey);
2242 void ssl_set_client_disabled(SSL *s);
2243 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2245 __owur int ssl_add_clienthello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
2247 __owur int ssl_parse_clienthello_use_srtp_ext(SSL *s, unsigned char *d, int len,
2249 __owur int ssl_add_serverhello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
2251 __owur int ssl_parse_serverhello_use_srtp_ext(SSL *s, unsigned char *d, int len,
2254 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen);
2257 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2258 void ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2259 unsigned char *md_out,
2260 size_t *md_out_size,
2261 const unsigned char header[13],
2262 const unsigned char *data,
2263 size_t data_plus_mac_size,
2264 size_t data_plus_mac_plus_padding_size,
2265 const unsigned char *mac_secret,
2266 unsigned mac_secret_length, char is_sslv3);
2268 void tls_fips_digest_extra(const EVP_CIPHER_CTX *cipher_ctx,
2269 EVP_MD_CTX *mac_ctx, const unsigned char *data,
2270 size_t data_len, size_t orig_len);
2272 __owur int srp_verify_server_param(SSL *s, int *al);
2276 void custom_ext_init(custom_ext_methods *meths);
2278 __owur int custom_ext_parse(SSL *s, int server,
2279 unsigned int ext_type,
2280 const unsigned char *ext_data, size_t ext_size, int *al);
2281 __owur int custom_ext_add(SSL *s, int server,
2282 unsigned char **pret, unsigned char *limit, int *al);
2284 __owur int custom_exts_copy(custom_ext_methods *dst, const custom_ext_methods *src);
2285 void custom_exts_free(custom_ext_methods *exts);
2289 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2290 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2291 # define tls1_process_heartbeat SSL_test_functions()->p_tls1_process_heartbeat
2292 # define dtls1_process_heartbeat SSL_test_functions()->p_dtls1_process_heartbeat