Return to CURLOPT_CRLFILE.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CRLFILE.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .\"
                     23: .TH CURLOPT_CRLFILE 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_CRLFILE \- specify a Certificate Revocation List file
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CRLFILE, char *file);
                     31: .SH DESCRIPTION
                     32: Pass a char * to a zero terminated string naming a \fIfile\fP with the
                     33: concatenation of CRL (in PEM format) to use in the certificate validation that
                     34: occurs during the SSL exchange.
                     35: 
                     36: When curl is built to use NSS or GnuTLS, there is no way to influence the use
                     37: of CRL passed to help in the verification process. When libcurl is built with
                     38: OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both
                     39: set, requiring CRL check against all the elements of the certificate chain if
                     40: a CRL file is passed.
                     41: 
                     42: This option makes sense only when used in combination with the
                     43: \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
                     44: 
                     45: A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
                     46: option. It is returned when the SSL exchange fails because the CRL file cannot
                     47: be loaded.  A failure in certificate verification due to a revocation
                     48: information found in the CRL does not trigger this specific error.
                     49: 
                     50: The application does not have to keep the string around after setting this
                     51: option.
                     52: .SH DEFAULT
                     53: NULL
                     54: .SH PROTOCOLS
                     55: All TLS-based protocols
                     56: .SH EXAMPLE
                     57: .nf
                     58: CURL *curl = curl_easy_init();
                     59: if(curl) {
                     60:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
                     61:   curl_easy_setopt(curl, CURLOPT_CRLFILE, "/etc/certs/crl.pem");
                     62:   ret = curl_easy_perform(curl);
                     63:   curl_easy_cleanup(curl);
                     64: }
                     65: .fi
                     66: .SH AVAILABILITY
                     67: Added in 7.19.0
                     68: .SH RETURN VALUE
                     69: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
                     70: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
                     71: .SH "SEE ALSO"
                     72: .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "
                     73: .BR CURLOPT_PROXY_CRLFILE "(3), "