Skip to content
Snippets Groups Projects
Commit a72da2e3 authored by Jaime Perez Crespo's avatar Jaime Perez Crespo
Browse files

Reformat sspmod_saml_Auth_Process_PersistentNameID and fix some phpdoc comments.

parent 83e18ffb
No related branches found
No related tags found
No related merge requests found
<?php <?php
/** /**
* Authproc filter to generate a persistent NameID. * Authentication processing filter to generate a persistent NameID.
* *
* @package simpleSAMLphp * @package SimpleSAMLphp
*/ */
class sspmod_saml_Auth_Process_PersistentNameID extends sspmod_saml_BaseNameIDGenerator { class sspmod_saml_Auth_Process_PersistentNameID extends sspmod_saml_BaseNameIDGenerator
{
/**
* Which attribute contains the unique identifier of the user.
*
* @var string
*/
private $attribute;
/**
* Which attribute contains the unique identifier of the user.
*
* @var string
*/
private $attribute;
/**
* Initialize this filter, parse configuration.
*
* @param array $config Configuration information about this filter.
* @param mixed $reserved For future use.
*/
public function __construct($config, $reserved) {
parent::__construct($config, $reserved);
assert('is_array($config)');
$this->format = SAML2_Const::NAMEID_PERSISTENT; /**
* Initialize this filter, parse configuration.
*
* @param array $config Configuration information about this filter.
* @param mixed $reserved For future use.
*
* @throws SimpleSAML_Error_Exception If the required option 'attribute' is missing.
*/
public function __construct($config, $reserved)
{
parent::__construct($config, $reserved);
assert('is_array($config)');
if (!isset($config['attribute'])) { $this->format = SAML2_Const::NAMEID_PERSISTENT;
throw new SimpleSAML_Error_Exception('PersistentNameID: Missing required option \'attribute\'.');
}
$this->attribute = $config['attribute'];
}
if (!isset($config['attribute'])) {
throw new SimpleSAML_Error_Exception("PersistentNameID: Missing required option 'attribute'.");
}
$this->attribute = $config['attribute'];
}
/**
* Get the NameID value.
*
* @return string|NULL The NameID value.
*/
protected function getValue(array &$state) {
if (!isset($state['Destination']['entityid'])) { /**
SimpleSAML_Logger::warning('No SP entity ID - not generating persistent NameID.'); * Get the NameID value.
return NULL; *
} * @param array $state The state array.
$spEntityId = $state['Destination']['entityid']; * @return string|null The NameID value.
*/
protected function getValue(array &$state)
{
if (!isset($state['Source']['entityid'])) { if (!isset($state['Destination']['entityid'])) {
SimpleSAML_Logger::warning('No IdP entity ID - not generating persistent NameID.'); SimpleSAML_Logger::warning('No SP entity ID - not generating persistent NameID.');
return NULL; return null;
} }
$idpEntityId = $state['Source']['entityid']; $spEntityId = $state['Destination']['entityid'];
if (!isset($state['Attributes'][$this->attribute]) || count($state['Attributes'][$this->attribute]) === 0) { if (!isset($state['Source']['entityid'])) {
SimpleSAML_Logger::warning('Missing attribute ' . var_export($this->attribute, TRUE) . ' on user - not generating persistent NameID.'); SimpleSAML_Logger::warning('No IdP entity ID - not generating persistent NameID.');
return NULL; return null;
} }
if (count($state['Attributes'][$this->attribute]) > 1) { $idpEntityId = $state['Source']['entityid'];
SimpleSAML_Logger::warning('More than one value in attribute ' . var_export($this->attribute, TRUE) . ' on user - not generating persistent NameID.');
return NULL;
}
$uid = array_values($state['Attributes'][$this->attribute]); /* Just in case the first index is no longer 0. */
$uid = $uid[0];
$secretSalt = SimpleSAML\Utils\Config::getSecretSalt(); if (!isset($state['Attributes'][$this->attribute]) || count($state['Attributes'][$this->attribute]) === 0) {
SimpleSAML_Logger::warning(
'Missing attribute '.var_export($this->attribute, true).
' on user - not generating persistent NameID.'
);
return null;
}
if (count($state['Attributes'][$this->attribute]) > 1) {
SimpleSAML_Logger::warning(
'More than one value in attribute '.var_export($this->attribute, true).
' on user - not generating persistent NameID.'
);
return null;
}
$uid = array_values($state['Attributes'][$this->attribute]); // just in case the first index is no longer 0
$uid = $uid[0];
$uidData = 'uidhashbase' . $secretSalt; $secretSalt = SimpleSAML\Utils\Config::getSecretSalt();
$uidData .= strlen($idpEntityId) . ':' . $idpEntityId;
$uidData .= strlen($spEntityId) . ':' . $spEntityId;
$uidData .= strlen($uid) . ':' . $uid;
$uidData .= $secretSalt;
return sha1($uidData); $uidData = 'uidhashbase'.$secretSalt;
} $uidData .= strlen($idpEntityId).':'.$idpEntityId;
$uidData .= strlen($spEntityId).':'.$spEntityId;
$uidData .= strlen($uid).':'.$uid;
$uidData .= $secretSalt;
return sha1($uidData);
}
} }
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment