bundler-audit 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c98968f6509b0551b595706cc23591bf2741626a472dcccda17e107c2e7788d0
-  data.tar.gz: 61c7ea8687934092a74aca4f0358e2565ce9eec53fe0713198bd1eadd5e2ae31
+  metadata.gz: 762980c9b274b19e477ee0be0ae021e452a1e7d63796ceb6da0d667de704dad9
+  data.tar.gz: 3e0fae808a027e677f3d218949c092d8189fc124bb34f61b57fdf982b5ffd6b1
 SHA512:
-  metadata.gz: 3a10a9071b08c8781c33db982d9d72929c63c2ec3ce69839cf93186bcd47775e8483fe397cf9b05363f13c785757f9b7cb3dfef2bced8085f9913c38553d6714
-  data.tar.gz: 4789e6c07340509b1e08218b6f9b2e16fcc40f24f42476ca92fe530171b2035bab209984b324783bf387758c9262d3fce724ceb0f76cdc0e78c967109112431d
+  metadata.gz: faa37304223ab40fd5678b6a4fcc1f9edb6d112c418c3a80a38aff6dbfbfacd416481f32f402998ece370d4646fe416e8f9453a5cec98d634845ff7bfd1abc6f
+  data.tar.gz: 7fbd39c761fdee364266207e4f0b52be6347b480b8447d31688428b8d3b5337c7f7403142ef0b2da0bc293ddfbe1ea5df93750b3a70be3920eff37af1d6a7884

data/.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,44 @@
+---
+name: Bug Report
+about: Report a bug
+title: ''
+labels: bug
+assignees: ''
+
+---
+<!--
+**Double Check**
+
+- Did you update to the latest bundler-audit? (ex: `bundle update bundler-audit` or `gem update bundler-audit`)
+- Did you update the ruby-advisory-db? (ex: `bundler-audit update`)
+-->
+
+## Description
+
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps To Reproduce
+
+Steps to reproduce the bug:
+1. `$ bundle-audit ...`
+2. ???
+
+## Expected Behavior
+
+<!-- What should happen. -->
+
+## Actual Behavior
+
+<!-- The error message or backtrace. -->
+```
+```
+
+## Environment
+
+    $ bundler-audit --version
+    ...
+    $ bundle --version
+    ...
+    $ ruby --version
+    ...
+

data/.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,14 @@
+---
+name: Feature Request
+about: Request a new Feature
+title: ''
+labels: feature
+assignees: ''
+
+---
+
+## Description
+
+<!-- Explain how the desired feature would work. -->
+<!-- Explain why the desired feature is needed. -->
+<!-- Explain who would use the desired feature. -->

data/.github/workflows/ruby.yml

@@ -9,11 +9,11 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.4
           - 2.5
           - 2.6
           - 2.7
-          - 3.0
+          - '3.0'
+          - 3.1
           - jruby
           - truffleruby-head
     name: Ruby ${{ matrix.ruby }}
@@ -27,3 +27,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -0,0 +1,86 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'spec/bundle/**/*'
+    - 'spec/fixtures/database/**/*'
+    - 'vendor/**/*'
+
+#
+# Style
+#
+Layout/FirstArrayElementIndentation: { EnforcedStyle: consistent }
+Layout/FirstHashElementIndentation: { EnforcedStyle: consistent }
+Layout/SpaceAroundEqualsInParameterDefault: { EnforcedStyle: no_space }
+Style/SymbolArray: { EnforcedStyle: brackets }
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: '{}'
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+# 
+# Rules that conflict with my style.
+#
+Metrics: { Enabled: false }
+Layout/BeginEndAlignment: { Enabled: false } # Offense count: 1
+Layout/BlockAlignment: { Enabled: false } # Offense count: 1
+Layout/EmptyLinesAroundClassBody: { Enabled: false } # Offense count: 15
+Layout/ExtraSpacing: { Enabled: false } # Offense count: 9
+Layout/HashAlignment: { Enabled: false  } # Offense count: 3
+Layout/SpaceAfterComma: { Enabled: false } # Offense count: 122
+Layout/SpaceInsideHashLiteralBraces: { Enabled: false } # Offense count: 8
+Lint/MissingSuper: { Enabled: false } # Offense count: 3
+Lint/ShadowingOuterLocalVariable: { Enabled: false }
+Lint/ConstantDefinitionInBlock: { Exclude: ['spec/cli/formats_spec.rb'] }
+Lint/SuppressedException: { Exclude: ['spec/cli_spec.rb'] }
+Lint/UnusedBlockArgument: { Enabled: false } # Offense count: 4
+Lint/UnusedMethodArgument: { Enabled: false } # Offense count: 6
+Naming/RescuedExceptionsVariableName: { Enabled: false } # Offense count: 2
+Style/BlockDelimiters: { Enabled: false } # Offense count: 20
+Style/CaseEquality: { Exclude: ['lib/bundler/audit/advisory.rb'] }
+Style/ClassCheck: { Enabled: false } # Offense count: 4
+Style/Documentation: { Enabled: false } # Offense count: 12
+Style/GuardClause: { Enabled: false } # Offense count: 1
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/bundler/audit/task.rb'
+Style/IfUnlessModifier: { Enabled: false } # Offense count: 14
+Style/MethodCallWithoutArgsParentheses: { Enabled: false } # Offense count: 1
+Style/MultilineBlockChain: { Exclude: ['spec/**/*'] } # Offense count: 6
+Style/MutableConstant: { Enabled: false } # Offense count: 4
+Style/ParenthesesAroundCondition: { Enabled: false } # Offense count: 1
+Style/RedundantBegin: { Exclude: ['spec/cli_spec.rb'] } # Offense count: 1
+Style/RedundantReturn: { Enabled: false } # Offense count: 6
+Style/SpecialGlobalVars: { Enabled: false } # Offense count: 5
+Style/StringLiterals: { Enabled: false } # Offense count: 333
+Style/StructInheritance: { Enabled: false } # Offense count: 1
+Style/UnlessElse: { Enabled: false } # Offense count: 1
+Style/WordArray: { Enabled: false } # Offense count: 1
+Style/Lambda: { Enabled: false } # Offense count: 2
+Style/SafeNavigation: { Enabled: false } # Offense count: 2
+Lint/IneffectiveAccessModifier: { Enabled: false } # Offense count: 1
+Gemspec/DuplicatedAssignment:
+  Exclude:
+    - 'bundler-audit.gemspec'
+
+#
+# Rules that may be disabled in the future.
+#
+# Layout/SpaceInsideParens: { Enabled: false }
+# Layout/TrailingWhitespace: { Enabled: false }
+
+#
+# Rules that I want to fully enabled in the future.
+#
+Style/DoubleNegation: { Exclude: ['spec/spec_helper.rb'] } # Offense count: 1
+Style/EmptyMethod: { Exclude: ['spec/cli/formats_spec.rb'] } # Offense count: 2
+Style/ExpandPathArguments: { Enabled: false } # Offense count: 5
+Style/FrozenStringLiteralComment: { Enabled: false } # Offense count: 42
+Style/MixinUsage: { Exclude: ['spec/spec_helper.rb'] } # Offense count: 1
+Layout/LineLength: { Enabled: false }

data/COPYING.txt

@@ -1,7 +1,7 @@
                     GNU GENERAL PUBLIC LICENSE
                        Version 3, 29 June 2007
 
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
   You should also get your employer (if you work as a programmer) or school,
 if any, to sign a "copyright disclaimer" for the program, if necessary.
 For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
+<https://www.gnu.org/licenses/>.
 
   The GNU General Public License does not permit incorporating your program
 into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/philosophy/why-not-lgpl.html>.

data/ChangeLog.md

@@ -1,3 +1,54 @@
+### 0.9.1 / 2022-05-19
+
+#### CLI
+
+* Improve the readability of the suggested gem versions to upgrade to
+  (pull #331).
+
+#### Rake Task
+
+* Fixed a regression introduced in 0.9.0 where the `bundler:audit` rake task
+  was not exiting with an error status code if vulnerabilities were found.
+  Now when the `bundler-audit` command fails, the rake task will also exit with
+  the `bundler-audit` command's error code.
+* If the `bundler-audit` command could not be found for some reason raise the
+  {Bundler::Audit::Task::CommandNotFound} exception.
+
+### 0.9.0.1 / 2021-08-31
+
+* Add a workaround for Psych < 3.1.0 to support running on Ruby < 2.6.
+  (issue #319)
+  * Although, Ruby 2.5 and prior have all reached [End-of-Life] and
+  are no longer receiving security updates. It is strongly advised that you
+  should upgrade to a currently supported version of Ruby.
+
+[End-of-Life]: https://www.ruby-lang.org/en/downloads/branches/
+
+### 0.9.0 / 2021-08-31
+
+* Load advisory metadata using `YAML.safe_load`. (issue #302)
+  * Explicitly permit the `Date` class for Psych >= 4.0.0 and Ruby >= 3.1.0.
+* Added {Bundler::Audit::Advisory#to_h}. (pull #310)
+* Added {Bundler::Audit::Database#commit_id}.
+
+#### CLI
+
+* Added the `--config` option. (pull #306)
+* Added the `junit` output format (ex: `--format junit`). (pull #314)
+* Add missing output for CVSSv3 criticality information. (pull #302)
+  * Include criticality information in the JSON output as well. (pull #310)
+* `bundle-audit stats` now prints the commit ID of the ruby-advisory-db.
+* Fixed a deprecation warning from Thor. (issue #317)
+
+#### Rake Task
+
+* Add the `bundle:audit:update` task for updating the [ruby-advisory-db].
+  (pull #296)
+* Aliased `bundle:audit` to `bundle:audit:check`.
+* Aliased `bundler:audit:*` to `bundle:audit:*`.
+* Rake tasks now execute `bundle-audit` command as a subprocess to ensure
+  isolation.
+
 ### 0.8.0 / 2021-03-10
 
 * No longer vendor [ruby-advisory-db].

data/Gemfile

@@ -4,10 +4,15 @@ gemspec
 
 group :development do
   gem 'rake'
-  gem 'kramdown',       '~> 2.0'
-
   gem 'rubygems-tasks', '~> 0.2'
+
+  gem 'rubocop',        '~> 1.18'
+
   gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.7', require: false
+
+  gem 'kramdown',       '~> 2.0'
+  gem 'redcarpet',       platform: :mri
   gem 'yard',           '~> 0.9'
-  gem 'simplecov',      '~> 0.7', :require => false
+  gem 'yard-spellcheck', require: false
 end

data/README.md

@@ -1,6 +1,8 @@
 # bundler-audit
+
 [![CI](https://github.com/rubysec/bundler-audit/actions/workflows/ruby.yml/badge.svg)](https://github.com/rubysec/bundler-audit/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/rubysec/bundler-audit.svg)](https://codeclimate.com/github/rubysec/bundler-audit)
+[![Gem Version](https://badge.fury.io/rb/bundler-audit.svg)](https://badge.fury.io/rb/bundler-audit)
 
 * [Homepage](https://github.com/rubysec/bundler-audit#readme)
 * [Issues](https://github.com/rubysec/bundler-audit/issues)
@@ -13,7 +15,7 @@ Patch-level verification for [bundler].
 ## Features
 
 * Checks for vulnerable versions of gems in `Gemfile.lock`.
-* Checks for insecure gem sources (`http://`).
+* Checks for insecure gem sources (`http://` and `git://`).
 * Allows ignoring certain advisories that have been manually worked around.
 * Prints advisory information.
 * Does not require a network connection.
@@ -109,35 +111,48 @@ Update the [ruby-advisory-db] that `bundle audit` uses:
 
 Update the [ruby-advisory-db] and check `Gemfile.lock` (useful for CI runs):
 
-    $ bundle-audit check --update
+```shell
+$ bundle-audit check --update
+```
 
 Checking the `Gemfile.lock` without updating the [ruby-advisory-db]:
 
-    $ bundle-audit check --no-update
+```shell
+$ bundle-audit check --no-update
+```
 
 Ignore specific advisories:
 
-    $ bundle-audit check --ignore OSVDB-108664
+```shell
+$ bundle-audit check --ignore OSVDB-108664
+```
 
 Checking a custom `Gemfile.lock` file:
 
-    $ bundle-audit check --gemfile Gemfile.custom.lock
+```shell
+$ bundle-audit check --gemfile-lock Gemfile.custom.lock
+```
 
 Output the audit's results in JSON:
 
-    $ bundle-audit check --format json
+```shell
+$ bundle-audit check --format json
+```
 
 Output the audit's results in JSON, to a file:
 
-    $ bundle-audit check --format json --output bundle-audit.json
+```shell
+$ bundle-audit check --format json --output bundle-audit.json
+```
 
-Rake task:
+## Rake Tasks
 
-```ruby
-require 'bundler/audit/task'
-Bundler::Audit::Task.new
+Bundler-audit provides Rake tasks for checking the code and for updating
+its vulnerability database:
 
-task default: 'bundle:audit'
+```bash
+rake bundle:audit
+rake bundle:audit:update
 ```
 
 ## Configuration File
@@ -146,13 +161,21 @@ bundler-audit also supports a per-project configuration file:
 
 `.bundler-audit.yml`:
 
-    ---
-    ignore:
-      - CVE-YYYY-XXXX
-      - ...
+```yaml
+---
+ignore:
+  - CVE-YYYY-XXXX
+  - ...
+```
 
 * `ignore:` \[Array\<String\>\] - A list of advisory IDs to ignore.
 
+You can provide a path to a config file using the `--config` flag:
+
+```shell
+$ bundle-audit check --config bundler-audit.custom.yaml
+```
+
 ## Requirements
 
 * [git]
@@ -163,32 +186,42 @@ bundler-audit also supports a per-project configuration file:
 
 ## Install
 
-    $ [sudo] gem install bundler-audit
+```shell
+$ [sudo] gem install bundler-audit
+```
 
 ### Git
 
 * Debian / Ubuntu:
 
-      $ sudo apt install git
+```shell
+$ sudo apt install git
+```
 
 * RedHat / Fedora:
 
-      $ sudo dnf install git
+```shell
+$ sudo dnf install git
+```
 
 * Alpine Linux:
 
-      $ apk add git
+```shell
+$ apk add git
+```
 
 * macOS:
 
-      $ brew install git
+```shell
+$ brew install git
+```
 
 ## Contributing
 
 1. https://github.com/rubysec/bundler-audit/fork
 2. `git clone YOUR_FORK_URI`
 3. `cd bundler-audit/`
-4. `budle install`
+4. `bundle install`
 5. `bundle exec rake spec`
 6. `git checkout -b YOUR_FEATURE`
 7. Make your changes
@@ -198,7 +231,7 @@ bundler-audit also supports a per-project configuration file:
 
 ## License
 
-Copyright (c) 2013-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+Copyright (c) 2013-2022 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
@@ -211,14 +244,13 @@ 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/>.
+along with bundler-audit.  If not, see <https://www.gnu.org/licenses/>.
 
 [git]: https://git-scm.com
 [ruby]: https://ruby-lang.org
 [rubygems]: https://rubygems.org
 [thor]: http://whatisthor.com/
-[bundler]: https://github.com/carlhuda/bundler#readme
-[git]: https://github.com/git/git
+[bundler]: https://bundler.io
 
 [OSVDB]: http://osvdb.org/
 [ruby-advisory-db]: https://github.com/rubysec/ruby-advisory-db

data/Rakefile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rubygems'
 
 begin
@@ -36,5 +34,11 @@ task :test    => :spec
 task :default => :spec
 
 require 'yard'
-YARD::Rake::YardocTask.new  
+YARD::Rake::YardocTask.new
 task :doc => :yard
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new

data/bundler-audit.gemspec

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'yaml'
 
 Gem::Specification.new do |gem|
@@ -32,7 +30,7 @@ Gem::Specification.new do |gem|
   gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
 
   gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
-  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.test_files       = glob[gemspec['test_files'] || 'spec/{**/}*_spec.rb']
   gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
   gem.require_paths = Array(gemspec.fetch('require_paths') {
@@ -57,4 +55,5 @@ Gem::Specification.new do |gem|
       gem.add_development_dependency(name,split[versions])
     end
   end
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/gemspec.yml

@@ -6,6 +6,13 @@ authors: Postmodern
 email: postmodern.mod3@gmail.com
 homepage: https://github.com/rubysec/bundler-audit#readme
 
+metadata:
+  documentation_uri: https://rubydoc.info/gems/bundler-audit
+  source_code_uri:   https://github.com/rubysec/bundler-audit.rb
+  bug_tracker_uri:   https://github.com/rubysec/bundler-audit.rb/issues
+  changelog_uri:     https://github.com/rubysec/bundler-audit.rb/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
 required_ruby_version: ">= 2.0.0"
 required_rubygems_version: ">= 1.8.0"
 

data/lib/bundler/audit/advisory.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2013-2022 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
@@ -12,13 +12,17 @@
 # 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/>.
+# along with bundler-audit.  If not, see <https://www.gnu.org/licenses/>.
 #
 
+require 'date'
 require 'yaml'
 
 module Bundler
   module Audit
+    #
+    # Represents an advisory loaded from the {Database}.
+    #
     class Advisory < Struct.new(:path,
                                 :id,
                                 :url,
@@ -45,7 +49,14 @@ module Bundler
       #
       def self.load(path)
         id   = File.basename(path).chomp('.yml')
-        data = YAML.load_file(path)
+        data = File.open(path) do |yaml|
+                 if Psych::VERSION >= '3.1.0'
+                   YAML.safe_load(yaml, permitted_classes: [Date])
+                 else
+                   # XXX: psych < 3.1.0 YAML.safe_load calling convention
+                   YAML.safe_load(yaml, [Date])
+                 end
+               end
 
         unless data.kind_of?(Hash)
           raise("advisory data in #{path.dump} was not a Hash")
@@ -200,6 +211,17 @@ module Bundler
         id == other.id
       end
 
+      #
+      # Converts the advisory to a Hash.
+      #
+      # @return [Hash{Symbol => Object}]
+      #
+      def to_h
+        super.merge({
+          criticality: criticality
+        })
+      end
+
       alias to_s id
 
     end

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

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2013-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2013-2022 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
@@ -12,7 +12,7 @@
 # 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/>.
+# along with bundler-audit.  If not, see <https://www.gnu.org/licenses/>.
 #
 
 require 'thor'
@@ -22,6 +22,9 @@ module Bundler
   module Audit
     class CLI < ::Thor
       module Formats
+        #
+        # The JSON output format.
+        #
         module JSON
           #
           # Outputs the report as JSON. Will pretty-print JSON if `output`
@@ -37,11 +40,22 @@ module Bundler
             hash = report.to_h
 
             if output.tty?
-              output.puts ::JSON.pretty_generate(hash)
+              output.puts(::JSON.pretty_generate(hash))
             else
               output.write(::JSON.generate(hash))
             end
           end
+
+          def criticality_label(advisory)
+            case advisory.criticality
+            when :none     then "none"
+            when :low      then "low"
+            when :medium   then "medium"
+            when :high     then "high"
+            when :critical then "critical"
+            else "unknown"
+            end
+          end
         end
 
         Formats.register :json, JSON