Class: Gem::ConfigFile

# File 'lib/rubygems/config_file.rb', line 775

def self.deep_transform_config_keys!(config)
  config.transform_keys! do |k|
    if k.match?(/\A:(.*)\z/)
      k[1..-1].to_sym
    elsif k.include?("__") || k.end_with?("/")
      if k.is_a?(Symbol)
        k.to_s.gsub(/__/,".").delete_suffix("/").to_sym
      else
        k.dup.gsub(/__/,".").delete_suffix("/")
      end
    else
      k
    end
  end

  config.transform_values! do |v|
    if v.is_a?(String)
      if v.match?(/\A:(.*)\z/)
        v[1..-1].to_sym
      elsif v.match?(/\A[-]?\d\z/)
        v.to_i
      elsif v.match?(/\A(?:true|false)\z/)
        v == "true"
      elsif v.empty?
        nil
      else
        v
      end
    elsif v.respond_to?(:empty?) && v.empty?
      nil
    elsif v.is_a?(Hash)
      deep_transform_config_keys!(v)
    else
      v
    end
  end

  config
end

# File 'lib/rubygems/config_file.rb', line 728

def self.dump_with_rubygems_yaml(content)
  content.transform_keys! do |k|
    k.is_a?(Symbol) ? ":#{k}" : k
  end

  require_relative "yaml_serializer"
  Gem::YAMLSerializer.dump(content)
end

# File 'lib/rubygems/config_file.rb', line 737

def self.load_with_rubygems_config_hash(yaml)
  require_relative "yaml_serializer"

  content = Gem::YAMLSerializer.load(yaml, permitted_classes: [])
  return {} unless content.is_a?(Hash)

  deep_transform_config_keys!(content)
end

# File 'lib/rubygems/config_file.rb', line 769

def self.normalize_credentials_key(host)
  return host unless host.is_a?(String)

  deep_transform_config_keys!(host => nil).keys.first
end

# File 'lib/rubygems/config_file.rb', line 571

def backtrace
  @backtrace || $DEBUG
end

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

attr_writer :backtrace

# File 'lib/rubygems/config_file.rb', line 128

attr_accessor :bulk_threshold

# File 'lib/rubygems/config_file.rb', line 184

attr_accessor :cert_expiration_length_days

# File 'lib/rubygems/config_file.rb', line 155

attr_accessor :concurrent_downloads

# File 'lib/rubygems/config_file.rb', line 142

attr_accessor :cooldown

# File 'lib/rubygems/config_file.rb', line 227

attr_accessor :credential_store

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

attr_accessor :disable_default_gem_server

# File 'lib/rubygems/config_file.rb', line 206

attr_accessor :global_gem_cache

# File 'lib/rubygems/config_file.rb', line 725

attr_reader :hash

# File 'lib/rubygems/config_file.rb', line 117

attr_accessor :home

# File 'lib/rubygems/config_file.rb', line 189

attr_accessor :install_extension_in_lib

# File 'lib/rubygems/config_file.rb', line 195

attr_accessor :ipv4_fallback_enabled

# File 'lib/rubygems/config_file.rb', line 600

def last_update_check
  if File.readable?(state_file_name)
    File.read(state_file_name).to_i
  else
    0
  end
end

# File 'lib/rubygems/config_file.rb', line 609

def last_update_check=(timestamp)
  File.write(state_file_name, timestamp.to_s) if state_file_writable?
end

# File 'lib/rubygems/config_file.rb', line 112

attr_accessor :path

# File 'lib/rubygems/config_file.rb', line 400

def rubygems_api_key
  load_api_keys unless @rubygems_api_key

  # #load_api_keys only reads the credentials file, which no longer holds the
  # key once it is stored. A copy left there after the move is stale.
  credential_store_default_api_key || @rubygems_api_key
end

# File 'lib/rubygems/config_file.rb', line 411

def rubygems_api_key=(api_key)
  if credential_store
    store = active_credential_store

    if api_key.to_s.empty?
      warn_unremoved_credential(CREDENTIAL_STORE_DEFAULT_ACCOUNT) if store&.available? && !store.delete(CREDENTIAL_STORE_DEFAULT_ACCOUNT)
    elsif store&.set(CREDENTIAL_STORE_DEFAULT_ACCOUNT, api_key)
      remove_api_key_from_file(:rubygems_api_key)
      @rubygems_api_key = api_key
      return
    else
      warn_unremoved_credential(CREDENTIAL_STORE_DEFAULT_ACCOUNT) if store&.available? && !store.delete(CREDENTIAL_STORE_DEFAULT_ACCOUNT)
      warn_credential_store_fallback
    end
  end

  set_api_key :rubygems_api_key, api_key

  @rubygems_api_key = api_key
end

# File 'lib/rubygems/config_file.rb', line 179

attr_accessor :sources

# File 'lib/rubygems/config_file.rb', line 175

attr_accessor :ssl_ca_cert

# File 'lib/rubygems/config_file.rb', line 216

attr_reader :ssl_client_cert

# File 'lib/rubygems/config_file.rb', line 169

attr_reader :ssl_verify_mode

# File 'lib/rubygems/config_file.rb', line 576

def state_file_writable?
  if File.exist?(state_file_name)
    File.writable?(state_file_name)
  else
    require "fileutils"
    FileUtils.mkdir_p File.dirname(state_file_name)
    File.open(state_file_name, "w") {}
    true
  end
rescue Errno::EACCES
  false
end

# File 'lib/rubygems/config_file.rb', line 160

attr_accessor :update_sources

# File 'lib/rubygems/config_file.rb', line 211

attr_accessor :use_psych

# File 'lib/rubygems/config_file.rb', line 150

attr_accessor :verbose

# File 'lib/rubygems/config_file.rb', line 707

def [](key)
  @hash[key] || @hash[key.to_s]
end

# File 'lib/rubygems/config_file.rb', line 712

def []=(key, value)
  @hash[key] = value
end

# File 'lib/rubygems/config_file.rb', line 815

def active_credential_store
  return nil unless credential_store

  require_relative "credential_store"
  Gem::CredentialStore.for(credential_store)
end

# File 'lib/rubygems/config_file.rb', line 330

def api_keys
  load_api_keys unless @api_keys

  @api_keys
end

# File 'lib/rubygems/config_file.rb', line 340

def check_credentials_permissions
  return if Gem.win_platform? # windows doesn't write 0600 as 0600
  return unless File.exist? credentials_path

  existing_permissions = File.stat(credentials_path).mode & 0o777

  return if existing_permissions == 0o600

  alert_error <<-ERROR
Your gem push credentials file located at:

\t#{credentials_path}

has file permissions of 0#{existing_permissions.to_s 8} but 0600 is required.

To fix this error run:

\tchmod 0600 #{credentials_path}

You should reset your credentials at:

\thttps://rubygems.org/profile/edit

if you believe they were disclosed to a third party.
  ERROR

  terminate_interaction 1
end

# File 'lib/rubygems/config_file.rb', line 590

def config_file_name
  @config_file_name || Gem.config_file
end

# File 'lib/rubygems/config_file.rb', line 440

def credential_store_api_key_for(host)
  return nil if host.nil? || host.to_s.empty?
  return nil unless credential_store
  return nil unless store = active_credential_store

  store.get(self.class.credential_store_account(host))
end

# File 'lib/rubygems/config_file.rb', line 471

def credential_store_default_api_key
  return nil unless credential_store
  return nil unless store = active_credential_store

  store.get(CREDENTIAL_STORE_DEFAULT_ACCOUNT)
end

# File 'lib/rubygems/config_file.rb', line 454

def credential_store_read_failed_for?(host)
  return false unless credential_store
  return false unless store = active_credential_store

  # #rubygems_api_key reads the default account on the way to answering, and
  # for the default host that is the only failure that can happen.
  return true if store.read_failed?(CREDENTIAL_STORE_DEFAULT_ACCOUNT)
  return false if host.nil? || host.to_s.empty?

  store.read_failed?(self.class.credential_store_account(host))
end

# File 'lib/rubygems/config_file.rb', line 372

def credentials_path
  credentials = File.join Gem.user_home, ".gem", "credentials"
  if File.exist? credentials
    credentials
  else
    File.join Gem.data_home, "gem", "credentials"
  end
end

