CURLOPT_PROXY_CRLFILE(3)

1CURLOPT_PROXY_CRLFILE(3)   curl_easy_setopt options   CURLOPT_PROXY_CRLFILE(3)
2
3
4

NAME

6       CURLOPT_PROXY_CRLFILE  -  specify  a  proxy Certificate Revocation List
7       file
8

SYNOPSIS

10       #include <curl/curl.h>
11
12       CURLcode  curl_easy_setopt(CURL  *handle,  CURLOPT_PROXY_CRLFILE,  char
13       *file);
14

DESCRIPTION

16       This option is for connecting to an HTTPS proxy, not an HTTPS server.
17
18       Pass  a  char * to a zero terminated string naming a file with the con‐
19       catenation of CRL (in PEM format) to use in the certificate  validation
20       that occurs during the SSL exchange.
21
22       When  curl  is built to use NSS or GnuTLS, there is no way to influence
23       the use of CRL passed to help in the verification process. When libcurl
24       is    built    with    OpenSSL   support,   X509_V_FLAG_CRL_CHECK   and
25       X509_V_FLAG_CRL_CHECK_ALL are both set, requiring CRL check against all
26       the elements of the certificate chain if a CRL file is passed.
27
28       This  option  makes  sense  only when used in combination with the CUR‐
29       LOPT_PROXY_SSL_VERIFYPEER(3) option.
30
31       A specific error  code  (CURLE_SSL_CRL_BADFILE)  is  defined  with  the
32       option. It is returned when the SSL exchange fails because the CRL file
33       cannot be loaded.  A failure in certificate verification due to a revo‐
34       cation  information  found  in  the  CRL does not trigger this specific
35       error.
36
37       The application does not have to keep the string around  after  setting
38       this option.
39

DEFAULT

41       NULL
42

PROTOCOLS

44       Used with HTTPS proxy.
45

EXAMPLE

47       CURL *curl = curl_easy_init();
48       if(curl) {
49         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
50         curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:80");
51         curl_easy_setopt(curl, CURLOPT_PROXY_CRLFILE, "/etc/certs/crl.pem");
52         ret = curl_easy_perform(curl);
53         curl_easy_cleanup(curl);
54       }
55

AVAILABILITY

57       Added in 7.52.0
58

RETURN VALUE

60       Returns  CURLE_OK  if  the option is supported, CURLE_UNKNOWN_OPTION if
61       not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
62