Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_KEYPASSWD.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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_KEYPASSWD 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_KEYPASSWD \- set passphrase to private key
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_KEYPASSWD, char *pwd);
31: .SH DESCRIPTION
32: Pass a pointer to a zero terminated string as parameter. It will be used as
33: the password required to use the \fICURLOPT_SSLKEY(3)\fP or
34: \fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP private key. You never needed a pass
35: phrase to load a certificate but you need one to load your private key.
36:
37: The application does not have to keep the string around after setting this
38: option.
39: .SH DEFAULT
40: NULL
41: .SH PROTOCOLS
42: All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
43: .SH EXAMPLE
44: .nf
45: CURL *curl = curl_easy_init();
46: if(curl) {
47: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
48: curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
49: curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
50: curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "superman");
51: ret = curl_easy_perform(curl);
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
57: CURLOPT_SSLCERTPASSWD up to 7.9.2.
58: .SH RETURN VALUE
59: Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
60: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
61: .SH "SEE ALSO"
62: .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>