Return to CURLOPT_SSL_VERIFYHOST.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSL_VERIFYHOST.3, revision 1.1.1.1

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