ftpd 0.4.0 → 0.5.0

data/lib/ftpd/null_logger.rb

@@ -0,0 +1,22 @@
+module Ftpd
+
+  # A logger that does not log.
+  # Quacks enough like a Logger to fool Ftpd.
+
+  class NullLogger
+
+    def self.stub(method_name)
+      define_method method_name do |*args|
+      end
+    end
+
+    stub :unknown
+    stub :fatal
+    stub :error
+    stub :warn
+    stub :info
+    stub :debug
+
+  end
+
+end

data/lib/ftpd/server.rb

@@ -72,9 +72,9 @@ module Ftpd
     def start_session_thread(socket)
       Thread.new do
         begin
-          session(socket)
+          session socket
         ensure
-          socket.close
+          close_socket socket
         end
       end
     end
@@ -83,5 +83,14 @@ module Ftpd
       @server_socket.accept
     end
 
+    def close_socket(socket)
+      if socket.respond_to?(:shutdown)
+        socket.shutdown
+        socket.read
+      end
+    ensure
+      socket.close
+    end
+
   end
 end

data/lib/ftpd/session.rb

@@ -6,6 +6,10 @@ module Ftpd
     include Error
 
     def initialize(opts)
+      @log = opts[:log] || NullLogger.new
+      @allow_low_data_ports = opts[:allow_low_data_ports]
+      @server_name = opts[:server_name]
+      @server_version = opts[:server_version]
       @driver = opts[:driver]
       @auth_level = opts[:auth_level]
       @socket = opts[:socket]
@@ -14,8 +18,6 @@ module Ftpd
         @socket.encrypt
       end
       @name_prefix = '/'
-      @debug_path = opts[:debug_path]
-      @debug = opts[:debug]
       @list_formatter = opts[:list_formatter]
       @data_type = 'A'
       @mode = 'S'
@@ -23,7 +25,9 @@ module Ftpd
       @response_delay = opts[:response_delay]
       @data_channel_protection_level = :clear
       @command_sequence_checker = init_command_sequence_checker
+      @session_timeout = opts[:session_timeout]
       @logged_in = false
+      set_socket_options
     end
 
     def run
@@ -32,6 +36,7 @@ module Ftpd
         loop do
           begin
             s = get_command
+            s = process_telnet_sequences(s)
             syntax_error unless s =~ /^(\w+)(?: (.*))?$/
             command, argument = $1.downcase, $2
             method = 'cmd_' + command
@@ -111,8 +116,13 @@ module Ftpd
         syntax_error unless (0..255) === i
         i
       end
-      @data_hostname = pieces[0..3].join('.')
-      @data_port = pieces[4] << 8 | pieces[5]
+      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
       reply "200 PORT command successful"
     end
 
@@ -452,6 +462,12 @@ module Ftpd
       end
     end
 
+    def cmd_stat(argument)
+      ensure_logged_in
+      syntax_error if argument
+      reply "211 #{@server_name} #{@server_version}"
+    end
+
     def self.unimplemented(command)
       method_name = "cmd_#{command}"
       define_method method_name do |arguments|
@@ -465,7 +481,6 @@ module Ftpd
     unimplemented :rest
     unimplemented :site
     unimplemented :smnt
-    unimplemented :stat
 
     def supported_commands
       private_methods.map do |method|
@@ -520,21 +535,31 @@ module Ftpd
     def transmit_file(contents, data_type = @data_type)
       open_data_connection do |data_socket|
         contents = unix_to_nvt_ascii(contents) if data_type == 'A'
-        data_socket.write(contents)
-        debug("Sent #{contents.size} bytes")
+        handle_data_disconnect do
+          data_socket.write(contents)
+        end
+        @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 = data_socket.read
+        contents = handle_data_disconnect do
+          data_socket.read
+        end
         contents = nvt_ascii_to_unix(contents) if @data_type == 'A'
-        debug("Received #{contents.size} bytes")
+        @log.debug "Received #{contents.size} bytes"
         contents
       end
     end
 
+    def handle_data_disconnect
+      return yield
+    rescue Errno::ECONNRESET, Errno::EPIPE
+      reply "426 Connection closed; transfer aborted."
+    end
+
     def unix_to_nvt_ascii(s)
       return s if s =~ /\r\n/
       s.gsub(/\n/, "\r\n")
