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