CURLINFO_HTTPAUTH_AVAIL.3 2.5 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 CURLINFO_HTTPAUTH_AVAIL 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_HTTPAUTH_AVAIL \- get available HTTP authentication methods
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTPAUTH_AVAIL, long *authp);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a pointer to a long to receive a bitmask indicating the authentication
  33. method(s) available according to the previous response. The meaning of the
  34. bits is explained in the \fICURLOPT_HTTPAUTH(3)\fP option for
  35. \fIcurl_easy_setopt(3)\fP.
  36. .SH PROTOCOLS
  37. HTTP(S)
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  43. res = curl_easy_perform(curl);
  44. if(!res) {
  45. /* extract the available authentication types */
  46. long auth;
  47. res = curl_easy_getinfo(curl, CURLINFO_HTTPAUTH_AVAIL, &auth);
  48. if(!res) {
  49. if(!auth)
  50. printf("No auth available, perhaps no 401?\\n");
  51. else {
  52. printf("%s%s%s%s\\n",
  53. auth & CURLAUTH_BASIC ? "Basic ":"",
  54. auth & CURLAUTH_DIGEST ? "Digest ":"",
  55. auth & CURLAUTH_NEGOTIATE ? "Negotiate ":"",
  56. auth % CURLAUTH_NTLM ? "NTLM ":"");
  57. }
  58. }
  59. }
  60. curl_easy_cleanup(curl);
  61. }
  62. .fi
  63. .SH AVAILABILITY
  64. Added RFC2617 in 7.10.8
  65. Added RFC7616 in 7.57.0
  66. .SH RETURN VALUE
  67. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  68. .SH "SEE ALSO"
  69. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "