carnage / doctrine-encrypted-column

src/Setup.php

<?php

namespace Carnage\EncryptedColumn;

use Carnage\EncryptedColumn\Container\KeyContainer;
use Carnage\EncryptedColumn\Container\VersionedContainer;
use Carnage\EncryptedColumn\Dbal\EncryptedColumn;
use Carnage\EncryptedColumn\Dbal\EncryptedColumnLegacySupport;
use Carnage\EncryptedColumn\Encryptor\HaliteEncryptor;
use Carnage\EncryptedColumn\Encryptor\LegacyEncryptor;
use Carnage\EncryptedColumn\Serializer\LegacySerializer;
use Carnage\EncryptedColumn\Serializer\PhpSerializer;
use Carnage\EncryptedColumn\Service\EncryptionService;
use Carnage\EncryptedColumn\ValueObject\Key;
use Carnage\EncryptedColumn\ValueObject\KeyIdentity;
use Doctrine\ORM\EntityManagerInterface;

final class Setup
{
    private $keyPath;
    private $enableLegacy = false;
    private $legacyKey;
    private $keyContainer;

    public function __construct()
    {
        $this->keyContainer = new KeyContainer();
    }

    public function register(EntityManagerInterface $em)
    {
        if ($this->enableLegacy) {
            $this->doRegisterLegacy($em);
        } else {
            $this->doRegister($em);
        }
    }

    public function enableLegacy(string $legacyKey)

This method seems to be duplicated in your project.

    {
        $this->enableLegacy = true;
        $this->legacyKey = $legacyKey;

        $key = new Key($legacyKey);
        $this->keyContainer->addKey($key);
        $this->keyContainer->tagKey('legacy', $key->getIdentifier()->toString());

        return $this;
    }

    public function withKeyPath(string $keypath)

This method seems to be duplicated in your project.

    {
        $this->keyPath = $keypath;

        $key = new Key($keypath);
        $this->keyContainer->addKey($key);
        $this->keyContainer->tagKey('default', $key->getIdentifier()->toString());

        return $this;
    }

    public function withKey(string $key, array $tags = [])
    {
        $key = new Key($key);
        $keyId = $key->getIdentifier()->toString();
        $this->keyContainer->addKey($key);

        foreach ($tags as $tag) {
            $this->keyContainer->tagKey($tag, $keyId);
        }

        return $this;
    }

    private function buildEncryptionService(): EncryptionService
    {
        $encryptors = self::buildEncryptorsContainer();
        $serializers = self::buildSerilaizerContainer();
        return new EncryptionService(
            $encryptors->get(HaliteEncryptor::IDENTITY),

$encryptors->get(\Carnage\EncryptedColumn\Encryptor\HaliteEncryptor::IDENTITY) of type object<Carnage\EncryptedColumn\Container\VersionedInterface> is not a sub-type of object<Carnage\EncryptedColumn\Encryptor\EncryptorInterface>. It seems like you assume a child interface of the interface Carnage\EncryptedColumn\Container\VersionedInterface to be always present.

            $serializers->get(PhpSerializer::IDENTITY),

$serializers->get(\Carnage\EncryptedColumn\Serializer\PhpSerializer::IDENTITY) of type object<Carnage\EncryptedColumn\Container\VersionedInterface> is not a sub-type of object<Carnage\EncryptedColumn\Serializer\SerializerInterface>. It seems like you assume a child interface of the interface Carnage\EncryptedColumn\Container\VersionedInterface to be always present.

            $encryptors,
            $serializers,
            $this->keyContainer
        );
    }

    private function buildEncryptorsContainer(): VersionedContainer
    {
        $services = [new HaliteEncryptor($this->keyPath)];

The call to HaliteEncryptor::__construct() has too many arguments starting with $this->keyPath.

        if ($this->enableLegacy) {
            $services[] = new LegacyEncryptor($this->legacyKey);

The call to LegacyEncryptor::__construct() has too many arguments starting with $this->legacyKey.

        }
        //@TODO add legacy encryptor, throw exceptions if required keys aren't specified
        return new VersionedContainer(...$services);
    }

    private function buildSerilaizerContainer(): VersionedContainer
    {
        $services = [new PhpSerializer()];
        if ($this->enableLegacy) {
            $services[] = new LegacySerializer();
        }
        return new VersionedContainer(...$services);
    }

    /**
     * @param EntityManagerInterface $em
     */
    private function doRegister(EntityManagerInterface $em)

This method seems to be duplicated in your project.

    {
        EncryptedColumn::create($this->buildEncryptionService());
        $conn = $em->getConnection();
        $conn->getDatabasePlatform()->registerDoctrineTypeMapping(
            EncryptedColumn::ENCRYPTED,
            EncryptedColumn::ENCRYPTED
        );
    }

    /**
     * @param EntityManagerInterface $em
     */
    private function doRegisterLegacy(EntityManagerInterface $em)

This method seems to be duplicated in your project.

    {
        EncryptedColumnLegacySupport::create($this->buildEncryptionService());
        $conn = $em->getConnection();
        $conn->getDatabasePlatform()->registerDoctrineTypeMapping(
            EncryptedColumnLegacySupport::ENCRYPTED,
            EncryptedColumnLegacySupport::ENCRYPTED
        );
    }
}