settings_reader-vault_resolver 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 200d04472a50277f38b29b18a30b565588e4c5fa7c55a2b654b70bb9dbbc0e62
-  data.tar.gz: 48ec7877b81d458ad9c22b14cdbce6ce05b1a22a141e7c978c3a19c7f6796037
+  metadata.gz: 06c1605f97de84c90b6ec0e9c82ba9bfbbe3bd66fa7e1b0e7ef84f576264e581
+  data.tar.gz: 546fc50b041e31d4cdd67850eda46b6047c17fb014bb782ffade8e321071e0a0
 SHA512:
-  metadata.gz: 365fa301486b2df995dc0eacd1e5492ee2f59dd68c26e251f13d813ed49dec7bb0d295de316c3b4edee924785bc03a61e872e48ad67c75e8dc1caa993ad194d0
-  data.tar.gz: 9129f937c54959ea99fcd99647889ccfa22b23783f33f89bdc665d5226b562dbcb6369629927076be3c4be869280a87477251b6bd63e1dc39ded8e8bbc62f22f
+  metadata.gz: 670cebdbec3ebaf40595ccf60d8e9cd749559e0141a395fe87655d684b406d223fd7e9939faa42dd6e5ae1588b688d04a0d4c7d3960bc56b964f8e1a6faa4bdc
+  data.tar.gz: af74dd636a40ba907f8df0fd094b0a1537e4ce4fd9f959efce3b413a0b036c6e35ce892ae67af82e4a493a575086fea4d3c37ebc28df5f44d83e1ebcd3f39742

data/lib/settings_reader/vault_resolver/address.rb

@@ -26,6 +26,10 @@ module SettingsReader
         URI.decode_www_form(@uri.query || '').to_h
       end
 
+      def no_cache?
+        options['no_cache'] == 'true'
+      end
+
       def to_s
         @uri.to_s
       end

data/lib/settings_reader/vault_resolver/cache.rb

@@ -23,7 +23,7 @@ module SettingsReader
       end
 
       def fetch(address, &block)
-        if (exiting_entry = retrieve(address))
+        if !address.no_cache? && (exiting_entry = retrieve(address))
           exiting_entry
         else
           new_entry = block.call(address)
@@ -36,6 +36,10 @@ module SettingsReader
         @secrets.each_value(&block)
       end
 
+      def active_entries(&block)
+        @secrets.values.select(&:active?).each(&block)
+      end
+
       def clear_all
         @secrets = {}
       end

data/lib/settings_reader/vault_resolver/configuration.rb

@@ -34,6 +34,10 @@ module SettingsReader
       # Default: empty proc
       attr_accessor :vault_initializer
 
+      # Block to be executed when "lease not found" error is raised
+      # Default: empty proc
+      attr_accessor :lease_not_found_handler
+
       def initialize
         @logger = Logger.new($stdout, level: Logger::ERROR)
         @retrieval_retries = 2
@@ -43,6 +47,7 @@ module SettingsReader
         @lease_renew_error_listener = -> {}
         @lease_renew_success_listener = -> {}
         @vault_initializer = -> {}
+        @lease_not_found_handler = ->(_entry) {}
       end
 
       def setup_lease_refresher(cache, previous_task = nil)

data/lib/settings_reader/vault_resolver/engines/abstract.rb

@@ -16,7 +16,7 @@ module SettingsReader
         end
 
         def get(address)
-          return unless (vault_secret = get_secret_with_authentication(address))
+          return unless (vault_secret = get_and_retry_auth(address))
 
           wrap_secret(address, vault_secret)
         rescue Vault::VaultError => e
@@ -26,42 +26,40 @@ module SettingsReader
         def renew(entry)
           return unless entry.leased?
 
-          new_secret = renew_lease_with_authentication(entry)
+          new_secret = renew_and_retry_auth(entry)
           entry.update_renewed(new_secret)
           true
-        rescue Vault::VaultError => e
-          raise SettingsReader::VaultResolver::Error, e.message
         end
 
         protected
 
-        def get_secret_with_authentication(address)
-          get_secret_with_retries(address)
-        rescue Vault::HTTPClientError => e # if not authenticated, let's reauthenticate and try once more
-          raise unless e.code == 403
+        def get_and_retry_auth(address)
+          get_and_retry_connection(address)
+        rescue Vault::HTTPError => e # if not authenticated, let's reauthenticate and try once more
+          raise unless auth_error?(e)
 
           config.vault_initializer.call
-          get_secret_with_retries(address)
+          get_and_retry_connection(address)
         end
 
-        def get_secret_with_retries(address)
+        def get_and_retry_connection(address)
           Vault.with_retries(Vault::HTTPConnectionError, attempts: config.retrieval_retries) do
             get_secret(address)
           end
         end
 
