DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

CURLOPT_TLSAUTH_TYPE(3)





CURLOPT_TLSAUTH_TYPE(3curl_easy_setopt optionCURLOPT_TLSAUTH_TYPE(3)



NAME

     CURLOPT_TLSAUTH_TYPE - set 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 zero terminated string as parameter. The
     string  should be the method of the TLS authentication. Sup-
     ported method is "SRP".

     SRP  TLS-SRP authentication. Secure Remote Password  authen-
          tication  for  TLS  is  defined in RFC5054 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.

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


DEFAULT

     blank


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

     You need to build libcurl with GnuTLS or OpenSSL  with  TLS-
     SRP support for this to work. Added in 7.21.4


RETURN VALUE

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


SEE ALSO

     CURLOPT_TLSAUTH_USERNAME(3), CURLOPT_TLSAUTH_PASSWORD(3),

libcurl 7.58.0      Last change: May 31, 2017                   1


Man(1) output converted with man2html