DragonFly On-Line Manual Pages

Search: Section:  

CURLOPT_PROXY_TLSAUTH_USERNAME(3)   libcurl  CURLOPT_PROXY_TLSAUTH_USERNAME(3)


NAME

       CURLOPT_PROXY_TLSAUTH_USERNAME - user name to use for proxy TLS
       authentication


SYNOPSIS

       #include <curl/curl.h>

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


DESCRIPTION

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

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


DEFAULT

       NULL


PROTOCOLS

       All


EXAMPLE

       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
         curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_TYPE, "SRP");
         curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_USERNAME, "user");
         curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_PASSWORD, "secret");
         ret = curl_easy_perform(curl);
         curl_easy_cleanup(curl);
       }


AVAILABILITY

       Added in 7.52.0, with the OpenSSL and GnuTLS backends only.


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_PROXY_TLSAUTH_TYPE(3), CURLOPT_PROXY_TLSAUTH_PASSWORD(3),
       CURLOPT_TLSAUTH_TYPE(3), CURLOPT_TLSAUTH_PASSWORD(3),

ibcurl 8.1.2                    April 26, 2023
                                             CURLOPT_PROXY_TLSAUTH_USERNAME(3)

Search: Section: