Download the PHP package codebot/laravel-usub without Composer
On this page you can find all versions of the php package codebot/laravel-usub. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codebot/laravel-usub
More information about codebot/laravel-usub
Files in codebot/laravel-usub
Package laravel-usub
Short Description Laravel package for authenticated user substitution to login as other users.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-usub
About laravel-usub
Laravel package for authenticated user substitution to login as other users. You will find this package useful when your client says "As an admin I want to be authenticated and act as chosen user without typing password, and want to back to my admin dashboard by single click.".
Installation
-
Install the package using composer - run command
composer require codebot/laravel-usub:0.1.* -
Publish vendors using
php artisan vendor:publish --tag=laravel-usubcommand. You will get published config file config/usub.php, middleware app/Http/Middleware/UsubSignIn.php, command app/Console/Commands/ClearUsubTokens.php, directory views/vendor/usub and migration to create usub_tokens table. -
Run
php artisan migrateto create usub_tokens table. -
If auto-discovery doesn't work for you then register service provider by adding
Usub\Core\UsubServiceProvider::classto providers in config/app.php file. - Add the
UsubSignInmiddleware to the$routeMiddlewarearray in theApp\Http\Kernel.phpclass.
You need complete UsubSignIn middleware to implement permissions. For example:
Configuration
expiration - Usub token expiration time in minutes.
length - Length of generated usub token.
redirect_to_on_sign_in - Default URL where user will be redirected on sign in whenever it's not overridden by redirect_to_on_sign_in key in request, e.g. by hidden input field.
redirect_to_on_sign_out - Default URL where user will be redirected on sign out whenever it's not overridden by redirect_to_on_sign_out key in request, e.g. by hidden input field.
redirect_to_on_cookie_expiration - URL where user will be redirected when token cookie expired.
forget_cookies_on_sign_out - Array of cookie names that will be removed from browser on sign out and usub token expiration.
You can change the configuration in your .env file if you need to.
Usage
Once you have package installed, following routes are registered:
-
POST /usub/sign-in- used to sign up as given user id.- Fields
- user2 (required)
- redirect_to_on_sign_in (optional, once set - overrides redirect_to_on_sign_in config variable )
- redirect_to_on_sign_out (optional, once set - overrides redirect_to_on_sign_out config variable )
POST /usub/sign-out- used to "sign up back" to administrator account.- No field needs to be specified.
An example of html form that can be used to sign in as specific user:
If you won't specify on_sign_in and on_sign_out values, then it will use defaults from the config/usub.php config file.
An example of html form that can be used to sign out and back to admin dashboard (or whatever page you need):
Cleanup
To delete expired tokens from the usub_tokens database table, you can use php artisan usub:clear command.
