SimpleSAML_Metadata_MetaDataStorageSource Class Reference

Inheritance diagram for SimpleSAML_Metadata_MetaDataStorageSource:

Collaboration diagram for SimpleSAML_Metadata_MetaDataStorageSource:

Public Member Functions
	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 DiscoHints->IPHint 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...

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

Private Member Functions
	lookupIndexFromEntityId ($entityId, $set)

Detailed Description

Definition at line 15 of file MetaDataStorageSource.php.

Member Function Documentation

getEntityIdFromHostPath()

SimpleSAML_Metadata_MetaDataStorageSource::getEntityIdFromHostPath	(		$hostPath,
			$set,
			$type = 'entityid'
	)

This function resolves an host/path combination to an entity id.

This class implements this function using the getMetadataSet-function. A subclass should override this function if it doesn't implement the getMetadataSet function, or if the implementation of getMetadataSet is slow.

Parameters

string	$hostPath	The host/path combination we are looking up.
string	$set	Which set of metadata we are looking it up in.
string	$type	Do you want to return the metaindex or the entityID. [entityid|metaindex]

Returns

string|null An entity id which matches the given host/path combination, or NULL if we are unable to locate one which matches.

Definition at line 132 of file MetaDataStorageSource.php.

References $index, $type, and getMetadataSet().

    {

        $metadataSet = $this->getMetadataSet($set);
        if ($metadataSet === null) {
            // this metadata source does not have this metadata set
            return null;
        }

        foreach ($metadataSet as $index => $entry) {
            if (!array_key_exists('host', $entry)) {
                continue;
            }

            if ($hostPath === $entry['host']) {
                if ($type === 'entityid') {
                    return $entry['entityid'];
                } else {
                    return $index;
                }
            }
        }

        // no entries matched, we should return null
        return null;
    }

Here is the call graph for this function:

getMetaData()

SimpleSAML_Metadata_MetaDataStorageSource::getMetaData	(		$index,
			$set
	)

This function retrieves metadata for the given entity id in the given set of metadata.

It will return NULL if it is unable to locate the metadata.

This class implements this function using the getMetadataSet-function. A subclass should override this function if it doesn't implement the getMetadataSet function, or if the implementation of getMetadataSet is slow.

Parameters

string	$index	The entityId or metaindex we are looking up.
string	$set	The set we are looking for metadata in.

Returns

array An associative array with metadata for the given entity, or NULL if we are unable to locate the entity.

Definition at line 256 of file MetaDataStorageSource.php.

References $index, getMetadataSet(), and lookupIndexFromEntityId().

    {

        assert(is_string($index));
        assert(isset($set));

        $metadataSet = $this->getMetadataSet($set);

        if (array_key_exists($index, $metadataSet)) {
            return $metadataSet[$index];
        }

        $indexlookup = $this->lookupIndexFromEntityId($index, $set);
        if (isset($indexlookup) && array_key_exists($indexlookup, $metadataSet)) {
            return $metadataSet[$indexlookup];
        }

        return null;
    }

Here is the call graph for this function:

getMetadataSet()

SimpleSAML_Metadata_MetaDataStorageSource::getMetadataSet

(

$set

)

This function attempts to generate an associative array with metadata for all entities in the given set.

The key of the array is the entity id.

A subclass should override this function if it is able to easily generate this list.

Parameters

string

$set

The set we want to list metadata for.

Returns

array An associative array with all entities in the given set, or an empty array if we are unable to generate this list.

Definition at line 112 of file MetaDataStorageSource.php.

Referenced by getEntityIdFromHostPath(), getMetaData(), getPreferredEntityIdFromCIDRhint(), and lookupIndexFromEntityId().

    {
        return array();
    }

Here is the caller graph for this function:

getPreferredEntityIdFromCIDRhint()

SimpleSAML_Metadata_MetaDataStorageSource::getPreferredEntityIdFromCIDRhint	(		$set,
			$ip,
			$type = 'entityid'
	)

This function will go through all the metadata, and check the DiscoHints->IPHint parameter, which defines a network space (ip range) for each remote entry.

This function returns the entityID for any of the entities that have an IP range which the IP falls within.

Parameters

string	$set	Which set of metadata we are looking it up in.
string	$ip	IP address
string	$type	Do you want to return the metaindex or the entityID. [entityid|metaindex]

Returns

string The entity id of a entity which have a CIDR hint where the provided IP address match.

Definition at line 173 of file MetaDataStorageSource.php.

