Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 01:36:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3416 from BookStackApp/group_sync_comma_escaping

Browse Source 
Added ability to escape role "External Auth ID" commas
This commit is contained in:
Dan Brown 2022-05-30 16:55:32 +01:00 committed by GitHub
commit 39fcf3a68f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 74 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
app/Auth/Access/GroupSyncService.php
View File

@ -28,10 +28,8 @@ class GroupSyncService
*/
protected function externalIdMatchesGroupNames(string $externalId, array $groupNames): bool
{
$externalAuthIds = explode(',', strtolower($externalId));
foreach ($externalAuthIds as $externalAuthId) {
if (in_array(trim($externalAuthId), $groupNames)) {
foreach ($this->parseRoleExternalAuthId($externalId) as $externalAuthId) {
if (in_array($externalAuthId, $groupNames)) {
return true;
}
}
@ -39,6 +37,18 @@ class GroupSyncService
return false;
}
protected function parseRoleExternalAuthId(string $externalId): array
{
$inputIds = preg_split('/(?<!\\\),/', $externalId);
$cleanIds = [];
foreach ($inputIds as $inputId) {
$cleanIds[] = str_replace('\,', ',', trim($inputId));
}
return $cleanIds;
}
/**
* Match an array of group names to BookStack system roles.
* Formats group names to be lower-case and hyphenated.

1
database/factories/Auth/RoleFactory.php
View File

@ -23,6 +23,7 @@ class RoleFactory extends Factory
return [
'display_name' => $this->faker->sentence(3),
'description' => $this->faker->sentence(10),
'external_auth_id' => '',
];
}
}

59
tests/Auth/GroupSyncServiceTest.php Normal file
View File

@ -0,0 +1,59 @@
<?php
namespace Tests\Auth;
use BookStack\Auth\Access\GroupSyncService;
use BookStack\Auth\Role;
use BookStack\Auth\User;
use Tests\TestCase;
class GroupSyncServiceTest extends TestCase
{
public function test_user_is_assigned_to_matching_roles()
{
$user = $this->getViewer();
$roleA = Role::factory()->create(['display_name' => 'Wizards']);
$roleB = Role::factory()->create(['display_name' => 'Gremlins']);
$roleC = Role::factory()->create(['display_name' => 'ABC123', 'external_auth_id' => 'sales']);
$roleD = Role::factory()->create(['display_name' => 'DEF456', 'external_auth_id' => 'admin-team']);
foreach([$roleA, $roleB, $roleC, $roleD] as $role) {
$this->assertFalse($user->hasRole($role->id));
}
(new GroupSyncService())->syncUserWithFoundGroups($user, ['Wizards', 'Gremlinz', 'Sales', 'Admin Team'], false);
$user = User::query()->find($user->id);
$this->assertTrue($user->hasRole($roleA->id));
$this->assertFalse($user->hasRole($roleB->id));
$this->assertTrue($user->hasRole($roleC->id));
$this->assertTrue($user->hasRole($roleD->id));
}
public function test_multiple_values_in_role_external_auth_id_handled()
{
$user = $this->getViewer();
$role = Role::factory()->create(['display_name' => 'ABC123', 'external_auth_id' => 'sales, engineering, developers, marketers']);
$this->assertFalse($user->hasRole($role->id));
(new GroupSyncService())->syncUserWithFoundGroups($user, ['Developers'], false);
$user = User::query()->find($user->id);
$this->assertTrue($user->hasRole($role->id));
}
public function test_commas_can_be_used_in_external_auth_id_if_escaped()
{
$user = $this->getViewer();
$role = Role::factory()->create(['display_name' => 'ABC123', 'external_auth_id' => 'sales\,-developers, marketers']);
$this->assertFalse($user->hasRole($role->id));
(new GroupSyncService())->syncUserWithFoundGroups($user, ['Sales, Developers'], false);
$user = User::query()->find($user->id);
$this->assertTrue($user->hasRole($role->id));
}
}