SimpleSAML_Metadata_MetaDataStorageHandler Class Reference

Collaboration diagram for SimpleSAML_Metadata_MetaDataStorageHandler:

Public Member Functions
	getGenerated ($property, $set)
	This function is used to generate some metadata elements automatically. More...
	getList ($set='saml20-idp-remote')
	This function lists all known metadata in the given set. More...
	getMetaDataCurrent ($set)
	This function retrieves metadata for the current entity based on the hostname/path the request was directed to. More...
	getMetaDataCurrentEntityID ($set, $type='entityid')
	This function locates the current entity id based on the hostname/path combination the user accessed. More...
	getPreferredEntityIdFromCIDRhint ($set, $ip)
	This method will call getPreferredEntityIdFromCIDRhint() on all of the sources. More...
	getMetaData ($index, $set)
	This function looks up the metadata for the given entity id in the given set. More...
	getMetaDataConfig ($entityId, $set)
	Retrieve the metadata as a configuration object. More...
	getMetaDataConfigForSha1 ($sha1, $set)
	Search for an entity's metadata, given the SHA1 digest of its entity ID. More...

Static Public Member Functions
static	getMetadataHandler ()
	This function retrieves the current instance of the metadata handler. More...

Protected Member Functions
	__construct ()
	This constructor initializes this metadata storage handler. More...

Private Attributes
	$sources

Static Private Attributes
static	$metadataHandler = null

Detailed Description

Definition at line 10 of file MetaDataStorageHandler.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Metadata_MetaDataStorageHandler::__construct ( )

protected

This constructor initializes this metadata storage handler.

It will load and parse the configuration, and initialize the metadata source list.

Definition at line 54 of file MetaDataStorageHandler.php.

References $config, $type, array, SimpleSAML_Configuration\getInstance(), and SimpleSAML_Metadata_MetaDataStorageSource\parseSources().

    {
        $config = SimpleSAML_Configuration::getInstance();

        $sourcesConfig = $config->getArray('metadata.sources', null);

        // for backwards compatibility, and to provide a default configuration
        if ($sourcesConfig === null) {
            $type = $config->getString('metadata.handler', 'flatfile');
            $sourcesConfig = array(array('type' => $type));
        }

        try {
            $this->sources = SimpleSAML_Metadata_MetaDataStorageSource::parseSources($sourcesConfig);
        } catch (Exception $e) {
            throw new Exception(
                "Invalid configuration of the 'metadata.sources' configuration option: ".$e->getMessage()
            );
        }
    }

Here is the call graph for this function:

Member Function Documentation

getGenerated()

SimpleSAML_Metadata_MetaDataStorageHandler::getGenerated	(		$property,
			$set
	)

This function is used to generate some metadata elements automatically.

Parameters

string	$property	The metadata property which should be auto-generated.
string	$set	The set we the property comes from.

Returns

string The auto-generated metadata property.

Exceptions

Exception

If the metadata cannot be generated automatically.

Definition at line 85 of file MetaDataStorageHandler.php.

References $baseurl, $config, SimpleSAML_Configuration\getInstance(), and getMetaDataCurrent().

    {
        // first we check if the user has overridden this property in the metadata
        try {
            $metadataSet = $this->getMetaDataCurrent($set);
            if (array_key_exists($property, $metadataSet)) {
                return $metadataSet[$property];
            }
        } catch (Exception $e) {
            // probably metadata wasn't found. In any case we continue by generating the metadata
        }

        // get the configuration
        $config = SimpleSAML_Configuration::getInstance();
        assert($config instanceof SimpleSAML_Configuration);

        $baseurl = \SimpleSAML\Utils\HTTP::getSelfURLHost().$config->getBasePath();

        if ($set == 'saml20-sp-hosted') {
            if ($property === 'SingleLogoutServiceBinding') {
                return \SAML2\Constants::BINDING_HTTP_REDIRECT;
            }
        } elseif ($set == 'saml20-idp-hosted') {
            switch ($property) {
                case 'SingleSignOnService':
                    return $baseurl.'saml2/idp/SSOService.php';

                case 'SingleSignOnServiceBinding':
                    return \SAML2\Constants::BINDING_HTTP_REDIRECT;

                case 'SingleLogoutService':
                    return $baseurl.'saml2/idp/SingleLogoutService.php';

                case 'SingleLogoutServiceBinding':
                    return \SAML2\Constants::BINDING_HTTP_REDIRECT;
            }
        } elseif ($set == 'shib13-idp-hosted') {
            if ($property === 'SingleSignOnService') {
                return $baseurl.'shib13/idp/SSOService.php';
            }
        }

        throw new Exception('Could not generate metadata property '.$property.' for set '.$set.'.');
    }

Here is the call graph for this function:

getList()

SimpleSAML_Metadata_MetaDataStorageHandler::getList

(

$set = 'saml20-idp-remote'

)

This function lists all known metadata in the given set.

It is returned as an associative array where the key is the entity id.

Parameters

string

$set

The set we want to list metadata from.

Returns

array An associative array with the metadata from from the given set.

Definition at line 139 of file MetaDataStorageHandler.php.

References $key, $result, $source, array, time, and SimpleSAML\Logger\warning().

    {
        assert('is_string($set)');

        $result = array();

        foreach ($this->sources as $source) {
            $srcList = $source->getMetadataSet($set);

            foreach ($srcList as $key => $le) {
                if (array_key_exists('expire', $le)) {
                    if ($le['expire'] < time()) {
                        unset($srcList[$key]);
                        SimpleSAML\Logger::warning(
                            "Dropping metadata entity ".var_export($key, true).", expired ".
                            SimpleSAML\Utils\Time::generateTimestamp($le['expire'])."."
                        );
                    }
                }
            }

            /* $result is the last argument to array_merge because we want the content already
             * in $result to have precedence.
             */
            $result = array_merge($srcList, $result);
        }

        return $result;
    }

Here is the call graph for this function:

getMetaData()

SimpleSAML_Metadata_MetaDataStorageHandler::getMetaData	(		$index,
			$set
	)

This function looks up the metadata for the given entity id in the given set.

It will throw an exception if it is unable to locate the metadata.

Parameters

string	$index	The entity id we are looking up. This parameter may be NULL, in which case we look up the current entity id based on the current hostname/path.
string	$set	The set of metadata we are looking up the entity id in.

Returns

array The metadata array describing the specified entity.

Exceptions

Exception	If metadata for the specified entity is expired.
SimpleSAML_Error_MetadataNotFound	If no metadata for the entity specified can be found.

Definition at line 269 of file MetaDataStorageHandler.php.

References $index, $metadata, $source, getMetaDataCurrentEntityID(), and time.

Referenced by getMetaDataConfig(), and getMetaDataCurrent().

    {
        assert('is_string($set)');

        if ($index === null) {
            $index = $this->getMetaDataCurrentEntityID($set, 'metaindex');
        }

        assert('is_string($index)');

        foreach ($this->sources as $source) {
            $metadata = $source->getMetaData($index, $set);

            if ($metadata !== null) {

                if (array_key_exists('expire', $metadata)) {
                    if ($metadata['expire'] < time()) {
                        throw new Exception(
                            'Metadata for the entity ['.$index.'] expired '.
                            (time() - $metadata['expire']).' seconds ago.'
                        );
                    }
                }

                $metadata['metadata-index'] = $index;
                $metadata['metadata-set'] = $set;
                assert('array_key_exists("entityid", $metadata)');
                return $metadata;
            }
        }

        throw new SimpleSAML_Error_MetadataNotFound($index);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetaDataConfig()

SimpleSAML_Metadata_MetaDataStorageHandler::getMetaDataConfig	(		$entityId,
			$set
	)

Retrieve the metadata as a configuration object.

This function will throw an exception if it is unable to locate the metadata.

Parameters

string	$entityId	The entity ID we are looking up.
string	$set	The metadata set we are searching.

Returns

SimpleSAML_Configuration The configuration object representing the metadata.

Exceptions

SimpleSAML_Error_MetadataNotFound

If no metadata for the entity specified can be found.

Definition at line 315 of file MetaDataStorageHandler.php.

References $entityId, $metadata, getMetaData(), and SimpleSAML_Configuration\loadFromArray().

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

        $metadata = $this->getMetaData($entityId, $set);
        return SimpleSAML_Configuration::loadFromArray($metadata, $set.'/'.var_export($entityId, true));
    }

Here is the call graph for this function:

getMetaDataConfigForSha1()

SimpleSAML_Metadata_MetaDataStorageHandler::getMetaDataConfigForSha1	(		$sha1,
			$set
	)

Search for an entity's metadata, given the SHA1 digest of its entity ID.

Parameters

string	$sha1	The SHA1 digest of the entity ID.
string	$set	The metadata set we are searching.

Returns

null|SimpleSAML_Configuration The metadata corresponding to the entity, or null if the entity cannot be found.

Definition at line 334 of file MetaDataStorageHandler.php.

References $result, $source, array, and SimpleSAML_Configuration\loadFromArray().

    {
        assert('is_string($sha1)');
        assert('is_string($set)');

        $result = array();

        foreach ($this->sources as $source) {
            $srcList = $source->getMetadataSet($set);

            /* $result is the last argument to array_merge because we want the content already
             * in $result to have precedence.
             */
            $result = array_merge($srcList, $result);
        }
        foreach ($result as $remote_provider) {

            if (sha1($remote_provider['entityid']) == $sha1) {
                $remote_provider['metadata-set'] = $set;

                return SimpleSAML_Configuration::loadFromArray(
                    $remote_provider,
                    $set.'/'.var_export($remote_provider['entityid'], true)
                );
            }
        }

        return null;
    }

Here is the call graph for this function:

getMetaDataCurrent()

SimpleSAML_Metadata_MetaDataStorageHandler::getMetaDataCurrent

(

$set

)

This function retrieves metadata for the current entity based on the hostname/path the request was directed to.

It will throw an exception if it is unable to locate the metadata.

Parameters

string

$set

The set we want metadata from.

Returns

array An associative array with the metadata.

Definition at line 178 of file MetaDataStorageHandler.php.

References getMetaData().

Referenced by getGenerated().

    {
        return $this->getMetaData(null, $set);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetaDataCurrentEntityID()

SimpleSAML_Metadata_MetaDataStorageHandler::getMetaDataCurrentEntityID	(		$set,
			$type = 'entityid'
	)

This function locates the current entity id based on the hostname/path combination the user accessed.

It will throw an exception if it is unable to locate the entity id.

Parameters

string	$set	The set we look for the entity id in.
string	$type	Do you want to return the metaindex or the entityID. [entityid|metaindex]

Returns

string The entity id which is associated with the current hostname/path combination.

Exceptions

Exception

If no default metadata can be found in the set for the current host.

Definition at line 194 of file MetaDataStorageHandler.php.

References $entityId, $index, $source, $type, SimpleSAML\Utils\HTTP\getSelfHost(), and SimpleSAML\Utils\HTTP\getSelfHostWithPath().

Referenced by getMetaData().

    {
        assert('is_string($set)');

        // first we look for the hostname/path combination
        $currenthostwithpath = \SimpleSAML\Utils\HTTP::getSelfHostWithPath(); // sp.example.org/university

        foreach ($this->sources as $source) {
            $index = $source->getEntityIdFromHostPath($currenthostwithpath, $set, $type);
            if ($index !== null) {
                return $index;
            }
        }

        // then we look for the hostname
        $currenthost = \SimpleSAML\Utils\HTTP::getSelfHost(); // sp.example.org

        foreach ($this->sources as $source) {
            $index = $source->getEntityIdFromHostPath($currenthost, $set, $type);
            if ($index !== null) {
                return $index;
            }
        }

        // then we look for the DEFAULT entry
        foreach ($this->sources as $source) {
            $entityId = $source->getEntityIdFromHostPath('__DEFAULT__', $set, $type);
            if ($entityId !== null) {
                return $entityId;
            }
        }

        // we were unable to find the hostname/path in any metadata source
        throw new Exception(
            'Could not find any default metadata entities in set ['.$set.'] for host ['.$currenthost.' : '.
            $currenthostwithpath.']'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMetadataHandler()

static SimpleSAML_Metadata_MetaDataStorageHandler::getMetadataHandler ( )

static

This function retrieves the current instance of the metadata handler.

The metadata handler will be instantiated if this is the first call to this function.

Returns

SimpleSAML_Metadata_MetaDataStorageHandler The current metadata handler instance.

Definition at line 40 of file MetaDataStorageHandler.php.

Referenced by ilSimpleSAMLphplIdpDiscovery\__construct(), SimpleSAML_IdP\__construct(), SimpleSAML_XHTML_IdPDisco\__construct(), sspmod_saml_Auth_Source_SP\authenticate(), SimpleSAML\XML\Shib13\AuthnRequest\createRedirect(), sspmod_saml_IdP_SAML2\getAssociationConfig(), sspmod_saml_Auth_Source_SP\getIdPMetadata(), sspmod_adfs_IdP_ADFS\getLogoutURL(), sspmod_saml_IdP_SAML2\getLogoutURL(), sspmod_statistics_Statistics_FieldPresentation_Entity\getPresentation(), SimpleSAML\XML\Shib13\AuthnResponse\getSessionIndex(), SimpleSAML_IdP\getSPName(), sspmod_consent_Auth_Process_Consent\process(), sspmod_saml_Auth_Source_SP\reauthenticate(), sspmod_adfs_IdP_ADFS\receiveAuthnRequest(), sspmod_saml_IdP_SAML1\receiveAuthnRequest(), sspmod_saml_IdP_SAML2\receiveAuthnRequest(), sspmod_saml_IdP_SAML2\receiveLogoutMessage(), SAML2\HTTPArtifact\send(), sspmod_saml_IdP_SAML2\sendLogoutRequest(), sspmod_adfs_IdP_ADFS\sendLogoutResponse(), sspmod_saml_IdP_SAML2\sendLogoutResponse(), sspmod_saml_IdP_SAML1\sendResponse(), and SimpleSAML\XML\Shib13\AuthnResponse\validate().

    {
        if (self::$metadataHandler === null) {
            self::$metadataHandler = new SimpleSAML_Metadata_MetaDataStorageHandler();
        }

        return self::$metadataHandler;
    }

Here is the caller graph for this function:

getPreferredEntityIdFromCIDRhint()

SimpleSAML_Metadata_MetaDataStorageHandler::getPreferredEntityIdFromCIDRhint	(		$set,
			$ip
	)

This method will call getPreferredEntityIdFromCIDRhint() on all of the sources.

Parameters

string	$set	Which set of metadata we are looking it up in.
string	$ip	IP address

Returns

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

Definition at line 244 of file MetaDataStorageHandler.php.

References $entityId, and $source.

    {
        foreach ($this->sources as $source) {
            $entityId = $source->getPreferredEntityIdFromCIDRhint($set, $ip);
            if ($entityId !== null) {
                return $entityId;
            }
        }

        return null;
    }

Field Documentation

$metadataHandler

SimpleSAML_Metadata_MetaDataStorageHandler::$metadataHandler = null

staticprivate

Definition at line 21 of file MetaDataStorageHandler.php.

$sources

SimpleSAML_Metadata_MetaDataStorageHandler::$sources

private

Definition at line 30 of file MetaDataStorageHandler.php.

---

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

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