SuppaFTP

SuppaFTP

Introduction 👋

SuppaFTP is a FTP/FTPS client library written in Rust, with both support for sync/async programming. It is a fork of the original ftp library "rust-ftp", but since the original library is currently unmaintened, I decided to keep working on this library by myself. Currently, I consider myself as the only maintainer of this project, indeed I've already added some features to the library and improved it with better error handling and test units. Then, feel free to use this library instead of the classic rust-ftp if you want, and if you have any feature request or issue to report, please open an issue on this repository; I will answer you as soon as possible.

Main differences between SuppaFTP and rust-ftp 🤔

Added methods to work with streams (e.g. put_with_stream) ⬇️
Added get_welcome_msg method 👋
Supports for both sync/async rust
Some extra features, such as the LIST command output parser
Replaced openssl with native-tls 🔒
Removed deprecated statements 👴
Better error handling 🐛
Added test units keeping an eye on code coverage 👀

Get started 🏁

To get started, first add suppaftp to your dependencies:

suppaftp = "4.1.2"

Features

SSL/TLS Support

If you want to enable support for FTPS, you must enable the secure feature in your cargo dependencies. FTPS support is achieved through rust-native-tls, so check if your target systems are compatible.

suppaftp = { version = "4.1.2", features = ["secure"] }

Async support

If you want to enable async support, you must enable async feature in your cargo dependencies.

suppaftp = { version = "4.1.2", features = ["async"] }

⚠️ If you want to enable both secure and async you must use the async-secure feature ⚠️

Example 📚

extern crate suppaftp;

use std::str;
use std::io::Cursor;
use suppaftp::FtpStream;

fn main() {
    // Create a connection to an FTP server and authenticate to it.
    let mut ftp_stream = FtpStream::connect("127.0.0.1:21").unwrap();
    let _ = ftp_stream.login("username", "password").unwrap();

    // Get the current directory that the client will be reading from and writing to.
    println!("Current directory: {}", ftp_stream.pwd().unwrap());

    // Change into a new directory, relative to the one we are currently in.
    let _ = ftp_stream.cwd("test_data").unwrap();

    // Retrieve (GET) a file from the FTP server in the current working directory.
    let data = ftp_stream.retr_as_buffer("ftpext-charter.txt").unwrap();
    println!("Read file with contents\n{}\n", str::from_utf8(&data.into_inner()).unwrap());

    // Store (PUT) a file from the client to the current working directory of the server.
    let mut reader = Cursor::new("Hello from the Rust \"ftp\" crate!".as_bytes());
    let _ = ftp_stream.put("greeting.txt", &mut reader);
    println!("Successfully wrote greeting.txt");

    // Terminate the connection to the server.
    let _ = ftp_stream.quit();
}

Going Async

use suppaftp::FtpStream;
use suppftp::async_native_tls::{TlsConnector, TlsStream};
let ftp_stream = FtpStream::connect("test.rebex.net:21").await.unwrap();
// Switch to the secure mode
let mut ftp_stream = ftp_stream.into_secure(TlsConnector::new(), "test.rebex.net").await.unwrap();
ftp_stream.login("demo", "password").await.unwrap();
// Do other secret stuff
// Do all public stuff
assert!(ftp_stream.quit().await.is_ok());

Built-in CLI client 🖥️

SuppaFTP comes also with a built-in command line FTP client. This CLI application provides all the commands to interact with a remote FTP server and supports FTPS too. You can also use it as a reference to implement your project. You can find it in the cli/ directory.

You can just install as any other rust application via Cargo:

cargo install suppaftp --features="secure cli-bin"

Buy me a coffee ☕

If you like SuppaFTP, please consider a little donation 🥳

Changelog

View Changelog here

License 📜

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution 🤝

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

If you want to contribute to this project, please read the Contributing guide first 🙂.

suppaftp 4.1.2