rewrite cryptography

Author: DavidBadura

phpstan.neon.dist

@@ -15,3 +15,7 @@ services:
 		class: Patchlevel\Hydrator\Tests\Architecture\FinalClassesTest
 		tags:
 			- phpat.test
+	-
+		class: Patchlevel\Hydrator\Tests\Architecture\ExceptionImplementsHydratorExceptionTest
+		tags:
+			- phpat.test

src/Attribute/SensitiveData.php

@@ -10,7 +10,7 @@
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class SensitiveData
 {
-    /** @var (callable(string, mixed):mixed)|null */
+    /** @var (callable(string):mixed)|null */
     public readonly mixed $fallbackCallable;
 
     public function __construct(

src/Cryptography/BaseCryptographer.php

@@ -0,0 +1,91 @@
+<?php
+
+namespace Patchlevel\Hydrator\Cryptography;
+
+use Patchlevel\Hydrator\Cryptography\Cipher\Cipher;
+use Patchlevel\Hydrator\Cryptography\Cipher\CipherKey;
+use Patchlevel\Hydrator\Cryptography\Cipher\CipherKeyFactory;
+use Patchlevel\Hydrator\Cryptography\Cipher\DecryptionFailed;
+use Patchlevel\Hydrator\Cryptography\Cipher\EncryptionFailed;
+use Patchlevel\Hydrator\Cryptography\Cipher\OpensslCipher;
+use Patchlevel\Hydrator\Cryptography\Cipher\OpensslCipherKeyFactory;
+use Patchlevel\Hydrator\Cryptography\Store\CipherKeyNotExists;
+use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
+
+/**
+ * @phpstan-type EncryptedDataV1 array{
+ *     __enc: 'v1',
+ *     data: non-empty-string,
+ *     method?: non-empty-string,
+ *     iv?: non-empty-string,
+ * }
+ */
+final class BaseCryptographer implements Cryptographer
+{
+    public function __construct(
+        private readonly Cipher $cipher,
+        private readonly CipherKeyStore $cipherKeyStore,
+        private readonly CipherKeyFactory $cipherKeyFactory,
+    )
+    {
+    }
+
+    /**
+     * @throws EncryptionFailed
+     *
+     * @return EncryptedDataV1
+     */
+    public function encrypt(string $subjectId, mixed $value): array
+    {
+        try {
+            $cipherKey = $this->cipherKeyStore->get($subjectId);
+        } catch (CipherKeyNotExists) {
+            $cipherKey = ($this->cipherKeyFactory)();
+            $this->cipherKeyStore->store($subjectId, $cipherKey);
+        }
+
+        return [
+            '__enc' => 'v1',
+            'data' => $this->cipher->encrypt($cipherKey, $value),
+            'method' => $cipherKey->method,
+            'iv' => $cipherKey->iv,
+        ];
+    }
+
+    /**
+     * @param EncryptedDataV1 $encryptedData
+     *
+     * @throws CipherKeyNotExists
+     * @throws DecryptionFailed
+     */
+    public function decrypt(string $subjectId, mixed $encryptedData): mixed
+    {
+        $cipherKey = $this->cipherKeyStore->get($subjectId);
+
+        return $this->cipher->decrypt(
+            new CipherKey(
+            $cipherKey->key,
+            $encryptedData['method'] ?? $cipherKey->method,
+            $encryptedData['iv'] ?? $cipherKey->iv
+        ),
+            $encryptedData['data']
+        );
+    }
+
+    public function supports(mixed $value): bool
+    {
+        return is_array($value) && array_key_exists('__enc', $value) && $value['__enc'] === 'v1';
+    }
+
+    /** @param non-empty-string $method */
+    public static function createWithOpenssl(
+        CipherKeyStore $cryptoStore,
+        string $method = OpensslCipherKeyFactory::DEFAULT_METHOD,
+    ): static {
+        return new self(
+            new OpensslCipher(),
+            $cryptoStore,
+            new OpensslCipherKeyFactory($method),
+        );
+    }
+}

src/Cryptography/Cipher/Cipher.php

@@ -6,7 +6,11 @@
 
 interface Cipher
 {
-    /** @throws EncryptionFailed */
+    /**
+     * @return non-empty-string
+     *
+     * @throws EncryptionFailed
+     */
     public function encrypt(CipherKey $key, mixed $data): string;
 
     /** @throws DecryptionFailed */

src/Cryptography/Cipher/CreateCipherKeyFailed.php

@@ -4,9 +4,10 @@
 
 namespace Patchlevel\Hydrator\Cryptography\Cipher;
 
+use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
-final class CreateCipherKeyFailed extends RuntimeException
+final class CreateCipherKeyFailed extends RuntimeException implements HydratorException
 {
     public function __construct()
     {

src/Cryptography/Cipher/DecryptionFailed.php

@@ -4,9 +4,10 @@
 
 namespace Patchlevel\Hydrator\Cryptography\Cipher;
 
+use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
-final class DecryptionFailed extends RuntimeException
+final class DecryptionFailed extends RuntimeException implements HydratorException
 {
     public function __construct()
     {

src/Cryptography/Cipher/EncryptionFailed.php

@@ -4,9 +4,10 @@
 
 namespace Patchlevel\Hydrator\Cryptography\Cipher;
 
+use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
-final class EncryptionFailed extends RuntimeException
+final class EncryptionFailed extends RuntimeException implements HydratorException
 {
     public function __construct()
     {

src/Cryptography/Cipher/MethodNotSupported.php

@@ -4,11 +4,12 @@
 
 namespace Patchlevel\Hydrator\Cryptography\Cipher;
 
+use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
 use function sprintf;
 
-final class MethodNotSupported extends RuntimeException
+final class MethodNotSupported extends RuntimeException implements HydratorException
 {
     public function __construct(string $method)
     {

src/Cryptography/Cipher/OpensslCipher.php

@@ -17,6 +17,9 @@
 
 final class OpensslCipher implements Cipher
 {
+    /**
+     * @return non-empty-string
+     */
     public function encrypt(CipherKey $key, mixed $data): string
     {
         $encryptedData = @openssl_encrypt(

src/Cryptography/CryptoNormalizer.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Patchlevel\Hydrator\Cryptography;
+
+use Closure;
+use Patchlevel\Hydrator\Cryptography\Cipher\DecryptionFailed;
+use Patchlevel\Hydrator\Cryptography\Store\CipherKeyNotExists;
+use Patchlevel\Hydrator\Normalizer\ContextAwareNormalizer;
+use Patchlevel\Hydrator\Normalizer\InvalidArgument;
+use Patchlevel\Hydrator\Normalizer\Normalizer;
+
+final class CryptoNormalizer implements Normalizer, ContextAwareNormalizer
+{
+    public function __construct(
+        private readonly Cryptographer $cryptographer,
+        private readonly string $subjectIdName,
+        private readonly mixed $fallback = null,
+        private readonly Normalizer|null $normalizer = null,
+    ) {
+    }
+
+    /**
+     * @param array<string, mixed> $context
+     *
+     * @throws InvalidArgument
+     */
+    public function normalize(mixed $value, array $context = []): mixed
+    {
+        if ($this->normalizer !== null) {
+            $value = $this->normalizer->normalize($value, $context);
+        }
+
+        if ($value === null) {
+            return null;
+        }
+
+        return $this->cryptographer->encrypt($context[SubjectIds::class]->get($this->subjectIdName), $value);
+    }
+
+    /**
+     * @param array<string, mixed> $context
+     *
+     * @throws InvalidArgument
+     */
+    public function denormalize(mixed $value, array $context = []): mixed
+    {
+        if (!$this->cryptographer->supports($value)) {
+            if ($this->normalizer === null) {
+                return $value;
+            }
+
+            return $this->normalizer->denormalize($value, $context);
+        }
+
+        $subjectId = $context[SubjectIds::class]->get($this->subjectIdName);
+
+        try {
+            $data = $this->cryptographer->decrypt($subjectId, $value);
+        } catch (DecryptionFailed|CipherKeyNotExists) {
+            if ($this->fallback instanceof Closure) {
+                return ($this->fallback)($subjectId);
+            }
+
+            return $this->fallback;
+        }
+
+        if ($this->normalizer === null) {
+            return $data;
+        }
+
+        return $this->normalizer->denormalize($data, $context);
+    }
+}