iron_dome 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e36094bedecbd10da8dbb74e4c51854a62b5105aa637e9fc0f3d2b48f485889
-  data.tar.gz: 4674ab0f953f419fa732bea2020eae7e56eeda47a61239b228c2f1a05042e8bf
+  metadata.gz: 9c889cd53f074999e647537c26d7a3d8556a50e6275f0ff151e56a9d628b9707
+  data.tar.gz: 519d8c5edc3da20ca618e9f083d75e92c78fa5eac5942a78cc4bb6ab216b6d15
 SHA512:
-  metadata.gz: 6186fbb051c06b6ebefdf6524237d3dad64c901400fbcca03dc44db76f99c2401af8489e55a413a75028522ebd123b288693e0e5f89b9fea5defe5e1ccc47671
-  data.tar.gz: 404d543ebfca0805f5e92ca410840212abb3163af733d24d9de9408490cde2de6d2d1bba105020ac3e281dea381ad424a7cf4127c707052d58fbee176f706415
+  metadata.gz: 1f296bbadbe9c5a68564adcb25afc812695e4d4c538a16ef036e0d0dd356745348dd5639ad03fb18e338437ee85b2a17e028dc14ea82de8d7f8f18f78a20c9b4
+  data.tar.gz: 836b9813c0c3c24b07d8f22a6ffbceef01293c429e647d7974fafa50a64595dbeb4084ff9a174f26f829c47013cc34bdbb36155646549618a4784462c3a09f2e

data/README.md

@@ -14,10 +14,27 @@ this directory must have the Gemfile.lock, you can also run on a ci/cd pipeline.
 
     $ iron_dome
 
+### Theres some optional params you can use, like, -o or --output and -d or --detail
+
+This will generate a sarif file format.
+
+    $ iron_dome -o
+    $ iron_dome --output
+
+This will show details on the current shell session like the output example below.
+
+    $ iron_dome -d
+    $ iron_dome --detail
+
 ## Output Example
 
 ![alt text](image.png)
 
+## Supported language and lockfile format
+
+| Ruby      | Gemfile.lock    |
+|-----------|-----------------|
+
 ## 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.

data/lib/iron_dome/reader.rb

@@ -27,7 +27,7 @@ module IronDome
       puts "Verifying vulnerabilities on osv database ..."
       results = Requester.osv_request(packages_and_versions)
       results.compact!
-      system_output(results)
+      system_output(results) unless options[:sarif_output] == true
       output_sarif_file_format(results) if options[:sarif_output] == true
     end
 
@@ -35,13 +35,13 @@ module IronDome
       # method to call the module to generate the sarif report
       puts "Generating the sarif output ..."
       IronDome::Sarif::Output.new.output_report(results)
-      puts "Sarif file outputed"
+      puts "Sarif file outputted"
     end
 
     def system_output(results)
       # method to call module to output the results on current shell.
       if results.empty?
-        puts "No vulnerabiities founded".colorize(:green)
+        puts "No vulnerabilities founded".colorize(:green)
         return
       end
 
@@ -50,35 +50,35 @@ module IronDome
 
     def build_output(results)
       # Build the terminal output but maybe we will need to improve this methods.
-      total_vulns = 0
+      total_vulnerabilities = 0
 
-      puts ":: Vulnerabilities found:"
+      puts ":: Vulnerabilities found:".colorize(:red)
       results.each do |result|
-        result["vulns"].each do |vuln|
-          print_vulnerability_info(vuln)
-          total_vulns += 1
+        result["vulns"].each do |vulnerability|
+          print_vulnerability_info(vulnerability)
+          total_vulnerabilities += 1
         end
       end
 
-      puts "#{total_vulns} vulnerabilities founded.".colorize(:red)
+      puts "#{total_vulnerabilities} vulnerabilities founded.".colorize(:light_red)
     end
 
-    def print_vulnerability_info(vuln)
-      package_name = extract_package_name(vuln)
-      version_fixed = extract_version_fixed(vuln)
-      summary = vuln["summary"]
-      details = vuln["details"]
+    def print_vulnerability_info(vulnerabilities)
+      package_name = extract_package_name(vulnerabilities)
+      version_fixed = extract_version_fixed(vulnerabilities)
+      summary = vulnerabilities["summary"]
+      details = vulnerabilities["details"]
 
       print_info(package_name, version_fixed, summary, details)
     end
 
-    def extract_package_name(vuln)
-      affected_package = vuln["affected"].first
+    def extract_package_name(vulnerability)
+      affected_package = vulnerability["affected"].first
       affected_package["package"]["name"]
     end
 
-    def extract_version_fixed(vuln)
-      affected_package = vuln["affected"].first
+    def extract_version_fixed(vulnerability)
+      affected_package = vulnerability["affected"].first
       version_ranges = affected_package["ranges"].first
       version_ranges["events"].last["fixed"]
     end

data/lib/iron_dome/requester.rb

@@ -5,7 +5,7 @@ require "faraday"
 require "concurrent"
 
 module IronDome
-  # The requester class responsable to deal with osv database request and result.
+  # The requester class responsible to deal with osv database request and result.
   class Requester
     URL = "https://api.osv.dev/v1/query"
     FARADAY_OPTIONS = { headers: { "Content-Type" => "application/json" } }.freeze

data/lib/iron_dome/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IronDome
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/iron_dome.rb

@@ -16,7 +16,10 @@ module IronDome
 
   # class entry, this is the entrypoint of the gem.
   class Entry
+    # rubocop:disable Metrics/MethodLength
     def main
+      puts display_ascii_art
+
       options = {}
       OptionParser.new do |opts|
         opts.on("-o", "--output", "Generate a sarif format file report.") do |output|
@@ -30,5 +33,18 @@ module IronDome
 
       Reader.new(options).call
     end
+    # rubocop:enable Metrics/MethodLength
+
+    def display_ascii_art
+      <<-ART
+  ██╗██████╗  ██████╗ ███╗   ██╗██████╗  ██████╗ ███╗   ███╗███████╗
+  ██║██╔══██╗██╔═══██╗████╗  ██║██╔══██╗██╔═══██╗████╗ ████║██╔════╝
+  ██║██████╔╝██║   ██║██╔██╗ ██║██║  ██║██║   ██║██╔████╔██║█████╗
+  ██║██╔══██╗██║   ██║██║╚██╗██║██║  ██║██║   ██║██║╚██╔╝██║██╔══╝
+  ██║██║  ██║╚██████╔╝██║ ╚████║██████╔╝╚██████╔╝██║ ╚═╝ ██║███████╗
+  ╚═╝╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═══╝╚═════╝  ╚═════╝ ╚═╝     ╚═╝╚══════╝ v#{IronDome::VERSION}
+
+      ART
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iron_dome
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jose Augusto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -83,14 +83,12 @@ files:
 - Rakefile
 - exe/iron_dome
 - image.png
-- iron_dome.gemspec
 - lib/iron_dome.rb
 - lib/iron_dome/output.rb
 - lib/iron_dome/reader.rb
 - lib/iron_dome/requester.rb
 - lib/iron_dome/sarif/output.rb
 - lib/iron_dome/version.rb
-- sig/iron_dome.rbs
 homepage: https://github.com/JAugusto42/iron_dome
 licenses:
 - MIT
@@ -113,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A vulnerability scanner for ruby projects dependencies

data/iron_dome.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/iron_dome/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "iron_dome"
-  spec.version = IronDome::VERSION
-  spec.authors = ["Jose Augusto"]
-  spec.email = ["joseaugusto.881@outlook.com"]
-
-  spec.summary = "A vulnerability scanner for ruby projects dependencies"
-  spec.homepage = "https://github.com/JAugusto42/iron_dome"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/JAugusto42/iron_dome"
-  spec.metadata["changelog_uri"] = "https://github.com/JAugusto42/iron_dome/CHANGELOG.md"
-
-  spec.executables << "iron_dome"
-
-  # 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(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "colorize", "~> 1.1"
-  spec.add_dependency "concurrent-ruby", "~> 1.2"
-  spec.add_dependency "faraday", "~> 2.9"
-  spec.add_dependency "rake", "~> 13.0"
-end

data/sig/iron_dome.rbs

@@ -1,4 +0,0 @@
-module IronDome
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end