investtools-ftpd 1.0.1

data/spec/protocols_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Ftpd
+  describe Protocols do
+
+    # A fake server that returns a connected server-side socket.
+
+    class TestServer
+
+      # The socket upon which the server is listening
+
+      attr_reader :listening_socket
+
+      # Returns the connected server-side socket
+
+      attr_reader :connected_socket
+
+      # @param bind_address [String] The address to which to bind the
+      #   server socket.
+      # @param connect_address [String] The address to which the
+      #   client socket should connect.
+
+      def initialize(bind_address, connect_address)
+        queue = Queue.new
+        @listening_socket = TCPServer.new(bind_address, 0)
+        port = @listening_socket.addr[1]
+        Thread.new do
+          queue.enq @listening_socket.accept
+        end
+        client_socket = TCPSocket.new(connect_address, port)
+        @connected_socket = queue.deq
+      end
+
+    end
+
+    context 'IPV4 server' do
+
+      let(:bind_address) {'127.0.0.1'}
+      let(:connect_address) {'127.0.0.1'}
+      let(:connected_socket) do
+        TestServer.new(bind_address, connect_address).connected_socket
+      end
+      subject(:protocols) {Protocols.new(connected_socket)}
+
+      it 'should support IPV4' do
+        expect(protocols.supports_protocol?(Protocols::IPV4)).to be_truthy
+      end
+
+      it 'should not support IPV6' do
+        expect(protocols.supports_protocol?(Protocols::IPV6)).to be_falsey
+      end
+
+      it 'should list the supported protocols' do
+        expect(protocols.protocol_codes).to eq [
+          Protocols::IPV4,
+        ]
+      end
+
+    end
+
+    context 'IPV6 server, IPV6 connection' do
+
+      let(:bind_address) {'::1'}
+      let(:connect_address) {'::1'}
+      let(:connected_socket) do
+        TestServer.new(bind_address, connect_address).connected_socket
+      end
+      subject(:protocols) {Protocols.new(connected_socket)}
+
+      it 'should not support IPV4' do
+        expect(protocols.supports_protocol?(Protocols::IPV4)).to be_falsey
+      end
+
+      it 'should support IPV6' do
+        expect(protocols.supports_protocol?(Protocols::IPV6)).to be_truthy
+      end
+
+      it 'should list the supported protocols' do
+        expect(protocols.protocol_codes).to eq [
+          Protocols::IPV6,
+        ]
+      end
+
+    end
+
+    context 'wildcard server, IPV4 connection' do
+
+      let(:bind_address) {'::'}
+      let(:connect_address) {'127.0.0.1'}
+      let(:connected_socket) do
+        TestServer.new(bind_address, connect_address).connected_socket
+      end
+      subject(:protocols) {Protocols.new(connected_socket)}
+
+      it 'should support IPV4' do
+        expect(protocols.supports_protocol?(Protocols::IPV4)).to be_truthy
+      end
+
+      it 'should support IPV6' do
+        expect(protocols.supports_protocol?(Protocols::IPV6)).to be_truthy
+      end
+
+      it 'should list the supported protocols' do
+        expect(protocols.protocol_codes).to eq [
+          Protocols::IPV4,
+          Protocols::IPV6,
+        ]
+      end
+
+    end
+
+    context 'wildcard server, IPV6 connection' do
+
+      let(:bind_address) {'::'}
+      let(:connect_address) {'::1'}
+      let(:connected_socket) do
+        TestServer.new(bind_address, connect_address).connected_socket
+      end
+      subject(:protocols) {Protocols.new(connected_socket)}
+
+      it 'should support IPV4' do
+        expect(protocols.supports_protocol?(Protocols::IPV4)).to be_truthy
+      end
+
+      it 'should support IPV6' do
+        expect(protocols.supports_protocol?(Protocols::IPV6)).to be_truthy
+      end
+
+      it 'should list the supported protocols' do
+        expect(protocols.protocol_codes).to eq [
+          Protocols::IPV4,
+          Protocols::IPV6,
+        ]
+      end
+
+    end
+
+  end
+end

data/spec/server_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Ftpd
+
+  describe Server do
+
+    describe '#join' do
+      it 'calls server_thread#join' do
+        expect_any_instance_of(Thread).to receive(:join)
+        server = Server.new
+        server.start
+        server.join
+      end
+      context 'when server is not started' do
+        it 'raises an error' do
+          server = Server.new
+          expect { server.join }.to raise_error('Server is not started!')
+        end
+      end
+    end
+
+    describe 'reuse explicit port (github #23)' do
+
+      # The bug being tested involves a race condition.  Monkey patch
+      # the server so that start does not return until "accept" has
+      # been called on the server socket.  This causes the test to
+      # reliably expose the bug.
+
+      def monkey_patch_server(server)
+
+        class << server
+
+          def start
+            @accepting = Queue.new
+            super
+            wait_for_accept
+          end
+
+          def accept
+            @accepting.enq true
+            super
+          end
+
+          private
+
+          def wait_for_accept
+            @accepting.deq
+            # There's a potential race condition in _this_ code:
+            # @accepting is triggered just before the accept is done
+            # on the socket, but it's possible that the server thread
+            # has been preempted and accept has not yet been called.
+            # A little sleep gives the server thread another shot at
+            # actually getting the accept done before we continue.
+            sleep 0.01
+          end
+
+        end
+
+      end
+
+      it do
+        port = find_open_port
+        2.times do
+          server = Server.new
+          monkey_patch_server server
+          server.port = port
+          server.start
+          server.stop
+        end
+      end
+
+      def find_open_port
+        socket = TCPServer.new('localhost', 0)
+        socket.addr[1].tap {socket.close}
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+unless $:.include?(File.dirname(__FILE__) + '/../lib')
+  $:.unshift(File.dirname(__FILE__) + '/../lib')
+end
+
+require 'ftpd'
+require 'rspec/its'
+require 'stringio'
+require 'thread'
+require 'timecop'
+require 'tmpdir'
+
+glob = File.expand_path('helpers/*.rb', File.dirname(__FILE__))
+Dir[glob].sort.each do |helper_path|
+  require helper_path
+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

data/spec/translate_exceptions_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Ftpd
+  describe TranslateExceptions do
+
+    class FooError < StandardError ; end
+    class BarError < StandardError ; end
+
+    class Subject
+
+      include TranslateExceptions
+
+      def initialize
+        translate_exception FooError
+      end
+
+      def raise_error(error, message)
+        raise error, message
+      end
+      translate_exceptions :raise_error
+
+    end
+
+    let(:subject) {Subject.new}
+    let(:message) {'An error happened'}
+
+    it 'should translate a registered error' do
+      expect {
+        subject.raise_error(FooError, message)
+      }.to raise_error PermanentFileSystemError, message
+    end
+
+    it 'should pass through an unregistered error' do
+      expect {
+        subject.raise_error(BarError, message)
+      }.to raise_error BarError, message
+    end
+
+  end
+end

metadata

@@ -0,0 +1,404 @@
+--- !ruby/object:Gem::Specification
+name: investtools-ftpd
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Wayne Conrad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memoizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: double-bag-ftps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: ftpd is a pure Ruby FTP server library.  It supports implicit and explicit
+  TLS, IPV6, passive and active mode, and is unconditionally compliant per RFC-1123.  It
+  can be used as part of a test fixture or embedded in a program.
+email: wconrad@yagni.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- ".travis.yml"
+- ".yardopts"
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- doc/benchmarks.md
+- doc/references.md
+- doc/rfc-compliance.md
+- examples/example.rb
+- examples/example_spec.rb
+- 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/abort.feature
+- 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
+- features/ftp_server/delay_after_failed_login.feature
+- features/ftp_server/delete.feature
+- features/ftp_server/directory_navigation.feature
+- features/ftp_server/disconnect_after_failed_logins.feature
+- features/ftp_server/eprt.feature
+- features/ftp_server/epsv.feature
+- features/ftp_server/features.feature
+- features/ftp_server/file_structure.feature
+- features/ftp_server/get.feature
+- features/ftp_server/get_ipv6.feature
+- 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/logging.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/max_connections.feature
+- features/ftp_server/mdtm.feature
+- features/ftp_server/mkdir.feature
+- features/ftp_server/mode.feature
+- features/ftp_server/name_list.feature
+- features/ftp_server/name_list_tls.feature
+- features/ftp_server/noop.feature
+- features/ftp_server/options.feature
+- features/ftp_server/pasv.feature
+- features/ftp_server/port.feature
+- features/ftp_server/put.feature
+- features/ftp_server/put_tls.feature
+- features/ftp_server/put_unique.feature
+- features/ftp_server/quit.feature
+- features/ftp_server/reinitialize.feature
+- features/ftp_server/rename.feature
+- features/ftp_server/rmdir.feature
+- features/ftp_server/site.feature
+- features/ftp_server/size.feature
+- features/ftp_server/status.feature
+- features/ftp_server/step_definitions/logging.rb
+- features/ftp_server/step_definitions/test_server.rb
+- features/ftp_server/structure_mount.feature
+- features/ftp_server/syntax_errors.feature
+- features/ftp_server/syst.feature
+- features/ftp_server/timeout.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
+- features/step_definitions/command.rb
+- features/step_definitions/connect.rb
+- features/step_definitions/delete.rb
+- features/step_definitions/directory_navigation.rb
+- features/step_definitions/error_replies.rb
+- features/step_definitions/features.rb
+- features/step_definitions/file_structure.rb
+- features/step_definitions/generic_send.rb
+- features/step_definitions/get.rb
+- features/step_definitions/help.rb
+- features/step_definitions/invalid_commands.rb
+- features/step_definitions/line_endings.rb
+- features/step_definitions/list.rb
+- features/step_definitions/login.rb
+- features/step_definitions/mkdir.rb
+- features/step_definitions/mode.rb
+- features/step_definitions/mtime.rb
+- features/step_definitions/noop.rb
+- features/step_definitions/options.rb
+- features/step_definitions/passive.rb
+- features/step_definitions/pending.rb
+- features/step_definitions/port.rb
+- features/step_definitions/put.rb
+- features/step_definitions/quit.rb
+- features/step_definitions/rename.rb
+- features/step_definitions/rmdir.rb
+- features/step_definitions/server_files.rb
+- features/step_definitions/server_title.rb
+- features/step_definitions/size.rb
+- features/step_definitions/status.rb
+- features/step_definitions/success_replies.rb
+- features/step_definitions/system.rb
+- features/step_definitions/timing.rb
+- features/step_definitions/type.rb
+- features/support/env.rb
+- features/support/example_server.rb
+- features/support/file_templates/ascii_unix
+- features/support/file_templates/ascii_windows
+- features/support/file_templates/binary
+- features/support/test_client.rb
+- features/support/test_file_templates.rb
+- features/support/test_server.rb
+- features/support/test_server_files.rb
+- ftpd.gemspec
+- insecure-test-cert.pem
+- investtools-ftpd.gemspec
+- lib/ftpd.rb
+- lib/ftpd/auth_levels.rb
+- lib/ftpd/cmd_abor.rb
+- lib/ftpd/cmd_allo.rb
+- lib/ftpd/cmd_appe.rb
+- lib/ftpd/cmd_auth.rb
+- lib/ftpd/cmd_cdup.rb
+- lib/ftpd/cmd_cwd.rb
+- lib/ftpd/cmd_dele.rb
+- lib/ftpd/cmd_eprt.rb
+- lib/ftpd/cmd_epsv.rb
+- lib/ftpd/cmd_feat.rb
+- lib/ftpd/cmd_help.rb
+- lib/ftpd/cmd_list.rb
+- lib/ftpd/cmd_login.rb
+- lib/ftpd/cmd_mdtm.rb
+- lib/ftpd/cmd_mkd.rb
+- lib/ftpd/cmd_mode.rb
+- lib/ftpd/cmd_nlst.rb
+- lib/ftpd/cmd_noop.rb
+- lib/ftpd/cmd_opts.rb
+- lib/ftpd/cmd_pasv.rb
+- lib/ftpd/cmd_pbsz.rb
+- lib/ftpd/cmd_port.rb
+- lib/ftpd/cmd_prot.rb
+- lib/ftpd/cmd_pwd.rb
+- lib/ftpd/cmd_quit.rb
+- lib/ftpd/cmd_rein.rb
+- lib/ftpd/cmd_rename.rb
+- lib/ftpd/cmd_rest.rb
+- lib/ftpd/cmd_retr.rb
+- lib/ftpd/cmd_rmd.rb
+- lib/ftpd/cmd_site.rb
+- lib/ftpd/cmd_size.rb
+- lib/ftpd/cmd_smnt.rb
+- lib/ftpd/cmd_stat.rb
+- lib/ftpd/cmd_stor.rb
+- lib/ftpd/cmd_stou.rb
+- lib/ftpd/cmd_stru.rb
+- lib/ftpd/cmd_syst.rb
+- lib/ftpd/cmd_type.rb
+- lib/ftpd/command_handler.rb
+- lib/ftpd/command_handler_factory.rb
+- lib/ftpd/command_handlers.rb
+- lib/ftpd/command_loop.rb
+- lib/ftpd/command_sequence_checker.rb
+- lib/ftpd/config.rb
+- lib/ftpd/connection_throttle.rb
+- lib/ftpd/connection_tracker.rb
+- lib/ftpd/data_connection_helper.rb
+- lib/ftpd/disk_file_system.rb
+- lib/ftpd/error.rb
+- lib/ftpd/exception_translator.rb
+- lib/ftpd/exceptions.rb
+- lib/ftpd/file_info.rb
+- lib/ftpd/file_system_helper.rb
+- lib/ftpd/ftp_server.rb
+- lib/ftpd/gets_peer_address.rb
+- lib/ftpd/insecure_certificate.rb
+- lib/ftpd/list_format/eplf.rb
+- lib/ftpd/list_format/ls.rb
+- lib/ftpd/list_path.rb
+- lib/ftpd/null_logger.rb
+- lib/ftpd/protocols.rb
+- lib/ftpd/read_only_disk_file_system.rb
+- lib/ftpd/server.rb
+- lib/ftpd/session.rb
+- lib/ftpd/session_config.rb
+- lib/ftpd/stream.rb
+- lib/ftpd/telnet.rb
+- lib/ftpd/temp_dir.rb
+- lib/ftpd/tls_server.rb
+- lib/ftpd/translate_exceptions.rb
+- rake_tasks/cucumber.rake
+- rake_tasks/default.rake
+- rake_tasks/jeweler.rake
+- rake_tasks/spec.rake
+- rake_tasks/test.rake
+- rake_tasks/yard.rake
+- spec/command_sequence_checker_spec.rb
+- spec/connection_throttle_spec.rb
+- spec/connection_tracker_spec.rb
+- spec/disk_file_system_spec.rb
+- spec/exception_translator_spec.rb
+- spec/file_info_spec.rb
+- spec/ftp_server_error_spec.rb
+- spec/list_format/eplf_spec.rb
+- spec/list_format/ls_spec.rb
+- spec/list_path_spec.rb
+- spec/null_logger_spec.rb
+- spec/protocols_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+- spec/telnet_spec.rb
+- spec/translate_exceptions_spec.rb
+homepage: http://github.com/wconrad/ftpd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Pure Ruby FTP server library
+test_files: []