CURLOPT_FTPSSLAUTH.3 2.4 KB

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