docs/libcurl/opts/CURLOPT_PROXY_CRLFILE.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_PROXY_CRLFILE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_PROXY_CRLFILE \- specify a proxy Certificate Revocation List file
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CRLFILE, char *file);
  31 .SH DESCRIPTION
  32 This option is for connecting to a HTTPS proxy, not a HTTPS server.
  33
  34 Pass a char * to a zero terminated string naming a \fIfile\fP with the
  35 concatenation of CRL (in PEM format) to use in the certificate validation that
  36 occurs during the SSL exchange.
  37
  38 When curl is built to use NSS or GnuTLS, there is no way to influence the use
  39 of CRL passed to help in the verification process. When libcurl is built with
  40 OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both
  41 set, requiring CRL check against all the elements of the certificate chain if
  42 a CRL file is passed.
  43
  44 This option makes sense only when used in combination with the
  45 \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option.
  46
  47 A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
  48 option. It is returned when the SSL exchange fails because the CRL file cannot
  49 be loaded.  A failure in certificate verification due to a revocation
  50 information found in the CRL does not trigger this specific error.
  51
  52 The application does not have to keep the string around after setting this
  53 option.
  54 .SH DEFAULT
  55 NULL
  56 .SH PROTOCOLS
  57 Used with HTTPS proxy.
  58 .SH EXAMPLE
  59 .nf
  60 CURL *curl = curl_easy_init();
  61 if(curl) {
  62   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  63   curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:80");
  64   curl_easy_setopt(curl, CURLOPT_PROXY_CRLFILE, "/etc/certs/crl.pem");
  65   ret = curl_easy_perform(curl);
  66   curl_easy_cleanup(curl);
  67 }
  68 .fi
  69 .SH AVAILABILITY
  70 Added in 7.52.0
  71 .SH RETURN VALUE
  72 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  73 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  74 .SH "SEE ALSO"
  75 .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
  76 .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "