CURLOPT_CAPATH.3 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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_CAPATH 3 "September 10, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_CAPATH \- specify directory holding CA certificates
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath);
  29. .SH DESCRIPTION
  30. Pass a char * to a zero terminated string naming a directory holding multiple
  31. CA certificates to verify the peer with. If libcurl is built against OpenSSL,
  32. the certificate directory must be prepared using the openssl c_rehash utility.
  33. This makes sense only when used in combination with the
  34. \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
  35. The \fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due
  36. to some limitation in openssl.
  37. The application does not have to keep the string around after setting this
  38. option.
  39. .SH DEFAULT
  40. NULL
  41. .SH PROTOCOLS
  42. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  48. curl_easy_setopt(curl, CURLOPT_CAPATH, "/etc/cert-dir");
  49. ret = curl_easy_perform(curl);
  50. curl_easy_cleanup(curl);
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. This option is supported by the OpenSSL, GnuTLS, PolarSSL and mbedTLS
  55. (since 7.56.0) backends. The NSS backend provides the option only for
  56. 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_CAINFO "(3), "
  64. .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "