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