Create a voter for applying all transitions on all workflow's steps

This voter checks that the related entity's centers is reachable by the user.
This commit is contained in:
Julien Fastré 2024-09-16 14:16:42 +02:00
parent 0d54637d35
commit 4696332a46
Signed by: julienfastre
GPG Key ID: BDE2190974723FCB
3 changed files with 235 additions and 0 deletions

View File

@ -0,0 +1,88 @@
<?php
declare(strict_types=1);
/*
* Chill is a software for social workers
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace Chill\MainBundle\Security\Authorization;
use Chill\MainBundle\Entity\Workflow\EntityWorkflowStep;
use Chill\MainBundle\Security\ProvideRoleHierarchyInterface;
use Chill\MainBundle\Security\Resolver\CenterResolverManagerInterface;
use Chill\MainBundle\Workflow\EntityWorkflowManager;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface;
use Symfony\Component\Security\Core\Authorization\Voter\Voter;
/**
* A voter class that determines if a user has permission to apply all transitions
* in a workflow based on their roles and the centers they have access to.
*/
final class EntityWorkflowTransitionVoter extends Voter implements ProvideRoleHierarchyInterface
{
final public const APPLY_ALL_TRANSITIONS = 'CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION';
public function __construct(
private readonly EntityWorkflowManager $workflowManager,
private readonly AuthorizationHelperForCurrentUserInterface $authorizationHelper,
private readonly CenterResolverManagerInterface $centerResolverManager,
private readonly AccessDecisionManagerInterface $accessDecisionManager,
) {}
public function getRoles(): array
{
return [self::APPLY_ALL_TRANSITIONS];
}
public function getRolesWithoutScope(): array
{
return [self::APPLY_ALL_TRANSITIONS];
}
public function getRolesWithHierarchy(): array
{
return [
'workflow.Permissions' => [
self::APPLY_ALL_TRANSITIONS,
],
];
}
protected function supports(string $attribute, $subject): bool
{
return self::APPLY_ALL_TRANSITIONS === $attribute && $subject instanceof EntityWorkflowStep;
}
protected function voteOnAttribute(string $attribute, $subject, TokenInterface $token): bool
{
/** @var EntityWorkflowStep $subject */
$entityWorkflow = $subject->getEntityWorkflow();
if (!$this->accessDecisionManager->decide($token, [EntityWorkflowVoter::SEE], $entityWorkflow)) {
return false;
}
$handler = $this->workflowManager->getHandler($entityWorkflow);
$entity = $handler->getRelatedEntity($entityWorkflow);
if (null === $entity) {
return false;
}
$centers = $this->centerResolverManager->resolveCenters($entity);
$reachableCenters = $this->authorizationHelper->getReachableCenters(self::APPLY_ALL_TRANSITIONS);
foreach ($centers as $center) {
if (in_array($center, $reachableCenters, true)) {
return true;
}
}
return false;
}
}

View File

@ -0,0 +1,144 @@
<?php
declare(strict_types=1);
/*
* Chill is a software for social workers
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace Chill\MainBundle\Tests\Authorization;
use Chill\MainBundle\Entity\Center;
use Chill\MainBundle\Entity\User;
use Chill\MainBundle\Entity\Workflow\EntityWorkflow;
use Chill\MainBundle\Security\Authorization\AuthorizationHelperForCurrentUserInterface;
use Chill\MainBundle\Security\Authorization\EntityWorkflowTransitionVoter;
use Chill\MainBundle\Security\Authorization\EntityWorkflowVoter;
use Chill\MainBundle\Security\Resolver\CenterResolverManagerInterface;
use Chill\MainBundle\Workflow\EntityWorkflowHandlerInterface;
use Chill\MainBundle\Workflow\EntityWorkflowManager;
use PHPUnit\Framework\TestCase;
use Prophecy\PhpUnit\ProphecyTrait;
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface;
use Symfony\Component\Security\Core\Authorization\Voter\Voter;
/**
* @internal
*
* @coversNothing
*/
class EntityWorkflowTransitionVoterTest extends TestCase
{
use ProphecyTrait;
public function testVoteOnAttributeHappyScenario(): void
{
$entityWorkflow = new EntityWorkflow();
$object = new \stdClass();
$center = new Center();
$user = new User();
$handler = $this->prophesize(EntityWorkflowHandlerInterface::class);
$handler->getRelatedEntity($entityWorkflow)->willReturn($object);
$entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
$entityWorkflowManager->getHandler($entityWorkflow)->willReturn($handler);
$centerResolver = $this->prophesize(CenterResolverManagerInterface::class);
$centerResolver->resolveCenters($object)->willReturn([$center, new Center()]);
$autorizationHelper = $this->prophesize(AuthorizationHelperForCurrentUserInterface::class);
$autorizationHelper->getReachableCenters('CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION')
->willReturn([$center, new Center()]);
$token = new UsernamePasswordToken($user, 'default', $user->getRoles());
$accessDecision = $this->prophesize(AccessDecisionManagerInterface::class);
$accessDecision->decide($token, [EntityWorkflowVoter::SEE], $entityWorkflow)
->willReturn(true)->shouldBeCalled();
$voter = new EntityWorkflowTransitionVoter(
$entityWorkflowManager->reveal(),
$autorizationHelper->reveal(),
$centerResolver->reveal(),
$accessDecision->reveal(),
);
self::assertEquals(Voter::ACCESS_GRANTED, $voter->vote($token, $entityWorkflow->getCurrentStep(), ['CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION']));
}
public function testVoteOnAttributeCenterNotReachable(): void
{
$entityWorkflow = new EntityWorkflow();
$object = new \stdClass();
$user = new User();
$handler = $this->prophesize(EntityWorkflowHandlerInterface::class);
$handler->getRelatedEntity($entityWorkflow)->willReturn($object);
$entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
$entityWorkflowManager->getHandler($entityWorkflow)->willReturn($handler);
$centerResolver = $this->prophesize(CenterResolverManagerInterface::class);
$centerResolver->resolveCenters($object)->willReturn([new Center()]);
$autorizationHelper = $this->prophesize(AuthorizationHelperForCurrentUserInterface::class);
$autorizationHelper->getReachableCenters('CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION')
->willReturn([new Center()]);
$token = new UsernamePasswordToken($user, 'default', $user->getRoles());
$accessDecision = $this->prophesize(AccessDecisionManagerInterface::class);
$accessDecision->decide($token, [EntityWorkflowVoter::SEE], $entityWorkflow)
->willReturn(true)->shouldBeCalled();
$voter = new EntityWorkflowTransitionVoter(
$entityWorkflowManager->reveal(),
$autorizationHelper->reveal(),
$centerResolver->reveal(),
$accessDecision->reveal(),
);
self::assertEquals(Voter::ACCESS_DENIED, $voter->vote($token, $entityWorkflow->getCurrentStep(), ['CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION']));
}
public function testVoteNotOnSupportedAttribute(): void
{
$entityWorkflow = new EntityWorkflow();
$object = new \stdClass();
$user = new User();
$handler = $this->prophesize(EntityWorkflowHandlerInterface::class);
$handler->getRelatedEntity($entityWorkflow)->willReturn($object);
$entityWorkflowManager = $this->prophesize(EntityWorkflowManager::class);
$entityWorkflowManager->getHandler($entityWorkflow)->willReturn($handler);
$centerResolver = $this->prophesize(CenterResolverManagerInterface::class);
$centerResolver->resolveCenters($object)->willReturn([new Center()]);
$autorizationHelper = $this->prophesize(AuthorizationHelperForCurrentUserInterface::class);
$autorizationHelper->getReachableCenters('CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION')
->willReturn([new Center()]);
$token = new UsernamePasswordToken($user, 'default', $user->getRoles());
$accessDecision = $this->prophesize(AccessDecisionManagerInterface::class);
$accessDecision->decide($token, [EntityWorkflowVoter::SEE], $entityWorkflow)
->willReturn(true);
$voter = new EntityWorkflowTransitionVoter(
$entityWorkflowManager->reveal(),
$autorizationHelper->reveal(),
$centerResolver->reveal(),
$accessDecision->reveal(),
);
self::assertEquals(Voter::ACCESS_ABSTAIN, $voter->vote($token, new \stdClass(), ['CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION']));
self::assertEquals(Voter::ACCESS_ABSTAIN, $voter->vote($token, $entityWorkflow->getCurrentStep(), ['SOMETHING_ELSE']));
}
}

View File

@ -532,6 +532,8 @@ workflow:
On hold: En attente
Automated transition: Transition automatique
waiting_for_signature: En attente de signature
Permissions: Workflows (suivi de décision)
signature_zone:
title: Signatures électroniques
@ -551,6 +553,7 @@ workflow:
Subscribe final: Recevoir une notification à l'étape finale
Subscribe all steps: Recevoir une notification à chaque étape
CHILL_MAIN_WORKFLOW_APPLY_ALL_TRANSITION: Appliquer les transitions sur tous les workflows
notification:
Notification: Notification