#26294

pending completion

Build # #26294

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/13712ad6e740ee998b673b638ef0be19680d6967">13712ad6e<a href="https://github.com/api-platform/core/commit/13712ad6e740ee998b673b638ef0be19680d6967">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/d0c1bcbf20b044093c28e87f2211b79e03cf4cfd">d0c1bcbf2</a>">d0c1bcbf2</a><a href="https://github.com/api-platform/core/commit/13712ad6e740ee998b673b638ef0be19680d6967"> into 126e65d8c">126e65d8c</a>

Run Details

11 of 11 new or added lines in 2 files covered. (100.0%)

9435 of 11401 relevant lines covered (82.76%)

14.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.0

/src/Security/ResourceAccessChecker.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Security;

use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;

/**
 * Checks if the logged user has sufficient permissions to access the given resource.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ResourceAccessChecker implements ResourceAccessCheckerInterface
{
    private $expressionLanguage;
    private $authenticationTrustResolver;
    private $roleHierarchy;
    private $tokenStorage;
    private $authorizationChecker;

    public function __construct(ExpressionLanguage $expressionLanguage = null, AuthenticationTrustResolverInterface $authenticationTrustResolver = null, RoleHierarchyInterface $roleHierarchy = null, TokenStorageInterface $tokenStorage = null, AuthorizationCheckerInterface $authorizationChecker = null)
    {
        $this->expressionLanguage = $expressionLanguage;
        $this->authenticationTrustResolver = $authenticationTrustResolver;
        $this->roleHierarchy = $roleHierarchy;
        $this->tokenStorage = $tokenStorage;
        $this->authorizationChecker = $authorizationChecker;
    }

    public function isGranted(string $resourceClass, string $expression, array $extraVariables = []): bool
    {
        if (null === $this->tokenStorage || null === $this->authenticationTrustResolver) {
            throw new \LogicException('The "symfony/security" library must be installed to use the "security" attribute.');
        }
        if (null === $this->expressionLanguage) {
            throw new \LogicException('The "symfony/expression-language" library must be installed to use the "security" attribute.');
        }

        $variables = array_merge($extraVariables, [
            'trust_resolver' => $this->authenticationTrustResolver,
            'auth_checker' => $this->authorizationChecker, // needed for the is_granted expression function
        ]);

        if ($token = $this->tokenStorage->getToken()) {
            $variables = array_merge($variables, $this->getVariables($token));
        }

        return (bool) $this->expressionLanguage->evaluate($expression, $variables);
    }

    /**
     * @copyright Fabien Potencier <fabien@symfony.com>
     *
     * @see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Security/Core/Authorization/Voter/ExpressionVoter.php
     */
    private function getVariables(TokenInterface $token): array
    {
        return [
            'token' => $token,
            'user' => $token->getUser(),
            'roles' => $this->getEffectiveRoles($token),
        ];
    }

    /**
     * @return string[]
     */
    private function getEffectiveRoles(TokenInterface $token): array
    {
        if (null === $this->roleHierarchy) {
            return method_exists($token, 'getRoleNames') ? $token->getRoleNames() : array_map('strval', $token->getRoles()); // @phpstan-ignore-line
        }

        if (method_exists($this->roleHierarchy, 'getReachableRoleNames')) {
            return $this->roleHierarchy->getReachableRoleNames($token->getRoleNames());
        }

        return array_map(static function (Role $role): string { // @phpstan-ignore-line
            return $role->getRole(); // @phpstan-ignore-line
        }, $this->roleHierarchy->getReachableRoles($token->getRoles())); // @phpstan-ignore-line
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Security;
15
16	use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
17	use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
18	use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
19	use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
20	use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
21	use Symfony\Component\Security\Core\Role\Role;
22	use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
23
24	/**
25	* Checks if the logged user has sufficient permissions to access the given resource.
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	*/
29	final class ResourceAccessChecker implements ResourceAccessCheckerInterface
30	{
31	private $expressionLanguage;
32	private $authenticationTrustResolver;
33	private $roleHierarchy;
34	private $tokenStorage;
35	private $authorizationChecker;
36
37	public function __construct(ExpressionLanguage $expressionLanguage = null, AuthenticationTrustResolverInterface $authenticationTrustResolver = null, RoleHierarchyInterface $roleHierarchy = null, TokenStorageInterface $tokenStorage = null, AuthorizationCheckerInterface $authorizationChecker = null)
38	{
39	$this->expressionLanguage = $expressionLanguage;	39✔
40	$this->authenticationTrustResolver = $authenticationTrustResolver;	39✔
41	$this->roleHierarchy = $roleHierarchy;	39✔
42	$this->tokenStorage = $tokenStorage;	39✔
43	$this->authorizationChecker = $authorizationChecker;	39✔
44	}	39✔
45
46	public function isGranted(string $resourceClass, string $expression, array $extraVariables = []): bool
47	{
48	if (null === $this->tokenStorage \|\| null === $this->authenticationTrustResolver) {	12✔
49	throw new \LogicException('The "symfony/security" library must be installed to use the "security" attribute.');	2✔
50	}
51	if (null === $this->expressionLanguage) {	10✔
52	throw new \LogicException('The "symfony/expression-language" library must be installed to use the "security" attribute.');	3✔
53	}
54
55	$variables = array_merge($extraVariables, [	7✔
56	'trust_resolver' => $this->authenticationTrustResolver,	7✔
57	'auth_checker' => $this->authorizationChecker, // needed for the is_granted expression function	7✔
58	]);
59
60	if ($token = $this->tokenStorage->getToken()) {	7✔
61	$variables = array_merge($variables, $this->getVariables($token));	7✔
62	}
63
64	return (bool) $this->expressionLanguage->evaluate($expression, $variables);	7✔
65	}
66
67	/**
68	* @copyright Fabien Potencier <fabien@symfony.com>
69	*
70	* @see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Security/Core/Authorization/Voter/ExpressionVoter.php
71	*/
72	private function getVariables(TokenInterface $token): array
73	{
74	return [
75	'token' => $token,	7✔
76	'user' => $token->getUser(),	7✔
77	'roles' => $this->getEffectiveRoles($token),	7✔
78	];
79	}
80
81	/**
82	* @return string[]
83	*/
84	private function getEffectiveRoles(TokenInterface $token): array
85	{
86	if (null === $this->roleHierarchy) {	7✔
87	return method_exists($token, 'getRoleNames') ? $token->getRoleNames() : array_map('strval', $token->getRoles()); // @phpstan-ignore-line	2✔
88	}
89
90	if (method_exists($this->roleHierarchy, 'getReachableRoleNames')) {	5✔
91	return $this->roleHierarchy->getReachableRoleNames($token->getRoleNames());	5✔
92	}
93
94	return array_map(static function (Role $role): string { // @phpstan-ignore-line
95	return $role->getRole(); // @phpstan-ignore-line	×
96	}, $this->roleHierarchy->getReachableRoles($token->getRoles())); // @phpstan-ignore-line	×
97	}
98	}

api-platform / core / #26294

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous