remotus 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46a1f303af4c352742c56801aee8d5ab8ec801361bf26761d49f8726b6e57f9a
-  data.tar.gz: 189b4526eb5c2b76834616d9a399cc601366f4bda6ceffe0d1b8387678d2acd7
+  metadata.gz: 46da915bc63af444b4bed497e154bec84c780f20bb92be17618f22444fd26889
+  data.tar.gz: 43f29167c6c4a9c264208f8c2454278b884edb78ea596cb00d1439db05a846ea
 SHA512:
-  metadata.gz: 475123658ca6e1aff45ddbefc328405dbaf2a163c5d0d5e28f3e4aba66ea0b4685665311f5218d797cda917a35648509b4dd6e17c760212c7722d6a45e00ebb6
-  data.tar.gz: a27f990ea488f4fb6e163dae3478855c2ef9298626936792eda57b0f9eb2f0ed3fc60602d779f9a2fc977a8bece2e8894718116d5b308bdad947f331c686cc7c
+  metadata.gz: e4421747e84af73d3c2648430ccb4717b9ecb01eef6044560a1d28e101f1f2082d357c4d1827c7921aace92b513123c4097419a587d31425d62d3ccbbf0e6d2f
+  data.tar.gz: 40dffbc5f8fa8db04fd9a803d73d3396ce31084da733b653c6636de73eb5e03c644f130b1f51baa6672f94955fb2a5b29fcd6def0b5ec3c8cb59afbc5319453c

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.2.2] - 2021-03-23
+* Ensure both user and password are populated before using a cached credential
+
 ## [0.2.1] - 2021-03-15
 * Fix connection pooling metadata sharing
 * Fix caching of pooled metadata

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remotus (0.2.1)
+    remotus (0.2.2)
       connection_pool (~> 2.2)
       net-scp (~> 3.0)
       net-ssh (~> 6.1)

data/lib/remotus/auth.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "remotus"
 require "remotus/auth/credential"
 require "remotus/auth/store"
 require "remotus/auth/hash_store"
@@ -17,15 +18,12 @@ module Remotus
     # @return [Remotus::Auth::Credential] found credential
     #
     def self.credential(connection, **options)
-      return cache[connection.host] if cache.key?(connection.host)
+      # Only return cached credentials that have a populated user and password, otherwise attempt retrieval
+      return cache[connection.host] if cache.key?(connection.host) && cache[connection.host].user && cache[connection.host].password
+
+      found_credential = credential_from_stores(connection, **options)
+      return found_credential if found_credential
 
-      stores.each do |store|
-        host_cred = store.credential(connection, **options)
-        if host_cred
-          cache[connection.host] = host_cred
-          return host_cred
-        end
-      end
       raise Remotus::MissingCredential, "Could not find credential for #{connection.host} in any credential store (#{stores.join(", ")})."
     end
 
@@ -62,5 +60,31 @@ module Remotus
     def self.stores=(stores)
       @stores = stores
     end
+
+    class << self
+      private
+
+      #
+      # Gets authentication credentials for the given connection and options from one of the credential stores
+      #
+      # @param [Remotus::SshConnection, Remotus::WinrmConnection, #host] connection remote connection
+      # @param [Hash] options options hash
+      #                       options may be used by different credential stores.
+      #
+      # @return [Remotus::Auth::Credential, nil] found credential or nil if the credential cannot be found
+      #
+      def credential_from_stores(connection, **options)
+        stores.each do |store|
+          Remotus.logger.debug { "Gathering #{connection.host} credentials from #{store} credential store" }
+          host_cred = store.credential(connection, **options)
+          next unless host_cred
+
+          Remotus.logger.debug { "#{connection.host} credentials found in #{store} credential store" }
+          cache[connection.host] = host_cred
+          return host_cred
+        end
+        nil
+      end
+    end
   end
 end

data/lib/remotus/auth/hash_store.rb

@@ -15,7 +15,7 @@ module Remotus
       #
       # Retrieves a credential from the hash store
       #
-      # @param [Remotus::SshConnection, Remotus::WinrmConnection, #host] connection <description>
+      # @param [Remotus::SshConnection, Remotus::WinrmConnection, #host] connection associated connection
       # @param [Hash] _options unused options hash
       #
       # @return [Remotus::Auth::Credential, nil] found credential or nil

data/lib/remotus/version.rb

@@ -2,5 +2,5 @@
 
 module Remotus
   # Remotus gem version
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotus
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Matthew Newell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool