CURLOPT_FTPSSLAUTH.3 2.4 KB

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