1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_TLSAUTH_USERNAME 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
26 CURLOPT_TLSAUTH_USERNAME \- user name to use for TLS authentication
28 #include <curl/curl.h>
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_USERNAME, char *user);
32 Pass a char * as parameter, which should point to the zero terminated username
33 to use for the TLS authentication method specified with the
34 \fICURLOPT_TLSAUTH_TYPE(3)\fP option. Requires that the
35 \fICURLOPT_TLSAUTH_PASSWORD(3)\fP option also be set.
37 The application does not have to keep the string around after setting this
42 All TLS-based protocols
45 CURL *curl = curl_easy_init();
47 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
48 curl_easy_setopt(curl, CURLOPT_TLSAUTH_TYPE, "SRP");
49 curl_easy_setopt(curl, CURLOPT_TLSAUTH_USERNAME, "user");
50 curl_easy_setopt(curl, CURLOPT_TLSAUTH_PASSWORD, "secret");
51 ret = curl_easy_perform(curl);
52 curl_easy_cleanup(curl);
58 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
59 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
61 .BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "