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

FreeBSD Manual Pages

  
 
  

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

NAME
       CURLOPT_PROXYAUTH - HTTP	proxy authentication methods

SYNOPSIS
       #include	<curl/curl.h>

       CURLcode	curl_easy_setopt(CURL *handle, CURLOPT_PROXYAUTH, long bitmask);

DESCRIPTION
       Pass  a	long  as parameter, which is set to a bitmask, to tell libcurl
       which HTTP authentication method(s) you want it to use for  your	 proxy
       authentication.	If more	than one bit is	set, libcurl first queries the
       site to see what	authentication methods it supports and then  it	 picks
       the best	one you	allow it to use. For some methods, this	induces	an ex-
       tra network round-trip.	Set the	actual name and	password with the CUR-
       LOPT_PROXYUSERPWD(3) option.

       The  bitmask can	be constructed by the bits listed and described	in the
       CURLOPT_HTTPAUTH(3) man page.

DEFAULT
       CURLAUTH_BASIC

PROTOCOLS
       This functionality affects all supported	protocols

EXAMPLE
       int main(void)
       {
	 CURL *curl = curl_easy_init();
	 if(curl) {
	   CURLcode ret;
	   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
	   /* use this proxy */
	   curl_easy_setopt(curl, CURLOPT_PROXY, "http://local.example.com:1080");
	   /* allow whatever auth the proxy speaks */
	   curl_easy_setopt(curl, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
	   /* set the proxy credentials	*/
	   curl_easy_setopt(curl, CURLOPT_PROXYUSERPWD,	"james:007");
	   ret = curl_easy_perform(curl);
	   curl_easy_cleanup(curl);
	 }
       }

AVAILABILITY
       Added in	curl 7.10.7

RETURN VALUE
       curl_easy_setopt(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
       CURLOPT_HTTPAUTH(3),   CURLOPT_PROXY(3),	  CURLOPT_PROXYPORT(3),	  CUR-
       LOPT_PROXYTYPE(3), CURLOPT_PROXYUSERPWD(3)

libcurl				  2025-06-03		  CURLOPT_PROXYAUTH(3)

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

home | help