Fix MDQ cache file bugs (#2200)

m0n1ker · anelson-unl · web-flow · commit 30662b322fac · 2024-08-13T09:48:42.000+10:00
* Ensure MDQ JSON cache is decoded properly

* Ensure MDQ JSON cache is overwritten not appended to

* Update MDQ cache file extension

---------

Co-authored-by: Alan Nelson &lt;alan.nelson@nebraska.edu&gt;
diff --git a/src/SimpleSAML/Metadata/Sources/MDQ.php b/src/SimpleSAML/Metadata/Sources/MDQ.php
@@ -130,7 +130,7 @@ private function getCacheFilename(string $set, string $entityId): string
         }
 
         $cachekey = sha1($entityId);
-        return $this->cacheDir . '/' . $set . '-' . $cachekey . '.cached.xml';
+        return $this->cacheDir . '/' . $set . '-' . $cachekey . '.cached.json';
     }
 
 
@@ -183,7 +183,8 @@ private function getFromCache(string $set, string $entityId): ?array
             ));
         }
 
-        $data = json_decode($rawData);
+        // ensure json is decoded as an associative array not an object
+        $data = json_decode($rawData, true);
         if ($data === false) {
             throw new Exception(
                 sprintf('%s: error unserializing cached data from file "%s".', __CLASS__, strval($file)),
@@ -217,8 +218,8 @@ private function writeToCache(string $set, string $entityId, array $data): void
 
         Logger::debug(sprintf('%s: Writing cache [%s] => [%s]', __CLASS__, $entityId, $cacheFileName));
 
-        /** @psalm-suppress TooManyArguments */
-        $this->fileSystem->appendToFile($cacheFileName, json_encode($data), true);
+        // using dumpFile instead of appendToFile here to replace any existing cache data
+        $this->fileSystem->dumpFile($cacheFileName, json_encode($data));
     }
 
 

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ private function getCacheFilename(string $set, string $entityId): string`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`$cachekey = sha1($entityId);`
`133`		`- return $this->cacheDir . '/' . $set . '-' . $cachekey . '.cached.xml';`
	`133`	`+ return $this->cacheDir . '/' . $set . '-' . $cachekey . '.cached.json';`
`134`	`134`	`}`
`135`	`135`
`136`	`136`
`@@ -183,7 +183,8 @@ private function getFromCache(string $set, string $entityId): ?array`
`183`	`183`	`));`
`184`	`184`	`}`
`185`	`185`
`186`		`- $data = json_decode($rawData);`
	`186`	`+ // ensure json is decoded as an associative array not an object`
	`187`	`+ $data = json_decode($rawData, true);`
`187`	`188`	`if ($data === false) {`
`188`	`189`	`throw new Exception(`
`189`	`190`	`sprintf('%s: error unserializing cached data from file "%s".', __CLASS__, strval($file)),`
`@@ -217,8 +218,8 @@ private function writeToCache(string $set, string $entityId, array $data): void`
`217`	`218`
`218`	`219`	`Logger::debug(sprintf('%s: Writing cache [%s] => [%s]', __CLASS__, $entityId, $cacheFileName));`
`219`	`220`
`220`		`- /** @psalm-suppress TooManyArguments */`
`221`		`- $this->fileSystem->appendToFile($cacheFileName, json_encode($data), true);`
	`221`	`+ // using dumpFile instead of appendToFile here to replace any existing cache data`
	`222`	`+ $this->fileSystem->dumpFile($cacheFileName, json_encode($data));`
`222`	`223`	`}`
`223`	`224`
`224`	`225`