op-clamav-client 3.4.2

data/lib/clamav/connection.rb

@@ -0,0 +1,129 @@
+# 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 'timeout'
+
+module ClamAV
+  class Connection
+    class ReadTimeoutError < ::ClamAV::Client::ReadTimeoutError; end
+    class WriteTimeoutError < ::ClamAV::Client::WriteTimeoutError; end
+
+    attr_accessor :client
+    attr_accessor :socket
+    attr_accessor :wrapper
+
+    def initialize(attrs={})
+      attrs.each do |attr, value|
+        send("#{attr}=", value)
+      end
+
+      begin
+        validate!
+      rescue => e
+        @client = nil
+        @socket = nil
+        @wrapper = nil
+
+        raise e
+      end
+    end
+
+    def validate!
+      missing_required_argument(:client) if !client
+      missing_required_argument(:socket) if !socket
+      missing_required_argument(:wrapper) if !wrapper
+    end
+
+    [
+      :tcp?,
+      :file,
+      :connect_timeout,
+      :read_timeout,
+      :write_timeout,
+    ].each do |m|
+      define_method(m) do
+        client.send(m)
+      end
+    end
+
+    def establish_connection
+      write_request("IDSESSION")
+    end
+
+    def write_request(str)
+      return write_request_with_timeout(str) if write_timeout
+
+      write_request_without_timeout(str)
+    end
+
+    def write_request_without_timeout(str)
+      wrapped_request = @wrapper.wrap_request(str)
+
+      @socket.write wrapped_request
+    end
+
+    def write_request_with_timeout(str)
+      Timeout::timeout(connect_timeout) do
+        write_request_without_timeout(str)
+      end
+    rescue Timeout::Error => e
+
+      raise WriteTimeoutError.new(e.to_s)
+    end
+
+    def read_response
+      return read_response_with_timeout if read_timeout
+
+      read_response_without_timeout
+    end
+
+    def read_response_without_timeout
+      @wrapper.read_response(@socket)
+    end
+
+    def read_response_with_timeout
+      Timeout::timeout(read_timeout) do
+        read_response_without_timeout
+      end
+    rescue Timeout::Error => e
+      raise ReadTimeoutError.new(e.to_s)
+    end
+
+    def disconnect!
+      return true if @socket.nil?
+
+      @socket.close
+
+      @socket.closed?.tap do
+        @socket = nil
+      end
+    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/response.rb

@@ -0,0 +1,28 @@
+# 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
+  class Response
+
+    attr_reader :file, :virus_name, :error_str
+
+    # Not sure if this is still required?
+    def ==(other)
+      @file == other.file && self.class == other.class
+    end
+
+  end
+end

data/lib/clamav/responses/error_response.rb

@@ -0,0 +1,25 @@
+# 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
+  class ErrorResponse < Response
+
+    def initialize(error_str)
+      @error_str = error_str
+    end
+
+  end
+end

data/lib/clamav/responses/success_response.rb

@@ -0,0 +1,25 @@
+# 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
+  class SuccessResponse < Response
+
+    def initialize(file)
+      @file = file
+    end
+
+  end
+end

data/lib/clamav/responses/virus_response.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/>.
+
+module ClamAV
+  class VirusResponse < Response
+
+    def initialize(file, virus_name)
+      @file = file
+      @virus_name = virus_name
+    end
+
+  end
+end

data/lib/clamav/util.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 Util
+    UnknownPathException = Class.new(RuntimeError)
+
+    def Util.path_to_files(path)
+      if Dir.exist?(path)
+        Dir.glob(path + '/*')
+      elsif File.exist?(path)
+        [path]
+      else
+        message =" (path = #{path})"
+        raise UnknownPathException.new("#{__FILE__}:#{__LINE__} path_to_files : path argument neither a file nor a directory. Aborting. #{message}")
+      end
+    end
+  end
+end

data/lib/clamav/wrapper.rb

@@ -0,0 +1,33 @@
+# 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
+  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
+      rescue TypeError => e
+        raise ::ClamAV::Client::ConnectionError.new(e.to_s)
+      end
+  end
+end

data/lib/clamav/wrappers/new_line_wrapper.rb

@@ -0,0 +1,29 @@
+# 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 Wrappers
+    class NewLineWrapper < ::ClamAV::Wrapper
+      def wrap_request(request)
+        "n#{request}\n"
+      end
+
+      def read_response(socket)
+        read_until(socket, "\n")
+      end
+    end
+  end
+end

data/lib/clamav/wrappers/null_termination_wrapper.rb

@@ -0,0 +1,29 @@
+# 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 Wrappers
+    class NullTerminationWrapper < ::ClamAV::Wrapper
+      def wrap_request(request)
+        "z#{request}\0"
+      end
+
+      def read_response(socket)
+        read_until(socket, "\0")
+      end
+    end
+  end
+end

data/lib/clamav.rb

@@ -0,0 +1 @@
+require_relative 'clamav/client'

data/test/Dockerfile

@@ -0,0 +1,16 @@
+ARG RUBY_VERSION
+FROM ruby:${RUBY_VERSION}
+LABEL maintainer="victor.pugin@lifen.fr"
+
+WORKDIR /clamav-client
+ADD Gemfile /clamav-client
+ADD clamav-client.gemspec /clamav-client
+
+RUN apt-get update -qq && \
+      apt-get install -y clamav-daemon clamav-freshclam clamav-unofficial-sigs && \
+      freshclam && \
+      bundle
+
+ENTRYPOINT ["./start.sh"]
+
+ADD . /clamav-client

data/test/integration/clamav/client_test.rb

@@ -0,0 +1,142 @@
+# 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 "ClamAV::Client Integration Tests" do
+  describe "default new line delimiter" do
+    let(:client) { ClamAV::Client.new }
+
+    describe "any callable" do
+      it "can be used" do
+        assert client.execute(lambda { |conn| true })
+      end
+    end
+
+    describe "ping" do
+      let(:ping_command) { ClamAV::Commands::PingCommand.new }
+
+      it "can be sent" do
+        assert client.execute(ping_command)
+      end
+
+      it "can be sent multiple times" do
+        assert client.execute(ping_command)
+        assert client.execute(ping_command)
+      end
+
+      it "can be used as #ping" do
+        assert_equal client.execute(ping_command), client.ping
+      end
+    end
+
+    describe "scan" do
+      let(:base_path) { File.expand_path('../../../../', __FILE__) }
+      let(:dir) { File.join(base_path, 'test/fixtures') }
+
+      it "can be started" do
+        results = client.execute(ClamAV::Commands::ScanCommand.new(dir))
+
+        expected_results = {
+          "#{base_path}/test/fixtures/clamavtest.gz"  => ClamAV::VirusResponse,
+          "#{base_path}/test/fixtures/clamavtest.txt" => ClamAV::VirusResponse,
+          "#{base_path}/test/fixtures/clamavtest.zip" => ClamAV::VirusResponse,
+          "#{base_path}/test/fixtures/innocent.txt"   => ClamAV::SuccessResponse
+        }
+
+        results.each do |result|
+          expected_result = expected_results[result.file]
+          assert_equal expected_result, result.class
+        end
+      end
+
+      it "can be used as #scan" do
+        assert_equal client.execute(ClamAV::Commands::ScanCommand.new(dir)), client.send(:scan, dir)
+      end
+
+      describe "with timeout configuration" do
+        let(:client) { ClamAV::Client.new(connect_timeout: 1, write_timeout: 1, read_timeout: 1) }
+
+        it "can be started" do
+          results = client.execute(ClamAV::Commands::ScanCommand.new(dir))
+
+          expected_results = {
+            "#{base_path}/test/fixtures/clamavtest.gz"  => ClamAV::VirusResponse,
+            "#{base_path}/test/fixtures/clamavtest.txt" => ClamAV::VirusResponse,
+            "#{base_path}/test/fixtures/clamavtest.zip" => ClamAV::VirusResponse,
+            "#{base_path}/test/fixtures/innocent.txt"   => ClamAV::SuccessResponse
+          }
+
+          results.each do |result|
+            expected_result = expected_results[result.file]
+            assert_equal expected_result, result.class
+          end
+        end
+      end
+    end
+
+    describe "instream" do
+      let(:dir) { File.expand_path('../../../../test/fixtures', __FILE__) }
+
+      it "can recognize a sane file" do
+        command = build_command_for_file('innocent.txt')
+        client.execute(command).must_equal ClamAV::SuccessResponse.new("stream")
+      end
+
+      it "can recognize an infected file" do
+        command = build_command_for_file('clamavtest.txt')
+        client.execute(command).must_equal ClamAV::VirusResponse.new("stream", "ClamAV-Test-Signature")
+      end
+
+      it "can be used as #instream" do
+        io = File.open(File.join(dir, 'innocent.txt'))
+        assert_equal client.execute(ClamAV::Commands::InstreamCommand.new(io)), client.send(:instream, io)
+      end
+
+      def build_command_for_file(file)
+        io = File.open(File.join(dir, file))
+        ClamAV::Commands::InstreamCommand.new(io)
+      end
+    end
+
+    describe 'safe?' do
+      let(:dir) { File.expand_path('../../../../test/fixtures', __FILE__) }
+
+      it 'returns true if the given io is safe' do
+        io = build_io_obj('innocent.txt')
+        assert client.safe?(io)
+      end
+
+      it 'returns false if the given io is infected' do
+        io = build_io_obj('clamavtest.txt')
+        refute client.safe?(io)
+      end
+
+      it 'returns false if there is any infected file in the given files' do
+        refute client.safe?(dir)
+      end
+
+      it 'returns true if all the give file is safe' do
+        assert client.safe?("#{dir}/innocent.txt")
+      end
+
+      def build_io_obj(file)
+        content = File.read(File.join(dir, file))
+        io = StringIO.new(content)
+      end
+    end
+  end
+end

data/test/integration/clamav/util_test.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 'test_helper'
+describe "ClamAV::Client Integration Tests" do
+  describe "Util" do
+    describe "absolute_path" do
+      it "transforms a single file to an array of one element" do
+        expected_path = File.absolute_path(__FILE__)
+        actual_path   = ClamAV::Util.path_to_files(__FILE__).first
+        assert_equal expected_path, actual_path
+      end
+
+      it "transforms a directory to an array of N element" do
+        files = %w(
+          clamav-client/test/integration/clamav/client_test.rb
+          clamav-client/test/integration/clamav/util_test.rb
+        ).sort
+        actual_files = ClamAV::Util.path_to_files(File.dirname(__FILE__)).sort
+
+        files.each_with_index do |file, index|
+          path   = Regexp.new(".*/#{file}")
+          assert path.match(actual_files[index])
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+# 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/>.
+
+gem 'minitest'
+
+require 'minitest/autorun'
+require 'clamav/client'
+require 'pry'

data/test/unit/clamav/client_test.rb

@@ -0,0 +1,59 @@
+# 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 "ClamAV::Client" do
+  describe "connect!" do
+    let(:conn_mock) { Minitest::Mock.new }
+    let(:client) { ClamAV::Client.new }
+
+    it "opens the connection" do
+      conn_mock.expect(:establish_connection, nil)
+
+      client.connect!(conn_mock)
+
+      conn_mock.verify
+    end
+
+    it 'raises an custom error if connection times out' do
+      conn_mock.expect(:establish_connection, nil) do
+        raise Errno::ETIMEDOUT
+      end
+
+      assert_raises(ClamAV::Client::ConnectTimeoutError) { client.connect!(conn_mock) }
+    end
+
+    it 'raises an custom error if something goes wrong' do
+      conn_mock.expect(:establish_connection, nil) do
+        raise SocketError
+      end
+
+      assert_raises(ClamAV::Client::ConnectionError) { client.connect!(conn_mock) }
+    end
+  end
+
+  describe "tcp?" do
+    it "returns true when config is tcp" do
+      assert client = ClamAV::Client.new(tcp_host: 'example', tcp_port: 3310).tcp?
+    end
+
+    it "returns false when config is not tcp" do
+      refute client = ClamAV::Client.new.tcp?
+      refute client = ClamAV::Client.new(unix_socket: '/some.sock').tcp?
+    end
+  end
+end