first commit

Hacker0x01 · Mar 31, 2020 · bdb9ce1 · bdb9ce1
commit bdb9ce1
Show file tree

Hide file tree

Showing 22 changed files with 502 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Rubymine
+/.idea
+.rakeTasks
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,16 @@
+## Unreleased Changes
+
+[Full Changelog](https://github.com/Hacker0x01/data_classification/compare/master)
+
+Bug Fixes:
+
+* None
+
+Enhancements:
+
+* Add a rake task to walk through your table/columns and easily classify and create a migration from it
+* Add a migration generator
+* Module helper to include in migrations to add data classification smart comment 
+
+Deprecations:
+* None
diff --git a/CODE_OF_CONDUCT.md b/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 opensource@hackerone.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/
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in data_classification.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 HackerOne Inc.
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,93 @@
+# DataClassification
+
+This gem is to help with classifying data in your database by adding smart comments to your columns in Rails. This brings
+the following functionality to your Rails app:
+ - a helper to allow migrations to easily add data classifications
+ - a generator to create a migration that will add one or more data classifications to columns
+ - a rake task to help you audit and set the data classifications for your columns
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data_classification'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install data_classification
+
+## Usage
+
+## Migration Helper
+
+One simple helper is available to set the classification on the column level:
+```ruby
+include DataClassification::Migrate
+
+add_data_classification 'table_name', 'column_name', 'classification' 
+```
+
+This generates the SQL to add a column. In PostgreSQL, this is equivalent to:
+```sql
+COMMENT ON COLUMN schema.table_name.column_name IS '{"tags":["classification:confidential"]}';
+```
+
+### Migration Generator
+
+You can view generators by running `bin/rails g`. The simple migration generator syntax is as follows:
+```
+bin/rails g data_classification <table>:<column>:<classification> <table>:<column>:<classification> ...
+```
+
+This will create a migration similar to the following:
+```ruby
+class CreateDataClassificationForArInternalMetadata < ActiveRecord::Migration[5.2]
+  include DataClassification::Migration
+
+  def up
+    add_data_classification 'ar_internal_metadata', 'key', 'confidential'
+  end
+
+  def down
+    fail ActiveRecord::IrreversibleMigration
+  end
+end
+```
+
+### Audit Data Classifications
+
+It's tedious to go through and map out the table and column classifications. To help simplify the process, you can use this rake task:
+```
+bin/rake data_classification:bulk_classify
+```
+
+This walks through any uncommented table/columns and prompts on how to classify:
+```
+Table: users, Column: password
+Data classification (public,operational,critical,confidential,personal,personal_sensitive, q(uit), n(ext) >
+```
+
+## 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/Hacker0x01/data_classification. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Hacker0x01/data_classification/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 DataClassification project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/Hacker0x01/data_classification/blob/master/CODE_OF_CONDUCT.md).
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
diff --git a/bin/console b/bin/console
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "data_classification"
+
+# 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__)
diff --git a/bin/setup b/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
diff --git a/data_classification.gemspec b/data_classification.gemspec
@@ -0,0 +1,37 @@
+require_relative 'lib/data_classification/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_classification"
+  spec.version       = DataClassification::VERSION
+  spec.authors       = ["HackerOne Open Source", "Ben Willis"]
+  spec.email         = ["opensource+data_classification@hackerone.com", "ben@hackerone.com"]
+
+  spec.summary       = %q{
+    DataClassification helps you tag your database columns with smart comments in order to classify your data.
+  }
+  spec.description   = %q{
+    By leveraging smart comments in your schema, you can easily use this data throughout your app
+    and make better decisions when logging data, exposing data through endpoints, monitoring data sent elsewhere,
+    or allowing other systems accessing your database to consume the classifications.
+  }
+  spec.homepage      = "https://github.com/Hacker0x01/data_classification"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_dependency('activerecord', '> 5.0')
+  spec.add_dependency('railties', '> 5.0')
+  spec.add_development_dependency('pry')
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Hacker0x01/data_classification"
+  spec.metadata["changelog_uri"] = "https://github.com/Hacker0x01/data_classification/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('..', __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
diff --git a/lib/data_classification.rb b/lib/data_classification.rb
@@ -0,0 +1,17 @@
+require "data_classification/version"
+require "data_classification/migration"
+require "data_classification/generators/data_classification/create_generator"
+
+module DataClassification
+  require 'data_classification/railtie' if defined?(Rails)
+  class Error < StandardError; end
+
+  DATA_CLASSIFICATIONS = [
+    PUBLIC = :public,
+    OPERATIONAL = :operational,
+    CRITICAL = :critical,
+    CONFIDENTIAL = :confidential,
+    PERSONAL = :personal,
+    PERSONAL_SENSITIVE = :personal_sensitive,
+  ].freeze
+end
diff --git a/lib/data_classification/generators/data_classification/USAGE b/lib/data_classification/generators/data_classification/USAGE
@@ -0,0 +1,8 @@
+Description:
+    Generate a migration to set the data classification of a table column.
+
+Example:
+    rails generate data_classification:create reports:vulnerability_information:confidential reports:title:confidential
+
+    This will create:
+        Migrations: db/migrate/{timestamp}_create_data_classification_for_{table_names}.rb
diff --git a/lib/data_classification/generators/data_classification/create_generator.rb b/lib/data_classification/generators/data_classification/create_generator.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require 'rails/generators/active_record/migration'
+require 'rails/generators/base'
+
+class CreateGenerator < Rails::Generators::Base
+  include ActiveRecord::Generators::Migration
+  include DataClassification::Migration
+
+  namespace 'data_classification:create'
+  source_root File.expand_path('../templates', __FILE__)
+
+  # table1:column1:classification table2:column2:classification
+  #   => ['table1:column1:classification', 'table2:column2:classification']
+  argument :table_column_classification, type: :array
+
+  def copy_migration
+    validate!
+    set_local_assigns!
+    migration_template 'create_migration.rb.erb', "db/migrate/#{migration_file_name}.rb"
+  end
+
+  protected
+
+  def set_local_assigns!
+    @table_classifications = table_column_classification.map { |params| params.split(':') }.sort_by { |params| params[0] }
+    tables = @table_classifications.map { |table, _column, _classification| table }.uniq.to_sentence.gsub(' ', '_')
+
+    @migration_file_name = "create_data_classification_for_#{tables}"
+    @migration_class_name = "CreateDataClassification#{tables.camelize}"
+  end
+
+  def validate!
+    table_column_classification.each do |data|
+      table, column, classification = data.split(':')
+
+      if table.blank? || column.blank? || classification.blank?
+        fail "All arguments require 3 parts <table>:<column>:<classification> referenced in '#{data}'"
+      end
+      unless ActiveRecord::Base.connection.table_exists?(table)
+        fail "Table '#{table}' referenced in '#{data}' does not exist"
+      end
+      unless ActiveRecord::Base.connection.column_exists? table, column
+        fail "Column '#{column}' on '#{table}' referenced in '#{data}' does not exist"
+      end
+      if DataClassification::DATA_CLASSIFICATIONS.map(&:to_s).exclude? classification
+        fail "Data classification '#{classification}' referenced in '#{data}' is not valid, must be one of "\
+          "#{DataClassification::DATA_CLASSIFICATIONS.join(', ')}"
+      end
+    end
+  end
+end