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
|
<?php
namespace SimpleSAML\Module\authorize\Auth\Process;
use SimpleSAML\Auth\State;
use SimpleSAML\Module;
use SimpleSAML\Utils\Arrays;
use SimpleSAML\Utils\HTTP;
use SimpleSAML\Module\Authorize\Tests\Utils;
use Webmozart\Assert\Assert;
/**
* Filter to authorize only certain users.
* See docs directory.
*
* @author Ernesto Revilla, Yaco Sistemas SL., Ryan Panning
* @package SimpleSAMLphp
*/
class Authorize extends \SimpleSAML\Auth\ProcessingFilter
{
/**
* Flag to deny/unauthorize the user a attribute filter IS found
*
* @var bool
*/
protected $deny = false;
/**
* Flag to turn the REGEX pattern matching on or off
*
* @var bool
*/
protected $regex = true;
/**
* Array of localised rejection messages
*
* @var array
*/
protected $reject_msg = [];
/**
* Array of valid users. Each element is a regular expression. You should
* user \ to escape special chars, like '.' etc.
*
*/
protected $valid_attribute_values = [];
/**
* Initialize this filter.
* Validate configuration parameters.
*
* @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));
// Check for the deny option
// Must be bool specifically, if not, it might be for an attrib filter below
if (isset($config['deny']) && is_bool($config['deny'])) {
$this->deny = $config['deny'];
}
// Check for the regex option
// Must be bool specifically, if not, it might be for an attrib filter below
if (isset($config['regex']) && is_bool($config['regex'])) {
$this->regex = $config['regex'];
}
// Check for the reject_msg option; Must be array of languages
if (isset($config['reject_msg']) && is_array($config['reject_msg'])) {
$this->reject_msg = $config['reject_msg'];
}
// Remove all above options
unset($config['deny'], $config['regex'], $config['reject_msg']);
foreach ($config as $attribute => $values) {
if (is_string($values)) {
$values = Arrays::arrayize($values);
} else if (!is_array($values)) {
throw new \Exception(
'Filter Authorize: Attribute values is neither string nor array: '.var_export($attribute, true)
);
}
foreach ($values as $value) {
if (!is_string($value)) {
throw new \Exception(
'Filter Authorize: Each value should be a string for attribute: '.var_export($attribute, true).
' value: '.var_export($value, true).' Config is: '.var_export($config, true)
);
}
}
$this->valid_attribute_values[$attribute] = $values;
}
}
/**
* Apply filter to validate attributes.
*
* @param array &$request The current request
* @return void
*/
public function process(&$request)
{
assert(is_array($request));
assert(array_key_exists('Attributes', $request));
$authorize = $this->deny;
$attributes = &$request['Attributes'];
// Store the rejection message array in the $request
if (!empty($this->reject_msg)) {
$request['authprocAuthorize_reject_msg'] = $this->reject_msg;
}
foreach ($this->valid_attribute_values as $name => $patterns) {
if (array_key_exists($name, $attributes)) {
foreach ($patterns as $pattern) {
$values = Arrays::arrayize($attributes[$name]);
foreach ($values as $value) {
if ($this->regex) {
$matched = preg_match($pattern, $value);
} else {
$matched = ($value == $pattern);
}
if ($matched) {
$authorize = ($this->deny ? false : true);
break 3;
}
}
}
}
}
if (!$authorize) {
$this->unauthorized($request);
}
}
/**
* When the process logic determines that the user is not
* authorized for this service, then forward the user to
* an 403 unauthorized page.
*
* Separated this code into its own method so that child
* classes can override it and change the action. Forward
* thinking in case a "chained" ACL is needed, more complex
* permission logic.
*
* @param array $request
* @return void
*/
protected function unauthorized(array &$request)
{
// Save state and redirect to 403 page
$id = State::saveState($request, 'authorize:Authorize');
$url = Module::getModuleURL('authorize/authorize_403.php');
HTTP::redirectTrustedURL($url, ['StateId' => $id]);
}
}
|