Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 1 | .\" ************************************************************************** |
| 2 | .\" * _ _ ____ _ |
| 3 | .\" * Project ___| | | | _ \| | |
| 4 | .\" * / __| | | | |_) | | |
| 5 | .\" * | (__| |_| | _ <| |___ |
| 6 | .\" * \___|\___/|_| \_\_____| |
| 7 | .\" * |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 8 | .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 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 |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 12 | .\" * are also available at https://curl.haxx.se/docs/copyright.html. |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 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 | .\" |
Haibo Huang | 445085a | 2019-09-11 13:33:50 -0700 | [diff] [blame^] | 23 | .TH CURLOPT_CAPATH 3 "September 10, 2017" "libcurl 7.66.0" "curl_easy_setopt options" |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 24 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 25 | .SH NAME |
| 26 | CURLOPT_CAPATH \- specify directory holding CA certificates |
| 27 | .SH SYNOPSIS |
| 28 | #include <curl/curl.h> |
| 29 | |
| 30 | CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath); |
| 31 | .SH DESCRIPTION |
| 32 | Pass a char * to a zero terminated string naming a directory holding multiple |
| 33 | CA certificates to verify the peer with. If libcurl is built against OpenSSL, |
| 34 | the certificate directory must be prepared using the openssl c_rehash utility. |
| 35 | This makes sense only when used in combination with the |
| 36 | \fICURLOPT_SSL_VERIFYPEER(3)\fP option. |
| 37 | |
| 38 | The \fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due |
| 39 | to some limitation in openssl. |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 40 | |
| 41 | The application does not have to keep the string around after setting this |
| 42 | option. |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 43 | .SH DEFAULT |
| 44 | NULL |
| 45 | .SH PROTOCOLS |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 46 | All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 47 | .SH EXAMPLE |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 48 | .nf |
| 49 | CURL *curl = curl_easy_init(); |
| 50 | if(curl) { |
| 51 | curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| 52 | curl_easy_setopt(curl, CURLOPT_CAPATH, "/etc/cert-dir"); |
| 53 | ret = curl_easy_perform(curl); |
| 54 | curl_easy_cleanup(curl); |
| 55 | } |
| 56 | .fi |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 57 | .SH AVAILABILITY |
Alex Deymo | 486467e | 2017-12-19 19:04:07 +0100 | [diff] [blame] | 58 | This option is supported by the OpenSSL, GnuTLS, PolarSSL and mbedTLS |
| 59 | (since 7.56.0) backends. The NSS backend provides the option only for |
| 60 | backward compatibility. |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 61 | .SH RETURN VALUE |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 62 | CURLE_OK if supported; or an error such as: |
| 63 | |
| 64 | CURLE_NOT_BUILT_IN - Not supported by the SSL backend |
| 65 | |
| 66 | CURLE_UNKNOWN_OPTION |
| 67 | |
| 68 | CURLE_OUT_OF_MEMORY |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 69 | .SH "SEE ALSO" |
| 70 | .BR CURLOPT_CAINFO "(3), " |
| 71 | .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), " |