Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSLKEY.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_SSLKEY 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_SSLKEY \- specify private keyfile for TLS and SSL client cert
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEY, char *keyfile);
31: .SH DESCRIPTION
32: Pass a pointer to a zero terminated string as parameter. The string should be
33: the file name of your private key. The default format is "PEM" and can be
34: changed with \fICURLOPT_SSLKEYTYPE(3)\fP.
35:
36: (iOS and Mac OS X only) This option is ignored if curl was built against
37: Secure Transport. Secure Transport expects the private key to be already
38: present in the keychain or PKCS#12 file containing the certificate.
39:
40: The application does not have to keep the string around after setting this
41: option.
42: .SH DEFAULT
43: NULL
44: .SH PROTOCOLS
45: All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
46: .SH EXAMPLE
47: .nf
48: CURL *curl = curl_easy_init();
49: if(curl) {
50: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
51: curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
52: curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
53: curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
54: ret = curl_easy_perform(curl);
55: curl_easy_cleanup(curl);
56: }
57: .fi
58: .SH AVAILABILITY
59: If built TLS enabled.
60: .SH RETURN VALUE
61: Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
62: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
63: .SH "SEE ALSO"
64: .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>