sspmod_metarefresh_MetaLoader Class Reference

Collaboration diagram for sspmod_metarefresh_MetaLoader:

Public Member Functions
	__construct ($expire=null, $stateFile=null, $oldMetadataSrc=null)
	Constructor. More...
	getTypes ()
	Get the types of entities that will be loaded. More...
	setTypes ($types)
	Set the types of entities that will be loaded. More...
	loadSource ($source)
	This function processes a SAML metadata file. More...
	writeState ()
	This function writes the state array back to disk. More...
	dumpMetadataStdOut ()
	This function writes the metadata to stdout. More...
	writeARPfile ($config)
	This function writes the metadata to an ARP file. More...
	writeMetadataFiles ($outputDir)
	This function writes the metadata to to separate files in the output directory. More...
	writeMetadataSerialize ($outputDir)
	Save metadata for loading with the 'serialize' metadata loader. More...

Private Member Functions
	createContext ($source)
	Create HTTP context, with any available caches taken into account. More...
	addCachedMetadata ($source)
	saveState ($source, $responseHeaders)
	Store caching state data for a source. More...
	loadXML ($data, $source)
	Parse XML metadata and return entities. More...
	addMetadata ($filename, $metadata, $type, $template=null)
	This function adds metadata from the specified file to the list of metadata. More...
	getTime ()

Private Attributes
	$expire
	$metadata
	$oldMetadataSrc
	$stateFile
	$changed
	$state
	$types

Detailed Description

Definition at line 6 of file MetaLoader.php.

Constructor & Destructor Documentation

__construct()

sspmod_metarefresh_MetaLoader::__construct	(		$expire = null,
			$stateFile = null,
			$oldMetadataSrc = null
	)

Constructor.

Parameters

integer	$expire
string	$stateFile
object	$oldMetadataSrc

Definition at line 30 of file MetaLoader.php.

References $expire, $oldMetadataSrc, and $stateFile.

    {
        $this->expire = $expire;
        $this->metadata = array();
        $this->oldMetadataSrc = $oldMetadataSrc;
        $this->stateFile = $stateFile;
        $this->changed = false;

        // Read file containing $state from disk
        if (is_readable($stateFile)) {
            include $stateFile;
        }

        $this->state = array();

    }

Member Function Documentation

addCachedMetadata()

sspmod_metarefresh_MetaLoader::addCachedMetadata (   $source )

private

Definition at line 221 of file MetaLoader.php.

References $source, $type, and addMetadata().

Referenced by loadSource().

    {
        if (isset($this->oldMetadataSrc)) {
            foreach ($this->types as $type) {
                foreach ($this->oldMetadataSrc->getMetadataSet($type) as $entity) {
                    if (array_key_exists('metarefresh:src', $entity)) {
                        if ($entity['metarefresh:src'] == $source['src']) {
                            $this->addMetadata($source['src'], $entity, $type);
                        }
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addMetadata()

sspmod_metarefresh_MetaLoader::addMetadata (   $filename,   $metadata,   $type,   $template = null  )

private

This function adds metadata from the specified file to the list of metadata.

This function will return without making any changes if $metadata is NULL.

Parameters

$filename	The filename the metadata comes from.
$metadata	The metadata.
$type	The metadata type.

Definition at line 330 of file MetaLoader.php.

Referenced by addCachedMetadata(), and loadSource().

    {
        if ($metadata === null) {
            return;
        }

        if (isset($template)) {
            $metadata = array_merge($metadata, $template);
        }

        $metadata['metarefresh:src'] = $filename;
        if (!array_key_exists($type, $this->metadata)) {
            $this->metadata[$type] = array();
        }

        // If expire is defined in constructor...
        if (!empty($this->expire)) {
            // If expire is already in metadata
            if (array_key_exists('expire', $metadata)) {
                // Override metadata expire with more restrictive global config-
                if ($this->expire < $metadata['expire']) {
                    $metadata['expire'] = $this->expire;
                }

                // If expire is not already in metadata use global config
            } else {
                $metadata['expire'] = $this->expire;
            }
        }
        $this->metadata[$type][] = array('filename' => $filename, 'metadata' => $metadata);
    }

Here is the caller graph for this function:

createContext()

sspmod_metarefresh_MetaLoader::createContext (   $source )

private

Create HTTP context, with any available caches taken into account.

Definition at line 195 of file MetaLoader.php.

References $config, $name, $source, and SimpleSAML_Configuration\getInstance().

Referenced by loadSource().

    {
        $config = SimpleSAML_Configuration::getInstance();
        $name = $config->getString('technicalcontact_name', null);
        $mail = $config->getString('technicalcontact_email', null);

        $rawheader = "User-Agent: SimpleSAMLphp metarefresh, run by $name <$mail>\r\n";

        if (isset($source['conditionalGET']) && $source['conditionalGET']) {
            if (array_key_exists($source['src'], $this->state)) {
                $sourceState = $this->state[$source['src']];

                if (isset($sourceState['last-modified'])) {
                    $rawheader .= 'If-Modified-Since: ' . $sourceState['last-modified'] . "\r\n";
                }

                if (isset($sourceState['etag'])) {
                    $rawheader .= 'If-None-Match: ' . $sourceState['etag'] . "\r\n";
                }
            }
        }

        return array('http' => array('header' => $rawheader));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

dumpMetadataStdOut()

sspmod_metarefresh_MetaLoader::dumpMetadataStdOut

(

)

This function writes the metadata to stdout.

Definition at line 300 of file MetaLoader.php.

References $filename, $m, and getTime().

    {
        foreach ($this->metadata as $category => $elements) {

            echo '/* The following data should be added to metadata/' . $category . '.php. */' . "\n";

            foreach ($elements as $m) {
                $filename = $m['filename'];
                $entityID = $m['metadata']['entityid'];

                echo "\n";
                echo '/* The following metadata was generated from ' . $filename . ' on ' . $this->getTime() . '. */' . "\n";
                echo '$metadata[\'' . addslashes($entityID) . '\'] = ' . var_export($m['metadata'], true) . ';' . "\n";
            }

            echo "\n";
            echo '/* End of data which should be added to metadata/' . $category . '.php. */' . "\n";
            echo "\n";
        }
    }

Here is the call graph for this function:

getTime()

sspmod_metarefresh_MetaLoader::getTime ( )

private

Definition at line 492 of file MetaLoader.php.

Referenced by dumpMetadataStdOut(), saveState(), and writeState().

    {
        /* The current date, as a string. */
        date_default_timezone_set('UTC');
        return date('Y-m-d\\TH:i:s\\Z');
    }

Here is the caller graph for this function:

getTypes()

sspmod_metarefresh_MetaLoader::getTypes

(

)

Get the types of entities that will be loaded.

Returns

array The entity types allowed.

Definition at line 53 of file MetaLoader.php.

References $types.

    {
        return $this->types;
    }

loadSource()

sspmod_metarefresh_MetaLoader::loadSource

(

$source

)

This function processes a SAML metadata file.

Parameters

$source

Definition at line 79 of file MetaLoader.php.

References $context, $data, $source, $template, addCachedMetadata(), addMetadata(), createContext(), SimpleSAML\Logger\debug(), SimpleSAML\Utils\HTTP\fetch(), SimpleSAML\Logger\info(), loadXML(), saveState(), and SimpleSAML\Logger\warning().

    {
        if (preg_match('@^https?://@i', $source['src'])) {
            // Build new HTTP context
            $context = $this->createContext($source);

            // GET!
            try {
                list($data, $responseHeaders) = \SimpleSAML\Utils\HTTP::fetch($source['src'], $context, true);
            } catch(Exception $e) {
                SimpleSAML\Logger::warning('metarefresh: ' . $e->getMessage());
            }

            // We have response headers, so the request succeeded
            if (!isset($responseHeaders)) {
                // No response headers, this means the request failed in some way, so re-use old data
                SimpleSAML\Logger::debug('No response from ' . $source['src'] . ' - attempting to re-use cached metadata');
                $this->addCachedMetadata($source);
                return;
            } elseif (preg_match('@^HTTP/1\.[01]\s304\s@', $responseHeaders[0])) {
                // 304 response
                SimpleSAML\Logger::debug('Received HTTP 304 (Not Modified) - attempting to re-use cached metadata');
                $this->addCachedMetadata($source);
                return;
            } elseif (!preg_match('@^HTTP/1\.[01]\s200\s@', $responseHeaders[0])) {
                // Other error
                SimpleSAML\Logger::debug('Error from ' . $source['src'] . ' - attempting to re-use cached metadata');
                $this->addCachedMetadata($source);
                return;
            }
        } else {
            // Local file.
            $data = file_get_contents($source['src']);
            $responseHeaders = null;
        }

        // Everything OK. Proceed.
        if (isset($source['conditionalGET']) && $source['conditionalGET']) {
            // Stale or no metadata, so a fresh copy
            SimpleSAML\Logger::debug('Downloaded fresh copy');
        }

        try {
            $entities = $this->loadXML($data, $source);
        } catch(Exception $e) {
            SimpleSAML\Logger::debug('XML parser error when parsing ' . $source['src'] . ' - attempting to re-use cached metadata');
            SimpleSAML\Logger::debug('XML parser returned: ' . $e->getMessage());
            $this->addCachedMetadata($source);
            return;
        }

        foreach ($entities as $entity) {

            if (isset($source['blacklist'])) {
                if (!empty($source['blacklist']) && in_array($entity->getEntityID(), $source['blacklist'], true)) {
                    SimpleSAML\Logger::info('Skipping "' .  $entity->getEntityID() . '" - blacklisted.' . "\n");
                    continue;
                }
            }

            if (isset($source['whitelist'])) {
                if (!empty($source['whitelist']) && !in_array($entity->getEntityID(), $source['whitelist'], true)) {
                    SimpleSAML\Logger::info('Skipping "' .  $entity->getEntityID() . '" - not in the whitelist.' . "\n");
                    continue;
                }
            }

            if (array_key_exists('certificates', $source) && $source['certificates'] !== null) {
                if (!$entity->validateSignature($source['certificates'])) {
                    SimpleSAML\Logger::info('Skipping "' . $entity->getEntityId() . '" - could not verify signature using certificate.' . "\n");
                    continue;
                }
            }

            if (array_key_exists('validateFingerprint', $source) && $source['validateFingerprint'] !== null) {
                if (!array_key_exists('certificates', $source) || $source['certificates'] == null) {
                    if (!$entity->validateFingerprint($source['validateFingerprint'])) {
                        SimpleSAML\Logger::info('Skipping "' . $entity->getEntityId() . '" - could not verify signature using fingerprint.' . "\n");
                        continue;
                    }
                } else {
                    SimpleSAML\Logger::info('Skipping validation with fingerprint since option certificate is set.' . "\n");
                }
            }

            $template = null;
            if (array_key_exists('template', $source)) {
                $template = $source['template'];
            }

            if (in_array('shib13-sp-remote', $this->types, true)) {
                $this->addMetadata($source['src'], $entity->getMetadata1xSP(), 'shib13-sp-remote', $template);
            }
            if (in_array('shib13-idp-remote', $this->types, true)) {
                $this->addMetadata($source['src'], $entity->getMetadata1xIdP(), 'shib13-idp-remote', $template);
            }
            if (in_array('saml20-sp-remote', $this->types, true)) {
                $this->addMetadata($source['src'], $entity->getMetadata20SP(), 'saml20-sp-remote', $template);
            }
            if (in_array('saml20-idp-remote', $this->types, true)) {
                $this->addMetadata($source['src'], $entity->getMetadata20IdP(), 'saml20-idp-remote', $template);
            }
            if (in_array('attributeauthority-remote', $this->types, true)) {
                $attributeAuthorities = $entity->getAttributeAuthorities();
                if (!empty($attributeAuthorities)) {
                     $this->addMetadata($source['src'], $attributeAuthorities[0], 'attributeauthority-remote', $template);
                }
            }
        }

        $this->saveState($source, $responseHeaders);
    }

Here is the call graph for this function:

loadXML()

sspmod_metarefresh_MetaLoader::loadXML (   $data,   $source  )

private

Parse XML metadata and return entities.

Definition at line 265 of file MetaLoader.php.

References $data, $source, SAML2\DOMDocumentFactory\fromString(), and SimpleSAML_Metadata_SAMLParser\parseDescriptorsElement().

Referenced by loadSource().

    {
        try {
            $doc = \SAML2\DOMDocumentFactory::fromString($data);
        } catch (Exception $e) {
            throw new Exception('Failed to read XML from ' . $source['src']);
        }
        if ($doc->documentElement === null) {
            throw new Exception('Opened file is not an XML document: ' . $source['src']);
        }
        return SimpleSAML_Metadata_SAMLParser::parseDescriptorsElement($doc->documentElement);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveState()

sspmod_metarefresh_MetaLoader::saveState (   $source,   $responseHeaders  )

private

Store caching state data for a source.

Definition at line 240 of file MetaLoader.php.

References $source, and getTime().

Referenced by loadSource().

    {
        if (isset($source['conditionalGET']) && $source['conditionalGET']) {
            // Headers section
            if ($responseHeaders !== null) {
                $candidates = array('last-modified', 'etag');

                foreach ($candidates as $candidate) {
                    if (array_key_exists($candidate, $responseHeaders)) {
                        $this->state[$source['src']][$candidate] = $responseHeaders[$candidate];
                    }
                }
            }

            if (!empty($this->state[$source['src']])) {
                // Timestamp when this src was requested.
                $this->state[$source['src']]['requested_at'] = $this->getTime();
                $this->changed = true;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTypes()

sspmod_metarefresh_MetaLoader::setTypes

(

$types

)

Set the types of entities that will be loaded.

Parameters

string | array

$types

Either a string with the name of one single type allowed, or an array with a list of types. Pass an empty array to reset to all types of entities.

Definition at line 65 of file MetaLoader.php.

References $types.

    {
        if (!is_array($types)) {
            $types = array($types);
        }
        $this->types = $types;
    }

writeARPfile()

sspmod_metarefresh_MetaLoader::writeARPfile

(

$config

)

This function writes the metadata to an ARP file.

Definition at line 366 of file MetaLoader.php.

    {
        assert($config instanceof SimpleSAML_Configuration);

        $arpfile = $config->getValue('arpfile');
        $types = array('saml20-sp-remote');

        $md = array();
        foreach ($this->metadata as $category => $elements) {
            if (!in_array($category, $types, true)) {
                continue;
            }
            $md = array_merge($md, $elements);
        }

        // $metadata, $attributemap, $prefix, $suffix
        $arp = new sspmod_metarefresh_ARP($md,
            $config->getValue('attributemap', ''),
            $config->getValue('prefix', ''),
            $config->getValue('suffix', '')
        );


        $arpxml = $arp->getXML();

        SimpleSAML\Logger::info('Writing ARP file: ' . $arpfile . "\n");
        file_put_contents($arpfile, $arpxml);
    }

writeMetadataFiles()

sspmod_metarefresh_MetaLoader::writeMetadataFiles

(

$outputDir

)

This function writes the metadata to to separate files in the output directory.

Definition at line 399 of file MetaLoader.php.

    {
        while (strlen($outputDir) > 0 && $outputDir[strlen($outputDir) - 1] === '/') {
            $outputDir = substr($outputDir, 0, strlen($outputDir) - 1);
        }

        if (!file_exists($outputDir)) {
            SimpleSAML\Logger::info('Creating directory: ' . $outputDir . "\n");
            $res = @mkdir($outputDir, 0777, true);
            if ($res === false) {
                throw new Exception('Error creating directory: ' . $outputDir);
            }
        }

        foreach ($this->types as $type) {
            $filename = $outputDir . '/' . $type . '.php';

            if (array_key_exists($type, $this->metadata)) {
                $elements = $this->metadata[$type];
                SimpleSAML\Logger::debug('Writing: ' . $filename);

                $content  = '<?php' . "\n" . '/* This file was generated by the metarefresh module at '. $this->getTime() . "\n";
                $content .= ' Do not update it manually as it will get overwritten' . "\n" . '*/' . "\n";

                foreach ($elements as $m) {
                    $entityID = $m['metadata']['entityid'];
                    $content .= "\n";
                    $content .= '$metadata[\'' . addslashes($entityID) . '\'] = ' . var_export($m['metadata'], true) . ';' . "\n";
                }

                $content .= "\n" . '?>';

                SimpleSAML\Utils\System::writeFile($filename, $content, 0644);
            } elseif (is_file($filename)) {
                if (unlink($filename)) {
                    SimpleSAML\Logger::debug('Deleting stale metadata file: ' . $filename);
                } else {
                    SimpleSAML\Logger::warning('Could not delete stale metadata file: ' . $filename);
                }
            }
        }
    }

writeMetadataSerialize()

sspmod_metarefresh_MetaLoader::writeMetadataSerialize

(

$outputDir

)

Save metadata for loading with the 'serialize' metadata loader.

Parameters

string

$outputDir

The directory we should save the metadata to.

Definition at line 448 of file MetaLoader.php.

    {
        assert(is_string($outputDir));

        $metaHandler = new SimpleSAML_Metadata_MetaDataStorageHandlerSerialize(array('directory' => $outputDir));

        /* First we add all the metadata entries to the metadata handler. */
        foreach ($this->metadata as $set => $elements) {
            foreach ($elements as $m) {
                $entityId = $m['metadata']['entityid'];

                SimpleSAML\Logger::debug(
                    'metarefresh: Add metadata entry ' .
                    var_export($entityId, true) . ' in set ' . var_export($set, true) . '.'
                );
                $metaHandler->saveMetadata($entityId, $set, $m['metadata']);
            }
        }

        /* Then we delete old entries which should no longer exist. */
        $ct = time();
        foreach ($metaHandler->getMetadataSets() as $set) {
            foreach ($metaHandler->getMetadataSet($set) as $entityId => $metadata) {
                if (!array_key_exists('expire', $metadata)) {
                    SimpleSAML\Logger::warning(
                        'metarefresh: Metadata entry without expire timestamp: ' . var_export($entityId, true) .
                        ' in set ' . var_export($set, true) . '.'
                    );
                    continue;
                }
                if ($metadata['expire'] > $ct) {
                    continue;
                }
                SimpleSAML\Logger::debug('metarefresh: ' . $entityId . ' expired ' . date('l jS \of F Y h:i:s A', $metadata['expire']));
                SimpleSAML\Logger::debug(
                    'metarefresh: Delete expired metadata entry ' .
                    var_export($entityId, true) . ' in set ' . var_export($set, true) . '. (' . ($ct - $metadata['expire']) . ' sec)'
                );
                $metaHandler->deleteMetadata($entityId, $set);
            }
        }
    }

writeState()

sspmod_metarefresh_MetaLoader::writeState

(

)

This function writes the state array back to disk.

Definition at line 282 of file MetaLoader.php.

References SimpleSAML\Logger\debug(), getTime(), and SimpleSAML\Utils\System\writeFile().

    {
        if ($this->changed) {
            SimpleSAML\Logger::debug('Writing: ' . $this->stateFile);
            SimpleSAML\Utils\System::writeFile(
                $this->stateFile,
                "<?php\n/* This file was generated by the metarefresh module at ".$this->getTime() . ".\n".
                " Do not update it manually as it will get overwritten. */\n".
                '$state = ' . var_export($this->state, true) . ";\n?>\n",
                0644
            );
        }
    }

Here is the call graph for this function:

Field Documentation

$changed

sspmod_metarefresh_MetaLoader::$changed

private

Definition at line 12 of file MetaLoader.php.

$expire

sspmod_metarefresh_MetaLoader::$expire

private

Definition at line 8 of file MetaLoader.php.

Referenced by __construct().

$metadata

sspmod_metarefresh_MetaLoader::$metadata

private

Definition at line 9 of file MetaLoader.php.

$oldMetadataSrc

sspmod_metarefresh_MetaLoader::$oldMetadataSrc

private

Definition at line 10 of file MetaLoader.php.

Referenced by __construct().

$state

sspmod_metarefresh_MetaLoader::$state

private

Definition at line 13 of file MetaLoader.php.

$stateFile

sspmod_metarefresh_MetaLoader::$stateFile

private

Definition at line 11 of file MetaLoader.php.

Referenced by __construct().

$types

sspmod_metarefresh_MetaLoader::$types

private

Initial value:

= array(
        'saml20-idp-remote',
        'saml20-sp-remote',
        'shib13-idp-remote',
        'shib13-sp-remote',
        'attributeauthority-remote'
    )

Definition at line 14 of file MetaLoader.php.

Referenced by getTypes(), and setTypes().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/metarefresh/lib/MetaLoader.php