Return to CURLOPT_PROXY_CAINFO.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_CAINFO.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_PROXY_CAINFO 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_PROXY_CAINFO \- path to proxy Certificate Authority (CA) bundle
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAINFO, char *path);
                     31: .SH DESCRIPTION
                     32: This option is for connecting to an HTTPS proxy, not an HTTPS server.
                     33: 
                     34: Pass a char * to a zero terminated string naming a file holding one or more
                     35: certificates to verify the HTTPS proxy with.
                     36: 
                     37: If \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the
                     38: server's certificate, \fICURLOPT_PROXY_CAINFO(3)\fP need not even indicate an
                     39: accessible file.
                     40: 
                     41: This option is by default set to the system path where libcurl's cacert bundle
                     42: is assumed to be stored, as established at build time.
                     43: 
                     44: If curl is built against the NSS SSL library, the NSS PEM PKCS#11 module
                     45: (libnsspem.so) needs to be available for this option to work properly.
                     46: 
                     47: (iOS and macOS only) If curl is built against Secure Transport, then this
                     48: option is supported for backward compatibility with other SSL engines, but it
                     49: should not be set. If the option is not set, then curl will use the
                     50: certificates in the system and user Keychain to verify the peer, which is the
                     51: preferred method of verifying the peer's certificate chain.
                     52: 
                     53: The application does not have to keep the string around after setting this
                     54: option.
                     55: .SH DEFAULT
                     56: Built-in system specific
                     57: .SH PROTOCOLS
                     58: Used with HTTPS proxy
                     59: .SH EXAMPLE
                     60: .nf
                     61: CURL *curl = curl_easy_init();
                     62: if(curl) {
                     63:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
                     64:   /* using an HTTPS proxy */
                     65:   curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:443");
                     66:   curl_easy_setopt(curl, CURLOPT_PROXY_CAINFO, "/etc/certs/cabundle.pem");
                     67:   ret = curl_easy_perform(curl);
                     68:   curl_easy_cleanup(curl);
                     69: }
                     70: .fi
                     71: .SH AVAILABILITY
                     72: Added in 7.52.0
                     73: 
                     74: For TLS backends that don't support certificate files, the
                     75: \fICURLOPT_PROXY_CAINFO(3)\fP option is ignored. Refer to
                     76: https://curl.haxx.se/docs/ssl-compared.html
                     77: .SH RETURN VALUE
                     78: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
                     79: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
                     80: .SH "SEE ALSO"
                     81: .BR CURLOPT_PROXY_CAPATH "(3), "
                     82: .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
                     83: .BR CURLOPT_CAPATH "(3), "
                     84: .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "