saml_idp 0.3.2 → 0.4.0

data/README.md

@@ -98,7 +98,7 @@ CERT
   # config.attribute_service_location = "#{base}/saml/attributes"
   # config.single_service_post_location = "#{base}/saml/auth"
 
-  # Principal is passed in when you `encode_response`
+  # Principal (e.g. User) is passed in when you `encode_response`
   #
   # config.name_id.formats # =>
   #   {                         # All 2.0
@@ -118,6 +118,28 @@ CERT
   #     },
   #   }
 
+  # If Principal responds to a method called `asserted_attributes`
+  # the return value of that method will be used in lieu of the
+  # attributes defined here in the global space. This allows for
+  # per-user attribute definitions.
+  #
+  ## EXAMPLE **
+  # class User
+  #   def asserted_attributes
+  #     {
+  #       phone: { getter: :phone },
+  #       email: {
+  #         getter: :email,
+  #         name_format: Saml::XML::Namespaces::Formats::NameId::EMAIL_ADDRESS,
+  #         name_id_format: Saml::XML::Namespaces::Formats::NameId::EMAIL_ADDRESS
+  #       }
+  #     }
+  #   end
+  # end
+  #
+  # If you have a method called `asserted_attributes` in your Principal class,
+  # there is no need to define it here in the config.
+
   # config.attributes # =>
   #   {
   #     <friendly_name> => {                                                  # required (ex "eduPersonAffiliation")

data/lib/saml_idp/assertion_builder.rb

@@ -52,9 +52,9 @@ module SamlIdp
               restriction.Audience audience_uri
             end
           end
-          if !config.attributes.nil? && !config.attributes.empty?
+          if asserted_attributes
             assertion.AttributeStatement do |attr_statement|
-              config.attributes.each do |friendly_name, attrs|
+              asserted_attributes.each do |friendly_name, attrs|
                 attrs = (attrs || {}).with_indifferent_access
                 attr_statement.Attribute Name: attrs[:name] || friendly_name,
                   NameFormat: attrs[:name_format] || Saml::XML::Namespaces::Formats::Attr::URI,
@@ -85,6 +85,15 @@ module SamlIdp
       encryptor.encrypt(raw_xml)
     end
 
+    def asserted_attributes
+      if principal.respond_to?(:asserted_attributes)
+        principal.send(:asserted_attributes)
+      elsif !config.attributes.nil? && !config.attributes.empty?
+        config.attributes
+      end
+    end
+    private :asserted_attributes
+
     def get_values_for(friendly_name, getter)
       result = nil
       if getter.present?

data/lib/saml_idp/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module SamlIdp
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/saml_idp.gemspec

@@ -50,7 +50,7 @@ section of the README.
   s.add_development_dependency "rake"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "rspec", "~> 2.5"
-  s.add_development_dependency "ruby-saml", "~> 1.2"
+  s.add_development_dependency "ruby-saml", "~> 1.3"
   s.add_development_dependency("rails", "~> 3.2")
   s.add_development_dependency("capybara")
   s.add_development_dependency("timecop")

data/spec/lib/saml_idp/assertion_builder_spec.rb

@@ -55,6 +55,27 @@ module SamlIdp
       end
     end
 
+    describe "with principal.asserted_attributes" do
+      it "delegates attributes to principal" do
+        Principal = Struct.new(:email, :asserted_attributes)
+        principal = Principal.new('foo@example.com', { emailAddress: { getter: :email } })
+        builder = described_class.new(
+          reference_id,
+          issuer_uri,
+          principal,
+          audience_uri,
+          saml_request_id,
+          saml_acs_url,
+          algorithm,
+          authn_context_classref,
+          expiry
+        )
+        Timecop.travel(Time.zone.local(2010, 6, 1, 13, 0, 0)) do
+          builder.raw.should == "<Assertion xmlns=\"urn:oasis:names:tc:SAML:2.0:assertion\" ID=\"_abc\" IssueInstant=\"2010-06-01T13:00:00Z\" Version=\"2.0\"><Issuer>http://sportngin.com</Issuer><Subject><NameID Format=\"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress\">foo@example.com</NameID><SubjectConfirmation Method=\"urn:oasis:names:tc:SAML:2.0:cm:bearer\"><SubjectConfirmationData InResponseTo=\"123\" NotOnOrAfter=\"2010-06-01T13:03:00Z\" Recipient=\"http://saml.acs.url\"></SubjectConfirmationData></SubjectConfirmation></Subject><Conditions NotBefore=\"2010-06-01T12:59:55Z\" NotOnOrAfter=\"2010-06-01T16:00:00Z\"><AudienceRestriction><Audience>http://example.com</Audience></AudienceRestriction></Conditions><AttributeStatement><Attribute Name=\"emailAddress\" NameFormat=\"urn:oasis:names:tc:SAML:2.0:attrname-format:uri\" FriendlyName=\"emailAddress\"><AttributeValue>foo@example.com</AttributeValue></Attribute></AttributeStatement><AuthnStatement AuthnInstant=\"2010-06-01T13:00:00Z\" SessionIndex=\"_abc\"><AuthnContext><AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:Password</AuthnContextClassRef></AuthnContext></AuthnStatement></Assertion>"
+        end
+      end
+    end
+
     it "builds encrypted XML" do
       builder = described_class.new(
         reference_id,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saml_idp
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -154,7 +154,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -393,7 +393,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2339269672469207321
+      hash: 3959281244219564156
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -402,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2339269672469207321
+      hash: 3959281244219564156
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23