ftpd 0.11.0 → 0.12.0

data/lib/ftpd/cmd_stru.rb

@@ -0,0 +1,27 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdStru < CommandHandler
+
+    def cmd_stru(argument)
+      syntax_error unless argument
+      ensure_logged_in
+      name, implemented = FILE_STRUCTURES[argument]
+      error "504 Invalid structure code" unless name
+      error "504 Structure not implemented" unless implemented
+      self.structure = argument
+      reply "200 File structure set to #{name}"
+    end
+
+    private
+
+    FILE_STRUCTURES = {
+      'R'=>['Record', false],
+      'F'=>['File', true],
+      'P'=>['Page', false],
+    }
+
+  end
+
+end

data/lib/ftpd/cmd_syst.rb

@@ -0,0 +1,16 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  # The System (SYST) command.
+
+  class CmdSyst < CommandHandler
+
+    def cmd_syst(argument)
+      syntax_error if argument
+      reply "215 UNIX Type: L8"
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_type.rb

@@ -0,0 +1,28 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdType < CommandHandler
+
+    def cmd_type(argument)
+      ensure_logged_in
+      syntax_error unless argument =~ /^(\S)(?: (\S+))?$/
+      type_code = $1
+      format_code = $2
+      unless argument =~ /^([AEI]( [NTC])?|L .*)$/
+        error '504 Invalid type code'
+      end
+      case argument
+      when /^A( [NT])?$/
+        self.data_type = 'A'
+      when /^(I|L 8)$/
+        self.data_type = 'I'
+      else
+        error '504 Type not implemented'
+      end
+      reply "200 Type set to #{data_type}"
+    end
+
+  end
+
+end

data/lib/ftpd/command_handler.rb

@@ -0,0 +1,91 @@
+require_relative 'data_connection_helper'
+require_relative 'error'
+require_relative 'file_system_helper'
+
+module Ftpd
+
+  # Command handler base class
+  
+  class CommandHandler
+
+    extend Forwardable
+
+    include AsciiHelper
+    include DataConnectionHelper
+    include Error
+    include FileSystemHelper
+
+    COMMAND_FILENAME_PREFIX = 'cmd_'
+    COMMAND_KLASS_PREFIX = 'Cmd'
+    COMMAND_METHOD_PREFIX = 'cmd_'
+
+    # param session [Session] The session
+
+    def initialize(session)
+      @session = session
+    end
+
+    # Return the commands implemented by this handler.  For example,
+    # if the handler has the method "cmd_allo", this returns ['allo'].
+
+    class << self
+      include Memoizer
+      def commands
+        public_instance_methods.map(&:to_s).grep(/#{COMMAND_METHOD_PREFIX}/).map do |method|
+          method.gsub(/^#{COMMAND_METHOD_PREFIX}/, '')
+        end
+      end
+      memoize :commands
+    end
+
+    def_delegator 'self.class', :commands
+
+    private
+
+    attr_reader :session
+
+    # Forward methods to the session
+
+    def_delegators :@session,
+    :close_data_server_socket,
+    :command_not_needed,
+    :config,
+    :data_channel_protection_level,
+    :data_channel_protection_level=,
+    :data_hostname,
+    :data_port,
+    :data_server,
+    :data_server=,
+    :data_type,
+    :data_type=,
+    :ensure_logged_in,
+    :ensure_not_epsv_all,
+    :ensure_protocol_supported,
+    :ensure_tls_supported,
+    :epsv_all=,
+    :execute_command,
+    :expect,
+    :file_system,
+    :list,
+    :list_path,
+    :logged_in,
+    :logged_in=,
+    :login,
+    :mode=,
+    :name_list,
+    :name_prefix,
+    :name_prefix=,
+    :protection_buffer_size_set,
+    :protection_buffer_size_set=,
+    :pwd,
+    :reply,
+    :server_name_and_version,
+    :set_active_mode_address,
+    :socket,
+    :structure=,
+    :supported_commands,
+    :tls_enabled?
+ 
+  end
+
+end

data/lib/ftpd/command_handler_factory.rb

@@ -0,0 +1,51 @@
+module Ftpd
+
+  class CommandHandlerFactory
+
+    def self.standard_command_handlers
+      [
+        CmdAbor,
+        CmdAllo,
+        CmdAppe,
+        CmdAuth,
+        CmdCdup,
+        CmdCwd,
+        CmdDele,
+        CmdEprt,
+        CmdEpsv,
+        CmdFeat,
+        CmdHelp,
+        CmdList,
+        CmdLogin,
+        CmdMdtm,
+        CmdMkd,
+        CmdMode,
+        CmdNlst,
+        CmdNoop,
+        CmdOpts,
+        CmdPasv,
+        CmdPbsz,
+        CmdPort,
+        CmdProt,
+        CmdPwd,
+        CmdQuit,
+        CmdRein,
+        CmdRename,
+        CmdRest,
+        CmdRetr,
+        CmdRmd,
+        CmdSite,
+        CmdSize,
+        CmdSmnt,
+        CmdStat,
+        CmdStor,
+        CmdStou,
+        CmdStru,
+        CmdSyst,
+        CmdType,
+      ]      
+    end
+
+  end
+
+end

data/lib/ftpd/command_handlers.rb

@@ -0,0 +1,60 @@
+module Ftpd
+
+  # All FTP commands which the server supports are dispatched by this
+  # class.
+
+  class CommandHandlers
+
+    def initialize
+      @commands = {}
+    end
+
+    # Add a command handler
+    #
+    # @param command_handler [Command]
+
+    def <<(command_handler)
+      command_handler.commands.each do |command|
+        @commands[command] = command_handler
+      end
+    end
+
+    # @param command [String] the command (e.g. "STOR").  Case
+    #   insensitive.
+    # @return truthy if the server supports the command.
+
+    def has?(command)
+      command = canonical_command(command)
+      @commands.has_key?(command)
+    end
+
+    # Dispatch a command to the appropriate command handler.
+    #
+    # @param command [String] the command (e.g. "STOR").  Case
+    #   insensitive.
+    # @param argument [String] The argument, or nil if there isn't
+    #   one.
+
+    def execute(command, argument)
+      command = canonical_command(command)
+      method = "cmd_#{command}"
+      @commands[command.downcase].send(method, argument)
+    end
+
+    # Return the sorted list of commands supported by this handler
+    #
+    # @return [Array<String>] Lowercase command
+
+    def commands
+      @commands.keys.sort
+    end
+
+    private
+
+    def canonical_command(command)
+      command.downcase
+    end
+
+  end
+
+end

data/lib/ftpd/command_loop.rb

@@ -0,0 +1,77 @@
+module Ftpd
+
+  class CommandLoop
+
+    extend Forwardable
+
+    include Error
+
+    def initialize(session)
+      @session = session
+    end
+
+    def read_and_execute_commands
+      catch :done do
+        begin
+          reply "220 #{server_name_and_version}"
+          loop do
+            begin
+              s = get_command
+              s = process_telnet_sequences(s)
+              syntax_error unless s =~ /^(\w+)(?: (.*))?$/
+              command, argument = $1.downcase, $2
+              unless valid_command?(command)
+                unrecognized_error s
+              end
+              command_sequence_checker.check command
+              execute_command command, argument
+            rescue CommandError => e
+              reply e.message
+            end
+          end
+        rescue Errno::ECONNRESET, Errno::EPIPE
+        end
+      end
+    end
+
+    private
+
+    def_delegators :@session,
+    :command_sequence_checker,
+    :config,
+    :execute_command,
+    :reply,
+    :server_name_and_version,
+    :socket,
+    :valid_command?
+
+    def get_command
+      s = gets_with_timeout(socket)
+      throw :done if s.nil?
+      s = s.chomp
+      config.log.debug s
+      s
+    end
+    
+    def gets_with_timeout(socket)
+      ready = IO.select([socket], nil, nil, config.session_timeout)
+      timeout if ready.nil?
+      ready[0].first.gets
+    end
+
+    def timeout
+      reply '421 Control connection timed out.'
+      throw :done
+    end
+
+    def process_telnet_sequences(s)
+      telnet = Telnet.new(s)
+      unless telnet.reply.empty?
+        socket.write telnet.reply
+      end
+      telnet.plain
+    end
+
+  end
+
+end

data/lib/ftpd/data_connection_helper.rb

@@ -0,0 +1,124 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  module DataConnectionHelper
+
+    def transmit_file(contents, data_type = session.data_type)
+      open_data_connection do |data_socket|
+        contents = unix_to_nvt_ascii(contents) if data_type == 'A'
+        handle_data_disconnect do
+          data_socket.write(contents)
+        end
+        config.log.debug "Sent #{contents.size} bytes"
+        reply "226 Transfer complete"
+      end
+    end
+
+    def receive_file(path_to_advertise = nil)
+      open_data_connection(path_to_advertise) do |data_socket|
+        contents = handle_data_disconnect do
+          data_socket.read
+        end
+        contents = nvt_ascii_to_unix(contents) if data_type == 'A'
+        config.log.debug "Received #{contents.size} bytes"
+        contents
+      end
+    end
+
+    def open_data_connection(path_to_advertise = nil, &block)
+      send_start_of_data_connection_reply(path_to_advertise)
+      if data_server
+        if encrypt_data?
+          open_passive_tls_data_connection(&block)
+        else
+          open_passive_data_connection(&block)
+        end
+      else
+        if encrypt_data?
+          open_active_tls_data_connection(&block)
+        else
+          open_active_data_connection(&block)
+        end
+      end
+    end
+
+    def open_passive_tls_data_connection
+      open_passive_data_connection do |socket|
+        make_tls_connection(socket) do |ssl_socket|
+          yield(ssl_socket)
+        end
+      end
+    end
+
+    def open_active_tls_data_connection
+      open_active_data_connection do |socket|
+        make_tls_connection(socket) do |ssl_socket|
+          yield(ssl_socket)
+        end
+      end
+    end
+
+    def open_active_data_connection
+      data_socket = TCPSocket.new(data_hostname, data_port)
+      begin
+        yield(data_socket)
+      ensure
+        data_socket.close
+      end
+    end
+
+    def open_passive_data_connection
+      data_socket = data_server.accept
+      begin
+        yield(data_socket)
+      ensure
+        data_socket.close
+      end
+    end
+
+    def handle_data_disconnect
+      return yield
+    rescue Errno::ECONNRESET, Errno::EPIPE
+      reply "426 Connection closed; transfer aborted."
+    end
+
+    def send_start_of_data_connection_reply(path)
+      if path
+        reply "150 FILE: #{path}"
+      else
+        reply "150 Opening #{data_connection_description}"
+      end
+    end
+
+    def data_connection_description
+      [
+        Session::DATA_TYPES[data_type][0],
+        "mode data connection",
+        ("(TLS)" if encrypt_data?)
+      ].compact.join(' ')
+    end
+
+    def make_tls_connection(data_socket)
+      ssl_socket = OpenSSL::SSL::SSLSocket.new(data_socket, socket.ssl_context)
+      ssl_socket.accept
+      begin
+        yield(ssl_socket)
+      ensure
+        ssl_socket.close
+      end
+    end
+
+    def close_data_server_socket_when_done
+      yield
+    ensure
+      close_data_server_socket
+    end
+
+    def encrypt_data?
+      data_channel_protection_level != :clear
+    end
+
+  end
+
+end