blob: 119a2e34b0daf1f8284fd3e95478a39e312dc3a1 [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
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 Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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 Huang445085a2019-09-11 13:33:50 -070023.TH CURLOPT_CAPATH 3 "September 10, 2017" "libcurl 7.66.0" "curl_easy_setopt options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070025.SH NAME
26CURLOPT_CAPATH \- specify directory holding CA certificates
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAPATH, char *capath);
31.SH DESCRIPTION
32Pass a char * to a zero terminated string naming a directory holding multiple
33CA certificates to verify the peer with. If libcurl is built against OpenSSL,
34the certificate directory must be prepared using the openssl c_rehash utility.
35This makes sense only when used in combination with the
36\fICURLOPT_SSL_VERIFYPEER(3)\fP option.
37
38The \fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due
39to some limitation in openssl.
Elliott Hughes82be86d2017-09-20 17:00:17 -070040
41The application does not have to keep the string around after setting this
42option.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070043.SH DEFAULT
44NULL
45.SH PROTOCOLS
Alex Deymo8f1a2142016-06-28 14:49:26 -070046All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070047.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070048.nf
49CURL *curl = curl_easy_init();
50if(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 SIMONNETe6cd7382015-07-01 15:39:44 -070057.SH AVAILABILITY
Alex Deymo486467e2017-12-19 19:04:07 +010058This option is supported by the OpenSSL, GnuTLS, PolarSSL and mbedTLS
59(since 7.56.0) backends. The NSS backend provides the option only for
60backward compatibility.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070061.SH RETURN VALUE
Elliott Hughes82be86d2017-09-20 17:00:17 -070062CURLE_OK if supported; or an error such as:
63
64CURLE_NOT_BUILT_IN - Not supported by the SSL backend
65
66CURLE_UNKNOWN_OPTION
67
68CURLE_OUT_OF_MEMORY
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070069.SH "SEE ALSO"
70.BR CURLOPT_CAINFO "(3), "
71.BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "