docs/libcurl/opts/CURLOPT_TLSAUTH_TYPE.3

   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_TLSAUTH_TYPE 3 "May 31, 2017" "libcurl 7.59.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
  33 should be 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 .SH DEFAULT
  45 blank
  46 .SH PROTOCOLS
  47 All TLS-based protocols
  48 .SH EXAMPLE
  49 .nf
  50 CURL *curl = curl_easy_init();
  51 if(curl) {
  52   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  53   curl_easy_setopt(curl, CURLOPT_TLSAUTH_TYPE, "SRP");
  54   curl_easy_setopt(curl, CURLOPT_TLSAUTH_USERNAME, "user");
  55   curl_easy_setopt(curl, CURLOPT_TLSAUTH_PASSWORD, "secret");
  56   ret = curl_easy_perform(curl);
  57   curl_easy_cleanup(curl);
  58 }
  59 .fi
  60 .SH AVAILABILITY
  61 You need to build libcurl with GnuTLS or OpenSSL with TLS-SRP support for this
  62 to work. Added in 7.21.4
  63 .SH RETURN VALUE
  64 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  65 .SH "SEE ALSO"
  66 .BR CURLOPT_TLSAUTH_USERNAME "(3), " CURLOPT_TLSAUTH_PASSWORD "(3), "