CURLOPT_PROXY_CAPATH.3 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2019, 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_CAPATH 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_CAPATH \- specify directory holding proxy CA certificates
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAPATH, char *capath);
  29. .SH DESCRIPTION
  30. Pass a char * to a null-terminated string naming a directory holding multiple
  31. CA certificates to verify the HTTPS proxy with. If libcurl is built against
  32. OpenSSL, the certificate directory must be prepared using the openssl c_rehash
  33. utility. This makes sense only when \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is
  34. enabled (which it is by default).
  35. The application does not have to keep the string around after setting this
  36. option.
  37. .SH DEFAULT
  38. NULL
  39. .SH PROTOCOLS
  40. Everything used over an HTTPS proxy
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. if(curl) {
  45. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  46. /* using an HTTPS proxy */
  47. curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:443");
  48. curl_easy_setopt(curl, CURLOPT_PROXY_CAPATH, "/etc/cert-dir");
  49. ret = curl_easy_perform(curl);
  50. curl_easy_cleanup(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. Added in 7.52.0
  55. This option is supported by the OpenSSL, GnuTLS, and mbedTLS (since 7.56.0)
  56. backends. The NSS backend provides the option only for backward compatibility.
  57. .SH RETURN VALUE
  58. CURLE_OK if supported; or an error such as:
  59. CURLE_NOT_BUILT_IN - Not supported by the SSL backend
  60. CURLE_UNKNOWN_OPTION
  61. CURLE_OUT_OF_MEMORY
  62. .SH "SEE ALSO"
  63. .BR CURLOPT_PROXY_CAINFO "(3), "
  64. .BR CURLOPT_CAINFO "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
  65. .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "