CURLOPT_PROXY_SSLCERT.3 2.9 KB

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