Return to CURLOPT_TLSAUTH_USERNAME.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TLSAUTH_USERNAME.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     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.
                     13: .\" *
                     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.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .\"
                     23: .TH CURLOPT_TLSAUTH_USERNAME 3 "December 16, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_TLSAUTH_USERNAME \- user name to use for TLS authentication
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_USERNAME, char *user);
                     31: .SH DESCRIPTION
                     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.
                     36: 
                     37: The application does not have to keep the string around after setting this
                     38: option.
                     39: 
                     40: This feature relies in TLS SRP which doesn't work with TLS 1.3.
                     41: .SH DEFAULT
                     42: NULL
                     43: .SH PROTOCOLS
                     44: All TLS-based protocols
                     45: .SH EXAMPLE
                     46: .nf
                     47: CURL *curl = curl_easy_init();
                     48: if(curl) {
                     49:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
                     50:   curl_easy_setopt(curl, CURLOPT_TLSAUTH_TYPE, "SRP");
                     51:   curl_easy_setopt(curl, CURLOPT_TLSAUTH_USERNAME, "user");
                     52:   curl_easy_setopt(curl, CURLOPT_TLSAUTH_PASSWORD, "secret");
                     53:   ret = curl_easy_perform(curl);
                     54:   curl_easy_cleanup(curl);
                     55: }
                     56: .fi
                     57: .SH AVAILABILITY
                     58: Added in 7.21.4
                     59: .SH RETURN VALUE
                     60: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
                     61: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
                     62: .SH "SEE ALSO"
                     63: .BR CURLOPT_TLSAUTH_TYPE "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "