clamby 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ec4a88600a8ac38d350f1d05a1c10ea3b4eca4
-  data.tar.gz: 9630ac5dd4a3eb82940765bb17d5aa95f2164488
+  metadata.gz: b01112eed29677aba4c41681568068a07d1fd44f
+  data.tar.gz: ea48a1a4470c40bcdc5e5d19ccda1c3013f711a5
 SHA512:
-  metadata.gz: b2dd5f30f7cb404a3b9ddfa44d9d42bc668f921cd0b926e28d4b9f6b86c85586a541894d0d0835748b4f2397625e21f83402378b8b4d62ef5deca5d8f01a710c
-  data.tar.gz: ae85ecf347ea698b1d3433cfd9ae70a2781e4015ffad88e433f9ed8d678c37f32c6d873955f7fd278e1ab33bd0e0ca9424aa77e42b17ee326d9ebd2d4e6511bf
+  metadata.gz: fa1d122187e6860f951be981e45fddc4cc7ba816228f4b0665954595f90a93653b205f24099e6a0df5aae99c79234337f1f89126cb770d607576ece7890c5d0d
+  data.tar.gz: 330b3bea8825e486404436c55e0b18ba4848673aa5e19e6f6b0fc75a62ce05d056db0d28ab3fc8d52ec2c99cb69dc6ae393a7dccf07949234b4b32ee55b90a95

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+#v1.2.5
+ - [bess](https://github.com/kobaltz/clamby/commits/master?author=bess) added `fdpass` option
+
 #v1.2.3
  - Fixed typo in config check `error_clamscan_missing` instead of `error_clamdscan_missing`
 

data/README.md

@@ -64,25 +64,30 @@ It's good to note that Clamby will not by default delete files which had a virus
 ```
 
 
-#Configuration
+# Configuration
 
 Configuration is rather limited right now. You can exclude the check if `clamscan` exists which will save a bunch of time for scanning your files. However, for development purposes, your machine may not have `clamscan` installed and you may wonder why it's not working properly. This is just to give you a reminder to install `clamscan` on your development machine and production machine. You can add the following to a config file, `clamby_setup.rb` to your initializers directory.
 
 There has been added additional functionality where you can override exceptions. If you set the exceptions below to false, then there will not be a hard exception generated. Instead, it will post to your log that an error had occured. By default each one of these configuration options are set to true. You may want to set these to false in your production environment.
 
+Setting the `fdpass` configuration option to `true` will pass the `--fdpass` option to clamscan. This might be useful if you are encountering permissions problems between clamscan and files being created by your application. From the clamscan man page:
+
+`--fdpass : Pass the file descriptor permissions to clamd. This is useful if clamd is running as a different user as it is faster than streaming the file to clamd. Only available if connected to clamd via local(unix) socket.`
+
 ```ruby
     Clamby.configure({
       :check => false,
       :daemonize => false,
       :error_clamscan_missing => false,
       :error_file_missing => false,
-      :error_file_virus => false
+      :error_file_virus => false,
+      :fdpass => false
     })
 ```
 
 I highly recommend using the `daemonize` set to true. This will allow for clamscan to remain in memory and will not have to load for each virus scan. It will save several seconds per request.
 
-#Dependencies
+# Dependencies
 
 ***Ubuntu***
 
@@ -108,7 +113,7 @@ This opens the root crontab file in a text editor. Add the following line
 
 `57 08 * * * sudo freshclam`
 
-#LICENSE
+# LICENSE
 
 Copyright (c) 2016 kobaltz
 

data/lib/clamby.rb

@@ -7,7 +7,8 @@ module Clamby
     :daemonize => false,
     :error_clamscan_missing => true,
     :error_file_missing => true,
-    :error_file_virus => false
+    :error_file_virus => false,
+    :fdpass => false
   }
 
   @valid_config_keys = @config.keys
@@ -22,10 +23,21 @@ module Clamby
     ! value
   end
 
+  # Assemble the system command to be called, including optional flags
+  # @param [String] path path to the file being scanned
+  # @return [String] command to be executed
+  def self.system_command(path)
+    command = clamd_executable_name
+    command += ' --fdpass' if @config[:fdpass]
+    command += " #{path}"
+    command += ' --no-summary'
+    command
+  end
+
   def self.virus?(path)
     return nil unless scanner_exists?
     return nil unless file_exists?(path)
-    scanner = system(clamd_executable_name, path, '--no-summary')
+    scanner = system(system_command(path))
 
     return false if scanner
     return true unless @config[:error_file_virus]

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.2.4"
+  VERSION = "1.2.5"
 end

data/spec/clamby_spec.rb

@@ -46,4 +46,26 @@ describe Clamby do
     expect(Clamby.virus?('eicar.com')).to be true
     File.delete('eicar.com')
   end
+
+  # From the clamscan man page:
+  # Pass the file descriptor permissions to clamd. This is useful if clamd is
+  # running as a different user as it is faster than streaming the file to
+  # clamd. Only available if connected to clamd via local(unix) socket.
+  context 'fdpass option' do
+    it 'is false by default' do
+      expect(Clamby.config[:fdpass]).to eq false
+    end
+    it 'accepts an fdpass option in the config' do
+      Clamby.configure(fdpass: true)
+      expect(Clamby.config[:fdpass]).to eq true
+    end
+    it 'does not include fdpass in the command by default' do
+      Clamby.configure(fdpass: false)
+      expect(Clamby.system_command(good_path)).to eq "clamscan #{good_path} --no-summary"
+    end
+    it 'passes the fdpass option when invoking clamscan if it is set' do
+      Clamby.configure(fdpass: true)
+      expect(Clamby.system_command(good_path)).to eq "clamscan --fdpass #{good_path} --no-summary"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - kobaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-20 00:00:00.000000000 Z
+date: 2017-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Scan file uploads with ClamAV