soar_authentication_token 5.0.2 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a48730da938999d584f82f37148a419197fbb13
-  data.tar.gz: 5c298e1d5df764989317a5694fd3aecd0b348fa4
+  metadata.gz: 491fb012d892cd595bc740285e53eceab63a0e40
+  data.tar.gz: c75f083d8147b4cd3d85c883b1a1b135457587ff
 SHA512:
-  metadata.gz: 0a9c0294bc0afef2aaa8cb65615ec8958641f18defe54460edbd87ba130b8069546fb33ba9c36bd2d45e8b5527131d545f25eb21ebb17197830f002655e65321
-  data.tar.gz: a84774d5898107d0d87a1feb7330588413f0283754b6b8a01f5a12955e9ef8a81189243d9181b5561c3ec4818cece9ff9d8ba21867a1ca0321bdd7e97c401aaf
+  metadata.gz: 25bdc621393d29988cb0f84228a611f475871997d80cd61a0b2e35c7c634d07507738acea54213139d5991ff1b6d7fc892d295f20c4f889f92a6c79e61ae5838
+  data.tar.gz: d3397fd56e4436a945ab7abd3195af33beb82708455eb703011ad89acb6e30a9683be8e923eaabe8de219c6f4e413f8c487c11f90dfe741c2b07466b5ab79a6a

data/lib/soar_authentication_token/providers/remote_token_generator.rb

@@ -5,6 +5,7 @@ module SoarAuthenticationToken
   class RemoteTokenGenerator
     def initialize(configuration)
       @configuration = configuration
+      set_configuration_defaults
       validate_configuration
     end
 
@@ -13,12 +14,26 @@ module SoarAuthenticationToken
     end
 
     def generate(authenticated_identifier:, flow_identifier: nil)
-      client = authenticated_client(authenticated_identifier,flow_identifier)
-      validate_and_extract_token_from_response(client.request)
+      attempt = 0
+      begin
+        Timeout::timeout(@configuration['timeout']) do
+          client = authenticated_client(authenticated_identifier,flow_identifier)
+          validate_and_extract_token_from_response(client.request)
+        end
+      rescue Timeout::Error
+        attempt += 1
+        retry if attempt < @configuration['attempts']
+        raise
+      end
     end
 
     private
 
+    def set_configuration_defaults
+      @configuration['timeout'] ||= 3
+      @configuration['attempts'] ||= 2
+    end
+
     def authenticated_client(authenticated_identifier,flow_identifier)
       client = AuthenticatedClient::Client.new
       client.url = @configuration['generator-url']
@@ -38,7 +53,11 @@ module SoarAuthenticationToken
     end
 
     def validate_configuration
-      raise "'generator-url' must be configured" if @configuration['generator-url'].nil?
+      raise "'generator-url' must be configured" unless @configuration['generator-url']
+      raise "'timeout' must be configured" unless @configuration['timeout']
+      raise "'timeout' must be an integer" unless Integer(@configuration['timeout'])
+      raise "'attempts' must be configured" unless @configuration['attempts']
+      raise "'attempts' must be an integer" unless Integer(@configuration['attempts'])
     end
   end
 end

data/lib/soar_authentication_token/providers/remote_token_validator.rb

@@ -4,6 +4,7 @@ module SoarAuthenticationToken
   class RemoteTokenValidator
     def initialize(configuration)
       @configuration = configuration
+      set_configuration_defaults
       validate_configuration
     end
 
@@ -12,12 +13,26 @@ module SoarAuthenticationToken
     end
 
     def validate(authentication_token:,flow_identifier: nil)
-      response = send_request(authentication_token,flow_identifier)
-      validate_and_extract_information_from_response(response)
+      attempt = 0
+      begin
+        Timeout::timeout(@configuration['timeout']) do
+          response = send_request(authentication_token,flow_identifier)
+          validate_and_extract_information_from_response(response)
+        end
+      rescue Timeout::Error
+        attempt += 1
+        retry if attempt < @configuration['attempts']
+        raise
+      end
     end
 
     private
 
+    def set_configuration_defaults
+      @configuration['timeout'] ||= 3
+      @configuration['attempts'] ||= 2
+    end
+
     def send_request(authentication_token,flow_identifier)
       uri = URI.parse(@configuration['validator-url'])
       uri.query = URI.encode_www_form( {'flow_identifier' => flow_identifier} )
