CURLOPT_PROXY_SSLKEY.3 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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 \- private keyfile for HTTPS proxy client cert
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLKEY, char *keyfile);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a pointer to a null-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. (Windows, iOS and Mac OS X) This option is ignored by Secure Transport and
  37. Schannel SSL backends because they expect the private key to be already present
  38. in the keychain or PKCS#12 file containing the certificate.
  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. All
  45. .SH EXAMPLE
  46. .nf
  47. CURL *curl = curl_easy_init();
  48. if(curl) {
  49. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  50. curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
  51. curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT, "client.pem");
  52. curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
  53. curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
  54. ret = curl_easy_perform(curl);
  55. curl_easy_cleanup(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.52.0
  60. If built TLS enabled.
  61. .SH RETURN VALUE
  62. Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  63. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  64. .SH "SEE ALSO"
  65. .BR CURLOPT_PROXY_SSLKEYTYPE "(3), " CURLOPT_PROXY_SSLCERT "(3), "
  66. .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "