sspmod_saml_Auth_Process_PersistentNameID Class Reference

Inheritance diagram for sspmod_saml_Auth_Process_PersistentNameID:

Collaboration diagram for sspmod_saml_Auth_Process_PersistentNameID:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...
Public Member Functions inherited from sspmod_saml_BaseNameIDGenerator
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...
	process (&$state)
	Generate transient NameID. More...
Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...
	process (&$request)
	Process a request. More...

Protected Member Functions
	getValue (array &$state)
	Get the NameID value. More...
Protected Member Functions inherited from sspmod_saml_BaseNameIDGenerator
	getValue (array &$state)
	Get the NameID value. More...

Private Attributes
	$attribute

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

Detailed Description

Definition at line 9 of file PersistentNameID.php.

Constructor & Destructor Documentation

__construct()

sspmod_saml_Auth_Process_PersistentNameID::__construct	(		$config,
			$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Exceptions

SimpleSAML_Error_Exception

If the required option 'attribute' is missing.

Definition at line 28 of file PersistentNameID.php.

References $config, format, and SAML2\Constants\NAMEID_PERSISTENT.

    {
        parent::__construct($config, $reserved);
        assert('is_array($config)');

        $this->format = \SAML2\Constants::NAMEID_PERSISTENT;

        if (!isset($config['attribute'])) {
            throw new SimpleSAML_Error_Exception("PersistentNameID: Missing required option 'attribute'.");
        }
        $this->attribute = $config['attribute'];
    }

Member Function Documentation

getValue()

sspmod_saml_Auth_Process_PersistentNameID::getValue ( array &  $state )

protected

Get the NameID value.

Parameters

array

$state

The state array.

Returns

string|null The NameID value.

Definition at line 48 of file PersistentNameID.php.

References $idpEntityId, $spEntityId, SimpleSAML\Utils\Config\getSecretSalt(), and SimpleSAML\Logger\warning().

    {

        if (!isset($state['Destination']['entityid'])) {
            SimpleSAML\Logger::warning('No SP entity ID - not generating persistent NameID.');
            return null;
        }
        $spEntityId = $state['Destination']['entityid'];

        if (!isset($state['Source']['entityid'])) {
            SimpleSAML\Logger::warning('No IdP entity ID - not generating persistent NameID.');
            return null;
        }
        $idpEntityId = $state['Source']['entityid'];

        if (!isset($state['Attributes'][$this->attribute]) || count($state['Attributes'][$this->attribute]) === 0) {
            SimpleSAML\Logger::warning(
                'Missing attribute '.var_export($this->attribute, true).
                ' on user - not generating persistent NameID.'
            );
            return null;
        }
        if (count($state['Attributes'][$this->attribute]) > 1) {
            SimpleSAML\Logger::warning(
                'More than one value in attribute '.var_export($this->attribute, true).
                ' on user - not generating persistent NameID.'
            );
            return null;
        }
        $uid = array_values($state['Attributes'][$this->attribute]); // just in case the first index is no longer 0
        $uid = $uid[0];

        if (empty($uid)) {
            SimpleSAML\Logger::warning(
                'Empty value in attribute '.var_export($this->attribute, true).
                ' on user - not generating persistent NameID.'
            );
            return null;
        }

        $secretSalt = SimpleSAML\Utils\Config::getSecretSalt();

        $uidData = 'uidhashbase'.$secretSalt;
        $uidData .= strlen($idpEntityId).':'.$idpEntityId;
        $uidData .= strlen($spEntityId).':'.$spEntityId;
        $uidData .= strlen($uid).':'.$uid;
        $uidData .= $secretSalt;

        return sha1($uidData);
    }

Here is the call graph for this function:

Field Documentation

$attribute

sspmod_saml_Auth_Process_PersistentNameID::$attribute

private

Definition at line 17 of file PersistentNameID.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/saml/lib/Auth/Process/PersistentNameID.php