Support for logout options

Author: Ana Martinez

lib/samlr/tools/logout_request_builder.rb

@@ -5,23 +5,39 @@ module Tools
     # Use this for building the SAML logout request XML
     module LogoutRequestBuilder
       def self.build(options = {})
-        name_id_format  = options[:name_id_format] || EMAIL_FORMAT
-
         # Mandatory
         name_id = options.fetch(:name_id)
         issuer  = options.fetch(:issuer)
 
         builder = Nokogiri::XML::Builder.new do |xml|
           xml.LogoutRequest("xmlns:samlp" => NS_MAP["samlp"], "xmlns:saml" => NS_MAP["saml"], "ID" => Samlr::Tools.uuid, "IssueInstant" => Samlr::Tools::Timestamp.stamp, "Version" => "2.0") do
             xml.doc.root.namespace = xml.doc.root.namespace_definitions.find { |ns| ns.prefix == "samlp" }
-
             xml["saml"].Issuer(issuer)
-            xml["saml"].NameID(name_id, "Format" => name_id_format)
+            xml["saml"].NameID(name_id, logout_options(options))
           end
         end
 
         builder.to_xml(COMPACT)
       end
+
+      def self.logout_options(options)
+        name_id_options  = options[:name_id_options] || {}
+        options = { "Format" => format_option(options)}
+        options.merge!("NameQualifier" => name_id_options[:name_qualifier]) if name_id_options[:name_qualifier]
+        options.merge!("SPNameQualifier" => name_id_options[:spname_qualifier]) if name_id_options[:spname_qualifier]
+        options
+      end
+
+      def self.format_option(options)
+        if options[:name_id_format]
+          warn "[DEPRECATION] options[:name_id_format] is deprecated. Please use options[:name_id_options][:format] instead"
+          options[:name_id_format]
+        elsif options[:name_id_options] && options[:name_id_options][:format]
+          options[:name_id_options][:format]
+        else
+          EMAIL_FORMAT
+        end
+      end
     end
   end
 end

test/unit/test_logout_request.rb

@@ -1,11 +1,15 @@
 require File.expand_path("test/test_helper")
 
 describe Samlr::LogoutRequest do
-  before do
-    @request = Samlr::LogoutRequest.new(
+  let(:options) {
+    {
       :issuer => "https://sp.example.com/saml2",
       :name_id => "[email protected]"
-    )
+    }
+  }
+
+  before do
+    @request = Samlr::LogoutRequest.new(options)
   end
 
   describe "#body" do
@@ -36,4 +40,34 @@
       end
     end
   end
+
+  describe "with optional params" do
+    it "understands name_id_format" do
+      options.merge!(:name_id_format => "some format")
+      request = Samlr::LogoutRequest.new(options)
+
+      assert_match /<saml:NameID Format="some format">/, request.body
+    end
+
+    it "understands [:name_id_options][:format]" do
+      options.merge!(:name_id_options => {:format => "some format"})
+      request = Samlr::LogoutRequest.new(options)
+
+      assert_match /<saml:NameID Format="some format">/, request.body
+    end
+
+    it "understands NameQualifier" do
+      options.merge!(:name_id_options => {:name_qualifier => "Some name qualifier"})
+      request = Samlr::LogoutRequest.new(options)
+
+      assert_match /NameQualifier="Some name qualifier"/, request.body
+    end
+
+    it "understands SPNameQualifier" do
+      options.merge!(:name_id_options => {:spname_qualifier => "Some SPName qualifier"})
+      request = Samlr::LogoutRequest.new(options)
+
+      assert_match /SPNameQualifier="Some SPName qualifier"/, request.body
+    end
+  end
 end