sanctify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cde83032c8a8588fc9770cd52aac67cc1d2b7500
+  data.tar.gz: 4ba14ad8564b2fa57fe112854156f1677f6c74d1
+SHA512:
+  metadata.gz: 9841359dfce42c32d930f83b75918be7d28592618535d07b07d8457514186bf4fa76cc0faf60ccedf9156484ecc94c49e04440ee185e6ca64043fd5a2bb02fba
+  data.tar.gz: 05a50c70ae9ca53472cbaeb0349b34faaf2f42f3132338bd2010ba130916334ba8683a6b0382a58e2e1c797ecdf9fbd003e488f8829c22c9f26bfa99ffb5c49b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

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 jrcanty@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sanctify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    sanctify (0.1.0)
+      git
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    git (1.3.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sanctify!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryan Canty
+
+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/README.md

@@ -0,0 +1,53 @@
+# Sanctify
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sanctify`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem install 'sanctify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanctify
+
+## Usage
+
+Run sanctify as part of the pre-commit hook, which will make sure to find and deny secrets before commit and PR. You can use the [precommit hook project](http://pre-commit.com/) to easily integrate this script with your repo.
+
+Sancitfy has very simple usage:
+
+```
+Usage: sanctify [-r REPO_PATH] [-c CONFIG_PATH]
+    -r, --repo REPO                  Repo to test
+    -c, --config CONFIG              Configuration file in YAML
+    -h, --help                       Prints this help
+```
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sanctify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) 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 Sanctify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sanctify/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/bin/sh
+# Run a Ruby REPL.
+
+cd $(dirname "$0")/..
+PRY_PATH=$(which pry)
+
+if [ -x $PRY_PATH ]
+then
+  exec bundle exec $PRY_PATH -Ilib -r sanctify -r sanctify/console
+else
+  red='\e[0;31m'
+  endColor='\e[0m'
+  echo -e "${red}Pry was not found or not executable. Make sure `which pry` returns an exacutable.${endColor}"
+fi

data/bin/sanctify

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'sanctify'
+Sanctify::CLI.run(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sanctify/cli.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require 'optparse'
+module Sanctify
+  class CliError < StandardError; end
+  class CLI
+    def self.run(argv)
+      args = {}
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: sanctify [-r REPO_PATH] [-c CONFIG_PATH]"
+
+        opts.on("-r REPO", "--repo REPO", "Repo to test") do |repo|
+          args[:repo] = repo
+        end
+
+        opts.on("-c CONFIG", "--config CONFIG", "Configuration file in YAML") do |config|
+          args[:config] = YAML.load(File.open(config))
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end
+
+      opt_parser.parse!(argv)
+      if args[:repo].nil?
+        if Dir['.git'].empty?
+          raise Sanctify::CliError, "Repo not specified and current directory not a git repository."
+        else
+          args[:repo] = Dir.pwd
+        end
+      end
+      Scanner.new(args).run
+    end
+  end
+end

data/lib/sanctify/console.rb

@@ -0,0 +1,6 @@
+require 'pry'
+Pry.config.prompt = lambda do |context, nesting, pry|
+  "[sanctify] #{context}> "
+end
+
+### Add extra console config here

data/lib/sanctify/matcher_list.rb

@@ -0,0 +1,68 @@
+module Sanctify
+  class ParserError < StandardError; end
+  class MatcherList
+    def initialize
+      @matchers = DEFAULT_MATCHERS
+    end
+
+    def add(desc:, regex:)
+      if desc.length.zero?
+        raise ParserError, "Description must exist and be greater length than zero"
+      end
+
+      unless regex.is_a? Regexp
+        raise ParserError, "Regex must be of type Regexp"
+      end
+
+      @matchers << { description: desc, regex: regex }
+      @matchers
+    end
+
+    def each(&blk)
+      @matchers.each &blk
+    end
+
+    DEFAULT_MATCHERS = [
+      {
+        description: "AWS Access Key ID",
+        regex: /AKIA[0-9A-Z]{16}/
+      },
+      {
+        description: "AWS Secret Key",
+        regex: /\b[\w\/&?=-@#$%\\^+]{40}\b/
+      },
+      {
+        description: "Redis URL with Password",
+        regex: /redis:\/\/[0-9a-zA-Z:@.\\-]+/
+      },
+      {
+        description: "URL Basic auth",
+        regex: /https?:\/\/[0-9a-zA-z_]+?:[0-9a-zA-z_]+?@.+?/
+      },
+      {
+        description:"Google Access Token",
+        regex: /ya29.[0-9a-zA-Z_\\-]{68}/
+      },
+      {
+        description: "Google API",
+        regex: /AIzaSy[0-9a-zA-Z_\\-]{33}/
+      },
+      {
+        description: "Slack API",
+        regex: /xoxp-\\d+-\\d+-\\d+-[0-9a-f]+/
+      },
+      {
+        description: "Slack Bot",
+        regex: /xoxb-\\d+-[0-9a-zA-Z]+/
+      },
+      {
+        description: "Gem Fury v1",
+        regex: /https?:\/\/[0-9a-zA-Z]+@[a-z]+\\.(gemfury.com|fury.io)(\/[a-z]+)?/
+      },
+      {
+        description: "Gem Fury v2",
+        regex: /https?:\/\/[a-z]+\\.(gemfury.com|fury.io)\/[0-9a-zA-Z]{20}/
+      }
+    ]
+  end
+end

data/lib/sanctify/repo.rb

@@ -0,0 +1,51 @@
+require 'git'
+
+module Sanctify
+  class Repo
+    attr_reader :path, :git, :ignored_paths
+    def initialize(path, ignored_paths = [])
+      @path = path
+      @git = Git.open(path)
+      @ignored_paths = ignored_paths
+    end
+
+    def diff(from = 'HEAD', to = nil)
+      # The diff processing is only done in the each method
+      # so we'll call this method as a singleton so we don't accidentally
+      # do this more than once per instance of the repo.
+      #
+      # NOTE: We expect this bydefault to be executed in a pre-commit hook
+      # but we may want to extend it to work with a static git repo as well.
+      @diff ||= git.diff(from, to).each.to_a
+    end
+
+    def added_lines
+      [].tap do |lines|
+        diff.each do |f|
+          next if f.type == 'deleted'
+          next if should_ignore? f.path
+          f.patch.split("\n").each do |line|
+            # don't include leading '+'
+            lines << [line[1..-1], f.path] if added_line? line
+          end
+        end
+      end
+    end
+
+    private
+
+    def should_ignore?(path)
+      # Add pattern matching for filenames so users can ignore files that
+      # they know contain secrets that they have accepted as false positive.
+      return false if ignored_paths.empty?
+      ignored_paths.each do |regex|
+        return true if regex.match(path)
+      end
+      false
+    end
+
+    def added_line?(line)
+      line.start_with?('+') && !line.start_with?('+++')
+    end
+  end
+end

data/lib/sanctify/scanner.rb

@@ -0,0 +1,45 @@
+require 'sanctify/matcher_list'
+require 'sanctify/repo'
+
+module Sanctify
+  class ScannerError < StandardError; end
+  class Scanner
+    attr_reader :config, :repo, :matcher_list
+    def initialize(args)
+      @config = args[:config] || {}
+      @repo = Repo.new(args[:repo], ignored_paths)
+      @matcher_list = MatcherList.new
+    end
+
+    def run
+      initialize_custom_matchers!
+      repo.added_lines.each do |line, path|
+        matcher_list.each do |matcher|
+          if matcher[:regex].match(line)
+            raise ScannerError, "[ERROR] SECRET FOUND (#{matcher[:description]}): #{line} : #{path}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def ignored_paths
+      patterns = config['ignored_paths'] || []
+      patterns.map { |patt| Regexp.new patt }
+    end
+
+    def initialize_custom_matchers!
+      custom_matchers = config['custom_matchers'] || []
+      if custom_matchers.any?
+        custom_matchers.each do |cust|
+          if cust['description'] && cust['regex']
+            matcher_list.add(desc: cust['description'], regex: Regexp.new(cust['regex']))
+          else
+            raise ScannerError, "Improperly configured custom matcher: #{cust}. Must include 'description' and 'regex'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sanctify/version.rb

@@ -0,0 +1,3 @@
+module Sanctify
+  VERSION = "0.1.0"
+end

data/lib/sanctify.rb

@@ -0,0 +1,9 @@
+require "sanctify/version"
+require "sanctify/cli"
+require "sanctify/matcher_list"
+require "sanctify/repo"
+require "sanctify/scanner"
+
+
+module Sanctify
+end

data/sanctify.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sanctify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sanctify"
+  spec.version       = Sanctify::VERSION
+  spec.authors       = ["Ryan Canty"]
+  spec.email         = ["jrcanty@gmail.com"]
+
+  spec.summary       = %q{Let's you know about all the potential keys you're about to push in a Git commit}
+  spec.description   = %q{Let's you know about all the potential keys you're about to push in a Git commit}
+  spec.homepage      = "https://github.com/onetwopunch/sanctify"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org/'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency "git"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: sanctify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Canty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+- !ruby/object:Gem::Dependency
+  name: git
+  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'
+description: Let's you know about all the potential keys you're about to push in a
+  Git commit
+email:
+- jrcanty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/sanctify
+- bin/setup
+- lib/sanctify.rb
+- lib/sanctify/cli.rb
+- lib/sanctify/console.rb
+- lib/sanctify/matcher_list.rb
+- lib/sanctify/repo.rb
+- lib/sanctify/scanner.rb
+- lib/sanctify/version.rb
+- sanctify.gemspec
+homepage: https://github.com/onetwopunch/sanctify
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Let's you know about all the potential keys you're about to push in a Git
+  commit
+test_files: []