Encryptors tests

Signed-off-by: Dusan Malusev <[email protected]>

Author: CodeLieutenant

composer.json

@@ -26,12 +26,12 @@
     "require": {
         "php": ">=8.1",
         "ext-sodium": "*",
-        "illuminate/support": "^8|^9|^10",
-        "illuminate/contracts": "^8|^9|^10",
+        "illuminate/collections": "^8|^9|^10",
         "illuminate/config": "^8|^9|^10",
-        "illuminate/hashing": "^8|^9|^10",
+        "illuminate/contracts": "^8|^9|^10",
         "illuminate/encryption": "^8|^9|^10",
-        "illuminate/collections": "^8|^9|^10"
+        "illuminate/hashing": "^8|^9|^10",
+        "illuminate/support": "^8|^9|^10"
     },
     "require-dev": {
         "nunomaduro/collision": "^7.10",
@@ -96,4 +96,4 @@
             "@php vendor/bin/phpunit"
         ]
     }
-}
+}

composer.lock

@@ -5,6 +5,7 @@
 namespace BrosSquad\LaravelCrypto\Encryption;
 
 use BrosSquad\LaravelCrypto\Encoder\Encoder;
+use BrosSquad\LaravelCrypto\Encoder\JsonEncoder;
 use BrosSquad\LaravelCrypto\Keys\Loader;
 use Exception;
 use Illuminate\Contracts\Encryption\DecryptException;
@@ -21,8 +22,8 @@ final class AesGcm256Encryptor implements Encrypter, KeyGeneration, StringEncryp
 
     public function __construct(
         private readonly Loader $keyLoader,
-        private readonly LoggerInterface $logger,
-        private readonly Encoder $encoder,
+        private readonly Encoder $encoder = new JsonEncoder(),
+        private readonly ?LoggerInterface $logger = null,
     ) {
     }
 
