CURLOPT_CAINFO.3 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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_CAINFO 3 "17 Jun 2014" "libcurl 7.37.0" "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 null-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) When curl uses Secure Transport this option is supported. If
  45. the option is not set, then curl will use the certificates in the system and
  46. user Keychain to verify the peer.
  47. (Schannel) This option is supported for Schannel in Windows 7 or later but we
  48. recommend not using it until Windows 8 since it works better starting then.
  49. If the option is not set, then curl will use the certificates in the Windows'
  50. store of root certificates (the default for Schannel).
  51. The application does not have to keep the string around after setting this
  52. option.
  53. .SH DEFAULT
  54. Built-in system specific. When curl is built with Secure Transport or
  55. Schannel, this option is not set by default.
  56. .SH PROTOCOLS
  57. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  58. .SH EXAMPLE
  59. .nf
  60. CURL *curl = curl_easy_init();
  61. if(curl) {
  62. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  63. curl_easy_setopt(curl, CURLOPT_CAINFO, "/etc/certs/cabundle.pem");
  64. ret = curl_easy_perform(curl);
  65. curl_easy_cleanup(curl);
  66. }
  67. .fi
  68. .SH AVAILABILITY
  69. For the SSL engines that don't support certificate files the CURLOPT_CAINFO
  70. option is ignored. Schannel support added in libcurl 7.60.
  71. .SH RETURN VALUE
  72. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  73. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  74. .SH "SEE ALSO"
  75. .BR CURLOPT_CAINFO_BLOB "(3), " CURLOPT_CAPATH "(3), "
  76. .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "