10000 Fixed the sample security voter to take into account the role hierarchy by javiereguiluz · Pull Request #5024 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Fixed the sample security voter to take into account the role hierarchy #5024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Fixed the sample security voter to take into account the role hierarchy #5024

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e6b10e9
Fixed the sample security voter to take into account the role hierarchy
javiereguiluz Feb 19, 2015
f9be868
Minor fixes in the sample code
javiereguiluz Feb 19, 2015
d68003c
'security.role_hierarchy' service is only defined when you actually u…
javiereguiluz Feb 21, 2015
75b35e0
Fixed the code sample when the application doesn't use the RoleHierarchy
javiereguiluz Feb 23, 2015
3dd747c
Fixed some grammar issues
javiereguiluz Feb 24, 2015
471ecda
Replaced TokenInterface by UserInterface
javiereguiluz Feb 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion best_practices/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,22 @@ the same ``getAuthorEmail`` logic you used above:< 8000 /td>

use Symfony\Component\Security\Core\Authorization\Voter\AbstractVoter;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
use Symfony\Component\Security\Core\User\UserInterface;

// AbstractVoter class requires Symfony 2.6 or higher version
class PostVoter extends AbstractVoter
{
const CREATE = 'create';
const EDIT = 'edit';

private $roleHierarchy;

public function __construct(RoleHierarchyInterface $roleHierarchy = null)
{
$this->roleHierarchy = $roleHierarchy;
}

protected function getSupportedAttributes()
{
return array(self::CREATE, self::EDIT);
Expand All @@ -163,7 +172,7 @@ the same ``getAuthorEmail`` logic you used above:
return false;
}

if ($attribute === self::CREATE && in_array('ROLE_ADMIN', $user->getRoles(), true)) {
if ($attribute === self::CREATE && $this->userHasRole($user, 'ROLE_ADMIN')) {
return true;
}

Expand All @@ -173,6 +182,25 @@ the same ``getAuthorEmail`` logic you used above:

return false;
}

/**
* Checks if the user token has the given role taking into account the
* entire role hierarchy if defined by the application.
*/
private function userHasRole(UserInterface $user, $roleName)
{
if (null === $this->roleHierarchy) {
return in_array($roleName, $user->getRoles(), true);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is wrong. You should be using the roles from the token to be consistent with the way the RoleVoter is working

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no way to retrieve token https://github.com/symfony/symfony/blob/2.7/src/Symfony/Component/Security/Core/Authorization/Voter/AbstractVoter.php#L76

}

foreach ($this->roleHierarchy->getReachableRoles($user->getRoles()) as $role) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$user->getRoles() can represent roles as strings, which is not supported by getReachableRoles (the Token class is normalizing this, and getReachableRoles is meant to work with $token->getRoles()

if ($roleName === $role->getRole()) {
return true;
}
}

return false;
}
}

To enable the security voter in the application, define a new service:
Expand All @@ -184,6 +212,9 @@ To enable the security voter in the application, define a new service:
# ...
post_voter:
class: AppBundle\Security\PostVoter
# beware that the 'security.role_hierarchy' service is only defined
# when the application's security config uses the role hierarchy
arguments: ["@?security.role_hierarchy"]
public: false
tags:
- { name: security.voter }
Expand Down
0