CURLOPT_KEYPASSWD explained
Name
CURLOPT_KEYPASSWD - passphrase to private key
Synopsis
#include <curl/curl.h> CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KEYPASSWD, char *pwd);
Description
Pass a pointer to a null-terminated string as parameter. It is used as the password required to use the CURLOPT_SSLKEY or CURLOPT_SSH_PRIVATE_KEYFILE 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.
Using this option multiple times makes the last set string override the previous ones. Set it to NULL to disable its use again.
Default
NULL
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
Example
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); } }
History
This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and CURLOPT_SSLCERTPASSWD up to 7.9.2.
Availability
Added in curl 7.17.0
Return value
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
See also
CURLOPT_SSH_PRIVATE_KEYFILE(3), CURLOPT_SSLKEY(3)
This HTML page was made with roffit.