2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-11-19 21:20:07 -07:00
repo/core/curl/files/CURLOPT_SSLENGINE_DEFAULT.3
2024-03-30 13:28:04 -05:00

53 lines
1.4 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_SSLENGINE_DEFAULT.md
.TH CURLOPT_SSLENGINE_DEFAULT 3 libcurl
.SH NAME
CURLOPT_SSLENGINE_DEFAULT \- make SSL engine default
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val);
.fi
.SH DESCRIPTION
Pass a long set to 1 to make the already specified crypto engine the default
for (asymmetric) crypto operations.
This option has no effect unless set after \fICURLOPT_SSLENGINE(3)\fP.
.SH DEFAULT
None
.SH PROTOCOLS
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
This option works only with the following TLS backends:
OpenSSL
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
curl_easy_setopt(curl, CURLOPT_SSLENGINE_DEFAULT, 1L);
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
.fi
.SH AVAILABILITY
Only if the SSL backend is OpenSSL built with engine support.
.SH RETURN VALUE
CURLE_OK \- Engine set as default.
CURLE_SSL_ENGINE_SETFAILED \- Engine could not be set as default.
CURLE_NOT_BUILT_IN \- Option not built in, OpenSSL is not the SSL backend.
CURLE_UNKNOWN_OPTION \- Option not recognized.
CURLE_OUT_OF_MEMORY \- Insufficient heap space.
.SH SEE ALSO
.BR CURLOPT_SSLCERT (3),
.BR CURLOPT_SSLENGINE (3)