class Remotus::Auth::Store

Authentication store base class

Public Instance Methods

credential(_connection, **_options) click to toggle source

Base method fo retrieving a credential from the hash store. This must be overridden in derived classes or it will raise an exception.

@param [Remotus::SshConnection, Remotus::WinrmConnection, host] _connection unused associated connection @param [Hash] _options unused options hash

# File lib/remotus/auth/store.rb, line 14
def credential(_connection, **_options)
  raise Remotus::MissingOverride, "credential method not implemented in credential store #{self.class}"
end
password(connection, **options) click to toggle source

Gets the password for a given connection and options

@param [Remotus::SshConnection, Remotus::WinrmConnection, host] connection associated connection @param [Hash] options options hash

@return [String] password

# File lib/remotus/auth/store.rb, line 38
def password(connection, **options)
  credential(connection, **options)&.password
end
user(connection, **options) click to toggle source

Gets the user for a given connection and options

@param [Remotus::SshConnection, Remotus::WinrmConnection, host] connection associated connection @param [Hash] options options hash

@return [String] user

# File lib/remotus/auth/store.rb, line 26
def user(connection, **options)
  credential(connection, **options)&.user
end