| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_SSL_CTX_FUNCTION 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_SSL_CTX_FUNCTION \- SSL context callback for OpenSSL, wolfSSL or mbedTLS |
| 26 |
.SH SYNOPSIS |
| 27 |
.nf |
| 28 |
#include <curl/curl.h> |
| 29 |
|
| 30 |
CURLcode ssl_ctx_callback(CURL *curl, void *ssl_ctx, void *userptr); |
| 31 |
|
| 32 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_CTX_FUNCTION, |
| 33 |
ssl_ctx_callback); |
| 34 |
.SH DESCRIPTION |
| 35 |
This option only works for libcurl powered by OpenSSL, wolfSSL or mbedTLS. If |
| 36 |
libcurl was built against another SSL library this functionality is absent. |
| 37 |
|
| 38 |
Pass a pointer to your callback function, which should match the prototype |
| 39 |
shown above. |
| 40 |
|
| 41 |
This callback function gets called by libcurl just before the initialization |
| 42 |
of an SSL connection after having processed all other SSL related options to |
| 43 |
give a last chance to an application to modify the behavior of the SSL |
| 44 |
initialization. The \fIssl_ctx\fP parameter is actually a pointer to the SSL |
| 45 |
library's \fISSL_CTX\fP for OpenSSL or wolfSSL, and a pointer to |
| 46 |
\fImbedtls_ssl_config\fP for mbedTLS. If an error is returned from the |
| 47 |
callback no attempt to establish a connection is made and the perform |
| 48 |
operation will return the callback's error code. Set the \fIuserptr\fP |
| 49 |
argument with the \fICURLOPT_SSL_CTX_DATA(3)\fP option. |
| 50 |
|
| 51 |
This function will get called on all new connections made to a server, during |
| 52 |
the SSL negotiation. The \fIssl_ctx\fP will point to a newly initialized object |
| 53 |
each time, but note the pointer may be the same as from a prior call. |
| 54 |
|
| 55 |
To use this properly, a non-trivial amount of knowledge of your SSL library is |
| 56 |
necessary. For example, you can use this function to call library-specific |
| 57 |
callbacks to add additional validation code for certificates, and even to |
| 58 |
change the actual URI of an HTTPS request. |
| 59 |
|
| 60 |
WARNING: The \fICURLOPT_SSL_CTX_FUNCTION(3)\fP callback allows the application |
| 61 |
to reach in and modify SSL details in the connection without libcurl itself |
| 62 |
knowing anything about it, which then subsequently can lead to libcurl |
| 63 |
unknowingly reusing SSL connections with different properties. To remedy this |
| 64 |
you may set \fICURLOPT_FORBID_REUSE(3)\fP from the callback function. |
| 65 |
.SH DEFAULT |
| 66 |
NULL |
| 67 |
.SH PROTOCOLS |
| 68 |
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. |
| 69 |
.SH EXAMPLE |
| 70 |
See cacertinmem.c in docs/examples directory for usage example. |
| 71 |
|
| 72 |
https://curl.haxx.se/libcurl/c/cacertinmem.html |
| 73 |
.SH AVAILABILITY |
| 74 |
Added in 7.11.0 for OpenSSL, in 7.42.0 for wolfSSL and in 7.54.0 for |
| 75 |
mbedTLS. Other SSL backends are not supported. |
| 76 |
.SH RETURN VALUE |
| 77 |
CURLE_OK if supported; or an error such as: |
| 78 |
|
| 79 |
CURLE_NOT_BUILT_IN - Not supported by the SSL backend |
| 80 |
|
| 81 |
CURLE_UNKNOWN_OPTION |
| 82 |
.SH "SEE ALSO" |
| 83 |
.BR CURLOPT_SSL_CTX_DATA "(3), " CURLOPT_SSL_VERIFYPEER "(3), " |