-
Notifications
You must be signed in to change notification settings - Fork 678
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cherry pick pr/2018 which is an update of pull/1984 against 2.3
#2018 A new MetaDataStorageHandlerDirectory class to load metadata from subdirectories
- Loading branch information
Showing
4 changed files
with
208 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
180 changes: 180 additions & 0 deletions
180
src/SimpleSAML/Metadata/MetaDataStorageHandlerDirectory.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,180 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
namespace SimpleSAML\Metadata; | ||
|
||
use Exception; | ||
use SimpleSAML\Assert\Assert; | ||
use SimpleSAML\Configuration; | ||
use SimpleSAML\Logger; | ||
|
||
use function array_key_exists; | ||
use function is_array; | ||
|
||
/** | ||
* A directory that contains metadata files. | ||
* Instantiation of session handler objects should be done through | ||
* the class method getMetadataHandler(). | ||
* | ||
* @package SimpleSAMLphp | ||
* This was created based on the MetaDataStorageHandlerFlatFile.php source in February 2024. | ||
*/ | ||
|
||
class MetaDataStorageHandlerDirectory extends MetaDataStorageSource | ||
{ | ||
/** | ||
* This is the directory we will load metadata files from. The path will always end | ||
* with a '/'. | ||
* | ||
* @var string | ||
*/ | ||
private string $directory = '/'; | ||
|
||
|
||
/** | ||
* This is an associative array which stores the different metadata sets we have loaded. | ||
* | ||
* @var array | ||
*/ | ||
private array $cachedMetadata = []; | ||
|
||
|
||
/** | ||
* This constructor initializes the flatfile metadata storage handler with the | ||
* specified configuration. The configuration is an associative array with the following | ||
* possible elements: | ||
* - 'directory': The directory we should load metadata from. The default directory is | ||
* set in the 'metadatadir' configuration option in 'config.php'. | ||
* | ||
* @param array $config An associative array with the configuration for this handler. | ||
*/ | ||
protected function __construct(Configuration $globalConfig, array $config) | ||
{ | ||
parent::__construct(); | ||
|
||
// get the configuration | ||
$globalConfig = Configuration::getInstance(); | ||
|
||
// find the path to the directory we should search for metadata in | ||
if (array_key_exists('directory', $config)) { | ||
$this->directory = $config['directory'] ?: 'metadata/'; | ||
} else { | ||
$this->directory = $globalConfig->getOptionalString('metadatadir', 'metadata/'); | ||
} | ||
|
||
/* Resolve this directory relative to the SimpleSAMLphp directory (unless it is | ||
* an absolute path). | ||
*/ | ||
|
||
/** @var string $base */ | ||
$base = $globalConfig->resolvePath($this->directory); | ||
$this->directory = $base . '/'; | ||
} | ||
|
||
|
||
/** | ||
* This function loads the given set of metadata files in the metadata directory. | ||
* This function returns null if it is unable to locate the given set in the metadata directory. | ||
* | ||
* @param string $set The set of metadata we are loading. | ||
* | ||
* @return array|null An associative array with the metadata, | ||
* or null if we are unable to load metadata from the given file. | ||
* @throws \Exception If the metadata set cannot be loaded. | ||
*/ | ||
private function load(string $set): ?array | ||
{ | ||
$metadatasetdir = $this->directory . $set . '.d'; | ||
|
||
if (!$this->fileSystem->exists($metadatasetdir)) { | ||
return null; | ||
} | ||
|
||
/** @psalm-var mixed $metadata We cannot be sure what the include below will do with this var */ | ||
$metadata = []; | ||
|
||
$dh = @opendir($metadatasetdir); | ||
if ($dh === false) { | ||
Logger::warning( | ||
'Directory metadata handler: Unable to open directory: ' . var_export($metadatasetdir, true) | ||
); | ||
return $metadata; | ||
} | ||
|
||
while (($entry = readdir($dh)) !== false) { | ||
if ($entry[0] === '.') { | ||
// skip '..', '.' and hidden files | ||
continue; | ||
} | ||
|
||
$path = $metadatasetdir . DIRECTORY_SEPARATOR . $entry; | ||
if (is_dir($path)) { | ||
Logger::warning( | ||
'Directory metadata handler: Metadata directory contained a directory where only files should ' . | ||
'exist: ' . var_export($path, true) | ||
); | ||
continue; | ||
} | ||
|
||
if (str_ends_with($path, '.php') || str_ends_with($path, '.xml')) { | ||
$type = 'flatfile'; | ||
if (str_ends_with($path, '.xml')) { | ||
$type = 'xml'; | ||
} | ||
Logger::info("loading set $set metadata file at $path"); | ||
|
||
$config = [ 'type' => $type, 'file' => $path ]; | ||
$source = MetaDataStorageSource::getSource($config); | ||
$md = $source->getMetadataSet($set); | ||
$metadata = array_merge($metadata, $md); | ||
} | ||
} | ||
|
||
|
||
|
||
|
||
if (!is_array($metadata)) { | ||
throw new Exception('Could not load metadata set [' . $set . '] from file: ' . $metadatasetfile); | ||
} | ||
return $metadata; | ||
} | ||
|
||
|
||
/** | ||
* This function retrieves the given set of metadata. It will return an empty array if it is | ||
* unable to locate it. | ||
* | ||
* @param string $set The set of metadata we are retrieving. | ||
* | ||
* @return array An associative array with the metadata. Each element in the array is an entity, and the | ||
* key is the entity id. | ||
*/ | ||
public function getMetadataSet(string $set): array | ||
{ | ||
if (array_key_exists($set, $this->cachedMetadata)) { | ||
return $this->cachedMetadata[$set]; | ||
} | ||
|
||
$metadataSet = $this->load($set); | ||
if ($metadataSet === null) { | ||
$metadataSet = []; | ||
} | ||
|
||
// add the entity id of an entry to each entry in the metadata | ||
foreach ($metadataSet as $entityId => &$entry) { | ||
$entry['entityid'] = $entityId; | ||
// check we're not seeing the entityID from the metadata-template | ||
if ($set === 'saml20-idp-hosted') { | ||
Assert::notEq( | ||
$entityId, | ||
'urn:x-simplesamlphp:example-idp', | ||
'Please set a valid and unique entityID', | ||
); | ||
} | ||
} | ||
|
||
$this->cachedMetadata[$set] = $metadataSet; | ||
return $metadataSet; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters