bundler-audit 0.6.0 → 0.8.0.rc2

data/lib/bundler/audit/cli/thor_ext/shell/basic/say_error.rb

@@ -0,0 +1,33 @@
+class Thor
+  module Shell
+    class Basic
+      #
+      # Prints an error message to `stderr`.
+      #
+      # @param [String] message
+      #   The message to print to `stderr`.
+      #
+      # @param [Symbol, nil] color
+      #   Optional ANSI color.
+      #
+      # @param [Boolean] force_new_line
+      #   Controls whether a newline character will be appended to the output.
+      #
+      def say_error(message,color=nil,force_new_line=(message.to_s !~ /( |\t)\Z/))
+        return if quiet?
+
+        buffer = prepare_message(message,*color)
+        buffer << $/ if force_new_line && !message.to_s.end_with?($/)
+
+        stderr.print(buffer)
+        stderr.flush
+      end
+    end
+
+    module_eval <<-METHOD, __FILE__, __LINE__ + 1
+      def say_error(*args,&block)
+        shell.say_error(*args,&block)
+      end
+    METHOD
+  end
+end

data/lib/bundler/audit/configuration.rb

@@ -0,0 +1,105 @@
+#
+# 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.kind_of?(YAML::Nodes::Document)
+          raise(InvalidConfigurationError,"Configuration found in '#{file_path}' is not YAML")
+        end
+
+        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

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013-2016 Hal Brodigan (postmodern.mod3 at gmail.com)
+# 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
@@ -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,49 +72,160 @@ 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`) }
-          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
 
       #
       # Updates the ruby-advisory-db.
       #
-      # @param [Boolean, quiet]
+      # @param [Hash] options
+      #   Additional options.
+      #
+      # @option options [Boolean] :quiet
       #   Specify whether `git` should be `--quiet`.
       #
       # @return [Boolean, nil]
       #   Specifies whether the update was successful.
       #   A `nil` indicates no update was performed.
       #
+      # @raise [ArgumentError]
+      #   Invalid options were given.
+      #
       # @note
       #   Requires network access.
       #
       # @since 0.3.0
       #
+      # @deprecated Use {#update!} instead.
+      #
       def self.update!(options={})
         raise "Invalid option(s)" unless (options.keys - [:quiet]).empty?
-        if File.directory?(USER_PATH)
-          if File.directory?(File.join(USER_PATH, ".git"))
-            Dir.chdir(USER_PATH) do
-              command = %w(git pull)
-              command << '--quiet' if options[:quiet]
-              command << 'origin' << 'master'
-              system *command
+
+        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
+
+      #
+      # 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
 

data/lib/bundler/audit/report.rb

@@ -0,0 +1,149 @@
+require 'bundler/audit/results'
+require 'bundler/audit/version'
+
+require 'time'
+
+module Bundler
+  module Audit
+    #
+    # Represents the result of a scan.
+    #
+    class Report
+
+      include Enumerable
+
+      # The version of `bundler-audit` which created the report object.
+      #
+      # @return [String]
+      attr_reader :version
+
+      # The time when the report was generated.
+      #
+      # @return [Time]
+      attr_reader :created_at
+
+      # The list of all results.
+      #
+      # @return [Array<Results::Result>]
+      attr_reader :results
+
+      # The insecure sources results.
+      #
+      # @return [Array<Results::InsecureSources>]
+      attr_reader :insecure_sources
+
+      # The unpatched gems results.
+      #
+      # @return [Array<Results::UnpatchedGems>]
+      attr_reader :unpatched_gems
+
+      #
+      # Initializes the report.
+      #
+      # @param [#each] results
+      #
+      def initialize(results=[])
+        @version    = VERSION
+        @created_at = Time.now
+
+        @results = []
+        @insecure_sources = []
+        @unpatched_gems = []
+
+        results.each { |result| self << result }
+      end
+
+      #
+      # Enumerates over the results.
+      #
+      # @yield [result]
+      #
+      # @yieldparam [Results::InsecureSource, Results::UnpatchedGem] result
+      #
+      # @return [Enumerator]
+      #
+      def each(&block)
+        @results.each(&block)
+      end
+
+      #
+      # Appends a result to the report.
+      #
+      # @param [InsecureSource, UnpatchedGem] result
+      #
+      def <<(result)
+        @results << result
+
+        case result
+        when Results::InsecureSource
+          @insecure_sources << result
+        when Results::UnpatchedGem
+          @unpatched_gems << result
+        end
+
+        return self
+      end
+
+      #
+      # Determines if there were vulnerabilities found.
+      #
+      # @return [Boolean]
+      #
+      def vulnerable?
+        !@results.empty?
+      end
+
+      #
+      # @yield [advisory]
+      #
+      # @yieldparam [Advisory] advisory
+      #
+      # @return [Enumerator]
+      #
+      def each_advisory
+        return enum_for(__method__) unless block_given?
+
+        @unpatched_gems.each { |result| yield result.advisory }
+      end
+
+      #
+      # @return [Array<Advisory>]
+      #
+      def advisories
+        @unpatched_gems.map(&:advisory)
+      end
+
+      #
+      # @yield [gem]
+      #
+      # @yieldparam [Gem::Specification]
+      #
+      # @return [Enumerator]
+      #
+      def each_vulnerable_gem
+        return enum_for(__method__) unless block_given?
+
+        @unpatched_gems.each { |result| yield result.gem }
+      end
+
+      #
+      # @return [Array<Gem::Specification>]
+      #
+      def vulnerable_gems
+        @unpatched_gems.map(&:gem)
+      end
+
+      #
+      # @return [Hash{Symbol => Object}]
+      #
+      def to_h
+        {
+          version:    @version,
+          created_at: @created_at,
+          results:    @results.map(&:to_h)
+        }
+      end
+
+    end
+  end
+end