Refactor, Add more tests

Author: pitbulk

lib/Saml2/Auth.php

@@ -20,6 +20,13 @@ class OneLogin_Saml2_Auth
      */
     private $_attributes = array();
 
+    /**
+     * User attributes data with FriendlyName index.
+     *
+     * @var array
+     */
+    private $_attributesWithFriendlyName = array();
+
     /**
      * NameID
      *
@@ -182,6 +189,7 @@ public function processResponse($requestId = null)
 
             if ($response->isValid($requestId)) {
                 $this->_attributes = $response->getAttributes();
+                $this->_attributesWithFriendlyName = $response->getAttributesWithFriendlyName();
                 $this->_nameid = $response->getNameId();
                 $this->_nameidFormat = $response->getNameIdFormat();
                 $this->_nameidNameQualifier = $response->getNameIdNameQualifier();
@@ -325,6 +333,16 @@ public function getAttributes()
         return $this->_attributes;
     }
 
+    /**
+     * Returns the set of SAML attributes indexed by FriendlyName
+     *
+     * @return array  Attributes of the user.
+     */
+    public function getAttributesWithFriendlyName()
+    {
+        return $this->_attributesWithFriendlyName;
+    }
+
     /**
      * Returns the nameID
      *
@@ -413,6 +431,24 @@ public function getAttribute($name)
         return $value;
     }
 
+    /**
+     * Returns the requested SAML attribute indexed by FriendlyName
+     *
+     * @param string $friendlyName The requested attribute of the user.
+     *
+     * @return array|null Requested SAML attribute ($friendlyName).
+     */
+    public function getAttributeWithFriendlyName($friendlyName)
+    {
+        assert('is_string($friendlyName)');
+
+        $value = null;
+        if (isset($this->_attributesWithFriendlyName[$friendlyName])) {
+            return $this->_attributesWithFriendlyName[$friendlyName];
+        }
+        return $value;
+    }
+
     /**
      * Initiates the SSO process.
      *

lib/Saml2/Response.php

@@ -707,46 +707,7 @@ public function getSessionIndex()
      */
     public function getAttributes()
     {
-        $attributes = array();
-
-        /* EncryptedAttributes not supported
-
-        $encriptedAttributes = $this->_queryAssertion('/saml:AttributeStatement/saml:EncryptedAttribute');
-
-        if ($encriptedAttributes->length > 0) {
-            foreach ($encriptedAttributes as $encriptedAttribute) {
-                $key = $this->_settings->getSPkey();
-                $seckey = new XMLSecurityKey(XMLSecurityKey::RSA_1_5, array('type'=>'private'));
-                $seckey->loadKey($key);
-                $attribute = OneLogin_Saml2_Utils::decryptElement($encriptedAttribute->firstChild(), $seckey);
-            }
-        }
-        */
-
-        $entries = $this->_queryAssertion('/saml:AttributeStatement/saml:Attribute');
-
-        /** @var $entry DOMNode */
-        foreach ($entries as $entry) {
-            $attributeName = $entry->attributes->getNamedItem('Name')->nodeValue;
-
-            if (in_array($attributeName, array_keys($attributes))) {
-                throw new OneLogin_Saml2_ValidationError(
-                    "Found an Attribute element with duplicated Name",
-                    OneLogin_Saml2_ValidationError::DUPLICATED_ATTRIBUTE_NAME_FOUND
-                );
-            }
-
-            $attributeValues = array();
-            foreach ($entry->childNodes as $childNode) {
-                $tagName = ($childNode->prefix ? $childNode->prefix.':' : '') . 'AttributeValue';
-                if ($childNode->nodeType == XML_ELEMENT_NODE && $childNode->tagName === $tagName) {
-                    $attributeValues[] = $childNode->nodeValue;
-                }
-            }
-
-            $attributes[$attributeName] = $attributeValues;
-        }
-        return $attributes;
+        return $this->_getAttributesByKeyName('Name');
     }
 
     /**
@@ -756,37 +717,28 @@ public function getAttributes()
      */
     public function getAttributesWithFriendlyName()
     {
-        $attributes = array();
-
-        /* EncryptedAttributes not supported
-
-        $encriptedAttributes = $this->_queryAssertion('/saml:AttributeStatement/saml:EncryptedAttribute');
+        return $this->_getAttributesByKeyName('FriendlyName');
+    }
 
-        if ($encriptedAttributes->length > 0) {
-            foreach ($encriptedAttributes as $encriptedAttribute) {
-                $key = $this->_settings->getSPkey();
-                $seckey = new XMLSecurityKey(XMLSecurityKey::RSA_1_5, array('type'=>'private'));
-                $seckey->loadKey($key);
-                $attribute = OneLogin_Saml2_Utils::decryptElement($encriptedAttribute->firstChild(), $seckey);
-            }
-        }
-        */
+    private function _getAttributesByKeyName($keyName="Name")
+    {
+        $attributes = array();
 
         $entries = $this->_queryAssertion('/saml:AttributeStatement/saml:Attribute');
 
         /** @var $entry DOMNode */
         foreach ($entries as $entry) {
-            $attributeFriendlyNameNode = $entry->attributes->getNamedItem('FriendlyName');
+            $attributeKeyNode = $entry->attributes->getNamedItem($keyName);
 
-            if ($attributeFriendlyNameNode === null) {
+            if ($attributeKeyNode === null) {
                 continue;
             }
 
-            $attributeFriendlyName = $attributeFriendlyNameNode->nodeValue;
+            $attributeKeyName = $attributeKeyNode->nodeValue;
 
-            if (in_array($attributeFriendlyName, array_keys($attributes))) {
+            if (in_array($attributeKeyName, array_keys($attributes))) {
                 throw new OneLogin_Saml2_ValidationError(
-                    "Found an Attribute element with duplicated FriendlyName",
+                    "Found an Attribute element with duplicated ".$keyName,
                     OneLogin_Saml2_ValidationError::DUPLICATED_ATTRIBUTE_NAME_FOUND
                 );
             }
@@ -799,7 +751,7 @@ public function getAttributesWithFriendlyName()
                 }
             }
 
-            $attributes[$attributeFriendlyName] = $attributeValues;
+            $attributes[$attributeKeyName] = $attributeValues;
         }
         return $attributes;
     }