mirror of https://github.com/moparisthebest/curl
60 lines
2.3 KiB
Groff
60 lines
2.3 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_PROXY_TLSAUTH_TYPE 3 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_PROXY_TLSAUTH_TYPE \- set proxy TLS authentication methods
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_TYPE, char *type);
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a zero terminated string as parameter. The string should be
|
|
the method of the TLS authentication used for the HTTPS connection. Supported
|
|
method is "SRP".
|
|
|
|
.IP SRP
|
|
TLS-SRP authentication. Secure Remote Password authentication for TLS is
|
|
defined in RFC5054 and provides mutual authentication if both sides have a
|
|
shared secret. To use TLS-SRP, you must also set the
|
|
\fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP and
|
|
\fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP options.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
.SH DEFAULT
|
|
blank
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
TODO
|
|
.SH AVAILABILITY
|
|
Added in 7.52.0
|
|
|
|
You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
|
|
to work.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_PROXY_TLSAUTH_USERNAME "(3), " CURLOPT_PROXY_TLSAUTH_PASSWORD "(3), "
|
|
.BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "
|