sspmod_core_Auth_Process_GenerateGroups Class Reference

Inheritance diagram for sspmod_core_Auth_Process_GenerateGroups:

Collaboration diagram for sspmod_core_Auth_Process_GenerateGroups:

Public Member Functions
	__construct ($config, $reserved)
	Initialize this filter. More...
	process (&$request)
	Apply filter to add groups 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	getRealm ($attributes)
	Determine which realm the user belongs to. More...
static	escapeIllegalChars ($string)
	Escape special characters in a string. More...

Private Attributes
	$generateGroupsFrom
	The attributes we should generate groups from. More...

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 GenerateGroups.php.

Constructor & Destructor Documentation

__construct()

sspmod_core_Auth_Process_GenerateGroups::__construct	(		$config,
			$reserved
	)

Initialize this filter.

Parameters

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

Definition at line 24 of file GenerateGroups.php.

                                                        {
                parent::__construct($config, $reserved);
 
                assert(is_array($config));
 
                if (count($config) === 0) {
                        // Use default groups
                        $this->generateGroupsFrom = array(
                                'eduPersonAffiliation',
                                'eduPersonOrgUnitDN',
                                'eduPersonEntitlement',
                        );
 
                } else {
                        // Validate configuration
                        foreach ($config as $attributeName) {
                                if (!is_string($attributeName)) {
                                        throw new Exception('Invalid attribute name for core:GenerateGroups filter: ' .
                                                var_export($attributeName, TRUE));
                                }
                        }
 
                        $this->generateGroupsFrom = $config;
                }
        }

References $config.

Member Function Documentation

escapeIllegalChars()

static sspmod_core_Auth_Process_GenerateGroups::escapeIllegalChars (   $string )

staticprivate

Escape special characters in a string.

This function is similar to urlencode, but encodes many more characters. This function takes any characters not in [a-zA-Z0-9_=.] and encodes them with as %<hex version>. For example, it will encode '+' as '%2b' and '' as '%25'.

Parameters

string

$string

The string which should be escaped.

Returns

string The escaped string.

Definition at line 134 of file GenerateGroups.php.

                                                            {
                assert(is_string($string));
 
                return preg_replace_callback('/([^a-zA-Z0-9_@=.])/',
                        function ($m) { return sprintf("%%%02x", ord($m[1])); },
                        $string);
        }

getRealm()

static sspmod_core_Auth_Process_GenerateGroups::getRealm (   $attributes )

staticprivate

Determine which realm the user belongs to.

This function will attempt to determine the realm a user belongs to based on the eduPersonPrincipalName attribute if it is present. If it isn't, or if it doesn't contain a realm, NULL will be returned.

Parameters

array

$attributes

The attributes of the user.

Returns

string|NULL The realm of the user, or NULL if we are unable to determine the realm.

Definition at line 101 of file GenerateGroups.php.

                                                      {
                assert(is_array($attributes));
 
                if (!array_key_exists('eduPersonPrincipalName', $attributes)) {
                        return NULL;
                }
                $eppn = $attributes['eduPersonPrincipalName'];
 
                if (count($eppn) < 1) {
                        return NULL;
                }
                $eppn = $eppn[0];
 
                $realm = explode('@', $eppn, 2);
                if (count($realm) < 2) {
                        return NULL;
                }
                $realm = $realm[1];
 
                return self::escapeIllegalChars($realm);
        }

Referenced by process().

Here is the caller graph for this function:

process()

sspmod_core_Auth_Process_GenerateGroups::process

(

&

$request

)

Apply filter to add groups attribute.

Parameters

array

&$request

The current request

Reimplemented from SimpleSAML_Auth_ProcessingFilter.

Definition at line 56 of file GenerateGroups.php.

                                           {
                assert(is_array($request));
                assert(array_key_exists('Attributes', $request));
 
                $groups = array();
                $attributes =& $request['Attributes'];
 
                $realm = self::getRealm($attributes);
                if ($realm !== NULL) {
                        $groups[] = 'realm-' . $realm;
                }
 
 
                foreach ($this->generateGroupsFrom as $name) {
                        if (!array_key_exists($name, $attributes)) {
                                SimpleSAML\Logger::debug('GenerateGroups - attribute \'' . $name . '\' not found.');
                                /* Attribute not present. */
                                continue;
                        }
 
                        foreach ($attributes[$name] as $value) {
                                $value = self::escapeIllegalChars($value);
                                $groups[] = $name . '-' . $value;
                                if ($realm !== NULL) {
                                        $groups[] = $name . '-' . $realm . '-' . $value;
                                }
                        }
                }
 
                if (count($groups) > 0) {
                        $attributes['groups'] = $groups;
                }
        }

References $attributes, $name, $request, SimpleSAML\Logger\debug(), and getRealm().

Here is the call graph for this function:

Field Documentation

$generateGroupsFrom

sspmod_core_Auth_Process_GenerateGroups::$generateGroupsFrom

private

The attributes we should generate groups from.

Definition at line 15 of file GenerateGroups.php.

---

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

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