ftpd 0.3.2 → 0.4.0

data/lib/ftpd.rb

@@ -20,6 +20,7 @@ module Ftpd
   autoload :FileSystemMethodMissing,   'ftpd/file_system_method_missing'
   autoload :FtpServer,                 'ftpd/ftp_server'
   autoload :InsecureCertificate,       'ftpd/insecure_certificate'
+  autoload :ReadOnlyDiskFileSystem,    'ftpd/read_only_disk_file_system'
   autoload :Server,                    'ftpd/server'
   autoload :Session,                   'ftpd/session'
   autoload :TempDir,                   'ftpd/temp_dir'
@@ -27,4 +28,5 @@ module Ftpd
   autoload :TranslateExceptions,       'ftpd/translate_exceptions'
 end
 
+require 'ftpd/auth_levels'
 require 'ftpd/exceptions'

data/lib/ftpd/auth_levels.rb

@@ -0,0 +1,9 @@
+module Ftpd
+
+  # Authorization levels for FtpServer#auth_level
+
+  AUTH_USER = 0
+  AUTH_PASSWORD = 1
+  AUTH_ACCOUNT = 2
+
+end

data/lib/ftpd/disk_file_system.rb

@@ -40,14 +40,6 @@ module Ftpd
       # directory named by the path may not exist.
       # @param ftp_path [String] The virtual path
       # @return [Boolean]
-      #
-      # Called for:
-      # * STOR
-      # * RETR
-      # * DELE
-      # * CWD
-      # * MKD
-      # * RMD
 
       def accessible?(ftp_path)
         # The server should never try to access a path outside of the
@@ -59,13 +51,6 @@ module Ftpd
       # Return true if the file or directory path exists.
       # @param ftp_path [String] The virtual path
       # @return [Boolean]
-      #
-      # Called for:
-      # * STOR (with directory)
-      # * RETR
-      # * DELE
-      # * CWD
-      # * MKD
 
       def exists?(ftp_path)
         File.exists?(expand_ftp_path(ftp_path))
@@ -74,10 +59,6 @@ module Ftpd
       # Return true if the path exists and is a directory.
       # @param ftp_path [String] The virtual path
       # @return [Boolean]
-      #
-      # Called for:
-      # * CWD
-      # * MKD
 
       def directory?(ftp_path)
         File.directory?(expand_ftp_path(ftp_path))
@@ -162,6 +143,33 @@ module Ftpd
     end
   end
 
+  class DiskFileSystem
+
+    # DiskFileSystem mixin providing file appending
+
+    module Append
+
+      include TranslateExceptions
+
+      # Append to a file.  If the file does not exist, create it.
+      # @param ftp_path [String] The virtual path
+      # @contents [String] The file's contents
+      #
+      # Called for:
+      # * APPE
+      #
+      # If missing, then these commands are not supported.
+
+      def append(ftp_path, contents)
+        File.open(expand_ftp_path(ftp_path), 'ab') do |file|
+          file.write contents
+        end
+      end
+      translate_exceptions :append
+
+    end
+  end
+
   class DiskFileSystem
 
     # DiskFileSystem mixing providing mkdir
@@ -360,6 +368,7 @@ module Ftpd
     # can be safely left out with the only effect being to make One or
     # more commands be unimplemented.
 
+    include DiskFileSystem::Append
     include DiskFileSystem::Delete
     include DiskFileSystem::List
     include DiskFileSystem::Mkdir
@@ -377,4 +386,24 @@ module Ftpd
     end
 
   end
+
+  # A disk file system that does not allow any modification (writes,
+  # deletes, etc.)
+
+  class ReadOnlyDiskFileSystem
+
+    include DiskFileSystem::Base
+    include DiskFileSystem::List
+    include DiskFileSystem::Read
+
+    # Make a new instance to serve a directory.  data_dir should be an
+    # absolute path.
+
+    def initialize(data_dir)
+      set_data_dir data_dir
+      translate_exception SystemCallError
+    end
+
+  end
+
 end

data/lib/ftpd/ftp_server.rb

@@ -31,6 +31,14 @@ module Ftpd
 
     attr_accessor :list_formatter
 
+    # @return [Integer] The authentication level
+    # One of:
+    # * Ftpd::AUTH_USER
+    # * Ftpd::AUTH_PASSWORD (default)
+    # * Ftpd::AUTH_ACCOUNT
+
+    attr_accessor :auth_level
+
     # Create a new FTP server.  The server won't start until the
     # #start method is called.
     #
@@ -38,15 +46,8 @@ module Ftpd
     #               authentication and file system access.
     #
     # The driver should expose these public methods:
