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