added: setting to disable forced sso on explicit logout action

Author: jdalsem

classes/ColdTrick/SAMLSSO/Logout.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace ColdTrick\SAMLSSO;
+
+use Elgg\Http\ResponseBuilder;
+use Elgg\Http\OkResponse;
+
+class Logout {
+	
+	/**
+	 * Disable forced SSO login after a logout
+	 *
+	 * @param \Elgg\Hook $hook 'response', 'action:logout'
+	 *
+	 * @return null|ResponseBuilder
+	 */
+	public static function disableSso(\Elgg\Hook $hook): ?ResponseBuilder {
+
+		$response = $hook->getValue();
+		if (!$response instanceof OkResponse) {
+			return null;
+		}
+		
+		if (!(bool) elgg_get_plugin_setting('disable_sso_on_logout', 'saml_sso')) {
+			return null;
+		}
+		
+		$forward = $response->getForwardURL() ?: elgg_get_site_url();
+		$forward = elgg_http_add_url_query_elements($forward, [
+			'disable_sso' => 1,
+		]);
+		
+		$response->setForwardURL($forward);
+		
+		return $response;
+	}
+}

elgg-plugin.php

@@ -9,6 +9,7 @@
 	],
 	'settings' => [
 		'use_http_x_forwarded' => 0,
+		'disable_sso_on_logout' => false,
 	],
 	'entities' => [
 		[
@@ -55,7 +56,12 @@
 			'menu:page' => [
 				'\ColdTrick\SAMLSSO\Menus::registerAdminPageMenu' => [],
 			],
-		]
+		],
+		'response' => [
+			'action:logout' => [
+				'\ColdTrick\SAMLSSO\Logout::disableSso' => [],
+			],
+		],
 	],
 	'actions' => [
 		'saml_sso/add_idp_from_xml' => [

languages/en.php

@@ -6,6 +6,8 @@
 
 	'saml_sso:settings:use_http_x_forwarded' => "Use proxy variables",
 	'saml_sso:settings:use_http_x_forwarded:help' => "Allow the usage of HTTP_X_FORWARDED server information",
+	'saml_sso:settings:disable_sso_on_logout' => "Disable SSO on logout",
+	'saml_sso:settings:disable_sso_on_logout:help' => "Enabling this will prevent forced SSO for users that explicitely use the logout action",
 
 	'add:object:saml_idp' => "Create IDP",
 	'add:object:saml_idp:from_xml' => "Create IDP from XML",

languages/nl.php

@@ -9,6 +9,8 @@
   'admin:configure_utilities:manage_idps' => 'Beheer SAML IDPs',
   'saml_sso:settings:use_http_x_forwarded' => 'Gebruik proxy variabelen',
   'saml_sso:settings:use_http_x_forwarded:help' => 'Sta het gebruik toe van de HTTP_X_FORWARDED server informatie',
+  'saml_sso:settings:disable_sso_on_logout' => 'SSO uitschakelen na afmelden',
+  'saml_sso:settings:disable_sso_on_logout:help' => 'Indien dit actief is zal er geen SSO geforceerd worden wanneer een gebruiker zich expliciet heeft afgemeld',
   'add:object:saml_idp' => 'Maak IDP',
   'add:object:saml_idp:from_xml' => 'Maak IDP obv XML',
   'saml_sso:add_from_xml:url' => 'Voer IDP metadata URL in voor autodetectie',

views/default/plugins/saml_sso/settings.php

@@ -16,3 +16,14 @@
 	'default' => 0,
 	'value' => 1,
 ]);
+
+echo elgg_view_field([
+	'#type' => 'checkbox',
+	'#label' => elgg_echo('saml_sso:settings:disable_sso_on_logout'),
+	'#help' => elgg_echo('saml_sso:settings:disable_sso_on_logout:help'),
+	'name' => 'params[disable_sso_on_logout]',
+	'checked' => (bool) $plugin->disable_sso_on_logout,
+	'switch' => true,
+	'default' => 0,
+	'value' => 1,
+]);