2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_CRLFILE.md
|
2024-08-02 19:52:59 -06:00
|
|
|
.TH CURLOPT_CRLFILE 3 "2024-08-02" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_CRLFILE \- Certificate Revocation List file
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLFILE, char *file);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a char pointer to a null\-terminated string naming a \fIfile\fP with the
|
|
|
|
|
concatenation of CRL (in PEM format) to use in the certificate validation that
|
|
|
|
|
occurs during the SSL exchange.
|
|
|
|
|
|
|
|
|
|
When curl is built to use GnuTLS, there is no way to influence the use of CRL
|
|
|
|
|
passed to help in the verification process.
|
|
|
|
|
|
|
|
|
|
When libcurl is built with OpenSSL support, X509_V_FLAG_CRL_CHECK and
|
|
|
|
|
X509_V_FLAG_CRL_CHECK_ALL are both set, requiring CRL check against all the
|
|
|
|
|
elements of the certificate chain if a CRL file is passed. Also note that
|
|
|
|
|
\fICURLOPT_CRLFILE(3)\fP implies \fBCURLSSLOPT_NO_PARTIALCHAIN\fP (see
|
|
|
|
|
\fICURLOPT_SSL_OPTIONS(3)\fP) since curl 7.71.0 due to an OpenSSL bug.
|
|
|
|
|
|
|
|
|
|
This option makes sense only when used in combination with the
|
|
|
|
|
\fICURLOPT_SSL_VERIFYPEER(3)\fP option.
|
|
|
|
|
|
|
|
|
|
A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the option. It
|
|
|
|
|
is returned when the SSL exchange fails because the CRL file cannot be
|
|
|
|
|
loaded. A failure in certificate verification due to a revocation information
|
|
|
|
|
found in the CRL does not trigger this specific error.
|
|
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
2024-03-30 12:28:04 -06:00
|
|
|
|
|
|
|
|
This option works only with the following TLS backends:
|
|
|
|
|
GnuTLS, OpenSSL and mbedTLS
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
|
|
|
|
CURLcode res;
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_CRLFILE, "/etc/certs/crl.pem");
|
|
|
|
|
res = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.19.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_PROXY_CRLFILE (3),
|
|
|
|
|
.BR CURLOPT_SSL_VERIFYHOST (3),
|
|
|
|
|
.BR CURLOPT_SSL_VERIFYPEER (3)
|
