| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- .\" generated by cd2nroff 0.1 from CURLOPT_TLSAUTH_USERNAME.md
- .TH CURLOPT_TLSAUTH_USERNAME 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_TLSAUTH_USERNAME \- username to use for TLS authentication
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_USERNAME, char *user);
- .fi
- .SH DESCRIPTION
- Pass a char pointer as parameter, which should point to the null\-terminated
- username to use for the TLS authentication method specified with the
- \fICURLOPT_TLSAUTH_TYPE(3)\fP option. Requires that the \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
- option also be set.
- The application does not have to keep the string around after setting this
- option.
- This feature relies on TLS SRP which does not work with TLS 1.3.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
- This option works only with the following TLS backends:
- GnuTLS and OpenSSL
- .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
- Added in curl 7.21.4
- .SH 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.
- .SH SEE ALSO
- .BR CURLOPT_TLSAUTH_PASSWORD (3),
- .BR CURLOPT_TLSAUTH_TYPE (3)
|
