CURLOPT_CAINFO.3 3.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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_CAINFO 3 "March 10, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_CAINFO \- path to Certificate Authority (CA) bundle
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAINFO, char *path);
  29. .SH DESCRIPTION
  30. Pass a char * to a zero terminated string naming a file holding one or more
  31. certificates to verify the peer with.
  32. If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the
  33. server's certificate, \fICURLOPT_CAINFO(3)\fP need not even indicate an
  34. accessible file.
  35. This option is by default set to the system path where libcurl's cacert bundle
  36. is assumed to be stored, as established at build time.
  37. If curl is built against the NSS SSL library, the NSS PEM PKCS#11 module
  38. (libnsspem.so) needs to be available for this option to work properly.
  39. Starting with curl-7.55.0, if both \fICURLOPT_CAINFO(3)\fP and
  40. \fICURLOPT_CAPATH(3)\fP are unset, NSS-linked libcurl tries to load
  41. libnssckbi.so, which contains a more comprehensive set of trust information
  42. than supported by nss-pem, because libnssckbi.so also includes information
  43. about distrusted certificates.
  44. (iOS and macOS only) If curl is built against Secure Transport, then this
  45. option is supported for backward compatibility with other SSL engines, but it
  46. should not be set. If the option is not set, then curl will use the
  47. certificates in the system and user Keychain to verify the peer, which is the
  48. preferred method of verifying the peer's certificate chain.
  49. (Schannel/WinSSL only) This option is supported for WinSSL in Windows 7 or
  50. later with libcurl 7.60 or later. This option is supported for backward
  51. compatibility with other SSL engines; instead it is recommended to use Windows'
  52. store of root certificates (the default for WinSSL).
  53. The application does not have to keep the string around after setting this
  54. option.
  55. .SH DEFAULT
  56. Built-in system specific
  57. .SH PROTOCOLS
  58. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  59. .SH EXAMPLE
  60. .nf
  61. CURL *curl = curl_easy_init();
  62. if(curl) {
  63. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  64. curl_easy_setopt(curl, CURLOPT_CAINFO, "/etc/certs/cabundle.pem");
  65. ret = curl_easy_perform(curl);
  66. curl_easy_cleanup(curl);
  67. }
  68. .fi
  69. .SH AVAILABILITY
  70. For SSL engines that don't support certificate files the CURLOPT_CAINFO option
  71. is ignored. Refer to https://curl.haxx.se/docs/ssl-compared.html
  72. .SH RETURN VALUE
  73. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  74. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  75. .SH "SEE ALSO"
  76. .BR CURLOPT_CAPATH "(3), "
  77. .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "