rubygems-update 3.3.18 → 3.6.2

data/lib/rubygems/gemcutter_utilities.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
-require_relative 'remote_fetcher'
-require_relative 'text'
+
+require_relative "remote_fetcher"
+require_relative "text"
+require_relative "gemcutter_utilities/webauthn_listener"
+require_relative "gemcutter_utilities/webauthn_poller"
 
 ##
 # Utility methods for using the RubyGems API.
 
 module Gem::GemcutterUtilities
-
   ERROR_CODE = 1
-  API_SCOPES = %i[index_rubygems push_rubygem yank_rubygem add_owner remove_owner access_webhooks show_dashboard].freeze
+  API_SCOPES = [:index_rubygems, :push_rubygem, :yank_rubygem, :add_owner, :remove_owner, :access_webhooks].freeze
+  EXCLUSIVELY_API_SCOPES = [:show_dashboard].freeze
 
   include Gem::Text
 
@@ -19,8 +22,8 @@ module Gem::GemcutterUtilities
   # Add the --key option
 
   def add_key_option
-    add_option('-k', '--key KEYNAME', Symbol,
-               'Use the given API key',
+    add_option("-k", "--key KEYNAME", Symbol,
+               "Use the given API key",
                "from #{Gem.configuration.credentials_path}") do |value,options|
       options[:key] = value
     end
@@ -30,9 +33,9 @@ module Gem::GemcutterUtilities
   # Add the --otp option
 
   def add_otp_option
-    add_option('--otp CODE',
-               'Digit code for multifactor authentication',
-               'You can also use the environment variable GEM_HOST_OTP_CODE') do |value, options|
+    add_option("--otp CODE",
+               "Digit code for multifactor authentication",
+               "You can also use the environment variable GEM_HOST_OTP_CODE") do |value, options|
       options[:otp] = value
     end
   end
@@ -59,6 +62,10 @@ module Gem::GemcutterUtilities
     options[:otp] || ENV["GEM_HOST_OTP_CODE"]
   end
 
+  def webauthn_enabled?
+    options[:webauthn]
+  end
+
   ##
   # The host to connect to either from the RUBYGEMS_HOST environment variable
   # or from the user's configuration
@@ -69,9 +76,8 @@ module Gem::GemcutterUtilities
 
     @host ||=
       begin
-        env_rubygems_host = ENV['RUBYGEMS_HOST']
-        env_rubygems_host = nil if
-          env_rubygems_host and env_rubygems_host.empty?
+        env_rubygems_host = ENV["RUBYGEMS_HOST"]
+        env_rubygems_host = nil if env_rubygems_host&.empty?
 
         env_rubygems_host || configured_host
       end
@@ -82,8 +88,8 @@ module Gem::GemcutterUtilities
   #
   # If +allowed_push_host+ metadata is present, then it will only allow that host.
 
-  def rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, &block)
-    require 'net/http'
+  def rubygems_api_request(method, path, host = nil, allowed_push_host = nil, scope: nil, credentials: {}, &block)
+    require_relative "vendored_net_http"
 
     self.host = host if host
     unless self.host
@@ -92,8 +98,8 @@ module Gem::GemcutterUtilities
     end
 
     if allowed_push_host
-      allowed_host_uri = URI.parse(allowed_push_host)
-      host_uri         = URI.parse(self.host)
+      allowed_host_uri = Gem::URI.parse(allowed_push_host)
+      host_uri         = Gem::URI.parse(self.host)
 
       unless (host_uri.scheme == allowed_host_uri.scheme) && (host_uri.host == allowed_host_uri.host)
         alert_error "#{self.host.inspect} is not allowed by the gemspec, which only allows #{allowed_push_host.inspect}"
@@ -101,11 +107,11 @@ module Gem::GemcutterUtilities
       end
     end
 
-    uri = URI.parse "#{self.host}/#{path}"
+    uri = Gem::URI.parse "#{self.host}/#{path}"
     response = request_with_otp(method, uri, &block)
 
     if mfa_unauthorized?(response)
-      ask_otp
+      fetch_otp(credentials)
       response = request_with_otp(method, uri, &block)
     end
 
@@ -118,27 +124,26 @@ module Gem::GemcutterUtilities
   end
 
   def mfa_unauthorized?(response)
-    response.kind_of?(Net::HTTPUnauthorized) && response.body.start_with?('You have enabled multifactor authentication')
+    response.is_a?(Gem::Net::HTTPUnauthorized) && response.body.start_with?("You have enabled multifactor authentication")
   end
 
   def update_scope(scope)
-    sign_in_host        = self.host
+    sign_in_host        = host
     pretty_host         = pretty_host(sign_in_host)
     update_scope_params = { scope => true }
 
     say "The existing key doesn't have access of #{scope} on #{pretty_host}. Please sign in to update access."
 
-    email    = ask "   Email: "
-    password = ask_for_password "Password: "
+    identifier = ask "Username/email: "
+    password   = ask_for_password "      Password: "
 
     response = rubygems_api_request(:put, "api/v1/api_key",
                                     sign_in_host, scope: scope) do |request|
-      request.basic_auth email, password
-      request["OTP"] = otp if otp
-      request.body = URI.encode_www_form({ :api_key => api_key }.merge(update_scope_params))
+      request.basic_auth identifier, password
+      request.body = Gem::URI.encode_www_form({ api_key: api_key }.merge(update_scope_params))
     end
 
-    with_response response do |resp|
+    with_response response do |_resp|
       say "Added #{scope} scope to the existing API key"
     end
   end
@@ -148,29 +153,33 @@ module Gem::GemcutterUtilities
   # key.
 
   def sign_in(sign_in_host = nil, scope: nil)
-    sign_in_host ||= self.host
+    sign_in_host ||= host
     return if api_key
 
     pretty_host = pretty_host(sign_in_host)
 
     say "Enter your #{pretty_host} credentials."
-    say "Don't have an account yet? " +
+    say "Don't have an account yet? " \
         "Create one at #{sign_in_host}/sign_up"
 
-    email = ask "   Email: "
-    password = ask_for_password "Password: "
+    identifier = ask "Username/email: "
+    password   = ask_for_password "      Password: "
     say "\n"
 
     key_name     = get_key_name(scope)
     scope_params = get_scope_params(scope)
-    mfa_params   = get_mfa_params(email, password)
+    profile      = get_user_profile(identifier, password)
+    mfa_params   = get_mfa_params(profile)
     all_params   = scope_params.merge(mfa_params)
+    warning      = profile["warning"]
+    credentials  = { identifier: identifier, password: password }
+
+    say "#{warning}\n" if warning
 
     response = rubygems_api_request(:post, "api/v1/api_key",
-                                    sign_in_host, scope: scope) do |request|
-      request.basic_auth email, password
-      request["OTP"] = otp if otp
-      request.body = URI.encode_www_form({ name: key_name }.merge(all_params))
+                                    sign_in_host, credentials: credentials, scope: scope) do |request|
+      request.basic_auth identifier, password
+      request.body = Gem::URI.encode_www_form({ name: key_name }.merge(all_params))
     end
 
     with_response response do |resp|
@@ -197,16 +206,23 @@ module Gem::GemcutterUtilities
   # block was given or shows the response body to the user.
   #
   # If the response was not successful, shows an error to the user including
-  # the +error_prefix+ and the response body.
+  # the +error_prefix+ and the response body. If the response was a permanent redirect,
+  # shows an error to the user including the redirect location.
 
   def with_response(response, error_prefix = nil)
     case response
-    when Net::HTTPSuccess then
+    when Gem::Net::HTTPSuccess then
       if block_given?
         yield response
       else
         say clean_text(response.body)
       end
+    when Gem::Net::HTTPPermanentRedirect, Gem::Net::HTTPRedirection then
+      message = "The request has redirected permanently to #{response["location"]}. Please check your defined push host URL."
+      message = "#{error_prefix}: #{message}" if error_prefix
+
+      say clean_text(message)
+      terminate_interaction(ERROR_CODE)
     else
       message = response.body
       message = "#{error_prefix}: #{message}" if error_prefix
@@ -231,37 +247,100 @@ module Gem::GemcutterUtilities
   private
 
   def request_with_otp(method, uri, &block)
-    request_method = Net::HTTP.const_get method.to_s.capitalize
+    request_method = Gem::Net::HTTP.const_get method.to_s.capitalize
 
     Gem::RemoteFetcher.fetcher.request(uri, request_method) do |req|
       req["OTP"] = otp if otp
       block.call(req)
     end
+  ensure
+    options[:otp] = nil if webauthn_enabled?
+  end
+
+  def fetch_otp(credentials)
+    options[:otp] = if webauthn_url = webauthn_verification_url(credentials)
+      server = TCPServer.new 0
+      port = server.addr[1].to_s
+
+      url_with_port = "#{webauthn_url}?port=#{port}"
+      say "You have enabled multi-factor authentication. Please visit #{url_with_port} to authenticate via security device. If you can't verify using WebAuthn but have OTP enabled, you can re-run the gem signin command with the `--otp [your_code]` option."
+
+      threads = [WebauthnListener.listener_thread(host, server), WebauthnPoller.poll_thread(options, host, webauthn_url, credentials)]
+      otp_thread = wait_for_otp_thread(*threads)
+
+      threads.each(&:join)
+
+      if error = otp_thread[:error]
+        alert_error error.message
+        terminate_interaction(1)
+      end
+
+      options[:webauthn] = true
+
+      say "You are verified with a security device. You may close the browser window."
+      otp_thread[:otp]
+    else
+      say "You have enabled multi-factor authentication. Please enter OTP code."
+      ask "Code: "
+    end
+  end
+
+  def wait_for_otp_thread(*threads)
+    loop do
+      threads.each do |otp_thread|
+        return otp_thread unless otp_thread.alive?
+      end
+      sleep 0.1
+    end
+  ensure
+    threads.each(&:exit)
   end
 
-  def ask_otp
-    say 'You have enabled multi-factor authentication. Please enter OTP code.'
-    options[:otp] = ask 'Code: '
+  def webauthn_verification_url(credentials)
+    response = rubygems_api_request(:post, "api/v1/webauthn_verification") do |request|
+      if credentials.empty?
+        request.add_field "Authorization", api_key
+      else
+        request.basic_auth credentials[:identifier], credentials[:password]
+      end
+    end
+    response.is_a?(Gem::Net::HTTPSuccess) ? response.body : nil
   end
 
   def pretty_host(host)
     if default_host?
-      'RubyGems.org'
+      "RubyGems.org"
     else
       host
     end
   end
 
   def get_scope_params(scope)
-    scope_params = {}
+    scope_params = { index_rubygems: true }
 
     if scope
       scope_params = { scope => true }
     else
-      say "Please select scopes you want to enable for the API key (y/n)"
-      API_SCOPES.each do |scope|
-        selected = ask_yes_no("#{scope}", false)
-        scope_params[scope] = true if selected
+      say "The default access scope is:"
+      scope_params.each do |k, _v|
+        say "  #{k}: y"
+      end
+      say "\n"
+      customise = ask_yes_no("Do you want to customise scopes?", false)
+      if customise
+        EXCLUSIVELY_API_SCOPES.each do |excl_scope|
+          selected = ask_yes_no("#{excl_scope} (exclusive scope, answering yes will not prompt for other scopes)", false)
+          next unless selected
+
+          return { excl_scope => true }
+        end
+
+        scope_params = {}
+
+        API_SCOPES.each do |s|
+          selected = ask_yes_no(s.to_s, false)
+          scope_params[s] = true if selected
+        end
       end
       say "\n"
     end
@@ -270,30 +349,29 @@ module Gem::GemcutterUtilities
   end
 
   def default_host?
-    self.host == Gem::DEFAULT_HOST
+    host == Gem::DEFAULT_HOST
   end
 
-  def get_mfa_params(email, password)
+  def get_user_profile(identifier, password)
     return {} unless default_host?
 
-    mfa_level = get_user_mfa_level(email, password)
-    params = {}
-    if mfa_level == "ui_only" || mfa_level == "ui_and_gem_signin"
-      selected = ask_yes_no("Would you like to enable MFA for this key? (strongly recommended)")
-      params["mfa"] = true if selected
-    end
-    params
-  end
-
-  def get_user_mfa_level(email, password)
     response = rubygems_api_request(:get, "api/v1/profile/me.yaml") do |request|
-      request.basic_auth email, password
+      request.basic_auth identifier, password
     end
 
     with_response response do |resp|
-      body = Gem::SafeYAML.load clean_text(resp.body)
-      body["mfa"]
+      Gem::ConfigFile.load_with_rubygems_config_hash(clean_text(resp.body))
+    end
+  end
+
+  def get_mfa_params(profile)
+    mfa_level = profile["mfa"]
+    params = {}
+    if ["ui_only", "ui_and_gem_signin"].include?(mfa_level)
+      selected = ask_yes_no("Would you like to enable MFA for this key? (strongly recommended)")
+      params["mfa"] = true if selected
     end
+    params
   end
 
   def get_key_name(scope)
@@ -311,6 +389,6 @@ module Gem::GemcutterUtilities
   end
 
   def api_key_forbidden?(response)
-    response.kind_of?(Net::HTTPForbidden) && response.body.start_with?("The API key doesn't have access")
+    response.is_a?(Gem::Net::HTTPForbidden) && response.body.start_with?("The API key doesn't have access")
   end
 end

data/lib/rubygems/gemspec_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../rubygems"
+
+##
+# Mixin methods for commands that work with gemspecs.
+
+module Gem::GemspecHelpers
+  def find_gemspec(glob = "*.gemspec")
+    gemspecs = Dir.glob(glob).sort
+
+    if gemspecs.size > 1
+      alert_error "Multiple gemspecs found: #{gemspecs}, please specify one"
+      terminate_interaction(1)
+    end
+
+    gemspecs.first
+  end
+end

data/lib/rubygems/install_default_message.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require_relative '../rubygems'
-require_relative 'user_interaction'
+
+require_relative "../rubygems"
+require_relative "user_interaction"
 
 ##
 # A post-install hook that displays "Successfully installed

data/lib/rubygems/install_message.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require_relative '../rubygems'
-require_relative 'user_interaction'
+
+require_relative "../rubygems"
+require_relative "user_interaction"
 
 ##
 # A default post-install hook that displays "Successfully installed

data/lib/rubygems/install_update_options.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 #--
 # Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
 # All rights reserved.
 # See LICENSE.txt for permissions.
 #++
 
-require_relative '../rubygems'
-require_relative 'security_option'
+require_relative "../rubygems"
+require_relative "security_option"
 
 ##
 # Mixin methods for install and update options for Gem::Commands
@@ -18,106 +19,106 @@ module Gem::InstallUpdateOptions
   # Add the install/update options to the option parser.
 
   def add_install_update_options
-    add_option(:"Install/Update", '-i', '--install-dir DIR',
-               'Gem repository directory to get installed',
-               'gems') do |value, options|
+    add_option(:"Install/Update", "-i", "--install-dir DIR",
+               "Gem repository directory to get installed",
+               "gems") do |value, options|
       options[:install_dir] = File.expand_path(value)
     end
 
-    add_option(:"Install/Update", '-n', '--bindir DIR',
-               'Directory where executables will be',
-               'placed when the gem is installed') do |value, options|
+    add_option(:"Install/Update", "-n", "--bindir DIR",
+               "Directory where executables will be",
+               "placed when the gem is installed") do |value, options|
       options[:bin_dir] = File.expand_path(value)
     end
 
