clamd 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1 @@
+source 'https://rubygems.org'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 soundarapandian rathinasamy
+
+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,89 @@
+# Clamd
+
+Ruby gem to speak with Clamd daemon
+
+NOTE: Still under development
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clamd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clamd
+
+## Configuration
+
+Refer the below code to configure the Clamd gem
+    
+    Clamd.configure do |config|
+      config.host = "localhost" #mandatory
+      config.port = 9321 #mandatory
+      config.open_timeout = 5 #optional
+      config.read_timeout = 20 #optional
+      config.chunk_size = 10240 #optional
+    end  
+
+## Usage
+
+To check ClamAV version
+
+    Clamd.version
+
+Response will be like below
+
+    =>"ClamAV 0.97.5/15468/Wed Oct 17 01:13:58 2012\n"
+
+To check Clamd is alive or not.
+
+    Clamd.ping
+
+Response from Clamd daemon will be "PONG" if it is alive
+
+    =>"PONG"
+
+To reload Clamd virus signature database
+
+    Clamd.reload
+
+Response from Clamd daemon will be "RELOADING"
+
+    =>"RELOADING"
+
+To shutdown Clamd daemon
+
+    Clamd.shutdown
+
+Response will be blank if shutdown success
+
+    =>""
+
+To scan a file
+
+    Clamd.scan("/file/path")
+    =>"/file/path: OK"
+
+To use CONTSCAN facility of Clamd
+
+    Clamd.contscan("/file/path")
+    =>"/file/path: OK"
+
+To use MULTISCAN facility of Clamd
+
+    Clamd.multiscan("/file/path")
+    =>"/file/path: OK"
+
+To use INSTREAM facility of Clamd
+
+    Clamd.instream("/file/path/to/stream/to/clamd")
+    =>"stream: OK"
+    
+To know Clamd scan queue status
+
+    Clamd.stats

data/Rakefile

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

data/clamd.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clamd/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "clamd"
+  gem.version       = Clamd::VERSION
+  gem.authors       = ["soundarapandian rathinasamy"]
+  gem.email         = ["soundar.rathinasamy@gmail.com"]
+  gem.description   = %q{Ruby gem to interact with ClamAV daemon(Clamd)}
+  gem.summary       = %q{Clamd gem enables you to feed the simple VERSION command to 
+                         complex INSTREAM command to ClamAV antivirus daemon(Clamd)}
+  gem.homepage      = "https://github.com/soundarapandian/clamd"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/clamd.rb

@@ -0,0 +1,7 @@
+require "clamd/command"
+require "clamd/configuration"
+require "clamd/version"
+
+module Clamd
+  extend Command
+end

data/lib/clamd/command.rb

@@ -0,0 +1,100 @@
+require 'timeout'
+require 'clamd/socket_utility'
+require 'clamd/instream_helper'
+
+module Clamd
+  module Command
+    COMMAND = {
+      :ping => "PING",
+      :version => "VERSION",
+      :reload => "RELOAD",
+      :shutdown => "SHUTDOWN",
+      :scan => "SCAN",
+      :contscan => "CONTSCAN",
+      :multiscan => "MULTISCAN",
+      :instream => "zINSTREAM\0",
+      :stats => "zSTATS\0" }.freeze
+
+    include SocketUtility
+    include InstreamHelper
+
+    def exec(command, path=nil)
+      begin
+        return "ERROR: Please configure Clamd first" unless Clamd.configured?
+        socket = Timeout::timeout(Clamd.configuration.open_timeout) { open_socket }
+        write_socket(socket, command, path)
+        Timeout::timeout(Clamd.configuration.read_timeout) { read_socket(socket, command) }
+      rescue Errno::ECONNREFUSED
+        "ERROR: Failed to connect to Clamd daemon"
+      rescue Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE
+        "ERROR: Connection with Clamd daemon closed unexpectedly"
+      rescue Timeout::Error
+        "ERROR: Timeout error occurred"
+      ensure
+        close_socket(socket) if socket
+      end
+    end
+    
+    def read_socket(socket, command)
+      socket.recv(clamd_response_size(command)).gsub(/(\u0000)|(\n)/, "")
+    end
+
+    def write_socket(socket, command, path)
+      if path && command != COMMAND[:instream]
+        socket.write("#{command} #{path}")
+      else
+        socket.write(command)
+      end
+      stream_to_clamd(socket, path) if command == COMMAND[:instream]
+    end
+
+    def clamd_response_size(command)
+      case command
+      when COMMAND[:ping]
+        4
+      when COMMAND[:reload]
+        9
+      when COMMAND[:shutdown]
+        1
+      else
+        1024
+      end
+    end
+
+    def ping
+      exec(COMMAND[:ping])
+    end
+
+    def version
+      exec(COMMAND[:version])
+    end
+
+    def reload
+      exec(COMMAND[:reload])
+    end
+
+    def shutdown
+      exec(COMMAND[:shutdown])
+    end
+
+    def scan(path)
+      exec(COMMAND[:scan], path)
+    end
+
+    def contscan(path)
+      exec(COMMAND[:contscan], path)
+    end
+
+    def multiscan(path)
+      exec(COMMAND[:multiscan], path)
+    end
+
+    def instream(path)
+      exec(COMMAND[:instream], path)
+    end
+
+    def stats
+      exec(COMMAND[:stats])
+    end
+  end
+end

data/lib/clamd/configuration.rb

@@ -0,0 +1,35 @@
+module Clamd
+  class Configuration
+    attr_accessor :host, :port, :open_timeout, :read_timeout, :chunk_size
+    DEFAULT_CONFIGURATION = { :open_timeout => 5, :read_timeout => 30, :chunk_size => 10240 } 
+
+    def initialize
+      @open_timeout = DEFAULT_CONFIGURATION[:open_timeout] 
+      @read_timeout = DEFAULT_CONFIGURATION[:read_timeout]
+      @chunk_size = DEFAULT_CONFIGURATION[:chunk_size]
+    end
+  end
+
+  def self.configure
+    @configuration ||= Configuration.new
+    yield(@configuration) if block_given?
+    missing = []
+    missing << "host" unless @configuration.host
+    missing << "port" unless @configuration.port
+    raise ConfigurationError,
+      "Missing configuration: #{missing.join(",")}" unless missing.empty?
+    @configuration
+  end
+
+  def self.configuration
+    return unless @configuration
+    @configuration
+  end
+
+  def self.configured?
+    return true if configuration
+    false
+  end
+  
+  class ConfigurationError < StandardError;end
+end

data/lib/clamd/instream_helper.rb

@@ -0,0 +1,26 @@
+module Clamd
+  module InstreamHelper
+    def stream_to_clamd(socket, path)
+      begin
+        file = File.open(path, "rb")
+        read = file.read(Clamd.configuration.chunk_size)
+        while read
+          write_chunk(socket, read)
+          read = file.read(10240)
+        end
+        stop_streaming(socket)
+      ensure
+        file.close if file
+      end
+    end
+
+    def write_chunk(socket, chunk)
+      socket.write([chunk.size].pack("N"))
+      socket.write(chunk)
+    end
+
+    def stop_streaming(socket)
+      socket.write([0].pack("N"))
+    end
+  end
+end

data/lib/clamd/socket_utility.rb

@@ -0,0 +1,13 @@
+require 'socket'
+
+module Clamd
+  module SocketUtility
+    def open_socket
+      TCPSocket.open(Clamd.configuration.host, Clamd.configuration.port)
+    end
+
+    def close_socket(socket)
+      socket.close
+    end
+  end
+end

data/lib/clamd/version.rb

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: clamd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- soundarapandian rathinasamy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-16 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem to interact with ClamAV daemon(Clamd)
+email:
+- soundar.rathinasamy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clamd.gemspec
+- lib/clamd.rb
+- lib/clamd/command.rb
+- lib/clamd/configuration.rb
+- lib/clamd/instream_helper.rb
+- lib/clamd/socket_utility.rb
+- lib/clamd/version.rb
+homepage: https://github.com/soundarapandian/clamd
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Clamd gem enables you to feed the simple VERSION command to  complex INSTREAM
+  command to ClamAV antivirus daemon(Clamd)
+test_files: []