SimpleSAML\Metadata\Sources\MDQ Class Reference

Inheritance diagram for SimpleSAML\Metadata\Sources\MDQ:

Collaboration diagram for SimpleSAML\Metadata\Sources\MDQ:

Public Member Functions
	getMetadataSet ($set)
	This function is not implemented. 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 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...

Protected Member Functions
	__construct ($config)
	This function initializes the dynamic XML metadata source. More...

Private Member Functions
	getCacheFilename ($set, $entityId)
	Find the cache file name for an entity,. More...
	getFromCache ($set, $entityId)
	Load a entity from the cache. More...
	writeToCache ($set, $entityId, $data)
	Save a entity to the cache. More...

Static Private Member Functions
static	getParsedSet (\SimpleSAML_Metadata_SAMLParser $entity, $set)
	Retrieve metadata for the correct set from a SAML2Parser. More...

Private Attributes
	$server
	$validateFingerprint
	$cacheDir
	$cacheLength

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 16 of file MDQ.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Metadata\Sources\MDQ::__construct (   $config )

protected

This function initializes the dynamic XML metadata source.

Options:

• 'server': URL of the MDQ server (url:port). Mandatory.
• 'validateFingerprint': The fingerprint of the certificate used to sign the metadata. You don't need this option if you don't want to validate the signature on the metadata. Optional.
• 'cachedir': Directory where metadata can be cached. Optional.
• 'cachelength': Maximum time metadata cah be cached, in seconds. Default to 24 hours (86400 seconds).

Parameters

array

$config

The configuration for this instance of the XML metadata source.

Exceptions

Exception If no server option can be found in the configuration.

Definition at line 66 of file MDQ.php.

    {
        assert(is_array($config));
 
        if (!array_key_exists('server', $config)) {
            throw new \Exception(__CLASS__.": the 'server' configuration option is not set.");
        } else {
            $this->server = $config['server'];
        }
 
        if (array_key_exists('validateFingerprint', $config)) {
            $this->validateFingerprint = $config['validateFingerprint'];
        } else {
            $this->validateFingerprint = null;
        }
 
        if (array_key_exists('cachedir', $config)) {
            $globalConfig = \SimpleSAML_Configuration::getInstance();
            $this->cacheDir = $globalConfig->resolvePath($config['cachedir']);
        } else {
            $this->cacheDir = null;
        }
 
        if (array_key_exists('cachelength', $config)) {
            $this->cacheLength = $config['cachelength'];
        } else {
            $this->cacheLength = 86400;
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

getCacheFilename()

SimpleSAML\Metadata\Sources\MDQ::getCacheFilename (   $set,   $entityId  )

private

Find the cache file name for an entity,.

Parameters

string	$set	The metadata set this entity belongs to.
string	$entityId	The entity id of this entity.

Returns

string The full path to the cache file.

Definition at line 119 of file MDQ.php.

    {
        assert(is_string($set));
        assert(is_string($entityId));
 
        $cachekey = sha1($entityId);
        return $this->cacheDir.'/'.$set.'-'.$cachekey.'.cached.xml';
    }

References $entityId.

Referenced by SimpleSAML\Metadata\Sources\MDQ\getFromCache(), and SimpleSAML\Metadata\Sources\MDQ\writeToCache().

Here is the caller graph for this function:

getFromCache()

SimpleSAML\Metadata\Sources\MDQ::getFromCache (   $set,   $entityId  )

private

Load a entity from the cache.

Parameters

string	$set	The metadata set this entity belongs to.
string	$entityId	The entity id of this entity.

Returns

array|NULL The associative array with the metadata for this entity, or NULL if the entity could not be found.

Exceptions

Exception If an error occurs while loading metadata from cache.

Definition at line 139 of file MDQ.php.

    {
        assert(is_string($set));
        assert(is_string($entityId));
 
        if (empty($this->cacheDir)) {
            return null;
        }
 
        $cachefilename = $this->getCacheFilename($set, $entityId);
        if (!file_exists($cachefilename)) {
            return null;
        }
        if (!is_readable($cachefilename)) {
            throw new \Exception(__CLASS__.': could not read cache file for entity ['.$cachefilename.']');
        }
        Logger::debug(__CLASS__.': reading cache ['.$entityId.'] => ['.$cachefilename.']');
 
        /* Ensure that this metadata isn't older that the cachelength option allows. This
         * must be verified based on the file, since this option may be changed after the
         * file is written.
         */
        $stat = stat($cachefilename);
        if ($stat['mtime'] + $this->cacheLength <= time()) {
            Logger::debug(__CLASS__.': cache file older that the cachelength option allows.');
            return null;
        }
 
        $rawData = file_get_contents($cachefilename);
        if (empty($rawData)) {
            $error = error_get_last();
            throw new \Exception(
                __CLASS__.': error reading metadata from cache file "'.$cachefilename.'": '.$error['message']
            );
        }
 
        $data = unserialize($rawData);
        if ($data === false) {
            throw new \Exception(__CLASS__.': error unserializing cached data from file "'.$cachefilename.'".');
        }
 
        if (!is_array($data)) {
            throw new \Exception(__CLASS__.': Cached metadata from "'.$cachefilename.'" wasn\'t an array.');
        }
 
        return $data;
    }

References $data, $entityId, SimpleSAML\Logger\debug(), and SimpleSAML\Metadata\Sources\MDQ\getCacheFilename().

Here is the call graph for this function:

getMetadataSet()

SimpleSAML\Metadata\Sources\MDQ::getMetadataSet

(

$set

)

This function is not implemented.

Parameters

string

$set

The set we want to list metadata for.

Returns

array An empty array.

Reimplemented from SimpleSAML_Metadata_MetaDataStorageSource.

Definition at line 104 of file MDQ.php.

    {
        // we don't have this metadata set
        return array();
    }

getParsedSet()

static SimpleSAML\Metadata\Sources\MDQ::getParsedSet ( \SimpleSAML_Metadata_SAMLParser  $entity,   $set  )

staticprivate

Retrieve metadata for the correct set from a SAML2Parser.

Parameters

\SimpleSAML_Metadata_SAMLParser	$entity	A SAML2Parser representing an entity.
string	$set	The metadata set we are looking for.

Returns

array|NULL The associative array with the metadata, or NULL if no metadata for the given set was found.

Definition at line 225 of file MDQ.php.

    {
        assert(is_string($set));
 
        switch ($set) {
            case 'saml20-idp-remote':
                return $entity->getMetadata20IdP();
            case 'saml20-sp-remote':
                return $entity->getMetadata20SP();
            case 'shib13-idp-remote':
                return $entity->getMetadata1xIdP();
            case 'shib13-sp-remote':
                return $entity->getMetadata1xSP();
            case 'attributeauthority-remote':
                $ret = $entity->getAttributeAuthorities();
                return $ret[0];
 
            default:
                Logger::warning(__CLASS__.': unknown metadata set: \''.$set.'\'.');
        }
 
        return null;
    }

References $ret, error(), SimpleSAML_Metadata_SAMLParser\getAttributeAuthorities(), SimpleSAML_Metadata_SAMLParser\getMetadata1xIdP(), SimpleSAML_Metadata_SAMLParser\getMetadata1xSP(), SimpleSAML_Metadata_SAMLParser\getMetadata20IdP(), SimpleSAML_Metadata_SAMLParser\getMetadata20SP(), and SimpleSAML\Logger\warning().

Here is the call graph for this function:

writeToCache()

SimpleSAML\Metadata\Sources\MDQ::writeToCache (   $set,   $entityId,   $data  )

private

Save a entity to the cache.

Parameters

string	$set	The metadata set this entity belongs to.
string	$entityId	The entity id of this entity.
array	$data	The associative array with the metadata for this entity.

Exceptions

Exception If metadata cannot be written to cache.

Definition at line 197 of file MDQ.php.

    {
        assert(is_string($set));
        assert(is_string($entityId));
        assert(is_array($data));
 
        if (empty($this->cacheDir)) {
            return;
        }
 
        $cachefilename = $this->getCacheFilename($set, $entityId);
        if (!is_writable(dirname($cachefilename))) {
            throw new \Exception(__CLASS__.': could not write cache file for entity ['.$cachefilename.']');
        }
        Logger::debug(__CLASS__.': Writing cache ['.$entityId.'] => ['.$cachefilename.']');
        file_put_contents($cachefilename, serialize($data));
    }

References $data, $entityId, SimpleSAML\Logger\debug(), and SimpleSAML\Metadata\Sources\MDQ\getCacheFilename().

Here is the call graph for this function:

Field Documentation

$cacheDir

SimpleSAML\Metadata\Sources\MDQ::$cacheDir

private

Definition at line 39 of file MDQ.php.

$cacheLength

SimpleSAML\Metadata\Sources\MDQ::$cacheLength

private

Definition at line 47 of file MDQ.php.

$server

SimpleSAML\Metadata\Sources\MDQ::$server

private

Definition at line 24 of file MDQ.php.

$validateFingerprint

SimpleSAML\Metadata\Sources\MDQ::$validateFingerprint

private

Definition at line 32 of file MDQ.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Metadata/Sources/MDQ.php