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


NAME

       CURLOPT_TLSAUTH_TYPE - TLS authentication methods


SYNOPSIS

       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_TYPE, char *type);


DESCRIPTION

       Pass a pointer to a null-terminated string as parameter. The string
       should be the method of the TLS authentication. Supported method is
       "SRP".

       SRP    TLS-SRP authentication. Secure Remote Password authentication
              for TLS is defined in RFC 5054 and provides mutual
              authentication if both sides have a shared secret. To use
              TLS-SRP, you must also set the CURLOPT_TLSAUTH_USERNAME(3) and
              CURLOPT_TLSAUTH_PASSWORD(3) options.

              TLS SRP does not work with TLS 1.3.


DEFAULT

       blank


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_TLSAUTH_TYPE, "SRP");
           curl_easy_setopt(curl, CURLOPT_TLSAUTH_USERNAME, "user");
           curl_easy_setopt(curl, CURLOPT_TLSAUTH_PASSWORD, "secret");
           res = curl_easy_perform(curl);
           curl_easy_cleanup(curl);
         }
       }


AVAILABILITY

       Added in curl 7.21.4


RETURN VALUE

       Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


SEE ALSO

       CURLOPT_TLSAUTH_PASSWORD(3), CURLOPT_TLSAUTH_USERNAME(3)

libcurl                           2024-08-05           CURLOPT_TLSAUTH_TYPE(3)

curl 8.9.1 - Generated Wed Aug 7 16:05:28 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.