mirror of
https://github.com/moparisthebest/curl
synced 2024-11-17 15:05:02 -05:00
6a90c9e0c4
For a long time (since 7.28.1) we've returned error when setting the value to 1 to make applications notice that we stopped supported the old behavior for 1. Starting now, we treat 1 and 2 exactly the same. Closes #4241
99 lines
3.8 KiB
Groff
99 lines
3.8 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2019, 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.haxx.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_VERIFYHOST 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_SSL_VERIFYHOST \- verify the certificate's name against host
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYHOST, long verify);
|
|
.SH DESCRIPTION
|
|
Pass a long as parameter specifying what to \fIverify\fP.
|
|
|
|
This option determines whether libcurl verifies that the server cert is for
|
|
the server it is known as.
|
|
|
|
When negotiating TLS and SSL connections, the server sends a certificate
|
|
indicating its identity.
|
|
|
|
When \fICURLOPT_SSL_VERIFYHOST(3)\fP is 2, that certificate must indicate that
|
|
the server is the server to which you meant to connect, or the connection
|
|
fails. Simply put, it means it has to have the same name in the certificate as
|
|
is in the URL you operate against.
|
|
|
|
Curl considers the server the intended one when the Common Name field or a
|
|
Subject Alternate Name field in the certificate matches the host name in the
|
|
URL to which you told Curl to connect.
|
|
|
|
If \fIverify\fP value is set to 1:
|
|
|
|
In 7.28.0 and earlier: treated as a debug option of some sorts, not supported
|
|
anymore due to frequently leading to programmer mistakes.
|
|
|
|
From 7.28.1 to 7.65.3: setting it to 1 made curl_easy_setopt() return an error
|
|
and leaving the flag untouched.
|
|
|
|
From 7.66.0: treats 1 and 2 the same.
|
|
|
|
When the \fIverify\fP value is 0, the connection succeeds regardless of the
|
|
names in the certificate. Use that ability with caution!
|
|
|
|
The default value for this option is 2.
|
|
|
|
This option controls checking the server's certificate's claimed identity.
|
|
The server could be lying. To control lying, see
|
|
\fICURLOPT_SSL_VERIFYPEER(3)\fP.
|
|
.SH LIMITATIONS
|
|
DarwinSSL: If \fIverify\fP value is 0, then SNI is also disabled. SNI is a TLS
|
|
extension that sends the hostname to the server. The server may use that
|
|
information to do such things as sending back a specific certificate for the
|
|
hostname, or forwarding the request to a specific origin server. Some hostnames
|
|
may be inaccessible if SNI is not sent.
|
|
|
|
NSS: If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero,
|
|
\fICURLOPT_SSL_VERIFYHOST(3)\fP is also set to zero and cannot be overridden.
|
|
.SH DEFAULT
|
|
2
|
|
.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 name check please */
|
|
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L);
|
|
|
|
curl_easy_perform(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
If built TLS enabled.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
If 1 is set as argument, \fICURLE_BAD_FUNCTION_ARGUMENT\fP is returned.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_CAINFO "(3), "
|