sspmod_core_Auth_Process_TargetedID Class Reference

Inheritance diagram for sspmod_core_Auth_Process_TargetedID:

Collaboration diagram for sspmod_core_Auth_Process_TargetedID:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	process (&$state)
	Apply filter to add the targeted ID. More...
Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...
	process (&$request)
	Process a request. More...

Static Private Member Functions
static	getEntityId ($metadata)
	Generate ID from entity metadata. More...

Private Attributes
	$attribute = NULL
	The attribute we should generate the targeted id from, or NULL if we should use the UserID. More...
	$generateNameId = FALSE

Additional Inherited Members
Data Fields inherited from SimpleSAML_Auth_ProcessingFilter
	$priority = 50
	Priority of this filter. More...

Detailed Description

Definition at line 31 of file TargetedID.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_TargetedID::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

array	$config	Configuration information about this filter.
mixed	$reserved	For future use.

Definition at line 55 of file TargetedID.php.

                                                        {
                parent::__construct($config, $reserved);
 
                assert(is_array($config));
 
                if (array_key_exists('attributename', $config)) {
                        $this->attribute = $config['attributename'];
                        if (!is_string($this->attribute)) {
                                throw new Exception('Invalid attribute name given to core:TargetedID filter.');
                        }
                }
 
                if (array_key_exists('nameId', $config)) {
                        $this->generateNameId = $config['nameId'];
                        if (!is_bool($this->generateNameId)) {
                                throw new Exception('Invalid value of \'nameId\'-option to core:TargetedID filter.');
                        }
                }
        }

References $config.

Member Function Documentation

getEntityId()

static sspmod_core_Auth_Process_TargetedID::getEntityId (   $metadata )

staticprivate

Generate ID from entity metadata.

This function takes in the metadata of an entity, and attempts to generate an unique identifier based on that.

Parameters

array

$metadata

The metadata of the entity.

Returns

string The unique identifier for the entity.

Definition at line 154 of file TargetedID.php.

                                                       {
                assert(is_array($metadata));
 
                $id = '';
 
                if (array_key_exists('metadata-set', $metadata)) {
                        $set = $metadata['metadata-set'];
                        $id .= 'set' . strlen($set) . ':' . $set;
                }
 
                if (array_key_exists('entityid', $metadata)) {
                        $entityid = $metadata['entityid'];
                        $id .= 'set' . strlen($entityid) . ':' . $entityid;
                }
 
                return $id;
        }

process()

sspmod_core_Auth_Process_TargetedID::process

(

&

$state

)

Apply filter to add the targeted ID.

Parameters

array

&$state

The current state.

Reimplemented from SimpleSAML_Auth_ProcessingFilter.

Definition at line 81 of file TargetedID.php.

                                         {
                assert(is_array($state));
                assert(array_key_exists('Attributes', $state));
 
                if ($this->attribute === NULL) {
                        if (!array_key_exists('UserID', $state)) {
                                throw new Exception('core:TargetedID: Missing UserID for this user. Please' .
                                        ' check the \'userid.attribute\' option in the metadata against the' .
                                        ' attributes provided by the authentication source.');
                        }
 
                        $userID = $state['UserID'];
                } else {
                        if (!array_key_exists($this->attribute, $state['Attributes'])) {
                                throw new Exception('core:TargetedID: Missing attribute \'' . $this->attribute .
                                        '\', which is needed to generate the targeted ID.');
                        }
 
                        $userID = $state['Attributes'][$this->attribute][0];
                }
 
 
                $secretSalt = SimpleSAML\Utils\Config::getSecretSalt();
 
                if (array_key_exists('Source', $state)) {
                        $srcID = self::getEntityId($state['Source']);
                } else {
                        $srcID = '';
                }
 
                if (array_key_exists('Destination', $state)) {
                        $dstID = self::getEntityId($state['Destination']);
                } else {
                        $dstID = '';
                }
 
                $uidData = 'uidhashbase' . $secretSalt;
                $uidData .= strlen($srcID) . ':' . $srcID;
                $uidData .= strlen($dstID) . ':' . $dstID;
                $uidData .= strlen($userID) . ':' . $userID;
                $uidData .= $secretSalt;
 
                $uid = hash('sha1', $uidData);
 
                if ($this->generateNameId) {
                        // Convert the targeted ID to a SAML 2.0 name identifier element
                        $nameId = new \SAML2\XML\saml\NameID();
                        $nameId->value = $uid;
                        $nameId->Format = \SAML2\Constants::NAMEID_PERSISTENT;
 
                        if (isset($state['Source']['entityid'])) {
                                $nameId->NameQualifier = $state['Source']['entityid'];
                        }
                        if (isset($state['Destination']['entityid'])) {
                                $nameId->SPNameQualifier = $state['Destination']['entityid'];
                        }
                } else {
                        $nameId = $uid;
                }
 
                $state['Attributes']['eduPersonTargetedID'] = array($nameId);
        }

References $state.

Field Documentation

$attribute

sspmod_core_Auth_Process_TargetedID::$attribute = NULL

private

The attribute we should generate the targeted id from, or NULL if we should use the UserID.

Definition at line 38 of file TargetedID.php.

$generateNameId

sspmod_core_Auth_Process_TargetedID::$generateNameId = FALSE

private

Definition at line 46 of file TargetedID.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/core/lib/Auth/Process/TargetedID.php