CURLOPT_FTPSSLAUTH.3 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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_FTPSSLAUTH 3 "May 31, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_FTPSSLAUTH \- set order in which to attempt TLS vs SSL when using FTP
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPSSLAUTH, long order);
  29. .SH DESCRIPTION
  30. Pass a long using one of the values from below, to alter how libcurl issues
  31. \&"AUTH TLS" or "AUTH SSL" when FTP over SSL is activated. This is only
  32. interesting if \fICURLOPT_USE_SSL(3)\fP is also set.
  33. Possible \fIorder\fP values:
  34. .IP CURLFTPAUTH_DEFAULT
  35. Allow libcurl to decide.
  36. .IP CURLFTPAUTH_SSL
  37. Try "AUTH SSL" first, and only if that fails try "AUTH TLS".
  38. .IP CURLFTPAUTH_TLS
  39. Try "AUTH TLS" first, and only if that fails try "AUTH SSL".
  40. .SH DEFAULT
  41. CURLFTPAUTH_DEFAULT
  42. .SH PROTOCOLS
  43. FTP
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
  49. curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_TRY);
  50. /* funny server, ask for SSL before TLS */
  51. curl_easy_setopt(curl, CURLOPT_FTPSSLAUTH, CURLFTPAUTH_SSL);
  52. ret = curl_easy_perform(curl);
  53. curl_easy_cleanup(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.12.2
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  60. .SH "SEE ALSO"
  61. .BR CURLOPT_USE_SSL "(3), " CURLOPT_FTP_SSL_CCC "(3), "