81 lines
1.8 KiB
Markdown
81 lines
1.8 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_PROXY_TLSAUTH_TYPE
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_PROXY_TLSAUTH_PASSWORD (3)
|
|
- CURLOPT_PROXY_TLSAUTH_USERNAME (3)
|
|
- CURLOPT_TLSAUTH_PASSWORD (3)
|
|
- CURLOPT_TLSAUTH_USERNAME (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_PROXY_TLSAUTH_TYPE - HTTPS proxy TLS authentication methods
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_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 used for the HTTPS connection. 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_PROXY_TLSAUTH_USERNAME(3) and
|
|
CURLOPT_PROXY_TLSAUTH_PASSWORD(3) options.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
# DEFAULT
|
|
|
|
blank
|
|
|
|
# PROTOCOLS
|
|
|
|
All
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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 7.52.0
|
|
|
|
You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
|
|
to work.
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|