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