SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile Class Reference

Inheritance diagram for SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile:

Collaboration diagram for SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile:

Public Member Functions
	getMetadataSet ($set)
	This function retrieves the given set of metadata. More...
Public Member Functions inherited from SimpleSAML_Metadata_MetaDataStorageSource
	getMetadataSet ($set)
	This function attempts to generate an associative array with metadata for all entities in the given set. More...
	getEntityIdFromHostPath ($hostPath, $set, $type='entityid')
	This function resolves an host/path combination to an entity id. More...
	getPreferredEntityIdFromCIDRhint ($set, $ip, $type='entityid')
	This function will go through all the metadata, and check the hint.cidr parameter, which defines a network space (ip range) for each remote entry. More...
	getMetaData ($index, $set)
	This function retrieves metadata for the given entity id in the given set of metadata. More...

Protected Member Functions
	__construct ($config)
	This constructor initializes the flatfile metadata storage handler with the specified configuration. More...

Private Member Functions
	load ($set)
	This function loads the given set of metadata from a file our metadata directory. More...
	generateDynamicHostedEntityID ($set)

Private Attributes
	$directory
	$cachedMetadata = array()

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Metadata_MetaDataStorageSource
static	parseSources ($sourcesConfig)
	Parse array with metadata sources. More...
static	getSource ($sourceConfig)
	This function creates a metadata source based on the given configuration. More...

Detailed Description

Definition at line 12 of file MetaDataStorageHandlerFlatFile.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile::__construct (   $config )

protected

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'.

Parameters

array

$config

An associative array with the configuration for this handler.

Definition at line 41 of file MetaDataStorageHandlerFlatFile.php.

References $config, $globalConfig, and SimpleSAML_Configuration\getInstance().

    {
        assert('is_array($config)');

        // get the configuration
        $globalConfig = SimpleSAML_Configuration::getInstance();

        // find the path to the directory we should search for metadata in
        if (array_key_exists('directory', $config)) {
            $this->directory = $config['directory'];
        } else {
            $this->directory = $globalConfig->getString('metadatadir', 'metadata/');
        }

        /* Resolve this directory relative to the SimpleSAMLphp directory (unless it is
         * an absolute path).
         */
        $this->directory = $globalConfig->resolvePath($this->directory).'/';
    }

Here is the call graph for this function:

Member Function Documentation

generateDynamicHostedEntityID()

SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile::generateDynamicHostedEntityID (   $set )

private

Definition at line 127 of file MetaDataStorageHandlerFlatFile.php.

References $baseurl, and SimpleSAML\Utils\HTTP\getBaseURL().

Referenced by getMetadataSet().

    {
        // get the configuration
        $baseurl = \SimpleSAML\Utils\HTTP::getBaseURL();

        if ($set === 'saml20-idp-hosted') {
            return $baseurl.'saml2/idp/metadata.php';
        } elseif ($set === 'shib13-idp-hosted') {
            return $baseurl.'shib13/idp/metadata.php';
        } elseif ($set === 'wsfed-sp-hosted') {
            return 'urn:federation:'.\SimpleSAML\Utils\HTTP::getSelfHost();
        } elseif ($set === 'adfs-idp-hosted') {
            return 'urn:federation:'.\SimpleSAML\Utils\HTTP::getSelfHost().':idp';
        } else {
            throw new Exception('Can not generate dynamic EntityID for metadata of this type: ['.$set.']');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetadataSet()

SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile::getMetadataSet

(

$set

)

This function retrieves the given set of metadata.

It will return an empty array if it is unable to locate it.

Parameters

string

$set

The set of metadata we are retrieving.

Returns

array An associative array with the metadata. Each element in the array is an entity, and the key is the entity id.

Definition at line 101 of file MetaDataStorageHandlerFlatFile.php.

References $entityId, array, generateDynamicHostedEntityID(), and load().

    {
        if (array_key_exists($set, $this->cachedMetadata)) {
            return $this->cachedMetadata[$set];
        }

        $metadataSet = $this->load($set);
        if ($metadataSet === null) {
            $metadataSet = array();
        }

        // add the entity id of an entry to each entry in the metadata
        foreach ($metadataSet as $entityId => &$entry) {
            if (preg_match('/__DYNAMIC(:[0-9]+)?__/', $entityId)) {
                $entry['entityid'] = $this->generateDynamicHostedEntityID($set);
            } else {
                $entry['entityid'] = $entityId;
            }
        }

        $this->cachedMetadata[$set] = $metadataSet;

        return $metadataSet;
    }

Here is the call graph for this function:

load()

SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile::load (   $set )

private

This function loads the given set of metadata from a file our metadata directory.

This function returns null if it is unable to locate the given set in the metadata directory.

Parameters

string

$set

The set of metadata we are loading.

Returns

array An associative array with the metadata, or null if we are unable to load metadata from the given file.

Exceptions

Exception

If the metadata set cannot be loaded.

Definition at line 72 of file MetaDataStorageHandlerFlatFile.php.

References $metadata, and array.

Referenced by getMetadataSet().

    {
        $metadatasetfile = $this->directory.$set.'.php';

        if (!file_exists($metadatasetfile)) {
            return null;
        }

        $metadata = array();

        include($metadatasetfile);

        if (!is_array($metadata)) {
            throw new Exception('Could not load metadata set ['.$set.'] from file: '.$metadatasetfile);
        }

        return $metadata;
    }

Here is the caller graph for this function:

Field Documentation

$cachedMetadata

SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile::$cachedMetadata = array()

private

Definition at line 29 of file MetaDataStorageHandlerFlatFile.php.

$directory

SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile::$directory

private

Definition at line 21 of file MetaDataStorageHandlerFlatFile.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Metadata/MetaDataStorageHandlerFlatFile.php