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