-    add_option(:"Install/Update", '--document [TYPES]', Array,
-               'Generate documentation for installed gems',
-               'List the documentation types you wish to',
-               'generate.  For example: rdoc,ri') do |value, options|
+    add_option(:"Install/Update", "--document [TYPES]", Array,
+               "Generate documentation for installed gems",
+               "List the documentation types you wish to",
+               "generate.  For example: rdoc,ri") do |value, options|
       options[:document] = case value
-      when nil   then %w[ri]
-      when false then []
-      else            value
+                           when nil   then %w[ri]
+                           when false then []
+                           else value
       end
     end
 
-    add_option(:"Install/Update", '--build-root DIR',
-               'Temporary installation root. Useful for building',
-               'packages. Do not use this when installing remote gems.') do |value, options|
+    add_option(:"Install/Update", "--build-root DIR",
+               "Temporary installation root. Useful for building",
+               "packages. Do not use this when installing remote gems.") do |value, options|
       options[:build_root] = File.expand_path(value)
     end
 
-    add_option(:"Install/Update", '--vendor',
-               'Install gem into the vendor directory.',
-               'Only for use by gem repackagers.') do |value, options|
+    add_option(:"Install/Update", "--vendor",
+               "Install gem into the vendor directory.",
+               "Only for use by gem repackagers.") do |_value, options|
       unless Gem.vendor_dir
-        raise Gem::OptionParser::InvalidOption.new 'your platform is not supported'
+        raise Gem::OptionParser::InvalidOption.new "your platform is not supported"
       end
 
       options[:vendor] = true
       options[:install_dir] = Gem.vendor_dir
     end
 
-    add_option(:"Install/Update", '-N', '--no-document',
-               'Disable documentation generation') do |value, options|
+    add_option(:"Install/Update", "-N", "--no-document",
+               "Disable documentation generation") do |_value, options|
       options[:document] = []
     end
 
-    add_option(:"Install/Update", '-E', '--[no-]env-shebang',
+    add_option(:"Install/Update", "-E", "--[no-]env-shebang",
                "Rewrite the shebang line on installed",
                "scripts to use /usr/bin/env") do |value, options|
       options[:env_shebang] = value
     end
 
-    add_option(:"Install/Update", '-f', '--[no-]force',
-               'Force gem to install, bypassing dependency',
-               'checks') do |value, options|
+    add_option(:"Install/Update", "-f", "--[no-]force",
+               "Force gem to install, bypassing dependency",
+               "checks") do |value, options|
       options[:force] = value
     end
 
-    add_option(:"Install/Update", '-w', '--[no-]wrappers',
-               'Use bin wrappers for executables',
-               'Not available on dosish platforms') do |value, options|
+    add_option(:"Install/Update", "-w", "--[no-]wrappers",
+               "Use bin wrappers for executables",
+               "Not available on dosish platforms") do |value, options|
       options[:wrappers] = value
     end
 
     add_security_option
 
-    add_option(:"Install/Update", '--ignore-dependencies',
-               'Do not install any required dependent gems') do |value, options|
+    add_option(:"Install/Update", "--ignore-dependencies",
+               "Do not install any required dependent gems") do |value, options|
       options[:ignore_dependencies] = value
     end
 
-    add_option(:"Install/Update", '--[no-]format-executable',
-               'Make installed executable names match Ruby.',
-               'If Ruby is ruby18, foo_exec will be',
-               'foo_exec18') do |value, options|
+    add_option(:"Install/Update", "--[no-]format-executable",
+               "Make installed executable names match Ruby.",
+               "If Ruby is ruby18, foo_exec will be",
+               "foo_exec18") do |value, options|
       options[:format_executable] = value
     end
 
-    add_option(:"Install/Update",       '--[no-]user-install',
-               'Install in user\'s home directory instead',
-               'of GEM_HOME.') do |value, options|
+    add_option(:"Install/Update", "--[no-]user-install",
+               "Install in user's home directory instead",
+               "of GEM_HOME.") do |value, options|
       options[:user_install] = value
     end
 
     add_option(:"Install/Update", "--development",
                 "Install additional development",
-                "dependencies") do |value, options|
+                "dependencies") do |_value, options|
       options[:development] = true
       options[:dev_shallow] = true
     end
 
     add_option(:"Install/Update", "--development-all",
                 "Install development dependencies for all",
-                "gems (including dev deps themselves)") do |value, options|
+                "gems (including dev deps themselves)") do |_value, options|
       options[:development] = true
       options[:dev_shallow] = false
     end
 
     add_option(:"Install/Update", "--conservative",
                 "Don't attempt to upgrade gems already",
-                "meeting version requirement") do |value, options|
+                "meeting version requirement") do |_value, options|
       options[:conservative] = true
       options[:minimal_deps] = true
     end
@@ -133,15 +134,15 @@ module Gem::InstallUpdateOptions
       options[:post_install_message] = value
     end
 
-    add_option(:"Install/Update", '-g', '--file [FILE]',
-               'Read from a gem dependencies API file and',
-               'install the listed gems') do |v,o|
-      v = Gem::GEM_DEP_FILES.find do |file|
+    add_option(:"Install/Update", "-g", "--file [FILE]",
+               "Read from a gem dependencies API file and",
+               "install the listed gems") do |v,_o|
+      v ||= Gem::GEM_DEP_FILES.find do |file|
         File.exist? file
-      end unless v
+      end
 
       unless v
-        message = v ? v : "(tried #{Gem::GEM_DEP_FILES.join ', '})"
+        message = v ? v : "(tried #{Gem::GEM_DEP_FILES.join ", "})"
 
         raise Gem::OptionParser::InvalidArgument,
                 "cannot find gem dependencies file #{message}"
@@ -150,34 +151,39 @@ module Gem::InstallUpdateOptions
       options[:gemdeps] = v
     end
 
-    add_option(:"Install/Update", '--without GROUPS', Array,
-               'Omit the named groups (comma separated)',
-               'when installing from a gem dependencies',
-               'file') do |v,o|
-      options[:without_groups].concat v.map {|without| without.intern }
+    add_option(:"Install/Update", "--without GROUPS", Array,
+               "Omit the named groups (comma separated)",
+               "when installing from a gem dependencies",
+               "file") do |v,_o|
+      options[:without_groups].concat v.map(&:intern)
     end
 
-    add_option(:"Install/Update", '--default',
-               'Add the gem\'s full specification to',
-               'specifications/default and extract only its bin') do |v,o|
+    add_option(:"Install/Update", "--default",
+               "Add the gem's full specification to",
+               "specifications/default and extract only its bin") do |v,_o|
       options[:install_as_default] = v
     end
 
-    add_option(:"Install/Update", '--explain',
-               'Rather than install the gems, indicate which would',
-               'be installed') do |v,o|
+    add_option(:"Install/Update", "--explain",
+               "Rather than install the gems, indicate which would",
+               "be installed") do |v,_o|
       options[:explain] = v
     end
 
-    add_option(:"Install/Update", '--[no-]lock',
-               'Create a lock file (when used with -g/--file)') do |v,o|
+    add_option(:"Install/Update", "--[no-]lock",
+               "Create a lock file (when used with -g/--file)") do |v,_o|
       options[:lock] = v
     end
 
-    add_option(:"Install/Update", '--[no-]suggestions',
-               'Suggest alternates when gems are not found') do |v,o|
+    add_option(:"Install/Update", "--[no-]suggestions",
+               "Suggest alternates when gems are not found") do |v,_o|
       options[:suggest_alternate] = v
     end
+
+    add_option(:"Install/Update", "--target-rbconfig [FILE]",
+                "rbconfig.rb for the deployment target platform") do |v, _o|
+      Gem.set_target_rbconfig(v)
+    end
   end
 
   ##
@@ -185,7 +191,7 @@ module Gem::InstallUpdateOptions
 
   def install_update_options
     {
-      :document => %w[ri],
+      document: %w[ri],
     }
   end
 
@@ -193,7 +199,6 @@ module Gem::InstallUpdateOptions
   # Default description for the gem install and update commands.
 
   def install_update_defaults_str
-    '--document=ri'
+    "--document=ri"
   end
-
 end