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