cert_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fbfe0496dab05b12e7f5d32ff36b27a12c129714f1631ba3c32f220b7093ae6
+  data.tar.gz: fa06b46de835033f37ff60bf76e120aac7e495cd16a93f2f37c9cddc1bc22f01
+SHA512:
+  metadata.gz: 4ad67822ece77d667957d8fe139d75ac50b7f9aa4c4d89870c83b8d81d8c8101542785d50888a6510f3454c6da0605239eb4c186e56948768fe815a52b42524e
+  data.tar.gz: ebd96f2c92a505932ecdcd2c4207ff8bfb2b1a3c2bfef18486d823636f7aaab4373dca2128e9ffcd46ccca1c4431248982309be88c2c3f66fdb7d24ab6555966

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+spec/examples.txt
+
+*.swp

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require gem_helper

data/.rubocop.yml

@@ -0,0 +1,137 @@
+---
+# https://github.com/rails/rails/blob/master/.rubocop.yml
+#
+AllCops:
+  TargetRubyVersion: 2.5
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+  IndentOneStep: false
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# No extra empty lines.
+Layout/EmptyLines:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  # EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+# str = "abcda"
+# str.gsub!("c", "b") # will raise a error, we cannot change string literal
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Include:
+    - 'app/**/*'
+    - 'lib/**/*'
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+# Style/StringLiterals:
+#   Enabled: true
+#   EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+# Style/UnneededPercentQ:
+#   Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cert_checker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    cert_checker (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    method_source (0.9.2)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  cert_checker!
+  pry (>= 0.10)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.60.0)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 jiangzhi.xie
+
+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/README.md

@@ -0,0 +1,87 @@
+# CertChecker
+
+A tool to check X509 cert status
+
+## Installation
+
+```
+$ gem install cert_checker
+```
+
+## Command Line Usage
+
+
+```
+$ cert_checker
+cert_checker [-d domain_or_ip] [-f hosts_file]
+    -d host                          host name, example google.com. more host: -h h1.com -h h2.com
+    -f file                          hosts file, split hosts by new line, and ignore line whice start by # and empt line
+```
+
+### Examples
+
+```
+$ cert_checker -d taobao.com -d xjz.pw
+ok             taobao.com                          GlobalSign nv-sa     2019-11-13 344 days
+ok             xjz.pw                              Let's Encrypt        2019-02-18 76 days
+
+$ cat >> myhosts <<EOF
+# A
+xjz.pw
+
+# B
+taobao.com
+jd.com
+EOF
+
+$ cert_checker -f myhosts
+ok             xjz.pw                              Let's Encrypt        2019-02-18 76 days
+ok             taobao.com                          GlobalSign nv-sa     2019-11-13 344 days
+ok             jd.com                              GlobalSign nv-sa     2019-09-28 298 days
+```
+
+## Code Usage 
+
+```
+require 'cert_checker'
+
+status, host, issuer, expired, desc = CertChecker.check('taobao.com')
+
+# Other port and timeout
+port = 443 # default
+status, host, issuer, expired, desc = CertChecker.check('taobao.com', port, timeout: 5)
+```
+
+**Add your root cert**
+
+```
+CertChecker.cert_store.add_cert(root_ca)
+
+# It will trust certs which signed by this root ca
+status, host, issuer, expired, desc = CertChecker.check('mydomain.com', port, timeout: 3)
+```
+
+**Multiple cert store instance**
+
+```
+class MyChecker
+  include CertChecker
+end
+
+MyChecker.cert_store.add_cert(root_ca)
+status, host, issuer, expired, desc = MyChecker.check('mydomain.com', port, timeout: 3)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xiejiangzhi/cert_checker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cert_checker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cert_checker.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cert_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cert_checker"
+  spec.version       = CertChecker::VERSION
+  spec.authors       = ["jiangzhi.xie"]
+  spec.email         = ["xiejiangzhi@gmail.com"]
+
+  spec.summary       = %q{A tool to check host certs config}
+  spec.description   = %q{A tool to check host certs config}
+  spec.homepage      = "https://github.com/xiejiangzhi/cert_checker"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", ">= 0.10"
+  spec.add_development_dependency "rubocop", "~> 0.60.0"
+end

data/exe/cert_checker

@@ -0,0 +1,42 @@
+#! /usr/bin/env ruby
+
+require 'cert_checker'
+require 'optparse'
+
+options = { hosts: [] }
+
+parser = OptionParser.new do |opts|
+  opts.banner = "cert_checker [-d domain_or_ip] [-f hosts_file]"
+  opts.version = CertChecker::VERSION
+
+  opts.on('-d domain', "host name, example google.com. more host: -d h1.com -d h2.com") do |host|
+    options[:hosts] << host
+  end
+
+  opts.on(
+    '-f file', "hosts file, split hosts by new line, and ignore line whice start by # and empt line"
+  ) do |file|
+    options[:file] = file
+  end
+end
+
+parser.parse!
+
+hosts = options[:hosts]
+if (file = options[:file]) && File.exists?(file)
+  hosts += File.readlines(file).map(&:strip).select { |host| host.size > 0 && host[0] != '#' }
+end
+
+puts parser.help if hosts.empty?
+
+format = "%-14s %-35s %-20s %10s %s"
+hosts.each do |host|
+  begin
+    status, host, issuer, expired, desc = CertChecker.check(host)
+    expired = expired.strftime('%F') if expired
+    desc = desc.to_s + ' days' if desc.to_s =~ /^\d+$/
+    puts format % [status, host, issuer, expired, desc]
+  rescue CertChecker::Error => e
+    puts format % ['error', e.message]
+  end
+end

data/lib/cert_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CertChecker
+  VERSION = "0.1.0"
+end

data/lib/cert_checker.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "cert_checker/version"
+
+require 'socket'
+require 'openssl'
+
+module CertChecker
+  extend self
+
+  class Error < StandardError; end
+
+  DEFAULT_TIMEOUT = 5
+  ONE_DAY = 3600.0 * 24
+
+  def get_cert(host, port = 443, timeout: DEFAULT_TIMEOUT)
+    tcp_client = Socket.tcp(host, port, connect_timeout: timeout)
+    ssl_client = OpenSSL::SSL::SSLSocket.new(tcp_client)
+    ssl_client.hostname = host
+
+    begin
+      ssl_client.connect_nonblock
+    rescue IO::WaitReadable
+      retry if IO.select([ssl_client], nil, nil, timeout)
+    rescue IO::WaitWritable
+      retry if IO.select(nil, [ssl_client], nil, timeout)
+    end
+
+    [ssl_client.peer_cert, ssl_client.peer_cert_chain].tap do
+      ssl_client.close
+      tcp_client.close
+    end
+  rescue SocketError, SystemCallError, OpenSSL::SSL::SSLError => e
+    raise CertChecker::Error.new("Failed to get cert of #{host}:#{port}. #{e.inspect}")
+  end
+
+  # @return [cert, verify_result, cert_chain, err_str]
+  def verify(host, *args)
+    cert, cert_chain = get_cert(host, *args)
+    if cert
+      err = nil
+      result = cert_store.verify(cert, cert_chain) { |r, s| err = s.error_string unless r; r }
+      [cert, result, cert_chain, err]
+    end
+  end
+
+  # @return [status_symbol, host, issuer, expired_at, desc]
+  def check(host, *args)
+    cert, verify_result, cert_chain, err_str = verify(host, *args)
+    return ['failed', host, nil, nil, nil] unless cert
+    status_sym = :unverifiable unless verify_result
+
+    issuer = get_cert_issuer_name(cert)
+    expired_at = cert.not_after
+    valid_days = ((cert.not_after - Time.now) / ONE_DAY).floor
+    valid_days = 0 if valid_days < 0
+    desc = err_str || valid_days
+
+    status_sym ||= :not_match unless verify_cert_dns(host, cert)
+    status_sym ||= if expired_at <= Time.now then :expired
+    elsif expired_at <= Time.now + 15 * ONE_DAY then :urgent
+    elsif expired_at <= Time.now + 30 * ONE_DAY then :warning
+    else :ok
+    end
+
+    [status_sym, host, issuer, expired_at, desc]
+  end
+
+  def cert_store
+    @cert_store ||= OpenSSL::X509::Store.new.tap do |store|
+      store.set_default_paths
+    end
+  end
+
+  private
+
+  def verify_cert_dns(host, cert)
+    dns_ext = cert.extensions.find { |e| e.oid == 'subjectAltName' }
+    dns = dns_ext.value.split(',').map { |d| d.split(':').last }
+    !dns.all? { |d| !(Regexp.new('\A' + d.gsub('*', '.+') + '\z') =~ host) }
+  end
+
+  def get_cert_issuer_name(cert)
+    issuer_names = cert.issuer.to_a
+    (
+      issuer_names.find { |name, data, type| name == 'O' } ||
+      issuer_names.find { |name, data, type| name == 'CN' }
+    )[1]
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: cert_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiangzhi.xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+description: A tool to check host certs config
+email:
+- xiejiangzhi@gmail.com
+executables:
+- cert_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cert_checker.gemspec
+- exe/cert_checker
+- lib/cert_checker.rb
+- lib/cert_checker/version.rb
+homepage: https://github.com/xiejiangzhi/cert_checker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A tool to check host certs config
+test_files: []