CURLINFO_CERTINFO.3 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <[email protected]>, 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 CURLINFO_CERTINFO 3 "May 17, 2022" "libcurl 7.85.0" "curl_easy_getinfo options"
  26. .SH NAME
  27. CURLINFO_CERTINFO \- get the TLS certificate chain
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CERTINFO,
  32. struct curl_certinfo **chainp);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a 'struct curl_certinfo *' and you will get it set to point to
  36. a struct that holds a number of linked lists with info about the certificate
  37. chain, assuming you had \fICURLOPT_CERTINFO(3)\fP enabled when the request was
  38. made. The struct reports how many certs it found and then you can extract info
  39. for each of those certs by following the linked lists. The info chain is
  40. provided in a series of data in the format "name:content" where the content is
  41. for the specific named data. See also the certinfo.c example.
  42. .SH PROTOCOLS
  43. All TLS-based
  44. .SH EXAMPLE
  45. .nf
  46. curl = curl_easy_init();
  47. if(curl) {
  48. curl_easy_setopt(curl, CURLOPT_URL, "https://www.example.com/");
  49. /* connect to any HTTPS site, trusted or not */
  50. curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
  51. curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
  52. curl_easy_setopt(curl, CURLOPT_CERTINFO, 1L);
  53. res = curl_easy_perform(curl);
  54. if (!res) {
  55. struct curl_certinfo *ci;
  56. res = curl_easy_getinfo(curl, CURLINFO_CERTINFO, &ci);
  57. if (!res) {
  58. printf("%d certs!\\n", ci->num_of_certs);
  59. for(i = 0; i < ci->num_of_certs; i++) {
  60. struct curl_slist *slist;
  61. for(slist = ci->certinfo[i]; slist; slist = slist->next)
  62. printf("%s\\n", slist->data);
  63. }
  64. }
  65. }
  66. curl_easy_cleanup(curl);
  67. }
  68. .fi
  69. .SH AVAILABILITY
  70. This option is only working in libcurl built with OpenSSL, NSS, Schannel, GSKit
  71. or Secure Transport support. Schannel support added in 7.50.0. Secure Transport
  72. support added in 7.79.0.
  73. Added in 7.19.1
  74. .SH RETURN VALUE
  75. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  76. .SH "SEE ALSO"
  77. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "