virustotalx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81764924df363de73f62d4368dc94e147e127191600079c6469c3395d15b54fa
+  data.tar.gz: 9afc5ef8eaecf1dbfec5db769e744cfaa605f185b04449a5443fa74acf5014ff
+SHA512:
+  metadata.gz: c8ae7d801c06e49e166a8fce75a637dee7bef7d985758f5d01ecd0ebbcd515850c12961f13554f6caf0372b5f236acaa9651a5d359cd5174bfecba79814a777e
+  data.tar.gz: 7c5866ffd1eed670f9e0da74db74446b18e648f12497c6cdb08c5b8fac1ff260e7a04cb7c5d3f7f10a1878295227b7f523683cd5df90b88c17cddd04dd06b989

data/.gitignore

@@ -0,0 +1,49 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in virustotalx.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    virustotalx (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hashdiff (0.3.9)
+    json (2.2.0)
+    public_suffix (3.0.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.20.2)
+    vcr (4.0.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls (~> 0.8)
+  rake (~> 12.3)
+  rspec (~> 3.8)
+  vcr (~> 4.0)
+  virustotalx!
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Manabu Niseki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# virustotalx
+
+[![Build Status](https://travis-ci.org/ninoseki/virustotalx.svg?branch=master)](https://travis-ci.org/ninoseki/virustotalx)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/virustotalx/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/virustotalx?branch=master)
+
+Yet another VirusTotal API wrapper for Ruby
+
+## Installation
+
+```bash
+gem install virustotalx
+```
+
+## Usage
+
+```ruby
+require "virustotalx"
+# or
+require "virustotal"
+
+# when given nothing, it tries to load your API key from ENV["VIRUSTOTASL_API_KEY"]
+api = VirusTotal::API.new
+# or you can set it manually
+api = VirusTotal::API.new(key: "YOUR_API_KEY")
+
+hash = "726a2eedb9df3d63ec1b4a7d774a799901f1a2b9"
+api.file.report(hash)
+api.file.scan("PAHT_TO_FILE")
+api.file.rescan(hash)
+api.file.upload_url
+api.file.download(hash)
+api.file.behaviour(hash)
+api.file.network_traffic(hash)
+api.file.clusters("DATETIME")
+api.file.search("resource:#{hash}")
+
+api.url.report("http://github.com")
+api.url.scan("https://github.com/ninoseki/virustotalx")
+
+api.domain.report("github.com")
+
+api.ip_address.report("1.1.1.1")
+```
+
+See `/spec/clients` for more.
+
+## Supported API endpoints
+
+* [VirusTotal API reference](https://developers.virustotal.com/reference)
+
+| HTTP Method | URL                   | Public / Private | API method                                                |
+|-------------|-----------------------|------------------|-----------------------------------------------------------|
+| GET         | /file/report          | Public           | `VirusTotal::Client::File#report(resource, allinfo: nil)` |
+| POST        | /file/scan            | Public           | `VirusTotal::Client::File#scan(path)`                     |
+| GET         | /file/scan/upload_url | Private          | `VirusTotal::Client::File#upload_url`                     |
+| POST        | /file/rescan          | Public           | `VirusTotal::Client::File#rescan(resource)`               |
+| GET         | /file/download        | Private          | `VirusTotal::Client::File#download(hash)`                 |
+| GET         | /file/behaviour       | Private          | `VirusTotal::Client::File#behaviour(hash)`                |
+| GET         | /file/network-traffic | Private          | `VirusTotal::Client::File#network_traffic(hash)`          |
+| GET         | /file/feed            | Private          | N/A                                                       |
+| GET         | /file/clusters        | Private          | `VirusTotal::Client::File#clusters(date)`                 |
+| GET         | /file/search          | Private          | `VirusTotal::Client::File#search(query, offset: nil)`     |
+| GET         | /url/report           | Public           | `VirusTotal::Client::URL#report(resource, allinfo: nil)`  |
+| POST        | /url/scan             | Public           | `VirusTotal::Client::URL#scan(url)`                       |
+| GET         | /url/feed             | Private          | N/A                                                       |
+| GET         | /domain/report        | Public           | `VirusTotal::Client::Domain#report(domain)`               |
+| GET         | /ip-address/report    | Public           | `VirusTotal::Client::IPAddress(ip)`                       |
+| GET         | /comments/            | Public           | N/A                                                       |
+| POST        | /comments/put         | Public           | N/A                                                       |
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "virustotalx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/virustotal.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "virustotal/version"
+
+require "virustotal/errors"
+
+require "virustotal/api"
+
+require "virustotal/clients/base"
+
+require "virustotal/clients/domain"
+require "virustotal/clients/file"
+require "virustotal/clients/ip_address"
+require "virustotal/clients/url"
+
+module VirusTotal
+  class Error < StandardError; end
+end

data/lib/virustotal/api.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "clients/base"
+
+module VirusTotal
+  class API
+    attr_reader :domain
+    attr_reader :file
+    attr_reader :ip_address
+    attr_reader :url
+
+    def initialize(key: ENV["VIRUSTOTAL_API_KEY"])
+      raise ArgumentError, "No API key has been found or provided! (setup your VIRUSTOTAL_API_KEY environment varialbe)" unless key
+
+      @domain = Client::Domain.new(key: key)
+      @file = Client::File.new(key: key)
+      @ip_address = Client::IPAddress.new(key: key)
+      @url = Client::URL.new(key: key)
+    end
+  end
+end

data/lib/virustotal/clients/base.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/https"
+require "uri"
+
+module VirusTotal
+  module Client
+    class Base
+      HOST = "www.virustotal.com"
+      VERSION = "v2"
+      BASE_URL = "https://#{HOST}/vtapi/#{VERSION}"
+
+      attr_reader :key
+
+      def initialize(key: ENV["VIRUSTOTAL_API_KEY"])
+        @key = key
+        raise ArgumentError, "No key has been found or provided!" unless key?
+      end
+
+      private
+
+      def key?
+        !key.nil?
+      end
+
+      def default_params
+        { apikey: key }
+      end
+
+      def url_for(path)
+        URI(BASE_URL + path)
+      end
+
+      def https_options
+        if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+          uri = URI(proxy)
+          {
+            proxy_address: uri.hostname,
+            proxy_port: uri.port,
+            proxy_from_env: false,
+            use_ssl: true
+          }
+        else
+          { use_ssl: true }
+        end
+      end
+
+      def request(req)
+        Net::HTTP.start(HOST, 443, https_options) do |http|
+          response = http.request(req)
+
+          case response.code
+          when "200"
+            if response["Content-Type"] == "application/json"
+              yield JSON.parse(response.body)
+            else
+              yield response.body
+            end
+          when "204"
+            raise(RateLimitError, response.body)
+          when "302"
+            yield response["Location"]
+          else
+            raise(Error, "unsupported response code returned: #{response.code}")
+          end
+        end
+      end
+
+      def get(path, params = {}, &block)
+        uri = url_for(path)
+        uri.query = URI.encode_www_form(params.merge(default_params))
+        get = Net::HTTP::Get.new(uri)
+
+        request(get, &block)
+      end
+
+      def post(path, params = {}, &block)
+        post = Net::HTTP::Post.new(url_for(path))
+        post.set_form_data params.merge(default_params)
+
+        request(post, &block)
+      end
+
+      def post_with_file(path, file:, filename:, &block)
+        post = Net::HTTP::Post.new(url_for(path))
+
+        data = [
+          ["file", file, { "filename": filename }],
+          ["apikey", key]
+        ]
+        post.set_form(data, "multipart/form-data")
+
+        request(post, &block)
+      end
+    end
+  end
+end

data/lib/virustotal/clients/domain.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  module Client
+    class Domain < Base
+      def report(domain)
+        get("/domain/report", domain: domain) { |json| json }
+      end
+    end
+  end
+end

data/lib/virustotal/clients/file.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  module Client
+    class File < Base
+      def report(resource, allinfo: nil)
+        params = { resource: resource, allinfo: allinfo }.compact
+        post("/file/report", params) { |json| json }
+      end
+
+      def scan(path)
+        name = ::File.basename(path)
+        data = ::File.read(path)
+        post_with_file("/file/scan", filename: name, file: data) { |json| json }
+      end
+
+      def rescan(resource)
+        post("/file/rescan", resource: resource) { |json| json }
+      end
+
+      def upload_url
+        get("/file/scan/upload_url") { |location| location }
+      end
+
+      def download(hash)
+        get("/file/download", hash: hash) { |raw| raw }
+      end
+
+      def behaviour(hash)
+        get("/file/behaviour", hash: hash) { |json| json }
+      end
+
+      def network_traffic(hash)
+        get("/file/network-traffic", hash: hash) { |json| json }
+      end
+
+      def clusters(date)
+        get("/file/clusters", date: date) { |json| json }
+      end
+
+      def search(query, offset: nil)
+        params = { query: query, offset: offset }.compact
+        get("/file/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/virustotal/clients/ip_address.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  module Client
+    class IPAddress < Base
+      def report(ip)
+        get("/ip-address/report", ip: ip) { |json| json }
+      end
+    end
+  end
+end

data/lib/virustotal/clients/url.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  module Client
+    class URL < Base
+      def report(resource, allinfo: nil)
+        params = { resource: resource, allinfo: allinfo }.compact
+        post("/url/report", params) { |json| json }
+      end
+
+      def scan(url)
+        post("/url/scan", url: url) { |json| json }
+      end
+    end
+  end
+end

data/lib/virustotal/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  class Error < StandardError; end
+  class RateLimitError < Error; end
+end

data/lib/virustotal/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  VERSION = "0.1.0"
+end

data/lib/virustotalx.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "virustotal"

data/virustotalx.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "virustotal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "virustotalx"
+  spec.version       = VirusTotal::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "Yet another VirusTotal API wrapper for Ruby"
+  spec.description   = "Yet another VirusTotal API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/virustotalx"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.5"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: virustotalx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Yet another VirusTotal API wrapper for Ruby
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/virustotal.rb
+- lib/virustotal/api.rb
+- lib/virustotal/clients/base.rb
+- lib/virustotal/clients/domain.rb
+- lib/virustotal/clients/file.rb
+- lib/virustotal/clients/ip_address.rb
+- lib/virustotal/clients/url.rb
+- lib/virustotal/errors.rb
+- lib/virustotal/version.rb
+- lib/virustotalx.rb
+- virustotalx.gemspec
+homepage: https://github.com/ninoseki/virustotalx
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Yet another VirusTotal API wrapper for Ruby
+test_files: []