investtools-ftpd 1.0.1

data/lib/ftpd.rb

@@ -0,0 +1,86 @@
+# Standard libraries
+require 'fileutils'
+require 'forwardable'
+require 'logger'
+require 'openssl'
+require 'pathname'
+require 'shellwords'
+require 'socket'
+require 'strscan'
+require 'thread'
+require 'tmpdir'
+
+# Gems
+require 'memoizer'
+
+# Ftpd
+require_relative 'ftpd/auth_levels'
+require_relative 'ftpd/cmd_abor'
+require_relative 'ftpd/cmd_allo'
+require_relative 'ftpd/cmd_appe'
+require_relative 'ftpd/cmd_auth'
+require_relative 'ftpd/cmd_cdup'
+require_relative 'ftpd/cmd_cwd'
+require_relative 'ftpd/cmd_dele'
+require_relative 'ftpd/cmd_eprt'
+require_relative 'ftpd/cmd_epsv'
+require_relative 'ftpd/cmd_feat'
+require_relative 'ftpd/cmd_help'
+require_relative 'ftpd/cmd_list'
+require_relative 'ftpd/cmd_login'
+require_relative 'ftpd/cmd_mdtm'
+require_relative 'ftpd/cmd_mkd'
+require_relative 'ftpd/cmd_mode'
+require_relative 'ftpd/cmd_nlst'
+require_relative 'ftpd/cmd_noop'
+require_relative 'ftpd/cmd_opts'
+require_relative 'ftpd/cmd_pasv'
+require_relative 'ftpd/cmd_pbsz'
+require_relative 'ftpd/cmd_port'
+require_relative 'ftpd/cmd_prot'
+require_relative 'ftpd/cmd_pwd'
+require_relative 'ftpd/cmd_quit'
+require_relative 'ftpd/cmd_rein'
+require_relative 'ftpd/cmd_rename'
+require_relative 'ftpd/cmd_rest'
+require_relative 'ftpd/cmd_retr'
+require_relative 'ftpd/cmd_rmd'
+require_relative 'ftpd/cmd_site'
+require_relative 'ftpd/cmd_size'
+require_relative 'ftpd/cmd_smnt'
+require_relative 'ftpd/cmd_stat'
+require_relative 'ftpd/cmd_stor'
+require_relative 'ftpd/cmd_stou'
+require_relative 'ftpd/cmd_stru'
+require_relative 'ftpd/cmd_syst'
+require_relative 'ftpd/cmd_type'
+require_relative 'ftpd/command_handler'
+require_relative 'ftpd/command_handler_factory'
+require_relative 'ftpd/command_handlers'
+require_relative 'ftpd/command_loop'
+require_relative 'ftpd/command_sequence_checker'
+require_relative 'ftpd/connection_throttle'
+require_relative 'ftpd/connection_tracker'
+require_relative 'ftpd/data_connection_helper'
+require_relative 'ftpd/disk_file_system'
+require_relative 'ftpd/error'
+require_relative 'ftpd/exception_translator'
+require_relative 'ftpd/exceptions'
+require_relative 'ftpd/file_info'
+require_relative 'ftpd/file_system_helper'
+require_relative 'ftpd/ftp_server'
+require_relative 'ftpd/insecure_certificate'
+require_relative 'ftpd/list_format/eplf'
+require_relative 'ftpd/list_format/ls'
+require_relative 'ftpd/list_path'
+require_relative 'ftpd/null_logger'
+require_relative 'ftpd/protocols'
+require_relative 'ftpd/read_only_disk_file_system'
+require_relative 'ftpd/server'
+require_relative 'ftpd/session'
+require_relative 'ftpd/session_config'
+require_relative 'ftpd/stream'
+require_relative 'ftpd/telnet'
+require_relative 'ftpd/temp_dir'
+require_relative 'ftpd/tls_server'
+require_relative 'ftpd/translate_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/cmd_abor.rb

@@ -0,0 +1,13 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdAbor < CommandHandler
+
+    def cmd_abor(argument)
+      unimplemented_error
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_allo.rb

@@ -0,0 +1,20 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  # The Allocate (ALLO) command.
+  #
+  # This server does not need the ALLO command, so treats it as a
+  # NOOP.
+
+  class CmdAllo < CommandHandler
+
+    def cmd_allo(argument)
+      ensure_logged_in
+      syntax_error unless argument =~ /^\d+( R \d+)?$/
+      command_not_needed
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_appe.rb

@@ -0,0 +1,24 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdAppe < CommandHandler
+
+    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
+        receive_file do |data_socket|
+          file_system.append path, data_socket
+        end
+        reply "226 Transfer complete"
+      end
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_auth.rb

@@ -0,0 +1,21 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdAuth < CommandHandler
+
+    def cmd_auth(security_scheme)
+      ensure_tls_supported
+      if socket.encrypted?
+        error "AUTH already done", 503
+      end
+      unless security_scheme =~ /^TLS(-C)?$/i
+        error "Security scheme not implemented: #{security_scheme}", 504
+      end
+      reply "234 AUTH #{security_scheme} OK."
+      socket.encrypt
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_cdup.rb

@@ -0,0 +1,16 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdCdup < CommandHandler
+
+    def cmd_cdup(argument)
+      syntax_error if argument
+      ensure_logged_in
+      execute_command 'cwd', '..'
+    end
+    alias cmd_xcup :cmd_cdup
+
+  end
+
+end

data/lib/ftpd/cmd_cwd.rb

@@ -0,0 +1,20 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdCwd < CommandHandler
+
+    def cmd_cwd(argument)
+      ensure_logged_in
+      path = File.expand_path(argument, name_prefix)
+      ensure_accessible path
+      ensure_exists path
+      ensure_directory path
+      self.name_prefix = path
+      pwd 250
+    end
+    alias cmd_xcwd :cmd_cwd
+
+  end
+
+end

data/lib/ftpd/cmd_dele.rb

@@ -0,0 +1,21 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdDele < CommandHandler
+
+    def cmd_dele(argument)
+      ensure_logged_in
+      ensure_file_system_supports :delete
+      path = argument
+      error "Path required", 501 unless path
+      path = File.expand_path(path, name_prefix)
+      ensure_accessible path
+      ensure_exists path
+      file_system.delete path
+      reply "250 DELE command successful"
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_eprt.rb

@@ -0,0 +1,23 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdEprt < CommandHandler
+
+    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
+
+  end
+
+end

data/lib/ftpd/cmd_epsv.rb

@@ -0,0 +1,30 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdEpsv < CommandHandler
+
+    def cmd_epsv(argument)
+      ensure_logged_in
+      if data_server
+        reply "200 Already in passive mode"
+      else
+        if argument == 'ALL'
+          self.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]
+          self.data_server = TCPServer.new(interface, 0)
+          port = data_server.addr[1]
+          reply "229 Entering extended passive mode (|||#{port}|)"
+        end
+      end
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_feat.rb

@@ -0,0 +1,44 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdFeat < CommandHandler
+
+    def cmd_feat(argument)
+      syntax_error if argument
+      reply '211-Extensions supported:'
+      extensions.each do |extension|
+        reply " #{extension}"
+      end
+      reply '211 END'
+    end
+
+    private
+
+    def extensions
+      [
+        (TLS_EXTENSIONS if tls_enabled?),
+        IPV6_EXTENSIONS,
+        RFC_3659_EXTENSIONS,
+      ].flatten.compact
+    end
+
+    TLS_EXTENSIONS = [
+      'AUTH TLS',
+      'PBSZ',
+      'PROT'
+    ]
+
+    IPV6_EXTENSIONS = [
+      'EPRT',
+      'EPSV',
+    ]
+
+    RFC_3659_EXTENSIONS = [
+      'MDTM',
+      'SIZE',
+    ]
+
+  end
+
+end

data/lib/ftpd/cmd_help.rb

@@ -0,0 +1,29 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdHelp < CommandHandler
+
+    def cmd_help(argument)
+      if argument
+        command = argument.upcase
+        if supported_commands.include?(command)
+          reply "214 Command #{command} is recognized"
+        else
+          reply "214 Command #{command} is not recognized"
+        end
+      else
+        reply '214-The following commands are recognized:'
+        supported_commands.sort.each_slice(8) do |commands|
+          line = commands.map do |command|
+            '   %-4s' % command
+          end.join
+          reply line
+        end
+        reply '214 Have a nice day.'
+      end
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_list.rb

@@ -0,0 +1,33 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  class CmdList < CommandHandler
+
+    def cmd_list(argument)
+      close_data_server_socket_when_done do
+        ensure_logged_in
+        ensure_file_system_supports :dir
+        ensure_file_system_supports :file_info
+        path = list_path(argument)
+        path = File.expand_path(path, name_prefix)
+        transmit_file(StringIO.new(list(path)), 'A')
+      end
+    end
+
+    private
+
+    def list(path)
+      format_list(path_list(path))
+    end
+
+    def format_list(paths)
+      paths.map do |path|
+        file_info = file_system.file_info(path)
+        config.list_formatter.new(file_info).to_s + "\n"
+      end.join
+    end
+
+  end
+
+end

data/lib/ftpd/cmd_login.rb

@@ -0,0 +1,60 @@
+require_relative 'command_handler'
+
+module Ftpd
+
+  # The login commands
+
+  class CmdLogin < CommandHandler
+
+    # @return [String] The user for the current login sequence
+
+    attr_accessor :user
+
+    # @return [String] The password for the current login sequence
+
+    attr_accessor :password
+
+    def initialize(*)
+      super
+      @user = nil
+      @password = nil
+    end
+
+    #  * User Name (USER) command.
+
+    def cmd_user(argument)
+      syntax_error unless argument
+      sequence_error if logged_in
+      @user = argument
+      if config.auth_level > AUTH_USER
+        reply "331 Password required"
+        expect 'pass'
+      else
+        login @user
+      end
+    end
+
+    # The Password (PASS) command
+
+    def cmd_pass(argument)
+      syntax_error unless argument
+      @password = argument
+      if config.auth_level > AUTH_PASSWORD
+        reply "332 Account required"
+        expect 'acct'
+      else
+        login @user, @password
+      end
+    end
+
+    # The Account (ACCT) command
+
+    def cmd_acct(argument)
+      syntax_error unless argument
+      account = argument
+      login @user, @password, account
+    end
+
+  end
+
+end