Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CURLINFO_HTTPAUTH_USED(3)   Library Functions Manual   CURLINFO_HTTPAUTH_USED(3)

NAME
     CURLINFO_HTTPAUTH_USED - used HTTP authentication method

SYNOPSIS
     #include <curl/curl.h>

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

DESCRIPTION
     Pass a pointer to a long to receive a bitmask indicating the authentication
     method  that was used in the previous HTTP request. The meaning of the pos-
     sible bits is explained in the CURLOPT_HTTPAUTH(3) option for curl_easy_se-
     topt(3).

     The returned value has zero or one bit set.

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");
	 curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC | CURLAUTH_DIGEST);
	 curl_easy_setopt(curl, CURLOPT_USERNAME, "shrek");
	 curl_easy_setopt(curl, CURLOPT_PASSWORD, "swamp");

	 result = curl_easy_perform(curl);

	 if(result == CURLE_OK) {
	   long auth;
	   result = curl_easy_getinfo(curl, CURLINFO_HTTPAUTH_USED, &auth);
	   if(result == CURLE_OK) {
	     if(!auth)
	       printf("No auth used\n");
	     else {
	       if(auth == CURLAUTH_DIGEST)
		 printf("Used Digest authentication\n");
	       else
		 printf("Used Basic authentication\n");
	     }
	   }
	 }
	 curl_easy_cleanup(curl);
       }
     }

AVAILABILITY
     Added in curl 8.12.0

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).

SEE ALSO
     CURLINFO_HTTPAUTH_AVAIL(3), CURLINFO_PROXYAUTH_USED(3), CURLOPT_HTTPAUTH(3)

libcurl 			   2026-06-11	       CURLINFO_HTTPAUTH_USED(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=CURLINFO_HTTPAUTH_USED&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help