Build Status Software License Release Gem Version Github commits (since latest release) GitHub repo size in bytes GitHub contributors

SSL Expiry

This is a simple little gem for checking when an SSL will expire.

Installation

Add this line to your application's Gemfile:

gem 'ssl_expiry'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ssl_expiry

Usage

Simple Usage

  require 'ssl_expiry'

  SSLExpiry::SSLExpiry.check_certificates('antiphoton.com')

  Results:
  {"antiphoton.com"=>{"status"=>200, "expires_on"=>"09 Mar 2019", "expires_in"=>16, "common_name"=>"antiphoton.com", "issuer"=>"COMODO CA Limited"}}

Displaying the output

  require 'ssl_expiry'

  results = SSLExpiry::SSLExpiry.check_certificates(['antiphoton.com','wolfsoftware.com'])
  SSLExpiry::SSLExpiry.display_results(results)

This would give the following output

  ----------------------------------------------------------------------------------------------------
   Domain                         | Status
  ----------------------------------------------------------------------------------------------------
   antiphoton.com                 | expires on 09 Mar 2019 (in 16 days) [CN=antiphoton.com]
   wolfsoftware.com               | expires on 12 Sep 2019 (in 203 days) [CN=*.wolfsoftware.com]
  ----------------------------------------------------------------------------------------------------

Command Line Tools

There is a command line tool included with this gem.

  check-ssl -d antiphoton.com

  ----------------------------------------------------------------------------------------------------
   Domain                         | Status
  ----------------------------------------------------------------------------------------------------
   antiphoton.com                 | expires on 09 Mar 2019 (in 16 days) [CN=antiphoton.com]
  ----------------------------------------------------------------------------------------------------

Custom port

If you want to check an SSL expiry on a custom port you can do this by adding the port to the end of the domain.

  check-ssl -d antiphoton.com:8080

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.

Testing

For local testing make sure that you run bundle exec rspec spec and then rake install to install the gem locally.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/AntiPhotonltd/ssl_expiry. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the SSLExpiry project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.