| 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_SSLCERT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_SSLCERT \- set SSL client certificate |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT, char *cert); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a pointer to a zero terminated string as parameter. The string should be |
| 32 |
the file name of your client certificate. The default format is "P12" on |
| 33 |
Secure Transport and "PEM" on other engines, and can be changed with |
| 34 |
\fICURLOPT_SSLCERTTYPE(3)\fP. |
| 35 |
|
| 36 |
With NSS or Secure Transport, this can also be the nickname of the certificate |
| 37 |
you wish to authenticate with as it is named in the security database. If you |
| 38 |
want to use a file from the current directory, please precede it with "./" |
| 39 |
prefix, in order to avoid confusion with a nickname. |
| 40 |
|
| 41 |
(Schannel only) Client certificates must be specified by a path expression to |
| 42 |
a certificate store. (Loading PFX is not supported; you can import it to a |
| 43 |
store first). You can use "<store location>\\<store name>\\<thumbprint>" to |
| 44 |
refer to a certificate in the system certificates store, for example, |
| 45 |
"CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a". Thumbprint is |
| 46 |
usually a SHA-1 hex string which you can see in certificate details. Following |
| 47 |
store locations are supported: CurrentUser, LocalMachine, CurrentService, |
| 48 |
Services, CurrentUserGroupPolicy, LocalMachineGroupPolicy, |
| 49 |
LocalMachineEnterprise. |
| 50 |
|
| 51 |
When using a client certificate, you most likely also need to provide a |
| 52 |
private key with \fICURLOPT_SSLKEY(3)\fP. |
| 53 |
|
| 54 |
The application does not have to keep the string around after setting this |
| 55 |
option. |
| 56 |
.SH DEFAULT |
| 57 |
NULL |
| 58 |
.SH PROTOCOLS |
| 59 |
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. |
| 60 |
.SH EXAMPLE |
| 61 |
.nf |
| 62 |
CURL *curl = curl_easy_init(); |
| 63 |
if(curl) { |
| 64 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| 65 |
curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem"); |
| 66 |
curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem"); |
| 67 |
curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret"); |
| 68 |
ret = curl_easy_perform(curl); |
| 69 |
curl_easy_cleanup(curl); |
| 70 |
} |
| 71 |
.fi |
| 72 |
.SH AVAILABILITY |
| 73 |
If built TLS enabled. |
| 74 |
.SH RETURN VALUE |
| 75 |
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or |
| 76 |
CURLE_OUT_OF_MEMORY if there was insufficient heap space. |
| 77 |
.SH "SEE ALSO" |
| 78 |
.BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), " |