sequel_vault 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 165282372b352387b3f41c17d6a652db49e6fd88
-  data.tar.gz: bcf9013ae07860c426d1e9895dac5c8fc50eed21
+  metadata.gz: 3049adb333bd60b77bf10308bd4b762c0fe5e074
+  data.tar.gz: 942936b542ea08b4c968d85a000515da9cd1c4f0
 SHA512:
-  metadata.gz: 35567135ac68c423cba3e794f1f4e96a336fdb8c34bbea44857ecc02b630175f455f06dc46b50f85d1a1127ce5cc642efe6d749a5db7fc83826ec15c0fed2ebf
-  data.tar.gz: 161c4e25ecad6ff8720f419803c415183971853c0884f6d18480137d6983954abd6a5c66b5a199bf608344407267b283a3b46287f48c7c1159fbdf9bb36c7acf
+  metadata.gz: ffeab0fb22d2bdb46899ff54599574251b41a55080a8311e08571d7255dd671bed61193f34ce5fd94fceaccf2b962d6a8e597fa168fd6b287dca70338e88178b
+  data.tar.gz: 1ee118a4925797d427da37de478e95e486ba1521f7b4ad06366127d4ecfe4c89e51222f16bccd70f97aaf1f7e3bd94b4bdba1c97e884c21b61b6387891dadfa5

data/.gitignore

@@ -1,2 +1,4 @@
 coverage
 *.gem
+doc/
+.yardoc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sequel_vault (0.2)
+    sequel_vault (0.3)
       fernet (~> 2.1, >= 2.1)
       sequel (~> 4.21, >= 4.21.0)
 
@@ -26,7 +26,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    sequel (4.23.0)
+    sequel (4.26.0)
     simplecov (0.9.2)
       docile (~> 1.1.0)
       multi_json (~> 1.0)
@@ -43,3 +43,6 @@ DEPENDENCIES
   sequel_vault!
   simplecov (~> 0.9.2)
   sqlite3 (~> 1.3, >= 1.3.10)
+
+BUNDLED WITH
+   1.10.6

data/lib/sequel_vault.rb

@@ -17,20 +17,27 @@ module Sequel
         model.vault_attributes(keys, *attrs) unless attrs.empty?
       end
 
+      # @!attribute [r] vault_attrs
+      #   @return [Array<Symbol>] array of all attributes to be encrypted
+      # @!attribute [r] vault_keys
+      #   @return [Array<String>] array of all keys to be used.
       module ClassMethods
         attr_reader :vault_attrs
         attr_reader :vault_keys
-        attr_reader :vault_module
 
         Plugins.inherited_instance_variables(self, :@vault_attrs => :dup, :@vault_keys => :dup)
 
-        def vault_attributes(keys, *attrs)
-          raise(Error, 'must provide both keys name and attrs when setting up vault') unless keys && attrs
+        # Setup vault with the given keys for the given attributes.
+        #
+        # @param [Array<String>] keys to be used
+        # @param [Array<Symbol>] attributes that will be encrypted
+        def vault_attributes(keys, *attributes)
+          raise(Error, 'must provide both keys name and attrs when setting up vault') unless keys && attributes
           @vault_keys = keys
-          @vault_attrs = attrs
+          @vault_attrs = attributes
 
           self.class.instance_eval do
-            attrs.each do |attr|
+            attributes.each do |attr|
               define_method("#{attr}_lookup") do |plain|
                 digests = keys.map { |key| Sequel.blob(digest(key, plain)) }
                 where("#{attr}_digest": digests).first
@@ -39,14 +46,29 @@ module Sequel
           end
         end
 
+        # Returns the HMAC digest of plain text.
+        #
+        # @param [Array<String>] keys to be used
+        # @param [String] plain text
+        # @return [String] HMAC digest of the plain text
         def digest(keys, plain)
-          OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha512'), Array(keys).first, plain)
+          OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha512'), Array(keys).last, plain)
         end
 
+        # Returns the encrypted version of plain text.
+        #
+        # @param [Array<String>] keys to be used
+        # @param [String] plain text
+        # @return [String] encrypted version of the plain text
         def encrypt(keys, plain)
-          ::Fernet.generate(keys.first, plain)
+          ::Fernet.generate(keys.last, plain)
         end
 
+        # Returns the decryped version of encrypted text.
+        #
+        # @param [Array<String>] keys to be used
+        # @param [String] cypher text
+        # @return [String] plain version of the cypher text
         def decrypt(keys, cypher)
           keys.each do |key|
             verifier = ::Fernet.verifier(key, cypher, enforce_ttl: false)
@@ -57,14 +79,12 @@ module Sequel
         end
       end
 
-      module DatasetMethods
-      end
-
       module InstanceMethods
         def []=(attr, plain)
           if model.vault_attrs.include?(attr) && !plain.nil?
             send("#{attr}_digest=", self.class.digest(model.vault_keys, plain))
             value = self.class.encrypt(model.vault_keys, plain)
+            super(:key_id, model.vault_keys.length) if model.columns.include?(:key_id)
           end
           super(attr, value || plain)
         end

data/sequel_vault.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "sequel_vault"
   gem.require_paths = ["lib"]
-  gem.version       = '0.3'
+  gem.version       = '0.4'
 
   gem.add_runtime_dependency 'sequel', '~> 4.21', '>= 4.21.0'
   gem.add_runtime_dependency 'fernet', '~> 2.1', '>= 2.1'

data/spec/sequel_vault_spec.rb

@@ -7,7 +7,7 @@ describe Sequel::Plugins::Vault do
     Class.new(Sequel::Model(db[:vm])) do
       set_primary_key :id
       unrestrict_primary_key
-      set_columns([:id, :secret, :secret_digest])
+      set_columns([:id, :secret, :secret_digest, :key_id])
 
       plugin :vault
     end
@@ -15,18 +15,19 @@ describe Sequel::Plugins::Vault do
   let(:dataset) { klass.dataset }
   let(:model) { klass.new }
   let(:keys) do
-    ["woRXJWevRaxZLxgoiEQtCDPBSf9TNg57bki0RUK1U48=",
-     "fih3l0Z9e4NBpy5KIj+rmXVexY5O9LspzuqCFyqavjg="]
+    ["fih3l0Z9e4NBpy5KIj+rmXVexY5O9LspzuqCFyqavjg=",
+     "woRXJWevRaxZLxgoiEQtCDPBSf9TNg57bki0RUK1U48="]
   end
   let(:secret) { "Attack at once." }
   let(:cypher) { klass.encrypt(keys, secret) }
-  let(:digest) { OpenSSL::HMAC.digest('sha512', keys.first, secret) }
+  let(:digest) { OpenSSL::HMAC.digest('sha512', keys.last, secret) }
 
   it "should encrypt vault attributes" do
     klass.vault_attributes(keys, :secret)
     model.secret = secret
     expect(model.values[:secret]).to_not eq(secret)
     expect(model.secret).to eq(secret)
+    expect(model.key_id).to eq(2)
   end
 
   it "should allow nil value" do
@@ -34,6 +35,7 @@ describe Sequel::Plugins::Vault do
     model.secret = nil
     expect(model.values[:secret]).to be_nil
     expect(model.secret).to be_nil
+    expect(model.key_id).to be_nil
   end
 
   it "should write a digest of the value" do
@@ -41,6 +43,7 @@ describe Sequel::Plugins::Vault do
     model.secret = secret
     expect(model.values[:secret_digest]).to_not eq(secret)
     expect(model.secret_digest).to eq(digest)
+    expect(model.key_id).to eq(2)
   end
 
   it "should provide a digest lookup" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel_vault
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - Timothée Peignier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -141,10 +141,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Handle attributes encryption.
 test_files:
 - spec/sequel_vault_spec.rb
 - spec/spec_helper.rb
+has_rdoc: