xref: /freebsd/crypto/openssl/include/openssl/ssl.h.in (revision e7be843b4a162e68651d3911f0357ed464915629)
1/*
2 * {- join("\n * ", @autowarntext) -}
3 *
4 * Copyright 1995-2025 The OpenSSL Project Authors. All Rights Reserved.
5 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
6 * Copyright 2005 Nokia. All rights reserved.
7 *
8 * Licensed under the Apache License 2.0 (the "License").  You may not use
9 * this file except in compliance with the License.  You can obtain a copy
10 * in the file LICENSE in the source distribution or at
11 * https://www.openssl.org/source/license.html
12 */
13
14{-
15use OpenSSL::stackhash qw(generate_stack_macros generate_const_stack_macros);
16-}
17
18#ifndef OPENSSL_SSL_H
19# define OPENSSL_SSL_H
20# pragma once
21
22# include <openssl/macros.h>
23# ifndef OPENSSL_NO_DEPRECATED_3_0
24#  define HEADER_SSL_H
25# endif
26
27# include <openssl/e_os2.h>
28# include <openssl/e_ostime.h>
29# include <openssl/opensslconf.h>
30# include <openssl/comp.h>
31# include <openssl/bio.h>
32# ifndef OPENSSL_NO_DEPRECATED_1_1_0
33#  include <openssl/x509.h>
34#  include <openssl/crypto.h>
35#  include <openssl/buffer.h>
36# endif
37# include <openssl/lhash.h>
38# include <openssl/pem.h>
39# include <openssl/hmac.h>
40# include <openssl/async.h>
41
42# include <openssl/safestack.h>
43# include <openssl/symhacks.h>
44# include <openssl/ct.h>
45# include <openssl/sslerr.h>
46# include <openssl/prov_ssl.h>
47# ifndef OPENSSL_NO_STDIO
48#  include <stdio.h>
49# endif
50
51#ifdef  __cplusplus
52extern "C" {
53#endif
54
55/* OpenSSL version number for ASN.1 encoding of the session information */
56/*-
57 * Version 0 - initial version
58 * Version 1 - added the optional peer certificate
59 */
60# define SSL_SESSION_ASN1_VERSION 0x0001
61
62# define SSL_MAX_SSL_SESSION_ID_LENGTH           32
63# define SSL_MAX_SID_CTX_LENGTH                  32
64
65# define SSL_MIN_RSA_MODULUS_LENGTH_IN_BYTES     (512/8)
66# define SSL_MAX_KEY_ARG_LENGTH                  8
67/* SSL_MAX_MASTER_KEY_LENGTH is defined in prov_ssl.h */
68
69/* The maximum number of encrypt/decrypt pipelines we can support */
70# define SSL_MAX_PIPELINES  32
71
72/* text strings for the ciphers */
73
74/* These are used to specify which ciphers to use and not to use */
75
76# define SSL_TXT_LOW             "LOW"
77# define SSL_TXT_MEDIUM          "MEDIUM"
78# define SSL_TXT_HIGH            "HIGH"
79# define SSL_TXT_FIPS            "FIPS"
80
81# define SSL_TXT_aNULL           "aNULL"
82# define SSL_TXT_eNULL           "eNULL"
83# define SSL_TXT_NULL            "NULL"
84
85# define SSL_TXT_kRSA            "kRSA"
86# define SSL_TXT_kDHr            "kDHr"/* this cipher class has been removed */
87# define SSL_TXT_kDHd            "kDHd"/* this cipher class has been removed */
88# define SSL_TXT_kDH             "kDH"/* this cipher class has been removed */
89# define SSL_TXT_kEDH            "kEDH"/* alias for kDHE */
90# define SSL_TXT_kDHE            "kDHE"
91# define SSL_TXT_kECDHr          "kECDHr"/* this cipher class has been removed */
92# define SSL_TXT_kECDHe          "kECDHe"/* this cipher class has been removed */
93# define SSL_TXT_kECDH           "kECDH"/* this cipher class has been removed */
94# define SSL_TXT_kEECDH          "kEECDH"/* alias for kECDHE */
95# define SSL_TXT_kECDHE          "kECDHE"
96# define SSL_TXT_kPSK            "kPSK"
97# define SSL_TXT_kRSAPSK         "kRSAPSK"
98# define SSL_TXT_kECDHEPSK       "kECDHEPSK"
99# define SSL_TXT_kDHEPSK         "kDHEPSK"
100# define SSL_TXT_kGOST           "kGOST"
101# define SSL_TXT_kGOST18         "kGOST18"
102# define SSL_TXT_kSRP            "kSRP"
103
104# define SSL_TXT_aRSA            "aRSA"
105# define SSL_TXT_aDSS            "aDSS"
106# define SSL_TXT_aDH             "aDH"/* this cipher class has been removed */
107# define SSL_TXT_aECDH           "aECDH"/* this cipher class has been removed */
108# define SSL_TXT_aECDSA          "aECDSA"
109# define SSL_TXT_aPSK            "aPSK"
110# define SSL_TXT_aGOST94         "aGOST94"
111# define SSL_TXT_aGOST01         "aGOST01"
112# define SSL_TXT_aGOST12         "aGOST12"
113# define SSL_TXT_aGOST           "aGOST"
114# define SSL_TXT_aSRP            "aSRP"
115
116# define SSL_TXT_DSS             "DSS"
117# define SSL_TXT_DH              "DH"
118# define SSL_TXT_DHE             "DHE"/* same as "kDHE:-ADH" */
119# define SSL_TXT_EDH             "EDH"/* alias for DHE */
120# define SSL_TXT_ADH             "ADH"
121# define SSL_TXT_RSA             "RSA"
122# define SSL_TXT_ECDH            "ECDH"
123# define SSL_TXT_EECDH           "EECDH"/* alias for ECDHE" */
124# define SSL_TXT_ECDHE           "ECDHE"/* same as "kECDHE:-AECDH" */
125# define SSL_TXT_AECDH           "AECDH"
126# define SSL_TXT_ECDSA           "ECDSA"
127# define SSL_TXT_PSK             "PSK"
128# define SSL_TXT_SRP             "SRP"
129
130# define SSL_TXT_DES             "DES"
131# define SSL_TXT_3DES            "3DES"
132# define SSL_TXT_RC4             "RC4"
133# define SSL_TXT_RC2             "RC2"
134# define SSL_TXT_IDEA            "IDEA"
135# define SSL_TXT_SEED            "SEED"
136# define SSL_TXT_AES128          "AES128"
137# define SSL_TXT_AES256          "AES256"
138# define SSL_TXT_AES             "AES"
139# define SSL_TXT_AES_GCM         "AESGCM"
140# define SSL_TXT_AES_CCM         "AESCCM"
141# define SSL_TXT_AES_CCM_8       "AESCCM8"
142# define SSL_TXT_CAMELLIA128     "CAMELLIA128"
143# define SSL_TXT_CAMELLIA256     "CAMELLIA256"
144# define SSL_TXT_CAMELLIA        "CAMELLIA"
145# define SSL_TXT_CHACHA20        "CHACHA20"
146# define SSL_TXT_GOST            "GOST89"
147# define SSL_TXT_ARIA            "ARIA"
148# define SSL_TXT_ARIA_GCM        "ARIAGCM"
149# define SSL_TXT_ARIA128         "ARIA128"
150# define SSL_TXT_ARIA256         "ARIA256"
151# define SSL_TXT_GOST2012_GOST8912_GOST8912 "GOST2012-GOST8912-GOST8912"
152# define SSL_TXT_CBC             "CBC"
153
154# define SSL_TXT_MD5             "MD5"
155# define SSL_TXT_SHA1            "SHA1"
156# define SSL_TXT_SHA             "SHA"/* same as "SHA1" */
157# define SSL_TXT_GOST94          "GOST94"
158# define SSL_TXT_GOST89MAC       "GOST89MAC"
159# define SSL_TXT_GOST12          "GOST12"
160# define SSL_TXT_GOST89MAC12     "GOST89MAC12"
161# define SSL_TXT_SHA256          "SHA256"
162# define SSL_TXT_SHA384          "SHA384"
163
164# define SSL_TXT_SSLV3           "SSLv3"
165# define SSL_TXT_TLSV1           "TLSv1"
166# define SSL_TXT_TLSV1_1         "TLSv1.1"
167# define SSL_TXT_TLSV1_2         "TLSv1.2"
168
169# define SSL_TXT_ALL             "ALL"
170
171/*-
172 * COMPLEMENTOF* definitions. These identifiers are used to (de-select)
173 * ciphers normally not being used.
174 * Example: "RC4" will activate all ciphers using RC4 including ciphers
175 * without authentication, which would normally disabled by DEFAULT (due
176 * the "!ADH" being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT"
177 * will make sure that it is also disabled in the specific selection.
178 * COMPLEMENTOF* identifiers are portable between version, as adjustments
179 * to the default cipher setup will also be included here.
180 *
181 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
182 * DEFAULT gets, as only selection is being done and no sorting as needed
183 * for DEFAULT.
184 */
185# define SSL_TXT_CMPALL          "COMPLEMENTOFALL"
186# define SSL_TXT_CMPDEF          "COMPLEMENTOFDEFAULT"
187
188/*
189 * The following cipher list is used by default. It also is substituted when
190 * an application-defined cipher list string starts with 'DEFAULT'.
191 * This applies to ciphersuites for TLSv1.2 and below.
192 * DEPRECATED IN 3.0.0, in favor of OSSL_default_cipher_list()
193 * Update both macro and function simultaneously
194 */
195# ifndef OPENSSL_NO_DEPRECATED_3_0
196#  define SSL_DEFAULT_CIPHER_LIST "ALL:!COMPLEMENTOFDEFAULT:!eNULL"
197/*
198 * This is the default set of TLSv1.3 ciphersuites
199 * DEPRECATED IN 3.0.0, in favor of OSSL_default_ciphersuites()
200 * Update both macro and function simultaneously
201 */
202#  define TLS_DEFAULT_CIPHERSUITES "TLS_AES_256_GCM_SHA384:" \
203                                   "TLS_CHACHA20_POLY1305_SHA256:" \
204                                   "TLS_AES_128_GCM_SHA256"
205# endif
206/*
207 * As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
208 * starts with a reasonable order, and all we have to do for DEFAULT is
209 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
210 * actually enabled by ALL, but "ALL:RSA" would enable some of them.)
211 */
212
213/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
214# define SSL_SENT_SHUTDOWN       1
215# define SSL_RECEIVED_SHUTDOWN   2
216
217#ifdef __cplusplus
218}
219#endif
220
221#ifdef  __cplusplus
222extern "C" {
223#endif
224
225# define SSL_FILETYPE_ASN1       X509_FILETYPE_ASN1
226# define SSL_FILETYPE_PEM        X509_FILETYPE_PEM
227
228/*
229 * This is needed to stop compilers complaining about the 'struct ssl_st *'
230 * function parameters used to prototype callbacks in SSL_CTX.
231 */
232typedef struct ssl_st *ssl_crock_st;
233typedef struct tls_session_ticket_ext_st TLS_SESSION_TICKET_EXT;
234typedef struct ssl_method_st SSL_METHOD;
235typedef struct ssl_cipher_st SSL_CIPHER;
236typedef struct ssl_session_st SSL_SESSION;
237typedef struct tls_sigalgs_st TLS_SIGALGS;
238typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
239
240STACK_OF(SSL_CIPHER);
241
242/* SRTP protection profiles for use with the use_srtp extension (RFC 5764)*/
243typedef struct srtp_protection_profile_st {
244    const char *name;
245    unsigned long id;
246} SRTP_PROTECTION_PROFILE;
247{-
248    generate_stack_macros("SRTP_PROTECTION_PROFILE");
249-}
250
251
252typedef int (*tls_session_ticket_ext_cb_fn)(SSL *s, const unsigned char *data,
253                                            int len, void *arg);
254typedef int (*tls_session_secret_cb_fn)(SSL *s, void *secret, int *secret_len,
255                                        STACK_OF(SSL_CIPHER) *peer_ciphers,
256                                        const SSL_CIPHER **cipher, void *arg);
257
258/* Extension context codes */
259/* This extension is only allowed in TLS */
260#define SSL_EXT_TLS_ONLY                        0x00001
261/* This extension is only allowed in DTLS */
262#define SSL_EXT_DTLS_ONLY                       0x00002
263/* Some extensions may be allowed in DTLS but we don't implement them for it */
264#define SSL_EXT_TLS_IMPLEMENTATION_ONLY         0x00004
265/* Most extensions are not defined for SSLv3 but EXT_TYPE_renegotiate is */
266#define SSL_EXT_SSL3_ALLOWED                    0x00008
267/* Extension is only defined for TLS1.2 and below */
268#define SSL_EXT_TLS1_2_AND_BELOW_ONLY           0x00010
269/* Extension is only defined for TLS1.3 and above */
270#define SSL_EXT_TLS1_3_ONLY                     0x00020
271/* Ignore this extension during parsing if we are resuming */
272#define SSL_EXT_IGNORE_ON_RESUMPTION            0x00040
273#define SSL_EXT_CLIENT_HELLO                    0x00080
274/* Really means TLS1.2 or below */
275#define SSL_EXT_TLS1_2_SERVER_HELLO             0x00100
276#define SSL_EXT_TLS1_3_SERVER_HELLO             0x00200
277#define SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS     0x00400
278#define SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST      0x00800
279#define SSL_EXT_TLS1_3_CERTIFICATE              0x01000
280#define SSL_EXT_TLS1_3_NEW_SESSION_TICKET       0x02000
281#define SSL_EXT_TLS1_3_CERTIFICATE_REQUEST      0x04000
282#define SSL_EXT_TLS1_3_CERTIFICATE_COMPRESSION  0x08000
283/* When sending a raw public key in a certificate message */
284#define SSL_EXT_TLS1_3_RAW_PUBLIC_KEY           0x10000
285
286/* Typedefs for handling custom extensions */
287
288typedef int (*custom_ext_add_cb)(SSL *s, unsigned int ext_type,
289                                 const unsigned char **out, size_t *outlen,
290                                 int *al, void *add_arg);
291
292typedef void (*custom_ext_free_cb)(SSL *s, unsigned int ext_type,
293                                   const unsigned char *out, void *add_arg);
294
295typedef int (*custom_ext_parse_cb)(SSL *s, unsigned int ext_type,
296                                   const unsigned char *in, size_t inlen,
297                                   int *al, void *parse_arg);
298
299
300typedef int (*SSL_custom_ext_add_cb_ex)(SSL *s, unsigned int ext_type,
301                                        unsigned int context,
302                                        const unsigned char **out,
303                                        size_t *outlen, X509 *x,
304                                        size_t chainidx,
305                                        int *al, void *add_arg);
306
307typedef void (*SSL_custom_ext_free_cb_ex)(SSL *s, unsigned int ext_type,
308                                          unsigned int context,
309                                          const unsigned char *out,
310                                          void *add_arg);
311
312typedef int (*SSL_custom_ext_parse_cb_ex)(SSL *s, unsigned int ext_type,
313                                          unsigned int context,
314                                          const unsigned char *in,
315                                          size_t inlen, X509 *x,
316                                          size_t chainidx,
317                                          int *al, void *parse_arg);
318
319/* Typedef for verification callback */
320typedef int (*SSL_verify_cb)(int preverify_ok, X509_STORE_CTX *x509_ctx);
321
322/* Typedef for SSL async callback */
323typedef int (*SSL_async_callback_fn)(SSL *s, void *arg);
324
325#define SSL_OP_BIT(n)  ((uint64_t)1 << (uint64_t)n)
326
327/*
328 * SSL/TLS connection options.
329 */
330    /* Disable Extended master secret */
331# define SSL_OP_NO_EXTENDED_MASTER_SECRET                SSL_OP_BIT(0)
332    /* Cleanse plaintext copies of data delivered to the application */
333# define SSL_OP_CLEANSE_PLAINTEXT                        SSL_OP_BIT(1)
334    /* Allow initial connection to servers that don't support RI */
335# define SSL_OP_LEGACY_SERVER_CONNECT                    SSL_OP_BIT(2)
336    /* Enable support for Kernel TLS */
337# define SSL_OP_ENABLE_KTLS                              SSL_OP_BIT(3)
338# define SSL_OP_TLSEXT_PADDING                           SSL_OP_BIT(4)
339# define SSL_OP_SAFARI_ECDHE_ECDSA_BUG                   SSL_OP_BIT(6)
340# define SSL_OP_IGNORE_UNEXPECTED_EOF                    SSL_OP_BIT(7)
341# define SSL_OP_ALLOW_CLIENT_RENEGOTIATION               SSL_OP_BIT(8)
342# define SSL_OP_DISABLE_TLSEXT_CA_NAMES                  SSL_OP_BIT(9)
343    /* In TLSv1.3 allow a non-(ec)dhe based kex_mode */
344# define SSL_OP_ALLOW_NO_DHE_KEX                         SSL_OP_BIT(10)
345    /*
346     * Disable SSL 3.0/TLS 1.0 CBC vulnerability workaround that was added
347     * in OpenSSL 0.9.6d.  Usually (depending on the application protocol)
348     * the workaround is not needed.  Unfortunately some broken SSL/TLS
349     * implementations cannot handle it at all, which is why we include it
350     * in SSL_OP_ALL. Added in 0.9.6e
351     */
352# define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS              SSL_OP_BIT(11)
353    /* DTLS options */
354# define SSL_OP_NO_QUERY_MTU                             SSL_OP_BIT(12)
355    /* Turn on Cookie Exchange (on relevant for servers) */
356# define SSL_OP_COOKIE_EXCHANGE                          SSL_OP_BIT(13)
357    /* Don't use RFC4507 ticket extension */
358# define SSL_OP_NO_TICKET                                SSL_OP_BIT(14)
359# ifndef OPENSSL_NO_DTLS1_METHOD
360    /*
361     * Use Cisco's version identifier of DTLS_BAD_VER
362     * (only with deprecated DTLSv1_client_method())
363     */
364#  define SSL_OP_CISCO_ANYCONNECT                        SSL_OP_BIT(15)
365# endif
366    /* As server, disallow session resumption on renegotiation */
367# define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION   SSL_OP_BIT(16)
368    /* Don't use compression even if supported */
369# define SSL_OP_NO_COMPRESSION                           SSL_OP_BIT(17)
370    /* Permit unsafe legacy renegotiation */
371# define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION        SSL_OP_BIT(18)
372    /* Disable encrypt-then-mac */
373# define SSL_OP_NO_ENCRYPT_THEN_MAC                      SSL_OP_BIT(19)
374    /*
375     * Enable TLSv1.3 Compatibility mode. This is on by default. A future
376     * version of OpenSSL may have this disabled by default.
377     */
378# define SSL_OP_ENABLE_MIDDLEBOX_COMPAT                  SSL_OP_BIT(20)
379    /*
380     * Prioritize Chacha20Poly1305 when client does.
381     * Modifies SSL_OP_CIPHER_SERVER_PREFERENCE
382     */
383# define SSL_OP_PRIORITIZE_CHACHA                        SSL_OP_BIT(21)
384    /*
385     * Set on servers to choose the cipher according to server's preferences.
386     */
387# define SSL_OP_CIPHER_SERVER_PREFERENCE                 SSL_OP_BIT(22)
388    /*
389     * If set, a server will allow a client to issue an SSLv3.0 version
390     * number as latest version supported in the premaster secret, even when
391     * TLSv1.0 (version 3.1) was announced in the client hello. Normally
392     * this is forbidden to prevent version rollback attacks.
393     */
394# define SSL_OP_TLS_ROLLBACK_BUG                         SSL_OP_BIT(23)
395    /*
396     * Switches off automatic TLSv1.3 anti-replay protection for early data.
397     * This is a server-side option only (no effect on the client).
398     */
399# define SSL_OP_NO_ANTI_REPLAY                           SSL_OP_BIT(24)
400# define SSL_OP_NO_SSLv3                                 SSL_OP_BIT(25)
401# define SSL_OP_NO_TLSv1                                 SSL_OP_BIT(26)
402# define SSL_OP_NO_TLSv1_2                               SSL_OP_BIT(27)
403# define SSL_OP_NO_TLSv1_1                               SSL_OP_BIT(28)
404# define SSL_OP_NO_TLSv1_3                               SSL_OP_BIT(29)
405# define SSL_OP_NO_DTLSv1                                SSL_OP_BIT(26)
406# define SSL_OP_NO_DTLSv1_2                              SSL_OP_BIT(27)
407    /* Disallow all renegotiation */
408# define SSL_OP_NO_RENEGOTIATION                         SSL_OP_BIT(30)
409    /*
410     * Make server add server-hello extension from early version of
411     * cryptopro draft, when GOST ciphersuite is negotiated. Required for
412     * interoperability with CryptoPro CSP 3.x
413     */
414# define SSL_OP_CRYPTOPRO_TLSEXT_BUG                     SSL_OP_BIT(31)
415/*
416 * Disable RFC8879 certificate compression
417 * SSL_OP_NO_TX_CERTIFICATE_COMPRESSION: don't send compressed certificates,
418 *     and ignore the extension when received.
419 * SSL_OP_NO_RX_CERTIFICATE_COMPRESSION: don't send the extension, and
420 *     subsequently indicating that receiving is not supported
421 */
422# define SSL_OP_NO_TX_CERTIFICATE_COMPRESSION            SSL_OP_BIT(32)
423# define SSL_OP_NO_RX_CERTIFICATE_COMPRESSION            SSL_OP_BIT(33)
424    /* Enable KTLS TX zerocopy on Linux */
425# define SSL_OP_ENABLE_KTLS_TX_ZEROCOPY_SENDFILE         SSL_OP_BIT(34)
426
427#define SSL_OP_PREFER_NO_DHE_KEX                         SSL_OP_BIT(35)
428
429/*
430 * Option "collections."
431 */
432# define SSL_OP_NO_SSL_MASK \
433        ( SSL_OP_NO_SSLv3 | SSL_OP_NO_TLSv1 | SSL_OP_NO_TLSv1_1 \
434          | SSL_OP_NO_TLSv1_2 | SSL_OP_NO_TLSv1_3 )
435# define SSL_OP_NO_DTLS_MASK \
436        ( SSL_OP_NO_DTLSv1 | SSL_OP_NO_DTLSv1_2 )
437
438/* Various bug workarounds that should be rather harmless. */
439# define SSL_OP_ALL \
440        ( SSL_OP_CRYPTOPRO_TLSEXT_BUG | SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS \
441          | SSL_OP_TLSEXT_PADDING | SSL_OP_SAFARI_ECDHE_ECDSA_BUG )
442
443/*
444 * OBSOLETE OPTIONS retained for compatibility
445 */
446
447# define SSL_OP_MICROSOFT_SESS_ID_BUG                    0x0
448# define SSL_OP_NETSCAPE_CHALLENGE_BUG                   0x0
449# define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG         0x0
450# define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG              0x0
451# define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER               0x0
452# define SSL_OP_MSIE_SSLV2_RSA_PADDING                   0x0
453# define SSL_OP_SSLEAY_080_CLIENT_DH_BUG                 0x0
454# define SSL_OP_TLS_D5_BUG                               0x0
455# define SSL_OP_TLS_BLOCK_PADDING_BUG                    0x0
456# define SSL_OP_SINGLE_ECDH_USE                          0x0
457# define SSL_OP_SINGLE_DH_USE                            0x0
458# define SSL_OP_EPHEMERAL_RSA                            0x0
459# define SSL_OP_NO_SSLv2                                 0x0
460# define SSL_OP_PKCS1_CHECK_1                            0x0
461# define SSL_OP_PKCS1_CHECK_2                            0x0
462# define SSL_OP_NETSCAPE_CA_DN_BUG                       0x0
463# define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG          0x0
464
465/*
466 * Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success
467 * when just a single record has been written):
468 */
469# define SSL_MODE_ENABLE_PARTIAL_WRITE       0x00000001U
470/*
471 * Make it possible to retry SSL_write() with changed buffer location (buffer
472 * contents must stay the same!); this is not the default to avoid the
473 * misconception that non-blocking SSL_write() behaves like non-blocking
474 * write():
475 */
476# define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002U
477/*
478 * Never bother the application with retries if the transport is blocking:
479 */
480# define SSL_MODE_AUTO_RETRY 0x00000004U
481/* Don't attempt to automatically build certificate chain */
482# define SSL_MODE_NO_AUTO_CHAIN 0x00000008U
483/*
484 * Save RAM by releasing read and write buffers when they're empty. (SSL3 and
485 * TLS only.) Released buffers are freed.
486 */
487# define SSL_MODE_RELEASE_BUFFERS 0x00000010U
488/*
489 * Send the current time in the Random fields of the ClientHello and
490 * ServerHello records for compatibility with hypothetical implementations
491 * that require it.
492 */
493# define SSL_MODE_SEND_CLIENTHELLO_TIME 0x00000020U
494# define SSL_MODE_SEND_SERVERHELLO_TIME 0x00000040U
495/*
496 * Send TLS_FALLBACK_SCSV in the ClientHello. To be set only by applications
497 * that reconnect with a downgraded protocol version; see
498 * draft-ietf-tls-downgrade-scsv-00 for details. DO NOT ENABLE THIS if your
499 * application attempts a normal handshake. Only use this in explicit
500 * fallback retries, following the guidance in
501 * draft-ietf-tls-downgrade-scsv-00.
502 */
503# define SSL_MODE_SEND_FALLBACK_SCSV 0x00000080U
504/*
505 * Support Asynchronous operation
506 */
507# define SSL_MODE_ASYNC 0x00000100U
508
509/*
510 * When using DTLS/SCTP, include the terminating zero in the label
511 * used for computing the endpoint-pair shared secret. Required for
512 * interoperability with implementations having this bug like these
513 * older version of OpenSSL:
514 * - OpenSSL 1.0.0 series
515 * - OpenSSL 1.0.1 series
516 * - OpenSSL 1.0.2 series
517 * - OpenSSL 1.1.0 series
518 * - OpenSSL 1.1.1 and 1.1.1a
519 */
520# define SSL_MODE_DTLS_SCTP_LABEL_LENGTH_BUG 0x00000400U
521
522/* Cert related flags */
523/*
524 * Many implementations ignore some aspects of the TLS standards such as
525 * enforcing certificate chain algorithms. When this is set we enforce them.
526 */
527# define SSL_CERT_FLAG_TLS_STRICT                0x00000001U
528
529/* Suite B modes, takes same values as certificate verify flags */
530# define SSL_CERT_FLAG_SUITEB_128_LOS_ONLY       0x10000
531/* Suite B 192 bit only mode */
532# define SSL_CERT_FLAG_SUITEB_192_LOS            0x20000
533/* Suite B 128 bit mode allowing 192 bit algorithms */
534# define SSL_CERT_FLAG_SUITEB_128_LOS            0x30000
535
536/* Perform all sorts of protocol violations for testing purposes */
537# define SSL_CERT_FLAG_BROKEN_PROTOCOL           0x10000000
538
539/* Flags for building certificate chains */
540/* Treat any existing certificates as untrusted CAs */
541# define SSL_BUILD_CHAIN_FLAG_UNTRUSTED          0x1
542/* Don't include root CA in chain */
543# define SSL_BUILD_CHAIN_FLAG_NO_ROOT            0x2
544/* Just check certificates already there */
545# define SSL_BUILD_CHAIN_FLAG_CHECK              0x4
546/* Ignore verification errors */
547# define SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR       0x8
548/* Clear verification errors from queue */
549# define SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR        0x10
550
551/* Flags returned by SSL_check_chain */
552/* Certificate can be used with this session */
553# define CERT_PKEY_VALID         0x1
554/* Certificate can also be used for signing */
555# define CERT_PKEY_SIGN          0x2
556/* EE certificate signing algorithm OK */
557# define CERT_PKEY_EE_SIGNATURE  0x10
558/* CA signature algorithms OK */
559# define CERT_PKEY_CA_SIGNATURE  0x20
560/* EE certificate parameters OK */
561# define CERT_PKEY_EE_PARAM      0x40
562/* CA certificate parameters OK */
563# define CERT_PKEY_CA_PARAM      0x80
564/* Signing explicitly allowed as opposed to SHA1 fallback */
565# define CERT_PKEY_EXPLICIT_SIGN 0x100
566/* Client CA issuer names match (always set for server cert) */
567# define CERT_PKEY_ISSUER_NAME   0x200
568/* Cert type matches client types (always set for server cert) */
569# define CERT_PKEY_CERT_TYPE     0x400
570/* Cert chain suitable to Suite B */
571# define CERT_PKEY_SUITEB        0x800
572/* Cert pkey valid for raw public key use */
573# define CERT_PKEY_RPK           0x1000
574
575# define SSL_CONF_FLAG_CMDLINE           0x1
576# define SSL_CONF_FLAG_FILE              0x2
577# define SSL_CONF_FLAG_CLIENT            0x4
578# define SSL_CONF_FLAG_SERVER            0x8
579# define SSL_CONF_FLAG_SHOW_ERRORS       0x10
580# define SSL_CONF_FLAG_CERTIFICATE       0x20
581# define SSL_CONF_FLAG_REQUIRE_PRIVATE   0x40
582/* Configuration value types */
583# define SSL_CONF_TYPE_UNKNOWN           0x0
584# define SSL_CONF_TYPE_STRING            0x1
585# define SSL_CONF_TYPE_FILE              0x2
586# define SSL_CONF_TYPE_DIR               0x3
587# define SSL_CONF_TYPE_NONE              0x4
588# define SSL_CONF_TYPE_STORE             0x5
589
590/* Maximum length of the application-controlled segment of a a TLSv1.3 cookie */
591# define SSL_COOKIE_LENGTH                       4096
592
593/*
594 * Note: SSL[_CTX]_set_{options,mode} use |= op on the previous value, they
595 * cannot be used to clear bits.
596 */
597
598uint64_t SSL_CTX_get_options(const SSL_CTX *ctx);
599uint64_t SSL_get_options(const SSL *s);
600uint64_t SSL_CTX_clear_options(SSL_CTX *ctx, uint64_t op);
601uint64_t SSL_clear_options(SSL *s, uint64_t op);
602uint64_t SSL_CTX_set_options(SSL_CTX *ctx, uint64_t op);
603uint64_t SSL_set_options(SSL *s, uint64_t op);
604
605# define SSL_CTX_set_mode(ctx,op) \
606        SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,(op),NULL)
607# define SSL_CTX_clear_mode(ctx,op) \
608        SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_MODE,(op),NULL)
609# define SSL_CTX_get_mode(ctx) \
610        SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,0,NULL)
611# define SSL_clear_mode(ssl,op) \
612        SSL_ctrl((ssl),SSL_CTRL_CLEAR_MODE,(op),NULL)
613# define SSL_set_mode(ssl,op) \
614        SSL_ctrl((ssl),SSL_CTRL_MODE,(op),NULL)
615# define SSL_get_mode(ssl) \
616        SSL_ctrl((ssl),SSL_CTRL_MODE,0,NULL)
617# define SSL_set_mtu(ssl, mtu) \
618        SSL_ctrl((ssl),SSL_CTRL_SET_MTU,(mtu),NULL)
619# define DTLS_set_link_mtu(ssl, mtu) \
620        SSL_ctrl((ssl),DTLS_CTRL_SET_LINK_MTU,(mtu),NULL)
621# define DTLS_get_link_min_mtu(ssl) \
622        SSL_ctrl((ssl),DTLS_CTRL_GET_LINK_MIN_MTU,0,NULL)
623
624# define SSL_get_secure_renegotiation_support(ssl) \
625        SSL_ctrl((ssl), SSL_CTRL_GET_RI_SUPPORT, 0, NULL)
626
627# define SSL_CTX_set_cert_flags(ctx,op) \
628        SSL_CTX_ctrl((ctx),SSL_CTRL_CERT_FLAGS,(op),NULL)
629# define SSL_set_cert_flags(s,op) \
630        SSL_ctrl((s),SSL_CTRL_CERT_FLAGS,(op),NULL)
631# define SSL_CTX_clear_cert_flags(ctx,op) \
632        SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_CERT_FLAGS,(op),NULL)
633# define SSL_clear_cert_flags(s,op) \
634        SSL_ctrl((s),SSL_CTRL_CLEAR_CERT_FLAGS,(op),NULL)
635
636void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
637                              void (*cb) (int write_p, int version,
638                                          int content_type, const void *buf,
639                                          size_t len, SSL *ssl, void *arg));
640void SSL_set_msg_callback(SSL *ssl,
641                          void (*cb) (int write_p, int version,
642                                      int content_type, const void *buf,
643                                      size_t len, SSL *ssl, void *arg));
644# define SSL_CTX_set_msg_callback_arg(ctx, arg) SSL_CTX_ctrl((ctx), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg))
645# define SSL_set_msg_callback_arg(ssl, arg) SSL_ctrl((ssl), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg))
646
647# define SSL_get_extms_support(s) \
648        SSL_ctrl((s),SSL_CTRL_GET_EXTMS_SUPPORT,0,NULL)
649
650# ifndef OPENSSL_NO_SRP
651/* see tls_srp.c */
652#  ifndef OPENSSL_NO_DEPRECATED_3_0
653OSSL_DEPRECATEDIN_3_0 __owur int SSL_SRP_CTX_init(SSL *s);
654OSSL_DEPRECATEDIN_3_0 __owur int SSL_CTX_SRP_CTX_init(SSL_CTX *ctx);
655OSSL_DEPRECATEDIN_3_0 int SSL_SRP_CTX_free(SSL *ctx);
656OSSL_DEPRECATEDIN_3_0 int SSL_CTX_SRP_CTX_free(SSL_CTX *ctx);
657OSSL_DEPRECATEDIN_3_0 __owur int SSL_srp_server_param_with_username(SSL *s,
658                                                                    int *ad);
659OSSL_DEPRECATEDIN_3_0 __owur int SRP_Calc_A_param(SSL *s);
660#  endif
661# endif
662
663/* 100k max cert list */
664# define SSL_MAX_CERT_LIST_DEFAULT (1024*100)
665
666# define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT      (1024*20)
667
668/*
669 * This callback type is used inside SSL_CTX, SSL, and in the functions that
670 * set them. It is used to override the generation of SSL/TLS session IDs in
671 * a server. Return value should be zero on an error, non-zero to proceed.
672 * Also, callbacks should themselves check if the id they generate is unique
673 * otherwise the SSL handshake will fail with an error - callbacks can do
674 * this using the 'ssl' value they're passed by;
675 * SSL_has_matching_session_id(ssl, id, *id_len) The length value passed in
676 * is set at the maximum size the session ID can be. In SSLv3/TLSv1 it is 32
677 * bytes. The callback can alter this length to be less if desired. It is
678 * also an error for the callback to set the size to zero.
679 */
680typedef int (*GEN_SESSION_CB) (SSL *ssl, unsigned char *id,
681                               unsigned int *id_len);
682
683# define SSL_SESS_CACHE_OFF                      0x0000
684# define SSL_SESS_CACHE_CLIENT                   0x0001
685# define SSL_SESS_CACHE_SERVER                   0x0002
686# define SSL_SESS_CACHE_BOTH     (SSL_SESS_CACHE_CLIENT|SSL_SESS_CACHE_SERVER)
687# define SSL_SESS_CACHE_NO_AUTO_CLEAR            0x0080
688/* enough comments already ... see SSL_CTX_set_session_cache_mode(3) */
689# define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP       0x0100
690# define SSL_SESS_CACHE_NO_INTERNAL_STORE        0x0200
691# define SSL_SESS_CACHE_NO_INTERNAL \
692        (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP|SSL_SESS_CACHE_NO_INTERNAL_STORE)
693# define SSL_SESS_CACHE_UPDATE_TIME              0x0400
694
695LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
696# define SSL_CTX_sess_number(ctx) \
697        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_NUMBER,0,NULL)
698# define SSL_CTX_sess_connect(ctx) \
699        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT,0,NULL)
700# define SSL_CTX_sess_connect_good(ctx) \
701        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_GOOD,0,NULL)
702# define SSL_CTX_sess_connect_renegotiate(ctx) \
703        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_RENEGOTIATE,0,NULL)
704# define SSL_CTX_sess_accept(ctx) \
705        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT,0,NULL)
706# define SSL_CTX_sess_accept_renegotiate(ctx) \
707        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_RENEGOTIATE,0,NULL)
708# define SSL_CTX_sess_accept_good(ctx) \
709        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_GOOD,0,NULL)
710# define SSL_CTX_sess_hits(ctx) \
711        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_HIT,0,NULL)
712# define SSL_CTX_sess_cb_hits(ctx) \
713        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CB_HIT,0,NULL)
714# define SSL_CTX_sess_misses(ctx) \
715        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_MISSES,0,NULL)
716# define SSL_CTX_sess_timeouts(ctx) \
717        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_TIMEOUTS,0,NULL)
718# define SSL_CTX_sess_cache_full(ctx) \
719        SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CACHE_FULL,0,NULL)
720
721void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
722                             int (*new_session_cb) (struct ssl_st *ssl,
723                                                    SSL_SESSION *sess));
724int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (struct ssl_st *ssl,
725                                              SSL_SESSION *sess);
726void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
727                                void (*remove_session_cb) (struct ssl_ctx_st
728                                                           *ctx,
729                                                           SSL_SESSION *sess));
730void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (struct ssl_ctx_st *ctx,
731                                                  SSL_SESSION *sess);
732void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
733                             SSL_SESSION *(*get_session_cb) (struct ssl_st
734                                                             *ssl,
735                                                             const unsigned char
736                                                             *data, int len,
737                                                             int *copy));
738SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (struct ssl_st *ssl,
739                                                       const unsigned char *data,
740                                                       int len, int *copy);
741void SSL_CTX_set_info_callback(SSL_CTX *ctx,
742                               void (*cb) (const SSL *ssl, int type, int val));
743void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
744                                                 int val);
745void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
746                                int (*client_cert_cb) (SSL *ssl, X509 **x509,
747                                                       EVP_PKEY **pkey));
748int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
749                                                 EVP_PKEY **pkey);
750# ifndef OPENSSL_NO_ENGINE
751__owur int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e);
752# endif
753void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
754                                    int (*app_gen_cookie_cb) (SSL *ssl,
755                                                              unsigned char
756                                                              *cookie,
757                                                              unsigned int
758                                                              *cookie_len));
759void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
760                                  int (*app_verify_cookie_cb) (SSL *ssl,
761                                                               const unsigned
762                                                               char *cookie,
763                                                               unsigned int
764                                                               cookie_len));
765
766void SSL_CTX_set_stateless_cookie_generate_cb(
767    SSL_CTX *ctx,
768    int (*gen_stateless_cookie_cb) (SSL *ssl,
769                                    unsigned char *cookie,
770                                    size_t *cookie_len));
771void SSL_CTX_set_stateless_cookie_verify_cb(
772    SSL_CTX *ctx,
773    int (*verify_stateless_cookie_cb) (SSL *ssl,
774                                       const unsigned char *cookie,
775                                       size_t cookie_len));
776# ifndef OPENSSL_NO_NEXTPROTONEG
777
778typedef int (*SSL_CTX_npn_advertised_cb_func)(SSL *ssl,
779                                              const unsigned char **out,
780                                              unsigned int *outlen,
781                                              void *arg);
782void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *s,
783                                           SSL_CTX_npn_advertised_cb_func cb,
784                                           void *arg);
785#  define SSL_CTX_set_npn_advertised_cb SSL_CTX_set_next_protos_advertised_cb
786
787typedef int (*SSL_CTX_npn_select_cb_func)(SSL *s,
788                                          unsigned char **out,
789                                          unsigned char *outlen,
790                                          const unsigned char *in,
791                                          unsigned int inlen,
792                                          void *arg);
793void SSL_CTX_set_next_proto_select_cb(SSL_CTX *s,
794                                      SSL_CTX_npn_select_cb_func cb,
795                                      void *arg);
796#  define SSL_CTX_set_npn_select_cb SSL_CTX_set_next_proto_select_cb
797
798void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
799                                    unsigned *len);
800#  define SSL_get0_npn_negotiated SSL_get0_next_proto_negotiated
801# endif
802
803__owur int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
804                                 const unsigned char *in, unsigned int inlen,
805                                 const unsigned char *client,
806                                 unsigned int client_len);
807
808# define OPENSSL_NPN_UNSUPPORTED 0
809# define OPENSSL_NPN_NEGOTIATED  1
810# define OPENSSL_NPN_NO_OVERLAP  2
811
812__owur int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
813                                   unsigned int protos_len);
814__owur int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
815                               unsigned int protos_len);
816typedef int (*SSL_CTX_alpn_select_cb_func)(SSL *ssl,
817                                           const unsigned char **out,
818                                           unsigned char *outlen,
819                                           const unsigned char *in,
820                                           unsigned int inlen,
821                                           void *arg);
822void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
823                                SSL_CTX_alpn_select_cb_func cb,
824                                void *arg);
825void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
826                            unsigned int *len);
827
828# ifndef OPENSSL_NO_PSK
829/*
830 * the maximum length of the buffer given to callbacks containing the
831 * resulting identity/psk
832 */
833#  define PSK_MAX_IDENTITY_LEN 256
834#  define PSK_MAX_PSK_LEN 512
835typedef unsigned int (*SSL_psk_client_cb_func)(SSL *ssl,
836                                               const char *hint,
837                                               char *identity,
838                                               unsigned int max_identity_len,
839                                               unsigned char *psk,
840                                               unsigned int max_psk_len);
841void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb);
842void SSL_set_psk_client_callback(SSL *ssl, SSL_psk_client_cb_func cb);
843
844typedef unsigned int (*SSL_psk_server_cb_func)(SSL *ssl,
845                                               const char *identity,
846                                               unsigned char *psk,
847                                               unsigned int max_psk_len);
848void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb);
849void SSL_set_psk_server_callback(SSL *ssl, SSL_psk_server_cb_func cb);
850
851__owur int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint);
852__owur int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
853const char *SSL_get_psk_identity_hint(const SSL *s);
854const char *SSL_get_psk_identity(const SSL *s);
855# endif
856
857typedef int (*SSL_psk_find_session_cb_func)(SSL *ssl,
858                                            const unsigned char *identity,
859                                            size_t identity_len,
860                                            SSL_SESSION **sess);
861typedef int (*SSL_psk_use_session_cb_func)(SSL *ssl, const EVP_MD *md,
862                                           const unsigned char **id,
863                                           size_t *idlen,
864                                           SSL_SESSION **sess);
865
866void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb);
867void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
868                                           SSL_psk_find_session_cb_func cb);
869void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb);
870void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
871                                          SSL_psk_use_session_cb_func cb);
872
873/* Register callbacks to handle custom TLS Extensions for client or server. */
874
875__owur int SSL_CTX_has_client_custom_ext(const SSL_CTX *ctx,
876                                         unsigned int ext_type);
877
878__owur int SSL_CTX_add_client_custom_ext(SSL_CTX *ctx,
879                                         unsigned int ext_type,
880                                         custom_ext_add_cb add_cb,
881                                         custom_ext_free_cb free_cb,
882                                         void *add_arg,
883                                         custom_ext_parse_cb parse_cb,
884                                         void *parse_arg);
885
886__owur int SSL_CTX_add_server_custom_ext(SSL_CTX *ctx,
887                                         unsigned int ext_type,
888                                         custom_ext_add_cb add_cb,
889                                         custom_ext_free_cb free_cb,
890                                         void *add_arg,
891                                         custom_ext_parse_cb parse_cb,
892                                         void *parse_arg);
893
894__owur int SSL_CTX_add_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
895                                  unsigned int context,
896                                  SSL_custom_ext_add_cb_ex add_cb,
897                                  SSL_custom_ext_free_cb_ex free_cb,
898                                  void *add_arg,
899                                  SSL_custom_ext_parse_cb_ex parse_cb,
900                                  void *parse_arg);
901
902__owur int SSL_extension_supported(unsigned int ext_type);
903
904# define SSL_NOTHING            1
905# define SSL_WRITING            2
906# define SSL_READING            3
907# define SSL_X509_LOOKUP        4
908# define SSL_ASYNC_PAUSED       5
909# define SSL_ASYNC_NO_JOBS      6
910# define SSL_CLIENT_HELLO_CB    7
911# define SSL_RETRY_VERIFY       8
912
913/* These will only be used when doing non-blocking IO */
914# define SSL_want_nothing(s)         (SSL_want(s) == SSL_NOTHING)
915# define SSL_want_read(s)            (SSL_want(s) == SSL_READING)
916# define SSL_want_write(s)           (SSL_want(s) == SSL_WRITING)
917# define SSL_want_x509_lookup(s)     (SSL_want(s) == SSL_X509_LOOKUP)
918# define SSL_want_retry_verify(s)    (SSL_want(s) == SSL_RETRY_VERIFY)
919# define SSL_want_async(s)           (SSL_want(s) == SSL_ASYNC_PAUSED)
920# define SSL_want_async_job(s)       (SSL_want(s) == SSL_ASYNC_NO_JOBS)
921# define SSL_want_client_hello_cb(s) (SSL_want(s) == SSL_CLIENT_HELLO_CB)
922
923# define SSL_MAC_FLAG_READ_MAC_STREAM 1
924# define SSL_MAC_FLAG_WRITE_MAC_STREAM 2
925# define SSL_MAC_FLAG_READ_MAC_TLSTREE 4
926# define SSL_MAC_FLAG_WRITE_MAC_TLSTREE 8
927
928/*
929 * A callback for logging out TLS key material. This callback should log out
930 * |line| followed by a newline.
931 */
932typedef void (*SSL_CTX_keylog_cb_func)(const SSL *ssl, const char *line);
933
934/*
935 * SSL_CTX_set_keylog_callback configures a callback to log key material. This
936 * is intended for debugging use with tools like Wireshark. The cb function
937 * should log line followed by a newline.
938 */
939void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb);
940
941/*
942 * SSL_CTX_get_keylog_callback returns the callback configured by
943 * SSL_CTX_set_keylog_callback.
944 */
945SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx);
946
947int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data);
948uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx);
949int SSL_set_max_early_data(SSL *s, uint32_t max_early_data);
950uint32_t SSL_get_max_early_data(const SSL *s);
951int SSL_CTX_set_recv_max_early_data(SSL_CTX *ctx, uint32_t recv_max_early_data);
952uint32_t SSL_CTX_get_recv_max_early_data(const SSL_CTX *ctx);
953int SSL_set_recv_max_early_data(SSL *s, uint32_t recv_max_early_data);
954uint32_t SSL_get_recv_max_early_data(const SSL *s);
955
956#ifdef __cplusplus
957}
958#endif
959
960# include <openssl/ssl2.h>
961# include <openssl/ssl3.h>
962# include <openssl/tls1.h>      /* This is mostly sslv3 with a few tweaks */
963# include <openssl/dtls1.h>     /* Datagram TLS */
964# include <openssl/srtp.h>      /* Support for the use_srtp extension */
965# include <openssl/quic.h>
966
967#ifdef  __cplusplus
968extern "C" {
969#endif
970
971/*
972 * These need to be after the above set of includes due to a compiler bug
973 * in VisualStudio 2015
974 */
975{-
976    generate_const_stack_macros("SSL_CIPHER");
977-}
978
979/* compatibility */
980# define SSL_set_app_data(s,arg)         (SSL_set_ex_data(s,0,(char *)(arg)))
981# define SSL_get_app_data(s)             (SSL_get_ex_data(s,0))
982# define SSL_SESSION_set_app_data(s,a)   (SSL_SESSION_set_ex_data(s,0, \
983                                                                  (char *)(a)))
984# define SSL_SESSION_get_app_data(s)     (SSL_SESSION_get_ex_data(s,0))
985# define SSL_CTX_get_app_data(ctx)       (SSL_CTX_get_ex_data(ctx,0))
986# define SSL_CTX_set_app_data(ctx,arg)   (SSL_CTX_set_ex_data(ctx,0, \
987                                                              (char *)(arg)))
988# ifndef OPENSSL_NO_DEPRECATED_1_1_0
989OSSL_DEPRECATEDIN_1_1_0 void SSL_set_debug(SSL *s, int debug);
990# endif
991
992/* TLSv1.3 KeyUpdate message types */
993/* -1 used so that this is an invalid value for the on-the-wire protocol */
994#define SSL_KEY_UPDATE_NONE             -1
995/* Values as defined for the on-the-wire protocol */
996#define SSL_KEY_UPDATE_NOT_REQUESTED     0
997#define SSL_KEY_UPDATE_REQUESTED         1
998
999/*
1000 * The valid handshake states (one for each type message sent and one for each
1001 * type of message received). There are also two "special" states:
1002 * TLS = TLS or DTLS state
1003 * DTLS = DTLS specific state
1004 * CR/SR = Client Read/Server Read
1005 * CW/SW = Client Write/Server Write
1006 *
1007 * The "special" states are:
1008 * TLS_ST_BEFORE = No handshake has been initiated yet
1009 * TLS_ST_OK = A handshake has been successfully completed
1010 */
1011typedef enum {
1012    TLS_ST_BEFORE,
1013    TLS_ST_OK,
1014    DTLS_ST_CR_HELLO_VERIFY_REQUEST,
1015    TLS_ST_CR_SRVR_HELLO,
1016    TLS_ST_CR_CERT,
1017    TLS_ST_CR_COMP_CERT,
1018    TLS_ST_CR_CERT_STATUS,
1019    TLS_ST_CR_KEY_EXCH,
1020    TLS_ST_CR_CERT_REQ,
1021    TLS_ST_CR_SRVR_DONE,
1022    TLS_ST_CR_SESSION_TICKET,
1023    TLS_ST_CR_CHANGE,
1024    TLS_ST_CR_FINISHED,
1025    TLS_ST_CW_CLNT_HELLO,
1026    TLS_ST_CW_CERT,
1027    TLS_ST_CW_COMP_CERT,
1028    TLS_ST_CW_KEY_EXCH,
1029    TLS_ST_CW_CERT_VRFY,
1030    TLS_ST_CW_CHANGE,
1031    TLS_ST_CW_NEXT_PROTO,
1032    TLS_ST_CW_FINISHED,
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,
1037    TLS_ST_SW_CERT,
1038    TLS_ST_SW_COMP_CERT,
1039    TLS_ST_SW_KEY_EXCH,
1040    TLS_ST_SW_CERT_REQ,
1041    TLS_ST_SW_SRVR_DONE,
1042    TLS_ST_SR_CERT,
1043    TLS_ST_SR_COMP_CERT,
1044    TLS_ST_SR_KEY_EXCH,
1045    TLS_ST_SR_CERT_VRFY,
1046    TLS_ST_SR_NEXT_PROTO,
1047    TLS_ST_SR_CHANGE,
1048    TLS_ST_SR_FINISHED,
1049    TLS_ST_SW_SESSION_TICKET,
1050    TLS_ST_SW_CERT_STATUS,
1051    TLS_ST_SW_CHANGE,
1052    TLS_ST_SW_FINISHED,
1053    TLS_ST_SW_ENCRYPTED_EXTENSIONS,
1054    TLS_ST_CR_ENCRYPTED_EXTENSIONS,
1055    TLS_ST_CR_CERT_VRFY,
1056    TLS_ST_SW_CERT_VRFY,
1057    TLS_ST_CR_HELLO_REQ,
1058    TLS_ST_SW_KEY_UPDATE,
1059    TLS_ST_CW_KEY_UPDATE,
1060    TLS_ST_SR_KEY_UPDATE,
1061    TLS_ST_CR_KEY_UPDATE,
1062    TLS_ST_EARLY_DATA,
1063    TLS_ST_PENDING_EARLY_DATA_END,
1064    TLS_ST_CW_END_OF_EARLY_DATA,
1065    TLS_ST_SR_END_OF_EARLY_DATA
1066} OSSL_HANDSHAKE_STATE;
1067
1068/*
1069 * Most of the following state values are no longer used and are defined to be
1070 * the closest equivalent value in the current state machine code. Not all
1071 * defines have an equivalent and are set to a dummy value (-1). SSL_ST_CONNECT
1072 * and SSL_ST_ACCEPT are still in use in the definition of SSL_CB_ACCEPT_LOOP,
1073 * SSL_CB_ACCEPT_EXIT, SSL_CB_CONNECT_LOOP and SSL_CB_CONNECT_EXIT.
1074 */
1075
1076# define SSL_ST_CONNECT                  0x1000
1077# define SSL_ST_ACCEPT                   0x2000
1078
1079# define SSL_ST_MASK                     0x0FFF
1080
1081# define SSL_CB_LOOP                     0x01
1082# define SSL_CB_EXIT                     0x02
1083# define SSL_CB_READ                     0x04
1084# define SSL_CB_WRITE                    0x08
1085# define SSL_CB_ALERT                    0x4000/* used in callback */
1086# define SSL_CB_READ_ALERT               (SSL_CB_ALERT|SSL_CB_READ)
1087# define SSL_CB_WRITE_ALERT              (SSL_CB_ALERT|SSL_CB_WRITE)
1088# define SSL_CB_ACCEPT_LOOP              (SSL_ST_ACCEPT|SSL_CB_LOOP)
1089# define SSL_CB_ACCEPT_EXIT              (SSL_ST_ACCEPT|SSL_CB_EXIT)
1090# define SSL_CB_CONNECT_LOOP             (SSL_ST_CONNECT|SSL_CB_LOOP)
1091# define SSL_CB_CONNECT_EXIT             (SSL_ST_CONNECT|SSL_CB_EXIT)
1092# define SSL_CB_HANDSHAKE_START          0x10
1093# define SSL_CB_HANDSHAKE_DONE           0x20
1094
1095/* Is the SSL_connection established? */
1096# define SSL_in_connect_init(a)          (SSL_in_init(a) && !SSL_is_server(a))
1097# define SSL_in_accept_init(a)           (SSL_in_init(a) && SSL_is_server(a))
1098int SSL_in_init(const SSL *s);
1099int SSL_in_before(const SSL *s);
1100int SSL_is_init_finished(const SSL *s);
1101
1102/*
1103 * The following 3 states are kept in ssl->rlayer.rstate when reads fail, you
1104 * should not need these
1105 */
1106# define SSL_ST_READ_HEADER                      0xF0
1107# define SSL_ST_READ_BODY                        0xF1
1108# define SSL_ST_READ_DONE                        0xF2
1109
1110/*-
1111 * Obtain latest Finished message
1112 *   -- that we sent (SSL_get_finished)
1113 *   -- that we expected from peer (SSL_get_peer_finished).
1114 * Returns length (0 == no Finished so far), copies up to 'count' bytes.
1115 */
1116size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1117size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
1118
1119/*
1120 * use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options are
1121 * 'ored' with SSL_VERIFY_PEER if they are desired
1122 */
1123# define SSL_VERIFY_NONE                 0x00
1124# define SSL_VERIFY_PEER                 0x01
1125# define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
1126# define SSL_VERIFY_CLIENT_ONCE          0x04
1127# define SSL_VERIFY_POST_HANDSHAKE       0x08
1128
1129# ifndef OPENSSL_NO_DEPRECATED_1_1_0
1130#  define OpenSSL_add_ssl_algorithms()   SSL_library_init()
1131#  define SSLeay_add_ssl_algorithms()    SSL_library_init()
1132# endif
1133
1134/* More backward compatibility */
1135# define SSL_get_cipher(s) \
1136                SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1137# define SSL_get_cipher_bits(s,np) \
1138                SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np)
1139# define SSL_get_cipher_version(s) \
1140                SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1141# define SSL_get_cipher_name(s) \
1142                SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1143# define SSL_get_time(a)         SSL_SESSION_get_time(a)
1144# define SSL_set_time(a,b)       SSL_SESSION_set_time((a),(b))
1145# define SSL_get_timeout(a)      SSL_SESSION_get_timeout(a)
1146# define SSL_set_timeout(a,b)    SSL_SESSION_set_timeout((a),(b))
1147
1148# define d2i_SSL_SESSION_bio(bp,s_id) ASN1_d2i_bio_of(SSL_SESSION,SSL_SESSION_new,d2i_SSL_SESSION,bp,s_id)
1149# define i2d_SSL_SESSION_bio(bp,s_id) ASN1_i2d_bio_of(SSL_SESSION,i2d_SSL_SESSION,bp,s_id)
1150
1151DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1152# define SSL_AD_REASON_OFFSET            1000/* offset to get SSL_R_... value
1153                                              * from SSL_AD_... */
1154/* These alert types are for SSLv3 and TLSv1 */
1155# define SSL_AD_CLOSE_NOTIFY             SSL3_AD_CLOSE_NOTIFY
1156/* fatal */
1157# define SSL_AD_UNEXPECTED_MESSAGE       SSL3_AD_UNEXPECTED_MESSAGE
1158/* fatal */
1159# define SSL_AD_BAD_RECORD_MAC           SSL3_AD_BAD_RECORD_MAC
1160# define SSL_AD_DECRYPTION_FAILED        TLS1_AD_DECRYPTION_FAILED
1161# define SSL_AD_RECORD_OVERFLOW          TLS1_AD_RECORD_OVERFLOW
1162/* fatal */
1163# define SSL_AD_DECOMPRESSION_FAILURE    SSL3_AD_DECOMPRESSION_FAILURE
1164/* fatal */
1165# define SSL_AD_HANDSHAKE_FAILURE        SSL3_AD_HANDSHAKE_FAILURE
1166/* Not for TLS */
1167# define SSL_AD_NO_CERTIFICATE           SSL3_AD_NO_CERTIFICATE
1168# define SSL_AD_BAD_CERTIFICATE          SSL3_AD_BAD_CERTIFICATE
1169# define SSL_AD_UNSUPPORTED_CERTIFICATE  SSL3_AD_UNSUPPORTED_CERTIFICATE
1170# define SSL_AD_CERTIFICATE_REVOKED      SSL3_AD_CERTIFICATE_REVOKED
1171# define SSL_AD_CERTIFICATE_EXPIRED      SSL3_AD_CERTIFICATE_EXPIRED
1172# define SSL_AD_CERTIFICATE_UNKNOWN      SSL3_AD_CERTIFICATE_UNKNOWN
1173/* fatal */
1174# define SSL_AD_ILLEGAL_PARAMETER        SSL3_AD_ILLEGAL_PARAMETER
1175/* fatal */
1176# define SSL_AD_UNKNOWN_CA               TLS1_AD_UNKNOWN_CA
1177/* fatal */
1178# define SSL_AD_ACCESS_DENIED            TLS1_AD_ACCESS_DENIED
1179/* fatal */
1180# define SSL_AD_DECODE_ERROR             TLS1_AD_DECODE_ERROR
1181# define SSL_AD_DECRYPT_ERROR            TLS1_AD_DECRYPT_ERROR
1182/* fatal */
1183# define SSL_AD_EXPORT_RESTRICTION       TLS1_AD_EXPORT_RESTRICTION
1184/* fatal */
1185# define SSL_AD_PROTOCOL_VERSION         TLS1_AD_PROTOCOL_VERSION
1186/* fatal */
1187# define SSL_AD_INSUFFICIENT_SECURITY    TLS1_AD_INSUFFICIENT_SECURITY
1188/* fatal */
1189# define SSL_AD_INTERNAL_ERROR           TLS1_AD_INTERNAL_ERROR
1190# define SSL_AD_USER_CANCELLED           TLS1_AD_USER_CANCELLED
1191# define SSL_AD_NO_RENEGOTIATION         TLS1_AD_NO_RENEGOTIATION
1192# define SSL_AD_MISSING_EXTENSION        TLS13_AD_MISSING_EXTENSION
1193# define SSL_AD_CERTIFICATE_REQUIRED     TLS13_AD_CERTIFICATE_REQUIRED
1194# define SSL_AD_UNSUPPORTED_EXTENSION    TLS1_AD_UNSUPPORTED_EXTENSION
1195# define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
1196# define SSL_AD_UNRECOGNIZED_NAME        TLS1_AD_UNRECOGNIZED_NAME
1197# define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
1198# define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
1199/* fatal */
1200# define SSL_AD_UNKNOWN_PSK_IDENTITY     TLS1_AD_UNKNOWN_PSK_IDENTITY
1201/* fatal */
1202# define SSL_AD_INAPPROPRIATE_FALLBACK   TLS1_AD_INAPPROPRIATE_FALLBACK
1203# define SSL_AD_NO_APPLICATION_PROTOCOL  TLS1_AD_NO_APPLICATION_PROTOCOL
1204# define SSL_ERROR_NONE                  0
1205# define SSL_ERROR_SSL                   1
1206# define SSL_ERROR_WANT_READ             2
1207# define SSL_ERROR_WANT_WRITE            3
1208# define SSL_ERROR_WANT_X509_LOOKUP      4
1209# define SSL_ERROR_SYSCALL               5/* look at error stack/return
1210                                           * value/errno */
1211# define SSL_ERROR_ZERO_RETURN           6
1212# define SSL_ERROR_WANT_CONNECT          7
1213# define SSL_ERROR_WANT_ACCEPT           8
1214# define SSL_ERROR_WANT_ASYNC            9
1215# define SSL_ERROR_WANT_ASYNC_JOB       10
1216# define SSL_ERROR_WANT_CLIENT_HELLO_CB 11
1217# define SSL_ERROR_WANT_RETRY_VERIFY    12
1218
1219# ifndef OPENSSL_NO_DEPRECATED_3_0
1220#  define SSL_CTRL_SET_TMP_DH                    3
1221#  define SSL_CTRL_SET_TMP_ECDH                  4
1222#  define SSL_CTRL_SET_TMP_DH_CB                 6
1223# endif
1224
1225# define SSL_CTRL_GET_CLIENT_CERT_REQUEST        9
1226# define SSL_CTRL_GET_NUM_RENEGOTIATIONS         10
1227# define SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS       11
1228# define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS       12
1229# define SSL_CTRL_GET_FLAGS                      13
1230# define SSL_CTRL_EXTRA_CHAIN_CERT               14
1231# define SSL_CTRL_SET_MSG_CALLBACK               15
1232# define SSL_CTRL_SET_MSG_CALLBACK_ARG           16
1233/* only applies to datagram connections */
1234# define SSL_CTRL_SET_MTU                17
1235/* Stats */
1236# define SSL_CTRL_SESS_NUMBER                    20
1237# define SSL_CTRL_SESS_CONNECT                   21
1238# define SSL_CTRL_SESS_CONNECT_GOOD              22
1239# define SSL_CTRL_SESS_CONNECT_RENEGOTIATE       23
1240# define SSL_CTRL_SESS_ACCEPT                    24
1241# define SSL_CTRL_SESS_ACCEPT_GOOD               25
1242# define SSL_CTRL_SESS_ACCEPT_RENEGOTIATE        26
1243# define SSL_CTRL_SESS_HIT                       27
1244# define SSL_CTRL_SESS_CB_HIT                    28
1245# define SSL_CTRL_SESS_MISSES                    29
1246# define SSL_CTRL_SESS_TIMEOUTS                  30
1247# define SSL_CTRL_SESS_CACHE_FULL                31
1248# define SSL_CTRL_MODE                           33
1249# define SSL_CTRL_GET_READ_AHEAD                 40
1250# define SSL_CTRL_SET_READ_AHEAD                 41
1251# define SSL_CTRL_SET_SESS_CACHE_SIZE            42
1252# define SSL_CTRL_GET_SESS_CACHE_SIZE            43
1253# define SSL_CTRL_SET_SESS_CACHE_MODE            44
1254# define SSL_CTRL_GET_SESS_CACHE_MODE            45
1255# define SSL_CTRL_GET_MAX_CERT_LIST              50
1256# define SSL_CTRL_SET_MAX_CERT_LIST              51
1257# define SSL_CTRL_SET_MAX_SEND_FRAGMENT          52
1258/* see tls1.h for macros based on these */
1259# define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB       53
1260# define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG      54
1261# define SSL_CTRL_SET_TLSEXT_HOSTNAME            55
1262# define SSL_CTRL_SET_TLSEXT_DEBUG_CB            56
1263# define SSL_CTRL_SET_TLSEXT_DEBUG_ARG           57
1264# define SSL_CTRL_GET_TLSEXT_TICKET_KEYS         58
1265# define SSL_CTRL_SET_TLSEXT_TICKET_KEYS         59
1266/*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT    60 */
1267/*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB 61 */
1268/*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB_ARG 62 */
1269# define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB       63
1270# define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB_ARG   64
1271# define SSL_CTRL_SET_TLSEXT_STATUS_REQ_TYPE     65
1272# define SSL_CTRL_GET_TLSEXT_STATUS_REQ_EXTS     66
1273# define SSL_CTRL_SET_TLSEXT_STATUS_REQ_EXTS     67
1274# define SSL_CTRL_GET_TLSEXT_STATUS_REQ_IDS      68
1275# define SSL_CTRL_SET_TLSEXT_STATUS_REQ_IDS      69
1276# define SSL_CTRL_GET_TLSEXT_STATUS_REQ_OCSP_RESP        70
1277# define SSL_CTRL_SET_TLSEXT_STATUS_REQ_OCSP_RESP        71
1278# ifndef OPENSSL_NO_DEPRECATED_3_0
1279#  define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB      72
1280# endif
1281# define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME_CB    75
1282# define SSL_CTRL_SET_SRP_VERIFY_PARAM_CB                76
1283# define SSL_CTRL_SET_SRP_GIVE_CLIENT_PWD_CB             77
1284# define SSL_CTRL_SET_SRP_ARG            78
1285# define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME               79
1286# define SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH               80
1287# define SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD               81
1288# define DTLS_CTRL_GET_TIMEOUT           73
1289# define DTLS_CTRL_HANDLE_TIMEOUT        74
1290# define SSL_CTRL_GET_RI_SUPPORT                 76
1291# define SSL_CTRL_CLEAR_MODE                     78
1292# define SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB      79
1293# define SSL_CTRL_GET_EXTRA_CHAIN_CERTS          82
1294# define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS        83
1295# define SSL_CTRL_CHAIN                          88
1296# define SSL_CTRL_CHAIN_CERT                     89
1297# define SSL_CTRL_GET_GROUPS                     90
1298# define SSL_CTRL_SET_GROUPS                     91
1299# define SSL_CTRL_SET_GROUPS_LIST                92
1300# define SSL_CTRL_GET_SHARED_GROUP               93
1301# define SSL_CTRL_SET_SIGALGS                    97
1302# define SSL_CTRL_SET_SIGALGS_LIST               98
1303# define SSL_CTRL_CERT_FLAGS                     99
1304# define SSL_CTRL_CLEAR_CERT_FLAGS               100
1305# define SSL_CTRL_SET_CLIENT_SIGALGS             101
1306# define SSL_CTRL_SET_CLIENT_SIGALGS_LIST        102
1307# define SSL_CTRL_GET_CLIENT_CERT_TYPES          103
1308# define SSL_CTRL_SET_CLIENT_CERT_TYPES          104
1309# define SSL_CTRL_BUILD_CERT_CHAIN               105
1310# define SSL_CTRL_SET_VERIFY_CERT_STORE          106
1311# define SSL_CTRL_SET_CHAIN_CERT_STORE           107
1312# define SSL_CTRL_GET_PEER_SIGNATURE_NID         108
1313# define SSL_CTRL_GET_PEER_TMP_KEY               109
1314# define SSL_CTRL_GET_RAW_CIPHERLIST             110
1315# define SSL_CTRL_GET_EC_POINT_FORMATS           111
1316# define SSL_CTRL_GET_CHAIN_CERTS                115
1317# define SSL_CTRL_SELECT_CURRENT_CERT            116
1318# define SSL_CTRL_SET_CURRENT_CERT               117
1319# define SSL_CTRL_SET_DH_AUTO                    118
1320# define DTLS_CTRL_SET_LINK_MTU                  120
1321# define DTLS_CTRL_GET_LINK_MIN_MTU              121
1322# define SSL_CTRL_GET_EXTMS_SUPPORT              122
1323# define SSL_CTRL_SET_MIN_PROTO_VERSION          123
1324# define SSL_CTRL_SET_MAX_PROTO_VERSION          124
1325# define SSL_CTRL_SET_SPLIT_SEND_FRAGMENT        125
1326# define SSL_CTRL_SET_MAX_PIPELINES              126
1327# define SSL_CTRL_GET_TLSEXT_STATUS_REQ_TYPE     127
1328# define SSL_CTRL_GET_TLSEXT_STATUS_REQ_CB       128
1329# define SSL_CTRL_GET_TLSEXT_STATUS_REQ_CB_ARG   129
1330# define SSL_CTRL_GET_MIN_PROTO_VERSION          130
1331# define SSL_CTRL_GET_MAX_PROTO_VERSION          131
1332# define SSL_CTRL_GET_SIGNATURE_NID              132
1333# define SSL_CTRL_GET_TMP_KEY                    133
1334# define SSL_CTRL_GET_NEGOTIATED_GROUP           134
1335# define SSL_CTRL_GET_IANA_GROUPS                135
1336# define SSL_CTRL_SET_RETRY_VERIFY               136
1337# define SSL_CTRL_GET_VERIFY_CERT_STORE          137
1338# define SSL_CTRL_GET_CHAIN_CERT_STORE           138
1339# define SSL_CTRL_GET0_IMPLEMENTED_GROUPS        139
1340# define SSL_CTRL_GET_SIGNATURE_NAME             140
1341# define SSL_CTRL_GET_PEER_SIGNATURE_NAME        141
1342# define SSL_CERT_SET_FIRST                      1
1343# define SSL_CERT_SET_NEXT                       2
1344# define SSL_CERT_SET_SERVER                     3
1345# define DTLSv1_get_timeout(ssl, arg) \
1346        SSL_ctrl(ssl,DTLS_CTRL_GET_TIMEOUT,0, (void *)(arg))
1347# define DTLSv1_handle_timeout(ssl) \
1348        SSL_ctrl(ssl,DTLS_CTRL_HANDLE_TIMEOUT,0, NULL)
1349# define SSL_num_renegotiations(ssl) \
1350        SSL_ctrl((ssl),SSL_CTRL_GET_NUM_RENEGOTIATIONS,0,NULL)
1351# define SSL_clear_num_renegotiations(ssl) \
1352        SSL_ctrl((ssl),SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS,0,NULL)
1353# define SSL_total_renegotiations(ssl) \
1354        SSL_ctrl((ssl),SSL_CTRL_GET_TOTAL_RENEGOTIATIONS,0,NULL)
1355# ifndef OPENSSL_NO_DEPRECATED_3_0
1356#  define SSL_CTX_set_tmp_dh(ctx,dh) \
1357        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_DH,0,(char *)(dh))
1358# endif
1359# define SSL_CTX_set_dh_auto(ctx, onoff) \
1360        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_DH_AUTO,onoff,NULL)
1361# define SSL_set_dh_auto(s, onoff) \
1362        SSL_ctrl(s,SSL_CTRL_SET_DH_AUTO,onoff,NULL)
1363# ifndef OPENSSL_NO_DEPRECATED_3_0
1364#  define SSL_set_tmp_dh(ssl,dh) \
1365        SSL_ctrl(ssl,SSL_CTRL_SET_TMP_DH,0,(char *)(dh))
1366# endif
1367# ifndef OPENSSL_NO_DEPRECATED_3_0
1368#  define SSL_CTX_set_tmp_ecdh(ctx,ecdh) \
1369        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_ECDH,0,(char *)(ecdh))
1370#  define SSL_set_tmp_ecdh(ssl,ecdh) \
1371        SSL_ctrl(ssl,SSL_CTRL_SET_TMP_ECDH,0,(char *)(ecdh))
1372# endif
1373# define SSL_CTX_add_extra_chain_cert(ctx,x509) \
1374        SSL_CTX_ctrl(ctx,SSL_CTRL_EXTRA_CHAIN_CERT,0,(char *)(x509))
1375# define SSL_CTX_get_extra_chain_certs(ctx,px509) \
1376        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,0,px509)
1377# define SSL_CTX_get_extra_chain_certs_only(ctx,px509) \
1378        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,1,px509)
1379# define SSL_CTX_clear_extra_chain_certs(ctx) \
1380        SSL_CTX_ctrl(ctx,SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS,0,NULL)
1381# define SSL_CTX_set0_chain(ctx,sk) \
1382        SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN,0,(char *)(sk))
1383# define SSL_CTX_set1_chain(ctx,sk) \
1384        SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN,1,(char *)(sk))
1385# define SSL_CTX_add0_chain_cert(ctx,x509) \
1386        SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN_CERT,0,(char *)(x509))
1387# define SSL_CTX_add1_chain_cert(ctx,x509) \
1388        SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN_CERT,1,(char *)(x509))
1389# define SSL_CTX_get0_chain_certs(ctx,px509) \
1390        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_CHAIN_CERTS,0,px509)
1391# define SSL_CTX_clear_chain_certs(ctx) \
1392        SSL_CTX_set0_chain(ctx,NULL)
1393# define SSL_CTX_build_cert_chain(ctx, flags) \
1394        SSL_CTX_ctrl(ctx,SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1395# define SSL_CTX_select_current_cert(ctx,x509) \
1396        SSL_CTX_ctrl(ctx,SSL_CTRL_SELECT_CURRENT_CERT,0,(char *)(x509))
1397# define SSL_CTX_set_current_cert(ctx, op) \
1398        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CURRENT_CERT, op, NULL)
1399# define SSL_CTX_set0_verify_cert_store(ctx,st) \
1400        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_VERIFY_CERT_STORE,0,(char *)(st))
1401# define SSL_CTX_set1_verify_cert_store(ctx,st) \
1402        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_VERIFY_CERT_STORE,1,(char *)(st))
1403# define SSL_CTX_get0_verify_cert_store(ctx,st) \
1404        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_VERIFY_CERT_STORE,0,(char *)(st))
1405# define SSL_CTX_set0_chain_cert_store(ctx,st) \
1406        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)(st))
1407# define SSL_CTX_set1_chain_cert_store(ctx,st) \
1408        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)(st))
1409# define SSL_CTX_get0_chain_cert_store(ctx,st) \
1410        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_CHAIN_CERT_STORE,0,(char *)(st))
1411# define SSL_set0_chain(s,sk) \
1412        SSL_ctrl(s,SSL_CTRL_CHAIN,0,(char *)(sk))
1413# define SSL_set1_chain(s,sk) \
1414        SSL_ctrl(s,SSL_CTRL_CHAIN,1,(char *)(sk))
1415# define SSL_add0_chain_cert(s,x509) \
1416        SSL_ctrl(s,SSL_CTRL_CHAIN_CERT,0,(char *)(x509))
1417# define SSL_add1_chain_cert(s,x509) \
1418        SSL_ctrl(s,SSL_CTRL_CHAIN_CERT,1,(char *)(x509))
1419# define SSL_get0_chain_certs(s,px509) \
1420        SSL_ctrl(s,SSL_CTRL_GET_CHAIN_CERTS,0,px509)
1421# define SSL_clear_chain_certs(s) \
1422        SSL_set0_chain(s,NULL)
1423# define SSL_build_cert_chain(s, flags) \
1424        SSL_ctrl(s,SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1425# define SSL_select_current_cert(s,x509) \
1426        SSL_ctrl(s,SSL_CTRL_SELECT_CURRENT_CERT,0,(char *)(x509))
1427# define SSL_set_current_cert(s,op) \
1428        SSL_ctrl(s,SSL_CTRL_SET_CURRENT_CERT, op, NULL)
1429# define SSL_set0_verify_cert_store(s,st) \
1430        SSL_ctrl(s,SSL_CTRL_SET_VERIFY_CERT_STORE,0,(char *)(st))
1431# define SSL_set1_verify_cert_store(s,st) \
1432        SSL_ctrl(s,SSL_CTRL_SET_VERIFY_CERT_STORE,1,(char *)(st))
1433#define SSL_get0_verify_cert_store(s,st) \
1434        SSL_ctrl(s,SSL_CTRL_GET_VERIFY_CERT_STORE,0,(char *)(st))
1435# define SSL_set0_chain_cert_store(s,st) \
1436        SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)(st))
1437# define SSL_set1_chain_cert_store(s,st) \
1438        SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)(st))
1439#define SSL_get0_chain_cert_store(s,st) \
1440        SSL_ctrl(s,SSL_CTRL_GET_CHAIN_CERT_STORE,0,(char *)(st))
1441
1442# define SSL_get1_groups(s, glist) \
1443        SSL_ctrl(s,SSL_CTRL_GET_GROUPS,0,(int*)(glist))
1444# define SSL_get0_iana_groups(s, plst) \
1445        SSL_ctrl(s,SSL_CTRL_GET_IANA_GROUPS,0,(uint16_t **)(plst))
1446# define SSL_CTX_set1_groups(ctx, glist, glistlen) \
1447        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(int *)(glist))
1448# define SSL_CTX_set1_groups_list(ctx, s) \
1449        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)(s))
1450# define SSL_CTX_get0_implemented_groups(ctx, all, out) \
1451        SSL_CTX_ctrl(ctx,SSL_CTRL_GET0_IMPLEMENTED_GROUPS, all, \
1452        (STACK_OF(OPENSSL_CSTRING) *)(out))
1453# define SSL_set1_groups(s, glist, glistlen) \
1454        SSL_ctrl(s,SSL_CTRL_SET_GROUPS,glistlen,(char *)(glist))
1455# define SSL_set1_groups_list(s, str) \
1456        SSL_ctrl(s,SSL_CTRL_SET_GROUPS_LIST,0,(char *)(str))
1457# define SSL_get_shared_group(s, n) \
1458        SSL_ctrl(s,SSL_CTRL_GET_SHARED_GROUP,n,NULL)
1459# define SSL_get_negotiated_group(s) \
1460        SSL_ctrl(s,SSL_CTRL_GET_NEGOTIATED_GROUP,0,NULL)
1461# define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
1462        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS,slistlen,(int *)(slist))
1463# define SSL_CTX_set1_sigalgs_list(ctx, s) \
1464        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS_LIST,0,(char *)(s))
1465# define SSL_set1_sigalgs(s, slist, slistlen) \
1466        SSL_ctrl(s,SSL_CTRL_SET_SIGALGS,slistlen,(int *)(slist))
1467# define SSL_set1_sigalgs_list(s, str) \
1468        SSL_ctrl(s,SSL_CTRL_SET_SIGALGS_LIST,0,(char *)(str))
1469# define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
1470        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS,slistlen,(int *)(slist))
1471# define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
1472        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS_LIST,0,(char *)(s))
1473# define SSL_set1_client_sigalgs(s, slist, slistlen) \
1474        SSL_ctrl(s,SSL_CTRL_SET_CLIENT_SIGALGS,slistlen,(int *)(slist))
1475# define SSL_set1_client_sigalgs_list(s, str) \
1476        SSL_ctrl(s,SSL_CTRL_SET_CLIENT_SIGALGS_LIST,0,(char *)(str))
1477# define SSL_get0_certificate_types(s, clist) \
1478        SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)(clist))
1479# define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
1480        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_CERT_TYPES,clistlen, \
1481                     (char *)(clist))
1482# define SSL_set1_client_certificate_types(s, clist, clistlen) \
1483        SSL_ctrl(s,SSL_CTRL_SET_CLIENT_CERT_TYPES,clistlen,(char *)(clist))
1484# define SSL_get0_signature_name(s, str) \
1485        SSL_ctrl(s,SSL_CTRL_GET_SIGNATURE_NAME,0,(1?(str):(const char **)NULL))
1486# define SSL_get_signature_nid(s, pn) \
1487        SSL_ctrl(s,SSL_CTRL_GET_SIGNATURE_NID,0,pn)
1488# define SSL_get0_peer_signature_name(s, str) \
1489        SSL_ctrl(s,SSL_CTRL_GET_PEER_SIGNATURE_NAME,0,(1?(str):(const char **)NULL))
1490# define SSL_get_peer_signature_nid(s, pn) \
1491        SSL_ctrl(s,SSL_CTRL_GET_PEER_SIGNATURE_NID,0,pn)
1492# define SSL_get_peer_tmp_key(s, pk) \
1493        SSL_ctrl(s,SSL_CTRL_GET_PEER_TMP_KEY,0,pk)
1494# define SSL_get_tmp_key(s, pk) \
1495        SSL_ctrl(s,SSL_CTRL_GET_TMP_KEY,0,pk)
1496# define SSL_get0_raw_cipherlist(s, plst) \
1497        SSL_ctrl(s,SSL_CTRL_GET_RAW_CIPHERLIST,0,plst)
1498# define SSL_get0_ec_point_formats(s, plst) \
1499        SSL_ctrl(s,SSL_CTRL_GET_EC_POINT_FORMATS,0,plst)
1500# define SSL_CTX_set_min_proto_version(ctx, version) \
1501        SSL_CTX_ctrl(ctx, SSL_CTRL_SET_MIN_PROTO_VERSION, version, NULL)
1502# define SSL_CTX_set_max_proto_version(ctx, version) \
1503        SSL_CTX_ctrl(ctx, SSL_CTRL_SET_MAX_PROTO_VERSION, version, NULL)
1504# define SSL_CTX_get_min_proto_version(ctx) \
1505        SSL_CTX_ctrl(ctx, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL)
1506# define SSL_CTX_get_max_proto_version(ctx) \
1507        SSL_CTX_ctrl(ctx, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL)
1508# define SSL_set_min_proto_version(s, version) \
1509        SSL_ctrl(s, SSL_CTRL_SET_MIN_PROTO_VERSION, version, NULL)
1510# define SSL_set_max_proto_version(s, version) \
1511        SSL_ctrl(s, SSL_CTRL_SET_MAX_PROTO_VERSION, version, NULL)
1512# define SSL_get_min_proto_version(s) \
1513        SSL_ctrl(s, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL)
1514# define SSL_get_max_proto_version(s) \
1515        SSL_ctrl(s, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL)
1516
1517const char *SSL_get0_group_name(SSL *s);
1518const char *SSL_group_to_name(SSL *s, int id);
1519
1520/* Backwards compatibility, original 1.1.0 names */
1521# define SSL_CTRL_GET_SERVER_TMP_KEY \
1522         SSL_CTRL_GET_PEER_TMP_KEY
1523# define SSL_get_server_tmp_key(s, pk) \
1524         SSL_get_peer_tmp_key(s, pk)
1525
1526int SSL_set0_tmp_dh_pkey(SSL *s, EVP_PKEY *dhpkey);
1527int SSL_CTX_set0_tmp_dh_pkey(SSL_CTX *ctx, EVP_PKEY *dhpkey);
1528
1529/*
1530 * The following symbol names are old and obsolete. They are kept
1531 * for compatibility reasons only and should not be used anymore.
1532 */
1533# define SSL_CTRL_GET_CURVES           SSL_CTRL_GET_GROUPS
1534# define SSL_CTRL_SET_CURVES           SSL_CTRL_SET_GROUPS
1535# define SSL_CTRL_SET_CURVES_LIST      SSL_CTRL_SET_GROUPS_LIST
1536# define SSL_CTRL_GET_SHARED_CURVE     SSL_CTRL_GET_SHARED_GROUP
1537
1538# define SSL_get1_curves               SSL_get1_groups
1539# define SSL_CTX_set1_curves           SSL_CTX_set1_groups
1540# define SSL_CTX_set1_curves_list      SSL_CTX_set1_groups_list
1541# define SSL_set1_curves               SSL_set1_groups
1542# define SSL_set1_curves_list          SSL_set1_groups_list
1543# define SSL_get_shared_curve          SSL_get_shared_group
1544
1545
1546# ifndef OPENSSL_NO_DEPRECATED_1_1_0
1547/* Provide some compatibility macros for removed functionality. */
1548#  define SSL_CTX_need_tmp_RSA(ctx)                0
1549#  define SSL_CTX_set_tmp_rsa(ctx,rsa)             1
1550#  define SSL_need_tmp_RSA(ssl)                    0
1551#  define SSL_set_tmp_rsa(ssl,rsa)                 1
1552#  define SSL_CTX_set_ecdh_auto(dummy, onoff)      ((onoff) != 0)
1553#  define SSL_set_ecdh_auto(dummy, onoff)          ((onoff) != 0)
1554/*
1555 * We "pretend" to call the callback to avoid warnings about unused static
1556 * functions.
1557 */
1558#  define SSL_CTX_set_tmp_rsa_callback(ctx, cb)    while(0) (cb)(NULL, 0, 0)
1559#  define SSL_set_tmp_rsa_callback(ssl, cb)        while(0) (cb)(NULL, 0, 0)
1560# endif
1561__owur const BIO_METHOD *BIO_f_ssl(void);
1562__owur BIO *BIO_new_ssl(SSL_CTX *ctx, int client);
1563__owur BIO *BIO_new_ssl_connect(SSL_CTX *ctx);
1564__owur BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx);
1565__owur int BIO_ssl_copy_session_id(BIO *to, BIO *from);
1566void BIO_ssl_shutdown(BIO *ssl_bio);
1567
1568__owur int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
1569__owur SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth);
1570__owur SSL_CTX *SSL_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq,
1571                               const SSL_METHOD *meth);
1572int SSL_CTX_up_ref(SSL_CTX *ctx);
1573void SSL_CTX_free(SSL_CTX *);
1574__owur long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
1575__owur long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1576__owur X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
1577void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
1578void SSL_CTX_set1_cert_store(SSL_CTX *, X509_STORE *);
1579__owur int SSL_want(const SSL *s);
1580__owur int SSL_clear(SSL *s);
1581
1582#ifndef OPENSSL_NO_DEPRECATED_3_4
1583OSSL_DEPRECATEDIN_3_4_FOR("not Y2038-safe, replace with SSL_CTX_flush_sessions_ex()")
1584void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
1585#endif
1586void SSL_CTX_flush_sessions_ex(SSL_CTX *ctx, time_t tm);
1587
1588__owur const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
1589__owur const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s);
1590__owur int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits);
1591__owur const char *SSL_CIPHER_get_version(const SSL_CIPHER *c);
1592__owur const char *SSL_CIPHER_get_name(const SSL_CIPHER *c);
1593__owur const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c);
1594__owur const char *OPENSSL_cipher_name(const char *rfc_name);
1595__owur uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c);
1596__owur uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c);
1597__owur int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c);
1598__owur int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c);
1599__owur const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c);
1600__owur int SSL_CIPHER_is_aead(const SSL_CIPHER *c);
1601
1602__owur int SSL_get_fd(const SSL *s);
1603__owur int SSL_get_rfd(const SSL *s);
1604__owur int SSL_get_wfd(const SSL *s);
1605__owur const char *SSL_get_cipher_list(const SSL *s, int n);
1606__owur char *SSL_get_shared_ciphers(const SSL *s, char *buf, int size);
1607__owur int SSL_get_read_ahead(const SSL *s);
1608__owur int SSL_pending(const SSL *s);
1609__owur int SSL_has_pending(const SSL *s);
1610# ifndef OPENSSL_NO_SOCK
1611__owur int SSL_set_fd(SSL *s, int fd);
1612__owur int SSL_set_rfd(SSL *s, int fd);
1613__owur int SSL_set_wfd(SSL *s, int fd);
1614# endif
1615void SSL_set0_rbio(SSL *s, BIO *rbio);
1616void SSL_set0_wbio(SSL *s, BIO *wbio);
1617void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
1618__owur BIO *SSL_get_rbio(const SSL *s);
1619__owur BIO *SSL_get_wbio(const SSL *s);
1620__owur int SSL_set_cipher_list(SSL *s, const char *str);
1621__owur int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str);
1622__owur int SSL_set_ciphersuites(SSL *s, const char *str);
1623void SSL_set_read_ahead(SSL *s, int yes);
1624__owur int SSL_get_verify_mode(const SSL *s);
1625__owur int SSL_get_verify_depth(const SSL *s);
1626__owur SSL_verify_cb SSL_get_verify_callback(const SSL *s);
1627void SSL_set_verify(SSL *s, int mode, SSL_verify_cb callback);
1628void SSL_set_verify_depth(SSL *s, int depth);
1629void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg);
1630# ifndef OPENSSL_NO_DEPRECATED_3_0
1631OSSL_DEPRECATEDIN_3_0 __owur int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
1632OSSL_DEPRECATEDIN_3_0
1633__owur int SSL_use_RSAPrivateKey_ASN1(SSL *ssl,
1634                                      const unsigned char *d, long len);
1635# endif
1636__owur int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
1637__owur int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const unsigned char *d,
1638                                   long len);
1639__owur int SSL_use_certificate(SSL *ssl, X509 *x);
1640__owur int SSL_use_certificate_ASN1(SSL *ssl, const unsigned char *d, int len);
1641__owur int SSL_use_cert_and_key(SSL *ssl, X509 *x509, EVP_PKEY *privatekey,
1642                                STACK_OF(X509) *chain, int override);
1643
1644
1645/* serverinfo file format versions */
1646# define SSL_SERVERINFOV1   1
1647# define SSL_SERVERINFOV2   2
1648
1649/* Set serverinfo data for the current active cert. */
1650__owur int SSL_CTX_use_serverinfo(SSL_CTX *ctx, const unsigned char *serverinfo,
1651                                  size_t serverinfo_length);
1652__owur int SSL_CTX_use_serverinfo_ex(SSL_CTX *ctx, unsigned int version,
1653                                     const unsigned char *serverinfo,
1654                                     size_t serverinfo_length);
1655__owur int SSL_CTX_use_serverinfo_file(SSL_CTX *ctx, const char *file);
1656
1657#ifndef OPENSSL_NO_DEPRECATED_3_0
1658OSSL_DEPRECATEDIN_3_0
1659__owur int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
1660#endif
1661
1662__owur int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
1663__owur int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
1664
1665#ifndef OPENSSL_NO_DEPRECATED_3_0
1666OSSL_DEPRECATEDIN_3_0
1667__owur int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file,
1668                                          int type);
1669#endif
1670__owur int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
1671                                       int type);
1672__owur int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
1673                                        int type);
1674/* PEM type */
1675__owur int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
1676__owur int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
1677__owur STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
1678__owur STACK_OF(X509_NAME)
1679*SSL_load_client_CA_file_ex(const char *file, OSSL_LIB_CTX *libctx,
1680                            const char *propq);
1681__owur int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1682                                               const char *file);
1683int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1684                                       const char *dir);
1685int SSL_add_store_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1686                                       const char *uri);
1687
1688# ifndef OPENSSL_NO_DEPRECATED_1_1_0
1689#  define SSL_load_error_strings() \
1690    OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \
1691                     | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
1692# endif
1693
1694__owur const char *SSL_state_string(const SSL *s);
1695__owur const char *SSL_rstate_string(const SSL *s);
1696__owur const char *SSL_state_string_long(const SSL *s);
1697__owur const char *SSL_rstate_string_long(const SSL *s);
1698
1699#ifndef OPENSSL_NO_DEPRECATED_3_4
1700OSSL_DEPRECATEDIN_3_4_FOR("not Y2038-safe, replace with SSL_SESSION_get_time_ex()")
1701__owur long SSL_SESSION_get_time(const SSL_SESSION *s);
1702OSSL_DEPRECATEDIN_3_4_FOR("not Y2038-safe, replace with SSL_SESSION_set_time_ex()")
1703__owur long SSL_SESSION_set_time(SSL_SESSION *s, long t);
1704#endif
1705__owur long SSL_SESSION_get_timeout(const SSL_SESSION *s);
1706__owur long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
1707__owur int SSL_SESSION_get_protocol_version(const SSL_SESSION *s);
1708__owur int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version);
1709
1710__owur time_t SSL_SESSION_get_time_ex(const SSL_SESSION *s);
1711__owur time_t SSL_SESSION_set_time_ex(SSL_SESSION *s, time_t t);
1712
1713__owur const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s);
1714__owur int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname);
1715void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
1716                                    const unsigned char **alpn,
1717                                    size_t *len);
1718__owur int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s,
1719                                          const unsigned char *alpn,
1720                                          size_t len);
1721__owur const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
1722__owur int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher);
1723__owur int SSL_SESSION_has_ticket(const SSL_SESSION *s);
1724__owur unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
1725void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
1726                             size_t *len);
1727__owur uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s);
1728__owur int SSL_SESSION_set_max_early_data(SSL_SESSION *s,
1729                                          uint32_t max_early_data);
1730__owur int SSL_copy_session_id(SSL *to, const SSL *from);
1731__owur X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
1732__owur int SSL_SESSION_set1_id_context(SSL_SESSION *s,
1733                                       const unsigned char *sid_ctx,
1734                                       unsigned int sid_ctx_len);
1735__owur int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
1736                               unsigned int sid_len);
1737__owur int SSL_SESSION_is_resumable(const SSL_SESSION *s);
1738
1739__owur SSL_SESSION *SSL_SESSION_new(void);
1740__owur SSL_SESSION *SSL_SESSION_dup(const SSL_SESSION *src);
1741const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
1742                                        unsigned int *len);
1743const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
1744                                                 unsigned int *len);
1745__owur unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s);
1746# ifndef OPENSSL_NO_STDIO
1747int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
1748# endif
1749int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
1750int SSL_SESSION_print_keylog(BIO *bp, const SSL_SESSION *x);
1751int SSL_SESSION_up_ref(SSL_SESSION *ses);
1752void SSL_SESSION_free(SSL_SESSION *ses);
1753__owur int i2d_SSL_SESSION(const SSL_SESSION *in, unsigned char **pp);
1754__owur int SSL_set_session(SSL *to, SSL_SESSION *session);
1755int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *session);
1756int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *session);
1757__owur int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb);
1758__owur int SSL_set_generate_session_id(SSL *s, GEN_SESSION_CB cb);
1759__owur int SSL_has_matching_session_id(const SSL *s,
1760                                       const unsigned char *id,
1761                                       unsigned int id_len);
1762SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
1763                             long length);
1764SSL_SESSION *d2i_SSL_SESSION_ex(SSL_SESSION **a, const unsigned char **pp,
1765                                long length, OSSL_LIB_CTX *libctx,
1766                                const char *propq);
1767
1768# ifdef OPENSSL_X509_H
1769__owur X509 *SSL_get0_peer_certificate(const SSL *s);
1770__owur X509 *SSL_get1_peer_certificate(const SSL *s);
1771/* Deprecated in 3.0.0 */
1772#  ifndef OPENSSL_NO_DEPRECATED_3_0
1773#   define SSL_get_peer_certificate SSL_get1_peer_certificate
1774#  endif
1775# endif
1776
1777__owur STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
1778
1779__owur int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1780__owur int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
1781__owur SSL_verify_cb SSL_CTX_get_verify_callback(const SSL_CTX *ctx);
1782void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, SSL_verify_cb callback);
1783void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1784void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
1785                                      int (*cb) (X509_STORE_CTX *, void *),
1786                                      void *arg);
1787void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg),
1788                         void *arg);
1789# ifndef OPENSSL_NO_DEPRECATED_3_0
1790OSSL_DEPRECATEDIN_3_0
1791__owur int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
1792OSSL_DEPRECATEDIN_3_0
1793__owur int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, const unsigned char *d,
1794                                          long len);
1795# endif
1796__owur int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
1797__owur int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
1798                                       const unsigned char *d, long len);
1799__owur int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
1800__owur int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
1801                                        const unsigned char *d);
1802__owur int SSL_CTX_use_cert_and_key(SSL_CTX *ctx, X509 *x509, EVP_PKEY *privatekey,
1803                                    STACK_OF(X509) *chain, int override);
1804
1805void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);
1806void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u);
1807pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx);
1808void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx);
1809void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb);
1810void SSL_set_default_passwd_cb_userdata(SSL *s, void *u);
1811pem_password_cb *SSL_get_default_passwd_cb(SSL *s);
1812void *SSL_get_default_passwd_cb_userdata(SSL *s);
1813
1814__owur int SSL_CTX_check_private_key(const SSL_CTX *ctx);
1815__owur int SSL_check_private_key(const SSL *ctx);
1816
1817__owur int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
1818                                          const unsigned char *sid_ctx,
1819                                          unsigned int sid_ctx_len);
1820
1821SSL *SSL_new(SSL_CTX *ctx);
1822int SSL_up_ref(SSL *s);
1823int SSL_is_dtls(const SSL *s);
1824int SSL_is_tls(const SSL *s);
1825int SSL_is_quic(const SSL *s);
1826__owur int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
1827                                      unsigned int sid_ctx_len);
1828
1829__owur int SSL_CTX_set_purpose(SSL_CTX *ctx, int purpose);
1830__owur int SSL_set_purpose(SSL *ssl, int purpose);
1831__owur int SSL_CTX_set_trust(SSL_CTX *ctx, int trust);
1832__owur int SSL_set_trust(SSL *ssl, int trust);
1833
1834__owur int SSL_set1_host(SSL *s, const char *host);
1835__owur int SSL_add1_host(SSL *s, const char *host);
1836__owur const char *SSL_get0_peername(SSL *s);
1837void SSL_set_hostflags(SSL *s, unsigned int flags);
1838
1839__owur int SSL_CTX_dane_enable(SSL_CTX *ctx);
1840__owur int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md,
1841                                  uint8_t mtype, uint8_t ord);
1842__owur int SSL_dane_enable(SSL *s, const char *basedomain);
1843__owur int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1844                             uint8_t mtype, const unsigned char *data, size_t dlen);
1845__owur int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki);
1846__owur int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1847                              uint8_t *mtype, const unsigned char **data,
1848                              size_t *dlen);
1849/*
1850 * Bridge opacity barrier between libcrypt and libssl, also needed to support
1851 * offline testing in test/danetest.c
1852 */
1853SSL_DANE *SSL_get0_dane(SSL *ssl);
1854/*
1855 * DANE flags
1856 */
1857unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags);
1858unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags);
1859unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags);
1860unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags);
1861
1862__owur int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
1863__owur int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
1864
1865__owur X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
1866__owur X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
1867
1868# ifndef OPENSSL_NO_SRP
1869#  ifndef OPENSSL_NO_DEPRECATED_3_0
1870OSSL_DEPRECATEDIN_3_0 int SSL_CTX_set_srp_username(SSL_CTX *ctx, char *name);
1871OSSL_DEPRECATEDIN_3_0 int SSL_CTX_set_srp_password(SSL_CTX *ctx, char *password);
1872OSSL_DEPRECATEDIN_3_0 int SSL_CTX_set_srp_strength(SSL_CTX *ctx, int strength);
1873OSSL_DEPRECATEDIN_3_0
1874int SSL_CTX_set_srp_client_pwd_callback(SSL_CTX *ctx,
1875                                        char *(*cb) (SSL *, void *));
1876OSSL_DEPRECATEDIN_3_0
1877int SSL_CTX_set_srp_verify_param_callback(SSL_CTX *ctx,
1878                                          int (*cb) (SSL *, void *));
1879OSSL_DEPRECATEDIN_3_0
1880int SSL_CTX_set_srp_username_callback(SSL_CTX *ctx,
1881                                      int (*cb) (SSL *, int *, void *));
1882OSSL_DEPRECATEDIN_3_0 int SSL_CTX_set_srp_cb_arg(SSL_CTX *ctx, void *arg);
1883
1884OSSL_DEPRECATEDIN_3_0
1885int SSL_set_srp_server_param(SSL *s, const BIGNUM *N, const BIGNUM *g,
1886                             BIGNUM *sa, BIGNUM *v, char *info);
1887OSSL_DEPRECATEDIN_3_0
1888int SSL_set_srp_server_param_pw(SSL *s, const char *user, const char *pass,
1889                                const char *grp);
1890
1891OSSL_DEPRECATEDIN_3_0 __owur BIGNUM *SSL_get_srp_g(SSL *s);
1892OSSL_DEPRECATEDIN_3_0 __owur BIGNUM *SSL_get_srp_N(SSL *s);
1893
1894OSSL_DEPRECATEDIN_3_0 __owur char *SSL_get_srp_username(SSL *s);
1895OSSL_DEPRECATEDIN_3_0 __owur char *SSL_get_srp_userinfo(SSL *s);
1896#  endif
1897# endif
1898
1899/*
1900 * ClientHello callback and helpers.
1901 */
1902
1903# define SSL_CLIENT_HELLO_SUCCESS 1
1904# define SSL_CLIENT_HELLO_ERROR   0
1905# define SSL_CLIENT_HELLO_RETRY   (-1)
1906
1907typedef int (*SSL_client_hello_cb_fn) (SSL *s, int *al, void *arg);
1908void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
1909                                 void *arg);
1910typedef int (*SSL_new_pending_conn_cb_fn) (SSL_CTX *ctx, SSL *new_ssl,
1911                                           void *arg);
1912void SSL_CTX_set_new_pending_conn_cb(SSL_CTX *c, SSL_new_pending_conn_cb_fn cb,
1913                                     void *arg);
1914
1915int SSL_client_hello_isv2(SSL *s);
1916unsigned int SSL_client_hello_get0_legacy_version(SSL *s);
1917size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out);
1918size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out);
1919size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out);
1920size_t SSL_client_hello_get0_compression_methods(SSL *s,
1921                                                 const unsigned char **out);
1922int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen);
1923int SSL_client_hello_get_extension_order(SSL *s, uint16_t *exts,
1924                                         size_t *num_exts);
1925int SSL_client_hello_get0_ext(SSL *s, unsigned int type,
1926                              const unsigned char **out, size_t *outlen);
1927
1928void SSL_certs_clear(SSL *s);
1929void SSL_free(SSL *ssl);
1930# ifdef OSSL_ASYNC_FD
1931/*
1932 * Windows application developer has to include windows.h to use these.
1933 */
1934__owur int SSL_waiting_for_async(SSL *s);
1935__owur int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds);
1936__owur int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd,
1937                                     size_t *numaddfds, OSSL_ASYNC_FD *delfd,
1938                                     size_t *numdelfds);
1939__owur int SSL_CTX_set_async_callback(SSL_CTX *ctx, SSL_async_callback_fn callback);
1940__owur int SSL_CTX_set_async_callback_arg(SSL_CTX *ctx, void *arg);
1941__owur int SSL_set_async_callback(SSL *s, SSL_async_callback_fn callback);
1942__owur int SSL_set_async_callback_arg(SSL *s, void *arg);
1943__owur int SSL_get_async_status(SSL *s, int *status);
1944
1945# endif
1946__owur int SSL_accept(SSL *ssl);
1947__owur int SSL_stateless(SSL *s);
1948__owur int SSL_connect(SSL *ssl);
1949__owur int SSL_read(SSL *ssl, void *buf, int num);
1950__owur int SSL_read_ex(SSL *ssl, void *buf, size_t num, size_t *readbytes);
1951
1952# define SSL_READ_EARLY_DATA_ERROR   0
1953# define SSL_READ_EARLY_DATA_SUCCESS 1
1954# define SSL_READ_EARLY_DATA_FINISH  2
1955
1956__owur int SSL_read_early_data(SSL *s, void *buf, size_t num,
1957                               size_t *readbytes);
1958__owur int SSL_peek(SSL *ssl, void *buf, int num);
1959__owur int SSL_peek_ex(SSL *ssl, void *buf, size_t num, size_t *readbytes);
1960__owur ossl_ssize_t SSL_sendfile(SSL *s, int fd, off_t offset, size_t size,
1961                                 int flags);
1962__owur int SSL_write(SSL *ssl, const void *buf, int num);
1963__owur int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written);
1964__owur int SSL_write_early_data(SSL *s, const void *buf, size_t num,
1965                                size_t *written);
1966long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
1967long SSL_callback_ctrl(SSL *, int, void (*)(void));
1968long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
1969long SSL_CTX_callback_ctrl(SSL_CTX *, int, void (*)(void));
1970
1971# define SSL_WRITE_FLAG_CONCLUDE    (1U << 0)
1972
1973__owur int SSL_write_ex2(SSL *s, const void *buf, size_t num,
1974                         uint64_t flags,
1975                         size_t *written);
1976
1977# define SSL_EARLY_DATA_NOT_SENT    0
1978# define SSL_EARLY_DATA_REJECTED    1
1979# define SSL_EARLY_DATA_ACCEPTED    2
1980
1981__owur int SSL_get_early_data_status(const SSL *s);
1982
1983__owur int SSL_get_error(const SSL *s, int ret_code);
1984__owur const char *SSL_get_version(const SSL *s);
1985__owur int SSL_get_handshake_rtt(const SSL *s, uint64_t *rtt);
1986
1987/* This sets the 'default' SSL version that SSL_new() will create */
1988# ifndef OPENSSL_NO_DEPRECATED_3_0
1989OSSL_DEPRECATEDIN_3_0
1990__owur int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth);
1991# endif
1992
1993# ifndef OPENSSL_NO_SSL3_METHOD
1994#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
1995OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *SSLv3_method(void); /* SSLv3 */
1996OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *SSLv3_server_method(void);
1997OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *SSLv3_client_method(void);
1998#  endif
1999# endif
2000
2001#define SSLv23_method           TLS_method
2002#define SSLv23_server_method    TLS_server_method
2003#define SSLv23_client_method    TLS_client_method
2004
2005/* Negotiate highest available SSL/TLS version */
2006__owur const SSL_METHOD *TLS_method(void);
2007__owur const SSL_METHOD *TLS_server_method(void);
2008__owur const SSL_METHOD *TLS_client_method(void);
2009
2010# ifndef OPENSSL_NO_TLS1_METHOD
2011#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
2012OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_method(void); /* TLSv1.0 */
2013OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_server_method(void);
2014OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_client_method(void);
2015#  endif
2016# endif
2017
2018# ifndef OPENSSL_NO_TLS1_1_METHOD
2019#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
2020OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_1_method(void); /* TLSv1.1 */
2021OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_1_server_method(void);
2022OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_1_client_method(void);
2023#  endif
2024# endif
2025
2026# ifndef OPENSSL_NO_TLS1_2_METHOD
2027#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
2028OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_2_method(void); /* TLSv1.2 */
2029OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_2_server_method(void);
2030OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *TLSv1_2_client_method(void);
2031#  endif
2032# endif
2033
2034# ifndef OPENSSL_NO_DTLS1_METHOD
2035#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
2036OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *DTLSv1_method(void); /* DTLSv1.0 */
2037OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *DTLSv1_server_method(void);
2038OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *DTLSv1_client_method(void);
2039#  endif
2040# endif
2041
2042# ifndef OPENSSL_NO_DTLS1_2_METHOD
2043/* DTLSv1.2 */
2044#  ifndef OPENSSL_NO_DEPRECATED_1_1_0
2045OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *DTLSv1_2_method(void);
2046OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *DTLSv1_2_server_method(void);
2047OSSL_DEPRECATEDIN_1_1_0 __owur const SSL_METHOD *DTLSv1_2_client_method(void);
2048#  endif
2049# endif
2050
2051__owur const SSL_METHOD *DTLS_method(void); /* DTLS 1.0 and 1.2 */
2052__owur const SSL_METHOD *DTLS_server_method(void); /* DTLS 1.0 and 1.2 */
2053__owur const SSL_METHOD *DTLS_client_method(void); /* DTLS 1.0 and 1.2 */
2054
2055__owur size_t DTLS_get_data_mtu(const SSL *s);
2056
2057__owur STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
2058__owur STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx);
2059__owur STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s);
2060__owur STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s);
2061
2062__owur int SSL_do_handshake(SSL *s);
2063int SSL_key_update(SSL *s, int updatetype);
2064int SSL_get_key_update_type(const SSL *s);
2065int SSL_renegotiate(SSL *s);
2066int SSL_renegotiate_abbreviated(SSL *s);
2067__owur int SSL_renegotiate_pending(const SSL *s);
2068int SSL_new_session_ticket(SSL *s);
2069int SSL_shutdown(SSL *s);
2070__owur int SSL_verify_client_post_handshake(SSL *s);
2071void SSL_CTX_set_post_handshake_auth(SSL_CTX *ctx, int val);
2072void SSL_set_post_handshake_auth(SSL *s, int val);
2073
2074__owur const SSL_METHOD *SSL_CTX_get_ssl_method(const SSL_CTX *ctx);
2075__owur const SSL_METHOD *SSL_get_ssl_method(const SSL *s);
2076__owur int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2077__owur const char *SSL_alert_type_string_long(int value);
2078__owur const char *SSL_alert_type_string(int value);
2079__owur const char *SSL_alert_desc_string_long(int value);
2080__owur const char *SSL_alert_desc_string(int value);
2081
2082void SSL_set0_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
2083void SSL_CTX_set0_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
2084__owur const STACK_OF(X509_NAME) *SSL_get0_CA_list(const SSL *s);
2085__owur const STACK_OF(X509_NAME) *SSL_CTX_get0_CA_list(const SSL_CTX *ctx);
2086__owur int SSL_add1_to_CA_list(SSL *ssl, const X509 *x);
2087__owur int SSL_CTX_add1_to_CA_list(SSL_CTX *ctx, const X509 *x);
2088__owur const STACK_OF(X509_NAME) *SSL_get0_peer_CA_list(const SSL *s);
2089
2090void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
2091void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
2092__owur STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
2093__owur STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2094__owur int SSL_add_client_CA(SSL *ssl, X509 *x);
2095__owur int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
2096
2097void SSL_set_connect_state(SSL *s);
2098void SSL_set_accept_state(SSL *s);
2099
2100__owur long SSL_get_default_timeout(const SSL *s);
2101
2102# ifndef OPENSSL_NO_DEPRECATED_1_1_0
2103#  define SSL_library_init() OPENSSL_init_ssl(0, NULL)
2104# endif
2105
2106__owur char *SSL_CIPHER_description(const SSL_CIPHER *, char *buf, int size);
2107__owur STACK_OF(X509_NAME) *SSL_dup_CA_list(const STACK_OF(X509_NAME) *sk);
2108
2109__owur SSL *SSL_dup(SSL *ssl);
2110
2111__owur X509 *SSL_get_certificate(const SSL *ssl);
2112/*
2113 * EVP_PKEY
2114 */
2115struct evp_pkey_st *SSL_get_privatekey(const SSL *ssl);
2116
2117__owur X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
2118__owur EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
2119
2120void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
2121__owur int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
2122void SSL_set_quiet_shutdown(SSL *ssl, int mode);
2123__owur int SSL_get_quiet_shutdown(const SSL *ssl);
2124void SSL_set_shutdown(SSL *ssl, int mode);
2125__owur int SSL_get_shutdown(const SSL *ssl);
2126__owur int SSL_version(const SSL *ssl);
2127__owur int SSL_client_version(const SSL *s);
2128__owur int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
2129__owur int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx);
2130__owur int SSL_CTX_set_default_verify_file(SSL_CTX *ctx);
2131__owur int SSL_CTX_set_default_verify_store(SSL_CTX *ctx);
2132__owur int SSL_CTX_load_verify_file(SSL_CTX *ctx, const char *CAfile);
2133__owur int SSL_CTX_load_verify_dir(SSL_CTX *ctx, const char *CApath);
2134__owur int SSL_CTX_load_verify_store(SSL_CTX *ctx, const char *CAstore);
2135__owur int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2136                                                        const char *CAfile,
2137                                                        const char *CApath);
2138# define SSL_get0_session SSL_get_session/* just peek at pointer */
2139__owur SSL_SESSION *SSL_get_session(const SSL *ssl);
2140__owur SSL_SESSION *SSL_get1_session(SSL *ssl); /* obtain a reference count */
2141__owur SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
2142SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
2143void SSL_set_info_callback(SSL *ssl,
2144                           void (*cb) (const SSL *ssl, int type, int val));
2145void (*SSL_get_info_callback(const SSL *ssl)) (const SSL *ssl, int type,
2146                                               int val);
2147__owur OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl);
2148
2149void SSL_set_verify_result(SSL *ssl, long v);
2150__owur long SSL_get_verify_result(const SSL *ssl);
2151__owur STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s);
2152
2153__owur size_t SSL_get_client_random(const SSL *ssl, unsigned char *out,
2154                                    size_t outlen);
2155__owur size_t SSL_get_server_random(const SSL *ssl, unsigned char *out,
2156                                    size_t outlen);
2157__owur size_t SSL_SESSION_get_master_key(const SSL_SESSION *sess,
2158                                         unsigned char *out, size_t outlen);
2159__owur int SSL_SESSION_set1_master_key(SSL_SESSION *sess,
2160                                       const unsigned char *in, size_t len);
2161uint8_t SSL_SESSION_get_max_fragment_length(const SSL_SESSION *sess);
2162
2163#define SSL_get_ex_new_index(l, p, newf, dupf, freef) \
2164    CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL, l, p, newf, dupf, freef)
2165__owur int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2166void *SSL_get_ex_data(const SSL *ssl, int idx);
2167#define SSL_SESSION_get_ex_new_index(l, p, newf, dupf, freef) \
2168    CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, l, p, newf, dupf, freef)
2169__owur int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx, void *data);
2170void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2171#define SSL_CTX_get_ex_new_index(l, p, newf, dupf, freef) \
2172    CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_CTX, l, p, newf, dupf, freef)
2173__owur int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2174void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2175
2176__owur int SSL_get_ex_data_X509_STORE_CTX_idx(void);
2177
2178# define SSL_CTX_sess_set_cache_size(ctx,t) \
2179        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_SIZE,t,NULL)
2180# define SSL_CTX_sess_get_cache_size(ctx) \
2181        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_SIZE,0,NULL)
2182# define SSL_CTX_set_session_cache_mode(ctx,m) \
2183        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_MODE,m,NULL)
2184# define SSL_CTX_get_session_cache_mode(ctx) \
2185        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_MODE,0,NULL)
2186
2187# define SSL_CTX_get_default_read_ahead(ctx) SSL_CTX_get_read_ahead(ctx)
2188# define SSL_CTX_set_default_read_ahead(ctx,m) SSL_CTX_set_read_ahead(ctx,m)
2189# define SSL_CTX_get_read_ahead(ctx) \
2190        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_READ_AHEAD,0,NULL)
2191# define SSL_CTX_set_read_ahead(ctx,m) \
2192        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_READ_AHEAD,m,NULL)
2193# define SSL_CTX_get_max_cert_list(ctx) \
2194        SSL_CTX_ctrl(ctx,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL)
2195# define SSL_CTX_set_max_cert_list(ctx,m) \
2196        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL)
2197# define SSL_get_max_cert_list(ssl) \
2198        SSL_ctrl(ssl,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL)
2199# define SSL_set_max_cert_list(ssl,m) \
2200        SSL_ctrl(ssl,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL)
2201
2202# define SSL_CTX_set_max_send_fragment(ctx,m) \
2203        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL)
2204# define SSL_set_max_send_fragment(ssl,m) \
2205        SSL_ctrl(ssl,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL)
2206# define SSL_CTX_set_split_send_fragment(ctx,m) \
2207        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SPLIT_SEND_FRAGMENT,m,NULL)
2208# define SSL_set_split_send_fragment(ssl,m) \
2209        SSL_ctrl(ssl,SSL_CTRL_SET_SPLIT_SEND_FRAGMENT,m,NULL)
2210# define SSL_CTX_set_max_pipelines(ctx,m) \
2211        SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_PIPELINES,m,NULL)
2212# define SSL_set_max_pipelines(ssl,m) \
2213        SSL_ctrl(ssl,SSL_CTRL_SET_MAX_PIPELINES,m,NULL)
2214# define SSL_set_retry_verify(ssl) \
2215        (SSL_ctrl(ssl,SSL_CTRL_SET_RETRY_VERIFY,0,NULL) > 0)
2216
2217void SSL_CTX_set_default_read_buffer_len(SSL_CTX *ctx, size_t len);
2218void SSL_set_default_read_buffer_len(SSL *s, size_t len);
2219
2220# ifndef OPENSSL_NO_DH
2221#  ifndef OPENSSL_NO_DEPRECATED_3_0
2222/* NB: the |keylength| is only applicable when is_export is true */
2223OSSL_DEPRECATEDIN_3_0
2224void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
2225                                 DH *(*dh) (SSL *ssl, int is_export,
2226                                            int keylength));
2227OSSL_DEPRECATEDIN_3_0
2228void SSL_set_tmp_dh_callback(SSL *ssl,
2229                             DH *(*dh) (SSL *ssl, int is_export,
2230                                        int keylength));
2231#  endif
2232# endif
2233
2234__owur const COMP_METHOD *SSL_get_current_compression(const SSL *s);
2235__owur const COMP_METHOD *SSL_get_current_expansion(const SSL *s);
2236__owur const char *SSL_COMP_get_name(const COMP_METHOD *comp);
2237__owur const char *SSL_COMP_get0_name(const SSL_COMP *comp);
2238__owur int SSL_COMP_get_id(const SSL_COMP *comp);
2239STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void);
2240__owur STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
2241                                                             *meths);
2242# ifndef OPENSSL_NO_DEPRECATED_1_1_0
2243#  define SSL_COMP_free_compression_methods() while(0) continue
2244# endif
2245__owur int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
2246
2247const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr);
2248int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c);
2249int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c);
2250int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
2251                             int isv2format, STACK_OF(SSL_CIPHER) **sk,
2252                             STACK_OF(SSL_CIPHER) **scsvs);
2253
2254/* TLS extensions functions */
2255__owur int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len);
2256
2257__owur int SSL_set_session_ticket_ext_cb(SSL *s,
2258                                         tls_session_ticket_ext_cb_fn cb,
2259                                         void *arg);
2260
2261/* Pre-shared secret session resumption functions */
2262__owur int SSL_set_session_secret_cb(SSL *s,
2263                                     tls_session_secret_cb_fn session_secret_cb,
2264                                     void *arg);
2265
2266void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
2267                                                int (*cb) (SSL *ssl,
2268                                                           int
2269                                                           is_forward_secure));
2270
2271void SSL_set_not_resumable_session_callback(SSL *ssl,
2272                                            int (*cb) (SSL *ssl,
2273                                                       int is_forward_secure));
2274
2275void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
2276                                         size_t (*cb) (SSL *ssl, int type,
2277                                                       size_t len, void *arg));
2278void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg);
2279void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX *ctx);
2280int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size);
2281int SSL_CTX_set_block_padding_ex(SSL_CTX *ctx, size_t app_block_size,
2282                                 size_t hs_block_size);
2283
2284int SSL_set_record_padding_callback(SSL *ssl,
2285                                    size_t (*cb) (SSL *ssl, int type,
2286                                                  size_t len, void *arg));
2287void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg);
2288void *SSL_get_record_padding_callback_arg(const SSL *ssl);
2289int SSL_set_block_padding(SSL *ssl, size_t block_size);
2290int SSL_set_block_padding_ex(SSL *ssl, size_t app_block_size,
2291                             size_t hs_block_size);
2292int SSL_set_num_tickets(SSL *s, size_t num_tickets);
2293size_t SSL_get_num_tickets(const SSL *s);
2294int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets);
2295size_t SSL_CTX_get_num_tickets(const SSL_CTX *ctx);
2296
2297/* QUIC support */
2298int SSL_handle_events(SSL *s);
2299__owur int SSL_get_event_timeout(SSL *s, struct timeval *tv, int *is_infinite);
2300__owur int SSL_get_rpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
2301__owur int SSL_get_wpoll_descriptor(SSL *s, BIO_POLL_DESCRIPTOR *desc);
2302__owur int SSL_net_read_desired(SSL *s);
2303__owur int SSL_net_write_desired(SSL *s);
2304__owur int SSL_set_blocking_mode(SSL *s, int blocking);
2305__owur int SSL_get_blocking_mode(SSL *s);
2306__owur int SSL_set1_initial_peer_addr(SSL *s, const BIO_ADDR *peer_addr);
2307__owur SSL *SSL_get0_connection(SSL *s);
2308__owur int SSL_is_connection(SSL *s);
2309
2310__owur int SSL_is_listener(SSL *ssl);
2311__owur SSL *SSL_get0_listener(SSL *s);
2312#define SSL_LISTENER_FLAG_NO_VALIDATE   (1UL << 1)
2313__owur SSL *SSL_new_listener(SSL_CTX *ctx, uint64_t flags);
2314__owur SSL *SSL_new_listener_from(SSL *ssl, uint64_t flags);
2315__owur SSL *SSL_new_from_listener(SSL *ssl, uint64_t flags);
2316#define SSL_ACCEPT_CONNECTION_NO_BLOCK  (1UL << 0)
2317__owur SSL *SSL_accept_connection(SSL *ssl, uint64_t flags);
2318__owur size_t SSL_get_accept_connection_queue_len(SSL *ssl);
2319__owur int SSL_listen(SSL *ssl);
2320
2321__owur int SSL_is_domain(SSL *s);
2322__owur SSL *SSL_get0_domain(SSL *s);
2323__owur SSL *SSL_new_domain(SSL_CTX *ctx, uint64_t flags);
2324
2325#define SSL_DOMAIN_FLAG_SINGLE_THREAD       (1U << 0)
2326#define SSL_DOMAIN_FLAG_MULTI_THREAD        (1U << 1)
2327#define SSL_DOMAIN_FLAG_THREAD_ASSISTED     (1U << 2)
2328#define SSL_DOMAIN_FLAG_BLOCKING            (1U << 3)
2329#define SSL_DOMAIN_FLAG_LEGACY_BLOCKING     (1U << 4)
2330
2331__owur int SSL_CTX_set_domain_flags(SSL_CTX *ctx, uint64_t domain_flags);
2332__owur int SSL_CTX_get_domain_flags(const SSL_CTX *ctx, uint64_t *domain_flags);
2333__owur int SSL_get_domain_flags(const SSL *ssl, uint64_t *domain_flags);
2334
2335#define SSL_STREAM_TYPE_NONE        0
2336#define SSL_STREAM_TYPE_READ        (1U << 0)
2337#define SSL_STREAM_TYPE_WRITE       (1U << 1)
2338#define SSL_STREAM_TYPE_BIDI        (SSL_STREAM_TYPE_READ | SSL_STREAM_TYPE_WRITE)
2339__owur int SSL_get_stream_type(SSL *s);
2340
2341__owur uint64_t SSL_get_stream_id(SSL *s);
2342__owur int SSL_is_stream_local(SSL *s);
2343
2344#define SSL_DEFAULT_STREAM_MODE_NONE        0
2345#define SSL_DEFAULT_STREAM_MODE_AUTO_BIDI   1
2346#define SSL_DEFAULT_STREAM_MODE_AUTO_UNI    2
2347__owur int SSL_set_default_stream_mode(SSL *s, uint32_t mode);
2348
2349#define SSL_STREAM_FLAG_UNI         (1U << 0)
2350#define SSL_STREAM_FLAG_NO_BLOCK    (1U << 1)
2351#define SSL_STREAM_FLAG_ADVANCE     (1U << 2)
2352__owur SSL *SSL_new_stream(SSL *s, uint64_t flags);
2353
2354#define SSL_INCOMING_STREAM_POLICY_AUTO      0
2355#define SSL_INCOMING_STREAM_POLICY_ACCEPT    1
2356#define SSL_INCOMING_STREAM_POLICY_REJECT    2
2357__owur int SSL_set_incoming_stream_policy(SSL *s, int policy, uint64_t aec);
2358
2359#define SSL_ACCEPT_STREAM_NO_BLOCK      (1U << 0)
2360__owur SSL *SSL_accept_stream(SSL *s, uint64_t flags);
2361__owur size_t SSL_get_accept_stream_queue_len(SSL *s);
2362
2363# ifndef OPENSSL_NO_QUIC
2364__owur int SSL_inject_net_dgram(SSL *s, const unsigned char *buf,
2365                                size_t buf_len,
2366                                const BIO_ADDR *peer,
2367                                const BIO_ADDR *local);
2368# endif
2369
2370typedef struct ssl_shutdown_ex_args_st {
2371    uint64_t    quic_error_code;
2372    const char  *quic_reason;
2373} SSL_SHUTDOWN_EX_ARGS;
2374
2375#define SSL_SHUTDOWN_FLAG_RAPID             (1U << 0)
2376#define SSL_SHUTDOWN_FLAG_NO_STREAM_FLUSH   (1U << 1)
2377#define SSL_SHUTDOWN_FLAG_NO_BLOCK          (1U << 2)
2378#define SSL_SHUTDOWN_FLAG_WAIT_PEER         (1U << 3)
2379
2380__owur int SSL_shutdown_ex(SSL *ssl, uint64_t flags,
2381                           const SSL_SHUTDOWN_EX_ARGS *args,
2382                           size_t args_len);
2383
2384__owur int SSL_stream_conclude(SSL *ssl, uint64_t flags);
2385
2386typedef struct ssl_stream_reset_args_st {
2387    uint64_t quic_error_code;
2388} SSL_STREAM_RESET_ARGS;
2389
2390__owur int SSL_stream_reset(SSL *ssl,
2391                            const SSL_STREAM_RESET_ARGS *args,
2392                            size_t args_len);
2393
2394#define SSL_STREAM_STATE_NONE           0
2395#define SSL_STREAM_STATE_OK             1
2396#define SSL_STREAM_STATE_WRONG_DIR      2
2397#define SSL_STREAM_STATE_FINISHED       3
2398#define SSL_STREAM_STATE_RESET_LOCAL    4
2399#define SSL_STREAM_STATE_RESET_REMOTE   5
2400#define SSL_STREAM_STATE_CONN_CLOSED    6
2401__owur int SSL_get_stream_read_state(SSL *ssl);
2402__owur int SSL_get_stream_write_state(SSL *ssl);
2403
2404__owur int SSL_get_stream_read_error_code(SSL *ssl, uint64_t *app_error_code);
2405__owur int SSL_get_stream_write_error_code(SSL *ssl, uint64_t *app_error_code);
2406
2407#define SSL_CONN_CLOSE_FLAG_LOCAL       (1U << 0)
2408#define SSL_CONN_CLOSE_FLAG_TRANSPORT   (1U << 1)
2409
2410typedef struct ssl_conn_close_info_st {
2411    uint64_t    error_code, frame_type;
2412    const char  *reason;
2413    size_t      reason_len;
2414    uint32_t    flags;
2415} SSL_CONN_CLOSE_INFO;
2416
2417__owur int SSL_get_conn_close_info(SSL *ssl,
2418                                   SSL_CONN_CLOSE_INFO *info,
2419                                   size_t info_len);
2420
2421# define SSL_VALUE_CLASS_GENERIC                0
2422# define SSL_VALUE_CLASS_FEATURE_REQUEST        1
2423# define SSL_VALUE_CLASS_FEATURE_PEER_REQUEST   2
2424# define SSL_VALUE_CLASS_FEATURE_NEGOTIATED     3
2425
2426# define SSL_VALUE_NONE                             0
2427# define SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL     1
2428# define SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL    2
2429# define SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL      3
2430# define SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL     4
2431# define SSL_VALUE_QUIC_IDLE_TIMEOUT                5
2432# define SSL_VALUE_EVENT_HANDLING_MODE              6
2433# define SSL_VALUE_STREAM_WRITE_BUF_SIZE            7
2434# define SSL_VALUE_STREAM_WRITE_BUF_USED            8
2435# define SSL_VALUE_STREAM_WRITE_BUF_AVAIL           9
2436
2437# define SSL_VALUE_EVENT_HANDLING_MODE_INHERIT      0
2438# define SSL_VALUE_EVENT_HANDLING_MODE_IMPLICIT     1
2439# define SSL_VALUE_EVENT_HANDLING_MODE_EXPLICIT     2
2440
2441int SSL_get_value_uint(SSL *s, uint32_t class_, uint32_t id, uint64_t *v);
2442int SSL_set_value_uint(SSL *s, uint32_t class_, uint32_t id, uint64_t v);
2443
2444# define SSL_get_generic_value_uint(ssl, id, v) \
2445    SSL_get_value_uint((ssl), SSL_VALUE_CLASS_GENERIC, (id), (v))
2446# define SSL_set_generic_value_uint(ssl, id, v) \
2447    SSL_set_value_uint((ssl), SSL_VALUE_CLASS_GENERIC, (id), (v))
2448# define SSL_get_feature_request_uint(ssl, id, v) \
2449    SSL_get_value_uint((ssl), SSL_VALUE_CLASS_FEATURE_REQUEST, (id), (v))
2450# define SSL_set_feature_request_uint(ssl, id, v) \
2451    SSL_set_value_uint((ssl), SSL_VALUE_CLASS_FEATURE_REQUEST, (id), (v))
2452# define SSL_get_feature_peer_request_uint(ssl, id, v) \
2453    SSL_get_value_uint((ssl), SSL_VALUE_CLASS_FEATURE_PEER_REQUEST, (id), (v))
2454# define SSL_get_feature_negotiated_uint(ssl, id, v) \
2455    SSL_get_value_uint((ssl), SSL_VALUE_CLASS_FEATURE_NEGOTIATED, (id), (v))
2456
2457# define SSL_get_quic_stream_bidi_local_avail(ssl, value) \
2458    SSL_get_generic_value_uint((ssl), SSL_VALUE_QUIC_STREAM_BIDI_LOCAL_AVAIL, \
2459                               (value))
2460# define SSL_get_quic_stream_bidi_remote_avail(ssl, value) \
2461    SSL_get_generic_value_uint((ssl), SSL_VALUE_QUIC_STREAM_BIDI_REMOTE_AVAIL, \
2462                               (value))
2463# define SSL_get_quic_stream_uni_local_avail(ssl, value) \
2464    SSL_get_generic_value_uint((ssl), SSL_VALUE_QUIC_STREAM_UNI_LOCAL_AVAIL, \
2465                               (value))
2466# define SSL_get_quic_stream_uni_remote_avail(ssl, value) \
2467    SSL_get_generic_value_uint((ssl), SSL_VALUE_QUIC_STREAM_UNI_REMOTE_AVAIL, \
2468                               (value))
2469
2470# define SSL_get_event_handling_mode(ssl, value) \
2471    SSL_get_generic_value_uint((ssl), SSL_VALUE_EVENT_HANDLING_MODE, \
2472                               (value))
2473# define SSL_set_event_handling_mode(ssl, value) \
2474    SSL_set_generic_value_uint((ssl), SSL_VALUE_EVENT_HANDLING_MODE, \
2475                               (value))
2476
2477# define SSL_get_stream_write_buf_size(ssl, value) \
2478    SSL_get_generic_value_uint((ssl), SSL_VALUE_STREAM_WRITE_BUF_SIZE, \
2479                               (value))
2480# define SSL_get_stream_write_buf_used(ssl, value) \
2481    SSL_get_generic_value_uint((ssl), SSL_VALUE_STREAM_WRITE_BUF_USED, \
2482                               (value))
2483# define SSL_get_stream_write_buf_avail(ssl, value) \
2484    SSL_get_generic_value_uint((ssl), SSL_VALUE_STREAM_WRITE_BUF_AVAIL, \
2485                               (value))
2486
2487# define SSL_POLL_EVENT_NONE        0
2488
2489# define SSL_POLL_EVENT_F           (1U <<  0) /* F   (Failure) */
2490# define SSL_POLL_EVENT_EL          (1U <<  1) /* EL  (Exception on Listener) */
2491# define SSL_POLL_EVENT_EC          (1U <<  2) /* EC  (Exception on Conn) */
2492# define SSL_POLL_EVENT_ECD         (1U <<  3) /* ECD (Exception on Conn Drained) */
2493# define SSL_POLL_EVENT_ER          (1U <<  4) /* ER  (Exception on Read) */
2494# define SSL_POLL_EVENT_EW          (1U <<  5) /* EW  (Exception on Write) */
2495# define SSL_POLL_EVENT_R           (1U <<  6) /* R   (Readable) */
2496# define SSL_POLL_EVENT_W           (1U <<  7) /* W   (Writable) */
2497# define SSL_POLL_EVENT_IC          (1U <<  8) /* IC  (Incoming Connection) */
2498# define SSL_POLL_EVENT_ISB         (1U <<  9) /* ISB (Incoming Stream: Bidi) */
2499# define SSL_POLL_EVENT_ISU         (1U << 10) /* ISU (Incoming Stream: Uni) */
2500# define SSL_POLL_EVENT_OSB         (1U << 11) /* OSB (Outgoing Stream: Bidi) */
2501# define SSL_POLL_EVENT_OSU         (1U << 12) /* OSU (Outgoing Stream: Uni) */
2502
2503# define SSL_POLL_EVENT_RW          (SSL_POLL_EVENT_R | SSL_POLL_EVENT_W)
2504# define SSL_POLL_EVENT_RE          (SSL_POLL_EVENT_R | SSL_POLL_EVENT_ER)
2505# define SSL_POLL_EVENT_WE          (SSL_POLL_EVENT_W | SSL_POLL_EVENT_EW)
2506# define SSL_POLL_EVENT_RWE         (SSL_POLL_EVENT_RE | SSL_POLL_EVENT_WE)
2507# define SSL_POLL_EVENT_E           (SSL_POLL_EVENT_EL | SSL_POLL_EVENT_EC \
2508                                     | SSL_POLL_EVENT_ER | SSL_POLL_EVENT_EW)
2509# define SSL_POLL_EVENT_IS          (SSL_POLL_EVENT_ISB | SSL_POLL_EVENT_ISU)
2510# define SSL_POLL_EVENT_ISE         (SSL_POLL_EVENT_IS | SSL_POLL_EVENT_EC)
2511# define SSL_POLL_EVENT_I           (SSL_POLL_EVENT_IS | SSL_POLL_EVENT_IC)
2512# define SSL_POLL_EVENT_OS          (SSL_POLL_EVENT_OSB | SSL_POLL_EVENT_OSU)
2513# define SSL_POLL_EVENT_OSE         (SSL_POLL_EVENT_OS | SSL_POLL_EVENT_EC)
2514
2515typedef struct ssl_poll_item_st {
2516    BIO_POLL_DESCRIPTOR desc;
2517    uint64_t            events, revents;
2518} SSL_POLL_ITEM;
2519
2520# define SSL_POLL_FLAG_NO_HANDLE_EVENTS  (1U << 0)
2521
2522__owur int SSL_poll(SSL_POLL_ITEM *items,
2523                    size_t num_items,
2524                    size_t stride,
2525                    const struct timeval *timeout,
2526                    uint64_t flags,
2527                    size_t *result_count);
2528
2529static ossl_inline ossl_unused BIO_POLL_DESCRIPTOR
2530SSL_as_poll_descriptor(SSL *s)
2531{
2532    BIO_POLL_DESCRIPTOR d;
2533
2534    d.type      = BIO_POLL_DESCRIPTOR_TYPE_SSL;
2535    d.value.ssl = s;
2536    return d;
2537}
2538
2539# ifndef OPENSSL_NO_DEPRECATED_1_1_0
2540#  define SSL_cache_hit(s) SSL_session_reused(s)
2541# endif
2542
2543__owur int SSL_session_reused(const SSL *s);
2544__owur int SSL_is_server(const SSL *s);
2545
2546__owur __owur SSL_CONF_CTX *SSL_CONF_CTX_new(void);
2547int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx);
2548void SSL_CONF_CTX_free(SSL_CONF_CTX *cctx);
2549unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
2550__owur unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx,
2551                                             unsigned int flags);
2552__owur int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *pre);
2553
2554void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl);
2555void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx);
2556
2557__owur int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value);
2558__owur int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
2559__owur int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd);
2560
2561void SSL_add_ssl_module(void);
2562int SSL_config(SSL *s, const char *name);
2563int SSL_CTX_config(SSL_CTX *ctx, const char *name);
2564
2565# ifndef OPENSSL_NO_SSL_TRACE
2566void SSL_trace(int write_p, int version, int content_type,
2567               const void *buf, size_t len, SSL *ssl, void *arg);
2568# endif
2569
2570# ifndef OPENSSL_NO_SOCK
2571int DTLSv1_listen(SSL *s, BIO_ADDR *client);
2572# endif
2573
2574# ifndef OPENSSL_NO_CT
2575
2576/*
2577 * A callback for verifying that the received SCTs are sufficient.
2578 * Expected to return 1 if they are sufficient, otherwise 0.
2579 * May return a negative integer if an error occurs.
2580 * A connection should be aborted if the SCTs are deemed insufficient.
2581 */
2582typedef int (*ssl_ct_validation_cb)(const CT_POLICY_EVAL_CTX *ctx,
2583                                    const STACK_OF(SCT) *scts, void *arg);
2584
2585/*
2586 * Sets a |callback| that is invoked upon receipt of ServerHelloDone to validate
2587 * the received SCTs.
2588 * If the callback returns a non-positive result, the connection is terminated.
2589 * Call this function before beginning a handshake.
2590 * If a NULL |callback| is provided, SCT validation is disabled.
2591 * |arg| is arbitrary userdata that will be passed to the callback whenever it
2592 * is invoked. Ownership of |arg| remains with the caller.
2593 *
2594 * NOTE: A side-effect of setting a CT callback is that an OCSP stapled response
2595 *       will be requested.
2596 */
2597int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
2598                                   void *arg);
2599int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
2600                                       ssl_ct_validation_cb callback,
2601                                       void *arg);
2602#define SSL_disable_ct(s) \
2603        ((void) SSL_set_validation_callback((s), NULL, NULL))
2604#define SSL_CTX_disable_ct(ctx) \
2605        ((void) SSL_CTX_set_validation_callback((ctx), NULL, NULL))
2606
2607/*
2608 * The validation type enumerates the available behaviours of the built-in SSL
2609 * CT validation callback selected via SSL_enable_ct() and SSL_CTX_enable_ct().
2610 * The underlying callback is a static function in libssl.
2611 */
2612enum {
2613    SSL_CT_VALIDATION_PERMISSIVE = 0,
2614    SSL_CT_VALIDATION_STRICT
2615};
2616
2617/*
2618 * Enable CT by setting up a callback that implements one of the built-in
2619 * validation variants.  The SSL_CT_VALIDATION_PERMISSIVE variant always
2620 * continues the handshake, the application can make appropriate decisions at
2621 * handshake completion.  The SSL_CT_VALIDATION_STRICT variant requires at
2622 * least one valid SCT, or else handshake termination will be requested.  The
2623 * handshake may continue anyway if SSL_VERIFY_NONE is in effect.
2624 */
2625int SSL_enable_ct(SSL *s, int validation_mode);
2626int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode);
2627
2628/*
2629 * Report whether a non-NULL callback is enabled.
2630 */
2631int SSL_ct_is_enabled(const SSL *s);
2632int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx);
2633
2634/* Gets the SCTs received from a connection */
2635const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s);
2636
2637/*
2638 * Loads the CT log list from the default location.
2639 * If a CTLOG_STORE has previously been set using SSL_CTX_set_ctlog_store,
2640 * the log information loaded from this file will be appended to the
2641 * CTLOG_STORE.
2642 * Returns 1 on success, 0 otherwise.
2643 */
2644int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx);
2645
2646/*
2647 * Loads the CT log list from the specified file path.
2648 * If a CTLOG_STORE has previously been set using SSL_CTX_set_ctlog_store,
2649 * the log information loaded from this file will be appended to the
2650 * CTLOG_STORE.
2651 * Returns 1 on success, 0 otherwise.
2652 */
2653int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
2654
2655/*
2656 * Sets the CT log list used by all SSL connections created from this SSL_CTX.
2657 * Ownership of the CTLOG_STORE is transferred to the SSL_CTX.
2658 */
2659void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE *logs);
2660
2661/*
2662 * Gets the CT log list used by all SSL connections created from this SSL_CTX.
2663 * This will be NULL unless one of the following functions has been called:
2664 * - SSL_CTX_set_default_ctlog_list_file
2665 * - SSL_CTX_set_ctlog_list_file
2666 * - SSL_CTX_set_ctlog_store
2667 */
2668const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx);
2669
2670# endif /* OPENSSL_NO_CT */
2671
2672/* What the "other" parameter contains in security callback */
2673/* Mask for type */
2674# define SSL_SECOP_OTHER_TYPE    0xffff0000
2675# define SSL_SECOP_OTHER_NONE    0
2676# define SSL_SECOP_OTHER_CIPHER  (1 << 16)
2677# define SSL_SECOP_OTHER_CURVE   (2 << 16)
2678# define SSL_SECOP_OTHER_DH      (3 << 16)
2679# define SSL_SECOP_OTHER_PKEY    (4 << 16)
2680# define SSL_SECOP_OTHER_SIGALG  (5 << 16)
2681# define SSL_SECOP_OTHER_CERT    (6 << 16)
2682
2683/* Indicated operation refers to peer key or certificate */
2684# define SSL_SECOP_PEER          0x1000
2685
2686/* Values for "op" parameter in security callback */
2687
2688/* Called to filter ciphers */
2689/* Ciphers client supports */
2690# define SSL_SECOP_CIPHER_SUPPORTED      (1 | SSL_SECOP_OTHER_CIPHER)
2691/* Cipher shared by client/server */
2692# define SSL_SECOP_CIPHER_SHARED         (2 | SSL_SECOP_OTHER_CIPHER)
2693/* Sanity check of cipher server selects */
2694# define SSL_SECOP_CIPHER_CHECK          (3 | SSL_SECOP_OTHER_CIPHER)
2695/* Curves supported by client */
2696# define SSL_SECOP_CURVE_SUPPORTED       (4 | SSL_SECOP_OTHER_CURVE)
2697/* Curves shared by client/server */
2698# define SSL_SECOP_CURVE_SHARED          (5 | SSL_SECOP_OTHER_CURVE)
2699/* Sanity check of curve server selects */
2700# define SSL_SECOP_CURVE_CHECK           (6 | SSL_SECOP_OTHER_CURVE)
2701/* Temporary DH key */
2702# define SSL_SECOP_TMP_DH                (7 | SSL_SECOP_OTHER_PKEY)
2703/* SSL/TLS version */
2704# define SSL_SECOP_VERSION               (9 | SSL_SECOP_OTHER_NONE)
2705/* Session tickets */
2706# define SSL_SECOP_TICKET                (10 | SSL_SECOP_OTHER_NONE)
2707/* Supported signature algorithms sent to peer */
2708# define SSL_SECOP_SIGALG_SUPPORTED      (11 | SSL_SECOP_OTHER_SIGALG)
2709/* Shared signature algorithm */
2710# define SSL_SECOP_SIGALG_SHARED         (12 | SSL_SECOP_OTHER_SIGALG)
2711/* Sanity check signature algorithm allowed */
2712# define SSL_SECOP_SIGALG_CHECK          (13 | SSL_SECOP_OTHER_SIGALG)
2713/* Used to get mask of supported public key signature algorithms */
2714# define SSL_SECOP_SIGALG_MASK           (14 | SSL_SECOP_OTHER_SIGALG)
2715/* Use to see if compression is allowed */
2716# define SSL_SECOP_COMPRESSION           (15 | SSL_SECOP_OTHER_NONE)
2717/* EE key in certificate */
2718# define SSL_SECOP_EE_KEY                (16 | SSL_SECOP_OTHER_CERT)
2719/* CA key in certificate */
2720# define SSL_SECOP_CA_KEY                (17 | SSL_SECOP_OTHER_CERT)
2721/* CA digest algorithm in certificate */
2722# define SSL_SECOP_CA_MD                 (18 | SSL_SECOP_OTHER_CERT)
2723/* Peer EE key in certificate */
2724# define SSL_SECOP_PEER_EE_KEY           (SSL_SECOP_EE_KEY | SSL_SECOP_PEER)
2725/* Peer CA key in certificate */
2726# define SSL_SECOP_PEER_CA_KEY           (SSL_SECOP_CA_KEY | SSL_SECOP_PEER)
2727/* Peer CA digest algorithm in certificate */
2728# define SSL_SECOP_PEER_CA_MD            (SSL_SECOP_CA_MD | SSL_SECOP_PEER)
2729
2730void SSL_set_security_level(SSL *s, int level);
2731__owur int SSL_get_security_level(const SSL *s);
2732void SSL_set_security_callback(SSL *s,
2733                               int (*cb) (const SSL *s, const SSL_CTX *ctx,
2734                                          int op, int bits, int nid,
2735                                          void *other, void *ex));
2736int (*SSL_get_security_callback(const SSL *s)) (const SSL *s,
2737                                                const SSL_CTX *ctx, int op,
2738                                                int bits, int nid, void *other,
2739                                                void *ex);
2740void SSL_set0_security_ex_data(SSL *s, void *ex);
2741__owur void *SSL_get0_security_ex_data(const SSL *s);
2742
2743void SSL_CTX_set_security_level(SSL_CTX *ctx, int level);
2744__owur int SSL_CTX_get_security_level(const SSL_CTX *ctx);
2745void SSL_CTX_set_security_callback(SSL_CTX *ctx,
2746                                   int (*cb) (const SSL *s, const SSL_CTX *ctx,
2747                                              int op, int bits, int nid,
2748                                              void *other, void *ex));
2749int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
2750                                                          const SSL_CTX *ctx,
2751                                                          int op, int bits,
2752                                                          int nid,
2753                                                          void *other,
2754                                                          void *ex);
2755void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex);
2756__owur void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx);
2757
2758/* OPENSSL_INIT flag 0x010000 reserved for internal use */
2759# define OPENSSL_INIT_NO_LOAD_SSL_STRINGS    0x00100000L
2760# define OPENSSL_INIT_LOAD_SSL_STRINGS       0x00200000L
2761
2762# define OPENSSL_INIT_SSL_DEFAULT \
2763        (OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
2764
2765int OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
2766
2767# ifndef OPENSSL_NO_UNIT_TEST
2768__owur const struct openssl_ssl_test_functions *SSL_test_functions(void);
2769# endif
2770
2771__owur int SSL_free_buffers(SSL *ssl);
2772__owur int SSL_alloc_buffers(SSL *ssl);
2773
2774/* Status codes passed to the decrypt session ticket callback. Some of these
2775 * are for internal use only and are never passed to the callback. */
2776typedef int SSL_TICKET_STATUS;
2777
2778/* Support for ticket appdata */
2779/* fatal error, malloc failure */
2780# define SSL_TICKET_FATAL_ERR_MALLOC 0
2781/* fatal error, either from parsing or decrypting the ticket */
2782# define SSL_TICKET_FATAL_ERR_OTHER  1
2783/* No ticket present */
2784# define SSL_TICKET_NONE             2
2785/* Empty ticket present */
2786# define SSL_TICKET_EMPTY            3
2787/* the ticket couldn't be decrypted */
2788# define SSL_TICKET_NO_DECRYPT       4
2789/* a ticket was successfully decrypted */
2790# define SSL_TICKET_SUCCESS          5
2791/* same as above but the ticket needs to be renewed */
2792# define SSL_TICKET_SUCCESS_RENEW    6
2793
2794/* Return codes for the decrypt session ticket callback */
2795typedef int SSL_TICKET_RETURN;
2796
2797/* An error occurred */
2798#define SSL_TICKET_RETURN_ABORT             0
2799/* Do not use the ticket, do not send a renewed ticket to the client */
2800#define SSL_TICKET_RETURN_IGNORE            1
2801/* Do not use the ticket, send a renewed ticket to the client */
2802#define SSL_TICKET_RETURN_IGNORE_RENEW      2
2803/* Use the ticket, do not send a renewed ticket to the client */
2804#define SSL_TICKET_RETURN_USE               3
2805/* Use the ticket, send a renewed ticket to the client */
2806#define SSL_TICKET_RETURN_USE_RENEW         4
2807
2808typedef int (*SSL_CTX_generate_session_ticket_fn)(SSL *s, void *arg);
2809typedef SSL_TICKET_RETURN (*SSL_CTX_decrypt_session_ticket_fn)(SSL *s, SSL_SESSION *ss,
2810                                                               const unsigned char *keyname,
2811                                                               size_t keyname_length,
2812                                                               SSL_TICKET_STATUS status,
2813                                                               void *arg);
2814int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
2815                                  SSL_CTX_generate_session_ticket_fn gen_cb,
2816                                  SSL_CTX_decrypt_session_ticket_fn dec_cb,
2817                                  void *arg);
2818int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len);
2819int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len);
2820
2821typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us);
2822
2823void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb);
2824
2825
2826typedef int (*SSL_allow_early_data_cb_fn)(SSL *s, void *arg);
2827void SSL_CTX_set_allow_early_data_cb(SSL_CTX *ctx,
2828                                     SSL_allow_early_data_cb_fn cb,
2829                                     void *arg);
2830void SSL_set_allow_early_data_cb(SSL *s,
2831                                 SSL_allow_early_data_cb_fn cb,
2832                                 void *arg);
2833
2834/* store the default cipher strings inside the library */
2835const char *OSSL_default_cipher_list(void);
2836const char *OSSL_default_ciphersuites(void);
2837
2838/* RFC8879 Certificate compression APIs */
2839
2840int SSL_CTX_compress_certs(SSL_CTX *ctx, int alg);
2841int SSL_compress_certs(SSL *ssl, int alg);
2842
2843int SSL_CTX_set1_cert_comp_preference(SSL_CTX *ctx, int *algs, size_t len);
2844int SSL_set1_cert_comp_preference(SSL *ssl, int *algs, size_t len);
2845
2846int SSL_CTX_set1_compressed_cert(SSL_CTX *ctx, int algorithm, unsigned char *comp_data,
2847                                size_t comp_length, size_t orig_length);
2848int SSL_set1_compressed_cert(SSL *ssl, int algorithm, unsigned char *comp_data,
2849                            size_t comp_length, size_t orig_length);
2850size_t SSL_CTX_get1_compressed_cert(SSL_CTX *ctx, int alg, unsigned char **data, size_t *orig_len);
2851size_t SSL_get1_compressed_cert(SSL *ssl, int alg, unsigned char **data, size_t *orig_len);
2852
2853__owur int SSL_add_expected_rpk(SSL *s, EVP_PKEY *rpk);
2854__owur EVP_PKEY *SSL_get0_peer_rpk(const SSL *s);
2855__owur EVP_PKEY *SSL_SESSION_get0_peer_rpk(SSL_SESSION *s);
2856__owur int SSL_get_negotiated_client_cert_type(const SSL *s);
2857__owur int SSL_get_negotiated_server_cert_type(const SSL *s);
2858
2859__owur int SSL_set1_client_cert_type(SSL *s, const unsigned char *val, size_t len);
2860__owur int SSL_set1_server_cert_type(SSL *s, const unsigned char *val, size_t len);
2861__owur int SSL_CTX_set1_client_cert_type(SSL_CTX *ctx, const unsigned char *val, size_t len);
2862__owur int SSL_CTX_set1_server_cert_type(SSL_CTX *ctx, const unsigned char *val, size_t len);
2863__owur int SSL_get0_client_cert_type(const SSL *s, unsigned char **t, size_t *len);
2864__owur int SSL_get0_server_cert_type(const SSL *s, unsigned char **t, size_t *len);
2865__owur int SSL_CTX_get0_client_cert_type(const SSL_CTX *ctx, unsigned char **t, size_t *len);
2866__owur int SSL_CTX_get0_server_cert_type(const SSL_CTX *s, unsigned char **t, size_t *len);
2867
2868/*
2869 * Protection level. For <= TLSv1.2 only "NONE" and "APPLICATION" are used.
2870 */
2871# define OSSL_RECORD_PROTECTION_LEVEL_NONE        0
2872# define OSSL_RECORD_PROTECTION_LEVEL_EARLY       1
2873# define OSSL_RECORD_PROTECTION_LEVEL_HANDSHAKE   2
2874# define OSSL_RECORD_PROTECTION_LEVEL_APPLICATION 3
2875
2876int SSL_set_quic_tls_cbs(SSL *s, const OSSL_DISPATCH *qtdis, void *arg);
2877int SSL_set_quic_tls_transport_params(SSL *s,
2878                                      const unsigned char *params,
2879                                      size_t params_len);
2880
2881int SSL_set_quic_tls_early_data_enabled(SSL *s, int enabled);
2882
2883# ifdef  __cplusplus
2884}
2885# endif
2886#endif
2887