From abb8cecb7ed25f5e1a302b23ff408738ab687fd8 Mon Sep 17 00:00:00 2001 From: Thijs Kinkhorst Date: Fri, 5 Nov 2021 15:29:54 +0100 Subject: [PATCH] Fix docblock formatting and add newer settings to README documentation --- .../Component/Auth/ApacheShibbAuthenticate.php | 9 +++++---- app/Plugin/ShibbAuth/README.md | 3 +++ 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/app/Plugin/ShibbAuth/Controller/Component/Auth/ApacheShibbAuthenticate.php b/app/Plugin/ShibbAuth/Controller/Component/Auth/ApacheShibbAuthenticate.php index 34ea870e2..a77fd389f 100644 --- a/app/Plugin/ShibbAuth/Controller/Component/Auth/ApacheShibbAuthenticate.php +++ b/app/Plugin/ShibbAuth/Controller/Component/Auth/ApacheShibbAuthenticate.php @@ -39,10 +39,11 @@ class ApacheShibbAuthenticate extends BaseAuthenticate * 'group_one' => 1, * ), * 'DefaultOrg' => 'MY_ORG', - * 'BlockOrgModifications' => false // set to true if you wish for the user's organisation never to be updated during login. Especially useful if you manually change organisations in MISP - * 'DefaultRole' => false // set to a specific value if you wish to hard-set users created via ApacheShibbAuth - * 'BlockRoleModifications' => false // set to true if you wish for the roles never to be updated during login. Especially * // useful if you manually change roles in MISP - * 'BlockOrgModifications' => false // set to true if you wish for the organizations never to be updated during login. Especially * // useful if you manually change orgs in MISP + * 'DefaultRole' => false, // set to a specific value if you wish to hard-set users created via ApacheShibbAuth + * 'BlockRoleModifications' => false, // set to true if you wish for the roles never to be updated during login. Especially + * // useful if you manually change roles in MISP + * 'BlockOrgModifications' => false, // set to true if you wish for the organizations never to be updated during login. Especially + * // useful if you manually change orgs in MISP * ), * @param CakeRequest $request The request that contains login information. * @param CakeResponse $response Unused response object. diff --git a/app/Plugin/ShibbAuth/README.md b/app/Plugin/ShibbAuth/README.md index 2ea9eb8b9..abfb80efe 100644 --- a/app/Plugin/ShibbAuth/README.md +++ b/app/Plugin/ShibbAuth/README.md @@ -145,6 +145,9 @@ in the list given by apache. By default, you can leave it at ';'. 'possible_group_attribute_value_1' => 1, ), 'DefaultOrg' => 'MISP_DEFAULT_ORG', + 'DefaultRole' => false, // set to a specific value if you wish to hard-set users created via ApacheShibbAuth + 'BlockRoleModifications' => false, // set to true if you wish for the roles never to be updated during login. Especially useful if you manually change roles in MISP + 'BlockOrgModifications' => false, // set to true if you wish for the organizations never to be updated during login. Especially useful if you manually change orgs in MISP ), ```