include/openssl/ssl.h

   1 /*
   2  * Copyright 1995-2018 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"/* this cipher class has been removed */
  71 # define SSL_TXT_kDHd            "kDHd"/* this cipher class has been removed */
  72 # define SSL_TXT_kDH             "kDH"/* this cipher class has been removed */
  73 # define SSL_TXT_kEDH            "kEDH"/* alias for kDHE */
  74 # define SSL_TXT_kDHE            "kDHE"
  75 # define SSL_TXT_kECDHr          "kECDHr"/* this cipher class has been removed */
  76 # define SSL_TXT_kECDHe          "kECDHe"/* this cipher class has been removed */
  77 # define SSL_TXT_kECDH           "kECDH"/* this cipher class has been removed */
  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"/* this cipher class has been removed */
  90 # define SSL_TXT_aECDH           "aECDH"/* this cipher class has been removed */
  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 /* Length of a TLSv1.3 cookie */
 550 # define SSL_COOKIE_LENGTH                       255
 551
 552 /*
 553  * Note: SSL[_CTX]_set_{options,mode} use |= op on the previous value, they
 554  * cannot be used to clear bits.
 555  */
 556
 557 unsigned long SSL_CTX_get_options(const SSL_CTX *ctx);
 558 unsigned long SSL_get_options(const SSL* s);
 559 unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op);
 560 unsigned long SSL_clear_options(SSL *s, unsigned long op);
 561 unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op);
 562 unsigned long SSL_set_options(SSL *s, unsigned long op);
 563
 564 # define SSL_CTX_set_mode(ctx,op) \
 565         SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,(op),NULL)
 566 # define SSL_CTX_clear_mode(ctx,op) \
 567         SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_MODE,(op),NULL)
 568 # define SSL_CTX_get_mode(ctx) \
 569         SSL_CTX_ctrl((ctx),SSL_CTRL_MODE,0,NULL)
 570 # define SSL_clear_mode(ssl,op) \
 571         SSL_ctrl((ssl),SSL_CTRL_CLEAR_MODE,(op),NULL)
 572 # define SSL_set_mode(ssl,op) \
 573         SSL_ctrl((ssl),SSL_CTRL_MODE,(op),NULL)
 574 # define SSL_get_mode(ssl) \
 575         SSL_ctrl((ssl),SSL_CTRL_MODE,0,NULL)
 576 # define SSL_set_mtu(ssl, mtu) \
 577         SSL_ctrl((ssl),SSL_CTRL_SET_MTU,(mtu),NULL)
 578 # define DTLS_set_link_mtu(ssl, mtu) \
 579         SSL_ctrl((ssl),DTLS_CTRL_SET_LINK_MTU,(mtu),NULL)
 580 # define DTLS_get_link_min_mtu(ssl) \
 581         SSL_ctrl((ssl),DTLS_CTRL_GET_LINK_MIN_MTU,0,NULL)
 582
 583 # define SSL_get_secure_renegotiation_support(ssl) \
 584         SSL_ctrl((ssl), SSL_CTRL_GET_RI_SUPPORT, 0, NULL)
 585
 586 # ifndef OPENSSL_NO_HEARTBEATS
 587 #  define SSL_heartbeat(ssl) \
 588         SSL_ctrl((ssl),SSL_CTRL_DTLS_EXT_SEND_HEARTBEAT,0,NULL)
 589 # endif
 590
 591 # define SSL_CTX_set_cert_flags(ctx,op) \
 592         SSL_CTX_ctrl((ctx),SSL_CTRL_CERT_FLAGS,(op),NULL)
 593 # define SSL_set_cert_flags(s,op) \
 594         SSL_ctrl((s),SSL_CTRL_CERT_FLAGS,(op),NULL)
 595 # define SSL_CTX_clear_cert_flags(ctx,op) \
 596         SSL_CTX_ctrl((ctx),SSL_CTRL_CLEAR_CERT_FLAGS,(op),NULL)
 597 # define SSL_clear_cert_flags(s,op) \
 598         SSL_ctrl((s),SSL_CTRL_CLEAR_CERT_FLAGS,(op),NULL)
 599
 600 void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
 601                               void (*cb) (int write_p, int version,
 602                                           int content_type, const void *buf,
 603                                           size_t len, SSL *ssl, void *arg));
 604 void SSL_set_msg_callback(SSL *ssl,
 605                           void (*cb) (int write_p, int version,
 606                                       int content_type, const void *buf,
 607                                       size_t len, SSL *ssl, void *arg));
 608 # define SSL_CTX_set_msg_callback_arg(ctx, arg) SSL_CTX_ctrl((ctx), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg))
 609 # define SSL_set_msg_callback_arg(ssl, arg) SSL_ctrl((ssl), SSL_CTRL_SET_MSG_CALLBACK_ARG, 0, (arg))
 610
 611 # define SSL_get_extms_support(s) \
 612         SSL_ctrl((s),SSL_CTRL_GET_EXTMS_SUPPORT,0,NULL)
 613
 614 # ifndef OPENSSL_NO_SRP
 615
 616 /* see tls_srp.c */
 617 __owur int SSL_SRP_CTX_init(SSL *s);
 618 __owur int SSL_CTX_SRP_CTX_init(SSL_CTX *ctx);
 619 int SSL_SRP_CTX_free(SSL *ctx);
 620 int SSL_CTX_SRP_CTX_free(SSL_CTX *ctx);
 621 __owur int SSL_srp_server_param_with_username(SSL *s, int *ad);
 622 __owur int SRP_Calc_A_param(SSL *s);
 623
 624 # endif
 625
 626 /* 100k max cert list */
 627 # define SSL_MAX_CERT_LIST_DEFAULT 1024*100
 628
 629 # define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT      (1024*20)
 630
 631 /*
 632  * This callback type is used inside SSL_CTX, SSL, and in the functions that
 633  * set them. It is used to override the generation of SSL/TLS session IDs in
 634  * a server. Return value should be zero on an error, non-zero to proceed.
 635  * Also, callbacks should themselves check if the id they generate is unique
 636  * otherwise the SSL handshake will fail with an error - callbacks can do
 637  * this using the 'ssl' value they're passed by;
 638  * SSL_has_matching_session_id(ssl, id, *id_len) The length value passed in
 639  * is set at the maximum size the session ID can be. In SSLv3/TLSv1 it is 32
 640  * bytes. The callback can alter this length to be less if desired. It is
 641  * also an error for the callback to set the size to zero.
 642  */
 643 typedef int (*GEN_SESSION_CB) (SSL *ssl, unsigned char *id,
 644                                unsigned int *id_len);
 645
 646 # define SSL_SESS_CACHE_OFF                      0x0000
 647 # define SSL_SESS_CACHE_CLIENT                   0x0001
 648 # define SSL_SESS_CACHE_SERVER                   0x0002
 649 # define SSL_SESS_CACHE_BOTH     (SSL_SESS_CACHE_CLIENT|SSL_SESS_CACHE_SERVER)
 650 # define SSL_SESS_CACHE_NO_AUTO_CLEAR            0x0080
 651 /* enough comments already ... see SSL_CTX_set_session_cache_mode(3) */
 652 # define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP       0x0100
 653 # define SSL_SESS_CACHE_NO_INTERNAL_STORE        0x0200
 654 # define SSL_SESS_CACHE_NO_INTERNAL \
 655         (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP|SSL_SESS_CACHE_NO_INTERNAL_STORE)
 656
 657 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
 658 # define SSL_CTX_sess_number(ctx) \
 659         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_NUMBER,0,NULL)
 660 # define SSL_CTX_sess_connect(ctx) \
 661         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT,0,NULL)
 662 # define SSL_CTX_sess_connect_good(ctx) \
 663         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_GOOD,0,NULL)
 664 # define SSL_CTX_sess_connect_renegotiate(ctx) \
 665         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CONNECT_RENEGOTIATE,0,NULL)
 666 # define SSL_CTX_sess_accept(ctx) \
 667         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT,0,NULL)
 668 # define SSL_CTX_sess_accept_renegotiate(ctx) \
 669         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_RENEGOTIATE,0,NULL)
 670 # define SSL_CTX_sess_accept_good(ctx) \
 671         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_ACCEPT_GOOD,0,NULL)
 672 # define SSL_CTX_sess_hits(ctx) \
 673         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_HIT,0,NULL)
 674 # define SSL_CTX_sess_cb_hits(ctx) \
 675         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CB_HIT,0,NULL)
 676 # define SSL_CTX_sess_misses(ctx) \
 677         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_MISSES,0,NULL)
 678 # define SSL_CTX_sess_timeouts(ctx) \
 679         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_TIMEOUTS,0,NULL)
 680 # define SSL_CTX_sess_cache_full(ctx) \
 681         SSL_CTX_ctrl(ctx,SSL_CTRL_SESS_CACHE_FULL,0,NULL)
 682
 683 void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
 684                              int (*new_session_cb) (struct ssl_st *ssl,
 685                                                     SSL_SESSION *sess));
 686 int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)) (struct ssl_st *ssl,
 687                                               SSL_SESSION *sess);
 688 void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
 689                                 void (*remove_session_cb) (struct ssl_ctx_st
 690                                                            *ctx,
 691                                                            SSL_SESSION
 692                                                            *sess));
 693 void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)) (struct ssl_ctx_st *ctx,
 694                                                   SSL_SESSION *sess);
 695 void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
 696                              SSL_SESSION *(*get_session_cb) (struct ssl_st
 697                                                              *ssl,
 698                                                              const unsigned char
 699                                                              *data, int len,
 700                                                              int *copy));
 701 SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx)) (struct ssl_st *ssl,
 702                                                        const unsigned char *data,
 703                                                        int len, int *copy);
 704 void SSL_CTX_set_info_callback(SSL_CTX *ctx,
 705                                void (*cb) (const SSL *ssl, int type,
 706                                            int val));
 707 void (*SSL_CTX_get_info_callback(SSL_CTX *ctx)) (const SSL *ssl, int type,
 708                                                  int val);
 709 void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx,
 710                                 int (*client_cert_cb) (SSL *ssl, X509 **x509,
 711                                                        EVP_PKEY **pkey));
 712 int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx)) (SSL *ssl, X509 **x509,
 713                                                  EVP_PKEY **pkey);
 714 # ifndef OPENSSL_NO_ENGINE
 715 __owur int SSL_CTX_set_client_cert_engine(SSL_CTX *ctx, ENGINE *e);
 716 # endif
 717 void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
 718                                     int (*app_gen_cookie_cb) (SSL *ssl,
 719                                                               unsigned char
 720                                                               *cookie,
 721                                                               unsigned int
 722                                                               *cookie_len));
 723 void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
 724                                   int (*app_verify_cookie_cb) (SSL *ssl,
 725                                                                const unsigned char
 726                                                                *cookie,
 727                                                                unsigned int
 728                                                                cookie_len));
 729 # ifndef OPENSSL_NO_NEXTPROTONEG
 730
 731 typedef int (*SSL_CTX_npn_advertised_cb_func)(SSL *ssl,
 732                                               const unsigned char **out,
 733                                               unsigned int *outlen,
 734                                               void *arg);
 735 void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *s,
 736                                    SSL_CTX_npn_advertised_cb_func cb,
 737                                    void *arg);
 738 #  define SSL_CTX_set_npn_advertised_cb SSL_CTX_set_next_protos_advertised_cb
 739
 740 typedef int (*SSL_CTX_npn_select_cb_func)(SSL *s,
 741                                           unsigned char **out,
 742                                           unsigned char *outlen,
 743                                           const unsigned char *in,
 744                                           unsigned int inlen,
 745                                           void *arg);
 746 void SSL_CTX_set_next_proto_select_cb(SSL_CTX *s,
 747                                       SSL_CTX_npn_select_cb_func cb,
 748                                       void *arg);
 749 #  define SSL_CTX_set_npn_select_cb SSL_CTX_set_next_proto_select_cb
 750
 751 void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
 752                                     unsigned *len);
 753 #  define SSL_get0_npn_negotiated SSL_get0_next_proto_negotiated
 754 # endif
 755
 756 __owur int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
 757                           const unsigned char *in, unsigned int inlen,
 758                           const unsigned char *client,
 759                           unsigned int client_len);
 760
 761 # define OPENSSL_NPN_UNSUPPORTED 0
 762 # define OPENSSL_NPN_NEGOTIATED  1
 763 # define OPENSSL_NPN_NO_OVERLAP  2
 764
 765 __owur int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
 766                                    unsigned int protos_len);
 767 __owur int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
 768                                unsigned int protos_len);
 769 typedef int (*SSL_CTX_alpn_select_cb_func)(SSL *ssl,
 770                                            const unsigned char **out,
 771                                            unsigned char *outlen,
 772                                            const unsigned char *in,
 773                                            unsigned int inlen,
 774                                            void *arg);
 775 void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
 776                                 SSL_CTX_alpn_select_cb_func cb,
 777                                 void *arg);
 778 void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
 779                             unsigned int *len);
 780
 781 # ifndef OPENSSL_NO_PSK
 782 /*
 783  * the maximum length of the buffer given to callbacks containing the
 784  * resulting identity/psk
 785  */
 786 #  define PSK_MAX_IDENTITY_LEN 128
 787 #  define PSK_MAX_PSK_LEN 256
 788 typedef unsigned int (*SSL_psk_client_cb_func)(SSL *ssl,
 789                                                const char *hint,
 790                                                char *identity,
 791                                                unsigned int max_identity_len,
 792                                                unsigned char *psk,
 793                                                unsigned int max_psk_len);
 794 void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb);
 795 void SSL_set_psk_client_callback(SSL *ssl, SSL_psk_client_cb_func cb);
 796
 797 typedef unsigned int (*SSL_psk_server_cb_func)(SSL *ssl,
 798                                                const char *identity,
 799                                                unsigned char *psk,
 800                                                unsigned int max_psk_len);
 801 void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb);
 802 void SSL_set_psk_server_callback(SSL *ssl, SSL_psk_server_cb_func cb);
 803
 804 __owur int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *identity_hint);
 805 __owur int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
 806 const char *SSL_get_psk_identity_hint(const SSL *s);
 807 const char *SSL_get_psk_identity(const SSL *s);
 808 # endif
 809
 810 typedef int (*SSL_psk_find_session_cb_func)(SSL *ssl,
 811                                             const unsigned char *identity,
 812                                             size_t identity_len,
 813                                             SSL_SESSION **sess);
 814 typedef int (*SSL_psk_use_session_cb_func)(SSL *ssl, const EVP_MD *md,
 815                                            const unsigned char **id,
 816                                            size_t *idlen,
 817                                            SSL_SESSION **sess);
 818
 819 void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb);
 820 void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
 821                                            SSL_psk_find_session_cb_func cb);
 822 void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb);
 823 void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
 824                                           SSL_psk_use_session_cb_func cb);
 825
 826 /* Register callbacks to handle custom TLS Extensions for client or server. */
 827
 828 __owur int SSL_CTX_has_client_custom_ext(const SSL_CTX *ctx,
 829                                          unsigned int ext_type);
 830
 831 __owur int SSL_CTX_add_client_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
 832                                   custom_ext_add_cb add_cb,
 833                                   custom_ext_free_cb free_cb,
 834                                   void *add_arg,
 835                                   custom_ext_parse_cb parse_cb,
 836                                   void *parse_arg);
 837
 838 __owur int SSL_CTX_add_server_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
 839                                   custom_ext_add_cb add_cb,
 840                                   custom_ext_free_cb free_cb,
 841                                   void *add_arg,
 842                                   custom_ext_parse_cb parse_cb,
 843                                   void *parse_arg);
 844
 845 __owur int SSL_CTX_add_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
 846                                   unsigned int context,
 847                                   SSL_custom_ext_add_cb_ex add_cb,
 848                                   SSL_custom_ext_free_cb_ex free_cb,
 849                                   void *add_arg,
 850                                   SSL_custom_ext_parse_cb_ex parse_cb,
 851                                   void *parse_arg);
 852
 853 __owur int SSL_extension_supported(unsigned int ext_type);
 854
 855 # define SSL_NOTHING            1
 856 # define SSL_WRITING            2
 857 # define SSL_READING            3
 858 # define SSL_X509_LOOKUP        4
 859 # define SSL_ASYNC_PAUSED       5
 860 # define SSL_ASYNC_NO_JOBS      6
 861 # define SSL_CLIENT_HELLO_CB    7
 862
 863 /* These will only be used when doing non-blocking IO */
 864 # define SSL_want_nothing(s)         (SSL_want(s) == SSL_NOTHING)
 865 # define SSL_want_read(s)            (SSL_want(s) == SSL_READING)
 866 # define SSL_want_write(s)           (SSL_want(s) == SSL_WRITING)
 867 # define SSL_want_x509_lookup(s)     (SSL_want(s) == SSL_X509_LOOKUP)
 868 # define SSL_want_async(s)           (SSL_want(s) == SSL_ASYNC_PAUSED)
 869 # define SSL_want_async_job(s)       (SSL_want(s) == SSL_ASYNC_NO_JOBS)
 870 # define SSL_want_client_hello_cb(s) (SSL_want(s) == SSL_CLIENT_HELLO_CB)
 871
 872 # define SSL_MAC_FLAG_READ_MAC_STREAM 1
 873 # define SSL_MAC_FLAG_WRITE_MAC_STREAM 2
 874
 875 /*
 876  * A callback for logging out TLS key material. This callback should log out
 877  * |line| followed by a newline.
 878  */
 879 typedef void (*SSL_CTX_keylog_cb_func)(const SSL *ssl, const char *line);
 880
 881 /*
 882  * SSL_CTX_set_keylog_callback configures a callback to log key material. This
 883  * is intended for debugging use with tools like Wireshark. The cb function
 884  * should log line followed by a newline.
 885  */
 886 void SSL_CTX_set_keylog_callback(SSL_CTX *ctx, SSL_CTX_keylog_cb_func cb);
 887
 888 /*
 889  * SSL_CTX_get_keylog_callback returns the callback configured by
 890  * SSL_CTX_set_keylog_callback.
 891  */
 892 SSL_CTX_keylog_cb_func SSL_CTX_get_keylog_callback(const SSL_CTX *ctx);
 893
 894 int SSL_CTX_set_max_early_data(SSL_CTX *ctx, uint32_t max_early_data);
 895 uint32_t SSL_CTX_get_max_early_data(const SSL_CTX *ctx);
 896 int SSL_set_max_early_data(SSL *s, uint32_t max_early_data);
 897 uint32_t SSL_get_max_early_data(const SSL *s);
 898
 899 #ifdef __cplusplus
 900 }
 901 #endif
 902
 903 # include <openssl/ssl2.h>
 904 # include <openssl/ssl3.h>
 905 # include <openssl/tls1.h>      /* This is mostly sslv3 with a few tweaks */
 906 # include <openssl/dtls1.h>     /* Datagram TLS */
 907 # include <openssl/srtp.h>      /* Support for the use_srtp extension */
 908
 909 #ifdef  __cplusplus
 910 extern "C" {
 911 #endif
 912
 913 /*
 914  * These need to be after the above set of includes due to a compiler bug
 915  * in VisualStudio 2015
 916  */
 917 DEFINE_STACK_OF_CONST(SSL_CIPHER)
 918 DEFINE_STACK_OF(SSL_COMP)
 919
 920 /* compatibility */
 921 # define SSL_set_app_data(s,arg)         (SSL_set_ex_data(s,0,(char *)(arg)))
 922 # define SSL_get_app_data(s)             (SSL_get_ex_data(s,0))
 923 # define SSL_SESSION_set_app_data(s,a)   (SSL_SESSION_set_ex_data(s,0, \
 924                                                                   (char *)(a)))
 925 # define SSL_SESSION_get_app_data(s)     (SSL_SESSION_get_ex_data(s,0))
 926 # define SSL_CTX_get_app_data(ctx)       (SSL_CTX_get_ex_data(ctx,0))
 927 # define SSL_CTX_set_app_data(ctx,arg)   (SSL_CTX_set_ex_data(ctx,0, \
 928                                                               (char *)(arg)))
 929 DEPRECATEDIN_1_1_0(void SSL_set_debug(SSL *s, int debug))
 930
 931 /* TLSv1.3 KeyUpdate message types */
 932 /* -1 used so that this is an invalid value for the on-the-wire protocol */
 933 #define SSL_KEY_UPDATE_NONE             -1
 934 /* Values as defined for the on-the-wire protocol */
 935 #define SSL_KEY_UPDATE_NOT_REQUESTED     0
 936 #define SSL_KEY_UPDATE_REQUESTED         1
 937
 938 /*
 939  * The valid handshake states (one for each type message sent and one for each
 940  * type of message received). There are also two "special" states:
 941  * TLS = TLS or DTLS state
 942  * DTLS = DTLS specific state
 943  * CR/SR = Client Read/Server Read
 944  * CW/SW = Client Write/Server Write
 945  *
 946  * The "special" states are:
 947  * TLS_ST_BEFORE = No handshake has been initiated yet
 948  * TLS_ST_OK = A handshake has been successfully completed
 949  */
 950 typedef enum {
 951     TLS_ST_BEFORE,
 952     TLS_ST_OK,
 953     DTLS_ST_CR_HELLO_VERIFY_REQUEST,
 954     TLS_ST_CR_SRVR_HELLO,
 955     TLS_ST_CR_CERT,
 956     TLS_ST_CR_CERT_STATUS,
 957     TLS_ST_CR_KEY_EXCH,
 958     TLS_ST_CR_CERT_REQ,
 959     TLS_ST_CR_SRVR_DONE,
 960     TLS_ST_CR_SESSION_TICKET,
 961     TLS_ST_CR_CHANGE,
 962     TLS_ST_CR_FINISHED,
 963     TLS_ST_CW_CLNT_HELLO,
 964     TLS_ST_CW_CERT,
 965     TLS_ST_CW_KEY_EXCH,
 966     TLS_ST_CW_CERT_VRFY,
 967     TLS_ST_CW_CHANGE,
 968     TLS_ST_CW_NEXT_PROTO,
 969     TLS_ST_CW_FINISHED,
 970     TLS_ST_SW_HELLO_REQ,
 971     TLS_ST_SR_CLNT_HELLO,
 972     DTLS_ST_SW_HELLO_VERIFY_REQUEST,
 973     TLS_ST_SW_SRVR_HELLO,
 974     TLS_ST_SW_CERT,
 975     TLS_ST_SW_KEY_EXCH,
 976     TLS_ST_SW_CERT_REQ,
 977     TLS_ST_SW_SRVR_DONE,
 978     TLS_ST_SR_CERT,
 979     TLS_ST_SR_KEY_EXCH,
 980     TLS_ST_SR_CERT_VRFY,
 981     TLS_ST_SR_NEXT_PROTO,
 982     TLS_ST_SR_CHANGE,
 983     TLS_ST_SR_FINISHED,
 984     TLS_ST_SW_SESSION_TICKET,
 985     TLS_ST_SW_CERT_STATUS,
 986     TLS_ST_SW_CHANGE,
 987     TLS_ST_SW_FINISHED,
 988     TLS_ST_SW_ENCRYPTED_EXTENSIONS,
 989     TLS_ST_CR_ENCRYPTED_EXTENSIONS,
 990     TLS_ST_CR_CERT_VRFY,
 991     TLS_ST_SW_CERT_VRFY,
 992     TLS_ST_CR_HELLO_REQ,
 993     TLS_ST_SW_KEY_UPDATE,
 994     TLS_ST_CW_KEY_UPDATE,
 995     TLS_ST_SR_KEY_UPDATE,
 996     TLS_ST_CR_KEY_UPDATE,
 997     TLS_ST_EARLY_DATA,
 998     TLS_ST_PENDING_EARLY_DATA_END,
 999     TLS_ST_CW_END_OF_EARLY_DATA,
1000     TLS_ST_SR_END_OF_EARLY_DATA
1001 } OSSL_HANDSHAKE_STATE;
1002
1003 /*
1004  * Most of the following state values are no longer used and are defined to be
1005  * the closest equivalent value in the current state machine code. Not all
1006  * defines have an equivalent and are set to a dummy value (-1). SSL_ST_CONNECT
1007  * and SSL_ST_ACCEPT are still in use in the definition of SSL_CB_ACCEPT_LOOP,
1008  * SSL_CB_ACCEPT_EXIT, SSL_CB_CONNECT_LOOP and SSL_CB_CONNECT_EXIT.
1009  */
1010
1011 # define SSL_ST_CONNECT                  0x1000
1012 # define SSL_ST_ACCEPT                   0x2000
1013
1014 # define SSL_ST_MASK                     0x0FFF
1015
1016 # define SSL_CB_LOOP                     0x01
1017 # define SSL_CB_EXIT                     0x02
1018 # define SSL_CB_READ                     0x04
1019 # define SSL_CB_WRITE                    0x08
1020 # define SSL_CB_ALERT                    0x4000/* used in callback */
1021 # define SSL_CB_READ_ALERT               (SSL_CB_ALERT|SSL_CB_READ)
1022 # define SSL_CB_WRITE_ALERT              (SSL_CB_ALERT|SSL_CB_WRITE)
1023 # define SSL_CB_ACCEPT_LOOP              (SSL_ST_ACCEPT|SSL_CB_LOOP)
1024 # define SSL_CB_ACCEPT_EXIT              (SSL_ST_ACCEPT|SSL_CB_EXIT)
1025 # define SSL_CB_CONNECT_LOOP             (SSL_ST_CONNECT|SSL_CB_LOOP)
1026 # define SSL_CB_CONNECT_EXIT             (SSL_ST_CONNECT|SSL_CB_EXIT)
1027 # define SSL_CB_HANDSHAKE_START          0x10
1028 # define SSL_CB_HANDSHAKE_DONE           0x20
1029
1030 /* Is the SSL_connection established? */
1031 # define SSL_in_connect_init(a)          (SSL_in_init(a) && !SSL_is_server(a))
1032 # define SSL_in_accept_init(a)           (SSL_in_init(a) && SSL_is_server(a))
1033 int SSL_in_init(SSL *s);
1034 int SSL_in_before(SSL *s);
1035 int SSL_is_init_finished(SSL *s);
1036
1037 /*
1038  * The following 3 states are kept in ssl->rlayer.rstate when reads fail, you
1039  * should not need these
1040  */
1041 # define SSL_ST_READ_HEADER                      0xF0
1042 # define SSL_ST_READ_BODY                        0xF1
1043 # define SSL_ST_READ_DONE                        0xF2
1044
1045 /*-
1046  * Obtain latest Finished message
1047  *   -- that we sent (SSL_get_finished)
1048  *   -- that we expected from peer (SSL_get_peer_finished).
1049  * Returns length (0 == no Finished so far), copies up to 'count' bytes.
1050  */
1051 size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1052 size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
1053
1054 /*
1055  * use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 2 options are
1056  * 'ored' with SSL_VERIFY_PEER if they are desired
1057  */
1058 # define SSL_VERIFY_NONE                 0x00
1059 # define SSL_VERIFY_PEER                 0x01
1060 # define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
1061 # define SSL_VERIFY_CLIENT_ONCE          0x04
1062
1063 # define OpenSSL_add_ssl_algorithms()    SSL_library_init()
1064 # if OPENSSL_API_COMPAT < 0x10100000L
1065 #  define SSLeay_add_ssl_algorithms()    SSL_library_init()
1066 # endif
1067
1068 /* More backward compatibility */
1069 # define SSL_get_cipher(s) \
1070                 SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1071 # define SSL_get_cipher_bits(s,np) \
1072                 SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np)
1073 # define SSL_get_cipher_version(s) \
1074                 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1075 # define SSL_get_cipher_name(s) \
1076                 SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1077 # define SSL_get_time(a)         SSL_SESSION_get_time(a)
1078 # define SSL_set_time(a,b)       SSL_SESSION_set_time((a),(b))
1079 # define SSL_get_timeout(a)      SSL_SESSION_get_timeout(a)
1080 # define SSL_set_timeout(a,b)    SSL_SESSION_set_timeout((a),(b))
1081
1082 # define d2i_SSL_SESSION_bio(bp,s_id) ASN1_d2i_bio_of(SSL_SESSION,SSL_SESSION_new,d2i_SSL_SESSION,bp,s_id)
1083 # define i2d_SSL_SESSION_bio(bp,s_id) ASN1_i2d_bio_of(SSL_SESSION,i2d_SSL_SESSION,bp,s_id)
1084
1085 DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1086 # define SSL_AD_REASON_OFFSET            1000/* offset to get SSL_R_... value
1087                                               * from SSL_AD_... */
1088 /* These alert types are for SSLv3 and TLSv1 */
1089 # define SSL_AD_CLOSE_NOTIFY             SSL3_AD_CLOSE_NOTIFY
1090 /* fatal */
1091 # define SSL_AD_UNEXPECTED_MESSAGE       SSL3_AD_UNEXPECTED_MESSAGE
1092 /* fatal */
1093 # define SSL_AD_BAD_RECORD_MAC           SSL3_AD_BAD_RECORD_MAC
1094 # define SSL_AD_DECRYPTION_FAILED        TLS1_AD_DECRYPTION_FAILED
1095 # define SSL_AD_RECORD_OVERFLOW          TLS1_AD_RECORD_OVERFLOW
1096 /* fatal */
1097 # define SSL_AD_DECOMPRESSION_FAILURE    SSL3_AD_DECOMPRESSION_FAILURE
1098 /* fatal */
1099 # define SSL_AD_HANDSHAKE_FAILURE        SSL3_AD_HANDSHAKE_FAILURE
1100 /* Not for TLS */
1101 # define SSL_AD_NO_CERTIFICATE           SSL3_AD_NO_CERTIFICATE
1102 # define SSL_AD_BAD_CERTIFICATE          SSL3_AD_BAD_CERTIFICATE
1103 # define SSL_AD_UNSUPPORTED_CERTIFICATE  SSL3_AD_UNSUPPORTED_CERTIFICATE
1104 # define SSL_AD_CERTIFICATE_REVOKED      SSL3_AD_CERTIFICATE_REVOKED
1105 # define SSL_AD_CERTIFICATE_EXPIRED      SSL3_AD_CERTIFICATE_EXPIRED
1106 # define SSL_AD_CERTIFICATE_UNKNOWN      SSL3_AD_CERTIFICATE_UNKNOWN
1107 /* fatal */
1108 # define SSL_AD_ILLEGAL_PARAMETER        SSL3_AD_ILLEGAL_PARAMETER
1109 /* fatal */
1110 # define SSL_AD_UNKNOWN_CA               TLS1_AD_UNKNOWN_CA
1111 /* fatal */
1112 # define SSL_AD_ACCESS_DENIED            TLS1_AD_ACCESS_DENIED
1113 /* fatal */
1114 # define SSL_AD_DECODE_ERROR             TLS1_AD_DECODE_ERROR
1115 # define SSL_AD_DECRYPT_ERROR            TLS1_AD_DECRYPT_ERROR
1116 /* fatal */
1117 # define SSL_AD_EXPORT_RESTRICTION       TLS1_AD_EXPORT_RESTRICTION
1118 /* fatal */
1119 # define SSL_AD_PROTOCOL_VERSION         TLS1_AD_PROTOCOL_VERSION
1120 /* fatal */
1121 # define SSL_AD_INSUFFICIENT_SECURITY    TLS1_AD_INSUFFICIENT_SECURITY
1122 /* fatal */
1123 # define SSL_AD_INTERNAL_ERROR           TLS1_AD_INTERNAL_ERROR
1124 # define SSL_AD_USER_CANCELLED           TLS1_AD_USER_CANCELLED
1125 # define SSL_AD_NO_RENEGOTIATION         TLS1_AD_NO_RENEGOTIATION
1126 # define SSL_AD_MISSING_EXTENSION        TLS13_AD_MISSING_EXTENSION
1127 # define SSL_AD_CERTIFICATE_REQUIRED     TLS13_AD_CERTIFICATE_REQUIRED
1128 # define SSL_AD_UNSUPPORTED_EXTENSION    TLS1_AD_UNSUPPORTED_EXTENSION
1129 # define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
1130 # define SSL_AD_UNRECOGNIZED_NAME        TLS1_AD_UNRECOGNIZED_NAME
1131 # define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
1132 # define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
1133 /* fatal */
1134 # define SSL_AD_UNKNOWN_PSK_IDENTITY     TLS1_AD_UNKNOWN_PSK_IDENTITY
1135 /* fatal */
1136 # define SSL_AD_INAPPROPRIATE_FALLBACK   TLS1_AD_INAPPROPRIATE_FALLBACK
1137 # define SSL_AD_NO_APPLICATION_PROTOCOL  TLS1_AD_NO_APPLICATION_PROTOCOL
1138 # define SSL_ERROR_NONE                  0
1139 # define SSL_ERROR_SSL                   1
1140 # define SSL_ERROR_WANT_READ             2
1141 # define SSL_ERROR_WANT_WRITE            3
1142 # define SSL_ERROR_WANT_X509_LOOKUP      4
1143 # define SSL_ERROR_SYSCALL               5/* look at error stack/return
1144                                            * value/errno */
1145 # define SSL_ERROR_ZERO_RETURN           6
1146 # define SSL_ERROR_WANT_CONNECT          7
1147 # define SSL_ERROR_WANT_ACCEPT           8
1148 # define SSL_ERROR_WANT_ASYNC            9
1149 # define SSL_ERROR_WANT_ASYNC_JOB       10
1150 # define SSL_ERROR_WANT_CLIENT_HELLO_CB 11
1151 # define SSL_CTRL_SET_TMP_DH                     3
1152 # define SSL_CTRL_SET_TMP_ECDH                   4
1153 # define SSL_CTRL_SET_TMP_DH_CB                  6
1154 # define SSL_CTRL_GET_CLIENT_CERT_REQUEST        9
1155 # define SSL_CTRL_GET_NUM_RENEGOTIATIONS         10
1156 # define SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS       11
1157 # define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS       12
1158 # define SSL_CTRL_GET_FLAGS                      13
1159 # define SSL_CTRL_EXTRA_CHAIN_CERT               14
1160 # define SSL_CTRL_SET_MSG_CALLBACK               15
1161 # define SSL_CTRL_SET_MSG_CALLBACK_ARG           16
1162 /* only applies to datagram connections */
1163 # define SSL_CTRL_SET_MTU                17
1164 /* Stats */
1165 # define SSL_CTRL_SESS_NUMBER                    20
1166 # define SSL_CTRL_SESS_CONNECT                   21
1167 # define SSL_CTRL_SESS_CONNECT_GOOD              22
1168 # define SSL_CTRL_SESS_CONNECT_RENEGOTIATE       23
1169 # define SSL_CTRL_SESS_ACCEPT                    24
1170 # define SSL_CTRL_SESS_ACCEPT_GOOD               25
1171 # define SSL_CTRL_SESS_ACCEPT_RENEGOTIATE        26
1172 # define SSL_CTRL_SESS_HIT                       27
1173 # define SSL_CTRL_SESS_CB_HIT                    28
1174 # define SSL_CTRL_SESS_MISSES                    29
1175 # define SSL_CTRL_SESS_TIMEOUTS                  30
1176 # define SSL_CTRL_SESS_CACHE_FULL                31
1177 # define SSL_CTRL_MODE                           33
1178 # define SSL_CTRL_GET_READ_AHEAD                 40
1179 # define SSL_CTRL_SET_READ_AHEAD                 41
1180 # define SSL_CTRL_SET_SESS_CACHE_SIZE            42
1181 # define SSL_CTRL_GET_SESS_CACHE_SIZE            43
1182 # define SSL_CTRL_SET_SESS_CACHE_MODE            44
1183 # define SSL_CTRL_GET_SESS_CACHE_MODE            45
1184 # define SSL_CTRL_GET_MAX_CERT_LIST              50
1185 # define SSL_CTRL_SET_MAX_CERT_LIST              51
1186 # define SSL_CTRL_SET_MAX_SEND_FRAGMENT          52
1187 /* see tls1.h for macros based on these */
1188 # define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB       53
1189 # define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG      54
1190 # define SSL_CTRL_SET_TLSEXT_HOSTNAME            55
1191 # define SSL_CTRL_SET_TLSEXT_DEBUG_CB            56
1192 # define SSL_CTRL_SET_TLSEXT_DEBUG_ARG           57
1193 # define SSL_CTRL_GET_TLSEXT_TICKET_KEYS         58
1194 # define SSL_CTRL_SET_TLSEXT_TICKET_KEYS         59
1195 /*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT    60 */
1196 /*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB 61 */
1197 /*# define SSL_CTRL_SET_TLSEXT_OPAQUE_PRF_INPUT_CB_ARG 62 */
1198 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB       63
1199 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_CB_ARG   64
1200 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_TYPE     65
1201 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_EXTS     66
1202 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_EXTS     67
1203 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_IDS      68
1204 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_IDS      69
1205 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_OCSP_RESP        70
1206 # define SSL_CTRL_SET_TLSEXT_STATUS_REQ_OCSP_RESP        71
1207 # define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB       72
1208 # define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME_CB    75
1209 # define SSL_CTRL_SET_SRP_VERIFY_PARAM_CB                76
1210 # define SSL_CTRL_SET_SRP_GIVE_CLIENT_PWD_CB             77
1211 # define SSL_CTRL_SET_SRP_ARG            78
1212 # define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME               79
1213 # define SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH               80
1214 # define SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD               81
1215 # ifndef OPENSSL_NO_HEARTBEATS
1216 #  define SSL_CTRL_DTLS_EXT_SEND_HEARTBEAT               85
1217 #  define SSL_CTRL_GET_DTLS_EXT_HEARTBEAT_PENDING        86
1218 #  define SSL_CTRL_SET_DTLS_EXT_HEARTBEAT_NO_REQUESTS    87
1219 # endif
1220 # define DTLS_CTRL_GET_TIMEOUT           73
1221 # define DTLS_CTRL_HANDLE_TIMEOUT        74
1222 # define SSL_CTRL_GET_RI_SUPPORT                 76
1223 # define SSL_CTRL_CLEAR_MODE                     78
1224 # define SSL_CTRL_SET_NOT_RESUMABLE_SESS_CB      79
1225 # define SSL_CTRL_GET_EXTRA_CHAIN_CERTS          82
1226 # define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS        83
1227 # define SSL_CTRL_CHAIN                          88
1228 # define SSL_CTRL_CHAIN_CERT                     89
1229 # define SSL_CTRL_GET_GROUPS                     90
1230 # define SSL_CTRL_SET_GROUPS                     91
1231 # define SSL_CTRL_SET_GROUPS_LIST                92
1232 # define SSL_CTRL_GET_SHARED_GROUP               93
1233 # define SSL_CTRL_SET_SIGALGS                    97
1234 # define SSL_CTRL_SET_SIGALGS_LIST               98
1235 # define SSL_CTRL_CERT_FLAGS                     99
1236 # define SSL_CTRL_CLEAR_CERT_FLAGS               100
1237 # define SSL_CTRL_SET_CLIENT_SIGALGS             101
1238 # define SSL_CTRL_SET_CLIENT_SIGALGS_LIST        102
1239 # define SSL_CTRL_GET_CLIENT_CERT_TYPES          103
1240 # define SSL_CTRL_SET_CLIENT_CERT_TYPES          104
1241 # define SSL_CTRL_BUILD_CERT_CHAIN               105
1242 # define SSL_CTRL_SET_VERIFY_CERT_STORE          106
1243 # define SSL_CTRL_SET_CHAIN_CERT_STORE           107
1244 # define SSL_CTRL_GET_PEER_SIGNATURE_NID         108
1245 # define SSL_CTRL_GET_SERVER_TMP_KEY             109
1246 # define SSL_CTRL_GET_RAW_CIPHERLIST             110
1247 # define SSL_CTRL_GET_EC_POINT_FORMATS           111
1248 # define SSL_CTRL_GET_CHAIN_CERTS                115
1249 # define SSL_CTRL_SELECT_CURRENT_CERT            116
1250 # define SSL_CTRL_SET_CURRENT_CERT               117
1251 # define SSL_CTRL_SET_DH_AUTO                    118
1252 # define DTLS_CTRL_SET_LINK_MTU                  120
1253 # define DTLS_CTRL_GET_LINK_MIN_MTU              121
1254 # define SSL_CTRL_GET_EXTMS_SUPPORT              122
1255 # define SSL_CTRL_SET_MIN_PROTO_VERSION          123
1256 # define SSL_CTRL_SET_MAX_PROTO_VERSION          124
1257 # define SSL_CTRL_SET_SPLIT_SEND_FRAGMENT        125
1258 # define SSL_CTRL_SET_MAX_PIPELINES              126
1259 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_TYPE     127
1260 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_CB       128
1261 # define SSL_CTRL_GET_TLSEXT_STATUS_REQ_CB_ARG   129
1262 # define SSL_CTRL_GET_MIN_PROTO_VERSION          130
1263 # define SSL_CTRL_GET_MAX_PROTO_VERSION          131
1264 # define SSL_CERT_SET_FIRST                      1
1265 # define SSL_CERT_SET_NEXT                       2
1266 # define SSL_CERT_SET_SERVER                     3
1267 # define DTLSv1_get_timeout(ssl, arg) \
1268         SSL_ctrl(ssl,DTLS_CTRL_GET_TIMEOUT,0, (void *)(arg))
1269 # define DTLSv1_handle_timeout(ssl) \
1270         SSL_ctrl(ssl,DTLS_CTRL_HANDLE_TIMEOUT,0, NULL)
1271 # define SSL_num_renegotiations(ssl) \
1272         SSL_ctrl((ssl),SSL_CTRL_GET_NUM_RENEGOTIATIONS,0,NULL)
1273 # define SSL_clear_num_renegotiations(ssl) \
1274         SSL_ctrl((ssl),SSL_CTRL_CLEAR_NUM_RENEGOTIATIONS,0,NULL)
1275 # define SSL_total_renegotiations(ssl) \
1276         SSL_ctrl((ssl),SSL_CTRL_GET_TOTAL_RENEGOTIATIONS,0,NULL)
1277 # define SSL_CTX_set_tmp_dh(ctx,dh) \
1278         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_DH,0,(char *)(dh))
1279 # define SSL_CTX_set_tmp_ecdh(ctx,ecdh) \
1280         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TMP_ECDH,0,(char *)(ecdh))
1281 # define SSL_CTX_set_dh_auto(ctx, onoff) \
1282         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_DH_AUTO,onoff,NULL)
1283 # define SSL_set_dh_auto(s, onoff) \
1284         SSL_ctrl(s,SSL_CTRL_SET_DH_AUTO,onoff,NULL)
1285 # define SSL_set_tmp_dh(ssl,dh) \
1286         SSL_ctrl(ssl,SSL_CTRL_SET_TMP_DH,0,(char *)(dh))
1287 # define SSL_set_tmp_ecdh(ssl,ecdh) \
1288         SSL_ctrl(ssl,SSL_CTRL_SET_TMP_ECDH,0,(char *)(ecdh))
1289 # define SSL_CTX_add_extra_chain_cert(ctx,x509) \
1290         SSL_CTX_ctrl(ctx,SSL_CTRL_EXTRA_CHAIN_CERT,0,(char *)(x509))
1291 # define SSL_CTX_get_extra_chain_certs(ctx,px509) \
1292         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,0,px509)
1293 # define SSL_CTX_get_extra_chain_certs_only(ctx,px509) \
1294         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_EXTRA_CHAIN_CERTS,1,px509)
1295 # define SSL_CTX_clear_extra_chain_certs(ctx) \
1296         SSL_CTX_ctrl(ctx,SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS,0,NULL)
1297 # define SSL_CTX_set0_chain(ctx,sk) \
1298         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN,0,(char *)(sk))
1299 # define SSL_CTX_set1_chain(ctx,sk) \
1300         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN,1,(char *)(sk))
1301 # define SSL_CTX_add0_chain_cert(ctx,x509) \
1302         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN_CERT,0,(char *)(x509))
1303 # define SSL_CTX_add1_chain_cert(ctx,x509) \
1304         SSL_CTX_ctrl(ctx,SSL_CTRL_CHAIN_CERT,1,(char *)(x509))
1305 # define SSL_CTX_get0_chain_certs(ctx,px509) \
1306         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_CHAIN_CERTS,0,px509)
1307 # define SSL_CTX_clear_chain_certs(ctx) \
1308         SSL_CTX_set0_chain(ctx,NULL)
1309 # define SSL_CTX_build_cert_chain(ctx, flags) \
1310         SSL_CTX_ctrl(ctx,SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1311 # define SSL_CTX_select_current_cert(ctx,x509) \
1312         SSL_CTX_ctrl(ctx,SSL_CTRL_SELECT_CURRENT_CERT,0,(char *)(x509))
1313 # define SSL_CTX_set_current_cert(ctx, op) \
1314         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CURRENT_CERT, op, NULL)
1315 # define SSL_CTX_set0_verify_cert_store(ctx,st) \
1316         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_VERIFY_CERT_STORE,0,(char *)(st))
1317 # define SSL_CTX_set1_verify_cert_store(ctx,st) \
1318         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_VERIFY_CERT_STORE,1,(char *)(st))
1319 # define SSL_CTX_set0_chain_cert_store(ctx,st) \
1320         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)(st))
1321 # define SSL_CTX_set1_chain_cert_store(ctx,st) \
1322         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)(st))
1323 # define SSL_set0_chain(ctx,sk) \
1324         SSL_ctrl(ctx,SSL_CTRL_CHAIN,0,(char *)(sk))
1325 # define SSL_set1_chain(ctx,sk) \
1326         SSL_ctrl(ctx,SSL_CTRL_CHAIN,1,(char *)(sk))
1327 # define SSL_add0_chain_cert(ctx,x509) \
1328         SSL_ctrl(ctx,SSL_CTRL_CHAIN_CERT,0,(char *)(x509))
1329 # define SSL_add1_chain_cert(ctx,x509) \
1330         SSL_ctrl(ctx,SSL_CTRL_CHAIN_CERT,1,(char *)(x509))
1331 # define SSL_get0_chain_certs(ctx,px509) \
1332         SSL_ctrl(ctx,SSL_CTRL_GET_CHAIN_CERTS,0,px509)
1333 # define SSL_clear_chain_certs(ctx) \
1334         SSL_set0_chain(ctx,NULL)
1335 # define SSL_build_cert_chain(s, flags) \
1336         SSL_ctrl(s,SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1337 # define SSL_select_current_cert(ctx,x509) \
1338         SSL_ctrl(ctx,SSL_CTRL_SELECT_CURRENT_CERT,0,(char *)(x509))
1339 # define SSL_set_current_cert(ctx,op) \
1340         SSL_ctrl(ctx,SSL_CTRL_SET_CURRENT_CERT, op, NULL)
1341 # define SSL_set0_verify_cert_store(s,st) \
1342         SSL_ctrl(s,SSL_CTRL_SET_VERIFY_CERT_STORE,0,(char *)(st))
1343 # define SSL_set1_verify_cert_store(s,st) \
1344         SSL_ctrl(s,SSL_CTRL_SET_VERIFY_CERT_STORE,1,(char *)(st))
1345 # define SSL_set0_chain_cert_store(s,st) \
1346         SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,0,(char *)(st))
1347 # define SSL_set1_chain_cert_store(s,st) \
1348         SSL_ctrl(s,SSL_CTRL_SET_CHAIN_CERT_STORE,1,(char *)(st))
1349 # define SSL_get1_groups(ctx, s) \
1350         SSL_ctrl(ctx,SSL_CTRL_GET_GROUPS,0,(char *)(s))
1351 # define SSL_get1_curves(ctx, s) \
1352         SSL_get1_groups((ctx), (s))
1353 # define SSL_CTX_set1_groups(ctx, glist, glistlen) \
1354         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(char *)(glist))
1355 # define SSL_CTX_set1_groups_list(ctx, s) \
1356         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)(s))
1357 # define SSL_CTX_set1_curves(ctx, clist, clistlen) \
1358         SSL_CTX_set1_groups((ctx), (clist), (clistlen))
1359 # define SSL_CTX_set1_curves_list(ctx, s) \
1360         SSL_CTX_set1_groups_list((ctx), (s))
1361 # define SSL_set1_groups(ctx, glist, glistlen) \
1362         SSL_ctrl(ctx,SSL_CTRL_SET_GROUPS,glistlen,(char *)(glist))
1363 # define SSL_set1_groups_list(ctx, s) \
1364         SSL_ctrl(ctx,SSL_CTRL_SET_GROUPS_LIST,0,(char *)(s))
1365 # define SSL_set1_curves(ctx, clist, clistlen) \
1366         SSL_set1_groups((ctx), (clist), (clistlen))
1367 # define SSL_set1_curves_list(ctx, s) \
1368         SSL_set1_groups_list((ctx), (s))
1369 # define SSL_get_shared_group(s, n) \
1370         SSL_ctrl(s,SSL_CTRL_GET_SHARED_GROUP,n,NULL)
1371 # define SSL_get_shared_curve(s, n) \
1372         SSL_get_shared_group((s), (n))
1373 # define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
1374         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS,slistlen,(int *)(slist))
1375 # define SSL_CTX_set1_sigalgs_list(ctx, s) \
1376         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SIGALGS_LIST,0,(char *)(s))
1377 # define SSL_set1_sigalgs(ctx, slist, slistlen) \
1378         SSL_ctrl(ctx,SSL_CTRL_SET_SIGALGS,slistlen,(int *)(slist))
1379 # define SSL_set1_sigalgs_list(ctx, s) \
1380         SSL_ctrl(ctx,SSL_CTRL_SET_SIGALGS_LIST,0,(char *)(s))
1381 # define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
1382         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS,slistlen,(int *)(slist))
1383 # define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
1384         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS_LIST,0,(char *)(s))
1385 # define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
1386         SSL_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS,clistlen,(int *)(slist))
1387 # define SSL_set1_client_sigalgs_list(ctx, s) \
1388         SSL_ctrl(ctx,SSL_CTRL_SET_CLIENT_SIGALGS_LIST,0,(char *)(s))
1389 # define SSL_get0_certificate_types(s, clist) \
1390         SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)(clist))
1391 # define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
1392         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_CLIENT_CERT_TYPES,clistlen, \
1393                      (char *)(clist))
1394 # define SSL_set1_client_certificate_types(s, clist, clistlen) \
1395         SSL_ctrl(s,SSL_CTRL_SET_CLIENT_CERT_TYPES,clistlen,(char *)(clist))
1396 # define SSL_get_peer_signature_nid(s, pn) \
1397         SSL_ctrl(s,SSL_CTRL_GET_PEER_SIGNATURE_NID,0,pn)
1398 # define SSL_get_server_tmp_key(s, pk) \
1399         SSL_ctrl(s,SSL_CTRL_GET_SERVER_TMP_KEY,0,pk)
1400 # define SSL_get0_raw_cipherlist(s, plst) \
1401         SSL_ctrl(s,SSL_CTRL_GET_RAW_CIPHERLIST,0,plst)
1402 # define SSL_get0_ec_point_formats(s, plst) \
1403         SSL_ctrl(s,SSL_CTRL_GET_EC_POINT_FORMATS,0,plst)
1404 #define SSL_CTX_set_min_proto_version(ctx, version) \
1405         SSL_CTX_ctrl(ctx, SSL_CTRL_SET_MIN_PROTO_VERSION, version, NULL)
1406 #define SSL_CTX_set_max_proto_version(ctx, version) \
1407         SSL_CTX_ctrl(ctx, SSL_CTRL_SET_MAX_PROTO_VERSION, version, NULL)
1408 #define SSL_CTX_get_min_proto_version(ctx) \
1409         SSL_CTX_ctrl(ctx, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL)
1410 #define SSL_CTX_get_max_proto_version(ctx) \
1411         SSL_CTX_ctrl(ctx, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL)
1412 #define SSL_set_min_proto_version(s, version) \
1413         SSL_ctrl(s, SSL_CTRL_SET_MIN_PROTO_VERSION, version, NULL)
1414 #define SSL_set_max_proto_version(s, version) \
1415         SSL_ctrl(s, SSL_CTRL_SET_MAX_PROTO_VERSION, version, NULL)
1416 #define SSL_get_min_proto_version(s) \
1417         SSL_ctrl(s, SSL_CTRL_GET_MIN_PROTO_VERSION, NULL, NULL)
1418 #define SSL_get_max_proto_version(s) \
1419         SSL_ctrl(s, SSL_CTRL_GET_MAX_PROTO_VERSION, NULL, NULL)
1420
1421 #if OPENSSL_API_COMPAT < 0x10100000L
1422 /* Provide some compatibility macros for removed functionality. */
1423 # define SSL_CTX_need_tmp_RSA(ctx)                0
1424 # define SSL_CTX_set_tmp_rsa(ctx,rsa)             1
1425 # define SSL_need_tmp_RSA(ssl)                    0
1426 # define SSL_set_tmp_rsa(ssl,rsa)                 1
1427 # define SSL_CTX_set_ecdh_auto(dummy, onoff)      ((onoff) != 0)
1428 # define SSL_set_ecdh_auto(dummy, onoff)          ((onoff) != 0)
1429 /*
1430  * We "pretend" to call the callback to avoid warnings about unused static
1431  * functions.
1432  */
1433 # define SSL_CTX_set_tmp_rsa_callback(ctx, cb)    while(0) (cb)(NULL, 0, 0)
1434 # define SSL_set_tmp_rsa_callback(ssl, cb)        while(0) (cb)(NULL, 0, 0)
1435 #endif
1436
1437 __owur const BIO_METHOD *BIO_f_ssl(void);
1438 __owur BIO *BIO_new_ssl(SSL_CTX *ctx, int client);
1439 __owur BIO *BIO_new_ssl_connect(SSL_CTX *ctx);
1440 __owur BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx);
1441 __owur int BIO_ssl_copy_session_id(BIO *to, BIO *from);
1442 void BIO_ssl_shutdown(BIO *ssl_bio);
1443
1444 __owur int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
1445 __owur SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth);
1446 int SSL_CTX_up_ref(SSL_CTX *ctx);
1447 void SSL_CTX_free(SSL_CTX *);
1448 __owur long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
1449 __owur long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1450 __owur X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
1451 void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
1452 void SSL_CTX_set1_cert_store(SSL_CTX *, X509_STORE *);
1453 __owur int SSL_want(const SSL *s);
1454 __owur int SSL_clear(SSL *s);
1455
1456 void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
1457
1458 __owur const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
1459 __owur const SSL_CIPHER *SSL_get_pending_cipher(const SSL *s);
1460 __owur int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits);
1461 __owur const char *SSL_CIPHER_get_version(const SSL_CIPHER *c);
1462 __owur const char *SSL_CIPHER_get_name(const SSL_CIPHER *c);
1463 __owur const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c);
1464 __owur const char *OPENSSL_cipher_name(const char *rfc_name);
1465 __owur uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c);
1466 __owur uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c);
1467 __owur int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c);
1468 __owur int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c);
1469 __owur const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c);
1470 __owur int SSL_CIPHER_is_aead(const SSL_CIPHER *c);
1471
1472 __owur int SSL_get_fd(const SSL *s);
1473 __owur int SSL_get_rfd(const SSL *s);
1474 __owur int SSL_get_wfd(const SSL *s);
1475 __owur const char *SSL_get_cipher_list(const SSL *s, int n);
1476 __owur char *SSL_get_shared_ciphers(const SSL *s, char *buf, int len);
1477 __owur int SSL_get_read_ahead(const SSL *s);
1478 __owur int SSL_pending(const SSL *s);
1479 __owur int SSL_has_pending(const SSL *s);
1480 # ifndef OPENSSL_NO_SOCK
1481 __owur int SSL_set_fd(SSL *s, int fd);
1482 __owur int SSL_set_rfd(SSL *s, int fd);
1483 __owur int SSL_set_wfd(SSL *s, int fd);
1484 # endif
1485 void SSL_set0_rbio(SSL *s, BIO *rbio);
1486 void SSL_set0_wbio(SSL *s, BIO *wbio);
1487 void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
1488 __owur BIO *SSL_get_rbio(const SSL *s);
1489 __owur BIO *SSL_get_wbio(const SSL *s);
1490 __owur int SSL_set_cipher_list(SSL *s, const char *str);
1491 void SSL_set_read_ahead(SSL *s, int yes);
1492 __owur int SSL_get_verify_mode(const SSL *s);
1493 __owur int SSL_get_verify_depth(const SSL *s);
1494 __owur SSL_verify_cb SSL_get_verify_callback(const SSL *s);
1495 void SSL_set_verify(SSL *s, int mode, SSL_verify_cb callback);
1496 void SSL_set_verify_depth(SSL *s, int depth);
1497 void SSL_set_cert_cb(SSL *s, int (*cb) (SSL *ssl, void *arg), void *arg);
1498 # ifndef OPENSSL_NO_RSA
1499 __owur int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
1500 __owur int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const unsigned char *d, long len);
1501 # endif
1502 __owur int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
1503 __owur int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const unsigned char *d,
1504                             long len);
1505 __owur int SSL_use_certificate(SSL *ssl, X509 *x);
1506 __owur int SSL_use_certificate_ASN1(SSL *ssl, const unsigned char *d, int len);
1507
1508
1509 /* serverinfo file format versions */
1510 # define SSL_SERVERINFOV1   1
1511 # define SSL_SERVERINFOV2   2
1512
1513 /* Set serverinfo data for the current active cert. */
1514 __owur int SSL_CTX_use_serverinfo(SSL_CTX *ctx, const unsigned char *serverinfo,
1515                            size_t serverinfo_length);
1516 __owur int SSL_CTX_use_serverinfo_ex(SSL_CTX *ctx, unsigned int version,
1517                                      const unsigned char *serverinfo,
1518                                      size_t serverinfo_length);
1519 __owur int SSL_CTX_use_serverinfo_file(SSL_CTX *ctx, const char *file);
1520
1521 #ifndef OPENSSL_NO_RSA
1522 __owur int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);
1523 #endif
1524
1525 __owur int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);
1526 __owur int SSL_use_certificate_file(SSL *ssl, const char *file, int type);
1527
1528 #ifndef OPENSSL_NO_RSA
1529 __owur int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);
1530 #endif
1531 __owur int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);
1532 __owur int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);
1533 /* PEM type */
1534 __owur int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, const char *file);
1535 __owur int SSL_use_certificate_chain_file(SSL *ssl, const char *file);
1536 __owur STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
1537 __owur int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1538                                         const char *file);
1539 int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *stackCAs,
1540                                        const char *dir);
1541
1542 #if OPENSSL_API_COMPAT < 0x10100000L
1543 # define SSL_load_error_strings() \
1544     OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \
1545                      | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
1546 #endif
1547
1548 __owur const char *SSL_state_string(const SSL *s);
1549 __owur const char *SSL_rstate_string(const SSL *s);
1550 __owur const char *SSL_state_string_long(const SSL *s);
1551 __owur const char *SSL_rstate_string_long(const SSL *s);
1552 __owur long SSL_SESSION_get_time(const SSL_SESSION *s);
1553 __owur long SSL_SESSION_set_time(SSL_SESSION *s, long t);
1554 __owur long SSL_SESSION_get_timeout(const SSL_SESSION *s);
1555 __owur long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
1556 __owur int SSL_SESSION_get_protocol_version(const SSL_SESSION *s);
1557 __owur int SSL_SESSION_set_protocol_version(SSL_SESSION *s, int version);
1558
1559 __owur const char *SSL_SESSION_get0_hostname(const SSL_SESSION *s);
1560 __owur int SSL_SESSION_set1_hostname(SSL_SESSION *s, const char *hostname);
1561 void SSL_SESSION_get0_alpn_selected(const SSL_SESSION *s,
1562                                     const unsigned char **alpn,
1563                                     size_t *len);
1564 __owur int SSL_SESSION_set1_alpn_selected(SSL_SESSION *s,
1565                                           const unsigned char *alpn,
1566                                           size_t len);
1567 __owur const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
1568 __owur int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher);
1569 __owur int SSL_SESSION_has_ticket(const SSL_SESSION *s);
1570 __owur unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
1571 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
1572                             size_t *len);
1573 __owur uint32_t SSL_SESSION_get_max_early_data(const SSL_SESSION *s);
1574 __owur int SSL_SESSION_set_max_early_data(SSL_SESSION *s,
1575                                           uint32_t max_early_data);
1576 __owur int SSL_copy_session_id(SSL *to, const SSL *from);
1577 __owur X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
1578 __owur int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
1579                                 unsigned int sid_ctx_len);
1580 __owur int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
1581                                unsigned int sid_len);
1582 __owur int SSL_SESSION_is_resumable(const SSL_SESSION *s);
1583
1584 __owur SSL_SESSION *SSL_SESSION_new(void);
1585 __owur SSL_SESSION *SSL_SESSION_dup(SSL_SESSION *src);
1586 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
1587                                         unsigned int *len);
1588 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
1589                                                 unsigned int *len);
1590 __owur unsigned int SSL_SESSION_get_compress_id(const SSL_SESSION *s);
1591 # ifndef OPENSSL_NO_STDIO
1592 int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
1593 # endif
1594 int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
1595 int SSL_SESSION_print_keylog(BIO *bp, const SSL_SESSION *x);
1596 int SSL_SESSION_up_ref(SSL_SESSION *ses);
1597 void SSL_SESSION_free(SSL_SESSION *ses);
1598 __owur int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp);
1599 __owur int SSL_set_session(SSL *to, SSL_SESSION *session);
1600 int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
1601 int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
1602 __owur int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
1603 __owur int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
1604 __owur int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
1605                                 unsigned int id_len);
1606 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
1607                              long length);
1608
1609 # ifdef HEADER_X509_H
1610 __owur X509 *SSL_get_peer_certificate(const SSL *s);
1611 # endif
1612
1613 __owur STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
1614
1615 __owur int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1616 __owur int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
1617 __owur SSL_verify_cb SSL_CTX_get_verify_callback(const SSL_CTX *ctx);
1618 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, SSL_verify_cb callback);
1619 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1620 void SSL_CTX_set_cert_verify_callback(SSL_CTX *ctx,
1621                                       int (*cb) (X509_STORE_CTX *, void *),
1622                                       void *arg);
1623 void SSL_CTX_set_cert_cb(SSL_CTX *c, int (*cb) (SSL *ssl, void *arg),
1624                          void *arg);
1625 # ifndef OPENSSL_NO_RSA
1626 __owur int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
1627 __owur int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, const unsigned char *d,
1628                                    long len);
1629 # endif
1630 __owur int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
1631 __owur int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
1632                                 const unsigned char *d, long len);
1633 __owur int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
1634 __owur int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
1635                                  const unsigned char *d);
1636
1637 void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);
1638 void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *u);
1639 pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx);
1640 void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx);
1641 void SSL_set_default_passwd_cb(SSL *s, pem_password_cb *cb);
1642 void SSL_set_default_passwd_cb_userdata(SSL *s, void *u);
1643 pem_password_cb *SSL_get_default_passwd_cb(SSL *s);
1644 void *SSL_get_default_passwd_cb_userdata(SSL *s);
1645
1646 __owur int SSL_CTX_check_private_key(const SSL_CTX *ctx);
1647 __owur int SSL_check_private_key(const SSL *ctx);
1648
1649 __owur int SSL_CTX_set_session_id_context(SSL_CTX *ctx, const unsigned char *sid_ctx,
1650                                    unsigned int sid_ctx_len);
1651
1652 SSL *SSL_new(SSL_CTX *ctx);
1653 int SSL_up_ref(SSL *s);
1654 int SSL_is_dtls(const SSL *s);
1655 __owur int SSL_set_session_id_context(SSL *ssl, const unsigned char *sid_ctx,
1656                                unsigned int sid_ctx_len);
1657
1658 __owur int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
1659 __owur int SSL_set_purpose(SSL *s, int purpose);
1660 __owur int SSL_CTX_set_trust(SSL_CTX *s, int trust);
1661 __owur int SSL_set_trust(SSL *s, int trust);
1662
1663 __owur int SSL_set1_host(SSL *s, const char *hostname);
1664 __owur int SSL_add1_host(SSL *s, const char *hostname);
1665 __owur const char *SSL_get0_peername(SSL *s);
1666 void SSL_set_hostflags(SSL *s, unsigned int flags);
1667
1668 __owur int SSL_CTX_dane_enable(SSL_CTX *ctx);
1669 __owur int SSL_CTX_dane_mtype_set(SSL_CTX *ctx, const EVP_MD *md,
1670                                   uint8_t mtype, uint8_t ord);
1671 __owur int SSL_dane_enable(SSL *s, const char *basedomain);
1672 __owur int SSL_dane_tlsa_add(SSL *s, uint8_t usage, uint8_t selector,
1673                              uint8_t mtype, unsigned const char *data, size_t dlen);
1674 __owur int SSL_get0_dane_authority(SSL *s, X509 **mcert, EVP_PKEY **mspki);
1675 __owur int SSL_get0_dane_tlsa(SSL *s, uint8_t *usage, uint8_t *selector,
1676                               uint8_t *mtype, unsigned const char **data,
1677                               size_t *dlen);
1678 /*
1679  * Bridge opacity barrier between libcrypt and libssl, also needed to support
1680  * offline testing in test/danetest.c
1681  */
1682 SSL_DANE *SSL_get0_dane(SSL *ssl);
1683 /*
1684  * DANE flags
1685  */
1686 unsigned long SSL_CTX_dane_set_flags(SSL_CTX *ctx, unsigned long flags);
1687 unsigned long SSL_CTX_dane_clear_flags(SSL_CTX *ctx, unsigned long flags);
1688 unsigned long SSL_dane_set_flags(SSL *ssl, unsigned long flags);
1689 unsigned long SSL_dane_clear_flags(SSL *ssl, unsigned long flags);
1690
1691 __owur int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
1692 __owur int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
1693
1694 __owur X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
1695 __owur X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
1696
1697 # ifndef OPENSSL_NO_SRP
1698 int SSL_CTX_set_srp_username(SSL_CTX *ctx, char *name);
1699 int SSL_CTX_set_srp_password(SSL_CTX *ctx, char *password);
1700 int SSL_CTX_set_srp_strength(SSL_CTX *ctx, int strength);
1701 int SSL_CTX_set_srp_client_pwd_callback(SSL_CTX *ctx,
1702                                         char *(*cb) (SSL *, void *));
1703 int SSL_CTX_set_srp_verify_param_callback(SSL_CTX *ctx,
1704                                           int (*cb) (SSL *, void *));
1705 int SSL_CTX_set_srp_username_callback(SSL_CTX *ctx,
1706                                       int (*cb) (SSL *, int *, void *));
1707 int SSL_CTX_set_srp_cb_arg(SSL_CTX *ctx, void *arg);
1708
1709 int SSL_set_srp_server_param(SSL *s, const BIGNUM *N, const BIGNUM *g,
1710                              BIGNUM *sa, BIGNUM *v, char *info);
1711 int SSL_set_srp_server_param_pw(SSL *s, const char *user, const char *pass,
1712                                 const char *grp);
1713
1714 __owur BIGNUM *SSL_get_srp_g(SSL *s);
1715 __owur BIGNUM *SSL_get_srp_N(SSL *s);
1716
1717 __owur char *SSL_get_srp_username(SSL *s);
1718 __owur char *SSL_get_srp_userinfo(SSL *s);
1719 # endif
1720
1721 /*
1722  * ClientHello callback and helpers.
1723  */
1724
1725 # define SSL_CLIENT_HELLO_SUCCESS 1
1726 # define SSL_CLIENT_HELLO_ERROR   0
1727 # define SSL_CLIENT_HELLO_RETRY   (-1)
1728
1729 typedef int (*SSL_client_hello_cb_fn) (SSL *s, int *al, void *arg);
1730 void SSL_CTX_set_client_hello_cb(SSL_CTX *c, SSL_client_hello_cb_fn cb,
1731                                  void *arg);
1732 int SSL_client_hello_isv2(SSL *s);
1733 unsigned int SSL_client_hello_get0_legacy_version(SSL *s);
1734 size_t SSL_client_hello_get0_random(SSL *s, const unsigned char **out);
1735 size_t SSL_client_hello_get0_session_id(SSL *s, const unsigned char **out);
1736 size_t SSL_client_hello_get0_ciphers(SSL *s, const unsigned char **out);
1737 size_t SSL_client_hello_get0_compression_methods(SSL *s,
1738                                                  const unsigned char **out);
1739 int SSL_client_hello_get1_extensions_present(SSL *s, int **out, size_t *outlen);
1740 int SSL_client_hello_get0_ext(SSL *s, unsigned int type,
1741                               const unsigned char **out, size_t *outlen);
1742
1743 void SSL_certs_clear(SSL *s);
1744 void SSL_free(SSL *ssl);
1745 # ifdef OSSL_ASYNC_FD
1746 /*
1747  * Windows application developer has to include windows.h to use these.
1748  */
1749 __owur int SSL_waiting_for_async(SSL *s);
1750 __owur int SSL_get_all_async_fds(SSL *s, OSSL_ASYNC_FD *fds, size_t *numfds);
1751 __owur int SSL_get_changed_async_fds(SSL *s, OSSL_ASYNC_FD *addfd,
1752                                      size_t *numaddfds, OSSL_ASYNC_FD *delfd,
1753                                      size_t *numdelfds);
1754 # endif
1755 __owur int SSL_accept(SSL *ssl);
1756 __owur int SSL_stateless(SSL *s);
1757 __owur int SSL_connect(SSL *ssl);
1758 __owur int SSL_read(SSL *ssl, void *buf, int num);
1759 __owur int SSL_read_ex(SSL *ssl, void *buf, size_t num, size_t *readbytes);
1760
1761 # define SSL_READ_EARLY_DATA_ERROR   0
1762 # define SSL_READ_EARLY_DATA_SUCCESS 1
1763 # define SSL_READ_EARLY_DATA_FINISH  2
1764
1765 __owur int SSL_read_early_data(SSL *s, void *buf, size_t num,
1766                                size_t *readbytes);
1767 __owur int SSL_peek(SSL *ssl, void *buf, int num);
1768 __owur int SSL_peek_ex(SSL *ssl, void *buf, size_t num, size_t *readbytes);
1769 __owur int SSL_write(SSL *ssl, const void *buf, int num);
1770 __owur int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written);
1771 __owur int SSL_write_early_data(SSL *s, const void *buf, size_t num,
1772                                 size_t *written);
1773 long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
1774 long SSL_callback_ctrl(SSL *, int, void (*)(void));
1775 long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
1776 long SSL_CTX_callback_ctrl(SSL_CTX *, int, void (*)(void));
1777
1778 # define SSL_EARLY_DATA_NOT_SENT    0
1779 # define SSL_EARLY_DATA_REJECTED    1
1780 # define SSL_EARLY_DATA_ACCEPTED    2
1781
1782 __owur int SSL_get_early_data_status(const SSL *s);
1783
1784 __owur int SSL_get_error(const SSL *s, int ret_code);
1785 __owur const char *SSL_get_version(const SSL *s);
1786
1787 /* This sets the 'default' SSL version that SSL_new() will create */
1788 __owur int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth);
1789
1790 # ifndef OPENSSL_NO_SSL3_METHOD
1791 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *SSLv3_method(void)) /* SSLv3 */
1792 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *SSLv3_server_method(void)) /* SSLv3 */
1793 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *SSLv3_client_method(void)) /* SSLv3 */
1794 # endif
1795
1796 #define SSLv23_method           TLS_method
1797 #define SSLv23_server_method    TLS_server_method
1798 #define SSLv23_client_method    TLS_client_method
1799
1800 /* Negotiate highest available SSL/TLS version */
1801 __owur const SSL_METHOD *TLS_method(void);
1802 __owur const SSL_METHOD *TLS_server_method(void);
1803 __owur const SSL_METHOD *TLS_client_method(void);
1804
1805 # ifndef OPENSSL_NO_TLS1_METHOD
1806 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_method(void)) /* TLSv1.0 */
1807 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_server_method(void)) /* TLSv1.0 */
1808 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_client_method(void)) /* TLSv1.0 */
1809 # endif
1810
1811 # ifndef OPENSSL_NO_TLS1_1_METHOD
1812 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_1_method(void)) /* TLSv1.1 */
1813 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_1_server_method(void)) /* TLSv1.1 */
1814 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_1_client_method(void)) /* TLSv1.1 */
1815 # endif
1816
1817 # ifndef OPENSSL_NO_TLS1_2_METHOD
1818 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_2_method(void)) /* TLSv1.2 */
1819 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_2_server_method(void)) /* TLSv1.2 */
1820 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *TLSv1_2_client_method(void)) /* TLSv1.2 */
1821 # endif
1822
1823 # ifndef OPENSSL_NO_DTLS1_METHOD
1824 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_method(void)) /* DTLSv1.0 */
1825 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_server_method(void)) /* DTLSv1.0 */
1826 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_client_method(void)) /* DTLSv1.0 */
1827 # endif
1828
1829 # ifndef OPENSSL_NO_DTLS1_2_METHOD
1830 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_2_method(void)) /* DTLSv1.2 */
1831 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_2_server_method(void)) /* DTLSv1.2 */
1832 DEPRECATEDIN_1_1_0(__owur const SSL_METHOD *DTLSv1_2_client_method(void)) /* DTLSv1.2 */
1833 #endif
1834
1835 __owur const SSL_METHOD *DTLS_method(void); /* DTLS 1.0 and 1.2 */
1836 __owur const SSL_METHOD *DTLS_server_method(void); /* DTLS 1.0 and 1.2 */
1837 __owur const SSL_METHOD *DTLS_client_method(void); /* DTLS 1.0 and 1.2 */
1838
1839 __owur size_t DTLS_get_data_mtu(const SSL *s);
1840
1841 __owur STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
1842 __owur STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx);
1843 __owur STACK_OF(SSL_CIPHER) *SSL_get_client_ciphers(const SSL *s);
1844 __owur STACK_OF(SSL_CIPHER) *SSL_get1_supported_ciphers(SSL *s);
1845
1846 __owur int SSL_do_handshake(SSL *s);
1847 int SSL_key_update(SSL *s, int updatetype);
1848 int SSL_get_key_update_type(SSL *s);
1849 int SSL_renegotiate(SSL *s);
1850 int SSL_renegotiate_abbreviated(SSL *s);
1851 __owur int SSL_renegotiate_pending(SSL *s);
1852 int SSL_shutdown(SSL *s);
1853
1854 __owur const SSL_METHOD *SSL_CTX_get_ssl_method(SSL_CTX *ctx);
1855 __owur const SSL_METHOD *SSL_get_ssl_method(SSL *s);
1856 __owur int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
1857 __owur const char *SSL_alert_type_string_long(int value);
1858 __owur const char *SSL_alert_type_string(int value);
1859 __owur const char *SSL_alert_desc_string_long(int value);
1860 __owur const char *SSL_alert_desc_string(int value);
1861
1862 void SSL_set0_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
1863 void SSL_CTX_set0_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
1864 __owur const STACK_OF(X509_NAME) *SSL_get0_CA_list(const SSL *s);
1865 __owur const STACK_OF(X509_NAME) *SSL_CTX_get0_CA_list(const SSL_CTX *ctx);
1866 __owur int SSL_add1_CA_list(SSL *ssl, const X509 *x);
1867 __owur int SSL_CTX_add1_CA_list(SSL_CTX *ctx, const X509 *x);
1868 __owur const STACK_OF(X509_NAME) *SSL_get0_peer_CA_list(const SSL *s);
1869
1870 void SSL_set_client_CA_list(SSL *s, STACK_OF(X509_NAME) *name_list);
1871 void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK_OF(X509_NAME) *name_list);
1872 __owur STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
1873 __owur STACK_OF(X509_NAME) *SSL_CTX_get_client_CA_list(const SSL_CTX *s);
1874 __owur int SSL_add_client_CA(SSL *ssl, X509 *x);
1875 __owur int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
1876
1877 void SSL_set_connect_state(SSL *s);
1878 void SSL_set_accept_state(SSL *s);
1879
1880 __owur long SSL_get_default_timeout(const SSL *s);
1881
1882 #if OPENSSL_API_COMPAT < 0x10100000L
1883 # define SSL_library_init() OPENSSL_init_ssl(0, NULL)
1884 #endif
1885
1886 __owur char *SSL_CIPHER_description(const SSL_CIPHER *, char *buf, int size);
1887 __owur STACK_OF(X509_NAME) *SSL_dup_CA_list(const STACK_OF(X509_NAME) *sk);
1888
1889 __owur SSL *SSL_dup(SSL *ssl);
1890
1891 __owur X509 *SSL_get_certificate(const SSL *ssl);
1892 /*
1893  * EVP_PKEY
1894  */ struct evp_pkey_st *SSL_get_privatekey(const SSL *ssl);
1895
1896 __owur X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
1897 __owur EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
1898
1899 void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
1900 __owur int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
1901 void SSL_set_quiet_shutdown(SSL *ssl, int mode);
1902 __owur int SSL_get_quiet_shutdown(const SSL *ssl);
1903 void SSL_set_shutdown(SSL *ssl, int mode);
1904 __owur int SSL_get_shutdown(const SSL *ssl);
1905 __owur int SSL_version(const SSL *ssl);
1906 __owur int SSL_client_version(const SSL *s);
1907 __owur int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
1908 __owur int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx);
1909 __owur int SSL_CTX_set_default_verify_file(SSL_CTX *ctx);
1910 __owur int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile,
1911                                   const char *CApath);
1912 # define SSL_get0_session SSL_get_session/* just peek at pointer */
1913 __owur SSL_SESSION *SSL_get_session(const SSL *ssl);
1914 __owur SSL_SESSION *SSL_get1_session(SSL *ssl); /* obtain a reference count */
1915 __owur SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
1916 SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
1917 void SSL_set_info_callback(SSL *ssl,
1918                            void (*cb) (const SSL *ssl, int type, int val));
1919 void (*SSL_get_info_callback(const SSL *ssl)) (const SSL *ssl, int type,
1920                                                int val);
1921 __owur OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl);
1922
1923 void SSL_set_verify_result(SSL *ssl, long v);
1924 __owur long SSL_get_verify_result(const SSL *ssl);
1925 __owur STACK_OF(X509) *SSL_get0_verified_chain(const SSL *s);
1926
1927 __owur size_t SSL_get_client_random(const SSL *ssl, unsigned char *out,
1928                                     size_t outlen);
1929 __owur size_t SSL_get_server_random(const SSL *ssl, unsigned char *out,
1930                                     size_t outlen);
1931 __owur size_t SSL_SESSION_get_master_key(const SSL_SESSION *sess,
1932                                          unsigned char *out, size_t outlen);
1933 __owur int SSL_SESSION_set1_master_key(SSL_SESSION *sess,
1934                                        const unsigned char *in, size_t len);
1935 uint8_t SSL_SESSION_get_max_fragment_length(const SSL_SESSION *sess);
1936
1937 #define SSL_get_ex_new_index(l, p, newf, dupf, freef) \
1938     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL, l, p, newf, dupf, freef)
1939 __owur int SSL_set_ex_data(SSL *ssl, int idx, void *data);
1940 void *SSL_get_ex_data(const SSL *ssl, int idx);
1941 #define SSL_SESSION_get_ex_new_index(l, p, newf, dupf, freef) \
1942     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_SESSION, l, p, newf, dupf, freef)
1943 __owur int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx, void *data);
1944 void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
1945 #define SSL_CTX_get_ex_new_index(l, p, newf, dupf, freef) \
1946     CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL_CTX, l, p, newf, dupf, freef)
1947 __owur int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
1948 void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
1949
1950 __owur int SSL_get_ex_data_X509_STORE_CTX_idx(void);
1951
1952 # define SSL_CTX_sess_set_cache_size(ctx,t) \
1953         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_SIZE,t,NULL)
1954 # define SSL_CTX_sess_get_cache_size(ctx) \
1955         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_SIZE,0,NULL)
1956 # define SSL_CTX_set_session_cache_mode(ctx,m) \
1957         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SESS_CACHE_MODE,m,NULL)
1958 # define SSL_CTX_get_session_cache_mode(ctx) \
1959         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_SESS_CACHE_MODE,0,NULL)
1960
1961 # define SSL_CTX_get_default_read_ahead(ctx) SSL_CTX_get_read_ahead(ctx)
1962 # define SSL_CTX_set_default_read_ahead(ctx,m) SSL_CTX_set_read_ahead(ctx,m)
1963 # define SSL_CTX_get_read_ahead(ctx) \
1964         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_READ_AHEAD,0,NULL)
1965 # define SSL_CTX_set_read_ahead(ctx,m) \
1966         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_READ_AHEAD,m,NULL)
1967 # define SSL_CTX_get_max_cert_list(ctx) \
1968         SSL_CTX_ctrl(ctx,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL)
1969 # define SSL_CTX_set_max_cert_list(ctx,m) \
1970         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL)
1971 # define SSL_get_max_cert_list(ssl) \
1972         SSL_ctrl(ssl,SSL_CTRL_GET_MAX_CERT_LIST,0,NULL)
1973 # define SSL_set_max_cert_list(ssl,m) \
1974         SSL_ctrl(ssl,SSL_CTRL_SET_MAX_CERT_LIST,m,NULL)
1975
1976 # define SSL_CTX_set_max_send_fragment(ctx,m) \
1977         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL)
1978 # define SSL_set_max_send_fragment(ssl,m) \
1979         SSL_ctrl(ssl,SSL_CTRL_SET_MAX_SEND_FRAGMENT,m,NULL)
1980 # define SSL_CTX_set_split_send_fragment(ctx,m) \
1981         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_SPLIT_SEND_FRAGMENT,m,NULL)
1982 # define SSL_set_split_send_fragment(ssl,m) \
1983         SSL_ctrl(ssl,SSL_CTRL_SET_SPLIT_SEND_FRAGMENT,m,NULL)
1984 # define SSL_CTX_set_max_pipelines(ctx,m) \
1985         SSL_CTX_ctrl(ctx,SSL_CTRL_SET_MAX_PIPELINES,m,NULL)
1986 # define SSL_set_max_pipelines(ssl,m) \
1987         SSL_ctrl(ssl,SSL_CTRL_SET_MAX_PIPELINES,m,NULL)
1988
1989 void SSL_CTX_set_default_read_buffer_len(SSL_CTX *ctx, size_t len);
1990 void SSL_set_default_read_buffer_len(SSL *s, size_t len);
1991
1992 # ifndef OPENSSL_NO_DH
1993 /* NB: the |keylength| is only applicable when is_export is true */
1994 void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
1995                                  DH *(*dh) (SSL *ssl, int is_export,
1996                                             int keylength));
1997 void SSL_set_tmp_dh_callback(SSL *ssl,
1998                              DH *(*dh) (SSL *ssl, int is_export,
1999                                         int keylength));
2000 # endif
2001
2002 __owur const COMP_METHOD *SSL_get_current_compression(SSL *s);
2003 __owur const COMP_METHOD *SSL_get_current_expansion(SSL *s);
2004 __owur const char *SSL_COMP_get_name(const COMP_METHOD *comp);
2005 __owur const char *SSL_COMP_get0_name(const SSL_COMP *comp);
2006 __owur int SSL_COMP_get_id(const SSL_COMP *comp);
2007 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void);
2008 __owur STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
2009                                                       *meths);
2010 #if OPENSSL_API_COMPAT < 0x10100000L
2011 # define SSL_COMP_free_compression_methods() while(0) continue
2012 #endif
2013 __owur int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
2014
2015 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr);
2016 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c);
2017 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c);
2018 int SSL_bytes_to_cipher_list(SSL *s, const unsigned char *bytes, size_t len,
2019                              int isv2format, STACK_OF(SSL_CIPHER) **sk,
2020                              STACK_OF(SSL_CIPHER) **scsvs);
2021
2022 /* TLS extensions functions */
2023 __owur int SSL_set_session_ticket_ext(SSL *s, void *ext_data, int ext_len);
2024
2025 __owur int SSL_set_session_ticket_ext_cb(SSL *s, tls_session_ticket_ext_cb_fn cb,
2026                                   void *arg);
2027
2028 /* Pre-shared secret session resumption functions */
2029 __owur int SSL_set_session_secret_cb(SSL *s,
2030                               tls_session_secret_cb_fn tls_session_secret_cb,
2031                               void *arg);
2032
2033 void SSL_CTX_set_not_resumable_session_callback(SSL_CTX *ctx,
2034                                                 int (*cb) (SSL *ssl,
2035                                                            int
2036                                                            is_forward_secure));
2037
2038 void SSL_set_not_resumable_session_callback(SSL *ssl,
2039                                             int (*cb) (SSL *ssl,
2040                                                        int
2041                                                        is_forward_secure));
2042
2043 void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx,
2044                                          size_t (*cb) (SSL *ssl, int type,
2045                                                        size_t len, void *arg));
2046 void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg);
2047 void *SSL_CTX_get_record_padding_callback_arg(SSL_CTX *ctx);
2048 int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size);
2049
2050 void SSL_set_record_padding_callback(SSL *ssl,
2051                                     size_t (*cb) (SSL *ssl, int type,
2052                                                   size_t len, void *arg));
2053 void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg);
2054 void *SSL_get_record_padding_callback_arg(SSL *ssl);
2055 int SSL_set_block_padding(SSL *ssl, size_t block_size);
2056
2057 # if OPENSSL_API_COMPAT < 0x10100000L
2058 #  define SSL_cache_hit(s) SSL_session_reused(s)
2059 # endif
2060
2061 __owur int SSL_session_reused(SSL *s);
2062 __owur int SSL_is_server(const SSL *s);
2063
2064 __owur __owur SSL_CONF_CTX *SSL_CONF_CTX_new(void);
2065 int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx);
2066 void SSL_CONF_CTX_free(SSL_CONF_CTX *cctx);
2067 unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
2068 __owur unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
2069 __owur int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *pre);
2070
2071 void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl);
2072 void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx);
2073
2074 __owur int SSL_CONF_cmd(SSL_CONF_CTX *cctx, const char *cmd, const char *value);
2075 __owur int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
2076 __owur int SSL_CONF_cmd_value_type(SSL_CONF_CTX *cctx, const char *cmd);
2077
2078 void SSL_add_ssl_module(void);
2079 int SSL_config(SSL *s, const char *name);
2080 int SSL_CTX_config(SSL_CTX *ctx, const char *name);
2081
2082 # ifndef OPENSSL_NO_SSL_TRACE
2083 void SSL_trace(int write_p, int version, int content_type,
2084                const void *buf, size_t len, SSL *ssl, void *arg);
2085 # endif
2086
2087 # ifndef OPENSSL_NO_SOCK
2088 int DTLSv1_listen(SSL *s, BIO_ADDR *client);
2089 # endif
2090
2091 # ifndef OPENSSL_NO_CT
2092
2093 /*
2094  * A callback for verifying that the received SCTs are sufficient.
2095  * Expected to return 1 if they are sufficient, otherwise 0.
2096  * May return a negative integer if an error occurs.
2097  * A connection should be aborted if the SCTs are deemed insufficient.
2098  */
2099 typedef int(*ssl_ct_validation_cb)(const CT_POLICY_EVAL_CTX *ctx,
2100                                    const STACK_OF(SCT) *scts, void *arg);
2101
2102 /*
2103  * Sets a |callback| that is invoked upon receipt of ServerHelloDone to validate
2104  * the received SCTs.
2105  * If the callback returns a non-positive result, the connection is terminated.
2106  * Call this function before beginning a handshake.
2107  * If a NULL |callback| is provided, SCT validation is disabled.
2108  * |arg| is arbitrary userdata that will be passed to the callback whenever it
2109  * is invoked. Ownership of |arg| remains with the caller.
2110  *
2111  * NOTE: A side-effect of setting a CT callback is that an OCSP stapled response
2112  *       will be requested.
2113  */
2114 int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
2115                                    void *arg);
2116 int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
2117                                        ssl_ct_validation_cb callback,
2118                                        void *arg);
2119 #define SSL_disable_ct(s) \
2120         ((void) SSL_set_validation_callback((s), NULL, NULL))
2121 #define SSL_CTX_disable_ct(ctx) \
2122         ((void) SSL_CTX_set_validation_callback((ctx), NULL, NULL))
2123
2124 /*
2125  * The validation type enumerates the available behaviours of the built-in SSL
2126  * CT validation callback selected via SSL_enable_ct() and SSL_CTX_enable_ct().
2127  * The underlying callback is a static function in libssl.
2128  */
2129 enum {
2130     SSL_CT_VALIDATION_PERMISSIVE = 0,
2131     SSL_CT_VALIDATION_STRICT
2132 };
2133
2134 /*
2135  * Enable CT by setting up a callback that implements one of the built-in
2136  * validation variants.  The SSL_CT_VALIDATION_PERMISSIVE variant always
2137  * continues the handshake, the application can make appropriate decisions at
2138  * handshake completion.  The SSL_CT_VALIDATION_STRICT variant requires at
2139  * least one valid SCT, or else handshake termination will be requested.  The
2140  * handshake may continue anyway if SSL_VERIFY_NONE is in effect.
2141  */
2142 int SSL_enable_ct(SSL *s, int validation_mode);
2143 int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode);
2144
2145 /*
2146  * Report whether a non-NULL callback is enabled.
2147  */
2148 int SSL_ct_is_enabled(const SSL *s);
2149 int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx);
2150
2151 /* Gets the SCTs received from a connection */
2152 const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s);
2153
2154 /*
2155  * Loads the CT log list from the default location.
2156  * If a CTLOG_STORE has previously been set using SSL_CTX_set_ctlog_store,
2157  * the log information loaded from this file will be appended to the
2158  * CTLOG_STORE.
2159  * Returns 1 on success, 0 otherwise.
2160  */
2161 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx);
2162
2163 /*
2164  * Loads the CT log list from the specified file path.
2165  * If a CTLOG_STORE has previously been set using SSL_CTX_set_ctlog_store,
2166  * the log information loaded from this file will be appended to the
2167  * CTLOG_STORE.
2168  * Returns 1 on success, 0 otherwise.
2169  */
2170 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
2171
2172 /*
2173  * Sets the CT log list used by all SSL connections created from this SSL_CTX.
2174  * Ownership of the CTLOG_STORE is transferred to the SSL_CTX.
2175  */
2176 void SSL_CTX_set0_ctlog_store(SSL_CTX *ctx, CTLOG_STORE *logs);
2177
2178 /*
2179  * Gets the CT log list used by all SSL connections created from this SSL_CTX.
2180  * This will be NULL unless one of the following functions has been called:
2181  * - SSL_CTX_set_default_ctlog_list_file
2182  * - SSL_CTX_set_ctlog_list_file
2183  * - SSL_CTX_set_ctlog_store
2184  */
2185 const CTLOG_STORE *SSL_CTX_get0_ctlog_store(const SSL_CTX *ctx);
2186
2187 # endif /* OPENSSL_NO_CT */
2188
2189 /* What the "other" parameter contains in security callback */
2190 /* Mask for type */
2191 # define SSL_SECOP_OTHER_TYPE    0xffff0000
2192 # define SSL_SECOP_OTHER_NONE    0
2193 # define SSL_SECOP_OTHER_CIPHER  (1 << 16)
2194 # define SSL_SECOP_OTHER_CURVE   (2 << 16)
2195 # define SSL_SECOP_OTHER_DH      (3 << 16)
2196 # define SSL_SECOP_OTHER_PKEY    (4 << 16)
2197 # define SSL_SECOP_OTHER_SIGALG  (5 << 16)
2198 # define SSL_SECOP_OTHER_CERT    (6 << 16)
2199
2200 /* Indicated operation refers to peer key or certificate */
2201 # define SSL_SECOP_PEER          0x1000
2202
2203 /* Values for "op" parameter in security callback */
2204
2205 /* Called to filter ciphers */
2206 /* Ciphers client supports */
2207 # define SSL_SECOP_CIPHER_SUPPORTED      (1 | SSL_SECOP_OTHER_CIPHER)
2208 /* Cipher shared by client/server */
2209 # define SSL_SECOP_CIPHER_SHARED         (2 | SSL_SECOP_OTHER_CIPHER)
2210 /* Sanity check of cipher server selects */
2211 # define SSL_SECOP_CIPHER_CHECK          (3 | SSL_SECOP_OTHER_CIPHER)
2212 /* Curves supported by client */
2213 # define SSL_SECOP_CURVE_SUPPORTED       (4 | SSL_SECOP_OTHER_CURVE)
2214 /* Curves shared by client/server */
2215 # define SSL_SECOP_CURVE_SHARED          (5 | SSL_SECOP_OTHER_CURVE)
2216 /* Sanity check of curve server selects */
2217 # define SSL_SECOP_CURVE_CHECK           (6 | SSL_SECOP_OTHER_CURVE)
2218 /* Temporary DH key */
2219 # define SSL_SECOP_TMP_DH                (7 | SSL_SECOP_OTHER_PKEY)
2220 /* SSL/TLS version */
2221 # define SSL_SECOP_VERSION               (9 | SSL_SECOP_OTHER_NONE)
2222 /* Session tickets */
2223 # define SSL_SECOP_TICKET                (10 | SSL_SECOP_OTHER_NONE)
2224 /* Supported signature algorithms sent to peer */
2225 # define SSL_SECOP_SIGALG_SUPPORTED      (11 | SSL_SECOP_OTHER_SIGALG)
2226 /* Shared signature algorithm */
2227 # define SSL_SECOP_SIGALG_SHARED         (12 | SSL_SECOP_OTHER_SIGALG)
2228 /* Sanity check signature algorithm allowed */
2229 # define SSL_SECOP_SIGALG_CHECK          (13 | SSL_SECOP_OTHER_SIGALG)
2230 /* Used to get mask of supported public key signature algorithms */
2231 # define SSL_SECOP_SIGALG_MASK           (14 | SSL_SECOP_OTHER_SIGALG)
2232 /* Use to see if compression is allowed */
2233 # define SSL_SECOP_COMPRESSION           (15 | SSL_SECOP_OTHER_NONE)
2234 /* EE key in certificate */
2235 # define SSL_SECOP_EE_KEY                (16 | SSL_SECOP_OTHER_CERT)
2236 /* CA key in certificate */
2237 # define SSL_SECOP_CA_KEY                (17 | SSL_SECOP_OTHER_CERT)
2238 /* CA digest algorithm in certificate */
2239 # define SSL_SECOP_CA_MD                 (18 | SSL_SECOP_OTHER_CERT)
2240 /* Peer EE key in certificate */
2241 # define SSL_SECOP_PEER_EE_KEY           (SSL_SECOP_EE_KEY | SSL_SECOP_PEER)
2242 /* Peer CA key in certificate */
2243 # define SSL_SECOP_PEER_CA_KEY           (SSL_SECOP_CA_KEY | SSL_SECOP_PEER)
2244 /* Peer CA digest algorithm in certificate */
2245 # define SSL_SECOP_PEER_CA_MD            (SSL_SECOP_CA_MD | SSL_SECOP_PEER)
2246
2247 void SSL_set_security_level(SSL *s, int level);
2248 __owur int SSL_get_security_level(const SSL *s);
2249 void SSL_set_security_callback(SSL *s,
2250                                int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
2251                                           int bits, int nid, void *other,
2252                                           void *ex));
2253 int (*SSL_get_security_callback(const SSL *s)) (const SSL *s, const SSL_CTX *ctx, int op,
2254                                                 int bits, int nid,
2255                                                 void *other, void *ex);
2256 void SSL_set0_security_ex_data(SSL *s, void *ex);
2257 __owur void *SSL_get0_security_ex_data(const SSL *s);
2258
2259 void SSL_CTX_set_security_level(SSL_CTX *ctx, int level);
2260 __owur int SSL_CTX_get_security_level(const SSL_CTX *ctx);
2261 void SSL_CTX_set_security_callback(SSL_CTX *ctx,
2262                                    int (*cb) (const SSL *s, const SSL_CTX *ctx, int op,
2263                                               int bits, int nid, void *other,
2264                                               void *ex));
2265 int (*SSL_CTX_get_security_callback(const SSL_CTX *ctx)) (const SSL *s,
2266                                                           const SSL_CTX *ctx,
2267                                                           int op, int bits,
2268                                                           int nid,
2269                                                           void *other,
2270                                                           void *ex);
2271 void SSL_CTX_set0_security_ex_data(SSL_CTX *ctx, void *ex);
2272 __owur void *SSL_CTX_get0_security_ex_data(const SSL_CTX *ctx);
2273
2274 /* OPENSSL_INIT flag 0x010000 reserved for internal use */
2275 #define OPENSSL_INIT_NO_LOAD_SSL_STRINGS    0x00100000L
2276 #define OPENSSL_INIT_LOAD_SSL_STRINGS       0x00200000L
2277
2278 #define OPENSSL_INIT_SSL_DEFAULT \
2279         (OPENSSL_INIT_LOAD_SSL_STRINGS | OPENSSL_INIT_LOAD_CRYPTO_STRINGS)
2280
2281 int OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
2282
2283 # ifndef OPENSSL_NO_UNIT_TEST
2284 __owur const struct openssl_ssl_test_functions *SSL_test_functions(void);
2285 # endif
2286
2287 __owur int SSL_free_buffers(SSL *ssl);
2288 __owur int SSL_alloc_buffers(SSL *ssl);
2289
2290 extern const char SSL_version_str[];
2291
2292 int ERR_load_SSL_strings(void);
2293
2294
2295 typedef unsigned int (*DTLS_timer_cb)(SSL *s, unsigned int timer_us);
2296
2297 void DTLS_set_timer_cb(SSL *s, DTLS_timer_cb cb);
2298
2299
2300 # ifdef  __cplusplus
2301 }
2302 # endif
2303 #endif