@@ -48,6 +63,8 @@ module SoarAuthenticationToken
 
     def validate_configuration
       raise "'validator-url' must be configured in remote mode" unless @configuration['validator-url']
+      raise "'timeout' must be configured" unless @configuration['timeout']
+      raise "'timeout' must be an integer" unless Integer(@configuration['timeout'])
     end
 
     def rejection_result(reason:)

data/lib/soar_authentication_token/rack_middleware.rb

@@ -40,7 +40,7 @@ module SoarAuthenticationToken
     end
 
     def rejection
-      [401, {"Content-Type" => "text/html"}, ["401 - Not authenticated"]]
+      [401, { 'Content-Type' => 'application/json'}, ["401 - Not authenticated"]]
     end
   end
 end

data/lib/soar_authentication_token/version.rb

@@ -1,3 +1,3 @@
 module SoarAuthenticationToken
-  VERSION = '5.0.2'
+  VERSION = '5.0.3'
 end

data/spec/config_rotator_spec.rb

@@ -11,17 +11,21 @@ describe SoarAuthenticationToken::ConfigRotator do
     @private_key_4, @public_key_4 = keypair_generator.generate
 
     @valid_validator_config = {
-      'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
-      'keys' => {
-        'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 },
-        'KEYPAIR_20160107T230201' => { 'public_key' => @public_key_2 },
-        'KEYPAIR_20160107T230301' => { 'public_key' => @public_key_3 }
+      'auth_token_validator' => {
+        'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
+        'keys' => {
+          'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 },
+          'KEYPAIR_20160107T230201' => { 'public_key' => @public_key_2 },
+          'KEYPAIR_20160107T230301' => { 'public_key' => @public_key_3 }
+        }
       }
     }
     @valid_generator_config = {
-      'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
-      'private_key' => @private_key_3,
-      'key_description' => 'original key'
+      'auth_token_generator' => {
+        'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
+        'private_key' => @private_key_3,
+        'key_description' => 'original key'
+      }
     }
   end
 
@@ -34,7 +38,9 @@ describe SoarAuthenticationToken::ConfigRotator do
     context "with key list containing no keys" do
       let!(:validator_configuration) {
         {
-          'keys' => { }
+          'auth_token_validator' => {
+            'keys' => { }
+          }
         }
       }
       it 'the resulting list is kept intact with no keys' do
@@ -42,7 +48,9 @@ describe SoarAuthenticationToken::ConfigRotator do
         subject.send(:trim_public_keys, test_configuration)
         expect(test_configuration).to eq(
                 {
-                  'keys' => { }
+                  'auth_token_validator' => {
+                    'keys' => { }
+                  }
                 })
       end
     end
@@ -50,9 +58,11 @@ describe SoarAuthenticationToken::ConfigRotator do
     context "with key list containing lower than maximum allowed number of keys" do
       let!(:validator_configuration) {
         {
-          'keys' => {
-            'KEYPAIR_20160107T230001' => [],
-            'KEYPAIR_20160107T230101' => []
+          'auth_token_validator' => {
+            'keys' => {
+              'KEYPAIR_20160107T230001' => [],
+              'KEYPAIR_20160107T230101' => []
+            }
           }
         }
       }
@@ -60,9 +70,11 @@ describe SoarAuthenticationToken::ConfigRotator do
         test_configuration = validator_configuration.dup
         subject.send(:trim_public_keys, test_configuration)
         expect(test_configuration).to eq(        {
-                  'keys' => {
-                    'KEYPAIR_20160107T230001' => [],
-                    'KEYPAIR_20160107T230101' => []
+                  'auth_token_validator' => {
+                    'keys' => {
+                      'KEYPAIR_20160107T230001' => [],
+                      'KEYPAIR_20160107T230101' => []
+                    }
                   }
                 })
       end
@@ -71,10 +83,12 @@ describe SoarAuthenticationToken::ConfigRotator do
     context "with key list containing the maximum allowed number of keys" do
       let!(:validator_configuration) {
         {
-          'keys' => {
-            'KEYPAIR_20160107T230001' => [],
-            'KEYPAIR_20160107T230101' => [],
-            'KEYPAIR_20160107T230201' => []
+          'auth_token_validator' => {
+            'keys' => {
+              'KEYPAIR_20160107T230001' => [],
+              'KEYPAIR_20160107T230101' => [],
+              'KEYPAIR_20160107T230201' => []
+            }
           }
         }
       }
@@ -82,9 +96,11 @@ describe SoarAuthenticationToken::ConfigRotator do
         test_configuration = validator_configuration.dup
         subject.send(:trim_public_keys, test_configuration)
         expect(test_configuration).to eq(        {
-                  'keys' => {
-                    'KEYPAIR_20160107T230101' => [],
-                    'KEYPAIR_20160107T230201' => []
+                  'auth_token_validator' => {
+                    'keys' => {
+                      'KEYPAIR_20160107T230101' => [],
+                      'KEYPAIR_20160107T230201' => []
+                    }
                   }
                 })
       end
@@ -93,11 +109,13 @@ describe SoarAuthenticationToken::ConfigRotator do
     context "with key list containing more than the maximum allowed number of keys" do
       let!(:validator_configuration) {
         {
-          'keys' => {
-            'KEYPAIR_20160107T230001' => [],
-            'KEYPAIR_20160107T230401' => [],
-            'KEYPAIR_20160107T230201' => [],
-            'KEYPAIR_20160107T230101' => []
+          'auth_token_validator' => {
+            'keys' => {
+              'KEYPAIR_20160107T230001' => [],
+              'KEYPAIR_20160107T230401' => [],
+              'KEYPAIR_20160107T230201' => [],
+              'KEYPAIR_20160107T230101' => []
+            }
           }
         }
       }
@@ -105,9 +123,11 @@ describe SoarAuthenticationToken::ConfigRotator do
         test_configuration = validator_configuration.dup
         subject.send(:trim_public_keys, test_configuration)
         expect(test_configuration).to eq(        {
-                  'keys' => {
-                    'KEYPAIR_20160107T230201' => [],
-                    'KEYPAIR_20160107T230401' => []
+                'auth_token_validator' => {
+                    'keys' => {
+                      'KEYPAIR_20160107T230201' => [],
+                      'KEYPAIR_20160107T230401' => []
+                    }
                   }
                 })
       end
@@ -126,7 +146,7 @@ describe SoarAuthenticationToken::ConfigRotator do
       let!(:generator_config_file_name) {
         filename = "generator_config.json"
         File.open(filename,"w") do |f|
-          f.write({}.to_json) #Empty hash is an Invalid hash
+          f.write({'auth_token_generator' => {}}.to_json) #Empty hash is an Invalid hash
         end
         filename
       }
@@ -141,7 +161,7 @@ describe SoarAuthenticationToken::ConfigRotator do
       let!(:validator_config_file_name) {
         filename = "validator_config.json"
         File.open(filename,"w") do |f|
-          f.write({}.to_json)  #Empty hash is an invalid hash
+          f.write({'auth_token_validator' => {}}.to_json)  #Empty hash is an invalid hash
         end
         filename
       }
@@ -178,7 +198,7 @@ describe SoarAuthenticationToken::ConfigRotator do
         subject.rotate_json_config_files(generator_file_name: generator_config_file_name,
                                          validator_file_name: validator_config_file_name)
         generator_config = JSON.parse(File.read(generator_config_file_name))
-        expect(generator_config['private_key']).to_not eq(@valid_generator_config['private_key'])
+        expect(generator_config['auth_token_generator']['private_key']).to_not eq(@valid_generator_config['auth_token_generator']['private_key'])
       end
 
       it 'adds the newly generated public key to the validator configuration' do
@@ -186,7 +206,7 @@ describe SoarAuthenticationToken::ConfigRotator do
                                          validator_file_name: validator_config_file_name)
         generator_config = JSON.parse(File.read(generator_config_file_name))
         validator_config = JSON.parse(File.read(validator_config_file_name))
-        expect(validator_config['keys'][generator_config['key_description']]).to_not be nil
+        expect(validator_config['auth_token_validator']['keys'][generator_config['auth_token_generator']['key_description']]).to_not be nil
       end
 
       it 'removes the oldest public key from the validator configuration in keeping with maximum number of keys' do
@@ -194,7 +214,7 @@ describe SoarAuthenticationToken::ConfigRotator do
                                          validator_file_name: validator_config_file_name)
         generator_config = JSON.parse(File.read(generator_config_file_name))
         validator_config = JSON.parse(File.read(validator_config_file_name))
-        expect(validator_config['keys'].size).to be 3
+        expect(validator_config['auth_token_validator']['keys'].size).to be 3
       end
     end
   end
@@ -202,15 +222,19 @@ describe SoarAuthenticationToken::ConfigRotator do
   context "when confirming that configurations are valid" do
     context "given validator (with single public key) configuration that includes generator key" do
       let!(:validator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
-        'keys' => {
-          'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 }
+        'auth_token_validator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
+          'keys' => {
+            'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 }
+          }
         }
       }}
       let!(:generator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
-        'private_key' => @private_key_1,
-        'key_description' => 'original key'
+        'auth_token_generator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
+          'private_key' => @private_key_1,
+          'key_description' => 'original key'
+        }
       }}
       it 'responds that the configuration combination is valid' do
         valid = subject.configurations_match_and_valid?(generator_config: generator_config,
@@ -221,15 +245,19 @@ describe SoarAuthenticationToken::ConfigRotator do
 
     context "given validator (with single public key) configuration that does not include generator key" do
       let!(:validator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
-        'keys' => {
-          'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 }
+        'auth_token_validator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
+          'keys' => {
+            'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 }
+          }
         }
       }}
       let!(:generator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
-        'private_key' => @private_key_2,
-        'key_description' => 'original key'
+        'auth_token_generator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
+          'private_key' => @private_key_2,
+          'key_description' => 'original key'
+        }
       }}
       it 'responds that the configuration combination is not valid' do
         valid = subject.configurations_match_and_valid?(generator_config: generator_config,
@@ -240,17 +268,21 @@ describe SoarAuthenticationToken::ConfigRotator do
 
     context "given validator (with multiple public keys) configuration that include generator key" do
       let!(:validator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
-        'keys' => {
-          'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 },
-          'KEYPAIR_20160107T230201' => { 'public_key' => @public_key_2 },
-          'KEYPAIR_20160107T230301' => { 'public_key' => @public_key_3 },
+        'auth_token_validator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
+          'keys' => {
+            'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 },
+            'KEYPAIR_20160107T230201' => { 'public_key' => @public_key_2 },
+            'KEYPAIR_20160107T230301' => { 'public_key' => @public_key_3 },
+          }
         }
       }}
       let!(:generator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
-        'private_key' => @private_key_2,
-        'key_description' => 'original key'
+        'auth_token_generator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
+          'private_key' => @private_key_2,
+          'key_description' => 'original key'
+        }
       }}
       it 'responds that the configuration combination is valid' do
         valid = subject.configurations_match_and_valid?(generator_config: generator_config,
@@ -261,17 +293,21 @@ describe SoarAuthenticationToken::ConfigRotator do
 
     context "given validator (with multiple public keys) configuration that does not include generator key" do
       let!(:validator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
-        'keys' => {
-          'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 },
-          'KEYPAIR_20160107T230201' => { 'public_key' => @public_key_2 },
-          'KEYPAIR_20160107T230301' => { 'public_key' => @public_key_3 },
+        'auth_token_validator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenValidator',
+          'keys' => {
+            'KEYPAIR_20160107T230101' => { 'public_key' => @public_key_1 },
+            'KEYPAIR_20160107T230201' => { 'public_key' => @public_key_2 },
+            'KEYPAIR_20160107T230301' => { 'public_key' => @public_key_3 },
+          }
         }
       }}
       let!(:generator_config) {{
-        'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
-        'private_key' => @private_key_4,
-        'key_description' => 'original key'
+        'auth_token_generator' => {
+          'provider' => 'SoarAuthenticationToken::JwtTokenGenerator',
+          'private_key' => @private_key_4,
+          'key_description' => 'original key'
+        }
       }}
       it 'responds that the configuration combination is not valid' do
         valid = subject.configurations_match_and_valid?(generator_config: generator_config,

data/spec/rack_middleware_spec.rb

@@ -44,12 +44,13 @@ describe SoarAuthenticationToken::RackMiddleware do
     @test_app = lambda do |env|
       request = Rack::Request.new env
       session = request.session
+      $stderr.puts "In the controller"
       test_app_response_data = {
         'message' => "tested with authenticated user #{session['user']}",
         'user' => session['user'],
         'auth_token_meta' => session['auth_token_meta']
       }
-      [200, {"Content-Type"=>"text/html"}, test_app_response_data ]
+      [200, {"Content-Type" => "application/json"}, test_app_response_data ]
     end
     @iut_configuration = {
       'provider' => 'SoarAuthenticationToken::RemoteTokenValidator',
@@ -77,7 +78,7 @@ describe SoarAuthenticationToken::RackMiddleware do
       it "return with 401" do
         opts = { }
         code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
-        expect([code, env, body]).to eq([401, {"Content-Type" => "text/html"}, ["401 - Not authenticated"]])
+        expect([code, env, body]).to eq([401, {"Content-Type" => "application/json"}, ["401 - Not authenticated"]])
       end
     end
 
@@ -85,7 +86,7 @@ describe SoarAuthenticationToken::RackMiddleware do
       it "return with 401" do
         opts = { 'HTTP_AUTHORIZATION' => @local_invalid_generator.generate(authenticated_identifier: 'a@b.com') }
         code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
-        expect([code, env, body]).to eq([401, {"Content-Type" => "text/html"}, ["401 - Not authenticated"]])
+        expect([code, env, body]).to eq([401, {"Content-Type" => "application/json"}, ["401 - Not authenticated"]])
       end
     end
 
@@ -93,7 +94,7 @@ describe SoarAuthenticationToken::RackMiddleware do
       it "pass requests to the application" do
         opts = { 'HTTP_AUTHORIZATION' => @local_valid_generator.generate(authenticated_identifier: 'a@b.com') }
         code, env, body = @iut.call Rack::MockRequest.env_for('http://service', opts)
-        expect([code, env, body['message']]).to eq([200, {"Content-Type"=>"text/html"}, "tested with authenticated user a@b.com" ])
+        expect([code, env, body['message']]).to eq([200, {"Content-Type"=>"application/json"}, "tested with authenticated user a@b.com" ])
       end
 
       it "populate the 'user' key in the rack session with the authenticated user" do

data/spec/remote_token_validator_spec.rb

@@ -74,5 +74,30 @@ describe SoarAuthenticationToken::RemoteTokenValidator do
         expect(message).to match /Token decode\/verification failure/
       end
     end
+
+    context 'given invalid token validator url that will result in timeouts' do
+      let!(:invalid_validator_configuration) {{
+        'provider' => 'SoarAuthenticationToken::RemoteTokenValidator',
+        'validator-url' => 'http://auth-token-validator.auto-h.net/validate',
+        'generator-client-auth-token' => 'test_ecosystem_token_for_auth_token_aaapi_authenticator_service'
+      }}
+      let!(:iut) { subject.new(invalid_validator_configuration) }
+      let!(:valid_token) {
+        token, token_generator_meta = @remote_generator.generate(authenticated_identifier: @test_identifier)
+        token
+      }
+      it 'raise error after attempt that timeout has occured' do
+        expect{
+          iut.validate(authentication_token: valid_token)
+        }.to raise_error Timeout::Error
+      end
+      it 'by default attempts 2 times with 3 second timeout' do
+        start_time = Time.now
+        expect{
+          iut.validate(authentication_token: valid_token)
+        }.to raise_error Timeout::Error
+        expect(Time.now - start_time).to be_within(1).of 6
+      end
+    end
   end
 end

data/spec/token_generator_spec.rb

@@ -73,4 +73,25 @@ describe SoarAuthenticationToken::TokenGenerator do
       expect(messages).to match(/Valid token/)
     end
   end
+
+  context 'given invalid token generator url that will result in timeouts' do
+    let!(:invalid_generator_configuration) {{
+      'provider' => 'SoarAuthenticationToken::RemoteTokenGenerator',
+      'generator-url' => 'http://auth-token-generator.auto-h.net/generate',
+      'generator-client-auth-token' => 'test_ecosystem_token_for_auth_token_aaapi_authenticator_service'
+    }}
+    let!(:iut) { SoarAuthenticationToken::TokenGenerator.new(invalid_generator_configuration) }
+    it 'raise error after attempt that timeout has occured' do
+      expect{
+        iut.generate(authenticated_identifier: @test_authenticated_identifier, flow_identifier: 'test-flow-id')
+      }.to raise_error Timeout::Error
+    end
+    it 'by default attempts 2 times with 3 second timeout' do
+      start_time = Time.now
+      expect{
+        iut.generate(authenticated_identifier: @test_authenticated_identifier, flow_identifier: 'test-flow-id')
+      }.to raise_error Timeout::Error
+      expect(Time.now - start_time).to be_within(1).of 6
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar_authentication_token
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3
 platform: ruby
 authors:
 - Barney de Villiers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: soar_xt