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",

  # 2018 Move to GitHub assigned IP space
  "192.30.252.153",
  "192.30.252.154"
].freeze
CURRENT_IP_ADDRESSES = 
%w(
  185.199.108.153
  185.199.109.153
  185.199.110.153
  185.199.111.153
).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?
  non_github_pages_ip_present? 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.



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

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 



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

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) 


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

def a_record?
  return unless dns?

  dns.first.type == Dnsruby::Types::A
end

#aaaa_record_present? ⇒ Boolean

Returns:

  • (Boolean) 


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

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) 


163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/github-pages-health-check/domain.rb', line 163

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,
                      :default_rule => nil,
                      :ignore_private => true) == unicode_host
end

#caa_error ⇒ Object

Any errors querying CAA records



406
407
408
409
410
 
# File 'lib/github-pages-health-check/domain.rb', line 406

def caa_error
  return nil unless caa.errored?

  caa.error.class.name
end

#check! ⇒ Object

Runs all checks, raises an error if invalid

Raises:



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

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) 


247
248
249
 
# File 'lib/github-pages-health-check/domain.rb', line 247

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



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

def cname
  cnames = dns.take_while { |answer| answer.type == Dnsruby::Types::CNAME }
  return if cnames.empty?

  @cname ||= Domain.new(cnames.last.cname.to_s)
end

#cname_record? ⇒ Boolean Also known as: cname?

Is this domain’s first response a CNAME record?

Returns:

  • (Boolean) 


329
330
331
332
333
334
 
# File 'lib/github-pages-health-check/domain.rb', line 329

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) 


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

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) 


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

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) 


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

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
124
 
# 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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/github-pages-health-check/domain.rb', line 283

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) 


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

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

#enforces_https? ⇒ Boolean

Does this domain redirect HTTP requests to HTTPS?

Returns:

  • (Boolean) 


383
384
385
386
387
388
 
# File 'lib/github-pages-health-check/domain.rb', line 383

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) 


242
243
244
 
# File 'lib/github-pages-health-check/domain.rb', line 242

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) 


252
253
254
 
# File 'lib/github-pages-health-check/domain.rb', line 252

def fastly_ip?
  cdn_ip?(Fastly)
end

#github_domain? ⇒ Boolean

Is this domain owned by GitHub?

Returns:

  • (Boolean) 


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

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) 


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

def https?
  https_response.return_code == :ok
end

#https_eligible? ⇒ Boolean

Can an HTTPS certificate be issued for this domain?

Returns:

  • (Boolean) 


391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/github-pages-health-check/domain.rb', line 391

def https_eligible?
  # Can't have any IP's which aren't GitHub's present.
  return false if non_github_pages_ip_present?
  # Can't have any AAAA records present
  return false if aaaa_record_present?
  # Must be a CNAME or point to our IPs.

  # Only check the one domain if a CNAME. Don't check the parent domain.
  return true if cname_to_github_user_domain?

  # Check CAA records for the full domain and its parent domain.
  pointed_to_github_pages_ip? && caa.lets_encrypt_allowed?
end

#https_error ⇒ Object

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



378
379
380
 
# File 'lib/github-pages-health-check/domain.rb', line 378

def https_error
  https_response.return_code unless https?
end

#invalid_a_record? ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
136
137
 
# File 'lib/github-pages-health-check/domain.rb', line 133

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) 


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

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) 


139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/github-pages-health-check/domain.rb', line 139

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) 


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

def mx_records_present?
  return unless dns?

  dns.any? { |answer| answer.type == Dnsruby::Types::MX }
end

#non_github_pages_ip_present? ⇒ Boolean

Are any of the domain’s A records pointing elsewhere?

Returns:

  • (Boolean) 


193
194
195
196
197
198
199
200
201
 
# File 'lib/github-pages-health-check/domain.rb', line 193

def non_github_pages_ip_present?
  return unless dns?

  a_records = dns.select { |answer| answer.type == Dnsruby::Types::A }

  a_records.any? { |answer| !github_pages_ip?(answer.address.to_s) }

  false
end

#old_ip_address? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def pointed_to_github_pages_ip?
  a_record? && CURRENT_IP_ADDRESSES.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) 


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

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) 


352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/github-pages-health-check/domain.rb', line 352

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) 


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

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

#should_be_cname_record? ⇒ Boolean

Returns:

  • (Boolean) 


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

def should_be_cname_record?
  !should_be_a_record?
end

#uri(overrides = {}) ⇒ Object 



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

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) 


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

def valid_domain?
  return @valid if defined? @valid

  unicode_host = Addressable::IDNA.to_unicode(host)
  @valid = PublicSuffix.valid?(unicode_host,
                               :default_rule => nil,
                               :ignore_private => true)
end