ftpd 0.8.0 → 0.9.0

data/features/ftp_server/epsv.feature

@@ -0,0 +1,36 @@
+Feature: EPSV
+
+  As a programmer
+  I want good error messages
+  So that I can correct problems
+
+  Background:
+    Given the test server is bound to "::"
+    And the test server is started
+
+  Scenario: No argument
+    Given a successful login
+    Then the client successfully sends "EPSV"
+
+  Scenario: Explicit IPV4
+    Given a successful login
+    Then the client successfully sends "EPSV 1"
+
+  Scenario: Explicit IPV6
+    Given a successful login
+    Then the client successfully sends "EPSV 2"
+
+  Scenario: After "EPSV ALL"
+    Given a successful login
+    Given the client successfully sends "EPSV ALL"
+    Then the client successfully sends "EPSV"
+
+  Scenario: Not logged in
+    Given a successful connection
+    When the client sends "EPSV"
+    Then the server returns a not logged in error
+
+  Scenario: Unknown network protocol
+    Given a successful login
+    When the client sends "EPSV 99"
+    Then the server returns a network protocol not supported error

data/features/ftp_server/get_ipv6.feature

@@ -0,0 +1,43 @@
+Feature: Get IPV6
+
+  As a client
+  I want to get a file
+  So that I have it on my computer
+
+  Scenario: Active
+    Given the test server is bound to "::1"
+    And the test server is started
+    And a successful login
+    And the server has file "ascii_unix"
+    And the client is in active mode
+    When the client successfully gets text "ascii_unix"
+    Then the local file "ascii_unix" should match the remote file
+
+  Scenario: Passive
+    Given the test server is bound to "::1"
+    And the test server is started
+    And a successful login
+    And the server has file "ascii_unix"
+    And the client is in passive mode
+    When the client successfully gets text "ascii_unix"
+    Then the local file "ascii_unix" should match the remote file
+
+  Scenario: Active, TLS
+    Given the test server is bound to "::1"
+    And the test server has TLS mode "explicit"
+    And the test server is started
+    And a successful login
+    And the server has file "ascii_unix"
+    And the client is in active mode
+    When the client successfully gets text "ascii_unix"
+    Then the local file "ascii_unix" should match the remote file
+
+  Scenario: Passive, TLS
+    Given the test server is bound to "::1"
+    And the test server has TLS mode "explicit"
+    And the test server is started
+    And a successful login
+    And the server has file "ascii_unix"
+    And the client is in passive mode
+    When the client successfully gets text "ascii_unix"
+    Then the local file "ascii_unix" should match the remote file

data/features/ftp_server/list.feature

@@ -68,6 +68,15 @@ Feature: List
     And the file list should contain "foo"
     And the file list should contain "bar"
 
+  Scenario: -a
+    Given a successful login
+    And the server has file "foo"
+    And the server has file "bar"
+    When the client successfully lists the directory "-a"
+    Then the file list should be in long form
+    And the file list should contain "foo"
+    And the file list should contain "bar"
+
   Scenario: Missing directory
     Given a successful login
     When the client successfully lists the directory "missing/file"

data/features/ftp_server/name_list.feature

@@ -41,6 +41,15 @@ Feature: Name List
     Then the file list should be in short form
     And the file list should contain "foo"
 
+  Scenario: '-a'
+    Given a successful login
+    And the server has file "foo"
+    And the server has file "bar"
+    When the client successfully name-lists the directory "-a"
+    Then the file list should be in short form
+    And the file list should contain "foo"
+    And the file list should contain "bar"
+
   Scenario: Passive
     Given a successful login
     And the server has file "foo"

data/features/ftp_server/pasv.feature

@@ -0,0 +1,23 @@
+Feature: PASV
+
+  As a programmer
+  I want good error messages
+  So that I can correct problems
+
+  Background:
+    Given the test server is started
+
+  Scenario: No argument
+    Given a successful login
+    Then the client successfully sends "PASV"
+
+  Scenario: After "EPSV ALL"
+    Given a successful login
+    Given the client successfully sends "EPSV ALL"
+    When the client sends "PASV"
+    Then the server sends a not allowed after epsv all error
+
+  Scenario: Not logged in
+    Given a successful connection
+    When the client sends "EPSV"
+    Then the server returns a not logged in error

data/features/ftp_server/port.feature

@@ -1,4 +1,4 @@
-Feature: Port
+Feature: PORT
 
   As a programmer
   I want good error messages
@@ -41,3 +41,9 @@ Feature: Port
     Given a successful login
     When the client sends PORT "1,2,3,4,5,256"
     Then the server returns a syntax error
+
+  Scenario: After "EPSV ALL"
+    Given a successful login
+    Given the client successfully sends "EPSV ALL"
+    When the client sends "PORT 1,2,3,4,4,0"
+    Then the server sends a not allowed after epsv all error

data/features/ftp_server/step_definitions/test_server.rb

@@ -10,6 +10,10 @@ Given /^the test server has TLS mode "(\w+)"$/ do |mode|
   server.tls = mode.to_sym
 end
 
+Given(/^the test server is bound to "(.*?)"$/) do |ip_address|
+  server.interface = ip_address
+end
+
 Given /^the test server has logging (enabled|disabled)$/ do |state|
   server.logging = state == 'enabled'
 end

data/features/step_definitions/connect.rb

@@ -3,7 +3,7 @@ require 'net/ftp'
 
 When /^the( \w+)? client connects(?: with (\w+) TLS)?$/ do
 |client_name, tls_mode|
-  tls_mode ||= :off
+  tls_mode ||= 'off'
   client(client_name).tls_mode = tls_mode.to_sym
   client(client_name).start
   client(client_name).connect(server.host, server.port)

data/features/step_definitions/error_replies.rb

@@ -105,3 +105,11 @@ end
 Then /^the server returns an already exists error$/ do
   step 'the server returns a "550 Already exists" error'
 end
+
+Then /^the server returns a network protocol not supported error$/ do
+  step 'the server returns a "522 Network protocol" error'
+end
+
+Then /^the server sends a not allowed after epsv all error$/ do
+  step 'the server returns a "501 Not allowed after EPSV ALL" error'
+end

data/features/support/test_server.rb

@@ -219,6 +219,7 @@ class TestServer
   def_delegator :@server, :'auth_level'
   def_delegator :@server, :'auth_level='
   def_delegator :@server, :'failed_login_delay='
+  def_delegator :@server, :'interface='
   def_delegator :@server, :'max_connections='
   def_delegator :@server, :'max_connections_per_ip='
   def_delegator :@server, :'max_failed_logins='
@@ -250,7 +251,7 @@ class TestServer
   end
 
   def host
-    'localhost'
+    @server.interface
   end
 
   def user

data/ftpd.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "0.8.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Conrad"]
-  s.date = "2013-09-15"
+  s.date = "2013-10-01"
   s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, passive and active mode, and is unconditionally compliant per [RFC-1123][1].  It an be used as part of a test fixture or embedded in a program."
   s.email = "wconrad@yagni.com"
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "doc/references.md",
     "doc/rfc-compliance.md",
     "examples/example.rb",
+    "examples/example_spec.rb",
     "examples/hello_world.rb",
     "features/example/eplf.feature",
     "features/example/example.feature",
@@ -44,9 +45,12 @@ Gem::Specification.new do |s|
     "features/ftp_server/delete.feature",
     "features/ftp_server/directory_navigation.feature",
     "features/ftp_server/disconnect_after_failed_logins.feature",
+    "features/ftp_server/eprt.feature",
+    "features/ftp_server/epsv.feature",
     "features/ftp_server/features.feature",
     "features/ftp_server/file_structure.feature",
     "features/ftp_server/get.feature",
+    "features/ftp_server/get_ipv6.feature",
     "features/ftp_server/get_tls.feature",
     "features/ftp_server/help.feature",
     "features/ftp_server/implicit_tls.feature",
@@ -64,6 +68,7 @@ Gem::Specification.new do |s|
     "features/ftp_server/name_list_tls.feature",
     "features/ftp_server/noop.feature",
     "features/ftp_server/options.feature",
+    "features/ftp_server/pasv.feature",
     "features/ftp_server/port.feature",
     "features/ftp_server/put.feature",
     "features/ftp_server/put_tls.feature",
@@ -144,7 +149,9 @@ Gem::Specification.new do |s|
     "lib/ftpd/insecure_certificate.rb",
     "lib/ftpd/list_format/eplf.rb",
     "lib/ftpd/list_format/ls.rb",
+    "lib/ftpd/list_path.rb",
     "lib/ftpd/null_logger.rb",
+    "lib/ftpd/protocols.rb",
     "lib/ftpd/read_only_disk_file_system.rb",
     "lib/ftpd/server.rb",
     "lib/ftpd/session.rb",
@@ -167,7 +174,9 @@ Gem::Specification.new do |s|
     "spec/file_system_error_translator_spec.rb",
     "spec/list_format/eplf_spec.rb",
     "spec/list_format/ls_spec.rb",
+    "spec/list_path_spec.rb",
     "spec/null_logger_spec.rb",
+    "spec/protocols_spec.rb",
     "spec/spec_helper.rb",
     "spec/telnet_spec.rb",
     "spec/translate_exceptions_spec.rb"
@@ -175,17 +184,17 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/wconrad/ftpd"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "2.0.0"
   s.summary = "Pure Ruby FTP server library"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<memoizer>, ["~> 1.0.1"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<double-bag-ftps>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["= 1.8.4"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<redcarpet>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
@@ -195,7 +204,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<memoizer>, ["~> 1.0.1"])
       s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<double-bag-ftps>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["= 1.8.4"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<redcarpet>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
@@ -206,7 +215,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<memoizer>, ["~> 1.0.1"])
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<double-bag-ftps>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["= 1.8.4"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<redcarpet>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])

data/lib/ftpd.rb

@@ -25,7 +25,9 @@ module Ftpd
   autoload :FileSystemMethodMissing,   'ftpd/file_system_method_missing'
   autoload :FtpServer,                 'ftpd/ftp_server'
   autoload :InsecureCertificate,       'ftpd/insecure_certificate'
+  autoload :ListPath,                  'ftpd/list_path'
   autoload :NullLogger,                'ftpd/null_logger'
+  autoload :Protocols,                 'ftpd/protocols'
   autoload :ReadOnlyDiskFileSystem,    'ftpd/read_only_disk_file_system'
   autoload :Server,                    'ftpd/server'
   autoload :Session,                   'ftpd/session'

data/lib/ftpd/list_path.rb

@@ -0,0 +1,28 @@
+module Ftpd
+
+  # Functions for manipulating LIST and NLST arguments
+
+  module ListPath
+
+    # Turn the argument to LIST/NLST into a path
+    #
+    # @param argument [String] The argument, or nil if not present
+    # @return [String] The path
+    #
+    # Although compliant with the spec, this function does not do
+    # these things that traditional Unix FTP servers do:
+    #
+    # * Allow multiple paths
+    # * Handle switches such as "-a"
+    #
+    # See: http://cr.yp.to/ftp/list.html sections "LIST parameters"
+    # and "LIST wildcards"
+
+    def list_path(argument)
+      argument ||= '.'
+      argument = '' if argument =~ /^-/
+      argument
+    end
+
+  end
+end

data/lib/ftpd/protocols.rb

@@ -0,0 +1,60 @@
+module Ftpd
+
+  # With the commands EPORT and EPSV, the client sends a protocol code
+  # to indicate whether it wants an IPV4 or an IPV6 connection.  This
+  # class contains functions related to that protocol code.
+
+  class Protocols
+
+    module Codes
+      IPV4 = 1
+      IPV6 = 2
+    end
+    include Codes
+
+    # @param socket [TCPSocket, OpenSSL::SSL::SSLSocket] The socket.
+    #   It doesn't matter whether it's the server socket (the one on
+    #   which #accept is called), or the socket returned by #accept.
+
+    def initialize(socket)
+      @socket = socket
+    end
+
+    # Can the socket support a connection in the indicated protocol?
+    #
+    # @param protocol_code [Integer] protocol code
+
+    def supports_protocol?(protocol_code)
+      protocol_codes.include?(protocol_code)
+    end
+
+    # What protocol codes does the socket support?
+    #
+    # @return [Array<Integer>] List of protocol codes
+
+    def protocol_codes
+      [
+        (IPV4 if supports_ipv4?),
+        (IPV6 if supports_ipv6?),
+      ].compact
+    end
+
+    private
+
+    def supports_ipv4?
+      @socket.local_address.ipv4? || ipv6_dual_stack?
+    end
+
+    def supports_ipv6?
+      @socket.local_address.ipv6?
+    end
+
+    def ipv6_dual_stack?
+      v6only = @socket.getsockopt(Socket::IPPROTO_IPV6,
+                                  Socket::IPV6_V6ONLY).unpack('i')
+      v6only == [0]
+    end
+
+  end
+
+end

data/lib/ftpd/session.rb

@@ -4,6 +4,7 @@ module Ftpd
   class Session
 
     include Error
+    include ListPath
 
     def initialize(opts)
       @failed_login_delay = opts[:failed_login_delay]
@@ -25,6 +26,7 @@ module Ftpd
       end
       @command_sequence_checker = init_command_sequence_checker
       set_socket_options
+      @protocols = Protocols.new(@socket)
       initialize_session
     end
 
@@ -108,6 +110,7 @@ module Ftpd
 
     def cmd_port(argument)
       ensure_logged_in
+      ensure_not_epsv_all
       pieces = argument.split(/,/)
       syntax_error unless pieces.size == 6
       pieces.collect! do |s|
@@ -118,11 +121,7 @@ module Ftpd
       end
       hostname = pieces[0..3].join('.')
       port = pieces[4] << 8 | pieces[5]
-      if port < 1024 && !@allow_low_data_ports
-        error "504 Command not implemented for that parameter"
-      end
-      @data_hostname = hostname
-      @data_port = port
+      set_active_mode_address hostname, port
       reply "200 PORT command successful"
     end
 
@@ -201,8 +200,7 @@ module Ftpd
         ensure_logged_in
         ensure_file_system_supports :dir
         ensure_file_system_supports :file_info
-        path = argument
-        path ||= '.'
+        path = list_path(argument)
         path = File.expand_path(path, @name_prefix)
         transmit_file(list(path), 'A')
       end
@@ -212,8 +210,7 @@ module Ftpd
       close_data_server_socket_when_done do
         ensure_logged_in
         ensure_file_system_supports :dir
-        path = argument
-        path ||= '.'
+        path = list_path(argument)
         path = File.expand_path(path, @name_prefix)
         transmit_file(name_list(path), 'A')
       end
@@ -265,6 +262,7 @@ module Ftpd
 
     def cmd_pasv(argument)
       ensure_logged_in
+      ensure_not_epsv_all
       if @data_server
         reply "200 Already in passive mode"
       else
@@ -360,6 +358,12 @@ module Ftpd
       end
     end
 
+    def ensure_not_epsv_all
+      if @epsv_all
+        error "501 Not allowed after EPSV ALL"
+      end
+    end
+
     def tls_enabled?
       @tls != :off
     end
@@ -490,6 +494,49 @@ module Ftpd
       error '501 Unsupported option'
     end
 
+    def cmd_eprt(argument)
+      ensure_logged_in
+      ensure_not_epsv_all
+      delim = argument[0..0]
+      parts = argument.split(delim)[1..-1]
+      syntax_error unless parts.size == 3
+      protocol_code, address, port = *parts
+      protocol_code = protocol_code.to_i
+      ensure_protocol_supported protocol_code
+      port = port.to_i
+      set_active_mode_address address, port
+      reply "200 EPRT command successful"
+    end
+
+    def ensure_protocol_supported(protocol_code)
+      unless @protocols.supports_protocol?(protocol_code)
+        protocol_list = @protocols.protocol_codes.join(',')
+        error("522 Network protocol #{protocol_code} not supported, "\
+              "use (#{protocol_list})")
+      end
+    end
+
+    def cmd_epsv(argument)
+      ensure_logged_in
+      if @data_server
+        reply "200 Already in passive mode"
+      else
+        if argument == 'ALL'
+          @epsv_all = true
+          reply "220 EPSV now required for port setup"
+        else
+          protocol_code = argument && argument.to_i
+          if protocol_code
+            ensure_protocol_supported protocol_code
+          end
+          interface = @socket.addr[3]
+          @data_server = TCPServer.new(interface, 0)
+          port = @data_server.addr[1]
+          reply "229 Entering extended passive mode (|||#{port}|)"
+        end
+      end
+    end
+
     unimplemented :abor
     unimplemented :rein
     unimplemented :rest
@@ -498,7 +545,8 @@ module Ftpd
 
     def extensions
       [
-        (TLS_EXTENSIONS if tls_enabled?)
+        (TLS_EXTENSIONS if tls_enabled?),
+        IPV6_EXTENSIONS,
       ].flatten.compact
     end
 
@@ -508,6 +556,11 @@ module Ftpd
       'PROT'
     ]
 
+    IPV6_EXTENSIONS = [
+      'EPRT',
+      'EPSV',
+    ]
+
     def supported_commands
       private_methods.map do |method|
         method.to_s[/^cmd_(\w+)$/, 1]
@@ -823,6 +876,18 @@ module Ftpd
       end
     end
 
+    def set_data_address(n)
+
+    end
+
+    def set_active_mode_address(address, port)
+      if port > 0xffff || port < 1024 && !@allow_low_data_ports
+        error "504 Command not implemented for that parameter"
+      end
+      @data_hostname = address
+      @data_port = port
+    end
+
     def initialize_session
       @logged_in = false
       @data_type = 'A'
@@ -833,6 +898,7 @@ module Ftpd
       @data_hostname = nil
       @data_port = nil
       @protection_buffer_size_set = 0
+      @epsv_all = false
       close_data_server_socket
       reset_failed_auths
     end