Return to CURLOPT_TLSAUTH_TYPE.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3, revision 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_TYPE 3 "December 16, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_TLSAUTH_TYPE \- set TLS authentication methods
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_TYPE, char *type);
        !            31: .SH DESCRIPTION
        !            32: Pass a pointer to a zero terminated string as parameter. The string should be
        !            33: the method of the TLS authentication. Supported method is "SRP".
        !            34: 
        !            35: .IP SRP
        !            36: TLS-SRP authentication. Secure Remote Password authentication for TLS is
        !            37: defined in RFC5054 and provides mutual authentication if both sides have a
        !            38: shared secret. To use TLS-SRP, you must also set the
        !            39: \fICURLOPT_TLSAUTH_USERNAME(3)\fP and \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
        !            40: options.
        !            41: 
        !            42: The application does not have to keep the string around after setting this
        !            43: option.
        !            44: 
        !            45: TLS SRP doesn't work with TLS 1.3.
        !            46: .SH DEFAULT
        !            47: blank
        !            48: .SH PROTOCOLS
        !            49: All TLS-based protocols
        !            50: .SH EXAMPLE
        !            51: .nf
        !            52: CURL *curl = curl_easy_init();
        !            53: if(curl) {
        !            54:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
        !            55:   curl_easy_setopt(curl, CURLOPT_TLSAUTH_TYPE, "SRP");
        !            56:   curl_easy_setopt(curl, CURLOPT_TLSAUTH_USERNAME, "user");
        !            57:   curl_easy_setopt(curl, CURLOPT_TLSAUTH_PASSWORD, "secret");
        !            58:   ret = curl_easy_perform(curl);
        !            59:   curl_easy_cleanup(curl);
        !            60: }
        !            61: .fi
        !            62: .SH AVAILABILITY
        !            63: You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
        !            64: to work. Added in 7.21.4
        !            65: .SH RETURN VALUE
        !            66: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            67: .SH "SEE ALSO"
        !            68: .BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "