kms_encrypted 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bec6f5799315832f67c01e6ffe79b58a5c5019e3ca8efa5a2c0795149a2b727c
-  data.tar.gz: 8cbea27c197f2da4dbd1cad3bbee59c36c2404cd8eddb379c07be7ebbfc72a05
+  metadata.gz: f0f09d385a70037946d973c086b0eea95497df19cc8b572b899bdbb6188b55e2
+  data.tar.gz: 2165ab882704315f6321cdac7544ed7db5a1da256187f954d292b92b14dbb35b
 SHA512:
-  metadata.gz: ba30a61a50245321fcca825ce5d36a4f350edb26b832f033d029b6051578a1f6d3ac8efb81f01339762a1a6869f6e70ca4a4fc780d3341ea80b4d17ca57724e8
-  data.tar.gz: e511299714c5d035f000d7e85de6855be813fccc0a65fe7332a9418e0dc2733c6618ae42070f582877b48db98117aabc9b605ab1931537885180b20693fb7da0
+  metadata.gz: 341db4f5ec475a23fce65729360fe625b8e7f6905f870654ff668e8651eb89d03852a0073a53c1c2c9200cd5b33da347d8236a1430b80cdf6c46f6835d995e63
+  data.tar.gz: ef0f312ed2695cb1f658968cd15349e9dc1d56982e99b8411e8070d0daa6cbd3e025cd613ddd920e6688f012dc8ad587c472f3f8377031e501ed62b8bd9be663

data/CHANGELOG.md

@@ -1,35 +1,65 @@
-## 0.3.0
+## 1.2.0 (2020-08-18)
+
+- Raise error when trying to rotate key used for encrypted files
+
+## 1.1.1 (2020-04-16)
+
+- Fixed `SystemStackError` with `reload` and CarrierWave
+
+## 1.1.0 (2019-07-09)
+
+- Added support for Lockbox
+- Dropped support for Rails 4.2
+
+## 1.0.1 (2019-01-21)
+
+- Added support for encryption and decryption outside models
+- Added support for dynamic keys
+- Fixed issue with inheritance
+
+## 1.0.0 (2018-12-17)
+
+- Added versioning
+- Added `context_hash` method
+
+Breaking changes
+
+- There’s now a default encryption context with the model name and id
+- ActiveSupport notifications were changed from `generate_data_key` and `decrypt_data_key` to `encrypt` and `decrypt`
+- AWS KMS uses the `Encrypt` operation instead of `GenerateDataKey`
+
+## 0.3.0 (2018-11-11)
 
 - Added support for Vault
 - Removed `KmsEncrypted.kms_client` and `KmsEncrypted.client_options` in favor of `KmsEncrypted.aws_client`
 - Removed `KmsEncrypted::Google.kms_client` in favor of `KmsEncrypted.google_client`
 
-## 0.2.0
+## 0.2.0 (2018-02-23)
 
 - Added support for Google KMS
 
-## 0.1.4
+## 0.1.4 (2017-12-03)
 
 - Added `kms_keys` method to models
 - Reset data keys when record is reloaded
 - Added `kms_client`
 - Added ActiveSupport notifications
 
-## 0.1.3
+## 0.1.3 (2017-12-01)
 
 - Added test key
 - Added `client_options`
 - Allow private or protected `kms_encryption_context` method
 
-## 0.1.2
+## 0.1.2 (2017-09-25)
 
 - Use `KMS_KEY_ID` env variable by default
 
-## 0.1.1
+## 0.1.1 (2017-09-23)
 
 - Added key rotation
 - Added support for multiple keys per record
 
-## 0.1.0
+## 0.1.0 (2017-09-23)
 
 - First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Andrew Kane
+Copyright (c) 2017-2020 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,40 +1,515 @@
 # KMS Encrypted
 
