tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_SSL_VERIFYSTATUS.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_SSL_VERIFYSTATUS 3 "04 Dec 2014" "libcurl 7.40.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SSL_VERIFYSTATUS \- verify the certificate's status
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYSTATUS, long verify);
30 .SH DESCRIPTION
31 Pass a long as parameter to enable or disable.
32
33 This option determines whether libcurl verifies the status of the server cert
34 using the "Certificate Status Request" TLS extension (aka. OCSP stapling).
35
36 Note that if this option is enabled but the server does not support the TLS
37 extension, the verification will fail.
38
39 .SH DEFAULT
40 0
41 .SH PROTOCOLS
42 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3, SMTPS etc.
43 .SH EXAMPLE
44 TODO
45 .SH AVAILABILITY
46 This is currently only supported by the GnuTLS and NSS TLS backends.
47 .SH RETURN VALUE
48 Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise
49 returns CURLE_NOT_BUILT_IN.
50 .SH "SEE ALSO"
51 .BR CURLOPT_SSL_VERIFYHOST "(3), "
52 .BR CURLOPT_SSL_VERIFYPEER "(3), "
53 .BR CURLOPT_CAINFO "(3), "