CURLOPT_PROXY_ISSUERCERT.3 3.1 KB

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