Download the PHP package yooslim/legit-artisan-commands without Composer
On this page you can find all versions of the php package yooslim/legit-artisan-commands. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yooslim/legit-artisan-commands
More information about yooslim/legit-artisan-commands
Files in yooslim/legit-artisan-commands
Package legit-artisan-commands
Short Description A Laravel 9 package that allows you enforce security of your artisan commands by authenticating users before running.
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 legit-artisan-commands
Introduction
This package allows you as a developer to restrict who can and cannot run artisan commands, especially in a production environment. For example, a user (admin) should be allowed to run commands only if he has the right role/permission.
How it works ?
An artisan user will be provided with a token in order to use it as an option when running commands. This token has a configurable size and lifetime. The user can use this token as much as he wants until it expires or is revoked.
In order to get this token, an artisan user must first perform an authentication within the console, if the authentication is successful, the user will be prompted with the token, otherwise, a warning message will be displayed.
The logic of authentication is customizable, the developer can put in place his own validation rules. For exemple, one would want to authorize a user only if he has an "admin" role, an other one would check if he has the right permissions, another one would fetch an active directory or external authentication service, etc.
How to implement it !
A few steps to put this in place.
Install the package
composer require yooslim/legit-artisan-commands
Publish the vendor configuration file
php artisan vendor:publish --provider="YOoSlim\LegitArtisanCommands\Providers\LegitCommandsServiceProvider"
Edit configuration file
- Token lifetime: The console token lifetime in seconds.
- Token size: The number of caracters to be generated (must be less than 255).
- Environments to be ignored: No need to waste our time with authentication in local environments, so it possible to ignore a set of environments.
- User model relationship: The model name (namespace included) of the user entity.
Run migrations
php artisan migrate
Add the ArtisanUserInterface to the user model
Customize your authentication logic in AppServiceProvider.php
Finally, edit your artisan command
There are two main things to edit in your command :
- Add the LegitArtisanCommandSignature trait, it will edit your command signature by appending the --token option part.
- Wrap your original command inside the isAuthorized callback function.
How to use it !
- First, request a token by providing your credentials.
php artisan console:authentication --username="[email protected]"
This will prompt a random token.
- Then, whenever you use a protected artisan command, include the --token option.
php artisan MyCommand:MyAction --token="*"
Enjoy :D
Please, let me know if something is ambiguous, incomprehensible or wrong. I would be glad to clarify or fix it.
