docs/libcurl/opts/CURLOPT_PROXY_TLSAUTH_TYPE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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 "16 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXY_TLSAUTH_TYPE \- set proxy TLS authentication methods
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TLSAUTH_TYPE, char *type);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string as parameter. The string should be
  32 the method of the TLS authentication used for the HTTPS connection. Supported
  33 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_PROXY_TLSAUTH_USERNAME(3)\fP and
  40 \fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP options.
  41
  42 The application does not have to keep the string around after setting this
  43 option.
  44 .SH DEFAULT
  45 blank
  46 .SH PROTOCOLS
  47 All
  48 .SH EXAMPLE
  49 TODO
  50 .SH AVAILABILITY
  51 Added in 7.52.0
  52
  53 You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
  54 to work.
  55 .SH RETURN VALUE
  56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  57 .SH "SEE ALSO"
  58 .BR CURLOPT_PROXY_TLSAUTH_USERNAME "(3), " CURLOPT_PROXY_TLSAUTH_PASSWORD "(3), "
  59 .BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "