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