lekoala / silverstripe-encrypt

src/HasEncryptedFields.php

<?php

namespace LeKoala\Encrypt;

use SodiumException;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use ParagonIE\CipherSweet\CipherSweet;
use SilverStripe\ORM\DataObjectSchema;
use ParagonIE\CipherSweet\EncryptedRow;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\Queries\SQLSelect;
use SilverStripe\ORM\Queries\SQLUpdate;
use ParagonIE\CipherSweet\EncryptedField;
use ParagonIE\CipherSweet\KeyRotation\RowRotator;
use ParagonIE\CipherSweet\Exception\InvalidCiphertextException;

/**
 * This trait helps to override the default getField method in order to return
 * the value of a field directly instead of the db object instance
 *
 * Simply define this in your code
 *
 * public function getField($field)
 * {
 *    return $this->getEncryptedField($field);
 * }
 *
 * public function setField($fieldName, $val)
 * {
 *     return $this->setEncryptedField($fieldName, $val);
 * }
 */
trait HasEncryptedFields
{
    /**
     * This value will return exactly one record, taking care of false positives
     *
     * @param string $field
     * @param string $value
     * @return DataObject|bool
     */
    public static function getByBlindIndex($field, $value)
    {
        /** @var DataObject $singl  */
        $singl = singleton(get_called_class());
        /** @var EncryptedDBField $obj  */
        $obj = $singl->dbObject($field);
        return $obj->fetchRecord($value);
    }

    /**
     * This value will return a list of records
     *
     * @param string $field
     * @param string $value
     * @return DataList|static[]
     */
    public static function getAllByBlindIndex($field, $value)
    {
        /** @var DataObject $singl  */
        $singl = singleton(get_called_class());
        /** @var EncryptedDBField $obj  */
        $obj = $singl->dbObject($field);
        return $obj->fetchDataList($value);
    }

    /**
     * Check if the record needs to be reencrypted with a new key or algo
     * @param CipherSweet $old
     * @return bool
     */
    public function needsToRotateEncryption(CipherSweet $old)
    {
        $class = get_class($this);
        $tableName = DataObject::getSchema()->tableName($class);
        $columnIdentifier = DataObject::getSchema()->sqlColumnForField($class, 'ID');

        $new = EncryptHelper::getCipherSweet();

        $oldRow = $this->getEncryptedRow($old);
        $newRow = $this->getEncryptedRow($new);

        $rotator = new RowRotator($oldRow, $newRow);
        $query = new SQLSelect("*", $tableName, [$columnIdentifier => $this->ID]);
        $ciphertext = $query->execute()->record();
        // not needed anymore since 3.0.1
        // $ciphertext = EncryptHelper::removeNulls($ciphertext);
        if ($rotator->needsReEncrypt($ciphertext)) {
            return true;
        }
        return false;
    }

    /**
     * Rotate encryption with current engine without using orm
     * @param CipherSweet $old
     * @return bool
     * @throws SodiumException
     * @throws InvalidCiphertextException
     */
    public function rotateEncryption(CipherSweet $old)
    {
        $class = get_class($this);
        $tableName = DataObject::getSchema()->tableName($class);
        $columnIdentifier = DataObject::getSchema()->sqlColumnForField($class, 'ID');

        $new = EncryptHelper::getCipherSweet();

        $encryptedFields = array_keys(EncryptHelper::getEncryptedFields($class, true));
        if (EncryptHelper::getAadSource()) {
            $encryptedFields[] = EncryptHelper::getAadSource();
        }
        $query = new SQLSelect($encryptedFields, $tableName, [$columnIdentifier => $this->ID]);
        $ciphertext = $query->execute()->record();
        $ciphertext = array_filter($ciphertext);

        // Get only what we need
        $oldRow = $this->getEncryptedRow($old, $ciphertext);
        $newRow = $this->getEncryptedRow($new, $ciphertext);

        $rotator = new RowRotator($oldRow, $newRow);

        $indices = null;
        if ($rotator->needsReEncrypt($ciphertext)) {
            list($ciphertext, $indices) = $rotator->prepareForUpdate($ciphertext);
            $assignment = $ciphertext;
            foreach ($indices as $name => $arr) {
                $assignment[$name] = $arr["value"];
            }
            $update = new SQLUpdate($tableName, $assignment, ["ID" => $this->ID]);
            $update->execute();
            return true;
        }
        return false;
    }

    /**
     * @param CipherSweet $engine
     * @param array $onlyFields
     * @return EncryptedRow
     */
    public function getEncryptedRow(?CipherSweet $engine = null, $onlyFields = [])
    {
        if ($engine === null) {
            $engine = EncryptHelper::getCipherSweet();
        }
        $class = get_class($this);
        $tableName = DataObject::getSchema()->tableName($class);
        $encryptedRow = new EncryptedRow($engine, $tableName);
        $encryptedRow->setPermitEmpty(true);
        $encryptedRow->setTypedIndexes(true);
        $encryptedFields = array_keys(EncryptHelper::getEncryptedFields($class));
        $aadSource = EncryptHelper::getAadSource();
        foreach ($encryptedFields as $field) {
            if (!empty($onlyFields) && !array_key_exists($field, $onlyFields)) {
                continue;
            }
            /** @var EncryptedDBField $dbField */
            $dbField = $this->dbObject($field);

It seems like dbObject() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            /** @var EncryptedField $encryptedField */
            $encryptedField = $dbField->getEncryptedField($engine);
            $blindIndexes = $encryptedField->getBlindIndexObjects();

            //TODO: review how naming is done (see: EncryptedDBField)
            if (count($blindIndexes)) {
                $encryptedRow->addOptionalTextField($field . EncryptedDBField::VALUE_SUFFIX, $aadSource);
                foreach ($encryptedField->getBlindIndexObjects() as $blindIndex) {
                    $encryptedRow->addBlindIndex($field . EncryptedDBField::VALUE_SUFFIX, $blindIndex);
                }
            } else {
                $encryptedRow->addOptionalTextField($field, $aadSource);
            }
        }
        return $encryptedRow;
    }

    /**
     * Extend getField to support retrieving encrypted value transparently
     * @param string $field The name of the field
     * @return mixed The field value
     */
    public function getEncryptedField($field)
    {
        // We cannot check directly $this->record[$field] because it may
        // contain encrypted value that needs to be decoded first

        // If it's an encrypted field
        if ($this->hasEncryptedField($field)) {
            /** @var EncryptedDBField $fieldObj  */
            $fieldObj = $this->dbObject($field);
            // Set decrypted value directly on the record for later use
            // it can be fetched by dbObject calls
            $this->record[$field] = $fieldObj->getValue();

The property record does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

            return $this->record[$field];
        }
        return parent::getField($field);
    }

    /**
     * Extend setField to support setting encrypted value transparently
     * @param string $field
     * @param mixed $val
     * @return $this
     */
    public function setEncryptedField($field, $val)
    {
        // If it's an encrypted field
        if ($this->hasEncryptedField($field) && $val && is_scalar($val)) {
            /** @var DataObjectSchema $schema  */
            $schema = static::getSchema();

            // In case of composite fields, return the DBField object
            // Eg: if we call MyIndexedVarchar instead of MyIndexedVarcharValue
            $compositeClass = $schema->compositeField(static::class, $field);
            if ($compositeClass) {
                /** @var EncryptedDBField $fieldObj  */
                $fieldObj = $this->dbObject($field);
                $fieldObj->setValue($val);
                // Keep a reference for isChange checks
                // and also can be queried by dbObject
                $this->record[$field] = $fieldObj;

The property record does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

                // Proceed with DBField instance, that will call saveInto
                // and call this method again for distinct fields
                $val = $fieldObj;
            }
        }
        parent::setField($field, $val);
        return $this;
    }

    /**
     * @param string $field
     * @return boolean
     */
    public function hasEncryptedField($field)
    {
        return EncryptHelper::isEncryptedField(get_class($this), $field);
    }

    /**
     * Rebind record value for aad
     *
     * It would be better to deal with this in writeToManipulation but it is not called
     * for CompositeFields
     *
     * @return void
     */
    protected function resetFieldValues()
    {
        if (EncryptHelper::getAadSource() === "ID") {
            $db = $this->config()->db;

It seems like config() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            foreach ($this->record as $k => $v) {
                $dbClass = $db[$k] ?? null;
                if ($dbClass && EncryptHelper::isEncryptedDbClass($dbClass)) {
                    $this->dbObject($k)->setValue($v);
                }
            }
        }
    }
}