| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- .\" generated by cd2nroff 0.1 from CURLOPT_PROXY_SSL_VERIFYHOST.md
- .TH CURLOPT_PROXY_SSL_VERIFYHOST 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_PROXY_SSL_VERIFYHOST \- verify the proxy certificate\(aqs name against host
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSL_VERIFYHOST,
- long verify);
- .fi
- .SH DESCRIPTION
- Pass a long set to 2L as asking curl to \fIverify\fP in the HTTPS proxy\(aqs
- 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 hostname 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 \fIcurl_easy_setopt(3)\fP 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.
- .SH DEFAULT
- 2
- .SH PROTOCOLS
- This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
- All TLS backends support this option.
- .SH EXAMPLE
- .nf
- int main(void)
- {
- 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 curl 7.52.0
- .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_CAINFO (3),
- .BR CURLOPT_PROXY_CAINFO (3),
- .BR CURLOPT_PROXY_SSL_VERIFYPEER (3),
- .BR CURLOPT_SSL_VERIFYPEER (3)
|