github-pages-health-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1c13045e846da98ad6852b7e252863b2fff17b9
+  data.tar.gz: 1aab4822c1e5b5ac88a2ccf94460baf8b8eec981
+SHA512:
+  metadata.gz: 397b3e0ccdd3fe29c49a4998fe8ee35799c4632f5c21459ed466689eddcc3f1cd755bde343bacc62c02d9de3f2fadb8bab7c52dd1ef397f9d51caa639dee28bb
+  data.tar.gz: 3fed5d309e7bc71fb44cda0dba972e8d63bfdda9234557dd0ee9ca487cdcde039bc14014798ff181c677272c298d796921ebc3c15cfc572650a77248b836acdf

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/config/cloudflare-ips.txt

@@ -0,0 +1,13 @@
+199.27.128.0/21
+173.245.48.0/20
+103.21.244.0/22
+103.22.200.0/22
+103.31.4.0/22
+141.101.64.0/18
+108.162.192.0/18
+190.93.240.0/20
+188.114.96.0/20
+197.234.240.0/22
+198.41.128.0/17
+162.158.0.0/15
+104.16.0.0/12

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

@@ -0,0 +1,141 @@
+require 'net/dns'
+require 'net/dns/resolver'
+require 'ipaddr'
+require 'public_suffix'
+require 'singleton'
+require_relative 'github-pages-health-check/version'
+require_relative 'github-pages-health-check/cloudflare'
+require_relative 'github-pages-health-check/error'
+require_relative 'github-pages-health-check/errors/deprecated_ip'
+require_relative 'github-pages-health-check/errors/invalid_a_record'
+require_relative 'github-pages-health-check/errors/invalid_cname'
+
+class GitHubPages
+  class HealthCheck
+
+    attr_accessor :domain
+
+    LEGACY_IP_ADDRESSES = %w[
+      207.97.227.245
+      204.232.175.78
+      199.27.73.133
+    ]
+
+    def initialize(domain)
+      @domain = domain
+    end
+
+    def cloudflare_ip?
+      dns.all? { |answer| answer.class == Net::DNS::RR::A && CloudFlare.controls_ip?(answer.address) }
+    end
+
+    # Returns an array of DNS answers
+    def dns
+      @dns ||= Net::DNS::Resolver.start(domain).answer if domain
+    rescue Exception => msg
+      false
+    end
+
+    # Does this domain have *any* A record that points to the legacy IPs?
+    def old_ip_address?
+      dns.any? { |answer| answer.class == Net::DNS::RR::A && LEGACY_IP_ADDRESSES.include?(answer.address.to_s) }
+    end
+
+    # Is this domain's first response an A record?
+    def a_record?
+      dns.first.class == Net::DNS::RR::A
+    end
+
+    # Is this domain's first response a CNAME record?
+    def cname_record?
+      dns.first.class == Net::DNS::RR::CNAME
+    end
+
+    # Is this a valid domain that PublicSuffix recognizes?
+    # Used as an escape hatch to prevent false positves on DNS checkes
+    def valid_domain?
+      PublicSuffix.valid? domain
+    end
+
+    # Is this domain an SLD, meaning a CNAME would be innapropriate
+    def apex_domain?
+      PublicSuffix.parse(domain).trd == nil
+    rescue
+      false
+    end
+
+    # Should the domain be an apex record?
+    def should_be_a_record?
+      !pages_domain? && apex_domain?
+    end
+
+    # Is the domain's first response a CNAME to a pages domain?
+    def pointed_to_github_user_domain?
+      dns.first.class == Net::DNS::RR::CNAME && pages_domain?(dns.first.cname.to_s)
+    end
+
+    # Is the given cname a pages domain?
+    #
+    # domain - the domain to check, generaly the target of a cname
+    def pages_domain?(domain = domain)
+      !!domain.match(/^[\w-]+\.github\.(io|com)\.?$/i)
+    end
+
+    def to_hash
+      {
+        :cloudflare_ip?                 => cloudflare_ip?,
+        :old_ip_address?                => old_ip_address?,
+        :a_record?                      => a_record?,
+        :cname_record?                  => cname_record?,
+        :valid_domain?                  => valid_domain?,
+        :apex_domain?                   => apex_domain?,
+        :should_be_a_record?            => should_be_a_record?,
+        :pointed_to_github_user_domain? => pointed_to_github_user_domain?,
+        :pages_domain?                  => pages_domain?,
+        :valid?                         => valid?,
+        :reason                         => reason
+      }
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+    # Runs all checks, raises an error if invalid
+    def check!
+      return unless dns
+      return if cloudflare_ip?
+      raise DeprecatedIP if a_record? && old_ip_address?
+      raise InvalidARecord if valid_domain? && a_record? && !should_be_a_record?
+      raise InvalidCNAME if valid_domain? && !apex_domain? && !pointed_to_github_user_domain?
+      true
+    end
+    alias_method :valid!, :check!
+
+    # Runs all checks, returns true if valid, otherwise false
+    def valid?
+      check!
+      true
+    rescue
+      false
+    end
+
+    # Return the error, if any
+    def reason
+      check!
+      nil
+    rescue GitHubPages::HealthCheck::Error => e
+      e
+    end
+
+    def inspect
+      "#<GitHubPages::HealthCheck @domain=\"#{domain}\" valid?=#{valid?}>"
+    end
+
+    def to_s
+      to_hash.inject(Array.new) do |all, pair|
+        all.push pair.join(": ")
+      end.join("\n")
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+class GitHubPages
+  class HealthCheck
+    class CloudFlare
+      include Singleton
+
+      CONFIG_PATH = File.expand_path("../../config/cloudflare-ips.txt", File.dirname(__FILE__))
+
+      # Public: Does cloudflare control this address?
+      def self.controls_ip?(address)
+        instance.controls_ip?(address)
+      end
+
+      # Internal: Create a new cloudflare info instance.
+      def initialize(options = {})
+        @path = options.fetch(:path) { CONFIG_PATH }
+      end
+
+      # Internal: The path of the config file.
+      attr_reader :path
+
+      # Internal: Does cloudflare control this address?
+      def controls_ip?(address)
+        ranges.any? { |range| range.include?(address) }
+      end
+
+      # Internal: The IP address ranges that cloudflare controls.
+      def ranges
+        @ranges ||= load_ranges
+      end
+
+      # Internal: Load IPAddr ranges from #path
+      def load_ranges
+        File.read(path).lines.map { |line| IPAddr.new(line.chomp) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+class GitHubPages
+  class HealthCheck
+    class Error < StandardError
+      def message
+        "Invalid domain"
+      end
+      def to_s
+        message
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+class GitHubPages
+  class HealthCheck
+    class DeprecatedIP < Error
+      def message
+        "A record points to deprecated IP address"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+class GitHubPages
+  class HealthCheck
+    class InvalidARecord < Error
+      def message
+        "Should not be an A record"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+class GitHubPages
+  class HealthCheck
+    class InvalidCNAME < Error
+      def message
+        "CNAME does not point to GitHub Pages"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+class GitHubPages
+  class HealthCheck
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: github-pages-health-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GitHub, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-dns
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Checks your GitHub Pages site for commons DNS configuration issues.
+email: support@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- config/cloudflare-ips.txt
+- lib/github-pages-health-check.rb
+- lib/github-pages-health-check/cloudflare.rb
+- lib/github-pages-health-check/error.rb
+- lib/github-pages-health-check/errors/deprecated_ip.rb
+- lib/github-pages-health-check/errors/invalid_a_record.rb
+- lib/github-pages-health-check/errors/invalid_cname.rb
+- lib/github-pages-health-check/version.rb
+homepage: https://github.com/github/github-pages-health-check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Checks your GitHub Pages site for commons DNS configuration issues
+test_files: []