IonGhitun\MysqlEncryption\Models\BaseModel

Complexity

Total Complexity

28

Size/Duplication

Total Lines	263
Duplicated Lines	0 %

Importance

Changes	8
Bugs	2	Features	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	scopeOrWhereNotEncrypted()	0	3	1
A	scopeWhereNotEncrypted()	0	3	1
A	getEncrypted()	0	3	1
A	generateMysqlAesKey()	0	9	2
A	getAttribute()	0	15	4
A	aesEncrypt()	0	7	2
A	scopeWhereEncrypted()	0	3	1
A	scopeOrWhereEncrypted()	0	3	1
A	scopeOrderByEncrypted()	0	3	1
A	aesDecrypt()	0	7	2
A	anonymize()	0	12	4
A	getOriginal()	0	7	2
A	attributesToArray()	0	11	3
A	setAttribute()	0	7	2
A	getAnonymizable()	0	3	1

<?php

namespace IonGhitun\MysqlEncryption\Models;

use Faker\Factory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;

/**
 * @method static Builder|self whereEncrypted($column, $value)
 * @method static Builder|self whereNotEncrypted($column, $value)
 * @method static Builder|self orWhereEncrypted($column, $value)
 * @method static Builder|self orWhereNotEncrypted($column, $value)
 * @method static Builder|self orderByEncrypted($column, $direction)
 */
class BaseModel extends Model
{
    /**
     * Elements should be the names of the fields
     *
     * @var array
     */
    protected array $encrypted = [];

    /**
     * Elements should be pairs with key column name and value and array with type and optional parameters
     *
     * @example ['age' => ['randomDigit']]
     * @example ['age' => ['numberBetween', '18','50']]
     *
     * Available types: https://github.com/fzaninotto/Faker
     *
     * @var array
     */
    protected array $anonymizable = [];

    /**
     * Get model attribute
     *
     * @param $key
     *
     * @return mixed
     */
    public function getAttribute($key)
    {
        $value = parent::getAttribute($key);

        if (array_key_exists($key, $this->relations) || method_exists($this, $key)) {
            return $value;
        }

        $value = parent::getAttribute($key);

        if (in_array($key, $this->encrypted, true)) {
            return $this->aesDecrypt($value);
        }

        return $value;
    }

    /**
     * Decrypt value
     *
     * @param $val
     * @param string $cypher
     * @param bool $mySqlKey
     *
     * @return false|string
     */
    public function aesDecrypt($val, string $cypher = 'aes-128-ecb', bool $mySqlKey = true): bool|string
    {
        $secret = getenv('ENCRYPTION_KEY');

        $key = $mySqlKey ? $this->generateMysqlAesKey($secret) : $secret;

        return openssl_decrypt($val, $cypher, $key, 1);
    }

    /**
     * Generate encryption key
     *
     * @param $key
     *
     * @return string
     */
    private function generateMysqlAesKey($key): string
    {
        $generatedKey = str_repeat(chr(0), 16);

        for ($i = 0, $len = strlen($key); $i < $len; $i++) {
            $generatedKey[$i % 16] = $generatedKey[$i % 16] ^ $key[$i];
        }

        return $generatedKey;
    }

    /**
     * Set model attribute
     *
     * @param $key
     * @param $value
     *
     * @return mixed
     */
    public function setAttribute($key, $value)
    {
        if (in_array($key, $this->encrypted, true)) {
            $value = $this->aesEncrypt($value);
        }

        return parent::setAttribute($key, $value);
    }

    /**
     * Encrypt value
     *
     * @param $val
     * @param string $cypher
     * @param bool $mySqlKey
     *
     * @return false|string
     */
    public function aesEncrypt($val, string $cypher = 'aes-128-ecb', bool $mySqlKey = true): bool|string
    {
        $secret = getenv('ENCRYPTION_KEY');

        $key = $mySqlKey ? $this->generateMysqlAesKey($secret) : $secret;

        return openssl_encrypt($val, $cypher, $key, 1);
    }

    /**
     * Get attributes array
     *
     * @return array
     */
    public function attributesToArray()
    {
        $attributes = parent::attributesToArray();

        foreach ($this->encrypted as $key) {
            if (isset($attributes[$key])) {
                $attributes[$key] = $this->aesDecrypt($attributes[$key]);
            }
        }

        return $attributes;
    }

    /**
     * Get original not encrypted
     *
     * @param $key
     * @param $default
     *
     * @return mixed|array
     */
    public function getOriginal($key = null, $default = null)
    {
        if (in_array($key, $this->encrypted, true)) {
            return $this->aesDecrypt(Arr::get($this->original, $key, $default));
        }

        return Arr::get($this->original, $key, $default);
    }

    /**
     * Get encrypted columns
     *
     * @return array
     */
    public function getEncrypted(): array
    {
        return $this->encrypted;
    }

    /**
     * Get anonymizable columns
     *
     * @return array
     */
    public function getAnonymizable(): array
    {
        return $this->anonymizable;
    }

    /**
     * Anonymize model fields
     *
     * @param string|null $locale
     *
     * @return void
     */
    public function anonymize(string $locale = null): void
    {
        $faker = Factory::create($locale ?? (getenv('FAKER_LOCALE') ?? Factory::DEFAULT_LOCALE));

        foreach ($this->anonymizable as $field => $type) {
            if (in_array($field, $this->attributes, true)) {
                $method = $type[0];

                if (count($type) > 1) {
                    $this->$field = $faker->$method(array_slice($type, 1));
                } else {
                    $this->$field = $faker->$method;
                }
            }
        }
    }

    /**
     * where for encrypted columns
     *
     * @param $query
     * @param $column
     * @param $value
     *
     * @return mixed
     */
    public function scopeWhereEncrypted($query, $column, $value): mixed
    {
        return $query->whereRaw('AES_DECRYPT(' . $column . ', "' . getenv('ENCRYPTION_KEY') . '") LIKE ' . DB::getPdo()->quote($value) . ' COLLATE utf8mb4_general_ci');
    }

    /**
     * where not for encrypted columns
     *
     * @param $query
     * @param $column
     * @param $value
     *
     * @return mixed
     */
    public function scopeWhereNotEncrypted($query, $column, $value): mixed
    {
        return $query->whereRaw('AES_DECRYPT(' . $column . ', "' . getenv('ENCRYPTION_KEY') . '") NOT LIKE ' . DB::getPdo()->quote($value) . ' COLLATE utf8mb4_general_ci');
    }

    /**
     * orWhere for encrypted columns
     *
     * @param $query
     * @param $column
     * @param $value
     *
     * @return mixed
     */
    public function scopeOrWhereEncrypted($query, $column, $value): mixed
    {
        return $query->orWhereRaw('AES_DECRYPT(' . $column . ', "' . getenv('ENCRYPTION_KEY') . '") LIKE ' . DB::getPdo()->quote($value) . ' COLLATE utf8mb4_general_ci');
    }

    /**
     * orWhere not for encrypted columns
     *
     * @param $query
     * @param $column
     * @param $value
     *
     * @return mixed
     */
    public function scopeOrWhereNotEncrypted($query, $column, $value): mixed
    {
        return $query->orWhereRaw('AES_DECRYPT(' . $column . ', "' . getenv('ENCRYPTION_KEY') . '") NOT LIKE ' . DB::getPdo()->quote($value) . ' COLLATE utf8mb4_general_ci');
    }

    /**
     * orderBy for encrypted columns
     *
     * @param $query
     * @param $column
     * @param $direction
     *
     * @return mixed
     */
    public function scopeOrderByEncrypted($query, $column, $direction): mixed
    {
        return $query->orderByRaw('AES_DECRYPT(' . $column . ', "' . getenv('ENCRYPTION_KEY') . '") ' . $direction);
    }
}