docs/libcurl/opts/CURLOPT_CAINFO.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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 "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
  44 (iOS and macOS only) If curl is built against Secure Transport, then this
  45 option is supported for backward compatibility with other SSL engines, but it
  46 should not be set. If the option is not set, then curl will use the
  47 certificates in the system and user Keychain to verify the peer, which is the
  48 preferred method of verifying the peer's certificate chain.
  49
  50 The application does not have to keep the string around after setting this
  51 option.
  52 .SH DEFAULT
  53 Built-in system specific
  54 .SH PROTOCOLS
  55 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  56 .SH EXAMPLE
  57 TODO
  58 .SH AVAILABILITY
  59 For SSL engines that don't support certificate files the CURLOPT_CAINFO option
  60 is ignored. Refer to https://curl.haxx.se/docs/ssl-compared.html
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  63 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  64 .SH "SEE ALSO"
  65 .BR CURLOPT_CAPATH "(3), "
  66 .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "