chore: keys

CodeLieutenant · CodeLieutenant · commit 4679f2b0f655 · 2024-03-05T12:50:19.000+01:00
Signed-off-by: Dusan Malusev &lt;dusan@dusanmalusev.dev&gt;
diff --git a/src/Console/GenerateCryptoKeysCommand.php b/src/Console/GenerateCryptoKeysCommand.php
@@ -5,7 +5,7 @@
 namespace CodeLieutenant\LaravelCrypto\Console;
 
 use CodeLieutenant\LaravelCrypto\Keys\Generators\AppKeyGenerator;
-use CodeLieutenant\LaravelCrypto\Keys\Generators\Blake2bHashingKeyGenerator;
+use CodeLieutenant\LaravelCrypto\Keys\Generators\Blake2BHashingKeyGenerator;
 use CodeLieutenant\LaravelCrypto\Keys\Generators\EdDSASignerKeyGenerator;
 use CodeLieutenant\LaravelCrypto\Keys\Generators\HmacKeyGenerator;
 use Exception;
@@ -31,7 +31,7 @@ class GenerateCryptoKeysCommand extends Command
     public function handle(
         EdDSASignerKeyGenerator $edDSAGenerator,
         AppKeyGenerator $appKeyGenerator,
-        Blake2bHashingKeyGenerator $blake2bKeyGenerator,
+        Blake2BHashingKeyGenerator $blake2bKeyGenerator,
         HmacKeyGenerator $hmacKeyGenerator,
     ): int {
         $show = $this->option('show');
diff --git a/src/Contracts/KeyGeneration.php b/src/Contracts/KeyGeneration.php
diff --git a/src/Contracts/KeyGenerator.php b/src/Contracts/KeyGenerator.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace CodeLieutenant\LaravelCrypto\Keys\Generators;
+namespace CodeLieutenant\LaravelCrypto\Contracts;
 
-interface Generator
+interface KeyGenerator
 {
     public function generate(?string $write): ?string;
 }
diff --git a/src/Encryption/AesGcm256Encrypter.php b/src/Encryption/AesGcm256Encrypter.php
@@ -5,7 +5,6 @@
 namespace CodeLieutenant\LaravelCrypto\Encryption;
 
 use CodeLieutenant\LaravelCrypto\Contracts\Encoder;
-use CodeLieutenant\LaravelCrypto\Contracts\KeyGeneration;
 use CodeLieutenant\LaravelCrypto\Contracts\KeyLoader;
 use CodeLieutenant\LaravelCrypto\Encoder\JsonEncoder;
 use CodeLieutenant\LaravelCrypto\Support\Base64;
@@ -17,7 +16,7 @@
 use Illuminate\Contracts\Encryption\StringEncrypter;
 use Psr\Log\LoggerInterface;
 
-final class AesGcm256Encrypter implements Encrypter, KeyGeneration, StringEncrypter
+final class AesGcm256Encrypter implements Encrypter, StringEncrypter
 {
     use Crypto;
 
@@ -70,11 +69,6 @@ public function decrypt($payload, $unserialize = true)
         };
     }
 
-    public static function generateKey(string $cipher): string
-    {
-        return sodium_crypto_aead_aes256gcm_keygen();
-    }
-
     public static function nonceSize(): int
     {
         return SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES;
diff --git a/src/Encryption/XChaCha20Poly1305Encrypter.php b/src/Encryption/XChaCha20Poly1305Encrypter.php
@@ -5,7 +5,6 @@
 namespace CodeLieutenant\LaravelCrypto\Encryption;
 
 use CodeLieutenant\LaravelCrypto\Contracts\Encoder;
-use CodeLieutenant\LaravelCrypto\Contracts\KeyGeneration;
 use CodeLieutenant\LaravelCrypto\Contracts\KeyLoader;
 use CodeLieutenant\LaravelCrypto\Encoder\JsonEncoder;
 use CodeLieutenant\LaravelCrypto\Support\Base64;
@@ -17,7 +16,7 @@
 use Illuminate\Contracts\Encryption\StringEncrypter;
 use Psr\Log\LoggerInterface;
 
-final class XChaCha20Poly1305Encrypter implements Encrypter, KeyGeneration, StringEncrypter
+final class XChaCha20Poly1305Encrypter implements Encrypter, StringEncrypter
 {
     use Crypto;
 
@@ -81,11 +80,6 @@ public function decrypt($payload, $unserialize = true)
         return $decrypted;
     }
 
-    public static function generateKey(string $_): string
-    {
-        return sodium_crypto_aead_xchacha20poly1305_ietf_keygen();
-    }
-
     public static function nonceSize(): int
     {
         return SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES;
diff --git a/src/Keys/Blake2bHashingKey.php b/src/Keys/Blake2bHashingKey.php
diff --git a/src/Keys/Generators/AppKeyGenerator.php b/src/Keys/Generators/AppKeyGenerator.php
@@ -4,14 +4,15 @@
 
 namespace CodeLieutenant\LaravelCrypto\Keys\Generators;
 
+use CodeLieutenant\LaravelCrypto\Contracts\KeyGenerator;
 use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
 use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
 use CodeLieutenant\LaravelCrypto\Enums\Encryption;
 use CodeLieutenant\LaravelCrypto\Traits\EnvKeySaver;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Encryption\Encrypter;
 
-class AppKeyGenerator implements Generator
+class AppKeyGenerator implements KeyGenerator
 {
     use EnvKeySaver;
 
@@ -31,8 +32,8 @@ public function generate(?string $write): ?string
 
         $new = $this->formatKey(
             match (Encryption::tryFrom($cipher)) {
-                Encryption::SodiumAES256GCM => AesGcm256Encrypter::generateKey($cipher),
-                Encryption::SodiumXChaCha20Poly1305 => XChaCha20Poly1305Encrypter::generateKey($cipher),
+                Encryption::SodiumAES256GCM => sodium_crypto_aead_aes256gcm_keygen(),
+                Encryption::SodiumXChaCha20Poly1305 => sodium_crypto_aead_xchacha20poly1305_ietf_keygen(),
                 default => Encrypter::generateKey($cipher),
             }
         );
diff --git a/src/Keys/Generators/Blake2BHashingKeyGenerator.php b/src/Keys/Generators/Blake2BHashingKeyGenerator.php
@@ -4,11 +4,12 @@
 
 namespace CodeLieutenant\LaravelCrypto\Keys\Generators;
 
+use CodeLieutenant\LaravelCrypto\Contracts\KeyGenerator;
 use CodeLieutenant\LaravelCrypto\Support\Random;
 use CodeLieutenant\LaravelCrypto\Traits\EnvKeySaver;
 use Illuminate\Contracts\Config\Repository;
 
-class Blake2bHashingKeyGenerator implements Generator
+class Blake2BHashingKeyGenerator implements KeyGenerator
 {
     use EnvKeySaver;
 
diff --git a/src/Keys/Generators/EdDSASignerKeyGenerator.php b/src/Keys/Generators/EdDSASignerKeyGenerator.php
@@ -4,12 +4,13 @@
 
 namespace CodeLieutenant\LaravelCrypto\Keys\Generators;
 
+use CodeLieutenant\LaravelCrypto\Contracts\KeyGenerator;
 use Illuminate\Contracts\Config\Repository;
 use Psr\Log\LoggerInterface;
 use RuntimeException;
 use SplFileObject;
 
-class EdDSASignerKeyGenerator implements Generator
+class EdDSASignerKeyGenerator implements KeyGenerator
 {
     private const CONFIG_KEY_PATH = 'crypto.signing.keys.eddsa';
 
diff --git a/src/Keys/Generators/HmacKeyGenerator.php b/src/Keys/Generators/HmacKeyGenerator.php
@@ -4,7 +4,7 @@
 
 namespace CodeLieutenant\LaravelCrypto\Keys\Generators;
 
-class HmacKeyGenerator extends Blake2bHashingKeyGenerator
+class HmacKeyGenerator extends Blake2BHashingKeyGenerator
 {
     public const ENV = 'CRYPTO_HMAC_KEY';
     public const CONFIG_KEY_PATH = 'crypto.signing.keys.hmac';
diff --git a/src/Keys/Loaders/AppKeyLoader.php b/src/Keys/Loaders/AppKeyLoader.php
@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace CodeLieutenant\LaravelCrypto\Keys;
+namespace CodeLieutenant\LaravelCrypto\Keys\Loaders;
 
 use CodeLieutenant\LaravelCrypto\Contracts\KeyLoader;
 use CodeLieutenant\LaravelCrypto\Traits\LaravelKeyParser;
 use Illuminate\Contracts\Config\Repository;
 
-class AppKey implements KeyLoader
+class AppKeyLoader implements KeyLoader
 {
     use LaravelKeyParser;
 
diff --git a/src/Keys/Loaders/Blake2BHashingKeyLoader.php b/src/Keys/Loaders/Blake2BHashingKeyLoader.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CodeLieutenant\LaravelCrypto\Keys\Loaders;
+
+
+class Blake2BHashingKeyLoader extends AppKeyLoader
+{
+    public const CONFIG_KEY_PATH = 'crypto.signing.keys.hmac';
+}
diff --git a/src/Keys/Loaders/EdDSASignerKeyLoader.php b/src/Keys/Loaders/EdDSASignerKeyLoader.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace CodeLieutenant\LaravelCrypto\Keys;
+namespace CodeLieutenant\LaravelCrypto\Keys\Loaders;
 
 use CodeLieutenant\LaravelCrypto\Contracts\KeyLoader;
 use Illuminate\Contracts\Config\Repository;
@@ -11,7 +11,7 @@
 use RuntimeException;
 use SplFileObject;
 
-class EdDSASignerKey implements KeyLoader
+class EdDSASignerKeyLoader implements KeyLoader
 {
     public const KEY_LENGTH = SODIUM_CRYPTO_SIGN_KEYPAIRBYTES;
     public const PUBLIC_KEY_LENGTH = SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES;
diff --git a/src/Keys/Loaders/HmacKeyLoader.php b/src/Keys/Loaders/HmacKeyLoader.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace CodeLieutenant\LaravelCrypto\Keys;
+namespace CodeLieutenant\LaravelCrypto\Keys\Loaders;
 
-class HmacKey extends AppKey
+class HmacKeyLoader extends AppKeyLoader
 {
     public const CONFIG_KEY_PATH = 'crypto.signing.keys.hmac';
 }
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -20,14 +20,14 @@
 use CodeLieutenant\LaravelCrypto\Hashing\HashingManager;
 use CodeLieutenant\LaravelCrypto\Hashing\Sha256;
 use CodeLieutenant\LaravelCrypto\Hashing\Sha512;
-use CodeLieutenant\LaravelCrypto\Keys\AppKey;
-use CodeLieutenant\LaravelCrypto\Keys\Blake2bHashingKey;
-use CodeLieutenant\LaravelCrypto\Keys\EdDSASignerKey;
 use CodeLieutenant\LaravelCrypto\Keys\Generators\AppKeyGenerator;
-use CodeLieutenant\LaravelCrypto\Keys\Generators\Blake2bHashingKeyGenerator;
+use CodeLieutenant\LaravelCrypto\Keys\Generators\Blake2BHashingKeyGenerator;
 use CodeLieutenant\LaravelCrypto\Keys\Generators\EdDSASignerKeyGenerator;
 use CodeLieutenant\LaravelCrypto\Keys\Generators\HmacKeyGenerator;
-use CodeLieutenant\LaravelCrypto\Keys\HmacKey;
+use CodeLieutenant\LaravelCrypto\Keys\Loaders\AppKeyLoader;
+use CodeLieutenant\LaravelCrypto\Keys\Loaders\Blake2BHashingKeyLoader;
+use CodeLieutenant\LaravelCrypto\Keys\Loaders\EdDSASignerKeyLoader;
+use CodeLieutenant\LaravelCrypto\Keys\Loaders\HmacKeyLoader;
 use CodeLieutenant\LaravelCrypto\Signing\EdDSA\EdDSA;
 use CodeLieutenant\LaravelCrypto\Signing\Hmac\Blake2b as HmacBlake2b;
 use CodeLieutenant\LaravelCrypto\Signing\Hmac\Sha256 as HmacSha256;
@@ -91,22 +91,22 @@ protected function registerEncoder(): void
     protected function registerKeyLoaders(): void
     {
         $this->app->singleton(
-            AppKey::class,
-            fn(Application $app) => AppKey::make($app->make(Repository::class))
+            AppKeyLoader::class,
+            fn(Application $app) => AppKeyLoader::make($app->make(Repository::class))
         );
         $this->app->singleton(
-            Blake2bHashingKey::class,
-            fn(Application $app) => Blake2bHashingKey::make($app->make(Repository::class))
+            Blake2BHashingKeyLoader::class,
+            fn(Application $app) => Blake2BHashingKeyLoader::make($app->make(Repository::class))
         );
 
         $this->app->singleton(
-            HmacKey::class,
-            fn(Application $app) => HmacKey::make($app->make(Repository::class))
+            HmacKeyLoader::class,
+            fn(Application $app) => HmacKeyLoader::make($app->make(Repository::class))
         );
 
         $this->app->singleton(
-            EdDSASignerKey::class,
-            fn(Application $app) => EdDSASignerKey::make(
+            EdDSASignerKeyLoader::class,
+            fn(Application $app) => EdDSASignerKeyLoader::make(
                 $app->make(Repository::class),
                 $app->make(LoggerInterface::class)
             )
@@ -119,7 +119,7 @@ protected function registerSigners(): void
 
         $this->app->when(EdDSA::class)
             ->needs(KeyLoader::class)
-            ->give(EdDSASignerKey::class);
+            ->give(EdDSASignerKeyLoader::class);
 
         $hmacSigners = [
             HmacBlake2b::class,
@@ -130,7 +130,7 @@ protected function registerSigners(): void
         foreach ($hmacSigners as $signer) {
             $this->app->singleton($signer, function (Application $app) use ($signer) {
                 $config = $app->make(Repository::class)->get('crypto.signing.config.' . $signer);
-                $keyLoader = $app->make(HmacKey::class);
+                $keyLoader = $app->make(HmacKeyLoader::class);
 
                 return $config !== null ? new $signer($keyLoader, $config) : new $signer($keyLoader);
             });
@@ -177,7 +177,7 @@ protected function registerEncrypter(): void
             $this->app->singleton($encryptor);
             $this->app->when($encryptor)
                 ->needs(KeyLoader::class)
-                ->give(AppKey::class);
+                ->give(AppKeyLoader::class);
         }
 
         $func = static function (Application $app) {
@@ -186,7 +186,7 @@ protected function registerEncrypter(): void
             $enc = Encryption::tryFrom($cipher);
 
             if ($enc === null) {
-                return new LaravelConcreteEncrypter($app->make(AppKey::class)->getKey(), $cipher);
+                return new LaravelConcreteEncrypter($app->make(AppKeyLoader::class)->getKey(), $cipher);
             }
 
             return match ($enc) {
@@ -202,7 +202,7 @@ protected function registerEncrypter(): void
     protected function registerGenerators(): void
     {
         $this->app->singleton(AppKeyGenerator::class);
-        $this->app->singleton(Blake2bHashingKeyGenerator::class);
+        $this->app->singleton(Blake2BHashingKeyGenerator::class);
         $this->app->singleton(HmacKeyGenerator::class);
         $this->app->singleton(EdDSASignerKeyGenerator::class);
     }
diff --git a/tests/Architecture/EncryptionTest.php b/tests/Architecture/EncryptionTest.php
@@ -2,17 +2,12 @@
 
 declare(strict_types=1);
 
-use CodeLieutenant\LaravelCrypto\Contracts\KeyGeneration;
-use CodeLieutenant\LaravelCrypto\Encryption\AesGcm256Encrypter;
-use CodeLieutenant\LaravelCrypto\Encryption\XChaCha20Poly1305Encrypter;
-use CodeLieutenant\LaravelCrypto\Enums\Encryption;
-use CodeLieutenant\LaravelCrypto\Traits\Crypto;
 use Illuminate\Contracts\Encryption\Encrypter;
 use Illuminate\Contracts\Encryption\StringEncrypter;
 
 arch('encryption')
     ->expect('CodeLieutenant\LaravelCrypto\Encryption')
-    ->toImplement([Encrypter::class, StringEncrypter::class])
+    ->toOnlyImplement([Encrypter::class, StringEncrypter::class])
     ->toBeClasses()
     ->toHaveSuffix('Encrypter')
     ->toBeFinal();
diff --git a/tests/Architecture/KeysTest.php b/tests/Architecture/KeysTest.php
@@ -2,10 +2,17 @@
 
 declare(strict_types=1);
 
+use CodeLieutenant\LaravelCrypto\Contracts\KeyGenerator;
 use CodeLieutenant\LaravelCrypto\Contracts\KeyLoader;
 
-arch('keys')
-    ->expect('CodeLieutenant\LaravelCrypto\Keys')
+arch('keys loaders')
+    ->expect('CodeLieutenant\LaravelCrypto\Keys\Loaders')
     ->toBeClasses()
-    ->toImplement(KeyLoader::class)
-    ->toHaveSuffix('Key');
+    ->toOnlyImplement(KeyLoader::class)
+    ->toHaveSuffix('KeyLoader');
+
+arch('key generators')
+    ->expect('CodeLieutenant\LaravelCrypto\Keys\Generators')
+    ->toBeClasses()
+    ->toImplement(KeyGenerator::class)
+    ->toHaveSuffix('KeyGenerator');

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`declare(strict_types=1);`
`4`	`4`
`5`		`-namespace CodeLieutenant\LaravelCrypto\Keys\Generators;`
	`5`	`+namespace CodeLieutenant\LaravelCrypto\Contracts;`
`6`	`6`
`7`		`-interface Generator`
	`7`	`+interface KeyGenerator`
`8`	`8`	`{`
`9`	`9`	`public function generate(?string $write): ?string;`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace CodeLieutenant\LaravelCrypto\Keys\Generators;`
`6`	`6`
`7`		`-class HmacKeyGenerator extends Blake2bHashingKeyGenerator`
	`7`	`+class HmacKeyGenerator extends Blake2BHashingKeyGenerator`
`8`	`8`	`{`
`9`	`9`	`public const ENV = 'CRYPTO_HMAC_KEY';`
`10`	`10`	`public const CONFIG_KEY_PATH = 'crypto.signing.keys.hmac';`