-    #
-    #     # Return truthy if the user/password should be allowed to
-    #     # log in.
-    #     authenticate(user, password)
-    #     
-    #     # Return the file system to use for a user.  The file system
-    #     # should expose the same public methods as
-    #     # Ftpd::DiskFileSystem.
-    #     def file_system(user)
+    # * {Example::Driver#authenticate authenticate}
+    # * {Example::Driver#file_system file_system}
 
     def initialize(driver)
       super()
@@ -55,6 +56,7 @@ module Ftpd
       @debug = false
       @response_delay = 0
       @list_formatter = ListFormat::Ls
+      @auth_level = AUTH_PASSWORD
     end
 
     private
@@ -66,7 +68,8 @@ module Ftpd
                   :debug_path => debug_path,
                   :list_formatter => @list_formatter,
                   :response_delay => response_delay,
-                  :tls => @tls).run
+                  :tls => @tls,
+                  :auth_level => @auth_level).run
     end
 
   end

data/lib/ftpd/read_only_disk_file_system.rb

@@ -0,0 +1,22 @@
+module Ftpd
+
+  # A disk file system that does not allow any modification (writes,
+  # deletes, etc.)
+
+  class ReadOnlyDiskFileSystem
+
+    include DiskFileSystem::Base
+    include DiskFileSystem::List
+    include DiskFileSystem::Read
+
+    # Make a new instance to serve a directory.  data_dir should be an
+    # absolute path.
+
+    def initialize(data_dir)
+      set_data_dir data_dir
+      translate_exception SystemCallError
+    end
+
+  end
+
+end

data/lib/ftpd/session.rb

@@ -7,6 +7,7 @@ module Ftpd
 
     def initialize(opts)
       @driver = opts[:driver]
+      @auth_level = opts[:auth_level]
       @socket = opts[:socket]
       @tls = opts[:tls]
       if @tls == :implicit
@@ -18,7 +19,6 @@ module Ftpd
       @list_formatter = opts[:list_formatter]
       @data_type = 'A'
       @mode = 'S'
-      @format = 'N'
       @structure = 'F'
       @response_delay = opts[:response_delay]
       @data_channel_protection_level = :clear
@@ -65,19 +65,29 @@ module Ftpd
       syntax_error unless argument
       sequence_error if @logged_in
       @user = argument
-      reply "331 Password required"
-      expect 'pass'
+      if @auth_level > AUTH_USER
+        reply "331 Password required"
+        expect 'pass'
+      else
+        login(@user)
+      end
     end
 
     def cmd_pass(argument)
       syntax_error unless argument
-      password = argument
-      unless @driver.authenticate(@user, password)
-        error "530 Login incorrect"
+      @password = argument
+      if @auth_level > AUTH_PASSWORD
+        reply "332 Account required"
+        expect 'acct'
+      else
+        login(@user, @password)
       end
-      reply "230 Logged in"
-      set_file_system @driver.file_system(@user)
-      @logged_in = true
+    end
+
+    def cmd_acct(argument)
+      syntax_error unless argument
+      account = argument
+      login(@user, @password, account)
     end
 
     def cmd_quit(argument)
@@ -136,6 +146,20 @@ module Ftpd
       end
     end
 
+    def cmd_appe(argument)
+      close_data_server_socket_when_done do
+        ensure_logged_in
+        ensure_file_system_supports :append
+        path = argument
+        syntax_error unless path
+        path = File.expand_path(path, @name_prefix)
+        ensure_accessible path
+        contents = receive_file
+        @file_system.append path, contents
+        reply "226 Transfer complete"
+      end
+    end
+
     def cmd_retr(argument)
       close_data_server_socket_when_done do
         ensure_logged_in
@@ -190,26 +214,20 @@ module Ftpd
       syntax_error unless argument =~ /^(\S)(?: (\S+))?$/
       type_code = $1
       format_code = $2
-      set_type(type_code)
-      set_format(format_code)
+      unless argument =~ /^([AEI]( [NTC])?|L .*)$/
+        error '504 Invalid type code'
+      end
+      case argument
+      when /^A( [NT])?$/
+        @data_type = 'A'
+      when /^(I|L 8)$/
+        @data_type = 'I'
+      else
+        error '504 Type not implemented'
+      end
       reply "200 Type set to #{@data_type}"
     end
 
-    def set_type(type_code)
-      name, implemented = DATA_TYPES[type_code]
-      error "504 Invalid type code" unless name
-      error "504 Type not implemented" unless implemented
-      @data_type = type_code
-    end
-
-    def set_format(format_code)
-      format_code ||= 'N'
-      name, implemented = FORMAT_TYPES[format_code]
-      error "504 Invalid format code" unless name
-      error "504 Format not implemented" unless implemented
-      @data_format = format_code
-    end
-
     def cmd_mode(argument)
       syntax_error unless argument
       ensure_logged_in
@@ -443,8 +461,6 @@ module Ftpd
     end
 
     unimplemented :abor
-    unimplemented :acct
-    unimplemented :appe
     unimplemented :rein
     unimplemented :rest
     unimplemented :site
@@ -469,7 +485,7 @@ module Ftpd
 
     FORMAT_TYPES = {
       'N'=>['Non-print', true],
-      'T'=>['Telnet format effectors', false],
+      'T'=>['Telnet format effectors', true],
       'C'=>['Carriage Control (ASA)', false],
     }
 
@@ -674,6 +690,7 @@ module Ftpd
 
     def init_command_sequence_checker
       checker = CommandSequenceChecker.new
+      checker.must_expect 'acct'
       checker.must_expect 'pass'
       checker.must_expect 'rnto'
       checker
@@ -703,5 +720,21 @@ module Ftpd
       @file_system.dir(path).sort
     end
 
+    def authenticate(*args)
+      while args.size < @driver.method(:authenticate).arity
+        args << nil
+      end
+      @driver.authenticate(*args)
+    end
+
+    def login(*auth_tokens)
+      unless authenticate(*auth_tokens)
+        error "530 Login incorrect"
+      end
+      reply "230 Logged in"
+      set_file_system @driver.file_system(@user)
+      @logged_in = true
+    end
+
   end
 end

data/spec/disk_file_system_spec.rb

@@ -164,6 +164,36 @@ module Ftpd
 
     end
 
+    describe '#append' do
+
+      let(:contents) {'file contents'}
+
+      context '(destination missing)' do
+        let(:path) {'file_path'}
+        specify do
+          disk_file_system.append(path, contents)
+          read_file(path).should == contents
+        end
+      end
+
+      context '(destination exists)' do
+        let(:path) {'file'}
+        specify do
+          disk_file_system.append(path, contents)
+          read_file(path).should == canned_contents(path) + contents
+        end
+      end
+
+      context '(error)' do
+        specify do
+          expect {
+            disk_file_system.append('dir', contents)
+          }.to raise_error *is_a_directory_error
+        end
+      end
+
+    end
+
     describe '#mkdir' do
 
       context '(success)' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ftpd
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoizer
@@ -179,8 +179,10 @@ files:
 - examples/hello_world.rb
 - features/example/eplf.feature
 - features/example/example.feature
+- features/example/read_only.feature
 - features/example/step_definitions/example_server.rb
 - features/ftp_server/allo.feature
+- features/ftp_server/append.feature
 - features/ftp_server/cdup.feature
 - features/ftp_server/command_errors.feature
 - features/ftp_server/concurrent_sessions.feature
@@ -192,9 +194,12 @@ files:
 - features/ftp_server/get_tls.feature
 - features/ftp_server/help.feature
 - features/ftp_server/implicit_tls.feature
+- features/ftp_server/invertability.feature
 - features/ftp_server/list.feature
 - features/ftp_server/list_tls.feature
-- features/ftp_server/login.feature
+- features/ftp_server/login_auth_level_account.feature
+- features/ftp_server/login_auth_level_password.feature
+- features/ftp_server/login_auth_level_user.feature
 - features/ftp_server/mkdir.feature
 - features/ftp_server/mode.feature
 - features/ftp_server/name_list.feature
@@ -212,6 +217,7 @@ files:
 - features/ftp_server/syntax_errors.feature
 - features/ftp_server/syst.feature
 - features/ftp_server/type.feature
+- features/step_definitions/append.rb
 - features/step_definitions/client.rb
 - features/step_definitions/client_and_server_files.rb
 - features/step_definitions/client_files.rb
@@ -255,6 +261,7 @@ files:
 - ftpd.gemspec
 - insecure-test-cert.pem
 - lib/ftpd.rb
+- lib/ftpd/auth_levels.rb
 - lib/ftpd/command_sequence_checker.rb
 - lib/ftpd/disk_file_system.rb
 - lib/ftpd/error.rb
@@ -266,6 +273,7 @@ files:
 - lib/ftpd/insecure_certificate.rb
 - lib/ftpd/list_format/eplf.rb
 - lib/ftpd/list_format/ls.rb
+- lib/ftpd/read_only_disk_file_system.rb
 - lib/ftpd/server.rb
 - lib/ftpd/session.rb
 - lib/ftpd/temp_dir.rb
@@ -301,7 +309,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 286911087
+      hash: 451937393
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: