feature #51585 [Security] Add badge resolution to profiler (Jean-Beru)

fabpot · fabpot · commit fee9b30b798b · 2023-09-10T11:07:23.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Security] Add badge resolution to profiler | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | #36668 | License | MIT | Doc PR | This PR add badges resolution status in Security profiler as mentioned in #36668 (" See which badges are resolved and which aren't"). ### CSRF error ![image](https://github.com/symfony/symfony/assets/6114779/fbadfdeb-451f-4ac1-bd59-23f0cb121e6d) ### Wrong credentials ![image](https://github.com/symfony/symfony/assets/6114779/49246ffa-4152-448c-b82e-eebd43bad9d8) ### Authentication successful ![image](https://github.com/symfony/symfony/assets/6114779/1cb5f9a7-5dc2-460c-a744-0f89fb6b8e3b) Commits ------- 2324da2 [Security] Add badge resolution to profiler
diff --git a/src/Symfony/Bundle/SecurityBundle/Resources/views/Collector/security.html.twig b/src/Symfony/Bundle/SecurityBundle/Resources/views/Collector/security.html.twig
@@ -28,6 +28,25 @@
             border: 0;
             padding: 0 0 8px 0;
         }
+
+        #collector-content .authenticators .badge {
+            color: var(--white);
+            display: inline-block;
+            text-align: center;
+        }
+        #collector-content .authenticators .badge.badge-resolved {
+            background-color: var(--green-500);
+        }
+        #collector-content .authenticators .badge.badge-not_resolved {
+            background-color: var(--yellow-500);
+        }
+
+        #collector-content .authenticators svg[data-icon-name="icon-tabler-check"] {
+            color: var(--green-500);
+        }
+        #collector-content .authenticators svg[data-icon-name="icon-tabler-x"] {
+            color: var(--red-500);
+        }
     </style>
 {% endblock %}
 
@@ -316,13 +335,15 @@
                 <h3 class="tab-title">Authenticators</h3>
                 <div class="tab-content">
                     {% if collector.authenticators|default([]) is not empty %}
-                        <table>
+                        <table class="authenticators">
                             <thead>
                             <tr>
                                 <th>Authenticator</th>
                                 <th>Supports</th>
+                                <th>Authenticated</th>
                                 <th>Duration</th>
                                 <th>Passport</th>
+                                <th>Badges</th>
                             </tr>
                             </thead>
 
@@ -340,8 +361,18 @@
                                 <tr>
                                     <td class="font-normal">{{ profiler_dump(authenticator.stub) }}</td>
                                     <td class="no-wrap">{{ source('@WebProfiler/Icon/' ~ (authenticator.supports ? 'yes' : 'no') ~ '.svg') }}</td>
+                                    <td class="no-wrap">{{ authenticator.authenticated is not null ? source('@WebProfiler/Icon/' ~ (authenticator.authenticated ? 'yes' : 'no') ~ '.svg') : '' }}</td>
                                     <td class="no-wrap">{{ '%0.2f'|format(authenticator.duration * 1000) }} ms</td>
                                     <td class="font-normal">{{ authenticator.passport ? profiler_dump(authenticator.passport) : '(none)' }}</td>
+                                    <td class="font-normal">
+                                        {% for badge in authenticator.badges ?? [] %}
+                                            <span class="badge badge-{{ badge.resolved ? 'resolved' : 'not_resolved' }}">
+                                            {{ badge.stub|abbr_class }}
+                                            </span>
+                                        {% else %}
+                                            (none)
+                                        {% endfor %}
+                                    </td>
                                 </tr>
 
                                 {% if loop.last %}
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticator.php b/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticator.php
@@ -17,6 +17,7 @@
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
 use Symfony\Component\Security\Http\Authenticator\InteractiveAuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\Passport\Badge\BadgeInterface;
 use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
 use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
 use Symfony\Component\Security\Http\EntryPoint\Exception\NotAnEntryPointException;
@@ -29,14 +30,13 @@
  */
 final class TraceableAuthenticator implements AuthenticatorInterface, InteractiveAuthenticatorInterface, AuthenticationEntryPointInterface
 {
-    private AuthenticatorInterface $authenticator;
     private ?Passport $passport = null;
     private ?float $duration = null;
     private ClassStub|string $stub;
+    private ?bool $authenticated = null;
 
-    public function __construct(AuthenticatorInterface $authenticator)
+    public function __construct(private AuthenticatorInterface $authenticator)
     {
-        $this->authenticator = $authenticator;
     }
 
     public function getInfo(): array
@@ -46,6 +46,16 @@ public function getInfo(): array
             'passport' => $this->passport,
             'duration' => $this->duration,
             'stub' => $this->stub ??= class_exists(ClassStub::class) ? new ClassStub($this->authenticator::class) : $this->authenticator::class,
+            'authenticated' => $this->authenticated,
+            'badges' => array_map(
+                static function (BadgeInterface $badge): array {
+                    return [
+                        'stub' => class_exists(ClassStub::class) ? new ClassStub($badge::class) : $badge::class,
+                        'resolved' => $badge->isResolved(),
+                    ];
+                },
+                $this->passport->getBadges(),
+            ),
         ];
     }
 
@@ -70,11 +80,15 @@ public function createToken(Passport $passport, string $firewallName): TokenInte
 
     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
     {
+        $this->authenticated = true;
+
         return $this->authenticator->onAuthenticationSuccess($request, $token, $firewallName);
     }
 
     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
     {
+        $this->authenticated = false;
+
         return $this->authenticator->onAuthenticationFailure($request, $exception);
     }
 
diff --git a/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticatorManagerListener.php b/src/Symfony/Component/Security/Http/Authenticator/Debug/TraceableAuthenticatorManagerListener.php
@@ -53,6 +53,8 @@ public function authenticate(RequestEvent $event): void
                 'stub' => $this->hasVardumper ? new ClassStub($skippedAuthenticator::class) : $skippedAuthenticator::class,
                 'passport' => null,
                 'duration' => 0,
+                'authenticated' => null,
+                'badges' => [],
             ];
         }
 

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,8 @@ public function authenticate(RequestEvent $event): void`
`53`	`53`	`'stub' => $this->hasVardumper ? new ClassStub($skippedAuthenticator::class) : $skippedAuthenticator::class,`
`54`	`54`	`'passport' => null,`
`55`	`55`	`'duration' => 0,`
	`56`	`+ 'authenticated' => null,`
	`57`	`+ 'badges' => [],`
`56`	`58`	`];`
`57`	`59`	`}`
`58`	`60`