SimpleSAML_Metadata_MetaDataStorageHandlerPdo Class Reference

Inheritance diagram for SimpleSAML_Metadata_MetaDataStorageHandlerPdo:

Collaboration diagram for SimpleSAML_Metadata_MetaDataStorageHandlerPdo:

Public Member Functions
	__construct ($config)
	This constructor initializes the PDO metadata storage handler with the specified configuration. More...
	getMetadataSet ($set)
	Retrieve a list of all available metadata for a given set. More...
	addEntry ($index, $set, $entityData)
	Add metadata to the configured database. More...
	initDatabase ()
	Initialize the configured database. 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...

Data Fields
	$supportedSets
	All the metadata sets supported by this MetaDataStorageHandler. More...

Private Member Functions
	load ($set)
	This function loads the given set of metadata from a file to a configured database. More...
	generateDynamicHostedEntityID ($set)
	getTableName ($table)
	Replace the -'s to an _ in table names for Metadata sets since SQL does not allow a - in a table name. More...

Private Attributes
	$db
	The PDO object. More...
	$tablePrefix
	Prefix to apply to the metadata table. More...
	$cachedMetadata = array()
	This is an associative array which stores the different metadata sets we have loaded. More...

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 14 of file MetaDataStorageHandlerPdo.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::__construct

(

$config

)

This constructor initializes the PDO metadata storage handler with the specified configuration.

The configuration is an associative array with the following possible elements (set in config.php):

• 'usePersistentConnection': TRUE/FALSE if database connection should be persistent.
• 'dsn': The database connection string.
• 'username': Database user name
• 'password': Password for the database user.

Parameters

array

$config

An associative array with the configuration for this handler.

Definition at line 61 of file MetaDataStorageHandlerPdo.php.

References SimpleSAML\Database\getInstance().

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

        $this->db = SimpleSAML\Database::getInstance();
    }

Here is the call graph for this function:

Member Function Documentation

addEntry()

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::addEntry	(		$index,
			$set,
			$entityData
	)

Add metadata to the configured database.

Parameters

string	$index	Entity ID
string	$set	The set to add the metadata to
array	$entityData	Metadata

Returns

bool True/False if entry was successfully added

Definition at line 180 of file MetaDataStorageHandlerPdo.php.

References $index, $metadata, $params, $rows, array, and getTableName().

    {
        assert('is_string($index)');
        assert('is_string($set)');
        assert('is_array($entityData)');

        if (!in_array($set, $this->supportedSets, true)) {
            return false;
        }

        $tableName = $this->getTableName($set);

        $metadata = $this->db->read(
            "SELECT entity_id, entity_data FROM $tableName WHERE entity_id = :entity_id",
            array(
                'entity_id' => $index,
            )
        );

        $retrivedEntityIDs = $metadata->fetch();

        $params = array(
            'entity_id'   => $index,
            'entity_data' => json_encode($entityData),
        );

        if ($retrivedEntityIDs !== false && count($retrivedEntityIDs) > 0) {
            $rows = $this->db->write(
                "UPDATE $tableName SET entity_data = :entity_data WHERE entity_id = :entity_id",
                $params
            );
        } else {
            $rows = $this->db->write(
                "INSERT INTO $tableName (entity_id, entity_data) VALUES (:entity_id, :entity_data)",
                $params
            );
        }

        return $rows === 1;
    }

Here is the call graph for this function:

generateDynamicHostedEntityID()

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::generateDynamicHostedEntityID (   $set )

private

Definition at line 146 of file MetaDataStorageHandlerPdo.php.

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

Referenced by getMetadataSet().

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

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

        if ($set === 'saml20-idp-hosted') {
            return $baseurl.'saml2/idp/metadata.php';
        } elseif ($set === 'saml20-sp-hosted') {
            return $baseurl.'saml2/sp/metadata.php';
        } elseif ($set === 'shib13-idp-hosted') {
            return $baseurl.'shib13/idp/metadata.php';
        } elseif ($set === 'shib13-sp-hosted') {
            return $baseurl.'shib13/sp/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_MetaDataStorageHandlerPdo::getMetadataSet

(

$set

)

Retrieve a list of all available metadata for a given set.

Parameters

string

$set

The set we are looking for metadata in.

Returns

array $metadata An associative array with all the metadata for the given set.

Definition at line 120 of file MetaDataStorageHandlerPdo.php.

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

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

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

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

        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:

getTableName()

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::getTableName (   $table )

private

Replace the -'s to an _ in table names for Metadata sets since SQL does not allow a - in a table name.

Parameters

string

$table

Table

Returns

string Replaced table name

Definition at line 230 of file MetaDataStorageHandlerPdo.php.

Referenced by addEntry(), initDatabase(), and load().

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

        return $this->db->applyPrefix(str_replace("-", "_", $this->tablePrefix.$table));
    }

Here is the caller graph for this function:

initDatabase()

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::initDatabase

(

)

Initialize the configured database.

Returns

int|false The number of SQL statements successfully executed, false if some error occurred.

Definition at line 243 of file MetaDataStorageHandlerPdo.php.

References $rows, and getTableName().

    {
        $stmt = 0;
        $fine = true;
        foreach ($this->supportedSets as $set) {
            $tableName = $this->getTableName($set);
            $rows = $this->db->write(
                "CREATE TABLE IF NOT EXISTS $tableName (entity_id VARCHAR(255) PRIMARY KEY NOT NULL, entity_data ".
                "TEXT NOT NULL)"
            );
            if ($rows === 0) {
                $fine = false;
            } else {
                $stmt += $rows;
            }
        }
        if (!$fine) {
            return false;
        }
        return $stmt;
    }

Here is the call graph for this function:

load()

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::load (   $set )

private

This function loads the given set of metadata from a file to a configured database.

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 $metadata Associative array with the metadata, or NULL if we are unable to load metadata from the given file.

Exceptions

Exception	If a database error occurs.
SimpleSAML_Error_Exception	If the metadata can be retrieved from the database, but cannot be decoded.

Definition at line 81 of file MetaDataStorageHandlerPdo.php.

References $d, $data, $metadata, array, and getTableName().

Referenced by getMetadataSet().

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

        $tableName = $this->getTableName($set);

        if (!in_array($set, $this->supportedSets, true)) {
            return null;
        }

        $stmt = $this->db->read("SELECT entity_id, entity_data FROM $tableName");
        if ($stmt->execute()) {
            $metadata = array();

            while ($d = $stmt->fetch()) {
                $data = json_decode($d['entity_data'], true);
                if ($data === null) {
                    throw new SimpleSAML_Error_Exception("Cannot decode metadata for entity '${d['entity_id']}'");
                }
                if (!array_key_exists('entityid', $data)) {
                    $data['entityid'] = $d['entity_id'];
                }
                $metadata[$d['entity_id']] = $data;
            }

            return $metadata;
        } else {
            throw new Exception('PDO metadata handler: Database error: '.var_export($this->db->getLastError(), true));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$cachedMetadata

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::$cachedMetadata = array()

private

This is an associative array which stores the different metadata sets we have loaded.

Definition at line 30 of file MetaDataStorageHandlerPdo.php.

$db

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::$db

private

The PDO object.

Definition at line 20 of file MetaDataStorageHandlerPdo.php.

$supportedSets

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::$supportedSets

Initial value:

= array(
        'adfs-idp-hosted',
        'adfs-sp-remote',
        'saml20-idp-hosted',
        'saml20-idp-remote',
        'saml20-sp-remote',
        'shib13-idp-hosted',
        'shib13-idp-remote',
        'shib13-sp-hosted',
        'shib13-sp-remote',
        'wsfed-idp-remote',
        'wsfed-sp-hosted'
    )

All the metadata sets supported by this MetaDataStorageHandler.

Definition at line 35 of file MetaDataStorageHandlerPdo.php.

$tablePrefix

SimpleSAML_Metadata_MetaDataStorageHandlerPdo::$tablePrefix

private

Prefix to apply to the metadata table.

Definition at line 25 of file MetaDataStorageHandlerPdo.php.

---

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

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