github-pages-health-check 1.18.4 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e2a387d18201b5732790cea5c70f84c736eb04433cb66cf8715b7afd263bbb7
-  data.tar.gz: c9ccd398d02d8d6a2f4b372bf022cb75688178951cca0fc0f0616cf7078c4fc0
+  metadata.gz: f2a1a3411ae633f468b19e0ac83279b0d4670b90345250f9c15924d69b31b794
+  data.tar.gz: 59c1251b90c8e5c76a1db5025a481a988a697d380f9a339dd2e34d963b4c7f32
 SHA512:
-  metadata.gz: 20d385527764b7326b390244b38e44b2aa426748244d51e64feef83200111053efc3fe52a9cf55e0f523df27ddeaf2a24e1df15ae702a1948e2fcede15ba254d
-  data.tar.gz: 55bee6916048119777f9321cfe29a496317d855e6e428b185244c97b6ee1d77b23d16ca63be53e145a3467a94cf62858bace2c48ed0aade07c38d90000c1c274
+  metadata.gz: 445d74066cf216a0ca6aa1fc32afc5dae3aa421c7735c1ec017234b819968900b9cb4ee1def153c8f26a1ef2fbdce86d42f4aa4b0abb098c4f4d100e9e5dcce5
+  data.tar.gz: bf5038c6d651bb2683c0d72ced5eecc4d23a45da69c05e1bc0e2b0ec04255bd7e3d7e412eae425906677df80fede859639a4b2c95a5e277faf14af6b33635aca

data/.github/workflows/pages-gem.yml

@@ -14,9 +14,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Setup Ruby
-        uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999 # v1.191.0
+        uses: ruby/setup-ruby@13e7a03dc3ac6c3798f4570bfead2aed4d96abfb # v1.244.0
         with:
-          ruby-version: '3.2'
+          ruby-version: '3.3'
       - name: Build gem
         run: |
           gem build github-pages-health-check.gemspec

data/.github/workflows/push-cibuild.yml

@@ -10,9 +10,9 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
     steps:
     - uses: actions/checkout@master
     - name: script/cibuild-docker

data/.ruby-version

@@ -1 +1 @@
-3.2
+3.3

data/github-pages-health-check.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.files                 = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.require_paths         = ["lib"]
 
-  s.add_dependency("addressable", "~> 2.3")
+  s.add_dependency("addressable", "~> 2.8.7")
   s.add_dependency("dnsruby", "~> 1.60")
   s.add_dependency("octokit", ">= 4", "< 10")
   s.add_dependency("public_suffix", ">= 3.0", "< 7.0")

data/lib/github-pages-health-check/domain.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 module GitHubPages
   module HealthCheck
     class Domain < Checkable
@@ -245,13 +247,17 @@ module GitHubPages
 
       # Check if the CNAME points to a Domain that points to pages
       # e.g. CNAME -> Domain -> Pages
+      # rubocop:disable Metrics/AbcSize
       def cname_to_domain_to_pages?
+        return false unless dns?
+
         a_record_to_pages = dns.select { |d| d.type == Dnsruby::Types::A && d.name.to_s == host }.first
 
         return false unless a_record_to_pages && cname? && !cname_to_pages_dot_github_dot_com? && @www_cname
 
         CURRENT_IP_ADDRESSES.include?(a_record_to_pages.address.to_s.downcase)
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Is the given domain a CNAME to pages.github.(io|com)
       # instead of being CNAME'd to the user's subdomain?
@@ -438,6 +444,40 @@ module GitHubPages
         end
       end
 
+      def parent_domain
+        parsed = PublicSuffix.parse(host)
+        parent = host.split(".", 2).last
+        if parent == parsed.tld
+          return nil
+        end
+
+        parent
+      rescue PublicSuffix::DomainNotAllowed
+        nil
+      end
+
+      def maybe_wildcard?
+        return @maybe_wildcard if defined? @maybe_wildcard
+        return false unless dns_resolves?
+        return false unless parent_domain
+
+        sibling_domain = SecureRandom.alphanumeric(20) + "." + parent_domain
+
+        @maybe_wildcard = begin
+          wildcard_resolver = GitHubPages::HealthCheck::Resolver.new(sibling_domain, :nameservers => nameservers)
+
+          [Dnsruby::Types::A, Dnsruby::Types::AAAA].any? do |record_type|
+            wildcard_resolver.query(record_type).any? do |record|
+              record.respond_to?(:address) && github_pages_ip?(record.address)
+            end
+          end
+        end
+      end
+
+      def wildcard_warning
+        Errors::WildcardRecordError.new :domain => self, :parent_domain => parent_domain if maybe_wildcard?
+      end
+
       def uri(overrides = {})
         options = { :host => host, :scheme => scheme, :path => "/" }
         options = options.merge(overrides)

data/lib/github-pages-health-check/errors/wildcard_record_error.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GitHubPages
+  module HealthCheck
+    module Errors
+      class WildcardRecordError < GitHubPages::HealthCheck::Error
+        DOCUMENTATION_PATH = "/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages/"
+
+        attr_reader :parent_domain
+
+        def initialize(repository: nil, domain: nil, parent_domain: nil)
+          super(:repository => repository, :domain => domain)
+          @parent_domain = parent_domain
+        end
+
+        def message
+          <<-MSG
+            The DNS record for your domain appears to be *.#{parent_domain}, a wildcard record.
+            Your GitHub Pages site will still work, but unless you verify ownership of #{parent_domain},
+            any GitHub Pages user can serve their content from an arbitrary subdomain of it.
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/github-pages-health-check/resolver.rb

@@ -43,15 +43,15 @@ module GitHubPages
                         self.class.default_resolver
                       when :authoritative
                         Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS.merge(
-                                                :nameservers => authoritative_nameservers
+                                                :nameserver => authoritative_nameservers
                                               ))
                       when :public
                         Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS.merge(
-                                                :nameservers => PUBLIC_NAMESERVERS
+                                                :nameserver => PUBLIC_NAMESERVERS
                                               ))
                       when Array
                         Dnsruby::Resolver.new(DEFAULT_RESOLVER_OPTIONS.merge(
-                                                :nameservers => nameservers
+                                                :nameserver => nameservers
                                               ))
                       else
                         raise "Invalid nameserver type: #{nameservers.inspect}"

data/lib/github-pages-health-check/version.rb

@@ -2,6 +2,6 @@
 
 module GitHubPages
   module HealthCheck
-    VERSION = "1.18.4"
+    VERSION = "1.19.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-pages-health-check
 version: !ruby/object:Gem::Version
-  version: 1.18.4
+  version: 1.19.0
 platform: ruby
 authors:
 - GitHub, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.8.7
 - !ruby/object:Gem::Dependency
   name: dnsruby
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ files:
 - lib/github-pages-health-check/errors/invalid_repository_error.rb
 - lib/github-pages-health-check/errors/missing_access_token_error.rb
 - lib/github-pages-health-check/errors/not_served_by_pages_error.rb
+- lib/github-pages-health-check/errors/wildcard_record_error.rb
 - lib/github-pages-health-check/printer.rb
 - lib/github-pages-health-check/redundant_check.rb
 - lib/github-pages-health-check/repository.rb
@@ -153,7 +154,7 @@ homepage: https://github.com/github/github-pages-health-check
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Checks your GitHub Pages site for commons DNS configuration issues
 test_files: []