include/openssl/ssl.h

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