5f1ee5fb0e
The 'name' field was really redundant and caused confusion in the codebase, since the 'Display' name is often used and we have a 'system_name' for the admin and public role. This fixes #2032, Where external auth group matching has confusing behaviour as matching was done against the display_name, if no external_auth field is set, but only roles with a match 'name' field would be considered. This also fixes and error where the role users migration, on role delete, would not actually fire due to mis-matching http body keys. Looks like this has been an issue from the start. Added some testing to cover. Fixes #2211. Also converted phpdoc to typehints in many areas of the reviewed code during the above.
75 lines
2.4 KiB
PHP
75 lines
2.4 KiB
PHP
<?php namespace BookStack\Auth\Access;
|
|
|
|
use BookStack\Auth\Role;
|
|
use BookStack\Auth\User;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Support\Collection;
|
|
use Illuminate\Support\Facades\DB;
|
|
|
|
class ExternalAuthService
|
|
{
|
|
/**
|
|
* Check a role against an array of group names to see if it matches.
|
|
* Checked against role 'external_auth_id' if set otherwise the name of the role.
|
|
*/
|
|
protected function roleMatchesGroupNames(Role $role, array $groupNames): bool
|
|
{
|
|
if ($role->external_auth_id) {
|
|
return $this->externalIdMatchesGroupNames($role->external_auth_id, $groupNames);
|
|
}
|
|
|
|
$roleName = str_replace(' ', '-', trim(strtolower($role->display_name)));
|
|
return in_array($roleName, $groupNames);
|
|
}
|
|
|
|
/**
|
|
* Check if the given external auth ID string matches one of the given group names.
|
|
*/
|
|
protected function externalIdMatchesGroupNames(string $externalId, array $groupNames): bool
|
|
{
|
|
$externalAuthIds = explode(',', strtolower($externalId));
|
|
|
|
foreach ($externalAuthIds as $externalAuthId) {
|
|
if (in_array(trim($externalAuthId), $groupNames)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Match an array of group names to BookStack system roles.
|
|
* Formats group names to be lower-case and hyphenated.
|
|
*/
|
|
protected function matchGroupsToSystemsRoles(array $groupNames): Collection
|
|
{
|
|
foreach ($groupNames as $i => $groupName) {
|
|
$groupNames[$i] = str_replace(' ', '-', trim(strtolower($groupName)));
|
|
}
|
|
|
|
$roles = Role::query()->get(['id', 'external_auth_id', 'display_name']);
|
|
$matchedRoles = $roles->filter(function (Role $role) use ($groupNames) {
|
|
return $this->roleMatchesGroupNames($role, $groupNames);
|
|
});
|
|
|
|
return $matchedRoles->pluck('id');
|
|
}
|
|
|
|
/**
|
|
* Sync the groups to the user roles for the current user
|
|
*/
|
|
public function syncWithGroups(User $user, array $userGroups): void
|
|
{
|
|
// Get the ids for the roles from the names
|
|
$groupsAsRoles = $this->matchGroupsToSystemsRoles($userGroups);
|
|
|
|
// Sync groups
|
|
if ($this->config['remove_from_groups']) {
|
|
$user->roles()->sync($groupsAsRoles);
|
|
$user->attachDefaultRole();
|
|
} else {
|
|
$user->roles()->syncWithoutDetaching($groupsAsRoles);
|
|
}
|
|
}
|
|
}
|