loggable_activity 0.1.46 → 0.1.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 309f169a39d30cfaaa058c625747d1d469c28680cdbde1dcba7fc51315b1a907
-  data.tar.gz: d7dfa9e7c068cf786a1becc1cb45652c857f70e07f250b1b8c859d971d1d5a13
+  metadata.gz: ee3e20a374ac054a343ce5ff1c35c5fcce765fb631788fb6d9b738e52161a16a
+  data.tar.gz: 042cc1db90cf6b99eeb2c8d5ab3f16a5473178c00085f42400c4eec344a99731
 SHA512:
-  metadata.gz: 8654992dccda157320395bce6be47af4bc04808fd65bf402f5721879c4aa3d4482e0f039442042ca1a33fed751581251e52056b0faccc7d24410033d39781166
-  data.tar.gz: 4701568d294807adce3f455bd9856423bf137a0704eee2a6384be277e6b88d4fc24e4b86a919ba1b7b8d4277701748a3b42d3457e29ef09f4f8c0661898a4c54
+  metadata.gz: 1f4063eb4cd98a16061d151759735e0b5cc98e7747151dc2c56856f2010f23936c2c338991c5cc85dfd3c72af4f60133a4e39271f29ec76e5ee04383ad6dd073
+  data.tar.gz: 8be57a52cfd948825e273648ffaec5809975dc14863f49206ee8f364f07b58a193758d80d867155f21760522a24bc2cf49d183ba757c503af1fdf51317b78202

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 - nothing so far
+
+## [0.1.48] - 2024-02-16
+### Breaking change
+- Updated encryption_key to be 32 bytes
+- Updated README.md
+- Updated GETTING_STARTED.md
+- Added PULL_REQUEST_TEMPLATE.md
+## [0.1.46] - 2024-02-16
+- Fixed spelling error in EncryptionKey 
 ## [0.1.43] - 2024-02-15
 - Updated README.md and GETTING-STARTED.md 
 ## [0.1.39] - 2024-02-12
@@ -7,6 +16,5 @@
 ## [0.1.38] - 2024-02-12
 - Removed dependency on awesome print
 ## [0.1.35] - 2024-02-11
-
 - Initial release
 

data/GETTING-STARTED.md

