Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_SSLKEYTYPE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, 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_PROXY_SSLKEYTYPE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_PROXY_SSLKEYTYPE \- set type of the proxy private key file
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEYTYPE, char *type);
31: .SH DESCRIPTION
32: This option is for connecting to an HTTPS proxy, not an HTTPS server.
33:
34: Pass a pointer to a zero terminated string as parameter. The string should be
35: the format of your private key. Supported formats are "PEM", "DER" and "ENG".
36:
37: The application does not have to keep the string around after setting this
38: option.
39: .SH PROTOCOLS
40: Used with HTTPS proxy
41: .SH EXAMPLE
42: .nf
43: CURL *curl = curl_easy_init();
44: if(curl) {
45: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
46: curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
47: curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT, "client.pem");
48: curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
49: curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEYTYPE, "PEM");
50: curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
51: ret = curl_easy_perform(curl);
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: Added in 7.52.0
57: .SH RETURN VALUE
58: Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
59: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
60: .SH "SEE ALSO"
61: .BR CURLOPT_PROXY_SSLKEY "(3), " CURLOPT_PROXY_SSLCERT "(3), "
62: .BR CURLOPT_SSLKEYTYPE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>