Coverage Report

Created: 2026-01-09 07:00

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