Coverage Report

Created: 2025-12-14 06:48

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