first commit
This commit is contained in:
@@ -0,0 +1,90 @@
|
||||
.\" **************************************************************************
|
||||
.\" * _ _ ____ _
|
||||
.\" * Project ___| | | | _ \| |
|
||||
.\" * / __| | | | |_) | |
|
||||
.\" * | (__| |_| | _ <| |___
|
||||
.\" * \___|\___/|_| \_\_____|
|
||||
.\" *
|
||||
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <[email protected]>, 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_PROXY_SSL_VERIFYHOST 3 "November 04, 2020" "libcurl 7.75.0" "curl_easy_setopt options"
|
||||
|
||||
.SH NAME
|
||||
CURLOPT_PROXY_SSL_VERIFYHOST \- verify the proxy certificate's name against host
|
||||
.SH SYNOPSIS
|
||||
#include <curl/curl.h>
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYHOST, long verify);
|
||||
.SH DESCRIPTION
|
||||
Pass a long set to 2L as asking curl to \fIverify\fP in the HTTPS proxy's
|
||||
certificate name fields against the proxy name.
|
||||
|
||||
This option determines whether libcurl verifies that the proxy cert contains
|
||||
the correct name for the name it is known as.
|
||||
|
||||
When \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP is 2, the proxy certificate must
|
||||
indicate that the server is the proxy to which you meant to connect to, or the
|
||||
connection fails.
|
||||
|
||||
Curl considers the proxy the intended one when the Common Name field or a
|
||||
Subject Alternate Name field in the certificate matches the host name in the
|
||||
proxy string which you told curl to use.
|
||||
|
||||
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 0L, the connection succeeds regardless of the
|
||||
names used in the certificate. Use that ability with caution!
|
||||
|
||||
See also \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP to verify the digital signature
|
||||
of the proxy certificate. If libcurl is built against NSS and
|
||||
\fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is zero,
|
||||
\fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP is also set to zero and cannot be
|
||||
overridden.
|
||||
.SH DEFAULT
|
||||
2
|
||||
.SH PROTOCOLS
|
||||
All protocols when used over an HTTPS proxy.
|
||||
.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_PROXY_SSL_VERIFYHOST, 2L);
|
||||
|
||||
curl_easy_perform(curl);
|
||||
}
|
||||
.fi
|
||||
.SH AVAILABILITY
|
||||
Added in 7.52.0.
|
||||
|
||||
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_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_CAINFO "(3), "
|
||||
.BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_CAINFO "(3), "
|
||||
Reference in New Issue
Block a user