2014-06-17 18:29:22 -04:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
|
.\" *
|
2017-05-31 05:56:28 -04:00
|
|
|
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
|
2014-06-17 18:29:22 -04:00
|
|
|
.\" *
|
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2020-11-04 08:02:01 -05:00
|
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
2014-06-17 18:29:22 -04:00
|
|
|
.\" *
|
|
|
|
|
.\" * 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_KEYPASSWD 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_KEYPASSWD \- set passphrase to private key
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KEYPASSWD, char *pwd);
|
|
|
|
|
.SH DESCRIPTION
|
2020-06-25 05:38:25 -04:00
|
|
|
Pass a pointer to a null-terminated string as parameter. It will be used as
|
2014-06-17 18:29:22 -04:00
|
|
|
the password required to use the \fICURLOPT_SSLKEY(3)\fP or
|
|
|
|
|
\fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP private key. You never needed a pass
|
|
|
|
|
phrase to load a certificate but you need one to load your private key.
|
2016-12-21 08:48:35 -05:00
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
2014-06-17 18:29:22 -04:00
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
2015-11-07 17:11:04 -05:00
|
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
2014-06-17 18:29:22 -04:00
|
|
|
.SH EXAMPLE
|
2017-05-31 05:56:28 -04:00
|
|
|
.nf
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
2020-09-16 17:04:07 -04:00
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
|
2017-05-31 05:56:28 -04:00
|
|
|
curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "superman");
|
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2014-06-17 18:29:22 -04:00
|
|
|
.SH AVAILABILITY
|
|
|
|
|
This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
|
|
|
|
|
CURLOPT_SSLCERTPASSWD up to 7.9.2.
|
|
|
|
|
.SH RETURN VALUE
|
2014-06-18 17:27:24 -04:00
|
|
|
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
2014-06-17 18:29:22 -04:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), "
|
