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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<?php
declare(strict_types=1);
namespace SimpleSAML\Module\core\Auth\Process;
use SimpleSAML\Error;
use SimpleSAML\Logger;
/**
* A filter for limiting which attributes are passed on.
*
* @author Olav Morken, UNINETT AS.
* @package SimpleSAMLphp
*/
class AttributeLimit extends \SimpleSAML\Auth\ProcessingFilter
{
/**
* List of attributes which this filter will allow through.
* @var array
*/
private $allowedAttributes = [];
/**
* Whether the 'attributes' option in the metadata takes precedence.
*
* @var bool
*/
private $isDefault = false;
/**
* Initialize this filter.
*
* @param array &$config Configuration information about this filter.
* @param mixed $reserved For future use
* @throws \SimpleSAML\Error\Exception If invalid configuration is found.
*/
public function __construct(&$config, $reserved)
{
parent::__construct($config, $reserved);
assert(is_array($config));
foreach ($config as $index => $value) {
if ($index === 'default') {
$this->isDefault = (bool) $value;
} elseif (is_int($index)) {
if (!is_string($value)) {
throw new Error\Exception('AttributeLimit: Invalid attribute name: ' .
var_export($value, true));
}
$this->allowedAttributes[] = $value;
} elseif (is_string($index)) {
if (!is_array($value)) {
throw new Error\Exception('AttributeLimit: Values for ' .
var_export($index, true) . ' must be specified in an array.');
}
$this->allowedAttributes[$index] = $value;
} else {
throw new Error\Exception('AttributeLimit: Invalid option: ' . var_export($index, true));
}
}
}
/**
* Get list of allowed from the SP/IdP config.
*
* @param array &$request The current request.
* @return array|null Array with attribute names, or NULL if no limit is placed.
*/
private static function getSPIdPAllowed(array &$request): ?array
{
if (array_key_exists('attributes', $request['Destination'])) {
// SP Config
return $request['Destination']['attributes'];
}
if (array_key_exists('attributes', $request['Source'])) {
// IdP Config
return $request['Source']['attributes'];
}
return null;
}
/**
* Apply filter to remove attributes.
*
* Removes all attributes which aren't one of the allowed attributes.
*
* @param array &$request The current request
* @throws \SimpleSAML\Error\Exception If invalid configuration is found.
* @return void
*/
public function process(&$request)
{
assert(is_array($request));
assert(array_key_exists('Attributes', $request));
if ($this->isDefault) {
$allowedAttributes = self::getSPIdPAllowed($request);
if ($allowedAttributes === null) {
$allowedAttributes = $this->allowedAttributes;
}
} elseif (!empty($this->allowedAttributes)) {
$allowedAttributes = $this->allowedAttributes;
} else {
$allowedAttributes = self::getSPIdPAllowed($request);
if ($allowedAttributes === null) {
// No limit on attributes
return;
}
}
$attributes = &$request['Attributes'];
foreach ($attributes as $name => $values) {
if (!in_array($name, $allowedAttributes, true)) {
// the attribute name is not in the array of allowed attributes
if (array_key_exists($name, $allowedAttributes)) {
// but it is an index of the array
if (!is_array($allowedAttributes[$name])) {
throw new Error\Exception('AttributeLimit: Values for ' .
var_export($name, true) . ' must be specified in an array.');
}
$attributes[$name] = $this->filterAttributeValues($attributes[$name], $allowedAttributes[$name]);
if (!empty($attributes[$name])) {
continue;
}
}
unset($attributes[$name]);
}
}
}
/**
* Perform the filtering of attributes
* @param array $values The current values for a given attribute
* @param array $allowedConfigValues The allowed values, and possibly configuration options.
* @return array The filtered values
*/
private function filterAttributeValues(array $values, array $allowedConfigValues): array
{
if (array_key_exists('regex', $allowedConfigValues) && $allowedConfigValues['regex'] === true) {
$matchedValues = [];
foreach ($allowedConfigValues as $option => $pattern) {
if (!is_int($option)) {
// Ignore any configuration options in $allowedConfig. e.g. regex=>true
continue;
}
foreach ($values as $index => $attributeValue) {
/* Suppress errors in preg_match since phpunit is set to fail on warnings, which
* prevents us from testing with invalid regex.
*/
$regexResult = @preg_match($pattern, $attributeValue);
if ($regexResult === false) {
Logger::warning("Error processing regex '$pattern' on value '$attributeValue'");
break;
} elseif ($regexResult === 1) {
$matchedValues[] = $attributeValue;
// Remove matched value incase a subsequent regex also matches it.
unset($values[$index]);
}
}
}
return $matchedValues;
} elseif (array_key_exists('ignoreCase', $allowedConfigValues) && $allowedConfigValues['ignoreCase'] === true) {
unset($allowedConfigValues['ignoreCase']);
return array_uintersect($values, $allowedConfigValues, "strcasecmp");
}
// The not true values for these options shouldn't leak through to array_intersect
unset($allowedConfigValues['ignoreCase']);
unset($allowedConfigValues['regex']);
return array_intersect($values, $allowedConfigValues);
}
}
|
