CURLINFO_HTTPAUTH_AVAIL.3 2.5 KB

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