ftpd 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da62814ce49fab3ad30c35b6841810728722bc99
-  data.tar.gz: fd68f590b35708037f0ca1678dd84936dee7d4e1
+  metadata.gz: 637e5bfc2505f89b270ab1a8f89df0dfdb02e84c
+  data.tar.gz: c5209641735180ea65417e1c7ed9afeea370c946
 SHA512:
-  metadata.gz: a84a4a7d0554c71e71816376b7cac3268d0f6250a58d34ffa0a9bc1f5116468b73e36c5f09a333f28b173cf9c4dd9e7427ac5c9f9cb93cf12f63344ae7bfd09e
-  data.tar.gz: ffd9e7e5477c2afd9301158be878968ed7e601677433f5c8e2b0dfee050106f580026235368a726e05a84da0f92a25369de649ddf19a1fa03ff8b2e7d591ce98
+  metadata.gz: 16be5eac5cfe71218a0bd02bb32585ca86f4d241cb6c5ba80b531d8b388a04375f069d1a2f8af323b6a7e452678ddc9239091037b52dae7284f696f04f288e65
+  data.tar.gz: 5dfcee331e594fd2d5a8f7b956d81b71a9b2693ecbf5ffb9603cbd0f83aa1e4df945216eb7f403b37067b2851f7efdedc81bf81b17a495493f84f4213f49e487

data/Changelog.md

@@ -2,7 +2,11 @@ This is the change log for the main branch of ftpd, which supports
 Ruby 1.9 and greater.  For ruby 1.8.7, please use the latest version
 before 0.8.0.
 
-### Development
+### 2.0.1 2016-11-02
+
+* Redact password in log (thanks ukolovda)
+
+### 2.0.0 2016-06-01
 
 Breaking changes:
 

data/Gemfile

@@ -4,7 +4,7 @@ gem 'memoizer', '~> 1.0'
 
 group :development do
   gem 'cucumber', '~> 2.0'
-  gem 'double-bag-ftps', '~> 0.1'
+  gem 'double-bag-ftps', '~> 0.1', '>= 0.1.3'
   gem 'jeweler', '~> 2.0'
   gem 'rake', '~> 11.1'
   gem 'redcarpet', '~> 3.1'

data/Gemfile.lock

@@ -3,62 +3,63 @@ GEM
   specs:
     addressable (2.4.0)
     builder (3.2.2)
-    cucumber (2.3.3)
+    cucumber (2.4.0)
       builder (>= 2.1.2)
-      cucumber-core (~> 1.4.0)
+      cucumber-core (~> 1.5.0)
       cucumber-wire (~> 0.0.1)
       diff-lcs (>= 1.1.3)
-      gherkin (~> 3.2.0)
+      gherkin (~> 4.0)
       multi_json (>= 1.7.5, < 2.0)
       multi_test (>= 0.1.2)
-    cucumber-core (1.4.0)
-      gherkin (~> 3.2.0)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
     cucumber-wire (0.0.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
-    double-bag-ftps (0.1.2)
+    double-bag-ftps (0.1.3)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    gherkin (3.2.0)
+    gherkin (4.0.0)
     git (1.3.0)
-    github_api (0.13.1)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
+      hashie (>= 1.2)
       multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
       oauth2
-    hashie (3.4.3)
+    hashie (3.4.6)
     highline (1.7.8)
-    jeweler (2.1.1)
+    jeweler (2.1.2)
       builder
       bundler (>= 1.0)
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.11.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
       rake
       rdoc
       semver
     json (1.8.3)
-    jwt (1.5.1)
+    jwt (1.5.6)
     memoizer (1.0.1)
-    mini_portile2 (2.0.0)
-    multi_json (1.11.2)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
     multi_test (0.1.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    oauth2 (1.1.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.2.0)
       faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0, < 1.5.2)
+      jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    rack (1.6.4)
-    rake (11.1.2)
+    rack (2.0.1)
+    rake (11.3.0)
     rdoc (4.2.2)
       json (~> 1.4)
     redcarpet (3.3.4)
@@ -88,7 +89,7 @@ PLATFORMS
 
 DEPENDENCIES
   cucumber (~> 2.0)
-  double-bag-ftps (~> 0.1)
+  double-bag-ftps (~> 0.1, >= 0.1.3)
   jeweler (~> 2.0)
   memoizer (~> 1.0)
   rake (~> 11.1)
@@ -99,4 +100,4 @@ DEPENDENCIES
   yard (~> 0.8.7)
 
 BUNDLED WITH
-   1.11.2
+   1.13.1

data/README.md

@@ -174,8 +174,8 @@ server.start
 
 You can set any of these attributes before starting the server:
 
-# {Ftpd::FtpServer#nat_ip}
-# {Ftpd::FtpServer#passive_ports}
+* {Ftpd::FtpServer#nat_ip}
+* {Ftpd::FtpServer#passive_ports}
 * {Ftpd::FtpServer#allow_low_data_ports}
 * {Ftpd::FtpServer#auth_level}
 * {Ftpd::FtpServer#exception_handler}

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1

data/bin/ftpdrb

@@ -0,0 +1,289 @@
+#!/usr/bin/env ruby
+#
+# Ftpd is a pure Ruby FTP server library. CLI version
+#
+unless $:.include?(File.dirname(__FILE__) + '/../lib')
+  $:.unshift(File.dirname(__FILE__) + '/../lib')
+end
+
+require 'ftpd'
+require 'ipaddr'
+require 'optparse'
+
+module FTPDrb
+
+  # Command-line option parser
+  class Arguments
+
+    attr_reader :account
+    attr_reader :auth_level
+    attr_reader :debug
+    attr_reader :eplf
+    attr_reader :interface
+    attr_reader :nat_ip
+    attr_reader :passive_ports
+    attr_reader :password
+    attr_reader :port
+    attr_reader :path
+    attr_reader :read_only
+    attr_reader :session_timeout
+    attr_reader :servername
+    attr_reader :tls
+    attr_reader :user
+
+    def initialize(argv)
+      @interface       = '127.0.0.1'
+      @tls             = :explicit
+      @port            = 0
+      @auth_level      = 'password'
+      @user            = ENV['LOGNAME']
+      @password        = ''
+      @account         = ''
+      @path            = nil
+      @session_timeout = default_session_timeout
+      @servername      = 'FTPd - Pure Ruby FTP server'
+      @log             = nil
+      @nat_ip          = nil
+      @passive_ports   = nil
+      
+      opts = option_parser
+      opts.parse!(argv)
+    rescue OptionParser::ParseError => e
+      $stderr.puts e
+      exit(1)
+    end
+    
+    private
+    
+    def option_parser
+      opts = OptionParser.new do |op|
+        op.banner = "ftpdrb - Pure Ruby FTP Server. (ftpd ruby gem)\n\nUsage: #{__FILE__} [OPTIONS]"
+        
+        op.separator "Help menu:"
+        op.on('-p', '--port N', Integer, 'Bind to a specific port') do |t|
+          @port = t
+        end
+        op.on('-i', '--interface IP', 'Bind to a specific interface. (Use "0.0.0.0" for all interfaces)') do |t|
+          @interface = t
+        end
+        op.on('-s', '--servername SERVERNAME', 'Set servername for FTP server)',
+              "\tdefault = FTPd - Pure Ruby FTP server") do |t|
+          @servername = t
+        end
+        op.on('--tls [TYPE]', [:off, :explicit, :implicit],
+              'Select TLS support (off, explicit, implicit)',
+              "\tdefault = off") do |t|
+          @tls = t
+        end
+        op.on('--eplf', 'LIST uses EPLF format') do |t|
+          @eplf = t
+        end 
+        op.on('--read-only', 'Prohibit put, delete, rmdir, etc.') do |t|
+          @read_only = t
+        end
+        op.on('--auth [LEVEL]', [:user, :password, :account],
+              'Set authorization level (user, password, account)',
+              "\tdefault = password") do |t|
+          @auth_level = t
+        end
+        op.on('-U', '--user NAME', 'User for authentication',
+              "\tdefaults to current user") do |t|
+          @user = t
+        end
+        op.on('-P', '--password PASS', 'Password for authentication',
+              "\tdefaults to empty string") do |t|
+          @password = t
+        end
+        op.on('-A', '--account P', 'Account for authentication',
+              "\tdefaults to empty string") do |t|
+          @account = t
+        end
+        op.on('--path PATH', 'Directory path for share',
+              "\tdefaults to random temp directory") do |t|
+          @path = t
+        end
+        op.on('--timeout SEC', Integer, 'Session idle timeout',
+              "\tdefaults to #{default_session_timeout}") do |t|
+          @session_timeout = t
+        end
+        op.on('-d', '--debug', 'Write server debug log to stdout') do |t|
+          @debug = t
+        end
+        op.on('--nat-ip IP', 'Set advertised passive mode IP') do |t|
+          @nat_ip = t
+        end
+        op.on('--ports MIN..MAX', 'Port numbers for passive mode sockets') do |v|
+          @passive_ports = Range.new(*v.split(/\.\./).map(&:to_i))
+        end
+        op.on("-h","--help","Show the full help screen.") do
+          puts opts
+          puts "\nExample:"
+          puts "    #{__FILE__} -i 0.0.0.0 -p 21 -U ftp -P ftp --path /tmp/\n\n"
+          exit 0
+        end
+      end
+    end
+
+    def default_session_timeout
+      Ftpd::FtpServer::DEFAULT_SESSION_TIMEOUT
+    end
+
+  end
+end
+
+module FTPDrb
+
+  # The FTP server requires and instance of a _driver_ which can
+  # authenticate users and create a file system drivers for a given
+  # user.
+  
+  class Driver
+
+    # Your driver's initialize method can be anything you need.  Ftpd
+    # does not create an instance of your driver.
+
+    def initialize(user, password, account, data_dir, read_only)
+      @user      = user
+      @password  = password
+      @account   = account
+      @data_dir  = data_dir
+      @read_only = read_only
+    end
+
+    # Return true if the user should be allowed to log in.
+    # @param user [String]
+    # @param password [String]
+    # @param account [String]
+    # @return [Boolean]
+    #
+    # Depending upon the server's auth_level, some of these parameters
+    # may be nil.  A parameter with a nil value is not required for
+    # authentication.  Here are the parameters that are non-nil for
+    # each auth_level:
+    # * :user (user)
+    # * :password (user, password)
+    # * :account (user, password, account)
+
+    def authenticate(user, password, account)
+      user == @user &&
+        (password.nil? || password == @password) &&
+        (account.nil? || account == @account)
+    end
+
+    # Return the file system to use for a user.
+    # @param user [String]
+    # @return A file system driver that quacks like {Ftpd::DiskFileSystem}
+
+    def file_system(user)
+      if @read_only
+        Ftpd::ReadOnlyDiskFileSystem
+      else
+        Ftpd::DiskFileSystem.new(@data_dir)
+      end
+    end
+    
+  end
+end
+
+module FTPDrb
+  class Server
+
+    include Ftpd::InsecureCertificate
+    
+    def initialize(argv)
+      @args = Arguments.new(argv)
+      # Create a temp directory if path argument is not assigned 
+      @args.path.nil? ? @data_dir = Ftpd::TempDir.make : @data_dir = @args.path
+      create_files if @args.path.nil?
+      @driver = Driver.new(user, password, account,
+                           @data_dir, @args.read_only)
+      @server = Ftpd::FtpServer.new(@driver)
+      configure_server
+      @server.start
+    end
+    
+    def run
+      puts "FTP server started. (Press CRL+C to stop it)"
+      connection_info.each do |key, value|
+        puts "#{key}: #{value}"
+      end
+      $stdout.flush
+      begin
+        loop{}
+      rescue Interrupt
+        puts "\nClosing FTP server..."
+      end
+    end
+    
+    private
+    def configure_server
+      @server.server_name   = @args.servername 
+      @server.interface     = @args.interface
+      @server.port          = @args.port
+      @server.tls           = @args.tls
+      @server.passive_ports = @args.passive_ports
+      @server.certfile_path = insecure_certfile_path
+      if @args.eplf
+        @server.list_formatter = Ftpd::ListFormat::Eplf
+      end
+      @server.auth_level      = auth_level
+      @server.session_timeout = @args.session_timeout
+      @server.log             = make_log
+      @server.nat_ip          = @args.nat_ip
+    end
+
+    def auth_level
+      Ftpd.const_get("AUTH_#{@args.auth_level.upcase}")
+    end
+
+    def create_files
+      create_file 'README',
+          "Automatically created by FTPdrb.\n" +
+          "This file, and the directory it is in, will be deleted\n" + 
+          "When ftpd server exits. Make sure your data is backed-up.\n"
+    end
+    
+    def create_file(path, contents)
+      full_path = File.expand_path(path, @data_dir)
+      FileUtils.mkdir_p File.dirname(full_path)
+      File.open(full_path, 'w') do |file|
+        file.write contents
+      end
+    end
+    
+    def connection_info
+      {
+        "Servername"=> @server.server_name,
+        "Interface" => @server.interface,
+        "Port"      => @server.bound_port,
+        "User"      => user,
+        "Pass"      => "#{password if auth_level >= Ftpd::AUTH_PASSWORD}",
+        "Account"   => "#{account  if auth_level >= Ftpd::AUTH_ACCOUNT}",
+        "TLS"       => @args.tls,
+        "Directory" => @data_dir,
+        "URI"       => "ftp://#{user}:#{password}@#{IPAddr.new(@server.interface)}:#{@server.bound_port}",
+        "PID"       => $$
+      }
+    end
+    
+    def user
+      @args.user
+    end
+    
+    def password
+      @args.password
+    end
+    
+    def account
+      @args.account
+    end
+    
+    def make_log
+      @args.debug && Logger.new($stdout)
+    end
+    
+  end
+end
+
+FTPDrb::Server.new(ARGV).run if $0 == __FILE__
+ 

data/ftpd.gemspec

@@ -2,18 +2,19 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ftpd 2.0.0 ruby lib
+# stub: ftpd 2.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ftpd"
-  s.version = "2.0.0"
+  s.version = "2.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Wayne Conrad"]
-  s.date = "2016-06-02"
+  s.date = "2016-11-02"
   s.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."
   s.email = "wconrad@yagni.com"
+  s.executables = ["ftpdrb"]
   s.extra_rdoc_files = [
     "LICENSE.md",
     "README.md"
@@ -28,6 +29,7 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/ftpdrb",
     "doc/benchmarks.md",
     "doc/references.md",
     "doc/rfc-compliance.md",
@@ -244,7 +246,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/wconrad/ftpd"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.8"
+  s.rubygems_version = "2.5.1"
   s.summary = "Pure Ruby FTP server library"
 
   if s.respond_to? :specification_version then
@@ -253,7 +255,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<memoizer>, ["~> 1.0"])
       s.add_development_dependency(%q<cucumber>, ["~> 2.0"])
-      s.add_development_dependency(%q<double-bag-ftps>, ["~> 0.1"])
+      s.add_development_dependency(%q<double-bag-ftps>, [">= 0.1.3", "~> 0.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_development_dependency(%q<rake>, ["~> 11.1"])
       s.add_development_dependency(%q<redcarpet>, ["~> 3.1"])
@@ -264,7 +266,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<memoizer>, ["~> 1.0"])
       s.add_dependency(%q<cucumber>, ["~> 2.0"])
-      s.add_dependency(%q<double-bag-ftps>, ["~> 0.1"])
+      s.add_dependency(%q<double-bag-ftps>, [">= 0.1.3", "~> 0.1"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_dependency(%q<rake>, ["~> 11.1"])
       s.add_dependency(%q<redcarpet>, ["~> 3.1"])
@@ -276,7 +278,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<memoizer>, ["~> 1.0"])
     s.add_dependency(%q<cucumber>, ["~> 2.0"])
-    s.add_dependency(%q<double-bag-ftps>, ["~> 0.1"])
+    s.add_dependency(%q<double-bag-ftps>, [">= 0.1.3", "~> 0.1"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])
     s.add_dependency(%q<rake>, ["~> 11.1"])
     s.add_dependency(%q<redcarpet>, ["~> 3.1"])

data/lib/ftpd/command_loop.rb

@@ -54,7 +54,7 @@ module Ftpd
       s = gets_with_timeout(socket)
       throw :done if s.nil?
       s = s.chomp
-      config.log.debug s
+      config.log.debug s.sub(/^PASS .*/, 'PASS **FILTERED**') # Filter real password
       s
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ftpd
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Wayne Conrad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoizer
@@ -42,6 +42,9 @@ dependencies:
   name: double-bag-ftps
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
@@ -49,6 +52,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
@@ -154,7 +160,8 @@ description: ftpd is a pure Ruby FTP server library.  It supports implicit and e
   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: []
+executables:
+- ftpdrb
 extensions: []
 extra_rdoc_files:
 - LICENSE.md
@@ -169,6 +176,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/ftpdrb
 - doc/benchmarks.md
 - doc/references.md
 - doc/rfc-compliance.md
@@ -402,7 +410,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pure Ruby FTP server library