omniauth-shibboleth 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbc1910339ca687b35d3e2120072009e39dca66a
-  data.tar.gz: 60215822a0ac07502b0dcee32545d18c0e2dc160
+  metadata.gz: 522260d787eef76c5a8ff86890b001ecf2f6b524
+  data.tar.gz: e118c60297ee37d49f279a2836f54a94933143b5
 SHA512:
-  metadata.gz: f58cc5c54b07a092f15984b1aa6290d21a7271c4e16933b2d0b6b99639bf8881a1ffe9a03503083be69f8f834bf27c9b843d3c9e52b8bc9a217fe485c2703a3d
-  data.tar.gz: 2b29dcaa1c212ad9b6825b184b1ba766626685d3212daaa1afe7805c9898b6590a7c9df5e62be68bfb874e3e74caa566d651b174e6f9ed124cac0d8a02cd94ed
+  metadata.gz: c143be18e00484f679d4e08c4cd56eeb2c58ea8d5651634a8e35159bb4b9aa03836aa83e906a338d1e458132397b88dc465a9dd07a47fe516e4f828500e5f083
+  data.tar.gz: a136b0b97c1299535f9d06bf96bb27869f96fd35b5d5ab7318b304e3c9b44c11ee3948a5b43b67de13e2926c1adfa625d136fecc179e31a0a10c7876a4f05653

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    omniauth-shibboleth (1.2.0)
+      omniauth (>= 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    hashie (3.4.1)
+    omniauth (1.2.2)
+      hashie (>= 1.2, < 4)
+      rack (~> 1.0)
+    rack (1.6.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-shibboleth!
+  rack-test
+  rake
+  rspec (>= 2.8)
+
+BUNDLED WITH
+   1.10.2

data/README.md

@@ -1,5 +1,8 @@
 # OmniAuth Shibboleth strategy
 
+[![Gem Version](http://img.shields.io/gem/v/omniauth-shibboleth.svg)](http://rubygems.org/gems/omniauth-shibboleth)
+[![Build Status](https://travis-ci.org/toyokazu/omniauth-shibboleth.svg?branch=master)](https://travis-ci.org/toyokazu/omniauth-shibboleth)
+
 OmniAuth Shibboleth strategy is an OmniAuth strategy for authenticating through Shibboleth (SAML). If you do not know OmniAuth, please visit OmniAuth wiki.
 
 https://github.com/intridea/omniauth/wiki
@@ -29,6 +32,11 @@ https://github.com/toyokazu/omniauth-shibboleth/issues
 
 To use OmniAuth Shibboleth strategy as a middleware in your rails application, add the following file to your rails application initializer directory.
 
+    % vi config/initializer/omniauth.rb
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :shibboleth
+    end
+
     % vi config/initializer/omniauth.rb
     Rails.application.config.middleware.use OmniAuth::Builder do
       provider :shibboleth, {

data/lib/omniauth-shibboleth/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Shibboleth
-    VERSION = "1.2.0"
+    VERSION = "1.2.1"
   end
 end

data/lib/omniauth/strategies/shibboleth.rb

@@ -10,6 +10,7 @@ module OmniAuth
       option :info_fields, {}
       option :extra_fields, []
       option :debug, false
+      option :fail_with_empty_uid, false
       option :request_type, :env
 
       def request_phase
@@ -55,6 +56,7 @@ module OmniAuth
           ]
         end
         return fail!(:no_shibboleth_session) unless (request_param(options.shib_session_id_field.to_s) || request_param(options.shib_application_id_field.to_s))
+        return fail!(:empty_uid) if options[:fail_with_empty_uid] && option_handler(options.uid_field).empty?
         super
       end
 

data/spec/omniauth/strategies/shibboleth_spec.rb

@@ -10,7 +10,7 @@ def make_env(path = '/auth/shibboleth', props = {})
   }.merge(props)
 end
 
-def failure_path
+def without_session_failure_path
   if OmniAuth::VERSION >= "1.0" && OmniAuth::VERSION < "1.1"
     "/auth/failure?message=no_shibboleth_session"
   elsif OmniAuth::VERSION >= "1.1"
@@ -18,6 +18,14 @@ def failure_path
   end
 end
 
+def empty_uid_failure_path
+  if OmniAuth::VERSION >= "1.0" && OmniAuth::VERSION < "1.1"
+    "/auth/failure?message=empty_uid"
+  elsif OmniAuth::VERSION >= "1.1"
+    "/auth/failure?message=empty_uid&strategy=shibboleth"
+  end
+end
+
 describe OmniAuth::Strategies::Shibboleth do
   let(:app){ Rack::Builder.new do |b|
     b.use Rack::Session::Cookie, {:secret => "abc123"}
@@ -44,7 +52,7 @@ describe OmniAuth::Strategies::Shibboleth do
 
       it 'is expected to fail to get Shib-Session-ID environment variable' do
         expect(last_response.status).to eq(302)
-        expect(last_response.location).to eq(failure_path)
+        expect(last_response.location).to eq(without_session_failure_path)
       end
     end
 
@@ -68,7 +76,6 @@ describe OmniAuth::Strategies::Shibboleth do
         :shib_application_id_field => 'Shib-Application-ID',
         :uid_field => :uid,
         :name_field => :sn,
-        #:name_field => :displayName,
         :info_fields => {},
         :extra_fields => [:o, :affiliation] } }
       let(:app){ lambda{|env| [404, {}, ['Not Found']]}}
@@ -233,5 +240,48 @@ describe OmniAuth::Strategies::Shibboleth do
         expect(strategy.env['omniauth.auth']['extra']['raw_info']['affiliation']).to eq(@affiliation)
       end
     end
+
+    context 'empty uid with :fail_with_empty_uid = false' do
+      let(:options){ {
+        :request_type => :env,
+        :fail_with_empty_uid => false,
+        :uid_field => :uid,
+        :name_field => :displayName,
+        :info_fields => {} } }
+      let(:app){ lambda{|env| [200, {}, ['OK']]}}
+      let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
+
+      it 'is expected to output null (empty) uid as it is' do
+        @dummy_id = 'abcdefg'
+        @display_name = 'Test User'
+        @uid = ''
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'uid' => @uid, 'displayName' => @display_name)
+        response = strategy.call!(env)
+        expect(strategy.env['omniauth.auth']['uid']).to eq(@uid)
+      end
+    end
+
+    context 'empty uid with :fail_with_empty_uid = true' do
+      let(:options){ {
+        :request_type => :env,
+        :fail_with_empty_uid => true,
+        :shib_session_id_field => 'Shib-Session-ID',
+        :shib_application_id_field => 'Shib-Application-ID',
+        :uid_field => :uid,
+        :name_field => :displayName,
+        :info_fields => {} } }
+      let(:app){ lambda{|env| [200, {}, ['OK']]}}
+      let(:strategy){ OmniAuth::Strategies::Shibboleth.new(app, options) }
+
+      it 'is expected to fail because of the empty uid' do
+        @dummy_id = 'abcdefg'
+        @display_name = 'Test User'
+        @uid = ''
+        env = make_env('/auth/shibboleth/callback', 'Shib-Session-ID' => @dummy_id, 'uid' => @uid, 'displayName' => @display_name)
+        response = strategy.call!(env)
+        expect(response[0]).to eq(302)
+        expect(response[1]["Location"]).to eq(empty_uid_failure_path)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-shibboleth
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Toyokazu Akiyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - lib/omniauth-shibboleth.rb
@@ -102,11 +103,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: OmniAuth Shibboleth strategies for OmniAuth 1.x
 test_files:
 - spec/omniauth/strategies/shibboleth_spec.rb
 - spec/spec_helper.rb
-has_rdoc: