Coverage Report

Created: 2026-04-12 07:08

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