rubygems-update 3.4.10 → 3.5.22

data/lib/rubygems/gemcutter_utilities/webauthn_poller.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+##
+# The WebauthnPoller class retrieves an OTP after a user successfully WebAuthns. An instance
+# polls the Gem host for the OTP code. The polling request (api/v1/webauthn_verification/<webauthn_token>/status.json)
+# is sent to the Gem host every 5 seconds and will timeout after 5 minutes. If the status field in the json response
+# is "success", the code field will contain the OTP code.
+#
+# Example usage:
+#
+#   thread = Gem::WebauthnPoller.poll_thread(
+#     {},
+#     "RubyGems.org",
+#     "https://rubygems.org/api/v1/webauthn_verification/odow34b93t6aPCdY",
+#     { email: "email@example.com", password: "password" }
+#   )
+#   thread.join
+#   otp = thread[:otp]
+#   error = thread[:error]
+#
+
+module Gem::GemcutterUtilities
+  class WebauthnPoller
+    include Gem::GemcutterUtilities
+    TIMEOUT_IN_SECONDS = 300
+
+    attr_reader :options, :host
+
+    def initialize(options, host)
+      @options = options
+      @host = host
+    end
+
+    def self.poll_thread(options, host, webauthn_url, credentials)
+      Thread.new do
+        thread = Thread.current
+        thread.abort_on_exception = true
+        thread.report_on_exception = false
+        thread[:otp] = new(options, host).poll_for_otp(webauthn_url, credentials)
+      rescue Gem::WebauthnVerificationError, Gem::Timeout::Error => e
+        thread[:error] = e
+      end
+    end
+
+    def poll_for_otp(webauthn_url, credentials)
+      Gem::Timeout.timeout(TIMEOUT_IN_SECONDS) do
+        loop do
+          response = webauthn_verification_poll_response(webauthn_url, credentials)
+          raise Gem::WebauthnVerificationError, response.message unless response.is_a?(Gem::Net::HTTPSuccess)
+
+          require "json"
+          parsed_response = JSON.parse(response.body)
+          case parsed_response["status"]
+          when "pending"
+            sleep 5
+          when "success"
+            return parsed_response["code"]
+          else
+            raise Gem::WebauthnVerificationError, parsed_response.fetch("message", "Invalid response from server")
+          end
+        end
+      end
+    end
+
+    private
+
+    def webauthn_verification_poll_response(webauthn_url, credentials)
+      webauthn_token = %r{(?<=\/)[^\/]+(?=$)}.match(webauthn_url)[0]
+      rubygems_api_request(:get, "api/v1/webauthn_verification/#{webauthn_token}/status.json") do |request|
+        if credentials.empty?
+          request.add_field "Authorization", api_key
+        elsif credentials[:identifier] && credentials[:password]
+          request.basic_auth credentials[:identifier], credentials[:password]
+        else
+          raise Gem::WebauthnVerificationError, "Provided missing credentials"
+        end
+      end
+    end
+  end
+end

data/lib/rubygems/gemcutter_utilities.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
+
 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
 
@@ -70,8 +73,7 @@ module Gem::GemcutterUtilities
     @host ||=
       begin
         env_rubygems_host = ENV["RUBYGEMS_HOST"]
-        env_rubygems_host = nil if
-          env_rubygems_host && env_rubygems_host.empty?
+        env_rubygems_host = nil if env_rubygems_host&.empty?
 
         env_rubygems_host || configured_host
       end
@@ -82,8 +84,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 +94,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 +103,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 +120,27 @@ 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.basic_auth identifier, password
       request["OTP"] = otp if otp
-      request.body = URI.encode_www_form({ :api_key => api_key }.merge(update_scope_params))
+      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,33 +150,34 @@ 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)
-    profile      = get_user_profile(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
+                                    sign_in_host, credentials: credentials, scope: scope) do |request|
+      request.basic_auth identifier, password
       request["OTP"] = otp if otp
-      request.body = URI.encode_www_form({ name: key_name }.merge(all_params))
+      request.body = Gem::URI.encode_www_form({ name: key_name }.merge(all_params))
     end
 
     with_response response do |resp|
@@ -206,14 +209,14 @@ module Gem::GemcutterUtilities
 
   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 Net::HTTPPermanentRedirect, Net::HTTPRedirection then
-      message = "The request has redirected permanently to #{response['location']}. Please check your defined push host URL."
+    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)
@@ -242,7 +245,7 @@ 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
@@ -250,9 +253,52 @@ module Gem::GemcutterUtilities
     end
   end
 
-  def ask_otp
-    say "You have enabled multi-factor authentication. Please enter OTP code."
-    options[:otp] = ask "Code: "
+  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
+
+      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 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)
@@ -264,15 +310,31 @@ module Gem::GemcutterUtilities
   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
@@ -281,25 +343,25 @@ module Gem::GemcutterUtilities
   end
 
   def default_host?
-    self.host == Gem::DEFAULT_HOST
+    host == Gem::DEFAULT_HOST
   end
 
-  def get_user_profile(email, password)
+  def get_user_profile(identifier, password)
     return {} unless default_host?
 
     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|
-      Gem::SafeYAML.load clean_text(resp.body)
+      Gem::ConfigFile.load_with_rubygems_config_hash(clean_text(resp.body))
     end
   end
 
   def get_mfa_params(profile)
     mfa_level = profile["mfa"]
     params = {}
-    if mfa_level == "ui_only" || mfa_level == "ui_and_gem_signin"
+    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
@@ -321,6 +383,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,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "../rubygems"
 require_relative "user_interaction"
 

data/lib/rubygems/install_message.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative "../rubygems"
 require_relative "user_interaction"
 

data/lib/rubygems/install_update_options.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #--
 # Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
 # All rights reserved.
@@ -35,9 +36,9 @@ module Gem::InstallUpdateOptions
                "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
 
@@ -49,7 +50,7 @@ module Gem::InstallUpdateOptions
 
     add_option(:"Install/Update", "--vendor",
                "Install gem into the vendor directory.",
-               "Only for use by gem repackagers.") do |value, options|
+               "Only for use by gem repackagers.") do |_value, options|
       unless Gem.vendor_dir
         raise Gem::OptionParser::InvalidOption.new "your platform is not supported"
       end
@@ -59,7 +60,7 @@ module Gem::InstallUpdateOptions
     end
 
     add_option(:"Install/Update", "-N", "--no-document",
-               "Disable documentation generation") do |value, options|
+               "Disable documentation generation") do |_value, options|
       options[:document] = []
     end
 
@@ -103,21 +104,21 @@ module Gem::InstallUpdateOptions
 
     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
@@ -135,13 +136,13 @@ module Gem::InstallUpdateOptions
 
     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|
+               "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}"
@@ -153,29 +154,29 @@ module Gem::InstallUpdateOptions
     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 }
+               "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|
+               "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|
+               "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|
+               "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|
+               "Suggest alternates when gems are not found") do |v,_o|
       options[:suggest_alternate] = v
     end
   end
@@ -185,7 +186,7 @@ module Gem::InstallUpdateOptions
 
   def install_update_options
     {
-      :document => %w[ri],
+      document: %w[ri],
     }
   end
 
@@ -195,5 +196,4 @@ module Gem::InstallUpdateOptions
   def install_update_defaults_str
     "--document=ri"
   end
-
 end