bundler-audit 0.7.0.1 → 0.8.0.rc1

data/lib/bundler/audit/cli/formats.rb

@@ -0,0 +1,144 @@
+#
+# Copyright (c) 2013-2020 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# bundler-audit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bundler-audit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bundler-audit.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'thor'
+
+module Bundler
+  module Audit
+    class CLI < ::Thor
+      #
+      # {Bundler::Audit::CLI} supports outputting it's audit results as
+      # {Bundler::Audit::CLI::Formats::Text text} or
+      # {Bundler::Audit::CLI::Formats::JSON JSON}, by default.
+      #
+      # ## API
+      #
+      # {Bundler::Audit::CLI} formats are really just modules defined under
+      # {Bundler::Audit::CLI::Formats}, that define a `#print_report` entry
+      # method. When the `#print_report` method is called it will be passed a
+      # {Bundler::Audit::Report report} object and an optional `output`
+      # stream, which may be either `$stdout` or a `File` object.
+      #
+      # {Bundler::Audit::CLI} will load a format by first calling
+      # {Formats.load}, which attempts to require the
+      # `bundler/audit/cli/formats/#{format}.rb` file, then gets the registered
+      # format module using {Formats.[]}.
+      # If the format module has been successfully loaded, it will be extended
+      # into the {Bundler::Audit::CLI} instance method access to
+      # {Bundler::Audit::CLI}'s instance methods.
+      #
+      # ## Custom Formats
+      #
+      # To define a custom format, it...
+      #
+      # * MUST be defined in a file in a
+      # `lib/bundler/audit/cli/formats/` directory.
+      # * MUST define a `print_report(report,output=$stdout)` instance method.
+      # * MUST register themselves by calling {Formats.register} at the end
+      #   of the file.
+      #
+      # ### Example
+      #
+      #     # lib/bundler/audit/cli/formats/my_format.rb
+      #     module Bundler
+      #       module Audit
+      #         class CLI < ::Thor
+      #           module Formats
+      #             module MyFormat
+      #               def print_report(report,output=$stdout)
+      #                 # ...
+      #               end
+      #             end
+      #
+      #             Formats.register :my_format, MyFormat
+      #           end
+      #         end
+      #       end
+      #     end
+      #
+      module Formats
+        class FormatNotFound < RuntimeError
+        end
+
+        # Directory where format modules are loaded from.
+        DIR = 'bundler/audit/cli/formats'
+
+        @registry = {}
+
+        #
+        # Registers a format with the given format name.
+        #
+        # @param [Symbol, String] name
+        #
+        # @param [Module#print_results] format
+        #   The format object.
+        #
+        # @raise [NotImplementedError]
+        #   The format object does not respond to `#call`.
+        #
+        # @api public
+        #
+        def self.register(name,format)
+          unless format.instance_methods.include?(:print_report)
+            raise(NotImplementedError,"#{format.inspect} does not define #print_report")
+          end
+
+          @registry[name.to_sym] = format
+        end
+
+        #
+        # Retrieves the format by name.
+        #
+        # @param [String, Symbol] name
+        #
+        # @return [Module#print_results, nil]
+        #   The format registered with the given name or `nil`.
+        #
+        def self.[](name)
+          @registry[name.to_sym]
+        end
+
+        #
+        # Loads the format with the given name by attempting to require
+        # `bundler/audit/cli/formats/#{name}` and returning the registered
+        # format using {[]}.
+        #
+        # @param [#to_s] name
+        #
+        # @return [Module#print_results]
+        #
+        # @raise [FormatNotFound]
+        #   No format exists with that given name.
+        #
+        def self.load(name)
+          name = name.to_s
+
+          begin
+            require File.join(DIR,File.basename(name))
+          rescue LoadError
+            raise(FormatNotFound,"could not load format #{name.inspect}")
+          end
+
+          return self[name] || \
+            raise(FormatNotFound,"unknown format #{name.inspect}")
+        end
+      end
+    end
+  end
+end
+
+require 'bundler/audit/cli/formats/text'

data/lib/bundler/audit/cli/formats/json.rb

@@ -0,0 +1,51 @@
+#
+# Copyright (c) 2013-2020 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# bundler-audit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bundler-audit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bundler-audit.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'thor'
+require 'json'
+
+module Bundler
+  module Audit
+    class CLI < ::Thor
+      module Formats
+        module JSON
+          #
+          # Outputs the report as JSON. Will pretty-print JSON if `output`
+          # is a TTY, otherwise normal JSON will be outputted.
+          #
+          # @param [Report] report
+          #   The results from the {Scanner}.
+          #
+          # @param [IO, File] output
+          #   The output stream.
+          #
+          def print_report(report,output=$stdout)
+            hash = report.to_h
+
+            if output.tty?
+              output.puts ::JSON.pretty_generate(hash)
+            else
+              output.write(::JSON.generate(hash))
+            end
+          end
+        end
+
+        Formats.register :json, JSON
+      end
+    end
+  end
+end

data/lib/bundler/audit/cli/formats/text.rb

@@ -0,0 +1,116 @@
+#
+# Copyright (c) 2013-2020 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# bundler-audit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bundler-audit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bundler-audit.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'thor'
+
+module Bundler
+  module Audit
+    class CLI < ::Thor
+      module Formats
+        module Text
+          #
+          # Prints any findings as plain-text.
+          #
+          # @param [Report] report
+          #   The results from the {Scanner}.
+          #
+          # @param [IO, File] output
+          #   Optional output stream.
+          #
+          def print_report(report,output=$stdout)
+            original_stdout = $stdout
+            $stdout = output
+
+            report.each do |result|
+              case result
+              when Results::InsecureSource
+                print_warning "Insecure Source URI found: #{result.source}"
+              when Results::UnpatchedGem
+                print_advisory result.gem, result.advisory
+              end
+            end
+
+            if report.vulnerable?
+              say "Vulnerabilities found!", :red
+            else
+              say("No vulnerabilities found", :green) unless options.quiet?
+            end
+
+            $stdout = original_stdout
+          end
+
+          private
+
+          def print_warning(message)
+            say message, :yellow
+          end
+
+          def print_advisory(gem, advisory)
+            say "Name: ", :red
+            say gem.name
+
+            say "Version: ", :red
+            say gem.version
+
+            say "Advisory: ", :red
+
+            if advisory.cve
+              say "CVE-#{advisory.cve}"
+            elsif advisory.osvdb
+              say advisory.osvdb
+            end
+
+            say "Criticality: ", :red
+            case advisory.criticality
+            when :low    then say "Low"
+            when :medium then say "Medium", :yellow
+            when :high   then say "High", [:red, :bold]
+            else              say "Unknown"
+            end
+
+            say "URL: ", :red
+            say advisory.url
+
+            if options.verbose?
+              say "Description:", :red
+              say
+
+              print_wrapped advisory.description, :indent => 2
+              say
+            else
+              say "Title: ", :red
+              say advisory.title
+            end
+
+            unless advisory.patched_versions.empty?
+              say "Solution: upgrade to ", :red
+              say advisory.patched_versions.join(', ')
+            else
+              say "Solution: ", :red
+              say "remove or disable this gem until a patch is available!", [:red, :bold]
+            end
+
+            say
+          end
+
+        end
+
+        Formats.register :text, Text
+      end
+    end
+  end
+end

data/lib/bundler/audit/configuration.rb

@@ -0,0 +1,101 @@
+#
+# Copyright (c) 2013-2020 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# bundler-audit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# bundler-audit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with bundler-audit.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'yaml'
+require 'set'
+
+module Bundler
+  module Audit
+    #
+    # Class for storing and validating configuration for running the auditor.
+    #
+    # @since 0.8.0
+    #
+    class Configuration
+      class InvalidConfigurationError < StandardError; end
+      class FileNotFound < StandardError; end
+
+      #
+      # A constructor method for loading configuration from a YAML file.
+      #
+      # @param [String] file_path
+      #   Path to the yaml file holding the configuration.
+      #
+      # @raise [FileNotFound]
+      #   Will raise a file not found error when the path to the
+      #   configuration YAML file does not exist.
+      #
+      # @raise [InvalidConfigurationError]
+      #   Will raise an invalid configuration error indicating what in the
+      #   YAML file is invalid for the configuration.
+      #
+      # @return [Configuration]
+      #   A Configuration object containing the config hash loaded from the
+      #   file passed.
+      #
+      def self.load(file_path)
+        raise(FileNotFound,"Configuration file '#{file_path}' does not exist") unless File.exist?(file_path)
+
+        doc = YAML.parse(File.new(file_path))
+
+        unless doc.root.kind_of?(YAML::Nodes::Mapping)
+          raise(InvalidConfigurationError,"Configuration found in '#{file_path}' is not a Hash")
+        end
+
+        config = {}
+
+        doc.root.children.each_slice(2) do |key,value|
+          case key.value
+          when 'ignore'
+            unless value.is_a?(YAML::Nodes::Sequence)
+              raise(InvalidConfigurationError,"'ignore' key found in config file, but is not an Array")
+            end
+
+            unless value.children.all? { |node| node.is_a?(YAML::Nodes::Scalar) }
+              raise(InvalidConfigurationError,"'ignore' array in config file contains a non-String")
+            end
+
+            config[:ignore] = value.children.map(&:value)
+          end
+        end
+
+        new(config)
+      end
+
+      #
+      # The list of advisory IDs to ignore.
+      #
+      # @return [Set<String>]
+      #
+      attr_reader :ignore
+
+      #
+      # Initializes the configuration.
+      #
+      # @param [Hash] config
+      #   The configuration hash.
+      #
+      # @option config [Array<String>] :ignore
+      #   The list of advisory IDs to ignore.
+      #
+      def initialize(config={})
+        @ignore = Set.new(config[:ignore])
+      end
+
+    end
+  end
+end

data/lib/bundler/audit/database.rb

@@ -28,17 +28,22 @@ module Bundler
     #
     class Database
 
-      # Git URL of the ruby-advisory-db
-      URL = 'https://github.com/rubysec/ruby-advisory-db.git'
+      class DownloadFailed < RuntimeError
+      end
 
-      # Default path to the ruby-advisory-db
-      VENDORED_PATH =  File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','data','ruby-advisory-db'))
+      class UpdateFailed < RuntimeError
+      end
 
-      # Timestamp for when the database was last updated
-      VENDORED_TIMESTAMP = Time.parse(File.read("#{VENDORED_PATH}.ts")).utc
+      # Git URL of the ruby-advisory-db
+      URL = 'https://github.com/rubysec/ruby-advisory-db.git'
 
       # Path to the user's copy of the ruby-advisory-db
-      USER_PATH = File.expand_path(File.join(ENV['HOME'],'.local','share','ruby-advisory-db'))
+      USER_PATH = File.expand_path(File.join(Gem.user_home,'.local','share','ruby-advisory-db'))
+
+      # Default path to the ruby-advisory-db
+      #
+      # @since 0.8.0
+      DEFAULT_PATH = ENV['BUNDLER_AUDIT_DB'] || USER_PATH
 
       # The path to the advisory database
       attr_reader :path
@@ -67,16 +72,62 @@ module Bundler
       #   The path to the database directory.
       #
       def self.path
-        if File.directory?(USER_PATH)
-          t1 = Dir.chdir(USER_PATH) { Time.parse(`git log --date=iso8601 --pretty="%cd" -1`).utc }
-          t2 = VENDORED_TIMESTAMP
+        DEFAULT_PATH
+      end
 
