docs/libcurl/opts/CURLOPT_PROXY_SSLKEY.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXY_SSLKEY \- specify private keyfile for TLS and SSL proxy client cert
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string as parameter. The string should be
  32 the file name of your private key used for connecting to the HTTPS proxy. The
  33 default format is "PEM" and can be changed with
  34 \fICURLOPT_PROXY_SSLKEYTYPE(3)\fP.
  35
  36 (iOS and Mac OS X only) This option is ignored if curl was built against
  37 Secure Transport. Secure Transport expects the private key to be already
  38 present in the keychain or PKCS#12 file containing the certificate.
  39
  40 The application does not have to keep the string around after setting this
  41 option.
  42 .SH DEFAULT
  43 NULL
  44 .SH PROTOCOLS
  45 All
  46 .SH EXAMPLE
  47 TODO
  48 .SH AVAILABILITY
  49 Added in 7.52.0
  50
  51 If built TLS enabled.
  52 .SH RETURN VALUE
  53 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  54 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  55 .SH "SEE ALSO"
  56 .BR CURLOPT_PROXY_SSLKEYTYPE "(3), " CURLOPT_PROXY_SSLCERT "(3), "
  57 .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "