|
| 1 | +<?php |
| 2 | +declare(strict_types=1); |
| 3 | + |
| 4 | +/** |
| 5 | + * Copyright 2010 - 2019, Cake Development Corporation (https://www.cakedc.com) |
| 6 | + * |
| 7 | + * Licensed under The MIT License |
| 8 | + * Redistributions of files must retain the above copyright notice. |
| 9 | + * |
| 10 | + * @copyright Copyright 2010 - 2019, Cake Development Corporation (https://www.cakedc.com) |
| 11 | + * @license MIT License (http://www.opensource.org/licenses/mit-license.php) |
| 12 | + */ |
| 13 | + |
| 14 | +namespace CakeDC\Auth\Rbac; |
| 15 | + |
| 16 | +use Cake\Cache\Cache; |
| 17 | +use Cake\Core\Configure; |
| 18 | +use Cake\Core\InstanceConfigTrait; |
| 19 | +use Cake\Log\LogTrait; |
| 20 | +use Cake\Utility\Hash; |
| 21 | +use Cake\Utility\Inflector; |
| 22 | +use CakeDC\Auth\Rbac\Permissions\AbstractProvider; |
| 23 | +use CakeDC\Auth\Rbac\PermissionMatchResult; |
| 24 | +use CakeDC\Auth\Rbac\Rules\Rule; |
| 25 | +use CakeDC\Auth\Rbac\Rules\RuleRegistry; |
| 26 | +use CakeDC\Auth\Rbac\RbacInterface; |
| 27 | +use Psr\Http\Message\ServerRequestInterface; |
| 28 | +use Psr\Log\LogLevel; |
| 29 | + |
| 30 | +/** |
| 31 | + * Class CachedRbac, determine if a request matches any of the given rbac rules |
| 32 | + * |
| 33 | + * @package Rbac |
| 34 | + */ |
| 35 | +class CachedRbac extends Rbac |
| 36 | +{ |
| 37 | + /** |
| 38 | + * A map of rules |
| 39 | + * |
| 40 | + * @var array[] rules array |
| 41 | + */ |
| 42 | + protected $permissionsMap = []; |
| 43 | + |
| 44 | + /** |
| 45 | + * An undasherize flag |
| 46 | + * |
| 47 | + * @var bool undasherize flag |
| 48 | + */ |
| 49 | + protected bool $undasherize = false; |
| 50 | + |
| 51 | + /** |
| 52 | + * Rbac constructor. |
| 53 | + * |
| 54 | + * @param array $config Class configuration |
| 55 | + */ |
| 56 | + public function __construct($config = []) |
| 57 | + { |
| 58 | + parent::__construct($config); |
| 59 | + if (isset($config['undasherize'])) { |
| 60 | + $this->undasherize = $config['undasherize']; |
| 61 | + } |
| 62 | + $this->permissionsMap = Cache::remember('auth_permissions', function () { |
| 63 | + return $this->buildPermissionsMap(); |
| 64 | + }, '_cakedc_auth_'); |
| 65 | + } |
| 66 | + |
| 67 | + /** |
| 68 | + * @return array |
| 69 | + */ |
| 70 | + public function getPermissions(): array |
| 71 | + { |
| 72 | + return $this->permissions; |
| 73 | + } |
| 74 | + |
| 75 | + /** |
| 76 | + * @return array |
| 77 | + */ |
| 78 | + public function buildPermissionsMap() |
| 79 | + { |
| 80 | + $asArray = function ($permission, $key, $default = null) { |
| 81 | + if ($default !== null && !array_key_exists($key, $permission)) { |
| 82 | + return [$default, '_']; |
| 83 | + } |
| 84 | + if (!array_key_exists($key, $permission) || $permission[$key] == false || $permission[$key] == null) { |
| 85 | + return ['_']; |
| 86 | + } |
| 87 | + $item = $permission[$key]; |
| 88 | + if (is_string($item)) { |
| 89 | + return [$item]; |
| 90 | + } |
| 91 | + return (array)$item; |
| 92 | + }; |
| 93 | + $map = []; |
| 94 | + foreach ($this->permissions as $permission) { |
| 95 | + if (isset($permission['role'])) { |
| 96 | + $role = $permission['role']; |
| 97 | + } else { |
| 98 | + $role = '*'; |
| 99 | + } |
| 100 | + $roles = (array)$role; |
| 101 | + foreach ($roles as $role) { |
| 102 | + $prefixes = $asArray($permission, 'prefix', '*'); |
| 103 | + $plugins = $asArray($permission, 'plugin', '*'); |
| 104 | + $controllers = $asArray($permission, 'controller', '*'); |
| 105 | + foreach ($prefixes as $prefix) { |
| 106 | + foreach ($plugins as $plugin) { |
| 107 | + foreach ($controllers as $controller) { |
| 108 | + $key = "$prefix|$plugin|$controller"; |
| 109 | + $map[$role][$key][] = $permission; |
| 110 | + } |
| 111 | + } |
| 112 | + } |
| 113 | + } |
| 114 | + } |
| 115 | + |
| 116 | + return $map; |
| 117 | + } |
| 118 | + |
| 119 | + /** |
| 120 | + * @param array $permissions permissions |
| 121 | + * @return void |
| 122 | + */ |
| 123 | + public function setPermissions($permissions): void |
| 124 | + { |
| 125 | + $this->permissions = $permissions; |
| 126 | + } |
| 127 | + |
| 128 | + /** |
| 129 | + * Match against permissions, return if matched |
| 130 | + * Permissions are processed based on the 'permissions' config values |
| 131 | + * |
| 132 | + * @param array|\ArrayAccess $user current user array |
| 133 | + * @param \Psr\Http\Message\ServerRequestInterface $request request |
| 134 | + * @return bool true if there is a match in permissions |
| 135 | + */ |
| 136 | + public function checkPermissions($user, ServerRequestInterface $request): bool |
| 137 | + { |
| 138 | + $roleField = $this->getConfig('role_field'); |
| 139 | + $defaultRole = $this->getConfig('default_role'); |
| 140 | + $role = Hash::get($user, $roleField, $defaultRole); |
| 141 | + |
| 142 | + $keys = $this->permissionKeys($request); |
| 143 | + foreach ([$role, '*'] as $checkRole) { |
| 144 | + if (!array_key_exists($checkRole, $this->permissionsMap)) { |
| 145 | + continue; |
| 146 | + } |
| 147 | + foreach ($keys as $key) { |
| 148 | + if (!array_key_exists($key, $this->permissionsMap[$checkRole])) { |
| 149 | + continue; |
| 150 | + } |
| 151 | + $permissions = $this->permissionsMap[$checkRole][$key]; |
| 152 | + foreach ($permissions as $permission) { |
| 153 | + $matchResult = $this->_matchPermission($permission, $user, $role, $request); |
| 154 | + if ($matchResult !== null) { |
| 155 | + if ($this->getConfig('log')) { |
| 156 | + $this->log($matchResult->getReason(), LogLevel::DEBUG); |
| 157 | + } |
| 158 | + |
| 159 | + return $matchResult->isAllowed(); |
| 160 | + } |
| 161 | + } |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + return false; |
| 166 | + } |
| 167 | + |
| 168 | + /** |
| 169 | + * Build list of permission keys to search. |
| 170 | + * |
| 171 | + * @param \Psr\Http\Message\ServerRequestInterface $request request |
| 172 | + * @return array list of key to search based on request. |
| 173 | + */ |
| 174 | + protected function permissionKeys(ServerRequestInterface $request) |
| 175 | + { |
| 176 | + $params = $request->getAttribute('params'); |
| 177 | + $permission = [ |
| 178 | + 'prefix' => $params['prefix'] ?? null, |
| 179 | + 'plugin' => $params['plugin'] ?? null, |
| 180 | + 'controller' => $params['controller'] ?? null, |
| 181 | + ]; |
| 182 | + $keys = []; |
| 183 | + $getKeys = function ($permission, $key) { |
| 184 | + if ($permission[$key] == false || $permission[$key] == null) { |
| 185 | + return ['_', '*']; |
| 186 | + } |
| 187 | + $item = $permission[$key]; |
| 188 | + if ($this->undasherize) { |
| 189 | + $item = Inflector::camelize((string)$item, '-'); |
| 190 | + } |
| 191 | + return [$item, '*']; |
| 192 | + }; |
| 193 | + $prefixes = $getKeys($permission, 'prefix'); |
| 194 | + $plugins = $getKeys($permission, 'plugin'); |
| 195 | + $controllers = $getKeys($permission, 'controller'); |
| 196 | + foreach ($prefixes as $prefix) { |
| 197 | + foreach ($plugins as $plugin) { |
| 198 | + foreach ($controllers as $controller) { |
| 199 | + $keys[] = "$prefix|$plugin|$controller"; |
| 200 | + } |
| 201 | + } |
| 202 | + } |
| 203 | + |
| 204 | + return $keys; |
| 205 | + } |
| 206 | + |
| 207 | +} |
0 commit comments