# File 'lib/rubygems/config_file.rb', line 851

def delete_stored_key(store, host)
  account = self.class.credential_store_account(host)
  warn_unremoved_credential(account) if store&.available? && !store.delete(account)
end

# File 'lib/rubygems/config_file.rb', line 614

def each(&block)
  hash = @hash.dup
  hash.delete :update_sources
  hash.delete :verbose
  hash.delete :backtrace
  hash.delete :bulk_threshold

  yield :update_sources, @update_sources
  yield :verbose, @verbose
  yield :backtrace, @backtrace
  yield :bulk_threshold, @bulk_threshold

  yield "config_file_name", @config_file_name if @config_file_name

  hash.each(&block)
end

# File 'lib/rubygems/config_file.rb', line 632

def handle_arguments(arg_list)
  @args = []

  arg_list.each do |arg|
    case arg
    when /^--(backtrace|traceback)$/ then
      @backtrace = true
    when /^--debug$/ then
      $DEBUG = true

      warn "NOTE:  Debugging mode prints all exceptions even when rescued"
    else
      @args << arg
    end
  end
end

# File 'lib/rubygems/config_file.rb', line 381

def load_api_keys
  check_credentials_permissions

  @api_keys = if File.exist? credentials_path
    load_file(credentials_path)
  else
    @hash
  end

  if @api_keys.key? :rubygems_api_key
    @rubygems_api_key    = @api_keys[:rubygems_api_key]
    @api_keys[:rubygems] = @api_keys.delete :rubygems_api_key unless
      @api_keys.key? :rubygems
  end
end

# File 'lib/rubygems/config_file.rb', line 546

def load_file(filename)
  yaml_errors = [ArgumentError]

  return {} unless filename && !filename.empty? && File.exist?(filename)

  begin
    config = self.class.load_with_rubygems_config_hash(File.read(filename))
    has_invalid_keys = config.keys.any? {|k| k.to_s.gsub(%r{https?:\/\/}, "").include?(": ") }
    has_invalid_values = config.values.any? {|v| v.is_a?(String) && v.gsub(%r{https?:\/\/}, "").match?(/\A\S+: /) }
    if has_invalid_keys || has_invalid_values
      warn "Failed to load #{filename} because it doesn't contain valid YAML hash"
      return {}
    else
      return config
    end
  rescue *yaml_errors => e
    warn "Failed to load #{filename}, #{e}"
  rescue Errno::EACCES
    warn "Failed to load #{filename} due to permissions problem."
  end

  {}
end

# File 'lib/rubygems/config_file.rb', line 881

def normalize_credential_store(value, default)
  # An environment variable can carry bytes String#downcase would reject.
  normalized = value.to_s.b.downcase

  if normalized.empty?
    default
  elsif CREDENTIAL_STORE_OFF.include?(normalized)
    false
  elsif CREDENTIAL_STORE_ON.include?(normalized)
    true
  else
    value
  end
end

# File 'lib/rubygems/config_file.rb', line 650

def really_verbose
  case verbose
  when true, false, nil then
    false
  else
    true
  end
end

# File 'lib/rubygems/config_file.rb', line 833

def remove_api_key_from_file(host)
  return unless File.exist?(credentials_path)

  unless File.writable?(credentials_path)
    alert_warning "The API key moved to the credential store but the plain text copy " \
                  "in #{credentials_path} could not be removed. Delete it yourself."
    return
  end

  key = self.class.normalize_credentials_key(host)
  config = load_file(credentials_path)
  return unless config.key?(key)

  config.delete(key)
  write_credentials(config)
  load_api_keys
end

# File 'lib/rubygems/config_file.rb', line 481

def set_api_key(host, api_key)
  if credential_store && host != :rubygems_api_key
    store = active_credential_store

    if api_key.to_s.empty?
      delete_stored_key(store, host)
    elsif store&.set(self.class.credential_store_account(host), api_key)
      remove_api_key_from_file(host)
      return
    else
      delete_stored_key(store, host)
      warn_credential_store_fallback
    end
  end

  check_credentials_permissions

  config = load_file(credentials_path).merge(self.class.normalize_credentials_key(host) => api_key)

  write_credentials(config)

  load_api_keys # reload
end

# File 'lib/rubygems/config_file.rb', line 896

def set_config_file_name(args)
  @config_file_name = ENV["GEMRC"]
  need_config_file_name = false

  args.each do |arg|
    if need_config_file_name
      @config_file_name = arg
      need_config_file_name = false
    elsif arg =~ /^--config-file=(.*)/
      @config_file_name = $1
    elsif /^--config-file$/.match?(arg)
      need_config_file_name = true
    end
  end
end

# File 'lib/rubygems/config_file.rb', line 595

def state_file_name
  Gem.state_file
end

# File 'lib/rubygems/config_file.rb', line 660

def to_yaml # :nodoc:
  yaml_hash = {}
  yaml_hash[:backtrace] = @hash.fetch(:backtrace, DEFAULT_BACKTRACE)
  yaml_hash[:bulk_threshold] = @hash.fetch(:bulk_threshold, DEFAULT_BULK_THRESHOLD)
  yaml_hash[:sources] = Gem.sources.to_a
  yaml_hash[:update_sources] = @hash.fetch(:update_sources, DEFAULT_UPDATE_SOURCES)
  yaml_hash[:verbose] = @hash.fetch(:verbose, DEFAULT_VERBOSITY)

  yaml_hash[:concurrent_downloads] =
    @hash.fetch(:concurrent_downloads, DEFAULT_CONCURRENT_DOWNLOADS)

  yaml_hash[:install_extension_in_lib] =
    @hash.fetch(:install_extension_in_lib, DEFAULT_INSTALL_EXTENSION_IN_LIB)

  yaml_hash[:ssl_verify_mode] =
    @hash[:ssl_verify_mode] if @hash.key? :ssl_verify_mode

  yaml_hash[:ssl_ca_cert] =
    @hash[:ssl_ca_cert] if @hash.key? :ssl_ca_cert

  yaml_hash[:ssl_client_cert] =
    @hash[:ssl_client_cert] if @hash.key? :ssl_client_cert

  keys = yaml_hash.keys.map(&:to_s)
  keys << "debug"
  re = Regexp.union(*keys)

  @hash.each do |key, value|
    key = key.to_s
    next if key&.match?(re)
    yaml_hash[key.to_s] = value
  end

  self.class.dump_with_rubygems_yaml(yaml_hash)
end

# File 'lib/rubygems/config_file.rb', line 511

def unset_api_key!
  store = active_credential_store
  store_cleared =
    if store.nil?
      true
    elsif store.available?
      store.delete_all
    else
      # Failing here would make signout exit 1 on every platform without a
      # native store, and plain success would claim a removal nobody made.
      Gem::CredentialStore.warn_once "The credential store is enabled but unavailable, so any key it holds was left in place."
      true
    end

  file_removed =
    if File.exist?(credentials_path)
      # POSIX deletes a read-only file whenever the directory is writable, so
      # the marking has to be honored explicitly.
      if File.writable?(credentials_path)
        begin
          File.delete(credentials_path)
          true
        rescue SystemCallError
          false
        end
      else
        false
      end
    else
      false
    end

  [store_cleared, file_removed]
end

# File 'lib/rubygems/config_file.rb', line 862

def warn_credential_store_fallback
  alert_warning "Could not write the API key to the credential store, so it was written to #{credentials_path} in plain text."
end

# File 'lib/rubygems/config_file.rb', line 856

def warn_unremoved_credential(account)
  alert_warning "Could not remove the API key for #{account} from the credential store. " \
                "It is still there and will be used instead of the one just set. " \
                "Remove it with your platform's credential manager."
end

# File 'lib/rubygems/config_file.rb', line 697

def write
  require "fileutils"
  FileUtils.mkdir_p File.dirname(config_file_name)

  File.open config_file_name, "w" do |io|
    io.write to_yaml
  end
end

# File 'lib/rubygems/config_file.rb', line 822

def write_credentials(config)
  dirname = File.dirname credentials_path
  require "fileutils"
  FileUtils.mkdir_p(dirname)

  permissions = 0o600 & ~File.umask
  File.open(credentials_path, "w", permissions) do |f|
    f.write self.class.dump_with_rubygems_yaml(config)
  end
end