feat: add support for encrypted boolean

Author: JaZo

MIGRATING.md

@@ -3,8 +3,6 @@
 ## To Laravel Encrypted Casting
 The main difference between this package and [Laravel Encrypted Casting](https://laravel.com/docs/10.x/eloquent-mutators#encrypted-casting) is that this package serializes the data before encrypting it, while Laravel Encrypted Casting encrypts the data directly. This means that the data is not compatible between the two packages. In order to migrate from this package to Laravel Encrypted Casting, you will need to decrypt the data and then re-encrypt it using Laravel Encrypted Casting. Here is a step-by-step guide on how to do this:
 
-[//]: # (TODO: What to do when you need encrypted serialized data?)
-
 1. Make sure you're running on Laravel 11 or higher.
 2. Remove the `Swis\Laravel\Encrypted\EncryptedModel` from your models and replace it with `Illuminate\Database\Eloquent\Model`:
 ```diff
@@ -23,17 +21,20 @@ The main difference between this package and [Laravel Encrypted Casting](https:/
 +     'secret' => 'encrypted',
 + ];
 ```
-4. If you're using encrypted date(time)s, use the custom casts provided by this package:
+4. If you're using encrypted booleans or date(time)s, use the custom casts provided by this package:
 ```diff
 - protected $encrypted = [
--     'secret',
+-     'secret_boolean',
+-     'secret_datetime',
 - ];
 -
 - protected $casts = [
--     'secret' => 'datetime',
+-     'secret_boolean' => 'bool',
+-     'secret_datetime' => 'datetime',
 - ];
 + protected $casts = [
-+     'secret' => \Swis\Laravel\Encrypted\Casts\AsEncryptedDateTime::class,
++     'secret_boolean' => \Swis\Laravel\Encrypted\Casts\AsEncryptedBoolean::class,
++     'secret_datetime' => \Swis\Laravel\Encrypted\Casts\AsEncryptedDateTime::class,
 + ];
 ```
 5. Set up our custom model encrypter in your `AppServiceProvider`:

README.md

@@ -29,6 +29,14 @@ composer require swisnl/laravel-encrypted-data
 
 You can use the Eloquent casts provided by this package and everything will be encrypted/decrypted under the hood!
 
+#### Boolean
+
+```php
+protected $casts = [
+    'boolean' => \Swis\Laravel\Encrypted\Casts\AsEncryptedBoolean::class,
+];
+```
+
 #### Datetime
 
 ```php

src/Casts/AsEncryptedBoolean.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\Laravel\Encrypted\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\Castable;
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\Crypt;
+
+class AsEncryptedBoolean implements Castable
+{
+    /**
+     * @param string[] $arguments
+     *
+     * @return \Illuminate\Contracts\Database\Eloquent\CastsAttributes<bool, bool>
+     */
+    public static function castUsing(array $arguments): CastsAttributes
+    {
+        return new class implements CastsAttributes {
+            /**
+             * @param string|null          $value
+             * @param array<string, mixed> $attributes
+             */
+            public function get(Model $model, string $key, mixed $value, array $attributes): ?bool
+            {
+                if ($value === null) {
+                    return null;
+                }
+
+                return (bool) ($model::$encrypter ?? Crypt::getFacadeRoot())->decrypt($value, false);
+            }
+
+            /**
+             * @param bool|null            $value
+             * @param array<string, mixed> $attributes
+             */
+            public function set(Model $model, string $key, #[\SensitiveParameter] mixed $value, array $attributes): ?string
+            {
+                if ($value === null) {
+                    return null;
+                }
+
+                return ($model::$encrypter ?? Crypt::getFacadeRoot())->encrypt((string) (int) $value, false);
+            }
+
+            /**
+             * @param string|null $original
+             * @param string|null $value
+             */
+            public function compare(Model $model, string $key, mixed $original, mixed $value): bool
+            {
+                if (!empty(($model::$encrypter ?? Crypt::getFacadeRoot())->getPreviousKeys())) {
+                    return false;
+                }
+
+                return $this->get($model, $key, $original, []) === $this->get($model, $key, $value, []);
+            }
+        };
+    }
+}

tests/Casts/AsEncryptedBooleanTest.php

@@ -0,0 +1,97 @@
+<?php
+
+namespace Swis\Laravel\Encrypted\Tests\Casts;
+
+use PHPUnit\Framework\TestCase;
+use Swis\Laravel\Encrypted\Casts\AsEncryptedBoolean;
+use Swis\Laravel\Encrypted\Tests\_mocks\DummyEncrypter;
+use Swis\Laravel\Encrypted\Tests\_mocks\Model;
+
+class AsEncryptedBooleanTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        Model::$encrypter = new DummyEncrypter();
+    }
+
+    public function testGetReturnsNullForNull(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        $result = $cast->get($model, 'flag', null, []);
+
+        $this->assertNull($result);
+    }
+
+    public function testGetReturnsBoolean(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        $encryptedTrue = Model::$encrypter->encrypt('1', false);
+        $encryptedFalse = Model::$encrypter->encrypt('0', false);
+
+        $this->assertTrue($cast->get($model, 'flag', $encryptedTrue, []));
+        $this->assertFalse($cast->get($model, 'flag', $encryptedFalse, []));
+    }
+
+    public function testSetReturnsNullForNull(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        $result = $cast->set($model, 'flag', null, []);
+
+        $this->assertNull($result);
+    }
+
+    public function testSetReturnsEncryptedString(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        $encrypted = $cast->set($model, 'flag', true, []);
+        $this->assertEquals(Model::$encrypter->encrypt('1', false), $encrypted);
+
+        $encrypted = $cast->set($model, 'flag', false, []);
+        $this->assertEquals(Model::$encrypter->encrypt('0', false), $encrypted);
+    }
+
+    public function testCompareReturnsTrueForSameDecryptedValue(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        $encryptedTrue = Model::$encrypter->encrypt('1', false);
+        $encryptedTrue2 = Model::$encrypter->encrypt('1', false);
+
+        $this->assertTrue($cast->compare($model, 'flag', $encryptedTrue, $encryptedTrue2));
+    }
+
+    public function testCompareReturnsFalseForDifferentDecryptedValue(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        $encryptedTrue = Model::$encrypter->encrypt('1', false);
+        $encryptedFalse = Model::$encrypter->encrypt('0', false);
+
+        $this->assertFalse($cast->compare($model, 'flag', $encryptedTrue, $encryptedFalse));
+    }
+
+    public function testCompareReturnsFalseIfPreviousKeysExist(): void
+    {
+        $cast = AsEncryptedBoolean::castUsing([]);
+        $model = new Model();
+
+        // Simulate previous keys
+        /* @noinspection PhpUndefinedMethodInspection */
+        $model::$encrypter->setPreviousKeys(['dummy-key']);
+
+        $encrypted = Model::$encrypter->encrypt('1', false);
+
+        $this->assertFalse($cast->compare($model, 'flag', $encrypted, $encrypted));
+    }
+}