2014-06-19 19:53:13 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
.\" *
|
2019-06-02 22:55:05 +08:00
|
|
|
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
|
2014-06-19 19:53:13 +08:00
|
|
|
.\" *
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2020-11-04 21:02:01 +08:00
|
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
2014-06-19 19:53:13 +08:00
|
|
|
.\" *
|
|
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
|
|
.\" *
|
|
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
|
.\" * KIND, either express or implied.
|
|
|
|
.\" *
|
|
|
|
.\" **************************************************************************
|
|
|
|
.\"
|
|
|
|
.TH CURLOPT_SSL_CTX_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
|
|
.SH NAME
|
2019-06-02 22:55:05 +08:00
|
|
|
CURLOPT_SSL_CTX_FUNCTION \- SSL context callback for OpenSSL, wolfSSL or mbedTLS
|
2014-06-19 19:53:13 +08:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
CURLcode ssl_ctx_callback(CURL *curl, void *ssl_ctx, void *userptr);
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_CTX_FUNCTION,
|
|
|
|
ssl_ctx_callback);
|
|
|
|
.SH DESCRIPTION
|
2019-06-02 22:55:05 +08:00
|
|
|
This option only works for libcurl powered by OpenSSL, wolfSSL or mbedTLS. If
|
|
|
|
libcurl was built against another SSL library this functionality is absent.
|
2014-06-19 19:53:13 +08:00
|
|
|
|
|
|
|
Pass a pointer to your callback function, which should match the prototype
|
|
|
|
shown above.
|
|
|
|
|
|
|
|
This callback function gets called by libcurl just before the initialization
|
2015-03-28 12:16:08 +08:00
|
|
|
of an SSL connection after having processed all other SSL related options to
|
2018-08-27 14:30:57 +08:00
|
|
|
give a last chance to an application to modify the behavior of the SSL
|
2015-03-28 12:16:08 +08:00
|
|
|
initialization. The \fIssl_ctx\fP parameter is actually a pointer to the SSL
|
2019-06-02 22:55:05 +08:00
|
|
|
library's \fISSL_CTX\fP for OpenSSL or wolfSSL, and a pointer to
|
|
|
|
\fImbedtls_ssl_config\fP for mbedTLS. If an error is returned from the
|
|
|
|
callback no attempt to establish a connection is made and the perform
|
|
|
|
operation will return the callback's error code. Set the \fIuserptr\fP
|
|
|
|
argument with the \fICURLOPT_SSL_CTX_DATA(3)\fP option.
|
2014-06-19 19:53:13 +08:00
|
|
|
|
|
|
|
This function will get called on all new connections made to a server, during
|
2017-02-21 20:15:56 +08:00
|
|
|
the SSL negotiation. The \fIssl_ctx\fP will point to a newly initialized object
|
|
|
|
each time, but note the pointer may be the same as from a prior call.
|
2014-06-19 19:53:13 +08:00
|
|
|
|
2016-03-06 23:58:34 +08:00
|
|
|
To use this properly, a non-trivial amount of knowledge of your SSL library is
|
|
|
|
necessary. For example, you can use this function to call library-specific
|
2015-03-28 12:16:08 +08:00
|
|
|
callbacks to add additional validation code for certificates, and even to
|
2018-04-18 03:17:57 +08:00
|
|
|
change the actual URI of an HTTPS request.
|
2018-08-27 14:30:57 +08:00
|
|
|
|
|
|
|
WARNING: The \fICURLOPT_SSL_CTX_FUNCTION(3)\fP callback allows the application
|
|
|
|
to reach in and modify SSL details in the connection without libcurl itself
|
|
|
|
knowing anything about it, which then subsequently can lead to libcurl
|
2018-08-29 22:08:16 +08:00
|
|
|
unknowingly reusing SSL connections with different properties. To remedy this
|
|
|
|
you may set \fICURLOPT_FORBID_REUSE(3)\fP from the callback function.
|
2021-03-04 13:55:53 +08:00
|
|
|
|
2021-07-16 15:17:03 +08:00
|
|
|
WARNING: If you are using DNS-over-HTTPS (DoH) via \fICURLOPT_DOH_URL(3)\fP
|
2021-03-04 13:55:53 +08:00
|
|
|
then the CTX callback will also be called for those transfers and the curl
|
|
|
|
handle is set to an internal handle. \fBThis behavior is subject to change.\fP
|
|
|
|
We recommend before performing your transfer set \fICURLOPT_PRIVATE(3)\fP on
|
|
|
|
your curl handle so you can identify it in the CTX callback. If you have a
|
2021-07-16 15:17:03 +08:00
|
|
|
reason to modify DoH SSL context please let us know on the curl-library mailing
|
2021-03-04 13:55:53 +08:00
|
|
|
list because we are considering removing this capability.
|
2014-06-19 19:53:13 +08:00
|
|
|
.SH DEFAULT
|
|
|
|
NULL
|
|
|
|
.SH PROTOCOLS
|
2015-11-08 06:11:04 +08:00
|
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
2014-06-19 19:53:13 +08:00
|
|
|
.SH EXAMPLE
|
2017-12-19 15:17:39 +08:00
|
|
|
See cacertinmem.c in docs/examples directory for usage example.
|
2016-03-06 23:58:34 +08:00
|
|
|
|
2020-11-04 21:02:01 +08:00
|
|
|
https://curl.se/libcurl/c/cacertinmem.html
|
2014-06-19 19:53:13 +08:00
|
|
|
.SH AVAILABILITY
|
2019-06-02 22:55:05 +08:00
|
|
|
Added in 7.11.0 for OpenSSL, in 7.42.0 for wolfSSL and in 7.54.0 for
|
|
|
|
mbedTLS. Other SSL backends are not supported.
|
2014-06-19 19:53:13 +08:00
|
|
|
.SH RETURN VALUE
|
2017-03-05 05:07:07 +08:00
|
|
|
CURLE_OK if supported; or an error such as:
|
|
|
|
|
|
|
|
CURLE_NOT_BUILT_IN - Not supported by the SSL backend
|
|
|
|
|
|
|
|
CURLE_UNKNOWN_OPTION
|
2014-06-19 19:53:13 +08:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR CURLOPT_SSL_CTX_DATA "(3), " CURLOPT_SSL_VERIFYPEER "(3), "
|