SSLTest
A small ruby gem (with no dependencies) to help you test a website's SSL certificate.
gem 'ssl-test'
Usage
Simply call the SSLTest.test_url method and it'll return 3 values:
- the validity of the certificate
- the error message (if any)
- the certificate itself
Example with good cert:
valid, error, cert = SSLTest.test_url "https://google.com"
valid # => true
error # => nil
cert # => #<OpenSSL::X509::Certificate...>
Example with bad certificate:
valid, error, cert = SSLTest.test_url "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:
valid, error, cert = SSLTest.test_url "https://thisisdefinitelynotawebsite.com"
valid # => nil
error # => "SSL certificate test failed: getaddrinfo: Name or service not known"
cert # => nil
You can also pass custom timeout values (defaults to 5 seconds for open and read):
valid, error, cert = SSLTest.test_url "https://slowebsite.com", open_timeout: 2, read_timeout: 2
valid # => nil
error # => "SSL certificate test failed: execution expired"
cert # => nil
Or a proxy host and port to use for the http requests:
valid, error, cert = SSLTest.test_url "https://slowebsite.com", proxy_host: 'localhost', proxy_port: 8080
valid # => true
error # => nil
cert # => #<OpenSSL::X509::Certificate...>
Revoked certificates are detected using CRL by default:
valid, error, cert = SSLTest.test_url "https://revoked.badssl.com"
valid # => false
error # => "SSL certificate revoked: Key Compromise (revocation date: 2019-10-07 20:30:39 UTC)"
cert # => #<OpenSSL::X509::Certificate...>
If the CRL is missing, invalid or unreachable the certificate revocation will be tested using OCSP.
If both CRL and OCSP tests are impossible, the certificate will still be considered valid but with an error message:
valid, error, cert = SSLTest.test_url "https://sitewithnoOCSPorCRL.com"
valid # => true
error # => "Revocation test couldn't be performed: CRL: Missing crlDistributionPoints extension, OCSP: Missing OCSP URI in authorityInfoAccess extension"
cert # => #<OpenSSL::X509::Certificate...>
Testing when you have the client certificate and Certificate Authority Bundle
If you already have access to the client certificate and the CA certificate bundle to check against, you can call test_cert which takes a certificate and ca bundle certificate instead of a URL. it has all the same options as test_url
cert = OpenSSL::X509::Certificate.new(File.read('path/to/certificate')))
ca_bundle = OpenSSL::X509::Certificate.load(File.read('path/to/ca-bundle-certificate'))
valid, error, cert = SSLTest.test_cert(cert, ca_bundle)
This check will pass for self-signed certificates if the certificate is signed by the ca certificate provided.
How it works
SSLTester connects as an HTTPS client (without issuing any requests) and then closes the connection. It does so using ruby net/https library and verifies the SSL status. It also hooks into the validation process to intercept the raw certificate for you.
After that it fetches the CRL to verify if the certificate has been revoked. If the CRL is not available it'll query the OCSP endpoint instead. It does this for every certificates in the chain (except the root which is trusted by your Operating System). It is possible the first one will be validated with CRL and the intermediate with OCSP depending on what they offer.
Caching
OCSP and CRL responses are cached in memory, which makes subsequent testing faster and more robust (avoids network error and throttling) but be careful about memory usage if you try to validate millions of certificates in a row.
About the caching duration:
- OCSP responses are cached until their "next_update" indicated inside the repsonse
- OCSP errors are cached for 5 minutes
- CRL responses are cached for 1 hour
CRL responses can be big so when they expires they are re-validated with the server using HTTP caching headers when available (Etag & Last-Modified) to avoid downloading the list again if it didn't change.
You can check the size of the cache with SSLTest.cache_size, which returns:
{
crl: {
lists: 5,
bytes: 5123456
},
ocsp: {
responses: 350,
errors: 2,
bytes: 45876
}
}
You can also flush the cache using SSLTest.flush_cache if you want (not recommended)
Logging
You can enable logging by setting SSLTest.logger, for example:
SSLTest.logger = Rails.logger
SSLTest will log various messages depending on the log level you specify, example:
INFO -- : SSLTest https://www.anonymisation.gov.pf started
DEBUG -- : SSLTest + test_chain_revocation: www.anonymisation.gov.pf
DEBUG -- : SSLTest + CRL: [false, "Missing crlDistributionPoints extension", nil]
DEBUG -- : SSLTest + OCSP: fetch URI http://servicesca.ocsp.certigna.fr
DEBUG -- : SSLTest + OCSP: 200 OK (4661 bytes)
DEBUG -- : SSLTest + OCSP: ocsp_ok
DEBUG -- : SSLTest + test_chain_revocation: Certigna Services CA
DEBUG -- : SSLTest + CRL: fetch URI http://crl.certigna.fr/certigna.crl
DEBUG -- : SSLTest + CRL: 200 OK (1152 bytes)
DEBUG -- : SSLTest + CRL: crl_ok
INFO -- : SSLTest https://www.anonymisation.gov.pf finished: revoked=false
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
- Untrusted root (if your system is up-to-date)
- And more...
But also revoked certs like most browsers (not handled by curl)
Changelog
See also github releases: https://github.com/jarthod/ssl-test/releases
- 1.6.0 - 2026-06-16: Check revocation with CRL first and fall back to OCSP (was OCSP first) to reduce revocation detection delay
- 1.5.0 - 2025-11-28: Add support for local certificates testing and HTTP proxies (#8), changed
#testmethod into#test_urland#test_cert(#testremains as an alias for#test_urlfor backward-compatibility) - 1.4.1 - 2022-10-24: Add support for "tcps://" scheme
- 1.4.0 - 2021-01-16: Implemented CRL as fallback to OCSP + expose cache metrics + add logger support
- 1.3.1 - 2020-04-25: Improved caching of failed OCSP responses (#5)
- 1.3.0 - 2020-04-25: Added revoked cert detection using OCSP (#3)
- 1.2.0 - 2018-03-04: Better support for wrong hostname across ruby versions
- 1.1.0 - 2017-01-13: Removed HTTP call, Net::HTTP#start is enough to open the connection and get cert details and validation
Contributing
- Fork it ( https://github.com/[my-github-username]/ssl-test/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Make sure the tests are passing (
rspec) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request