@@ -78,3 +78,9 @@ Then an `LoggableActivity::Activity` is created. You can inspect it from the ter
 puts activity = Loggable::Activity.last
 puts activity.attrs
 ```
+
+## For developers
+If you want to contribute to the development and try it out in the process
+- 1 Down the demo project from [demo project on github](https://github.com/maxgronlund/LoggableActivityDemoApp)
+- 2 Update the Gemfile in the demo project so it points to your localhost.
+- 3 you can now build and test you version of the gem `$ gem build loggable_activity.gemspec`

data/README.md

@@ -5,6 +5,8 @@ Secure protect data and log how it is handled
 - Prepare for General Data Protection Regulation (GDPR) compliance.
 - Handles activities that involves more than one table in the DB.
 
+### Important!
+This project is under development and not ready for production. There might be breaking changes, so please consult the CHANGELOG.md
 ### What it is not
 - An error logging system
 - A paper trails system with rollback.

data/lib/loggable_activity/activity.rb

@@ -260,11 +260,13 @@ module LoggableActivity
 
     def record_key
       return nil if record.nil?
+
       LoggableActivity::EncryptionKey.for_record(record)&.key
     end
 
     def actor_key
       return nil if actor.nil?
+
       LoggableActivity::EncryptionKey.for_record(actor)&.key
     end
 

data/lib/loggable_activity/encryption.rb

@@ -19,17 +19,21 @@ module LoggableActivity
     # Returns:
     #   "SOME_ENCRYPTED_STRING"
     #
-    def self.encrypt(data, encryption_key)
-      return nil if data.nil?
-      return nil if encryption_key.nil?
-      raise EncryptionError, 'Encryption failed: Invalid encryption key length' unless encryption_key.bytesize == 32
+    def self.encrypt(data, encoded_key)
+      return nil if data.nil? || encoded_key.nil?
+
+      encryption_key = Base64.decode64(encoded_key)
+      raise EncryptionError, "Encryption failed: Invalid encryption key length #{encryption_key.bytesize}" unless encryption_key.bytesize == 32
+
+      cipher = OpenSSL::Cipher.new('AES-256-CBC').encrypt
+      cipher.key = encryption_key
+      cipher.iv = iv = cipher.random_iv
 
-      cipher = OpenSSL::Cipher.new('AES-128-CBC').encrypt
-      cipher.key = Digest::SHA1.hexdigest(encryption_key)[0..15]
       encrypted = cipher.update(data.to_s) + cipher.final
-      Base64.encode64(encrypted)
+      # Combine IV with encrypted data, encode with Base64 for storage/transmission
+      Base64.encode64(iv + encrypted)
     rescue OpenSSL::Cipher::CipherError => e
-      raise EncryptionError, "Encryption failed: #{e.message} ***"
+      raise EncryptionError, "Encryption failed: #{e.message}"
     end
 
     # Decrypts the given data using the given encryption key
@@ -40,19 +44,22 @@ module LoggableActivity
     # Returns:
     #   "my secret data"
     #
-    def self.decrypt(data, encryption_key)
-      return "" if data.nil?
-      return I18n.t('loggable.activity.deleted') if encryption_key.nil?
+    def self.decrypt(data, encoded_key)
+      return '' if data.nil? || encoded_key.nil?
+
+      encryption_key = Base64.decode64(encoded_key)
+      raise EncryptionError, 'Decryption failed: Invalid encryption key length' unless encryption_key.bytesize == 32
+
+      cipher = OpenSSL::Cipher.new('AES-256-CBC').decrypt
+      cipher.key = encryption_key
 
-      cipher = OpenSSL::Cipher.new('AES-128-CBC').decrypt
-      cipher.key = Digest::SHA1.hexdigest(encryption_key)[0..15]
-      decrypted_data = Base64.decode64(data)
-      decrypted_output = cipher.update(decrypted_data) + cipher.final
-      raise 'Decryption failed: Invalid UTF-8 output' unless decrypted_output.valid_encoding?
+      raw_data = Base64.decode64(data)
+      cipher.iv = raw_data[0...cipher.iv_len] # Extract IV from the beginning of raw_data
+      decrypted_data = cipher.update(raw_data[cipher.iv_len..]) + cipher.final
 
-      decrypted_output.force_encoding('UTF-8')
+      decrypted_data.force_encoding('UTF-8')
     rescue OpenSSL::Cipher::CipherError => e
-      raise EncryptionError, e.message
+      raise EncryptionError, "Decryption failed: #{e.message}"
     end
 
     def self.blank?(value)

data/lib/loggable_activity/encryption_key.rb

@@ -9,7 +9,7 @@ module LoggableActivity
     # Associations
     belongs_to :record, polymorphic: true, optional: true
     belongs_to :parent_key, class_name: 'LoggableActivity::EncryptionKey', optional: true,
-                             foreign_key: 'parent_key_id'
+                            foreign_key: 'parent_key_id'
 
     # Marks the encryption key as deleted by updating the key to nil.
     def mark_as_deleted
@@ -90,7 +90,7 @@ module LoggableActivity
     #
     def self.create_encryption_key(record_type, record_id, parent_key = nil)
       if parent_key
-        create(record_type:, record_id:, key: random_key, parent_key: )
+        create(record_type:, record_id:, key: random_key, parent_key:)
       else
         create(record_type:, record_id:, key: random_key)
       end
@@ -107,7 +107,10 @@ module LoggableActivity
     #  "a8f4774e7f42eb253045a4db7de7b79e"
     #
     def self.random_key
-      SecureRandom.hex(16)
+      # Generate 32 random bytes (256 bits) directly
+      encryption_key = SecureRandom.random_bytes(32)
+      # Encode the key in Base64 to ensure it's in a transferable format
+      Base64.encode64(encryption_key).strip
     end
   end
 end

data/lib/loggable_activity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LoggableActivity
-  VERSION = '0.1.46'
+  VERSION = '0.1.48'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggable_activity
 version: !ruby/object:Gem::Version
-  version: 0.1.46
+  version: 0.1.48
 platform: ruby
 authors:
 - "Max \nGroenlund"