Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onramplab/laravel-security-model
https://github.com/onramplab/laravel-security-model
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/onramplab/laravel-security-model
- Owner: OnrampLab
- License: mit
- Created: 2023-02-14T02:36:15.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-28T09:06:06.000Z (about 1 year ago)
- Last Synced: 2024-08-09T21:09:14.227Z (3 months ago)
- Language: PHP
- Size: 109 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-security-model
[](LICENSE.md)
[](https://circleci.com/gh/OnrampLab/laravel-security-model)
[](https://packagist.org/packages/onramplab/laravel-security-model)
A Laravel package providing security for Eloquent model
## Requirements
- PHP >= 7.4;
- composer.
## Features
- Encryption
- Easy to use with Laravel Eloquent model
- Support multiple types of key management service
- AWS KMS
## Installation
Install the package via composer
```bash
composer require onramplab/laravel-security-model
```
Publish migration files and run command to build tables needed in package
```bash
php artisan vendor:publish --tag="security-model-migrations"
php artisan migrate
```
Also, you can choose to publish the configuration file
```bash
php artisan vendor:publish --tag="security-model-config"
```
## Usage
### Encryption
1. Set up credentials for key provider you want to use for encryption
2. Run command to generate a encryption key and a hash key
```bash
php artisan security-model:generate-key
```
3. Use the `Securable` trait in a model
4. Implement the `Securable` interface in a model
5. Set up `$encryptable` attribute in a model to define encryptable fields. You can check out the [section](#encryptable-field-parameters) below for more info about field parameters
```php
['type' => 'string'],
'email' => ['type' => 'string', 'searchable' => true],
];
}
```
### Encryptable Field Parameters
- type
- Type
string
- Required
yes
- Description
Determinate content type of the encryptable field. Here are available types:
- `string`
- `json`
- `integer`
- `float`
- `boolean`
- searchable
- Type
boolean
- Required
no
- Description
Determinate whether the encryptable field is searchable. If the field is searchable, you should make a migration to create a new column to store blind index value for searching.
### Searchable Encrypted Field
To achieve searching on encrypted fields, we use a strategy called **blind indexing**. Its idea is to store a hash value of the plaintext in a separate column and would it will be used for searching.
That means if you define a encryptable field to be searchable, you should postfix the original column name with `_bidx` to create a new column. For example, if you define a `email` column to be searchable, then you need to create a `email_bidx` column in your table.
### Conditional Encryption
Sometimes you may need to determinate whether a model should be encrypted under certain conditions. To accomplish this, you may define a `shouldBeEncryptable` method on your model:
```php
/**
* Determine if the model should be encrytable.
*/
public function shouldBeEncryptable(): bool
{
return $this->isClassified();
}
```
### Redaction
1. Use the `Securable` trait in a model
2. Implement the `Securable` interface in a model
3. Set up `$redactable` attribute in a model to define redactable fields with redactor classes you want to apply for each fields
```php
E164PhoneNumberRedactor::class,
'email' => EmailRedactor::class,
];
}
```
There are some built-in redactors available for different kinds of model field:
- E164PhoneNumberRedactor
- EmailRedactor
- NameRedactor
- PhoneNumberRedactor
- SecretRedactor
- ZipCodeRedactor
### Custom Redactor
Besides those built-in redactors mentioned above, you may wish to specify ones with custom logic. Thus, you are free to create your own redactor class. Just simply implement the class with `Redactor` interface, then use it in your securable model.
```php