imanghafoori/laravel-masterpass

A minimal yet powerful package to help you easily impersonate your users.

v2.2.51 2024-06-26 21:46 UTC

Requires

• php: >=5.6.0
• laravel/framework: ^5.5|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• imanghafoori/php-imports-analyzer: ^v1.0.5
• laravel/passport: >=v1.0.0
• orchestra/testbench: ^3.5|^4.0|^5.0|^6.0|^7.0|^8.0|^9.0

Suggests

• imanghafoori/laravel-anypass: Allows you login with any password in local environment.
• imanghafoori/laravel-decorator: Allows you to easily apply the decorator pattern in a laravel app.
• imanghafoori/laravel-heyman: It allows to write expressive code to authorize, validate and authenticate.
• imanghafoori/laravel-terminator: Gives you opportunity to refactor your controllers.
• imanghafoori/laravel-widgetize: Gives you a better structure and caching opportunity for your laravel apps.

MIT

• Iman Ghafoori

• php
• laravel
• laravel-login
• laravel-auth
• laravel-utility
• laravel-password
• laravel-authentication

README

🔑 Make your login form smart in a minute.

Built with ❤️ for every smart Laravel developer

Helps you set a master password in .env file and login into any account with that, to impersonate your users.

This means that each account will have 2 valid passwords. The original one and the master password.

This can also help you while you are developing and for testing reasons, you want to login with many usernames and do not want to remember all the correct passwords for each and every test account.

• Also works if you use laravel-passport (as of version 2.0.6 and above)

🔥 Installation

composer require imanghafoori/laravel-masterpass

Compatible with laravel version 5.5 and above.

Then run:

php artisan vendor:publish --tag=master_password

🔧 Config

The only thing you should do is to put your master password in the .env file:

MASTER_PASSWORD=mySecretMasterPass

Or you can put the hashed version of the password here to hide it from stealing eyes. 👀

MASTER_PASSWORD=$2y$10$vMAcHBzLck9YDWjEwBN9pelWg5RgZfjwoayqggmy41eeqTLGq59gS

Both of the options will work just fine.

• If the master password can't be read from the config/master_password.php file, this package will be totally disabled and will do nothing.

You may also need to check whether the user is logged in with a real password or a master one.

$bool = Auth::isLoggedInByMasterPass();

Or in blade files you can use our directives:

@isLoggedInByMasterPass

     Your are here by master password.

@endif

▶️ Advanced Usage:

What if I want to put the master password in the database? (not .env)

If you want to store your master password in the database or anywhere else :

\Event::listen('masterPass.whatIsIt?', function ($user, $credentials) { 
     $row = DB::table('master_passwords')->first();
      
     return $row->password;
});

▶️ Super admin accounts should not be opened by a master password, right?

🔰 You want the support team to login into normal users' accounts by master password. BUT

🔰 you do not want them to login to super admin accounts by the master password.

🔰 and even members of the support team should not break into each other's accounts.

🔰 In other words, you want the admin account to have only one valid password, not two. a master password is only for normal user accounts.

▶️ So how to exclude admin accounts, in code?

In that case, you can listen to the 'masterPass.canBeUsed?' event check your conditions, and return false from it.

Sample:

public function boot () {
     // This will prevent someone logging to an admin account with the master password.
     \Event::listen('masterPass.canBeUsed?', function ($user, $credentials) {
          if ($user->isAdmin) {
               return false;
          }
     });
          
}

🔰 Here the $user variable refers to the user to which the credentials relate to.

What if an employee leaves my company?!

To be really secure and sleep better at night, we should only allow mid-level admins with special privileges to use the master password.

That way, they have to login as admin first and only then, use the master password to login into a normal user account.

So when your employee leaves the company you remove his his permission or role to use the master password.

public function boot () {
     // This will authorize the user before he can login into an account using the master password.
     \Event::listen('masterPass.canBeUsed?', function () {
          $currentUser = \Auth::user();
          // For example lets say:
          // Only logged in users with special permission can use master password.
          
          if (! $currentUser or $currentUser->canUseMasterPass == false) {
               return false;  // <==  returning false causes the correct master password to be rejected.    
          }

     });
          
}

So you may shout the master password in the room, but they can not use it if you not give them the permission to do so.

▶️ Is it Compatible with other custom guards?

Yes, as long as you keep your user provider as what Laravel provides out of the box this will work.

Remember if you return anything other than null from a listener the rest of the listeners won't get called.

So if you want to continue the checking process return null.

Support for laravel-passport is also added.

⚠️ Warning

• Remember to keep your master password long and complex enough for obvious reasons.

⭐ Your Stars Make Us Do More ⭐

As always if you found this package useful and you want to encourage us to maintain and work on it, Please press the star button to declare your willing.

More packages from the author:

💎 A minimal yet powerful package to give a better structure and caching opportunity for your Laravel apps.

• https://github.com/imanghafoori1/laravel-widgetize

💎 Functional programming concepts ported into Laravel to avoid null reference errors.

• https://github.com/imanghafoori1/laravel-nullable

💎 Authorization and validation are now very easy with hey-man package!!!

• https://github.com/imanghafoori1/laravel-heyman

💎 It automatically checks your laravel application

• https://github.com/imanghafoori1/laravel-microscope