@@ -38,7 +39,7 @@ public function encrypt($value, $serialize = true): string
             $encrypted = sodium_crypto_aead_aes256gcm_encrypt($serialized, $nonce, $nonce, $this->getKey());
             return Base64::constantUrlEncodeNoPadding($nonce . $encrypted);
         } catch (Exception $e) {
-            $this->logger->error($e->getMessage(), [
+            $this->logger?->error($e->getMessage(), [
                 'exception' => $e,
                 'stack' => $e->getTraceAsString(),
             ]);
@@ -55,7 +56,7 @@ public function decrypt($payload, $unserialize = true)
         try {
             $decrypted = sodium_crypto_aead_aes256gcm_decrypt($cipherText, $nonce, $nonce, $this->keyLoader->getKey());
         } catch (Exception $e) {
-            $this->logger->error($e->getMessage(), [
+            $this->logger?->error($e->getMessage(), [
                 'stack' => $e->getTraceAsString(),
                 'exception' => $e,
             ]);

src/Encryption/AesGcm256Encryptor.php

@@ -5,6 +5,7 @@
 namespace BrosSquad\LaravelCrypto\Encryption;
 
 use BrosSquad\LaravelCrypto\Encoder\Encoder;
+use BrosSquad\LaravelCrypto\Encoder\JsonEncoder;
 use BrosSquad\LaravelCrypto\Keys\Loader;
 use BrosSquad\LaravelCrypto\Support\Base64;
 use Exception;
@@ -18,8 +19,8 @@ final class XChaCha20Poly1305Encryptor
 
     public function __construct(
         private readonly Loader $keyLoader,
-        private readonly LoggerInterface $logger,
-        private readonly Encoder $encoder,
+        private readonly Encoder $encoder = new JsonEncoder(),
+        private readonly ?LoggerInterface $logger = null,
     ) {
     }
 
@@ -39,12 +40,12 @@ public function encrypt($value, $serialize = true): string
             );
             return Base64::constantUrlEncodeNoPadding($nonce . $encrypted);
         } catch (Exception $e) {
-            $this->logger->error($e->getMessage(), [
+            $this->logger?->error($e->getMessage(), [
                 'exception' => $e,
                 'value' => $value,
                 'serialize' => $serialize,
             ]);
-            throw new EncryptException('Value cannot be encrypted');
+            throw new EncryptException('Value cannot be encrypted ' . $e->getMessage());
         }
     }
 
@@ -62,10 +63,9 @@ public function decrypt($payload, $unserialize = true)
                 $this->keyLoader->getKey()
             );
         } catch (Exception $e) {
-            $this->logger->error($e->getMessage(), [
+            $this->logger?->error($e->getMessage(), [
                 'exception' => $e,
-                'value' => $value,
-                'serialize' => $serialize,
+                'serialize' => $unserialize,
             ]);
             throw new DecryptException('Payload cannot be decrypted');
         }
@@ -77,7 +77,7 @@ public function decrypt($payload, $unserialize = true)
         return $decrypted;
     }
 
-    public static function generateKey(string $cipher): string
+    public static function generateKey(string $_): string
     {
         return sodium_crypto_aead_xchacha20poly1305_ietf_keygen();
     }

src/Encryption/XChaCha20Poly1305Encryptor.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use BrosSquad\LaravelCrypto\Encryption\AesGcm256Encryptor;
+
+it('should encrypt/decrypt data', function (bool $serialize) {
+    $encryptor = new AesGcm256Encryptor(inMemoryKeyLoader());
+    $data = $serialize ? ['data'] : 'hello world';
+    $encrypted = $encryptor->encrypt($data, $serialize);
+
+    expect($encrypted)
+        ->toBeString()
+        ->and($encryptor->decrypt($encrypted, $serialize))
+        ->toBe($data);
+})->with([true, false]);
+
+it('should encrypt/decrypt string', function () {
+    $encryptor = new AesGcm256Encryptor(inMemoryKeyLoader());
+    $data = 'hello world';
+    $encrypted = $encryptor->encryptString($data);
+
+    expect($encrypted)
+        ->toBeString()
+        ->and($encryptor->decryptString($encrypted))
+        ->toBe($data);
+});

tests/Feature/Encryption/AesGcm256EncryptorTest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use BrosSquad\LaravelCrypto\Encryption\XChaCha20Poly1305Encryptor;
+
+it('should encrypt/decrypt data', function (bool $serialize) {
+    $encryptor = new XChaCha20Poly1305Encryptor(inMemoryKeyLoader());
+    $data = $serialize ? ['data'] : 'hello world';
+    $encrypted = $encryptor->encrypt($data, $serialize);
+
+    expect($encrypted)
+        ->toBeString()
+        ->and($encryptor->decrypt($encrypted, $serialize))
+        ->toBe($data);
+})->with([true, false]);
+
+it('should encrypt/decrypt string', function () {
+    $encryptor = new XChaCha20Poly1305Encryptor(inMemoryKeyLoader());
+    $data = 'hello world';
+    $encrypted = $encryptor->encryptString($data);
+
+    expect($encrypted)
+        ->toBeString()
+        ->and($encryptor->decryptString($encrypted))
+        ->toBe($data);
+});

tests/Feature/Encryption/XChaCha20Poly1305EncryptorTest.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BrosSquad\LaravelCrypto\Tests;
+
+use BrosSquad\LaravelCrypto\Keys\Loader;
+use Illuminate\Support\Str;
+
+class InMemoryAppKeyLoader implements Loader
+{
+    public function __construct(private readonly string $key)
+    {
+    }
+
+    public function getKey(): string|array
+    {
+        return Str::of($this->key)
+            ->remove('base64:', $this->key)
+            ->fromBase64()
+            ->toString();
+    }
+}

tests/InMemoryAppKeyLoader.php

@@ -2,6 +2,44 @@
 
 declare(strict_types=1);
 
+use BrosSquad\LaravelCrypto\Tests\InMemoryAppKeyLoader;
 use BrosSquad\LaravelCrypto\Tests\TestCase;
+use BrosSquad\LaravelCrypto\Keys\Loader;
 
 uses(TestCase::class)->in(__DIR__);
+
+function inMemoryKeyLoader(): Loader
+{
+    return new InMemoryAppKeyLoader(config('app.key'));
+}
+
+expect()->extend('toBeBase64', function () {
+    if (!preg_match('/^[-A-Za-z0-9+\/]+={0,3}$/', preg_quote($this->value, '/'))) {
+        throw new RuntimeException(sprintf('Value %s is not a valid base64 string', $this->value));
+    }
+
+    return $this;
+});
+
+expect()->extend('toBeBase64NoPadding', function () {
+    if (!preg_match('/^[-A-Za-z0-9+\/]+$/', preg_quote($this->value, '/'))) {
+        throw new RuntimeException(sprintf('Value %s is not a valid base64 string', $this->value));
+    }
+    return $this;
+});
+
+expect()->extend('toBeBase64Url', function () {
+    if (!preg_match('/^[-A-Za-z0-9_-]+={0,3}$/', $this->value)) {
+        throw new RuntimeException(sprintf('Value %s is not a valid base64 string', $this->value));
+    }
+
+    return $this;
+});
+
+expect()->extend('toBeBase64UrlNoPadding', function () {
+    if (!preg_match('/^[-A-Za-z0-9_-]+$/', $this->value)) {
+        throw new RuntimeException(sprintf('Value %s is not a valid base64 string', $this->value));
+    }
+
+    return $this;
+});