1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at https://curl.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLOPT_SSL_VERIFYPEER 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_SSL_VERIFYPEER \- verify the peer's SSL certificate
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYPEER, long verify);
- .fi
- .SH DESCRIPTION
- Pass a long as parameter to enable or disable.
- This option determines whether curl verifies the authenticity of the peer's
- certificate. A value of 1 means curl verifies; 0 (zero) means it does not.
- When negotiating a TLS or SSL connection, the server sends a certificate
- indicating its identity. Curl verifies whether the certificate is authentic,
- i.e. that you can trust that the server is who the certificate says it is.
- This trust is based on a chain of digital signatures, rooted in certification
- authority (CA) certificates you supply. curl uses a default bundle of CA
- certificates (the path for that is determined at build time) and you can
- specify alternate certificates with the \fICURLOPT_CAINFO(3)\fP option or the
- \fICURLOPT_CAPATH(3)\fP option.
- When \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled, and the verification fails to
- prove that the certificate is authentic, the connection fails. When the
- option is zero, the peer certificate verification succeeds regardless.
- Authenticating the certificate is not enough to be sure about the server. You
- typically also want to ensure that the server is the server you mean to be
- talking to. Use \fICURLOPT_SSL_VERIFYHOST(3)\fP for that. The check that the
- host name in the certificate is valid for the host name you are connecting to
- is done independently of the \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
- WARNING: disabling verification of the certificate allows bad guys to
- man-in-the-middle the communication without you knowing it. Disabling
- verification makes the communication insecure. Just having encryption on a
- transfer is not enough as you cannot be sure that you are communicating with
- the correct end-point.
- NOTE: even when this option is disabled, depending on the used TLS backend,
- curl may still load the certificate file specified in
- \fICURLOPT_CAINFO(3)\fP. curl default settings in some distributions might use
- quite a large file as a default setting for \fICURLOPT_CAINFO(3)\fP, so
- loading the file can be quite expensive, especially when dealing with many
- connections. Thus, in some situations, you might want to disable verification
- fully to save resources by setting \fICURLOPT_CAINFO(3)\fP to NULL - but
- please also consider the warning above!
- .SH DEFAULT
- By default, curl assumes a value of 1.
- .SH PROTOCOLS
- All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- /* Set the default value: strict certificate check please */
- curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L);
- curl_easy_perform(curl);
- }
- .fi
- .SH AVAILABILITY
- If built TLS enabled.
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH "SEE ALSO"
- .BR CURLOPT_SSL_VERIFYHOST "(3), "
- .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), "
- .BR CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
- .BR CURLOPT_CAINFO "(3), "
|