Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CAPATH.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, 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_CAPATH 3 "March 04, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
24:
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.
40:
41: The application does not have to keep the string around after setting this
42: option.
43: .SH DEFAULT
44: NULL
45: .SH PROTOCOLS
46: All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
47: .SH EXAMPLE
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
57: .SH AVAILABILITY
58: This option is supported by the OpenSSL, GnuTLS and mbedTLS (since 7.56.0)
59: backends. The NSS backend provides the option only for backward compatibility.
60: .SH RETURN VALUE
61: CURLE_OK if supported; or an error such as:
62:
63: CURLE_NOT_BUILT_IN - Not supported by the SSL backend
64:
65: CURLE_UNKNOWN_OPTION
66:
67: CURLE_OUT_OF_MEMORY
68: .SH "SEE ALSO"
69: .BR CURLOPT_CAINFO "(3), "
70: .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>