| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152 |
- .\" generated by cd2nroff 0.1 from CURLOPT_KEYPASSWD.md
- .TH CURLOPT_KEYPASSWD 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_KEYPASSWD \- passphrase to private key
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KEYPASSWD, char *pwd);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a null\-terminated string as parameter. It is used as the
- password required to use the \fICURLOPT_SSLKEY(3)\fP or
- \fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP private key. You never need a passphrase to
- load a certificate but you need one to load your private key.
- The application does not have to keep the string around after setting this
- option.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
- This option works only with the following TLS backends:
- OpenSSL, Schannel, mbedTLS and wolfSSL
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
- curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
- curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
- curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "superman");
- res = curl_easy_perform(curl);
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH HISTORY
- This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
- CURLOPT_SSLCERTPASSWD up to 7.9.2.
- .SH AVAILABILITY
- Added in curl 7.17.0
- .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_SSH_PRIVATE_KEYFILE (3),
- .BR CURLOPT_SSLKEY (3)
|
