lockbox 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d220724fb1331a7a9fdda8fdd073de62c19f601b2d15173a5fe22046e51071d
-  data.tar.gz: 9f144deb1211bd79d49f5eb2dccee29b25a2ea8869aadadad92ebda825012c00
+  metadata.gz: 72291291d3b8ac532d4c309bde141febf41d40b5228ce4d4b2541248702fe08d
+  data.tar.gz: d184e486e64cf5f0ecc882cf453fa76b18ce69b03f34d93335da7b1f70c12a01
 SHA512:
-  metadata.gz: 31492e71cafb170205944089f047269302249a5ba03f23533d302b45f45fc770ee221eb56af50f47c39ac44d980f8886ff0aa3cd50ed9dcc018638859ac06ace
-  data.tar.gz: 69faba8f29dca9c7b85c3e5d7905db625d96105b2ae74a61b0a3cd7094cbcea437caf909a731346ac53607f8624ec27b1b9d58bb44f80f294028c07ab813e938
+  metadata.gz: 4badf3561effc1d381ae5ddfcdd3ce64a5bfb70e586c140df4795a392d36e5440a3d3930921f14732b349c2f93246a6f4ddfbe62ef508c2a2ad503b5f52d28f8
+  data.tar.gz: 12e48eab11c6f1aefc7a1ea8656e8d1e0cdceebe54147e573e1beb13f635149d99a5bfea0402595a8a6d53403bb498b2f404bb3a70a684908bc87decbd39c365

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.7 (2020-04-20)
+
+- Added Active Support notifications for Active Storage and Carrierwave
+
 ## 0.3.6 (2020-04-19)
 
 - Fixed content type detection for Active Storage and CarrierWave

data/README.md

@@ -316,19 +316,35 @@ To serve encrypted files, use a controller action.
 ```ruby
 def license
   user = User.find(params[:id])
-  send_data box.decrypt(user.license.read), type: user.license.mime_type
+  send_data lockbox.decrypt(user.license.read), type: user.license.mime_type
 end
 ```
 
 ## Local Files
 
-Read the file as a binary string
+Generate a key
+
+```ruby
+key = Lockbox.generate_key
+```
+
+Create a lockbox
+
+```ruby
+lockbox = Lockbox.new(key: key)
+```
+
+Encrypt
 
 ```ruby
-message = File.binread("file.txt")
+ciphertext = lockbox.encrypt(File.binread("file.txt"))
 ```
 
-Then follow the instructions for encrypting a string below.
+Decrypt
+
+```ruby
+lockbox.decrypt(ciphertext)
+```
 
 ## Strings
 

data/lib/lockbox.rb

@@ -19,6 +19,9 @@ require "lockbox/carrier_wave_extensions" if defined?(CarrierWave)
 require "lockbox/railtie" if defined?(Rails)
 
 if defined?(ActiveSupport)
+  require "lockbox/log_subscriber"
+  Lockbox::LogSubscriber.attach_to :lockbox
+
   ActiveSupport.on_load(:active_record) do
     extend Lockbox::Model
     extend Lockbox::Model::Attached

data/lib/lockbox/active_storage_extensions.rb

@@ -95,7 +95,7 @@ module Lockbox
 
         options = Utils.encrypted_options(record, name)
         if options
-          result = Utils.build_box(record, options, record.class.table_name, name).decrypt(result)
+          result = Utils.decrypt_result(record, name, options, result)
         end
 
         result
@@ -106,13 +106,13 @@ module Lockbox
           blob.open(**options) do |file|
             options = Utils.encrypted_options(record, name)
             if options
-              result = file.read
+              result = Utils.decrypt_result(record, name, options, file.read)
               file.rewind
               # truncate may not be available on all platforms
               # according to the Ruby docs
               # may need to create a new temp file instead
               file.truncate(0)
-              file.write(Utils.build_box(record, options, record.class.table_name, name).decrypt(result))
+              file.write(result)
               file.rewind
             end
 

data/lib/lockbox/carrier_wave_extensions.rb

@@ -5,13 +5,13 @@ module Lockbox
         before :cache, :encrypt
 
         def encrypt(file)
-          @file = CarrierWave::SanitizedFile.new(lockbox.encrypt_io(file))
+          @file = CarrierWave::SanitizedFile.new(with_notification("encrypt_file") { lockbox.encrypt_io(file) })
         end
 
         # TODO safe to memoize?
         def read
           r = super
-          lockbox.decrypt(r) if r
+          with_notification("decrypt_file") { lockbox.decrypt(r) } if r
         end
 
         def size
@@ -40,20 +40,39 @@ module Lockbox
         define_method :lockbox do
           @lockbox ||= begin
             table = model ? model.class.table_name : "_uploader"
-            attribute =
-              if mounted_as
-                mounted_as.to_s
-              else
-                uploader = self
-                while uploader.parent_version
-                  uploader = uploader.parent_version
-                end
-                uploader.class.name.sub(/Uploader\z/, "").underscore
-              end
+            attribute = lockbox_name
 
             Utils.build_box(self, options, table, attribute)
           end
         end
+
+        def lockbox_name
+          if mounted_as
+            mounted_as.to_s
+          else
+            uploader = self
+            while uploader.parent_version
+              uploader = uploader.parent_version
+            end
+            uploader.class.name.sub(/Uploader\z/, "").underscore
+          end
+        end
+
+        def with_notification(type)
+          if defined?(ActiveSupport::Notifications)
+            name = lockbox_name
+
+            # get version
+            version, _ = parent_version && parent_version.versions.find { |k, v| v == self }
+            name = "#{name} #{version} version" if version
+
+            ActiveSupport::Notifications.instrument("#{type}.lockbox", {name: name}) do
+              yield
+            end
+          else
+            yield
+          end
+        end
       end
     end
   end

data/lib/lockbox/log_subscriber.rb

@@ -0,0 +1,21 @@
+module Lockbox
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def encrypt_file(event)
+      return unless logger.debug?
+
+      payload = event.payload
+      name = "Encrypt File (#{event.duration.round(1)}ms)"
+
+      debug "  #{color(name, YELLOW, true)} Encrypted #{payload[:name]}"
+    end
+
+    def decrypt_file(event)
+      return unless logger.debug?
+
+      payload = event.payload
+      name = "Decrypt File (#{event.duration.round(1)}ms)"
+
+      debug "  #{color(name, YELLOW, true)} Decrypted #{payload[:name]}"
+    end
+  end
+end

data/lib/lockbox/utils.rb

@@ -47,27 +47,30 @@ module Lockbox
     end
 
     def self.encrypt_attachable(record, name, attachable)
-      options = encrypted_options(record, name)
-      box = build_box(record, options, record.class.table_name, name)
       io = nil
 
-      case attachable
-      when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile
-        io = attachable
-        attachable = {
-          io: box.encrypt_io(io),
-          filename: attachable.original_filename,
-          content_type: attachable.content_type
-        }
-      when Hash
-        io = attachable[:io]
-        attachable = {
-          io: box.encrypt_io(io),
-          filename: attachable[:filename],
-          content_type: attachable[:content_type]
-        }
-      else
-        raise NotImplementedError, "Not supported"
+      ActiveSupport::Notifications.instrument("encrypt_file.lockbox", {name: name}) do
+        options = encrypted_options(record, name)
+        box = build_box(record, options, record.class.table_name, name)
+
+        case attachable
+        when ActionDispatch::Http::UploadedFile, Rack::Test::UploadedFile
+          io = attachable
+          attachable = {
+            io: box.encrypt_io(io),
+            filename: attachable.original_filename,
+            content_type: attachable.content_type
+          }
+        when Hash
+          io = attachable[:io]
+          attachable = {
+            io: box.encrypt_io(io),
+            filename: attachable[:filename],
+            content_type: attachable[:content_type]
+          }
+        else
+          raise NotImplementedError, "Not supported"
+        end
       end
 
       # set content type based on unencrypted data
@@ -76,5 +79,11 @@ module Lockbox
 
       attachable
     end
+
+    def self.decrypt_result(record, name, options, result)
+      ActiveSupport::Notifications.instrument("decrypt_file.lockbox", {name: name}) do
+        Utils.build_box(record, options, record.class.table_name, name).decrypt(result)
+      end
+    end
   end
 end

data/lib/lockbox/version.rb

@@ -1,3 +1,3 @@
 module Lockbox
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lockbox
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Andrew Kane
@@ -42,16 +42,16 @@ dependencies:
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +184,7 @@ files:
 - lib/lockbox/encryptor.rb
 - lib/lockbox/io.rb
 - lib/lockbox/key_generator.rb
+- lib/lockbox/log_subscriber.rb
 - lib/lockbox/migrator.rb
 - lib/lockbox/model.rb
 - lib/lockbox/padding.rb