-Simple, secure key management for [attr_encrypted](https://github.com/attr-encrypted/attr_encrypted)
+Simple, secure key management for [Lockbox](https://github.com/ankane/lockbox) and [attr_encrypted](https://github.com/attr-encrypted/attr_encrypted)
 
-The attr_encrypted gem is great for encryption, but:
+With KMS Encrypted:
 
-1. Leaves you to manage the security of your keys
-2. Doesn’t provide an easy way to rotate your keys
-3. Doesn’t have a great audit trail to see how data has been accessed
-4. Doesn’t let you grant encryption and decryption permission separately
+- Master encryption keys are not on application servers
+- Encrypt and decrypt permissions can be granted separately
+- There’s an immutable audit log of all activity
+- Decryption can be disabled if an attack is detected
+- It’s easy to rotate keys
 
-Key management services address all of these issues and it’s easy to use them together.
+Supports [AWS KMS](https://aws.amazon.com/kms/), [Google Cloud KMS](https://cloud.google.com/kms/), and [Vault](https://www.vaultproject.io/)
 
-Supports [Amazon KMS](https://aws.amazon.com/kms/), [Google KMS](https://cloud.google.com/kms/), and [Vault](https://www.vaultproject.io/)
+Check out [this post](https://ankane.org/sensitive-data-rails) for more info on securing sensitive data with Rails
 
 [![Build Status](https://travis-ci.org/ankane/kms_encrypted.svg?branch=master)](https://travis-ci.org/ankane/kms_encrypted)
 
 ## How It Works
 
-This approach uses KMS to manage encryption keys and attr_encrypted to do the encryption.
+This approach uses a key management service (KMS) to manage encryption keys and Lockbox / attr_encrypted to do the encryption.
 
-To encrypt an attribute, we first generate a data key and encrypt it with KMS. This is known as [envelope encryption](https://cloud.google.com/kms/docs/envelope-encryption). We pass the unencrypted version to attr_encrypted and store the encrypted version in the `encrypted_kms_key` column. For each record, we generate a different data key.
+To encrypt an attribute, we first generate a data key and encrypt it with the KMS. This is known as [envelope encryption](https://cloud.google.com/kms/docs/envelope-encryption). We pass the unencrypted version to the encryption library and store the encrypted version in the `encrypted_kms_key` column. For each record, we generate a different data key.
 
-To decrypt an attribute, we first decrypt the data key with KMS. Once we have the decrypted key, we pass it to attr_encrypted to decrypt the data. We can easily track decryptions since we have a different data key for each record.
+To decrypt an attribute, we first decrypt the data key with the KMS. Once we have the decrypted key, we pass it to the encryption library to decrypt the data. We can easily track decryptions since we have a different data key for each record.
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'kms_encrypted'
+```
+
+And follow the instructions for your key management service:
+
+- [AWS KMS](#aws-kms)
+- [Google Cloud KMS](#google-cloud-kms)
+- [Vault](#vault)
+
+### AWS KMS
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'aws-sdk-kms'
+```
+
+Create an [Amazon Web Services](https://aws.amazon.com/) account if you don’t have one. KMS works great whether or not you run your infrastructure on AWS.
+
+Create a [KMS master key](https://console.aws.amazon.com/iam/home#/encryptionKeys) and set it in your environment along with your AWS credentials ([dotenv](https://github.com/bkeepers/dotenv) is great for this)
+
+```sh
+KMS_KEY_ID=arn:aws:kms:...
+AWS_ACCESS_KEY_ID=...
+AWS_SECRET_ACCESS_KEY=...
+```
+
+You can also use the alias
+
+```sh
+KMS_KEY_ID=alias/my-alias
+```
+
+### Google Cloud KMS
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'google-api-client'
+```
+
+Create a [Google Cloud Platform](https://cloud.google.com/) account if you don’t have one. KMS works great whether or not you run your infrastructure on GCP.
+
+Create a [KMS key ring and key](https://console.cloud.google.com/iam-admin/kms) and set it in your environment along with your GCP credentials ([dotenv](https://github.com/bkeepers/dotenv) is great for this)
+
+```sh
+KMS_KEY_ID=projects/.../locations/.../keyRings/.../cryptoKeys/...
+```
+
+The Google API client logs requests by default. Be sure to turn off the logger in production or it will leak the plaintext.
+
+```ruby
+Google::Apis.logger = Logger.new(nil)
+```
+
+### Vault
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'vault'
+```
+
+Enable the [transit](https://www.vaultproject.io/docs/secrets/transit/index.html) secrets engine
+
+```sh
+vault secrets enable transit
+```
+
+And create a key
+
+```sh
+vault write -f transit/keys/my-key derived=true
+```
+
+Set it in your environment along with your Vault credentials ([dotenv](https://github.com/bkeepers/dotenv) is great for this)
+
+```sh
+KMS_KEY_ID=vault/my-key
+VAULT_ADDR=http://127.0.0.1:8200
+VAULT_TOKEN=secret
+```
 
 ## Getting Started
 
-Follow the instructions for your key management service:
+Create a migration to add a column for the encrypted KMS data keys
+
+```ruby
+add_column :users, :encrypted_kms_key, :text
+```
+
+And update your model
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key
+
+  # Lockbox fields
+  encrypts :email, key: :kms_key
+
+  # Lockbox files
+  encrypts_attached :license, key: :kms_key
+
+  # attr_encrypted fields
+  attr_encrypted :email, key: :kms_key
+end
+```
+
+For each encrypted attribute, use the `kms_key` method for its key.
+
+## Auditing & Alerting
+
+### Context
+
+Encryption context is used in auditing to identify the data being decrypted. This is the model name and id by default. You can customize this with:
+
+```ruby
+class User < ApplicationRecord
+  def kms_encryption_context
+    {
+      model_name: model_name.to_s,
+      model_id: id
+    }
+  end
+end
+```
+
+The context is used as part of the encryption and decryption process, so it must be a value that doesn’t change. Otherwise, you won’t be able to decrypt. You can [rotate the context](#switching-context) without downtime if needed.
+
+### Order of Events
+
+Since the default context includes the id, the data key cannot be encrypted until the record has an id. For new records, the default flow is:
+
+1. Start a database transaction
+2. Insert the record, getting back the id
+3. Call KMS to encrypt the data key, passing the id as part of the context
+4. Update the `encrypted_kms_key` column
+5. Commit the database transaction
+
+With Postgres, you can avoid a network call inside a transaction with:
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key eager_encrypt: :fetch_id
+end
+```
+
+This changes the flow to:
+
+1. Prefetch the id with the Postgres `nextval` function
+2. Call KMS to encrypt the data key, passing the id as part of the context
+3. Insert the record with the id and encrypted data key
+
+If you don’t need the id from the database for context, you can use:
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key eager_encrypt: true
+end
+```
+
+### AWS KMS
+
+[AWS CloudTrail](https://aws.amazon.com/cloudtrail/) logs all decryption calls. You can view them in the [CloudTrail console](https://console.aws.amazon.com/cloudtrail/home#/events?EventName=Decrypt). Note that it can take 20 minutes for events to show up. You can also use the AWS CLI.
+
+```sh
+aws cloudtrail lookup-events --lookup-attributes AttributeKey=EventName,AttributeValue=Decrypt
+```
+
+If you haven’t already, enable CloudTrail storage to S3 to ensure events are accessible after 90 days. Later, you can use Amazon Athena and this [table structure](https://www.1strategy.com/blog/2017/07/25/auditing-aws-activity-with-cloudtrail-and-athena/) to query them.
+
+Read more about [encryption context here](https://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html).
+
+#### Alerting
+
+Set up alerts for suspicious behavior. To get near real-time alerts (20-30 second delay), use CloudWatch Events.
+
+First, create a new SNS topic with a name like "decryptions". We’ll use this shortly.
+
+Next, open [CloudWatch Events](https://console.aws.amazon.com/cloudwatch/home#rules:) and create a rule to match “Events by Service”. Choose “Key Management Service (KMS)” as the service name and “AWS API Call via CloudTrail” as the event type. For operations, select “Specific Operations” and enter “Decrypt”.
+
+Select the SNS topic created earlier as the target and save the rule.
+
+To set up an alarm, go to [this page](https://console.aws.amazon.com/cloudwatch/home?#metricsV2:graph=%7E();namespace=AWS/Events;dimensions=RuleName) in CloudWatch Metrics. Find the rule and check “Invocations”. On the “Graphed Metrics” tab, change the statistic to “Sum” and the period to “1 minute”. Finally, click the bell icon to create an alarm for high number of decryptions.
+
+While the alarm we created isn’t super sophisticated, this setup provides a great foundation for alerting as your organization grows.
+
+You can use the SNS topic or another target to send events to a log provider or [SIEM](https://en.wikipedia.org/wiki/Security_information_and_event_management), where can you do more advanced anomaly detection.
+
+You should also use other tools to detect breaches, like an [IDS](https://www.alienvault.com/blogs/security-essentials/open-source-intrusion-detection-tools-a-quick-overview). You can use [Amazon GuardDuty](https://aws.amazon.com/guardduty/) if you run infrastructure on AWS.
+
+### Google Cloud KMS
+
+Follow the [instructions here](https://cloud.google.com/kms/docs/logging) to set up data access logging. There is not currently a way to see what data is being decrypted, since the additional authenticated data is not logged. For this reason, we recommend another KMS provider.
+
+### Vault
+
+Follow the [instructions here](https://www.vaultproject.io/docs/audit/) to set up data access logging.
+
+**Note:** Vault will only verify this value if `derived` was set to true when creating the key. If this is not done, the context cannot be trusted.
+
+Context will show up hashed in the audit logs. To get the hash for a record, use:
+
+```ruby
+KmsEncrypted.context_hash(record.kms_encryption_context, path: "file")
+```
+
+The `path` option should point to your audit device. Common paths are `file`, `syslog`, and `socket`.
+
+## Separate Permissions
+
+A great feature of KMS is the ability to grant encryption and decryption permission separately.
 
-- [Amazon KMS](guides/Amazon.md)
-- [Google KMS](guides/Google.md)
-- [Vault](guides/Vault.md)
+Be extremely selective of servers you allow to decrypt.
+
+For servers that can only encrypt, clear out the existing data and data key before assigning new values (otherwise, you’ll get a decryption error).
+
+```ruby
+# Lockbox
+user.email_ciphertext = nil
+user.encrypted_kms_key = nil
+
+# attr_encrypted
+user.encrypted_email = nil
+user.encrypted_email_iv = nil
+user.encrypted_kms_key = nil
+```
+
+### AWS KMS
+
+To encrypt the data, use an IAM policy with:
+
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "EncryptData",
+            "Effect": "Allow",
+            "Action": "kms:Encrypt",
+            "Resource": "arn:aws:kms:..."
+        }
+    ]
+}
+```
+
+To decrypt the data, use an IAM policy with:
+
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "DecryptData",
+            "Effect": "Allow",
+            "Action": "kms:Decrypt",
+            "Resource": "arn:aws:kms:..."
+        }
+    ]
+}
+```
+
+### Google Cloud KMS
+
+todo: document
+
+### Vault
+
+To encrypt the data, use a policy with:
+
+```hcl
+path "transit/encrypt/my-key"
+{
+  capabilities = ["create", "update"]
+}
+```
+
+To decrypt the data, use a policy with:
+
+```hcl
+path "transit/decrypt/my-key"
+{
+  capabilities = ["create", "update"]
+}
+```
+
+Apply a policy with:
+
+```sh
+vault policy write encrypt encrypt.hcl
+```
+
+And create a token with specific policies with:
+
+```sh
+vault token create -policy=encrypt -policy=decrypt -no-default-policy
+```
+
+## Testing
+
+For testing, you can prevent network calls to KMS by setting:
+
+```sh
+KMS_KEY_ID=insecure-test-key
+```
+
+## Key Rotation
+
+Key management services allow you to rotate the master key.
+
+AWS KMS supports [automatic key rotation](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html).
+
+For Google Cloud, use the Google Cloud Console or API.
+
+For Vault, use:
+
+```sh
+vault write -f transit/keys/my-key/rotate
+```
+
+New data will be encrypted with the new master key version. To encrypt existing data with new master key version, run:
+
+```ruby
+User.find_each do |user|
+  user.rotate_kms_key!
+end
+```
+
+**Note:** This method does not rotate encrypted files, so avoid calling `rotate_kms_key!` on models with file uploads for now.
+
+### Switching Keys
+
+You can change keys within your current KMS or move to a different KMS without downtime. Update your model:
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key version: 2, key_id: ENV["KMS_KEY_ID_V2"],
+    previous_versions: {
+      1 => {key_id: ENV["KMS_KEY_ID"]}
+    }
+end
+```
+
+New data will be encrypted with the new key. To update existing data, use:
+
+```ruby
+User.where("encrypted_kms_key NOT LIKE 'v2:%'").find_each do |user|
+  user.rotate_kms_key!
+end
+```
+
+Once all data is updated, you can remove the `previous_versions` option.
+
+### Switching Context
+
+You can change your encryption context without downtime. Update your model:
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key version: 2,
+    previous_versions: {
+      1 => {key_id: ENV["KMS_KEY_ID"]}
+    }
+
+  def kms_encryption_context(version:)
+    if version == 1
+      # previous context method
+    else
+      # new context method
+    end
+  end
+end
+```
+
+New data will be encrypted with the new context. To update existing data, use:
+
+```ruby
+User.where("encrypted_kms_key NOT LIKE 'v2:%'").find_each do |user|
+  user.rotate_kms_key!
+end
+```
+
+Once all data is updated, you can remove the `previous_versions` option.
+
+## Multiple Keys Per Record
+
+You may want to protect different columns with different data keys (or even master keys).
+
+To do this, add another column
+
+```ruby
+add_column :users, :encrypted_kms_key_phone, :text
+```
+
+And update your model
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key
+  has_kms_key name: :phone, key_id: "..."
+
+  # Lockbox
+  encrypts :email, key: :kms_key
+  encrypts :phone, key: :kms_key_phone
+
+  # attr_encrypted
+  attr_encrypted :email, key: :kms_key
+  attr_encrypted :phone, key: :kms_key_phone
+end
+```
+
+To rotate keys, use:
+
+```ruby
+user.rotate_kms_key_phone!
+```
+
+For custom context, use:
+
+```ruby
+class User < ApplicationRecord
+  def kms_encryption_context_phone
+    # some hash
+  end
+end
+```
+
+## Outside Models
+
+To encrypt and decrypt outside of models, create a box:
+
+```ruby
+kms = KmsEncrypted::Box.new
+```
+
+You can pass `key_id`, `version`, and `previous_versions` if needed.
+
+Encrypt
+
+```ruby
+kms.encrypt(message, context: {model_name: "User", model_id: 123})
+```
+
+Decrypt
+
+```ruby
+kms.decrypt(ciphertext, context: {model_name: "User", model_id: 123})
+```
 
 ## Related Projects
 
 To securely search encrypted data, check out [Blind Index](https://github.com/ankane/blind_index).
 
+## Upgrading
+
+### 1.0
+
+KMS Encrypted 1.0 brings a number of improvements. Here are a few breaking changes to be aware of:
+
+- There’s now a default encryption context with the model name and id
+- ActiveSupport notifications were changed from `generate_data_key` and `decrypt_data_key` to `encrypt` and `decrypt`
+- AWS KMS uses the `Encrypt` operation instead of `GenerateDataKey`
+
+If you didn’t previously use encryption context, add the `upgrade_context` option to your models:
+
+```ruby
+class User < ApplicationRecord
+  has_kms_key upgrade_context: true
+end
+```
+
+Then run:
+
+```ruby
+User.where("encrypted_kms_key NOT LIKE 'v1:%'").find_each do |user|
+  user.rotate_kms_key!
+end
+```
+
+And remove the `upgrade_context` option.
+
 ## History
 
 View the [changelog](CHANGELOG.md)
@@ -47,3 +522,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/kms_encrypted/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/kms_encrypted.git
+cd kms_encrypted
+bundle install
+bundle exec rake test
+```