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