manpagez: man pages & more
man CURLOPT_PROXY_TLSAUTH_USERNAME(3)
Home | html | info | man
CURLOPT_PROXY_TLSAUTH_USERNAME(3)                     Library Functions Manual


NAME

       CURLOPT_PROXY_TLSAUTH_USERNAME - username 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 pointer 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

       This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS,
       POP3S, SMTPS etc.

       This option works only with the following TLS backends: GnuTLS and
       OpenSSL


EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode res;
           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");
           res = curl_easy_perform(curl);
           curl_easy_cleanup(curl);
         }
       }


AVAILABILITY

       Added in curl 7.52.0


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_PASSWORD(3), CURLOPT_PROXY_TLSAUTH_TYPE(3),
       CURLOPT_TLSAUTH_PASSWORD(3), CURLOPT_TLSAUTH_TYPE(3)

libcurl                           2024-08-05 CURLOPT_PROXY_TLSAUTH_USERNAME(3)

curl 8.9.1 - Generated Tue Aug 13 07:44:25 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.