githack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d580c81976aa556c3c84fd93c7394a473dd08d11
+  data.tar.gz: 768611bf8d2d7bcd8b71c34fb4d2624c4e9b20f2
+SHA512:
+  metadata.gz: e9f21fb4bc6e718d7e52d08c9c53044bea0d67c2369492226fd74bdb38f0a30bc2b76a8c243911abbe168a9369637fab7e3f1b0c8d67fb1aefc4dde9e6b70308
+  data.tar.gz: e8b34e95ca079a6dbc8aa8a90f56adb63e32e6f170e0a6a5e820f4e6c371f3734599fb67059308226515e46a7b8ee3f84d238795e09bc87e21309ebc53c8e21a

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.4.1
+before_install: gem install bundler -v 1.16.1

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 contact@rousseau-alexandre.Fr. 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 githack.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    githack (0.1.0)
+      git (~> 1.5)
+      tty-spinner (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    git (1.5.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    tty-cursor (0.6.0)
+    tty-spinner (0.8.0)
+      tty-cursor (>= 0.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  githack!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,86 @@
+# Githack
+
+Crawl [Git][git]'s commits of a given repository to find forgotten credentials
+
+Currently support:
+
+- [Ruby on Rails](https://rubyonrails.org)
+
+  - _config/secrets.yml_
+  - _config/database.yml_
+
+## Dependencies
+
+You need to install [Git][git]. Exemple for Debian based distributions:
+
+```bash
+$ sudo apt install git
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'githack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install githack
+
+## Usage
+
+### As library
+
+Simply use tis to clone the remote repository in your temporary folder
+
+```ruby
+require 'githack'
+
+repository = Repository.new 'https://github.com/RaspberryCook/website'
+```
+
+And then you can search on repository like this:
+
+```ruby
+repository.search_rails_config_database
+# [{"adapter"=>"mysql2", "database"=>"raspberry_cook", "encoding"=>"utf8", "username"=>"raspberry_cook", "password"=>"secret", "host"=>"localhost", "pool"=>5, "timeout"=>5000}])
+
+repository.search_rails_config_secrets
+# [{"development"=>{"marmiton_password"=>"20462046"}, "production"=>{"marmiton_password"=>"20462046"}, "test"=>{"marmiton_password"=>"20462046"}}])
+```
+
+Theses methods will:
+
+1. Search all commit were file changed
+2. Checkout on theses commit to get file content
+3. Filter only usefull informations
+
+### As command line tool
+
+Simply use
+
+```bash
+$ githack.rb https://github.com/RaspberryCook/website
+```
+
+## 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]/githack. 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.
+
+## Code of Conduct
+
+Everyone interacting in the Githack project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/githack/blob/master/CODE_OF_CONDUCT.md).
+
+[git]: https://git-scm.com/

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 "githack"
+
+# 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/githack.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+require 'githack'
+require 'optparse'
+require 'tty-spinner'
+require 'pp'
+
+url = nil
+
+options = {
+  skip_config_secrets: false,
+  skip_config_database: false
+}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: githack.rb URL with URL as remote URL of a Git repository (currently works only for Rails project)'
+
+  url = ARGV.pop
+
+  opts.on '--skip_config_secrets', 'Not search for config/secrets.yml' do |_o|
+    options[:skip_config_secrets] = true
+  end
+
+  opts.on '--skip_config_database', 'Not search for config/database.yml' do |_o|
+    options[:skip_config_secrets] = true
+  end
+
+  unless url
+    puts "You must provide a Git remote URL\r\n\r\n"
+    puts opts
+    exit
+  end
+end.parse!
+
+spinner = TTY::Spinner.new '[:spinner] Cloning repository ...'
+spinner.auto_spin
+repository = Repository.new url
+spinner.stop('Done!')
+
+unless options[:skip_config_database]
+  spinner = TTY::Spinner.new '[:spinner] Search in config/database.yml (Rails) ...'
+  spinner.auto_spin
+  result = repository.search_rails_config_database
+  spinner.stop('Done!')
+  pp result
+end
+
+unless options[:skip_config_secrets]
+  spinner = TTY::Spinner.new '[:spinner] Search in config/secrets.yml (Rails) ...'
+  spinner.auto_spin
+  result = repository.search_rails_config_secrets
+  spinner.stop('Done!')
+  pp result
+end

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

@@ -0,0 +1,38 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'githack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'githack'
+  spec.version       = Githack::VERSION
+  spec.authors       = ['Rousseau Alexandre']
+  spec.email         = ['contact@rousseau-alexandre.Fr']
+
+  spec.summary       = "Crawl git's commits of a given repository to find forgotten credentials"
+  spec.description   = "Crawl git's commits of a given repository to find forgotten credentials"
+  spec.homepage      = 'https://github.com/madeindjs/githack'
+
+  # 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        = 'bin'
+  spec.executables   = ['githack.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'git', '~> 1.5'
+  spec.add_dependency 'tty-spinner', '~> 0.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/githack.rb

@@ -0,0 +1,6 @@
+require "githack/version"
+require "githack/repository"
+
+module Githack
+  # Your code goes here...
+end

data/lib/githack/repository.rb

@@ -0,0 +1,87 @@
+require 'tmpdir'
+require 'yaml'
+require 'git'
+
+class Repository
+  SENSIBLES_FILES = [
+    File.join('config', 'database.yml')
+  ].freeze
+
+  attr_reader :git, :remote, :name, :path
+
+  def initialize(remote)
+    @remote = remote
+    @name = remote.gsub /[^0-9A-Z]/i, '_'
+    @path = File.join(Dir.tmpdir, name)
+
+    @git = if File.directory? @path
+             Git.open @path
+           else
+             Git.clone @remote, @name, path: Dir.tmpdir
+           end
+  end
+
+  # Get all changements for config/secrets.yml file (who contains some API keys)
+  def search_rails_config_secrets
+    results = []
+
+    absolute_file_path = File.join @path, 'config', 'secrets.yml'
+
+    checkout_on_yaml_file_change(absolute_file_path) do |secrets|
+      results << secrets
+    end
+
+    results.uniq
+  end
+
+  # Get all changements for config/database.yml file (who contains database configuration for Ruby on Rails Framework)
+  def search_rails_config_database
+    results = []
+
+    absolute_file_path = File.join @path, 'config', 'database.yml'
+
+    checkout_on_yaml_file_change(absolute_file_path) do |configs|
+      configs.each do |config|
+        config_data = config[1]
+        next if config_data['adapter'] == 'sqlite3'
+        results << config_data
+      end
+    end
+
+    results.uniq
+  end
+
+  # Checkout on all file changes
+  #
+  # @param file <String> absolute filepath
+  # @yield <Hash> YAML file parsed
+  def checkout_on_yaml_file_change(file)
+    checkout_on_file_change(file) do
+      begin
+        data = YAML.safe_load(File.read(file))
+        yield data
+      rescue Psych::SyntaxError => e
+        # can't parse YAML file
+      end
+    end
+  end
+
+  # Checkout on all file changes
+  #
+  # @param file <String> absolute filepath
+  # @yield <Git::Log>
+  def checkout_on_file_change(file)
+    @git.checkout 'master'
+    begin
+      @git.log.object(file).each do |commit|
+        @git.checkout commit
+        next unless File.exist? file
+
+        yield commit
+      end
+    rescue StandardError
+      Psych::BadAlias
+    end
+    @git.checkout 'master'
+  end
+end

data/lib/githack/version.rb

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: githack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rousseau Alexandre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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'
+description: Crawl git's commits of a given repository to find forgotten credentials
+email:
+- contact@rousseau-alexandre.Fr
+executables:
+- githack.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/githack.rb
+- bin/setup
+- githack.gemspec
+- lib/githack.rb
+- lib/githack/repository.rb
+- lib/githack/version.rb
+homepage: https://github.com/madeindjs/githack
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Crawl git's commits of a given repository to find forgotten credentials
+test_files: []