CURLOPT_CAINFO_BLOB.3 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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_CAINFO_BLOB 3 "31 March 2021" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_CAINFO_BLOB \- Certificate Authority (CA) bundle in PEM format
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CAINFO_BLOB,
  32. struct curl_blob *stblob);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a curl_blob structure, which contains information (pointer
  36. and size) about a memory block with binary data of PEM encoded content holding
  37. one or more certificates to verify the HTTPS server with.
  38. If \fICURLOPT_SSL_VERIFYPEER(3)\fP is zero and you avoid verifying the
  39. server's certificate, \fICURLOPT_CAINFO_BLOB(3)\fP is not needed.
  40. This option overrides \fICURLOPT_CAINFO(3)\fP.
  41. .SH DEFAULT
  42. NULL
  43. .SH PROTOCOLS
  44. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  45. .SH EXAMPLE
  46. .nf
  47. char *strpem; /* strpem must point to a PEM string */
  48. CURL *curl = curl_easy_init();
  49. if(curl) {
  50. struct curl_blob blob;
  51. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  52. blob.data = strpem;
  53. blob.len = strlen(strpem);
  54. blob.flags = CURL_BLOB_COPY;
  55. curl_easy_setopt(curl, CURLOPT_CAINFO_BLOB, &blob);
  56. ret = curl_easy_perform(curl);
  57. curl_easy_cleanup(curl);
  58. }
  59. .fi
  60. .SH AVAILABILITY
  61. Added in 7.77.0.
  62. This option is supported by the BearSSL (since 7.79.0), mbedTLS (since 7.81.0),
  63. rustls (since 7.82.0), wolfSSL (since 8.2.0), OpenSSL, Secure Transport and Schannel backends.
  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_CAINFO "(3), " CURLOPT_CAPATH "(3), "
  69. .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "