CURLOPT_PROXY_CAINFO_BLOB.3 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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_CAINFO_BLOB 3 "31 March 2021" "libcurl 7.77.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_CAINFO_BLOB \- proxy Certificate Authority (CA) bundle in PEM format
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_CAINFO_BLOB,
  30. struct curl_blob *stblob);
  31. .fi
  32. .SH DESCRIPTION
  33. This option is for connecting to an HTTPS proxy, not an HTTPS server.
  34. Pass a pointer to a curl_blob structure, which contains information (pointer
  35. and size) about a memory block with binary data of PEM encoded content holding
  36. one or more certificates to verify the HTTPS proxy with.
  37. If \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the
  38. server's certificate, \fICURLOPT_PROXY_CAINFO_BLOB(3)\fP is not needed.
  39. This option overrides \fICURLOPT_PROXY_CAINFO(3)\fP.
  40. .SH DEFAULT
  41. NULL
  42. .SH PROTOCOLS
  43. Used with HTTPS proxy
  44. .SH EXAMPLE
  45. .nf
  46. char *strpem; /* strpem must point to a PEM string */
  47. CURL *curl = curl_easy_init();
  48. if(curl) {
  49. struct curl_blob blob;
  50. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  51. /* using an HTTPS proxy */
  52. curl_easy_setopt(curl, CURLOPT_PROXY, "https://localhost:443");
  53. blob.data = strpem;
  54. blob.len = strlen(strpem);
  55. blob.flags = CURL_BLOB_COPY;
  56. curl_easy_setopt(curl, CURLOPT_PROXY_CAINFO_BLOB, &blob);
  57. ret = curl_easy_perform(curl);
  58. curl_easy_cleanup(curl);
  59. }
  60. .fi
  61. .SH AVAILABILITY
  62. Added in 7.77.0.
  63. This option is supported by the rustls (since 7.82.0), OpenSSL, Secure
  64. Transport and Schannel backends.
  65. .SH RETURN VALUE
  66. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  67. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  68. .SH "SEE ALSO"
  69. .BR CURLOPT_PROXY_CAINFO "(3), " CURLOPT_PROXY_CAPATH "(3), "
  70. .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
  71. .BR CURLOPT_CAINFO "(3), " CURLOPT_CAINFO_BLOB "(3), "
  72. .BR CURLOPT_CAPATH "(3), "
  73. .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "