filecop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 424c8eb0af3e229e81d62aa09e9a6455723e8ff7
+  data.tar.gz: 4ce5d1e3a221866847a27ef2d8e37e346a6a2250
+SHA512:
+  metadata.gz: 22944c03a082c180c00a1ad555656fa60e59f57e55534f0dce1dbe7800b74d24b1fb91a994db07e55ae50f8077bc196ab598c75d5b48da6901fd93ad8950983c
+  data.tar.gz: 3017e1fe14f90ff1388c1423cf5523d240ab705a7c67562eba1fff68699cbecdb241a0b00fa036eb32958c72be82d78b9f44512c1d5bd9d25e3df9a335abe9f0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filecop.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tom Moor
+
+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,69 @@
+# Filecop
+
+Filecop is designed to find sensitive files in a provided list. Ideally this would be integrated into something like a git pre-commit hook or post commit check to reduce instances of leaked credentials.
+
+The base list of sensitive files is from [jandre/safe-commit-hook](https://github.com/jandre/safe-commit-hook/blob/master/git-deny-patterns.json) - I hope to add to this and contribute back over time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'filecop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filecop
+
+## Usage
+
+Using filecop is easy, pass no arguments to check all files in the current directory:
+
+    $ filecop
+
+or pass a list of individual files to check:
+
+    $ filecop private.key README.md .bashrc
+
+Output will look something like this:
+
+```
+Checking 3 files
+
+Issues:
+
+private.key: Potential cryptographic private key
+.bashrc: Shell configuration file
+
+3 files checked, 2 potential problems
+```
+
+Or pass the `--json` flag to get a machine parseable output
+
+```
+[
+  {"file": "private.key", "message": "Potential cryptographic private key"},
+  {"file": ".bashrc", "message": "Shell configuration file"}
+]
+```
+
+## 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/tommoor/filecop.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "filecop"
+
+# 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

data/bin/filecop

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'filecop'
+
+cli = Filecop::CLI.new
+exit cli.run

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/filecop.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filecop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "filecop"
+  spec.version       = Filecop::VERSION
+  spec.authors       = ["Tom Moor"]
+  spec.email         = ["tom.moor@gmail.com"]
+
+  spec.summary       = %q{Checks filenames against a library of rules to find sensitive files}
+  spec.homepage      = "https://github.com/tommoor/filecop"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/filecop.rb

@@ -0,0 +1,63 @@
+require "json"
+require "pathname"
+
+require "filecop/version"
+require "filecop/options"
+require "filecop/rule"
+
+module Filecop
+  class CLI
+
+    def run(args = ARGV)
+      @options, @paths = Options.parse!(args)
+      @paths = Dir.entries(".") if @paths.length==0
+
+      unless @options.json
+        puts "Checking #{@paths.length} files\n"
+      end
+
+      files = matching_files
+
+      if @options.json
+        puts JSON.generate files.map { |p| { file: p[:file], message: p[:rule].message } } 
+      else
+        if files.length>0
+          puts "\nIssues:\n\n"
+        end
+        puts files.map { |p| "#{p[:file]}: #{p[:rule].message}" } 
+        puts "\n"
+        puts "#{@paths.length} files checked, #{files.length} potential problems"
+      end
+
+      return files.length>0 ? 1 : 0
+    rescue StandardError, SyntaxError => e
+      $stderr.puts e.message
+      $stderr.puts e.backtrace
+      return 1
+    end
+
+    private
+
+    def matching_files
+      # load banned patterns from config file
+      patterns = JSON.parse File.read(File.join(File.dirname(__FILE__), 'patterns.json'))
+      rules = patterns.map { |o| Rule.new(o) }
+      output = []
+
+      @paths.each do |file|
+        rules.each do |rule|
+          if rule.matches?(file)
+            output << {
+              file: file,
+              rule: rule
+            }
+            break
+          end
+        end
+      end
+      
+      output
+    end
+    
+  end
+end

data/lib/filecop/options.rb

@@ -0,0 +1,27 @@
+require 'optparse'
+
+module Filecop
+  class Options
+    def self.parse!(args)
+      # The options specified on the command line will be collected here
+      options = OpenStruct.new
+      options.json = false
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: filecop [options] [file1, file2, ...]'
+
+        opts.on("-j", "--json", "Output as JSON") do |v|
+          options.json = true
+        end
+
+        opts.on_tail('--version', 'Show version') do
+          puts Filecop::VERSION
+          exit
+        end
+      end
+
+      opt_parser.parse!(args)
+      [options, args]
+    end
+  end
+end

data/lib/filecop/rule.rb

@@ -0,0 +1,33 @@
+module Filecop
+  class Rule
+    def initialize(options)
+      @part = options['part']
+      @type = options['type']
+      @pattern = options['pattern']
+      @caption = options['caption']
+      @description = options['description']
+    end
+  
+    def matches?(file)
+      parts = {
+        path: file,
+        filename: Pathname.new(file).basename,
+        extension: File.extname(file).delete('.')
+      }
+      to_check = parts[@part.to_sym].to_s
+    
+      if @type == 'regex'
+        reg = Regexp.new(@pattern, true)
+        reg.match(to_check)
+      else
+        to_check == @pattern
+      end
+    end
+  
+    def message
+      output = "#{@caption}."
+      output += " #{@description}" if @description
+      output
+    end
+  end
+end

data/lib/filecop/version.rb

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

data/lib/patterns.json

@@ -0,0 +1,408 @@
+[
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": ".*_rsa",
+    "caption": "Private SSH key",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": ".*_dsa",
+    "caption": "Private SSH key",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": ".*_ed25519",
+    "caption": "Private SSH key",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": ".*_ecdsa",
+    "caption": "Private SSH key",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "pem",
+    "caption": "Potential cryptographic private key",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "ppk",
+    "caption": "Potential cryptographic private key",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "regex",
+    "pattern": "key(pair)?",
+    "caption": "Potential cryptographic private key",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "pkcs12",
+    "caption": "Potential cryptographic key bundle",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "pfx",
+    "caption": "Potential cryptographic key bundle",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "p12",
+    "caption": "Potential cryptographic key bundle",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "asc",
+    "caption": "Potential cryptographic key bundle",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "otr.private_key",
+    "caption": "Pidgin OTR private key",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?(bash_|zsh_|z)?history",
+    "caption": "Shell command history file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?mysql_history",
+    "caption": "MySQL client command history file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?psql_history",
+    "caption": "PostgreSQL client command history file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?irb_history",
+    "caption": "Ruby IRB console history file",
+    "description": null
+  },
+  {
+    "part": "path",
+    "type": "regex",
+    "pattern": "\\.?purple\\/accounts\\.xml",
+    "caption": "Pidgin chat client account configuration file",
+    "description": null
+  },
+  {
+    "part": "path",
+    "type": "regex",
+    "pattern": "\\.?xchat2?\\/servlist_?\\.conf",
+    "caption": "Hexchat/XChat IRC client server list configuration file",
+    "description": null
+  },
+  {
+    "part": "path",
+    "type": "regex",
+    "pattern": "\\.?irssi\\/config",
+    "caption": "Irssi IRC client configuration file",
+    "description": null
+  },
+  {
+    "part": "path",
+    "type": "regex",
+    "pattern": "\\.?recon-ng\\/keys\\.db",
+    "caption": "Recon-ng web reconnaissance framework API key database",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?dbeaver-data-sources.xml",
+    "caption": "DBeaver SQL database manager configuration file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?muttrc",
+    "caption": "Mutt e-mail client configuration file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?s3cfg",
+    "caption": "S3cmd configuration file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?trc",
+    "caption": "T command-line Twitter client configuration file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "ovpn",
+    "caption": "OpenVPN client configuration file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?gitrobrc",
+    "caption": "Well, this is awkward... Gitrob configuration file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?(bash|zsh)rc",
+    "caption": "Shell configuration file",
+    "description": "Shell configuration files might contain information such as server hostnames, passwords and API keys."
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?(bash_|zsh_)?profile",
+    "caption": "Shell profile configuration file",
+    "description": "Shell configuration files might contain information such as server hostnames, passwords and API keys."
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?(bash_|zsh_)?aliases",
+    "caption": "Shell command alias configuration file",
+    "description": "Shell configuration files might contain information such as server hostnames, passwords and API keys."
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "secret_token.rb",
+    "caption": "Ruby On Rails secret token configuration file",
+    "description": "If the Rails secret token is known, it can allow for remote code execution. (http://www.exploit-db.com/exploits/27527/)"
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "omniauth.rb",
+    "caption": "OmniAuth configuration file",
+    "description": "The OmniAuth configuration file might contain client application secrets."
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "carrierwave.rb",
+    "caption": "Carrierwave configuration file",
+    "description": "Can contain credentials for online storage systems such as Amazon S3 and Google Storage."
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "schema.rb",
+    "caption": "Ruby On Rails database schema file",
+    "description": "Contains information on the database schema of a Ruby On Rails application."
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "database.yml",
+    "caption": "Potential Ruby On Rails database configuration file",
+    "description": "Might contain database credentials."
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "settings.py",
+    "caption": "Django configuration file",
+    "description": "Might contain database credentials, online storage system credentials, secret keys, etc."
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "(.*)?config(\\.inc)?\\.php",
+    "caption": "PHP configuration file",
+    "description": "Might contain credentials and keys."
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "kdb",
+    "caption": "KeePass password manager database file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "agilekeychain",
+    "caption": "1Password password manager database file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "keychain",
+    "caption": "Apple Keychain database file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "regex",
+    "pattern": "key(store|ring)",
+    "caption": "GNOME Keyring database file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "log",
+    "caption": "Log file",
+    "description": "Log files might contain information such as references to secret HTTP endpoints, session IDs, user information, passwords and API keys."
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "pcap",
+    "caption": "Network traffic capture file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "regex",
+    "pattern": "sql(dump)?",
+    "caption": "SQL dump file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "gnucash",
+    "caption": "GnuCash database file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "backup",
+    "caption": "Contains word: backup",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "dump",
+    "caption": "Contains word: dump",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "password",
+    "caption": "Contains word: password",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "private.*key",
+    "caption": "Contains words: private, key",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "jenkins.plugins.publish_over_ssh.BapSshPublisherPlugin.xml",
+    "caption": "Jenkins publish over SSH plugin file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "credentials.xml",
+    "caption": "Potential Jenkins credentials file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?htpasswd",
+    "caption": "Apache htpasswd file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": "\\.?netrc",
+    "caption": "Configuration file for auto-login process",
+    "description": "Might contain username and password."
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "kwallet",
+    "caption": "KDE Wallet Manager database file",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": "LocalSettings.php",
+    "caption": "Potential MediaWiki configuration file",
+    "description": null
+  },
+  {
+    "part": "extension",
+    "type": "match",
+    "pattern": "tblk",
+    "caption": "Tunnelblick VPN configuration file",
+    "description": null
+  },
+  {
+    "part": "path",
+    "type": "regex",
+    "pattern": "\\.?gem/credentials",
+    "caption": "Rubygems credentials file",
+    "description": "Might contain API key for a rubygems.org account."
+  },
+  {
+    "part": "filename",
+    "type": "regex",
+    "pattern": ".*\\.pubxml(\\.user)?",
+    "caption": "Potential MSBuild publish profile",
+    "description": null
+  },
+  {
+    "part": "filename",
+    "type": "match",
+    "pattern": ".env",
+    "caption": "dotenv",
+    "description": "Environment file that contains sensitive data"
+  }
+]

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: filecop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Moor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: 
+email:
+- tom.moor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/filecop
+- bin/setup
+- filecop.gemspec
+- lib/filecop.rb
+- lib/filecop/options.rb
+- lib/filecop/rule.rb
+- lib/filecop/version.rb
+- lib/patterns.json
+homepage: https://github.com/tommoor/filecop
+licenses:
+- MIT
+metadata: {}
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Checks filenames against a library of rules to find sensitive files
+test_files: []