| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, 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_SSL_VERIFYPEER 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_SSL_VERIFYPEER \- verify the peer's SSL certificate |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYPEER, long verify); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long as parameter to enable or disable. |
| 32 |
|
| 33 |
This option determines whether curl verifies the authenticity of the peer's |
| 34 |
certificate. A value of 1 means curl verifies; 0 (zero) means it doesn't. |
| 35 |
|
| 36 |
When negotiating a TLS or SSL connection, the server sends a certificate |
| 37 |
indicating its identity. Curl verifies whether the certificate is authentic, |
| 38 |
i.e. that you can trust that the server is who the certificate says it is. |
| 39 |
This trust is based on a chain of digital signatures, rooted in certification |
| 40 |
authority (CA) certificates you supply. curl uses a default bundle of CA |
| 41 |
certificates (the path for that is determined at build time) and you can |
| 42 |
specify alternate certificates with the \fICURLOPT_CAINFO(3)\fP option or the |
| 43 |
\fICURLOPT_CAPATH(3)\fP option. |
| 44 |
|
| 45 |
When \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled, and the verification fails to |
| 46 |
prove that the certificate is authentic, the connection fails. When the |
| 47 |
option is zero, the peer certificate verification succeeds regardless. |
| 48 |
|
| 49 |
Authenticating the certificate is not enough to be sure about the server. You |
| 50 |
typically also want to ensure that the server is the server you mean to be |
| 51 |
talking to. Use \fICURLOPT_SSL_VERIFYHOST(3)\fP for that. The check that the |
| 52 |
host name in the certificate is valid for the host name you're connecting to |
| 53 |
is done independently of the \fICURLOPT_SSL_VERIFYPEER(3)\fP option. |
| 54 |
|
| 55 |
WARNING: disabling verification of the certificate allows bad guys to |
| 56 |
man-in-the-middle the communication without you knowing it. Disabling |
| 57 |
verification makes the communication insecure. Just having encryption on a |
| 58 |
transfer is not enough as you cannot be sure that you are communicating with |
| 59 |
the correct end-point. |
| 60 |
|
| 61 |
NOTE: even when this option is disabled, depending on the used TLS backend, |
| 62 |
curl may still load the certificate file specified in |
| 63 |
\fICURLOPT_CAINFO(3)\fP. curl default settings in some distributions might use |
| 64 |
quite a large file as a default setting for \fICURLOPT_CAINFO(3)\fP, so |
| 65 |
loading the file can be quite expensive, especially when dealing with many |
| 66 |
connections. Thus, in some situations, you might want to disable verification |
| 67 |
fully to save resources by setting \fICURLOPT_CAINFO(3)\fP to NULL - but |
| 68 |
please also consider the warning above! |
| 69 |
.SH DEFAULT |
| 70 |
By default, curl assumes a value of 1. |
| 71 |
.SH PROTOCOLS |
| 72 |
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. |
| 73 |
.SH EXAMPLE |
| 74 |
.nf |
| 75 |
CURL *curl = curl_easy_init(); |
| 76 |
if(curl) { |
| 77 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); |
| 78 |
|
| 79 |
/* Set the default value: strict certificate check please */ |
| 80 |
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L); |
| 81 |
|
| 82 |
curl_easy_perform(curl); |
| 83 |
} |
| 84 |
.fi |
| 85 |
.SH AVAILABILITY |
| 86 |
If built TLS enabled. |
| 87 |
.SH RETURN VALUE |
| 88 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 89 |
.SH "SEE ALSO" |
| 90 |
.BR CURLOPT_SSL_VERIFYHOST "(3), " |
| 91 |
.BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " |
| 92 |
.BR CURLOPT_PROXY_SSL_VERIFYHOST "(3), " |
| 93 |
.BR CURLOPT_CAINFO "(3), " |