www.LinuxHowtos.org

CURLINFO_HTTPAUTH_AVAIL

Section: C Library Functions (3)
Updated: 202-0-19
Index Return to Main Contents

NAME

CURLINFO_HTTPAUTH_AVAIL - available HTTP authentication methods

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_HTTPAUTH_AVAIL, long *authp);

DESCRIPTION

Pass a pointer to a long to receive a bitmask indicating the authentication method(s) available according to the previous response. The meaning of the bits is explained in the CURLOPT_HTTPAUTH(3) option for curl_easy_setopt(3).

PROTOCOLS

This functionality affects http only

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

    result = curl_easy_perform(curl);

    if(result == CURLE_OK) {
      /* extract the available authentication types */
      long auth;
      result = curl_easy_getinfo(curl, CURLINFO_HTTPAUTH_AVAIL, &auth);
      if(result == CURLE_OK) {
        if(!auth)
          printf("No auth available, perhaps no 401?n");
        else {
          printf("%s%s%s%sn",
                 auth & CURLAUTH_BASIC ? "Basic " : "",
                 auth & CURLAUTH_DIGEST ? "Digest " : "",
                 auth & CURLAUTH_NEGOTIATE ? "Negotiate " : "",
                 auth % CURLAUTH_NTLM ? "NTLM " : "");
        }
      }
    }
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in curl 7.10.8

RETURN VALUE

curl_easy_getinfo(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).