README

Introduction

The Impersonator package allows administrators to impersonate user logins within a Laravel application. This feature is useful for debugging, customer support, and administrative purposes. However, it should be used with caution to avoid security risks.

Installation

To install the package, run the following command:

composer require mozhuilungdsuo/impersonator

Next, publish the package service provider and configuration file:

php artisan vendor:publish --provider="Mozhuilungdsuo\Impersonator\ImpersonateServiceProvider"

Run the database migrations:

php artisan migrate

Configuration

After publishing, a configuration file named impersonate.php will be created in the config directory. You can use this file to define allowed and restricted email addresses for impersonation. Also enable or disable the impersonation feature.

return [
    'enabled' => false,
    'allowed_emails' => [
        'admin@example.com',
    ],
    'restricted_emails' => [
        'superadmin@example.com',
    ],
];

Usage

Blade Directives

Impersonation Button

Place the following directive in your views to add an impersonation button for a specific user:

@impersonateButton($userId)

Stop Impersonation Button

Add the following directive to your layout file to allow users to stop impersonating:

@stopImpersonationButton

Customization

The views for the impersonation buttons can be customized in the vendor/impersonate directory. Modify them as needed to fit your application's UI.

Handling Messages

This package returns success and error messages that need to be manually caught and displayed in your views. For example:

return redirect()->back()->with('error', 'User not found.');

In your Blade template, catch and display messages like this:

@if(session('success'))
    <div class="alert alert-success">
        {{ session('success') }}
    </div>
@endif

@if(session('error'))
    <div class="alert alert-danger">
        {{ session('error') }}
    </div>
@endif

Security Warning ⚠️

Use this package with caution. Impersonating a user grants full access to their account, which can pose serious security and privacy risks. Ensure that only authorized administrators have permission to use this functionality.

Developer

Lungdsuo Mozhui
Email: mozhui.lungdsuo@gmail.com

License

This package is open-source and available under the MIT License.

mozhuilungdsuo / impersonator

Maintainers

Details