Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLINFO_HTTPAUTH_AVAIL (3)

Name

CURLINFO_HTTPAUTH_AVAIL - get available HTTP authentication methods

Synopsis

#include <curl/curl.h>

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

Description

curl_easy_getinfo options                           CURLINFO_HTTPAUTH_AVAIL(3)



NAME
       CURLINFO_HTTPAUTH_AVAIL - get 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  authenti-
       cation  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
       HTTP(S)

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

         res = curl_easy_perform(curl);

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

AVAILABILITY
       Added RFC2617 in 7.10.8 Added RFC7616 in 7.57.0

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.44.0                    12 Sep 2015
                                                    CURLINFO_HTTPAUTH_AVAIL(3)