danger-brakeman_scanner 0.1.0.pre.preview

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fbfd5ee304ec4be6876f559fb554b741853f21e176c25295fea97708a036388
+  data.tar.gz: 2194c26064a82df51f6743ec568b9ec529b858b93be8814052ca29a469eedb1f
+SHA512:
+  metadata.gz: 88df0e5755614f0b06dcb03842dbc6d881ba5cdb596ac34f88b3479e28620897529c38cfb34d1cf99fda9feace4afc41fcf5dae8c179fe8eb4b9913cda1b46f4
+  data.tar.gz: 0b299aa41039120ccd1d92ef925a5034756b44b08c54ce07168784a1dfd04fa9abb3c495bab2208bc723a12dd1517af194314b67c5f21c2ad507ed3d1a823df9

data/.circleci/config.yml

@@ -0,0 +1,38 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6
+        environment:
+          - BUNDLE_JOBS: 4
+          - BUNDLE_RETRY: 3
+          - BUNDLE_PATH: vendor/bundle
+    steps:
+      - checkout
+      - run:
+          name: Configuring Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(tail -1 Gemfile.lock | xargs)' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler -v $BUNDLER_VERSION
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ arch }}-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-{{ arch }}-
+      - run:
+          name: Install dependencies
+          command: |
+            bundle check || bundle install --jobs=4 --retry=3
+      - save_cache:
+          key: v1-dependencies-{{ arch }}-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run tests
+          command: make

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/.rubocop-*
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Override Klaxit remote Rubocop config
+# See https://github.com/klaxit/ruby/rubocop.yml
+inherit_from:
+  - https://git.io/klaxit-rubocop
+
+
+AllCops:
+  Exclude:
+    - "spec/**/*"
+    - "vendor/**/*"

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@klaxit.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# See danger-brakeman_scanner.gemspec.
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    danger-brakeman_scanner (0.1.0.pre.preview)
+      brakeman
+      danger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    brakeman (4.8.0)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (6.3.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.6)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    diff-lcs (1.3)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    git (1.6.0)
+      rchardet (~> 1.8)
+    jaro_winkler (1.5.4)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    no_proxy_fix (0.1.2)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rchardet (1.8.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.6.1)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  danger-brakeman_scanner!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  yard
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present Klaxit SAS
+
+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/Makefile

@@ -0,0 +1,16 @@
+BE = bundle exec
+
+.PHONY: default
+default: test rubocop docs
+
+.PHONY: test
+test:
+	$(BE) rspec
+
+.PHONY: rubocop
+rubocop:
+	$(BE) rubocop
+
+.PHONY: docs
+docs:
+	$(BE) danger plugins lint

data/README.md

@@ -0,0 +1,93 @@
+# Danger Brakeman Plugin [![CircleCI](https://circleci.com/gh/klaxit/danger-brakeman_scanner.svg?style=svg)](https://circleci.com/gh/klaxit/danger-brakeman_scanner)
+
+A [Danger] plugin for [Brakeman] security static analysis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "danger-brakeman_scanner"
+```
+
+## Usage
+
+Run Ruby files through Brakeman. A markdown table will be shown as result.
+
+```ruby
+brakeman.run("my_app_path")
+```
+
+You can pass a list of options as well, thoses will be given as-is to brakeman
+scanner.
+
+```ruby
+brakeman.run(app_path: "my_app_path", github_repo: "klaxit/fast-polylines")
+```
+
+The list of all options is available below, but not that some of those won't make sense here:
+
+<details>
+<summary>
+https://github.com/presidentbeef/brakeman/blob/1eef0997f2a8a01f885d3f4908447ab20bfd0b7d/lib/brakeman.rb#L32-L67
+</summary>
+
+- `:app_path` - path to root of Rails app (required)
+- `:additional_checks_path` - array of additional directories containing additional out-of-tree checks to run
+- `:additional_libs_path` - array of additional application relative lib directories (ex. app/mailers) to process
+- `:assume_all_routes` - assume all methods are routes (default: true)
+- `:check_arguments` - check arguments of methods (default: true)
+- `:collapse_mass_assignment` - report unprotected models in single warning (default: false)
+- `:combine_locations` - combine warning locations (default: true)
+- `:config_file` - configuration file
+- `:escape_html` - escape HTML by default (automatic)
+- `:exit_on_error` - only affects Commandline module (default: true)
+- `:exit_on_warn` - only affects Commandline module (default: true)
+- `:github_repo` - github repo to use for file links (user/repo[/path][@ref])
+- `:highlight_user_input` - highlight user input in reported warnings (default: true)
+- `:html_style` - path to CSS file
+- `:ignore_model_output` - consider models safe (default: false)
+- `:index_libs` - add libraries to call index (default: true)
+- `:interprocedural` - limited interprocedural processing of method calls (default: false)
+- `:message_limit` - limit length of messages
+- `:min_confidence` - minimum confidence (0-2, 0 is highest)
+- `:output_files` - files for output
+- `:output_formats` - formats for output (:to_s, :to_tabs, :to_csv, :to_html)
+- `:parallel_checks` - run checks in parallel (default: true)
+- `:parser_timeout` - set timeout for parsing an individual file (default: 10 seconds)
+- `:print_report` - if no output file specified, print to stdout (default: false)
+- `:quiet` - suppress most messages (default: true)
+- `:rails3` - force Rails 3 mode (automatic)
+- `:rails4` - force Rails 4 mode (automatic)
+- `:rails5` - force Rails 5 mode (automatic)
+- `:rails6` - force Rails 6 mode (automatic)
+- `:report_routes` - show found routes on controllers (default: false)
+- `:run_checks` - array of checks to run (run all if not specified)
+- `:safe_methods` - array of methods to consider safe
+- `:skip_libs` - do not process lib/ directory (default: false)
+- `:skip_checks` - checks not to run (run all if not specified)
+- `:absolute_paths` - show absolute path of each file (default: false)
+- `:summary_only` - only output summary section of report for plain/table (:summary_only, :no_summary, true)
+
+</details>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `make` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/klaxit/danger-brakeman_scanner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct].
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Danger::Brakeman project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct].
+
+[code of conduct]: https://github.com/klaxit/danger-brakeman_scanner/blob/master/CODE_OF_CONDUCT.md
+[brakeman]: https://brakemanscanner.org/
+[danger]: https://danger.systems/ruby/

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+require "brakeman"
+
+# Print methods of an object with some filtering.
+def m(instance)
+  noizy_methods = Object.instance_methods + Object.methods + Enumerable.methods
+  puts((instance.methods - noizy_methods).sort)
+end
+
+# A safe app to run Brakeman through
+#
+# @example
+#   Brakeman.run(safe_rails_app_path)
+def safe_rails_app_path
+  File.expand_path("../spec/fixtures/safe_rails_app", __dir__)
+end
+
+# A dangerous app to run Brakeman through
+#
+# @example
+#   Brakeman.run(dangerous_rails_app_path)
+def dangerous_rails_app_path
+  File.expand_path("../spec/fixtures/dangerous_rails_app", __dir__)
+end
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/danger-brakeman_scanner.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "danger-brakeman_scanner"
+  spec.version = DangerBrakemanScanner::VERSION
+  spec.authors = ["Ulysse Buonomo"]
+  spec.email = ["dev@klaxit.com"]
+
+  github_url = "https://github.com/klaxit/#{spec.name}"
+
+  spec.summary = "A Danger plugin for running Ruby files through Brakeman."
+  spec.homepage = github_url
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = github_url
+  spec.metadata["changelog_uri"] = "#{github_url}/blob/master/CHANGELOG.md"
+
+  # 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 { |file| file.match(%r(^spec/)) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r(^exe/), &File.method(:basename))
+  spec.require_paths = ["lib"]
+
+  # Main dependencies
+  spec.add_dependency "brakeman"
+  spec.add_dependency "danger"
+
+  # Testing support
+  spec.add_development_dependency "rspec"
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require "pry"
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency "pry"
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Run ruby files through Brakeman
+#
+# @example Run with default configuration in application directory
+#
+#   brakeman.run
+#
+# @see https://github.com/presidentbeef/brakeman
+# @tags brakeman, security, ruby
+class Danger::DangerBrakeman < Danger::Plugin
+  require "brakeman"
+
+  # Run a Brakeman scan over current application.
+  #
+  # @param options (see {Brakeman.run})
+  # @return [void]
+  def run(options = File.dirname(Kernel.caller_locations.first.absolute_path))
+    tracker = Brakeman.run(options)
+    return if tracker.warnings.empty? && tracker.errors.empty?
+
+    markdown tracker.report.to_markdown
+    failure "Brakeman static analysis detected issues in the code. " \
+            "If this is a false positive, [mark it as such]" \
+            "(https://brakemanscanner.org/docs/ignoring_false_positives/)."
+  end
+end

data/lib/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: danger-brakeman_scanner
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.preview
+platform: ruby
+authors:
+- Ulysse Buonomo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- dev@klaxit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
+- bin/console
+- bin/setup
+- danger-brakeman_scanner.gemspec
+- lib/danger_plugin.rb
+- lib/version.rb
+homepage: https://github.com/klaxit/danger-brakeman_scanner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/klaxit/danger-brakeman_scanner
+  source_code_uri: https://github.com/klaxit/danger-brakeman_scanner
+  changelog_uri: https://github.com/klaxit/danger-brakeman_scanner/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.0.pre3
+signing_key: 
+specification_version: 4
+summary: A Danger plugin for running Ruby files through Brakeman.
+test_files: []