Merge pull request #1953 from tomudding/feature/improved-custom-page-…

…authorization-checks

feat: dynamically evaluate page access permissions

module/Frontpage/src/Model/Page.php

@@ -201,6 +201,6 @@ public function toArray(): array
      */
     public function getResourceId(): string
     {
-        return 'page' . $this->getId();
+        return 'page';
     }
 }

module/Frontpage/src/Module.php

@@ -31,11 +31,8 @@
 use Frontpage\Service\Page as PageService;
 use Frontpage\Service\Poll as PollService;
 use Psr\Container\ContainerInterface;
-use RuntimeException;
 use User\Authorization\AclServiceFactory;
 
-use function sprintf;
-
 class Module
 {
     /**
@@ -58,28 +55,7 @@ public function getServiceConfig(): array
         return [
             'factories' => [
                 // Services
-                AclService::class => static function (
-                    ContainerInterface $container,
-                    $requestedName,
-                    ?array $options = null,
-                ) {
-                    $aclService = (new AclServiceFactory())->__invoke($container, $requestedName, $options);
-
-                    if ($aclService instanceof AclService) {
-                        $pages = $container->get(PageMapper::class)->findAll();
-                        $aclService->setPages($pages);
-
-                        return $aclService;
-                    }
-
-                    throw new RuntimeException(
-                        sprintf(
-                            'Expected service of type %s, got service of type %s',
-                            AclService::class,
-                            $aclService::class,
-                        ),
-                    );
-                },
+                AclService::class => AclServiceFactory::class,
                 FrontpageService::class => FrontpageServiceFactory::class,
                 NewsService::class => NewsServiceFactory::class,
                 PageService::class => PageServiceFactory::class,

module/Frontpage/src/Service/AclService.php

@@ -4,23 +4,11 @@
 
 namespace Frontpage\Service;
 
-use Frontpage\Model\Page as PageModel;
 use Laminas\Permissions\Acl\Resource\GenericResource as Resource;
+use User\Permissions\Assertion\IsAllowedToViewPage;
 
 class AclService extends \User\Service\AclService
 {
-    /**
-     * @param PageModel[] $pages
-     */
-    public function setPages(array $pages): void
-    {
-        foreach ($pages as $page) {
-            $requiredRole = $page->getRequiredRole()->value;
-            $this->acl->addResource($page);
-            $this->acl->allow($requiredRole, $page, 'view');
-        }
-    }
-
     protected function createAcl(): void
     {
         parent::createAcl();
@@ -36,5 +24,7 @@ protected function createAcl(): void
         $this->acl->allow('user', 'infimum', 'view');
         $this->acl->allow('user', 'poll', ['vote', 'request']);
         $this->acl->allow('user', 'poll_comment', ['view', 'create', 'list']);
+
+        $this->acl->allow(null, 'page', 'view', new IsAllowedToViewPage());
     }
 }

module/User/src/Permissions/Assertion/IsAfterMembershipEndedAndNotTagged.php

@@ -21,13 +21,7 @@
 class IsAfterMembershipEndedAndNotTagged implements AssertionInterface
 {
     /**
-     * Returns true if and only if the assertion conditions are met.
-     *
-     * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
-     * $role, $resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
-     * privileges, respectively.
-     *
-     * @param string|null $privilege
+     * @inheritDoc
      */
     public function assert(
         Acl $acl,

module/User/src/Permissions/Assertion/IsAllowedToViewPage.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace User\Permissions\Assertion;
+
+use Frontpage\Model\Page as PageModel;
+use Laminas\Permissions\Acl\Acl;
+use Laminas\Permissions\Acl\Assertion\AssertionInterface;
+use Laminas\Permissions\Acl\Resource\ResourceInterface;
+use Laminas\Permissions\Acl\Role\RoleInterface;
+
+/**
+ * Assertion to check if whoever is trying to view the page is allowed to view the page.
+ */
+class IsAllowedToViewPage implements AssertionInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function assert(
+        Acl $acl,
+        ?RoleInterface $role = null,
+        ?ResourceInterface $resource = null,
+        $privilege = null,
+    ): bool {
+        if (!$resource instanceof PageModel) {
+            return false;
+        }
+
+        $requiredRole = $resource->getRequiredRole()->value;
+
+        return $role->getRoleId() === $requiredRole || $acl->inheritsRole($role, $requiredRole);
+    }
+}

module/User/src/Permissions/Assertion/IsCreator.php

@@ -18,13 +18,7 @@
 class IsCreator implements AssertionInterface
 {
     /**
-     * Returns true if and only if the assertion conditions are met.
-     *
-     * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
-     * $role, $resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
-     * privileges, respectively.
-     *
-     * @param string|null $privilege
+     * @inheritDoc
      */
     public function assert(
         Acl $acl,

module/User/src/Permissions/Assertion/IsCreatorOrOrganMember.php

@@ -16,13 +16,7 @@
 class IsCreatorOrOrganMember implements AssertionInterface
 {
     /**
-     * Returns true if and only if the assertion conditions are met.
-     *
-     * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
-     * $role, $resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
-     * privileges, respectively.
-     *
-     * @param string|null $privilege
+     * @inheritDoc
      */
     public function assert(
         Acl $acl,

module/User/src/Permissions/Assertion/IsOrganMember.php

@@ -20,13 +20,7 @@
 class IsOrganMember implements AssertionInterface
 {
     /**
-     * Returns true if and only if the assertion conditions are met.
-     *
-     * This method is passed the ACL, Role, Resource, and privilege to which the authorization query applies. If the
-     * $role, $resource, or $privilege parameters are null, it means that the query applies to all Roles, Resources, or
-     * privileges, respectively.
-     *
-     * @param string|null $privilege
+     * @inheritDoc
      */
     public function assert(
         Acl $acl,

phpcs.xml.dist

@@ -140,6 +140,7 @@
         <exclude-pattern>module/User/src/Service/Factory/UserFactory.php</exclude-pattern>
         <!-- Permission assertions -->
         <exclude-pattern>module/User/src/Permissions/Assertion/IsAfterMembershipEndedAndNotTagged.php</exclude-pattern>
+        <exclude-pattern>module/User/src/Permissions/Assertion/IsAllowedToViewPage.php</exclude-pattern>
         <exclude-pattern>module/User/src/Permissions/Assertion/IsCreator.php</exclude-pattern>
         <exclude-pattern>module/User/src/Permissions/Assertion/IsCreatorOrOrganMember.php</exclude-pattern>
         <exclude-pattern>module/User/src/Permissions/Assertion/IsOrganMember.php</exclude-pattern>