www.LinuxHowtos.org

CURLINFO_PROXYAUTH_USED

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

NAME

CURLINFO_PROXYAUTH_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 result;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
    curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example");
    curl_easy_setopt(curl, CURLOPT_PROXYAUTH,
                     CURLAUTH_BASIC | CURLAUTH_DIGEST);
    curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "shrek");
    curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "swamp");

    result = curl_easy_perform(curl);

    if(result == CURLE_OK) {
      long auth;
      result = curl_easy_getinfo(curl, CURLINFO_PROXYAUTH_USED, &auth);
      if(result == CURLE_OK) {
        if(!auth)
          printf("No auth usedn");
        else {
          if(auth == CURLAUTH_DIGEST)
            printf("Used Digest proxy authenticationn");
          else
            printf("Used Basic proxy authenticationn");
        }
      }
    }
    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).