sspmod_saml_Auth_Process_NameIDAttribute Class Reference

Inheritance diagram for sspmod_saml_Auth_Process_NameIDAttribute:

Collaboration diagram for sspmod_saml_Auth_Process_NameIDAttribute:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...
	process (&$state)
	Convert NameID to attribute. 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	parseFormat ($format)
	Parse a NameID format string into an array. More...

Private Attributes
	$attribute
	$format

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

Detailed Description

Definition at line 9 of file NameIDAttribute.php.

Constructor & Destructor Documentation

__construct()

sspmod_saml_Auth_Process_NameIDAttribute::__construct	(		$config,
			$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Definition at line 34 of file NameIDAttribute.php.

References $config, and $format.

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

        if (isset($config['attribute'])) {
            $this->attribute = (string) $config['attribute'];
        } else {
            $this->attribute = 'nameid';
        }

        if (isset($config['format'])) {
            $format = (string) $config['format'];
        } else {
            $format = '%I!%S!%V';
        }

        $this->format = self::parseFormat($format);
    }

Member Function Documentation

parseFormat()

static sspmod_saml_Auth_Process_NameIDAttribute::parseFormat (   $format )

staticprivate

Parse a NameID format string into an array.

Parameters

string

$format

The format string.

Returns

array The format string broken into its individual components.

Exceptions

SimpleSAML_Error_Exception

if the replacement is invalid.

Definition at line 63 of file NameIDAttribute.php.

References $format, and $ret.

    {
        assert(is_string($format));

        $ret = array();
        $pos = 0;
        while (($next = strpos($format, '%', $pos)) !== false) {
            $ret[] = substr($format, $pos, $next - $pos);

            $replacement = $format[$next + 1];
            switch ($replacement) {
                case 'F':
                    $ret[] = 'Format';
                    break;
                case 'I':
                    $ret[] = 'NameQualifier';
                    break;
                case 'S':
                    $ret[] = 'SPNameQualifier';
                    break;
                case 'V':
                    $ret[] = 'value';
                    break;
                case '%':
                    $ret[] = '%';
                    break;
                default:
                    throw new SimpleSAML_Error_Exception('NameIDAttribute: Invalid replacement: "%'.$replacement.'"');
            }

            $pos = $next + 2;
        }
        $ret[] = substr($format, $pos);

        return $ret;
    }

process()

sspmod_saml_Auth_Process_NameIDAttribute::process

(

&

$state

)

Convert NameID to attribute.

Parameters

array

&$state

The request state.

Definition at line 106 of file NameIDAttribute.php.

References $attribute, $state, and SAML2\Constants\NAMEID_UNSPECIFIED.

    {
        assert(is_array($state));
        assert(isset($state['Source']['entityid']));
        assert(isset($state['Destination']['entityid']));

        if (!isset($state['saml:sp:NameID'])) {
            return;
        }

        $rep = $state['saml:sp:NameID'];
        assert(isset($rep->value));

        $rep->{'%'} = '%';
        if (!isset($rep->Format)) {
            $rep->Format = \SAML2\Constants::NAMEID_UNSPECIFIED;
        }
        if (!isset($rep->NameQualifier)) {
            $rep->NameQualifier = $state['Source']['entityid'];
        }
        if (!isset($rep->SPNameQualifier)) {
            $rep->SPNameQualifier = $state['Destination']['entityid'];
        }

        $value = '';
        $isString = true;
        foreach ($this->format as $element) {
            if ($isString) {
                $value .= $element;
            } else {
                $value .= $rep->$element;
            }
            $isString = !$isString;
        }

        $state['Attributes'][$this->attribute] = array($value);
    }

Field Documentation

$attribute

sspmod_saml_Auth_Process_NameIDAttribute::$attribute

private

Definition at line 17 of file NameIDAttribute.php.

Referenced by process().

$format

sspmod_saml_Auth_Process_NameIDAttribute::$format

private

Definition at line 25 of file NameIDAttribute.php.

Referenced by __construct(), and parseFormat().

---

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

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