Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_TYPE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, 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_PROXY_TLSAUTH_TYPE 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_PROXY_TLSAUTH_TYPE \- set proxy TLS authentication methods
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_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 used for the HTTPS connection. Supported
34: method is "SRP".
35:
36: .IP SRP
37: TLS-SRP authentication. Secure Remote Password authentication for TLS is
38: defined in RFC5054 and provides mutual authentication if both sides have a
39: shared secret. To use TLS-SRP, you must also set the
40: \fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP and
41: \fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP options.
42:
43: The application does not have to keep the string around after setting this
44: option.
45: .SH DEFAULT
46: blank
47: .SH PROTOCOLS
48: All
49: .SH EXAMPLE
50: .nf
51: CURL *curl = curl_easy_init();
52: if(curl) {
53: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
54: curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
55: curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_TYPE, "SRP");
56: curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_USERNAME, "user");
57: curl_easy_setopt(curl, CURLOPT_PROXY_TLSAUTH_PASSWORD, "secret");
58: ret = curl_easy_perform(curl);
59: curl_easy_cleanup(curl);
60: }
61: .fi
62: .SH AVAILABILITY
63: Added in 7.52.0
64:
65: You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
66: to work.
67: .SH RETURN VALUE
68: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
69: .SH "SEE ALSO"
70: .BR CURLOPT_PROXY_TLSAUTH_USERNAME "(3), " CURLOPT_PROXY_TLSAUTH_PASSWORD "(3), "
71: .BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>