clamby 1.6.1 → 1.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc73965f059691dd46a23b5d0fd7ba7d6e5d1103859bfe68124780c12ca56639
-  data.tar.gz: f666ead4b14e3dc024ed92ca6842928cc4256d424df0ff25299a7c5eb3c5762f
+  metadata.gz: 81853e9529f298f606bb599f22da044e9ada2f805d2d6f6635caac455450e93e
+  data.tar.gz: d122cf67adcfd0187c8fabd7153ca7fe20643b075f9bcfe77c8d482075462f74
 SHA512:
-  metadata.gz: dcdb2f76042a1cd6751095e30201d635adf0e847defeaeb4d61b174a52ea6c355e4afa567e4770df388b9a2ee79e8c5ef0826486adc46e9ea21d308b4ebc83c8
-  data.tar.gz: 65beb709c82e4cce7804fe696bbc71d81b6951a2c38cf22ea6c1e2bd42536b55ede204c06a1b78cbba10fe778ef7db0d6b436ec02a80c0e6cafc0b0238bce8f7
+  metadata.gz: c56dc7d74dfa3e29eeeca5d44b0cee9fc55efbc55269bcee95cd5108cb8c09ac8faa5a353bd6932ae7602adf1686bec8df4671a5afd57997bb0bdf605d2c2bdc
+  data.tar.gz: 85b9072343ce8061cb67ab7607a52570f6d42459e9ad3467c3497c381a9df6cdea3832435dd276e306b1b5fdc1a8bb415940e0a90371027f65497952f215a89b

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store/
+.byebug_history

data/.travis.yml

@@ -4,12 +4,14 @@ before_install:
   - gem install rake
   - gem install rspec
 rvm:
-  - 2.0.0
-  - 2.1.1
   - 2.3.4
   - 2.4.1
   - 2.5.3
