2024-03-16 02:55:33 +00:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_SSLCERT.md
|
2024-06-01 20:49:19 +00:00
|
|
|
.TH CURLOPT_SSLCERT 3 "2024-06-01" libcurl
|
2024-03-16 02:55:33 +00:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_SSLCERT \- SSL client certificate
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT, char *cert);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a pointer to a null\-terminated string as parameter. The string should be
|
2024-03-30 18:28:04 +00:00
|
|
|
the filename of your client certificate. The default format is \fIP12\fP on Secure
|
|
|
|
|
Transport and \fIPEM\fP on other engines, and can be changed with
|
2024-03-16 02:55:33 +00:00
|
|
|
\fICURLOPT_SSLCERTTYPE(3)\fP.
|
|
|
|
|
|
|
|
|
|
With Secure Transport, this can also be the nickname of the certificate you
|
|
|
|
|
wish to authenticate with as it is named in the security database. If you want
|
2024-03-30 18:28:04 +00:00
|
|
|
to use a file from the current directory, please precede it with \fI./\fP prefix,
|
2024-03-16 02:55:33 +00:00
|
|
|
in order to avoid confusion with a nickname.
|
|
|
|
|
|
|
|
|
|
(Schannel only) Client certificates can be specified by a path expression to a
|
|
|
|
|
certificate store. (You can import \fIPFX\fP to a store first). You can use
|
2024-03-30 18:28:04 +00:00
|
|
|
\&"<store location>\\<store name>\\<thumbprint>" to refer to a certificate
|
|
|
|
|
in the system certificates store, for example,
|
|
|
|
|
\fB"CurrentUser\\MY\\934a7ac6f8a5d579285a74fa"\fP. The thumbprint is usually a
|
|
|
|
|
SHA\-1 hex string which you can see in certificate details. Following store
|
|
|
|
|
locations are supported: \fBCurrentUser\fP, \fBLocalMachine\fP,
|
|
|
|
|
\fBCurrentService\fP, \fBServices\fP, \fBCurrentUserGroupPolicy\fP,
|
|
|
|
|
\fBLocalMachineGroupPolicy\fP, \fBLocalMachineEnterprise\fP. Schannel also support
|
|
|
|
|
P12 certificate file, with the string \fIP12\fP specified with
|
|
|
|
|
\fICURLOPT_SSLCERTTYPE(3)\fP.
|
2024-03-16 02:55:33 +00:00
|
|
|
|
|
|
|
|
When using a client certificate, you most likely also need to provide a
|
|
|
|
|
private key with \fICURLOPT_SSLKEY(3)\fP.
|
|
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
2024-03-30 18:28:04 +00:00
|
|
|
|
|
|
|
|
This option works only with the following TLS backends:
|
|
|
|
|
GnuTLS, OpenSSL, Schannel, Secure Transport, mbedTLS and wolfSSL
|
2024-03-16 02:55:33 +00: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
|
|
|
|
|
If built TLS enabled.
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_KEYPASSWD (3),
|
|
|
|
|
.BR CURLOPT_SSLCERTTYPE (3),
|
|
|
|
|
.BR CURLOPT_SSLKEY (3)
|
