| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_SSLCERT 3 "September 08, 2021" "libcurl 7.80.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_SSLCERT \- SSL client certificate |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT, char *cert); |
| .SH DESCRIPTION |
| Pass a pointer to a null-terminated string as parameter. The string should be |
| the file name of your client certificate. The default format is "P12" on |
| Secure Transport and "PEM" on other engines, and can be changed with |
| \fICURLOPT_SSLCERTTYPE(3)\fP. |
| |
| With NSS or 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 to use a file from the current directory, please precede it with "./" |
| prefix, 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 PFX to a store first). You can use |
| "<store location>\\<store name>\\<thumbprint>" to refer to a certificate |
| in the system certificates store, for example, |
| "CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a". Thumbprint is |
| usually a SHA-1 hex string which you can see in certificate details. Following |
| store locations are supported: CurrentUser, LocalMachine, CurrentService, |
| Services, CurrentUserGroupPolicy, LocalMachineGroupPolicy, |
| LocalMachineEnterprise. |
| Schannel also support P12 certificate file, with the string "P12" specified |
| with \fICURLOPT_SSLCERTTYPE(3)\fP. |
| |
| 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. |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| 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"); |
| ret = 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_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), " |
