secure_credentials 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baefe8bdd2471d662ae34de970a0407e784ea6305cdb0ed4f8325a5743fecc44
-  data.tar.gz: e1a11e5de1a3b6c9e5d9612d28e23189bcb3bfd7250b9e2fb09a2993e9a69781
+  metadata.gz: d2476d0c44a0cb5df3796eef53a98a2e45863aacd1835ed0c4bf2e2aeb04f370
+  data.tar.gz: c9a7ea3212f40ed7ac59bfbae2a93bd2f97221807ccd1f389c9913eca3679d65
 SHA512:
-  metadata.gz: f1cdd618b4381eea588ed2703c8b347685d4cf369853e1716fe3f1ad91048898a50571823f3d948ec2ae8b078609e854596393e7f7747e2d7696cdf1edc43c1e
-  data.tar.gz: 494164b9046a187d753380daba71f72038616edbd363226e9e0e91948023b4b84144f7b839a29e2c3094c48b9cd024df616530fccf74d52eecd61547cd8ddfd1
+  metadata.gz: e0b99b7e6728a0f665bd9e13363f8b35c643df8b2632e646d472e1a8e0fa7e6dd3e5523a91bc6888f89e2ce41cc8189cdf0c6bcbd74b999df211706942fcc9b6
+  data.tar.gz: 85e319bdde06ec3db186f72825e12cae6f7c59ae6a922049abdbdae030ff05dfd0ea949d24461e6dfd6c5359ec2cfe3ffa59ec4e5bfa8319a09e4007c680c695

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# Unreleased
+
+# 0.2.3
+- Fix using explicit `key_path` when different `master.key` exists.
+
 # 0.2.2
 - Backport encrypted:edit for Rails 5.1.
 

data/lib/secure_credentials.rb

@@ -6,17 +6,6 @@ require 'secure_credentials/version'
 # is to help you to avoid it.
 module SecureCredentials
   class FileNotFound < StandardError; end
-
-  module_function
-
-  attr_writer :master_key
-
-  def master_key
-    return @master_key if @master_key
-    return unless defined?(::Rails)
-    key_path = ::Rails.root.join('config/master.key')
-    key_path.binread.strip if key_path.exist?
-  end
 end
 
 require 'secure_credentials/store'

data/lib/secure_credentials/encrypted_file.rb

@@ -6,28 +6,19 @@ rescue LoadError
 end
 
 module SecureCredentials
-  # Wraps ActiveSupport::EncryptedFile and provides passing key as an argument.
-  # Automatically generates missing key filenames based on store filename.
+  # Wraps ActiveSupport::EncryptedFile to accept key as an argument.
   class EncryptedFile < ActiveSupport::EncryptedFile
-    class << self
-      # Same file name but with `.key` extension instead of `.enc`.
-      def default_key_path_for(filename)
-        filename.sub_ext('.key')
-      end
-    end
-
-    def initialize(path, key = nil, key_path: nil, env_key: nil)
+    def initialize(key: nil, key_path: nil, env_key: nil, **options)
       @key = key
       super(
-        content_path: path,
-        key_path: key_path || self.class.default_key_path_for(path),
+        **options,
         env_key: env_key,
-        raise_if_missing_key: true,
+        key_path: key_path || key && '' # original implementation does not accept nil
       )
     end
 
     def key
-      @key || read_env_key || read_key_file || SecureCredentials.master_key || handle_missing_key
+      @key || super
     end
   end
 end

data/lib/secure_credentials/rails/application_methods.rb

@@ -15,6 +15,8 @@ module SecureCredentials
       end
 
       def read_secure_credentials(path, key_path: nil, **options)
+        # Unlike Rails we don't provide default value for key_path
+        # to be able to generate it based on path.
         key_path &&= ::Rails.root.join(key_path)
         store = Store.new(::Rails.root.join(path), key_path: key_path, env: ::Rails.env, **options)
         Credentials.new(store)

data/lib/secure_credentials/store.rb

@@ -33,10 +33,13 @@ module SecureCredentials
       # Finds the most appropriate existing file for given path and env.
       # Returns `[environmental?, encrypted?, filename]`.
       def detect_filename(path, env)
-        stub_ext_path = Pathname.new("#{path}.stub")
-        if path.basename.to_s.include?('.yml')
+        # Backward compatibility with original Rails implementation:
+        # if filename is given with extension then we don't try to detect
+        # environmental and/or encrypted variant.
+        if path.basename.to_s =~ /\.yml(\.enc)?\z/i
           [false, path.basename.to_s.end_with?('.enc'), path]
         else
+          stub_ext_path = Pathname.new("#{path}.stub")
           [
             [true,  true,   stub_ext_path.sub_ext(".#{env}.yml.enc")],
             [true,  false,  stub_ext_path.sub_ext(".#{env}.yml")],
@@ -46,6 +49,14 @@ module SecureCredentials
         end
       end
 
+      # Looks for key file for given path replacing `.yml.enc` with `.key`.
+      # It falls back to `config/master.key` in Rails app if file does not exist.
+      def detect_key_path_for(path)
+        return unless path.to_s.end_with?('.yml.enc')
+        key_path = path.sub_ext('').sub_ext('.key')
+        key_path.exist? || !defined?(::Rails) ? key_path : ::Rails.root.join('config/master.key')
+      end
+
       def env_key_for(path)
         "#{path.basename.to_s.upcase}_KEY"
       end
@@ -60,12 +71,12 @@ module SecureCredentials
     alias_method :environmental?, :environmental
     alias_method :encrypted?, :encrypted
 
-    def initialize(path, key = nil, env: nil, key_path: nil, env_key: nil)
+    def initialize(path, env: nil, key: nil, key_path: nil, env_key: nil)
       @path = path = Pathname.new(path)
       @env = env
       @environmental, @encrypted, @filename = self.class.detect_filename(path, env)
       @key = key
-      @key_path = key_path || filename && filename.sub_ext('').sub_ext('.key')
+      @key_path = key_path || self.class.detect_key_path_for(filename)
       @env_key = env_key || self.class.env_key_for(path)
     end
 
@@ -107,7 +118,13 @@ module SecureCredentials
     end
 
     def encrypted_file
-      EncryptedFile.new(filename, key, key_path: key_path, env_key: env_key)
+      EncryptedFile.new(
+        content_path: filename,
+        key: key,
+        key_path: key_path,
+        env_key: env_key,
+        raise_if_missing_key: true
+      )
     end
   end
 end

data/lib/secure_credentials/version.rb

@@ -1,3 +1,3 @@
 module SecureCredentials
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secure_credentials
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Max Melentiev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport