activerecord-data_classification 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fec4de7b27cfc673e959455b96af6a64532ee748132d492c1efd1ea4d297ecc7
+  data.tar.gz: ee6fdc5d5f131ee7a461756e43c6f9c2237f9e2f7b494f0ef2b4109548da4952
+SHA512:
+  metadata.gz: 32cf7e5c9e49e20c15354503ca24bb3b0600557cef24e1de59e4fa9b4ac87dcb2b321620ace1b4324f0cae59d434414afe236f4bc622118ae9f5cf50b8fd6e7a
+  data.tar.gz: ebf1cd76fe551605fc854a6efe96fc4d5ea0242e9f0e18eabd9d81d481304d2d2468b359e73a09860afacc3535d70ad640c91a3a95341cf54415382a5e397d00

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Invoca 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.

data/README.md

@@ -0,0 +1,31 @@
+# ActiveRecord::DataClassification
+
+TODO: Delete this and the text below, and describe your gem
+
+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/active_record/data_classification`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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/invoca/activerecord-data_classification.

data/lib/active_record/data_classification/aggregate/extension.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    module Aggregate
+      module Extension
+        extend ActiveSupport::Concern
+
+        AGGREGATE_BUILTINS =
+          ::Aggregate::AttributeHandler::BUILTIN_TYPES
+            .invert
+            .merge(::Aggregate::Attribute::ForeignKey => "foreign_key").freeze
+
+        # rubocop:disable Metrics/BlockLength
+        included do
+          alias_method :columns_without_aggregates, :columns
+
+          def columns
+            agg_columns = if (storage_field = @model.try(:aggregate_storage_field))
+                            aggregate_columns(@model, "#{storage_field}->\"$.", @models)
+                          else
+                            []
+                          end
+
+            [*columns_without_aggregates, *agg_columns].flatten.compact
+          end
+
+          private
+
+          def aggregate_columns(_klass, prefix, all_models)
+            aggregate_models_by_field = {}
+            aggregate_handlers_by_field = {}
+
+            all_models.each do |model|
+              model.aggregated_attribute_handlers.map do |key, handler|
+                aggregate_models_by_field[key] ||= []
+                aggregate_models_by_field[key] << model
+
+                aggregate_handlers_by_field[key] ||= handler
+              end
+            end
+
+            aggregate_models_by_field.map do |field, models|
+              columns_for_aggregate_attribute(aggregate_handlers_by_field[field], field, models, prefix)
+            end
+          end
+
+          def nested_aggregate_columns(klass, prefix, models)
+            klass.aggregated_attribute_handlers.map do |field, handler|
+              columns_for_aggregate_attribute(handler, field, models + [klass], prefix)
+            end
+          end
+
+          def aggregate_type_name(_field, handler)
+            AGGREGATE_BUILTINS[handler.class] || handler.class.name
+          end
+
+          def columns_for_aggregate_attribute(handler, key, models, prefix)
+            case handler
+            when *AGGREGATE_BUILTINS.keys
+              Column.new(
+                "#{prefix}#{key}\"", AGGREGATE_BUILTINS[handler.class],
+                sensitivity_friendly(models, nil), sensitivity_source(models, nil), anonymization_type, models
+              )
+            when ::Aggregate::Attribute::List
+              columns_for_aggregate_has_many(handler, key, models, prefix)
+            when ::Aggregate::Attribute::NestedAggregate
+              nested_aggregate_columns(handler.class_name.constantize, "#{prefix}#{key}.", models)
+            when ::Aggregate::Attribute::SchemaVersion
+              Column.new(
+                "#{prefix}schema_version\"", "schema_version",
+                sensitivity_friendly(models, nil), sensitivity_source(models, nil), anonymization_type, models
+              )
+            else
+              raise "Unexpected handler #{handler.inspect}"
+            end
+          end
+
+          def columns_for_aggregate_has_many(handler, key, models, prefix)
+            case handler.element_helper
+            when *AGGREGATE_BUILTINS.keys
+              Column.new(
+                "#{prefix}#{key}\"",
+                "list of #{AGGREGATE_BUILTINS[handler.element_helper.class]}",
+                sensitivity_friendly(models, nil),
+                sensitivity_source(models, nil),
+                anonymization_type,
+                models
+              )
+            when ::Aggregate::Attribute::NestedAggregate
+              nested_aggregate_columns(handler.element_helper.class_name.constantize, "#{prefix}#{key}.*.", models)
+            else
+              raise "Unexpected element_helper #{handler.element_helper.inspect}"
+            end
+          end
+        end
+        # rubocop:enable Metrics/BlockLength
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/column.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    Column = Struct.new(
+      :column,
+      :type,
+      :sensitivity,
+      :sensitivity_source,
+      :anonymization,
+      :models
+    ).freeze
+  end
+end

data/lib/active_record/data_classification/configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    class ConfigurationError < StandardError; end
+
+    class Configuration
+      attr_accessor :default_classification,
+                    :ignored_tables,
+                    :confidential_class_names,
+                    :excluded_table_patterns
+
+      attr_reader :load_models_block,
+                  :table_name_transformer_block
+
+      def initialize
+        @default_classification       = :Private
+        @load_models_block            = -> { }
+        @table_name_transformer_block = ->(table_name) { table_name }
+        @confidential_class_names     = []
+        @excluded_table_patterns      = []
+        @ignored_tables              = [
+          "schema_migrations",
+          "ar_internal_metadata",
+        ]
+      end
+
+      def load_models(&block)
+        @load_models_block = block
+      end
+
+      def transform_table_name(&block)
+        @table_name_transformer_block = block
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/declare_schema/extension.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    module DeclareSchema
+      module Extension
+        [:ruby_default, :data_security, :anonymize_using].each do |option|
+          define_method(option) { @options[option] }
+        end
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/model_annotation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Adds the ability to specify data security to a model.
+module ActiveRecord
+  module DataClassification
+    module ModelAnnotation
+      extend ActiveSupport::Concern
+
+      CLASSIFICATIONS = [:Public, :Private, :Confidential].freeze
+
+      module ClassMethods
+        def data_security(type = nil)
+          if type
+            type.in?(CLASSIFICATIONS) or raise ArgumentError, "Unknown classification type #{type}"
+            self._data_security_type = type
+          end
+          _data_security_type
+        end
+
+        def confidential?
+          _data_security_type == :Confidential
+        end
+      end
+
+      included do
+        class_attribute :_data_security_type
+        if defined?(::DeclareSchema)
+          require_relative 'declare_schema/extension'
+
+          unless ::DeclareSchema::Model::FieldSpec < DeclareSchema::Extension
+            ::DeclareSchema::Model::FieldSpec.prepend(DeclareSchema::Extension)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/model_reflection.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    class ModelReflection
+      attr_reader :server_type, :table_name, :model_name
+
+      def initialize(table_name, models)
+        @models = models
+        @model  = @models.find { |m| m.try(:base_class) == m } || @models.first
+
+        @server_type = find_server_type(table_name)
+
+        @model_name = @model.name
+        @table_name = table_name
+      end
+
+      def columns
+        connection.columns(table_name).map do |column|
+          column_spec = @model.try(:field_specs)&.[](column.name)
+          Column.new(
+            column.name,
+            column.sql_type,
+            sensitivity_friendly(@models, column_spec&.data_security),
+            sensitivity_source(@models, column_spec&.data_security),
+            anonymization_type || column_spec&.anonymize_using,
+            @models
+          )
+        end
+      end
+
+      private
+
+      def anonymization_type
+        if sensitivity_friendly(@models, nil) == "Confidential"
+          "Truncated"
+        end
+      end
+
+      def sensitivity(models, field_sensitivity)
+        if (model_sensitivity = models.map_and_find { |m| m.try(:data_security) })
+          model_sensitivity
+        elsif field_sensitivity
+          field_sensitivity
+        end
+      end
+
+      def sensitivity_friendly(models, field_sensitivity)
+        sensitivity(models, field_sensitivity)&.to_s
+      end
+
+      def sensitivity_source(models, field_sensitivity)
+        if (model = models.find { |m| m.try(:data_security) })
+          model.name
+        elsif field_sensitivity
+          "Field"
+        end
+      end
+
+      def find_server_type(table_name)
+        case table_name
+        when /number_attributions_partitioned/
+          "attr"
+        when  /\Acf_.*/
+          "shard"
+        else
+          "common"
+        end
+      end
+
+      def connection
+        ActiveRecord::Base.connection
+      end
+    end
+  end
+end
+
+if defined?(Aggregate)
+  require_relative 'aggregate/extension'
+  ActiveRecord::DataClassification::ModelReflection.include(ActiveRecord::DataClassification::Aggregate::Extension)
+end

data/lib/active_record/data_classification/model_space.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    module ModelSpace
+      class << self
+        def models
+          models_by_table.map do |table, all_models|
+            DataClassification::ModelReflection.new(table, all_models)
+          end
+        end
+
+        def all_mysql_model_tables
+          models_by_table.keys
+        end
+
+        private
+
+        def include_table?(table_name)
+          DataClassification::TableSpace.all_tables.include?(table_name)
+        end
+
+        def table_for_model(model)
+          model.try(:table_name)
+        rescue
+          # Some rails models raise an error when you call table name on them.  Ignore these.
+        end
+
+        def models_by_table
+          unless @models_by_table
+            @models_by_table = {}
+            ObjectSpace.each_object(Class) do |model|
+              table_name = table_for_model(model)
+              if include_table?(table_name)
+                @models_by_table[table_name] ||= []
+                @models_by_table[table_name] << model
+              end
+            end
+          end
+          @models_by_table
+        end
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/report.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module ActiveRecord
+  module DataClassification
+    module Report
+      REPORT_COLUNMS = [
+        "Server Type",
+        "Table",
+        "Column",
+        "Type",
+        "Sensitivity",
+        "Clone Handling",
+        "Models",
+        "Sensitivity Source",
+      ].freeze
+
+      class << self
+        def generate
+          load_all_models
+          assert_all_tables
+
+          models = DataClassification::ModelSpace.models
+
+          generate_csv(models)
+        end
+
+        private
+
+        def generate_csv(models)
+          CSV.generate(col_sep: "\t", headers: REPORT_COLUNMS) do |csv|
+            csv << REPORT_COLUNMS
+            found_models = Set.new
+            models.sort_by(&:table_name).each do |model|
+              if include_table?(model.table_name)
+                fixed_name = fixed_table_name(model.table_name)
+                unless found_models.member?(fixed_name)
+                  found_models.add(fixed_name)
+                  model.columns.map do |column|
+                    csv << csv_row(model, fixed_name, column)
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        def csv_row(model, fixed_name, column)
+          [
+            model.server_type,
+            fixed_name,
+            column.column,
+            column.type,
+            column.sensitivity || ActiveRecord::DataClassification.config.default_classification,
+            column.anonymization,
+            column.models.map(&:name).compact.sort.join(","),
+            column.sensitivity_source,
+          ]
+        end
+
+        def include_table?(table_name)
+          ActiveRecord::DataClassification.config.excluded_table_patterns.none? { table_name.match?(_1) }
+        end
+
+        def assert_all_tables
+          missing_models = DataClassification::TableSpace.all_tables -
+                           DataClassification::ModelSpace.all_mysql_model_tables -
+                           ActiveRecord::DataClassification.config.ignored_tables
+
+          if missing_models.any?
+            raise "Found database tables without an associated model:  #{missing_models.inspect}"
+          end
+        end
+
+        def fixed_table_name(table_name)
+          ActiveRecord::DataClassification.config.table_name_transformer_block.call(table_name)
+        end
+
+        def load_all_models
+          ActiveRecord::DataClassification.config.load_models_block.call
+          ActiveRecord::DataClassification.config.confidential_class_names.each do |klass_name|
+            make_confidential(klass_name.constantize)
+          end
+        end
+
+        def make_confidential(klass)
+          klass.send(:include, DataClassification::ModelAnnotation)
+          klass.data_security(:Confidential)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/table_space.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    module TableSpace
+      class << self
+        def all_tables
+          @all_tables ||= connection.select_rows("select distinct(TABLE_NAME) from information_schema.columns where TABLE_SCHEMA='#{schema}'").flatten
+        end
+
+        def connection
+          ActiveRecord::Base.connection
+        end
+
+        def schema
+          connection.config[:database]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/data_classification/tasks.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'active_record/data_classification'
+
+namespace :data_classification do
+  #
+  # Table, Field, Type, Security Profile
+  #
+  desc "Generate a report of all models"
+  task report: :environment do
+    filename = "../data_classification_report.csv"
+    File.write(filename, ActiveRecord::DataClassification::Report.generate)
+    puts "Report written to #{filename}"
+  end
+end

data/lib/active_record/data_classification/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module DataClassification
+    VERSION = "0.1.0.pre.1"
+  end
+end

data/lib/active_record/data_classification.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+
+require_relative "data_classification/version"
+require_relative "data_classification/column"
+require_relative "data_classification/configuration"
+require_relative "data_classification/report"
+require_relative "data_classification/model_annotation"
+require_relative "data_classification/model_reflection"
+require_relative "data_classification/table_space"
+require_relative "data_classification/model_space"
+
+module ActiveRecord
+  module DataClassification
+
+    class << self
+      def configure(&block)
+        @config = Configuration.new.tap(&block).freeze
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-data_classification
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+platform: ruby
+authors:
+- Invoca Development
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: An ActiveRecord extension for classifying models and fields as confidential
+  data
+email:
+- development@invoca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/active_record/data_classification.rb
+- lib/active_record/data_classification/aggregate/extension.rb
+- lib/active_record/data_classification/column.rb
+- lib/active_record/data_classification/configuration.rb
+- lib/active_record/data_classification/declare_schema/extension.rb
+- lib/active_record/data_classification/model_annotation.rb
+- lib/active_record/data_classification/model_reflection.rb
+- lib/active_record/data_classification/model_space.rb
+- lib/active_record/data_classification/report.rb
+- lib/active_record/data_classification/table_space.rb
+- lib/active_record/data_classification/tasks.rb
+- lib/active_record/data_classification/version.rb
+homepage: https://github.com/invoca/activerecord-data_classification
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/invoca/activerecord-data_classification
+  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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.17
+signing_key:
+specification_version: 4
+summary: An ActiveRecord extension for classifying models and fields as confidential
+  data
+test_files: []