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

Updated OIDC group attr option name

Browse Source 
To match the existing option name for display names.
Closes #3704
This commit is contained in:
Dan Brown 2022-09-06 16:32:42 +01:00
parent b9941e8e61
commit 24f82749ff
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.env.example.complete
View File

@ -266,7 +266,7 @@ OIDC_TOKEN_ENDPOINT=null
OIDC_ADDITIONAL_SCOPES=null OIDC_ADDITIONAL_SCOPES=null
OIDC_DUMP_USER_DETAILS=false OIDC_DUMP_USER_DETAILS=false
OIDC_USER_TO_GROUPS=false OIDC_USER_TO_GROUPS=false
OIDC_GROUP_ATTRIBUTE=groups OIDC_GROUPS_CLAIM=groups
OIDC_REMOVE_FROM_GROUPS=false OIDC_REMOVE_FROM_GROUPS=false
# Disable default third-party services such as Gravatar and Draw.IO # Disable default third-party services such as Gravatar and Draw.IO

2
app/Auth/Access/Oidc/OidcService.php
View File

@ -181,7 +181,7 @@ class OidcService
*/ */
protected function getUserGroups(OidcIdToken $token): array protected function getUserGroups(OidcIdToken $token): array
{ {
$groupsAttr = $this->config()['group_attribute']; $groupsAttr = $this->config()['groups_claim'];
if (empty($groupsAttr)) { if (empty($groupsAttr)) {
return []; return [];
} }

2
app/Config/oidc.php
View File

@ -41,7 +41,7 @@ return [
// Enable syncing, upon login, of OIDC groups to BookStack roles // Enable syncing, upon login, of OIDC groups to BookStack roles
'user_to_groups' => env('OIDC_USER_TO_GROUPS', false), 'user_to_groups' => env('OIDC_USER_TO_GROUPS', false),
// Attribute, within a OIDC ID token, to find group names within // Attribute, within a OIDC ID token, to find group names within
'group_attribute' => env('OIDC_GROUP_ATTRIBUTE', 'groups'), 'groups_claim' => env('OIDC_GROUPS_CLAIM', 'groups'),
// When syncing groups, remove any groups that no longer match. Otherwise sync only adds new groups. // When syncing groups, remove any groups that no longer match. Otherwise sync only adds new groups.
'remove_from_groups' => env('OIDC_REMOVE_FROM_GROUPS', false), 'remove_from_groups' => env('OIDC_REMOVE_FROM_GROUPS', false),
]; ];

6
tests/Auth/OidcTest.php
View File

@ -40,7 +40,7 @@ class OidcTest extends TestCase
'oidc.dump_user_details' => false, 'oidc.dump_user_details' => false,
'oidc.additional_scopes' => '', 'oidc.additional_scopes' => '',
'oidc.user_to_groups' => false, 'oidc.user_to_groups' => false,
'oidc.group_attribute' => 'group', 'oidc.groups_claim' => 'group',
'oidc.remove_from_groups' => false, 'oidc.remove_from_groups' => false,
]); ]);
} }
@ -364,7 +364,7 @@ class OidcTest extends TestCase
{ {
config()->set([ config()->set([
'oidc.user_to_groups' => true, 'oidc.user_to_groups' => true,
'oidc.group_attribute' => 'groups', 'oidc.groups_claim' => 'groups',
'oidc.remove_from_groups' => false, 'oidc.remove_from_groups' => false,
]); ]);
$roleA = Role::factory()->create(['display_name' => 'Wizards']); $roleA = Role::factory()->create(['display_name' => 'Wizards']);
@ -390,7 +390,7 @@ class OidcTest extends TestCase
{ {
config()->set([ config()->set([
'oidc.user_to_groups' => true, 'oidc.user_to_groups' => true,
'oidc.group_attribute' => 'my.custom.groups.attr', 'oidc.groups_claim' => 'my.custom.groups.attr',
'oidc.remove_from_groups' => false, 'oidc.remove_from_groups' => false,
]); ]);
$roleA = Role::factory()->create(['display_name' => 'Wizards']); $roleA = Role::factory()->create(['display_name' => 'Wizards']);