ssl-test 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21729c3237468056d754aef8e94254d88385a81d
+  data.tar.gz: 8d8f3b8ff9f3dbae8bac6d5342af42ed7ba39bd2
+SHA512:
+  metadata.gz: 52f5e5b81041aff3c33c97582f2163e3f72052fd541765dd8ec27d37900570109afc6d7f1a496fc95086bbccd7eb6828e86e3a1b127bb6652e9963f625dd423e
+  data.tar.gz: 2bb85576cffb6265f3e4b16f846137968ae8ad74fdeda1da9f61a589dfcff26e8d8920f0ed8e69386e3e6c854f4fc4dfec98309e938f0ffc27c9ea1934b60b65

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ssl-test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Adrien Jarthon
+
+MIT License
+
+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,74 @@
+# SSLTest
+
+A small tool to help you test a website's SSL certificate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ssl-test'
+```
+
+Or install it yourself as:
+
+    $ gem install ssl-test
+
+## Usage
+
+Simply call the `SSLTest.test` method and it'll return 3 values:
+1. the validity of the certificate
+2. the error message (if any)
+3. the certificate itself
+
+Example with good cert:
+```ruby
+valid, error, cert = SSLTest.test "https://google.com"
+valid # => true
+error # => nil
+cert # => #<OpenSSL::X509::Certificate...>
+```
+
+Example with bad certificate:
+```ruby
+valid, error, cert = SSLTest.test "https://testssl-expire.disig.sk"
+valid # => false
+error # => "error code 10: certificate has expired"
+cert # => #<OpenSSL::X509::Certificate...>
+```
+
+If the request fails and we're unable to detemine the validity, here are the returned values:
+```ruby
+valid, error, cert = SSLTest.test "https://thisisdefinitelynotawebsite.com"
+valid # => nil
+error # => "SSL certificate test failed: getaddrinfo: Name or service not known"
+cert # => nil
+```
+
+## How it works
+
+SSLTester simply performs a HEAD request using ruby `net/https` library and verifies the SSL status. It also hooks into the validation process to intercept the raw certificate for you.
+
+### What kind of errors will SSLTest detect
+
+Pretty much the same errors `curl` will:
+- Expired certificates
+- Incomplete certificate chain (missing intermediary)
+- Self signed certificates
+- Valid certs used with incorect hostname
+
+### GOTCHA: errors SSLTest will NOT detect
+
+There is a spefic kind or error this code will *NOT* detect: *revoked certificates*. This is much more complex to handle because it needs an up to date database of revoked certs to check with. This is implemented in most modern browsers but the results vary greatly (chrome ignores this for example).
+
+Here is an example of website with a revoked certificate: https://revoked.grc.com/
+
+Any contribution to add this feature is greatly appreciated :)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ssl-test/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Open an irb session preloaded with ssl-test"
+task :console do
+  sh "irb -rubygems -I lib -r ssl_test.rb"
+end
+
+task default: :test

data/lib/ssl_test.rb

@@ -0,0 +1,32 @@
+require "net/https"
+
+module SSLTest
+  VERSION = "0.0.1"
+
+  def self.test url
+    uri = URI.parse(url)
+    return if uri.scheme != 'https'
+    cert = failed_cert_reason = nil
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.verify_callback = -> (verify_ok, store_context) {
+      cert = store_context.current_cert
+      failed_cert_reason =  [store_context.error, store_context.error_string] if !verify_ok
+      verify_ok
+    }
+
+    req = Net::HTTP::Head.new('/')
+    begin
+      res = http.start { http.request(req) }
+      return [true, nil, cert]
+    rescue OpenSSL::SSL::SSLError => e
+      error = e.message
+      error = "error code %d: %s" % failed_cert_reason if failed_cert_reason
+      return [false, error, cert]
+    rescue => e
+      return [nil, "SSL certificate test failed: #{e.message}"]
+    end
+  end
+end

data/ssl-test.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ssl_test'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ssl-test"
+  spec.version       = SSLTest::VERSION
+  spec.authors       = ["Adrien Jarthon"]
+  spec.email         = ["jobs@adrienjarthon.com"]
+  spec.summary       = %q{Test website SSL certificate validity}
+  spec.homepage      = "https://github.com/jarthod/ssl-test"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/ssl_test_test.rb

@@ -0,0 +1,50 @@
+require "ssl_test"
+require "minitest/autorun"
+
+describe SSLTest do
+
+  describe '.test' do
+    it "returns no error on valid SNI website" do
+      valid, error, cert = SSLTest.test("https://www.mycs.com")
+      valid.must_equal true
+      error.must_be_nil
+      cert.must_be_instance_of OpenSSL::X509::Certificate
+    end
+
+    it "returns error on self signed certificate" do
+      valid, error, cert = SSLTest.test("https://kernelcoffee.org")
+      valid.must_equal false
+      error.must_equal "error code 18: self signed certificate"
+      cert.must_be_instance_of OpenSSL::X509::Certificate
+    end
+
+    it "returns error on invalid host" do
+      valid, error, cert = SSLTest.test("https://staging.updown.io")
+      valid.must_equal false
+      error.must_equal 'hostname "staging.updown.io" does not match the server certificate'
+      cert.must_be_instance_of OpenSSL::X509::Certificate
+    end
+
+    it "returns error on expired cert" do
+      valid, error, cert = SSLTest.test("https://testssl-expire.disig.sk")
+      valid.must_equal false
+      error.must_equal "error code 10: certificate has expired"
+      cert.must_be_instance_of OpenSSL::X509::Certificate
+    end
+
+    it "returns undetermined state on unhandled error" do
+      valid, error, cert = SSLTest.test("https://pijoinlrfgind.com")
+      valid.must_be_nil
+      error.must_equal "SSL certificate test failed: getaddrinfo: Name or service not known"
+      cert.must_be_nil
+    end
+
+    # Not implemented yet
+    # it "returns error on revoked cert" do
+    #   valid, error, cert = SSLTest.test("https://revoked.grc.com")
+    #   valid.must_equal false
+    #   error.must_equal "error code XX: certificate has been revoked"
+    #   cert.must_be_instance_of OpenSSL::X509::Certificate
+    # end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: ssl-test
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adrien Jarthon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- jobs@adrienjarthon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ssl_test.rb
+- ssl-test.gemspec
+- test/ssl_test_test.rb
+homepage: https://github.com/jarthod/ssl-test
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Test website SSL certificate validity
+test_files:
+- test/ssl_test_test.rb
+has_rdoc: