em-ftpd-memory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 935bb1e47a5d580f87e0b150f866074fdf5ac242
+  data.tar.gz: 976fcbab17763aeddf50197cd3bd36279fa7b7e8
+SHA512:
+  metadata.gz: 8d00f379e4d9b66db5f43aeabc4caa9588cd82ff6ecc93d67eeb06c84c506896b12f736a813652a1da5c741db55978c13aa5b21e158caa60b4b88f4a081ac9be
+  data.tar.gz: 5aac095867e9ed4ae16224ac3e852763d091d6471ed75dc0e73698d635b7c271c3ec2777055a5f21357033de79453e7004fdeee109f9e40aec0a3f2102679afd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in em-ftpd-memory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 chrislee35
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# EM::FTPD::Memory
+
+This is an in-memory fake filesystem for em-ftpd. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'em-ftpd-memory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em-ftpd-memory
+
+## Usage
+
+	require 'eventmachine'
+	require 'em/ftpd/memory'
+	require 'em/ftpd'
+	
+    options = {
+      "filesystem_name" => "boss",
+      "authentication_realm" => "georgia",
+      "pwalgo" => "otp",
+      
+    }
+    auth = EM::FTPD::Memory::Authenticator.getAuthenticatorByRealm(options["authentication_realm"], options)
+    auth << EM::FTPD::Memory::User.new("test", "test1\ntest2\ntest3\ntest4\ntest5")
+    fs = EM::FTPD::Memory::FileSystem.getFileSystemByName(options["filesystem_name"])
+    fs.create_dir("/pub")
+    fs.create_file("/pub/helper.rb", "test/helper.rb")
+    
+    EM.run {
+      EventMachine::start_server("0.0.0.0", 2021, EM::FTPD::Server, EM::FTPD::Memory::Driver, options)
+    }
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/em-ftpd-memory/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'lib'
+	t.test_files = FileList['test/test_*.rb']
+	t.verbose = true
+end
+
+task :default => :test

data/em-ftpd-memory.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "em-ftpd-memory"
+  spec.version       = "0.0.1"
+  spec.authors       = ["chrislee35"]
+  spec.email         = ["rubygems@chrislee.dhs.org"]
+  spec.summary       = %q{Memory-based backing store for em-ftpd}
+  spec.description   = %q{This implements a simple in-memory storage of files for use with em-ftpd}
+  spec.homepage      = "https://github.com/chrislee35/em-ftpd-memory"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "em-ftpd", "~> 0.0.1"
+  spec.add_runtime_dependency "eventmachine", "~> 1.0.7"
+  spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/em/ftpd/memory.rb

@@ -0,0 +1,3 @@
+require 'em/ftpd/memory/authenticator'
+require 'em/ftpd/memory/filesystem'
+require 'em/ftpd/memory/driver'

data/lib/em/ftpd/memory/authenticator.rb

@@ -0,0 +1,82 @@
+require 'em-ftpd'
+require 'digest/md5'
+
+module EM::FTPD::Memory
+  class User < Struct.new(:name, :credential); end
+  class InvalidPasswordAlgorithm < StandardError; end
+  class NoSuchUserError < StandardError; end
+  class InvalidCredentialdError < StandardError; end
+  class ExpiredCredentialError < StandardError; end
+
+  class Authenticator
+    @@realms = Hash.new
+    def self.getAuthenticatorByRealm(realm, options = {})
+      if @@realms[realm].nil?
+        @@realms[realm] = Authenticator.new(options)
+      end
+      #puts "returning Authenticator of realm #{realm}"
+      @@realms[realm]
+    end
+  
+    def initialize(options = {})
+      @users = Hash.new
+      @pwalgo = options["pwalgo"] || "plain"
+    end
+  
+    def <<(user)
+      @users[user.name] = user
+    end
+  
+    def delete(user)
+      @users.delete(user.name)
+    end
+  
+    def authenticate(username, credential)
+      if @users[username].nil?
+        raise NoSuchUserError.new
+      end
+      # this prevents someone from setting "delete" as the authentication algorithm
+      algo = "#{@pwalgo}_authentication".to_sym
+      if self.respond_to?(algo)
+        self.send(algo, username, credential)
+      else
+        raise InvalidPasswordAlgorithmError.new
+      end
+    end
+  
+    def plain_authentication(username, credential)
+      if @users[username].credential != credential
+        raise InvalidCredentialdError.new
+      else
+        return true
+      end
+    end
+  
+    def timed_md5_authentication(username, credential)
+      seed, time, hash = credential.split(/:/, 3)
+      if (time.to_i - Time.now.to_i).abs > 300
+        raise ExpiredCredentialError.new
+      else
+        if Digest::MD5.hexdigest("#{seed}:#{time}:#{@users[username].credential}") == hash
+          return true
+        else
+          raise InvalidCredentialError.new
+        end
+      end
+    end
+    
+    def otp_authentication(username, credential)
+      passwords = @users[username].credential.split(/\n/)
+      if passwords.empty?
+        raise NoFurtherCredentialsAvailable.new
+      end
+      current_password = passwords.shift
+      if credential == current_password
+        @users[username].credential = passwords.join("\n")
+        return true
+      else
+        raise InvalidCredentialError.new        
+      end
+    end
+  end
+end

data/lib/em/ftpd/memory/driver.rb

@@ -0,0 +1,56 @@
+module EM::FTPD::Memory
+  class Driver
+    def initialize(options = {})
+      filesystem_name = options["filesystem_name"] || "default"
+      realm = options["authentication_realm"] || "default"
+      @fs = FileSystem.getFileSystemByName(filesystem_name)
+      @authenticator = Authenticator.getAuthenticatorByRealm(realm, options)
+    end
+    
+    def change_dir(path, &block)
+      yield @fs.is_dir(path)
+    end
+
+    def dir_contents(path, &block)
+      yield @fs.list_files(path)
+    end
+
+    def authenticate(user, pass, &block)
+      begin
+        @authenticator.authenticate(user, pass)
+        yield true
+      rescue Exception => e
+        #puts e.backtrace
+        yield false
+      end
+    end
+
+    def bytes(path, &block)
+      yield @fs.file_size(path)
+    end
+
+    def get_file(path, &block)
+      yield @fs.file_contents(path)
+    end
+
+    def put_file(path, data, &block)
+      yield @fs.create_file(path, data)
+    end
+
+    def delete_file(path, &block)
+      yield @fs.remove_file(path)
+    end
+
+    def delete_dir(path, &block)
+      yield @fs.delete_dir(path)
+    end
+
+    def rename(from, to, &block)
+      yield @fs.rename(from, to)
+    end
+
+    def make_dir(path, &block)
+      yield @fs.create_dir(path)
+    end    
+  end
+end

data/lib/em/ftpd/memory/filesystem.rb

@@ -0,0 +1,138 @@
+module EM::FTPD::Memory
+  class FileSystem
+    @@filesystems = Hash.new
+    def self.getFileSystemByName(name)
+      if @@filesystems[name].nil?
+        @@filesystems[name] = FileSystem.new
+      end
+      #puts "returning FileSystem named #{name}"
+      return @@filesystems[name]
+    end
+    
+    def initialize()
+      @root = {
+        '/' => Array.new
+      }
+      @contents = Hash.new
+    end
+
+    def exist?(path)
+      is_dir(path) || is_file(path)
+    end
+    
+    def list_files(path)
+      @root[path] || []
+    end
+    
+    def file_size(path)
+      f = get_file(path)
+      return false unless f
+      f.size
+    end
+    
+    def file_contents(path)
+      # nil || false => false
+      @contents[path] || false
+    end
+    
+    def get_file(path)
+      dirname = File.dirname(path)
+      basename = File.basename(path)
+      if is_dir(dirname)
+        return @root[dirname].find {|file| file.directory == false && file.name == basename}
+      end
+      nil
+    end
+    
+    def is_file(path)
+      @contents[path] || false
+    end
+    
+    def is_dir(path)
+      @root[path] != nil
+    end
+    
+    def create_file(path, data)
+      dirname = File.dirname(path)
+      basename = File.basename(path)
+      if is_dir(dirname)
+        contents = File.open(data,'r').read
+        f = get_file(path)
+        if f
+          f.size = contents.length
+        else
+          @root[dirname] << EM::FTPD::DirectoryItem.new(:name => basename, :directory => false, :size => contents.length)
+        end
+        @contents[path] = contents
+        return true
+      else
+        return false
+      end
+    end
+    
+    def remove_file(path)
+      if is_file(path)
+        dirname = File.dirname(path)
+        basename = File.basename(path)
+        @root[dirname].reject! {|file| file.directory == false && file.name == basename}
+        @contents.delete(path)
+        return true
+      end
+      false
+    end
+    
+    def delete_dir(path)
+      if is_dir(path) && @root[path].empty?
+        @root.delete(path)
+        dirname = File.dirname(path)
+        basename = File.basename(path)
+        @root[dirname].reject! {|file| file.directory == true && file.name == basename}
+        return true
+      end
+      false
+    end
+    
+    def create_dir(path)
+      if not exist?(path)
+        dirname = File.dirname(path)
+        basename = File.basename(path)
+        if is_dir(dirname)
+          @root[path] = Array.new
+          @root[dirname] << EM::FTPD::DirectoryItem.new(:name => basename, :directory => true, :size => 0)
+          return true
+        end
+      end
+      return false
+    end
+    
+    def rename(from, to)
+      return false if exist?(to)
+      return false unless exist?(from)
+      
+      from_dirname = File.dirname(from)
+      from_basename = File.basename(from)
+      to_dirname = File.dirname(to)
+      to_basename = File.basename(to)
+      
+      if from_dirname == to_dirname
+        @root[from_dirname].find {|file| file.name == from_basename}.name = to_basename
+      else
+        entry = @root[from_dirname].reject! {|file| file.name == from_basename}
+        entry.name = to_basename
+        @root[to_dirname] << entry
+      end
+      
+      if is_dir(from)
+        @root[to] = @root[from]
+        @root.delete(from)
+      else
+        # @contents[to] points to the same reference/pointer as @contents[from]
+        # i.e., this is not a copy, they point to the same object
+        @contents[to] = @contents[from]
+        @contents.delete(from)
+      end
+      return true
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/test'
+require 'minitest/unit'
+include MiniTest::Assertions
+require File.expand_path('../../lib/em/ftpd/memory.rb', __FILE__)

data/test/test_ftpd-memory.rb

@@ -0,0 +1,68 @@
+unless Kernel.respond_to?(:require_relative)
+	module Kernel
+		def require_relative(path)
+			require File.join(File.dirname(caller[0]), path.to_str)
+		end
+	end
+end
+
+require_relative 'helper'
+require 'eventmachine'
+require 'em-ftpd'
+
+class TestFTPDMemory < Minitest::Test
+  def test_example
+    options = {
+      "filesystem_name" => "boss",
+      "authentication_realm" => "georgia",
+      "pwalgo" => "otp",
+      
+    }
+    auth = EM::FTPD::Memory::Authenticator.getAuthenticatorByRealm(options["authentication_realm"], options)
+    auth << EM::FTPD::Memory::User.new("test", "test1\ntest2\ntest3\ntest4\ntest5")
+    fs = EM::FTPD::Memory::FileSystem.getFileSystemByName(options["filesystem_name"])
+    fs.create_dir("/pub")
+    fs.create_file("/pub/helper.rb", "test/helper.rb")
+    
+    EM.run {
+      EventMachine::start_server("0.0.0.0", 2021, EM::FTPD::Server, EM::FTPD::Memory::Driver, options)
+      EM::Timer.new(0.1) do
+        EM.stop
+      end
+    }
+  end
+  
+  def test_plain_login
+  end
+  
+  def test_time_based_login
+  end
+  
+  def test_otp_login
+  end
+  
+  def test_file_creation
+  end
+  
+  def test_file_deletion
+  end
+  
+  def test_create_directory
+  end
+  
+  def test_delete_directory
+  end
+  
+  def test_file_rename
+  end
+  
+  def test_file_move_between_directories
+  end
+  
+  def test_chmod_file
+  end
+  
+  def test_chmod_directory
+  end
+  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: em-ftpd-memory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- chrislee35
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-ftpd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This implements a simple in-memory storage of files for use with em-ftpd
+email:
+- rubygems@chrislee.dhs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- em-ftpd-memory.gemspec
+- lib/em/ftpd/memory.rb
+- lib/em/ftpd/memory/authenticator.rb
+- lib/em/ftpd/memory/driver.rb
+- lib/em/ftpd/memory/filesystem.rb
+- test/helper.rb
+- test/test_ftpd-memory.rb
+homepage: https://github.com/chrislee35/em-ftpd-memory
+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: Memory-based backing store for em-ftpd
+test_files:
+- test/helper.rb
+- test/test_ftpd-memory.rb