Merge pull request #13 from cleverage/bugfix/fix-decrypt-from-mcrypt

Fix a bug when decrypting from mcrypt as the fallback decryption is not triggered

Author: johnkrovitch

.travis.yml

@@ -13,6 +13,7 @@ install:
 
 script:
     - bin/phpunit
+    - bin/var-dump-check --symfony --exclude vendor src
 
 env:
     - SYMFONY_VERSION=4.4.*

Makefile

@@ -7,3 +7,4 @@ install:
 
 tests:
 	bin/phpunit
+	bin/var-dump-check --symfony --exclude vendor src

composer.json

@@ -27,7 +27,8 @@
         "doctrine/orm": "*",
         "symfony/security":"^4.4|^5.1",
         "symfony/monolog-bundle": "^3.6",
-        "symfony/string": "^5.2"
+        "symfony/string": "^5.2",
+        "php-parallel-lint/php-var-dump-check": "^0.5.0"
     },
     "require-dev": {
         "symfony/stopwatch": "^4.4|^5.1",

src/DependencyInjection/Compiler/EncryptionAdapterCompilerPass.php

@@ -41,7 +41,6 @@ public function process(ContainerBuilder $container): void
                 [
                     new Reference($adapterId),
                     new Reference(CipherKeyStorageInterface::class),
-                    $container->getParameter('sidus.encryption.throw_exceptions'),
                 ]
             );
             $managerDefinition->addTag('sidus.encryption.manager');

src/Doctrine/ValueEncrypter.php

@@ -14,15 +14,18 @@ class ValueEncrypter implements ValueEncrypterInterface
     private EncryptionManagerRegistryInterface $registry;
     private LoggerInterface $logger;
     private EncryptionEnablerInterface $encryptionEnabler;
+    private bool $throwExceptions;
 
     public function __construct(
         EncryptionManagerRegistryInterface $registry,
         LoggerInterface $logger,
-        EncryptionEnablerInterface $encryptionEnabler
+        EncryptionEnablerInterface $encryptionEnabler,
+        bool $throwExceptions
     ) {
         $this->registry = $registry;
         $this->logger = $logger;
         $this->encryptionEnabler = $encryptionEnabler;
+        $this->throwExceptions = $throwExceptions;
     }
 
     public function encrypt(string $value): string
@@ -55,6 +58,10 @@ public function decrypt(string $value): string
                 } catch (Exception $exception) {
                 }
             }
+    
+            if ($this->throwExceptions) {
+                throw $exception;
+            }
         }
 
         return $value;

src/Manager/EncryptionManager.php

@@ -10,7 +10,6 @@
 
 namespace Sidus\EncryptionBundle\Manager;
 
-use Exception;
 use Sidus\EncryptionBundle\Encryption\EncryptionAdapterInterface;
 use Sidus\EncryptionBundle\Entity\UserEncryptionProviderInterface;
 use Sidus\EncryptionBundle\Exception\EmptyCipherKeyException;
@@ -101,16 +100,7 @@ public function encryptString(string $string, string $nonce = null): string
         if (null === $nonce) {
             $nonce = $this->encryptionAdapter->generateNonce();
         }
-    
-        try {
-            $encrypted = $this->encryptionAdapter->encrypt($string, $nonce, $this->cipherKeyStorage->getCipherKey());
-        } catch (Exception $exception) {
-            if ($this->throwExceptions) {
-                throw $exception;
-            }
-    
-            return '';
-        }
+        $encrypted = $this->encryptionAdapter->encrypt($string, $nonce, $this->cipherKeyStorage->getCipherKey());
 
         return $nonce.$encrypted;
     }
@@ -125,22 +115,14 @@ public function decryptString(string $encryptedString, string $nonce = null): st
             return '';
         }
 
-        try {
-            if ($nonce === null) {
-                $nonce = $this->encryptionAdapter->parseNonce($encryptedString);
-            }
-            $decrypted = $this->encryptionAdapter->decrypt(
-                $encryptedString,
-                $nonce,
-                $this->cipherKeyStorage->getCipherKey()
-            );
-        } catch (Exception $exception) {
-            if ($this->throwExceptions) {
-                throw $exception;
-            }
-        
-            return '';
+        if ($nonce === null) {
+            $nonce = $this->encryptionAdapter->parseNonce($encryptedString);
         }
+        $decrypted = $this->encryptionAdapter->decrypt(
+            $encryptedString,
+            $nonce,
+            $this->cipherKeyStorage->getCipherKey()
+        );
 
         return rtrim($decrypted, "\0");
     }

src/Resources/config/services/encryption.yaml

@@ -23,12 +23,13 @@ services:
         class: Sidus\EncryptionBundle\Encryption\Enabler\EncryptionEnabler
         public: false
 
+    Sidus\EncryptionBundle\Doctrine\ValueEncrypterInterface: '@Sidus\EncryptionBundle\Doctrine\ValueEncrypter'
     Sidus\EncryptionBundle\Doctrine\ValueEncrypter:
         class: Sidus\EncryptionBundle\Doctrine\ValueEncrypter
         public: false
         arguments:
             - '@Sidus\EncryptionBundle\Registry\EncryptionManagerRegistryInterface'
             - '@logger'
             - '@Sidus\EncryptionBundle\Encryption\Enabler\EncryptionEnablerInterface'
-            
-    Sidus\EncryptionBundle\Doctrine\ValueEncrypterInterface: '@Sidus\EncryptionBundle\Doctrine\ValueEncrypter'
+            - '%sidus.encryption.throw_exceptions%'
+    

tests/PHPUnit/Doctrine/Type/EncryptStringTypeTest.php

@@ -61,7 +61,7 @@ protected function setUp(): void
         $registry = new EncryptionManagerRegistry(
             XChaChaPolySodiumEncryptionAdapter::getCode(), new \ArrayIterator($managers)
         );
-        $encrypter = new ValueEncrypter($registry, new Logger('encryption'), $enabler);
+        $encrypter = new ValueEncrypter($registry, new Logger('encryption'), $enabler, true);
         $this->type = new EncryptStringType();
         $this->type->setValueEncrypter($encrypter);
     }

tests/PHPUnit/Doctrine/Type/EncryptTextTypeTest.php

@@ -61,7 +61,7 @@ protected function setUp(): void
         $registry = new EncryptionManagerRegistry(
             XChaChaPolySodiumEncryptionAdapter::getCode(), new \ArrayIterator($managers)
         );
-        $encrypter = new ValueEncrypter($registry, new Logger('encryption'), $enabler);
+        $encrypter = new ValueEncrypter($registry, new Logger('encryption'), $enabler, true);
         $this->type = new EncryptTextType();
         $this->type->setValueEncrypter($encrypter);
     }

tests/PHPUnit/Doctrine/ValueEncrypterTest.php

@@ -73,6 +73,6 @@ protected function setUp(string $defaultAdapterCode = null): void
         $this->registry = new EncryptionManagerRegistry(
             XChaChaPolySodiumEncryptionAdapter::getCode(), new \ArrayIterator($managers)
         );
-        $this->encrypter = new ValueEncrypter($this->registry, new Logger('encryption'), $enabler);
+        $this->encrypter = new ValueEncrypter($this->registry, new Logger('encryption'), $enabler, true);
     }
 }