CURLOPT_PROXY_TLSAUTH_TYPE(3)

1CURLOPT_PROXY_TLSAUTH_TYPE(3c)url_easy_setopt optionCsURLOPT_PROXY_TLSAUTH_TYPE(3)
2
3
4

NAME

6       CURLOPT_PROXY_TLSAUTH_TYPE - set proxy TLS authentication methods
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLcode   curl_easy_setopt(CURL  *handle,  CURLOPT_PROXY_TLSAUTH_TYPE,
12       char *type);
13

DESCRIPTION

15       Pass a pointer to a null-terminated string  as  parameter.  The  string
16       should  be the method of the TLS authentication used for the HTTPS con‐
17       nection. Supported method is "SRP".
18
19
20       SRP    TLS-SRP authentication. Secure  Remote  Password  authentication
21              for TLS is defined in RFC5054 and provides mutual authentication
22              if both sides have a shared secret. To  use  TLS-SRP,  you  must
23              also   set   the   CURLOPT_PROXY_TLSAUTH_USERNAME(3)   and  CUR‐
24              LOPT_PROXY_TLSAUTH_PASSWORD(3) options.
25
26              The application does not have to keep the  string  around  after
27              setting this option.
28

DEFAULT

30       blank
31

PROTOCOLS

33       All
34

EXAMPLE

36       CURL *curl = curl_easy_init();
37       if(curl) {
38         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
39         curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
40         curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_TYPE, "SRP");
41         curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_USERNAME, "user");
42         curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_PASSWORD, "secret");
43         ret = curl_easy_perform(curl);
44         curl_easy_cleanup(curl);
45       }
46

AVAILABILITY

48       Added in 7.52.0
49
50       You  need  to build libcurl with GnuTLS or OpenSSL with TLS-SRP support
51       for this to work.
52

RETURN VALUE

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