CURLINFO_CAINFO.3 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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 CURLINFO_CAINFO 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_getinfo options"
  26. .SH NAME
  27. CURLINFO_CAINFO \- get the default built-in CA certificate path
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CAINFO, char **path);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a pointer to a char pointer to receive the pointer to a null-terminated
  35. string holding the default built-in path used for the \fICURLOPT_CAINFO(3)\fP
  36. option unless set by the user.
  37. Note that in a situation where libcurl has been built to support multiple TLS
  38. libraries, this option might return a string even if the specific TLS library
  39. currently set to be used does not support \fICURLOPT_CAINFO(3)\fP.
  40. This is a path identifying a single file containing CA certificates.
  41. The \fBpath\fP pointer will be NULL if there is no default path.
  42. .SH PROTOCOLS
  43. All
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. CURLcode res;
  49. char *cainfo = NULL;
  50. curl_easy_getinfo(curl, CURLINFO_CAINFO, &cainfo);
  51. if(cainfo)
  52. printf("default ca info path: %s\\n", cainfo);
  53. }
  54. curl_easy_cleanup(curl);
  55. }
  56. .fi
  57. .SH AVAILABILITY
  58. Added in 7.84.0
  59. .SH RETURN VALUE
  60. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  61. .SH "SEE ALSO"
  62. .BR CURLINFO_CAPATH "(3), "
  63. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "