Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_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

CURLOPT_TLSAUTH_TYPE(3)    curl_easy_setopt options    CURLOPT_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. Supported method is
       "SRP".


       SRP    TLS-SRP authentication. Secure  Remote  Password  authentication
              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    CUR-
              LOPT_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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_TLSAUTH_USERNAME(3), CURLOPT_TLSAUTH_PASSWORD(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014          CURLOPT_TLSAUTH_TYPE(3)