1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at https://curl.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLOPT_PROXY_SSLCERT 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
- .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 file name 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 NSS or 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
- Used with HTTPS proxy
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- 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");
- ret = curl_easy_perform(curl);
- curl_easy_cleanup(curl);
- }
- .fi
- .SH AVAILABILITY
- Added in 7.52.0
- .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), " CURLOPT_PROXY_SSLKEY "(3), "
- .BR CURLOPT_SSLCERT "(3), "
|