Class: GitHubPages::HealthCheck::Domain

Inherits:
Checkable
  • Object
show all
Defined in:
lib/github-pages-health-check/domain.rb

Constant Summary collapse

LEGACY_IP_ADDRESSES = 
[
  # Legacy GitHub Datacenter
  "207.97.227.245",
  "204.232.175.78",

  # Aug. 2016 Fastly datacenter deprecation
  "199.27.73.133",
  "199.27.76.133",

  # Feb. 2017 Fastly datacenter deprecation
  "103.245.222.133",
  "103.245.223.133",
  "103.245.224.133",
  "104.156.81.133",
  "104.156.82.133",
  "104.156.83.133",
  "104.156.85.133",
  "104.156.87.133",
  "104.156.88.133",
  "104.156.89.133",
  "104.156.90.133",
  "104.156.91.133",
  "104.156.92.133",
  "104.156.93.133",
  "104.156.94.133",
  "104.156.95.133",
  "104.37.95.133",
  "157.52.64.133",
  "157.52.66.133",
  "157.52.67.133",
  "157.52.68.133",
  "157.52.69.133",
  "157.52.96.133",
  "172.111.64.133",
  "172.111.96.133",
  "185.31.16.133",
  "185.31.17.133",
  "185.31.18.133",
  "185.31.19.133",
  "199.27.74.133",
  "199.27.75.133",
  "199.27.76.133",
  "199.27.78.133",
  "199.27.79.133",
  "23.235.33.133",
  "23.235.37.133",
  "23.235.39.133",
  "23.235.40.133",
  "23.235.41.133",
  "23.235.43.133",
  "23.235.44.133",
  "23.235.45.133",
  "23.235.46.133",
  "23.235.47.133",
  "23.235.47.133",
  "43.249.72.133",
  "43.249.73.133",
  "43.249.74.133",
  "43.249.75.133"
].freeze
NEW_PRIMARY_IPS = 
%w(
  185.199.108.153
  185.199.109.153
  185.199.110.153
  185.199.111.153
).freeze
CURRENT_IP_ADDRESSES = 
[
  "192.30.252.153",
  "192.30.252.154",
  *NEW_PRIMARY_IPS
].freeze
HASH_METHODS = 
%i[
  host uri nameservers dns_resolves? proxied? cloudflare_ip?
  fastly_ip? old_ip_address? a_record? cname_record?
  mx_records_present? valid_domain? apex_domain? should_be_a_record?
  cname_to_github_user_domain? cname_to_pages_dot_github_dot_com?
  cname_to_fastly? pointed_to_github_pages_ip? pages_domain?
  served_by_pages? valid? reason valid_domain? https?
  enforces_https? https_error https_eligible? caa_error
].freeze
REQUESTED_RECORD_TYPES = 
[
  Dnsruby::Types::A,
  Dnsruby::Types::AAAA,
  Dnsruby::Types::CNAME,
  Dnsruby::Types::MX
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Checkable

#reason, #to_hash, #to_json, #to_s, #to_s_pretty, #valid?

Constructor Details

#initialize(host, nameservers: :default) ⇒ Domain

Returns a new instance of Domain.



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/github-pages-health-check/domain.rb', line 96

def initialize(host, nameservers: :default)
  unless host.is_a? String
    raise ArgumentError, "Expected string, got #{host.class}"
  end

  @host = normalize_host(host)
  @nameservers = nameservers
  @resolver = GitHubPages::HealthCheck::Resolver.new(self.host,
    :nameservers => nameservers)
end

Instance Attribute Details

#host ⇒ Object (readonly)

Returns the value of attribute host.



6
7
8
 
# File 'lib/github-pages-health-check/domain.rb', line 6

def host
  @host
end

#nameservers ⇒ Object (readonly)

Returns the value of attribute nameservers.



6
7
8
 
# File 'lib/github-pages-health-check/domain.rb', line 6

def nameservers
  @nameservers
end

#resolver ⇒ Object (readonly)

Returns the value of attribute resolver.



6
7
8
 
# File 'lib/github-pages-health-check/domain.rb', line 6

def resolver
  @resolver
end

Class Method Details

.redundant(host) ⇒ Object 



92
93
94
 
# File 'lib/github-pages-health-check/domain.rb', line 92

def self.redundant(host)
  GitHubPages::HealthCheck::RedundantCheck.new(host).check
end

Instance Method Details

#a_record? ⇒ Boolean

Is this domain’s first response an A record?

Returns:

  • (Boolean) 


297
298
299
300
 
# File 'lib/github-pages-health-check/domain.rb', line 297

def a_record?
  return unless dns?
  dns.first.type == Dnsruby::Types::A
end

#aaaa_record_present? ⇒ Boolean

Returns:

  • (Boolean) 


302
303
304
305
 
# File 'lib/github-pages-health-check/domain.rb', line 302

def aaaa_record_present?
  return unless dns?
  dns.any? { |answer| answer.type == Dnsruby::Types::AAAA }
end

#apex_domain? ⇒ Boolean

Is this domain an apex domain, meaning a CNAME would be innapropriate

Returns:

  • (Boolean) 


155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/github-pages-health-check/domain.rb', line 155

def apex_domain?
  return @apex_domain if defined?(@apex_domain)
  return unless valid_domain?

  # PublicSuffix.domain pulls out the apex-level domain name.
  # E.g. PublicSuffix.domain("techblog.netflix.com") # => "netflix.com"
  # It's aware of multi-step top-level domain names:
  # E.g. PublicSuffix.domain("blog.digital.gov.uk") # => "digital.gov.uk"
  # For apex-level domain names, DNS providers do not support CNAME records.
  unicode_host = Addressable::IDNA.to_unicode(host)
  PublicSuffix.domain(unicode_host) == unicode_host
end

#caa_error ⇒ Object

Any errors querying CAA records



371
372
373
374
 
# File 'lib/github-pages-health-check/domain.rb', line 371

def caa_error
  return nil unless caa.errored?
  caa.error.class.name
end

#check! ⇒ Object

Runs all checks, raises an error if invalid

Raises:



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/github-pages-health-check/domain.rb', line 108

def check!
  raise Errors::InvalidDomainError, :domain => self unless valid_domain?
  raise Errors::InvalidDNSError, :domain => self    unless dns_resolves?
  raise Errors::DeprecatedIPError, :domain => self if deprecated_ip?
  return true if proxied?
  raise Errors::InvalidARecordError, :domain => self    if invalid_a_record?
  raise Errors::InvalidCNAMEError, :domain => self      if invalid_cname?
  raise Errors::InvalidAAAARecordError, :domain => self if invalid_aaaa_record?
  raise Errors::NotServedByPagesError, :domain => self  unless served_by_pages?
  true
end

#cloudflare_ip? ⇒ Boolean

Does the domain resolve to a CloudFlare-owned IP

Returns:

  • (Boolean) 


231
232
233
 
# File 'lib/github-pages-health-check/domain.rb', line 231

def cloudflare_ip?
  cdn_ip?(CloudFlare)
end

#cname ⇒ Object

The domain to which this domain’s CNAME resolves Returns nil if the domain is not a CNAME



317
318
319
320
 
# File 'lib/github-pages-health-check/domain.rb', line 317

def cname
  return unless dns.first.type == Dnsruby::Types::CNAME
  @cname ||= Domain.new(dns.first.cname.to_s)
end

#cname_record? ⇒ Boolean Also known as: cname?

Is this domain’s first response a CNAME record?

Returns:

  • (Boolean) 


308
309
310
311
312
 
# File 'lib/github-pages-health-check/domain.rb', line 308

def cname_record?
  return unless dns?
  return false unless cname
  cname.valid_domain?
end

#cname_to_fastly? ⇒ Boolean

Is the given domain CNAME’d directly to our Fastly account?

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/github-pages-health-check/domain.rb', line 201

def cname_to_fastly?
  cname? && !pages_domain? && cname.fastly?
end

#cname_to_github_user_domain? ⇒ Boolean

Is the domain’s first response a CNAME to a pages domain?

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/github-pages-health-check/domain.rb', line 188

def cname_to_github_user_domain?
  cname? && !cname_to_pages_dot_github_dot_com? && cname.pages_domain?
end

#cname_to_pages_dot_github_dot_com? ⇒ Boolean

Is the given domain a CNAME to pages.github.(io|com) instead of being CNAME’d to the user’s subdomain?

domain - the domain to check, generaly the target of a cname

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/github-pages-health-check/domain.rb', line 196

def cname_to_pages_dot_github_dot_com?
  cname? && cname.pages_dot_github_dot_com?
end

#deprecated_ip? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
123
 
# File 'lib/github-pages-health-check/domain.rb', line 120

def deprecated_ip?
  return @deprecated_ip if defined? @deprecated_ip
  @deprecated_ip = (valid_domain? && a_record? && old_ip_address?)
end

#dns ⇒ Object

Returns an array of DNS answers



266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/github-pages-health-check/domain.rb', line 266

def dns
  return @dns if defined? @dns
  return unless valid_domain?
  @dns = Timeout.timeout(TIMEOUT) do
    GitHubPages::HealthCheck.without_warnings do
      next if host.nil?
      REQUESTED_RECORD_TYPES
        .map { |type| resolver.query(type) }
        .flatten.uniq
    end
  end
rescue StandardError
  @dns = nil
end

#dns? ⇒ Boolean Also known as: dns_resolves?

Are we even able to get the DNS record?

Returns:

  • (Boolean) 


282
283
284
 
# File 'lib/github-pages-health-check/domain.rb', line 282

def dns?
  !(dns.nil? || dns.empty?)
end

#enforces_https? ⇒ Boolean

Does this domain redirect HTTP requests to HTTPS?

Returns:

  • (Boolean) 


358
359
360
361
362
 
# File 'lib/github-pages-health-check/domain.rb', line 358

def enforces_https?
  return false unless https? && http_response.headers["Location"]
  redirect = Addressable::URI.parse(http_response.headers["Location"])
  redirect.scheme == "https" && redirect.host == host
end

#fastly? ⇒ Boolean

Is the host our Fastly CNAME?

Returns:

  • (Boolean) 


226
227
228
 
# File 'lib/github-pages-health-check/domain.rb', line 226

def fastly?
  !!host.match(/\A#{Regexp.union(Fastly::HOSTNAMES)}\z/i)
end

#fastly_ip? ⇒ Boolean

Does the domain resolve to a Fastly-owned IP

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/github-pages-health-check/domain.rb', line 236

def fastly_ip?
  cdn_ip?(Fastly)
end

#github_domain? ⇒ Boolean

Is this domain owned by GitHub?

Returns:

  • (Boolean) 


221
222
223
 
# File 'lib/github-pages-health-check/domain.rb', line 221

def github_domain?
  !!host.downcase.end_with?("github.com")
end

#https? ⇒ Boolean

Does this domain respond to HTTPS requests with a valid cert?

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/github-pages-health-check/domain.rb', line 347

def https?
  https_response.return_code == :ok
end

#https_eligible? ⇒ Boolean

Can an HTTPS certificate be issued for this domain?

Returns:

  • (Boolean) 


365
366
367
368
 
# File 'lib/github-pages-health-check/domain.rb', line 365

def https_eligible?
  (cname_to_github_user_domain? || pointed_to_new_primary_ips?) &&
    !aaaa_record_present? && caa.lets_encrypt_allowed?
end

#https_error ⇒ Object

The response code of the HTTPS request, if it failed. Useful for diagnosing cert errors



353
354
355
 
# File 'lib/github-pages-health-check/domain.rb', line 353

def https_error
  https_response.return_code unless https?
end

#invalid_a_record? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
134
 
# File 'lib/github-pages-health-check/domain.rb', line 131

def invalid_a_record?
  return @invalid_a_record if defined? @invalid_a_record
  @invalid_a_record = (valid_domain? && a_record? && !should_be_a_record?)
end

#invalid_aaaa_record? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
128
129
 
# File 'lib/github-pages-health-check/domain.rb', line 125

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?)
end

#invalid_cname? ⇒ Boolean

Returns:

  • (Boolean) 


136
137
138
139
140
141
142
143
144
 
# File 'lib/github-pages-health-check/domain.rb', line 136

def invalid_cname?
  return @invalid_cname if defined? @invalid_cname
  @invalid_cname = begin
    return false unless valid_domain?
    return false if github_domain? || apex_domain?
    return true  if cname_to_pages_dot_github_dot_com? || cname_to_fastly?
    !cname_to_github_user_domain? && should_be_cname_record?
  end
end

#mx_records_present? ⇒ Boolean

Returns:

  • (Boolean) 


322
323
324
325
 
# File 'lib/github-pages-health-check/domain.rb', line 322

def mx_records_present?
  return unless dns?
  dns.any? { |answer| answer.type == Dnsruby::Types::MX }
end

#old_ip_address? ⇒ Boolean

Does this domain have any A record that points to the legacy IPs?

Returns:

  • (Boolean) 


288
289
290
291
292
293
294
 
# File 'lib/github-pages-health-check/domain.rb', line 288

def old_ip_address?
  return unless dns?

  dns.any? do |answer|
    answer.type == Dnsruby::Types::A && legacy_ip?(answer.address.to_s)
  end
end

#pages_domain? ⇒ Boolean

Is the host a *.github.(io|com) domain?

Returns:

  • (Boolean) 


211
212
213
 
# File 'lib/github-pages-health-check/domain.rb', line 211

def pages_domain?
  !!host.match(/\A[\w-]+\.github\.(io|com)\.?\z/i)
end

#pages_dot_github_dot_com? ⇒ Boolean

Is the host pages.github.com or pages.github.io?

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/github-pages-health-check/domain.rb', line 216

def pages_dot_github_dot_com?
  !!host.match(/\Apages\.github\.(io|com)\.?\z/i)
end

#pages_io_domain? ⇒ Boolean

Is the host a *.github.io domain?

Returns:

  • (Boolean) 


206
207
208
 
# File 'lib/github-pages-health-check/domain.rb', line 206

def pages_io_domain?
  !!host.match(/\A[\w-]+\.github\.(io)\.?\z/i)
end

#pointed_to_github_pages_ip? ⇒ Boolean

Is the domain’s first response an A record to a valid GitHub Pages IP?

Returns:

  • (Boolean) 


178
179
180
 
# File 'lib/github-pages-health-check/domain.rb', line 178

def pointed_to_github_pages_ip?
  a_record? && CURRENT_IP_ADDRESSES.include?(dns.first.address.to_s)
end

#pointed_to_new_primary_ips? ⇒ Boolean

Is the domain’s first response an A record to the new primary IPs?

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/github-pages-health-check/domain.rb', line 183

def pointed_to_new_primary_ips?
  a_record? && NEW_PRIMARY_IPS.include?(dns.first.address.to_s)
end

#proxied? ⇒ Boolean

Does this non-GitHub-pages domain proxy a GitHub Pages site?

This can be:

1. A Cloudflare-owned IP address
2. A site that returns GitHub.com server headers, but
   isn't CNAME'd to a GitHub domain
3. A site that returns GitHub.com server headers, but
   isn't CNAME'd to a GitHub IP

Returns:

  • (Boolean) 


248
249
250
251
252
253
254
255
256
 
# File 'lib/github-pages-health-check/domain.rb', line 248

def proxied?
  return unless dns?
  return true if cloudflare_ip?
  return false if pointed_to_github_pages_ip?
  return false if cname_to_github_user_domain?
  return false if cname_to_pages_dot_github_dot_com?
  return false if cname_to_fastly? || fastly_ip?
  served_by_pages?
end

#served_by_pages? ⇒ Boolean

Returns:

  • (Boolean) 


327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/github-pages-health-check/domain.rb', line 327

def served_by_pages?
  return @served_by_pages if defined? @served_by_pages
  return unless dns_resolves?

  @served_by_pages = begin
    return false unless response.mock? || response.return_code == :ok
    return true if response.headers["Server"] == "GitHub.com"

    # Typhoeus mangles the case of the header, compare insensitively
    response.headers.any? { |k, _v| k =~ /X-GitHub-Request-Id/i }
  end
end

#should_be_a_record? ⇒ Boolean

Should the domain use an A record?

Returns:

  • (Boolean) 


169
170
171
 
# File 'lib/github-pages-health-check/domain.rb', line 169

def should_be_a_record?
  !pages_io_domain? && (apex_domain? || mx_records_present?)
end

#should_be_cname_record? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/github-pages-health-check/domain.rb', line 173

def should_be_cname_record?
  !should_be_a_record?
end

#uri(overrides = {}) ⇒ Object 



340
341
342
343
344
 
# File 'lib/github-pages-health-check/domain.rb', line 340

def uri(overrides = {})
  options = { :host => host, :scheme => scheme, :path => "/" }
  options = options.merge(overrides)
  Addressable::URI.new(options).normalize.to_s
end

#valid_domain? ⇒ Boolean

Is this a valid domain that PublicSuffix recognizes? Used as an escape hatch to prevent false positives on DNS checkes

Returns:

  • (Boolean) 


148
149
150
151
152
 
# File 'lib/github-pages-health-check/domain.rb', line 148

def valid_domain?
  return @valid if defined? @valid
  unicode_host = Addressable::IDNA.to_unicode(host)
  @valid = PublicSuffix.valid?(unicode_host, :default_rule => nil)
end