CURLOPT_DOH_SSL_VERIFYSTATUS.3 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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_DOH_SSL_VERIFYSTATUS 3 "11 Feb 2021" "libcurl 7.76.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_DOH_SSL_VERIFYSTATUS \- verify the DoH SSL certificate's status
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DOH_SSL_VERIFYSTATUS,
  30. long verify);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a long as parameter set to 1 to enable or 0 to disable.
  34. This option determines whether libcurl verifies the status of the DoH
  35. (DNS-over-HTTPS) server cert using the "Certificate Status Request" TLS
  36. extension (aka. OCSP stapling).
  37. This option is the DoH equivalent of \fICURLOPT_SSL_VERIFYSTATUS(3)\fP and
  38. only affects requests to the DoH server.
  39. Note that if this option is enabled but the server does not support the TLS
  40. extension, the verification will fail.
  41. .SH DEFAULT
  42. 0
  43. .SH PROTOCOLS
  44. DoH
  45. .SH EXAMPLE
  46. .nf
  47. CURL *curl = curl_easy_init();
  48. if(curl) {
  49. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  50. curl_easy_setopt(curl, CURLOPT_DOH_URL, "https://cloudflare-dns.com/dns-query");
  51. /* Ask for OCSP stapling when verifying the DoH server */
  52. curl_easy_setopt(curl, CURLOPT_DOH_SSL_VERIFYSTATUS, 1L);
  53. curl_easy_perform(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.76.0. This option is currently only supported by the OpenSSL, GnuTLS
  58. and NSS TLS backends.
  59. .SH RETURN VALUE
  60. Returns CURLE_OK if OCSP stapling is supported by the SSL backend, otherwise
  61. returns CURLE_NOT_BUILT_IN.
  62. .SH "SEE ALSO"
  63. .BR CURLOPT_DOH_SSL_VERIFYHOST "(3), "
  64. .BR CURLOPT_DOH_SSL_VERIFYPEER "(3), "
  65. .BR CURLOPT_SSL_VERIFYSTATUS "(3), "