| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, 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 "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 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAINFO, char *path); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a char * to a zero terminated string naming a file holding one or more |
| 32 |
certificates to verify the peer with. |
| 33 |
|
| 34 |
If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the |
| 35 |
server's certificate, \fICURLOPT_CAINFO(3)\fP need not even indicate an |
| 36 |
accessible file. |
| 37 |
|
| 38 |
This option is by default set to the system path where libcurl's cacert bundle |
| 39 |
is assumed to be stored, as established at build time. |
| 40 |
|
| 41 |
If curl is built against the NSS SSL library, the NSS PEM PKCS#11 module |
| 42 |
(libnsspem.so) needs to be available for this option to work properly. |
| 43 |
Starting with curl-7.55.0, if both \fICURLOPT_CAINFO(3)\fP and |
| 44 |
\fICURLOPT_CAPATH(3)\fP are unset, NSS-linked libcurl tries to load |
| 45 |
libnssckbi.so, which contains a more comprehensive set of trust information |
| 46 |
than supported by nss-pem, because libnssckbi.so also includes information |
| 47 |
about distrusted certificates. |
| 48 |
|
| 49 |
(iOS and macOS) When curl uses Secure Transport this option is supported. If |
| 50 |
the option is not set, then curl will use the certificates in the system and |
| 51 |
user Keychain to verify the peer. |
| 52 |
|
| 53 |
(Schannel) This option is supported for Schannel in Windows 7 or later but we |
| 54 |
recommend not using it until Windows 8 since it works better starting then. |
| 55 |
If the option is not set, then curl will use the certificates in the Windows' |
| 56 |
store of root certificates (the default for Schannel). |
| 57 |
|
| 58 |
The application does not have to keep the string around after setting this |
| 59 |
option. |
| 60 |
.SH DEFAULT |
| 61 |
Built-in system specific. When curl is built with Secure Transport or |
| 62 |
Schannel, this option is not set by default. |
| 63 |
.SH PROTOCOLS |
| 64 |
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. |
| 65 |
.SH EXAMPLE |
| 66 |
.nf |
| 67 |
CURL *curl = curl_easy_init(); |
| 68 |
if(curl) { |
| 69 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| 70 |
curl_easy_setopt(curl, CURLOPT_CAINFO, "/etc/certs/cabundle.pem"); |
| 71 |
ret = curl_easy_perform(curl); |
| 72 |
curl_easy_cleanup(curl); |
| 73 |
} |
| 74 |
.fi |
| 75 |
.SH AVAILABILITY |
| 76 |
For the SSL engines that don't support certificate files the CURLOPT_CAINFO |
| 77 |
option is ignored. Schannel support added in libcurl 7.60. |
| 78 |
.SH RETURN VALUE |
| 79 |
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
| 80 |
CURLE_OUT_OF_MEMORY if there was insufficient heap space. |
| 81 |
.SH "SEE ALSO" |
| 82 |
.BR CURLOPT_CAPATH "(3), " |
| 83 |
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), " |