LoggedOut Controller

Author: ioigoume

composer.json

@@ -40,8 +40,7 @@
         "simplesamlphp/simplesamlphp": "^2.2",
         "simplesamlphp/xml-cas": "^v1.3",
         "simplesamlphp/xml-common": "^v1.17",
-        "simplesamlphp/xml-soap": "^v1.5",
-        "symfony/cache": "^6.0|^5.0|^4.3|^3.4"
+        "simplesamlphp/xml-soap": "^v1.5"
     },
     "require-dev": {
         "simplesamlphp/simplesamlphp-test-framework": "^1.7",

public/loggedOut.php

@@ -6,9 +6,10 @@
 
 declare(strict_types=1);
 
-use SimpleSAML\Module\casserver\Codebooks\RoutesEnum;
 use SimpleSAML\Module\casserver\Codebooks\LegacyRoutesEnum;
+use SimpleSAML\Module\casserver\Codebooks\RoutesEnum;
 use SimpleSAML\Module\casserver\Controller\Cas10Controller;
+use SimpleSAML\Module\casserver\Controller\LoggedOutController;
 use SimpleSAML\Module\casserver\Controller\LogoutController;
 use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
 
@@ -19,12 +20,16 @@
     // New Routes
     $routes->add(RoutesEnum::Validate->name, RoutesEnum::Validate->value)
         ->controller([Cas10Controller::class, 'validate']);
-    $routes->add(RoutesEnum::Validate->name, RoutesEnum::Logout->value)
+    $routes->add(RoutesEnum::Logout->name, RoutesEnum::Logout->value)
         ->controller([LogoutController::class, 'logout']);
+    $routes->add(RoutesEnum::LoggedOut->name, RoutesEnum::LoggedOut->value)
+        ->controller([LoggedOutController::class, 'main']);
 
     // Legacy Routes
     $routes->add(LegacyRoutesEnum::LegacyValidate->name, LegacyRoutesEnum::LegacyValidate->value)
         ->controller([Cas10Controller::class, 'validate']);
-    $routes->add(LegacyRoutesEnum::LegacyValidate->name, LegacyRoutesEnum::LegacyLogout->value)
+    $routes->add(LegacyRoutesEnum::LegacyLogout->name, LegacyRoutesEnum::LegacyLogout->value)
         ->controller([LogoutController::class, 'logout']);
+    $routes->add(LegacyRoutesEnum::LegacyLoggedOut->name, LegacyRoutesEnum::LegacyLoggedOut->value)
+        ->controller([LoggedOutController::class, 'main']);
 };

routing/routes/routes.php

@@ -12,4 +12,14 @@ services:
         exclude:
             - '../../src/Controller/Traits/*'
         public: true
-        autowire: true
+        tags: ['controller.service_arguments']
+
+    # Explicit service definitions for CasServer Controllers
+    SimpleSAML\Module\casserver\Controller\Cas10Controller:
+        public: true
+
+    SimpleSAML\Module\casserver\Controller\LogoutController:
+        public: true
+
+    SimpleSAML\Module\casserver\Controller\LoggedOutController:
+        public: true

routing/services/services.yml

@@ -11,14 +11,9 @@
 use SimpleSAML\Module\casserver\Controller\Traits\UrlTrait;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Attribute\AsController;
 
-/**
- * Controller class for the casserver module.
- *
- * This class serves the different views available in the module.
- *
- * @package SimpleSAML\Module\casserver
- */
+#[AsController]
 class Cas10Controller
 {
     use UrlTrait;

src/Controller/Cas10Controller.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\casserver\Controller;
+
+use SimpleSAML\Configuration;
+use SimpleSAML\XHTML\Template;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Attribute\AsController;
+
+#[AsController]
+class LoggedOutController
+{
+    /** @var \SimpleSAML\Configuration */
+    protected Configuration $config;
+
+    /**
+     * Controller constructor.
+     *
+     * It initializes the global configuration for the controllers implemented here.
+     *
+     * @param   Configuration|null  $config
+     *
+     * @throws \Exception
+     */
+    public function __construct(Configuration $config = null)
+    {
+        $this->config = $config ?? Configuration::getInstance();
+    }
+
+    /**
+     * Show Log out view.
+     *
+     * @param   Request  $request
+     * @return Response
+     * @throws \Exception
+     */
+    public function main(Request $request): Response
+    {
+        $t = new Template($this->config, 'casserver:loggedOut.twig');
+        if ($request->query->has('url')) {
+            $t->data['url'] = $request->query->get('url');
+        }
+        return $t;
+    }
+}

src/Controller/LoggedOutController.php

@@ -7,12 +7,16 @@
 use SimpleSAML\Auth\Simple;
 use SimpleSAML\Configuration;
 use SimpleSAML\Logger;
+use SimpleSAML\Module;
 use SimpleSAML\Module\casserver\Cas\Factories\TicketFactory;
 use SimpleSAML\Module\casserver\Controller\Traits\UrlTrait;
 use SimpleSAML\Session;
 use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Attribute\AsController;
 use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
 
+#[AsController]
 class LogoutController
 {
     use UrlTrait;
@@ -57,11 +61,13 @@ public function __construct()
 
     /**
      *
+     * @param   Request      $request
      * @param   string|null  $url
      *
      * @return RedirectResponse|null
      */
     public function logout(
+        Request $request,
         #[MapQueryParameter] ?string $url = null,
     ): RedirectResponse|null {
         if (!$this->casConfig->getOptionalValue('enable_logout', false)) {
@@ -76,8 +82,13 @@ public function logout(
         }
 
         // Construct the logout redirect url
-        $logoutRedirectUrl =  ($skipLogoutPage || $url === null) ? $url
-            : $url . '?' . http_build_query(['url' => $url]);
+        if ($skipLogoutPage) {
+            $logoutRedirectUrl = $url;
+        } else {
+            $loggedOutUrl = Module::getModuleURL('casserver/loggedOut.php');
+            $logoutRedirectUrl =  $url === null ? $loggedOutUrl
+                : $loggedOutUrl . '?' . http_build_query(['url' => $url]);
+        }
 
         // Delete the ticket from the session
         $session = $this->getSession();

src/Controller/LogoutController.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Module\casserver\Tests\Controller;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Module\casserver\Controller\LogoutController;
+use Symfony\Component\HttpFoundation\Request;
+
+class LogoutControllerTest extends TestCase
+{
+    /** @var LogoutController */
+    private $controller;
+
+    protected function setUp(): void
+    {
+        $this->controller = new LogoutController();
+    }
+
+    public static function requestParameters(): array
+    {
+        return [
+            'no redirect url' => [''],
+            'with redirect url' => ['http://example.com/redirect'],
+        ];
+    }
+
+    #[DataProvider('requestParameters')]
+    public function testLogout(string $redirectUrl): void
+    {
+        $request = Request::create(
+            uri: 'https://localhost/casserver/logout',
+            parameters: ['url' => $redirectUrl],
+        );
+    }
+}