mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 20:56:58 +00:00
52 lines
1.6 KiB
Groff
52 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_SSLKEYTYPE.md
|
|
.TH CURLOPT_SSLKEYTYPE 3 "March 15 2024" libcurl
|
|
.SH NAME
|
|
CURLOPT_SSLKEYTYPE \- type of the private key file
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEYTYPE, char *type);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a null\-terminated string as parameter. The string should be
|
|
the format of your private key. Supported formats are "PEM", "DER" and "ENG".
|
|
|
|
The format "ENG" enables you to load the private key from a crypto engine. In
|
|
this case \fICURLOPT_SSLKEY(3)\fP is used as an identifier passed to the engine. You
|
|
have to set the crypto engine with \fICURLOPT_SSLENGINE(3)\fP. "DER" format key file
|
|
currently does not work because of a bug in OpenSSL.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
.SH DEFAULT
|
|
\&"PEM"
|
|
.SH PROTOCOLS
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
|
.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_SSLCERT, "client.pem");
|
|
curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
|
|
curl_easy_setopt(curl, CURLOPT_SSLKEYTYPE, "PEM");
|
|
curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
If built TLS enabled.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_PROXY_SSLKEYTYPE (3),
|
|
.BR CURLOPT_SSLCERT (3),
|
|
.BR CURLOPT_SSLKEY (3)
|