References $index, $type, and getMetadataSet().

    {

        $metadataSet = $this->getMetadataSet($set);

        foreach ($metadataSet as $index => $entry) {
            $cidrHints = array();
            
            // support hint.cidr for idp discovery
            if (array_key_exists('hint.cidr', $entry) && is_array($entry['hint.cidr'])) {
                $cidrHints = $entry['hint.cidr'];
            }

            // support discohints in idp metadata for idp discovery
            if (array_key_exists('DiscoHints', $entry) 
                && array_key_exists('IPHint', $entry['DiscoHints']) 
                && is_array($entry['DiscoHints']['IPHint'])) {
                // merge with hints derived from discohints, but prioritize hint.cidr in case it is used
                $cidrHints = array_merge($entry['DiscoHints']['IPHint'], $cidrHints);
            }

            if (empty($cidrHints)) {
                continue;
            }

            foreach ($cidrHints as $hint_entry) {
                if (SimpleSAML\Utils\Net::ipCIDRcheck($hint_entry, $ip)) {
                    if ($type === 'entityid') {
                        return $entry['entityid'];
                    } else {
                        return $index;
                    }
                }
            }
        }

        // no entries matched, we should return null
        return null;
    }

Here is the call graph for this function:

getSource()

static SimpleSAML_Metadata_MetaDataStorageSource::getSource (   $sourceConfig )

static

This function creates a metadata source based on the given configuration.

The type of source is based on the 'type' parameter in the configuration. The default type is 'flatfile'.

Parameters

array

$sourceConfig

Associative array with the configuration for this metadata source.

Returns

mixed An instance of a metadata source with the given configuration.

Exceptions

Exception

If the metadata source type is invalid.

Definition at line 60 of file MetaDataStorageSource.php.

References $type, and SimpleSAML\Module\resolveClass().

Referenced by metarefresh_hook_cron().

    {
        assert(is_array($sourceConfig));

        if (array_key_exists('type', $sourceConfig)) {
            $type = $sourceConfig['type'];
        } else {
            $type = 'flatfile';
        }

        switch ($type) {
            case 'flatfile':
                return new SimpleSAML_Metadata_MetaDataStorageHandlerFlatFile($sourceConfig);
            case 'xml':
                return new SimpleSAML_Metadata_MetaDataStorageHandlerXML($sourceConfig);
            case 'serialize':
                return new SimpleSAML_Metadata_MetaDataStorageHandlerSerialize($sourceConfig);
            case 'mdx':
            case 'mdq':
                return new \SimpleSAML\Metadata\Sources\MDQ($sourceConfig);
            case 'pdo':
                return new SimpleSAML_Metadata_MetaDataStorageHandlerPdo($sourceConfig);
            default:
                // metadata store from module
                try {
                    $className = SimpleSAML\Module::resolveClass(
                        $type,
                        'MetadataStore',
                        'SimpleSAML_Metadata_MetaDataStorageSource'
                    );
                } catch (Exception $e) {
                    throw new SimpleSAML\Error\CriticalConfigurationError(
                        "Invalid 'type' for metadata source. Cannot find store '$type'.",
                        null
                    );
                }
                return new $className($sourceConfig);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupIndexFromEntityId()

SimpleSAML_Metadata_MetaDataStorageSource::lookupIndexFromEntityId (   $entityId,   $set  )

private

Definition at line 217 of file MetaDataStorageSource.php.

References $entityId, $index, getMetadataSet(), and SimpleSAML\Utils\HTTP\getSelfHost().

Referenced by getMetaData().

    {
        assert(is_string($entityId));
        assert(isset($set));

        $metadataSet = $this->getMetadataSet($set);

        // check for hostname
        $currenthost = \SimpleSAML\Utils\HTTP::getSelfHost(); // sp.example.org

        foreach ($metadataSet as $index => $entry) {
            if ($index === $entityId) {
                return $index;
            }
            if ($entry['entityid'] === $entityId) {
                if ($entry['host'] === '__DEFAULT__' || $entry['host'] === $currenthost) {
                    return $index;
                }
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseSources()

static SimpleSAML_Metadata_MetaDataStorageSource::parseSources (   $sourcesConfig )

static

Parse array with metadata sources.

This function accepts an array with metadata sources, and returns an array with each metadata source as an object.

Parameters

array

$sourcesConfig

Array with metadata source configuration.

Returns

array Parsed metadata configuration.

Exceptions

Exception

If something is wrong in the configuration.

Definition at line 31 of file MetaDataStorageSource.php.

Referenced by SimpleSAML_Metadata_MetaDataStorageHandler\__construct().

    {
        assert(is_array($sourcesConfig));

        $sources = array();

        foreach ($sourcesConfig as $sourceConfig) {
            if (!is_array($sourceConfig)) {
                throw new Exception("Found an element in metadata source configuration which wasn't an array.");
            }

            $sources[] = self::getSource($sourceConfig);
        }

        return $sources;
    }

Here is the caller graph for this function:

---

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

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