ftpd is a pure Ruby FTP server library. It supports implicit and explicit TLS, IPV6, passive and active mode, and is unconditionally compliant per RFC-1123. It can be used as part of a test fixture or embedded in a program.
This readme contains Yardoc markup for links to the API docs; those links don't display properly on github. You'll find a properly rendered version on rubydoc.info
Ftpd has been used for many years to test FTP clients, and is stable and reliable for that purpose. However, it was not originally intended to be part of a publically accessible FTP server. I would be cautious in using it in an untrusted environment due to the probability that it contains critical flaws (or even security vulnarabilities) that have not been discovered in its use as a test harness.
This is examples/hello_world.rb, a bare minimum FTP server. It allows any user/password, and serves files in a temporary directory. It binds to an ephemeral port on the local interface:
require 'ftpd'
require 'tmpdir'
class Driver
def initialize(temp_dir)
@temp_dir = temp_dir
end
def authenticate(user, password)
true
end
def file_system(user)
Ftpd::DiskFileSystem.new(@temp_dir)
end
end
Dir.mktmpdir do |temp_dir|
driver = Driver.new(temp_dir)
server = Ftpd::FtpServer.new(driver)
server.start
puts "Server listening on port #{server.bound_port}"
gets
end
A more full-featured example that allows TLS and takes options is in examples/example.rb
Ftpd's dynamic behavior such as authentication and file retrieval is controlled by a driver that you supply. The Driver class in the "hello world" example above shows a rudimentary driver. Ftpd calls the authenticate method to decide who can log in. Once someone is logged on, it calls the file_system method to obtain a file system driver for that user.
There is no base class for a driver. Any object that quacks like a driver will do. Here are the methods your driver needs:
The file system object that the driver supplies to Ftpd is Ftpd's gateway to the logical file system. Ftpd doesn't know or care whether it's serving files from disk, memory, or any other means.
The file system can be very minimal. If the file system is missing certain methods, the server simply disables the commands which need that method. For example, if there is no write method, then STOR is not supported and causes a "502 Command not implemented" response to the client.
The canonical and commented example of an Ftpd file system is {Ftpd::DiskFileSystem}. You can use it as a template for creating your own, and its comments are the official specification for an Ftpd file system.
Here are the methods a file system may expose:
Ftpd includes a disk based file system:
class Driver
...
def file_system(user)
Ftpd::DiskFileSystem.new('/var/lib/ftp')
end
end
Warning: The DiskFileSystem allows file and directory modification including writing, renaming, deleting, etc. If you want a read-only file system, then use {Ftpd::ReadOnlyDiskFileSystem} instead.
The DiskFileSystem is composed out of modules:
You can use these modules to create a custom disk file system that allows only the operations you want, or which mixes the predefined modules with your customizations, as in this silly example that allows uploads but then throws them away.
class BlackHole
def write(ftp_path, contents)
end
end
class CustomDiskFileSystem
include DiskFileSystem::Base
include DiskFileSystem::Read
include BlackHole
end
Configuration is done via accessors on {Ftpd::FtpServer}. For example, to set the session timeout to 10 minutes:
server = Ftpd::FtpServer.new(driver)
server.session_timeout = 10 * 60
server.start
You can set any of these attributes before starting the server:
By default, the LIST command uses Unix "ls -l" formatting:
-rw-r--r-- 1 user group 1234 Mar 3 08:38 foo
An alternative to "ls -l" formatting is Easily Parsed LIST format (EPLF) format:
+r,s1234,m1362325080\tfoo
to configure Ftpd for EPLF formatting:
ftp_server.list_formatter = Ftpd::ListFormat::Eplf
To create your own custom formatter, create a class with these methods:
And register your class with the ftp_server before starting it:
ftp_server.list_formatter = MyListFormatter
Ftpd can write to an instance of {http://www.ruby-doc.org/stdlib-2.0.0/libdoc/logger/rdoc/Logger.html Logger} that you provide. To log to standard out:
server.log = Logger.new($stdout)
To log to a file:
server.log = Logger.new('/tmp/ftpd.log')
Unconditionally compliant per RFC-1123 (Requirements for Internet Hosts).
Implements all of the security recommendations in RFC-2577 (FTP Security Considerations).
Implements RFC-2389 (Feature negotiation mechanism for the File Transfer Protocol)
Implements RFC-2428 (FTP Extensions for IPv6 and NATs)
Implements enough of RFC-4217 (Securing FTP with TLS) to get by.
See RFC Compliance for details
The tests pass with these Rubies:
For Ruby 1.8, use an ftpd version before 0.8. In your Gemfile:
gem 'ftpd', '<0.8'
Ftpd runs on:
The master branch of ftpd does not currently run on Windows. There is an experimental branch for Windows which contains several changes that ought to make ftpd work on Windows, but they need testing. To try that branch, use this line in your Gemfile:
gem 'ftpd', github: 'wconrad/ftpd', branch: 'windows'
Does it work for you? Is it busted? Please report your experience here.
To run the cucumber (functional) tests:
$ rake test:features
To run the rspec (unit) tests:
$ rake test:spec
To run all tests:
$ rake test
or just:
$ rake
To force features to write the server log to stdout:
$ FTPD_DEBUG=1 rake test:features
The stand-alone example is good for manually testing Ftpd with any FTP client. To run the stand-alone example:
$ examples/example.rb
The example prints its port, username and password to the console. You can connect to the stand-alone example with any FTP client.
example.rb has many options. To see them:
$ examples/example.rb -h
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)I created ftpd to support the test framework I wrote for Databill, LLC, which has given its kind permission to donate it to the community.
Wayne Conrad wconrad@yagni.com
Thanks to Databill, LLC, which supported the creation of this library, and granted permission to donate it to the community.
Among those who have improved ftpd are:
If I've forgotten to add you, please remind me, or submit a merge request.
Thank you!
FAQs
Unknown package
We found that investtools-ftpd demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.