mongoid-kms 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18d8d83436bd3ff21504f25d350ce292073e6f87
-  data.tar.gz: 67aed43a318aade0ac6c27afe43f918b02527aec
+  metadata.gz: daf435fff7916049bd43927b7d0801d4b9dca290
+  data.tar.gz: 08a6217d281d9bd19dfa3e584f9e310d8e874919
 SHA512:
-  metadata.gz: aef8308e7a7186427bf44247621cc1a250983aacd06855c774f06498e664838ce5fc9df597c6a3668a2dd2c85ef941e57d61004ee3a32822038f48dd680e5973
-  data.tar.gz: 274d378dff7c502714d52fc59681253c0ee1596d5c9aec1663e5c430b57a36f040033d0d00212f87cca38e96a5eb709c4268ffcb5b7124d8610b4a3b77076513
+  metadata.gz: dbd1e9f79c6b23100a9fb3f079bcbb3f6a2a1aaeba60146ac5b06f510de13955bd8ce9bcf7be637db77b60edb1965b05e4ed8d5723cd60e8f85c8a693029f041
+  data.tar.gz: 35344d3727d89ced09d2d778c5985fa8c34802d933b617f469adf78533039e38297cd085c352a5458bf977f1f00baeb0cd4ca413d9c9fad0cd28bac89223c7e7

data/README.md

@@ -35,21 +35,23 @@ require 'mongoid/kms'
 Mongoid::Kms.configure({region: "us-east-1", key: "your aws kms key id i.e <02342-234-232-234-234>"})
 ```
 
-When defining yoru classes, `include Mongoid::Kms`, and use the
-`secure_field` to define your fields with a required `:context`.
-Context must return a hash.
+When defining your classes, `include Mongoid::Kms`, and use the
+`secure_field` to define your fields.  The `:context` argument is an
+optional list of method names or strings used for encrypting your
+values.
+
+The context argument is an important way to ensure simply having the
+authentication keys and data field does not enable decryption.  When
+using context, it also requires an attacker to know the decryption
+context.
 
 ```ruby
 class MyClass
   include Mongoid::Document
   include Mongoid::Kms
 
-  secure_field :secure, type: String, context: lambda { |d| {name: d.name} }
-  field :unsecure
-
-  def name
-    @name ||= "me-#{Time.now.to_i}"
-  end
+  secure_field :my_secure_field, type: String, context: [:unsecure_field, "some-string"]
+  field :unsecure_field
 end
 ```
 

data/lib/mongoid/kms/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
 module Kms
-VERSION = "0.0.16"
+VERSION = "0.0.17"
 end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-kms
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Chris Winslett