include/openssl/ssl.h.in

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