From 1fa16596ca04283f6d8a900c77dfa4fa95e9acdf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jaime=20Pe=CC=81rez?= <jaime.perez@uninett.no>
Date: Wed, 6 Jul 2016 11:37:53 +0200
Subject: [PATCH] bugfix: Make sure the PDO and Serialize metadata storage
handlers return metadata containing the 'entityid' key.
While investigating issue #393, we noticed that these two handlers don't enforce the entity ID of each entity to be set in the 'entityid' key of the metadata array (the Flatfile and XML handlers to enforce this). Since this is the way we propagate the entity ID (code using metadata won't necessarily have access to the key of the metadata array containing the entity ID, or such a thing might not even exist), we need to make sure the entity ID is set inside the array. Otherwise, if the metadata for an entity does not contain it directly, the 'ExpectedIssuer' would be set to null, an error recorded, and authentication would fail as the entity ID of the IdP issuing an assertion would not match.
---
lib/SimpleSAML/Metadata/MetaDataStorageHandlerPdo.php | 10 +++++++++-
.../Metadata/MetaDataStorageHandlerSerialize.php | 4 ++++
2 files changed, 13 insertions(+), 1 deletion(-)
diff --git a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerPdo.php b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerPdo.php
index e8981169d..09c38b3a5 100644
--- a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerPdo.php
+++ b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerPdo.php
@@ -76,6 +76,7 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerPdo extends SimpleSAML_Metadata_
* given file.
*
* @throws Exception If a database error occurs.
+ * @throws SimpleSAML_Error_Exception If the metadata can be retrieved from the database, but cannot be decoded.
*/
private function load($set)
{
@@ -92,7 +93,14 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerPdo extends SimpleSAML_Metadata_
$metadata = array();
while ($d = $stmt->fetch()) {
- $metadata[$d['entity_id']] = json_decode($d['entity_data'], true);
+ $data = json_decode($d['entity_data'], true);
+ if ($data === null) {
+ throw new SimpleSAML_Error_Exception("Cannot decode metadata for entity '${d['entity_id']}'");
+ }
+ if (!array_key_exists('entityid', $data)) {
+ $data['entityid'] = $d['entity_id'];
+ }
+ $metadata[$d['entity_id']] = $data;
}
return $metadata;
diff --git a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSerialize.php b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSerialize.php
index a34f19491..c487d31b7 100644
--- a/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSerialize.php
+++ b/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSerialize.php
@@ -195,6 +195,10 @@ class SimpleSAML_Metadata_MetaDataStorageHandlerSerialize extends SimpleSAML_Met
return null;
}
+ if (!array_key_exists('entityid', $data)) {
+ $data['entityid'] = $entityId;
+ }
+
return $data;
}
--
GitLab