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