Fix serialization for the NameID element

simplesamlphp · Jan 25, 2024 · e91bf4c · e91bf4c
1 parent 49e4264
commit e91bf4c
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 1 deletion.
diff --git a/src/SAML2/XML/saml/NameIDType.php b/src/SAML2/XML/saml/NameIDType.php
@@ -13,8 +13,9 @@
 use DOMElement;
 use SAML2\Constants;
 use SAML2\DOMDocumentFactory;
+use Serializable;
 
-abstract class NameIDType
+abstract class NameIDType implements Serializable
 {
     use IDNameQualifiersTrait;
 
@@ -197,6 +198,62 @@ public function toXML(DOMElement $parent = null) : DOMElement
     }
 
 
+    /**
+     * Serialize this NameID.
+     *
+     * @return string The NameID serialized.
+     */
+    public function serialize() : string
+    {
+        return serialize([
+            'NameQualifier' => $this->NameQualifier,
+            'SPNameQualifier' => $this->SPNameQualifier,
+            'nodeName' => $this->nodeName,
+            'Format' => $this->Format,
+            'SPProvidedID' => $this->SPProvidedID,
+            'value' => $this->value
+        ]);
+    }
+
+
+    /**
+     * Un-serialize this NameID.
+     *
+     * @param string $serialized The serialized NameID.
+     * @return void
+     *
+     * Type hint not possible due to upstream method signature
+     */
+    public function unserialize($serialized) : void
+    {
+        $unserialized = unserialize($serialized);
+        foreach ($unserialized as $k => $v) {
+            $this->$k = $v;
+        }
+    }
+
+
+    public function __serialize(): array
+    {
+        return [
+            'NameQualifier' => $this->getNameQualifier(),
+            'SPNameQualifier' => $this->getSPNameQualifier(),
+            'nodeName' => $this->nodeName,
+            'Format' => $this->Format,
+            'SPProvidedID' => $this->SPProvidedID,
+            'value' => $this->value
+        ];
+    }
+
+
+    public function __unserialize($serialized): void
+    {
+        foreach ($serialized as $k => $v) {
+            $this->$k = $v;
+        }
+    }
+
+
     /**
      * Get a string representation of this BaseIDType object.
      *

diff --git a/tests/SAML2/XML/saml/NameIDTest.php b/tests/SAML2/XML/saml/NameIDTest.php
@@ -77,4 +77,23 @@ public function testToString() : void
 
         $this->assertXmlStringEqualsXmlString($output, $nameId->__toString());
     }
+
+
+
+    /**
+     * Serialize a NameID and unserialize that again.
+     * @return void
+     */
+    public function testSerialize() : void
+    {
+        $nid1 = new NameID();
+        $nid1->setValue('aap:noot:mies');
+        $ser = $nid1->serialize();
+
+        $nid2 = new NameID();
+        $nid2->setValue('Wim');
+        $nid2->unserialize($ser);
+
+        $this->assertEquals($nid1, $nid2);
+    }
 }