Download the PHP package pmingram/laravel-model-encryptor without Composer

On this page you can find all versions of the php package pmingram/laravel-model-encryptor. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of pmingram/laravel-model-encryptor

Informations about the package laravel-model-encryptor

Laravel Model Encryptor

PHP Version Latest Version on Packagist

A model trait for flexible encryption and decryption of data

Installation

You can install the package via composer:

Usage and Configuration

This package is a trait that can be added to any Laravel model you wish to apply encryption to:

By default, the trait will apply encryption to any record on creation - but to actually encrypt data, you need to configure some properties within your model:

Property Type Description Default Value
$encryptOnCreate Boolean Enable or disable encryption on model creation. If set to false, the model can be encrypted later by invoking $model->encrypt(true). true
$encryptionKey String A random string to act as a base encryption key for the model in conjunction with the application key set by Laravel. If left blank, the Laravel application key will be used alone. Empty string
$encryptionSaltColumn String The data in the column defined here will be appended to the $encryptionKey to create a per-row encryption key. This should not be a column in the $encryptionColumnKeys array, as this could lead to data loss. Empty string
$encryptionColumnKeys Array List of columns to be included in the encryption and decryption processes. These columns should be defined as LONGTEXT datatypes (or the equivalent type in your database engine.) Empty array

There is no specific scope requirement for these properties, but it is recommended to use a protected scope.

Encryption and Decryption

Models can be encrypted and decrypted easily with a simple method call:

This will encrypt or decrypt the data within the current model instance, but will not persist the change to the database. This is particularly useful in the event you wish to decrypt the data for presentation (for example, in a view or in a resource for an API endpoint) but you want to keep that data encrypted in the database.

To persist to the database, simply pass true as an optional argument within the method:

Example Configuration

Model

Laravel Configuration File - "encryptionkeys.php"

Environment Variable (.env)

Recommendation on Encryption Keys and Security

While it is entirely possible to store the model-level encryption key within the model itself, as a string in the $encryptionKey property, it is strongly advised to abstract the string out to a configuration file as per the example above, then use the .env file to set the strings.

It is both bad practice and a security risk to store encryption keys and passwords within a codebase, especially when that codebase is persisted to a VCS such as Git or SVN.

Important Note

The Laravel application key is used with this trait. If the application key is changed, any encrypted data will no longer be readable. Of course this is the case with any encryption routines deployed, but should be considered if you need to change your application's key.

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-model-encryptor with dependencies

PHP Build Version
Package Version
Requires php Version >=7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package pmingram/laravel-model-encryptor contains the following files

Loading the files please wait ....