Coverage Report

Created: 2023-04-12 06:22

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