pod4 0.10.3 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c65450007521cb6a9e312bdc47350624c85f381f
-  data.tar.gz: 37a401097db2e57f2ea96c337e4b3e151a154606
+  metadata.gz: 630728075021ff016e6ead3d63c58806821bc3ce
+  data.tar.gz: 8545dc27e2f1f73a7fd4bc0589d4f751a44d3811
 SHA512:
-  metadata.gz: c7c157f8b35a9961a48e9457e7aa328dd1a4c361876aa236cdfbe009448a21e005c659fa7a089c79f4e61d169580d622e5539d3b04cf4d78f293422b0e20dc8e
-  data.tar.gz: 5be81a188a0e925fdbb45cb4f1bb74240eed34b16c6e103ce75905aefe3bc378354c744cf8437fca0389b1c68b82ef2f6fdb21b0b14a26672babcb133838c6e4
+  metadata.gz: b93e6dc86f29c31acca757cb64392a23b406829f033e6db3a4c0158e951ce258a5abe874d6f6f3f393b03afc84b0a8d3db461d0fdf6e189cee545c201adc8d41
+  data.tar.gz: f07ac222e7260b0fd94669640fc519a14604779982d659333da5de52577e590cf811665645fd2192ec277b80d56765ac35e57e1689c5dec21c27c712d58b6f02

data/.hgtags

@@ -29,3 +29,4 @@ f1b3a814e7a8c7d818b57f6d35ce7ed749573d76 0.9.1
 77ad625b2ab048bd660194cf093015b1f2698069 0.10
 7ac52e99228fe39ca59c87fad8fe2c1236fce4fa 0.10.1
 7a39c71dceaf05b9204e1f2870f904940fdac4d3 0.10.3
+e98232cdc6cbe61e2bf0513fcf578001a2931018 0.10.4

data/lib/pod4/encrypting.rb

@@ -75,6 +75,10 @@ module Pod4
   #
   # * `encryption_iv` returns the value of the IV column of the record, whatever it is.
   #
+  # * `encrypt` and `decrypt` allow you to transform arbitrary text in a manner compatible with the
+  #   model -- for example, if you removed a column from `encrypted_columns`, you could do a
+  #   one-time decrypt of your data.
+  #
   # Notes
   # -----
   #
@@ -135,12 +139,11 @@ module Pod4
         hash   = super.to_h
         cipher = get_cipher(:encrypt)
 
-        # If the IV is not set we need to set it both in the model object AND the hash, since we've
-        # already obtained the hash from the model object.
-        if use_iv? && encryption_iv.nil?
-          iv = cipher.random_iv
-          set_encryption_iv(iv)
-          hash[self.class.encryption_iv_column] = Base64.strict_encode64(iv)
+        # Each time we write, we set a new IV. We must also set it on the hash to go to the
+        # interface, where it must be base64 encoded, just like the encrypted columns.
+        if use_iv? 
+          set_encryption_iv( cipher.random_iv )
+          hash[self.class.encryption_iv_column] = Base64.strict_encode64(encryption_iv)
         end
 
         self.class.encryption_columns.each do |col|
@@ -157,10 +160,9 @@ module Pod4
         hash   = ot.to_h
         cipher = get_cipher(:decrypt)
 
-        # The IV is not in columns, we need to de-base-64 it and set it on the model ourselves
-        if use_iv?
-          iv = Base64.strict_decode64 hash[self.class.encryption_iv_column]
-          set_encryption_iv(iv)
+        # The IV column is not in columns, so we need to de-base-64 it and set it on the model here
+        if use_iv? && (iv64 = hash[self.class.encryption_iv_column])
+          set_encryption_iv Base64.strict_decode64(iv64)
         end
 
         self.class.encryption_columns.each do |col|
@@ -178,6 +180,24 @@ module Pod4
         instance_variable_get( "@#{self.class.encryption_iv_column}".to_sym )
       end
 
+      ##
+      # Public facing manual encryption, compatible with the current model
+      #
+      def encrypt(string)
+        cipher = get_cipher(:encrypt)
+        iv     = use_iv? ? encryption_iv : nil
+        crypt(cipher, :encrypt, iv, string)
+      end
+
+      ##
+      # Public facing manual decryption, compatible with the current model
+      #
+      def decrypt(string)
+        cipher = get_cipher(:decrypt)
+        iv     = use_iv? ? encryption_iv : nil
+        crypt(cipher, :decrypt, iv, string)
+      end
+
       private
 
       ##
@@ -219,14 +239,16 @@ module Pod4
         cipher.key = self.class.encryption_key
         cipher.iv = iv if use_iv?
 
-        string = Base64.strict_decode64(string) if direction == :decrypt
-
-        answer = ""
-        answer << cipher.update(string.to_s) unless direction == :encrypt && string.empty?
-        answer << cipher.final
-
-        answer = Base64.strict_encode64(answer) if direction == :encrypt
-        answer
+        case direction
+          when :encrypt
+            answer = string.to_s.empty? ? "" : cipher.update(string.to_s)
+            answer << cipher.final
+            Base64.strict_encode64(answer)
+
+          when :decrypt
+            answer = Base64.strict_decode64(string.to_s)
+            cipher.update(answer) + cipher.final
+        end
 
       rescue OpenSSL::Cipher::CipherError
         raise Pod4::Pod4Error, $!

data/lib/pod4/version.rb

@@ -1,3 +1,3 @@
 module Pod4 
-  VERSION = '0.10.3'
+  VERSION = '0.10.4'
 end

data/spec/common/model_plus_encrypting_spec.rb

@@ -229,7 +229,7 @@ describe "(Model with Encryption)" do
         expect( d.heading ).to eq "fred"
         expect( d.text    ).to eq "sore toe"
       end
-    
+
     end
     
     context "when we have an IV column" do
@@ -249,6 +249,24 @@ describe "(Model with Encryption)" do
         expect( m.prescription ).to eq "suck thumb"
       end
 
+      it "handles the case of a record with no IV (not encrypted)" do
+        ot = Octothorpe.new( id:           80,
+                             nhs_no:       "abc",
+                             name:         "sally",
+                             ailment:      "short-sighted",
+                             prescription: "glasses",
+                             nonce:        nil )
+
+        m80 = medical_model_class.new(80)
+        allow( m80.interface ).to receive(:read).with(80).and_return(ot)
+
+        m80.read
+        expect( m80.nhs_no       ).to eq "abc"
+        expect( m80.name         ).to eq "sally"
+        expect( m80.ailment      ).to eq "short-sighted"
+        expect( m80.prescription ).to eq "glasses"
+      end
+
     end
 
   end # of (reading a record)
@@ -294,6 +312,21 @@ describe "(Model with Encryption)" do
   end # of Model#encryption_iv
 
 
+  describe "Model#encrypt & Model#decrypt" do
+
+    it "encrypts and decrypts when the model has no IV" do
+      d = diary_model_class.new
+      expect( d.decrypt(d.encrypt "foobar123") ).to eq "foobar123"
+    end
+
+    it "encrypts and decrypts when the model has IV" do
+      m = medical_model_class.new
+      expect( m.decrypt(m.encrypt "plonkplink987") ).to eq "plonkplink987"
+    end
+
+  end # of Model#encrypt & Model#decrypt
+
+
   describe "Model#map_to_interface" do
 
     it "raises Pod4Error if there is an encryption problem, eg, key too short" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pod4
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors:
 - Andy Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devnull