Session Ticket app data
[openssl.git] / include / openssl / ssl.h
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
4  * Copyright 2005 Nokia. All rights reserved.
5  *
6  * Licensed under the OpenSSL license (the "License").  You may not use
7  * this file except in compliance with the License.  You can obtain a copy
8  * in the file LICENSE in the source distribution or at
9  * https://www.openssl.org/source/license.html
10  */
11
12 #ifndef HEADER_SSL_H
13 # define HEADER_SSL_H
14
15 # include <openssl/e_os2.h>
16 # include <openssl/opensslconf.h>
17 # include <openssl/comp.h>
18 # include <openssl/bio.h>
19 # if OPENSSL_API_COMPAT < 0x10100000L
20 #  include <openssl/x509.h>
21 #  include <openssl/crypto.h>
22 #  include <openssl/buffer.h>
23 # endif
24 # include <openssl/lhash.h>
25 # include <openssl/pem.h>
26 # include <openssl/hmac.h>
27 # include <openssl/async.h>
28
29 # include <openssl/safestack.h>
30 # include <openssl/symhacks.h>
31 # include <openssl/ct.h>
32 # include <openssl/sslerr.h>
33
34 #ifdef  __cplusplus
35 extern "C" {
36 #endif
37
38 /* OpenSSL version number for ASN.1 encoding of the session information */
39 /*-
40  * Version 0 - initial version
41  * Version 1 - added the optional peer certificate
42  */
43 # define SSL_SESSION_ASN1_VERSION 0x0001
44
45 # define SSL_MAX_SSL_SESSION_ID_LENGTH           32
46 # define SSL_MAX_SID_CTX_LENGTH                  32
47
48 # define SSL_MIN_RSA_MODULUS_LENGTH_IN_BYTES     (512/8)
49 # define SSL_MAX_KEY_ARG_LENGTH                  8
50 # define SSL_MAX_MASTER_KEY_LENGTH               48
51 # define TLS13_MAX_RESUMPTION_MASTER_LENGTH      64
52
53 /* The maximum number of encrypt/decrypt pipelines we can support */
54 # define SSL_MAX_PIPELINES  32
55
56 /* text strings for the ciphers */
57
58 /* These are used to specify which ciphers to use and not to use */
59
60 # define SSL_TXT_LOW             "LOW"
61 # define SSL_TXT_MEDIUM          "MEDIUM"
62 # define SSL_TXT_HIGH            "HIGH"
63 # define SSL_TXT_FIPS            "FIPS"
64
65 # define SSL_TXT_aNULL           "aNULL"
66 # define SSL_TXT_eNULL           "eNULL"
67 # define SSL_TXT_NULL            "NULL"
68
69 # define SSL_TXT_kRSA            "kRSA"
70 # define SSL_TXT_kDHr            "kDHr"/* this cipher class has been removed */
71 # define SSL_TXT_kDHd            "kDHd"/* this cipher class has been removed */
72 # define SSL_TXT_kDH             "kDH"/* this cipher class has been removed */
73 # define SSL_TXT_kEDH            "kEDH"/* alias for kDHE */
74 # define SSL_TXT_kDHE            "kDHE"
75 # define SSL_TXT_kECDHr          "kECDHr"/* this cipher class has been removed */
76 # define SSL_TXT_kECDHe          "kECDHe"/* this cipher class has been removed */
77 # define SSL_TXT_kECDH           "kECDH"/* this cipher class has been removed */
78 # define SSL_TXT_kEECDH          "kEECDH"/* alias for kECDHE */
79 # define SSL_TXT_kECDHE          "kECDHE"
80 # define SSL_TXT_kPSK            "kPSK"
81 # define SSL_TXT_kRSAPSK         "kRSAPSK"
82 # define SSL_TXT_kECDHEPSK       "kECDHEPSK"
83 # define SSL_TXT_kDHEPSK         "kDHEPSK"
84 # define SSL_TXT_kGOST           "kGOST"
85 # define SSL_TXT_kSRP            "kSRP"
86
87 # define SSL_TXT_aRSA            "aRSA"
88 # define SSL_TXT_aDSS            "aDSS"
89 # define SSL_TXT_aDH             "aDH"/* this cipher class has been removed */
90 # define SSL_TXT_aECDH           "aECDH"/* this cipher class has been removed */
91 # define SSL_TXT_aECDSA          "aECDSA"
92 # define SSL_TXT_aPSK            "aPSK"
93 # define SSL_TXT_aGOST94         "aGOST94"
94 # define SSL_TXT_aGOST01         "aGOST01"
95 # define SSL_TXT_aGOST12         "aGOST12"
96 # define SSL_TXT_aGOST           "aGOST"
97 # define SSL_TXT_aSRP            "aSRP"
98
99 # define SSL_TXT_DSS             "DSS"
100 # define SSL_TXT_DH              "DH"
101 # define SSL_TXT_DHE             "DHE"/* same as "kDHE:-ADH" */
102 # define SSL_TXT_EDH             "EDH"/* alias for DHE */
103 # define SSL_TXT_ADH             "ADH"
104 # define SSL_TXT_RSA             "RSA"
105 # define SSL_TXT_ECDH            "ECDH"
106 # define SSL_TXT_EECDH           "EECDH"/* alias for ECDHE" */
107 # define SSL_TXT_ECDHE           "ECDHE"/* same as "kECDHE:-AECDH" */
108 # define SSL_TXT_AECDH           "AECDH"
109 # define SSL_TXT_ECDSA           "ECDSA"
110 # define SSL_TXT_PSK             "PSK"
111 # define SSL_TXT_SRP             "SRP"
112
113 # define SSL_TXT_DES             "DES"
114 # define SSL_TXT_3DES            "3DES"
115 # define SSL_TXT_RC4             "RC4"
116 # define SSL_TXT_RC2             "RC2"
117 # define SSL_TXT_IDEA            "IDEA"
118 # define SSL_TXT_SEED            "SEED"
119 # define SSL_TXT_AES128          "AES128"
120 # define SSL_TXT_AES256          "AES256"
121 # define SSL_TXT_AES             "AES"
122 # define SSL_TXT_AES_GCM         "AESGCM"
123 # define SSL_TXT_AES_CCM         "AESCCM"
124 # define SSL_TXT_AES_CCM_8       "AESCCM8"
125 # define SSL_TXT_CAMELLIA128     "CAMELLIA128"
126 # define SSL_TXT_CAMELLIA256     "CAMELLIA256"
127 # define SSL_TXT_CAMELLIA        "CAMELLIA"
128 # define SSL_TXT_CHACHA20        "CHACHA20"
129 # define SSL_TXT_GOST            "GOST89"
130 # define SSL_TXT_ARIA            "ARIA"
131 # define SSL_TXT_ARIA_GCM        "ARIAGCM"
132 # define SSL_TXT_ARIA128         "ARIA128"
133 # define SSL_TXT_ARIA256         "ARIA256"
134
135 # define SSL_TXT_MD5             "MD5"
136 # define SSL_TXT_SHA1            "SHA1"
137 # define SSL_TXT_SHA             "SHA"/* same as "SHA1" */
138 # define SSL_TXT_GOST94          "GOST94"
139 # define SSL_TXT_GOST89MAC       "GOST89MAC"
140 # define SSL_TXT_GOST12          "GOST12"
141 # define SSL_TXT_GOST89MAC12     "GOST89MAC12"
142 # define SSL_TXT_SHA256          "SHA256"
143 # define SSL_TXT_SHA384          "SHA384"
144
145 # define SSL_TXT_SSLV3           "SSLv3"
146 # define SSL_TXT_TLSV1           "TLSv1"
147 # define SSL_TXT_TLSV1_1         "TLSv1.1"
148 # define SSL_TXT_TLSV1_2         "TLSv1.2"
149
150 # define SSL_TXT_ALL             "ALL"
151
152 /*-
153  * COMPLEMENTOF* definitions. These identifiers are used to (de-select)
154  * ciphers normally not being used.
155  * Example: "RC4" will activate all ciphers using RC4 including ciphers
156  * without authentication, which would normally disabled by DEFAULT (due
157  * the "!ADH" being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT"
158  * will make sure that it is also disabled in the specific selection.
159  * COMPLEMENTOF* identifiers are portable between version, as adjustments
160  * to the default cipher setup will also be included here.
161  *
162  * COMPLEMENTOFDEFAULT does not experience the same special treatment that
163  * DEFAULT gets, as only selection is being done and no sorting as needed
164  * for DEFAULT.
165  */
166 # define SSL_TXT_CMPALL          "COMPLEMENTOFALL"
167 # define SSL_TXT_CMPDEF          "COMPLEMENTOFDEFAULT"
168
169 /*
170  * The following cipher list is used by default. It also is substituted when
171  * an application-defined cipher list string starts with 'DEFAULT'.
172  */
173 # define SSL_DEFAULT_CIPHER_LIST "ALL:!COMPLEMENTOFDEFAULT:!eNULL"
174 /*
175  * As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
176  * starts with a reasonable order, and all we have to do for DEFAULT is
177  * throwing out anonymous and unencrypted ciphersuites! (The latter are not
178  * actually enabled by ALL, but "ALL:RSA" would enable some of them.)
179  */
180
181 /* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
182 # define SSL_SENT_SHUTDOWN       1
183 # define SSL_RECEIVED_SHUTDOWN   2
184
185 #ifdef __cplusplus
186 }
187 #endif
188
189 #ifdef  __cplusplus
190 extern "C" {
191 #endif
192
193 # define SSL_FILETYPE_ASN1       X509_FILETYPE_ASN1
194 # define SSL_FILETYPE_PEM        X509_FILETYPE_PEM
195
196 /*
197  * This is needed to stop compilers complaining about the 'struct ssl_st *'
198  * function parameters used to prototype callbacks in SSL_CTX.
199  */
200 typedef struct ssl_st *ssl_crock_st;
201 typedef struct tls_session_ticket_ext_st TLS_SESSION_TICKET_EXT;
202 typedef struct ssl_method_st SSL_METHOD;
203 typedef struct ssl_cipher_st SSL_CIPHER;
204 typedef struct ssl_session_st SSL_SESSION;
205 typedef struct tls_sigalgs_st TLS_SIGALGS;
206 typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
207 typedef struct ssl_comp_st SSL_COMP;
208
209 STACK_OF(SSL_CIPHER);
210 STACK_OF(SSL_COMP);
211
212 /* SRTP protection profiles for use with the use_srtp extension (RFC 5764)*/
213 typedef struct srtp_protection_profile_st {
214     const char *name;
215     unsigned long id;
216 } SRTP_PROTECTION_PROFILE;
217
218 DEFINE_STACK_OF(SRTP_PROTECTION_PROFILE)
219
220 typedef int (*tls_session_ticket_ext_cb_fn) (SSL *s,
221                                              const unsigned char *data,
222                                              int len, void *arg);
223 typedef int (*tls_session_secret_cb_fn) (SSL *s, void *secret,
224                                          int *secret_len,
225                                          STACK_OF(SSL_CIPHER) *peer_ciphers,
226                                          const SSL_CIPHER **cipher, void *arg);
227
228 /* Extension context codes */
229 /* This extension is only allowed in TLS */
230 #define SSL_EXT_TLS_ONLY                        0x0001
231 /* This extension is only allowed in DTLS */
232 #define SSL_EXT_DTLS_ONLY                       0x0002
233 /* Some extensions may be allowed in DTLS but we don't implement them for it */
234 #define SSL_EXT_TLS_IMPLEMENTATION_ONLY         0x0004
235 /* Most extensions are not defined for SSLv3 but EXT_TYPE_renegotiate is */
236 #define SSL_EXT_SSL3_ALLOWED                    0x0008
237 /* Extension is only defined for TLS1.2 and below */
238 #define SSL_EXT_TLS1_2_AND_BELOW_ONLY           0x0010
239 /* Extension is only defined for TLS1.3 and above */
240 #define SSL_EXT_TLS1_3_ONLY                     0x0020
241 /* Ignore this extension during parsing if we are resuming */
242 #define SSL_EXT_IGNORE_ON_RESUMPTION            0x0040
243 #define SSL_EXT_CLIENT_HELLO                    0x0080
244 /* Really means TLS1.2 or below */
245 #define SSL_EXT_TLS1_2_SERVER_HELLO             0x0100
246 #define SSL_EXT_TLS1_3_SERVER_HELLO             0x0200
247 #define SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS     0x0400
248 #define SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST      0x0800
249 #define SSL_EXT_TLS1_3_CERTIFICATE              0x1000
250 #define SSL_EXT_TLS1_3_NEW_SESSION_TICKET       0x2000
251 #define SSL_EXT_TLS1_3_CERTIFICATE_REQUEST      0x4000
252
253 /* Typedefs for handling custom extensions */
254
255 typedef int (*custom_ext_add_cb) (SSL *s, unsigned int ext_type,
256                                   const unsigned char **out,
257                                   size_t *outlen, int *al, void *add_arg);
258
259 typedef void (*custom_ext_free_cb) (SSL *s, unsigned int ext_type,
260                                     const unsigned char *out, void *add_arg);
261
262 typedef int (*custom_ext_parse_cb) (SSL *s, unsigned int ext_type,
263                                     const unsigned char *in,
264                                     size_t inlen, int *al, void *parse_arg);
265
266
267 typedef int (*SSL_custom_ext_add_cb_ex) (SSL *s, unsigned int ext_type,
268                                          unsigned int context,
269                                          const unsigned char **out,
270                                          size_t *outlen, X509 *x,
271                                          size_t chainidx,
272                                          int *al, void *add_arg);
273
274 typedef void (*SSL_custom_ext_free_cb_ex) (SSL *s, unsigned int ext_type,
275                                            unsigned int context,
276                                            const unsigned char *out,
277                                            void *add_arg);
278
279 typedef int (*SSL_custom_ext_parse_cb_ex) (SSL *s, unsigned int ext_type,
280                                            unsigned int context,
281                                            const unsigned char *in,
282                                            size_t inlen, X509 *x,
283                                            size_t chainidx,
284                                            int *al, void *parse_arg);
285
286 /* Typedef for verification callback */
287 typedef int (*SSL_verify_cb)(int preverify_ok, X509_STORE_CTX *x509_ctx);
288
289 /*
290  * Some values are reserved until OpenSSL 1.2.0 because they were previously
291  * included in SSL_OP_ALL in a 1.1.x release.
292  *
293  * Reserved value (until OpenSSL 1.2.0)                  0x00000001U
294  * Reserved value (until OpenSSL 1.2.0)                  0x00000002U
295  */
296 /* Allow initial connection to servers that don't support RI */
297 # define SSL_OP_LEGACY_SERVER_CONNECT                    0x00000004U
298
299 /* Reserved value (until OpenSSL 1.2.0)                  0x00000008U */
300 # define SSL_OP_TLSEXT_PADDING                           0x00000010U
301 /* Reserved value (until OpenSSL 1.2.0)                  0x00000020U */
302 # define SSL_OP_SAFARI_ECDHE_ECDSA_BUG                   0x00000040U
303 /*
304  * Reserved value (until OpenSSL 1.2.0)                  0x00000080U
305  * Reserved value (until OpenSSL 1.2.0)                  0x00000100U
306  * Reserved value (until OpenSSL 1.2.0)                  0x00000200U
307  */
308
309 /* In TLSv1.3 allow a non-(ec)dhe based kex_mode */
310 # define SSL_OP_ALLOW_NO_DHE_KEX                         0x00000400U
311
312 /*
313  * Disable SSL 3.0/TLS 1.0 CBC vulnerability workaround that was added in
314  * OpenSSL 0.9.6d.  Usually (depending on the application protocol) the
315  * workaround is not needed.  Unfortunately some broken SSL/TLS
316  * implementations cannot handle it at all, which is why we include it in
317  * SSL_OP_ALL. Added in 0.9.6e
318  */
319 # define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS              0x00000800U
320
321 /* DTLS options */
322 # define SSL_OP_NO_QUERY_MTU                             0x00001000U
323 /* Turn on Cookie Exchange (on relevant for servers) */
324 # define SSL_OP_COOKIE_EXCHANGE                          0x00002000U
325 /* Don't use RFC4507 ticket extension */
326 # define SSL_OP_NO_TICKET                                0x00004000U
327 # ifndef OPENSSL_NO_DTLS1_METHOD
328 /* Use Cisco's "speshul" version of DTLS_BAD_VER
329  * (only with deprecated DTLSv1_client_method())  */
330 #  define SSL_OP_CISCO_ANYCONNECT                        0x00008000U
331 # endif
332
333 /* As server, disallow session resumption on renegotiation */
334 # define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION   0x00010000U
335 /* Don't use compression even if supported */
336 # define SSL_OP_NO_COMPRESSION                           0x00020000U
337 /* Permit unsafe legacy renegotiation */
338 # define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION        0x00040000U
339 /* Disable encrypt-then-mac */
340 # define SSL_OP_NO_ENCRYPT_THEN_MAC                      0x00080000U
341
342 /*
343  * Enable TLSv1.3 Compatibility mode. This is on by default. A future version
344  * of OpenSSL may have this disabled by default.
345  */
346 # define SSL_OP_ENABLE_MIDDLEBOX_COMPAT                  0x00100000U
347
348 /* Prioritize Chacha20Poly1305 when client does.
349  * Modifies SSL_OP_CIPHER_SERVER_PREFERENCE */
350 # define SSL_OP_PRIORITIZE_CHACHA                        0x00200000U
351
352 /*
353  * Set on servers to choose the cipher according to the server's preferences
354  */
355 # define SSL_OP_CIPHER_SERVER_PREFERENCE                 0x00400000U
356 /*
357  * If set, a server will allow a client to issue a SSLv3.0 version number as
358  * latest version supported in the premaster secret, even when TLSv1.0
359  * (version 3.1) was announced in the client hello. Normally this is
360  * forbidden to prevent version rollback attacks.
361  */
362 # define SSL_OP_TLS_ROLLBACK_BUG                         0x00800000U
363
364 # define SSL_OP_NO_SSLv3                                 0x02000000U
365 # define SSL_OP_NO_TLSv1                                 0x04000000U
366 # define SSL_OP_NO_TLSv1_2                               0x08000000U
367 # define SSL_OP_NO_TLSv1_1                               0x10000000U
368 # define SSL_OP_NO_TLSv1_3                               0x20000000U
369
370 # define SSL_OP_NO_DTLSv1                                0x04000000U
371 # define SSL_OP_NO_DTLSv1_2                              0x08000000U
372
373 # define SSL_OP_NO_SSL_MASK (SSL_OP_NO_SSLv3|\
374         SSL_OP_NO_TLSv1|SSL_OP_NO_TLSv1_1|SSL_OP_NO_TLSv1_2|SSL_OP_NO_TLSv1_3)
375 # define SSL_OP_NO_DTLS_MASK (SSL_OP_NO_DTLSv1|SSL_OP_NO_DTLSv1_2)
376
377 /* Disallow all renegotiation */
378 # define SSL_OP_NO_RENEGOTIATION                         0x40000000U
379
380 /*
381  * Make server add server-hello extension from early version of cryptopro
382  * draft, when GOST ciphersuite is negotiated. Required for interoperability
383  * with CryptoPro CSP 3.x
384  */
385 # define SSL_OP_CRYPTOPRO_TLSEXT_BUG                     0x80000000U
386
387 /*
388  * SSL_OP_ALL: various bug workarounds that should be rather harmless.
389  * This used to be 0x000FFFFFL before 0.9.7.
390  * This used to be 0x80000BFFU before 1.1.1.
391  */
392 # define SSL_OP_ALL        (SSL_OP_CRYPTOPRO_TLSEXT_BUG|\
393                             SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS|\
394                             SSL_OP_LEGACY_SERVER_CONNECT|\
395                             SSL_OP_TLSEXT_PADDING|\
396                             SSL_OP_SAFARI_ECDHE_ECDSA_BUG)
397
398 /* OBSOLETE OPTIONS: retained for compatibility */
399
400 /* Removed from OpenSSL 1.1.0. Was 0x00000001L */
401 /* Related to removed SSLv2. */
402 # define SSL_OP_MICROSOFT_SESS_ID_BUG                    0x0
403 /* Removed from OpenSSL 1.1.0. Was 0x00000002L */
404 /* Related to removed SSLv2. */
405 # define SSL_OP_NETSCAPE_CHALLENGE_BUG                   0x0
406 /* Removed from OpenSSL 0.9.8q and 1.0.0c. Was 0x00000008L */
407 /* Dead forever, see CVE-2010-4180 */
408 # define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG         0x0
409 /* Removed from OpenSSL 1.0.1h and 1.0.2. Was 0x00000010L */
410 /* Refers to ancient SSLREF and SSLv2. */
411 # define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG              0x0
412 /* Removed from OpenSSL 1.1.0. Was 0x00000020 */
413 # define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER               0x0
414 /* Removed from OpenSSL 0.9.7h and 0.9.8b. Was 0x00000040L */
415 # define SSL_OP_MSIE_SSLV2_RSA_PADDING                   0x0
416 /* Removed from OpenSSL 1.1.0. Was 0x00000080 */
417 /* Ancient SSLeay version. */
418 # define SSL_OP_SSLEAY_080_CLIENT_DH_BUG                 0x0
419 /* Removed from OpenSSL 1.1.0. Was 0x00000100L */
420 # define SSL_OP_TLS_D5_BUG                               0x0
421 /* Removed from OpenSSL 1.1.0. Was 0x00000200L */
422 # define SSL_OP_TLS_BLOCK_PADDING_BUG                    0x0
423 /* Removed from OpenSSL 1.1.0. Was 0x00080000L */
424 # define SSL_OP_SINGLE_ECDH_USE                          0x0
425 /* Removed from OpenSSL 1.1.0. Was 0x00100000L */
426 # define SSL_OP_SINGLE_DH_USE                            0x0
427 /* Removed from OpenSSL 1.0.1k and 1.0.2. Was 0x00200000L */
428 # define SSL_OP_EPHEMERAL_RSA                            0x0
429 /* Removed from OpenSSL 1.1.0. Was 0x01000000L */
430 # define SSL_OP_NO_SSLv2                                 0x0
431 /* Removed from OpenSSL 1.0.1. Was 0x08000000L */
432 # define SSL_OP_PKCS1_CHECK_1                            0x0
433 /* Removed from OpenSSL 1.0.1. Was 0x10000000L */
434 # define SSL_OP_PKCS1_CHECK_2                            0x0
435 /* Removed from OpenSSL 1.1.0. Was 0x20000000L */
436 # define SSL_OP_NETSCAPE_CA_DN_BUG                       0x0
437 /* Removed from OpenSSL 1.1.0. Was 0x40000000L */
438 # define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG          0x0
439
440 /*
441  * Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success
442  * when just a single record has been written):
443  */
444 # define SSL_MODE_ENABLE_PARTIAL_WRITE       0x00000001U
445 /*
446  * Make it possible to retry SSL_write() with changed buffer location (buffer
447  * contents must stay the same!); this is not the default to avoid the
448  * misconception that non-blocking SSL_write() behaves like non-blocking
449  * write():
450  */
451 # define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002U
452 /*
453  * Never bother the application with retries if the transport is blocking:
454  */
455 # define SSL_MODE_AUTO_RETRY 0x00000004U
456 /* Don't attempt to automatically build certificate chain */
457 # define SSL_MODE_NO_AUTO_CHAIN 0x00000008U
458 /*
459  * Save RAM by releasing read and write buffers when they're empty. (SSL3 and
460  * TLS only.) Released buffers are freed.
461  */
462 # define SSL_MODE_RELEASE_BUFFERS 0x00000010U
463 /*
464  * Send the current time in the Random fields of the ClientHello and
465  * ServerHello records for compatibility with hypothetical implementations
466  * that require it.
467  */
468 # define SSL_MODE_SEND_CLIENTHELLO_TIME 0x00000020U
469 # define SSL_MODE_SEND_SERVERHELLO_TIME 0x00000040U
470 /*
471  * Send TLS_FALLBACK_SCSV in the ClientHello. To be set only by applications
472  * that reconnect with a downgraded protocol version; see
473  * draft-ietf-tls-downgrade-scsv-00 for details. DO NOT ENABLE THIS if your
474  * application attempts a normal handshake. Only use this in explicit
475  * fallback retries, following the guidance in
476  * draft-ietf-tls-downgrade-scsv-00.
477  */
478 # define SSL_MODE_SEND_FALLBACK_SCSV 0x00000080U
479 /*
480  * Support Asynchronous operation
481  */
482 # define SSL_MODE_ASYNC 0x00000100U
483
484 /* Cert related flags */
485 /*
486  * Many implementations ignore some aspects of the TLS standards such as
487  * enforcing certificate chain algorithms. When this is set we enforce them.
488  */
489 # define SSL_CERT_FLAG_TLS_STRICT                0x00000001U
490
491 /* Suite B modes, takes same values as certificate verify flags */
492 # define SSL_CERT_FLAG_SUITEB_128_LOS_ONLY       0x10000
493 /* Suite B 192 bit only mode */
494 # define SSL_CERT_FLAG_SUITEB_192_LOS            0x20000
495 /* Suite B 128 bit mode allowing 192 bit algorithms */
496 # define SSL_CERT_FLAG_SUITEB_128_LOS            0x30000
497
498 /* Perform all sorts of protocol violations for testing purposes */
499 # define SSL_CERT_FLAG_BROKEN_PROTOCOL           0x10000000
500
501 /* Flags for building certificate chains */
502 /* Treat any existing certificates as untrusted CAs */
503 # define SSL_BUILD_CHAIN_FLAG_UNTRUSTED          0x1
504 /* Don't include root CA in chain */
505 # define SSL_BUILD_CHAIN_FLAG_NO_ROOT            0x2
506 /* Just check certificates already there */
507 # define SSL_BUILD_CHAIN_FLAG_CHECK              0x4
508 /* Ignore verification errors */
509 # define SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR       0x8
510 /* Clear verification errors from queue */
511 # define SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR        0x10
512
513 /* Flags returned by SSL_check_chain */
514 /* Certificate can be used with this session */
515 # define CERT_PKEY_VALID         0x1
516 /* Certificate can also be used for signing */
517 # define CERT_PKEY_SIGN          0x2
518 /* EE certificate signing algorithm OK */
519 # define CERT_PKEY_EE_SIGNATURE  0x10
520 /* CA signature algorithms OK */
521 # define CERT_PKEY_CA_SIGNATURE  0x20
522 /* EE certificate parameters OK */
523 # define CERT_PKEY_EE_PARAM      0x40
524 /* CA certificate parameters OK */
525 # define CERT_PKEY_CA_PARAM      0x80
526 /* Signing explicitly allowed as opposed to SHA1 fallback */
527 # define CERT_PKEY_EXPLICIT_SIGN 0x100
528 /* Client CA issuer names match (always set for server cert) */
529 # define CERT_PKEY_ISSUER_NAME   0x200
530 /* Cert type matches client types (always set for server cert) */
531 # define CERT_PKEY_CERT_TYPE     0x400
532 /* Cert chain suitable to Suite B */
533 # define CERT_PKEY_SUITEB        0x800
534
535 # define SSL_CONF_FLAG_CMDLINE           0x1
536 # define SSL_CONF_FLAG_FILE              0x2
537 # define SSL_CONF_FLAG_CLIENT            0x4
538 # define SSL_CONF_FLAG_SERVER            0x8
539 # define SSL_CONF_FLAG_SHOW_ERRORS       0x10
540 # define SSL_CONF_FLAG_CERTIFICATE       0x20
541 # define SSL_CONF_FLAG_REQUIRE_PRIVATE   0x40
542 /* Configuration value types */
543 # define SSL_CONF_TYPE_UNKNOWN           0x0
544 # define SSL_CONF_TYPE_STRING            0x1
545 # define SSL_CONF_TYPE_FILE              0x2
546 # define SSL_CONF_TYPE_DIR               0x3
547 # define SSL_CONF_TYPE_NONE              0x4
548
549 /* Length of a TLSv1.3 cookie */
550 # define SSL_COOKIE_LENGTH                       255
551
552 /*
553  * Note: SSL[_CTX]_set_{options,mode} use |= op on the previous value, they
554  * cannot be used to clear bits.
555  */
556
557 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx);
558 unsigned long SSL_get_options(const SSL* s);
559 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op);
560 unsigned long SSL_clear_options(SSL *s, unsigned long op);
561 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op);
562 unsigned long SSL_set_options(SSL *s, unsigned long op);
563
564 # define SSL_CTX_set_mode(ctx,op) \
565         SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,(op),NULL)
566 # define SSL_CTX_clear_mode(ctx,op) \
567         SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_MODE,(op),NULL)
568 # define SSL_CTX_get_mode(ctx) \
569         SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,0,NULL)
570 # define SSL_clear_mode(ssl,op) \
571         SSL_ctrl((ssl),SSL_CTRL_CLEAR_MODE,(op),NULL)
572 # define SSL_set_mode(ssl,op) \
573         SSL_ctrl((ssl),SSL_CTRL_MODE,(op),NULL)
574 # define SSL_get_mode(ssl) \
575         SSL_ctrl((ssl),SSL_CTRL_MODE,0,NULL)
576 # define SSL_set_mtu(ssl, mtu) \
577         SSL_ctrl((ssl),SSL_CTRL_SET_MTU,(mtu),NULL)
578 # define DTLS_set_link_mtu(ssl, mtu) \
579         SSL_ctrl((ssl),DTLS_CTRL_SET_LINK_MTU,(mtu),NULL)
580 # define DTLS_get_link_min_mtu(ssl) \
581         SSL_ctrl((ssl),DTLS_CTRL_GET_LINK_MIN_MTU,0,NULL)
582
583 # define SSL_get_secure_renegotiation_support(ssl) \
584         SSL_ctrl((ssl), SSL_CTRL_GET_RI_SUPPORT, 0, NULL)
585
586 # ifndef OPENSSL_NO_HEARTBEATS
587 #  define SSL_heartbeat(ssl) \
588         SSL_ctrl((ssl),SSL_CTRL_DTLS_EXT_SEND_HEARTBEAT,0,NULL)
589 # endif
590
591 # define SSL_CTX_set_cert_flags(ctx,op) \
592         SSL_CTX_ctrl((ctx),SSL_CTRL_CERT_FLAGS,(op),NULL)
593 # define SSL_set_cert_flags(s,op) \
594         SSL_ctrl((s),SSL_CTRL_CERT_FLAGS,(op),NULL)
595 # define SSL_CTX_clear_cert_flags(ctx,op) \
596         SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_CERT_FLAGS,(op),NULL)
597 # define SSL_clear_cert_flags(s,op) \
598         SSL_ctrl((s),SSL_CTRL_CLEAR_CERT_FLAGS,(op),NULL)
599
600 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
601                               void (*cb) (int write_p, int version,
602                                           int content_type, const void *buf,
603                                           size_t len, SSL *ssl, void *arg));
604 void SSL_set_msg_callback(SSL *ssl,
605                           void (*cb) (int write_p, int version,
606                                       int content_type, const void *buf,
607                                       size_t len, SSL *ssl, void *arg));
608 # define SSL_CTX_set_msg_callback_arg(ctx, arg) SSL_CTX_ctrl((ctx), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg))
609 # define SSL_set_msg_callback_arg(ssl, arg) SSL_ctrl((ssl), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg))
610
611 # define SSL_get_extms_support(s) \
612         SSL_ctrl((s),SSL_CTRL_GET_EXTMS_SUPPORT,0,NULL)
613
614 # ifndef OPENSSL_NO_SRP
615
616 /* see tls_srp.c */
617 __owur int SSL_SRP_CTX_init(SSL *s);
618 __owur int SSL_CTX_SRP_CTX_init(SSL_CTX *ctx);
619 int SSL_SRP_CTX_free(SSL *ctx);
620 int SSL_CTX_SRP_CTX_free(SSL_CTX *ctx);
621 __owur int SSL_srp_server_param_with_username(SSL *s, int *ad);
622 __owur int SRP_Calc_A_param(SSL *s);
623
624 # endif
625
626 /* 100k max cert list */
627 # define SSL_MAX_CERT_LIST_DEFAULT 1024*100
628
629 # define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT      (1024*20)
630
631 /*
632  * This callback type is used inside SSL_CTX, SSL, and in the functions that
633  * set them. It is used to override the generation of SSL/TLS session IDs in
634  * a server. Return value should be zero on an error, non-zero to proceed.
635  * Also, callbacks should themselves check if the id they generate is unique
636  * otherwise the SSL handshake will fail with an error - callbacks can do
637  * this using the 'ssl' value they're passed by;
638  * SSL_has_matching_session_id(ssl, id, *id_len) The length value passed in
639  * is set at the maximum size the session ID can be. In SSLv3/TLSv1 it is 32
640  * bytes. The callback can alter this length to be less if desired. It is
641  * also an error for the callback to set the size to zero.
642  */
643 typedef int (*GEN_SESSION_CB) (SSL *ssl, unsigned char *id,
644                                unsigned int *id_len);
645
646 # define SSL_SESS_CACHE_OFF                      0x0000
647 # define SSL_SESS_CACHE_CLIENT                   0x0001
648 # define SSL_SESS_CACHE_SERVER                   0x0002
649 # define SSL_SESS_CACHE_BOTH     (SSL_SESS_CACHE_CLIENT|SSL_SESS_CACHE_SERVER)
650 # define SSL_SESS_CACHE_NO_AUTO_CLEAR            0x0080
651 /* enough comments already ... see SSL_CTX_set_session_cache_mode(3) */
652 # define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP       0x0100
653 # define SSL_SESS_CACHE_NO_INTERNAL_STORE        0x0200
654 # define SSL_SESS_CACHE_NO_INTERNAL \
655         (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP|SSL_SESS_CACHE_NO_INTERNAL_STORE)
656
657 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
658 # define SSL_CTX_sess_number(ctx) \
659         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_NUMBER,0,NULL)
660 # define SSL_CTX_sess_connect(ctx) \
661         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT,0,NULL)
662 # define SSL_CTX_sess_connect_good(ctx) \
663         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_GOOD,0,NULL)
664 # define SSL_CTX_sess_connect_renegotiate(ctx) \
665         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_RENEGOTIATE,0,NULL)
666 # define SSL_CTX_sess_accept(ctx) \
667         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT,0,NULL)
668 # define SSL_CTX_sess_accept_renegotiate(ctx) \
669         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_RENEGOTIATE,0,NULL)
670 # define SSL_CTX_sess_accept_good(ctx) \
671         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_GOOD,0,NULL)
672 # define SSL_CTX_sess_hits(ctx) \
673         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_HIT,0,NULL)
674 # define SSL_CTX_sess_cb_hits(ctx) \
675         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CB_HIT,0,NULL)
676 # define SSL_CTX_sess_misses(ctx) \
677         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_MISSES,0,NULL)
678 # define SSL_CTX_sess_timeouts(ctx) \
679         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_TIMEOUTS,0,NULL)
680 # define SSL_CTX_sess_cache_full(ctx) \
681         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CACHE_FULL,0,NULL)
682
683 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
684                              int (*new_session_cb) (struct ssl_st *ssl,
685                                                     SSL_SESSION *sess));
686 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (struct ssl_st *ssl,
687                                               SSL_SESSION *sess);
688 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
689                                 void (*remove_session_cb) (struct ssl_ctx_st
690                                                            *ctx,
691                                                            SSL_SESSION
692                                                            *sess));
693 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (struct ssl_ctx_st *ctx,
694                                                   SSL_SESSION *sess);
695 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
696                              SSL_SESSION *(*get_session_cb) (struct ssl_st
697                                                              *ssl,
698                                                              const unsigned char
699                                                              *data, int len,
700                                                              int *copy));
701 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (struct ssl_st *ssl,
702                                                        const unsigned char *data,
703                                                        int len, int *copy);
704 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
705                                void (*cb) (const SSL *ssl, int type,
706                                            int val));
707 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
708                                                  int val);
709 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
710                                 int (*client_cert_cb) (SSL *ssl, X509 **x509,
711                                                        EVP_PKEY **pkey));
712 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
713                                                  EVP_PKEY **pkey);
714 # ifndef OPENSSL_NO_ENGINE
715 __owur int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e);
716 # endif
717 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
718                                     int (*app_gen_cookie_cb) (SSL *ssl,
719                                                               unsigned char
720                                                               *cookie,
721                                                               unsigned int
722                                                               *cookie_len));
723 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
724                                   int (*app_verify_cookie_cb) (SSL *ssl,
725                                                                const unsigned char
726                                                                *cookie,
727                                                                unsigned int
728                                                                cookie_len));
729 # ifndef OPENSSL_NO_NEXTPROTONEG
730
731 typedef int (*SSL_CTX_npn_advertised_cb_func)(SSL *ssl,
732                                               const unsigned char **out,
733                                               unsigned int *outlen,
734                                               void *arg);
735 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *s,
736                                    SSL_CTX_npn_advertised_cb_func cb,
737                                    void *arg);
738 #  define SSL_CTX_set_npn_advertised_cb SSL_CTX_set_next_protos_advertised_cb
739
740 typedef int (*SSL_CTX_npn_select_cb_func)(SSL *s,
741                                           unsigned char **out,
742                                           unsigned char *outlen,
743                                           const unsigned char *in,
744                                           unsigned int inlen,
745                                           void *arg);
746 void SSL_CTX_set_next_proto_select_cb(SSL_CTX *s,
747                                       SSL_CTX_npn_select_cb_func cb,
748                                       void *arg);
749 #  define SSL_CTX_set_npn_select_cb SSL_CTX_set_next_proto_select_cb
750
751 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
752                                     unsigned *len);
753 #  define SSL_get0_npn_negotiated SSL_get0_next_proto_negotiated
754 # endif
755
756 __owur int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
757                           const unsigned char *in, unsigned int inlen,
758                           const unsigned char *client,
759                           unsigned int client_len);
760
761 # define OPENSSL_NPN_UNSUPPORTED 0
762 # define OPENSSL_NPN_NEGOTIATED  1
763 # define OPENSSL_NPN_NO_OVERLAP  2
764
765 __owur int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
766                                    unsigned int protos_len);
767 __owur int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
768                                unsigned int protos_len);
769 typedef int (*SSL_CTX_alpn_select_cb_func)(SSL *ssl,
770                                            const unsigned char **out,
771                                            unsigned char *outlen,
772                                            const unsigned char *in,
773                                            unsigned int inlen,
774                                            void *arg);
775 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
776                                 SSL_CTX_alpn_select_cb_func cb,
777                                 void *arg);
778 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
779                             unsigned int *len);
780
781 # ifndef OPENSSL_NO_PSK
782 /*
783  * the maximum length of the buffer given to callbacks containing the
784  * resulting identity/psk
785  */
786 #  define PSK_MAX_IDENTITY_LEN 128
787 #  define PSK_MAX_PSK_LEN 256
788 typedef unsigned int (*SSL_psk_client_cb_func)(SSL *ssl,
789                                                const char *hint,
790                                                char *identity,
791                                                unsigned int max_identity_len,
792                                                unsigned char *psk,
793                                                unsigned int max_psk_len);
794 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb);
795 void SSL_set_psk_client_callback(SSL *ssl, SSL_psk_client_cb_func cb);
796
797 typedef unsigned int (*SSL_psk_server_cb_func)(SSL *ssl,
798                                                const char *identity,
799                                                unsigned char *psk,
800                                                unsigned int max_psk_len);
801 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb);
802 void SSL_set_psk_server_callback(SSL *ssl, SSL_psk_server_cb_func cb);
803
804 __owur int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint);
805 __owur int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
806 const char *SSL_get_psk_identity_hint(const SSL *s);
807 const char *SSL_get_psk_identity(const SSL *s);
808 # endif
809
810 typedef int (*SSL_psk_find_session_cb_func)(SSL *ssl,
811                                             const unsigned char *identity,
812                                             size_t identity_len,
813                                             SSL_SESSION **sess);
814 typedef int (*SSL_psk_use_session_cb_func)(SSL *ssl, const EVP_MD *md,
815                                            const unsigned char **id,
816                                            size_t *idlen,
817                                            SSL_SESSION **sess);
818
819 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb);
820 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
821                                            SSL_psk_find_session_cb_func cb);
822 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb);
823 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
824                                           SSL_psk_use_session_cb_func cb);
825
826 /* Register callbacks to handle custom TLS Extensions for client or server. */
827
828 __owur int SSL_CTX_has_client_custom_ext(const SSL_CTX *ctx,
829                                          unsigned int ext_type);
830
831 __owur int SSL_CTX_add_client_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
832                                   custom_ext_add_cb add_cb,
833                                   custom_ext_free_cb free_cb,
834                                   void *add_arg,
835                                   custom_ext_parse_cb parse_cb,
836                                   void *parse_arg);
837
838 __owur int SSL_CTX_add_server_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
839                                   custom_ext_add_cb add_cb,
840                                   custom_ext_free_cb free_cb,
841                                   void *add_arg,
842                                   custom_ext_parse_cb parse_cb,
843                                   void *parse_arg);
844
845 __owur int SSL_CTX_add_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
846                                   unsigned int context,
847                                   SSL_custom_ext_add_cb_ex add_cb,
848                                   SSL_custom_ext_free_cb_ex free_cb,
849                                   void *add_arg,
850                                   SSL_custom_ext_parse_cb_ex parse_cb,
851                                   void *parse_arg);
852
853 __owur int SSL_extension_supported(unsigned int ext_type);
854
855 # define SSL_NOTHING            1
856 # define SSL_WRITING            2
857 # define SSL_READING            3
858 # define SSL_X509_LOOKUP        4
859 # define SSL_ASYNC_PAUSED       5
860 # define SSL_ASYNC_NO_JOBS      6
861 # define SSL_CLIENT_HELLO_CB    7
862
863 /* These will only be used when doing non-blocking IO */
864 # define SSL_want_nothing(s)         (SSL_want(s) == SSL_NOTHING)
865 # define SSL_want_read(s)            (SSL_want(s) == SSL_READING)
866 # define SSL_want_write(s)           (SSL_want(s) == SSL_WRITING)
867 # define SSL_want_x509_lookup(s)     (SSL_want(s) == SSL_X509_LOOKUP)
868 # define SSL_want_async(s)           (SSL_want(s) == SSL_ASYNC_PAUSED)
869 # define SSL_want_async_job(s)       (SSL_want(s) == SSL_ASYNC_NO_JOBS)
870 # define SSL_want_client_hello_cb(s) (SSL_want(s) == SSL_CLIENT_HELLO_CB)
871
872 # define SSL_MAC_FLAG_READ_MAC_STREAM 1
873 # define SSL_MAC_FLAG_WRITE_MAC_STREAM 2
874
875 /*
876  * A callback for logging out TLS key material. This callback should log out
877  * |line| followed by a newline.
878  */
879 typedef void (*SSL_CTX_keylog_cb_func)(const SSL *ssl, const char *line);
880
881 /*
882  * SSL_CTX_set_keylog_callback configures a callback to log key material. This
883  * is intended for debugging use with tools like Wireshark. The cb function
884  * should log line followed by a newline.
885  */
886 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb);
887
888 /*
889  * SSL_CTX_get_keylog_callback returns the callback configured by
890  * SSL_CTX_set_keylog_callback.
891  */
892 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx);
893
894 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data);
895 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx);
896 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data);
897 uint32_t SSL_get_max_early_data(const SSL *s);
898
899 #ifdef __cplusplus
900 }
901 #endif
902
903 # include <openssl/ssl2.h>
904 # include <openssl/ssl3.h>
905 # include <openssl/tls1.h>      /* This is mostly sslv3 with a few tweaks */
906 # include <openssl/dtls1.h>     /* Datagram TLS */
907 # include <openssl/srtp.h>      /* Support for the use_srtp extension */
908
909 #ifdef  __cplusplus
910 extern "C" {
911 #endif
912
913 /*
914  * These need to be after the above set of includes due to a compiler bug
915  * in VisualStudio 2015
916  */
917 DEFINE_STACK_OF_CONST(SSL_CIPHER)
918 DEFINE_STACK_OF(SSL_COMP)
919
920 /* compatibility */
921 # define SSL_set_app_data(s,arg)         (SSL_set_ex_data(s,0,(char *)(arg)))
922 # define SSL_get_app_data(s)             (SSL_get_ex_data(s,0))
923 # define SSL_SESSION_set_app_data(s,a)   (SSL_SESSION_set_ex_data(s,0, \
924                                                                   (char *)(a)))
925 # define SSL_SESSION_get_app_data(s)     (SSL_SESSION_get_ex_data(s,0))
926 # define SSL_CTX_get_app_data(ctx)       (SSL_CTX_get_ex_data(ctx,0))
927 # define SSL_CTX_set_app_data(ctx,arg)   (SSL_CTX_set_ex_data(ctx,0, \
928                                                               (char *)(arg)))
929 DEPRECATEDIN_1_1_0(void SSL_set_debug(SSL *s, int debug))
930
931 /* TLSv1.3 KeyUpdate message types */
932 /* -1 used so that this is an invalid value for the on-the-wire protocol */
933 #define SSL_KEY_UPDATE_NONE             -1
934 /* Values as defined for the on-the-wire protocol */
935 #define SSL_KEY_UPDATE_NOT_REQUESTED     0
936 #define SSL_KEY_UPDATE_REQUESTED         1
937
938 /*
939  * The valid handshake states (one for each type message sent and one for each
940  * type of message received). There are also two "special" states:
941  * TLS = TLS or DTLS state
942  * DTLS = DTLS specific state
943  * CR/SR = Client Read/Server Read
944  * CW/SW = Client Write/Server Write
945  *
946  * The "special" states are:
947  * TLS_ST_BEFORE = No handshake has been initiated yet
948  * TLS_ST_OK = A handshake has been successfully completed
949  */
950 typedef enum {
951     TLS_ST_BEFORE,
952     TLS_ST_OK,
953     DTLS_ST_CR_HELLO_VERIFY_REQUEST,
954     TLS_ST_CR_SRVR_HELLO,
955     TLS_ST_CR_CERT,
956     TLS_ST_CR_CERT_STATUS,
957     TLS_ST_CR_KEY_EXCH,
958     TLS_ST_CR_CERT_REQ,
959     TLS_ST_CR_SRVR_DONE,
960     TLS_ST_CR_SESSION_TICKET,
961     TLS_ST_CR_CHANGE,
962     TLS_ST_CR_FINISHED,
963     TLS_ST_CW_CLNT_HELLO,
964     TLS_ST_CW_CERT,
965     TLS_ST_CW_KEY_EXCH,
966     TLS_ST_CW_CERT_VRFY,
967     TLS_ST_CW_CHANGE,
968     TLS_ST_CW_NEXT_PROTO,
969     TLS_ST_CW_FINISHED,
970     TLS_ST_SW_HELLO_REQ,
971     TLS_ST_SR_CLNT_HELLO,
972     DTLS_ST_SW_HELLO_VERIFY_REQUEST,
973     TLS_ST_SW_SRVR_HELLO,
974     TLS_ST_SW_CERT,
975     TLS_ST_SW_KEY_EXCH,
976     TLS_ST_SW_CERT_REQ,
977     TLS_ST_SW_SRVR_DONE,
978     TLS_ST_SR_CERT,
979     TLS_ST_SR_KEY_EXCH,
980     TLS_ST_SR_CERT_VRFY,
981     TLS_ST_SR_NEXT_PROTO,
982     TLS_ST_SR_CHANGE,
983     TLS_ST_SR_FINISHED,
984     TLS_ST_SW_SESSION_TICKET,
985     TLS_ST_SW_CERT_STATUS,
986     TLS_ST_SW_CHANGE,
987     TLS_ST_SW_FINISHED,
988     TLS_ST_SW_ENCRYPTED_EXTENSIONS,
989     TLS_ST_CR_ENCRYPTED_EXTENSIONS,
990     TLS_ST_CR_CERT_VRFY,
991     TLS_ST_SW_CERT_VRFY,
992     TLS_ST_CR_HELLO_REQ,
993     TLS_ST_SW_KEY_UPDATE,
994     TLS_ST_CW_KEY_UPDATE,
995     TLS_ST_SR_KEY_UPDATE,
996     TLS_ST_CR_KEY_UPDATE,
997     TLS_ST_EARLY_DATA,
998     TLS_ST_PENDING_EARLY_DATA_END,
999     TLS_ST_CW_END_OF_EARLY_DATA,
1000     TLS_ST_SR_END_OF_EARLY_DATA
1001 } OSSL_HANDSHAKE_STATE;
1002
1003 /*
1004  * Most of the following state values are no longer used and are defined to be
1005  * the closest equivalent value in the current state machine code. Not all
1006  * defines have an equivalent and are set to a dummy value (-1). SSL_ST_CONNECT
1007  * and SSL_ST_ACCEPT are still in use in the definition of SSL_CB_ACCEPT_LOOP,
1008  * SSL_CB_ACCEPT_EXIT, SSL_CB_CONNECT_LOOP and SSL_CB_CONNECT_EXIT.
1009  */
1010
1011 # define SSL_ST_CONNECT                  0x1000
1012 # define SSL_ST_ACCEPT                   0x2000
1013
1014 # define SSL_ST_MASK                     0x0FFF
1015
1016 # define SSL_CB_LOOP                     0x01
1017 # define SSL_CB_EXIT                     0x02
1018 # define SSL_CB_READ                     0x04
1019 # define SSL_CB_WRITE                    0x08
1020 # define SSL_CB_ALERT                    0x4000/* used in callback */
1021 # define SSL_CB_READ_ALERT               (SSL_CB_ALERT|SSL_CB_READ)
1022 # define SSL_CB_WRITE_ALERT              (SSL_CB_ALERT|SSL_CB_WRITE)
1023 # define SSL_CB_ACCEPT_LOOP              (SSL_ST_ACCEPT|SSL_CB_LOOP)
1024 # define SSL_CB_ACCEPT_EXIT              (SSL_ST_ACCEPT|SSL_CB_EXIT)
1025 # define SSL_CB_CONNECT_LOOP             (SSL_ST_CONNECT|SSL_CB_LOOP)
1026 # define SSL_CB_CONNECT_EXIT             (SSL_ST_CONNECT|SSL_CB_EXIT)
1027 # define SSL_CB_HANDSHAKE_START          0x10
1028 # define SSL_CB_HANDSHAKE_DONE           0x20
1029
1030 /* Is the SSL_connection established? */
1031 # define SSL_in_connect_init(a)          (SSL_in_init(a) && !SSL_is_server(a))
1032 # define SSL_in_accept_init(a)           (SSL_in_init(a) && SSL_is_server(a))
1033 int SSL_in_init(SSL *s);
1034 int SSL_in_before(SSL *s);
1035 int SSL_is_init_finished(SSL *s);
1036
1037 /*
1038  * The following 3 states are kept in ssl->rlayer.rstate when reads fail, you
1039  * should not need these
1040  */
1041 # define SSL_ST_READ_HEADER                      0xF0
1042 # define SSL_ST_READ_BODY                        0xF1
1043 # define SSL_ST_READ_DONE                        0xF2
1044
1045 /*-
1046  * Obtain latest Finished message
1047  *   -- that we sent (SSL_get_finished)
1048  *   -- that we expected from peer (SSL_get_peer_finished).
1049  * Returns length (0 == no Finished so far), copies up to 'count' bytes.
1050  */
1051 size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1052 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
1053
1054 /*
1055  * use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options are
1056  * 'ored' with SSL_VERIFY_PEER if they are desired
1057  */
1058 # define SSL_VERIFY_NONE                 0x00
1059 # define SSL_VERIFY_PEER                 0x01
1060 # define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
1061 # define SSL_VERIFY_CLIENT_ONCE          0x04
1062 # define SSL_VERIFY_POST_HANDSHAKE       0x08
1063
1064 # define OpenSSL_add_ssl_algorithms()    SSL_library_init()
1065 # if OPENSSL_API_COMPAT < 0x10100000L
1066 #  define SSLeay_add_ssl_algorithms()    SSL_library_init()
1067 # endif
1068
1069 /* More backward compatibility */
1070 # define SSL_get_cipher(s) \
1071                 SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1072 # define SSL_get_cipher_bits(s,np) \
1073                 SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np)
1074 # define SSL_get_cipher_version(s) \
1075                 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1076 # define SSL_get_cipher_name(s) \
1077                 SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1078 # define SSL_get_time(a)         SSL_SESSION_get_time(a)
1079 # define SSL_set_time(a,b)       SSL_SESSION_set_time((a),(b))
1080 # define SSL_get_timeout(a)      SSL_SESSION_get_timeout(a)
1081 # define SSL_set_timeout(a,b)    SSL_SESSION_set_timeout((a),(b))
1082
1083 # define d2i_SSL_SESSION_bio(bp,s_id) ASN1_d2i_bio_of(SSL_SESSION,SSL_SESSION_new,d2i_SSL_SESSION,bp,s_id)
1084 # define i2d_SSL_SESSION_bio(bp,s_id) ASN1_i2d_bio_of(SSL_SESSION,i2d_SSL_SESSION,bp,s_id)
1085
1086 DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1087 # define SSL_AD_REASON_OFFSET            1000/* offset to get SSL_R_... value
1088                                               * from SSL_AD_... */
1089 /* These alert types are for SSLv3 and TLSv1 */
1090 # define SSL_AD_CLOSE_NOTIFY             SSL3_AD_CLOSE_NOTIFY
1091 /* fatal */
1092 # define SSL_AD_UNEXPECTED_MESSAGE       SSL3_AD_UNEXPECTED_MESSAGE
1093 /* fatal */
1094 # define SSL_AD_BAD_RECORD_MAC           SSL3_AD_BAD_RECORD_MAC
1095 # define SSL_AD_DECRYPTION_FAILED        TLS1_AD_DECRYPTION_FAILED
1096 # define SSL_AD_RECORD_OVERFLOW          TLS1_AD_RECORD_OVERFLOW
1097 /* fatal */
1098 # define SSL_AD_DECOMPRESSION_FAILURE    SSL3_AD_DECOMPRESSION_FAILURE
1099 /* fatal */
1100 # define SSL_AD_HANDSHAKE_FAILURE        SSL3_AD_HANDSHAKE_FAILURE
1101 /* Not for TLS */
1102 # define SSL_AD_NO_CERTIFICATE           SSL3_AD_NO_CERTIFICATE
1103 # define SSL_AD_BAD_CERTIFICATE          SSL3_AD_BAD_CERTIFICATE
1104 # define SSL_AD_UNSUPPORTED_CERTIFICATE  SSL3_AD_UNSUPPORTED_CERTIFICATE
1105 # define SSL_AD_CERTIFICATE_REVOKED      SSL3_AD_CERTIFICATE_REVOKED
1106 # define SSL_AD_CERTIFICATE_EXPIRED      SSL3_AD_CERTIFICATE_EXPIRED
1107 # define SSL_AD_CERTIFICATE_UNKNOWN      SSL3_AD_CERTIFICATE_UNKNOWN
1108 /* fatal */
1109 # define SSL_AD_ILLEGAL_PARAMETER        SSL3_AD_ILLEGAL_PARAMETER
1110 /* fatal */
1111 # define SSL_AD_UNKNOWN_CA               TLS1_AD_UNKNOWN_CA
1112 /* fatal */
1113 # define SSL_AD_ACCESS_DENIED            TLS1_AD_ACCESS_DENIED
1114 /* fatal */
1115 # define SSL_AD_DECODE_ERROR             TLS1_AD_DECODE_ERROR
1116 # define SSL_AD_DECRYPT_ERROR            TLS1_AD_DECRYPT_ERROR
1117 /* fatal */
1118 # define SSL_AD_EXPORT_RESTRICTION       TLS1_AD_EXPORT_RESTRICTION
1119 /* fatal */
1120 # define SSL_AD_PROTOCOL_VERSION         TLS1_AD_PROTOCOL_VERSION
1121 /* fatal */
1122 # define SSL_AD_INSUFFICIENT_SECURITY    TLS1_AD_INSUFFICIENT_SECURITY
1123 /* fatal */
1124 # define SSL_AD_INTERNAL_ERROR           TLS1_AD_INTERNAL_ERROR
1125 # define SSL_AD_USER_CANCELLED           TLS1_AD_USER_CANCELLED
1126 # define SSL_AD_NO_RENEGOTIATION         TLS1_AD_NO_RENEGOTIATION
1127 # define SSL_AD_MISSING_EXTENSION        TLS13_AD_MISSING_EXTENSION
1128 # define SSL_AD_CERTIFICATE_REQUIRED     TLS13_AD_CERTIFICATE_REQUIRED
1129 # define SSL_AD_UNSUPPORTED_EXTENSION    TLS1_AD_UNSUPPORTED_EXTENSION
1130 # define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
1131 # define SSL_AD_UNRECOGNIZED_NAME        TLS1_AD_UNRECOGNIZED_NAME
1132 # define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
1133 # define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
1134 /* fatal */
1135 # define SSL_AD_UNKNOWN_PSK_IDENTITY     TLS1_AD_UNKNOWN_PSK_IDENTITY
1136 /* fatal */
1137 # define SSL_AD_INAPPROPRIATE_FALLBACK   TLS1_AD_INAPPROPRIATE_FALLBACK
1138 # define SSL_AD_NO_APPLICATION_PROTOCOL  TLS1_AD_NO_APPLICATION_PROTOCOL
1139 # define SSL_ERROR_NONE                  0
1140 # define SSL_ERROR_SSL                   1
1141 # define SSL_ERROR_WANT_READ             2
1142 # define SSL_ERROR_WANT_WRITE            3
1143 # define SSL_ERROR_WANT_X509_LOOKUP      4
1144 # define SSL_ERROR_SYSCALL               5/* look at error stack/return
1145                                            * value/errno */
1146 # define SSL_ERROR_ZERO_RETURN           6
1147 # define SSL_ERROR_WANT_CONNECT          7
1148 # define SSL_ERROR_WANT_ACCEPT           8
1149 # define SSL_ERROR_WANT_ASYNC            9
1150 # define SSL_ERROR_WANT_ASYNC_JOB       10
1151 # define SSL_ERROR_WANT_CLIENT_HELLO_CB 11
1152 # define SSL_CTRL_SET_TMP_DH                     3
1153 # define SSL_CTRL_SET_TMP_ECDH                   4
1154 # define SSL_CTRL_SET_TMP_DH_CB                  6
1155 # define SSL_CTRL_GET_CLIENT_CERT_REQUEST        9
1156 # define SSL_CTRL_GET_NUM_RENEGOTIATIONS         10
1157 # define SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS       11
1158 # define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS       12
1159 # define SSL_CTRL_GET_FLAGS                      13
1160 # define SSL_CTRL_EXTRA_CHAIN_CERT               14
1161 # define SSL_CTRL_SET_MSG_CALLBACK               15
1162 # define SSL_CTRL_SET_MSG_CALLBACK_ARG           16
1163 /* only applies to datagram connections */
1164 # define SSL_CTRL_SET_MTU                17
1165 /* Stats */
1166 # define SSL_CTRL_SESS_NUMBER                    20
1167 # define SSL_CTRL_SESS_CONNECT                   21
1168 # define SSL_CTRL_SESS_CONNECT_GOOD              22
1169 # define SSL_CTRL_SESS_CONNECT_RENEGOTIATE       23
1170 # define SSL_CTRL_SESS_ACCEPT                    24
1171 # define SSL_CTRL_SESS_ACCEPT_GOOD               25
1172 # define SSL_CTRL_SESS_ACCEPT_RENEGOTIATE        26
1173 # define SSL_CTRL_SESS_HIT                       27
1174 # define SSL_CTRL_SESS_CB_HIT                    28
1175 # define SSL_CTRL_SESS_MISSES                    29
1176 # define SSL_CTRL_SESS_TIMEOUTS                  30
1177 # define SSL_CTRL_SESS_CACHE_FULL                31
1178 # define SSL_CTRL_MODE                           33
1179 # define SSL_CTRL_GET_READ_AHEAD                 40
1180 # define SSL_CTRL_SET_READ_AHEAD                 41
1181 # define SSL_CTRL_SET_SESS_CACHE_SIZE            42
1182 # define SSL_CTRL_GET_SESS_CACHE_SIZE            43
1183 # define SSL_CTRL_SET_SESS_CACHE_MODE            44
1184 # define SSL_CTRL_GET_SESS_CACHE_MODE            45
1185 # define SSL_CTRL_GET_MAX_CERT_LIST              50
1186 # define SSL_CTRL_SET_MAX_CERT_LIST              51
1187 # define SSL_CTRL_SET_MAX_SEND_FRAGMENT          52
1188 /* see tls1.h for macros based on these */
1189 # define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB       53
1190 # define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG      54
1191 # define SSL_CTRL_SET_TLSEXT_HOSTNAME            55
1192 # define SSL_CTRL_SET_TLSEXT_DEBUG_CB            56
1193 # define SSL_CTRL_SET_TLSEXT_DEBUG_ARG           57
1194 # define SSL_CTRL_GET_TLSEXT_TICKET_KEYS         58
1195 # define SSL_CTRL_SET_TLSEXT_TICKET_KEYS         59
1196 /*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT    60 */
1197 /*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB 61 */
1198 /*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB_ARG 62 */
1199 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB       63
1200 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB_ARG   64
1201 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_TYPE     65
1202 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_EXTS     66
1203 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_EXTS     67
1204 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_IDS      68
1205 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_IDS      69
1206 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_OCSP_RESP        70
1207 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_OCSP_RESP        71
1208 # define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB       72
1209 # define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME_CB    75
1210 # define SSL_CTRL_SET_SRP_VERIFY_PARAM_CB                76
1211 # define SSL_CTRL_SET_SRP_GIVE_CLIENT_PWD_CB             77
1212 # define SSL_CTRL_SET_SRP_ARG            78
1213 # define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME               79
1214 # define SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH               80
1215 # define SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD               81
1216 # ifndef OPENSSL_NO_HEARTBEATS
1217 #  define SSL_CTRL_DTLS_EXT_SEND_HEARTBEAT               85
1218 #  define SSL_CTRL_GET_DTLS_EXT_HEARTBEAT_PENDING        86
1219 #  define SSL_CTRL_SET_DTLS_EXT_HEARTBEAT_NO_REQUESTS    87
1220 # endif
1221 # define DTLS_CTRL_GET_TIMEOUT           73
1222 # define DTLS_CTRL_HANDLE_TIMEOUT        74
1223 # define SSL_CTRL_GET_RI_SUPPORT                 76
1224 # define SSL_CTRL_CLEAR_MODE                     78
1225 # define SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB      79
1226 # define SSL_CTRL_GET_EXTRA_CHAIN_CERTS          82
1227 # define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS        83
1228 # define SSL_CTRL_CHAIN                          88
1229 # define SSL_CTRL_CHAIN_CERT                     89
1230 # define SSL_CTRL_GET_GROUPS                     90
1231 # define SSL_CTRL_SET_GROUPS                     91
1232 # define SSL_CTRL_SET_GROUPS_LIST                92
1233 # define SSL_CTRL_GET_SHARED_GROUP               93
1234 # define SSL_CTRL_SET_SIGALGS                    97
1235 # define SSL_CTRL_SET_SIGALGS_LIST               98
1236 # define SSL_CTRL_CERT_FLAGS                     99
1237 # define SSL_CTRL_CLEAR_CERT_FLAGS               100
1238 # define SSL_CTRL_SET_CLIENT_SIGALGS             101
1239 # define SSL_CTRL_SET_CLIENT_SIGALGS_LIST        102
1240 # define SSL_CTRL_GET_CLIENT_CERT_TYPES          103
1241 # define SSL_CTRL_SET_CLIENT_CERT_TYPES          104
1242 # define SSL_CTRL_BUILD_CERT_CHAIN               105
1243 # define SSL_CTRL_SET_VERIFY_CERT_STORE          106
1244 # define SSL_CTRL_SET_CHAIN_CERT_STORE           107
1245 # define SSL_CTRL_GET_PEER_SIGNATURE_NID         108
1246 # define SSL_CTRL_GET_SERVER_TMP_KEY             109
1247 # define SSL_CTRL_GET_RAW_CIPHERLIST             110
1248 # define SSL_CTRL_GET_EC_POINT_FORMATS           111
1249 # define SSL_CTRL_GET_CHAIN_CERTS                115
1250 # define SSL_CTRL_SELECT_CURRENT_CERT            116
1251 # define SSL_CTRL_SET_CURRENT_CERT               117
1252 # define SSL_CTRL_SET_DH_AUTO                    118
1253 # define DTLS_CTRL_SET_LINK_MTU                  120
1254 # define DTLS_CTRL_GET_LINK_MIN_MTU              121
1255 # define SSL_CTRL_GET_EXTMS_SUPPORT              122
1256 # define SSL_CTRL_SET_MIN_PROTO_VERSION          123
1257 # define SSL_CTRL_SET_MAX_PROTO_VERSION          124
1258 # define SSL_CTRL_SET_SPLIT_SEND_FRAGMENT        125
1259 # define SSL_CTRL_SET_MAX_PIPELINES              126
1260 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_TYPE     127
1261 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_CB       128
1262 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_CB_ARG   129
1263 # define SSL_CTRL_GET_MIN_PROTO_VERSION          130
1264 # define SSL_CTRL_GET_MAX_PROTO_VERSION          131
1265 # define SSL_CERT_SET_FIRST                      1
1266 # define SSL_CERT_SET_NEXT                       2
1267 # define SSL_CERT_SET_SERVER                     3
1268 # define DTLSv1_get_timeout(ssl, arg) \
1269         SSL_ctrl(ssl,DTLS_CTRL_GET_TIMEOUT,0, (void *)(arg))
1270 # define DTLSv1_handle_timeout(ssl) \
1271         SSL_ctrl(ssl,DTLS_CTRL_HANDLE_TIMEOUT,0, NULL)
1272 # define SSL_num_renegotiations(ssl) \
1273         SSL_ctrl((ssl),SSL_CTRL_GET_NUM_RENEGOTIATIONS,0,NULL)
1274 # define SSL_clear_num_renegotiations(ssl) \
1275         SSL_ctrl((ssl),SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS,0,NULL)
1276 # define SSL_total_renegotiations(ssl) \
1277         SSL_ctrl((ssl),SSL_CTRL_GET_TOTAL_RENEGOTIATIONS,0,NULL)
1278 # define SSL_CTX_set_tmp_dh(ctx,dh) \
1279         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_DH,0,(char *)(dh))
1280 # define SSL_CTX_set_tmp_ecdh(ctx,ecdh) \
1281         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_ECDH,0,(char *)(ecdh))
1282 # define SSL_CTX_set_dh_auto(ctx, onoff) \
1283         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_DH_AUTO,onoff,NULL)
1284 # define SSL_set_dh_auto(s, onoff) \
1285         SSL_ctrl(s,SSL_CTRL_SET_DH_AUTO,onoff,NULL)
1286 # define SSL_set_tmp_dh(ssl,dh) \
1287         SSL_ctrl(ssl,SSL_CTRL_SET_TMP_DH,0,(char *)(dh))
1288 # define SSL_set_tmp_ecdh(ssl,ecdh) \
1289         SSL_ctrl(ssl,SSL_CTRL_SET_TMP_ECDH,0,(char *)(ecdh))
1290 # define SSL_CTX_add_extra_chain_cert(ctx,x509) \
1291         SSL_CTX_ctrl(ctx,SSL_CTRL_EXTRA_CHAIN_CERT,0,(char *)(x509))
1292 # define SSL_CTX_get_extra_chain_certs(ctx,px509) \
1293         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,0,px509)
1294 # define SSL_CTX_get_extra_chain_certs_only(ctx,px509) \
1295         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,1,px509)
1296 # define SSL_CTX_clear_extra_chain_certs(ctx) \
1297         SSL_CTX_ctrl(ctx,SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS,0,NULL)
1298 # define SSL_CTX_set0_chain(ctx,sk) \
1299         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN,0,(char *)(sk))
1300 # define SSL_CTX_set1_chain(ctx,sk) \
1301         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN,1,(char *)(sk))
1302 # define SSL_CTX_add0_chain_cert(ctx,x509) \
1303         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN_CERT,0,(char *)(x509))
1304 # define SSL_CTX_add1_chain_cert(ctx,x509) \
1305         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN_CERT,1,(char *)(x509))
1306 # define SSL_CTX_get0_chain_certs(ctx,px509) \
1307         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_CHAIN_CERTS,0,px509)
1308 # define SSL_CTX_clear_chain_certs(ctx) \
1309         SSL_CTX_set0_chain(ctx,NULL)
1310 # define SSL_CTX_build_cert_chain(ctx, flags) \
1311         SSL_CTX_ctrl(ctx,SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1312 # define SSL_CTX_select_current_cert(ctx,x509) \
1313         SSL_CTX_ctrl(ctx,SSL_CTRL_SELECT_CURRENT_CERT,0,(char *)(x509))
1314 # define SSL_CTX_set_current_cert(ctx, op) \
1315         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CURRENT_CERT, op, NULL)
1316 # define SSL_CTX_set0_verify_cert_store(ctx,st) \
1317         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_VERIFY_CERT_STORE,0,(char *)(st))
1318 # define SSL_CTX_set1_verify_cert_store(ctx,st) \
1319         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_VERIFY_CERT_STORE,1,(char *)(st))
1320 # define SSL_CTX_set0_chain_cert_store(ctx,st) \
1321         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)(st))
1322 # define SSL_CTX_set1_chain_cert_store(ctx,st) \
1323         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)(st))
1324 # define SSL_set0_chain(ctx,sk) \
1325         SSL_ctrl(ctx,SSL_CTRL_CHAIN,0,(char *)(sk))
1326 # define SSL_set1_chain(ctx,sk) \
1327         SSL_ctrl(ctx,SSL_CTRL_CHAIN,1,(char *)(sk))
1328 # define SSL_add0_chain_cert(ctx,x509) \
1329         SSL_ctrl(ctx,SSL_CTRL_CHAIN_CERT,0,(char *)(x509))
1330 # define SSL_add1_chain_cert(ctx,x509) \
1331         SSL_ctrl(ctx,SSL_CTRL_CHAIN_CERT,1,(char *)(x509))
1332 # define SSL_get0_chain_certs(ctx,px509) \
1333         SSL_ctrl(ctx,SSL_CTRL_GET_CHAIN_CERTS,0,px509)
1334 # define SSL_clear_chain_certs(ctx) \
1335         SSL_set0_chain(ctx,NULL)
1336 # define SSL_build_cert_chain(s, flags) \
1337         SSL_ctrl(s,SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1338 # define SSL_select_current_cert(ctx,x509) \
1339         SSL_ctrl(ctx,SSL_CTRL_SELECT_CURRENT_CERT,0,(char *)(x509))
1340 # define SSL_set_current_cert(ctx,op) \
1341         SSL_ctrl(ctx,SSL_CTRL_SET_CURRENT_CERT, op, NULL)
1342 # define SSL_set0_verify_cert_store(s,st) \
1343         SSL_ctrl(s,SSL_CTRL_SET_VERIFY_CERT_STORE,0,(char *)(st))
1344 # define SSL_set1_verify_cert_store(s,st) \
1345         SSL_ctrl(s,SSL_CTRL_SET_VERIFY_CERT_STORE,1,(char *)(st))
1346 # define SSL_set0_chain_cert_store(s,st) \
1347         SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)(st))
1348 # define SSL_set1_chain_cert_store(s,st) \
1349         SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)(st))
1350 # define SSL_get1_groups(ctx, s) \
1351         SSL_ctrl(ctx,SSL_CTRL_GET_GROUPS,0,(char *)(s))
1352 # define SSL_get1_curves(ctx, s) \
1353         SSL_get1_groups((ctx), (s))
1354 # define SSL_CTX_set1_groups(ctx, glist, glistlen) \
1355         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(char *)(glist))
1356 # define SSL_CTX_set1_groups_list(ctx, s) \
1357         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)(s))
1358 # define SSL_CTX_set1_curves(ctx, clist, clistlen) \
1359         SSL_CTX_set1_groups((ctx), (clist), (clistlen))
1360 # define SSL_CTX_set1_curves_list(ctx, s) \
1361         SSL_CTX_set1_groups_list((ctx), (s))
1362 # define SSL_set1_groups(ctx, glist, glistlen) \
1363         SSL_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(char *)(glist))
1364 # define SSL_set1_groups_list(ctx, s) \
1365         SSL_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)(s))
1366 # define SSL_set1_curves(ctx, clist, clistlen) \
1367         SSL_set1_groups((ctx), (clist), (clistlen))
1368 # define SSL_set1_curves_list(ctx, s) \
1369         SSL_set1_groups_list((ctx), (s))
1370 # define SSL_get_shared_group(s, n) \
1371         SSL_ctrl(s,SSL_CTRL_GET_SHARED_GROUP,n,NULL)
1372 # define SSL_get_shared_curve(s, n) \
1373         SSL_get_shared_group((s), (n))
1374 # define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
1375         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS,slistlen,(int *)(slist))
1376 # define SSL_CTX_set1_sigalgs_list(ctx, s) \
1377         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS_LIST,0,(char *)(s))
1378 # define SSL_set1_sigalgs(ctx, slist, slistlen) \
1379         SSL_ctrl(ctx,SSL_CTRL_SET_SIGALGS,slistlen,(int *)(slist))
1380 # define SSL_set1_sigalgs_list(ctx, s) \
1381         SSL_ctrl(ctx,SSL_CTRL_SET_SIGALGS_LIST,0,(char *)(s))
1382 # define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
1383         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS,slistlen,(int *)(slist))
1384 # define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
1385         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS_LIST,0,(char *)(s))
1386 # define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
1387         SSL_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS,clistlen,(int *)(slist))
1388 # define SSL_set1_client_sigalgs_list(ctx, s) \
1389         SSL_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS_LIST,0,(char *)(s))
1390 # define SSL_get0_certificate_types(s, clist) \
1391         SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)(clist))
1392 # define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
1393         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_CERT_TYPES,clistlen, \
1394                      (char *)(clist))
1395 # define SSL_set1_client_certificate_types(s, clist, clistlen) \
1396         SSL_ctrl(s,SSL_CTRL_SET_CLIENT_CERT_TYPES,clistlen,(char *)(clist))
1397 # define SSL_get_peer_signature_nid(s, pn) \
1398         SSL_ctrl(s,SSL_CTRL_GET_PEER_SIGNATURE_NID,0,pn)
1399 # define SSL_get_server_tmp_key(s, pk) \
1400         SSL_ctrl(s,SSL_CTRL_GET_SERVER_TMP_KEY,0,pk)
1401 # define SSL_get0_raw_cipherlist(s, plst) \
1402         SSL_ctrl(s,SSL_CTRL_GET_RAW_CIPHERLIST,0,plst)
1403 # define SSL_get0_ec_point_formats(s, plst) \
1404         SSL_ctrl(s,SSL_CTRL_GET_EC_POINT_FORMATS,0,plst)
1405 #define SSL_CTX_set_min_proto_version(ctx, version) \
1406         SSL_CTX_ctrl(ctx, SSL_CTRL_SET_MIN_PROTO_VERSION, version, NULL)
1407 #define SSL_CTX_set_max_proto_version(ctx, version) \
1408         SSL_CTX_ctrl(ctx, SSL_CTRL_SET_MAX_PROTO_VERSION, version, NULL)
1409 #define SSL_CTX_get_min_proto_version(ctx) \
1410         SSL_CTX_ctrl(ctx, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL)
1411 #define SSL_CTX_get_max_proto_version(ctx) \
1412         SSL_CTX_ctrl(ctx, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL)
1413 #define SSL_set_min_proto_version(s, version) \
1414         SSL_ctrl(s, SSL_CTRL_SET_MIN_PROTO_VERSION, version, NULL)
1415 #define SSL_set_max_proto_version(s, version) \
1416         SSL_ctrl(s, SSL_CTRL_SET_MAX_PROTO_VERSION, version, NULL)
1417 #define SSL_get_min_proto_version(s) \
1418         SSL_ctrl(s, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL)
1419 #define SSL_get_max_proto_version(s) \
1420         SSL_ctrl(s, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL)
1421
1422 #if OPENSSL_API_COMPAT < 0x10100000L
1423 /* Provide some compatibility macros for removed functionality. */
1424 # define SSL_CTX_need_tmp_RSA(ctx)                0
1425 # define SSL_CTX_set_tmp_rsa(ctx,rsa)             1
1426 # define SSL_need_tmp_RSA(ssl)                    0
1427 # define SSL_set_tmp_rsa(ssl,rsa)                 1
1428 # define SSL_CTX_set_ecdh_auto(dummy, onoff)      ((onoff) != 0)
1429 # define SSL_set_ecdh_auto(dummy, onoff)          ((onoff) != 0)
1430 /*
1431  * We "pretend" to call the callback to avoid warnings about unused static
1432  * functions.
1433  */
1434 # define SSL_CTX_set_tmp_rsa_callback(ctx, cb)    while(0) (cb)(NULL, 0, 0)
1435 # define SSL_set_tmp_rsa_callback(ssl, cb)        while(0) (cb)(NULL, 0, 0)
1436 #endif
1437
1438 __owur const BIO_METHOD *BIO_f_ssl(void);
1439 __owur BIO *BIO_new_ssl(SSL_CTX *ctx, int client);
1440 __owur BIO *BIO_new_ssl_connect(SSL_CTX *ctx);
1441 __owur BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx);
1442 __owur int BIO_ssl_copy_session_id(BIO *to, BIO *from);
1443 void BIO_ssl_shutdown(BIO *ssl_bio);
1444
1445 __owur int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
1446 __owur SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth);
1447 int SSL_CTX_up_ref(SSL_CTX *ctx);
1448 void SSL_CTX_free(SSL_CTX *);
1449 __owur long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
1450 __owur long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1451 __owur X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
1452 void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
1453 void SSL_CTX_set1_cert_store(SSL_CTX *, X509_STORE *);
1454 __owur int SSL_want(const SSL *s);
1455 __owur int SSL_clear(SSL *s);
1456
1457 void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
1458
1459 __owur const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
1460 __owur const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s);
1461 __owur int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits);
1462 __owur const char *SSL_CIPHER_get_version(const SSL_CIPHER *c);
1463 __owur const char *SSL_CIPHER_get_name(const SSL_CIPHER *c);
1464 __owur const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c);
1465 __owur const char *OPENSSL_cipher_name(const char *rfc_name);
1466 __owur uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c);
1467 __owur uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c);
1468 __owur int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c);
1469 __owur int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c);
1470 __owur const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c);
1471 __owur int SSL_CIPHER_is_aead(const SSL_CIPHER *c);
1472
1473 __owur int SSL_get_fd(const SSL *s);
1474 __owur int SSL_get_rfd(const SSL *s);
1475 __owur int SSL_get_wfd(const SSL *s);
1476 __owur const char *SSL_get_cipher_list(const SSL *s, int n);
1477 __owur char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len);
1478 __owur int SSL_get_read_ahead(const SSL *s);
1479 __owur int SSL_pending(const SSL *s);
1480 __owur int SSL_has_pending(const SSL *s);
1481 # ifndef OPENSSL_NO_SOCK
1482 __owur int SSL_set_fd(SSL *s, int fd);
1483 __owur int SSL_set_rfd(SSL *s, int fd);
1484 __owur int SSL_set_wfd(SSL *s, int fd);
1485 # endif
1486 void SSL_set0_rbio(SSL *s, BIO *rbio);
1487 void SSL_set0_wbio(SSL *s, BIO *wbio);
1488 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
1489 __owur BIO *SSL_get_rbio(const SSL *s);
1490 __owur BIO *SSL_get_wbio(const SSL *s);
1491 __owur int SSL_set_cipher_list(SSL *s, const char *str);
1492 void SSL_set_read_ahead(SSL *s, int yes);
1493 __owur int SSL_get_verify_mode(const SSL *s);
1494 __owur int SSL_get_verify_depth(const SSL *s);
1495 __owur SSL_verify_cb SSL_get_verify_callback(const SSL *s);
1496 void SSL_set_verify(SSL *s, int mode, SSL_verify_cb callback);
1497 void SSL_set_verify_depth(SSL *s, int depth);
1498 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg);
1499 # ifndef OPENSSL_NO_RSA
1500 __owur int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
1501 __owur int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const unsigned char *d, long len);
1502 # endif
1503 __owur int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
1504 __owur int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const unsigned char *d,
1505                             long len);
1506 __owur int SSL_use_certificate(SSL *ssl, X509 *x);
1507 __owur int SSL_use_certificate_ASN1(SSL *ssl, const unsigned char *d, int len);
1508 __owur int SSL_use_cert_and_key(SSL *ssl, X509 *x509, EVP_PKEY *privatekey,
1509                                 STACK_OF(X509) *chain, int override);
1510
1511
1512 /* serverinfo file format versions */
1513 # define SSL_SERVERINFOV1   1
1514 # define SSL_SERVERINFOV2   2
1515
1516 /* Set serverinfo data for the current active cert. */
1517 __owur int SSL_CTX_use_serverinfo(SSL_CTX *ctx, const unsigned char *serverinfo,
1518                            size_t serverinfo_length);
1519 __owur int SSL_CTX_use_serverinfo_ex(SSL_CTX *ctx, unsigned int version,
1520                                      const unsigned char *serverinfo,
1521                                      size_t serverinfo_length);
1522 __owur int SSL_CTX_use_serverinfo_file(SSL_CTX *ctx, const char *file);
1523
1524 #ifndef OPENSSL_NO_RSA
1525 __owur int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
1526 #endif
1527
1528 __owur int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
1529 __owur int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
1530
1531 #ifndef OPENSSL_NO_RSA
1532 __owur int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
1533 #endif
1534 __owur int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
1535 __owur int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
1536 /* PEM type */
1537 __owur int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
1538 __owur int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
1539 __owur STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
1540 __owur int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1541                                         const char *file);
1542 int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1543                                        const char *dir);
1544
1545 #if OPENSSL_API_COMPAT < 0x10100000L
1546 # define SSL_load_error_strings() \
1547     OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \
1548                      | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
1549 #endif
1550
1551 __owur const char *SSL_state_string(const SSL *s);
1552 __owur const char *SSL_rstate_string(const SSL *s);
1553 __owur const char *SSL_state_string_long(const SSL *s);
1554 __owur const char *SSL_rstate_string_long(const SSL *s);
1555 __owur long SSL_SESSION_get_time(const SSL_SESSION *s);
1556 __owur long SSL_SESSION_set_time(SSL_SESSION *s, long t);
1557 __owur long SSL_SESSION_get_timeout(const SSL_SESSION *s);
1558 __owur long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
1559 __owur int SSL_SESSION_get_protocol_version(const SSL_SESSION *s);
1560 __owur int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version);
1561
1562 __owur const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s);
1563 __owur int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname);
1564 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
1565                                     const unsigned char **alpn,
1566                                     size_t *len);
1567 __owur int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s,
1568                                           const unsigned char *alpn,
1569                                           size_t len);
1570 __owur const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
1571 __owur int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher);
1572 __owur int SSL_SESSION_has_ticket(const SSL_SESSION *s);
1573 __owur unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
1574 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
1575                             size_t *len);
1576 __owur uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s);
1577 __owur int SSL_SESSION_set_max_early_data(SSL_SESSION *s,
1578                                           uint32_t max_early_data);
1579 __owur int SSL_copy_session_id(SSL *to, const SSL *from);
1580 __owur X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
1581 __owur int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
1582                                 unsigned int sid_ctx_len);
1583 __owur int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
1584                                unsigned int sid_len);
1585 __owur int SSL_SESSION_is_resumable(const SSL_SESSION *s);
1586
1587 __owur SSL_SESSION *SSL_SESSION_new(void);
1588 __owur SSL_SESSION *SSL_SESSION_dup(SSL_SESSION *src);
1589 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
1590                                         unsigned int *len);
1591 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
1592                                                 unsigned int *len);
1593 __owur unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s);
1594 # ifndef OPENSSL_NO_STDIO
1595 int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
1596 # endif
1597 int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
1598 int SSL_SESSION_print_keylog(BIO *bp, const SSL_SESSION *x);
1599 int SSL_SESSION_up_ref(SSL_SESSION *ses);
1600 void SSL_SESSION_free(SSL_SESSION *ses);
1601 __owur int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp);
1602 __owur int SSL_set_session(SSL *to, SSL_SESSION *session);
1603 int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
1604 int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
1605 __owur int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
1606 __owur int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
1607 __owur int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
1608                                 unsigned int id_len);
1609 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
1610                              long length);
1611
1612 # ifdef HEADER_X509_H
1613 __owur X509 *SSL_get_peer_certificate(const SSL *s);
1614 # endif
1615
1616 __owur STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
1617
1618 __owur int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1619 __owur int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
1620 __owur SSL_verify_cb SSL_CTX_get_verify_callback(const SSL_CTX *ctx);
1621 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, SSL_verify_cb callback);
1622 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1623 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
1624                                       int (*cb) (X509_STORE_CTX *, void *),
1625                                       void *arg);
1626 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg),
1627                          void *arg);
1628 # ifndef OPENSSL_NO_RSA
1629 __owur int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
1630 __owur int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, const unsigned char *d,
1631                                    long len);
1632 # endif
1633 __owur int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
1634 __owur int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
1635                                 const unsigned char *d, long len);
1636 __owur int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
1637 __owur int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
1638                                  const unsigned char *d);
1639 __owur int SSL_CTX_use_cert_and_key(SSL_CTX *ctx, X509 *x509, EVP_PKEY *privatekey,
1640                                     STACK_OF(X509) *chain, int override);
1641
1642 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);
1643 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u);
1644 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx);
1645 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx);
1646 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb);
1647 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u);
1648 pem_password_cb *SSL_get_default_passwd_cb(SSL *s);
1649 void *SSL_get_default_passwd_cb_userdata(SSL *s);
1650
1651 __owur int SSL_CTX_check_private_key(const SSL_CTX *ctx);
1652 __owur int SSL_check_private_key(const SSL *ctx);
1653
1654 __owur int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
1655                                    unsigned int sid_ctx_len);
1656
1657 SSL *SSL_new(SSL_CTX *ctx);
1658 int SSL_up_ref(SSL *s);
1659 int SSL_is_dtls(const SSL *s);
1660 __owur int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
1661                                unsigned int sid_ctx_len);
1662
1663 __owur int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
1664 __owur int SSL_set_purpose(SSL *s, int purpose);
1665 __owur int SSL_CTX_set_trust(SSL_CTX *s, int trust);
1666 __owur int SSL_set_trust(SSL *s, int trust);
1667
1668 __owur int SSL_set1_host(SSL *s, const char *hostname);
1669 __owur int SSL_add1_host(SSL *s, const char *hostname);
1670 __owur const char *SSL_get0_peername(SSL *s);
1671 void SSL_set_hostflags(SSL *s, unsigned int flags);
1672
1673 __owur int SSL_CTX_dane_enable(SSL_CTX *ctx);
1674 __owur int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md,
1675                                   uint8_t mtype, uint8_t ord);
1676 __owur int SSL_dane_enable(SSL *s, const char *basedomain);
1677 __owur int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1678                              uint8_t mtype, unsigned const char *data, size_t dlen);
1679 __owur int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki);
1680 __owur int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1681                               uint8_t *mtype, unsigned const char **data,
1682                               size_t *dlen);
1683 /*
1684  * Bridge opacity barrier between libcrypt and libssl, also needed to support
1685  * offline testing in test/danetest.c
1686  */
1687 SSL_DANE *SSL_get0_dane(SSL *ssl);
1688 /*
1689  * DANE flags
1690  */
1691 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags);
1692 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags);
1693 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags);
1694 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags);
1695
1696 __owur int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
1697 __owur int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
1698
1699 __owur X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
1700 __owur X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
1701
1702 # ifndef OPENSSL_NO_SRP
1703 int SSL_CTX_set_srp_username(SSL_CTX *ctx, char *name);
1704 int SSL_CTX_set_srp_password(SSL_CTX *ctx, char *password);
1705 int SSL_CTX_set_srp_strength(SSL_CTX *ctx, int strength);
1706 int SSL_CTX_set_srp_client_pwd_callback(SSL_CTX *ctx,
1707                                         char *(*cb) (SSL *, void *));
1708 int SSL_CTX_set_srp_verify_param_callback(SSL_CTX *ctx,
1709                                           int (*cb) (SSL *, void *));
1710 int SSL_CTX_set_srp_username_callback(SSL_CTX *ctx,
1711                                       int (*cb) (SSL *, int *, void *));
1712 int SSL_CTX_set_srp_cb_arg(SSL_CTX *ctx, void *arg);
1713
1714 int SSL_set_srp_server_param(SSL *s, const BIGNUM *N, const BIGNUM *g,
1715                              BIGNUM *sa, BIGNUM *v, char *info);
1716 int SSL_set_srp_server_param_pw(SSL *s, const char *user, const char *pass,
1717                                 const char *grp);
1718
1719 __owur BIGNUM *SSL_get_srp_g(SSL *s);
1720 __owur BIGNUM *SSL_get_srp_N(SSL *s);
1721
1722 __owur char *SSL_get_srp_username(SSL *s);
1723 __owur char *SSL_get_srp_userinfo(SSL *s);
1724 # endif
1725
1726 /*
1727  * ClientHello callback and helpers.
1728  */
1729
1730 # define SSL_CLIENT_HELLO_SUCCESS 1
1731 # define SSL_CLIENT_HELLO_ERROR   0
1732 # define SSL_CLIENT_HELLO_RETRY   (-1)
1733
1734 typedef int (*SSL_client_hello_cb_fn) (SSL *s, int *al, void *arg);
1735 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
1736                                  void *arg);
1737 int SSL_client_hello_isv2(SSL *s);
1738 unsigned int SSL_client_hello_get0_legacy_version(SSL *s);
1739 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out);
1740 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out);
1741 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out);
1742 size_t SSL_client_hello_get0_compression_methods(SSL *s,
1743                                                  const unsigned char **out);
1744 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen);
1745 int SSL_client_hello_get0_ext(SSL *s, unsigned int type,
1746                               const unsigned char **out, size_t *outlen);
1747
1748 void SSL_certs_clear(SSL *s);
1749 void SSL_free(SSL *ssl);
1750 # ifdef OSSL_ASYNC_FD
1751 /*
1752  * Windows application developer has to include windows.h to use these.
1753  */
1754 __owur int SSL_waiting_for_async(SSL *s);
1755 __owur int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds);
1756 __owur int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd,
1757                                      size_t *numaddfds, OSSL_ASYNC_FD *delfd,
1758                                      size_t *numdelfds);
1759 # endif
1760 __owur int SSL_accept(SSL *ssl);
1761 __owur int SSL_stateless(SSL *s);
1762 __owur int SSL_connect(SSL *ssl);
1763 __owur int SSL_read(SSL *ssl, void *buf, int num);
1764 __owur int SSL_read_ex(SSL *ssl, void *buf, size_t num, size_t *readbytes);
1765
1766 # define SSL_READ_EARLY_DATA_ERROR   0
1767 # define SSL_READ_EARLY_DATA_SUCCESS 1
1768 # define SSL_READ_EARLY_DATA_FINISH  2
1769
1770 __owur int SSL_read_early_data(SSL *s, void *buf, size_t num,
1771                                size_t *readbytes);
1772 __owur int SSL_peek(SSL *ssl, void *buf, int num);
1773 __owur int SSL_peek_ex(SSL *ssl, void *buf, size_t num, size_t *readbytes);
1774 __owur int SSL_write(SSL *ssl, const void *buf, int num);
1775 __owur int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written);
1776 __owur int SSL_write_early_data(SSL *s, const void *buf, size_t num,
1777                                 size_t *written);
1778 long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
1779 long SSL_callback_ctrl(SSL *, int, void (*)(void));
1780 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
1781 long SSL_CTX_callback_ctrl(SSL_CTX *, int, void (*)(void));
1782
1783 # define SSL_EARLY_DATA_NOT_SENT    0
1784 # define SSL_EARLY_DATA_REJECTED    1
1785 # define SSL_EARLY_DATA_ACCEPTED    2
1786
1787 __owur int SSL_get_early_data_status(const SSL *s);
1788
1789 __owur int SSL_get_error(const SSL *s, int ret_code);
1790 __owur const char *SSL_get_version(const SSL *s);
1791
1792 /* This sets the 'default' SSL version that SSL_new() will create */
1793 __owur int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth);
1794
1795 # ifndef OPENSSL_NO_SSL3_METHOD
1796 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *SSLv3_method(void)) /* SSLv3 */
1797 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *SSLv3_server_method(void)) /* SSLv3 */
1798 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *SSLv3_client_method(void)) /* SSLv3 */
1799 # endif
1800
1801 #define SSLv23_method           TLS_method
1802 #define SSLv23_server_method    TLS_server_method
1803 #define SSLv23_client_method    TLS_client_method
1804
1805 /* Negotiate highest available SSL/TLS version */
1806 __owur const SSL_METHOD *TLS_method(void);
1807 __owur const SSL_METHOD *TLS_server_method(void);
1808 __owur const SSL_METHOD *TLS_client_method(void);
1809
1810 # ifndef OPENSSL_NO_TLS1_METHOD
1811 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_method(void)) /* TLSv1.0 */
1812 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_server_method(void)) /* TLSv1.0 */
1813 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_client_method(void)) /* TLSv1.0 */
1814 # endif
1815
1816 # ifndef OPENSSL_NO_TLS1_1_METHOD
1817 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_1_method(void)) /* TLSv1.1 */
1818 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_1_server_method(void)) /* TLSv1.1 */
1819 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_1_client_method(void)) /* TLSv1.1 */
1820 # endif
1821
1822 # ifndef OPENSSL_NO_TLS1_2_METHOD
1823 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_2_method(void)) /* TLSv1.2 */
1824 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_2_server_method(void)) /* TLSv1.2 */
1825 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_2_client_method(void)) /* TLSv1.2 */
1826 # endif
1827
1828 # ifndef OPENSSL_NO_DTLS1_METHOD
1829 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_method(void)) /* DTLSv1.0 */
1830 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_server_method(void)) /* DTLSv1.0 */
1831 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_client_method(void)) /* DTLSv1.0 */
1832 # endif
1833
1834 # ifndef OPENSSL_NO_DTLS1_2_METHOD
1835 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_2_method(void)) /* DTLSv1.2 */
1836 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_2_server_method(void)) /* DTLSv1.2 */
1837 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_2_client_method(void)) /* DTLSv1.2 */
1838 #endif
1839
1840 __owur const SSL_METHOD *DTLS_method(void); /* DTLS 1.0 and 1.2 */
1841 __owur const SSL_METHOD *DTLS_server_method(void); /* DTLS 1.0 and 1.2 */
1842 __owur const SSL_METHOD *DTLS_client_method(void); /* DTLS 1.0 and 1.2 */
1843
1844 __owur size_t DTLS_get_data_mtu(const SSL *s);
1845
1846 __owur STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
1847 __owur STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx);
1848 __owur STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s);
1849 __owur STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s);
1850
1851 __owur int SSL_do_handshake(SSL *s);
1852 int SSL_key_update(SSL *s, int updatetype);
1853 int SSL_get_key_update_type(SSL *s);
1854 int SSL_renegotiate(SSL *s);
1855 int SSL_renegotiate_abbreviated(SSL *s);
1856 __owur int SSL_renegotiate_pending(SSL *s);
1857 int SSL_shutdown(SSL *s);
1858 __owur int SSL_verify_client_post_handshake(SSL *s);
1859 void SSL_force_post_handshake_auth(SSL *s);
1860
1861 __owur const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx);
1862 __owur const SSL_METHOD *SSL_get_ssl_method(SSL *s);
1863 __owur int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
1864 __owur const char *SSL_alert_type_string_long(int value);
1865 __owur const char *SSL_alert_type_string(int value);
1866 __owur const char *SSL_alert_desc_string_long(int value);
1867 __owur const char *SSL_alert_desc_string(int value);
1868
1869 void SSL_set0_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
1870 void SSL_CTX_set0_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
1871 __owur const STACK_OF(X509_NAME) *SSL_get0_CA_list(const SSL *s);
1872 __owur const STACK_OF(X509_NAME) *SSL_CTX_get0_CA_list(const SSL_CTX *ctx);
1873 __owur int SSL_add1_CA_list(SSL *ssl, const X509 *x);
1874 __owur int SSL_CTX_add1_CA_list(SSL_CTX *ctx, const X509 *x);
1875 __owur const STACK_OF(X509_NAME) *SSL_get0_peer_CA_list(const SSL *s);
1876
1877 void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
1878 void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
1879 __owur STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
1880 __owur STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(const SSL_CTX *s);
1881 __owur int SSL_add_client_CA(SSL *ssl, X509 *x);
1882 __owur int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
1883
1884 void SSL_set_connect_state(SSL *s);
1885 void SSL_set_accept_state(SSL *s);
1886
1887 __owur long SSL_get_default_timeout(const SSL *s);
1888
1889 #if OPENSSL_API_COMPAT < 0x10100000L
1890 # define SSL_library_init() OPENSSL_init_ssl(0, NULL)
1891 #endif
1892
1893 __owur char *SSL_CIPHER_description(const SSL_CIPHER *, char *buf, int size);
1894 __owur STACK_OF(X509_NAME) *SSL_dup_CA_list(const STACK_OF(X509_NAME) *sk);
1895
1896 __owur SSL *SSL_dup(SSL *ssl);
1897
1898 __owur X509 *SSL_get_certificate(const SSL *ssl);
1899 /*
1900  * EVP_PKEY
1901  */ struct evp_pkey_st *SSL_get_privatekey(const SSL *ssl);
1902
1903 __owur X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
1904 __owur EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
1905
1906 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
1907 __owur int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
1908 void SSL_set_quiet_shutdown(SSL *ssl, int mode);
1909 __owur int SSL_get_quiet_shutdown(const SSL *ssl);
1910 void SSL_set_shutdown(SSL *ssl, int mode);
1911 __owur int SSL_get_shutdown(const SSL *ssl);
1912 __owur int SSL_version(const SSL *ssl);
1913 __owur int SSL_client_version(const SSL *s);
1914 __owur int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
1915 __owur int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx);
1916 __owur int SSL_CTX_set_default_verify_file(SSL_CTX *ctx);
1917 __owur int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
1918                                   const char *CApath);
1919 # define SSL_get0_session SSL_get_session/* just peek at pointer */
1920 __owur SSL_SESSION *SSL_get_session(const SSL *ssl);
1921 __owur SSL_SESSION *SSL_get1_session(SSL *ssl); /* obtain a reference count */
1922 __owur SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
1923 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
1924 void SSL_set_info_callback(SSL *ssl,
1925                            void (*cb) (const SSL *ssl, int type, int val));
1926 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL *ssl, int type,
1927                                                int val);
1928 __owur OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl);
1929
1930 void SSL_set_verify_result(SSL *ssl, long v);
1931 __owur long SSL_get_verify_result(const SSL *ssl);
1932 __owur STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s);
1933
1934 __owur size_t SSL_get_client_random(const SSL *ssl, unsigned char *out,
1935                                     size_t outlen);
1936 __owur size_t SSL_get_server_random(const SSL *ssl, unsigned char *out,
1937                                     size_t outlen);
1938 __owur size_t SSL_SESSION_get_master_key(const SSL_SESSION *sess,
1939                                          unsigned char *out, size_t outlen);
1940 __owur int SSL_SESSION_set1_master_key(SSL_SESSION *sess,
1941                                        const unsigned char *in, size_t len);
1942 uint8_t SSL_SESSION_get_max_fragment_length(const SSL_SESSION *sess);
1943
1944 #define SSL_get_ex_new_index(l, p, newf, dupf, freef) \
1945     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL, l, p, newf, dupf, freef)
1946 __owur int SSL_set_ex_data(SSL *ssl, int idx, void *data);
1947 void *SSL_get_ex_data(const SSL *ssl, int idx);
1948 #define SSL_SESSION_get_ex_new_index(l, p, newf, dupf, freef) \
1949     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, l, p, newf, dupf, freef)
1950 __owur int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx, void *data);
1951 void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
1952 #define SSL_CTX_get_ex_new_index(l, p, newf, dupf, freef) \
1953     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_CTX, l, p, newf, dupf, freef)
1954 __owur int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
1955 void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
1956
1957 __owur int SSL_get_ex_data_X509_STORE_CTX_idx(void);
1958
1959 # define SSL_CTX_sess_set_cache_size(ctx,t) \
1960         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_SIZE,t,NULL)
1961 # define SSL_CTX_sess_get_cache_size(ctx) \
1962         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_SIZE,0,NULL)
1963 # define SSL_CTX_set_session_cache_mode(ctx,m) \
1964         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_MODE,m,NULL)
1965 # define SSL_CTX_get_session_cache_mode(ctx) \
1966         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_MODE,0,NULL)
1967
1968 # define SSL_CTX_get_default_read_ahead(ctx) SSL_CTX_get_read_ahead(ctx)
1969 # define SSL_CTX_set_default_read_ahead(ctx,m) SSL_CTX_set_read_ahead(ctx,m)
1970 # define SSL_CTX_get_read_ahead(ctx) \
1971         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_READ_AHEAD,0,NULL)
1972 # define SSL_CTX_set_read_ahead(ctx,m) \
1973         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_READ_AHEAD,m,NULL)
1974 # define SSL_CTX_get_max_cert_list(ctx) \
1975         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL)
1976 # define SSL_CTX_set_max_cert_list(ctx,m) \
1977         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL)
1978 # define SSL_get_max_cert_list(ssl) \
1979         SSL_ctrl(ssl,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL)
1980 # define SSL_set_max_cert_list(ssl,m) \
1981         SSL_ctrl(ssl,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL)
1982
1983 # define SSL_CTX_set_max_send_fragment(ctx,m) \
1984         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL)
1985 # define SSL_set_max_send_fragment(ssl,m) \
1986         SSL_ctrl(ssl,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL)
1987 # define SSL_CTX_set_split_send_fragment(ctx,m) \
1988         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SPLIT_SEND_FRAGMENT,m,NULL)
1989 # define SSL_set_split_send_fragment(ssl,m) \
1990         SSL_ctrl(ssl,SSL_CTRL_SET_SPLIT_SEND_FRAGMENT,m,NULL)
1991 # define SSL_CTX_set_max_pipelines(ctx,m) \
1992         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_PIPELINES,m,NULL)
1993 # define SSL_set_max_pipelines(ssl,m) \
1994         SSL_ctrl(ssl,SSL_CTRL_SET_MAX_PIPELINES,m,NULL)
1995
1996 void SSL_CTX_set_default_read_buffer_len(SSL_CTX *ctx, size_t len);
1997 void SSL_set_default_read_buffer_len(SSL *s, size_t len);
1998
1999 # ifndef OPENSSL_NO_DH
2000 /* NB: the |keylength| is only applicable when is_export is true */
2001 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
2002                                  DH *(*dh) (SSL *ssl, int is_export,
2003                                             int keylength));
2004 void SSL_set_tmp_dh_callback(SSL *ssl,
2005                              DH *(*dh) (SSL *ssl, int is_export,
2006                                         int keylength));
2007 # endif
2008
2009 __owur const COMP_METHOD *SSL_get_current_compression(SSL *s);
2010 __owur const COMP_METHOD *SSL_get_current_expansion(SSL *s);
2011 __owur const char *SSL_COMP_get_name(const COMP_METHOD *comp);
2012 __owur const char *SSL_COMP_get0_name(const SSL_COMP *comp);
2013 __owur int SSL_COMP_get_id(const SSL_COMP *comp);
2014 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void);
2015 __owur STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
2016                                                       *meths);
2017 #if OPENSSL_API_COMPAT < 0x10100000L
2018 # define SSL_COMP_free_compression_methods() while(0) continue
2019 #endif
2020 __owur int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
2021
2022 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr);
2023 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c);
2024 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c);
2025 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
2026                              int isv2format, STACK_OF(SSL_CIPHER) **sk,
2027                              STACK_OF(SSL_CIPHER) **scsvs);
2028
2029 /* TLS extensions functions */
2030 __owur int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len);
2031
2032 __owur int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
2033                                   void *arg);
2034
2035 /* Pre-shared secret session resumption functions */
2036 __owur int SSL_set_session_secret_cb(SSL *s,
2037                               tls_session_secret_cb_fn tls_session_secret_cb,
2038                               void *arg);
2039
2040 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
2041                                                 int (*cb) (SSL *ssl,
2042                                                            int
2043                                                            is_forward_secure));
2044
2045 void SSL_set_not_resumable_session_callback(SSL *ssl,
2046                                             int (*cb) (SSL *ssl,
2047                                                        int
2048                                                        is_forward_secure));
2049
2050 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
2051                                          size_t (*cb) (SSL *ssl, int type,
2052                                                        size_t len, void *arg));
2053 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg);
2054 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx);
2055 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size);
2056
2057 void SSL_set_record_padding_callback(SSL *ssl,
2058                                     size_t (*cb) (SSL *ssl, int type,
2059                                                   size_t len, void *arg));
2060 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg);
2061 void *SSL_get_record_padding_callback_arg(SSL *ssl);
2062 int SSL_set_block_padding(SSL *ssl, size_t block_size);
2063
2064 # if OPENSSL_API_COMPAT < 0x10100000L
2065 #  define SSL_cache_hit(s) SSL_session_reused(s)
2066 # endif
2067
2068 __owur int SSL_session_reused(SSL *s);
2069 __owur int SSL_is_server(const SSL *s);
2070
2071 __owur __owur SSL_CONF_CTX *SSL_CONF_CTX_new(void);
2072 int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx);
2073 void SSL_CONF_CTX_free(SSL_CONF_CTX *cctx);
2074 unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
2075 __owur unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
2076 __owur int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *pre);
2077
2078 void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl);
2079 void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx);
2080
2081 __owur int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value);
2082 __owur int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
2083 __owur int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd);
2084
2085 void SSL_add_ssl_module(void);
2086 int SSL_config(SSL *s, const char *name);
2087 int SSL_CTX_config(SSL_CTX *ctx, const char *name);
2088
2089 # ifndef OPENSSL_NO_SSL_TRACE
2090 void SSL_trace(int write_p, int version, int content_type,
2091                const void *buf, size_t len, SSL *ssl, void *arg);
2092 # endif
2093
2094 # ifndef OPENSSL_NO_SOCK
2095 int DTLSv1_listen(SSL *s, BIO_ADDR *client);
2096 # endif
2097
2098 # ifndef OPENSSL_NO_CT
2099
2100 /*
2101  * A callback for verifying that the received SCTs are sufficient.
2102  * Expected to return 1 if they are sufficient, otherwise 0.
2103  * May return a negative integer if an error occurs.
2104  * A connection should be aborted if the SCTs are deemed insufficient.
2105  */
2106 typedef int(*ssl_ct_validation_cb)(const CT_POLICY_EVAL_CTX *ctx,
2107                                    const STACK_OF(SCT) *scts, void *arg);
2108
2109 /*
2110  * Sets a |callback| that is invoked upon receipt of ServerHelloDone to validate
2111  * the received SCTs.
2112  * If the callback returns a non-positive result, the connection is terminated.
2113  * Call this function before beginning a handshake.
2114  * If a NULL |callback| is provided, SCT validation is disabled.
2115  * |arg| is arbitrary userdata that will be passed to the callback whenever it
2116  * is invoked. Ownership of |arg| remains with the caller.
2117  *
2118  * NOTE: A side-effect of setting a CT callback is that an OCSP stapled response
2119  *       will be requested.
2120  */
2121 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
2122                                    void *arg);
2123 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
2124                                        ssl_ct_validation_cb callback,
2125                                        void *arg);
2126 #define SSL_disable_ct(s) \
2127         ((void) SSL_set_validation_callback((s), NULL, NULL))
2128 #define SSL_CTX_disable_ct(ctx) \
2129         ((void) SSL_CTX_set_validation_callback((ctx), NULL, NULL))
2130
2131 /*
2132  * The validation type enumerates the available behaviours of the built-in SSL
2133  * CT validation callback selected via SSL_enable_ct() and SSL_CTX_enable_ct().
2134  * The underlying callback is a static function in libssl.
2135  */
2136 enum {
2137     SSL_CT_VALIDATION_PERMISSIVE = 0,
2138     SSL_CT_VALIDATION_STRICT
2139 };
2140
2141 /*
2142  * Enable CT by setting up a callback that implements one of the built-in
2143  * validation variants.  The SSL_CT_VALIDATION_PERMISSIVE variant always
2144  * continues the handshake, the application can make appropriate decisions at
2145  * handshake completion.  The SSL_CT_VALIDATION_STRICT variant requires at
2146  * least one valid SCT, or else handshake termination will be requested.  The
2147  * handshake may continue anyway if SSL_VERIFY_NONE is in effect.
2148  */
2149 int SSL_enable_ct(SSL *s, int validation_mode);
2150 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode);
2151
2152 /*
2153  * Report whether a non-NULL callback is enabled.
2154  */
2155 int SSL_ct_is_enabled(const SSL *s);
2156 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx);
2157
2158 /* Gets the SCTs received from a connection */
2159 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s);
2160
2161 /*
2162  * Loads the CT log list from the default location.
2163  * If a CTLOG_STORE has previously been set using SSL_CTX_set_ctlog_store,
2164  * the log information loaded from this file will be appended to the
2165  * CTLOG_STORE.
2166  * Returns 1 on success, 0 otherwise.
2167  */
2168 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx);
2169
2170 /*
2171  * Loads the CT log list from the specified file path.
2172  * If a CTLOG_STORE has previously been set using SSL_CTX_set_ctlog_store,
2173  * the log information loaded from this file will be appended to the
2174  * CTLOG_STORE.
2175  * Returns 1 on success, 0 otherwise.
2176  */
2177 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
2178
2179 /*
2180  * Sets the CT log list used by all SSL connections created from this SSL_CTX.
2181  * Ownership of the CTLOG_STORE is transferred to the SSL_CTX.
2182  */
2183 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE *logs);
2184
2185 /*
2186  * Gets the CT log list used by all SSL connections created from this SSL_CTX.
2187  * This will be NULL unless one of the following functions has been called:
2188  * - SSL_CTX_set_default_ctlog_list_file
2189  * - SSL_CTX_set_ctlog_list_file
2190  * - SSL_CTX_set_ctlog_store
2191  */
2192 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx);
2193
2194 # endif /* OPENSSL_NO_CT */
2195
2196 /* What the "other" parameter contains in security callback */
2197 /* Mask for type */
2198 # define SSL_SECOP_OTHER_TYPE    0xffff0000
2199 # define SSL_SECOP_OTHER_NONE    0
2200 # define SSL_SECOP_OTHER_CIPHER  (1 << 16)
2201 # define SSL_SECOP_OTHER_CURVE   (2 << 16)
2202 # define SSL_SECOP_OTHER_DH      (3 << 16)
2203 # define SSL_SECOP_OTHER_PKEY    (4 << 16)
2204 # define SSL_SECOP_OTHER_SIGALG  (5 << 16)
2205 # define SSL_SECOP_OTHER_CERT    (6 << 16)
2206
2207 /* Indicated operation refers to peer key or certificate */
2208 # define SSL_SECOP_PEER          0x1000
2209
2210 /* Values for "op" parameter in security callback */
2211
2212 /* Called to filter ciphers */
2213 /* Ciphers client supports */
2214 # define SSL_SECOP_CIPHER_SUPPORTED      (1 | SSL_SECOP_OTHER_CIPHER)
2215 /* Cipher shared by client/server */
2216 # define SSL_SECOP_CIPHER_SHARED         (2 | SSL_SECOP_OTHER_CIPHER)
2217 /* Sanity check of cipher server selects */
2218 # define SSL_SECOP_CIPHER_CHECK          (3 | SSL_SECOP_OTHER_CIPHER)
2219 /* Curves supported by client */
2220 # define SSL_SECOP_CURVE_SUPPORTED       (4 | SSL_SECOP_OTHER_CURVE)
2221 /* Curves shared by client/server */
2222 # define SSL_SECOP_CURVE_SHARED          (5 | SSL_SECOP_OTHER_CURVE)
2223 /* Sanity check of curve server selects */
2224 # define SSL_SECOP_CURVE_CHECK           (6 | SSL_SECOP_OTHER_CURVE)
2225 /* Temporary DH key */
2226 # define SSL_SECOP_TMP_DH                (7 | SSL_SECOP_OTHER_PKEY)
2227 /* SSL/TLS version */
2228 # define SSL_SECOP_VERSION               (9 | SSL_SECOP_OTHER_NONE)
2229 /* Session tickets */
2230 # define SSL_SECOP_TICKET                (10 | SSL_SECOP_OTHER_NONE)
2231 /* Supported signature algorithms sent to peer */
2232 # define SSL_SECOP_SIGALG_SUPPORTED      (11 | SSL_SECOP_OTHER_SIGALG)
2233 /* Shared signature algorithm */
2234 # define SSL_SECOP_SIGALG_SHARED         (12 | SSL_SECOP_OTHER_SIGALG)
2235 /* Sanity check signature algorithm allowed */
2236 # define SSL_SECOP_SIGALG_CHECK          (13 | SSL_SECOP_OTHER_SIGALG)
2237 /* Used to get mask of supported public key signature algorithms */
2238 # define SSL_SECOP_SIGALG_MASK           (14 | SSL_SECOP_OTHER_SIGALG)
2239 /* Use to see if compression is allowed */
2240 # define SSL_SECOP_COMPRESSION           (15 | SSL_SECOP_OTHER_NONE)
2241 /* EE key in certificate */
2242 # define SSL_SECOP_EE_KEY                (16 | SSL_SECOP_OTHER_CERT)
2243 /* CA key in certificate */
2244 # define SSL_SECOP_CA_KEY                (17 | SSL_SECOP_OTHER_CERT)
2245 /* CA digest algorithm in certificate */
2246 # define SSL_SECOP_CA_MD                 (18 | SSL_SECOP_OTHER_CERT)
2247 /* Peer EE key in certificate */
2248 # define SSL_SECOP_PEER_EE_KEY           (SSL_SECOP_EE_KEY | SSL_SECOP_PEER)
2249 /* Peer CA key in certificate */
2250 # define SSL_SECOP_PEER_CA_KEY           (SSL_SECOP_CA_KEY | SSL_SECOP_PEER)
2251 /* Peer CA digest algorithm in certificate */
2252 # define SSL_SECOP_PEER_CA_MD            (SSL_SECOP_CA_MD | SSL_SECOP_PEER)
2253
2254 void SSL_set_security_level(SSL *s, int level);
2255 __owur int SSL_get_security_level(const SSL *s);
2256 void SSL_set_security_callback(SSL *s,
2257                                int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
2258                                           int bits, int nid, void *other,
2259                                           void *ex));
2260 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s, const SSL_CTX *ctx, int op,
2261                                                 int bits, int nid,
2262                                                 void *other, void *ex);
2263 void SSL_set0_security_ex_data(SSL *s, void *ex);
2264 __owur void *SSL_get0_security_ex_data(const SSL *s);
2265
2266 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level);
2267 __owur int SSL_CTX_get_security_level(const SSL_CTX *ctx);
2268 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
2269                                    int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
2270                                               int bits, int nid, void *other,
2271                                               void *ex));
2272 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
2273                                                           const SSL_CTX *ctx,
2274                                                           int op, int bits,
2275                                                           int nid,
2276                                                           void *other,
2277                                                           void *ex);
2278 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex);
2279 __owur void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx);
2280
2281 /* OPENSSL_INIT flag 0x010000 reserved for internal use */
2282 #define OPENSSL_INIT_NO_LOAD_SSL_STRINGS    0x00100000L
2283 #define OPENSSL_INIT_LOAD_SSL_STRINGS       0x00200000L
2284
2285 #define OPENSSL_INIT_SSL_DEFAULT \
2286         (OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
2287
2288 int OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
2289
2290 # ifndef OPENSSL_NO_UNIT_TEST
2291 __owur const struct openssl_ssl_test_functions *SSL_test_functions(void);
2292 # endif
2293
2294 __owur int SSL_free_buffers(SSL *ssl);
2295 __owur int SSL_alloc_buffers(SSL *ssl);
2296
2297 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2298 typedef int SSL_TICKET_RETURN;
2299
2300 /* Support for ticket appdata */
2301 /* fatal error, malloc failure */
2302 # define SSL_TICKET_FATAL_ERR_MALLOC 0
2303 /* fatal error, either from parsing or decrypting the ticket */
2304 # define SSL_TICKET_FATAL_ERR_OTHER  1
2305 /* No ticket present */
2306 # define SSL_TICKET_NONE             2
2307 /* Empty ticket present */
2308 # define SSL_TICKET_EMPTY            3
2309 /* the ticket couldn't be decrypted */
2310 # define SSL_TICKET_NO_DECRYPT       4
2311 /* a ticket was successfully decrypted */
2312 # define SSL_TICKET_SUCCESS          5
2313 /* same as above but the ticket needs to be renewed */
2314 # define SSL_TICKET_SUCCESS_RENEW    6
2315
2316 typedef int (*SSL_CTX_generate_session_ticket_fn)(SSL *s, void *arg);
2317 typedef SSL_TICKET_RETURN (*SSL_CTX_decrypt_session_ticket_fn)(SSL *s, SSL_SESSION *ss,
2318                                                                const unsigned char *keyname,
2319                                                                size_t keyname_length,
2320                                                                SSL_TICKET_RETURN retv,
2321                                                                void *arg);
2322 int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
2323                                   SSL_CTX_generate_session_ticket_fn gen_cb,
2324                                   SSL_CTX_decrypt_session_ticket_fn dec_cb,
2325                                   void *arg);
2326 int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len);
2327 int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len);
2328
2329 extern const char SSL_version_str[];
2330
2331
2332
2333 typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us);
2334
2335 void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb);
2336
2337
2338 # ifdef  __cplusplus
2339 }
2340 # endif
2341 #endif