| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at https://curl.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_CRLFILE 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_CRLFILE \- specify a Certificate Revocation List file |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLFILE, char *file); |
| .SH DESCRIPTION |
| Pass a char * 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 NSS or 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 will imply \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 |
| All TLS-based protocols |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| curl_easy_setopt(curl, CURLOPT_CRLFILE, "/etc/certs/crl.pem"); |
| ret = curl_easy_perform(curl); |
| curl_easy_cleanup(curl); |
| } |
| .fi |
| .SH AVAILABILITY |
| Added in 7.19.0 |
| .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_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), " |
| .BR CURLOPT_PROXY_CRLFILE "(3), " |
