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