ftpd 1.1.1 → 2.0.0

data/lib/ftpd/command_handlers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # All FTP commands which the server supports are dispatched by this

data/lib/ftpd/command_loop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   class CommandLoop

data/lib/ftpd/command_sequence_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Some commands are supposed to occur in sequence.  For example, USER
 # must be immediately followed by PASS.  This class keeps track of
 # when a specific command either must arrive or must not arrive, and

data/lib/ftpd/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
   class Config
 

data/lib/ftpd/connection_throttle.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # This class limits the number of connections

data/lib/ftpd/connection_tracker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "gets_peer_address"
 
 module Ftpd

data/lib/ftpd/data_connection_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'command_handler'
 
 module Ftpd

data/lib/ftpd/data_server_factory.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'data_server_factory/random_ephemeral_port'
+require_relative 'data_server_factory/specific_port_range'
+
+module Ftpd
+
+  # Factories for creating TCPServer used for passive mode
+  # connections.
+  module DataServerFactory
+
+    attr_reader :tcp_server
+
+    # Create a factory.
+    #
+    # @param interface [String] The IP address of the interface to
+    #   bind to (e.g. "127.0.0.1")
+    # @param ports [nil, Range] The range of ports to bind to.  If nil,
+    #   then binds to a random ephemeral port.
+    def self.make(interface, ports)
+      if ports
+        SpecificPortRange.new(interface, ports)
+      else
+        RandomEphemeralPort.new(interface)
+      end
+    end
+
+    # @param interface [String] The IP address of the interface to
+    #   bind to (e.g. "127.0.0.1")
+    # @param ports [nil, Range] The range of ports to bind to.  If nil,
+    #   then binds to a random ephemeral port.
+    def initialize(interface, ports)
+      @interface = interface
+      @ports = ports
+    end
+
+    # @return [TCPServer]
+    def make_tcp_server
+      TCPServer.new(@interface, 0)
+    end
+
+  end
+
+end

data/lib/ftpd/data_server_factory/random_ephemeral_port.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ftpd
+
+  module DataServerFactory
+
+    # Factory for creating TCPServer used for passive mode connections.
+    # This factory binds to a random ephemeral port.
+    class RandomEphemeralPort
+
+      # @param interface [String] The IP address of the interface to
+      #   bind to (e.g. "127.0.0.1")
+      def initialize(interface)
+        @interface = interface
+      end
+
+      # @return [TCPServer]
+      def make_tcp_server
+        TCPServer.new(@interface, 0)
+      end
+
+    end
+
+  end
+
+end

data/lib/ftpd/data_server_factory/specific_port_range.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Ftpd
+
+  module DataServerFactory
+
+    # Factory for creating TCPServer used for passive mode
+    # connections.  This factory binds to a random port within a
+    # specific range of ports.
+    class SpecificPortRange
+
+      # @param interface [String] The IP address of the interface to
+      #   bind to (e.g. "127.0.0.1")
+      # @param ports [nil, Range] The range of ports to bind to.
+      def initialize(interface, ports)
+        @interface = interface
+        @ports = ports
+      end
+
+      # @return [TCPServer]
+      def make_tcp_server
+        ports_to_try = @ports.to_a.shuffle
+        until ports_to_try.empty?
+          port = ports_to_try.shift
+          begin
+            return TCPServer.new(@interface, port)
+          rescue Errno::EADDRINUSE
+          end
+        end
+        TCPServer.new(@interface, 0)
+      end
+
+    end
+
+  end
+
+end

data/lib/ftpd/disk_file_system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'translate_exceptions'
 
 module Ftpd

data/lib/ftpd/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
   module Error
 

data/lib/ftpd/exception_translator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # Translate specific exceptions to FileSystemError.

data/lib/ftpd/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # All errors (purposefully) generated by this library driver from

data/lib/ftpd/file_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # Information about a file object (file, directory, symlink, etc.)

data/lib/ftpd/file_system_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'command_handler'
 
 module Ftpd

data/lib/ftpd/ftp_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'tls_server'
 
 module Ftpd
@@ -88,6 +90,27 @@ module Ftpd
     def_delegator :@connection_throttle, :'max_connections_per_ip'
     def_delegator :@connection_throttle, :'max_connections_per_ip='
 
+    # The advertised public IP for passive mode connections.  This is
+    # the IP that the client must use to make a connection back to the
+    # server.  If nil, the IP of the bound interface is used.  When
+    # the FTP server is behind a firewall, set this to firewall's
+    # public IP and add the appropriate rule to the firewall to
+    # forward that IP to the machine that ftpd is running on.
+    #
+    # Set this before calling #start.
+    #
+    # @return [nil, String]
+    attr_accessor :nat_ip
+
+    # The range of ports for passive mode connections.  If nil, then a
+    # random etherial port is used.  Otherwise, a random port from
+    # this range is used.
+    #
+    # Set this before calling #start.
+    #
+    # @return [nil, Range]
+    attr_accessor :passive_ports
+
     # The number of seconds to delay before replying.  This is for
     # testing, when you need to test, for example, client timeouts.
     # Defaults to 0 (no delay).