-        def renew_lease_with_authentication(address)
-          renew_lease_with_retries(address)
-        rescue Vault::HTTPClientError => e # if not authenticated, let's reauthenticate and try once more
-          raise unless e.code == 403
+        def renew_and_retry_auth(entry)
+          renew_and_retry_connection(entry)
+        rescue Vault::HTTPError => e # if not authenticated, let's reauthenticate and try once more
+          raise unless auth_error?(e)
 
           config.vault_initializer.call
-          renew_lease_with_retries(address)
+          renew_and_retry_connection(entry)
         end
 
-        def renew_lease_with_retries(address)
+        def renew_and_retry_connection(entry)
           Vault.with_retries(Vault::HTTPConnectionError, attempts: config.lease_renew_retries) do
-            renew_lease(address)
+            renew_lease(entry)
           end
         end
 
@@ -76,6 +74,10 @@ module SettingsReader
         def wrap_secret(address, secret)
           SettingsReader::VaultResolver::Entry.new(address, secret)
         end
+
+        def auth_error?(error)
+          error.code == 403 || error.message =~ /token mac for token_version.*is incorrect/
+        end
       end
     end
   end

data/lib/settings_reader/vault_resolver/engines/auth.rb

@@ -12,6 +12,16 @@ module SettingsReader
 
         protected
 
+        # Auth backend should not retry auth errors as it causing infinite recursion
+        def get_and_retry_auth(address)
+          get_and_retry_connection(address)
+        end
+
+        # Auth backend should not retry auth errors as it causing infinite recursion
+        def renew_and_retry_auth(address)
+          renew_and_retry_connection(address)
+        end
+
         def get_secret(address)
           return k8s_auth(address) if address.path == K8S_AUTH
 

data/lib/settings_reader/vault_resolver/entry.rb

@@ -23,6 +23,10 @@ module SettingsReader
         Time.now > @lease_started + lease_duration
       end
 
+      def active?
+        !expired?
+      end
+
       def expires_in
         return MONTH unless leased?
 

data/lib/settings_reader/vault_resolver/helpers/vault_authentication.rb

@@ -8,8 +8,9 @@ module SettingsReader
         FAKE_RESOLVER_PATH = 'vault/authentication'.freeze
 
         def authenticate_via_k8s(role, route: nil, service_token_path: nil)
-          params = URI.encode_www_form({ role: role, route: route, service_token_path: service_token_path }.compact)
-          resolver.resolve("vault://auth/kubernetes/login?#{params}#client_token", FAKE_RESOLVER_PATH)
+          params = { role: role, route: route, service_token_path: service_token_path, no_cache: true }
+          url_params = URI.encode_www_form(params.compact)
+          resolver.resolve("vault://auth/kubernetes/login?#{url_params}#client_token", FAKE_RESOLVER_PATH)
         end
 
         private

data/lib/settings_reader/vault_resolver/refresher.rb

@@ -18,7 +18,7 @@ module SettingsReader
 
       def refresh
         info { 'Performing Vault leases refresh' }
-        promises = cache.entries.map do |entry|
+        promises = cache.active_entries.map do |entry|
           debug { "Checking lease for #{entry}. Leased?: #{entry.leased?}. Expires in: #{entry.expires_in}s" }
           refresh_entry(entry)
         end.compact
@@ -35,10 +35,27 @@ module SettingsReader
           info { "Lease renewed for #{entry}. Expires in: #{entry.expires_in}" }
           entry
         rescue StandardError => e
-          error { "Error refreshing lease for #{entry}: #{e.message}" }
-          raise SettingsReader::VaultResolver::Error, e.message
+          handle_refresh_error(e, entry)
         end
       end
+
+      private
+
+      def handle_refresh_error(error, entry)
+        handle_lease_not_found(entry) if lease_not_found_error?(error)
+
+        error { "Error refreshing lease for #{entry}: #{error.message}" }
+        raise SettingsReader::VaultResolver::Error, error.message
+      end
+
+      def lease_not_found_error?(error)
+        error.is_a?(Vault::HTTPClientError) && error.code == 400 && error.message =~ /lease not found/
+      end
+
+      def handle_lease_not_found(entry)
+        cache.clear(entry)
+        config.lease_not_found_handler.call(entry)
+      end
     end
   end
 end

data/lib/settings_reader/vault_resolver/version.rb

@@ -1,5 +1,5 @@
 module SettingsReader
   module VaultResolver
-    VERSION = '0.4.3'.freeze
+    VERSION = '0.4.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settings_reader-vault_resolver
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Volodymyr Mykhailyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby