sspmod_core_Auth_Process_AttributeMap Class Reference

Inheritance diagram for sspmod_core_Auth_Process_AttributeMap:

Collaboration diagram for sspmod_core_Auth_Process_AttributeMap:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter, parse configuration. More...
	process (&$request)
	Apply filter to rename attributes. 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 Member Functions
	loadMapFile ($fileName)
	Loads and merges in a file with a attribute map. More...

Private Attributes
	$map = array()
	Associative array with the mappings of attribute names. More...
	$duplicate = false
	Should attributes be duplicated or renamed. More...

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

Detailed Description

Definition at line 10 of file AttributeMap.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_AttributeMap::__construct	(		$config,
			$reserved
	)

Initialize this filter, parse configuration.

Parameters

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

Exceptions

Exception

If the configuration of the filter is wrong.

Definition at line 32 of file AttributeMap.php.

References $config, and loadMapFile().

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

        assert(is_array($config));
        $mapFiles = array();

        foreach ($config as $origName => $newName) {
            if (is_int($origName)) {
                if ($newName === '%duplicate') {
                    $this->duplicate = true;
                } else {
                    // no index given, this is a map file
                    $mapFiles[] = $newName;
                }
                continue;
            }

            if (!is_string($origName)) {
                throw new Exception('Invalid attribute name: '.var_export($origName, true));
            }

            if (!is_string($newName) && !is_array($newName)) {
                throw new Exception('Invalid attribute name: '.var_export($newName, true));
            }

            $this->map[$origName] = $newName;
        }

        // load map files after we determine duplicate or rename
        foreach ($mapFiles as &$file) {
            $this->loadMapFile($file);
        }
    }

Here is the call graph for this function:

Member Function Documentation

loadMapFile()

sspmod_core_Auth_Process_AttributeMap::loadMapFile (   $fileName )

private

Loads and merges in a file with a attribute map.

Parameters

string

$fileName

Name of attribute map file. Expected to be in the attributemap directory in the root of the SimpleSAMLphp installation, or in the root of a module.

Exceptions

Exception

If the filter could not load the requested attribute map file.

Definition at line 76 of file AttributeMap.php.

References $attributemap, $config, $m, SimpleSAML_Configuration\getInstance(), and SimpleSAML\Module\getModuleDir().

Referenced by __construct().

    {
        $config = SimpleSAML_Configuration::getInstance();

        $m = explode(':', $fileName);
        if (count($m) === 2) { // we are asked for a file in a module
            if (!SimpleSAML\Module::isModuleEnabled($m[0])) {
                throw new Exception("Module '$m[0]' is not enabled.");
            }
            $filePath = SimpleSAML\Module::getModuleDir($m[0]).'/attributemap/'.$m[1].'.php';
        } else {
            $filePath = $config->getPathValue('attributenamemapdir', 'attributemap/').$fileName.'.php';
        }

        if (!file_exists($filePath)) {
            throw new Exception('Could not find attribute map file: '.$filePath);
        }

        $attributemap = null;
        include($filePath);
        if (!is_array($attributemap)) {
            throw new Exception('Attribute map file "'.$filePath.'" didn\'t define an attribute map.');
        }

        if ($this->duplicate) {
            $this->map = array_merge_recursive($this->map, $attributemap);
        } else {
            $this->map = array_merge($this->map, $attributemap);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

process()

sspmod_core_Auth_Process_AttributeMap::process

(

&

$request

)

Apply filter to rename attributes.

Parameters

array

&$request

The current request.

Definition at line 113 of file AttributeMap.php.

References $name, $request, and $values.

    {
        assert(is_array($request));
        assert(array_key_exists('Attributes', $request));

        $mapped_attributes = array();

        foreach ($request['Attributes'] as $name => $values) {
            if (array_key_exists($name, $this->map)) {
                if (!is_array($this->map[$name])) {
                    if ($this->duplicate) {
                        $mapped_attributes[$name] = $values;
                    }
                    $mapped_attributes[$this->map[$name]] = $values;
                } else {
                    foreach ($this->map[$name] as $to_map) {
                        $mapped_attributes[$to_map] = $values;
                    }
                    if ($this->duplicate && !in_array($name, $this->map[$name], true)) {
                        $mapped_attributes[$name] = $values;
                    }
                }
            } else {
                $mapped_attributes[$name] = $values;
            }
        }

        $request['Attributes'] = $mapped_attributes;
    }

Field Documentation

$duplicate

sspmod_core_Auth_Process_AttributeMap::$duplicate = false

private

Should attributes be duplicated or renamed.

Definition at line 21 of file AttributeMap.php.

$map

sspmod_core_Auth_Process_AttributeMap::$map = array()

private

Associative array with the mappings of attribute names.

Definition at line 16 of file AttributeMap.php.

---

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

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