@@ -164,6 +187,8 @@ module Ftpd
       @server_version = read_version_file
       @allow_low_data_ports = false
       @failed_login_delay = 0
+      @nat_ip = nil
+      @passive_ports = nil
       self.log = nil
       @connection_tracker = ConnectionTracker.new
       @connection_throttle = ConnectionThrottle.new(@connection_tracker)
@@ -194,6 +219,8 @@ module Ftpd
       config.list_formatter = @list_formatter
       config.log = @log
       config.max_failed_logins = @max_failed_logins
+      config.nat_ip = @nat_ip
+      config.passive_ports = @passive_ports
       config.response_delay = response_delay
       config.server_name = @server_name
       config.server_version = @server_version

data/lib/ftpd/gets_peer_address.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "gets_peer_address"
 
 module Ftpd

data/lib/ftpd/insecure_certificate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # This mixin provides an insecure SSL certificate.  This certificate

data/lib/ftpd/list_format/eplf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
   module ListFormat
 

data/lib/ftpd/list_format/ls.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
   module ListFormat
 

data/lib/ftpd/list_path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # Functions for manipulating LIST and NLST arguments

data/lib/ftpd/null_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # A logger that does not log.

data/lib/ftpd/protocols.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # With the commands EPORT and EPSV, the client sends a protocol code

data/lib/ftpd/read_only_disk_file_system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # A disk file system that does not allow any modification (writes,

data/lib/ftpd/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
   class Server
 

data/lib/ftpd/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
   class Session
 
@@ -7,6 +9,7 @@ module Ftpd
     attr_accessor :command_sequence_checker
     attr_accessor :data_channel_protection_level
     attr_accessor :data_server
+    attr_accessor :data_server_factory
     attr_accessor :data_type
     attr_accessor :logged_in
     attr_accessor :name_prefix
@@ -34,6 +37,10 @@ module Ftpd
       @protocols = Protocols.new(@socket)
       @command_handlers = CommandHandlers.new
       @command_loop = CommandLoop.new(self)
+      @data_server_factory = DataServerFactory.make(
+        @socket.addr[3],
+        config.passive_ports,
+      )
       register_commands
       initialize_session
     end

data/lib/ftpd/session_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # All of the configuration needed by a session
@@ -23,8 +25,8 @@ module Ftpd
 
     attr_accessor :auth_level
 
-    # @return driver A driver for the server's dynamic behavior such
-    #   as authentication and file system access.
+    # A driver for the server's dynamic behavior such as
+    # authentication and file system access.
     #
     # The driver should expose these public methods:
     # * {Example::Driver#authenticate authenticate}
@@ -66,6 +68,28 @@ module Ftpd
 
     attr_accessor :response_delay
 
+    # The advertised public IP for passive mode connections.  This is
+    # the IP that the client must use to make a connection back to the
+    # server.  If nil, the IP of the bound interface is used.  When
+    # the FTP server is behind a firewall, set this to firewall's
+    # public IP and add the appropriate rule to the firewall to
+    # forward that IP to the machine that ftpd is running on.
+    #
+    # Set this before calling #start.
+    #
+    # @return [nil, String]
+
+    attr_accessor :nat_ip
+
+    # The range of ports for passive mode connections.  If nil, then a
+    # random etherial port is used.  Otherwise, a random port from
+    # this range is used.
+    #
+    # Set this before calling #start.
+    #
+    # @return [nil, Range]
+    attr_accessor :passive_ports
+
     # The server's name, sent in a STAT reply.  Defaults to
     # {Ftpd::FtpServer::DEFAULT_SERVER_NAME}.
     #

data/lib/ftpd/stream.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   class Stream

data/lib/ftpd/telnet.rb

@@ -1,4 +1,5 @@
 # -*- ruby encoding: us-ascii -*-
+# frozen_string_literal: true
 
 module Ftpd
 
@@ -97,8 +98,8 @@ module Ftpd
     # Parse the the command.  Sets @plain and @reply
 
     def parse_command(command)
-      @plain = ''
-      @reply = ''
+      @plain = ''.dup
+      @reply = ''.dup
       scanner = StringScanner.new(command)
       while !scanner.eos?
         SEQUENCES.each do |regexp, method|

data/lib/ftpd/temp_dir.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # Create temporary directories that will be removed when the program

data/lib/ftpd/tls_server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'server'
 
 module Ftpd

data/lib/ftpd/translate_exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ftpd
 
   # This module translates exceptions to FileSystemError exceptions.

data/spec/command_sequence_checker_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('spec_helper', File.dirname(__FILE__))
 
 module Ftpd