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