ratonvirus-resty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de801c65869a22224c37180d25d454fabb3a6f92ce20f0c35c519f20cf8bebc8
+  data.tar.gz: e71e339fa4ceff836d5e5c48a67bc3520cdc35137ed9cbfbea3bda3319b5e866
+SHA512:
+  metadata.gz: 30beb2cfa79f106da76939e0407cbf81061d6d496617e996736b8073b58285d69b52425d7c4cc2e4c5ff9cb643beb48e0e61224690e071b5f50b9ec880f4a20d
+  data.tar.gz: a1abb2e01e4d7db7efb899f7a86932f1f9d7f92151ba96488877f3819db8064e1ab14650836f82714a49bd926b647b243f969b7ef3594eb55cac4cabba86a6d8

data/README.md

@@ -0,0 +1,40 @@
+# Ratonvirus::Resty
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ratonvirus/resty`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ratonvirus-resty'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ratonvirus-resty
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ratonvirus-resty.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/generators/ratonviurs/resty/install_generator.rb

@@ -0,0 +1,15 @@
+module Ratonvirus
+  module Resty
+    module Generators
+      class InstallGenerator > Rails::Generators::Base
+
+        desc 'Generates the initializer'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def generate_initializer
+          template 'initializer.rb', 'config/initializers/ratonvirus_resty.rb'
+        end
+    end
+  end
+end

data/lib/generators/ratonviurs/resty/templates/initializer.rb

@@ -0,0 +1,25 @@
+Ratonvirus::Resty.configure do |config|
+  # Sets the base url for api requests
+  #
+  # default: config.base_url = ENV.fetch('RESTY_SERVICE_URL') { 'http://localhost:9000/scan' }
+  #
+  config.base_url = ENV.fetch('RESTY_SERVICE_URL', 'http://localhost:9000/scan')
+
+  # Optional sets the username for api requests
+  #
+  # config.username = ENV.fetch('RESTY_USER', nil)
+  #
+  config.username = ENV.fetch('RESTY_USER', nil)
+  # Optional sets the password for api requests
+  #
+  # config.password = ENV.fetch('RESTY_PASSWORD', nil)
+  #
+  config.password = ENV.fetch('RESTY_PASSWORD', nil)
+
+  
+  # Optional sets the proxy url 
+  #
+  # config.proxy_url = ENV.fetch('PROXY_URL', nil)
+  #
+  config.proxy_url = ENV.fetch('PROXY_URL', nil)
+end

data/lib/ratonvirus/resty.rb

@@ -0,0 +1,17 @@
+require "ratonvirus/resty/version"
+require "ratonvirus/resty/configuration"
+require "faraday"
+require "mimemagic"
+require 'active_support'
+
+require_relative "scanner/resty"
+require_relative "resty/configuration"
+
+module Ratonvirus
+  autoload :AntivirusCheckService, 'ratonvirus/services/antivirus_check_service'
+  
+  module Resty
+    extend Configuration
+    class Error < StandardError; end
+  end
+end

data/lib/ratonvirus/resty/configuration.rb

@@ -0,0 +1,17 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Ratonvirus
+  module Resty
+    module Configuration
+      def configure
+        yield self
+      end
+
+      mattr_accessor(:service_url) { ENV.fetch('RESTY_SERVICE_URL', 'http://localhost:9000/scan') }
+      mattr_accessor(:username) { ENV.fetch('RESTY_USER', nil) }
+      mattr_accessor(:password) { ENV.fetch('RESTY_PASSWORD', nil) }
+      mattr_accessor(:proxy_url) { ENV.fetch('PROXY_URL') { nil } }
+    end
+  end
+end

data/lib/ratonvirus/resty/version.rb

@@ -0,0 +1,5 @@
+module Ratonvirus
+  module Resty
+    VERSION = "0.1.0"
+  end
+end

data/lib/ratonvirus/scanner/resty.rb

@@ -0,0 +1,28 @@
+require 'ratonvirus'
+
+module Ratonvirus
+  module Scanner
+    class Resty < Ratonvirus::Scanner::Base
+      class << self
+        def executable?
+          AntivirusCheckService.installed?
+        end
+      end
+
+      protected
+
+      def run_scan(path)
+        if File.file?(path)
+          result = AntivirusCheckService.new(path).call
+          if result.virus?
+            errors << :antivirus_virus_deteced
+          end
+        else
+          errors << :antivirus_file_not_found
+        end
+        rescue StandardError
+          errors << :antivirus_client_error
+      end
+    end
+  end
+end

data/lib/ratonvirus/services/antivirus_check_service.rb

@@ -0,0 +1,90 @@
+module Ratonvirus
+  class AntivirusCheckService
+    class Result
+      attr_accessor :parsed_response
+
+      def virus?
+        parsed_response.any? && parsed_response['status'] != 'OK'
+      end
+    end
+
+    attr_accessor :file_path, :result
+
+    def initialize(path)
+      @file_path = path
+
+      @logger = Logger.new(STDOUT)
+      @result = Result.new
+    end
+
+    def installed?
+      true
+    end
+
+    def call
+      perform_request
+      @result
+    end
+
+    private
+
+    def perform_request
+      @logger.debug { "Performing request to #{base_url}" }
+      begin
+        @response = connection.post(base_url, { file: initialize_upload_file })
+        @result.parsed_response = parse_response
+        unless @response.success?
+          @logger.debug { "API request respond with status code #{@response.status}: #{parse_response}"}
+        end
+      rescue => exception
+        @logger.debug { "There was an error performing the API request: #{exception.message}"}
+      end
+    end
+
+    def parse_response
+      @logger.debug { "Parsing response #{@response}"}
+      JSON.parse(@response.body).transform_keys(&:downcase)
+    end
+
+    def connection
+      @connection ||= initialize_connection
+    end
+
+    def request_headers
+      { 'Content-Type' => 'application/json;charset=UTF-8' }
+    end
+
+    def initialize_connection
+      Faraday.new(base_url, proxy: proxy) do |f|
+        f.request :url_encoded
+        f.request :multipart
+        f.request :basic_auth, Ratonvirus::Resty::Configuration.username, Ratonvirus::Resty::Configuration.password if request_use_basic_auth?
+        f.adapter :net_http
+      end
+    end
+
+    def initialize_upload_file
+      Faraday::UploadIO.new(file_path, mime_type)
+    end
+
+    def mime_type
+      MimeMagic.by_path(file_path)
+    end
+
+    def base_url
+      Ratonvirus::Resty::Configuration.service_url
+    end
+
+    def request_path
+      "#{base_url}"
+    end
+
+    def request_use_basic_auth?
+      Ratonvirus::Resty::Configuration.username && Ratonvirus::Resty::Configuration.password
+    end
+
+    def proxy
+      Ratonvirus::Resty::Configuration.proxy_url
+    end
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: ratonvirus-resty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugen Müller
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: ratonvirus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+description: Ratonviurs scanner based on a ClamAv Rest service. Expect a Restservice
+  based on https://github.com/ajilaag/clamav-rest
+email:
+- eugen.mueller@enermarket.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/ratonviurs/resty/install_generator.rb
+- lib/generators/ratonviurs/resty/templates/initializer.rb
+- lib/ratonvirus/resty.rb
+- lib/ratonvirus/resty/configuration.rb
+- lib/ratonvirus/resty/version.rb
+- lib/ratonvirus/scanner/resty.rb
+- lib/ratonvirus/services/antivirus_check_service.rb
+homepage: https://github.com/enermarket/ratonvirus-resty.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/enermarket/ratonvirus-resty.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Restfull scanner for Ratonvirus
+test_files: []