docs/libcurl/opts/CURLOPT_SSL_VERIFYSTATUS.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_SSL_VERIFYSTATUS 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSL_VERIFYSTATUS \- verify the certificate's status
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYSTATUS, long verify);
  31 .SH DESCRIPTION
  32 Pass a long as parameter set to 1 to enable or 0 to disable.
  33
  34 This option determines whether libcurl verifies the status of the server cert
  35 using the "Certificate Status Request" TLS extension (aka. OCSP stapling).
  36
  37 Note that if this option is enabled but the server does not support the TLS
  38 extension, the verification will fail.
  39 .SH DEFAULT
  40 0
  41 .SH PROTOCOLS
  42 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  43 .SH EXAMPLE
  44 .nf
  45 CURL *curl = curl_easy_init();
  46 if(curl) {
  47   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  48   /* ask for OSCP stapling! */
  49   curl_easy_setopt(curl, CURLOPT_SSL_VERIFYSTATUS, 1L);
  50   ret = curl_easy_perform(curl);
  51   curl_easy_cleanup(curl);
  52 }
  53 .fi
  54 .SH AVAILABILITY
  55 Added in 7.41.0. This option is currently only supported by the OpenSSL, GnuTLS
  56 and NSS TLS backends.
  57 .SH RETURN VALUE
  58 Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise
  59 returns CURLE_NOT_BUILT_IN.
  60 .SH "SEE ALSO"
  61 .BR CURLOPT_SSL_VERIFYHOST "(3), "
  62 .BR CURLOPT_SSL_VERIFYPEER "(3), "
  63 .BR CURLOPT_CAINFO "(3), "