manpagez: man pages & more
man CURLINFO_PROXYAUTH_USED(3)
Home | html | info | man
CURLINFO_PROXYAUTH_USED(3)                            Library Functions Manual


NAME

       CURLINFO_PROXYAUTH_USED - get used HTTP proxy authentication method


SYNOPSIS

       #include <curl/curl.h>

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


DESCRIPTION

       Pass a pointer to a long to receive a bitmask indicating the
       authentication method that was used in the previous request done over
       an HTTP proxy. The meaning of the possible bits is explained in the
       CURLOPT_HTTPAUTH(3) option for curl_easy_setopt(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 res;
           curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
           curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example.com");
           curl_easy_setopt(curl, CURLOPT_PROXYAUTH,
                            CURLAUTH_BASIC | CURLAUTH_DIGEST);
           curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "shrek");
           curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "swamp");

           res = curl_easy_perform(curl);

           if(!res) {
             long auth;
             res = curl_easy_getinfo(curl, CURLINFO_PROXYAUTH_USED, &auth);
             if(!res) {
               if(!auth)
                 printf("No auth used\n");
               else {
                 if(auth == CURLAUTH_DIGEST)
                   printf("Used Digest proxy authentication\n");
                 else
                   printf("Used Basic proxy 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_USED(3), CURLINFO_PROXYAUTH_AVAIL(3),
       CURLOPT_HTTPAUTH(3)

libcurl                           2025-02-08        CURLINFO_PROXYAUTH_USED(3)

curl 8.12.0 - Generated Wed Feb 19 16:43:48 CST 2025
© manpagez.com 2000-2025
Individual documents may contain additional copyright information.