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