ftpd 0.8.0 → 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 402da43ab955cc1f7ec47d5080556ae09c85da9d
+  data.tar.gz: 6cde23e0be18f61b46e544809127337623ee55e9
+SHA512:
+  metadata.gz: 2a434cd8438916a37900e2e6dc37a56c9b87d0628ed979f18e9ed8e1bba4f4a31252c012de9bfaa77b7078440212231ae1b073a848a5d80f5f43819277df0399
+  data.tar.gz: a9a3d3875c56cb3d8f5ba701291e9c2c22668b3d42534cdb34eb79fc81f781e49b00c42eb8cab8b5a13f67e47e2b846ddb93e7f8faf38086b4b14205a10118f1

data/Changelog.md

@@ -2,6 +2,14 @@ This is the change log for the main branch of ftpd, which supports
 Ruby 1.9 and greater.  For ruby 1.8.7, please use the latest version
 before 0.8.0.
 
+### 0.9.0
+
+Enhancements
+
+* Added example showing ftp used as a test harness with rspec
+* Ignore LIST/NLST switches such as "-a"
+* Support IPV6
+
 ### 0.8.0
 
 Administration

data/Gemfile

@@ -5,7 +5,7 @@ gem 'memoizer', '~> 1.0.1'
 group :development do
   gem 'cucumber'
   gem 'double-bag-ftps'
-  gem 'jeweler', '1.8.4'
+  gem 'jeweler'
   gem 'rake'
   gem 'redcarpet'
   gem 'rspec'

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.3.5)
     builder (3.2.2)
     cucumber (1.3.8)
       builder (>= 2.1.2)
