docs/libcurl/opts/CURLOPT_CRLFILE.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_CRLFILE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_CRLFILE \- specify a Certificate Revocation List file
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLFILE, char *file);
  30 .SH DESCRIPTION
  31 Pass a char * to a zero terminated string naming a \fIfile\fP with the
  32 concatenation of CRL (in PEM format) to use in the certificate validation that
  33 occurs during the SSL exchange.
  34
  35 When curl is built to use NSS or GnuTLS, there is no way to influence the use
  36 of CRL passed to help in the verification process. When libcurl is built with
  37 OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both
  38 set, requiring CRL check against all the elements of the certificate chain if
  39 a CRL file is passed.
  40
  41 This option makes sense only when used in combination with the
  42 \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
  43
  44 A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
  45 option. It is returned when the SSL exchange fails because the CRL file cannot
  46 be loaded.  A failure in certificate verification due to a revocation
  47 information found in the CRL does not trigger this specific error.
  48 .SH DEFAULT
  49 NULL
  50 .SH PROTOCOLS
  51 All TLS-based protocols
  52 .SH EXAMPLE
  53 TODO
  54 .SH AVAILABILITY
  55 Added in 7.19.0
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  58 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  59 .SH "SEE ALSO"
  60 .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "