BaseNameIDGenerator.php

Go to the documentation of this file.

<?php

abstract class sspmod_saml_BaseNameIDGenerator extends SimpleSAML_Auth_ProcessingFilter
{
    private $nameQualifier;


    private $spNameQualifier;


    protected $format;


    public function __construct($config, $reserved)
    {
        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;
        }
    }


    abstract protected function getValue(array &$state);


    public function process(&$state)
    {
        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;
    }

}