Retrieve a scope from a source attribute and add it as a virtual target attribute. More...

Inheritance diagram for sspmod_core_Auth_Process_ScopeFromAttribute:

Collaboration diagram for sspmod_core_Auth_Process_ScopeFromAttribute:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...

	process (&$request)
	Apply this filter. More...

Public Member Functions inherited from SimpleSAML_Auth_ProcessingFilter
	__construct (&$config, $reserved)
	Constructor for a processing filter. More...

	process (&$request)
	Process a request. More...

Private Attributes
	$sourceAttribute

	$targetAttribute

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

Detailed Description

Retrieve a scope from a source attribute and add it as a virtual target attribute.

For instance, add the following to $simplesamldir/config.php, entry authproc.sp

51 => array( 'class' => 'core:ScopeFromAttribute', 'sourceAttribute' => 'eduPersonPrincipalName', 'targetAttribute' => 'scope', ),

to add a virtual 'scope' attribute from the eduPersonPrincipalName attribute.

Definition at line 19 of file ScopeFromAttribute.php.

Constructor & Destructor Documentation

◆ __construct()

sspmod_core_Auth_Process_ScopeFromAttribute::__construct	(	$config,
		$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Definition at line 39 of file ScopeFromAttribute.php.

References $config, and SimpleSAML_Configuration\loadFromArray().

                                                         {
                 parent::__construct($config, $reserved);
                 assert(is_array($config));
 
                 $config = SimpleSAML_Configuration::loadFromArray($config, 'ScopeFromAttribute');
                 $this->targetAttribute = $config->getString('targetAttribute');
                 $this->sourceAttribute = $config->getString('sourceAttribute');
         } // end constructor

Here is the call graph for this function:

Member Function Documentation

◆ process()

sspmod_core_Auth_Process_ScopeFromAttribute::process ( & $request )

Apply this filter.

Parameters

array &$request The current request

Definition at line 54 of file ScopeFromAttribute.php.

References $attributes, $request, $sourceAttribute, $targetAttribute, SimpleSAML\Logger\debug(), and SimpleSAML\Logger\warning().

                                            {
                 assert(is_array($request));
                 assert(array_key_exists('Attributes', $request));
 
                 $attributes =& $request['Attributes'];
 
                 if (!isset($attributes[$this->sourceAttribute])) {
                         return;
                 }
 
                 // will not overwrite existing attribute
                 if (isset($attributes[$this->targetAttribute])) {
                         return;
                 }
 
                 $sourceAttrVal = $attributes[$this->sourceAttribute][0];
 
                 /* the last position of an @ is usually the beginning of the scope
                  * string */
                 $scopeIndex = strrpos($sourceAttrVal, '@');
 
                 if ($scopeIndex !== FALSE) {
                         $attributes[$this->targetAttribute] = array();
                         $scope = substr($sourceAttrVal, $scopeIndex+1);
                         $attributes[$this->targetAttribute][] = $scope;
                         SimpleSAML\Logger::debug('ScopeFromAttribute: Inserted new attribute ' .
                                                  $this->targetAttribute . ', with scope ' .
                                                  $scope);
                 } else {
                         SimpleSAML\Logger::warning('ScopeFromAttribute: The configured source attribute ' .
                                                    $this->sourceAttribute .
                                                    ' does not have a scope. Did not add attribute ' .
                                                    $this->targetAttribute . '.');
                 }
         } /* end process */

Here is the call graph for this function:

Field Documentation

◆ $sourceAttribute

sspmod_core_Auth_Process_ScopeFromAttribute::$sourceAttribute

private

Definition at line 25 of file ScopeFromAttribute.php.

Referenced by process().

◆ $targetAttribute

sspmod_core_Auth_Process_ScopeFromAttribute::$targetAttribute

private

Definition at line 31 of file ScopeFromAttribute.php.

Referenced by process().

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

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

Public Member Functions

Private Attributes

Additional Inherited Members