sslcheck 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51b5701a3d326048e59aa81785d096d9d5e4e15c
-  data.tar.gz: 078098c638a5e5a8c4ffb262522e525c38b1cb54
+  metadata.gz: 4d4251f26088c6cda3ea58337487f6a775a840f1
+  data.tar.gz: d881012a9c13e3d11e62ac9febba24b4fd6c214d
 SHA512:
-  metadata.gz: 202bcdefd4a17ade919d6020e0e58fd874edd0620f0d0b5ce40df9c47026387e275ec3fffe4900f7d9afd3bcd5e0ed5897d1b6089cb3b02cfffa74afd97655ff
-  data.tar.gz: a974d145b55cbe75e435c5a71f5cd651ef53db6ff85617995f6dfe9f6ff6e488a3c059032c254bd15edc492e2f544e6f375131b2398c007f8b600f63260cc009
+  metadata.gz: 085c88e749846da6c9fe93d4e916a12ba96a1b56ba3ab48d64063fdd897f5043a8cda94d8182cdfcf1d8a7a283186839690319168ee06039d396ed3bc26940f8
+  data.tar.gz: ab57c766f1868f5beaaa875cf8079e1ef14f59b2f9c788377a8ead127566be904d1c38929c423d00d31e59a5d63ab7a0b8992ef61a94840caf8b0c435c2e4eae

data/README.md

@@ -48,6 +48,18 @@ Are there any errors?
   => []
 ```
 
+## Timeouts
+
+By default, connections to verify a certificate will timeout after 30 seconds. To
+change this behavior, specify your own timeout, in seconds, on the `SSLCheck::Client`
+class.
+
+```
+  SSLCheck::Client.timeout_seconds = 10  # A 10 second timeout
+  check = SSLCheck::Check.new
+  check.check("github.com")
+```
+
 What are the details of the certificate?
 
 The peer certificate found during the check is available with a rich

data/acceptance/client_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 module SSLCheck
   describe 'Client' do
     context "Getting Certificates" do
+      before do
+        Client.timeout_seconds = 1
+      end
+
       context "When Things Go Well" do
         it 'should have the host name' do
           sut = Client.new
@@ -41,9 +45,10 @@ module SSLCheck
 
       context "When the URL is not a real TLD or gTLD" do
         it 'should raise a connection error' do
+          Client.timeout_seconds = 1
           sut = Client.new
           response = sut.get("https://www.domain.does.not.exist.aljdahkqhb")
-          expect(response.errors.first).to be_a(SSLCheck::Errors::Connection::SocketError)
+          expect(response.errors.first).to be_a(SSLCheck::Errors::Connection::Timeout)
         end
       end
 
@@ -71,5 +76,41 @@ module SSLCheck
         end
       end
     end
+    describe 'Timeout' do
+      before do
+        Client.timeout_seconds = 30
+      end
+
+      it 'should use the timeout value when making connections' do
+        expect(Timeout).to receive(:timeout).with(30)
+        sut = Client.new
+        sut.get('https://www.sslinsight.com')
+      end
+      context 'When the timeout is not set' do
+        it 'should default to 30 seconds' do
+          expect(SSLCheck::Client.timeout_seconds).to eq(30)
+        end
+      end
+      context 'overriding the default timeout' do
+        it 'should use the supplied timeout value' do
+          SSLCheck::Client.timeout_seconds = 10
+          expect(SSLCheck::Client.timeout_seconds).to eq(10)
+        end
+        it 'should use the timeout value when making connections' do
+          SSLCheck::Client.timeout_seconds = 10
+          expect(Timeout).to receive(:timeout).with(10)
+          sut = Client.new
+          sut.get('https://www.sslinsight.com')
+        end
+      end
+      context 'When the timeout expires' do
+        it 'should raise a connection error' do
+          SSLCheck::Client.timeout_seconds = 1
+          sut = Client.new
+          response = sut.get("https://www.domain.does.not.exist.aljdahkqhb")
+          expect(response.errors.first).to be_a(SSLCheck::Errors::Connection::Timeout)
+        end
+      end
+    end
   end
 end

data/lib/sslcheck/client.rb

@@ -4,6 +4,16 @@ require 'openssl'
 
 module SSLCheck
   class Client
+    @@timeout_seconds = 30
+
+    def self.timeout_seconds
+      @@timeout_seconds
+    end
+
+    def self.timeout_seconds=(seconds)
+      @@timeout_seconds = seconds
+    end
+
     class Response
       attr_accessor :host_name, :errors
 
@@ -34,21 +44,33 @@ module SSLCheck
 
     def get(url)
       begin
-        uri = determine_uri(url)
+        Timeout::timeout(Client.timeout_seconds) {
+          uri = determine_uri(url)
+
+          sock = TCPSocket.new(uri.host, 443)
+          ctx = OpenSSL::SSL::SSLContext.new
+          ctx.set_params(
+            :verify_mode => OpenSSL::SSL::VERIFY_PEER,
+            :timeout     => Client.timeout_seconds,
+            :ssl_timeout => Client.timeout_seconds,
+          )
+
+          ctx.timeout = Client.timeout_seconds
+          ctx.ssl_timeout = Client.timeout_seconds
 
-        sock = TCPSocket.new(uri.host, 443)
-        ctx = OpenSSL::SSL::SSLContext.new
-        ctx.set_params(:verify_mode => OpenSSL::SSL::VERIFY_PEER)
+          @socket = OpenSSL::SSL::SSLSocket.new(sock, ctx).tap do |socket|
+            socket.sync_close = true
+            socket.connect
+            @response.host_name = uri.host
+            @response.raw_peer_cert = OpenSSL::X509::Certificate.new(socket.peer_cert)
+            @response.raw_peer_cert_chain = socket.peer_cert_chain
+          end
 
-        @socket = OpenSSL::SSL::SSLSocket.new(sock, ctx).tap do |socket|
-          socket.sync_close = true
-          socket.connect
-          @response.host_name = uri.host
-          @response.raw_peer_cert = OpenSSL::X509::Certificate.new(socket.peer_cert)
-          @response.raw_peer_cert_chain = socket.peer_cert_chain
-        end
+          @socket.sysclose
 
-        @socket.sysclose
+        }
+      rescue Timeout::Error, Errno::ETIMEDOUT
+        @response.errors << SSLCheck::Errors::Connection::Timeout.new({:name => "Timeout Error", :type => :timeout_error, :message => "The connection to #{url} took too long."})
       rescue SocketError
         @response.errors << SSLCheck::Errors::Connection::SocketError.new({:name => "Connection Error", :type => :socket_error, :message => "The connection to #{url} failed."})
       rescue URI::InvalidURIError

data/lib/sslcheck/validators/errors.rb

@@ -4,6 +4,7 @@ module SSLCheck
       class InvalidURI < GenericError; end
       class SSLVerify < GenericError; end
       class SocketError < GenericError; end
+      class Timeout < GenericError; end
     end
 
     module Validation

data/lib/sslcheck/version.rb

@@ -1,3 +1,3 @@
 module SSLCheck
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sslcheck
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Clayton Lengel-Zigich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-06 00:00:00.000000000 Z
+date: 2015-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport