clamav-client 1.0.0

data/README.md

@@ -0,0 +1,120 @@
+# ClamAV::Client
+
+ClamAV::Client is a client library that can talk to the clam daemon.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clamav-client', require: 'clamav/client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clamav-client
+
+Alternatively, you can spawn a `pry` console right away by just running:
+
+    $ rake console
+
+## Requirements
+
+* Ruby >= 2 (and Ruby >= 2.1 to be able to contribute to the project as it's making use of required keyword arguments)
+* clamd
+
+## Usage
+
+The `ClamAV::Client` class is responsible for opening a connection to a remote
+ClamAV clam daemon.
+
+You will find below the implemented commands.
+
+### PING => Boolean
+
+Pings the daemon to check whether it is alive.
+
+    client = ClamAV::Client.new
+    client.execute(ClamAV::Commands::PingCommand.new)
+    => true
+
+### SCAN <file_or_directory> => Array[Response]
+
+Scans a file or a directory for the existence of a virus.
+
+The absolute path must be given to that command.
+
+    client = ClamAV::Client.new
+
+    client.execute(ClamAV::Commands::ScanCommand.new('/tmp/path/foo.c')
+    => [#<ClamAV::SuccessResponse:0x007fbf314b9478 @file="/tmp/foo.c">]
+
+    client.execute(ClamAV::Commands::ScanCommand.new('/tmp/path')
+    => [#<ClamAV::SuccessResponse:0x007fc30c273298 @file="/tmp/path/foo.c">,
+     #<ClamAV::SuccessResponse:0x007fc30c272910 @file="/tmp/path/foo.cpp">]
+
+
+### Custom commands
+
+Custom commands can be given to the client. The contract between the client
+and the command is thru the `call` method call. The `call` method is being
+passed a `Connection` object.
+
+Here's a simple example that implements the `VERSION` command:
+
+    # Build the client
+    client = ClamAV::Client.new
+
+    # Create the command lambda
+    version_command = lambda { |conn| conn.send_request("VERSION") }
+    => #<Proc:0x007fc0d0c14b28>
+
+    # Execute the command
+    client.execute(version_command)
+    => "1: ClamAV 0.98.1/18489/Tue Feb 18 16:00:05 2014"
+
+
+## Defaults
+
+The default values in use are:
+
+  * clamd socket: UNIX Socket, located at `/tmp/clamd/socket`;
+  * New-line terminated commands.
+
+These defaults can be changed by injecting new defaults.
+
+## Injecting dependencies
+
+### Client
+
+The main object is the `Client` object. It is responsible for executing the commands.
+This object can receive a custom connection object.
+
+### Connection
+
+The connection object is the bridge between the raw socket object and the
+protocol being used between the client and the daemon.
+
+`clamd` supports two kinds of delimiters:
+
+  * NULL terminated commands
+  * New-line terminated commands
+
+The management of those delimiters is done with the wrapper argument.
+
+### Wrapper
+
+The wrapper is responsible for taking the incoming request with the
+`wrap_request` method, and parsing the response with the `read_response`
+method.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/franckverrot/clamav-client/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 new Pull Request

data/Rakefile

@@ -0,0 +1,104 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+require 'rubygems/specification'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+$:<< 'lib'
+require 'clamav/client'
+
+$stdout.puts """
+ClamAV::Client Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+This program comes with ABSOLUTELY NO WARRANTY; for details type `rake license'.
+This is free software, and you are welcome to redistribute it
+under certain conditions; type `rake license' for details.
+
+"""
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  #t.verbose = true
+  #t.warning = true
+end
+
+Rake::TestTask.new(:unit_tests) do |t|
+  t.libs << "test"
+  t.pattern = "test/unit/**/*_test.rb"
+  #t.verbose = true
+  #t.warning = true
+end
+
+Rake::TestTask.new(:integration_tests) do |t|
+  t.libs << "test"
+  t.pattern = "test/integration/**/*_test.rb"
+  #t.verbose = true
+  #t.warning = true
+end
+
+
+def gemspec
+  @gemspec ||= begin
+                 file = File.expand_path('../clamav-client.gemspec', __FILE__)
+                 eval(File.read(file), binding, file)
+               end
+end
+
+desc "Clean the current directory"
+task :clean do
+  rm_rf 'tmp'
+  rm_rf 'pkg'
+end
+
+desc "Run the full spec suite"
+task :full => ["clean", "test"]
+
+desc "install the gem locally"
+task :install => :package do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build the gem"
+task :gem => [:gemspec, :build] do
+  mkdir_p "pkg"
+  sh "gem build clamav-client.gemspec"
+  mv "#{gemspec.full_name}.gem", "pkg"
+end
+
+desc "Install ClamAV::Client"
+task :install => :gem do
+  sh "gem install pkg/#{gemspec.full_name}.gem"
+end
+
+task :default => :full
+
+task :license do
+  `open http://www.gnu.org/licenses/gpl.txt`
+end
+
+task :console do
+  require 'pry'
+  Pry.start
+end

data/clamav-client.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+$:<< 'lib'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clamav-client"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Franck Verrot"]
+  spec.email         = ["franck@verrot.fr"]
+  spec.summary       = %q{ClamAV::Client connects to a Clam Anti-Virus clam daemon and send commands.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/franckverrot/clamav-client"
+  spec.license       = "GPLv3"
+
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

data/lib/clamav/client.rb

@@ -0,0 +1,43 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "clamav/connection"
+require "clamav/commands/ping_command"
+require "clamav/commands/quit_command"
+require "clamav/commands/scan_command"
+require "clamav/util"
+require "clamav/wrappers/new_line_wrapper"
+require "clamav/wrappers/null_termination_wrapper"
+
+module ClamAV
+  class Client
+    def initialize(connection = default_connection)
+      @connection = connection
+      connection.establish_connection
+    end
+
+    def execute(command)
+      command.(@connection)
+    end
+
+    def default_connection
+      ClamAV::Connection.new(
+        socket: ::UNIXSocket.new('/tmp/clamd.socket'),
+        wrapper: ::ClamAV::Wrappers::NewLineWrapper.new
+      )
+    end
+  end
+end

data/lib/clamav/commands/command.rb

@@ -0,0 +1,32 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+module ClamAV
+  module Commands
+    class Command
+      def call
+        raise NotImplementedError.new
+      end
+
+      protected
+      def execute
+        conn.puts data + "\n"
+        response = conn.gets.chomp
+        conn.close
+        response
+      end
+    end
+  end
+end

data/lib/clamav/commands/ping_command.rb

@@ -0,0 +1,26 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require 'clamav/commands/command'
+
+module ClamAV
+  module Commands
+    class PingCommand < Command
+      def call(conn)
+        !!(/\d+: PONG/.match(conn.send_request("PING")))
+      end
+    end
+  end
+end

data/lib/clamav/commands/quit_command.rb

@@ -0,0 +1,26 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require 'clamav/commands/command'
+
+module ClamAV
+  module Commands
+    class QuitCommand < Command
+      def call(conn)
+        conn.send_request("QUIT").nil?
+      end
+    end
+  end
+end

data/lib/clamav/commands/scan_command.rb

@@ -0,0 +1,54 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'clamav/commands/command'
+require 'clamav/responses/error_response'
+require 'clamav/responses/success_response'
+require 'clamav/responses/virus_response'
+module ClamAV
+  module Commands
+    class ScanCommand < Command
+      Statuses = {
+        'ERROR' => ClamAV::ErrorResponse,
+        'OK' => ClamAV::SuccessResponse,
+        'ClamAV-Test-Signature FOUND' => ClamAV::VirusResponse
+      }
+
+      def initialize(path, path_finder = Util)
+        @path, @path_finder = path, path_finder
+      end
+
+      def call(conn)
+        @path_finder.path_to_files(@path).map { |file| scan_file(conn, file) }
+      end
+
+      protected
+      def scan_file(conn, file)
+        get_status_from_response(conn.send_request("SCAN #{file}"))
+      end
+
+      def get_status_from_response(str)
+        case str
+        when 'Error processing command. ERROR'
+          ErrorResponse.new(str)
+        else
+          /(?<id>\d+): (?<filepath>.*): (?<status>.*)/ =~ str
+          Statuses[status].new(filepath)
+        end
+      end
+    end
+  end
+end

data/lib/clamav/connection.rb

@@ -0,0 +1,37 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'socket'
+
+module ClamAV
+  class Connection
+    def initialize(socket:, wrapper:)
+      @socket = socket
+      @wrapper = wrapper
+    end
+
+    def establish_connection
+      wrapped_request = @wrapper.wrap_request("IDSESSION")
+      @socket.write wrapped_request
+    end
+
+    def send_request(str)
+      wrapped_request = @wrapper.wrap_request(str)
+      @socket.write wrapped_request
+      @wrapper.read_response(@socket)
+    end
+  end
+end