docs/libcurl/opts/CURLOPT_CERTINFO.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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_CERTINFO 3 "May 27, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_CERTINFO \- request SSL certificate information
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CERTINFO, long certinfo);
  31 .SH DESCRIPTION
  32 Pass a long set to 1 to enable libcurl's certificate chain info gatherer. With
  33 this enabled, libcurl will extract lots of information and data about the
  34 certificates in the certificate chain used in the SSL connection. This data
  35 may then be retrieved after a transfer using \fIcurl_easy_getinfo(3)\fP and
  36 its option \fICURLINFO_CERTINFO(3)\fP.
  37 .SH DEFAULT
  38 0
  39 .SH PROTOCOLS
  40 All TLS-based
  41 .SH EXAMPLE
  42 .nf
  43 curl = curl_easy_init();
  44 if(curl) {
  45   curl_easy_setopt(curl, CURLOPT_URL, "https://www.example.com/");
  46
  47   /* connect to any HTTPS site, trusted or not */
  48   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
  49   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
  50
  51   curl_easy_setopt(curl, CURLOPT_CERTINFO, 1L);
  52
  53   res = curl_easy_perform(curl);
  54
  55   if (!res) {
  56     struct curl_certinfo *ci;
  57     res = curl_easy_getinfo(curl, CURLINFO_CERTINFO, &ci);
  58
  59     if (!res) {
  60       printf("%d certs!\\n", ci->num_of_certs);
  61
  62       for(i = 0; i < ci->num_of_certs; i++) {
  63         struct curl_slist *slist;
  64
  65         for(slist = ci->certinfo[i]; slist; slist = slist->next)
  66           printf("%s\\n", slist->data);
  67       }
  68     }
  69   }
  70   curl_easy_cleanup(curl);
  71 }
  72 .fi
  73 .SH AVAILABILITY
  74 This option is supported by the OpenSSL, GnuTLS, NSS and GSKit backends.
  75 .SH RETURN VALUE
  76 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  77 .SH "SEE ALSO"
  78 .BR CURLOPT_CAINFO "(3), " CURLOPT_SSL_VERIFYPEER "(3), "