docs/libcurl/opts/CURLOPT_CAINFO.3

   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 "May 27, 2017" "libcurl 7.59.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 only) If curl is built against Secure Transport, then this
  51 option is supported for backward compatibility with other SSL engines, but it
  52 should not be set. If the option is not set, then curl will use the
  53 certificates in the system and user Keychain to verify the peer, which is the
  54 preferred method of verifying the peer's certificate chain.
  55
  56 The application does not have to keep the string around after setting this
  57 option.
  58 .SH DEFAULT
  59 Built-in system specific
  60 .SH PROTOCOLS
  61 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  62 .SH EXAMPLE
  63 .nf
  64 CURL *curl = curl_easy_init();
  65 if(curl) {
  66   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  67   curl_easy_setopt(curl, CURLOPT_CAINFO, "/etc/certs/cabundle.pem");
  68   ret = curl_easy_perform(curl);
  69   curl_easy_cleanup(curl);
  70 }
  71 .fi
  72 .SH AVAILABILITY
  73 For SSL engines that don't support certificate files the CURLOPT_CAINFO option
  74 is ignored. Refer to https://curl.haxx.se/docs/ssl-compared.html
  75 .SH RETURN VALUE
  76 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  77 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  78 .SH "SEE ALSO"
  79 .BR CURLOPT_CAPATH "(3), "
  80 .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "