omniauth-saml 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bcfa19e2be2f6691b84c032354fed50f9638777
-  data.tar.gz: 1074172e663efe15a0fad598211de088f1fc3f10
+  metadata.gz: 2974eb31e16837cace7a25f6b94f4fc6b0e35fb9
+  data.tar.gz: db9560dbfc1cfe42fe9f01ed03aad459aa11e528
 SHA512:
-  metadata.gz: b53e494e84dd5e2640026c347962824e091773f978dd1dee0d09596a269988a142d1afdd17627581a46bd918cc4921cee526ad871740cc9cfc1a2449ce9ea130
-  data.tar.gz: 496c67b355db754816a43f120d49091fbd0123c06bb5c877043087c0ce4ced5362a8bca9e3f8df366ec83e4fda7242dff20fffd728509a1a4dbfa5719f4d0ffc
+  metadata.gz: 80afb434850d5cdf2f26d3cf3612d5d5cd7b45a494faae1f721f9d127466da32db08dbcbaf2d235d4f18041728f469115e8403e60e95993828538f3363f82030
+  data.tar.gz: 1605a7ff623a28f00e69a649f0882bde4fb43efcc118a8df13e7ec3f808af32105ce49bd6adf43ab4c8bfd2cf8e7235ddd0c179172451b9e5a51a703ea1e28f5

data/README.md

@@ -94,8 +94,30 @@ The service provider metadata used to ease configuration of the SAML SP in the I
   If not specified, the IdP is free to choose the name identifier format used
   in the response. Optional.
 
+* `:request_attributes` - Used to build the metadata file to inform the IdP to send certain attributes
+  along with the SAMLResponse messages. Defaults to requesting `name`, `first_name`, `last_name` and `email`
+  attributes. See the `OneLogin::RubySaml::AttributeService` class in the [Ruby SAML gem](https://github.com/onelogin/ruby-saml) for the available options for each attribute. Set to `{}` to disable this from metadata.
+
+* `:attribute_service_name` - Name for the attribute service. Defaults to `Required attributes`.
+
 * See the `OneLogin::RubySaml::Settings` class in the [Ruby SAML gem](https://github.com/onelogin/ruby-saml) for additional supported options.
 
+## Devise Integration
+
+Straightforward integration with [Devise](https://github.com/plataformatec/devise), the widely-used authentication solution for Rails.
+
+In `config/initializers/devise.rb`:
+
+```ruby
+Devise.setup do |config|
+  config.omniauth :saml,
+    idp_cert_fingerprint: 'fingerprint',
+    idp_sso_target_url: 'target_url'
+end
+```
+
+Then follow Devise's general [OmniAuth tutorial](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview), replacing references to `facebook` with `saml`.
+
 ## Authors
 
 Authored by [Rajiv Aaron Manglani](http://www.rajivmanglani.com/), Raecoo Cao, Todd W Saxton, Ryan Wilcox, Steven Anderson, Nikos Dimitrakopoulos, Rudolf Vriend and [Bruno Pedro](http://brunopedro.com/).

data/lib/omniauth-saml/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module SAML
-    VERSION = '1.4.0'
+    VERSION = '1.4.1'
   end
 end

data/lib/omniauth/strategies/saml.rb

@@ -8,6 +8,13 @@ module OmniAuth
 
       option :name_identifier_format, nil
       option :idp_sso_target_url_runtime_params, {}
+      option :request_attributes, [
+        { name: 'email', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Email address' },
+        { name: 'name', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Full name' },
+        { name: 'first_name', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Given name' },
+        { name: 'last_name', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Family name' }
+      ]
+      option :attribute_service_name, 'Required attributes'
 
       def request_phase
         options[:assertion_consumer_service_url] ||= callback_url
@@ -81,6 +88,12 @@ module OmniAuth
 
           response = OneLogin::RubySaml::Metadata.new
           settings = OneLogin::RubySaml::Settings.new(options)
+          if options.request_attributes.length > 0
+            settings.attribute_consuming_service.service_name options.attribute_service_name
+            options.request_attributes.each do |attribute|
+              settings.attribute_consuming_service.add_attribute attribute
+            end
+          end
           Rack::Response.new(response.generate(settings), 200, { "Content-Type" => "application/xml" }).finish
         else
           call_app!

data/spec/omniauth/strategies/saml_spec.rb

@@ -20,7 +20,14 @@ describe OmniAuth::Strategies::SAML, :type => :strategy do
       :idp_sso_target_url                 => "https://idp.sso.target_url/signon/29490",
       :idp_cert_fingerprint               => "C1:59:74:2B:E8:0C:6C:A9:41:0F:6E:83:F6:D1:52:25:45:58:89:FB",
       :idp_sso_target_url_runtime_params  => {:original_param_key => :mapped_param_key},
-      :name_identifier_format             => "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"
+      :name_identifier_format             => "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
+      :request_attributes                 => [
+        { name: 'email', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Email address' },
+        { name: 'name', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Full name' },
+        { name: 'first_name', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Given name' },
+        { name: 'last_name', name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic', friendly_name: 'Family name' }
+      ],
+      :attribute_service_name             => 'Required attributes'
     }
   end
   let(:strategy) { [OmniAuth::Strategies::SAML, saml_options] }
@@ -157,5 +164,12 @@ describe OmniAuth::Strategies::SAML, :type => :strategy do
       last_response.status.should == 200
       last_response.header["Content-Type"].should == "application/xml"
     end
+
+    it 'should configure attributes consuming service' do
+      last_response.body.should match /AttributeConsumingService/
+      last_response.body.should match /first_name/
+      last_response.body.should match /last_name/
+      last_response.body.should match /Required attributes/
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-saml
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Raecoo Cao
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -120,10 +120,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A generic SAML strategy for OmniAuth.
 test_files:
 - spec/omniauth/strategies/saml_spec.rb
 - spec/spec_helper.rb
+has_rdoc: