Move to SspBridge in AuthContextService

Author: cicnavi

src/Bridges/SspBridge/Utils.php

@@ -4,6 +4,7 @@
 
 namespace SimpleSAML\Module\oidc\Bridges\SspBridge;
 
+use SimpleSAML\Utils\Attributes;
 use SimpleSAML\Utils\Auth;
 use SimpleSAML\Utils\Config;
 use SimpleSAML\Utils\HTTP;
@@ -15,6 +16,7 @@ class Utils
     protected static ?HTTP $http = null;
     protected static ?Random $random = null;
     protected static ?Auth $auth = null;
+    protected static ?Attributes $attributes = null;
 
     public function config(): Config
     {
@@ -35,4 +37,9 @@ public function auth(): Auth
     {
         return self::$auth ??= new Auth();
     }
+
+    public function attributes(): Attributes
+    {
+        return self::$attributes ??= new Attributes();
+    }
 }

src/Services/AuthContextService.php

@@ -6,10 +6,9 @@
 
 use RuntimeException;
 use SimpleSAML\Auth\Simple;
+use SimpleSAML\Module\oidc\Bridges\SspBridge;
 use SimpleSAML\Module\oidc\Factories\AuthSimpleFactory;
 use SimpleSAML\Module\oidc\ModuleConfig;
-use SimpleSAML\Utils\Attributes;
-use SimpleSAML\Utils\Auth;
 
 /**
  * Provide contextual authentication information for administration interface.
@@ -28,13 +27,13 @@ class AuthContextService
     public function __construct(
         private readonly ModuleConfig $moduleConfig,
         private readonly AuthSimpleFactory $authSimpleFactory,
+        private readonly SspBridge $sspBridge,
     ) {
     }
 
     public function isSspAdmin(): bool
     {
-        // TODO mivanci make bridge to SSP utility classes (search for SSP namespace through the codebase)
-        return (new Auth())->isAdmin();
+        return $this->sspBridge->utils()->auth()->isAdmin();
     }
 
     /**
@@ -45,7 +44,10 @@ public function getAuthUserId(): string
     {
         $simple = $this->authenticate();
         $userIdAttr = $this->moduleConfig->getUserIdentifierAttribute();
-        return (string)(new Attributes())->getExpectedAttribute($simple->getAttributes(), $userIdAttr);
+        return (string)$this->sspBridge->utils()->attributes()->getExpectedAttribute(
+            $simple->getAttributes(),
+            $userIdAttr,
+        );
     }
 
     /**

src/Services/Container.php

@@ -131,15 +131,19 @@ public function __construct()
         $authSimpleFactory = new AuthSimpleFactory($moduleConfig);
         $this->services[AuthSimpleFactory::class] = $authSimpleFactory;
 
-        $authContextService = new AuthContextService($moduleConfig, $authSimpleFactory);
+        $sspBridge = new SspBridge();
+        $this->services[SspBridge::class] = $sspBridge;
+
+        $authContextService = new AuthContextService(
+            $moduleConfig,
+            $authSimpleFactory,
+            $sspBridge,
+        );
         $this->services[AuthContextService::class] = $authContextService;
 
         $session = Session::getSessionFromRequest();
         $this->services[Session::class] = $session;
 
-        $sspBridge = new SspBridge();
-        $this->services[SspBridge::class] = $sspBridge;
-
         $helpers = new Helpers();
         $this->services[Helpers::class] = $helpers;
 

tests/unit/src/Bridges/SspBridge/UtilsTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\Module\oidc\Bridges\SspBridge\Utils;
+use SimpleSAML\Utils\Attributes;
 use SimpleSAML\Utils\Auth;
 use SimpleSAML\Utils\Config;
 use SimpleSAML\Utils\HTTP;
@@ -44,4 +45,9 @@ public function testCanBuildAuthInstance(): void
     {
         $this->assertInstanceOf(Auth::class, $this->sut()->auth());
     }
+
+    public function testCanBuileAttributesInstance(): void
+    {
+        $this->assertInstanceOf(Attributes::class, $this->sut()->attributes());
+    }
 }

tests/unit/src/Services/AuthContextServiceTest.php

@@ -10,9 +10,11 @@
 use SimpleSAML\Auth\Simple;
 use SimpleSAML\Configuration;
 use SimpleSAML\Error\Exception;
+use SimpleSAML\Module\oidc\Bridges\SspBridge;
 use SimpleSAML\Module\oidc\Factories\AuthSimpleFactory;
 use SimpleSAML\Module\oidc\ModuleConfig;
 use SimpleSAML\Module\oidc\Services\AuthContextService;
+use SimpleSAML\Utils\Attributes;
 
 /**
  * @covers \SimpleSAML\Module\oidc\Services\AuthContextService
@@ -28,6 +30,9 @@ class AuthContextServiceTest extends TestCase
     protected MockObject $moduleConfigMock;
     protected MockObject $authSimpleService;
     protected MockObject $authSimpleFactory;
+    protected MockObject $sspBridgeMock;
+    protected MockObject $sspBridgeUtilsMock;
+    protected MockObject $sspBridgeUtilsAttributesMock;
 
     /**
      * @throws \PHPUnit\Framework\MockObject\Exception
@@ -52,21 +57,35 @@ protected function setUp(): void
 
         $this->authSimpleFactory = $this->createMock(AuthSimpleFactory::class);
         $this->authSimpleFactory->method('getDefaultAuthSource')->willReturn($this->authSimpleService);
+
+        $this->sspBridgeMock = $this->createMock(SspBridge::class);
+        $this->sspBridgeUtilsMock = $this->createMock(SspBridge\Utils::class);
+        $this->sspBridgeMock->method('utils')->willReturn($this->sspBridgeUtilsMock);
+        $this->sspBridgeUtilsAttributesMock = $this->createMock(Attributes::class);
+        $this->sspBridgeUtilsMock->method('attributes')->willReturn($this->sspBridgeUtilsAttributesMock);
     }
 
-    protected function prepareMockedInstance(): AuthContextService
-    {
+    protected function sut(
+        ?ModuleConfig $moduleConfig = null,
+        ?AuthSimpleFactory $authSimpleFactory = null,
+        ?SspBridge $sspBridge = null,
+    ): AuthContextService {
+        $moduleConfig ??= $this->moduleConfigMock;
+        $authSimpleFactory ??= $this->authSimpleFactory;
+        $sspBridge ??= $this->sspBridgeMock;
+
         return new AuthContextService(
-            $this->moduleConfigMock,
-            $this->authSimpleFactory,
+            $moduleConfig,
+            $authSimpleFactory,
+            $sspBridge,
         );
     }
 
     public function testItIsInitializable(): void
     {
         $this->assertInstanceOf(
             AuthContextService::class,
-            $this->prepareMockedInstance(),
+            $this->sut(),
         );
     }
 
@@ -77,9 +96,15 @@ public function testItReturnsUsername(): void
     {
         $this->moduleConfigMock->method('getUserIdentifierAttribute')->willReturn('idAttribute');
         $this->authSimpleService->method('getAttributes')->willReturn(self::AUTHORIZED_USER);
+        $this->sspBridgeUtilsAttributesMock->expects($this->once())->method('getExpectedAttribute')
+            ->with(
+                self::AUTHORIZED_USER,
+                'idAttribute',
+            )
+            ->willReturn(self::AUTHORIZED_USER['idAttribute'][0]);
 
         $this->assertSame(
-            $this->prepareMockedInstance()->getAuthUserId(),
+            $this->sut()->getAuthUserId(),
             'myUsername',
         );
     }
@@ -94,8 +119,12 @@ public function testItThrowsWhenNoUsername(): void
             ->willReturn('attributeNotSet');
         $this->authSimpleService->method('getAttributes')->willReturn(self::AUTHORIZED_USER);
 
+        $this->sspBridgeUtilsAttributesMock->expects($this->once())->method('getExpectedAttribute')
+            ->with(self::AUTHORIZED_USER)
+            ->willThrowException(new Exception('error'));
+
         $this->expectException(Exception::class);
-        $this->prepareMockedInstance()->getAuthUserId();
+        $this->sut()->getAuthUserId();
     }
 
     /**
@@ -108,7 +137,7 @@ public function testPermissionsOk(): void
             ->willReturn($this->permissions);
         $this->authSimpleService->method('getAttributes')->willReturn(self::AUTHORIZED_USER);
 
-        $this->prepareMockedInstance()->requirePermission('client');
+        $this->sut()->requirePermission('client');
         $this->expectNotToPerformAssertions();
     }
 
@@ -121,7 +150,7 @@ public function testItThrowsIfNotAuthorizedForPermission(): void
             ->with(ModuleConfig::OPTION_ADMIN_UI_PERMISSIONS, null)
             ->willReturn($this->permissions);
         $this->expectException(RuntimeException::class);
-        $this->prepareMockedInstance()->requirePermission('no-match');
+        $this->sut()->requirePermission('no-match');
     }
 
     /**
@@ -141,7 +170,7 @@ public function testItThrowsForWrongEntitlements(): void
             );
 
         $this->expectException(RuntimeException::class);
-        $this->prepareMockedInstance()->requirePermission('client');
+        $this->sut()->requirePermission('client');
     }
 
     /**
@@ -160,7 +189,7 @@ public function testItThrowsForNotHavingEntitlementAttribute(): void
             );
 
         $this->expectException(RuntimeException::class);
-        $this->prepareMockedInstance()->requirePermission('client');
+        $this->sut()->requirePermission('client');
     }
 
     /**
@@ -173,6 +202,6 @@ public function testThrowsForNotHavingEnabledPermissions(): void
             ->willReturn(Configuration::loadFromArray([]));
 
         $this->expectException(RuntimeException::class);
-        $this->prepareMockedInstance()->requirePermission('client');
+        $this->sut()->requirePermission('client');
     }
 }