Skip to content

Enhancement: Add support for ?any? column types (e.g. json) #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ninos wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Enhancement: Add support for ?any? column types (e.g. json) #48

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c96efed
Enhancement: Add support for ?any? column types (e.g. json)
Ninos Sep 12, 2023
f7e01d7
Enhancement: Skip convertToDatabaseValue on string types
Ninos Sep 16, 2023
bb85298
Fixed: Allow any scalar types (bool, int, float, string)
Ninos Sep 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions src/Subscribers/DoctrineEncryptSubscriber.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
use Doctrine\Bundle\DoctrineBundle\EventSubscriber\EventSubscriberInterface;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Common\EventSubscriber;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Event\OnFlushEventArgs;
use Doctrine\ORM\Events;
Expand Down Expand Up @@ -159,26 +161,30 @@ protected function processFields(object $entity, EntityManagerInterface $em, boo
$unitOfWork = $em->getUnitOfWork();
$oid = spl_object_id($entity);
$meta = $em->getClassMetadata(get_class($entity));
$platform = $em->getConnection()->getDatabasePlatform();

foreach ($properties as $key => $refProperty) {
// Get the value in the entity.
$value = $refProperty->getValue($entity);
$type = ($fieldType = $meta->getTypeOfField($key)) ? Type::getType($fieldType) : null;

// Skip any null values.
if (null === $value) {
continue;
}

if (is_object($value)) {
throw new EncryptException('Cannot encrypt an object at '.$refProperty->class.':'.$refProperty->getName(), $value);
}

// Encryption is fired by onFlush event, else it is an onLoad event.
if ($isEncryptOperation) {
$changeSet = $unitOfWork->getEntityChangeSet($entity);

// Encrypt value only if change has been detected by Doctrine (comparing unencrypted values, see postLoad flow)
if (isset($changeSet[$key])) {
$value = is_scalar($value) ? $value : $type->convertToDatabaseValue($value, $platform);

if (!is_scalar($value)) {
throw new EncryptException('Cannot encrypt non-scalar value at '.$refProperty->class.':'.$refProperty->getName(), $value);
}

$encryptedValue = $this->encryptor->encrypt($value);
$refProperty->setValue($entity, $encryptedValue);
$unitOfWork->recomputeSingleEntityChangeSet($meta, $entity);
Expand All @@ -187,8 +193,13 @@ protected function processFields(object $entity, EntityManagerInterface $em, boo
$this->rawValues[$oid][$key] = $value;
}
} else {
if (!is_scalar($value)) {
throw new EncryptException('Cannot decrypt non-scalar value at '.$refProperty->class.':'.$refProperty->getName(), $value);
}

// Decryption is fired by onLoad and postFlush events.
$decryptedValue = $this->decryptValue($value);
$decryptedValue = $type->convertToPHPValue($decryptedValue, $platform);
$refProperty->setValue($entity, $decryptedValue);

// Tell Doctrine the original value was the decrypted one.
Expand Down