Merge pull request #107 from patchlevel/add-multiple-subject-id-identifiers

Author: DanielBadura

README.md

@@ -528,7 +528,7 @@ There are two events: `PostExtract` and `PreHydrate`.
 For this functionality we use the [symfony/event-dispatcher](https://symfony.com/doc/current/components/event_dispatcher.html).
 
 ```php
-use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
+use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 use Patchlevel\Hydrator\Metadata\Event\EventMetadataFactory;
 use Patchlevel\Hydrator\MetadataHydrator;
@@ -557,8 +557,8 @@ $hydrator = new MetadataHydrator(eventDispatcher: $eventDispatcher);
 
 ### Cryptography
 
-The library also offers the possibility to encrypt and decrypt personal data.
-For this purpose, a key is created for each subject ID, which is used to encrypt the personal data.
+The library also offers the possibility to encrypt and decrypt sensitive data, e.g. personal data of customers.
+For this purpose, a key is created for each subject ID, which is used to encrypt the sensitive data.
 
 #### DataSubjectId
 
@@ -579,42 +579,62 @@ final class EmailChanged
 
 > [!WARNING]
 > The `DataSubjectId` must be a string. You can use a normalizer to convert it to a string.
-> The Subject ID cannot be personal data.
+> The Subject ID cannot be sensitive data.
 
-#### PersonalData
+First we need to define what the subject id is.
 
-Next, we need to specify which fields we want to encrypt.
+```php
+use Patchlevel\Hydrator\Attribute\DataSubjectId;
+
+final class EmailChanged
+{
+    public function __construct(
+        #[DataSubjectId(name: 'profile')]
+        public readonly string $profileId,
+    ) {
+    }
+}
+```
+
+You can also use multiple data subject id's in one event by defining the name of the subject id's.
 
 ```php
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 final class DTO 
 {
     public function __construct(
-        #[DataSubjectId]
-        public readonly string $profileId,
-        #[PersonalData]
-        public readonly string|null $email,
+        #[DataSubjectId(name: 'profile1')]
+        public readonly string $profile1Id,
+        #[SensitiveData(subjectIdName: 'profile1')]
+        public readonly string|null $email1,
+        #[DataSubjectId(name: 'profile2')]
+        public readonly string $profile2Id,
+        #[SensitiveData(subjectIdName: 'profile2')]
+        public readonly string|null $email2,
     ) {
     }
 }
 ```
 
+> [!NOTE]
+> The default name of `DataSubjectId` is `default`.
+
 If the information could not be decrypted, then a fallback value is inserted.
 The default fallback value is `null`.
 You can change this by setting the `fallback` parameter.
 In this case `unknown` is added:
 
 ```php
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 final class DTO
 {
     public function __construct(
         #[DataSubjectId]
         public readonly string $profileId,
-        #[PersonalData(fallback: 'unknown')]
+        #[SensitiveData(fallback: 'unknown')]
         public readonly string $name,
     ) {
     }
@@ -625,16 +645,16 @@ You can also use a callable as a fallback.
 
 ```php
 use Patchlevel\Hydrator\Attribute\DataSubjectId;
-use Patchlevel\Hydrator\Attribute\PersonalData;
+use Patchlevel\Hydrator\Attribute\SensitiveData;
 
 final class ProfileCreated
 {
     public function __construct(
         #[DataSubjectId]
         public readonly string $profileId,
-        #[PersonalData(fallback: 'deleted profile')]
+        #[SensitiveData(fallback: 'deleted profile')]
         public readonly string $name,
-        #[PersonalData(fallbackCallable: [self::class, 'anonymizedEmail'])]
+        #[SensitiveData(fallbackCallable: [self::class, 'anonymizedEmail'])]
         public readonly string $email,
     ) {
     }
@@ -655,13 +675,13 @@ final class ProfileCreated
 Here we show you how to configure the cryptography.
 
 ```php
-use Patchlevel\Hydrator\Cryptography\PersonalDataPayloadCryptographer;
+use Patchlevel\Hydrator\Cryptography\SensitiveDataPayloadCryptographer;
 use Patchlevel\Hydrator\Cryptography\Store\CipherKeyStore;
 use Patchlevel\Hydrator\Metadata\Event\EventMetadataFactory;
 use Patchlevel\Hydrator\MetadataHydrator;
 
 $cipherKeyStore = new InMemoryCipherKeyStore();
-$cryptographer = PersonalDataPayloadCryptographer::createWithDefaultSettings($cipherKeyStore);
+$cryptographer = SensitiveDataPayloadCryptographer::createWithDefaultSettings($cipherKeyStore);
 $hydrator = new MetadataHydrator(cryptographer: $cryptographer);
 ```
 

baseline.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="6.12.0@cf420941d061a57050b6c468ef2c778faf40aee2">
-  <file src="src/Attribute/PersonalData.php">
+  <file src="src/Attribute/SensitiveData.php">
     <MixedPropertyTypeCoercion>
       <code><![CDATA[$fallbackCallable]]></code>
     </MixedPropertyTypeCoercion>
@@ -17,7 +17,7 @@
       <code><![CDATA[list<string>]]></code>
     </MoreSpecificReturnType>
   </file>
-  <file src="src/Cryptography/PersonalDataPayloadCryptographer.php">
+  <file src="src/Cryptography/SensitiveDataPayloadCryptographer.php">
     <MixedArgument>
       <code><![CDATA[$rawData]]></code>
     </MixedArgument>
@@ -30,12 +30,6 @@
     </MixedAssignment>
   </file>
   <file src="src/Metadata/AttributeMetadataFactory.php">
-    <InvalidReturnStatement>
-      <code><![CDATA[[false, null]]]></code>
-    </InvalidReturnStatement>
-    <InvalidReturnType>
-      <code><![CDATA[array{bool, mixed, (callable(string, mixed):mixed)|null}]]></code>
-    </InvalidReturnType>
     <PossiblyNullReference>
       <code><![CDATA[guess]]></code>
     </PossiblyNullReference>
@@ -47,7 +41,7 @@
   </file>
   <file src="src/Metadata/PropertyMetadata.php">
     <RiskyTruthyFalsyComparison>
-      <code><![CDATA[$this->personalDataFallbackCallable]]></code>
+      <code><![CDATA[$this->sensitiveDataFallbackCallable]]></code>
     </RiskyTruthyFalsyComparison>
   </file>
   <file src="src/MetadataHydrator.php">
@@ -82,23 +76,6 @@
       <code><![CDATA[$value]]></code>
     </MixedArgumentTypeCoercion>
   </file>
-  <file src="tests/Benchmark/tideways.php">
-    <ClassMustBeFinal>
-      <code><![CDATA[CompiledMetadataHydrator]]></code>
-    </ClassMustBeFinal>
-    <MixedMethodCall>
-      <code><![CDATA[normalize]]></code>
-      <code><![CDATA[normalize]]></code>
-    </MixedMethodCall>
-    <MixedReturnTypeCoercion>
-      <code><![CDATA[array]]></code>
-      <code><![CDATA[match (true) {
-            $object instanceof ProfileCreated => $this->extractProfileCreated($object),
-            $object instanceof Skill => $this->extractSkill($object),
-            default => throw new InvalidArgumentException('Unknown object type'),
-        }]]></code>
-    </MixedReturnTypeCoercion>
-  </file>
   <file src="tests/Unit/Cryptography/Cipher/OpensslCipherTest.php">
     <MixedAssignment>
       <code><![CDATA[$return]]></code>

phpstan-baseline.neon

@@ -16,7 +16,7 @@ parameters:
 			message: '#^Parameter \#2 \$data of method Patchlevel\\Hydrator\\Cryptography\\Cipher\\Cipher\:\:decrypt\(\) expects string, mixed given\.$#'
 			identifier: argument.type
 			count: 1
-			path: src/Cryptography/PersonalDataPayloadCryptographer.php
+			path: src/Cryptography/SensitiveDataPayloadCryptographer.php
 
 		-
 			message: '#^Method Patchlevel\\Hydrator\\Guesser\\BuiltInGuesser\:\:guess\(\) has parameter \$type with generic class Symfony\\Component\\TypeInfo\\Type\\ObjectType but does not specify its types\: T$#'
@@ -54,12 +54,6 @@ parameters:
 			count: 1
 			path: src/Metadata/AttributeMetadataFactory.php
 
-		-
-			message: '#^Method Patchlevel\\Hydrator\\Metadata\\AttributeMetadataFactory\:\:getPersonalData\(\) should return array\{bool, mixed, \(callable\(string, mixed\)\: mixed\)\|null\} but returns array\{false, null\}\.$#'
-			identifier: return.type
-			count: 1
-			path: src/Metadata/AttributeMetadataFactory.php
-
 		-
 			message: '#^Parameter \#1 \$class of method Patchlevel\\Hydrator\\Metadata\\AttributeMetadataFactory\:\:findNormalizerOnClass\(\) expects class\-string, string given\.$#'
 			identifier: argument.type

src/Attribute/DataSubjectId.php

@@ -9,4 +9,8 @@
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class DataSubjectId
 {
+    public function __construct(
+        public readonly string $name = 'default',
+    ) {
+    }
 }

src/Attribute/PersonalData.php src/Attribute/SensitiveData.phpsrc/Attribute/PersonalData.php renamed to src/Attribute/SensitiveData.php

@@ -8,14 +8,15 @@
 use InvalidArgumentException;
 
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final class PersonalData
+final class SensitiveData
 {
     /** @var (callable(string, mixed):mixed)|null */
     public readonly mixed $fallbackCallable;
 
     public function __construct(
         public readonly mixed $fallback = null,
         callable|null $fallbackCallable = null,
+        public readonly string $subjectIdName = 'default',
     ) {
         $this->fallbackCallable = $fallbackCallable;
 

src/Cryptography/NotSensitiveData.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Patchlevel\Hydrator\Cryptography;
+
+use RuntimeException;
+
+use function sprintf;
+
+final class NotSensitiveData extends RuntimeException
+{
+    /** @param class-string $class */
+    public function __construct(string $class, string $fieldName)
+    {
+        parent::__construct(sprintf('Trying to get subject id for %s::%s which is not marked as sensitive data.', $class, $fieldName));
+    }
+}

…phy/PersonalDataPayloadCryptographer.php …hy/SensitiveDataPayloadCryptographer.phpsrc/Cryptography/PersonalDataPayloadCryptographer.php renamed to src/Cryptography/SensitiveDataPayloadCryptographer.php src/Cryptography/PersonalDataPayloadCryptographer.php renamed to src/Cryptography/SensitiveDataPayloadCryptographer.php

@@ -18,7 +18,7 @@
 use function is_int;
 use function is_string;
 
-final class PersonalDataPayloadCryptographer implements PayloadCryptographer
+final class SensitiveDataPayloadCryptographer implements PayloadCryptographer
 {
     public function __construct(
         private readonly CipherKeyStore $cipherKeyStore,
@@ -36,24 +36,20 @@ public function __construct(
      */
     public function encrypt(ClassMetadata $metadata, array $data): array
     {
-        $subjectId = $this->subjectId($metadata, $data);
-
-        if ($subjectId === null) {
-            return $data;
-        }
-
-        try {
-            $cipherKey = $this->cipherKeyStore->get($subjectId);
-        } catch (CipherKeyNotExists) {
-            $cipherKey = ($this->cipherKeyFactory)();
-            $this->cipherKeyStore->store($subjectId, $cipherKey);
-        }
-
         foreach ($metadata->properties() as $propertyMetadata) {
-            if (!$propertyMetadata->isPersonalData()) {
+            if (!$propertyMetadata->isSensitiveData()) {
                 continue;
             }
 
+            $subjectId = $this->subjectId($propertyMetadata, $metadata, $data);
+
+            try {
+                $cipherKey = $this->cipherKeyStore->get($subjectId);
+            } catch (CipherKeyNotExists) {
+                $cipherKey = ($this->cipherKeyFactory)();
+                $this->cipherKeyStore->store($subjectId, $cipherKey);
+            }
+
             $targetFieldName = $this->useEncryptedFieldName
                 ? $propertyMetadata->encryptedFieldName()
                 : $propertyMetadata->fieldName();
@@ -80,23 +76,19 @@ public function encrypt(ClassMetadata $metadata, array $data): array
      */
     public function decrypt(ClassMetadata $metadata, array $data): array
     {
-        $subjectId = $this->subjectId($metadata, $data);
-
-        if ($subjectId === null) {
-            return $data;
-        }
-
-        try {
-            $cipherKey = $this->cipherKeyStore->get($subjectId);
-        } catch (CipherKeyNotExists) {
-            $cipherKey = null;
-        }
-
         foreach ($metadata->properties() as $propertyMetadata) {
-            if (!$propertyMetadata->isPersonalData()) {
+            if (!$propertyMetadata->isSensitiveData()) {
                 continue;
             }
 
+            $subjectId = $this->subjectId($propertyMetadata, $metadata, $data);
+
+            try {
+                $cipherKey = $this->cipherKeyStore->get($subjectId);
+            } catch (CipherKeyNotExists) {
+                $cipherKey = null;
+            }
+
             if ($this->useEncryptedFieldName && array_key_exists($propertyMetadata->encryptedFieldName(), $data)) {
                 $rawData = $data[$propertyMetadata->encryptedFieldName()];
                 unset($data[$propertyMetadata->encryptedFieldName()]);
@@ -125,14 +117,20 @@ public function decrypt(ClassMetadata $metadata, array $data): array
     }
 
     /** @param array<string, mixed> $data */
-    private function subjectId(ClassMetadata $metadata, array $data): string|null
+    private function subjectId(PropertyMetadata $propertyMetadata, ClassMetadata $metadata, array $data): string
     {
-        $fieldName = $metadata->dataSubjectIdField();
+        if (!$propertyMetadata->isSensitiveData()) {
+            throw new NotSensitiveData($metadata->className(), $propertyMetadata->propertyName());
+        }
 
-        if ($fieldName === null) {
-            return null;
+        $sensitiveDataSubjectIdName = $propertyMetadata->sensitiveDataSubjectIdName();
+
+        if (!$metadata->hasSubjectIdIdentifier($sensitiveDataSubjectIdName)) {
+            throw new MissingSubjectId($metadata->className(), $propertyMetadata->propertyName());
         }
 
+        $fieldName = $metadata->getSubjectIdFieldName($sensitiveDataSubjectIdName);
+
         if (!array_key_exists($fieldName, $data)) {
             throw new MissingSubjectId($metadata->className(), $fieldName);
         }
@@ -152,10 +150,10 @@ private function subjectId(ClassMetadata $metadata, array $data): string|null
 
     private function fallback(PropertyMetadata $propertyMetadata, string $subjectId, mixed $rawData): mixed
     {
-        $callback = $propertyMetadata->personalDataFallbackCallback();
+        $callback = $propertyMetadata->sensitiveDataFallbackCallable();
 
         if (!$callback) {
-            return $propertyMetadata->personalDataFallback();
+            return $propertyMetadata->sensitiveDataFallback();
         }
 
         return $callback($subjectId, $rawData);