2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-24 16:30:04 -07:00
repo/core/curl/files/CURLOPT_PROXY_SSLKEY.3

58 lines
1.9 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from CURLOPT_PROXY_SSLKEY.md
2024-07-29 18:00:04 -06:00
.TH CURLOPT_PROXY_SSLKEY 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_PROXY_SSLKEY \- private key file for HTTPS proxy client cert
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);
.fi
.SH DESCRIPTION
Pass a pointer to a null\-terminated string as parameter. The string should be
the filename of your private key used for connecting to the HTTPS proxy. The
default format is "PEM" and can be changed with
\fICURLOPT_PROXY_SSLKEYTYPE(3)\fP.
(Windows, iOS and Mac OS X) This option is ignored by Secure Transport and
Schannel SSL backends because they expect the private key to be already
present in the key chain or PKCS#12 file containing the certificate.
The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
2024-07-29 18:00:04 -06:00
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
2024-03-30 12:28:04 -06:00
This option works only with the following TLS backends:
OpenSSL, Schannel, mbedTLS and wolfSSL
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT, "client.pem");
curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
}
}
.fi
.SH AVAILABILITY
2024-07-29 18:00:04 -06:00
Added in curl 7.52.0
.SH RETURN VALUE
Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
.SH SEE ALSO
.BR CURLOPT_PROXY_SSLCERT (3),
.BR CURLOPT_PROXY_SSLKEYTYPE (3),
.BR CURLOPT_SSLCERT (3),
.BR CURLOPT_SSLKEY (3),
.BR CURLOPT_SSLKEYTYPE (3)