CURLOPT_PROXY_ISSUERCERT.3 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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_ISSUERCERT 3 "24 Jun 2020" "libcurl 7.71.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_ISSUERCERT \- proxy issuer SSL certificate filename
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_ISSUERCERT, char *file);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a char * to a null-terminated string naming a \fIfile\fP holding a CA
  33. certificate in PEM format. If the option is set, an additional check against
  34. the peer certificate is performed to verify the issuer of the the HTTPS proxy
  35. is indeed the one associated with the certificate provided by the option.
  36. This additional check is useful in multi-level PKI where one needs to enforce
  37. that the peer certificate is from a specific branch of the tree.
  38. This option makes sense only when used in combination with the
  39. \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP option. Otherwise, the result of the
  40. check is not considered as failure.
  41. A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option,
  42. which is returned if the setup of the SSL/TLS session has failed due to a
  43. mismatch with the issuer of peer certificate
  44. (\fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP has to be set too for the check to
  45. fail).
  46. The application does not have to keep the string around after setting this
  47. option.
  48. .SH DEFAULT
  49. NULL
  50. .SH PROTOCOLS
  51. All TLS-based protocols
  52. .SH EXAMPLE
  53. .nf
  54. CURL *curl = curl_easy_init();
  55. if(curl) {
  56. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  57. /* using an HTTPS proxy */
  58. curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:443");
  59. curl_easy_setopt(curl, CURLOPT_PROXY_ISSUERCERT, "/etc/certs/cacert.pem");
  60. ret = curl_easy_perform(curl);
  61. curl_easy_cleanup(curl);
  62. }
  63. .fi
  64. .SH AVAILABILITY
  65. Added in 7.71.0. This option is supported by the OpenSSL backends.
  66. .SH RETURN VALUE
  67. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  68. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  69. .SH "SEE ALSO"
  70. .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
  71. .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "