2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_PROXY_SSLCERT.md
|
2024-08-02 19:52:59 -06:00
|
|
|
.TH CURLOPT_PROXY_SSLCERT 3 "2024-08-02" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_PROXY_SSLCERT \- HTTPS proxy client certificate
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
This option is for connecting to an HTTPS proxy, not an HTTPS server.
|
|
|
|
|
|
|
|
|
|
Pass a pointer to a null\-terminated string as parameter. The string should be
|
|
|
|
|
the filename of your client certificate used to connect to the HTTPS proxy.
|
|
|
|
|
The default format is "P12" on Secure Transport and "PEM" on other engines,
|
|
|
|
|
and can be changed with \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP.
|
|
|
|
|
|
|
|
|
|
With Secure Transport, this can also be the nickname of the certificate you
|
|
|
|
|
wish to authenticate with as it is named in the security database. If you want
|
|
|
|
|
to use a file from the current directory, please precede it with "./" prefix,
|
|
|
|
|
in order to avoid confusion with a nickname.
|
|
|
|
|
|
|
|
|
|
When using a client certificate, you most likely also need to provide a
|
|
|
|
|
private key with \fICURLOPT_PROXY_SSLKEY(3)\fP.
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
GnuTLS, OpenSSL, Schannel, Secure Transport, mbedTLS and wolfSSL
|
2024-03-15 20:55:33 -06:00
|
|
|
.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
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_PROXY_SSLCERTTYPE (3),
|
|
|
|
|
.BR CURLOPT_PROXY_SSLKEY (3),
|
|
|
|
|
.BR CURLOPT_SSLCERT (3)
|
