8c01711dd56145c28b870ea3e698f04039a81fc8
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_CERTINFO.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_CERTINFO \- request SSL certificate information
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CERTINFO, long certinfo);
30 .SH DESCRIPTION
31 Pass a long set to 1 to enable libcurl's certificate chain info gatherer. With
32 this enabled, libcurl (if built with OpenSSL, NSS or GSKit) will
33 extract lots of information and data about the certificates in the certificate
34 chain used in the SSL connection. This data may then be retrieved after a
35 transfer using \fIcurl_easy_getinfo(3)\fP and its option
36 \fICURLINFO_CERTINFO\fP.
37 .SH DEFAULT
38 0
39 .SH PROTOCOLS
40 All TLS-based
41 .SH EXAMPLE
42 TODO
43 .SH AVAILABILITY
44 Added in 7.19.1
45 .SH RETURN VALUE
46 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
47 .SH "SEE ALSO"
48 .BR CURLOPT_CAINFO "(3), " CURLOPT_SSL_VERIFYPEER "(3), "