Security

Authentication

Basics

MoonShine provides a built-in authentication system that by default uses its own user model and guard. This allows you to quickly get started with the admin panel without worrying about setting up authentication.

Configuration

The main authentication settings are located in the configuration file config/moonshine.php in the auth section:

'auth' => [ 'enabled' => true, 'guard' => 'moonshine', 'model' => MoonshineUser::class, 'middleware' => Authenticate::class, 'pipelines' => [], ], 
'auth' => [
    'enabled' => true,
    'guard' => 'moonshine',
    'model' => MoonshineUser::class,
    'middleware' => Authenticate::class,
    'pipelines' => [],
],

Here you can configure:

  • enabled: enable/disable built-in authentication
  • guard: name of the guard for authentication
  • model: user model class
  • middleware: middleware for authentication
  • pipelines: additional pipelines for the authentication process

Customization

You can customize authentication in MoonShineServiceProvider:

$config ->guard('admin') ->authMiddleware(CustomAuthMiddleware::class) ->authPipelines([ TwoFactorAuthentication::class, PhoneVerification::class, ]); 
$config
    ->guard('admin')
    ->authMiddleware(CustomAuthMiddleware::class)
    ->authPipelines([
        TwoFactorAuthentication::class,
        PhoneVerification::class,
    ]);

Disabling authentication

If you want to disable the built-in authentication of MoonShine, you can do this in MoonShineServiceProvider:

$config->authDisable(); 
$config->authDisable();

Custom user model

If you want to use your own user model instead of MoonshineUser, you can specify it in the configuration:

'auth' => [ 'model' => App\Models\Admin::class, ], 
'auth' => [
    'model' => App\Models\Admin::class,
],

Custom user fields and profile

MoonShine allows you to customize the user fields used for authentication and profile:

$config ->userField('username', 'login') ->userField('password', 'pass') ->userField('name', 'full_name') ->userField('avatar', 'profile_image'); 
$config
    ->userField('username', 'login')
    ->userField('password', 'pass')
    ->userField('name', 'full_name')
    ->userField('avatar', 'profile_image');

If you want to completely replace the profile page with your own, you can do this through the moonshine.php configuration:

'pages' => [ 'profile' => App\MoonShine\Pages\CustomProfile::class, ], 
'pages' => [
    'profile' => App\MoonShine\Pages\CustomProfile::class,
],

Or through MoonShineServiceProvider:

$config->changePage(\MoonShine\Laravel\Pages\ProfilePage::class, \App\MoonShine\Pages\CustomProfile::class); 
$config->changePage(\MoonShine\Laravel\Pages\ProfilePage::class, \App\MoonShine\Pages\CustomProfile::class);

Role-based access

If you need to restrict access to the MoonShine admin panel based on user roles or other conditions, you can easily add your own middleware.

Creating middleware

Create a new middleware, for example, CheckAdminRole:

namespace App\Http\Middleware; use Closure; use Illuminate\Http\Request; use Symfony\Component\HttpFoundation\Response; class CheckAdminRole { public function handle(Request $request, Closure $next): Response { if ($request->user() && ! $request->user()->hasRole('admin')) { abort(403, 'Access denied.'); } return $next($request); } } 
namespace App\Http\Middleware;
 
use Closure;
use Illuminate\Http\Request;
use Symfony\Component\HttpFoundation\Response;
 
class CheckAdminRole
{
    public function handle(Request $request, Closure $next): Response
    {
        if ($request->user() && ! $request->user()->hasRole('admin')) {
            abort(403, 'Access denied.');
        }
 
        return $next($request);
    }
}

Adding middleware to configuration

Add the middleware to the config/moonshine.php file:

'middleware' => [ // ... other middleware \App\Http\Middleware\CheckAdminRole::class, ], 
'middleware' => [
    // ... other middleware
    \App\Http\Middleware\CheckAdminRole::class,
],

Or in MoonShineServiceProvider:

$config->addMiddleware([ \App\Http\Middleware\CheckAdminRole::class, ]); 
$config->addMiddleware([
    \App\Http\Middleware\CheckAdminRole::class,
]);

Authentication pipelines

Authentication pipelines in MoonShine allow you to add additional checks and actions to the authentication process after a successful login and password check.

Configuring pipelines

Configure pipelines in MoonShineServiceProvider:

$config->authPipelines([ \App\MoonShine\AuthPipelines\TwoFactorAuthentication::class, \App\MoonShine\AuthPipelines\PhoneVerification::class, ]); 
$config->authPipelines([
    \App\MoonShine\AuthPipelines\TwoFactorAuthentication::class,
    \App\MoonShine\AuthPipelines\PhoneVerification::class,
]);

Creating a pipeline

Example: Phone number login confirmation:

namespace App\MoonShine\AuthPipelines; use Closure; use MoonShine\Laravel\Models\MoonshineUser; class PhoneVerification { public function handle(Request $request, Closure $next) { $user = MoonshineUser::query() ->where('email', $request->get('username')) ->first(); if (! is_null($user) && ! is_null($user->getAttribute('phone'))) { $request->session()->put([ 'login.id' => $user->getKey(), 'login.remember' => $request->boolean('remember'), ]); return redirect()->route('sms-challenge'); } return $next($user); } } 
namespace App\MoonShine\AuthPipelines;
 
use Closure;
use MoonShine\Laravel\Models\MoonshineUser;
 
class PhoneVerification
{
    public function handle(Request $request, Closure $next)
    {
        $user = MoonshineUser::query()
            ->where('email', $request->get('username'))
            ->first();
 
         if (! is_null($user) && ! is_null($user->getAttribute('phone'))) {
            $request->session()->put([
                'login.id' => $user->getKey(),
                'login.remember' => $request->boolean('remember'),
            ]);
 
            return redirect()->route('sms-challenge');
        }
 
        return $next($user);
    }
}

Advantages of using pipelines

  • Flexibility: Easy to add, remove, or change the order of checks.
  • Modularity: Each aspect of extended authentication is isolated in a separate class.
  • Extensibility: Easy to add new authentication methods or checks.

Using authentication pipelines allows for complex authentication scenarios while keeping the code clean and modular, and gives full control over the process of users logging into the MoonShine admin panel.

For convenience, you can link your account with social networks to simplify the authentication process.

This functionality is based on the Laravel Socialite package.

Make sure you have it installed and configured.

Next, install the package for integrating Socialite into MoonShine:

composer require moonshine/socialite 
composer require moonshine/socialite

Run migrations:

php artisan migrate 
php artisan migrate

Publish the configuration file:

php artisan vendor:publish --provider="MoonShine\Socialite\Providers\SocialiteServiceProvider" 
php artisan vendor:publish --provider="MoonShine\Socialite\Providers\SocialiteServiceProvider"

Then in the config/moonshine-socialite.php config, set the available drivers and the image for the button:

return [ 'drivers' => [ 'github' => '/images/github.png', 'facebook' => '/images/facebook.svg', ], ]; 
return [
    'drivers' => [
        'github' => '/images/github.png',
        'facebook' => '/images/facebook.svg',
    ],
];

Drivers must be pre-configured in the Socialite package.

Add the trait MoonShine\Socialite\Traits\HasMoonShineSocialite to the model that is responsible for the admin panel users (by default, this is MoonshineUser).

Don't forget to publish the model if you're using the default configuration:

namespace App\Models; use MoonShine\Socialite\Traits\HasMoonShineSocialite; final class MoonshineUser extends \MoonShine\Laravel\Models\MoonshineUser { use HasMoonShineSocialite; } 
namespace App\Models;
 
use MoonShine\Socialite\Traits\HasMoonShineSocialite;
 
final class MoonshineUser extends \MoonShine\Laravel\Models\MoonshineUser
{
    use HasMoonShineSocialite;
}

And replace in the configuration file:

// .. 'auth' => [ // .. 'model' => \App\Models\MoonshineUser::class, // .. ], // .. 
// ..
'auth' => [
    // ..
    'model' => \App\Models\MoonshineUser::class,
    // ..
],
// ..

We will automatically add the SocialAuth component to the profile page and LoginLayout, but if you have overridden them and are using your own, then add the component yourself:

use MoonShine\Socialite\Components\SocialAuth; protected function components(): iterable { return [ // ... SocialAuth::make(profileMode: true), ]; } 
use MoonShine\Socialite\Components\SocialAuth;
 
protected function components(): iterable
{
    return [
        // ...
 
        SocialAuth::make(profileMode: true),
    ];
}

For added security, you can set up two-factor authentication:

composer require moonshine/two-factor 
composer require moonshine/two-factor

Next, run migrations:

php artisan migrate 
php artisan migrate

Then add authPipeline:

use MoonShine\TwoFactor\TwoFactorAuthPipe;return [ // ... 'auth' => [ // ... 'pipelines' => [ TwoFactorAuthPipe::class ], // ... ] // ...];
use MoonShine\TwoFactor\TwoFactorAuthPipe;
 
return [
    // ...
    'auth' => [
        // ...
        'pipelines' => [
            TwoFactorAuthPipe::class
        ],
        // ...
    ]
    // ...
];
use MoonShine\TwoFactor\TwoFactorAuthPipe;$config->authPipelines([ TwoFactorAuthPipe::class]);
use MoonShine\TwoFactor\TwoFactorAuthPipe;
 
$config->authPipelines([
    TwoFactorAuthPipe::class
]);

Add the trait MoonShine\TwoFactor\Traits\TwoFactorAuthenticatable to the model that is responsible for the admin panel users (by default, this is MoonshineUser).

Don't forget to publish the model if you're using the default configuration:

use MoonShine\TwoFactor\Traits\TwoFactorAuthenticatable; final class MoonshineUser extends \MoonShine\Laravel\Models\MoonshineUser { use TwoFactorAuthenticatable; } 
use MoonShine\TwoFactor\Traits\TwoFactorAuthenticatable;
 
final class MoonshineUser extends \MoonShine\Laravel\Models\MoonshineUser
{
    use TwoFactorAuthenticatable;
}

And replace in the configuration file:

// .. 'auth' => [ // ... 'model' => \App\Models\MoonshineUser::class, // ... ], // ... 
// ..
'auth' => [
    // ...
    'model' => \App\Models\MoonshineUser::class,
    // ...
],
// ...

We will automatically add the TwoFactor component to the profile page, but if you have overridden it and are using your own, then add the component yourself:

use MoonShine\TwoFactor\ComponentSets\TwoFactor; protected function components(): iterable { return [ // ... TwoFactor::make(), ]; } 
use MoonShine\TwoFactor\ComponentSets\TwoFactor;
 
protected function components(): iterable
{
    return [
        // ...
 
        TwoFactor::make(),
    ];
}

MoonShine also provides a simple way to switch the admin panel to API mode and interact through tokens.

For more details, read the API section.