include/openssl/ssl.h.in

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