Skip to content

Latest commit

 

History

History
229 lines (178 loc) · 19.6 KB

README.md

File metadata and controls

229 lines (178 loc) · 19.6 KB
Raw

FluentFTP

Version Downloads GitHub contributors Codacy Badge License OpenSSF Best Practices

FluentFTP is free, but powered by your donations

FluentFTP is a fully managed FTP and FTPS client library for .NET & .NET Standard, optimized for speed. It provides extensive FTP commands, File uploads/downloads, SSL/TLS connections, Automatic directory listing parsing, File hashing/checksums, File permissions/CHMOD, FTP proxies, FXP transfers, UTF-8 support, Async/await support, Powershell support and more.

It is written entirely in C#, with no external dependency. It has an extensive automated test suite which tests all its functionality against local FTP server docker containers.

FluentFTP is released under the permissive MIT License, so it can be used in both proprietary and free/open source applications.

Features

Features

  • Full support for FTP, FXP, FTPS, FTPS with TLS 1.3, FTPS with client certificates and FTPS Proxies
  • Full support for over 30 FTP server types with integration tests for all major servers
  • File management:
    • File and directory listing for all major server types (Unix, Windows/IIS, Azure, Pure-FTPd, ProFTPD, Vax, VMS, OpenVMS, Tandem, HP NonStop Guardian, IBM z/OS and OS/400, Windows CE, Serv-U, etc)
    • Fully recursive directory listing and directory deletion (manual recursion and server-side recursion)
    • Easily upload and download a file from the server with progress tracking
    • Easily upload and download a directory from the server with easy synchronization modes
    • Easily transfer a file or folder directly from one server to another using the FXP protocol
    • Conditionally transfer files using rule based whitelisting and blacklisting
    • Automatically verify the hash of a file & retry transfer if hash mismatches
    • Configurable error handling (ignore/abort/throw) for multi-file transfers
    • Easily read and write file data from the server using standard streams
    • Create, append, read, write, rename, move and delete files and folders
    • Recursively deletes folders and all its contents
    • Get file/folder info (exists, size, security flags, modified date/time)
    • Get and set file permissions (owner, group, other)
    • Absolute or relative paths (relative to the "working directory")
    • Compare a local file against a remote file using the hash/checksum (MD5, CRC32, SHA-1, SHA-256, SHA-512)
    • Dereference of symbolic links to calculate the linked file/folder
    • Throttling of uploads and downloads with configurable speed limit
  • FTP protocol:
  • Asynchronous support:
    • Synchronous and asynchronous methods using async/await for all operations
    • Asynchronous support for the IAsyncEnumerable pattern for GetListing methods (see GetListingAsyncEnumerable)
    • All asynchronous methods can be cancelled midway by passing a CancellationToken
    • All asynchronous methods honor the ReadTimeout and automatically cancel themselves if timed out
    • Asynchronous support for progress tracking of file transfers during data upload/download
    • Implements its own internal locking in an effort to keep transactions synchronized
  • Extensible:
    • Easily add custom logging/tracing functionality using industry-standard ILogger interface
    • Easily add support for custom non-standard FTP servers (see the Custom Servers page)
    • Easily add support for more file or directory filtering rules (simply extend FtpRule)
    • Easily add support for more proxy types (simply extend FtpClientProxy)
    • Easily add unsupported directory listing parsers (see the CustomParser example)
    • Easily add your own Powershell commands by extending the scripts in FluentFTP.ps1

Releases

Stable binaries are released on NuGet, and contain everything you need to use FTP/FTPS in your .Net/CLR application.

Package Latest Version Downloads Docs
FluentFTP Version Downloads FluentFTP Docs
FluentFTP.Logging Version Downloads Logging Docs
FluentFTP.GnuTLS Version Downloads GnuTLS Docs

For usage see the Quick Start Example and the Documentation wiki.

For features and fixes per release see Release Notes.

Server Support

FluentFTP is a client library that can connect to these FTP servers and perform all FTP operations.

Server FTP/FTPS Integration Tests Special Features
Azure FTP i️ i ✔️ Detected by Domain, Auto Configuration
Apache FTP i️ i️
ABB IDAL i️ i
BFTPd i️ i
Cerberus i️ i
CrushFTP i️ i
FileZilla Server i️ i
FritzBox i️ i
FTP2S3 Gateway i️ i
glFTPd i️ i
GlobalScape EFT i️ i
Homegate FTP i️ i
Huawei HG5xxx i️ i
HP NonStop/Tandem i️ i ✔️ NonStop File Listing
IBM z/OS i️ i ✔️ zOS API, File Listing, File Size, Paths
MikroTik RouterOS i️ i
OpenVMS i️ i ✔️ VMS File Listing, Paths, Capability Assumption
ProFTPD i️ i ✔️ SITE RMDIR and SITE MKDIR Commands
PureFTPd i️ i
PyFtpdLib i️ i
Rumpus i️ i
Serv-U i️ i ✔️ RMDA Command
Solaris FTP i️ i
Titan FTP i️ i
TP-LINK i️ i
VsFTPd i️ i
Windows CE i️ i ✔️ Windows File Listing
Windows Server/IIS i️ i ✔️ Windows File Listing
WS_FTP i️ i
WuFTPd i️ i ✔️ Capability Assumption
XLight i️ i

Platform Support

FluentFTP works on .NET and .NET Standard/.NET Core.

Platform Binaries Folder
.NET 4.6.2 net462
.NET 4.7.2 net472
.NET 5.0 net50
.NET 6.0 net60
.NET Standard 2.0 netstandard2.0
.NET Standard 2.1 netstandard2.1

FluentFTP is also supported on these platforms: (via .NET Standard)

  • Mono 4.6
  • Xamarin.iOS 10.0
  • Xamarin.Android 10.0
  • Universal Windows Platform 10.0

Binaries for all platforms are built from a single Visual Studio Project. You will need the latset Visual Studio to build or contribute to FluentFTP.

Example Usage

To get started, check out the Quick start example in C#.

We also have extensive examples for all methods in C# and VB.NET.

Documentation and FAQs

Check the Wiki.

Tests

We have an extensive automated test suite that tests FluentFTP against many servers. We use docker to orchestrate containerized FTP servers that are used for testing.

Sponsorship

Has FluentFTP made a difference for you or your organization? If so, consider becoming a sponsor to help keep the project thriving. Even a small monthly contribution, like $20, can make a meaningful impact.

As a seasoned freelancer with over a decade of experience, your support helps me continue dedicating time to these open-source projects while also supporting my family. Your contributions directly fuel the work that makes a difference to millions of developers around the world.

Contributors

Special thanks to these awesome people who helped create FluentFTP!

Reporting Vulnerabilities

Any security vulnerabilities that are found can be reported to the project owner at r o b i n r o d r i c k s 7 at g m a i l. No other direct correspondence will be entertained.

Software Support

FluentFTP has received free software from these generous organizations:

JetBrains provides cutting-edge IDE and developer productivity tools. Balsamiq provides rapid and effective wireframing and UI design tools. YourKit provides a market-leading intelligent Java Profiler and .NET Profiler.