2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_SSLKEY.md
|
2024-12-25 11:28:33 -07:00
|
|
|
.TH CURLOPT_SSLKEY 3 "2024-12-25" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_SSLKEY \- private key file for TLS and SSL client cert
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEY, char *keyfile);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a pointer to a null\-terminated string as parameter. The string should be
|
|
|
|
|
the filename of your private key. The default format is "PEM" and can be
|
|
|
|
|
changed with \fICURLOPT_SSLKEYTYPE(3)\fP.
|
|
|
|
|
|
2024-09-15 18:10:01 -06:00
|
|
|
(Windows, iOS and macOS) This option is ignored by Secure Transport and
|
2024-03-15 20:55:33 -06:00
|
|
|
Schannel SSL backends because they expect the private key to be already present
|
|
|
|
|
in the key\-chain or PKCS#12 file containing the certificate.
|
|
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
2024-09-15 18:10:01 -06:00
|
|
|
|
|
|
|
|
Using this option multiple times makes the last set string override the
|
|
|
|
|
previous ones. Set it to NULL to disable its use again.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
2024-03-30 12:28:04 -06:00
|
|
|
|
|
|
|
|
This option works only with the following TLS backends:
|
|
|
|
|
OpenSSL, Schannel, mbedTLS and wolfSSL
|
2024-03-15 20:55:33 -06:00
|
|
|
.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_KEYPASSWD, "s3cret");
|
|
|
|
|
res = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.9.3
|
2024-03-15 20:55:33 -06:00
|
|
|
.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_SSLCERT (3),
|
|
|
|
|
.BR CURLOPT_SSLKEYTYPE (3),
|
|
|
|
|
.BR CURLOPT_SSLKEY_BLOB (3)
|
