Laravel DB Encrypter

https://github.com/betterapp/laravel-db-encrypter
Admin
A Laravel package that encrypts and decrypts Eloquent model attributes using Laravel's standard...
Tokens:2,765
Snippets:16
Trust Score:6.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Laravel Db Encrypter Package via Composer

Source: https://github.com/betterapp/laravel-db-encrypter/blob/master/README.md

This snippet shows the Composer command to install the Laravel Db Encrypter package. It specifies the package name and version constraints for different Laravel versions.

```bash
composer install betterapp/laravel-db-encrypter:^v5
composer install betterapp/laravel-db-encrypter:^v4
composer install betterapp/laravel-db-encrypter:^v3
composer install betterapp/laravel-db-encrypter:^v2
composer install betterapp/laravel-db-encrypter:^v1
```

```bash
composer require betterapp/laravel-db-encrypter
```

--------------------------------

### Database Migration for Encrypted Fields (Laravel)

Source: https://context7.com/betterapp/laravel-db-encrypter/llms.txt

Provides example Laravel migrations for creating and altering tables to accommodate encrypted fields. It emphasizes using the `TEXT` data type for columns storing encrypted data due to their increased length. This ensures sufficient space for the encrypted payloads. The examples cover both initial table creation and modifying existing columns.

```php
<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    public function up(): void
    {
        Schema::create('clients', function (Blueprint $table) {
            $table->id();
            $table->string('name');

            // Use TEXT for encrypted fields - encrypted values are larger
            $table->text('id_number');
            $table->text('email');
            $table->text('phone')->nullable();
            $table->text('social_security_number')->nullable();

            $table->timestamps();
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('clients');
    }
};

// For existing tables, alter columns to TEXT
return new class extends Migration
{
    public function up(): void
    {
        Schema::table('clients', function (Blueprint $table) {
            $table->text('email')->change();
            $table->text('phone')->change();
        });
    }
};

```

--------------------------------

### Use Laravel Db Encrypter with Laravel Casts

Source: https://context7.com/betterapp/laravel-db-encrypter/llms.txt

This example shows how to use Laravel Db Encrypter in conjunction with Laravel's casting system. The trait ensures decryption happens before casting, allowing seamless handling of encrypted JSON, arrays, or other castable types. It requires the `EncryptableDbAttribute` trait, a defined `$encryptable` array, and a `$casts` property in your Eloquent model.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute;

class UserPreferences extends Model
{
    use EncryptableDbAttribute;

    protected $encryptable = [
        'settings',
        'api_credentials',
    ];

    protected $casts = [
        'settings' => 'array',
        'api_credentials' => 'object',
    ];

    protected $fillable = [
        'user_id',
        'settings',
        'api_credentials',
    ];
}

// Store encrypted JSON data
$prefs = UserPreferences::create([
    'user_id' => 1,
    'settings' => [
        'theme' => 'dark',
        'notifications' => true,
        'language' => 'en',
    ],
    'api_credentials' => [
        'key' => 'sk_live_abc123',
        'secret' => 'whsec_xyz789',
    ],
]);

// Retrieve and work with cast types
$prefs = UserPreferences::where('user_id', 1)->first();
echo $prefs->settings['theme'];  // Output: dark
echo $prefs->api_credentials->key;  // Output: sk_live_abc123

// Update nested values
$prefs->settings = array_merge($prefs->settings, ['theme' => 'light']);
$prefs->save();  // Array is JSON-encoded, then encrypted before storage

```

--------------------------------

### Eloquent Model with EncryptableDbAttribute Trait

Source: https://context7.com/betterapp/laravel-db-encrypter/llms.txt

Demonstrates how to use the `EncryptableDbAttribute` trait in an Eloquent model to automatically encrypt and decrypt specified attributes. It shows attribute configuration, model creation, retrieval, updating, and conversion to array/JSON, highlighting the transparent encryption/decryption process. Dependencies include Laravel's Eloquent ORM and the `betterapp/laravel-db-encrypter` package.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute;

class Client extends Model
{
    use EncryptableDbAttribute;

    /**
     * The attributes that should be encrypted/decrypted.
     *
     * @var array
     */
    protected $encryptable = [
        'id_number',
        'email',
        'phone',
        'social_security_number',
    ];

    /**
     * The attributes that should be cast (works with encryption).
     *
     * @var array
     */
    protected $casts = [
        'date_of_birth' => 'date',
        'is_active' => 'boolean',
    ];

    protected $fillable = [
        'name',
        'id_number',
        'email',
        'phone',
        'social_security_number',
    ];
}

// Creating a new client - attributes are automatically encrypted before storage
$client = Client::create([
    'name' => 'John Doe',
    'id_number' => '123-45-6789',
    'email' => 'john.doe@example.com',
    'phone' => '+1-555-123-4567',
    'social_security_number' => '987-65-4321',
]);

// Retrieving client - attributes are automatically decrypted
$client = Client::find(1);
echo $client->email;  // Output: john.doe@example.com (decrypted)
echo $client->id_number;  // Output: 123-45-6789 (decrypted)

// Updating encrypted attributes
$client->email = 'new.email@example.com';
$client->save();  // Email is automatically encrypted before storage

// Converting to array - all encryptable attributes are decrypted
$clientArray = $client->toArray();
// [
//     'id' => 1,
//     'name' => 'John Doe',
//     'id_number' => '123-45-6789',
//     'email' => 'new.email@example.com',
//     'phone' => '+1-555-123-4567',
//     'social_security_number' => '987-65-4321',
// ]

// JSON serialization also returns decrypted values
$clientJson = $client->toJson();
// {"id":1,"name":"John Doe","id_number":"123-45-6789","email":"new.email@example.com",...}

```

--------------------------------

### Handle Existing Unencrypted Data with Laravel Db Encrypter

Source: https://context7.com/betterapp/laravel-db-encrypter/llms.txt

This snippet demonstrates how to integrate Laravel Db Encrypter with existing unencrypted data. The package automatically encrypts data upon saving and returns unencrypted data as-is during read operations, facilitating gradual data migration. It requires the `EncryptableDbAttribute` trait and a defined `$encryptable` array in your Eloquent model.

```php
<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute;

class User extends Model
{
    use EncryptableDbAttribute;

    protected $encryptable = [
        'credit_card_number',
        'bank_account',
    ];

    protected $fillable = [
        'name',
        'credit_card_number',
        'bank_account',
    ];
}

// Existing record with unencrypted credit_card_number in database
$user = User::find(1);
echo $user->credit_card_number;  // Output: 4111-1111-1111-1111 (returned as-is)

// After saving, the value becomes encrypted
$user->credit_card_number = '4111-1111-1111-1111';
$user->save();  // Now stored encrypted in database

// Batch encrypt existing records
User::chunk(100, function ($users) {
    foreach ($users as $user) {
        // Simply saving triggers encryption of encryptable attributes
        $user->save();
    }
});

```

--------------------------------

### Configure Encryptable Attributes in Eloquent Model

Source: https://github.com/betterapp/laravel-db-encrypter/blob/master/README.md

This PHP code demonstrates how to use the EncryptableDbAttribute trait and define the $encryptable property in a Laravel Eloquent model. This configures which attributes should be automatically encrypted and decrypted.

```php
use betterapp\LaravelDbEncrypter\Traits\EncryptableDbAttribute;

class Client extends Eloquent {
    use EncryptableDbAttribute;
   
    /** @var array The attributes that should be encrypted/decrypted */
    protected $encryptable = [
        'id_number', 
        'email',
    ];
}
```
Tokens:
Raw