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