clamav-client 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adce3820c1acb8ee407dfe43d13cc0fbff8871ca
-  data.tar.gz: ba5be7eb98e86a26030a7da773f46c6abeb096a6
+  metadata.gz: 0e16bf843318d1ae3aec44e522c278143affc3d2
+  data.tar.gz: 100e606c288e5a6a3a46a0537e4d4f6f0d989b9c
 SHA512:
-  metadata.gz: 9249db0df3fde3b800dfb47dae0aae73884f7d6db27a764bee4df9bb30dba67fba1cfe94098b863eafd999c78a1652c7a04f3b4f3b9ff40d58dc5f3475c96bb4
-  data.tar.gz: fdde76cc4230eb0577f1637c9d5d1e72ff0a3e41bbcbc3f8e1e9d7939018f2ba90fe45f71252e8425419cd02a2fef2ff3dc8794bdea4addc71b6ba92bcbb6a6e
+  metadata.gz: 06d3e9d069ff7875b6f499c78adfbdaae9a29a030fd38f68435393e322cfa3c407c0d53a72d4067550cfa0b09c3da73858c4d944b8ce46f31c95ccb4d3484a0e
+  data.tar.gz: 141d5420ccd5fc6a90332b77184b5c1c593d2b27ce297a2b498677cc7b176a87aa3dffdd86f13173492912f47ed2906faba88daa17280407fbffb092d11df4a4

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx
+script: rake unit_tests

data/README.md

@@ -22,7 +22,7 @@ Alternatively, you can spawn a `pry` console right away by just running:
 
 ## Requirements
 
-* Ruby >= 2 (and Ruby >= 2.1 to be able to contribute to the project as it's making use of required keyword arguments)
+* Ruby >= 1.9.2
 * clamd
 
 ## Usage
@@ -30,15 +30,17 @@ Alternatively, you can spawn a `pry` console right away by just running:
 The `ClamAV::Client` class is responsible for opening a connection to a remote
 ClamAV clam daemon.
 
-You will find below the implemented commands.
+See the implemented commands below.
 
 ### PING => Boolean
 
 Pings the daemon to check whether it is alive.
 
-    client = ClamAV::Client.new
-    client.execute(ClamAV::Commands::PingCommand.new)
-    => true
+```ruby
+client = ClamAV::Client.new
+client.execute(ClamAV::Commands::PingCommand.new)
+# => true
+```
 
 ### SCAN <file_or_directory> => Array[Response]
 
@@ -46,56 +48,73 @@ 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
+```ruby
+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/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">]
+client.execute(ClamAV::Commands::ScanCommand.new('/tmp/path'))
+# => [#<ClamAV::SuccessResponse:0x007fc30c273298 @file="/tmp/path/foo.c">,
+#     #<ClamAV::SuccessResponse:0x007fc30c272910 @file="/tmp/path/foo.cpp">]
+```
 
+### INSTREAM => Response
+
+Scans an IO-like object for the existence of a virus.
+
+```ruby
+client = ClamAV::Client.new
+
+io = StringIO.new('some data')
+client.execute(ClamAV::Commands::InstreamCommand.new(io))
+# => [#<ClamAV::SuccessResponse:0x007fe471cabe50 @file="stream">]
+```
 
 ### 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:
+and the command is through the `Command#call` method. The `call` method will
+receive a `Connection` object.
 
-    # Build the client
-    client = ClamAV::Client.new
+Here's a simple example implementing the `VERSION` command:
 
-    # Create the command lambda
-    version_command = lambda { |conn| conn.send_request("VERSION") }
-    => #<Proc:0x007fc0d0c14b28>
+```ruby
+# Build the client
+client = ClamAV::Client.new
 
-    # Execute the command
-    client.execute(version_command)
-    => "1: ClamAV 0.98.1/18489/Tue Feb 18 16:00:05 2014"
+# 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`;
+  * clamd socket: UNIX Socket, located at `/var/run/clamav/clamd.ctl`;
   * New-line terminated commands.
 
-These defaults can be changed by injecting new defaults.
+These defaults can be changed:
 
-## Injecting dependencies
+  * by creating the object graph manually;
+  * by setting environment variables.
 
-### Client
+### The object graph
+
+#### Client
 
 The main object is the `Client` object. It is responsible for executing the commands.
-This object can receive a custom connection object.
+It can receive a custom connection object.
 
-### Connection
+#### Connection
 
-The connection object is the bridge between the raw socket object and the
-protocol being used between the client and the daemon.
+The `Connection` object is the bridge between the raw socket object and the
+protocol used between the client and the daemon.
 
 `clamd` supports two kinds of delimiters:
 
@@ -104,12 +123,43 @@ protocol being used between the client and the daemon.
 
 The management of those delimiters is done with the wrapper argument.
 
-### Wrapper
+#### Wrapper
 
 The wrapper is responsible for taking the incoming request with the
 `wrap_request` method, and parsing the response with the `read_response`
 method.
 
+### Environment variables
+
+The variables can be set programmatically in your Ruby programs like
+
+```ruby
+# from a ruby script
+ENV['CLAMD_UNIX_SOCKET'] = '/some/path'
+
+# Now the defaults are changed for any new ClamAV::Client instantiation
+```
+
+or by setting the variables before starting the Ruby process:
+
+```
+# from the command-line
+export CLAMD_UNIX_SOCKET = '/some/path'
+ruby my_program.rb
+# or
+CLAMD_UNIX_SOCKET = '/some/path' ruby my_program.rb
+```
+
+Please note that setting the `CLAMD_TCP_*` variables will have the precedence
+over the `CLAMD_UNIX_SOCKET`.
+
+#### CLAMD_UNIX_SOCKET
+
+Sets the socket path of the ClamAV daemon.
+
+#### CLAMD_TCP_HOST and CLAMD_TCP_PORT
+
+Sets the host and port of the ClamAV daemon.
 
 ## Contributing
 

data/clamav-client.gemspec

@@ -3,7 +3,7 @@ $:<< 'lib'
 
 Gem::Specification.new do |spec|
   spec.name          = "clamav-client"
-  spec.version       = "1.0.0"
+  spec.version       = "2.0.1"
   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.}
@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest"
 end

data/lib/clamav/client.rb

@@ -18,6 +18,7 @@ require "clamav/connection"
 require "clamav/commands/ping_command"
 require "clamav/commands/quit_command"
 require "clamav/commands/scan_command"
+require "clamav/commands/instream_command"
 require "clamav/util"
 require "clamav/wrappers/new_line_wrapper"
 require "clamav/wrappers/null_termination_wrapper"
@@ -30,14 +31,23 @@ module ClamAV
     end
 
     def execute(command)
-      command.(@connection)
+      command.call(@connection)
     end
 
     def default_connection
       ClamAV::Connection.new(
-        socket: ::UNIXSocket.new('/tmp/clamd.socket'),
+        socket: resolve_default_socket,
         wrapper: ::ClamAV::Wrappers::NewLineWrapper.new
       )
     end
+
+    def resolve_default_socket
+      unix_socket, tcp_host, tcp_port = ENV.values_at('CLAMD_UNIX_SOCKET', 'CLAMD_TCP_HOST', 'CLAMD_TCP_PORT')
+      if tcp_host && tcp_port
+        ::TCPSocket.new(tcp_host, tcp_port)
+      else
+        ::UNIXSocket.new(unix_socket || '/var/run/clamav/clamd.ctl')
+      end
+    end
   end
 end

data/lib/clamav/commands/command.rb

@@ -13,20 +13,34 @@
 
 # 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/responses/error_response'
+require 'clamav/responses/success_response'
+require 'clamav/responses/virus_response'
+
 module ClamAV
   module Commands
     class Command
-      def call
-        raise NotImplementedError.new
-      end
+      Statuses = {
+        'OK'                          => ClamAV::SuccessResponse,
+        'ERROR'                       => ClamAV::ErrorResponse,
+        'ClamAV-Test-Signature FOUND' => ClamAV::VirusResponse
+      }
+
+      def call; raise NotImplementedError.new; end
 
       protected
-      def execute
-        conn.puts data + "\n"
-        response = conn.gets.chomp
-        conn.close
-        response
-      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/commands/instream_command.rb

@@ -0,0 +1,41 @@
+# 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 InstreamCommand < Command
+
+      def initialize(io, max_chunk_size = 1024)
+        @io = begin io rescue raise ArgumentError, 'io is required', caller; end
+        @max_chunk_size = max_chunk_size
+      end
+
+      def call(conn)
+        conn.write_request("INSTREAM")
+
+        while(packet = @io.read(@max_chunk_size))
+          packet_size = [packet.size].pack("N")
+          conn.raw_write("#{packet_size}#{packet}")
+        end
+        conn.raw_write("\x00\x00\x00\x00")
+        get_status_from_response(conn.read_response)
+      end
+
+    end
+  end
+end

data/lib/clamav/commands/scan_command.rb

@@ -15,17 +15,10 @@
 # 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
@@ -35,20 +28,10 @@ module ClamAV
         @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

@@ -18,9 +18,16 @@ require 'socket'
 
 module ClamAV
   class Connection
-    def initialize(socket:, wrapper:)
-      @socket = socket
-      @wrapper = wrapper
+    def initialize(args)
+      socket  = args.fetch(:socket)  { missing_required_argument(:socket) }
+      wrapper = args.fetch(:wrapper) { missing_required_argument(:wrapper) }
+
+      if socket && wrapper
+        @socket = socket
+        @wrapper = wrapper
+      else
+        raise ArgumentError
+      end
     end
 
     def establish_connection
@@ -28,10 +35,27 @@ module ClamAV
       @socket.write wrapped_request
     end
 
-    def send_request(str)
+    def write_request(str)
       wrapped_request = @wrapper.wrap_request(str)
       @socket.write wrapped_request
+    end
+
+    def read_response
       @wrapper.read_response(@socket)
     end
+
+    def send_request(str)
+      write_request(str)
+      read_response
+    end
+
+    def raw_write(str)
+      @socket.write str
+    end
+
+    private
+    def missing_required_argument(key)
+      raise ArgumentError, "#{key} is required"
+    end
   end
 end

data/lib/clamav/responses.rb

@@ -21,10 +21,12 @@ module ClamAV
     end
 
     def ==(other)
-      @file == other.file
+      @file == other.file && self.class == other.class
     end
 
     protected
+
       attr_reader :file
+
   end
 end

data/lib/clamav/responses/error_response.rb

@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'clamav/responses'
+
 module ClamAV
   class ErrorResponse < Response
   end

data/lib/clamav/responses/success_response.rb

@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'clamav/responses'
+
 module ClamAV
   class SuccessResponse < Response
   end

data/lib/clamav/responses/virus_response.rb

@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'clamav/responses'
+
 module ClamAV
   class VirusResponse < Response
   end

data/lib/clamav/wrapper.rb

@@ -18,5 +18,14 @@ module ClamAV
   class Wrapper
     def wrap_request(request);     raise NotImplementedError; end
     def unwrap_response(response); raise NotImplementedError; end
+
+    protected
+      def read_until(socket, delimiter)
+        buff = ""
+        while (char = socket.getc) != delimiter
+          buff << char
+        end
+        buff
+      end
   end
 end

data/lib/clamav/wrappers/new_line_wrapper.rb

@@ -24,11 +24,7 @@ module ClamAV
       end
 
       def read_response(socket)
-        buff = ""
-        while (char = socket.getc) != "\n"
-          buff << char
-        end
-        buff
+        read_until(socket, "\n")
       end
     end
   end

data/lib/clamav/wrappers/null_termination_wrapper.rb

@@ -24,11 +24,7 @@ module ClamAV
       end
 
       def read_response(socket)
-        buff = ""
-        while (char = socket.getc) != "\0"
-          buff << char
-        end
-        buff
+        read_until(socket, "\0")
       end
     end
   end

data/test/integration/clamav/client_test.rb

@@ -53,5 +53,20 @@ describe "ClamAV::Client Integration Tests" do
         assert_equal expected_results, results
       end
     end
+
+    describe "instream" do
+      it "can be started" do
+        dir = File.expand_path('../../../../test/fixtures', __FILE__)
+
+        [
+          ['clamavtest.txt', ClamAV::VirusResponse],
+          ['innocent.txt',   ClamAV::SuccessResponse]
+        ].each do |file, response_class|
+          io      = File.open(File.join(dir, file))
+          command = ClamAV::Commands::InstreamCommand.new(io)
+          client.execute(command).must_equal response_class.new("stream")
+        end
+      end
+    end
   end
 end

data/test/test_helper.rb

@@ -14,6 +14,8 @@
 # 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 'minitest/autorun'
+gem 'minitest'
 
+require 'minitest/autorun'
 require 'clamav/client'
+require 'pry'

data/test/unit/clamav/commands/instream_command_test.rb

@@ -0,0 +1,53 @@
+# 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 'test_helper'
+
+describe "INSTREAM command" do
+  before do
+    @conn = Minitest::Mock.new
+    @io   = ::StringIO.new('hello')
+  end
+
+  after do
+    @conn.verify
+  end
+
+  it "can process an IO object" do
+    @conn.expect(:write_request, nil, ["INSTREAM"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x05hello"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x00"])
+    @conn.expect(:read_response, '1: stream: OK', [])
+
+    assert ClamAV::Commands::InstreamCommand.new(@io).call(@conn)
+  end
+
+  it "can specify the size of read chunks" do
+    chunk_size = 1
+
+    @conn.expect(:write_request, nil, ["INSTREAM"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x01h"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x01e"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x01l"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x01l"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x01o"])
+    @conn.expect(:raw_write, nil, ["\x00\x00\x00\x00"])
+    @conn.expect(:read_response, '1: stream: OK', [])
+
+    assert ClamAV::Commands::InstreamCommand.
+      new(@io, chunk_size).call(@conn)
+  end
+end

data/test/unit/clamav/connection_test.rb

@@ -18,7 +18,7 @@ require 'test_helper'
 
 describe "ClamAV::Connection" do
   let(:wrapper_mock) { Minitest::Mock.new }
-  let(:socket_mock)    { Minitest::Mock.new }
+  let(:socket_mock)  { Minitest::Mock.new }
 
   it "requires a port and a wrapper" do
     assert_raises(ArgumentError) { ClamAV::Connection.new }
@@ -29,4 +29,11 @@ describe "ClamAV::Connection" do
   it "can be constructed with a port and wrapper class" do
     ClamAV::Connection.new(socket: socket_mock, wrapper: wrapper_mock)
   end
+
+  it "support raw writes" do
+    socket_mock.expect(:write, nil, ["foo"])
+
+    conn = ClamAV::Connection.new(socket: socket_mock, wrapper: wrapper_mock)
+    conn.raw_write("foo")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamav-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Franck Verrot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: ClamAV::Client connects to a Clam Anti-Virus clam daemon and send commands.
 email:
 - franck@verrot.fr
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,6 +82,7 @@ files:
 - clamav-client.gemspec
 - lib/clamav/client.rb
 - lib/clamav/commands/command.rb
+- lib/clamav/commands/instream_command.rb
 - lib/clamav/commands/ping_command.rb
 - lib/clamav/commands/quit_command.rb
 - lib/clamav/commands/scan_command.rb
@@ -87,6 +103,7 @@ files:
 - test/integration/clamav/util_test.rb
 - test/test_helper.rb
 - test/unit/clamav/client_test.rb
+- test/unit/clamav/commands/instream_command_test.rb
 - test/unit/clamav/commands/ping_command_test.rb
 - test/unit/clamav/commands/scan_command_test.rb
 - test/unit/clamav/connection_test.rb
@@ -125,6 +142,7 @@ test_files:
 - test/integration/clamav/util_test.rb
 - test/test_helper.rb
 - test/unit/clamav/client_test.rb
+- test/unit/clamav/commands/instream_command_test.rb
 - test/unit/clamav/commands/ping_command_test.rb
 - test/unit/clamav/commands/scan_command_test.rb
 - test/unit/clamav/connection_test.rb