@@ -10,20 +11,49 @@ GEM
       multi_test (>= 0.0.2)
     diff-lcs (1.2.4)
     double-bag-ftps (0.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
     gherkin (2.12.1)
       multi_json (~> 1.3)
-    git (1.2.5)
-    jeweler (1.8.4)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
     json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
     memoizer (1.0.1)
     multi_json (1.8.0)
     multi_test (0.0.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
     rake (10.1.0)
-    rdoc (4.0.0)
+    rdoc (4.0.1)
       json (~> 1.4)
     redcarpet (3.0.0)
     rspec (2.14.1)
@@ -43,7 +73,7 @@ PLATFORMS
 DEPENDENCIES
   cucumber
   double-bag-ftps
-  jeweler (= 1.8.4)
+  jeweler
   memoizer (~> 1.0.1)
   rake
   redcarpet

data/README.md

@@ -34,32 +34,35 @@ 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'
+```ruby
+require 'ftpd'
+require 'tmpdir'
 
-    class Driver
+class Driver
 
-      def initialize(temp_dir)
-        @temp_dir = temp_dir
-      end
+  def initialize(temp_dir)
+    @temp_dir = temp_dir
+  end
 
-      def authenticate(user, password)
-        true
-      end
+  def authenticate(user, password)
+    true
+  end
 
-      def file_system(user)
-        Ftpd::DiskFileSystem.new(@temp_dir)
-      end
+  def file_system(user)
+    Ftpd::DiskFileSystem.new(@temp_dir)
+  end
 
-    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
+Dir.mktmpdir do |temp_dir|
+  driver = Driver.new(temp_dir)
+  server = Ftpd::FtpServer.new(driver)
+  server.interface = '127.0.0.1'
+  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
@@ -115,15 +118,17 @@ Here are the methods a file system may expose:
 
 Ftpd includes a disk based file system:
 
-    class Driver
+```ruby
+class Driver
 
-      ...
+  ...
 
-      def file_system(user)
-        Ftpd::DiskFileSystem.new('/var/lib/ftp')
-      end
+  def file_system(user)
+    Ftpd::DiskFileSystem.new('/var/lib/ftp')
+  end
 
-    end
+end
+```
 
 **Warning**: The DiskFileSystem allows file and directory modification
 including writing, renaming, deleting, etc.  If you want a read-only
@@ -146,25 +151,30 @@ 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
+```ruby
+class BlackHole
+  def write(ftp_path, contents)
+  end
+end
 
-    class CustomDiskFileSystem
-      include DiskFileSystem::Base
-      include DiskFileSystem::Read
-      include BlackHole
-    end
+class CustomDiskFileSystem
+  include DiskFileSystem::Base
+  include DiskFileSystem::Read
+  include BlackHole
+end
+```
 
 ## Configuration
 
 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
+```ruby
+server = Ftpd::FtpServer.new(driver)
+server.session_timeout = 10 * 60
+server.interface = '127.0.0.1'
+server.start
+```
 
 You can set any of these attributes before starting the server:
 
@@ -233,6 +243,9 @@ To log to a file:
 * Implements [RFC-2389](http://tools.ietf.org/rfc/rfc2389.txt)
   (Feature negotiation mechanism for the File Transfer Protocol)
 
+* Implements [RFC-2428](http://tools.ietf.org/rfc/rfc2428.txt) (FTP
+  Extensions for IPv6 and NATs)
+
 * Implements enough of
   [RFC-4217](http://tools.ietf.org/rfc/rfc4217.txt) (Securing FTP with
   TLS) to get by.
@@ -244,8 +257,8 @@ See [RFC Compliance](doc/rfc-compliance.md) for details
 The tests pass with these Rubies:
 
 * ruby-1.8.7-p371
-* ruby-1.9.3-p392
-* ruby-2.0.0-p0
+* ruby-1.9.3-p448
+* ruby-2.0.0-p247
 
 For Ruby 1.8, use an ftpd version before 0.8.  In your Gemfile:
 
@@ -312,6 +325,17 @@ 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.
 
+### Contributors
+
+Among those who have improved ftpd are:
+
+* Alfonso Cora
+* Bjoern B. Dorra
+* Larry. W. Cashdollar
+* Michael de Silva
+
+Thank you!
+
 ## See also
 
 * [Changelog](Changelog.md)

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/doc/rfc-compliance.md

@@ -213,8 +213,8 @@ use over various network protocols, and the new response codes 522 and
 * [link](http://tools.ietf.org/rfc/rfc2428.txt)
 
 <pre>
-EPRT    No      ---     Set active data connection over IPv4 or IPv6    
-EPSV    No      ---     Set passive data connection over IPv4 or IPv6 
+EPRT    Yes    0.9.0    Set active data connection over IPv4 or IPv6    
+EPSV    Yes    0.9.0    Set passive data connection over IPv4 or IPv6 
 </pre>
 
 ##RFC-2577 - FTP Security Considerations

data/examples/example.rb

@@ -5,6 +5,7 @@ unless $:.include?(File.dirname(__FILE__) + '/../lib')
 end
 
 require 'ftpd'
+require 'ipaddr'
 require 'optparse'
 
 module Example
@@ -26,7 +27,7 @@ module Example
     attr_reader :user
 
     def initialize(argv)
-      @interface = 'localhost'
+      @interface = '127.0.0.1'
       @tls = :explicit
       @port = 0
       @auth_level = 'password'
@@ -185,8 +186,6 @@ module Example
 
     private
 
-    HOST = 'localhost'
-
     def auth_level
       Ftpd.const_get("AUTH_#{@args.auth_level.upcase}")
     end
@@ -210,10 +209,10 @@ module Example
       puts "Port: #{@server.bound_port}"
       puts "User: #{user.inspect}"
       puts "Pass: #{password.inspect}" if auth_level >= Ftpd::AUTH_PASSWORD
-      puts "Acctount: #{account.inspect}" if auth_level >= Ftpd::AUTH_ACCOUNT
+      puts "Account: #{account.inspect}" if auth_level >= Ftpd::AUTH_ACCOUNT
       puts "TLS: #{@args.tls}"
       puts "Directory: #{@data_dir}"
-      puts "URI: ftp://#{HOST}:#{@server.bound_port}"
+      puts "URI: ftp://#{connection_host}:#{@server.bound_port}"
       puts "PID: #{$$}"
     end
 
@@ -221,7 +220,7 @@ module Example
       command_path = '/tmp/connect-to-example-ftp-server.sh'
       File.open(command_path, 'w') do |file|
         file.puts "#!/bin/bash"
-        file.puts "ftp $FTP_ARGS #{HOST} #{@server.bound_port}"
+        file.puts "ftp $FTP_ARGS #{connection_host} #{@server.bound_port}"
       end
       system("chmod +x #{command_path}")
       puts "Connection script written to #{command_path}"
@@ -253,6 +252,15 @@ module Example
       @args.debug && Logger.new($stdout)
     end
 
+    def connection_host
+      addr = IPAddr.new(@server.interface)
+      if addr.ipv6?
+        '::1'
+      else
+        '127.0.0.1'
+      end
+    end
+
   end
 end
 

data/examples/example_spec.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+
+# Authour: Michael de Silva <michael@mwdesilva.com>
+# CEO @ http://omakaselabs.com / Mentor @ http://railsphd.com
+# https://twitter.com/bsodmike / https://github.com/bsodmike
+
+# This is an example for using Ftpd as a means for spec driving
+# interaction with a 'dummy' ftp server via RSpec.  In this example we
+# assume the client is implemented via `Fetcher::FTPFetcher`.
+
+unless $:.include?(File.dirname(__FILE__) + '/../lib')
+  $:.unshift(File.dirname(__FILE__) + '/../lib')
+end
+
+require 'net/ftp'
+require 'ftpd'
+require 'tmpdir'
+
+# This is an example client spec driven via the use of Ftpd within the
+# specs.  The specs spawn a 'dummy' Ftpd server and ensure this client
+# operates as expected.
+
+module Fetcher
+
+  # This is the code under test, a simple fetcher that logs into an
+  # FTP site, changes to a directlry, and gets a list of files.
+
+  class FTPFetcher
+
+    # @param host [String] ftp host to connect to.
+    # @param user [String] username.
+    # @param pwd [String] password.
+    # @param dir [String] remote directory to change to.
+
+    def initialize(host, user, pwd, dir)
+      @host = host
+      @user = user
+      @pwd = pwd
+      @dir = dir
+      @ftp = Net::FTP.new
+    end
+
+    # @param port [Fixnum] port to connect to, 21 by default.
+    # @return [Array] list of files in the current directory.
+
+    def connect_and_list(port = 21)
+      @ftp.debug_mode = true if ENV['DEBUG'] == "true"
+      @ftp.passive = true
+      @ftp.connect @host, port
+      @ftp.login @user, @pwd
+      @ftp.chdir @dir
+      @ftp.nlst
+    end
+
+  end
+end
+
+describe Fetcher::FTPFetcher do
+
+  # This `Driver` tells Ftpd how to authenticate and how to interact
+  # with the file systme.  In this example, the file system is
+  # read-only and contains a single file.
+
+  class Driver
+    def initialize
+      @data_dir = Dir.mktmpdir
+      at_exit {FileUtils.rm_rf(@data_dir)}
+      FileUtils.touch File.expand_path('report.txt', @data_dir)
+    end
+    def authenticate(user, pwd); true; end
+    def file_system(user); Ftpd::ReadOnlyDiskFileSystem.new(@data_dir); end
+  end
+
+  let(:server) do
+    server = Ftpd::FtpServer.new(Driver.new)
+    server.interface = "127.0.0.1"
+    server.start
+    server
+  end
+
+  let(:subject) do
+    Fetcher::FTPFetcher.new('127.0.0.1', 'user', 'password', '/')
+  end
+
+  describe "#connect_and_list" do
+
+    it "should connect to the FTP server and find 'report.txt' in the Array returned" do
+      result = subject.connect_and_list(server.bound_port)
+      expect(result).to include('report.txt')
+    end
+
+  end
+end

data/features/ftp_server/eprt.feature

@@ -0,0 +1,54 @@
+Feature: EPRT
+
+  As a programmer
+  I want good error messages
+  So that I can correct problems
+
+  Background:
+    Given the test server is started
+
+  Scenario: Port 1024
+    Given a successful login
+    Then the client successfully sends "EPRT |1|1.2.3.4|1024|"
+
+  Scenario: Port 1023; low ports disallowed
+    Given the test server disallows low data ports
+    And a successful login
+    When the client sends "EPRT |1|2.3.4.3|255|"
+    Then the server returns an unimplemented parameter error
+
+  Scenario: Port out of range
+    Given a successful login
+    When the client sends "EPRT |1|2.3.4.5|65536|"
+    Then the server returns an unimplemented parameter error
+
+  Scenario: Port 1023; low ports allowed
+    Given the test server allows low data ports
+    And a successful login
+    Then the client successfully sends "EPRT |1|2.3.4.3|255|"
+
+  Scenario: Not logged in
+    Given a successful connection
+    When the client sends "EPRT |1|2.3.4.5|6|"
+    Then the server returns a not logged in error
+
+  Scenario: Too few parts
+    Given a successful login
+    When the client sends "EPRT |1|2.3.4|"
+    Then the server returns a syntax error
+
+  Scenario: Too many parts
+    Given a successful login
+    When the client sends "EPRT |1|2.3.4|5|6|"
+    Then the server returns a syntax error
+
+  Scenario: Unknown network protocol
+    Given a successful login
+    When the client sends "EPRT |3|2.3.4.5|6|"
+    Then the server returns a network protocol not supported error
+
+  Scenario: After "EPSV ALL"
+    Given a successful login
+    Given the client successfully sends "EPSV ALL"
+    When the client sends "EPRT |1|2.3.4.5|6|"
+    Then the server sends a not allowed after epsv all error