CURLOPT_PROXY_CAPATH.3 2.8 KB

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