docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3

   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_PROXY_SSLCERT 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXY_SSLCERT \- set SSL proxy client certificate
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT, char *cert);
  31 .SH DESCRIPTION
  32 This option is for connecting to a HTTPS proxy, not a HTTPS server.
  33
  34 Pass a pointer to a zero terminated string as parameter. The string should be
  35 the file name of your client certificate used to connect to the HTTPS proxy.
  36 The default format is "P12" on Secure Transport and "PEM" on other engines,
  37 and can be changed with \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP.
  38
  39 With NSS or Secure Transport, this can also be the nickname of the certificate
  40 you wish to authenticate with as it is named in the security database. If you
  41 want to use a file from the current directory, please precede it with "./"
  42 prefix, in order to avoid confusion with a nickname.
  43
  44 When using a client certificate, you most likely also need to provide a
  45 private key with \fICURLOPT_PROXY_SSLKEY(3)\fP.
  46
  47 The application does not have to keep the string around after setting this
  48 option.
  49 .SH DEFAULT
  50 NULL
  51 .SH PROTOCOLS
  52 Used with HTTPS proxy
  53 .SH EXAMPLE
  54 .nf
  55 CURL *curl = curl_easy_init();
  56 if(curl) {
  57   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  58   curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
  59   curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT, "client.pem");
  60   curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
  61   curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
  62   ret = curl_easy_perform(curl);
  63   curl_easy_cleanup(curl);
  64 }
  65 .fi
  66 .SH AVAILABILITY
  67 Added in 7.52.0
  68 .SH RETURN VALUE
  69 Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  70 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  71 .SH "SEE ALSO"
  72 .BR CURLOPT_PROXY_SSLCERTTYPE "(3), " CURLOPT_PROXY_SSLKEY "(3), "
  73 .BR CURLOPT_SSLCERT "(3), "