docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_TLSAUTH_TYPE \- set TLS authentication methods
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TLSAUTH_TYPE, char *type);
  30 .SH DESCRIPTION
  31 Pass a pointer to a zero terminated string as parameter. The string
  32 should be the method of the TLS authentication. Supported method is "SRP".
  33
  34 .IP SRP
  35 TLS-SRP authentication. Secure Remote Password authentication for TLS is
  36 defined in RFC5054 and provides mutual authentication if both sides have a
  37 shared secret. To use TLS-SRP, you must also set the
  38 \fICURLOPT_TLSAUTH_USERNAME(3)\fP and \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
  39 options.
  40
  41 The application does not have to keep the string around after setting this
  42 option.
  43 .SH DEFAULT
  44 blank
  45 .SH PROTOCOLS
  46 All TLS-based protocols
  47 .SH EXAMPLE
  48 TODO
  49 .SH AVAILABILITY
  50 You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
  51 to work. Added in 7.21.4
  52 .SH RETURN VALUE
  53 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  54 .SH "SEE ALSO"
  55 .BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "