Class: Gem::CredentialStore

# File 'lib/rubygems/credential_store.rb', line 56

def self.instance
  self.for(true)
end

# File 'lib/rubygems/credential_store.rb', line 64

def self.instance=(store)
  @override = store
end

# File 'lib/rubygems/credential_store.rb', line 113

def self.warn_handler=(handler)
  @warn_handler = handler
end

# File 'lib/rubygems/credential_store.rb', line 165

def self.default_backend
  if Gem.win_platform?
    require_relative "credential_store/native/windows"
    WindowsBackend
  elsif RUBY_PLATFORM.include?("darwin")
    require_relative "credential_store/native/macos"
    MacOSBackend
  elsif RUBY_PLATFORM.include?("linux")
    require_relative "credential_store/native/linux"
    LinuxBackend if LinuxBackend.available?
  end
end

# File 'lib/rubygems/credential_store.rb', line 44

def self.for(spec, service: SERVICE_NAME)
  return nil unless spec
  return @override if defined?(@override) && @override

  backend = defined?(@override_backend) && @override_backend ? @override_backend : backend_for(spec)
  (@instances ||= {})[[spec, service]] ||= new(backend: backend, service: service)
end

# File 'lib/rubygems/credential_store.rb', line 122

def self.register_backend(name, backend)
  (@backends ||= {})[name.to_s] = backend
end

# File 'lib/rubygems/credential_store.rb', line 81

def self.reset!
  @override = nil
  @override_backend = nil
  @instances = nil
  @warned = nil
  @warn_handler = nil
end

# File 'lib/rubygems/credential_store.rb', line 137

def self.resolve_backend(name)
  # The setting can carry bytes Regexp#match? would reject. A name that gets
  # past the match is ASCII only, so the require path it builds stays sound.
  name = name.to_s.b
  unless BACKEND_NAME.match?(name)
    warn_once "Ignoring invalid credential store backend name #{name.inspect}."
    return nil
  end

  return @backends[name] if @backends&.key?(name)

  begin
    require "rubygems/credential_store/backends/#{name}"
  rescue LoadError
    warn_once "Credential store backend #{name.inspect} is not installed. " \
              "Install a gem that provides rubygems/credential_store/backends/#{name}, " \
              "or unset the credential_store setting. Falling back to file storage."
    return nil
  end

  @backends && @backends[name]
end

# File 'lib/rubygems/credential_store.rb', line 94

def self.warn_once(message)
  @warned ||= {}
  return if @warned.key?(message)

  @warned[message] = true

  if defined?(@warn_handler) && @warn_handler
    @warn_handler.call(message)
  else
    Gem.ui.alert_warning message
  end
end

# File 'lib/rubygems/credential_store.rb', line 286

def delete_all
  return false unless @backend

  result = @backend.delete_all(@service)
  @cache.clear
  @failed = nil
  invalidate_list
  result
rescue StandardError => e
  warn_failure(:remove, e)
  false
end

# File 'lib/rubygems/credential_store.rb', line 200

def get(account)
  return nil unless @backend
  return @cache[account] if @cache.key?(account)

  @cache[account] = @backend.get(@service, account)
rescue StandardError => e
  warn_failure(:read, e)
  # Retrying means another subprocess and, on some platforms, another
  # authorization prompt. #read_failed? keeps this apart from an absent one.
  (@failed ||= {})[account] = true
  @cache[account] = nil
end

# File 'lib/rubygems/credential_store.rb', line 302

def invalidate_list
  remove_instance_variable(:@list) if defined?(@list)
end

# File 'lib/rubygems/credential_store.rb', line 270

def list
  return nil unless @backend.respond_to?(:list)
  return @list if defined?(@list)

  @list = @backend.list(@service)
rescue StandardError => e
  warn_failure(:list, e)
  # Remembered for the same reason #get remembers a failed read.
  @list = nil
end

# File 'lib/rubygems/credential_store.rb', line 219

def read_failed?(account)
  return false unless defined?(@failed) && @failed

  @failed.key?(account)
end

# File 'lib/rubygems/credential_store.rb', line 228

def set(account, secret)
  return false unless @backend

  validate_credential(account, secret)

  if @backend.set(@service, account, secret)
    @cache[account] = secret
    @failed&.delete(account)
    invalidate_list
    true
  else
    false
  end
rescue StandardError => e
  warn_failure(:write, e)
  false
end

# File 'lib/rubygems/credential_store.rb', line 322

def validate_credential(account, secret)
  raise ArgumentError, "credential secret must be printable ASCII" unless secret.to_s.b.match?(PRINTABLE_ASCII)
  raise ArgumentError, "credential account must not contain a newline" if account.to_s.include?("\n")
  raise ArgumentError, "credential service must not contain a newline" if @service.to_s.include?("\n")
end

# File 'lib/rubygems/credential_store.rb', line 328

def warn_failure(operation, error)
  self.class.warn_once "Credential store #{operation} failed for #{@service}" \
                       " (#{error.class}: #{error.message}); #{OUTCOMES[operation]}."
end