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