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