Return to CURLOPT_PROXY_SSL_VERIFYPEER.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYPEER.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2016, 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_SSL_VERIFYPEER 3 "December 16, 2016" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_PROXY_SSL_VERIFYPEER \- verify the proxy's SSL certificate
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYPEER, long verify);
                     31: .SH DESCRIPTION
                     32: Pass a long as parameter set to 1L to enable or 0L to disable.
                     33: 
                     34: This option tells curl to verifies the authenticity of the HTTPS proxy's
                     35: certificate. A value of 1 means curl verifies; 0 (zero) means it doesn't.
                     36: 
                     37: This is the proxy version of \fICURLOPT_SSL_VERIFYPEER(3)\fP that's used for
                     38: ordinary HTTPS servers.
                     39: 
                     40: When negotiating a TLS or SSL connection, the server sends a certificate
                     41: indicating its identity. Curl verifies whether the certificate is authentic,
                     42: i.e. that you can trust that the server is who the certificate says it is.
                     43: This trust is based on a chain of digital signatures, rooted in certification
                     44: authority (CA) certificates you supply.  curl uses a default bundle of CA
                     45: certificates (the path for that is determined at build time) and you can
                     46: specify alternate certificates with the \fICURLOPT_PROXY_CAINFO(3)\fP option
                     47: or the \fICURLOPT_PROXY_CAPATH(3)\fP option.
                     48: 
                     49: When \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is enabled, and the verification
                     50: fails to prove that the certificate is authentic, the connection fails.  When
                     51: the option is zero, the peer certificate verification succeeds regardless.
                     52: 
                     53: Authenticating the certificate is not enough to be sure about the server. You
                     54: typically also want to ensure that the server is the server you mean to be
                     55: talking to.  Use \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP for that. The check
                     56: that the host name in the certificate is valid for the host name you're
                     57: connecting to is done independently of the
                     58: \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option.
                     59: 
                     60: WARNING: disabling verification of the certificate allows bad guys to
                     61: man-in-the-middle the communication without you knowing it. Disabling
                     62: verification makes the communication insecure. Just having encryption on a
                     63: transfer is not enough as you cannot be sure that you are communicating with
                     64: the correct end-point.
                     65: .SH DEFAULT
                     66: 1
                     67: .SH PROTOCOLS
                     68: All
                     69: .SH EXAMPLE
                     70: .nf
                     71: CURL *curl = curl_easy_init();
                     72: if(curl) {
                     73:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
                     74: 
                     75:   /* Set the default value: strict certificate check please */
                     76:   curl_easy_setopt(curl, CURLOPT_PROXY_SSL_VERIFYPEER, 1L);
                     77: 
                     78:   curl_easy_perform(curl);
                     79: }
                     80: .fi
                     81: .SH AVAILABILITY
                     82: Added in 7.52.0
                     83: 
                     84: If built TLS enabled.
                     85: .SH RETURN VALUE
                     86: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     87: .SH "SEE ALSO"
                     88: .BR CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
                     89: .BR CURLOPT_SSL_VERIFYPEER "(3), "
                     90: .BR CURLOPT_SSL_VERIFYHOST "(3), "