mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 20:56:58 +00:00
53 lines
1.6 KiB
Groff
53 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_TLSAUTH_TYPE.md
|
|
.TH CURLOPT_TLSAUTH_TYPE 3 "March 15 2024" libcurl
|
|
.SH NAME
|
|
CURLOPT_TLSAUTH_TYPE \- TLS authentication methods
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_TYPE, char *type);
|
|
.fi
|
|
.SH 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".
|
|
.IP 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
|
|
\fICURLOPT_TLSAUTH_USERNAME(3)\fP and \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
|
|
options.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
TLS SRP does not work with TLS 1.3.
|
|
.SH DEFAULT
|
|
blank
|
|
.SH PROTOCOLS
|
|
All TLS\-based protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
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);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
You need to build libcurl with GnuTLS or OpenSSL with TLS\-SRP support for this
|
|
to work. Added in 7.21.4
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_TLSAUTH_PASSWORD (3),
|
|
.BR CURLOPT_TLSAUTH_USERNAME (3)
|