docs/libcurl/opts/CURLOPT_PROXY_SSLKEY.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_SSLKEY 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXY_SSLKEY \- specify private keyfile for TLS and SSL proxy client cert
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);
  31 .SH DESCRIPTION
  32 Pass a pointer to a zero terminated string as parameter. The string should be
  33 the file name of your private key used for connecting to the HTTPS proxy. The
  34 default format is "PEM" and can be changed with
  35 \fICURLOPT_PROXY_SSLKEYTYPE(3)\fP.
  36
  37 (iOS and Mac OS X only) This option is ignored if curl was built against
  38 Secure Transport. Secure Transport expects the private key to be already
  39 present in the keychain or PKCS#12 file containing the certificate.
  40
  41 The application does not have to keep the string around after setting this
  42 option.
  43 .SH DEFAULT
  44 NULL
  45 .SH PROTOCOLS
  46 All
  47 .SH EXAMPLE
  48 .nf
  49 CURL *curl = curl_easy_init();
  50 if(curl) {
  51   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  52   curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
  53   curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT, "client.pem");
  54   curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
  55   curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
  56   ret = curl_easy_perform(curl);
  57   curl_easy_cleanup(curl);
  58 }
  59 .fi
  60 .SH AVAILABILITY
  61 Added in 7.52.0
  62
  63 If built TLS enabled.
  64 .SH RETURN VALUE
  65 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  66 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  67 .SH "SEE ALSO"
  68 .BR CURLOPT_PROXY_SSLKEYTYPE "(3), " CURLOPT_PROXY_SSLCERT "(3), "
  69 .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "