CURLOPT_PROXY_CRLFILE(3)

1CURLOPT_PROXY_CRLFILE(3)   curl_easy_setopt options   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
12       *file);
13

DESCRIPTION

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

DEFAULT

40       NULL
41

PROTOCOLS

43       Used with HTTPS proxy.
44

EXAMPLE

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

AVAILABILITY

56       Added in 7.52.0
57

RETURN VALUE

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