mirror of
https://github.com/curl/curl.git
synced 2025-01-06 13:44:52 +08:00
c5775007d3
All man pages that are listed to be for TLS now must also specify exactly what TLS backends the option works for, or use All if they all work. cd2nroff makes sure this is done and that the listed backends exist. Closes #13168
76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_TLSAUTH_PASSWORD
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_PROXY_TLSAUTH_PASSWORD (3)
|
|
- CURLOPT_TLSAUTH_TYPE (3)
|
|
- CURLOPT_TLSAUTH_USERNAME (3)
|
|
Protocol:
|
|
- TLS
|
|
TLS-backend:
|
|
- OpenSSL
|
|
- GnuTLS
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_TLSAUTH_PASSWORD - password to use for TLS authentication
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_PASSWORD, char *pwd);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a char pointer as parameter, which should point to the null-terminated
|
|
password to use for the TLS authentication method specified with the
|
|
CURLOPT_TLSAUTH_TYPE(3) option. Requires that the
|
|
CURLOPT_TLSAUTH_USERNAME(3) option also be set.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
This feature relies in TLS SRP which does not work with TLS 1.3.
|
|
|
|
# DEFAULT
|
|
|
|
NULL
|
|
|
|
# PROTOCOLS
|
|
|
|
All TLS-based protocols
|
|
|
|
# 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_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);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.21.4, with the OpenSSL and GnuTLS backends only
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|