README.md in kms_encrypted-1.4.0 vs README.md in kms_encrypted-1.5.0
- old
+ new
@@ -27,11 +27,11 @@
## Installation
Add this line to your application’s Gemfile:
```ruby
-gem 'kms_encrypted'
+gem "kms_encrypted"
```
And follow the instructions for your key management service:
- [AWS KMS](#aws-kms)
@@ -41,11 +41,11 @@
### AWS KMS
Add this line to your application’s Gemfile:
```ruby
-gem 'aws-sdk-kms'
+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/kms/home#/kms/keys) and set it in your environment along with your AWS credentials ([dotenv](https://github.com/bkeepers/dotenv) is great for this)
@@ -65,11 +65,11 @@
### Google Cloud KMS
Add this line to your application’s Gemfile:
```ruby
-gem 'google-cloud-kms'
+gem "google-cloud-kms"
```
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)
@@ -81,11 +81,11 @@
### Vault
Add this line to your application’s Gemfile:
```ruby
-gem 'vault'
+gem "vault"
```
Enable the [transit](https://www.vaultproject.io/docs/secrets/transit/index.html) secrets engine
```sh
@@ -119,11 +119,11 @@
```ruby
class User < ApplicationRecord
has_kms_key
# Lockbox fields
- encrypts :email, key: :kms_key
+ has_encrypted :email, key: :kms_key
# Lockbox files
encrypts_attached :license, key: :kms_key
# attr_encrypted fields
@@ -427,11 +427,11 @@
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
+ has_encrypted :email, key: :kms_key
+ has_encrypted :phone, key: :kms_key_phone
# attr_encrypted
attr_encrypted :email, key: :kms_key
attr_encrypted :phone, key: :kms_key_phone
end