CURLOPT_PROXY_CRLFILE(3)

1CURLOPT_PROXY_CRLFILE(3)            libcurl           CURLOPT_PROXY_CRLFILE(3)
2
3
4

NAME

6       CURLOPT_PROXY_CRLFILE - HTTPS proxy Certificate Revocation List file
7

SYNOPSIS

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

DESCRIPTION

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

DEFAULT

39       NULL
40

PROTOCOLS

42       Used with HTTPS proxy.
43

EXAMPLE

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

AVAILABILITY

55       Added in 7.52.0
56

RETURN VALUE

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