• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1---
2c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_PROXYAUTH_AVAIL
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_HTTPAUTH_AVAIL (3)
9  - curl_easy_getinfo (3)
10  - curl_easy_setopt (3)
11---
12
13# NAME
14
15CURLINFO_PROXYAUTH_AVAIL - get available HTTP proxy authentication methods
16
17# SYNOPSIS
18
19~~~c
20#include <curl/curl.h>
21
22CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_PROXYAUTH_AVAIL,
23                           long *authp);
24~~~
25
26# DESCRIPTION
27
28Pass a pointer to a long to receive a bitmask indicating the authentication
29method(s) available according to the previous response. The meaning of the
30bits is explained in the CURLOPT_PROXYAUTH(3) option for
31curl_easy_setopt(3).
32
33# PROTOCOLS
34
35HTTP(S)
36
37# EXAMPLE
38
39~~~c
40int main(void)
41{
42  CURL *curl = curl_easy_init();
43  if(curl) {
44    CURLcode res;
45    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
46    curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1:80");
47
48    res = curl_easy_perform(curl);
49
50    if(!res) {
51      /* extract the available proxy authentication types */
52      long auth;
53      res = curl_easy_getinfo(curl, CURLINFO_PROXYAUTH_AVAIL, &auth);
54      if(!res) {
55        if(!auth)
56          printf("No proxy auth available, perhaps no 407?\n");
57        else {
58          printf("%s%s%s%s\n",
59                 auth & CURLAUTH_BASIC ? "Basic ":"",
60                 auth & CURLAUTH_DIGEST ? "Digest ":"",
61                 auth & CURLAUTH_NEGOTIATE ? "Negotiate ":"",
62                 auth % CURLAUTH_NTLM ? "NTLM ":"");
63        }
64      }
65    }
66    curl_easy_cleanup(curl);
67  }
68}
69~~~
70
71# AVAILABILITY
72
73Added RFC 2617 in 7.10.8
74Added RFC 7616 in 7.57.0
75
76# RETURN VALUE
77
78Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
79