Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_CAPATH (3)

Name

CURLOPT_CAPATH - directory holding CA certificates

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath);

Description

CURLOPT_CAPATH(3)          curl_easy_setopt options          CURLOPT_CAPATH(3)



NAME
       CURLOPT_CAPATH - directory holding CA certificates

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath);

DESCRIPTION
       Pass  a  char  * to a null-terminated string naming a directory holding
       multiple CA certificates to verify the peer with. If libcurl  is  built
       against  OpenSSL,  the certificate directory must be prepared using the
       openssl c_rehash utility.  This makes sense only when used in  combina-
       tion with the CURLOPT_SSL_VERIFYPEER(3) option.

       The  CURLOPT_CAPATH(3) function apparently does not work in Windows due
       to some limitation in openssl.

       The application does not have to keep the string around  after  setting
       this option.

DEFAULT
       A default path detected at build time.

PROTOCOLS
       All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_CAPATH, "/etc/cert-dir");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       This  option  is  supported  by  the OpenSSL, GnuTLS and mbedTLS (since
       7.56.0) backends. The NSS backend provides the option only for backward
       compatibility.

RETURN VALUE
       CURLE_OK if supported; or an error such as:

       CURLE_NOT_BUILT_IN - Not supported by the SSL backend

       CURLE_UNKNOWN_OPTION

       CURLE_OUT_OF_MEMORY


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_CAINFO(3), CURLOPT_STDERR(3), CURLOPT_DEBUGFUNCTION(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021             CURLOPT_CAPATH(3)