sspmod_saml_BaseNameIDGenerator Class Reference

Inheritance diagram for sspmod_saml_BaseNameIDGenerator:

Collaboration diagram for sspmod_saml_BaseNameIDGenerator:

Public Member Functions
	__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 Attributes
	$format

Private Attributes
	$nameQualifier
	$spNameQualifier

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

Detailed Description

Definition at line 8 of file BaseNameIDGenerator.php.

Constructor & Destructor Documentation

__construct()

sspmod_saml_BaseNameIDGenerator::__construct	(		$config,
			$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Definition at line 50 of file BaseNameIDGenerator.php.

References $config, $state, and getValue().

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

        if (isset($config['NameQualifier'])) {
            $this->nameQualifier = $config['NameQualifier'];
        } else {
            $this->nameQualifier = false;
        }

        if (isset($config['SPNameQualifier'])) {
            $this->spNameQualifier = $config['SPNameQualifier'];
        } else {
            $this->spNameQualifier = true;
        }
    }

Here is the call graph for this function:

Member Function Documentation

getValue()

sspmod_saml_BaseNameIDGenerator::getValue ( array &  $state )

abstractprotected

Get the NameID value.

Returns

string|null The NameID value.

Referenced by __construct(), and process().

Here is the caller graph for this function:

process()

sspmod_saml_BaseNameIDGenerator::process

(

&

$state

)

Generate transient NameID.

Parameters

array

&$state

The request state.

Definition at line 82 of file BaseNameIDGenerator.php.

References $format, $nameId, $nameQualifier, $spNameQualifier, getValue(), and SimpleSAML\Logger\warning().

    {
        assert(is_array($state));
        assert(is_string($this->format));

        $value = $this->getValue($state);
        if ($value === null) {
            return;
        }

        $nameId = new \SAML2\XML\saml\NameID();
        $nameId->value = $value;

        if ($this->nameQualifier === true) {
            if (isset($state['IdPMetadata']['entityid'])) {
                $nameId->NameQualifier = $state['IdPMetadata']['entityid'];
            } else {
                SimpleSAML\Logger::warning('No IdP entity ID, unable to set NameQualifier.');
            }
        } elseif (is_string($this->nameQualifier)) {
            $nameId->NameQualifier = $this->nameQualifier;
        }

        if ($this->spNameQualifier === true) {
            if (isset($state['SPMetadata']['entityid'])) {
                $nameId->SPNameQualifier = $state['SPMetadata']['entityid'];
            } else {
                SimpleSAML\Logger::warning('No SP entity ID, unable to set SPNameQualifier.');
            }
        } elseif (is_string($this->spNameQualifier)) {
            $nameId->SPNameQualifier = $this->spNameQualifier;
        }

        $state['saml:NameID'][$this->format] = $nameId;
    }

Here is the call graph for this function:

Field Documentation

$format

sspmod_saml_BaseNameIDGenerator::$format

protected

Definition at line 41 of file BaseNameIDGenerator.php.

Referenced by process().

$nameQualifier

sspmod_saml_BaseNameIDGenerator::$nameQualifier

private

Definition at line 19 of file BaseNameIDGenerator.php.

Referenced by process().

$spNameQualifier

sspmod_saml_BaseNameIDGenerator::$spNameQualifier

private

Definition at line 31 of file BaseNameIDGenerator.php.

Referenced by process().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/saml/lib/BaseNameIDGenerator.php