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

FreeBSD Manual Pages

  
 
  

home | help
CURLOPT_TLSAUTH_USERNAME(3)curl_easy_setopt optionsCURLOPT_TLSAUTH_USERNAME(3)

NAME
       CURLOPT_TLSAUTH_USERNAME	- user name to use for TLS authentication

SYNOPSIS
       #include	<curl/curl.h>

       CURLcode	 curl_easy_setopt(CURL *handle,	CURLOPT_TLSAUTH_USERNAME, char
       *user);

DESCRIPTION
       Pass a char * as	parameter, which should	point to  the  null-terminated
       username	 to  use  for the TLS authentication method specified with the
       CURLOPT_TLSAUTH_TYPE(3) option. Requires	that the CURLOPT_TLSAUTH_PASS-
       WORD(3) option also be set.

       The  application	 does not have to keep the string around after setting
       this option.

       This feature relies in TLS SRP which doesn't work with TLS 1.3.

DEFAULT
       NULL

PROTOCOLS
       All TLS-based protocols

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl)	{
	 curl_easy_setopt(curl,	CURLOPT_URL, "https://example.com/");
	 curl_easy_setopt(curl,	CURLOPT_TLSAUTH_TYPE, "SRP");
	 curl_easy_setopt(curl,	CURLOPT_TLSAUTH_USERNAME, "user");
	 curl_easy_setopt(curl,	CURLOPT_TLSAUTH_PASSWORD, "secret");
	 ret = curl_easy_perform(curl);
	 curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in	7.21.4

RETURN VALUE
       Returns CURLE_OK	if the option is  supported,  CURLE_UNKNOWN_OPTION  if
       not, or CURLE_OUT_OF_MEMORY if there was	insufficient heap space.

SEE ALSO
       CURLOPT_TLSAUTH_TYPE(3),	CURLOPT_TLSAUTH_PASSWORD(3),

libcurl	7.72.0			 June 25, 2020	   CURLOPT_TLSAUTH_USERNAME(3)

NAME | SYNOPSIS | DESCRIPTION | DEFAULT | PROTOCOLS | EXAMPLE | AVAILABILITY | RETURN VALUE | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=CURLOPT_TLSAUTH_USERNAME&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help