Encryption::decrypt() - Code Metrics - Inspection of "cs-fix" - blitz-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — main ( 96fa17...2c2b65 )

by Dimitri

created 2023-10-24 18:36 UTC

Encryption::decrypt() A

↳ Parent: Encryption

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10

<?php

/**
 * This file is part of Blitz PHP framework.
 *
 * (c) 2022 Dimitri Sitchet Tomkeu <[email protected]>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace BlitzPHP\Security\Encryption;

use BlitzPHP\Contracts\Security\EncrypterInterface;
use BlitzPHP\Exceptions\EncryptionException;

/**
 * Gestionnaire de chiffrement BlitzPHP
 *
 * Fournit un cryptage à clé bidirectionnel via les extensions PHP Sodium et/ou OpenSSL.
 * Cette classe détermine le pilote, le chiffrement et le mode à utiliser, puis initialise le gestionnaire de chiffrement approprié.
 *
 * @credit <a href="http://www.codeigniter.com">CodeIgniter 4.4 - \CodeIgniter\Encryption\Encryption</a>
 */
class Encryption implements EncrypterInterface
{
    /**
     * Le chiffreur que nous créons
     */
    protected EncrypterInterface $encrypter;

    /**
     * Le pilote utilisé
     */
    protected string $driver;

    /**
     * The key/seed being used
     */
    protected string $key;

    /**
     * La clé HMAC dérivée
     */
    protected string $hmacKey;

    /**
     * HMAC digest à utiliser
     */
    protected string $digest = 'SHA512';

    /**
     * Pilotes aux classes de gestionnaires, par ordre de préférence
     */
    protected array $drivers = [
        'OpenSSL',
        'Sodium',
    ];

    /**
     * Gestionnaires à installer
     *
     * @var array<string, bool>
     */
    protected array $handlers = [];

    /**
     * @throws EncryptionException
     */
    public function __construct(protected ?object $config = null)
    {
        $config ??= (object) config('encryption');

        $this->config = $config;
        $this->key    = $config->key;

        $this->driver = $config->driver;

        $this->digest = $config->digest ?? 'SHA512';


        $this->handlers = [
            'OpenSSL' => extension_loaded('openssl'),
            // le SodiumHandler utilise une API (comme sodium_pad) qui n'est disponible que sur la version 1.0.14+
            'Sodium' => extension_loaded('sodium') && version_compare(SODIUM_LIBRARY_VERSION, '1.0.14', '>='),
        ];

        if (! in_array($this->driver, $this->drivers, true) || (array_key_exists($this->driver, $this->handlers) && ! $this->handlers[$this->driver])) {
            throw EncryptionException::noHandlerAvailable($this->driver);
        }
    }

    /**
     * {@inheritDoc}
     */
    public function encrypt(string $data, null|array|string $params = null): string
    {
        return $this->encrypter()->encrypt($data, $params);
    }

    /**
     * {@inheritDoc}
     */
    public function decrypt(string $data, null|array|string $params = null): string
    {
        return $this->encrypter()->decrypt($data, $params);
    }

    /**
     * Initialiser ou réinitialiser un chiffreur
     *
     * @throws EncryptionException
     */
    public function initialize(?object $config = null): EncrypterInterface
    {
        if ($config) {
            $this->key    = $config->key;
            $this->driver = $config->driver;
            $this->digest = $config->digest ?? 'SHA512';
        }

        if (empty($this->driver)) {
            throw EncryptionException::noDriverRequested();
        }

        if (! in_array($this->driver, $this->drivers, true)) {
            throw EncryptionException::unKnownHandler($this->driver);
        }

        if (empty($this->key)) {
            throw EncryptionException::needsStarterKey();
        }

        $this->hmacKey = bin2hex(\hash_hkdf($this->digest, $this->key));

        $handlerName     = 'BlitzPHP\\Security\\Encryption\\Handlers\\' . $this->driver . 'Handler';
        $this->encrypter = new $handlerName($config);

        return $this->encrypter;
    }

    /**
     * Créer une clé aléatoire
     */
    public static function createKey(int $length = 32): string
    {
        return random_bytes($length);
    }

    /**
     * Fourni un accès en lecture seule à certaines de nos propriétés
     *
     * @param string $key Nom de la propriete
     *
     * @return array|bool|int|string|null
     */
    public function __get($key)
    {
        if ($this->__isset($key)) {
            return $this->{$key};
        }

        return null;
    }

    /**
     * Assure la vérification de certaines de nos propriétés
     *
     * @param string $key Nom de la propriete
     */
    public function __isset($key): bool
    {
        return in_array($key, ['key', 'digest', 'driver', 'drivers'], true);
    }

    private function encrypter(): EncrypterInterface
    {
        if (null === $this->encrypter) {
            $this->encrypter = $this->initialize($this->config);
        }

        return $this->encrypter;
    }
}


1			<?php
2
3			/**
4			* This file is part of Blitz PHP framework.
5			*
6			* (c) 2022 Dimitri Sitchet Tomkeu <[email protected]>
7			*
8			* For the full copyright and license information, please view
9			* the LICENSE file that was distributed with this source code.
10			*/
11
12			namespace BlitzPHP\Security\Encryption;
13
14			use BlitzPHP\Contracts\Security\EncrypterInterface;
15			use BlitzPHP\Exceptions\EncryptionException;
16
17			/**
18			* Gestionnaire de chiffrement BlitzPHP
19			*
20			* Fournit un cryptage à clé bidirectionnel via les extensions PHP Sodium et/ou OpenSSL.
21			* Cette classe détermine le pilote, le chiffrement et le mode à utiliser, puis initialise le gestionnaire de chiffrement approprié.
22			*
23			* @credit <a href="http://www.codeigniter.com">CodeIgniter 4.4 - \CodeIgniter\Encryption\Encryption</a>
24			*/
25			class Encryption implements EncrypterInterface
26			{
27			/**
28			* Le chiffreur que nous créons
29			*/
30			protected EncrypterInterface $encrypter;
31
32			/**
33			* Le pilote utilisé
34			*/
35			protected string $driver;
36
37			/**
38			* The key/seed being used
39			*/
40			protected string $key;
41
42			/**
43			* La clé HMAC dérivée
44			*/
45			protected string $hmacKey;
46
47			/**
48			* HMAC digest à utiliser
49			*/
50			protected string $digest = 'SHA512';
51
52			/**
53			* Pilotes aux classes de gestionnaires, par ordre de préférence
54			*/
55			protected array $drivers = [
56			'OpenSSL',
57			'Sodium',
58			];
59
60			/**
61			* Gestionnaires à installer
62			*
63			* @var array<string, bool>
64			*/
65			protected array $handlers = [];
66
67			/**
68			* @throws EncryptionException
69			*/
70			public function __construct(protected ?object $config = null)
71			{
72			$config ??= (object) config('encryption');
73
74			$this->config = $config;
75			$this->key = $config->key;
			0 ignored issues – show Bug introduced 2023-10-24 18:39 UTC by Report Bug Copy Issue Report The property `key` does not seem to exist on `BlitzPHP\Config\Config`. Loading history...
76			$this->driver = $config->driver;
			0 ignored issues – show Bug introduced 2023-10-24 18:39 UTC by Report Bug Copy Issue Report The property `driver` does not seem to exist on `BlitzPHP\Config\Config`. Loading history...
77			$this->digest = $config->digest ?? 'SHA512';
			0 ignored issues – show Bug introduced 2023-10-24 18:39 UTC by Report Bug Copy Issue Report The property `digest` does not seem to exist on `BlitzPHP\Config\Config`. Loading history...
78
79			$this->handlers = [
80			'OpenSSL' => extension_loaded('openssl'),
81			// le SodiumHandler utilise une API (comme sodium_pad) qui n'est disponible que sur la version 1.0.14+
82			'Sodium' => extension_loaded('sodium') && version_compare(SODIUM_LIBRARY_VERSION, '1.0.14', '>='),
83			];
84
85			if (! in_array($this->driver, $this->drivers, true) \|\| (array_key_exists($this->driver, $this->handlers) && ! $this->handlers[$this->driver])) {
86			throw EncryptionException::noHandlerAvailable($this->driver);
87			}
88			}
89
90			/**
91			* {@inheritDoc}
92			*/
93			public function encrypt(string $data, null\|array\|string $params = null): string
94			{
95			return $this->encrypter()->encrypt($data, $params);
96			}
97
98			/**
99			* {@inheritDoc}
100			*/
101			public function decrypt(string $data, null\|array\|string $params = null): string
102			{
103			return $this->encrypter()->decrypt($data, $params);
104			}
105
106			/**
107			* Initialiser ou réinitialiser un chiffreur
108			*
109			* @throws EncryptionException
110			*/
111			public function initialize(?object $config = null): EncrypterInterface
112			{
113			if ($config) {
114			$this->key = $config->key;
115			$this->driver = $config->driver;
116			$this->digest = $config->digest ?? 'SHA512';
117			}
118
119			if (empty($this->driver)) {
120			throw EncryptionException::noDriverRequested();
121			}
122
123			if (! in_array($this->driver, $this->drivers, true)) {
124			throw EncryptionException::unKnownHandler($this->driver);
125			}
126
127			if (empty($this->key)) {
128			throw EncryptionException::needsStarterKey();
129			}
130
131			$this->hmacKey = bin2hex(\hash_hkdf($this->digest, $this->key));
132
133			$handlerName = 'BlitzPHP\\Security\\Encryption\\Handlers\\' . $this->driver . 'Handler';
134			$this->encrypter = new $handlerName($config);
135
136			return $this->encrypter;
137			}
138
139			/**
140			* Créer une clé aléatoire
141			*/
142			public static function createKey(int $length = 32): string
143			{
144			return random_bytes($length);
145			}
146
147			/**
148			* Fourni un accès en lecture seule à certaines de nos propriétés
149			*
150			* @param string $key Nom de la propriete
151			*
152			* @return array\|bool\|int\|string\|null
153			*/
154			public function __get($key)
155			{
156			if ($this->__isset($key)) {
157			return $this->{$key};
158			}
159
160			return null;
161			}
162
163			/**
164			* Assure la vérification de certaines de nos propriétés
165			*
166			* @param string $key Nom de la propriete
167			*/
168			public function __isset($key): bool
169			{
170			return in_array($key, ['key', 'digest', 'driver', 'drivers'], true);
171			}
172
173			private function encrypter(): EncrypterInterface
174			{
175			if (null === $this->encrypter) {
176			$this->encrypter = $this->initialize($this->config);
177			}
178
179			return $this->encrypter;
180			}
181			}
182

blitz-php / framework

Push — main ( 96fa17...2c2b65 )

Encryption::decrypt() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like