secchecker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c2afd56529d49c34ab552c83f2a95d4d595d13a50c9b73008665db6b6748c4ed
+  data.tar.gz: 64dde885c618b6a2789b26de29c15c814ee725db5ef9e3ffcc3e40319662ea1e
+SHA512:
+  metadata.gz: 61abdc873a30f5c750969b11f7d79fdffe0064121f5ac4d2620ec6373b30b21ae59ae04a28fe8c362defc99067e32913ac28a856f25fbb3fea49f0f1b4a0c057
+  data.tar.gz: 0f4f09e3d194fc890d87cc076afce7f94e9cbeb2779f3497bedbee3abbdb00296b8976a2a5852198145b9b050fa0ddc883887b4857e679d34eb75bc43ff298bd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/out/
+/vendor/
+.DS_Store
+

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

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 src@srcw.net. 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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in secchecker.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    secchecker (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  secchecker!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 src
+
+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,30 @@
+# Secchecker
+
+Check passwords and other sensitive information.
+
+## Installation
+
+
+```ruby
+gem 'secchecker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install secchecker
+
+## Usage
+
+    $ gsecchecker ~/myrepository
+
+## 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 Secchecker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/secchecker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "secchecker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/config/config.yml

@@ -0,0 +1,10 @@
+patterns:
+  - !ruby/regexp /[A-Z0-9]{20}/
+  - !ruby/regexp /(\"|')?(AWS|aws|Aws)?_?(SECRET|secret|Secret)?_?(ACCESS|access|Access)?_?(KEY|key|Key)(\"|')?\s*(:|=>|=)\s*(\"|')?[A-Za-z0-9\/\+=]{40}(\"|')?/
+  - !ruby/regexp /(\"|')?(AWS|aws|Aws)?_?(ACCOUNT|account|Account)_?(ID|id|Id)?(\"|')?\s*(:|=>|=)\s*(\"|')?[0-9]{4}\-?[0-9]{4}\-?[0-9]{4}(\"|')?/
+allowed:
+  - !ruby/regexp /AKIAIOSFODNN7EXAMPLE/
+  - !ruby/regexp /wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY/
+
+  
+  

data/data/aws_credentials.txt

@@ -0,0 +1,9 @@
+[default]
+#許可される
+aws_access_key = AKIAIOSFODNN7EXAMPLE
+#許可される
+aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
+
+
+
+

data/exe/secchecker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "secchecker"
+
+Secchecker::Command.run(ARGV)
+

data/lib/secchecker.rb

@@ -0,0 +1,181 @@
+require "secchecker/version"
+require "yaml"
+require "optparse"
+require 'find'
+require 'fileutils'
+
+module Secchecker
+  class Error < StandardError; end
+
+  class Config
+    def initialize(config)
+      @config = config
+      @patterns = config_value("patterns", false) || []
+      @allowed = config_value("allowed", false) || []
+    end
+    attr_reader :patterns, :allowed
+
+    def match_patterns(line)
+      begin
+        @patterns.each do |pat|
+          return pat if pat =~ line
+        end
+      rescue
+#        puts $!
+      end
+      nil
+    end
+
+    def match_allowed(line)
+      @allowed.each do |pat|
+        return pat if pat =~ line
+      end
+      nil
+    end
+
+    def unmatch_allowd(line)
+    end
+    
+    private
+    def config_value(key, require)
+      value = @config[key]
+      if require && (value.nil? || value.empty?)
+        raise RuntimeError, "{key}: is empty"
+      end
+      value
+    end
+  end
+
+  class MatchLine
+    def initialize(line, lineno, pattern)
+      @line = line
+      @lineno = lineno
+      @pattern = pattern
+    end
+    attr_reader :line, :lineno, :pattern
+  end
+  
+  class Command
+    def self.run(argv)
+      STDOUT.sync = true
+      opts = {}
+      opt = OptionParser.new(argv)
+      opt.version = VERSION
+      opt.banner = "Usage: #{opt.program_name} [-h|--help] <dir>"
+      opt.separator('')
+      opt.separator("Examples:")
+      opt.separator("    #{opt.program_name} ~/project")
+      opt.separator('')      
+      opt.separator("Options:")
+      opt.on_head('-h', '--help', 'Show this message') do |v|
+        puts opt.help
+        exit       
+      end
+      opt.on('-s SETTINGFILE', '--setting=SETTINGFILE', 'setting file') {|v| opts[:s] = v}
+#      commands = ['scan']
+#      opt.on('-c COMMAND', '--command=COMMAND', commands, commands.join('|')) {|v| opts[:c] = v}
+      opt.on('-v', '--verbose', 'verbose message') {|v| opts[:v] = v}
+      opt.on('--dry-run', 'message only') {|v| opts[:dry_run] = v}
+      opt.on('-a', '--all', 'check all files') {|v| opts[:a]}
+      opt.parse!(argv)
+
+      settings = opts[:s] || File.expand_path("~/.seccheckerrc")
+      unless FileTest.file?(settings)
+        puts opt.help
+        exit
+      end
+      config = Config.new(YAML.load_file(settings))
+      command = Command.new(opts, config)
+      dir = argv[0]
+      if dir.nil? || !FileTest.directory?(dir)
+        puts opt.help
+        exit        
+      end
+      command.run(dir)
+    end
+
+    def initialize(opts, config)
+      @opts = opts
+      @config = config
+    end
+
+   
+    def run(dir)
+      puts "secchecker #{dir}"
+      dir = File.expand_path(dir)
+      all_matchlines = []
+      Dir.chdir(dir) do
+        ls_files(dir) do |f|
+          matchlines = process_file(dir, f)
+          if matchlines.size > 0
+            all_matchlines << matchlines 
+          end
+        end
+      end
+      if all_matchlines.size > 0
+        puts ""
+        puts "[ERROR] Matched one or more prohibited patterns"
+        puts ""        
+      end
+    end
+
+    private
+    def git_repository?(dir)
+      repodir = File.join(dir, ".git")
+      puts repodir
+      FileTest.directory?(repodir)
+    end
+    
+    def ls_files(dir)
+      if git_repository?(dir) && !@opts[:a]
+        `git ls-files`.each_line do |f|
+          f.chomp!
+          yield f
+        end
+      else                        
+        Find.find('.') {|f|
+          yield f
+        }
+      end
+    end
+
+    def process_file(dir, f)
+      path = File.expand_path(File.join(dir, f))
+      return [] unless FileTest.file?(path)
+      if is_file_binary(path)
+        puts "skip binary file: #{path}" if @opts[:v]
+        return []
+      end
+      puts "#{path}" if @opts[:v]
+
+      
+      matchlines = check_pattern(f)
+      if matchlines.size > 0
+        matchlines.each do |ml|
+          puts "#{f}:#{ml.lineno}:#{ml.line}\##### #{ml.pattern} #####"
+        end
+      end       
+      matchlines
+    end
+
+    
+    def check_pattern(filename)
+#      puts filename
+      matchlines = []     
+      lines = IO.readlines(filename, mode: "r:utf-8")
+      lines.each_with_index do |line, index|
+        line.chomp!
+        pat = @config.match_patterns(line)
+        if pat  && !@config.match_allowed(line)
+          matchlines << MatchLine.new(line, index + 1, pat)
+        end
+      end
+      matchlines
+    end
+
+    def is_file_binary(file)
+      s = (File.read(file, File.stat(file).blksize) || "").split(//)
+      ((s.size - s.grep(" ".."~").size) / s.size.to_f) > 0.30      
+    end
+  end
+end

data/lib/secchecker/version.rb

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

data/secchecker.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/secchecker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "secchecker"
+  spec.version       = Secchecker::VERSION
+  spec.authors       = ["src"]
+  spec.email         = ["src@srcw.net"]
+
+  spec.summary       = %q{Check passwords and other sensitive information.}
+  spec.description   = %q{Check passwords and other sensitive information.}
+  spec.homepage      = "https://github.com/src256/secchecker"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/secchecker.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+bundle exec ruby exe/secchecker $*
+
+
+
+

data/test_config.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+bundle exec ruby exe/secchecker -s config/config.yml ./data
+
+
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: secchecker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- src
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-24 00:00:00.000000000 Z
+dependencies: []
+description: Check passwords and other sensitive information.
+email:
+- src@srcw.net
+executables:
+- secchecker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/config.yml
+- data/aws_credentials.txt
+- exe/secchecker
+- lib/secchecker.rb
+- lib/secchecker/version.rb
+- secchecker.gemspec
+- secchecker.sh
+- test_config.sh
+homepage: https://github.com/src256/secchecker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/src256/secchecker
+  source_code_uri: https://github.com/src256/secchecker
+  changelog_uri: https://github.com/src256/secchecker
+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: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Check passwords and other sensitive information.
+test_files: []