CURLOPT_FTP_SKIP_PASV_IP.3 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  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_FTP_SKIP_PASV_IP 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
  26. .SH NAME
  27. CURLOPT_FTP_SKIP_PASV_IP \- ignore the IP address in the PASV response
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_SKIP_PASV_IP, long skip);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long. If \fIskip\fP is set to 1, it instructs libcurl to not use the IP
  35. address the server suggests in its 227-response to libcurl's PASV command when
  36. libcurl connects the data connection. Instead libcurl will re-use the same IP
  37. address it already uses for the control connection. But it will use the port
  38. number from the 227-response.
  39. This option thus allows libcurl to work around broken server installations
  40. that due to NATs, firewalls or incompetence report the wrong IP address
  41. back. Setting the option also reduces the risk for various sorts of client
  42. abuse by malicious servers.
  43. This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
  44. .SH DEFAULT
  45. 1 since 7.74.0, was 0 before then.
  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. /* please ignore the IP in the PASV response */
  54. curl_easy_setopt(curl, CURLOPT_FTP_SKIP_PASV_IP, 1L);
  55. ret = curl_easy_perform(curl);
  56. curl_easy_cleanup(curl);
  57. }
  58. .fi
  59. .SH AVAILABILITY
  60. Added in 7.14.2
  61. .SH RETURN VALUE
  62. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  63. .SH "SEE ALSO"
  64. .BR CURLOPT_FTPPORT "(3), " CURLOPT_FTP_USE_EPRT "(3), "