vendor/symfony/security-bundle/DataCollector/SecurityDataCollector.php line 68

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\SecurityBundle\DataCollector;
  14. use Symfony\Bundle\SecurityBundle\Debug\TraceableFirewallListener;
  15. use Symfony\Bundle\SecurityBundle\Security\FirewallMap;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\HttpKernel\DataCollector\DataCollector;
  19. use Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface;
  20. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  21. use Symfony\Component\Security\Core\Authentication\Token\SwitchUserToken;
  22. use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface;
  23. use Symfony\Component\Security\Core\Authorization\TraceableAccessDecisionManager;
  24. use Symfony\Component\Security\Core\Authorization\Voter\TraceableVoter;
  25. use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
  26. use Symfony\Component\Security\Http\Firewall\SwitchUserListener;
  27. use Symfony\Component\Security\Http\FirewallMapInterface;
  28. use Symfony\Component\Security\Http\Logout\LogoutUrlGenerator;
  29. use Symfony\Component\VarDumper\Caster\ClassStub;
  30. use Symfony\Component\VarDumper\Cloner\Data;
  32. /**
  33.  * @author Fabien Potencier <fabien@symfony.com>
  34.  *
  35.  * @final
  36.  */
  37. class SecurityDataCollector extends DataCollector implements LateDataCollectorInterface
  38. {
  39.     private ?TokenStorageInterface $tokenStorage;
  40.     private ?RoleHierarchyInterface $roleHierarchy;
  41.     private ?LogoutUrlGenerator $logoutUrlGenerator;
  42.     private ?AccessDecisionManagerInterface $accessDecisionManager;
  43.     private ?FirewallMapInterface $firewallMap;
  44.     private ?TraceableFirewallListener $firewall;
  45.     private bool $hasVarDumper;
  47.     public function __construct(?TokenStorageInterface $tokenStorage = null, ?RoleHierarchyInterface $roleHierarchy = null, ?LogoutUrlGenerator $logoutUrlGenerator = null, ?AccessDecisionManagerInterface $accessDecisionManager = null, ?FirewallMapInterface $firewallMap = null, ?TraceableFirewallListener $firewall = null)
  48.     {
  49.         $this->tokenStorage = $tokenStorage;
  50.         $this->roleHierarchy = $roleHierarchy;
  51.         $this->logoutUrlGenerator = $logoutUrlGenerator;
  52.         $this->accessDecisionManager = $accessDecisionManager;
  53.         $this->firewallMap = $firewallMap;
  54.         $this->firewall = $firewall;
  55.         $this->hasVarDumper = class_exists(ClassStub::class);
  56.     }
  58.     public function collect(Request $request, Response $response, ?\Throwable $exception = null): void
  59.     {
  60.         if (null === $this->tokenStorage) {
  61.             $this->data = [
  62.                 'enabled' => false,
  63.                 'authenticated' => false,
  64.                 'impersonated' => false,
  65.                 'impersonator_user' => null,
  66.                 'impersonation_exit_path' => null,
  67.                 'token' => null,
  68.                 'token_class' => null,
  69.                 'logout_url' => null,
  70.                 'user' => '',
  71.                 'roles' => [],
  72.                 'inherited_roles' => [],
  73.                 'supports_role_hierarchy' => null !== $this->roleHierarchy,
  74.             ];
  75.         } elseif (null === $token = $this->tokenStorage->getToken()) {
  76.             $this->data = [
  77.                 'enabled' => true,
  78.                 'authenticated' => false,
  79.                 'impersonated' => false,
  80.                 'impersonator_user' => null,
  81.                 'impersonation_exit_path' => null,
  82.                 'token' => null,
  83.                 'token_class' => null,
  84.                 'logout_url' => null,
  85.                 'user' => '',
  86.                 'roles' => [],
  87.                 'inherited_roles' => [],
  88.                 'supports_role_hierarchy' => null !== $this->roleHierarchy,
  89.             ];
  90.         } else {
  91.             $inheritedRoles = [];
  92.             $assignedRoles = $token->getRoleNames();
  94.             $impersonatorUser = null;
  95.             if ($token instanceof SwitchUserToken) {
  96.                 $originalToken = $token->getOriginalToken();
  97.                 $impersonatorUser = $originalToken->getUserIdentifier();
  98.             }
  100.             if (null !== $this->roleHierarchy) {
  101.                 foreach ($this->roleHierarchy->getReachableRoleNames($assignedRoles) as $role) {
  102.                     if (!\in_array($role, $assignedRoles, true)) {
  103.                         $inheritedRoles[] = $role;
  104.                     }
  105.                 }
  106.             }
  108.             $logoutUrl = null;
  109.             try {
  110.                 $logoutUrl = $this->logoutUrlGenerator?->getLogoutPath();
  111.             } catch (\Exception) {
  112.                 // fail silently when the logout URL cannot be generated
  113.             }
  115.             $this->data = [
  116.                 'enabled' => true,
  117.                 'authenticated' => (bool) $token->getUser(),
  118.                 'impersonated' => null !== $impersonatorUser,
  119.                 'impersonator_user' => $impersonatorUser,
  120.                 'impersonation_exit_path' => null,
  121.                 'token' => $token,
  122.                 'token_class' => $this->hasVarDumper ? new ClassStub($token::class) : $token::class,
  123.                 'logout_url' => $logoutUrl,
  124.                 'user' => $token->getUserIdentifier(),
  125.                 'roles' => $assignedRoles,
  126.                 'inherited_roles' => array_unique($inheritedRoles),
  127.                 'supports_role_hierarchy' => null !== $this->roleHierarchy,
  128.             ];
  129.         }
  131.         // collect voters and access decision manager information
  132.         if ($this->accessDecisionManager instanceof TraceableAccessDecisionManager) {
  133.             $this->data['voter_strategy'] = $this->accessDecisionManager->getStrategy();
  134.             $this->data['voters'] = [];
  136.             foreach ($this->accessDecisionManager->getVoters() as $voter) {
  137.                 if ($voter instanceof TraceableVoter) {
  138.                     $voter = $voter->getDecoratedVoter();
  139.                 }
  141.                 $this->data['voters'][] = $this->hasVarDumper ? new ClassStub($voter::class) : $voter::class;
  142.             }
  144.             // collect voter details
  145.             $decisionLog = $this->accessDecisionManager->getDecisionLog();
  146.             foreach ($decisionLog as $key => $log) {
  147.                 $decisionLog[$key]['voter_details'] = [];
  148.                 foreach ($log['voterDetails'] as $voterDetail) {
  149.                     $voterClass = $voterDetail['voter']::class;
  150.                     $classData = $this->hasVarDumper ? new ClassStub($voterClass) : $voterClass;
  151.                     $decisionLog[$key]['voter_details'][] = [
  152.                         'class' => $classData,
  153.                         'attributes' => $voterDetail['attributes'], // Only displayed for unanimous strategy
  154.                         'vote' => $voterDetail['vote'],
  155.                     ];
  156.                 }
  157.                 unset($decisionLog[$key]['voterDetails']);
  158.             }
  160.             $this->data['access_decision_log'] = $decisionLog;
  161.         } else {
  162.             $this->data['access_decision_log'] = [];
  163.             $this->data['voter_strategy'] = 'unknown';
  164.             $this->data['voters'] = [];
  165.         }
  167.         // collect firewall context information
  168.         $this->data['firewall'] = null;
  169.         if ($this->firewallMap instanceof FirewallMap) {
  170.             $firewallConfig = $this->firewallMap->getFirewallConfig($request);
  171.             if (null !== $firewallConfig) {
  172.                 $this->data['firewall'] = [
  173.                     'name' => $firewallConfig->getName(),
  174.                     'request_matcher' => $firewallConfig->getRequestMatcher(),
  175.                     'security_enabled' => $firewallConfig->isSecurityEnabled(),
  176.                     'stateless' => $firewallConfig->isStateless(),
  177.                     'provider' => $firewallConfig->getProvider(),
  178.                     'context' => $firewallConfig->getContext(),
  179.                     'entry_point' => $firewallConfig->getEntryPoint(),
  180.                     'access_denied_handler' => $firewallConfig->getAccessDeniedHandler(),
  181.                     'access_denied_url' => $firewallConfig->getAccessDeniedUrl(),
  182.                     'user_checker' => $firewallConfig->getUserChecker(),
  183.                     'authenticators' => $firewallConfig->getAuthenticators(),
  184.                 ];
  186.                 // generate exit impersonation path from current request
  187.                 if ($this->data['impersonated'] && null !== $switchUserConfig = $firewallConfig->getSwitchUser()) {
  188.                     $exitPath = $request->getRequestUri();
  189.                     $exitPath .= null === $request->getQueryString() ? '?' : '&';
  190.                     $exitPath .= sprintf('%s=%s', urlencode($switchUserConfig['parameter']), SwitchUserListener::EXIT_VALUE);
  192.                     $this->data['impersonation_exit_path'] = $exitPath;
  193.                 }
  194.             }
  195.         }
  197.         // collect firewall listeners information
  198.         $this->data['listeners'] = [];
  199.         if ($this->firewall) {
  200.             $this->data['listeners'] = $this->firewall->getWrappedListeners();
  201.         }
  203.         $this->data['authenticators'] = $this->firewall ? $this->firewall->getAuthenticatorsInfo() : [];
  204.     }
  206.     public function reset(): void
  207.     {
  208.         $this->data = [];
  209.     }
  211.     public function lateCollect(): void
  212.     {
  213.         $this->data = $this->cloneVar($this->data);
  214.     }
  216.     /**
  217.      * Checks if security is enabled.
  218.      */
  219.     public function isEnabled(): bool
  220.     {
  221.         return $this->data['enabled'];
  222.     }
  224.     /**
  225.      * Gets the user.
  226.      */
  227.     public function getUser(): string
  228.     {
  229.         return $this->data['user'];
  230.     }
  232.     /**
  233.      * Gets the roles of the user.
  234.      */
  235.     public function getRoles(): array|Data
  236.     {
  237.         return $this->data['roles'];
  238.     }
  240.     /**
  241.      * Gets the inherited roles of the user.
  242.      */
  243.     public function getInheritedRoles(): array|Data
  244.     {
  245.         return $this->data['inherited_roles'];
  246.     }
  248.     /**
  249.      * Checks if the data contains information about inherited roles. Still the inherited
  250.      * roles can be an empty array.
  251.      */
  252.     public function supportsRoleHierarchy(): bool
  253.     {
  254.         return $this->data['supports_role_hierarchy'];
  255.     }
  257.     /**
  258.      * Checks if the user is authenticated or not.
  259.      */
  260.     public function isAuthenticated(): bool
  261.     {
  262.         return $this->data['authenticated'];
  263.     }
  265.     public function isImpersonated(): bool
  266.     {
  267.         return $this->data['impersonated'];
  268.     }
  270.     public function getImpersonatorUser(): ?string
  271.     {
  272.         return $this->data['impersonator_user'];
  273.     }
  275.     public function getImpersonationExitPath(): ?string
  276.     {
  277.         return $this->data['impersonation_exit_path'];
  278.     }
  280.     /**
  281.      * Get the class name of the security token.
  282.      */
  283.     public function getTokenClass(): string|Data|null
  284.     {
  285.         return $this->data['token_class'];
  286.     }
  288.     /**
  289.      * Get the full security token class as Data object.
  290.      */
  291.     public function getToken(): ?Data
  292.     {
  293.         return $this->data['token'];
  294.     }
  296.     /**
  297.      * Get the logout URL.
  298.      */
  299.     public function getLogoutUrl(): ?string
  300.     {
  301.         return $this->data['logout_url'];
  302.     }
  304.     /**
  305.      * Returns the FQCN of the security voters enabled in the application.
  306.      *
  307.      * @return string[]|Data
  308.      */
  309.     public function getVoters(): array|Data
  310.     {
  311.         return $this->data['voters'];
  312.     }
  314.     /**
  315.      * Returns the strategy configured for the security voters.
  316.      */
  317.     public function getVoterStrategy(): string
  318.     {
  319.         return $this->data['voter_strategy'];
  320.     }
  322.     /**
  323.      * Returns the log of the security decisions made by the access decision manager.
  324.      */
  325.     public function getAccessDecisionLog(): array|Data
  326.     {
  327.         return $this->data['access_decision_log'];
  328.     }
  330.     /**
  331.      * Returns the configuration of the current firewall context.
  332.      */
  333.     public function getFirewall(): array|Data|null
  334.     {
  335.         return $this->data['firewall'];
  336.     }
  338.     public function getListeners(): array|Data
  339.     {
  340.         return $this->data['listeners'];
  341.     }
  343.     public function getAuthenticators(): array|Data
  344.     {
  345.         return $this->data['authenticators'];
  346.     }
  348.     public function getName(): string
  349.     {
  350.         return 'security';
  351.     }
  352. }