docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.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_KEYPASSWD 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXY_KEYPASSWD \- set passphrase to proxy private key
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_KEYPASSWD, char *pwd);
  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. It will be used as
  35 the password required to use the \fICURLOPT_PROXY_SSLKEY(3)\fP private key.
  36 You never needed a pass phrase to load a certificate but you need one to load
  37 your private key.
  38
  39 The application does not have to keep the string around after setting this
  40 option.
  41 .SH DEFAULT
  42 NULL
  43 .SH PROTOCOLS
  44 Used with HTTPS proxy
  45 .SH EXAMPLE
  46 .nf
  47 CURL *curl = curl_easy_init();
  48 if(curl) {
  49   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  50   curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy:443");
  51   curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "superman");
  52   ret = curl_easy_perform(curl);
  53   curl_easy_cleanup(curl);
  54 }
  55 .fi
  56 .SH AVAILABILITY
  57 Added in 7.52.0
  58 .SH RETURN VALUE
  59 Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  60 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  61 .SH "SEE ALSO"
  62 .BR CURLOPT_PROXY_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), "
  63 .BR CURLOPT_SSLKEY "(3), "