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
|
<?php
use SimpleSAML\Utils\HTTPAdapter;
/**
* Filter to ensure correct cardinality of attributes
*
* @author Guy Halse, http://orcid.org/0000-0002-9388-8592
* @package SimpleSAMLphp
*/
class sspmod_core_Auth_Process_Cardinality extends SimpleSAML_Auth_ProcessingFilter
{
/** @var array Associative array with the mappings of attribute names. */
private $cardinality = array();
/** @var array Entities that should be ignored */
private $ignoreEntities = array();
/** @var HTTP */
private $http;
/**
* Initialize this filter, parse configuration.
*
* @param array $config Configuration information about this filter.
* @param mixed $reserved For future use.
* @param HTTPAdapter $http HTTP utility service (handles redirects).
* @throws SimpleSAML_Error_Exception
*/
public function __construct($config, $reserved, HTTPAdapter $http = null)
{
parent::__construct($config, $reserved);
assert(is_array($config));
$this->http = $http ?: new HTTPAdapter();
foreach ($config as $attribute => $rules) {
if ($attribute === '%ignoreEntities') {
$this->ignoreEntities = $config['%ignoreEntities'];
continue;
}
if (!is_string($attribute)) {
throw new SimpleSAML_Error_Exception('Invalid attribute name: '.var_export($attribute, true));
}
$this->cardinality[$attribute] = array('warn' => false);
/* allow either positional or name-based parameters */
if (isset($rules[0])) {
$this->cardinality[$attribute]['min'] = $rules[0];
} elseif (isset($rules['min'])) {
$this->cardinality[$attribute]['min'] = $rules['min'];
}
if (isset($rules[1])) {
$this->cardinality[$attribute]['max'] = $rules[1];
} elseif (isset($rules['max'])) {
$this->cardinality[$attribute]['max'] = $rules['max'];
}
if (array_key_exists('warn', $rules)) {
$this->cardinality[$attribute]['warn'] = (bool) $rules['warn'];
}
/* sanity check the rules */
if (!array_key_exists('min', $this->cardinality[$attribute])) {
$this->cardinality[$attribute]['min'] = 0;
} elseif (!is_int($this->cardinality[$attribute]['min']) ||
$this->cardinality[$attribute]['min'] < 0
) {
throw new SimpleSAML_Error_Exception('Minimum cardinality must be a positive integer: '.
var_export($attribute, true));
}
if (array_key_exists('max', $this->cardinality[$attribute]) &&
!is_int($this->cardinality[$attribute]['max'])
) {
throw new SimpleSAML_Error_Exception('Maximum cardinality must be a positive integer: '.
var_export($attribute, true));
}
if (array_key_exists('min', $this->cardinality[$attribute]) &&
array_key_exists('max', $this->cardinality[$attribute]) &&
$this->cardinality[$attribute]['min'] > $this->cardinality[$attribute]['max']
) {
throw new SimpleSAML_Error_Exception('Minimum cardinality must be less than maximium: '.
var_export($attribute, true));
}
/* generate a display expression */
$this->cardinality[$attribute]['_expr'] = sprintf('%d ≤ n', $this->cardinality[$attribute]['min']);
if (array_key_exists('max', $this->cardinality[$attribute])) {
$this->cardinality[$attribute]['_expr'] .= sprintf(' ≤ %d', $this->cardinality[$attribute]['max']);
}
}
}
/**
* Process this filter
*
* @param array &$request The current request
*/
public function process(&$request)
{
assert(is_array($request));
assert(array_key_exists("Attributes", $request));
$entityid = false;
if (array_key_exists('Source', $request) && array_key_exists('entityid', $request['Source'])) {
$entityid = $request['Source']['entityid'];
}
if (in_array($entityid, $this->ignoreEntities, true)) {
SimpleSAML\Logger::debug('Cardinality: Ignoring assertions from '.$entityid);
return;
}
foreach ($request['Attributes'] as $k => $v) {
if (!array_key_exists($k, $this->cardinality)) {
continue;
}
if (!is_array($v)) {
$v = array($v);
}
/* minimum cardinality */
if (count($v) < $this->cardinality[$k]['min']) {
if ($this->cardinality[$k]['warn']) {
SimpleSAML\Logger::warning(sprintf(
'Cardinality: attribute %s from %s does not meet minimum cardinality of %d (%d)',
$k, $entityid, $this->cardinality[$k]['min'], count($v)
));
} else {
$request['core:cardinality:errorAttributes'][$k] = array(count($v), $this->cardinality[$k]['_expr']);
}
continue;
}
/* maximum cardinality */
if (array_key_exists('max', $this->cardinality[$k]) && count($v) > $this->cardinality[$k]['max']) {
if ($this->cardinality[$k]['warn']) {
SimpleSAML\Logger::warning(sprintf(
'Cardinality: attribute %s from %s does not meet maximum cardinality of %d (%d)',
$k, $entityid, $this->cardinality[$k]['max'], count($v)
));
} else {
$request['core:cardinality:errorAttributes'][$k] = array(count($v), $this->cardinality[$k]['_expr']);
}
continue;
}
}
/* check for missing attributes with a minimum cardinality */
foreach ($this->cardinality as $k => $v) {
if (!$this->cardinality[$k]['min'] || array_key_exists($k, $request['Attributes'])) {
continue;
}
if ($this->cardinality[$k]['warn']) {
SimpleSAML\Logger::warning(sprintf(
'Cardinality: attribute %s from %s is missing',
$k, $entityid
));
} else {
$request['core:cardinality:errorAttributes'][$k] = array(0, $this->cardinality[$k]['_expr']);
}
}
/* abort if we found a problematic attribute */
if (array_key_exists('core:cardinality:errorAttributes', $request)) {
$id = SimpleSAML_Auth_State::saveState($request, 'core:cardinality');
$url = SimpleSAML\Module::getModuleURL('core/cardinality_error.php');
$this->http->redirectTrustedURL($url, array('StateId' => $id));
return;
}
}
}
|