Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_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 CURLINFO_CERTINFO 3 "May 06, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_CERTINFO \- get the TLS certificate chain
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CERTINFO,
31                            struct curl_certinfo *chainp);
32 .SH DESCRIPTION
33 Pass a pointer to a 'struct curl_certinfo *' and you'll get it set to point to
34 struct that holds a number of linked lists with info about the certificate
35 chain, assuming you had \fICURLOPT_CERTINFO(3)\fP enabled when the request was
36 made. The struct reports how many certs it found and then you can extract info
37 for each of those certs by following the linked lists. The info chain is
38 provided in a series of data in the format "name:content" where the content is
39 for the specific named data. See also the certinfo.c example.
40 .SH PROTOCOLS
41 All TLS-based
42 .SH EXAMPLE
43 .nf
44 curl = curl_easy_init();
45 if(curl) {
46   curl_easy_setopt(curl, CURLOPT_URL, "https://www.example.com/");
47
48   /* connect to any HTTPS site, trusted or not */
49   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
50   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
51
52   curl_easy_setopt(curl, CURLOPT_CERTINFO, 1L);
53
54   res = curl_easy_perform(curl);
55
56   if (!res) {
57     struct curl_certinfo *ci;
58     res = curl_easy_getinfo(curl, CURLINFO_CERTINFO, &ci);
59
60     if (!res) {
61       printf("%d certs!\\n", ci->num_of_certs);
62
63       for(i = 0; i < ci->num_of_certs; i++) {
64         struct curl_slist *slist;
65
66         for(slist = ci->certinfo[i]; slist; slist = slist->next)
67           printf("%s\\n", slist->data);
68       }
69     }
70   }
71   curl_easy_cleanup(curl);
72 }
73 .fi
74 .SH AVAILABILITY
75 This option is only working in libcurl built with OpenSSL, NSS, schannel or
76 GSKit support. schannel support added in 7.50.0
77
78 Added in 7.19.1
79 .SH RETURN VALUE
80 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
81 .SH "SEE ALSO"
82 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "