| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2019, 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_VERIFYHOST 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_SSL_VERIFYHOST \- verify the certificate's name against host |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYHOST, long verify); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long as parameter specifying what to \fIverify\fP. |
| 32 |
|
| 33 |
This option determines whether libcurl verifies that the server cert is for |
| 34 |
the server it is known as. |
| 35 |
|
| 36 |
When negotiating TLS and SSL connections, the server sends a certificate |
| 37 |
indicating its identity. |
| 38 |
|
| 39 |
When \fICURLOPT_SSL_VERIFYHOST(3)\fP is 2, that certificate must indicate that |
| 40 |
the server is the server to which you meant to connect, or the connection |
| 41 |
fails. Simply put, it means it has to have the same name in the certificate as |
| 42 |
is in the URL you operate against. |
| 43 |
|
| 44 |
Curl considers the server the intended one when the Common Name field or a |
| 45 |
Subject Alternate Name field in the certificate matches the host name in the |
| 46 |
URL to which you told Curl to connect. |
| 47 |
|
| 48 |
If \fIverify\fP value is set to 1: |
| 49 |
|
| 50 |
In 7.28.0 and earlier: treated as a debug option of some sorts, not supported |
| 51 |
anymore due to frequently leading to programmer mistakes. |
| 52 |
|
| 53 |
From 7.28.1 to 7.65.3: setting it to 1 made curl_easy_setopt() return an error |
| 54 |
and leaving the flag untouched. |
| 55 |
|
| 56 |
From 7.66.0: treats 1 and 2 the same. |
| 57 |
|
| 58 |
When the \fIverify\fP value is 0, the connection succeeds regardless of the |
| 59 |
names in the certificate. Use that ability with caution! |
| 60 |
|
| 61 |
The default value for this option is 2. |
| 62 |
|
| 63 |
This option controls checking the server's certificate's claimed identity. |
| 64 |
The server could be lying. To control lying, see |
| 65 |
\fICURLOPT_SSL_VERIFYPEER(3)\fP. |
| 66 |
.SH LIMITATIONS |
| 67 |
DarwinSSL: If \fIverify\fP value is 0, then SNI is also disabled. SNI is a TLS |
| 68 |
extension that sends the hostname to the server. The server may use that |
| 69 |
information to do such things as sending back a specific certificate for the |
| 70 |
hostname, or forwarding the request to a specific origin server. Some hostnames |
| 71 |
may be inaccessible if SNI is not sent. |
| 72 |
|
| 73 |
NSS: If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero, |
| 74 |
\fICURLOPT_SSL_VERIFYHOST(3)\fP is also set to zero and cannot be overridden. |
| 75 |
.SH DEFAULT |
| 76 |
2 |
| 77 |
.SH PROTOCOLS |
| 78 |
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc. |
| 79 |
.SH EXAMPLE |
| 80 |
.nf |
| 81 |
CURL *curl = curl_easy_init(); |
| 82 |
if(curl) { |
| 83 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); |
| 84 |
|
| 85 |
/* Set the default value: strict name check please */ |
| 86 |
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L); |
| 87 |
|
| 88 |
curl_easy_perform(curl); |
| 89 |
} |
| 90 |
.fi |
| 91 |
.SH AVAILABILITY |
| 92 |
If built TLS enabled. |
| 93 |
.SH RETURN VALUE |
| 94 |
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not. |
| 95 |
|
| 96 |
If 1 is set as argument, \fICURLE_BAD_FUNCTION_ARGUMENT\fP is returned. |
| 97 |
.SH "SEE ALSO" |
| 98 |
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_CAINFO "(3), " |