clam_chowder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c1bbdb6150fe272295b9d2c3bd648a7c93aa20d
+  data.tar.gz: fdf79465aead5a27612b15aa223f94d182a096e2
+SHA512:
+  metadata.gz: 7d621c58a0e4bd9a41fca632f34f8dd0a976b365826bfa0f5820153b75cb051c7b6317af2756a819a0f9079b2e6bc0c666e227b570efbb5dc7340dd24660aaec
+  data.tar.gz: c16eb0847811416a172010df2441d220cc71df5f4c3e4c3d6b13b41f7485973db173fe218a0787ab35c7ff9513322fa09a61ee8c53487db9c1239da012835d32

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+vendor/

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 NEXWAY Co.,ltd.
+
+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,75 @@
+# README
+
+## Name
+clam_chower
+
+## Description
+Nicely application-level wrapper for anti-virus software.
+now supports on clamd only.
+
+## Installing
+Put this line in your Gemfile:
+```
+gem 'clam_chowder'
+```
+
+then bundle:
+```
+% bundle
+```
+
+## Usage
+```ruby
+response = ClamChowder::Scanner.new.scan_io(file_stream)
+```
+
+### Infected?
+When the file was infected with a virus, that return true and non-it return false.
+
+```ruby
+response.infected?
+# => true
+```
+
+### Virus Name
+```ruby
+response.virus_name
+# => 'Eicar-Test-Signature'
+```
+
+### Status
+When the file was infected with a virus, that return 'OK' and non-it return 'FOUND'.
+
+```ruby
+response.status
+# => 'OK'
+```
+
+### Stub Mode
+clam_chowder prepares a stub mode.  
+in stub mode consider infected a virus with written as virus in file.
+
+#### How to use
+```ruby
+ClamChowder.default_backend = :stub
+```
+
+if you use stub-mode when with the production environment on rails.
+```ruby
+# config/initializers/clam_chowder.rb
+ClamChowder.default_backend = Rails.env.production? ? :clamd : :stub
+```
+
+## Supported versions
+- Ruby 2.0
+- Ruby 2.1
+
+## Dependencies
+- clamd >= 1.0.1
+
+## Tested environments
+- MacOSX Mountain Lion
+- Ubuntu 12.04 LTS
+
+## License
+clam_chowder is available under the [MIT LICENSE](https://github.com/nexway/clam_chowder/blob/develop/LICENSE.txt)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/clam_chowder

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'clam_chowder'

data/clam_chowder.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clam_chowder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clam_chowder"
+  spec.version       = ClamChowder::VERSION
+  spec.authors       = ["NEXWAY", "Iori ONDA"]
+  spec.email         = ["n2developer@nexway.co.jp", "iori.onda@gmail.com"]
+  spec.summary       = %q{Nicely application-level wrapper for anti-virus software.}
+  spec.description   = %q{Nicely application-level wrapper for anti-virus software.}
+  spec.homepage      = ""
+  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.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency "clamd"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/clam_chowder.rb

@@ -0,0 +1,18 @@
+require 'clam_chowder/scanner'
+
+module ClamChowder
+  class ScanException < StandardError; end
+
+  class << self
+    attr_accessor :default_backend
+
+    def infected_stream?(io)
+      response = Scanner.new(default_backend).scan_io(io)
+      response.infected?
+    rescue => e
+      raise ScanException.new(e)
+    end
+  end
+
+  self.default_backend = :clamd
+end

data/lib/clam_chowder/backend.rb

@@ -0,0 +1,21 @@
+require 'clam_chowder/backend/clamd'
+require 'clam_chowder/backend/stub'
+
+module ClamChowder
+  module Backend
+    class << self
+      def add(name, klass)
+        @backends ||= {}
+
+        @backends[name] = klass
+      end
+
+      def lookup(name)
+        @backends[name]
+      end
+    end
+
+    add(:clamd, ::ClamChowder::Backend::Clamd)
+    add(:stub,  ::ClamChowder::Backend::Stub)
+  end
+end

data/lib/clam_chowder/backend/clamd.rb

@@ -0,0 +1,32 @@
+require 'clam_chowder/backend'
+require 'clam_chowder/response'
+
+require 'clamd'
+
+module ClamChowder
+  module Backend
+    class Clamd
+      def initialize
+        @clamd = ::Clamd::Client.new
+      end
+
+      def scan_file(path)
+        parse_response(@clamd.scan(path))
+      end
+
+      private
+
+      def parse_response(str)
+        /^(?<file_path>.*): (?<virus_name>.*)\s?(?<status>(OK|FOUND))$/ =~ str
+        case status
+        when 'OK'
+          ClamChowder::Response.new(status, file_path)
+        when "FOUND"
+          ClamChowder::Response.new(status, file_path, virus_name.strip)
+        else
+          raise ScanException.new(str)
+        end
+      end
+    end
+  end
+end

data/lib/clam_chowder/backend/stub.rb

@@ -0,0 +1,16 @@
+require 'clam_chowder/backend/clamd'
+require 'clam_chowder/response'
+
+module ClamChowder
+  module Backend
+    class Stub
+      def scan_file(path)
+        if File.open(path, encoding: 'BINARY') {|f| f.each_line.grep(/virus/).empty? }
+          ClamChowder::Response.new('OK', path)
+        else
+          ClamChowder::Response.new('FOUND', path, 'stub-virus')
+        end
+      end
+    end
+  end
+end

data/lib/clam_chowder/response.rb

@@ -0,0 +1,15 @@
+module ClamChowder
+  class Response
+    attr_reader :virus_name, :file_path
+
+    def initialize(status, file_path, virus_name = nil)
+      @status     = status
+      @file_path  = file_path
+      @virus_name = virus_name
+    end
+
+    def infected?
+      @status == 'FOUND'
+    end
+  end
+end

data/lib/clam_chowder/scanner.rb

@@ -0,0 +1,33 @@
+require 'tempfile'
+require 'clam_chowder'
+require 'clam_chowder/backend'
+require 'clam_chowder/response'
+
+module ClamChowder
+  class Scanner
+    def self.infected_stream?(io)
+      ::ClamChowder.infected_stream?(io) # XXX compatibility
+    end
+
+    def initialize(backend = ClamChowder.default_backend)
+      @backend ||= ClamChowder::Backend.lookup(backend).new
+    end
+
+    def scan_io(readable)
+      begin
+        Tempfile.open('clam_chowder_temp', encoding: 'BINARY') do |file|
+          while bytes = readable.read(1024 * 32)
+            file.write(bytes.strip)
+          end
+          file.rewind
+          file.chmod(0644)
+          @backend.scan_file(file.path)
+        end
+      rescue => e
+        raise ScanException.new(e)
+      end
+    ensure
+      readable.rewind if readable.respond_to?(:rewind)
+    end
+  end
+end

data/lib/clam_chowder/version.rb

@@ -0,0 +1,3 @@
+module ClamChowder
+  VERSION = "0.0.1"
+end

data/spec/clam_chowder_spec.rb

@@ -0,0 +1,117 @@
+require './lib/clam_chowder.rb'
+require 'tempfile'
+
+def create_virus_file
+  Tempfile.open('eicar.com', encoding: 'BINARY').tap do |file|
+    # [note] - EICAR Test Virus
+    # http://www.eicar.org/86-0-Intended-use.html
+    file.write('X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*')
+    file.rewind
+  end
+end
+
+describe 'Scanner' do
+  describe '.infected_stream?' do
+    subject { ClamChowder::Scanner.infected_stream?(File::open(file_path)) }
+
+    context 'ウイルスが未検知の場合' do
+      let(:file_path) { 'spec/fixtures/innocent.txt' }
+
+      it { should be_false }
+    end
+
+    context 'ウイルスが検知された場合' do
+      let(:file)      { create_virus_file }
+      let(:file_path) { file.path }
+
+      after { file.close }
+
+      it { should be_true }
+    end
+
+    context '検知/未検知以外の場合' do
+      let(:file_path) { 'path/to/file' }
+
+      specify 'ScanException 例外が発生すること' do
+        expect { ClamChowder::Scanner.infected_stream?(file_path) }.to raise_error(ClamChowder::ScanException)
+      end
+    end
+  end
+
+  describe '#scan_io' do
+    context 'Backend が clamd の場合' do
+      before { ClamChowder.default_backend = :clamd }
+
+      let(:scanner)     { ClamChowder::Scanner.new }
+      let(:scan_result) { scanner.scan_io File::open(file_path) }
+
+      context 'ウィルス未検知の場合' do
+        let(:file_path) { 'spec/fixtures/innocent.txt' }
+
+        specify do
+          expect(scan_result).to_not be_infected
+        end
+      end
+
+      context 'ウィルス検知の場合' do
+        let(:file)      { create_virus_file }
+        let(:file_path) { file.path }
+
+        after { file.close }
+
+        specify do
+          expect(scan_result).to be_infected
+          expect(scan_result.virus_name).to eq 'Eicar-Test-Signature'
+        end
+      end
+
+      context '検知/未検知以外の場合' do
+        let(:file_path) { "/path/to/file" }
+
+        specify "例外が発生すること" do
+          expect { ClamChowder::Scanner.new.scan_io(file_path) }.to raise_error(ClamChowder::ScanException)
+        end
+      end
+    end
+
+    context 'Backend が stub の場合' do
+      before { ClamChowder.default_backend = :stub }
+
+      let(:scanner)     { ClamChowder::Scanner.new }
+      let(:scan_result) { scanner.scan_io File::open(file_path) }
+
+      context 'ウィルス未検知の場合' do
+        let(:file_path) { 'spec/fixtures/innocent.txt' }
+
+        specify do
+          expect(scan_result).to_not be_infected
+        end
+      end
+
+      context 'ウィルス検知の場合' do
+        let(:file) do
+          Tempfile.open('stub_virus.txt', encoding: 'BINARY').tap do |file|
+            file.write('virus')
+            file.rewind
+          end
+        end
+        let(:file_path) { file.path }
+
+        after { file.close }
+
+        specify do
+          expect(scan_result).to be_infected
+          expect(scan_result.virus_name).to eq 'stub-virus'
+        end
+      end
+
+      context '検知/未検知以外の場合' do
+        let(:file_path) { "/path/to/file" }
+
+        specify "例外が発生すること" do
+          expect { ClamChowder::Scanner.new.scan_io(file_path) }.to raise_error(ClamChowder::ScanException)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: clam_chowder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- NEXWAY
+- Iori ONDA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Nicely application-level wrapper for anti-virus software.
+email:
+- n2developer@nexway.co.jp
+- iori.onda@gmail.com
+executables:
+- clam_chowder
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/clam_chowder
+- clam_chowder.gemspec
+- lib/clam_chowder.rb
+- lib/clam_chowder/backend.rb
+- lib/clam_chowder/backend/clamd.rb
+- lib/clam_chowder/backend/stub.rb
+- lib/clam_chowder/response.rb
+- lib/clam_chowder/scanner.rb
+- lib/clam_chowder/version.rb
+- spec/clam_chowder_spec.rb
+- spec/fixtures/innocent.txt
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.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: Nicely application-level wrapper for anti-virus software.
+test_files:
+- spec/clam_chowder_spec.rb
+- spec/fixtures/innocent.txt