dependabot-nuget 0.242.0 → 0.243.0

data/lib/dependabot/nuget/update_checker/repository_finder.rb

@@ -10,321 +10,343 @@ require "dependabot/nuget/cache_manager"
 
 module Dependabot
   module Nuget
-    class UpdateChecker < Dependabot::UpdateCheckers::Base
-      class RepositoryFinder
-        DEFAULT_REPOSITORY_URL = "https://api.nuget.org/v3/index.json"
-        DEFAULT_REPOSITORY_API_KEY = "nuget.org"
-
-        def initialize(dependency:, credentials:, config_files: [])
-          @dependency  = dependency
-          @credentials = credentials
-          @config_files = config_files
-        end
-
-        def dependency_urls
-          find_dependency_urls
-        end
+    class RepositoryFinder
+      DEFAULT_REPOSITORY_URL = "https://api.nuget.org/v3/index.json"
+      DEFAULT_REPOSITORY_API_KEY = "nuget.org"
+
+      def initialize(dependency:, credentials:, config_files: [])
+        @dependency  = dependency
+        @credentials = credentials
+        @config_files = config_files
+      end
 
-        def self.get_default_repository_details(dependency_name)
-          {
-            base_url: "https://api.nuget.org/v3-flatcontainer/",
-            registration_url: "https://api.nuget.org/v3/registration5-gz-semver2/#{dependency_name.downcase}/index.json",
-            repository_url: DEFAULT_REPOSITORY_URL,
-            versions_url: "https://api.nuget.org/v3-flatcontainer/" \
-                          "#{dependency_name.downcase}/index.json",
-            search_url: "https://azuresearch-usnc.nuget.org/query" \
-                        "?q=#{dependency_name.downcase}&prerelease=true&semVerLevel=2.0.0",
-            auth_header: {},
-            repository_type: "v3"
-          }
-        end
+      def dependency_urls
+        find_dependency_urls
+      end
 
-        private
+      def known_repositories
+        return @known_repositories if @known_repositories
 
-        attr_reader :dependency, :credentials, :config_files
+        @known_repositories = []
+        @known_repositories += credential_repositories
+        @known_repositories += config_file_repositories
 
-        def find_dependency_urls
-          @find_dependency_urls ||=
-            known_repositories.flat_map do |details|
-              if details.fetch(:url) == DEFAULT_REPOSITORY_URL
-                # Save a request for the default URL, since we already know how
-                # it addresses packages
-                next default_repository_details
-              end
+        @known_repositories << { url: DEFAULT_REPOSITORY_URL, token: nil } if @known_repositories.empty?
 
-              build_url_for_details(details)
-            end.compact.uniq
+        @known_repositories = @known_repositories.map do |repo|
+          { url: URI::DEFAULT_PARSER.escape(repo[:url]), token: repo[:token] }
         end
+        @known_repositories.uniq
+      end
 
-        def build_url_for_details(repo_details)
-          response = get_repo_metadata(repo_details)
-          check_repo_response(response, repo_details)
-          return unless response.status == 200
-
-          body = remove_wrapping_zero_width_chars(response.body)
-          parsed_json = JSON.parse(body)
-          base_url = base_url_from_v3_metadata(parsed_json)
-          resolved_base_url = base_url || repo_details.fetch(:url).gsub("/index.json", "-flatcontainer")
-          search_url = search_url_from_v3_metadata(parsed_json)
-          registration_url = registration_url_from_v3_metadata(parsed_json)
-
-          details = {
-            base_url: resolved_base_url,
-            repository_url: repo_details.fetch(:url),
-            auth_header: auth_header_for_token(repo_details.fetch(:token)),
-            repository_type: "v3"
-          }
-          if base_url
-            details[:versions_url] =
-              File.join(base_url, dependency.name.downcase, "index.json")
-          end
-          if search_url
-            details[:search_url] =
-              search_url + "?q=#{dependency.name.downcase}&prerelease=true&semVerLevel=2.0.0"
-          end
+      def self.get_default_repository_details(dependency_name)
+        {
+          base_url: "https://api.nuget.org/v3-flatcontainer/",
+          registration_url: "https://api.nuget.org/v3/registration5-gz-semver2/#{dependency_name.downcase}/index.json",
+          repository_url: DEFAULT_REPOSITORY_URL,
+          versions_url: "https://api.nuget.org/v3-flatcontainer/" \
+                        "#{dependency_name.downcase}/index.json",
+          search_url: "https://azuresearch-usnc.nuget.org/query" \
+                      "?q=#{dependency_name.downcase}&prerelease=true&semVerLevel=2.0.0",
+          auth_header: {},
+          repository_type: "v3"
+        }
+      end
 
-          if registration_url
-            details[:registration_url] = File.join(registration_url, dependency.name.downcase, "index.json")
-          end
+      private
 
-          details
-        rescue JSON::ParserError
-          build_v2_url(response, repo_details)
-        rescue Excon::Error::Timeout, Excon::Error::Socket
-          handle_timeout(repo_metadata_url: repo_details.fetch(:url))
-        end
+      attr_reader :dependency, :credentials, :config_files
 
-        def get_repo_metadata(repo_details)
-          url = repo_details.fetch(:url)
-          cache = CacheManager.cache("repo_finder_metadatacache")
-          if cache[url]
-            cache[url]
-          else
-            result = Dependabot::RegistryClient.get(
-              url: url,
-              headers: auth_header_for_token(repo_details.fetch(:token))
-            )
-            cache[url] = result
-            result
-          end
-        end
+      def find_dependency_urls
+        @find_dependency_urls ||=
+          known_repositories.flat_map do |details|
+            if details.fetch(:url) == DEFAULT_REPOSITORY_URL
+              # Save a request for the default URL, since we already know how
+              # it addresses packages
+              next default_repository_details
+            end
 
-        def base_url_from_v3_metadata(metadata)
-          metadata
-            .fetch("resources", [])
-            .find { |r| r.fetch("@type") == "PackageBaseAddress/3.0.0" }
-            &.fetch("@id")
-        end
+            build_url_for_details(details)
+          end.compact.uniq
+      end
 
-        def registration_url_from_v3_metadata(metadata)
-          allowed_registration_types = %w(
-            RegistrationsBaseUrl
-            RegistrationsBaseUrl/3.0.0-beta
-            RegistrationsBaseUrl/3.0.0-rc
-            RegistrationsBaseUrl/3.4.0
-            RegistrationsBaseUrl/3.6.0
-          )
-          metadata
-            .fetch("resources", [])
-            .find { |r| allowed_registration_types.find { |s| r.fetch("@type") == s } }
-            &.fetch("@id")
+      def build_url_for_details(repo_details)
+        response = get_repo_metadata(repo_details)
+        check_repo_response(response, repo_details)
+        return unless response.status == 200
+
+        body = remove_wrapping_zero_width_chars(response.body)
+        parsed_json = JSON.parse(body)
+        base_url = base_url_from_v3_metadata(parsed_json)
+        resolved_base_url = base_url || repo_details.fetch(:url).gsub("/index.json", "-flatcontainer")
+        search_url = search_url_from_v3_metadata(parsed_json)
+        registration_url = registration_url_from_v3_metadata(parsed_json)
+
+        details = {
+          base_url: resolved_base_url,
+          repository_url: repo_details.fetch(:url),
+          auth_header: auth_header_for_token(repo_details.fetch(:token)),
+          repository_type: "v3"
+        }
+        if base_url
+          details[:versions_url] =
+            File.join(base_url, dependency.name.downcase, "index.json")
         end
-
-        def search_url_from_v3_metadata(metadata)
-          # allowable values from here: https://learn.microsoft.com/en-us/nuget/api/search-query-service-resource#versioning
-          allowed_search_types = %w(
-            SearchQueryService
-            SearchQueryService/3.0.0-beta
-            SearchQueryService/3.0.0-rc
-            SearchQueryService/3.5.0
-          )
-          metadata
-            .fetch("resources", [])
-            .find { |r| allowed_search_types.find { |s| r.fetch("@type") == s } }
-            &.fetch("@id")
+        if search_url
+          details[:search_url] =
+            search_url + "?q=#{dependency.name.downcase}&prerelease=true&semVerLevel=2.0.0"
         end
 
-        def build_v2_url(response, repo_details)
-          doc = Nokogiri::XML(response.body)
-
-          doc.remove_namespaces!
-          base_url = doc.at_xpath("service")&.attributes
-                        &.fetch("base", nil)&.value
-
-          base_url ||= repo_details.fetch(:url)
-
-          {
-            base_url: base_url,
-            repository_url: base_url,
-            versions_url: File.join(
-              base_url,
-              "FindPackagesById()?id='#{dependency.name}'"
-            ),
-            auth_header: auth_header_for_token(repo_details.fetch(:token)),
-            repository_type: "v2"
-          }
+        if registration_url
+          details[:registration_url] = File.join(registration_url, dependency.name.downcase, "index.json")
         end
 
-        def check_repo_response(response, details)
-          return unless [401, 402, 403].include?(response.status)
-          raise if details.fetch(:url) == DEFAULT_REPOSITORY_URL
+        details
+      rescue JSON::ParserError
+        build_v2_url(response, repo_details)
+      rescue Excon::Error::Timeout, Excon::Error::Socket
+        handle_timeout(repo_metadata_url: repo_details.fetch(:url))
+      end
 
-          raise PrivateSourceAuthenticationFailure, details.fetch(:url)
+      def get_repo_metadata(repo_details)
+        url = repo_details.fetch(:url)
+        cache = CacheManager.cache("repo_finder_metadatacache")
+        if cache[url]
+          cache[url]
+        else
+          result = Dependabot::RegistryClient.get(
+            url: url,
+            headers: auth_header_for_token(repo_details.fetch(:token))
+          )
+          cache[url] = result
+          result
         end
+      end
 
-        def handle_timeout(repo_metadata_url:)
-          raise if repo_metadata_url == DEFAULT_REPOSITORY_URL
-
-          raise PrivateSourceTimedOut, repo_metadata_url
-        end
+      def base_url_from_v3_metadata(metadata)
+        metadata
+          .fetch("resources", [])
+          .find { |r| r.fetch("@type") == "PackageBaseAddress/3.0.0" }
+          &.fetch("@id")
+      end
 
-        def known_repositories
-          return @known_repositories if @known_repositories
+      def registration_url_from_v3_metadata(metadata)
+        allowed_registration_types = %w(
+          RegistrationsBaseUrl
+          RegistrationsBaseUrl/3.0.0-beta
+          RegistrationsBaseUrl/3.0.0-rc
+          RegistrationsBaseUrl/3.4.0
+          RegistrationsBaseUrl/3.6.0
+        )
+        metadata
+          .fetch("resources", [])
+          .find { |r| allowed_registration_types.find { |s| r.fetch("@type") == s } }
+          &.fetch("@id")
+      end
 
-          @known_repositories = []
-          @known_repositories += credential_repositories
-          @known_repositories += config_file_repositories
+      def search_url_from_v3_metadata(metadata)
+        # allowable values from here: https://learn.microsoft.com/en-us/nuget/api/search-query-service-resource#versioning
+        allowed_search_types = %w(
+          SearchQueryService
+          SearchQueryService/3.0.0-beta
+          SearchQueryService/3.0.0-rc
+          SearchQueryService/3.5.0
+        )
+        metadata
+          .fetch("resources", [])
+          .find { |r| allowed_search_types.find { |s| r.fetch("@type") == s } }
+          &.fetch("@id")
+      end
 
-          @known_repositories << { url: DEFAULT_REPOSITORY_URL, token: nil } if @known_repositories.empty?
+      def build_v2_url(response, repo_details)
+        doc = Nokogiri::XML(response.body)
+
+        doc.remove_namespaces!
+        base_url = doc.at_xpath("service")&.attributes
+                      &.fetch("base", nil)&.value
+
+        base_url ||= repo_details.fetch(:url)
+
+        {
+          base_url: base_url,
+          repository_url: base_url,
+          versions_url: File.join(
+            base_url,
+            "FindPackagesById()?id='#{dependency.name}'"
+          ),
+          auth_header: auth_header_for_token(repo_details.fetch(:token)),
+          repository_type: "v2"
+        }
+      end
 
-          @known_repositories.uniq
-        end
+      def check_repo_response(response, details)
+        return unless [401, 402, 403].include?(response.status)
+        raise if details.fetch(:url) == DEFAULT_REPOSITORY_URL
 
-        def credential_repositories
-          @credential_repositories ||=
-            credentials
-            .select { |cred| cred["type"] == "nuget_feed" }
-            .map { |c| { url: c.fetch("url"), token: c["token"] } }
-        end
+        raise PrivateSourceAuthenticationFailure, details.fetch(:url)
+      end
 
-        def config_file_repositories
-          config_files.flat_map { |file| repos_from_config_file(file) }
-        end
+      def handle_timeout(repo_metadata_url:)
+        raise if repo_metadata_url == DEFAULT_REPOSITORY_URL
 
-        # rubocop:disable Metrics/CyclomaticComplexity
-        # rubocop:disable Metrics/PerceivedComplexity
-        # rubocop:disable Metrics/AbcSize
-        def repos_from_config_file(config_file)
-          doc = Nokogiri::XML(config_file.content)
-          doc.remove_namespaces!
-          # analogous to having a root config with the default repository
-          base_sources = [{ url: DEFAULT_REPOSITORY_URL, key: "nuget.org" }]
-
-          sources = []
-
-          # regular package sources
-          doc.css("configuration > packageSources").children.each do |node|
-            if node.name == "clear"
-              sources.clear
-              base_sources.clear
-            else
-              key = node.attribute("key")&.value&.strip || node.at_xpath("./key")&.content&.strip
-              url = node.attribute("value")&.value&.strip || node.at_xpath("./value")&.content&.strip
-              sources << { url: url, key: key }
-            end
-          end
+        raise PrivateSourceTimedOut, repo_metadata_url
+      end
 
-          # signed package sources
-          # https://learn.microsoft.com/en-us/nuget/reference/nuget-config-file#trustedsigners-section
-          doc.xpath("/configuration/trustedSigners/repository").each do |node|
-            name = node.attribute("name")&.value&.strip
-            service_index = node.attribute("serviceIndex")&.value&.strip
-            sources << { url: service_index, key: name }
-          end
+      def credential_repositories
+        @credential_repositories ||=
+          credentials
+          .select { |cred| cred["type"] == "nuget_feed" && cred["url"] }
+          .map { |c| { url: c.fetch("url"), token: c["token"] } }
+      end
 
-          sources += base_sources # TODO: quirky overwrite behavior
-          disabled_sources = disabled_sources(doc)
-          sources.reject! do |s|
-            disabled_sources.include?(s[:key])
-          end
+      def config_file_repositories
+        config_files.flat_map { |file| repos_from_config_file(file) }
+      end
 
-          sources.reject! do |s|
-            known_urls = credential_repositories.map { |cr| cr.fetch(:url) }
-            known_urls.include?(s.fetch(:url))
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/AbcSize
+      def repos_from_config_file(config_file)
+        doc = Nokogiri::XML(config_file.content)
+        doc.remove_namespaces!
+        # analogous to having a root config with the default repository
+        base_sources = [{ url: DEFAULT_REPOSITORY_URL, key: "nuget.org" }]
+
+        sources = []
+
+        # regular package sources
+        doc.css("configuration > packageSources").children.each do |node|
+          if node.name == "clear"
+            sources.clear
+            base_sources.clear
+          else
+            key = node.attribute("key")&.value&.strip || node.at_xpath("./key")&.content&.strip
+            url = node.attribute("value")&.value&.strip || node.at_xpath("./value")&.content&.strip
+            url = expand_windows_style_environment_variables(url) if url
+            sources << { url: url, key: key }
           end
+        end
 
-          sources.select! { |s| s.fetch(:url)&.include?("://") }
-
-          add_config_file_credentials(sources: sources, doc: doc)
-          sources.each { |details| details.delete(:key) }
+        # signed package sources
+        # https://learn.microsoft.com/en-us/nuget/reference/nuget-config-file#trustedsigners-section
+        doc.xpath("/configuration/trustedSigners/repository").each do |node|
+          name = node.attribute("name")&.value&.strip
+          service_index = node.attribute("serviceIndex")&.value&.strip
+          sources << { url: service_index, key: name }
+        end
 
-          sources
+        sources += base_sources # TODO: quirky overwrite behavior
+        disabled_sources = disabled_sources(doc)
+        sources.reject! do |s|
+          disabled_sources.include?(s[:key])
         end
-        # rubocop:enable Metrics/AbcSize
-        # rubocop:enable Metrics/PerceivedComplexity
-        # rubocop:enable Metrics/CyclomaticComplexity
 
-        def default_repository_details
-          RepositoryFinder.get_default_repository_details(dependency.name)
+        sources.reject! do |s|
+          known_urls = credential_repositories.map { |cr| cr.fetch(:url) }
+          known_urls.include?(s.fetch(:url))
         end
 
-        # rubocop:disable Metrics/PerceivedComplexity
-        def disabled_sources(doc)
-          doc.css("configuration > disabledPackageSources > add").filter_map do |node|
-            value = node.attribute("value")&.value ||
-                    node.at_xpath("./value")&.content
+        sources.select! { |s| s.fetch(:url)&.include?("://") }
 
-            if value&.strip&.downcase == "true"
-              node.attribute("key")&.value&.strip ||
-                node.at_xpath("./key")&.content&.strip
-            end
+        add_config_file_credentials(sources: sources, doc: doc)
+        sources.each { |details| details.delete(:key) }
+
+        sources
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def default_repository_details
+        RepositoryFinder.get_default_repository_details(dependency.name)
+      end
+
+      # rubocop:disable Metrics/PerceivedComplexity
+      def disabled_sources(doc)
+        doc.css("configuration > disabledPackageSources > add").filter_map do |node|
+          value = node.attribute("value")&.value ||
+                  node.at_xpath("./value")&.content
+
+          if value&.strip&.downcase == "true"
+            node.attribute("key")&.value&.strip ||
+              node.at_xpath("./key")&.content&.strip
           end
         end
-        # rubocop:enable Metrics/PerceivedComplexity
-
-        # rubocop:disable Metrics/PerceivedComplexity
-        def add_config_file_credentials(sources:, doc:)
-          sources.each do |source_details|
-            key = source_details.fetch(:key)
-            next source_details[:token] = nil unless key
-            next source_details[:token] = nil if key.match?(/^\d/)
-
-            tag = key.gsub(" ", "_x0020_")
-            creds_nodes = doc.css("configuration > packageSourceCredentials " \
-                                  "> #{tag} > add")
-
-            username =
-              creds_nodes
-              .find { |n| n.attribute("key")&.value == "Username" }
-              &.attribute("value")&.value
-            password =
-              creds_nodes
-              .find { |n| n.attribute("key")&.value == "ClearTextPassword" }
-              &.attribute("value")&.value
-
-            # NOTE: We have to look for plain text passwords, as we have no
-            # way of decrypting encrypted passwords. For the same reason we
-            # don't fetch API keys from the nuget.config at all.
-            next source_details[:token] = nil unless username && password
-
-            source_details[:token] = "#{username}:#{password}"
-          rescue Nokogiri::XML::XPath::SyntaxError
-            # Any non-ascii characters in the tag with cause a syntax error
-            next source_details[:token] = nil
-          end
-
-          sources
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      # rubocop:disable Metrics/PerceivedComplexity
+      def add_config_file_credentials(sources:, doc:)
+        sources.each do |source_details|
+          key = source_details.fetch(:key)
+          next source_details[:token] = nil unless key
+          next source_details[:token] = nil if key.match?(/^\d/)
+
+          tag = key.gsub(" ", "_x0020_")
+          creds_nodes = doc.css("configuration > packageSourceCredentials " \
+                                "> #{tag} > add")
+
+          username =
+            creds_nodes
+            .find { |n| n.attribute("key")&.value == "Username" }
+            &.attribute("value")&.value
+          password =
+            creds_nodes
+            .find { |n| n.attribute("key")&.value == "ClearTextPassword" }
+            &.attribute("value")&.value
+
+          # NOTE: We have to look for plain text passwords, as we have no
+          # way of decrypting encrypted passwords. For the same reason we
+          # don't fetch API keys from the nuget.config at all.
+          next source_details[:token] = nil unless username && password
+
+          expanded_username = expand_windows_style_environment_variables(username)
+          expanded_password = expand_windows_style_environment_variables(password)
+          source_details[:token] = "#{expanded_username}:#{expanded_password}"
+        rescue Nokogiri::XML::XPath::SyntaxError
+          # Any non-ascii characters in the tag with cause a syntax error
+          next source_details[:token] = nil
         end
-        # rubocop:enable Metrics/PerceivedComplexity
 
-        def remove_wrapping_zero_width_chars(string)
-          string.force_encoding("UTF-8").encode
-                .gsub(/\A[\u200B-\u200D\uFEFF]/, "")
-                .gsub(/[\u200B-\u200D\uFEFF]\Z/, "")
+        sources
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def expand_windows_style_environment_variables(string)
+        # NuGet.Config files can have Windows-style environment variables that need to be replaced
+        # https://learn.microsoft.com/en-us/nuget/reference/nuget-config-file#using-environment-variables
+        string.gsub(/%([^%]+)%/) do
+          environment_variable_name = T.must(::Regexp.last_match(1))
+          environment_variable_value = ENV.fetch(environment_variable_name, nil)
+          if environment_variable_value
+            environment_variable_value
+          else
+            # report that the variable couldn't be expanded, then replace it as-is
+            Dependabot.logger.warn <<~WARN
+              The variable '%#{environment_variable_name}%' could not be expanded in NuGet.Config
+            WARN
+            "%#{environment_variable_name}%"
+          end
         end
+      end
 
-        def auth_header_for_token(token)
-          return {} unless token
+      def remove_wrapping_zero_width_chars(string)
+        string.force_encoding("UTF-8").encode
+              .gsub(/\A[\u200B-\u200D\uFEFF]/, "")
+              .gsub(/[\u200B-\u200D\uFEFF]\Z/, "")
+      end
 
-          if token.include?(":")
-            encoded_token = Base64.encode64(token).delete("\n")
-            { "Authorization" => "Basic #{encoded_token}" }
-          elsif Base64.decode64(token).ascii_only? &&
-                Base64.decode64(token).include?(":")
-            { "Authorization" => "Basic #{token.delete("\n")}" }
-          else
-            { "Authorization" => "Bearer #{token}" }
-          end
+      def auth_header_for_token(token)
+        return {} unless token
+
+        if token.include?(":")
+          encoded_token = Base64.encode64(token).delete("\n")
+          { "Authorization" => "Basic #{encoded_token}" }
+        elsif Base64.decode64(token).ascii_only? &&
+              Base64.decode64(token).include?(":")
+          { "Authorization" => "Basic #{token.delete("\n")}" }
+        else
+          { "Authorization" => "Bearer #{token}" }
         end
       end
     end

data/lib/dependabot/nuget/update_checker/tfm_comparer.rb

@@ -9,22 +9,20 @@ require "dependabot/shared_helpers"
 
 module Dependabot
   module Nuget
-    class UpdateChecker < Dependabot::UpdateCheckers::Base
-      class TfmComparer
-        def self.are_frameworks_compatible?(project_tfms, package_tfms)
-          return false if package_tfms.empty?
-          return false if project_tfms.empty?
+    class TfmComparer
+      def self.are_frameworks_compatible?(project_tfms, package_tfms)
+        return false if package_tfms.empty?
+        return false if project_tfms.empty?
 
-          key = "project_ftms:#{project_tfms.sort.join(',')}:package_tfms:#{package_tfms.sort.join(',')}".downcase
+        key = "project_ftms:#{project_tfms.sort.join(',')}:package_tfms:#{package_tfms.sort.join(',')}".downcase
 
-          @cached_framework_check ||= {}
-          unless @cached_framework_check.key?(key)
-            @cached_framework_check[key] =
-              NativeHelpers.run_nuget_framework_check(project_tfms,
-                                                      package_tfms)
-          end
-          @cached_framework_check[key]
+        @cached_framework_check ||= {}
+        unless @cached_framework_check.key?(key)
+          @cached_framework_check[key] =
+            NativeHelpers.run_nuget_framework_check(project_tfms,
+                                                    package_tfms)
         end
+        @cached_framework_check[key]
       end
     end
   end