ibf/laravel-encrypter

dev-main 2024-02-04 19:15 UTC

This package is auto-updated.

Last update: 2024-05-04 20:34:18 UTC


README

This package encrypts your php code with phpBolt

For Laravel and Lumen 6, 7, 8, 9

Installation

Step 1

At the first, You have to install phpBolt.

Step 2

Require the package with composer using the following command:

composer require --dev ibf/laravel-encrypter

Step 3

For Laravel

The service provider will automatically get registered. Or you may manually add the service provider in your config/app.php file:

'providers' => [
    // ...
    \ibf\LaravelEncrypter\LaravelEncryptServiceProvider::class,
];

For Lumen

Add this line of code under the Register Service Providers section of your bootstrap/app.php:

$app->register(\ibf\LaravelEncrypter\LaravelEncryptServiceProvider::class);

Step 4 (Optional)

You can publish the config file with this following command:

php artisan vendor:publish --provider="ibf\LaravelEncrypter\LaravelEncryptServiceProvider" --tag=config

Note: If you are using Lumen, you have to use this package.

Usage

Open terminal in project root and run this command:

php artisan ibf-encrypt

This command encrypts files and directories in config/Laravel-encrypter.php file. Default values are app, database, routes.

The default destination directory is encrypted. You can change it in config/Laravel-encrypter.php file.

Also the default encryption key length is 12. You can change it in config/Laravel-encrypter.php file. 12 is the recommended key length.

This command has these optional options:

Option Description Example
source Path(s) to encrypt app,routes,public/a.php
destination Destination directory encrypted
keylength Encryption key length 12
force Force the operation to run when destination directory already exists

Usage Examples

Command Description
php artisan ibf-encrypt Encrypts with default source, destination and keylength. If the destination directory exists, asks for delete it.
php artisan ibf-encrypt --force Encrypts with default source, destination and keylength. If the destination directory exists, deletes it.
php artisan ibf-encrypt --source=app Encrypts app directory to the default destination with default keylength.
php artisan ibf-encrypt --destination=dist Encrypts with default source and key length to dist directory.
php artisan ibf-encrypt --destination=dist --keylength=8 Encrypts default source to dist directory and the encryption key length is 8.

Written with ♥ by Iman Abbasi.

Please support me by staring this repository.