-install: 
+  - 2.6.3
+  - 2.6.5
+  - 2.6.6
+  - 2.7.2
+install:
  - sudo apt-get install clamav
  - sudo freshclam
 

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v1.6.8
+ - [codezomb](https://github.com/kobaltz/clamby/commits?author=codezomb)  - Allow paths to be escaped #37
+
+# v1.6.5
+ - [bennacer860](https://github.com/kobaltz/clamby/commits?author=bennacer860) - Added config data dir option
+
+
+# v1.6.2
+ - [emilong](https://github.com/kobaltz/clamby/commits?author=emilong) - Handle nil exit status of clamav executable.
+
 # v1.6.1
  - [broder](https://github.com/kobaltz/clamby/commits?author=broder) - Fixed issue with detecting clamdscan version when using custom config file
 
@@ -18,7 +28,7 @@
 
 # v1.3.2
  - [emilong](https://github.com/kobaltz/clamby/commits/master?author=emilong) added `stream` option
- 
+
 # v1.3.1
  - [zealot128](https://github.com/kobaltz/clamby/commits/master?author=zealot128) added `silence_output` option
 
@@ -36,7 +46,7 @@
  - Refactor of logic
  - Cleanup
  - Thanks to @hderms for contributing!
- 
+
 # v1.1.0
  - Changed `scan()` to `safe?()`
  - Added `virus?()`
@@ -63,7 +73,7 @@ HTTP request sent, awaiting response... 200 OK
 Length: 68 [application/octet-stream]
 Saving to: 'eicar.com'
 
-100%[=================>] 68          --.-K/s   in 0s      
+100%[=================>] 68          --.-K/s   in 0s
 
 2014-03-10 21:35:50 (13.0 MB/s) - 'eicar.com' saved [68/68]
 

data/README.md

@@ -17,14 +17,14 @@ Just add `gem 'clamby'` to your `Gemfile` and run `bundle install`.
 
 You can use two methods to scan a file for a virus:
 
-If you use `safe?` to scan a file, it will return true if no viruses were found, false if a virus was found, and nil if there was a problem finding the file or if there was a problem using `clamscan`
+If you use `safe?` to scan a file, it will return `true` if no viruses were found, `false` if a virus was found, and `nil` if there was a problem finding the file or if there was a problem using `clamscan`
 
-`safe?(path_to_file)`
+`Clamby.safe?(path_to_file)`
 
-If you use `virus?` to scan a file, it will return true if a virus was found, false if no virus was found, and nil if there was a problem finding the file or if there was a problem using `clamscan`
+If you use `virus?` to scan a file, it will return `true` if a virus was found, `false` if no virus was found, and `nil` if there was a problem finding the file or if there was a problem using `clamscan`
 
 
-`virus?(path_to_file)`
+`Clamby.virus?(path_to_file)`
 
 In your model with the uploader, you can add the scanner to a before method to scan the file. When a file is scanned, a successful scan will return `true`. An unsuccessful scan will return `false`. A scan may be unsuccessful for a number of reasons; `clamscan` could not be found, `clamscan` returned a virus, or the file which you were trying to scan could not be found.
 
@@ -64,6 +64,25 @@ It's good to note that Clamby will not by default delete files which had a virus
   end
 ```
 
+## with ActiveStorage
+
+With ActiveStorage, you don't have access to the file through normal methods, so you'll have to access the file through the `attachment_changes`. 
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+  before_save :scan_for_viruses
+
+  private
+
+  def scan_for_viruses
+    return unless self.attachment_changes['avatar']
+
+    path = self.attachment_changes['avatar'].attachable.tempfile.path
+    Clamby.safe?(path)
+  end
+end
+```
 
 # Configuration
 
@@ -161,6 +180,11 @@ This opens the root crontab file in a text editor. Add the following line
 
 `57 08 * * * sudo freshclam`
 
+# Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
 # LICENSE
 
 Copyright (c) 2016 kobaltz

data/clamby.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   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 "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/clamby/command.rb

@@ -16,24 +16,28 @@ module Clamby
     def self.scan(path)
       return nil unless file_exists?(path)
 
-      args = [path, '--no-summary']
+      args = [Shellwords.escape(path), '--no-summary']
 
       if Clamby.config[:daemonize]
         args << '--fdpass' if Clamby.config[:fdpass]
         args << '--stream' if Clamby.config[:stream]
       end
 
+      args << "-d #{Clamby.config[:datadir]}" if Clamby.config[:datadir]
+
       new.run scan_executable, *args
 
-      case $CHILD_STATUS.exitstatus
+      # $CHILD_STATUS maybe nil if the execution itself (not the client process)
+      # fails
+      case $CHILD_STATUS && $CHILD_STATUS.exitstatus
       when 0
         return false
-      when 2
+      when nil, 2
         # clamdscan returns 2 whenever error other than a detection happens
         if Clamby.config[:error_clamscan_client_error] && Clamby.config[:daemonize]
           raise Clamby::ClamscanClientError.new("Clamscan client error")
         end
-
+ 
         # returns true to maintain legacy behavior
         return true
       else
@@ -45,7 +49,9 @@ module Clamby
 
     # Update the virus definitions.
     def self.freshclam
-      new.run 'freshclam'
+      args = []
+      args << "--datadir=#{Clamby.config[:datadir]}" if Clamby.config[:datadir]
+      new.run 'freshclam', *args
     end
 
     # Show the ClamAV version. Also acts as a quick check if ClamAV functions.
@@ -66,7 +72,7 @@ module Clamby
       self.command = args | default_args
       self.command = command.sort.unshift(executable_full)
 
-      system(*self.command, system_options)
+      system(self.command.join(' '), system_options)
     end
 
     private

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.6.1"
+  VERSION = "1.6.8"
 end

data/lib/clamby.rb

@@ -15,6 +15,7 @@ module Clamby
     :fdpass => false,
     :stream => false,
     :output_level => 'medium',
+    :datadir => nil,
     :executable_path_clamscan => 'clamscan',
     :executable_path_clamdscan => 'clamdscan',
     :executable_path_freshclam => 'freshclam',

data/spec/clamby/command_spec.rb

@@ -134,9 +134,7 @@ describe Clamby::Command do
 
         it 'executes the clamscan executable from the custom path' do
           expect(runner).to receive(:system).with(
-            "#{custom_path}/clamscan",
-            '--no-summary',
-            good_path,
+            "#{custom_path}/clamscan --no-summary #{good_path}",
             {}
           ) { system("exit 0", out: File::NULL) }
 
@@ -149,9 +147,7 @@ describe Clamby::Command do
 
         it 'executes the clamdscan executable from the custom path' do
           expect(runner).to receive(:system).with(
-            "#{custom_path}/clamdscan",
-            '--no-summary',
-            good_path,
+            "#{custom_path}/clamdscan --no-summary #{good_path}",
             {}
           ) { system("exit 0", out: File::NULL) }
 
@@ -159,5 +155,11 @@ describe Clamby::Command do
         end
       end
     end
+
+    describe 'special filenames' do
+      it 'does not fail' do
+        expect(described_class.scan(special_path)).to be(false)
+      end
+    end
   end
 end

data/spec/fixtures/safe (special).txt

@@ -0,0 +1,2 @@
+This is a virus-free file.
+It is used by automated tests.

data/spec/support/shared_context.rb

@@ -1,4 +1,5 @@
 RSpec.shared_context 'paths' do
+  let(:special_path) { File.expand_path('../../fixtures/safe (special).txt', __FILE__) }
   let(:good_path) { File.expand_path('../../fixtures/safe.txt', __FILE__) }
   let(:bad_path) { File.expand_path("not-here/#{rand 10e6}.txt", __FILE__) }
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.8
 platform: ruby
 authors:
 - kobaltz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2021-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,7 @@ files:
 - spec/.DS_Store
 - spec/clamby/command_spec.rb
 - spec/clamby_spec.rb
+- spec/fixtures/safe (special).txt
 - spec/fixtures/safe.txt
 - spec/spec_helper.rb
 - spec/support/shared_context.rb
@@ -86,7 +87,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,14 +102,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Scan file uploads with ClamAV
 test_files:
 - spec/.DS_Store
 - spec/clamby/command_spec.rb
 - spec/clamby_spec.rb
+- spec/fixtures/safe (special).txt
 - spec/fixtures/safe.txt
 - spec/spec_helper.rb
 - spec/support/shared_context.rb