Code health: ssl/ssl_locl.h unused macros
[openssl.git] / ssl / ssl_locl.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* ====================================================================
11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12  * ECC cipher suite support in OpenSSL originally developed by
13  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
14  */
15 /* ====================================================================
16  * Copyright 2005 Nokia. All rights reserved.
17  *
18  * The portions of the attached software ("Contribution") is developed by
19  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
20  * license.
21  *
22  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24  * support (see RFC 4279) to OpenSSL.
25  *
26  * No patent licenses or other rights except those expressly stated in
27  * the OpenSSL open source license shall be deemed granted or received
28  * expressly, by implication, estoppel, or otherwise.
29  *
30  * No assurances are provided by Nokia that the Contribution does not
31  * infringe the patent or other intellectual property rights of any third
32  * party or that the license provides you with all the necessary rights
33  * to make use of the Contribution.
34  *
35  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
39  * OTHERWISE.
40  */
41
42 #ifndef HEADER_SSL_LOCL_H
43 # define HEADER_SSL_LOCL_H
44 # include <stdlib.h>
45 # include <time.h>
46 # include <string.h>
47 # include <errno.h>
48
49 # include "e_os.h"
50 # if defined(__unix) || defined(__unix__)
51 #  include <sys/time.h>         /* struct timeval for DTLS */
52 # endif
53
54 # include <openssl/buffer.h>
55 # include <openssl/comp.h>
56 # include <openssl/bio.h>
57 # include <openssl/stack.h>
58 # include <openssl/rsa.h>
59 # include <openssl/dsa.h>
60 # include <openssl/err.h>
61 # include <openssl/ssl.h>
62 # include <openssl/async.h>
63 # include <openssl/symhacks.h>
64 # include <openssl/ct.h>
65 # include "record/record.h"
66 # include "statem/statem.h"
67 # include "packet_locl.h"
68 # include "internal/dane.h"
69 # include "internal/refcount.h"
70
71 # ifdef OPENSSL_BUILD_SHLIBSSL
72 #  undef OPENSSL_EXTERN
73 #  define OPENSSL_EXTERN OPENSSL_EXPORT
74 # endif
75
76 # define c2l(c,l)        (l = ((unsigned long)(*((c)++)))     , \
77                          l|=(((unsigned long)(*((c)++)))<< 8), \
78                          l|=(((unsigned long)(*((c)++)))<<16), \
79                          l|=(((unsigned long)(*((c)++)))<<24))
80
81 /* NOTE - c is not incremented as per c2l */
82 # define c2ln(c,l1,l2,n) { \
83                         c+=n; \
84                         l1=l2=0; \
85                         switch (n) { \
86                         case 8: l2 =((unsigned long)(*(--(c))))<<24; \
87                         case 7: l2|=((unsigned long)(*(--(c))))<<16; \
88                         case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
89                         case 5: l2|=((unsigned long)(*(--(c))));     \
90                         case 4: l1 =((unsigned long)(*(--(c))))<<24; \
91                         case 3: l1|=((unsigned long)(*(--(c))))<<16; \
92                         case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
93                         case 1: l1|=((unsigned long)(*(--(c))));     \
94                                 } \
95                         }
96
97 # define l2c(l,c)        (*((c)++)=(unsigned char)(((l)    )&0xff), \
98                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
99                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
100                          *((c)++)=(unsigned char)(((l)>>24)&0xff))
101
102 # define n2l(c,l)        (l =((unsigned long)(*((c)++)))<<24, \
103                          l|=((unsigned long)(*((c)++)))<<16, \
104                          l|=((unsigned long)(*((c)++)))<< 8, \
105                          l|=((unsigned long)(*((c)++))))
106
107 # define n2l8(c,l)       (l =((uint64_t)(*((c)++)))<<56, \
108                          l|=((uint64_t)(*((c)++)))<<48, \
109                          l|=((uint64_t)(*((c)++)))<<40, \
110                          l|=((uint64_t)(*((c)++)))<<32, \
111                          l|=((uint64_t)(*((c)++)))<<24, \
112                          l|=((uint64_t)(*((c)++)))<<16, \
113                          l|=((uint64_t)(*((c)++)))<< 8, \
114                          l|=((uint64_t)(*((c)++))))
115
116
117 # define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
118                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
119                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
120                          *((c)++)=(unsigned char)(((l)    )&0xff))
121
122 # define l2n6(l,c)       (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
123                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
124                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
125                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
126                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
127                          *((c)++)=(unsigned char)(((l)    )&0xff))
128
129 # define l2n8(l,c)       (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
130                          *((c)++)=(unsigned char)(((l)>>48)&0xff), \
131                          *((c)++)=(unsigned char)(((l)>>40)&0xff), \
132                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
133                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
134                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
135                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
136                          *((c)++)=(unsigned char)(((l)    )&0xff))
137
138 /* NOTE - c is not incremented as per l2c */
139 # define l2cn(l1,l2,c,n) { \
140                         c+=n; \
141                         switch (n) { \
142                         case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
143                         case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
144                         case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
145                         case 5: *(--(c))=(unsigned char)(((l2)    )&0xff); \
146                         case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
147                         case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
148                         case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
149                         case 1: *(--(c))=(unsigned char)(((l1)    )&0xff); \
150                                 } \
151                         }
152
153 # define n2s(c,s)        ((s=(((unsigned int)((c)[0]))<< 8)| \
154                              (((unsigned int)((c)[1]))    )),(c)+=2)
155 # define s2n(s,c)        (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
156                            (c)[1]=(unsigned char)(((s)    )&0xff)),(c)+=2)
157
158 # define n2l3(c,l)       ((l =(((unsigned long)((c)[0]))<<16)| \
159                               (((unsigned long)((c)[1]))<< 8)| \
160                               (((unsigned long)((c)[2]))    )),(c)+=3)
161
162 # define l2n3(l,c)       (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
163                            (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
164                            (c)[2]=(unsigned char)(((l)    )&0xff)),(c)+=3)
165
166 /*
167  * DTLS version numbers are strange because they're inverted. Except for
168  * DTLS1_BAD_VER, which should be considered "lower" than the rest.
169  */
170 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
171 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
172 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
173 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
174 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
175
176
177 /*
178  * Define the Bitmasks for SSL_CIPHER.algorithms.
179  * This bits are used packed as dense as possible. If new methods/ciphers
180  * etc will be added, the bits a likely to change, so this information
181  * is for internal library use only, even though SSL_CIPHER.algorithms
182  * can be publicly accessed.
183  * Use the according functions for cipher management instead.
184  *
185  * The bit mask handling in the selection and sorting scheme in
186  * ssl_create_cipher_list() has only limited capabilities, reflecting
187  * that the different entities within are mutually exclusive:
188  * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
189  */
190
191 /* Bits for algorithm_mkey (key exchange algorithm) */
192 /* RSA key exchange */
193 # define SSL_kRSA                0x00000001U
194 /* tmp DH key no DH cert */
195 # define SSL_kDHE                0x00000002U
196 /* synonym */
197 # define SSL_kEDH                SSL_kDHE
198 /* ephemeral ECDH */
199 # define SSL_kECDHE              0x00000004U
200 /* synonym */
201 # define SSL_kEECDH              SSL_kECDHE
202 /* PSK */
203 # define SSL_kPSK                0x00000008U
204 /* GOST key exchange */
205 # define SSL_kGOST               0x00000010U
206 /* SRP */
207 # define SSL_kSRP                0x00000020U
208
209 # define SSL_kRSAPSK             0x00000040U
210 # define SSL_kECDHEPSK           0x00000080U
211 # define SSL_kDHEPSK             0x00000100U
212
213 /* all PSK */
214
215 # define SSL_PSK     (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
216
217 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
218 # define SSL_kANY                0x00000000U
219
220 /* Bits for algorithm_auth (server authentication) */
221 /* RSA auth */
222 # define SSL_aRSA                0x00000001U
223 /* DSS auth */
224 # define SSL_aDSS                0x00000002U
225 /* no auth (i.e. use ADH or AECDH) */
226 # define SSL_aNULL               0x00000004U
227 /* ECDSA auth*/
228 # define SSL_aECDSA              0x00000008U
229 /* PSK auth */
230 # define SSL_aPSK                0x00000010U
231 /* GOST R 34.10-2001 signature auth */
232 # define SSL_aGOST01             0x00000020U
233 /* SRP auth */
234 # define SSL_aSRP                0x00000040U
235 /* GOST R 34.10-2012 signature auth */
236 # define SSL_aGOST12             0x00000080U
237 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
238 # define SSL_aANY                0x00000000U
239
240 /* Bits for algorithm_enc (symmetric encryption) */
241 # define SSL_DES                 0x00000001U
242 # define SSL_3DES                0x00000002U
243 # define SSL_RC4                 0x00000004U
244 # define SSL_RC2                 0x00000008U
245 # define SSL_IDEA                0x00000010U
246 # define SSL_eNULL               0x00000020U
247 # define SSL_AES128              0x00000040U
248 # define SSL_AES256              0x00000080U
249 # define SSL_CAMELLIA128         0x00000100U
250 # define SSL_CAMELLIA256         0x00000200U
251 # define SSL_eGOST2814789CNT     0x00000400U
252 # define SSL_SEED                0x00000800U
253 # define SSL_AES128GCM           0x00001000U
254 # define SSL_AES256GCM           0x00002000U
255 # define SSL_AES128CCM           0x00004000U
256 # define SSL_AES256CCM           0x00008000U
257 # define SSL_AES128CCM8          0x00010000U
258 # define SSL_AES256CCM8          0x00020000U
259 # define SSL_eGOST2814789CNT12   0x00040000U
260 # define SSL_CHACHA20POLY1305    0x00080000U
261
262 # define SSL_AESGCM              (SSL_AES128GCM | SSL_AES256GCM)
263 # define SSL_AESCCM              (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
264 # define SSL_AES                 (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
265 # define SSL_CAMELLIA            (SSL_CAMELLIA128|SSL_CAMELLIA256)
266 # define SSL_CHACHA20            (SSL_CHACHA20POLY1305)
267
268 /* Bits for algorithm_mac (symmetric authentication) */
269
270 # define SSL_MD5                 0x00000001U
271 # define SSL_SHA1                0x00000002U
272 # define SSL_GOST94      0x00000004U
273 # define SSL_GOST89MAC   0x00000008U
274 # define SSL_SHA256              0x00000010U
275 # define SSL_SHA384              0x00000020U
276 /* Not a real MAC, just an indication it is part of cipher */
277 # define SSL_AEAD                0x00000040U
278 # define SSL_GOST12_256          0x00000080U
279 # define SSL_GOST89MAC12         0x00000100U
280 # define SSL_GOST12_512          0x00000200U
281
282 /*
283  * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
284  * sure to update this constant too
285  */
286
287 # define SSL_MD_MD5_IDX  0
288 # define SSL_MD_SHA1_IDX 1
289 # define SSL_MD_GOST94_IDX 2
290 # define SSL_MD_GOST89MAC_IDX 3
291 # define SSL_MD_SHA256_IDX 4
292 # define SSL_MD_SHA384_IDX 5
293 # define SSL_MD_GOST12_256_IDX  6
294 # define SSL_MD_GOST89MAC12_IDX 7
295 # define SSL_MD_GOST12_512_IDX  8
296 # define SSL_MD_MD5_SHA1_IDX 9
297 # define SSL_MD_SHA224_IDX 10
298 # define SSL_MD_SHA512_IDX 11
299 # define SSL_MAX_DIGEST 12
300
301 /* Bits for algorithm2 (handshake digests and other extra flags) */
302
303 /* Bits 0-7 are handshake MAC */
304 # define SSL_HANDSHAKE_MAC_MASK  0xFF
305 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
306 # define SSL_HANDSHAKE_MAC_SHA256   SSL_MD_SHA256_IDX
307 # define SSL_HANDSHAKE_MAC_SHA384   SSL_MD_SHA384_IDX
308 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
309 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
310 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
311 # define SSL_HANDSHAKE_MAC_DEFAULT  SSL_HANDSHAKE_MAC_MD5_SHA1
312
313 /* Bits 8-15 bits are PRF */
314 # define TLS1_PRF_DGST_SHIFT 8
315 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
316 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
317 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
318 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
319 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
320 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
321 # define TLS1_PRF            (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
322
323 /*
324  * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
325  * goes into algorithm2)
326  */
327 # define TLS1_STREAM_MAC 0x10000
328
329 # define SSL_STRONG_MASK         0x0000001FU
330 # define SSL_DEFAULT_MASK        0X00000020U
331
332 # define SSL_STRONG_NONE         0x00000001U
333 # define SSL_LOW                 0x00000002U
334 # define SSL_MEDIUM              0x00000004U
335 # define SSL_HIGH                0x00000008U
336 # define SSL_FIPS                0x00000010U
337 # define SSL_NOT_DEFAULT         0x00000020U
338
339 /* we have used 0000003f - 26 bits left to go */
340
341 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
342 # define SSL3_CK_CIPHERSUITE_FLAG                0x03000000
343
344 /* Check if an SSL structure is using DTLS */
345 # define SSL_IS_DTLS(s)  (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
346
347 /* Check if we are using TLSv1.3 */
348 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
349                           && (s)->method->version >= TLS1_3_VERSION \
350                           && (s)->method->version != TLS_ANY_VERSION)
351
352 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
353
354 /* See if we need explicit IV */
355 # define SSL_USE_EXPLICIT_IV(s)  \
356                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
357 /*
358  * See if we use signature algorithms extension and signature algorithm
359  * before signatures.
360  */
361 # define SSL_USE_SIGALGS(s)      \
362                         (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
363 /*
364  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
365  * apply to others in future.
366  */
367 # define SSL_USE_TLS1_2_CIPHERS(s)       \
368                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
369 /*
370  * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
371  * flags because it may not be set to correct version yet.
372  */
373 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s)        \
374     ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
375      (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
376 /*
377  * Determine if a client should send signature algorithms extension:
378  * as with TLS1.2 cipher we can't rely on method flags.
379  */
380 # define SSL_CLIENT_USE_SIGALGS(s)        \
381     SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
382
383 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
384 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
385
386 /* Mostly for SSLv3 */
387 # define SSL_PKEY_RSA            0
388 # define SSL_PKEY_DSA_SIGN       1
389 # define SSL_PKEY_ECC            2
390 # define SSL_PKEY_GOST01         3
391 # define SSL_PKEY_GOST12_256     4
392 # define SSL_PKEY_GOST12_512     5
393 # define SSL_PKEY_NUM            6
394 /*
395  * Pseudo-constant. GOST cipher suites can use different certs for 1
396  * SSL_CIPHER. So let's see which one we have in fact.
397  */
398 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
399
400 /*
401  * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
402  */
403
404 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
405
406 /*-
407  * SSL_kRSA <- RSA_ENC
408  * SSL_kDH  <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
409  * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
410  * SSL_aRSA <- RSA_ENC | RSA_SIGN
411  * SSL_aDSS <- DSA_SIGN
412  */
413
414 /*-
415 #define CERT_INVALID            0
416 #define CERT_PUBLIC_KEY         1
417 #define CERT_PRIVATE_KEY        2
418 */
419
420 /* CipherSuite length. SSLv3 and all TLS versions. */
421 # define TLS_CIPHER_LEN 2
422 /* used to hold info on the particular ciphers used */
423 struct ssl_cipher_st {
424     uint32_t valid;
425     const char *name;           /* text name */
426     uint32_t id;                /* id, 4 bytes, first is version */
427     /*
428      * changed in 1.0.0: these four used to be portions of a single value
429      * 'algorithms'
430      */
431     uint32_t algorithm_mkey;    /* key exchange algorithm */
432     uint32_t algorithm_auth;    /* server authentication */
433     uint32_t algorithm_enc;     /* symmetric encryption */
434     uint32_t algorithm_mac;     /* symmetric authentication */
435     int min_tls;                /* minimum SSL/TLS protocol version */
436     int max_tls;                /* maximum SSL/TLS protocol version */
437     int min_dtls;               /* minimum DTLS protocol version */
438     int max_dtls;               /* maximum DTLS protocol version */
439     uint32_t algo_strength;     /* strength and export flags */
440     uint32_t algorithm2;        /* Extra flags */
441     int32_t strength_bits;      /* Number of bits really used */
442     uint32_t alg_bits;          /* Number of bits for algorithm */
443 };
444
445 /* Used to hold SSL/TLS functions */
446 struct ssl_method_st {
447     int version;
448     unsigned flags;
449     unsigned long mask;
450     int (*ssl_new) (SSL *s);
451     void (*ssl_clear) (SSL *s);
452     void (*ssl_free) (SSL *s);
453     int (*ssl_accept) (SSL *s);
454     int (*ssl_connect) (SSL *s);
455     int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
456     int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
457     int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
458     int (*ssl_shutdown) (SSL *s);
459     int (*ssl_renegotiate) (SSL *s);
460     int (*ssl_renegotiate_check) (SSL *s, int);
461     int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
462                            unsigned char *buf, size_t len, int peek,
463                            size_t *readbytes);
464     int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
465                             size_t *written);
466     int (*ssl_dispatch_alert) (SSL *s);
467     long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
468     long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
469     const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
470     int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
471                                size_t *len);
472     size_t (*ssl_pending) (const SSL *s);
473     int (*num_ciphers) (void);
474     const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
475     long (*get_timeout) (void);
476     const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
477     int (*ssl_version) (void);
478     long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
479     long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
480 };
481
482 /*-
483  * Lets make this into an ASN.1 type structure as follows
484  * SSL_SESSION_ID ::= SEQUENCE {
485  *      version                 INTEGER,        -- structure version number
486  *      SSLversion              INTEGER,        -- SSL version number
487  *      Cipher                  OCTET STRING,   -- the 3 byte cipher ID
488  *      Session_ID              OCTET STRING,   -- the Session ID
489  *      Master_key              OCTET STRING,   -- the master key
490  *      Key_Arg [ 0 ] IMPLICIT  OCTET STRING,   -- the optional Key argument
491  *      Time [ 1 ] EXPLICIT     INTEGER,        -- optional Start Time
492  *      Timeout [ 2 ] EXPLICIT  INTEGER,        -- optional Timeout ins seconds
493  *      Peer [ 3 ] EXPLICIT     X509,           -- optional Peer Certificate
494  *      Session_ID_context [ 4 ] EXPLICIT OCTET STRING,   -- the Session ID context
495  *      Verify_result [ 5 ] EXPLICIT INTEGER,   -- X509_V_... code for `Peer'
496  *      HostName [ 6 ] EXPLICIT OCTET STRING,   -- optional HostName from servername TLS extension
497  *      PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
498  *      PSK_identity [ 8 ] EXPLICIT OCTET STRING,  -- optional PSK identity
499  *      Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
500  *      Ticket [10]             EXPLICIT OCTET STRING, -- session ticket (clients only)
501  *      Compression_meth [11]   EXPLICIT OCTET STRING, -- optional compression method
502  *      SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
503  *      flags [ 13 ] EXPLICIT INTEGER -- optional flags
504  *      }
505  * Look in ssl/ssl_asn1.c for more details
506  * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
507  */
508 struct ssl_session_st {
509     int ssl_version;            /* what ssl version session info is being kept
510                                  * in here? */
511     size_t master_key_length;
512
513     /*
514      * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
515      * master secret
516      */
517     unsigned char master_key[TLS13_MAX_RESUMPTION_MASTER_LENGTH];
518     /* session_id - valid? */
519     size_t session_id_length;
520     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
521     /*
522      * this is used to determine whether the session is being reused in the
523      * appropriate context. It is up to the application to set this, via
524      * SSL_new
525      */
526     size_t sid_ctx_length;
527     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
528 # ifndef OPENSSL_NO_PSK
529     char *psk_identity_hint;
530     char *psk_identity;
531 # endif
532     /*
533      * Used to indicate that session resumption is not allowed. Applications
534      * can also set this bit for a new session via not_resumable_session_cb
535      * to disable session caching and tickets.
536      */
537     int not_resumable;
538     /* This is the cert and type for the other end. */
539     X509 *peer;
540     int peer_type;
541     /* Certificate chain peer sent */
542     STACK_OF(X509) *peer_chain;
543     /*
544      * when app_verify_callback accepts a session where the peer's
545      * certificate is not ok, we must remember the error for session reuse:
546      */
547     long verify_result;         /* only for servers */
548     CRYPTO_REF_COUNT references;
549     long timeout;
550     long time;
551     unsigned int compress_meth; /* Need to lookup the method */
552     const SSL_CIPHER *cipher;
553     unsigned long cipher_id;    /* when ASN.1 loaded, this needs to be used to
554                                  * load the 'cipher' structure */
555     STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
556     CRYPTO_EX_DATA ex_data;     /* application specific data */
557     /*
558      * These are used to make removal of session-ids more efficient and to
559      * implement a maximum cache size.
560      */
561     struct ssl_session_st *prev, *next;
562
563     struct {
564         char *hostname;
565 # ifndef OPENSSL_NO_EC
566         size_t ecpointformats_len;
567         unsigned char *ecpointformats; /* peer's list */
568         size_t supportedgroups_len;
569         unsigned char *supportedgroups; /* peer's list */
570 # endif                         /* OPENSSL_NO_EC */
571     /* RFC4507 info */
572         unsigned char *tick; /* Session ticket */
573         size_t ticklen;      /* Session ticket length */
574         /* Session lifetime hint in seconds */
575         unsigned long tick_lifetime_hint;
576         uint32_t tick_age_add;
577         int tick_identity;
578     } ext;
579 # ifndef OPENSSL_NO_SRP
580     char *srp_username;
581 # endif
582     uint32_t flags;
583     CRYPTO_RWLOCK *lock;
584 };
585
586 /* Extended master secret support */
587 # define SSL_SESS_FLAG_EXTMS             0x1
588
589 # ifndef OPENSSL_NO_SRP
590
591 typedef struct srp_ctx_st {
592     /* param for all the callbacks */
593     void *SRP_cb_arg;
594     /* set client Hello login callback */
595     int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
596     /* set SRP N/g param callback for verification */
597     int (*SRP_verify_param_callback) (SSL *, void *);
598     /* set SRP client passwd callback */
599     char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
600     char *login;
601     BIGNUM *N, *g, *s, *B, *A;
602     BIGNUM *a, *b, *v;
603     char *info;
604     int strength;
605     unsigned long srp_Mask;
606 } SRP_CTX;
607
608 # endif
609
610 #define MAX_COMPRESSIONS_SIZE   255
611
612 struct ssl_comp_st {
613     int id;
614     const char *name;
615     COMP_METHOD *method;
616 };
617
618 typedef struct raw_extension_st {
619     /* Raw packet data for the extension */
620     PACKET data;
621     /* Set to 1 if the extension is present or 0 otherwise */
622     int present;
623     /* Set to 1 if we have already parsed the extension or 0 otherwise */
624     int parsed;
625     /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
626     unsigned int type;
627 } RAW_EXTENSION;
628
629 typedef struct {
630     unsigned int isv2;
631     unsigned int legacy_version;
632     unsigned char random[SSL3_RANDOM_SIZE];
633     size_t session_id_len;
634     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
635     size_t dtls_cookie_len;
636     unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
637     PACKET ciphersuites;
638     size_t compressions_len;
639     unsigned char compressions[MAX_COMPRESSIONS_SIZE];
640     PACKET extensions;
641     size_t pre_proc_exts_len;
642     RAW_EXTENSION *pre_proc_exts;
643 } CLIENTHELLO_MSG;
644
645 DEFINE_LHASH_OF(SSL_SESSION);
646 /* Needed in ssl_cert.c */
647 DEFINE_LHASH_OF(X509_NAME);
648
649 # define TLSEXT_KEYNAME_LENGTH 16
650
651 struct ssl_ctx_st {
652     const SSL_METHOD *method;
653     STACK_OF(SSL_CIPHER) *cipher_list;
654     /* same as above but sorted for lookup */
655     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
656     struct x509_store_st /* X509_STORE */ *cert_store;
657     LHASH_OF(SSL_SESSION) *sessions;
658     /*
659      * Most session-ids that will be cached, default is
660      * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
661      */
662     size_t session_cache_size;
663     struct ssl_session_st *session_cache_head;
664     struct ssl_session_st *session_cache_tail;
665     /*
666      * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
667      * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
668      * means only SSL_accept which cache SSL_SESSIONS.
669      */
670     uint32_t session_cache_mode;
671     /*
672      * If timeout is not 0, it is the default timeout value set when
673      * SSL_new() is called.  This has been put in to make life easier to set
674      * things up
675      */
676     long session_timeout;
677     /*
678      * If this callback is not null, it will be called each time a session id
679      * is added to the cache.  If this function returns 1, it means that the
680      * callback will do a SSL_SESSION_free() when it has finished using it.
681      * Otherwise, on 0, it means the callback has finished with it. If
682      * remove_session_cb is not null, it will be called when a session-id is
683      * removed from the cache.  After the call, OpenSSL will
684      * SSL_SESSION_free() it.
685      */
686     int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
687     void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
688     SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
689                                     const unsigned char *data, int len,
690                                     int *copy);
691     struct {
692         int sess_connect;       /* SSL new conn - started */
693         int sess_connect_renegotiate; /* SSL reneg - requested */
694         int sess_connect_good;  /* SSL new conne/reneg - finished */
695         int sess_accept;        /* SSL new accept - started */
696         int sess_accept_renegotiate; /* SSL reneg - requested */
697         int sess_accept_good;   /* SSL accept/reneg - finished */
698         int sess_miss;          /* session lookup misses */
699         int sess_timeout;       /* reuse attempt on timeouted session */
700         int sess_cache_full;    /* session removed due to full cache */
701         int sess_hit;           /* session reuse actually done */
702         int sess_cb_hit;        /* session-id that was not in the cache was
703                                  * passed back via the callback.  This
704                                  * indicates that the application is supplying
705                                  * session-id's from other processes - spooky
706                                  * :-) */
707     } stats;
708
709     CRYPTO_REF_COUNT references;
710
711     /* if defined, these override the X509_verify_cert() calls */
712     int (*app_verify_callback) (X509_STORE_CTX *, void *);
713     void *app_verify_arg;
714     /*
715      * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
716      * ('app_verify_callback' was called with just one argument)
717      */
718
719     /* Default password callback. */
720     pem_password_cb *default_passwd_callback;
721
722     /* Default password callback user data. */
723     void *default_passwd_callback_userdata;
724
725     /* get client cert callback */
726     int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
727
728     /* cookie generate callback */
729     int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
730                               unsigned int *cookie_len);
731
732     /* verify cookie callback */
733     int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
734                                  unsigned int cookie_len);
735
736     CRYPTO_EX_DATA ex_data;
737
738     const EVP_MD *md5;          /* For SSLv3/TLSv1 'ssl3-md5' */
739     const EVP_MD *sha1;         /* For SSLv3/TLSv1 'ssl3->sha1' */
740
741     STACK_OF(X509) *extra_certs;
742     STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
743
744     /* Default values used when no per-SSL value is defined follow */
745
746     /* used if SSL's info_callback is NULL */
747     void (*info_callback) (const SSL *ssl, int type, int val);
748
749     /* what we put in client cert requests */
750     STACK_OF(X509_NAME) *client_CA;
751
752     /*
753      * Default values to use in SSL structures follow (these are copied by
754      * SSL_new)
755      */
756
757     uint32_t options;
758     uint32_t mode;
759     int min_proto_version;
760     int max_proto_version;
761     size_t max_cert_list;
762
763     struct cert_st /* CERT */ *cert;
764     int read_ahead;
765
766     /* callback that allows applications to peek at protocol messages */
767     void (*msg_callback) (int write_p, int version, int content_type,
768                           const void *buf, size_t len, SSL *ssl, void *arg);
769     void *msg_callback_arg;
770
771     uint32_t verify_mode;
772     size_t sid_ctx_length;
773     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
774     /* called 'verify_callback' in the SSL */
775     int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
776
777     /* Default generate session ID callback. */
778     GEN_SESSION_CB generate_session_id;
779
780     X509_VERIFY_PARAM *param;
781
782     int quiet_shutdown;
783
784 # ifndef OPENSSL_NO_CT
785     CTLOG_STORE *ctlog_store;   /* CT Log Store */
786     /*
787      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
788      * If they are not, the connection should be aborted.
789      */
790     ssl_ct_validation_cb ct_validation_callback;
791     void *ct_validation_callback_arg;
792 # endif
793
794     /*
795      * If we're using more than one pipeline how should we divide the data
796      * up between the pipes?
797      */
798     size_t split_send_fragment;
799     /*
800      * Maximum amount of data to send in one fragment. actual record size can
801      * be more than this due to padding and MAC overheads.
802      */
803     size_t max_send_fragment;
804
805     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
806     size_t max_pipelines;
807
808     /* The default read buffer length to use (0 means not set) */
809     size_t default_read_buf_len;
810
811 # ifndef OPENSSL_NO_ENGINE
812     /*
813      * Engine to pass requests for client certs to
814      */
815     ENGINE *client_cert_engine;
816 # endif
817
818     /* Early callback.  Mostly for extensions, but not entirely. */
819     SSL_early_cb_fn early_cb;
820     void *early_cb_arg;
821
822     /* TLS extensions. */
823     struct {
824         /* TLS extensions servername callback */
825         int (*servername_cb) (SSL *, int *, void *);
826         void *servername_arg;
827         /* RFC 4507 session ticket keys */
828         unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
829         unsigned char tick_hmac_key[32];
830         unsigned char tick_aes_key[32];
831         /* Callback to support customisation of ticket key setting */
832         int (*ticket_key_cb) (SSL *ssl,
833                               unsigned char *name, unsigned char *iv,
834                               EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
835
836         /* certificate status request info */
837         /* Callback for status request */
838         int (*status_cb) (SSL *ssl, void *arg);
839         void *status_arg;
840         /* ext status type used for CSR extension (OCSP Stapling) */
841         int status_type;
842
843 # ifndef OPENSSL_NO_EC
844         /* EC extension values inherited by SSL structure */
845         size_t ecpointformats_len;
846         unsigned char *ecpointformats;
847         size_t supportedgroups_len;
848         unsigned char *supportedgroups;
849 # endif                         /* OPENSSL_NO_EC */
850
851         /*
852          * ALPN information (we are in the process of transitioning from NPN to
853          * ALPN.)
854          */
855
856         /*-
857          * For a server, this contains a callback function that allows the
858          * server to select the protocol for the connection.
859          *   out: on successful return, this must point to the raw protocol
860          *        name (without the length prefix).
861          *   outlen: on successful return, this contains the length of |*out|.
862          *   in: points to the client's list of supported protocols in
863          *       wire-format.
864          *   inlen: the length of |in|.
865          */
866         int (*alpn_select_cb) (SSL *s,
867                                const unsigned char **out,
868                                unsigned char *outlen,
869                                const unsigned char *in,
870                                unsigned int inlen, void *arg);
871         void *alpn_select_cb_arg;
872
873         /*
874          * For a client, this contains the list of supported protocols in wire
875          * format.
876          */
877         unsigned char *alpn;
878         size_t alpn_len;
879
880 # ifndef OPENSSL_NO_NEXTPROTONEG
881         /* Next protocol negotiation information */
882
883         /*
884          * For a server, this contains a callback function by which the set of
885          * advertised protocols can be provided.
886          */
887         SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
888         void *npn_advertised_cb_arg;
889         /*
890          * For a client, this contains a callback function that selects the next
891          * protocol from the list provided by the server.
892          */
893         SSL_CTX_npn_select_cb_func npn_select_cb;
894         void *npn_select_cb_arg;
895 # endif
896     } ext;
897
898 # ifndef OPENSSL_NO_PSK
899     SSL_psk_client_cb_func psk_client_callback;
900     SSL_psk_server_cb_func psk_server_callback;
901 # endif
902
903 # ifndef OPENSSL_NO_SRP
904     SRP_CTX srp_ctx;            /* ctx for SRP authentication */
905 # endif
906
907     /* Shared DANE context */
908     struct dane_ctx_st dane;
909
910     /* SRTP profiles we are willing to do from RFC 5764 */
911     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
912     /*
913      * Callback for disabling session caching and ticket support on a session
914      * basis, depending on the chosen cipher.
915      */
916     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
917
918     CRYPTO_RWLOCK *lock;
919
920     /*
921      * Callback for logging key material for use with debugging tools like
922      * Wireshark. The callback should log `line` followed by a newline.
923      */
924     SSL_CTX_keylog_cb_func keylog_callback;
925 };
926
927 struct ssl_st {
928     /*
929      * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
930      * DTLS1_VERSION)
931      */
932     int version;
933     /* SSLv3 */
934     const SSL_METHOD *method;
935     /*
936      * There are 2 BIO's even though they are normally both the same.  This
937      * is so data can be read and written to different handlers
938      */
939     /* used by SSL_read */
940     BIO *rbio;
941     /* used by SSL_write */
942     BIO *wbio;
943     /* used during session-id reuse to concatenate messages */
944     BIO *bbio;
945     /*
946      * This holds a variable that indicates what we were doing when a 0 or -1
947      * is returned.  This is needed for non-blocking IO so we know what
948      * request needs re-doing when in SSL_accept or SSL_connect
949      */
950     int rwstate;
951     int (*handshake_func) (SSL *);
952     /*
953      * Imagine that here's a boolean member "init" that is switched as soon
954      * as SSL_set_{accept/connect}_state is called for the first time, so
955      * that "state" and "handshake_func" are properly initialized.  But as
956      * handshake_func is == 0 until then, we use this test instead of an
957      * "init" member.
958      */
959     /* are we the server side? */
960     int server;
961     /*
962      * Generate a new session or reuse an old one.
963      * NB: For servers, the 'new' session may actually be a previously
964      * cached session or even the previous session unless
965      * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
966      */
967     int new_session;
968     /* don't send shutdown packets */
969     int quiet_shutdown;
970     /* we have shut things down, 0x01 sent, 0x02 for received */
971     int shutdown;
972     /* where we are */
973     OSSL_STATEM statem;
974     BUF_MEM *init_buf;          /* buffer used during init */
975     void *init_msg;             /* pointer to handshake message body, set by
976                                  * ssl3_get_message() */
977     size_t init_num;               /* amount read/written */
978     size_t init_off;               /* amount read/written */
979     struct ssl3_state_st *s3;   /* SSLv3 variables */
980     struct dtls1_state_st *d1;  /* DTLSv1 variables */
981     /* callback that allows applications to peek at protocol messages */
982     void (*msg_callback) (int write_p, int version, int content_type,
983                           const void *buf, size_t len, SSL *ssl, void *arg);
984     void *msg_callback_arg;
985     int hit;                    /* reusing a previous session */
986     X509_VERIFY_PARAM *param;
987     /* Per connection DANE state */
988     SSL_DANE dane;
989     /* crypto */
990     STACK_OF(SSL_CIPHER) *cipher_list;
991     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
992     /*
993      * These are the ones being used, the ones in SSL_SESSION are the ones to
994      * be 'copied' into these ones
995      */
996     uint32_t mac_flags;
997     /*
998      * The TLS1.3 secrets. The resumption master secret is stored in the
999      * session.
1000      */
1001     unsigned char early_secret[EVP_MAX_MD_SIZE];
1002     unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1003     unsigned char master_secret[EVP_MAX_MD_SIZE];
1004     unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1005     unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1006     unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1007     unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1008     unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1009     EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1010     unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1011     EVP_MD_CTX *read_hash;      /* used for mac generation */
1012     COMP_CTX *compress;         /* compression */
1013     COMP_CTX *expand;           /* uncompress */
1014     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1015     unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1016     EVP_MD_CTX *write_hash;     /* used for mac generation */
1017     /* Count of how many KeyUpdate messages we have received */
1018     unsigned int key_update_count;
1019     /* session info */
1020     /* client cert? */
1021     /* This is used to hold the server certificate used */
1022     struct cert_st /* CERT */ *cert;
1023
1024     /*
1025      * The hash of all messages prior to the CertificateVerify, and the length
1026      * of that hash.
1027      */
1028     unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1029     size_t cert_verify_hash_len;
1030
1031     /* Flag to indicate whether we should send a HelloRetryRequest or not */
1032     int hello_retry_request;
1033
1034     /*
1035      * the session_id_context is used to ensure sessions are only reused in
1036      * the appropriate context
1037      */
1038     size_t sid_ctx_length;
1039     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1040     /* This can also be in the session once a session is established */
1041     SSL_SESSION *session;
1042     /* Default generate session ID callback. */
1043     GEN_SESSION_CB generate_session_id;
1044     /* Used in SSL3 */
1045     /*
1046      * 0 don't care about verify failure.
1047      * 1 fail if verify fails
1048      */
1049     uint32_t verify_mode;
1050     /* fail if callback returns 0 */
1051     int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1052     /* optional informational callback */
1053     void (*info_callback) (const SSL *ssl, int type, int val);
1054     /* error bytes to be written */
1055     int error;
1056     /* actual code */
1057     int error_code;
1058 # ifndef OPENSSL_NO_PSK
1059     SSL_psk_client_cb_func psk_client_callback;
1060     SSL_psk_server_cb_func psk_server_callback;
1061 # endif
1062     SSL_CTX *ctx;
1063     /* Verified chain of peer */
1064     STACK_OF(X509) *verified_chain;
1065     long verify_result;
1066     /* extra application data */
1067     CRYPTO_EX_DATA ex_data;
1068     /* for server side, keep the list of CA_dn we can use */
1069     STACK_OF(X509_NAME) *client_CA;
1070     CRYPTO_REF_COUNT references;
1071     /* protocol behaviour */
1072     uint32_t options;
1073     /* API behaviour */
1074     uint32_t mode;
1075     int min_proto_version;
1076     int max_proto_version;
1077     size_t max_cert_list;
1078     int first_packet;
1079     /*
1080      * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1081      * secret and SSLv3/TLS (<=1.2) rollback check
1082      */
1083     int client_version;
1084     /*
1085      * If we're using more than one pipeline how should we divide the data
1086      * up between the pipes?
1087      */
1088     size_t split_send_fragment;
1089     /*
1090      * Maximum amount of data to send in one fragment. actual record size can
1091      * be more than this due to padding and MAC overheads.
1092      */
1093     size_t max_send_fragment;
1094     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1095     size_t max_pipelines;
1096
1097     struct {
1098         /* TLS extension debug callback */
1099         void (*debug_cb)(SSL *s, int client_server, int type,
1100                          const unsigned char *data, int len, void *arg);
1101         void *debug_arg;
1102         char *hostname;
1103         /* certificate status request info */
1104         /* Status type or -1 if no status type */
1105         int status_type;
1106         /* Raw extension data, if seen */
1107         unsigned char *scts;
1108         /* Length of raw extension data, if seen */
1109         uint16_t scts_len;
1110         /* Expect OCSP CertificateStatus message */
1111         int status_expected;
1112
1113         struct {
1114             /* OCSP status request only */
1115             STACK_OF(OCSP_RESPID) *ids;
1116             X509_EXTENSIONS *exts;
1117             /* OCSP response received or to be sent */
1118             unsigned char *resp;
1119             size_t resp_len;
1120         } ocsp;
1121
1122         /* RFC4507 session ticket expected to be received or sent */
1123         int ticket_expected;
1124 # ifndef OPENSSL_NO_EC
1125         size_t ecpointformats_len;
1126         /* our list */
1127         unsigned char *ecpointformats;
1128         size_t supportedgroups_len;
1129         /* our list */
1130         unsigned char *supportedgroups;
1131 # endif                         /* OPENSSL_NO_EC */
1132         /* TLS Session Ticket extension override */
1133         TLS_SESSION_TICKET_EXT *session_ticket;
1134         /* TLS Session Ticket extension callback */
1135         tls_session_ticket_ext_cb_fn session_ticket_cb;
1136         void *session_ticket_cb_arg;
1137         /* TLS pre-shared secret session resumption */
1138         tls_session_secret_cb_fn session_secret_cb;
1139         void *session_secret_cb_arg;
1140         /*
1141          * For a client, this contains the list of supported protocols in wire
1142          * format.
1143          */
1144         unsigned char *alpn;
1145         size_t alpn_len;
1146         /*
1147          * Next protocol negotiation. For the client, this is the protocol that
1148          * we sent in NextProtocol and is set when handling ServerHello
1149          * extensions. For a server, this is the client's selected_protocol from
1150          * NextProtocol and is set when handling the NextProtocol message, before
1151          * the Finished message.
1152          */
1153         unsigned char *npn;
1154         size_t npn_len;
1155
1156         /* The available PSK key exchange modes */
1157         int psk_kex_mode;
1158
1159         /* Set to one if we have negotiated ETM */
1160         int use_etm;
1161     } ext;
1162
1163     /* Parsed form of the ClientHello, kept around across early_cb calls. */
1164     CLIENTHELLO_MSG *clienthello;
1165
1166     /*-
1167      * no further mod of servername
1168      * 0 : call the servername extension callback.
1169      * 1 : prepare 2, allow last ack just after in server callback.
1170      * 2 : don't call servername callback, no ack in server hello
1171      */
1172     int servername_done;
1173 # ifndef OPENSSL_NO_CT
1174     /*
1175      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1176      * If they are not, the connection should be aborted.
1177      */
1178     ssl_ct_validation_cb ct_validation_callback;
1179     /* User-supplied argument that is passed to the ct_validation_callback */
1180     void *ct_validation_callback_arg;
1181     /*
1182      * Consolidated stack of SCTs from all sources.
1183      * Lazily populated by CT_get_peer_scts(SSL*)
1184      */
1185     STACK_OF(SCT) *scts;
1186     /* Have we attempted to find/parse SCTs yet? */
1187     int scts_parsed;
1188 # endif
1189     SSL_CTX *session_ctx;       /* initial ctx, used to store sessions */
1190     /* What we'll do */
1191     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1192     /* What's been chosen */
1193     SRTP_PROTECTION_PROFILE *srtp_profile;
1194     /*-
1195      * 1 if we are renegotiating.
1196      * 2 if we are a server and are inside a handshake
1197      * (i.e. not just sending a HelloRequest)
1198      */
1199     int renegotiate;
1200     /* If sending a KeyUpdate is pending */
1201     int key_update;
1202 # ifndef OPENSSL_NO_SRP
1203     /* ctx for SRP authentication */
1204     SRP_CTX srp_ctx;
1205 # endif
1206     /*
1207      * Callback for disabling session caching and ticket support on a session
1208      * basis, depending on the chosen cipher.
1209      */
1210     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1211     RECORD_LAYER rlayer;
1212     /* Default password callback. */
1213     pem_password_cb *default_passwd_callback;
1214     /* Default password callback user data. */
1215     void *default_passwd_callback_userdata;
1216     /* Async Job info */
1217     ASYNC_JOB *job;
1218     ASYNC_WAIT_CTX *waitctx;
1219     size_t asyncrw;
1220
1221     CRYPTO_RWLOCK *lock;
1222 };
1223
1224 /*
1225  * Structure containing table entry of values associated with the signature
1226  * algorithms (signature scheme) extension
1227 */
1228 typedef struct sigalg_lookup_st {
1229     /* TLS 1.3 signature scheme name */
1230     const char *name;
1231     /* Raw value used in extension */
1232     uint16_t sigalg;
1233     /* NID of hash algorithm */
1234     int hash;
1235     /* Index of hash algorithm */
1236     int hash_idx;
1237     /* NID of signature algorithm */
1238     int sig;
1239     /* Index of signature algorithm */
1240     int sig_idx;
1241     /* Combined hash and signature NID, if any */
1242     int sigandhash;
1243     /* Required public key curve (ECDSA only) */
1244     int curve;
1245 } SIGALG_LOOKUP;
1246
1247 typedef struct cert_pkey_st CERT_PKEY;
1248
1249 typedef struct ssl3_state_st {
1250     long flags;
1251     size_t read_mac_secret_size;
1252     unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1253     size_t write_mac_secret_size;
1254     unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1255     unsigned char server_random[SSL3_RANDOM_SIZE];
1256     unsigned char client_random[SSL3_RANDOM_SIZE];
1257     /* flags for countermeasure against known-IV weakness */
1258     int need_empty_fragments;
1259     int empty_fragment_done;
1260     /* used during startup, digest all incoming/outgoing packets */
1261     BIO *handshake_buffer;
1262     /*
1263      * When handshake digest is determined, buffer is hashed and
1264      * freed and MD_CTX for the required digest is stored here.
1265      */
1266     EVP_MD_CTX *handshake_dgst;
1267     /*
1268      * Set whenever an expected ChangeCipherSpec message is processed.
1269      * Unset when the peer's Finished message is received.
1270      * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1271      */
1272     int change_cipher_spec;
1273     int warn_alert;
1274     int fatal_alert;
1275     /*
1276      * we allow one fatal and one warning alert to be outstanding, send close
1277      * alert via the warning alert
1278      */
1279     int alert_dispatch;
1280     unsigned char send_alert[2];
1281     /*
1282      * This flag is set when we should renegotiate ASAP, basically when there
1283      * is no more data in the read or write buffers
1284      */
1285     int renegotiate;
1286     int total_renegotiations;
1287     int num_renegotiations;
1288     int in_read_app_data;
1289     struct {
1290         /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1291         unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1292         size_t finish_md_len;
1293         unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1294         size_t peer_finish_md_len;
1295         size_t message_size;
1296         int message_type;
1297         /* used to hold the new cipher we are going to use */
1298         const SSL_CIPHER *new_cipher;
1299 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1300         EVP_PKEY *pkey;         /* holds short lived DH/ECDH key */
1301 # endif
1302         /* used for certificate requests */
1303         int cert_req;
1304         /* Certificate types in certificate request message. */
1305         uint8_t *ctype;
1306         size_t ctype_len;
1307         STACK_OF(X509_NAME) *ca_names;
1308         size_t key_block_length;
1309         unsigned char *key_block;
1310         const EVP_CIPHER *new_sym_enc;
1311         const EVP_MD *new_hash;
1312         int new_mac_pkey_type;
1313         size_t new_mac_secret_size;
1314 # ifndef OPENSSL_NO_COMP
1315         const SSL_COMP *new_compression;
1316 # else
1317         char *new_compression;
1318 # endif
1319         int cert_request;
1320         /* Raw values of the cipher list from a client */
1321         unsigned char *ciphers_raw;
1322         size_t ciphers_rawlen;
1323         /* Temporary storage for premaster secret */
1324         unsigned char *pms;
1325         size_t pmslen;
1326 # ifndef OPENSSL_NO_PSK
1327         /* Temporary storage for PSK key */
1328         unsigned char *psk;
1329         size_t psklen;
1330 # endif
1331         /* Signature algorithm we actually use */
1332         const SIGALG_LOOKUP *sigalg;
1333         /* Pointer to certificate we use */
1334         CERT_PKEY *cert;
1335         /*
1336          * signature algorithms peer reports: e.g. supported signature
1337          * algorithms extension for server or as part of a certificate
1338          * request for client.
1339          */
1340         uint16_t *peer_sigalgs;
1341         /* Size of above array */
1342         size_t peer_sigalgslen;
1343         /* Sigalg peer actualy uses */
1344         const SIGALG_LOOKUP *peer_sigalg;
1345         /*
1346          * Set if corresponding CERT_PKEY can be used with current
1347          * SSL session: e.g. appropriate curve, signature algorithms etc.
1348          * If zero it can't be used at all.
1349          */
1350         uint32_t valid_flags[SSL_PKEY_NUM];
1351         /*
1352          * For servers the following masks are for the key and auth algorithms
1353          * that are supported by the certs below. For clients they are masks of
1354          * *disabled* algorithms based on the current session.
1355          */
1356         uint32_t mask_k;
1357         uint32_t mask_a;
1358         /*
1359          * The following are used by the client to see if a cipher is allowed or
1360          * not.  It contains the minimum and maximum version the client's using
1361          * based on what it knows so far.
1362          */
1363         int min_ver;
1364         int max_ver;
1365     } tmp;
1366
1367     /* Connection binding to prevent renegotiation attacks */
1368     unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1369     size_t previous_client_finished_len;
1370     unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1371     size_t previous_server_finished_len;
1372     int send_connection_binding; /* TODOEKR */
1373
1374 # ifndef OPENSSL_NO_NEXTPROTONEG
1375     /*
1376      * Set if we saw the Next Protocol Negotiation extension from our peer.
1377      */
1378     int npn_seen;
1379 # endif
1380
1381     /*
1382      * ALPN information (we are in the process of transitioning from NPN to
1383      * ALPN.)
1384      */
1385
1386     /*
1387      * In a server these point to the selected ALPN protocol after the
1388      * ClientHello has been processed. In a client these contain the protocol
1389      * that the server selected once the ServerHello has been processed.
1390      */
1391     unsigned char *alpn_selected;
1392     size_t alpn_selected_len;
1393     /* used by the server to know what options were proposed */
1394     unsigned char *alpn_proposed;
1395     size_t alpn_proposed_len;
1396     /* used by the client to know if it actually sent alpn */
1397     int alpn_sent;
1398
1399 # ifndef OPENSSL_NO_EC
1400     /*
1401      * This is set to true if we believe that this is a version of Safari
1402      * running on OS X 10.6 or newer. We wish to know this because Safari on
1403      * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1404      */
1405     char is_probably_safari;
1406 # endif                         /* !OPENSSL_NO_EC */
1407
1408     /* For clients: peer temporary key */
1409 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1410     /* The group_id for the DH/ECDH key */
1411     unsigned int group_id;
1412     EVP_PKEY *peer_tmp;
1413 # endif
1414
1415 } SSL3_STATE;
1416
1417 /* DTLS structures */
1418
1419 # ifndef OPENSSL_NO_SCTP
1420 #  define DTLS1_SCTP_AUTH_LABEL   "EXPORTER_DTLS_OVER_SCTP"
1421 # endif
1422
1423 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1424 # define DTLS1_MAX_MTU_OVERHEAD                   48
1425
1426 /*
1427  * Flag used in message reuse to indicate the buffer contains the record
1428  * header as well as the the handshake message header.
1429  */
1430 # define DTLS1_SKIP_RECORD_HEADER                 2
1431
1432 struct dtls1_retransmit_state {
1433     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1434     EVP_MD_CTX *write_hash;     /* used for mac generation */
1435     COMP_CTX *compress;         /* compression */
1436     SSL_SESSION *session;
1437     unsigned short epoch;
1438 };
1439
1440 struct hm_header_st {
1441     unsigned char type;
1442     size_t msg_len;
1443     unsigned short seq;
1444     size_t frag_off;
1445     size_t frag_len;
1446     unsigned int is_ccs;
1447     struct dtls1_retransmit_state saved_retransmit_state;
1448 };
1449
1450 struct dtls1_timeout_st {
1451     /* Number of read timeouts so far */
1452     unsigned int read_timeouts;
1453     /* Number of write timeouts so far */
1454     unsigned int write_timeouts;
1455     /* Number of alerts received so far */
1456     unsigned int num_alerts;
1457 };
1458
1459 typedef struct hm_fragment_st {
1460     struct hm_header_st msg_header;
1461     unsigned char *fragment;
1462     unsigned char *reassembly;
1463 } hm_fragment;
1464
1465 typedef struct pqueue_st pqueue;
1466 typedef struct pitem_st pitem;
1467
1468 struct pitem_st {
1469     unsigned char priority[8];  /* 64-bit value in big-endian encoding */
1470     void *data;
1471     pitem *next;
1472 };
1473
1474 typedef struct pitem_st *piterator;
1475
1476 pitem *pitem_new(unsigned char *prio64be, void *data);
1477 void pitem_free(pitem *item);
1478 pqueue *pqueue_new(void);
1479 void pqueue_free(pqueue *pq);
1480 pitem *pqueue_insert(pqueue *pq, pitem *item);
1481 pitem *pqueue_peek(pqueue *pq);
1482 pitem *pqueue_pop(pqueue *pq);
1483 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1484 pitem *pqueue_iterator(pqueue *pq);
1485 pitem *pqueue_next(piterator *iter);
1486 size_t pqueue_size(pqueue *pq);
1487
1488 typedef struct dtls1_state_st {
1489     unsigned char cookie[DTLS1_COOKIE_LENGTH];
1490     size_t cookie_len;
1491     unsigned int cookie_verified;
1492     /* handshake message numbers */
1493     unsigned short handshake_write_seq;
1494     unsigned short next_handshake_write_seq;
1495     unsigned short handshake_read_seq;
1496     /* Buffered handshake messages */
1497     pqueue *buffered_messages;
1498     /* Buffered (sent) handshake records */
1499     pqueue *sent_messages;
1500     size_t link_mtu;      /* max on-the-wire DTLS packet size */
1501     size_t mtu;           /* max DTLS packet size */
1502     struct hm_header_st w_msg_hdr;
1503     struct hm_header_st r_msg_hdr;
1504     struct dtls1_timeout_st timeout;
1505     /*
1506      * Indicates when the last handshake msg sent will timeout
1507      */
1508     struct timeval next_timeout;
1509     /* Timeout duration */
1510     unsigned short timeout_duration;
1511     unsigned int retransmitting;
1512 # ifndef OPENSSL_NO_SCTP
1513     int shutdown_received;
1514 # endif
1515 } DTLS1_STATE;
1516
1517 # ifndef OPENSSL_NO_EC
1518 /*
1519  * From ECC-TLS draft, used in encoding the curve type in ECParameters
1520  */
1521 #  define EXPLICIT_PRIME_CURVE_TYPE  1
1522 #  define EXPLICIT_CHAR2_CURVE_TYPE  2
1523 #  define NAMED_CURVE_TYPE           3
1524 # endif                         /* OPENSSL_NO_EC */
1525
1526 struct cert_pkey_st {
1527     X509 *x509;
1528     EVP_PKEY *privatekey;
1529     /* Chain for this certificate */
1530     STACK_OF(X509) *chain;
1531     /*-
1532      * serverinfo data for this certificate.  The data is in TLS Extension
1533      * wire format, specifically it's a series of records like:
1534      *   uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1535      *   uint16_t length;
1536      *   uint8_t data[length];
1537      */
1538     unsigned char *serverinfo;
1539     size_t serverinfo_length;
1540 };
1541 /* Retrieve Suite B flags */
1542 # define tls1_suiteb(s)  (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1543 /* Uses to check strict mode: suite B modes are always strict */
1544 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1545         (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1546
1547 typedef struct {
1548     unsigned short ext_type;
1549     /*
1550      * Per-connection flags relating to this extension type: not used if
1551      * part of an SSL_CTX structure.
1552      */
1553     uint32_t ext_flags;
1554     custom_ext_add_cb add_cb;
1555     custom_ext_free_cb free_cb;
1556     void *add_arg;
1557     custom_ext_parse_cb parse_cb;
1558     void *parse_arg;
1559 } custom_ext_method;
1560
1561 /* ext_flags values */
1562
1563 /*
1564  * Indicates an extension has been received. Used to check for unsolicited or
1565  * duplicate extensions.
1566  */
1567 # define SSL_EXT_FLAG_RECEIVED   0x1
1568 /*
1569  * Indicates an extension has been sent: used to enable sending of
1570  * corresponding ServerHello extension.
1571  */
1572 # define SSL_EXT_FLAG_SENT       0x2
1573
1574 typedef struct {
1575     custom_ext_method *meths;
1576     size_t meths_count;
1577 } custom_ext_methods;
1578
1579 typedef struct cert_st {
1580     /* Current active set */
1581     /*
1582      * ALWAYS points to an element of the pkeys array
1583      * Probably it would make more sense to store
1584      * an index, not a pointer.
1585      */
1586     CERT_PKEY *key;
1587 # ifndef OPENSSL_NO_DH
1588     EVP_PKEY *dh_tmp;
1589     DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1590     int dh_tmp_auto;
1591 # endif
1592     /* Flags related to certificates */
1593     uint32_t cert_flags;
1594     CERT_PKEY pkeys[SSL_PKEY_NUM];
1595     /* Custom certificate types sent in certificate request message. */
1596     uint8_t *ctype;
1597     size_t ctype_len;
1598     /*
1599      * supported signature algorithms. When set on a client this is sent in
1600      * the client hello as the supported signature algorithms extension. For
1601      * servers it represents the signature algorithms we are willing to use.
1602      */
1603     uint16_t *conf_sigalgs;
1604     /* Size of above array */
1605     size_t conf_sigalgslen;
1606     /*
1607      * Client authentication signature algorithms, if not set then uses
1608      * conf_sigalgs. On servers these will be the signature algorithms sent
1609      * to the client in a certificate request for TLS 1.2. On a client this
1610      * represents the signature algorithms we are willing to use for client
1611      * authentication.
1612      */
1613     uint16_t *client_sigalgs;
1614     /* Size of above array */
1615     size_t client_sigalgslen;
1616     /*
1617      * Signature algorithms shared by client and server: cached because these
1618      * are used most often.
1619      */
1620     const SIGALG_LOOKUP **shared_sigalgs;
1621     size_t shared_sigalgslen;
1622     /*
1623      * Certificate setup callback: if set is called whenever a certificate
1624      * may be required (client or server). the callback can then examine any
1625      * appropriate parameters and setup any certificates required. This
1626      * allows advanced applications to select certificates on the fly: for
1627      * example based on supported signature algorithms or curves.
1628      */
1629     int (*cert_cb) (SSL *ssl, void *arg);
1630     void *cert_cb_arg;
1631     /*
1632      * Optional X509_STORE for chain building or certificate validation If
1633      * NULL the parent SSL_CTX store is used instead.
1634      */
1635     X509_STORE *chain_store;
1636     X509_STORE *verify_store;
1637     /* Custom extension methods for server and client */
1638     custom_ext_methods cli_ext;
1639     custom_ext_methods srv_ext;
1640     /* Security callback */
1641     int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1642                    void *other, void *ex);
1643     /* Security level */
1644     int sec_level;
1645     void *sec_ex;
1646 # ifndef OPENSSL_NO_PSK
1647     /* If not NULL psk identity hint to use for servers */
1648     char *psk_identity_hint;
1649 # endif
1650     CRYPTO_REF_COUNT references;             /* >1 only if SSL_copy_session_id is used */
1651     CRYPTO_RWLOCK *lock;
1652 } CERT;
1653
1654 # define FP_ICC  (int (*)(const void *,const void *))
1655
1656 /*
1657  * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1658  * of a mess of functions, but hell, think of it as an opaque structure :-)
1659  */
1660 typedef struct ssl3_enc_method {
1661     int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1662     int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1663     int (*setup_key_block) (SSL *);
1664     int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1665                                    size_t, size_t *);
1666     int (*change_cipher_state) (SSL *, int);
1667     size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1668     const char *client_finished_label;
1669     size_t client_finished_label_len;
1670     const char *server_finished_label;
1671     size_t server_finished_label_len;
1672     int (*alert_value) (int);
1673     int (*export_keying_material) (SSL *, unsigned char *, size_t,
1674                                    const char *, size_t,
1675                                    const unsigned char *, size_t,
1676                                    int use_context);
1677     /* Various flags indicating protocol version requirements */
1678     uint32_t enc_flags;
1679     /* Set the handshake header */
1680     int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1681     /* Close construction of the handshake message */
1682     int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1683     /* Write out handshake message */
1684     int (*do_write) (SSL *s);
1685 } SSL3_ENC_METHOD;
1686
1687 # define ssl_set_handshake_header(s, pkt, htype) \
1688         s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1689 # define ssl_close_construct_packet(s, pkt, htype) \
1690         s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1691 # define ssl_do_write(s)  s->method->ssl3_enc->do_write(s)
1692
1693 /* Values for enc_flags */
1694
1695 /* Uses explicit IV for CBC mode */
1696 # define SSL_ENC_FLAG_EXPLICIT_IV        0x1
1697 /* Uses signature algorithms extension */
1698 # define SSL_ENC_FLAG_SIGALGS            0x2
1699 /* Uses SHA256 default PRF */
1700 # define SSL_ENC_FLAG_SHA256_PRF         0x4
1701 /* Is DTLS */
1702 # define SSL_ENC_FLAG_DTLS               0x8
1703 /*
1704  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1705  * apply to others in future.
1706  */
1707 # define SSL_ENC_FLAG_TLS1_2_CIPHERS     0x10
1708
1709 # ifndef OPENSSL_NO_COMP
1710 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1711 typedef struct ssl3_comp_st {
1712     int comp_id;                /* The identifier byte for this compression
1713                                  * type */
1714     char *name;                 /* Text name used for the compression type */
1715     COMP_METHOD *method;        /* The method :-) */
1716 } SSL3_COMP;
1717 # endif
1718
1719 /*
1720  * Extension index values NOTE: Any updates to these defines should be mirrored
1721  * with equivalent updates to ext_defs in extensions.c
1722  */
1723 typedef enum tlsext_index_en {
1724     TLSEXT_IDX_renegotiate,
1725     TLSEXT_IDX_server_name,
1726     TLSEXT_IDX_srp,
1727     TLSEXT_IDX_ec_point_formats,
1728     TLSEXT_IDX_supported_groups,
1729     TLSEXT_IDX_session_ticket,
1730     TLSEXT_IDX_signature_algorithms,
1731     TLSEXT_IDX_status_request,
1732     TLSEXT_IDX_next_proto_neg,
1733     TLSEXT_IDX_application_layer_protocol_negotiation,
1734     TLSEXT_IDX_use_srtp,
1735     TLSEXT_IDX_encrypt_then_mac,
1736     TLSEXT_IDX_signed_certificate_timestamp,
1737     TLSEXT_IDX_extended_master_secret,
1738     TLSEXT_IDX_supported_versions,
1739     TLSEXT_IDX_psk_kex_modes,
1740     TLSEXT_IDX_key_share,
1741     TLSEXT_IDX_cryptopro_bug,
1742     TLSEXT_IDX_padding,
1743     TLSEXT_IDX_psk
1744 } TLSEXT_INDEX;
1745
1746 /*
1747  * Dummy status type for the status_type extension. Indicates no status type
1748  * set
1749  */
1750 #define TLSEXT_STATUSTYPE_nothing  -1
1751
1752 /* Sigalgs values */
1753 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256                    0x0403
1754 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384                    0x0503
1755 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512                    0x0603
1756 #define TLSEXT_SIGALG_ecdsa_sha1                                0x0203
1757 #define TLSEXT_SIGALG_rsa_pss_sha256                            0x0804
1758 #define TLSEXT_SIGALG_rsa_pss_sha384                            0x0805
1759 #define TLSEXT_SIGALG_rsa_pss_sha512                            0x0806
1760 #define TLSEXT_SIGALG_rsa_pkcs1_sha256                          0x0401
1761 #define TLSEXT_SIGALG_rsa_pkcs1_sha384                          0x0501
1762 #define TLSEXT_SIGALG_rsa_pkcs1_sha512                          0x0601
1763 #define TLSEXT_SIGALG_rsa_pkcs1_sha1                            0x0201
1764 #define TLSEXT_SIGALG_dsa_sha256                                0x0402
1765 #define TLSEXT_SIGALG_dsa_sha384                                0x0502
1766 #define TLSEXT_SIGALG_dsa_sha512                                0x0602
1767 #define TLSEXT_SIGALG_dsa_sha1                                  0x0202
1768 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256       0xeeee
1769 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512       0xefef
1770 #define TLSEXT_SIGALG_gostr34102001_gostr3411                   0xeded
1771
1772 /* Known PSK key exchange modes */
1773 #define TLSEXT_KEX_MODE_KE                                      0x00
1774 #define TLSEXT_KEX_MODE_KE_DHE                                  0x01
1775
1776 /*
1777  * Internal representations of key exchange modes
1778  */
1779 #define TLSEXT_KEX_MODE_FLAG_NONE                               0
1780 #define TLSEXT_KEX_MODE_FLAG_KE                                 1
1781 #define TLSEXT_KEX_MODE_FLAG_KE_DHE                             2
1782
1783 /* An invalid index into the TLSv1.3 PSK identities */
1784 #define TLSEXT_PSK_BAD_IDENTITY                                 -1
1785
1786 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1787                         s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1788
1789 /* A dummy signature value not valid for TLSv1.2 signature algs */
1790 #define TLSEXT_signature_rsa_pss                                0x0101
1791
1792
1793 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1794
1795 __owur const SSL_METHOD *ssl_bad_method(int ver);
1796 __owur const SSL_METHOD *sslv3_method(void);
1797 __owur const SSL_METHOD *sslv3_server_method(void);
1798 __owur const SSL_METHOD *sslv3_client_method(void);
1799 __owur const SSL_METHOD *tlsv1_method(void);
1800 __owur const SSL_METHOD *tlsv1_server_method(void);
1801 __owur const SSL_METHOD *tlsv1_client_method(void);
1802 __owur const SSL_METHOD *tlsv1_1_method(void);
1803 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1804 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1805 __owur const SSL_METHOD *tlsv1_2_method(void);
1806 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1807 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1808 __owur const SSL_METHOD *tlsv1_3_method(void);
1809 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1810 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1811 __owur const SSL_METHOD *dtlsv1_method(void);
1812 __owur const SSL_METHOD *dtlsv1_server_method(void);
1813 __owur const SSL_METHOD *dtlsv1_client_method(void);
1814 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1815 __owur const SSL_METHOD *dtlsv1_2_method(void);
1816 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1817 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1818
1819 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1820 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1821 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1822 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1823 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1824 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1825 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1826
1827 /*
1828  * Flags for SSL methods
1829  */
1830 # define SSL_METHOD_NO_FIPS      (1U<<0)
1831 # define SSL_METHOD_NO_SUITEB    (1U<<1)
1832
1833 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1834                                  s_connect, enc_data) \
1835 const SSL_METHOD *func_name(void)  \
1836         { \
1837         static const SSL_METHOD func_name##_data= { \
1838                 version, \
1839                 flags, \
1840                 mask, \
1841                 tls1_new, \
1842                 tls1_clear, \
1843                 tls1_free, \
1844                 s_accept, \
1845                 s_connect, \
1846                 ssl3_read, \
1847                 ssl3_peek, \
1848                 ssl3_write, \
1849                 ssl3_shutdown, \
1850                 ssl3_renegotiate, \
1851                 ssl3_renegotiate_check, \
1852                 ssl3_read_bytes, \
1853                 ssl3_write_bytes, \
1854                 ssl3_dispatch_alert, \
1855                 ssl3_ctrl, \
1856                 ssl3_ctx_ctrl, \
1857                 ssl3_get_cipher_by_char, \
1858                 ssl3_put_cipher_by_char, \
1859                 ssl3_pending, \
1860                 ssl3_num_ciphers, \
1861                 ssl3_get_cipher, \
1862                 tls1_default_timeout, \
1863                 &enc_data, \
1864                 ssl_undefined_void_function, \
1865                 ssl3_callback_ctrl, \
1866                 ssl3_ctx_callback_ctrl, \
1867         }; \
1868         return &func_name##_data; \
1869         }
1870
1871 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1872 const SSL_METHOD *func_name(void)  \
1873         { \
1874         static const SSL_METHOD func_name##_data= { \
1875                 SSL3_VERSION, \
1876                 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1877                 SSL_OP_NO_SSLv3, \
1878                 ssl3_new, \
1879                 ssl3_clear, \
1880                 ssl3_free, \
1881                 s_accept, \
1882                 s_connect, \
1883                 ssl3_read, \
1884                 ssl3_peek, \
1885                 ssl3_write, \
1886                 ssl3_shutdown, \
1887                 ssl3_renegotiate, \
1888                 ssl3_renegotiate_check, \
1889                 ssl3_read_bytes, \
1890                 ssl3_write_bytes, \
1891                 ssl3_dispatch_alert, \
1892                 ssl3_ctrl, \
1893                 ssl3_ctx_ctrl, \
1894                 ssl3_get_cipher_by_char, \
1895                 ssl3_put_cipher_by_char, \
1896                 ssl3_pending, \
1897                 ssl3_num_ciphers, \
1898                 ssl3_get_cipher, \
1899                 ssl3_default_timeout, \
1900                 &SSLv3_enc_data, \
1901                 ssl_undefined_void_function, \
1902                 ssl3_callback_ctrl, \
1903                 ssl3_ctx_callback_ctrl, \
1904         }; \
1905         return &func_name##_data; \
1906         }
1907
1908 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
1909                                         s_connect, enc_data) \
1910 const SSL_METHOD *func_name(void)  \
1911         { \
1912         static const SSL_METHOD func_name##_data= { \
1913                 version, \
1914                 flags, \
1915                 mask, \
1916                 dtls1_new, \
1917                 dtls1_clear, \
1918                 dtls1_free, \
1919                 s_accept, \
1920                 s_connect, \
1921                 ssl3_read, \
1922                 ssl3_peek, \
1923                 ssl3_write, \
1924                 dtls1_shutdown, \
1925                 ssl3_renegotiate, \
1926                 ssl3_renegotiate_check, \
1927                 dtls1_read_bytes, \
1928                 dtls1_write_app_data_bytes, \
1929                 dtls1_dispatch_alert, \
1930                 dtls1_ctrl, \
1931                 ssl3_ctx_ctrl, \
1932                 ssl3_get_cipher_by_char, \
1933                 ssl3_put_cipher_by_char, \
1934                 ssl3_pending, \
1935                 ssl3_num_ciphers, \
1936                 ssl3_get_cipher, \
1937                 dtls1_default_timeout, \
1938                 &enc_data, \
1939                 ssl_undefined_void_function, \
1940                 ssl3_callback_ctrl, \
1941                 ssl3_ctx_callback_ctrl, \
1942         }; \
1943         return &func_name##_data; \
1944         }
1945
1946 struct openssl_ssl_test_functions {
1947     int (*p_ssl_init_wbio_buffer) (SSL *s);
1948     int (*p_ssl3_setup_buffers) (SSL *s);
1949 };
1950
1951 const char *ssl_protocol_to_string(int version);
1952
1953 /* Returns true if certificate and private key for 'idx' are present */
1954 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
1955 {
1956     if (idx < 0 || idx >= SSL_PKEY_NUM)
1957         return 0;
1958     return s->cert->pkeys[idx].x509 != NULL
1959         && s->cert->pkeys[idx].privatekey != NULL;
1960 }
1961
1962 # ifndef OPENSSL_UNIT_TEST
1963
1964 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
1965 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
1966 void ssl_clear_cipher_ctx(SSL *s);
1967 int ssl_clear_bad_session(SSL *s);
1968 __owur CERT *ssl_cert_new(void);
1969 __owur CERT *ssl_cert_dup(CERT *cert);
1970 void ssl_cert_clear_certs(CERT *c);
1971 void ssl_cert_free(CERT *c);
1972 __owur int ssl_get_new_session(SSL *s, int session);
1973 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
1974 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
1975 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1976 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
1977 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1978                                  const SSL_CIPHER *const *bp);
1979 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
1980                                                     STACK_OF(SSL_CIPHER) **pref,
1981                                                     STACK_OF(SSL_CIPHER)
1982                                                     **sorted,
1983                                                     const char *rule_str,
1984                                                     CERT *c);
1985 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites,
1986                                 int sslv2format, int *al);
1987 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
1988                                 STACK_OF(SSL_CIPHER) **skp,
1989                                 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
1990                                 int *al);
1991 void ssl_update_cache(SSL *s, int mode);
1992 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
1993                               const EVP_MD **md, int *mac_pkey_type,
1994                               size_t *mac_secret_size, SSL_COMP **comp,
1995                               int use_etm);
1996 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
1997                                    size_t *int_overhead, size_t *blocksize,
1998                                    size_t *ext_overhead);
1999 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2000 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2001                                                 const unsigned char *ptr,
2002                                                 int all);
2003 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2004 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2005 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2006 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2007 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2008 __owur int ssl_cert_set_current(CERT *c, long arg);
2009 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2010 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2011
2012 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2013 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2014 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2015                                    int ref);
2016
2017 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2018 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2019                             void *other);
2020
2021 int ssl_undefined_function(SSL *s);
2022 __owur int ssl_undefined_void_function(void);
2023 __owur int ssl_undefined_const_function(const SSL *s);
2024 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2025                                           const unsigned char **serverinfo,
2026                                           size_t *serverinfo_length);
2027 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2028 void ssl_set_masks(SSL *s);
2029 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2030 __owur int ssl_verify_alarm_type(long type);
2031 void ssl_sort_cipher_list(void);
2032 void ssl_load_ciphers(void);
2033 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2034                                  size_t len);
2035 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2036                                       int free_pms);
2037 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2038 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2039                       int genmaster);
2040 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2041
2042 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2043 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2044 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2045                                    size_t *len);
2046 int ssl3_init_finished_mac(SSL *s);
2047 __owur int ssl3_setup_key_block(SSL *s);
2048 __owur int ssl3_change_cipher_state(SSL *s, int which);
2049 void ssl3_cleanup_key_block(SSL *s);
2050 __owur int ssl3_do_write(SSL *s, int type);
2051 int ssl3_send_alert(SSL *s, int level, int desc);
2052 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2053                                        unsigned char *p, size_t len,
2054                                        size_t *secret_size);
2055 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2056 __owur int ssl3_num_ciphers(void);
2057 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2058 int ssl3_renegotiate(SSL *ssl);
2059 int ssl3_renegotiate_check(SSL *ssl, int initok);
2060 __owur int ssl3_dispatch_alert(SSL *s);
2061 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2062                                     unsigned char *p);
2063 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2064 void ssl3_free_digest_list(SSL *s);
2065 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2066                                             CERT_PKEY *cpk, int *al);
2067 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2068                                             STACK_OF(SSL_CIPHER) *clnt,
2069                                             STACK_OF(SSL_CIPHER) *srvr);
2070 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2071 __owur int ssl3_new(SSL *s);
2072 void ssl3_free(SSL *s);
2073 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2074 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2075 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2076 __owur int ssl3_shutdown(SSL *s);
2077 void ssl3_clear(SSL *s);
2078 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2079 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2080 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2081 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2082
2083 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2084 __owur long ssl3_default_timeout(void);
2085
2086 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2087 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2088 __owur int tls_setup_handshake(SSL *s);
2089 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2090 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2091 __owur int ssl3_handshake_write(SSL *s);
2092
2093 __owur int ssl_allow_compression(SSL *s);
2094
2095 __owur int ssl_version_supported(const SSL *s, int version);
2096
2097 __owur int ssl_set_client_hello_version(SSL *s);
2098 __owur int ssl_check_version_downgrade(SSL *s);
2099 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2100 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello);
2101 __owur int ssl_choose_client_version(SSL *s, int version);
2102 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
2103                                    int *max_version);
2104
2105 __owur long tls1_default_timeout(void);
2106 __owur int dtls1_do_write(SSL *s, int type);
2107 void dtls1_set_message_header(SSL *s,
2108                               unsigned char mt,
2109                               size_t len,
2110                               size_t frag_off, size_t frag_len);
2111
2112 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2113                                size_t *written);
2114
2115 __owur int dtls1_read_failed(SSL *s, int code);
2116 __owur int dtls1_buffer_message(SSL *s, int ccs);
2117 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2118 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2119 int dtls1_retransmit_buffered_messages(SSL *s);
2120 void dtls1_clear_received_buffer(SSL *s);
2121 void dtls1_clear_sent_buffer(SSL *s);
2122 void dtls1_get_message_header(unsigned char *data,
2123                               struct hm_header_st *msg_hdr);
2124 __owur long dtls1_default_timeout(void);
2125 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2126 __owur int dtls1_check_timeout_num(SSL *s);
2127 __owur int dtls1_handle_timeout(SSL *s);
2128 void dtls1_start_timer(SSL *s);
2129 void dtls1_stop_timer(SSL *s);
2130 __owur int dtls1_is_timer_expired(SSL *s);
2131 void dtls1_double_timeout(SSL *s);
2132 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2133                                          size_t cookie_len);
2134 __owur int dtls1_send_newsession_ticket(SSL *s);
2135 __owur size_t dtls1_min_mtu(SSL *s);
2136 void dtls1_hm_fragment_free(hm_fragment *frag);
2137 __owur int dtls1_query_mtu(SSL *s);
2138
2139 __owur int tls1_new(SSL *s);
2140 void tls1_free(SSL *s);
2141 void tls1_clear(SSL *s);
2142 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2143 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2144
2145 __owur int dtls1_new(SSL *s);
2146 void dtls1_free(SSL *s);
2147 void dtls1_clear(SSL *s);
2148 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2149 __owur int dtls1_shutdown(SSL *s);
2150
2151 __owur int dtls1_dispatch_alert(SSL *s);
2152
2153 __owur int ssl_init_wbio_buffer(SSL *s);
2154 void ssl_free_wbio_buffer(SSL *s);
2155
2156 __owur int tls1_change_cipher_state(SSL *s, int which);
2157 __owur int tls1_setup_key_block(SSL *s);
2158 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2159                                     unsigned char *p);
2160 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2161                                        unsigned char *p, size_t len,
2162                                        size_t *secret_size);
2163 __owur int tls13_setup_key_block(SSL *s);
2164 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2165                                      unsigned char *p);
2166 __owur int tls13_change_cipher_state(SSL *s, int which);
2167 __owur int tls13_update_key(SSL *s, int send);
2168 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2169                              const unsigned char *secret,
2170                              const unsigned char *label, size_t labellen,
2171                              const unsigned char *hash,
2172                              unsigned char *out, size_t outlen);
2173 __owur int tls13_derive_key(SSL *s, const unsigned char *secret,
2174                             unsigned char *key, size_t keylen);
2175 __owur int tls13_derive_iv(SSL *s, const unsigned char *secret,
2176                            unsigned char *iv, size_t ivlen);
2177 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2178                                     const unsigned char *secret,
2179                                     unsigned char *fin, size_t finlen);
2180 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2181                           const unsigned char *prevsecret,
2182                           const unsigned char *insecret,
2183                           size_t insecretlen,
2184                           unsigned char *outsecret);
2185 __owur int tls13_generate_handshake_secret(SSL *s,
2186                                            const unsigned char *insecret,
2187                                            size_t insecretlen);
2188 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2189                                         unsigned char *prev, size_t prevlen,
2190                                         size_t *secret_size);
2191 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2192                                        const char *label, size_t llen,
2193                                        const unsigned char *p, size_t plen,
2194                                        int use_context);
2195 __owur int tls1_alert_code(int code);
2196 __owur int tls13_alert_code(int code);
2197 __owur int ssl3_alert_code(int code);
2198
2199 #  ifndef OPENSSL_NO_EC
2200 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2201 #  endif
2202
2203 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2204
2205 #  ifndef OPENSSL_NO_EC
2206 /* Flags values from tls1_ec_curve_id2nid() */
2207 /* Mask for curve type */
2208 # define TLS_CURVE_TYPE          0x3
2209 # define TLS_CURVE_PRIME         0x0
2210 # define TLS_CURVE_CHAR2         0x1
2211 # define TLS_CURVE_CUSTOM        0x2
2212
2213 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2214
2215 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2216 __owur int tls1_ec_nid2curve_id(int nid);
2217 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2218 __owur int tls1_shared_group(SSL *s, int nmatch);
2219 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2220                            int *curves, size_t ncurves);
2221 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2222                                 const char *str);
2223 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2224                          size_t *num_formats);
2225 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2226 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2227 #  endif                        /* OPENSSL_NO_EC */
2228
2229 __owur int tls1_shared_list(SSL *s,
2230                             const unsigned char *l1, size_t l1len,
2231                             const unsigned char *l2, size_t l2len, int nmatch);
2232 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2233 __owur  int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2234                                size_t *num_curves);
2235
2236 void ssl_set_default_md(SSL *s);
2237 __owur int tls1_set_server_sigalgs(SSL *s);
2238
2239 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2240 typedef enum ticket_en {
2241     /* fatal error, malloc failure */
2242     TICKET_FATAL_ERR_MALLOC,
2243     /* fatal error, either from parsing or decrypting the ticket */
2244     TICKET_FATAL_ERR_OTHER,
2245     /* No ticket present */
2246     TICKET_NONE,
2247     /* Empty ticket present */
2248     TICKET_EMPTY,
2249     /* the ticket couldn't be decrypted */
2250     TICKET_NO_DECRYPT,
2251     /* a ticket was successfully decrypted */
2252     TICKET_SUCCESS,
2253     /* same as above but the ticket needs to be reneewed */
2254     TICKET_SUCCESS_RENEW
2255 } TICKET_RETURN;
2256
2257 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2258                                                 SSL_SESSION **ret);
2259 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2260                                         size_t eticklen,
2261                                         const unsigned char *sess_id,
2262                                         size_t sesslen, SSL_SESSION **psess);
2263
2264 __owur int tls_use_ticket(SSL *s);
2265
2266 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2267
2268 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2269 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2270                             int client);
2271 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2272                      int idx);
2273 void tls1_set_cert_validity(SSL *s);
2274
2275 #  ifndef OPENSSL_NO_CT
2276 __owur int ssl_validate_ct(SSL *s);
2277 #  endif
2278
2279 #  ifndef OPENSSL_NO_DH
2280 __owur DH *ssl_get_auto_dh(SSL *s);
2281 #  endif
2282
2283 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2284 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2285                                    int vfy);
2286
2287 int tls_choose_sigalg(SSL *s, int *al);
2288
2289 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2290 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2291 __owur long ssl_get_algorithm2(SSL *s);
2292 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2293                               const uint16_t *psig, size_t psiglen);
2294 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2295 __owur int tls1_process_sigalgs(SSL *s);
2296 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2297 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2298 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2299 void ssl_set_client_disabled(SSL *s);
2300 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2301
2302 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2303                                  size_t *hashlen);
2304 __owur const EVP_MD *ssl_md(int idx);
2305 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2306 __owur const EVP_MD *ssl_prf_md(SSL *s);
2307
2308 /*
2309  * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2310  * with |ssl|, if logging is enabled. It returns one on success and zero on
2311  * failure. The entry is identified by the first 8 bytes of
2312  * |encrypted_premaster|.
2313  */
2314 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2315                                            const uint8_t *encrypted_premaster,
2316                                            size_t encrypted_premaster_len,
2317                                            const uint8_t *premaster,
2318                                            size_t premaster_len);
2319
2320 /*
2321  * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2322  * logging is available. It returns one on success and zero on failure. It tags
2323  * the entry with |label|.
2324  */
2325 __owur int ssl_log_secret(SSL *ssl, const char *label,
2326                           const uint8_t *secret, size_t secret_len);
2327
2328 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2329 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2330 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2331 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2332 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2333
2334 /* s3_cbc.c */
2335 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2336 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2337                                   unsigned char *md_out,
2338                                   size_t *md_out_size,
2339                                   const unsigned char header[13],
2340                                   const unsigned char *data,
2341                                   size_t data_plus_mac_size,
2342                                   size_t data_plus_mac_plus_padding_size,
2343                                   const unsigned char *mac_secret,
2344                                   size_t mac_secret_length, char is_sslv3);
2345
2346 __owur int srp_generate_server_master_secret(SSL *s);
2347 __owur int srp_generate_client_master_secret(SSL *s);
2348 __owur int srp_verify_server_param(SSL *s, int *al);
2349
2350 /* t1_ext.c */
2351
2352 void custom_ext_init(custom_ext_methods *meths);
2353
2354 __owur int custom_ext_parse(SSL *s, int server,
2355                             unsigned int ext_type,
2356                             const unsigned char *ext_data, size_t ext_size,
2357                             int *al);
2358 __owur int custom_ext_add(SSL *s, int server, WPACKET *pkt, int *al);
2359
2360 __owur int custom_exts_copy(custom_ext_methods *dst,
2361                             const custom_ext_methods *src);
2362 void custom_exts_free(custom_ext_methods *exts);
2363
2364 void ssl_comp_free_compression_methods_int(void);
2365
2366 # else /* OPENSSL_UNIT_TEST */
2367
2368 #  define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2369 #  define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2370
2371 # endif
2372 #endif