-          if t1 >= t2 then USER_PATH
-          else             VENDORED_PATH
-          end
-        else
-          VENDORED_PATH
+      #
+      # Tests whether the database exists.
+      #
+      # @param [String] path
+      #   The given path of the database to check.
+      #
+      # @return [Boolean]
+      # 
+      # @since 0.8.0
+      #
+      def self.exists?(path=DEFAULT_PATH)
+        File.directory?(path) && !(Dir.entries(path) - %w[. ..]).empty?
+      end
+
+      #
+      # Downloads the ruby-advisory-db.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [String] :path (DEFAULT_PATH)
+      #   The destination path for the new ruby-advisory-db.
+      #
+      # @option options [Boolean] :quiet
+      #   Specify whether `git` should be `--quiet`.
+      #
+      # @return [Dataase]
+      #   The newly downloaded database.
+      #
+      # @raise [DownloadFailed]
+      #   Indicates that the download failed.
+      #
+      # @note
+      #   Requires network access.
+      #
+      # @since 0.8.0
+      #
+      def self.download(options={})
+        unless (options.keys - [:path, :quiet]).empty?
+          raise(ArgumentError,"Invalid option(s)")
         end
+
+        path = options.fetch(:path,DEFAULT_PATH)
+
+        command = %w(git clone)
+        command << '--quiet' if options[:quiet]
+        command << URL << path
+
+        unless system(*command)
+          raise(DownloadFailed,"failed to download #{URL} to #{path.inspect}")
+        end
+
+        return new(path)
       end
 
       #
@@ -100,25 +151,81 @@ module Bundler
       #
       # @since 0.3.0
       #
+      # @deprecated Use {#update!} instead.
+      #
       def self.update!(options={})
-        unless (options.keys - [:quiet]).empty?
-          raise(ArgumentError,"Invalid option(s)")
+        raise "Invalid option(s)" unless (options.keys - [:quiet]).empty?
+
+        if File.directory?(DEFAULT_PATH)
+          begin
+            new(DEFAULT_PATH).update!(options)
+          rescue UpdateFailed then false
+          end
+        else
+          begin
+            download(options.merge(path: DEFAULT_PATH))
+          rescue DownloadFailed then false
+          end
         end
+      end
 
-        if File.directory?(USER_PATH)
-          if File.directory?(File.join(USER_PATH, ".git"))
-            Dir.chdir(USER_PATH) do
-              command = %w(git pull --no-rebase)
-              command << '--quiet' if options[:quiet]
-              command << 'origin' << 'master'
-              system *command
+      #
+      # Determines if the database is a git repository.
+      #
+      # @return [Boolean]
+      #
+      # @since 0.8.0
+      #
+      def git?
+        File.directory?(File.join(@path,'.git'))
+      end
+
+      #
+      # Updates the ruby-advisory-db.
+      #
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Boolean] :quiet
+      #   Specify whether `git` should be `--quiet`.
+      #
+      # @return [true, nil]
+      #   `true` indicates that the update was successful.
+      #   `nil` indicates the database is not a git repository, thus not
+      #   capable of being updated.
+      #
+      # @since 0.8.0
+      #
+      def update!(options={})
+        if git?
+          Dir.chdir(@path) do
+            command = %w(git pull)
+            command << '--quiet' if options[:quiet]
+            command << 'origin' << 'master'
+
+            unless system(*command)
+              raise(UpdateFailed,"failed to update #{@path.inspect}")
             end
+
+            return true
+          end
+        end
+      end
+
+      #
+      # Determines the time when the database was last updated.
+      #
+      # @return [Time]
+      #
+      # @since 0.8.0
+      #
+      def last_updated_at
+        if git?
+          Dir.chdir(@path) do
+            Time.parse(`git log --date=iso8601 --pretty="%cd" -1`)
           end
         else
-          command = %w(git clone)
-          command << '--quiet' if options[:quiet]
-          command << URL << USER_PATH
-          system *command
+          File.mtime(@path)
         end
       end