@@ -642,20 +667,31 @@ module Ftpd
     end
 
     def get_command
-      s = @socket.gets
+      s = gets_with_timeout(@socket)
       throw :done if s.nil?
       s = s.chomp
-      debug(s)
+      @log.debug s
       s
     end
 
+    def gets_with_timeout(socket)
+      ready = IO.select([@socket], nil, nil, @session_timeout)
+      timeout if ready.nil?
+      ready[0].first.gets
+    end
+
+    def timeout
+      reply '421 Control connection timed out.'
+      throw :done
+    end
+
     def reply(s)
       if @response_delay.to_i != 0
-        debug "#{@response_delay} second delay before replying"
+        @log.warn "#{@response_delay} second delay before replying"
         sleep @response_delay
       end
-      debug(s)
-      @socket.puts(s)
+      @log.debug s
+      @socket.write s + "\r\n"
     end
 
     def unique_path(path)
@@ -677,17 +713,6 @@ module Ftpd
       end.join
     end
 
-    def debug(*s)
-      return unless debug?
-      File.open(@debug_path, 'a') do |file|
-        file.puts(*s)
-      end
-    end
-
-    def debug?
-      @debug || ENV['FTPD_DEBUG'].to_i != 0
-    end
-
     def init_command_sequence_checker
       checker = CommandSequenceChecker.new
       checker.must_expect 'acct'
@@ -736,5 +761,26 @@ module Ftpd
       @logged_in = true
     end
 
+    def set_socket_options
+      disable_nagle @socket
+      receive_oob_data_inline @socket
+    end
+
+    def disable_nagle(socket)
+      socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+    end
+
+    def receive_oob_data_inline(socket)
+      socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_OOBINLINE, 1)
+    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/telnet.rb

@@ -0,0 +1,119 @@
+# -*- ruby encoding: us-ascii -*-
+
+module Ftpd
+
+  # Handle the limited processing of Telnet sequences required by the
+  # FTP RFCs.
+  #
+  # Telnet option processing is quite complex, but we need do only a
+  # simple subset of it, since we can disagree with any request by the
+  # client to turn on an option (RFC-1123 4.1.2.12).  Adhering to
+  # RFC-1143 ("The Q Method of Implementing TELNET Option Negiation"),
+  # and supporting only what's needed to keep all options turned off:
+  #
+  # * Reply to WILL sequence with DONT sequence
+  # * Reply to DO sequence with WONT sequence
+  # * Ignore WONT sequence
+  # * Ignore DONT sequence
+  #
+  # We also handle the "interrupt process" and "data mark" sequences,
+  # which the client sends before the ABORT command, by ignoring them.
+  #
+  # All Telnet sequence start with an IAC, followed by at least one
+  # character.  Here are the sequences we care about:
+  #
+  #     SEQUENCE             CODES
+  #     -----------------    --------------------
+  #     WILL                 IAC WILL option-code
+  #     WONT                 IAC WONT option-code
+  #     DO                   IAC DO option-code
+  #     DONT                 IAC DONT option-code
+  #     escaped 255          IAC IAC
+  #     interrupt process    IAC IP
+  #     data mark            IAC DM
+  #
+  # Any pathalogical sequence (e.g. IAC + \x01), or any sequence we
+  # don't recognize, we pass through.
+
+  class Telnet
+
+    # The command with recognized Telnet sequences removed
+
+    attr_reader :plain
+
+    # Any Telnet sequences to send
+
+    attr_reader :reply
+
+    # Create a new instance with a command that may contain Telnet
+    # sequences.
+    # @param command [String]
+
+    def initialize(command)
+      telnet_state_machine command
+    end
+
+    private
+
+    module Codes
+      IAC  = 255.chr    # 0xff
+      DONT = 254.chr    # 0xfe
+      DO   = 253.chr    # 0xfd
+      WONT = 252.chr    # 0xfc
+      WILL = 251.chr    # 0xfb
+      IP   = 244.chr    # 0xf4
+      DM   = 242.chr    # 0xf2
+    end
+    include Codes
+
+    def telnet_state_machine (command)
+      @plain = ''
+      @reply = ''
+      state = :idle
+      command.each_char do |c|
+        case state
+        when :idle
+          if c == IAC
+            state = :iac
+          else
+            @plain << c
+          end
+        when :iac
+          case c
+          when IAC
+            @plain << c
+            state = :idle
+          when WILL
+            state = :will
+          when WONT
+            state = :wont
+          when DO
+            state = :do
+          when DONT
+            state = :dont
+          when IP
+            state = :idle
+          when DM
+            state = :idle
+          else
+            @plain << IAC + c
+            state = :idle
+          end
+        when :will
+          @reply << IAC + DONT + c
+          state = :idle
+        when :wont
+          state = :idle
+        when :do
+          @reply << IAC + WONT + c
+          state = :idle
+        when :dont
+          state = :idle
+        else
+          raise "Unknown state #{state.inspect}"
+        end
+      end
+    end
+
+  end
+end

data/rake_tasks/cucumber.rake

@@ -2,7 +2,6 @@ require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new 'test:features' do |t|
   t.fork = true
-  t.cucumber_opts = '--format progress'
 end
 
 task 'test:cucumber' => ['test:features']

data/spec/null_logger_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Ftpd
+  describe NullLogger do
+
+    subject {NullLogger.new}
+
+    def self.should_stub(method)
+      describe "#{method}" do
+        specify do
+          subject.should respond_to method
+        end
+      end
+    end
+
+    should_stub :unknown
+    should_stub :fatal
+    should_stub :error
+    should_stub :warn
+    should_stub :info
+    should_stub :debug
+
+  end
+end

data/spec/telnet_spec.rb

@@ -0,0 +1,75 @@
+# -*- ruby encoding: us-ascii -*-
+
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Ftpd
+  describe Telnet do
+
+    IAC  = 255.chr    # 0xff
+    DONT = 254.chr    # 0xfe
+    DO   = 253.chr    # 0xfd
+    WONT = 252.chr    # 0xfc
+    WILL = 251.chr    # 0xfb
+    IP   = 244.chr    # 0xf4
+    DM   = 242.chr    # 0xf2
+
+    subject {Telnet.new(command)}
+    let(:plain_command) {"NOOP\r\n"}
+    let(:command) {codes + plain_command}
+
+    context '(plain command)' do
+      let(:codes) {''}
+      its(:reply) {should == ''}
+      its(:plain) {should == plain_command}
+    end
+
+    context '(escaped IAC)' do
+      let(:codes) {"#{IAC}#{IAC}"}
+      its(:reply) {should == ''}
+      its(:plain) {should == "#{IAC}" + plain_command}
+    end
+
+    context '(IAC + unknown code)' do
+      let(:codes) {"#{IAC}\x01"}
+      its(:reply) {should == ''}
+      its(:plain) {should == codes + plain_command}
+    end
+
+    context '(WILL)' do
+      let(:codes) {"#{IAC}#{WILL}\x01"}
+      its(:reply) {should == "#{IAC}#{DONT}\x01"}
+      its(:plain) {should == plain_command}
+    end
+
+    context '(WONT)' do
+      let(:codes) {"#{IAC}#{WONT}\x01"}
+      its(:reply) {should == ''}
+      its(:plain) {should == plain_command}
+    end
+
+    context '(DO)' do
+      let(:codes) {"#{IAC}#{DO}\x01"}
+      its(:reply) {should == "#{IAC}#{WONT}\x01"}
+      its(:plain) {should == plain_command}
+    end
+
+    context '(DONT)' do
+      let(:codes) {"#{IAC}#{DONT}\x01"}
+      its(:reply) {should == ''}
+      its(:plain) {should == plain_command}
+    end
+
+    context '(interrupt process)' do
+      let(:codes) {"#{IAC}#{IP}"}
+      its(:reply) {should == ''}
+      its(:plain) {should == plain_command}
+    end
+
+    context '(data mark)' do
+      let(:codes) {"#{IAC}#{DM}"}
+      its(:reply) {should == ''}
+      its(:plain) {should == plain_command}
+    end
+
+  end
+end