1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
|
<?php
/**
* Authentication processing filter to create a NameID from an attribute.
*
* @package SimpleSAMLphp
*/
class sspmod_saml_Auth_Process_AttributeNameID extends sspmod_saml_BaseNameIDGenerator
{
/**
* The attribute we should use as the NameID.
*
* @var string
*/
private $attribute;
/**
* 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 options 'Format' or 'attribute' are missing.
*/
public function __construct($config, $reserved)
{
parent::__construct($config, $reserved);
assert('is_array($config)');
if (!isset($config['Format'])) {
throw new SimpleSAML_Error_Exception("AttributeNameID: Missing required option 'Format'.");
}
$this->format = (string) $config['Format'];
if (!isset($config['attribute'])) {
throw new SimpleSAML_Error_Exception("AttributeNameID: Missing required option 'attribute'.");
}
$this->attribute = (string) $config['attribute'];
}
/**
* Get the NameID value.
*
* @param array $state The state array.
* @return string|null The NameID value.
*/
protected function getValue(array &$state)
{
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 attribute 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 attribute NameID.'
);
return null;
}
$value = array_values($state['Attributes'][$this->attribute]); // just in case the first index is no longer 0
$value = $value[0];
if (empty($value)) {
SimpleSAML\Logger::warning(
'Empty value in attribute '.var_export($this->attribute, true).
' on user - not generating persistent NameID.'
);
return null;
}
return $value;
}
}
|