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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
|
<?php
declare(strict_types=1);
namespace SimpleSAML\Module\core\Auth\Process;
use SimpleSAML\Configuration;
use SimpleSAML\Logger;
/**
* Retrieve a scope from a source attribute and add it as a virtual target
* attribute.
*
* For instance, add the following to $simplesamldir/config.php, entry
* authproc.sp
*
* 51 => array(
* 'class' => 'core:ScopeFromAttribute',
* 'sourceAttribute' => 'eduPersonPrincipalName',
* 'targetAttribute' => 'scope',
* ),
*
* to add a virtual 'scope' attribute from the eduPersonPrincipalName
* attribute.
*/
class ScopeFromAttribute extends \SimpleSAML\Auth\ProcessingFilter
{
/**
* The attribute where the scope is taken from
*
* @var string
*/
private $sourceAttribute;
/**
* The name of the attribute which includes the scope
*
* @var string
*/
private $targetAttribute;
/**
* 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));
$cfg = Configuration::loadFromArray($config, 'ScopeFromAttribute');
$this->targetAttribute = $cfg->getString('targetAttribute');
$this->sourceAttribute = $cfg->getString('sourceAttribute');
}
/**
* Apply this filter.
*
* @param array &$request The current request
* @return void
*/
public function process(&$request)
{
assert(is_array($request));
assert(array_key_exists('Attributes', $request));
$attributes = &$request['Attributes'];
if (!isset($attributes[$this->sourceAttribute])) {
return;
}
// will not overwrite existing attribute
if (isset($attributes[$this->targetAttribute])) {
return;
}
$sourceAttrVal = $attributes[$this->sourceAttribute][0];
/* the last position of an @ is usually the beginning of the
* scope string
*/
$scopeIndex = strrpos($sourceAttrVal, '@');
if ($scopeIndex !== false) {
$attributes[$this->targetAttribute] = [];
$scope = substr($sourceAttrVal, $scopeIndex + 1);
$attributes[$this->targetAttribute][] = $scope;
Logger::debug(
'ScopeFromAttribute: Inserted new attribute ' . $this->targetAttribute . ', with scope ' . $scope
);
} else {
Logger::warning('ScopeFromAttribute: The configured source attribute ' . $this->sourceAttribute
. ' does not have a scope. Did not add attribute ' . $this->targetAttribute . '.');
}
}
}
|