vendor/easycorp/easyadmin-bundle/src/Security/SecurityVoter.php line 19

Open in your IDE?
  1. <?php
  3. namespace EasyCorp\Bundle\EasyAdminBundle\Security;
  5. use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
  6. use EasyCorp\Bundle\EasyAdminBundle\Dto\ActionDto;
  7. use EasyCorp\Bundle\EasyAdminBundle\Dto\CrudDto;
  8. use EasyCorp\Bundle\EasyAdminBundle\Dto\EntityDto;
  9. use EasyCorp\Bundle\EasyAdminBundle\Dto\FieldDto;
  10. use EasyCorp\Bundle\EasyAdminBundle\Dto\MenuItemDto;
  11. use EasyCorp\Bundle\EasyAdminBundle\Provider\AdminContextProvider;
  12. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  13. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  14. use Symfony\Component\Security\Core\Authorization\Voter\Voter;
  16. /**
  17. * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  18. */
  19. final class SecurityVoter extends Voter
  20. {
  21. private $authorizationChecker;
  22. private $adminContextProvider;
  24. public function __construct(AuthorizationCheckerInterface $authorizationChecker, AdminContextProvider $adminContextProvider)
  25. {
  26. $this->authorizationChecker = $authorizationChecker;
  27. $this->adminContextProvider = $adminContextProvider;
  28. }
  30. /**
  31. * @return bool
  32. */
  33. protected function supports($permissionName, $subject)
  34. {
  35. return Permission::exists($permissionName);
  36. }
  38. protected function voteOnAttribute($permissionName, $subject, TokenInterface $token): bool
  39. {
  40. if (Permission::EA_VIEW_MENU_ITEM === $permissionName) {
  41. return $this->voteOnViewMenuItemPermission($subject);
  42. }
  44. if (Permission::EA_EXECUTE_ACTION === $permissionName) {
  45. return $this->voteOnExecuteActionPermission($this->adminContextProvider->getContext()->getCrud(), $subject['action'] ?? null, $subject['entity'] ?? null);
  46. }
  48. if (Permission::EA_VIEW_FIELD === $permissionName) {
  49. return $this->voteOnViewPropertyPermission($subject);
  50. }
  52. if (Permission::EA_ACCESS_ENTITY === $permissionName) {
  53. return $this->voteOnViewEntityPermission($subject);
  54. }
  56. if (Permission::EA_EXIT_IMPERSONATION === $permissionName) {
  57. return $this->voteOnExitImpersonationPermission();
  58. }
  60. return true;
  61. }
  63. private function voteOnViewMenuItemPermission(MenuItemDto $menuItemDto): bool
  64. {
  65. // users can see the menu item if they have the permission required by the menu item
  66. return $this->authorizationChecker->isGranted($menuItemDto->getPermission(), $menuItemDto);
  67. }
  69. /**
  70. * @param string|ActionDto $actionNameOrDto
  71. */
  72. private function voteOnExecuteActionPermission(CrudDto $crudDto, $actionNameOrDto, ?EntityDto $entityDto): bool
  73. {
  74. // users can run the Crud action if:
  75. // * they have the required permission to execute the action on the given entity instance
  76. // * the action is not disabled
  78. if (!\is_string($actionNameOrDto) && !($actionNameOrDto instanceof ActionDto)) {
  79. throw new \RuntimeException(sprintf('When checking the "%s" permission with the isGranted() method, the value of the "action" parameter passed inside the voter $subject must be a string with the action name or a "%s" object.', Permission::EA_EXECUTE_ACTION, ActionDto::class));
  80. }
  81. $actionName = \is_string($actionNameOrDto) ? $actionNameOrDto : $actionNameOrDto->getName();
  83. $actionPermission = $crudDto->getActionsConfig()->getActionPermissions()[$actionName] ?? null;
  84. $disabledActionNames = $crudDto->getActionsConfig()->getDisabledActions();
  86. $subject = null === $entityDto ? null : $entityDto->getInstance();
  88. return $this->authorizationChecker->isGranted($actionPermission, $subject) && !\in_array($actionName, $disabledActionNames, true);
  89. }
  91. private function voteOnViewPropertyPermission(FieldDto $field): bool
  92. {
  93. // users can see the field if they have the permission required by the field
  94. return $this->authorizationChecker->isGranted($field->getPermission(), $field);
  95. }
  97. private function voteOnViewEntityPermission(EntityDto $entityDto): bool
  98. {
  99. // users can see the entity if they have the required permission on the specific entity instance
  100. return $this->authorizationChecker->isGranted($entityDto->getPermission(), $entityDto->getInstance());
  101. }
  103. private function voteOnExitImpersonationPermission(): bool
  104. {
  105. // users can exit impersonation if they are currently impersonating another user.
  106. // In Symfony, that means that current user has the special impersonator permission
  107. if (\defined('Symfony\Component\Security\Core\Authorization\Voter\AuthenticatedVoter::IS_IMPERSONATOR')) {
  108. $impersonatorPermission = 'IS_IMPERSONATOR';
  109. } else {
  110. $impersonatorPermission = 'ROLE_PREVIOUS_ADMIN';
  111. }
  113. return $this->authorizationChecker->isGranted($impersonatorPermission);
  114. }
  115. }