Return to CURLOPT_CAINFO.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CAINFO.3, revision 1.1.1.1

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