metascan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef3bca447dda61607d61ce407a66fe8a87cd1b0e
+  data.tar.gz: f7c01b0c3cc710864aa86ecb7a02a89dbae82f0a
+SHA512:
+  metadata.gz: 985594e081de4084d684ac4d6261a1995759bd6f3e9626a31489248c5f6c0f8c8f23ea83139dd1ca882aa50e1f1af6178661aa63bc7fdd0b0bcc82a05179459b
+  data.tar.gz: 4cdf9e857fa9ae41531f8322e0a1a8dc1dab5db2d658cfa89fd4c1e6bcb82af371f681a403a6523c415e762c3a25fe916887d451aa3a94d71591f352f07f8bae

data/lib/metascan.rb

@@ -0,0 +1,119 @@
+module Metascan
+
+  require 'typhoeus'
+  require 'json'
+
+  # Constants like paths and stuff.
+  PATHS = {
+    :scan_file            => "https://api.metascan-online.com/v1/file",
+    :results_by_data_id   => "https://api.metascan-online.com/v1/file/",
+    :results_by_file_hash => "https://api.metascan-online.com/v1/hash/"
+  }
+
+  # A single scan on the Metascan service.
+  # Initialized with the parameters to scan,
+  # exposes methods to inspect the scan results.
+  class Scan
+    def initialize(filename, client, archivepwd: nil)
+      @filename   = filename
+      @client     = client
+      @archivepwd = archivepwd
+    end
+
+    # Initiate a scan of @filename
+    def run
+      request = Typhoeus::Request.new(
+        Metascan::PATHS[:scan_file],
+        headers: {
+          'filename' => @filename,
+          'archivepwd' => @archivepwd,
+          'apikey' => @client.api_key
+        }.select { |k, v| !v.nil? },
+        method: :post,
+        body: { file: File.open(@filename, "r") }
+      )
+
+      request.on_complete do |r|
+        @data_id = JSON.parse(r.body)["data_id"]
+        retrieve_results
+      end
+
+      request.run
+    end
+
+    # Is my file clean?
+    def clean?
+      self.results["scan_results"]["scan_all_result_i"] == 0
+    end
+
+    # Only useful for testing.
+    def results=(results)
+      @results = results
+    end
+
+    # Return the results of my scan.
+    # If the optional argument "poll" is set to true, then attempt
+    # to requery Metascan for the results before returning them.
+    def results(poll: true)
+      if !@results or 
+        (poll and @results["scan_results"]["progress_percentage"] < 100) then
+        @results = retrieve_results
+      end
+      @results
+    end
+
+    def data_id
+      @data_id
+    end
+
+    def retrieve_results
+      request = Typhoeus::Request.new(
+        Metascan::PATHS[:results_by_data_id] + @data_id,
+        headers: {
+          'apikey' => @client.api_key
+        },
+        method: :get
+      )
+
+      response = request.run
+      JSON.parse(response.body)
+    end
+  end
+
+  # The Client object, which stores an API key and has a (currently not used)
+  # Typhoeus::Hydra for when you have a lot of requests to make at once.
+  class Client
+    # An API key is required. Free at www.metascan-online.com
+    def initialize(api_key)
+      @api_key = api_key
+      @hydra   = Typhoeus::Hydra.hydra
+    end
+
+    def api_key
+      @api_key
+    end
+
+    # A Typhoeus Hydra manages parallel HTTP requests.
+    def hydra
+      if !@hydra
+        @hydra = Typhoeus::Hydra.hydra
+      end
+      @hydra
+    end
+
+    # Returns a Scan object
+    # Sample usage:
+    #
+    #   scanner = Metascan::Client.new(MY_API_KEY) 
+    #   filename = "/etc/unwise-backups/passwd.rar" # FULLY QUALIFIED
+    #   scanner.scan_file(filename, archivepwd: "the eagle has left the nest")
+    #   => <Metascan::Scan ... >
+    #
+    # https://www.metascan-online.com/en/public-api
+    def scan_file(filename, archivepwd: nil)
+      scan = Metascan::Scan.new(filename, self)
+      scan.run
+      scan
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: metascan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Grayson Chao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+description: Allows scanning files using the Metascan public API. https://www.metascan-online.com/en/public-api
+email: graysonchao@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/metascan.rb
+homepage: http://rubygems.org/gems/metascan
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Scan files using the Metascan public API.
+test_files: []