libunftp

When you need to FTP, but don't want to.

Website | API Docs | unFTP

The libunftp library drives unFTP. It's an extensible, async, cloud orientated FTP(S) server implementation in Rust brought to you by the bol.com techlab.

Because of its plug-able authentication (e.g. PAM, JSON File, Generic REST) and storage backends (e.g. local filesystem, Google Cloud Storage) it's more flexible than traditional FTP servers and a perfect match for the cloud.

It runs on top of the Tokio asynchronous run-time and tries to make use of Async IO as much as possible.

Feature highlights:

• 39 Supported FTP commands (see commands directory) and growing
• Ability to implement own storage back-ends
• Ability to implement own authentication back-ends
• Explicit FTPS (TLS)
• Mutual TLS (Client certificates)
• TLS session resumption
• Prometheus integration
• Structured Logging
• Proxy Protocol support
• Automatic session timeouts
• Per user IP allow lists

Known storage back-ends:

• unftp-sbe-fs - Stores files on the local filesystem
• unftp-sbe-gcs - Stores files in Google Cloud Storage

Known authentication back-ends:

• unftp-auth-jsonfile - Authenticates against JSON text.
• unftp-auth-pam - Authenticates via PAM.
• unftp-auth-rest - Consumes an HTTP API to authenticate.

Prerequisites

You'll need Rust 1.41 or higher to build libunftp.

Getting started

If you've got Rust and cargo installed, create your project with

cargo new myftp

Add the libunftp and tokio crates to your project's dependencies in Cargo.toml. Then also choose a storage back-end implementation to add. Here we choose the file system back-end:

[dependencies]
libunftp = "0.18.9"
unftp-sbe-fs = "0.2"
tokio = { version = "1", features = ["full"] }

Now you're ready to develop your server! Add the following to src/main.rs:

use unftp_sbe_fs::ServerExt;

#[tokio::main]
pub async fn main() {
    let ftp_home = std::env::temp_dir();
    let server = libunftp::Server::with_fs(ftp_home)
        .greeting("Welcome to my FTP server")
        .passive_ports(50000..65535);
    
    server.listen("127.0.0.1:2121").await;
}

You can now run your server with cargo run and connect to localhost:2121 with your favourite FTP client e.g.:

lftp -p 2121 localhost

For more help refer to:

• the examples directory.
• the API Documentation.
• unFTP server, a server from the bol.com techlab that is built on top of libunftp.
• this blog post about libunftp and unFTP.

Getting help and staying informed

Support is given on a best effort basis. You are welcome to engage us on the discussions page or create a Github issue.

You can also follow news and talk to us on Telegram

Contributing

Thank you for your interest in contributing to libunftp!

Please feel free to create a Github issue if you encounter any problems.

Want to submit a feature request or develop your own storage or authentication back-end? Then head over to our contribution guide (CONTRIBUTING.md).

License

You're free to use, modify and distribute this software under the terms of the Apache License v2.0.