Add AAAA Support

Author: jriggins

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

@@ -70,13 +70,30 @@ class Domain < Checkable
         "192.30.252.154"
       ].freeze
 
+      # TODO: Should these be added?
+      # I see them at https://api.github.com/meta, but some of the
+      # IPs are explictly test against in specs
+      # 192.30.252.153
+      # 192.30.252.154
       CURRENT_IP_ADDRESSES = %w(
         185.199.108.153
         185.199.109.153
         185.199.110.153
         185.199.111.153
       ).freeze
 
+      CURRENT_IPV6_ADDRESSES = %w(
+        2606:50c0:8000::1538
+        2606:50c0:8001::1538
+        2606:50c0:8002::1538
+        2606:50c0:8003::1538
+      ).map { |a| Dnsruby::IPv6.create(a) }.to_set.freeze
+
+      CURRENT_IP_ADDRESSES_ALL =
+        (CURRENT_IP_ADDRESSES
+          .map { |a| Dnsruby::IPv4.create(a) }.to_set + CURRENT_IPV6_ADDRESSES)
+          .freeze
+
       HASH_METHODS = %i[
         host uri nameservers dns_resolves? proxied? cloudflare_ip?
         fastly_ip? old_ip_address? a_record? cname_record?
@@ -128,8 +145,8 @@ def deprecated_ip?
       def invalid_aaaa_record?
         return @invalid_aaaa_record if defined? @invalid_aaaa_record
 
-        @invalid_aaaa_record = (valid_domain? && should_be_a_record? &&
-                                aaaa_record_present?)
+        @invalid_aaaa_record =
+          (valid_domain? && aaaa_record_present? && !should_be_a_record?)
       end
 
       def invalid_a_record?
@@ -204,7 +221,7 @@ def dns_zone_ns?
         end
       end
 
-      # Should the domain use an A record?
+      # Should the domain use an A or AAAA record?
       def should_be_a_record?
         !pages_io_domain? && (apex_domain? || mx_records_present?)
       end
@@ -213,9 +230,11 @@ def should_be_cname_record?
         !should_be_a_record?
       end
 
-      # Is the domain's first response an A record to a valid GitHub Pages IP?
+      # Is the domain's first response an A or AAAA record to a valid GitHub Pages IP?
       def pointed_to_github_pages_ip?
-        a_record? && CURRENT_IP_ADDRESSES.include?(dns.first.address.to_s)
+        return false unless a_record?
+
+        CURRENT_IP_ADDRESSES_ALL.include?(dns.first.address)
       end
 
       # Are any of the domain's A records pointing elsewhere?
@@ -343,11 +362,12 @@ def old_ip_address?
         end
       end
 
-      # Is this domain's first response an A record?
+      # Is this domain's first response an A or AAAA record?
       def a_record?
+        return @is_a_record if defined?(@is_a_record)
         return unless dns?
 
-        dns.first.type == Dnsruby::Types::A
+        @is_a_record = [Dnsruby::Types::A, Dnsruby::Types::AAAA].include?(dns.first.type)
       end
 
       def aaaa_record_present?

spec/github_pages_health_check/domain_spec.rb

@@ -16,6 +16,7 @@
   let(:a_packet) do
     Dnsruby::RR.create("#{domain}. 1000 IN A #{ip}")
   end
+  let(:ip6) { "::1" }
   let(:aaaa_packet) do
     Dnsruby::RR.create("#{domain}. 1000 IN AAAA #{ip6}")
   end
@@ -161,25 +162,21 @@
       expect(subject.should_be_a_record?).to be_falsy
       expect(subject).to be_a_invalid_a_record
     end
+  end
 
-    context "AAAA records" do
-      let(:domain) { "parkermoore.de" }
-      let(:ip) { "185.199.108.153" }
-      let(:ip6) { "::1" }
-      before(:each) { allow(subject).to receive(:dns) { [a_packet, aaaa_packet] } }
-      it "knows that AAAA records are not allowed" do
-        expect(subject).to be_an_a_record
-        expect(subject).to be_a_valid_domain
-        expect(subject.invalid_aaaa_record?).to be_truthy
-      end
-      it "raises InvalidAAAARecordError" do
-        stub_request(:head, "http://#{domain}")
-          .to_return(:status => 200, :headers => { "Server" => "GitHub.com" })
-        expect(subject.invalid_aaaa_record?).to be_truthy
-        expect(-> { subject.check! }).to raise_error(
-          GitHubPages::HealthCheck::Errors::InvalidAAAARecordError
-        )
-      end
+  context "AAAA records" do
+    before(:each) { allow(subject).to receive(:dns) { [aaaa_packet] } }
+
+    it "knows when a domain is an AAAA record" do
+      expect(subject).to be_an_aaaa_record_present
+      expect(subject).to_not be_a_cname_record
+    end
+
+    it "knows when a domain has an invalid AAAA record" do
+      expect(subject).to be_an_aaaa_record_present
+      expect(subject).to be_a_valid_domain
+      expect(subject.should_be_a_record?).to eq(false)
+      expect(subject).to be_a_invalid_aaaa_record
     end
   end
 
@@ -473,6 +470,29 @@
     end
   end
 
+  context "GitHub Pages IPv6s" do
+    context "apex domains" do
+      context "pointed to Pages IPv6" do
+        let(:domain) { "myipv6.io" }
+        let(:ip6) { "2606:50C0:8000::1538" }
+        before(:each) { allow(subject).to receive(:dns) { [aaaa_packet] } }
+
+        it "Knows it's a Pages IP" do
+          expect(subject).to be_pointed_to_github_pages_ip
+        end
+      end
+
+      context "not pointed to a pages IP" do
+        let(:domain) { "example.com" }
+        let(:ip6) { "::1" }
+
+        it "knows it's not a Pages IP" do
+          expect(subject).to_not be_pointed_to_github_pages_ip
+        end
+      end
+    end
+  end
+
   context "Pages domains" do
     ["pages.github.com",
      "pages.github.io",