Caution

pii_safe_schema is deprecated. We use Satori to perform data masking for our database schemas.

PII Safe Schema

Schema migration tool for checking and adding comments on Personally Identifiable Information (PII) columns in Rails.

Maintained by the Application Security & Posture Management Team. You can find us on slack at #appsec-posture

Specifically, this gem serves a few functions:

• Warning you when you might be missing an annotation on a column
• Auto generating your migrations for you
• Customizable actions through Datadog Events if there are remaining unannotated columns. E.g. alerting your Security Team

Why

Data privacy is an ever increasing concern for users, especially if your project or business is in sensitive industries like healthcare or finance.

Having structured metadata on the database level of your application ensures Business Intelligence consumers (I.e. Periscope Data) can appropriately filter or obfuscate columns that personally identify your users without impacting business needs.

In other words, as your attack surface increases, the risk of user PII disclosure remains the same.

In your data warehousing pipeline, consume the structured metadata this gem provides in order to maintain the privacy of your users.

Getting Started

Add your Rails project Gemfile:

gem 'pii_safe_schema'

Then, to your application.rb

config.after_initialize do
  PiiSafeSchema.activate!
end

If you want to ignore certain columns, add the following initializer:

# initializers/pii_safe_schema.rb

PiiSafeSchema.configure do |config|
  config.ignore = {
    some_table:       :*,                       # ignore the whole table
    some_other_table: [:column_1, :column_2]    # just those columns
  }

  # Pass whatever instance you want here, but it must implement the method
  # #event(title, message, opts = {})
  # which is what datadog-statsd does:
  config.datadog_client =  Datadog::Statsd.new(
    Rails.application.secrets.fetch(:datadog_host),
    Datadog::Statsd::DEFAULT_PORT,
    # ...
  )
end

Generating Comment Migrations

rake pii_safe_schema:generate_migrations

This will generate one migration file for each table that should be commented. It will create a comment field for each column that it warns you about when you start a rails server or console.

Explicit annotations

If the generator fails to identify a PII column, you can specify explicitly what columns in what tables are PII. This is particularly useful if you're installed pii_safe_schema into an existing project.

rake pii_safe_schema:generate_migrations [table:column:annotation_type] ...

Run rake pii_safe_schema:generate_migrations help for details

Credits

Thanks to Alexi Garrow for the original code.

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

To get started with development and testing:

git clone https://github.com/wealthsimple/pii_safe_schema.git
cd pii_safe_schema
bundle install
bundle exec rspec