sspmod_smartattributes_Auth_Process_SmartID Class Reference

Inheritance diagram for sspmod_smartattributes_Auth_Process_SmartID:

Collaboration diagram for sspmod_smartattributes_Auth_Process_SmartID:

Public Member Functions
	__construct ($config, $reserved)
	process (&$request)
	Apply filter to add or replace 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
	addID ($attributes, $request)

Private Attributes
	$_candidates
	Which attributes to use as identifiers? More...
	$_id_attribute = 'smart_id'
	The name of the generated ID attribute. More...
	$_add_authority = true
	Whether to append the AuthenticatingAuthority, separated by '!' This only works when SSP is used as a gateway. More...
	$_add_candidate = true
	Whether to prepend the CandidateID, separated by ':'. More...
	$attributes = array()
	Attributes which should be added/appended. More...

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

Detailed Description

Definition at line 3 of file SmartID.php.

Constructor & Destructor Documentation

__construct()

sspmod_smartattributes_Auth_Process_SmartID::__construct	(		$config,
			$reserved
	)

Definition at line 46 of file SmartID.php.

    {
        parent::__construct($config, $reserved);
 
        assert(is_array($config));
 
        if (array_key_exists('candidates', $config)) {
            $this->_candidates = $config['candidates'];
            if (!is_array($this->_candidates)) {
                throw new Exception('SmartID authproc configuration error: \'candidates\' should be an array.');
            }
        }
 
        if (array_key_exists('id_attribute', $config)) {
            $this->_id_attribute = $config['id_attribute'];
            if (!is_string($this->_id_attribute)) {
                throw new Exception('SmartID authproc configuration error: \'id_attribute\' should be a string.');
            }
        }
 
        if (array_key_exists('add_authority', $config)) {
            $this->_add_authority = $config['add_authority'];
            if (!is_bool($this->_add_authority)) {
                throw new Exception('SmartID authproc configuration error: \'add_authority\' should be a boolean.');
            }
        }
 
        if (array_key_exists('add_candidate', $config)) {
            $this->_add_candidate = $config['add_candidate'];
            if (!is_bool($this->_add_candidate)) {
                throw new Exception('SmartID authproc configuration error: \'add_candidate\' should be a boolean.');
            }
        }
    }

References $config.

Member Function Documentation

addID()

sspmod_smartattributes_Auth_Process_SmartID::addID (   $attributes,   $request  )

private

Definition at line 81 of file SmartID.php.

    {
        $state = $request['saml:sp:State'];
        foreach ($this->_candidates as $idCandidate) {
            if (isset($attributes[$idCandidate][0])) {
                if (($this->_add_authority) && (isset($state['saml:AuthenticatingAuthority'][0]))) {
                    return ($this->_add_candidate ? $idCandidate.':' : '').$attributes[$idCandidate][0].'!'.$state['saml:AuthenticatingAuthority'][0];
                } else {
                    return ($this->_add_candidate ? $idCandidate.':' : '').$attributes[$idCandidate][0];
                }
            }
        }
        /*
         * At this stage no usable id_candidate has been detected.
         */
        throw new SimpleSAML_Error_Exception('This service needs at least one of the following
            attributes to identity users: '.implode(', ', $this->_candidates).'. Unfortunately not
            one of them was detected. Please ask your institution administrator to release one of
            them, or try using another identity provider.');
    }

References $attributes, $request, and $state.

Referenced by process().

Here is the caller graph for this function:

process()

sspmod_smartattributes_Auth_Process_SmartID::process

(

&

$request

)

Apply filter to add or replace attributes.

Add or replace existing attributes with the configured values.

Parameters

array

&$request

The current request

Reimplemented from SimpleSAML_Auth_ProcessingFilter.

Definition at line 109 of file SmartID.php.

    {
        assert(is_array($request));
        assert(array_key_exists('Attributes', $request));
 
        $id = $this->addID($request['Attributes'], $request);
 
        if (isset($id)) {
            $request['Attributes'][$this->_id_attribute] = array($id);
        }
    }

References $_id_attribute, $id, $request, and addID().

Here is the call graph for this function:

Field Documentation

$_add_authority

sspmod_smartattributes_Auth_Process_SmartID::$_add_authority = true

private

Whether to append the AuthenticatingAuthority, separated by '!' This only works when SSP is used as a gateway.

Definition at line 31 of file SmartID.php.

$_add_candidate

sspmod_smartattributes_Auth_Process_SmartID::$_add_candidate = true

private

Whether to prepend the CandidateID, separated by ':'.

Definition at line 36 of file SmartID.php.

$_candidates

sspmod_smartattributes_Auth_Process_SmartID::$_candidates

private

Initial value:

= array(
        'eduPersonTargetedID',
        'eduPersonPrincipalName',
        'openid',
        'facebook_targetedID',
        'twitter_targetedID',
        'windowslive_targetedID',
        'linkedin_targetedID',
    )

Which attributes to use as identifiers?

IMPORTANT: If you use the (default) attributemaps (twitter2name, facebook2name, etc., be sure to comment out the entries that map xxx_targetedID to eduPersonTargetedID, or there will be no way to see its origin any more.

Definition at line 12 of file SmartID.php.

$_id_attribute

sspmod_smartattributes_Auth_Process_SmartID::$_id_attribute = 'smart_id'

private

The name of the generated ID attribute.

Definition at line 25 of file SmartID.php.

Referenced by process().

$attributes

sspmod_smartattributes_Auth_Process_SmartID::$attributes = array()

private

Attributes which should be added/appended.

Associative array of arrays.

Definition at line 43 of file SmartID.php.

Referenced by addID().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/smartattributes/lib/Auth/Process/SmartID.php