ftpd 0.0.0.pre1

data/features/syntax_errors.feature

@@ -0,0 +1,15 @@
+Feature: Miscellaneous Errors
+
+  As a client
+  I want good error messages
+  So that I can figure out what went wrong
+
+  Scenario: Empty command
+    Given a successful connection
+    When the client sends an empty command
+    Then the server returns a syntax error
+
+  Scenario: Command contains non-word characters
+    Given a successful connection
+    When the client sends a non-word command
+    Then the server returns a syntax error

data/features/type.feature

@@ -0,0 +1,53 @@
+Feature: Representation Type
+
+  As a client
+  I want to set the representation type
+  So that I can interoperate with foreign operating systems
+
+Scenario: Type ASCII
+  Given a successful login
+  Then the client successfully sets type "A"
+
+Scenario: Type IMAGE
+  Given a successful login
+  Then the client successfully sets type "I"
+
+Scenario: Type EBCDIC
+  Given a successful login
+  When the client sets type "E"
+  Then the server returns a type not implemented error
+
+Scenario: Type Local
+  Given a successful login
+  When the client sets type "L 7"
+  Then the server returns a type not implemented error
+
+Scenario: Invalid Type
+  Given a successful login
+  When the client sets type "*"
+  Then the server returns an invalid type error
+
+Scenario: Format Telnet
+  Given a successful login
+  When the client sets type "A T"
+  Then the server returns a format not implemented error
+
+Scenario: Format Carriage Control
+  Given a successful login
+  When the client sets type "A C"
+  Then the server returns a format not implemented error
+
+Scenario: Invalid Format
+  Given a successful login
+  When the client sets type "A *"
+  Then the server returns an invalid format error
+
+Scenario: Not logged in
+  Given a successful connection
+  When the client sets type "S"
+  Then the server returns a not logged in error
+
+Scenario: Missing parameter
+  Given a successful login
+  When the client sets type with no parameter
+  Then the server returns a syntax error

data/ftpd.gemspec

@@ -0,0 +1,112 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "ftpd"
+  s.version = "0.0.0.pre1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wayne Conrad"]
+  s.date = "2013-02-10"
+  s.description = "ftpd is a pure Ruby FTP server library.  It supports implicit and explicit TLS, and can be used by a text fixture or FTP daemon."
+  s.email = "wconrad@yagni.com"
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.md",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "features/command_errors.feature",
+    "features/delete.feature",
+    "features/directory_navigation.feature",
+    "features/file_structure.feature",
+    "features/get.feature",
+    "features/list.feature",
+    "features/login.feature",
+    "features/mode.feature",
+    "features/name_list.feature",
+    "features/noop.feature",
+    "features/port.feature",
+    "features/put.feature",
+    "features/quit.feature",
+    "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/directories.rb",
+    "features/step_definitions/error.rb",
+    "features/step_definitions/file_structure.rb",
+    "features/step_definitions/get.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/mode.rb",
+    "features/step_definitions/noop.rb",
+    "features/step_definitions/passive.rb",
+    "features/step_definitions/port.rb",
+    "features/step_definitions/put.rb",
+    "features/step_definitions/quit.rb",
+    "features/step_definitions/server.rb",
+    "features/step_definitions/server_files.rb",
+    "features/step_definitions/type.rb",
+    "features/support/env.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/syntax_errors.feature",
+    "features/type.feature",
+    "ftpd.gemspec",
+    "insecure-test-cert.pem",
+    "lib/ftpd.rb",
+    "lib/ftpd/FakeFtpServer.rb",
+    "lib/ftpd/FakeServer.rb",
+    "lib/ftpd/FakeTlsServer.rb",
+    "lib/ftpd/ObjectUtil.rb",
+    "lib/ftpd/TempDir.rb",
+    "lib/ftpd/q.rb",
+    "rake_tasks/cucumber.rake",
+    "rake_tasks/jeweler.rake"
+  ]
+  s.homepage = "http://github.com/wconrad/ftpd"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "Pure Ruby FTP server library"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<cucumber>, ["~> 1.2.1"])
+      s.add_development_dependency(%q<double-bag-ftps>, ["~> 0.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rake>, ["~> 10.0.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<cucumber>, ["~> 1.2.1"])
+      s.add_dependency(%q<double-bag-ftps>, ["~> 0.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rake>, ["~> 10.0.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, ["~> 1.2.1"])
+    s.add_dependency(%q<double-bag-ftps>, ["~> 0.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rake>, ["~> 10.0.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.1"])
+  end
+end
+

data/insecure-test-cert.pem

@@ -0,0 +1,29 @@
+-----BEGIN CERTIFICATE-----
+MIICIzCCAYwCCQDPNA1ZOq8CbzANBgkqhkiG9w0BAQUFADBWMQswCQYDVQQGEwJV
+UzEPMA0GA1UECAwGRGVuaWFsMRQwEgYDVQQHDAtTcHJpbmdmaWVsZDEMMAoGA1UE
+CgwDRGlzMRIwEAYDVQQDDAlsb2NhbGhvc3QwHhcNMTIwNjIyMTMyMTI1WhcNMjIw
+NjIwMTMyMTI1WjBWMQswCQYDVQQGEwJVUzEPMA0GA1UECAwGRGVuaWFsMRQwEgYD
+VQQHDAtTcHJpbmdmaWVsZDEMMAoGA1UECgwDRGlzMRIwEAYDVQQDDAlsb2NhbGhv
+c3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAKyacIYurNopaS1tHCE5VrUb
+1tFveP5kWm6kyeE42dYFMcb0wSKofKDWPju+jEwxZ/SLBnF/IvDKqfFH8A7bzdTi
+mdtiWZgqMjs1QxFWF3ohoHm0bB2l0zSWufefjSjstSJanazOW4seq3Zm9ut233Mm
+7h2fKgmM8mzUIKqqLCFfAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAJdwBZm4BI+7y
+Ul0TJtzdLuKo5lKJXX/l8v7hlvziR6Vbv0H7bdqJ+5N3DLDDHZ4DEbypP67lxf2i
+cyKdbash/nJsMUVUr+MsvJ9VyRRiSyhzqCN/RgaN9nx4Z0fl5I8aQp2qcZi1t8R5
+ZLgk9oqiPOEca6i22DDBSg0cnhBH9Lk=
+-----END CERTIFICATE-----
+-----BEGIN RSA PRIVATE KEY-----
+MIICXAIBAAKBgQCsmnCGLqzaKWktbRwhOVa1G9bRb3j+ZFpupMnhONnWBTHG9MEi
+qHyg1j47voxMMWf0iwZxfyLwyqnxR/AO283U4pnbYlmYKjI7NUMRVhd6IaB5tGwd
+pdM0lrn3n40o7LUiWp2szluLHqt2Zvbrdt9zJu4dnyoJjPJs1CCqqiwhXwIDAQAB
+AoGAcyj/1qchsNVcVXCtCgXFskSGyWnEooa2R4gvIdPak48XrRT0H3mm3XDUSOxT
+kyqLn396pxMabunpBRDoPCGvbDdphhcSKIJPRga0LJBnMVp87xeaw0JvNB1EsdzP
+xbsXwSt39zjJeAE1IAOgMCHC/GRisvRnkZuKOM7XYe7UAGECQQDeawf/5Zgfcvgc
+Bqxv6ZPCJxAh7FKyWDUqa8RTtD0qWuXOYnlVzaEkN8FfimrPdmQBx+eMacsqCrLG
+v8hvubt5AkEAxqnzo+IU4bsUdezndEjYKOVH3qs9qO+8bneKCqD4h2k2Db2va8OG
+sP44hRMvgkkRiZjHWAUeG+ytgWGU7CK1lwJAe1fvv8GbcxVW8nPg/M8T2f+/upBL
+7AtusG/DGIhDw1FVT/bcQvEeA+/HlSw1v4dwPmyVxBCHUnFMY1vH0+20QQJBAI6s
+4eCx7qNLM1+Z24RFCJEeUWZWfzsDqcWALnCBuNuvMPXfY8u2KdaVTUwtQjKEfYbf
+ZVMOodgWO2mvBkAskVMCQE98evHiZkDEpVU89TbbClYpmGOSRjQTrXEaVePLb0Hr
+GwylNdJEAClM4gK+GnXa4m57xs13eBwuXsM+77fdU2I=
+-----END RSA PRIVATE KEY-----

data/lib/ftpd.rb

@@ -0,0 +1,6 @@
+require 'ftpd/q'
+require 'ftpd/ObjectUtil'
+require 'ftpd/TempDir'
+require 'ftpd/FakeServer'
+require 'ftpd/FakeTlsServer'
+require 'ftpd/FakeFtpServer'

data/lib/ftpd/FakeFtpServer.rb

@@ -0,0 +1,736 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'openssl'
+require 'pathname'
+require File.expand_path('FakeTlsServer', File.dirname(__FILE__))
+require File.expand_path('TempDir', File.dirname(__FILE__))
+require File.expand_path('q', File.dirname(__FILE__))
+
+class FakeFtpServer < FakeTlsServer
+
+  attr_accessor :user
+  attr_accessor :password
+  attr_accessor :debug_path
+  attr_accessor :response_delay
+  attr_accessor :implicit_tls
+
+  def initialize(data_path)
+    super()
+    self.user = 'user'
+    self.password = 'password'
+    self.debug_path = '/dev/stdout'
+    @data_path = Pathname.new(data_path)
+    @response_delay = 0
+    @implicit_tls = false
+  end
+
+  def session(socket)
+    Session.new(:socket => socket,
+                :user => user,
+                :password => password,
+                :data_path => @data_path,
+                :debug_path => debug_path,
+                :response_delay => response_delay,
+                :implicit_tls => @implicit_tls).run
+  end
+
+  private
+
+  class Session
+
+    def initialize(args)
+      @socket = args[:socket]
+      @socket.encrypt if args[:implicit_tls]
+      @expected_user = args[:user]
+      @expected_password = args[:password]
+      @data_path = @cwd = args[:data_path].realpath
+      @debug_path = args[:debug_path]
+      @data_type = 'A'
+      @mode = 'S'
+      @format = 'N'
+      @structure = 'F'
+      @response_delay = args[:response_delay]
+      @data_channel_protection_level = :clear
+    end
+
+    def run
+      reply "220 FakeFtpServer"
+      @state = :user
+      catch :done do
+        loop do
+          begin
+            s = get_command
+            syntax_error unless s =~ /^(\w+)(?: (.*))?$/
+            command, argument = $1.downcase, $2
+            unless VALID_COMMANDS.include?(command)
+              error "500 Syntax error, command unrecognized: #{s}"
+            end
+            method = 'cmd_' + command
+            unless self.class.private_method_defined?(method)
+              error "502 Command not implemented: #{command}"
+            end
+            send(method, argument)
+          rescue Error => e
+            reply e.message
+          rescue Errno::ECONNRESET, Errno::EPIPE
+          end
+        end
+      end
+    end
+
+    private
+
+    class Error < StandardError
+    end
+
+    VALID_COMMANDS = [
+      "abor",
+      "acct",
+      "allo",
+      "appe",
+      "auth",
+      "pbsz",
+      "cdup",
+      "cwd",
+      "dele",
+      "help",
+      "list",
+      "mkd",
+      "mode",
+      "nlst",
+      "noop",
+      "pass",
+      "pasv",
+      "port",
+      "prot",
+      "pwd",
+      "quit",
+      "rein",
+      "rest",
+      "retr",
+      "rmd",
+      "rnfr",
+      "rnto",
+      "site",
+      "smnt",
+      "stat",
+      "stor",
+      "stou",
+      "stru",
+      "syst",
+      "type",
+      "user",
+    ]
+
+    def cmd_user(argument)
+      syntax_error unless argument
+      bad_sequence unless @state == :user
+      @user = argument
+      @state = :password
+      reply "331 Password required"
+    end
+
+    def bad_sequence
+      error "503 Bad sequence of commands"
+    end
+
+    def cmd_pass(argument)
+      syntax_error unless argument
+      bad_sequence unless @state == :password
+      password = argument
+      if @user != @expected_user || password != @expected_password
+        @state = :user
+        error "530 Login incorrect"
+      end
+      reply "230 Logged in"
+      @state = :logged_in
+    end
+
+    def cmd_quit(argument)
+      syntax_error if argument
+      check_logged_in
+      reply "221 Byebye"
+      @state = :user
+    end
+
+    def syntax_error
+      error "501 Syntax error"
+    end
+
+    def cmd_port(argument)
+      check_logged_in
+      pieces = argument.split(/,/)
+      syntax_error unless pieces.size == 6
+      pieces.collect! do |s|
+        syntax_error unless s =~ /^\d{1,3}$/
+        i = s.to_i
+        syntax_error unless (0..255) === i
+        i
+      end
+      @data_hostname = pieces[0..3].join('.')
+      @data_port = pieces[4] << 8 | pieces[5]
+      reply "200 PORT command successful"
+    end
+
+    def cmd_stor(argument)
+      close_data_server_socket_when_done do
+        check_logged_in
+        path = argument
+        syntax_error unless path
+        target = target_path(path)
+        ensure_path_is_in_data_dir(target)
+        contents = receive_file(path)
+        write_file(target, contents)
+        reply "226 Transfer complete"
+      end
+    end
+
+    def cmd_retr(argument)
+      close_data_server_socket_when_done do
+        check_logged_in
+        path = argument
+        syntax_error unless path
+        target = target_path(path)
+        ensure_path_is_in_data_dir(target)
+        contents = read_file(target)
+        transmit_file(contents)
+      end
+    end
+
+    def cmd_dele(argument)
+      check_logged_in
+      path = argument
+      error "501 Path required" unless path
+      target = target_path(path)
+      ensure_path_is_in_data_dir(target)
+      ensure_path_exists target
+      File.unlink(target)
+      reply "250 DELE command successful"
+    end
+
+    def cmd_list(argument)
+      ls(argument, '-l')
+    end
+
+    def cmd_nlst(argument)
+      ls(argument, '-1')
+    end
+
+    def ls(path, option)
+      close_data_server_socket_when_done do
+        check_logged_in
+        ls_dir, ls_path = get_ls_dir_and_path(path)
+        list = get_file_list(ls_dir, ls_path, option)
+        transmit_file(list, 'A')
+      end
+    end
+
+    def get_ls_dir_and_path(path)
+      path = path || '.'
+      target = target_path(path)
+      target = realpath(target)
+      ensure_path_is_in_data_dir(target)
+      if target.to_s.index(@cwd.to_s) == 0
+        ls_dir = @cwd
+        ls_path = target.to_s[@cwd.to_s.length..-1]
+      else
+        raise
+      end
+      if ls_path =~ /^\//
+        ls_path = $'
+      end
+      [ls_dir, ls_path]
+    end
+
+    def get_file_list(ls_dir, ls_path, option)
+      command = [
+        'ls',
+        option,
+        ls_path,
+        '2>&1',
+      ].compact.join(' ')
+      list = Dir.chdir(ls_dir) do
+        `#{command}`
+      end
+      list = "" if $? != 0
+      list = list.gsub(/^total \d+\n/, '')
+      list
+    end
+
+    def realpath(pathname)
+      handle_system_error do
+        basename = File.basename(pathname.to_s)
+        if is_glob?(basename)
+          pathname.dirname.realpath + basename
+        else
+          pathname.realpath
+        end
+      end
+    end
+
+    def is_glob?(filename)
+      filename =~ /[.*]/
+    end
+
+    def cmd_type(argument)
+      check_logged_in
+      syntax_error unless argument =~ /^(\S)(?: (\S+))?$/
+      type_code = $1
+      format_code = $2
+      set_type(type_code)
+      set_format(format_code)
+      reply "200 Type set to #{@data_type}"
+    end
+
+    def set_type(type_code)
+      name, implemented = DATA_TYPES[type_code]
+      error "504 Invalid type code" unless name
+      error "504 Type not implemented" unless implemented
+      @data_type = type_code
+    end
+
+    def set_format(format_code)
+      format_code ||= 'N'
+      name, implemented = FORMAT_TYPES[format_code]
+      error "504 Invalid format code" unless name
+      error "504 Format not implemented" unless implemented
+      @data_format = format_code
+    end
+
+    def cmd_mode(argument)
+      syntax_error unless argument
+      check_logged_in
+      name, implemented = TRANSMISSION_MODES[argument]
+      error "504 Invalid mode code" unless name
+      error "504 Mode not implemented" unless implemented
+      @mode = argument
+      reply "200 Mode set to #{name}"
+    end
+
+    def cmd_stru(argument)
+      syntax_error unless argument
+      check_logged_in
+      name, implemented = FILE_STRUCTURES[argument]
+      error "504 Invalid structure code" unless name
+      error "504 Structure not implemented" unless implemented
+      @structure = argument
+      reply "200 File structure set to #{name}"
+    end
+
+    def cmd_noop(argument)
+      syntax_error if argument
+      reply "200 Nothing done"
+    end
+
+    def cmd_pasv(argument)
+      check_logged_in
+      if @data_server
+        reply "200 Already in passive mode"
+      else
+        @data_server = TCPServer.new('localhost', 0)
+        ip = @data_server.addr[3]
+        port = @data_server.addr[1]
+        quads = [
+          ip.scan(/\d+/),
+          port >> 8,
+          port & 0xff,
+        ].flatten.join(',')
+        reply "227 Entering passive mode (#{quads})"
+      end
+    end
+
+    def cmd_cwd(argument)
+      check_logged_in
+      target = if argument =~ %r"^/(.*)$"
+                 @data_path + $1
+               else
+                 @cwd + argument
+               end
+      ensure_path_is_in_data_dir(target)
+      restore_cwd_on_error do
+        @cwd = target
+        pwd
+      end
+    end
+
+    def cmd_cdup(argument)
+      check_logged_in
+      cmd_cwd('..')
+    end
+
+    def cmd_pwd(argument)
+      check_logged_in
+      pwd
+    end
+
+    def cmd_auth(security_scheme)
+      if @socket.encrypted?
+        raise Error, "503 AUTH already done"
+      end
+      unless security_scheme =~ /^TLS(-C)?$/i
+        raise Error, "500 Security scheme not implemented: #{security_scheme}"
+      end
+      reply "234 AUTH #{security_scheme} OK."
+      @socket.encrypt
+    end
+
+    def cmd_pbsz(buffer_size)
+      syntax_error unless buffer_size =~ /^\d+$/
+      buffer_size = buffer_size.to_i
+      unless @socket.encrypted?
+        raise Error, "503 PBSZ must be preceded by AUTH"
+      end
+      unless buffer_size == 0
+        raise Error, "501 PBSZ=0"
+      end
+      reply "200 PBSZ=0"
+      @protection_buffer_size_set = true
+    end
+
+    def cmd_prot(level_arg)
+      level_code = level_arg.upcase
+      unless @protection_buffer_size_set
+        raise Error, "503 PROT must be preceded by PBSZ"
+      end
+      level = DATA_CHANNEL_PROTECTION_LEVELS[level_code]
+      unless level
+        raise Error, "504 Unknown protection level"
+      end
+      unless level == :private
+        raise Error, "536 Unsupported protection level #{level}"
+      end
+      @data_channel_protection_level = level
+      reply "200 Data protection level #{level_code}"
+    end
+
+    def pwd
+      reply %Q(257 "#{sanitized_cwd}" is current directory)
+    end
+
+    def relative_to_data_path(path)
+      data_path = realpath(@data_path).to_s
+      path = realpath(path).to_s
+      path = path.gsub(data_path, '')
+      path = '/' if path.empty?
+      path
+    end
+
+    def sanitized_cwd
+      relative_to_data_path(@cwd)
+    end
+
+    def error(message)
+      raise Error, message
+    end
+
+    TRANSMISSION_MODES = {
+      'B'=>['Block', false],
+      'C'=>['Compressed', false],
+      'S'=>['Stream', true],
+    }
+
+    FORMAT_TYPES = {
+      'N'=>['Non-print', true],
+      'T'=>['Telnet format effectors', false],
+      'C'=>['Carriage Control (ASA)', false],
+    }
+
+    DATA_TYPES = {
+      'A'=>['ASCII', true],
+      'E'=>['EBCDIC', false],
+      'I'=>['BINARY', true],
+      'L'=>['LOCAL', false],
+    }
+
+    FILE_STRUCTURES = {
+      'R'=>['Record', false],
+      'F'=>['File', true],
+      'P'=>['Page', false],
+    }
+
+    DATA_CHANNEL_PROTECTION_LEVELS = {
+      'C'=>:clear,
+      'S'=>:safe,
+      'E'=>:confidential,
+      'P'=>:private
+    }
+
+    def check_logged_in
+      return if @state == :logged_in
+      error "530 Not logged in"
+    end
+
+    def ensure_path_is_in_data_dir(path)
+      unless child_path_of?(@data_path, path)
+        error "550 Access denied"
+      end
+    end
+
+    def ensure_path_exists(path)
+      unless File.exists?(path)
+        error '450 No such file or directory'
+      end
+    end
+
+    def child_path_of?(parent, child)
+      child.cleanpath.to_s.index(parent.cleanpath.to_s) == 0
+    end
+
+    def target_path(path)
+      path = Pathname.new(path)
+      base, path = if path.to_s =~ /^\/(.*)/
+                     [@data_path, $1]
+                   else
+                     [@cwd, path]
+                   end
+      base + path
+    end
+
+    def read_file(path)
+      handle_system_error do
+        File.open(path, 'rb') do |file|
+          file.read
+        end
+      end
+    end
+
+    def write_file(dest, contents)
+      handle_system_error do
+        File.open(dest, 'w') do |file|
+          file.write(contents)
+        end
+      end
+    end
+
+    def handle_system_error
+      begin
+        yield
+      rescue SystemCallError => e
+        error "550 #{e}"
+      end
+    end
+
+    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")
+        reply "226 Transfer complete"
+      end
+    end
+
+    def receive_file(path)
+      open_data_connection do |data_socket|
+        contents = data_socket.read
+        contents = nvt_ascii_to_unix(contents) if @data_type == 'A'
+        debug("Received #{contents.size} bytes")
+        contents
+      end
+    end
+
+    def unix_to_nvt_ascii(s)
+      return s if s =~ /\r\n/
+      s.gsub(/\n/, "\r\n")
+    end
+
+    def nvt_ascii_to_unix(s)
+      s.gsub(/\r\n/, "\n")
+    end
+
+    def open_data_connection(&block)
+      reply "150 Opening #{data_connection_description}"
+      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 data_connection_description
+      [
+        DATA_TYPES[@data_type][0],
+        "mode data connection",
+        ("(TLS)" if encrypt_data?)
+      ].compact.join(' ')
+    end
+
+    def encrypt_data?
+      @data_channel_protection_level != :clear
+    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_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_passive_data_connection
+      data_socket = @data_server.accept
+      begin
+        yield(data_socket)
+      ensure
+        data_socket.close
+      end
+    end
+
+    def close_data_server_socket_when_done
+      yield
+    ensure
+      close_data_server_socket
+    end
+
+    def close_data_server_socket
+      return unless @data_server
+      @data_server.close
+      @data_server = nil
+    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 make_tls_connection(socket)
+      ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, @socket.ssl_context)
+      ssl_socket.accept
+      begin
+        yield(ssl_socket)
+      ensure
+        ssl_socket.close
+      end
+    end
+
+    def get_command
+      s = @socket.gets
+      throw :done if s.nil?
+      s = s.chomp
+      debug(s)
+      s
+    end
+
+    def reply(s)
+      if @response_delay.to_i != 0
+        debug "#{@response_delay} second delay before replying"
+        sleep @response_delay
+      end
+      debug(s)
+      @socket.puts(s)
+    end
+
+    def debug(*s)
+      return unless debug?
+      File.open(@debug_path, 'a') do |file|
+        file.puts(*s)
+      end
+    end
+
+    def debug?
+      ENV['DEBUG'].to_i != 0
+    end
+
+    def restore_cwd_on_error
+      orig_cwd = @cwd
+      yield
+    rescue
+      @cwd = orig_cwd
+      raise
+    end
+
+  end
+
+end
+
+class Scaffold
+
+  def initialize
+    @data_dir = TempDir.new
+    create_files
+    @server = FakeFtpServer.new(@data_dir.path)
+    set_credentials
+    display_connection_info
+    create_connection_script
+  end
+
+  def run
+    wait_until_stopped
+  end
+
+  private
+  
+  HOST = 'localhost'
+
+  def create_files
+    [
+      'README',
+      'outgoing/getme',
+    ].each do |path|
+      base_name = File.basename(path)
+      dir_name = File.dirname(path)
+      dir_path = File.join(@data_dir.path, dir_name)
+      file_path = File.join(dir_path, base_name)
+      FileUtils.mkdir_p(dir_path)
+      File.open(file_path, 'w') do |file|
+        file.puts "Contents of #{path}"
+      end
+    end
+  end
+
+  def set_credentials
+    @server.user = ENV['LOGNAME']
+    @server.password = ''
+  end
+
+  def display_connection_info
+    puts "Host: #{HOST}"
+    puts "Port: #{@server.port}"
+    puts "User: #{@server.user}"
+    puts "Pass: #{@server.password}"
+    puts "Directory: #{@data_dir.path}"
+  end
+
+  def create_connection_script
+    command_path = '/tmp/connect_to_fake_ftp_server.sh'
+    File.open(command_path, 'w') do |file|
+      file.puts "#!/bin/bash"
+      file.puts "ftp $FTP_ARGS #{HOST} #{@server.port}"
+    end
+    system("chmod +x #{command_path}")
+    puts "Connection script written to #{command_path}"
+  end
+
+  def wait_until_stopped
+    puts "FTP server started.  Press ENTER or c-C to stop it"
+    $stdout.flush
+    begin
+      gets
+    rescue Interrupt
+      puts "Interrupt"
+    end
+  end
+
+end
+
+Scaffold.new.run if $0 == __FILE__