develop/v0.1.0: Added migration, model and helpers.

Author: wazzac

config/wazza-db-encrypt.php config/db-encrypt.phpconfig/wazza-db-encrypt.php renamed to config/db-encrypt.php

@@ -12,7 +12,15 @@
     ],
 
     // Define the DB encryption key. Will be used to encrypt and decrypt data.
-    'key' => env('DB_ENCRYPTION_KEY'),
+    // ------------------------------------------------------------
+    'key' => env('DB_ENCRYPT_KEY'),
+
+    // Local database Primary key format
+    // Options: 'int' (default) or 'uuid'
+    // ------------------------------------------------------------
+    'db' => [
+        'primary_key_format' => env('DB_ENCRYPT_DB_PRIMARY_KEY_FORMAT', 'int'), // int or uuid (36)
+    ],
 
     // ... more to follow
 

database/factories/EncryptedAttributesFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Wazza\DbEncrypt\Database\Factories;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class EncryptedAttributesFactory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'entity_id' => null,
+            'state_id' => null,
+            'type' => $this->faker->randomElement(['physical', 'billing', 'postal']),
+            'building_name' => $this->faker->word(),
+            'floor_number' => $this->faker->word(),
+            'address1' => $this->faker->streetAddress(),
+            'address2' => $this->faker->secondaryAddress(),
+            'city' => $this->faker->city(),
+            'postcode' => $this->faker->postcode(),
+            'comments' => $this->faker->text(2000),
+        ];
+    }
+}

database/migrations/2025_06_08_211522_create_encrypted_attributes_table.php

@@ -0,0 +1,59 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateEncryptedAttributesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        // load the local db primary key format
+        $dbPkFormat = config('db-encrypt.db.primary_key_format', 'int');
+
+        // create the table
+        Schema::create('encrypted_attributes', function (Blueprint $table) use ($dbPkFormat) {
+            // define tables engine and charset
+            $table->engine = 'InnoDB';
+            $table->charset = 'utf8mb4';
+            $table->collation = 'utf8mb4_unicode_ci';
+
+            // define columns
+            $table->id();
+            $table->string('object_type', 64)->nullable()->comment('The local object type - e.g. order, entity, user, etc.');
+            if ($dbPkFormat === 'uuid') {
+                $table->string('object_id', 36)->nullable()->comment('The local object unique ID (primary key - `uuid`)');
+            } else {
+                $table->unsignedBigInteger('object_id')->nullable()->comment('The local object unique ID (primary key - auto-incremented `int`)');
+            }
+            $table->string('attribute', 64)->nullable()->comment('The attribute name, e.g. email, phone, etc.');
+            $table->string('hash_index', 64)->nullable()->comment('SHA-256 hash of the attribute value (hex format) for fast searching');
+            $table->text('encrypted_value')->nullable()->comment('The encrypted value of the attribute (Base64 or binary-safe string)');
+            $table->timestamps();
+
+            // add some indexes (we need one on all columns for searching)
+            $table->index('object_id');
+            $table->index('hash_index');
+            $table->index('attribute');
+
+            // composite indexes
+            $table->unique(['object_type', 'object_id', 'attribute'], 'object_type_attribute_unique');
+            $table->index(['object_type', 'attribute', 'hash_index'], 'object_type_attribute_hash_index');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::dropIfExists('encrypted_attributes');
+    }
+}

src/Http/Controllers/BaseController.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Wazza\DbEncrypt\Http\Controllers;
+
+use Wazza\DbEncrypt\Http\Controllers\Logger\LogController;
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Bus\DispatchesJobs;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Routing\Controller;
+
+class BaseController extends Controller
+{
+    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+
+    /**
+     * The logger instance
+     *
+     * @var LogController
+     */
+    public $logger;
+
+    /**
+     * Create a new CrmController instance.
+     *
+     * @param string|null $logIdentifier
+     * @throws BindingResolutionException
+     * @throws NotFoundExceptionInterface
+     * @throws ContainerExceptionInterface
+     */
+    public function __construct(?string $logIdentifier = null)
+    {
+        // set the logger instance
+        $this->logger = new LogController($logIdentifier);
+    }
+}

src/Http/Controllers/DnEncryptController.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Wazza\DbEncrypt\Http\Controllers;
+
+use Wazza\DbEncrypt\Http\Controllers\BaseController;
+use Wazza\DbEncrypt\Models\EncryptedAttributes;
+use Illuminate\Support\Facades\App;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use Psr\Container\NotFoundExceptionInterface;
+use Psr\Container\ContainerExceptionInterface;
+use Exception;
+
+/**
+ * Sync Class CrmController
+ * Example: (new CrmController())->setModel($user)->execute();
+ *
+ * @package Wazza\DbEncrypt\Http\Controllers
+ * @version 1.0.0
+ * @todo convert the log class to be injected into the controller instead of using the facade
+ */
+
+class DnEncryptController extends BaseController
+{
+    /**
+     * Create a new CrmController instance and define the log identifier (blank will create a new one)
+     *
+     * @param string|null $logIdentifier
+     * @return void
+     * @throws BindingResolutionException
+     * @throws NotFoundExceptionInterface
+     * @throws ContainerExceptionInterface
+     */
+    public function __construct(?string $logIdentifier = null)
+    {
+        // parent constructor
+        parent::__construct($logIdentifier);
+
+        // ...
+    }
+}