2014-06-18 19:18:58 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
.\" *
|
2023-01-02 20:51:48 +08:00
|
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
2014-06-18 19:18:58 +08:00
|
|
|
.\" *
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2020-11-04 21:02:01 +08:00
|
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
2014-06-18 19:18:58 +08:00
|
|
|
.\" *
|
|
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
|
|
.\" *
|
|
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
|
|
.\" * KIND, either express or implied.
|
|
|
|
.\" *
|
|
|
|
.\" * SPDX-License-Identifier: curl
|
2022-05-17 17:16:50 +08:00
|
|
|
.\" *
|
2014-06-18 19:18:58 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
.\"
|
2023-04-26 14:58:35 +08:00
|
|
|
.TH CURLOPT_CAINFO 3 "17 Jun 2014" libcurl libcurl
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH NAME
|
|
|
|
CURLOPT_CAINFO \- path to Certificate Authority (CA) bundle
|
|
|
|
.SH SYNOPSIS
|
2021-11-26 21:20:18 +08:00
|
|
|
.nf
|
2014-06-18 19:18:58 +08:00
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAINFO, char *path);
|
2021-11-26 21:20:18 +08:00
|
|
|
.fi
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH DESCRIPTION
|
2020-06-25 17:38:25 +08:00
|
|
|
Pass a char * to a null-terminated string naming a file holding one or more
|
2014-06-18 19:18:58 +08:00
|
|
|
certificates to verify the peer with.
|
|
|
|
|
|
|
|
If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the
|
|
|
|
server's certificate, \fICURLOPT_CAINFO(3)\fP need not even indicate an
|
|
|
|
accessible file.
|
|
|
|
|
2022-09-21 05:30:19 +08:00
|
|
|
This option is by default set to the system path where libcurl's CA
|
|
|
|
certificate bundle is assumed to be stored, as established at build time.
|
2014-06-18 19:18:58 +08:00
|
|
|
|
2019-06-10 15:10:14 +08:00
|
|
|
(iOS and macOS) When curl uses Secure Transport this option is supported. If
|
2023-08-22 23:40:39 +08:00
|
|
|
the option is not set, then curl uses the certificates in the system and user
|
|
|
|
Keychain to verify the peer.
|
2016-12-21 21:48:35 +08:00
|
|
|
|
2019-05-12 22:35:33 +08:00
|
|
|
(Schannel) This option is supported for Schannel in Windows 7 or later but we
|
|
|
|
recommend not using it until Windows 8 since it works better starting then.
|
2023-08-22 23:40:39 +08:00
|
|
|
If the option is not set, then curl uses the certificates in the Windows'
|
2019-06-10 15:10:14 +08:00
|
|
|
store of root certificates (the default for Schannel).
|
schannel: add support for CURLOPT_CAINFO
- Move verify_certificate functionality in schannel.c into a new
file called schannel_verify.c. Additionally, some structure defintions
from schannel.c have been moved to schannel.h to allow them to be
used in schannel_verify.c.
- Make verify_certificate functionality for Schannel available on
all versions of Windows instead of just Windows CE. verify_certificate
will be invoked on Windows CE or when the user specifies
CURLOPT_CAINFO and CURLOPT_SSL_VERIFYPEER.
- In verify_certificate, create a custom certificate chain engine that
exclusively trusts the certificate store backed by the CURLOPT_CAINFO
file.
- doc updates of --cacert/CAINFO support for schannel
- Use CERT_NAME_SEARCH_ALL_NAMES_FLAG when invoking CertGetNameString
when available. This implements a TODO in schannel.c to improve
handling of multiple SANs in a certificate. In particular, all SANs
will now be searched instead of just the first name.
- Update tool_operate.c to not search for the curl-ca-bundle.crt file
when using Schannel to maintain backward compatibility. Previously,
any curl-ca-bundle.crt file found in that search would have been
ignored by Schannel. But, with CAINFO support, the file found by
that search would have been used as the certificate store and
could cause issues for any users that have curl-ca-bundle.crt in
the search path.
- Update url.c to not set the build time CURL_CA_BUNDLE if the selected
SSL backend is Schannel. We allow setting CA location for schannel
only when explicitly specified by the user via CURLOPT_CAINFO /
--cacert.
- Add new test cases 3000 and 3001. These test cases check that the first
and last SAN, respectively, matches the connection hostname. New test
certificates have been added for these cases. For 3000, the certificate
prefix is Server-localhost-firstSAN and for 3001, the certificate
prefix is Server-localhost-secondSAN.
- Remove TODO 15.2 (Add support for custom server certificate
validation), this commit addresses it.
Closes https://github.com/curl/curl/pull/1325
2017-03-11 04:27:30 +08:00
|
|
|
|
2016-12-21 21:48:35 +08:00
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
option.
|
2022-05-23 14:42:23 +08:00
|
|
|
|
|
|
|
The default value for this can be figured out with \fICURLINFO_CAINFO(3)\fP.
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH DEFAULT
|
2019-06-10 15:10:14 +08:00
|
|
|
Built-in system specific. When curl is built with Secure Transport or
|
|
|
|
Schannel, this option is not set by default.
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH PROTOCOLS
|
2015-11-08 06:11:04 +08:00
|
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH EXAMPLE
|
2017-05-28 05:11:26 +08:00
|
|
|
.nf
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
if(curl) {
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
|
|
curl_easy_setopt(curl, CURLOPT_CAINFO, "/etc/certs/cabundle.pem");
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
}
|
|
|
|
.fi
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH AVAILABILITY
|
2022-09-22 23:07:09 +08:00
|
|
|
For the SSL engines that do not support certificate files the
|
|
|
|
\fICURLOPT_CAINFO(3)\fP option is ignored. Schannel support added in libcurl
|
|
|
|
7.60.
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH RETURN VALUE
|
2014-06-19 05:27:24 +08:00
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
2014-06-18 19:18:58 +08:00
|
|
|
.SH "SEE ALSO"
|
2020-07-13 09:17:56 +08:00
|
|
|
.BR CURLOPT_CAINFO_BLOB "(3), " CURLOPT_CAPATH "(3), "
|
2014-06-18 19:18:58 +08:00
|
|
|
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "
|
2022-11-22 17:38:16 +08:00
|
|
|
.BR CURLINFO_CAINFO "(3), " CURLOPT_CA_CACHE_TIMEOUT "(3), "
|