Update: Login page improve readability

Author: cannycookie

README.md

@@ -119,26 +119,24 @@ public function panel(Panel $panel): Panel
         ->login(Login::class)
         ->userMenuItems([
         /**
-        * All users page to configure their 2fa
-         */
-            MenuItem::make('two-factor')
-                    ->url(config('filament-2fa.navigation.url'))
-                    ->label(config('filament-2fa.navigation.label'))
-                    ->icon(config('filament-2fa.navigation.icon'))
-                    ->sort(config('filament-2fa.navigation.sort')),
-                
-           /**
-            * This allows editing system wide banners - should only be available to admins 
-            * May need to think about other logic to restrict access
-            */
-            MenuItem::make('two-factor-banner')
-                ->url(config('filament-2fa.banner.navigation.url'))
-                ->label(config('filament-2fa.banner.navigation.label'))
-                ->icon(config('filament-2fa.banner.navigation.icon'))
-                ->sort(config('filament-2fa.banner.navigation.sort')),
-                ->visible(config('filament-2fa.banner.auth_guards.web.can_manage')),
-        ])
-}
+        * 2FA setup and manage link
+        */
+        MenuItem::make('two-factor')
+                    ->url('/two-factor-authentication')
+                    ->label('Two Factor Auth')
+                    ->icon('heroicon-o-key')
+                    ->sort(1),
+                    
+         /**
+         * Banner manager
+         * Ensure you limit access to who can change banners 
+         */           
+        MenuItem::make('two-factor-banner')
+            ->url(config('filament-2fa.banner.navigation.url'))
+            ->label(config('filament-2fa.banner.navigation.label'))
+            ->icon(config('filament-2fa.banner.navigation.icon'))
+            ->sort(2)
+            ->visible(fn() => Filament::auth()->user()->hasRole(['Developer', 'Super Admin'],'web'))
 ```
 
 ### Step 4:

config/filament-2fa.php

@@ -20,17 +20,23 @@
         'confirm_totp_page_url' => 'confirm-2fa'
     ],
 
+    /**
+     * 2FA link options
+     */
     'navigation' => [
         'visible_on_navbar' => true,
         'icon' => 'heroicon-o-key',
         'group' => 'Auth Security',
         'label' => 'Two Factor Auth',
-        'url' => '/two-factor-authentication',
+        'url' => 'two-factor-authentication',
         'cluster' => null,
         'sort' => 1,
         'subnav_position' => SubNavigationPosition::Top
     ],
 
+    /**
+     * Configure which auth guards 2fa should apply to
+     */
     'auth_guards' => [
         'web' => [
             'enabled' => 'true',
@@ -39,18 +45,30 @@
     ],
 
     'banner' => [
+
+        /**
+         * Configure which auth guards banners should apply to
+         * This will change the dropdown in the banner editor
+         */
         'auth_guards' => [
             'web' => [
                 'can_manage' => true,
                 'can_see_banner' => true,
             ]
         ],
+
+        /**
+         * Navigation link options
+         */
         'navigation' => [
             'icon' => 'heroicon-m-megaphone',
             'label' => 'Banners',
             'url' => 'banner-manager',
             'sort' => 50,
         ],
+        /**
+         * Do not show banners on these routes
+         */
         'excluded_routes' => [
             'two-factor-authentication',
             'confirm-2fa',

src/Filament/Pages/Login.php

@@ -10,64 +10,117 @@
 use Visualbuilder\Filament2fa\TwoFactorAuthResponse;
 use Visualbuilder\Filament2fa\Contracts\TwoFactorAuthenticatable;
 use Illuminate\Support\Facades\Crypt;
+use Illuminate\Contracts\Auth\Authenticatable;
 
 class Login extends BaseLogin
 {
     public function authenticate(): null|TwoFactorAuthResponse|LoginResponse
     {
-        try {
-            $this->rateLimit(5);
-        } catch (TooManyRequestsException $exception) {
-            $this->getRateLimitedNotification($exception)?->send();
-
-            return null;
+        if ($response = $this->handleRateLimiting()) {
+            return $response;
         }
 
         $data = $this->form->getState();
+        $credentials = $this->getCredentialsFromFormData($data);
+        $remember = $data['remember'] ?? false;
 
-        $responseClass = LoginResponse::class;
-
-        if (! Filament::auth()->attempt($this->getCredentialsFromFormData($data), $data['remember'] ?? false)) {
+        if (! $this->attemptLogin($credentials, $remember)) {
             $this->throwFailureValidationException();
         }
 
         $user = Filament::auth()->user();
 
-        /** Check If user loggedin with unsafe device redirecting to 2fa verification page */
-        if ($user instanceof TwoFactorAuthenticatable && $user->hasTwoFactorEnabled() && !$user->isSafeDevice(request())) {
-            $responseClass = TwoFactorAuthResponse::class;
-            $this->flashData($this->getCredentialsFromFormData($data), $data['remember'] ?? false);
-            Filament::auth()->logout();
-            goto response;
+        if ($response = $this->handleTwoFactorAuthentication($user, $credentials, $remember)) {
+            return $response;
         }
 
-        response:
-        if (
-            ($user instanceof FilamentUser) &&
-            (! $user->canAccessPanel(Filament::getCurrentPanel()))
-        ) {
+        if (! $this->userCanAccessPanel($user)) {
             Filament::auth()->logout();
             $this->throwFailureValidationException();
         }
 
         session()->regenerate();
 
-        return app($responseClass);
+        return app(LoginResponse::class);
     }
 
     /**
-     * Flashes the credentials into the session, encrypted.
+     * Handle rate limiting for login attempts.
      */
-    protected function flashData(array $credentials, bool $remember): void
+    protected function handleRateLimiting(): ?LoginResponse
     {
-        foreach ($credentials as $key => $value) {
-            $credentials[$key] = Crypt::encryptString($value);
+        try {
+            $this->rateLimit(5);
+        } catch (TooManyRequestsException $exception) {
+            $this->getRateLimitedNotification($exception)?->send();
+            return null;
         }
 
+        return null;
+    }
+
+    /**
+     * Attempt to authenticate the user.
+     */
+    protected function attemptLogin(array $credentials, bool $remember): bool
+    {
+        return Filament::auth()->attempt($credentials, $remember);
+    }
+
+    /**
+     * Handle two-factor authentication if required.
+     */
+    protected function handleTwoFactorAuthentication(Authenticatable $user, array $credentials, bool $remember): ?TwoFactorAuthResponse
+    {
+        if ($this->needsTwoFactorAuthentication($user)) {
+            $this->flashCredentials($credentials, $remember);
+            Filament::auth()->logout();
+
+            return app(TwoFactorAuthResponse::class);
+        }
+
+        return null;
+    }
+
+    /**
+     * Determine if two-factor authentication is required.
+     */
+    protected function needsTwoFactorAuthentication(Authenticatable $user): bool
+    {
+        return $user instanceof TwoFactorAuthenticatable
+            && $user->hasTwoFactorEnabled()
+            && ! $user->isSafeDevice(request());
+    }
+
+    /**
+     * Check if the authenticated user can access the current panel.
+     */
+    protected function userCanAccessPanel(Authenticatable $user): bool
+    {
+        return ! ($user instanceof FilamentUser && ! $user->canAccessPanel(Filament::getCurrentPanel()));
+    }
+
+    /**
+     * Flash the credentials into the session, encrypted.
+     */
+    protected function flashCredentials(array $credentials, bool $remember): void
+    {
+        $encryptedCredentials = array_map(
+            fn($value) => Crypt::encryptString($value),
+            $credentials
+        );
+
+        $sessionData = [
+            'credentials' => $encryptedCredentials,
+            'remember' => $remember,
+        ];
+
+        $credentialKey = config('filament-2fa.login.credential_key');
+
         if (config('filament-2fa.login.flashLoginCredentials')) {
-            request()->session()->flash(config('filament-2fa.login.credential_key'), ['credentials' => $credentials, 'remember' => $remember]);
+            request()->session()->flash($credentialKey, $sessionData);
         } else {
-            session([config('filament-2fa.login.credential_key') => ['credentials' => $credentials, 'remember' => $remember]]);
+            session([$credentialKey => $sessionData]);
         }
     }
 }

src/Http/Middleware/SetRenderLocation.php

@@ -39,7 +39,7 @@ private function filterBannersForUser($banners, $user)
     {
         return $banners->filter(function (Banner $banner) use ($user) {
             return $banner->isVisible()
-                && $banner->sApplicableForUser($user)
+                && $banner->isApplicableForUser($user)
                 && $banner->checkGuard()
                 && $this->checkCurrentAuth();
         });