2
0
mirror of https://github.com/curl/curl.git synced 2025-02-17 14:59:45 +08:00
curl/docs/libcurl/opts/CURLINFO_SSL_VERIFYRESULT.md
Daniel Stenberg b935fd4a07
docs: make each libcurl man specify protocol(s)
The mandatory header now has a mandatory list of protocols for which the
manpage is relevant.

Most man pages already has a "PROTOCOLS" section, but this introduces a
stricter way to specify the relevant protocols.

cd2nroff verifies that at least one protocol is mentioned (which can be
`*`).

This information is not used just yet, but A) the PROTOCOLS section can
now instead get generated and get a unified wording across all manpages
and B) this allows us to more reliably filter/search for protocol
specific manpages/options.

Closes 
2024-03-21 15:27:06 +01:00

1.4 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLINFO_SSL_VERIFYRESULT 3 libcurl
CURLINFO_PROXY_SSL_VERIFYRESULT (3)
curl_easy_getinfo (3)
curl_easy_setopt (3)
TLS

NAME

CURLINFO_SSL_VERIFYRESULT - get the result of the certificate verification

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SSL_VERIFYRESULT,
                           long *result);

DESCRIPTION

Pass a pointer to a long to receive the result of the server SSL certificate verification that was requested (using the CURLOPT_SSL_VERIFYPEER(3) option).

0 is a positive result. Non-zero is an error.

PROTOCOLS

All using TLS

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    long verifyresult;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    res = curl_easy_perform(curl);
    if(res)
      printf("error: %s\n", curl_easy_strerror(res));
    curl_easy_getinfo(curl, CURLINFO_SSL_VERIFYRESULT, &verifyresult);
    printf("The peer verification said %s\n", verifyresult?
           "BAAAD":"fine");
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in 7.5. Only set by the OpenSSL/libressl/boringssl and GnuTLS backends.

RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.