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(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) 


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

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

#aaaa_record_present? ⇒ Boolean

Returns:

  • (Boolean) 


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

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) 


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

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.
  PublicSuffix.domain(host) == host
end

#caa_error ⇒ Object

Any errors querying CAA records



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

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) 


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

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



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

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) 


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

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) 


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

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) 


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

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) 


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

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



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

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) 


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

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

#enforces_https? ⇒ Boolean

Does this domain redirect HTTP requests to HTTPS?

Returns:

  • (Boolean) 


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

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) 


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

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) 


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

def fastly_ip?
  cdn_ip?(Fastly)
end

#github_domain? ⇒ Boolean

Is this domain owned by GitHub?

Returns:

  • (Boolean) 


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

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) 


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

def https?
  https_response.return_code == :ok
end

#https_eligible? ⇒ Boolean

Can an HTTPS certificate be issued for this domain?

Returns:

  • (Boolean) 


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

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



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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

#should_be_cname_record? ⇒ Boolean

Returns:

  • (Boolean) 


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

def should_be_cname_record?
  !should_be_a_record?
end

#uri(overrides = {}) ⇒ Object 



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

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
 
# File 'lib/github-pages-health-check/domain.rb', line 148

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