CURLOPT_PROXY_CRLFILE.3 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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_PROXY_CRLFILE 3 "April 17, 2018" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_CRLFILE \- specify a proxy Certificate Revocation List file
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CRLFILE, char *file);
  29. .SH DESCRIPTION
  30. This option is for connecting to an HTTPS proxy, not an HTTPS server.
  31. Pass a char * to a zero terminated string naming a \fIfile\fP with the
  32. concatenation of CRL (in PEM format) to use in the certificate validation that
  33. occurs during the SSL exchange.
  34. When curl is built to use NSS or GnuTLS, there is no way to influence the use
  35. of CRL passed to help in the verification process. When libcurl is built with
  36. OpenSSL support, X509_V_FLAG_CRL_CHECK and X509_V_FLAG_CRL_CHECK_ALL are both
  37. set, requiring CRL check against all the elements of the certificate chain if
  38. a CRL file is passed.
  39. This option makes sense only when used in combination with the
  40. \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option.
  41. A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
  42. option. It is returned when the SSL exchange fails because the CRL file cannot
  43. be loaded. A failure in certificate verification due to a revocation
  44. information found in the CRL does not trigger this specific error.
  45. The application does not have to keep the string around after setting this
  46. option.
  47. .SH DEFAULT
  48. NULL
  49. .SH PROTOCOLS
  50. Used with HTTPS proxy.
  51. .SH EXAMPLE
  52. .nf
  53. CURL *curl = curl_easy_init();
  54. if(curl) {
  55. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  56. curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:80");
  57. curl_easy_setopt(curl, CURLOPT_PROXY_CRLFILE, "/etc/certs/crl.pem");
  58. ret = curl_easy_perform(curl);
  59. curl_easy_cleanup(curl);
  60. }
  61. .fi
  62. .SH AVAILABILITY
  63. Added in 7.52.0
  64. .SH RETURN VALUE
  65. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  66. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  67. .SH "SEE ALSO"
  68. .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
  69. .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "