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;
712 # ifndef OPENSSL_NO_COMP
719 DECLARE_STACK_OF(SSL_COMP)
720 DECLARE_LHASH_OF(SSL_SESSION);
723 const SSL_METHOD *method;
724 STACK_OF(SSL_CIPHER) *cipher_list;
725 /* same as above but sorted for lookup */
726 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
727 struct x509_store_st /* X509_STORE */ *cert_store;
728 LHASH_OF(SSL_SESSION) *sessions;
730 * Most session-ids that will be cached, default is
731 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
733 unsigned long session_cache_size;
734 struct ssl_session_st *session_cache_head;
735 struct ssl_session_st *session_cache_tail;
737 * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
738 * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
739 * means only SSL_accept which cache SSL_SESSIONS.
741 int session_cache_mode;
743 * If timeout is not 0, it is the default timeout value set when
744 * SSL_new() is called. This has been put in to make life easier to set
747 long session_timeout;
749 * If this callback is not null, it will be called each time a session id
750 * is added to the cache. If this function returns 1, it means that the
751 * callback will do a SSL_SESSION_free() when it has finished using it.
752 * Otherwise, on 0, it means the callback has finished with it. If
753 * remove_session_cb is not null, it will be called when a session-id is
754 * removed from the cache. After the call, OpenSSL will
755 * SSL_SESSION_free() it.
757 int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
758 void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
759 SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
760 unsigned char *data, int len, int *copy);
762 int sess_connect; /* SSL new conn - started */
763 int sess_connect_renegotiate; /* SSL reneg - requested */
764 int sess_connect_good; /* SSL new conne/reneg - finished */
765 int sess_accept; /* SSL new accept - started */
766 int sess_accept_renegotiate; /* SSL reneg - requested */
767 int sess_accept_good; /* SSL accept/reneg - finished */
768 int sess_miss; /* session lookup misses */
769 int sess_timeout; /* reuse attempt on timeouted session */
770 int sess_cache_full; /* session removed due to full cache */
771 int sess_hit; /* session reuse actually done */
772 int sess_cb_hit; /* session-id that was not in the cache was
773 * passed back via the callback. This
774 * indicates that the application is
775 * supplying session-id's from other
776 * processes - spooky :-) */
781 /* if defined, these override the X509_verify_cert() calls */
782 int (*app_verify_callback) (X509_STORE_CTX *, void *);
783 void *app_verify_arg;
785 * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
786 * ('app_verify_callback' was called with just one argument)
789 /* Default password callback. */
790 pem_password_cb *default_passwd_callback;
792 /* Default password callback user data. */
793 void *default_passwd_callback_userdata;
795 /* get client cert callback */
796 int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
798 /* cookie generate callback */
799 int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
800 unsigned int *cookie_len);
802 /* verify cookie callback */
803 int (*app_verify_cookie_cb) (SSL *ssl, unsigned char *cookie,
804 unsigned int cookie_len);
806 CRYPTO_EX_DATA ex_data;
808 const EVP_MD *md5; /* For SSLv3/TLSv1 'ssl3-md5' */
809 const EVP_MD *sha1; /* For SSLv3/TLSv1 'ssl3->sha1' */
811 STACK_OF(X509) *extra_certs;
812 STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
814 /* Default values used when no per-SSL value is defined follow */
816 /* used if SSL's info_callback is NULL */
817 void (*info_callback) (const SSL *ssl, int type, int val);
819 /* what we put in client cert requests */
820 STACK_OF(X509_NAME) *client_CA;
823 * Default values to use in SSL structures follow (these are copied by
827 unsigned long options;
831 struct cert_st /* CERT */ *cert;
834 /* callback that allows applications to peek at protocol messages */
835 void (*msg_callback) (int write_p, int version, int content_type,
836 const void *buf, size_t len, SSL *ssl, void *arg);
837 void *msg_callback_arg;
840 unsigned int sid_ctx_length;
841 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
842 /* called 'verify_callback' in the SSL */
843 int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
845 /* Default generate session ID callback. */
846 GEN_SESSION_CB generate_session_id;
848 X509_VERIFY_PARAM *param;
853 * Maximum amount of data to send in one fragment. actual record size can
854 * be more than this due to padding and MAC overheads.
856 unsigned int max_send_fragment;
858 # ifndef OPENSSL_NO_ENGINE
860 * Engine to pass requests for client certs to
862 ENGINE *client_cert_engine;
865 # ifndef OPENSSL_NO_TLSEXT
866 /* TLS extensions servername callback */
867 int (*tlsext_servername_callback) (SSL *, int *, void *);
868 void *tlsext_servername_arg;
869 /* RFC 4507 session ticket keys */
870 unsigned char tlsext_tick_key_name[16];
871 unsigned char tlsext_tick_hmac_key[16];
872 unsigned char tlsext_tick_aes_key[16];
873 /* Callback to support customisation of ticket key setting */
874 int (*tlsext_ticket_key_cb) (SSL *ssl,
875 unsigned char *name, unsigned char *iv,
876 EVP_CIPHER_CTX *ectx,
877 HMAC_CTX *hctx, int enc);
879 /* certificate status request info */
880 /* Callback for status request */
881 int (*tlsext_status_cb) (SSL *ssl, void *arg);
882 void *tlsext_status_arg;
885 # ifndef OPENSSL_NO_PSK
886 char *psk_identity_hint;
887 unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
889 unsigned int max_identity_len,
891 unsigned int max_psk_len);
892 unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
894 unsigned int max_psk_len);
897 # ifndef OPENSSL_NO_SRP
898 SRP_CTX srp_ctx; /* ctx for SRP authentication */
901 # ifndef OPENSSL_NO_TLSEXT
903 # ifndef OPENSSL_NO_NEXTPROTONEG
904 /* Next protocol negotiation information */
905 /* (for experimental NPN extension). */
908 * For a server, this contains a callback function by which the set of
909 * advertised protocols can be provided.
911 int (*next_protos_advertised_cb) (SSL *s, const unsigned char **buf,
912 unsigned int *len, void *arg);
913 void *next_protos_advertised_cb_arg;
915 * For a client, this contains a callback function that selects the next
916 * protocol from the list provided by the server.
918 int (*next_proto_select_cb) (SSL *s, unsigned char **out,
919 unsigned char *outlen,
920 const unsigned char *in,
921 unsigned int inlen, void *arg);
922 void *next_proto_select_cb_arg;
926 * ALPN information (we are in the process of transitioning from NPN to
931 * For a server, this contains a callback function that allows the
932 * server to select the protocol for the connection.
933 * out: on successful return, this must point to the raw protocol
934 * name (without the length prefix).
935 * outlen: on successful return, this contains the length of |*out|.
936 * in: points to the client's list of supported protocols in
938 * inlen: the length of |in|.
940 int (*alpn_select_cb) (SSL *s,
941 const unsigned char **out,
942 unsigned char *outlen,
943 const unsigned char *in,
944 unsigned int inlen, void *arg);
945 void *alpn_select_cb_arg;
948 * For a client, this contains the list of supported protocols in wire
951 unsigned char *alpn_client_proto_list;
952 unsigned alpn_client_proto_list_len;
954 /* SRTP profiles we are willing to do from RFC 5764 */
955 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
958 * Callback for disabling session caching and ticket support on a session
959 * basis, depending on the chosen cipher.
961 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
962 # ifndef OPENSSL_NO_EC
963 /* EC extension values inherited by SSL structure */
964 size_t tlsext_ecpointformatlist_length;
965 unsigned char *tlsext_ecpointformatlist;
966 size_t tlsext_ellipticcurvelist_length;
967 unsigned char *tlsext_ellipticcurvelist;
968 # endif /* OPENSSL_NO_EC */
974 * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
978 /* SSL_ST_CONNECT or SSL_ST_ACCEPT */
981 const SSL_METHOD *method;
983 * There are 2 BIO's even though they are normally both the same. This
984 * is so data can be read and written to different handlers
986 /* used by SSL_read */
988 /* used by SSL_write */
990 /* used during session-id reuse to concatenate messages */
993 * This holds a variable that indicates what we were doing when a 0 or -1
994 * is returned. This is needed for non-blocking IO so we know what
995 * request needs re-doing when in SSL_accept or SSL_connect
998 /* true when we are actually in SSL_accept() or SSL_connect() */
1000 int (*handshake_func) (SSL *);
1002 * Imagine that here's a boolean member "init" that is switched as soon
1003 * as SSL_set_{accept/connect}_state is called for the first time, so
1004 * that "state" and "handshake_func" are properly initialized. But as
1005 * handshake_func is == 0 until then, we use this test instead of an
1008 /* are we the server side? - mostly used by SSL_clear */
1011 * Generate a new session or reuse an old one.
1012 * NB: For servers, the 'new' session may actually be a previously
1013 * cached session or even the previous session unless
1014 * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1017 /* don't send shutdown packets */
1019 /* we have shut things down, 0x01 sent, 0x02 for received */
1023 BUF_MEM *init_buf; /* buffer used during init */
1024 void *init_msg; /* pointer to handshake message body, set by
1025 * ssl3_get_message() */
1026 int init_num; /* amount read/written */
1027 int init_off; /* amount read/written */
1029 struct ssl3_state_st *s3; /* SSLv3 variables */
1030 struct dtls1_state_st *d1; /* DTLSv1 variables */
1032 /* callback that allows applications to peek at protocol messages */
1033 void (*msg_callback) (int write_p, int version, int content_type,
1034 const void *buf, size_t len, SSL *ssl, void *arg);
1035 void *msg_callback_arg;
1036 int hit; /* reusing a previous session */
1037 X509_VERIFY_PARAM *param;
1039 STACK_OF(SSL_CIPHER) *cipher_list;
1040 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1042 * These are the ones being used, the ones in SSL_SESSION are the ones to
1043 * be 'copied' into these ones
1046 EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1047 EVP_MD_CTX *read_hash; /* used for mac generation */
1048 # ifndef OPENSSL_NO_COMP
1049 COMP_CTX *expand; /* uncompress */
1053 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1054 EVP_MD_CTX *write_hash; /* used for mac generation */
1055 # ifndef OPENSSL_NO_COMP
1056 COMP_CTX *compress; /* compression */
1062 /* This is used to hold the server certificate used */
1063 struct cert_st /* CERT */ *cert;
1065 * the session_id_context is used to ensure sessions are only reused in
1066 * the appropriate context
1068 unsigned int sid_ctx_length;
1069 unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1070 /* This can also be in the session once a session is established */
1071 SSL_SESSION *session;
1072 /* Default generate session ID callback. */
1073 GEN_SESSION_CB generate_session_id;
1076 * 0 don't care about verify failure.
1077 * 1 fail if verify fails
1080 /* fail if callback returns 0 */
1081 int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1082 /* optional informational callback */
1083 void (*info_callback) (const SSL *ssl, int type, int val);
1084 /* error bytes to be written */
1088 # ifndef OPENSSL_NO_KRB5
1089 /* Kerberos 5 context */
1091 # endif /* OPENSSL_NO_KRB5 */
1092 # ifndef OPENSSL_NO_PSK
1093 unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
1095 unsigned int max_identity_len,
1097 unsigned int max_psk_len);
1098 unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
1100 unsigned int max_psk_len);
1104 * set this flag to 1 and a sleep(1) is put into all SSL_read() and
1105 * SSL_write() calls, good for nbio debuging :-)
1108 /* extra application data */
1110 CRYPTO_EX_DATA ex_data;
1111 /* for server side, keep the list of CA_dn we can use */
1112 STACK_OF(X509_NAME) *client_CA;
1114 /* protocol behaviour */
1115 unsigned long options;
1120 /* what was passed, used for SSLv3/TLS rollback check */
1122 unsigned int max_send_fragment;
1123 # ifndef OPENSSL_NO_TLSEXT
1124 /* TLS extension debug callback */
1125 void (*tlsext_debug_cb) (SSL *s, int client_server, int type,
1126 unsigned char *data, int len, void *arg);
1127 void *tlsext_debug_arg;
1128 char *tlsext_hostname;
1130 * no further mod of servername
1131 * 0 : call the servername extension callback.
1132 * 1 : prepare 2, allow last ack just after in server callback.
1133 * 2 : don't call servername callback, no ack in server hello
1135 int servername_done;
1136 /* certificate status request info */
1137 /* Status type or -1 if no status type */
1138 int tlsext_status_type;
1139 /* Expect OCSP CertificateStatus message */
1140 int tlsext_status_expected;
1141 /* OCSP status request only */
1142 STACK_OF(OCSP_RESPID) *tlsext_ocsp_ids;
1143 X509_EXTENSIONS *tlsext_ocsp_exts;
1144 /* OCSP response received or to be sent */
1145 unsigned char *tlsext_ocsp_resp;
1146 int tlsext_ocsp_resplen;
1147 /* RFC4507 session ticket expected to be received or sent */
1148 int tlsext_ticket_expected;
1149 # ifndef OPENSSL_NO_EC
1150 size_t tlsext_ecpointformatlist_length;
1152 unsigned char *tlsext_ecpointformatlist;
1153 size_t tlsext_ellipticcurvelist_length;
1155 unsigned char *tlsext_ellipticcurvelist;
1156 # endif /* OPENSSL_NO_EC */
1157 /* TLS Session Ticket extension override */
1158 TLS_SESSION_TICKET_EXT *tlsext_session_ticket;
1159 /* TLS Session Ticket extension callback */
1160 tls_session_ticket_ext_cb_fn tls_session_ticket_ext_cb;
1161 void *tls_session_ticket_ext_cb_arg;
1162 /* TLS pre-shared secret session resumption */
1163 tls_session_secret_cb_fn tls_session_secret_cb;
1164 void *tls_session_secret_cb_arg;
1165 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
1166 # ifndef OPENSSL_NO_NEXTPROTONEG
1168 * Next protocol negotiation. For the client, this is the protocol that
1169 * we sent in NextProtocol and is set when handling ServerHello
1170 * extensions. For a server, this is the client's selected_protocol from
1171 * NextProtocol and is set when handling the NextProtocol message, before
1172 * the Finished message.
1174 unsigned char *next_proto_negotiated;
1175 unsigned char next_proto_negotiated_len;
1177 # define session_ctx initial_ctx
1179 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1180 /* What's been chosen */
1181 SRTP_PROTECTION_PROFILE *srtp_profile;
1183 * Is use of the Heartbeat extension negotiated?
1186 * 2: enabled, but not allowed to send Requests
1188 unsigned int tlsext_heartbeat;
1189 /* Indicates if a HeartbeatRequest is in flight */
1190 unsigned int tlsext_hb_pending;
1191 /* HeartbeatRequest sequence number */
1192 unsigned int tlsext_hb_seq;
1194 * For a client, this contains the list of supported protocols in wire
1197 unsigned char *alpn_client_proto_list;
1198 unsigned alpn_client_proto_list_len;
1200 # define session_ctx ctx
1201 # endif /* OPENSSL_NO_TLSEXT */
1203 * 1 if we are renegotiating.
1204 * 2 if we are a server and are inside a handshake
1205 * (i.e. not just sending a HelloRequest)
1208 # ifndef OPENSSL_NO_SRP
1209 /* ctx for SRP authentication */
1213 * Callback for disabling session caching and ticket support on a session
1214 * basis, depending on the chosen cipher.
1216 int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1218 RECORD_LAYER rlayer;
1222 typedef struct ssl3_state_st {
1224 int delay_buf_pop_ret;
1225 int read_mac_secret_size;
1226 unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1227 int write_mac_secret_size;
1228 unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1229 unsigned char server_random[SSL3_RANDOM_SIZE];
1230 unsigned char client_random[SSL3_RANDOM_SIZE];
1231 /* flags for countermeasure against known-IV weakness */
1232 int need_empty_fragments;
1233 int empty_fragment_done;
1234 /* The value of 'extra' when the buffers were initialized */
1236 /* used during startup, digest all incoming/outgoing packets */
1237 BIO *handshake_buffer;
1239 * When set of handshake digests is determined, buffer is hashed and
1240 * freed and MD_CTX-es for all required digests are stored in this array
1242 EVP_MD_CTX **handshake_dgst;
1244 * Set whenever an expected ChangeCipherSpec message is processed.
1245 * Unset when the peer's Finished message is received.
1246 * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1248 int change_cipher_spec;
1252 * we allow one fatal and one warning alert to be outstanding, send close
1253 * alert via the warning alert
1256 unsigned char send_alert[2];
1258 * This flag is set when we should renegotiate ASAP, basically when there
1259 * is no more data in the read or write buffers
1262 int total_renegotiations;
1263 int num_renegotiations;
1264 int in_read_app_data;
1266 /* actually only needs to be 16+20 */
1267 unsigned char cert_verify_md[EVP_MAX_MD_SIZE * 2];
1268 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1269 unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1271 unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1272 int peer_finish_md_len;
1273 unsigned long message_size;
1275 /* used to hold the new cipher we are going to use */
1276 const SSL_CIPHER *new_cipher;
1277 # ifndef OPENSSL_NO_DH
1280 # ifndef OPENSSL_NO_EC
1281 EC_KEY *ecdh; /* holds short lived ECDH key */
1283 /* used when SSL_ST_FLUSH_DATA is entered */
1286 /* used for certificate requests */
1289 char ctype[SSL3_CT_NUMBER];
1290 STACK_OF(X509_NAME) *ca_names;
1292 int key_block_length;
1293 unsigned char *key_block;
1294 const EVP_CIPHER *new_sym_enc;
1295 const EVP_MD *new_hash;
1296 int new_mac_pkey_type;
1297 int new_mac_secret_size;
1298 # ifndef OPENSSL_NO_COMP
1299 const SSL_COMP *new_compression;
1301 char *new_compression;
1306 /* Connection binding to prevent renegotiation attacks */
1307 unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1308 unsigned char previous_client_finished_len;
1309 unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1310 unsigned char previous_server_finished_len;
1311 int send_connection_binding; /* TODOEKR */
1313 # ifndef OPENSSL_NO_NEXTPROTONEG
1315 * Set if we saw the Next Protocol Negotiation extension from our peer.
1317 int next_proto_neg_seen;
1320 # ifndef OPENSSL_NO_TLSEXT
1323 * ALPN information (we are in the process of transitioning from NPN to
1328 * In a server these point to the selected ALPN protocol after the
1329 * ClientHello has been processed. In a client these contain the protocol
1330 * that the server selected once the ServerHello has been processed.
1332 unsigned char *alpn_selected;
1333 unsigned alpn_selected_len;
1335 # ifndef OPENSSL_NO_EC
1337 * This is set to true if we believe that this is a version of Safari
1338 * running on OS X 10.6 or newer. We wish to know this because Safari on
1339 * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1341 char is_probably_safari;
1342 # endif /* !OPENSSL_NO_EC */
1344 # endif /* !OPENSSL_NO_TLSEXT */
1348 /* DTLS structures */
1350 # ifndef OPENSSL_NO_SCTP
1351 # define DTLS1_SCTP_AUTH_LABEL "EXPORTER_DTLS_OVER_SCTP"
1354 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1355 # define DTLS1_MAX_MTU_OVERHEAD 48
1357 struct dtls1_retransmit_state {
1358 EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1359 EVP_MD_CTX *write_hash; /* used for mac generation */
1360 # ifndef OPENSSL_NO_COMP
1361 COMP_CTX *compress; /* compression */
1365 SSL_SESSION *session;
1366 unsigned short epoch;
1369 struct hm_header_st {
1371 unsigned long msg_len;
1373 unsigned long frag_off;
1374 unsigned long frag_len;
1375 unsigned int is_ccs;
1376 struct dtls1_retransmit_state saved_retransmit_state;
1379 struct ccs_header_st {
1384 struct dtls1_timeout_st {
1385 /* Number of read timeouts so far */
1386 unsigned int read_timeouts;
1387 /* Number of write timeouts so far */
1388 unsigned int write_timeouts;
1389 /* Number of alerts received so far */
1390 unsigned int num_alerts;
1393 typedef struct hm_fragment_st {
1394 struct hm_header_st msg_header;
1395 unsigned char *fragment;
1396 unsigned char *reassembly;
1399 typedef struct dtls1_state_st {
1400 unsigned int send_cookie;
1401 unsigned char cookie[DTLS1_COOKIE_LENGTH];
1402 unsigned char rcvd_cookie[DTLS1_COOKIE_LENGTH];
1403 unsigned int cookie_len;
1405 /* handshake message numbers */
1406 unsigned short handshake_write_seq;
1407 unsigned short next_handshake_write_seq;
1408 unsigned short handshake_read_seq;
1410 /* Buffered handshake messages */
1411 pqueue buffered_messages;
1412 /* Buffered (sent) handshake records */
1413 pqueue sent_messages;
1415 /* Is set when listening for new connections with dtls1_listen() */
1416 unsigned int listen;
1417 unsigned int link_mtu; /* max on-the-wire DTLS packet size */
1418 unsigned int mtu; /* max DTLS packet size */
1419 struct hm_header_st w_msg_hdr;
1420 struct hm_header_st r_msg_hdr;
1421 struct dtls1_timeout_st timeout;
1423 * Indicates when the last handshake msg or heartbeat sent will timeout
1425 struct timeval next_timeout;
1426 /* Timeout duration */
1427 unsigned short timeout_duration;
1429 unsigned int retransmitting;
1431 * Set when the handshake is ready to process peer's ChangeCipherSpec message.
1432 * Cleared after the message has been processed.
1434 unsigned int change_cipher_spec_ok;
1435 # ifndef OPENSSL_NO_SCTP
1436 /* used when SSL_ST_XX_FLUSH is entered */
1438 int shutdown_received;
1444 # ifndef OPENSSL_NO_EC
1446 * From ECC-TLS draft, used in encoding the curve type in ECParameters
1448 # define EXPLICIT_PRIME_CURVE_TYPE 1
1449 # define EXPLICIT_CHAR2_CURVE_TYPE 2
1450 # define NAMED_CURVE_TYPE 3
1451 # endif /* OPENSSL_NO_EC */
1453 typedef struct cert_pkey_st {
1455 EVP_PKEY *privatekey;
1456 /* Digest to use when signing */
1457 const EVP_MD *digest;
1458 /* Chain for this certificate */
1459 STACK_OF(X509) *chain;
1460 # ifndef OPENSSL_NO_TLSEXT
1462 * serverinfo data for this certificate. The data is in TLS Extension
1463 * wire format, specifically it's a series of records like:
1464 * uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1466 * uint8_t data[length];
1468 unsigned char *serverinfo;
1469 size_t serverinfo_length;
1472 * Set if CERT_PKEY can be used with current SSL session: e.g.
1473 * appropriate curve, signature algorithms etc. If zero it can't be used
1478 /* Retrieve Suite B flags */
1479 # define tls1_suiteb(s) (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1480 /* Uses to check strict mode: suite B modes are always strict */
1481 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1482 (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1485 unsigned short ext_type;
1487 * Per-connection flags relating to this extension type: not used if
1488 * part of an SSL_CTX structure.
1490 unsigned short ext_flags;
1491 custom_ext_add_cb add_cb;
1492 custom_ext_free_cb free_cb;
1494 custom_ext_parse_cb parse_cb;
1496 } custom_ext_method;
1498 /* ext_flags values */
1501 * Indicates an extension has been received. Used to check for unsolicited or
1502 * duplicate extensions.
1504 # define SSL_EXT_FLAG_RECEIVED 0x1
1506 * Indicates an extension has been sent: used to enable sending of
1507 * corresponding ServerHello extension.
1509 # define SSL_EXT_FLAG_SENT 0x2
1512 custom_ext_method *meths;
1514 } custom_ext_methods;
1516 typedef struct cert_st {
1517 /* Current active set */
1519 * ALWAYS points to an element of the pkeys array
1520 * Probably it would make more sense to store
1521 * an index, not a pointer.
1525 * For servers the following masks are for the key and auth algorithms
1526 * that are supported by the certs below. For clients they are masks of
1527 * *disabled* algorithms based on the current session.
1530 unsigned long mask_k;
1531 unsigned long mask_a;
1532 unsigned long export_mask_k;
1533 unsigned long export_mask_a;
1535 unsigned long mask_ssl;
1536 # ifndef OPENSSL_NO_RSA
1538 RSA *(*rsa_tmp_cb) (SSL *ssl, int is_export, int keysize);
1540 # ifndef OPENSSL_NO_DH
1542 DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1545 # ifndef OPENSSL_NO_EC
1547 /* Callback for generating ephemeral ECDH keys */
1548 EC_KEY *(*ecdh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1549 /* Select ECDH parameters automatically */
1552 /* Flags related to certificates */
1553 unsigned int cert_flags;
1554 CERT_PKEY pkeys[SSL_PKEY_NUM];
1556 * Certificate types (received or sent) in certificate request message.
1557 * On receive this is only set if number of certificate types exceeds
1560 unsigned char *ctypes;
1562 /* Temporary storage for premaster secret */
1566 * signature algorithms peer reports: e.g. supported signature algorithms
1567 * extension for server or as part of a certificate request for client.
1569 unsigned char *peer_sigalgs;
1570 /* Size of above array */
1571 size_t peer_sigalgslen;
1573 * suppported signature algorithms. When set on a client this is sent in
1574 * the client hello as the supported signature algorithms extension. For
1575 * servers it represents the signature algorithms we are willing to use.
1577 unsigned char *conf_sigalgs;
1578 /* Size of above array */
1579 size_t conf_sigalgslen;
1581 * Client authentication signature algorithms, if not set then uses
1582 * conf_sigalgs. On servers these will be the signature algorithms sent
1583 * to the client in a cerificate request for TLS 1.2. On a client this
1584 * represents the signature algortithms we are willing to use for client
1587 unsigned char *client_sigalgs;
1588 /* Size of above array */
1589 size_t client_sigalgslen;
1591 * Signature algorithms shared by client and server: cached because these
1592 * are used most often.
1594 TLS_SIGALGS *shared_sigalgs;
1595 size_t shared_sigalgslen;
1597 * Certificate setup callback: if set is called whenever a certificate
1598 * may be required (client or server). the callback can then examine any
1599 * appropriate parameters and setup any certificates required. This
1600 * allows advanced applications to select certificates on the fly: for
1601 * example based on supported signature algorithms or curves.
1603 int (*cert_cb) (SSL *ssl, void *arg);
1606 * Optional X509_STORE for chain building or certificate validation If
1607 * NULL the parent SSL_CTX store is used instead.
1609 X509_STORE *chain_store;
1610 X509_STORE *verify_store;
1611 /* Raw values of the cipher list from a client */
1612 unsigned char *ciphers_raw;
1613 size_t ciphers_rawlen;
1614 /* Custom extension methods for server and client */
1615 custom_ext_methods cli_ext;
1616 custom_ext_methods srv_ext;
1617 /* Security callback */
1618 int (*sec_cb) (SSL *s, SSL_CTX *ctx, int op, int bits, int nid,
1619 void *other, void *ex);
1620 /* Security level */
1623 int references; /* >1 only if SSL_copy_session_id is used */
1626 typedef struct sess_cert_st {
1627 STACK_OF(X509) *cert_chain; /* as received from peer */
1628 /* The 'peer_...' members are used only by clients. */
1630 CERT_PKEY *peer_key; /* points to an element of peer_pkeys (never
1632 CERT_PKEY peer_pkeys[SSL_PKEY_NUM];
1634 * Obviously we don't have the private keys of these, so maybe we
1635 * shouldn't even use the CERT_PKEY type here.
1637 # ifndef OPENSSL_NO_RSA
1638 RSA *peer_rsa_tmp; /* not used for SSL 2 */
1640 # ifndef OPENSSL_NO_DH
1641 DH *peer_dh_tmp; /* not used for SSL 2 */
1643 # ifndef OPENSSL_NO_EC
1644 EC_KEY *peer_ecdh_tmp;
1646 int references; /* actually always 1 at the moment */
1648 /* Structure containing decoded values of signature algorithms extension */
1649 struct tls_sigalgs_st {
1650 /* NID of hash algorithm */
1652 /* NID of signature algorithm */
1654 /* Combined hash and signature NID */
1655 int signandhash_nid;
1656 /* Raw values used in extension */
1657 unsigned char rsign;
1658 unsigned char rhash;
1669 * #define ABORT_DEBUG
1672 * #define PKT_DEBUG 1
1678 * #define DES_OFB_DEBUG
1687 * #define IDEA_DEBUG
1690 # define FP_ICC (int (*)(const void *,const void *))
1691 # define ssl_put_cipher_by_char(ssl,ciph,ptr) \
1692 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
1695 * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1696 * of a mess of functions, but hell, think of it as an opaque structure :-)
1698 typedef struct ssl3_enc_method {
1699 int (*enc) (SSL *, int);
1700 int (*mac) (SSL *, unsigned char *, int);
1701 int (*setup_key_block) (SSL *);
1702 int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1704 int (*change_cipher_state) (SSL *, int);
1705 int (*final_finish_mac) (SSL *, const char *, int, unsigned char *);
1706 int finish_mac_length;
1707 int (*cert_verify_mac) (SSL *, int, unsigned char *);
1708 const char *client_finished_label;
1709 int client_finished_label_len;
1710 const char *server_finished_label;
1711 int server_finished_label_len;
1712 int (*alert_value) (int);
1713 int (*export_keying_material) (SSL *, unsigned char *, size_t,
1714 const char *, size_t,
1715 const unsigned char *, size_t,
1717 /* Various flags indicating protocol version requirements */
1718 unsigned int enc_flags;
1719 /* Handshake header length */
1721 /* Set the handshake header */
1722 int (*set_handshake_header) (SSL *s, int type, unsigned long len);
1723 /* Write out handshake message */
1724 int (*do_write) (SSL *s);
1727 # define SSL_HM_HEADER_LENGTH(s) s->method->ssl3_enc->hhlen
1728 # define ssl_handshake_start(s) \
1729 (((unsigned char *)s->init_buf->data) + s->method->ssl3_enc->hhlen)
1730 # define ssl_set_handshake_header(s, htype, len) \
1731 s->method->ssl3_enc->set_handshake_header(s, htype, len)
1732 # define ssl_do_write(s) s->method->ssl3_enc->do_write(s)
1734 /* Values for enc_flags */
1736 /* Uses explicit IV for CBC mode */
1737 # define SSL_ENC_FLAG_EXPLICIT_IV 0x1
1738 /* Uses signature algorithms extension */
1739 # define SSL_ENC_FLAG_SIGALGS 0x2
1740 /* Uses SHA256 default PRF */
1741 # define SSL_ENC_FLAG_SHA256_PRF 0x4
1743 # define SSL_ENC_FLAG_DTLS 0x8
1745 * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1746 * apply to others in future.
1748 # define SSL_ENC_FLAG_TLS1_2_CIPHERS 0x10
1750 # ifndef OPENSSL_NO_COMP
1751 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1752 typedef struct ssl3_comp_st {
1753 int comp_id; /* The identifier byte for this compression
1755 char *name; /* Text name used for the compression type */
1756 COMP_METHOD *method; /* The method :-) */
1760 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1761 OPENSSL_EXTERN const SSL_CIPHER ssl3_ciphers[];
1763 SSL_METHOD *ssl_bad_method(int ver);
1765 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1766 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1767 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1768 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1769 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1770 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1772 # define IMPLEMENT_tls_meth_func(version, func_name, s_accept, s_connect, \
1773 s_get_meth, enc_data) \
1774 const SSL_METHOD *func_name(void) \
1776 static const SSL_METHOD func_name##_data= { \
1788 ssl3_renegotiate_check, \
1792 ssl3_dispatch_alert, \
1795 ssl3_get_cipher_by_char, \
1796 ssl3_put_cipher_by_char, \
1801 tls1_default_timeout, \
1803 ssl_undefined_void_function, \
1804 ssl3_callback_ctrl, \
1805 ssl3_ctx_callback_ctrl, \
1807 return &func_name##_data; \
1810 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect, s_get_meth) \
1811 const SSL_METHOD *func_name(void) \
1813 static const SSL_METHOD func_name##_data= { \
1825 ssl3_renegotiate_check, \
1829 ssl3_dispatch_alert, \
1832 ssl3_get_cipher_by_char, \
1833 ssl3_put_cipher_by_char, \
1838 ssl3_default_timeout, \
1840 ssl_undefined_void_function, \
1841 ssl3_callback_ctrl, \
1842 ssl3_ctx_callback_ctrl, \
1844 return &func_name##_data; \
1847 # define IMPLEMENT_ssl23_meth_func(func_name, s_accept, s_connect, s_get_meth) \
1848 const SSL_METHOD *func_name(void) \
1850 static const SSL_METHOD func_name##_data= { \
1860 ssl_undefined_function, \
1861 ssl_undefined_function, \
1866 ssl3_dispatch_alert, \
1869 ssl23_get_cipher_by_char, \
1870 ssl23_put_cipher_by_char, \
1871 ssl_undefined_const_function, \
1872 ssl23_num_ciphers, \
1875 ssl23_default_timeout, \
1876 &TLSv1_2_enc_data, \
1877 ssl_undefined_void_function, \
1878 ssl3_callback_ctrl, \
1879 ssl3_ctx_callback_ctrl, \
1881 return &func_name##_data; \
1884 # define IMPLEMENT_dtls1_meth_func(version, func_name, s_accept, s_connect, \
1885 s_get_meth, enc_data) \
1886 const SSL_METHOD *func_name(void) \
1888 static const SSL_METHOD func_name##_data= { \
1900 ssl3_renegotiate_check, \
1901 dtls1_get_message, \
1903 dtls1_write_app_data_bytes, \
1904 dtls1_dispatch_alert, \
1907 ssl3_get_cipher_by_char, \
1908 ssl3_put_cipher_by_char, \
1913 dtls1_default_timeout, \
1915 ssl_undefined_void_function, \
1916 ssl3_callback_ctrl, \
1917 ssl3_ctx_callback_ctrl, \
1919 return &func_name##_data; \
1922 struct openssl_ssl_test_functions {
1923 int (*p_ssl_init_wbio_buffer) (SSL *s, int push);
1924 int (*p_ssl3_setup_buffers) (SSL *s);
1925 int (*p_tls1_process_heartbeat) (SSL *s,
1926 unsigned char *p, unsigned int length);
1927 int (*p_dtls1_process_heartbeat) (SSL *s,
1928 unsigned char *p, unsigned int length);
1931 # ifndef OPENSSL_UNIT_TEST
1933 void ssl_clear_cipher_ctx(SSL *s);
1934 int ssl_clear_bad_session(SSL *s);
1935 __owur CERT *ssl_cert_new(void);
1936 __owur CERT *ssl_cert_dup(CERT *cert);
1937 void ssl_cert_set_default_md(CERT *cert);
1938 void ssl_cert_clear_certs(CERT *c);
1939 void ssl_cert_free(CERT *c);
1940 __owur SESS_CERT *ssl_sess_cert_new(void);
1941 void ssl_sess_cert_free(SESS_CERT *sc);
1942 __owur int ssl_set_peer_cert_type(SESS_CERT *c, int type);
1943 __owur int ssl_get_new_session(SSL *s, int session);
1944 __owur int ssl_get_prev_session(SSL *s, unsigned char *session, int len,
1945 const unsigned char *limit);
1946 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1947 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
1948 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1949 const SSL_CIPHER *const *bp);
1950 __owur STACK_OF(SSL_CIPHER) *ssl_bytes_to_cipher_list(SSL *s, unsigned char *p,
1952 STACK_OF(SSL_CIPHER) **skp);
1953 __owur int ssl_cipher_list_to_bytes(SSL *s, STACK_OF(SSL_CIPHER) *sk,
1955 int (*put_cb) (const SSL_CIPHER *,
1957 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
1958 STACK_OF(SSL_CIPHER) **pref,
1959 STACK_OF(SSL_CIPHER) **sorted,
1960 const char *rule_str, CERT *c);
1961 void ssl_update_cache(SSL *s, int mode);
1962 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
1963 const EVP_MD **md, int *mac_pkey_type,
1964 int *mac_secret_size, SSL_COMP **comp, int use_etm);
1965 __owur int ssl_get_handshake_digest(int i, long *mask, const EVP_MD **md);
1966 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
1967 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr);
1968 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
1969 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
1970 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
1971 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
1972 __owur int ssl_cert_select_current(CERT *c, X509 *x);
1973 __owur int ssl_cert_set_current(CERT *c, long arg);
1974 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
1975 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg),
1978 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
1979 __owur int ssl_add_cert_chain(SSL *s, CERT_PKEY *cpk, unsigned long *l);
1980 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
1981 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain, int ref);
1983 __owur int ssl_security(SSL *s, int op, int bits, int nid, void *other);
1984 __owur int ssl_ctx_security(SSL_CTX *ctx, int op, int bits, int nid, void *other);
1986 int ssl_undefined_function(SSL *s);
1987 __owur int ssl_undefined_void_function(void);
1988 __owur int ssl_undefined_const_function(const SSL *s);
1989 __owur CERT_PKEY *ssl_get_server_send_pkey(const SSL *s);
1990 # ifndef OPENSSL_NO_TLSEXT
1991 __owur int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
1992 size_t *serverinfo_length);
1994 __owur EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *c, const EVP_MD **pmd);
1995 __owur int ssl_cert_type(X509 *x, EVP_PKEY *pkey);
1996 void ssl_set_cert_masks(CERT *c, const SSL_CIPHER *cipher);
1997 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
1998 __owur int ssl_verify_alarm_type(long type);
1999 void ssl_load_ciphers(void);
2000 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field, int len);
2002 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2003 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
2004 void ssl3_init_finished_mac(SSL *s);
2005 __owur int ssl3_send_server_certificate(SSL *s);
2006 __owur int ssl3_send_newsession_ticket(SSL *s);
2007 __owur int ssl3_send_cert_status(SSL *s);
2008 __owur int ssl3_get_finished(SSL *s, int state_a, int state_b);
2009 __owur int ssl3_setup_key_block(SSL *s);
2010 __owur int ssl3_send_change_cipher_spec(SSL *s, int state_a, int state_b);
2011 __owur int ssl3_change_cipher_state(SSL *s, int which);
2012 void ssl3_cleanup_key_block(SSL *s);
2013 __owur int ssl3_do_write(SSL *s, int type);
2014 int ssl3_send_alert(SSL *s, int level, int desc);
2015 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2016 unsigned char *p, int len);
2017 __owur int ssl3_get_req_cert_type(SSL *s, unsigned char *p);
2018 __owur long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
2019 __owur int ssl3_send_finished(SSL *s, int a, int b, const char *sender, int slen);
2020 __owur int ssl3_num_ciphers(void);
2021 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2022 int ssl3_renegotiate(SSL *ssl);
2023 int ssl3_renegotiate_check(SSL *ssl);
2024 __owur int ssl3_dispatch_alert(SSL *s);
2025 __owur int ssl3_final_finish_mac(SSL *s, const char *sender, int slen,
2027 __owur int ssl3_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
2028 void ssl3_finish_mac(SSL *s, const unsigned char *buf, int len);
2029 void ssl3_free_digest_list(SSL *s);
2030 __owur unsigned long ssl3_output_cert_chain(SSL *s, CERT_PKEY *cpk);
2031 __owur SSL_CIPHER *ssl3_choose_cipher(SSL *ssl, STACK_OF(SSL_CIPHER) *clnt,
2032 STACK_OF(SSL_CIPHER) *srvr);
2033 __owur int ssl3_digest_cached_records(SSL *s);
2034 __owur int ssl3_new(SSL *s);
2035 void ssl3_free(SSL *s);
2036 __owur int ssl3_accept(SSL *s);
2037 __owur int ssl3_connect(SSL *s);
2038 __owur int ssl3_read(SSL *s, void *buf, int len);
2039 __owur int ssl3_peek(SSL *s, void *buf, int len);
2040 __owur int ssl3_write(SSL *s, const void *buf, int len);
2041 __owur int ssl3_shutdown(SSL *s);
2042 void ssl3_clear(SSL *s);
2043 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2044 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2045 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2046 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2048 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2049 __owur long ssl3_default_timeout(void);
2051 __owur int ssl3_set_handshake_header(SSL *s, int htype, unsigned long len);
2052 __owur int ssl3_handshake_write(SSL *s);
2054 __owur int ssl23_num_ciphers(void);
2055 __owur const SSL_CIPHER *ssl23_get_cipher(unsigned int u);
2056 __owur int ssl23_read(SSL *s, void *buf, int len);
2057 __owur int ssl23_peek(SSL *s, void *buf, int len);
2058 __owur int ssl23_write(SSL *s, const void *buf, int len);
2059 __owur int ssl23_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
2060 __owur const SSL_CIPHER *ssl23_get_cipher_by_char(const unsigned char *p);
2061 __owur long ssl23_default_timeout(void);
2063 __owur int ssl_allow_compression(SSL *s);
2065 __owur long tls1_default_timeout(void);
2066 __owur int dtls1_do_write(SSL *s, int type);
2067 void dtls1_set_message_header(SSL *s,
2068 unsigned char *p, unsigned char mt,
2070 unsigned long frag_off,
2071 unsigned long frag_len);
2073 __owur int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf, int len);
2075 __owur int dtls1_send_change_cipher_spec(SSL *s, int a, int b);
2076 __owur int dtls1_send_finished(SSL *s, int a, int b, const char *sender, int slen);
2077 __owur int dtls1_read_failed(SSL *s, int code);
2078 __owur int dtls1_buffer_message(SSL *s, int ccs);
2079 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq,
2080 unsigned long frag_off, int *found);
2081 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2082 int dtls1_retransmit_buffered_messages(SSL *s);
2083 void dtls1_clear_record_buffer(SSL *s);
2084 void dtls1_get_message_header(unsigned char *data,
2085 struct hm_header_st *msg_hdr);
2086 void dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr);
2087 __owur long dtls1_default_timeout(void);
2088 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2089 __owur int dtls1_check_timeout_num(SSL *s);
2090 __owur int dtls1_handle_timeout(SSL *s);
2091 __owur const SSL_CIPHER *dtls1_get_cipher(unsigned int u);
2092 void dtls1_start_timer(SSL *s);
2093 void dtls1_stop_timer(SSL *s);
2094 __owur int dtls1_is_timer_expired(SSL *s);
2095 void dtls1_double_timeout(SSL *s);
2096 __owur int dtls1_send_newsession_ticket(SSL *s);
2097 __owur unsigned int dtls1_min_mtu(SSL *s);
2098 __owur unsigned int dtls1_link_min_mtu(void);
2099 void dtls1_hm_fragment_free(hm_fragment *frag);
2101 /* some client-only functions */
2102 __owur int ssl3_client_hello(SSL *s);
2103 __owur int ssl3_get_server_hello(SSL *s);
2104 __owur int ssl3_get_certificate_request(SSL *s);
2105 __owur int ssl3_get_new_session_ticket(SSL *s);
2106 __owur int ssl3_get_cert_status(SSL *s);
2107 __owur int ssl3_get_server_done(SSL *s);
2108 __owur int ssl3_send_client_verify(SSL *s);
2109 __owur int ssl3_send_client_certificate(SSL *s);
2110 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
2111 __owur int ssl3_send_client_key_exchange(SSL *s);
2112 __owur int ssl3_get_key_exchange(SSL *s);
2113 __owur int ssl3_get_server_certificate(SSL *s);
2114 __owur int ssl3_check_cert_and_algorithm(SSL *s);
2115 # ifndef OPENSSL_NO_TLSEXT
2116 # ifndef OPENSSL_NO_NEXTPROTONEG
2117 __owur int ssl3_send_next_proto(SSL *s);
2121 int dtls1_client_hello(SSL *s);
2123 /* some server-only functions */
2124 __owur int ssl3_get_client_hello(SSL *s);
2125 __owur int ssl3_send_server_hello(SSL *s);
2126 __owur int ssl3_send_hello_request(SSL *s);
2127 __owur int ssl3_send_server_key_exchange(SSL *s);
2128 __owur int ssl3_send_certificate_request(SSL *s);
2129 __owur int ssl3_send_server_done(SSL *s);
2130 __owur int ssl3_get_client_certificate(SSL *s);
2131 __owur int ssl3_get_client_key_exchange(SSL *s);
2132 __owur int ssl3_get_cert_verify(SSL *s);
2133 # ifndef OPENSSL_NO_NEXTPROTONEG
2134 __owur int ssl3_get_next_proto(SSL *s);
2137 __owur int ssl23_accept(SSL *s);
2138 __owur int ssl23_connect(SSL *s);
2140 __owur int tls1_new(SSL *s);
2141 void tls1_free(SSL *s);
2142 void tls1_clear(SSL *s);
2143 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2144 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2146 __owur int dtls1_new(SSL *s);
2147 __owur int dtls1_accept(SSL *s);
2148 __owur int dtls1_connect(SSL *s);
2149 void dtls1_free(SSL *s);
2150 void dtls1_clear(SSL *s);
2151 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2152 __owur int dtls1_shutdown(SSL *s);
2154 __owur long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
2155 __owur int dtls1_dispatch_alert(SSL *s);
2157 __owur int ssl_init_wbio_buffer(SSL *s, int push);
2158 void ssl_free_wbio_buffer(SSL *s);
2160 __owur int tls1_change_cipher_state(SSL *s, int which);
2161 __owur int tls1_setup_key_block(SSL *s);
2162 __owur int tls1_final_finish_mac(SSL *s,
2163 const char *str, int slen, unsigned char *p);
2164 __owur int tls1_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
2165 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2166 unsigned char *p, int len);
2167 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2168 const char *label, size_t llen,
2169 const unsigned char *p, size_t plen,
2171 __owur int tls1_alert_code(int code);
2172 __owur int ssl3_alert_code(int code);
2173 __owur int ssl_ok(SSL *s);
2175 # ifndef OPENSSL_NO_EC
2176 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2179 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2181 # ifndef OPENSSL_NO_EC
2182 __owur int tls1_ec_curve_id2nid(int curve_id);
2183 __owur int tls1_ec_nid2curve_id(int nid);
2184 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2185 __owur int tls1_shared_curve(SSL *s, int nmatch);
2186 __owur int tls1_set_curves(unsigned char **pext, size_t *pextlen,
2187 int *curves, size_t ncurves);
2188 __owur int tls1_set_curves_list(unsigned char **pext, size_t *pextlen,
2190 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2191 # endif /* OPENSSL_NO_EC */
2193 # ifndef OPENSSL_NO_TLSEXT
2194 __owur int tls1_shared_list(SSL *s,
2195 const unsigned char *l1, size_t l1len,
2196 const unsigned char *l2, size_t l2len, int nmatch);
2197 __owur unsigned char *ssl_add_clienthello_tlsext(SSL *s, unsigned char *buf,
2198 unsigned char *limit, int *al);
2199 __owur unsigned char *ssl_add_serverhello_tlsext(SSL *s, unsigned char *buf,
2200 unsigned char *limit, int *al);
2201 __owur int ssl_parse_clienthello_tlsext(SSL *s, unsigned char **data,
2202 unsigned char *d, int n);
2203 __owur int tls1_set_server_sigalgs(SSL *s);
2204 __owur int ssl_check_clienthello_tlsext_late(SSL *s);
2205 __owur int ssl_parse_serverhello_tlsext(SSL *s, unsigned char **data,
2206 unsigned char *d, int n);
2207 __owur int ssl_prepare_clienthello_tlsext(SSL *s);
2208 __owur int ssl_prepare_serverhello_tlsext(SSL *s);
2210 # ifndef OPENSSL_NO_HEARTBEATS
2211 __owur int tls1_heartbeat(SSL *s);
2212 __owur int dtls1_heartbeat(SSL *s);
2213 __owur int tls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length);
2214 __owur int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length);
2217 __owur int tls1_process_ticket(SSL *s, unsigned char *session_id, int len,
2218 const unsigned char *limit, SSL_SESSION **ret);
2220 __owur int tls12_get_sigandhash(unsigned char *p, const EVP_PKEY *pk,
2222 __owur int tls12_get_sigid(const EVP_PKEY *pk);
2223 __owur const EVP_MD *tls12_get_hash(unsigned char hash_alg);
2224 void ssl_set_sig_mask(unsigned long *pmask_a, SSL *s, int op);
2226 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2227 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen, int client);
2228 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2230 void tls1_set_cert_validity(SSL *s);
2233 # ifndef OPENSSL_NO_DH
2234 __owur DH *ssl_get_auto_dh(SSL *s);
2237 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2238 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex, int vfy);
2240 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2241 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2242 __owur int ssl_add_serverhello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
2244 __owur int ssl_parse_serverhello_renegotiate_ext(SSL *s, unsigned char *d, int len,
2246 __owur int ssl_add_clienthello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
2248 __owur int ssl_parse_clienthello_renegotiate_ext(SSL *s, unsigned char *d, int len,
2250 __owur long ssl_get_algorithm2(SSL *s);
2251 __owur size_t tls12_copy_sigalgs(SSL *s, unsigned char *out,
2252 const unsigned char *psig, size_t psiglen);
2253 __owur int tls1_save_sigalgs(SSL *s, const unsigned char *data, int dsize);
2254 __owur int tls1_process_sigalgs(SSL *s);
2255 __owur size_t tls12_get_psigalgs(SSL *s, const unsigned char **psigs);
2256 __owur int tls12_check_peer_sigalg(const EVP_MD **pmd, SSL *s,
2257 const unsigned char *sig, EVP_PKEY *pkey);
2258 void ssl_set_client_disabled(SSL *s);
2259 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2261 __owur int ssl_add_clienthello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
2263 __owur int ssl_parse_clienthello_use_srtp_ext(SSL *s, unsigned char *d, int len,
2265 __owur int ssl_add_serverhello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
2267 __owur int ssl_parse_serverhello_use_srtp_ext(SSL *s, unsigned char *d, int len,
2270 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen);
2273 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2274 void ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2275 unsigned char *md_out,
2276 size_t *md_out_size,
2277 const unsigned char header[13],
2278 const unsigned char *data,
2279 size_t data_plus_mac_size,
2280 size_t data_plus_mac_plus_padding_size,
2281 const unsigned char *mac_secret,
2282 unsigned mac_secret_length, char is_sslv3);
2284 void tls_fips_digest_extra(const EVP_CIPHER_CTX *cipher_ctx,
2285 EVP_MD_CTX *mac_ctx, const unsigned char *data,
2286 size_t data_len, size_t orig_len);
2288 __owur int srp_verify_server_param(SSL *s, int *al);
2292 void custom_ext_init(custom_ext_methods *meths);
2294 __owur int custom_ext_parse(SSL *s, int server,
2295 unsigned int ext_type,
2296 const unsigned char *ext_data, size_t ext_size, int *al);
2297 __owur int custom_ext_add(SSL *s, int server,
2298 unsigned char **pret, unsigned char *limit, int *al);
2300 __owur int custom_exts_copy(custom_ext_methods *dst, const custom_ext_methods *src);
2301 void custom_exts_free(custom_ext_methods *exts);
2305 # define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2306 # define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2307 # define tls1_process_heartbeat SSL_test_functions()->p_tls1_process_heartbeat
2308 # define dtls1_process_heartbeat SSL_test_functions()->p_dtls1_process_heartbeat