BlockOperationsTrait::setInitializationVector() - Code Metrics - Inspection of "Added a vast of symmetric encryption algorithm obj..." - TonyKaravasilev/CryptoManana - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8055c8...3e2656 )

by Tony Karavasilev (Тони

created 2020-01-20 16:25 UTC

BlockOperationsTrait::setInitializationVector() A

↳ Parent: BlockOperationsTrait

Complexity

Conditions	4
Paths	4

Size

Total Lines	18
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	8
c	1
b	0
f	0
dl	0
loc	18
ccs	0
cts	12
cp	0
rs	10
cc	4
nc	4
nop	1
crap	20

<?php

/**
 * Trait implementation of the block cipher capabilities and actions for symmetric encryption algorithms.
 */

namespace CryptoManana\Core\Traits\MessageEncryption;

use \CryptoManana\Core\Interfaces\MessageEncryption\BlockOperationsInterface as BlockOperationsSpecification;

/**
 * Trait BlockOperationsTrait - Reusable implementation of `BlockOperationsInterface`.
 *
 * @see \CryptoManana\Core\Interfaces\MessageDigestion\BlockOperationsInterface The abstract specification.
 *
 * @package CryptoManana\Core\Traits\MessageEncryption
 *
 * @property string $iv The initialization vector (IV) string property storage.
 * @property string $mode The block encryption operation mode string property.
 * @property int $padding The final block padding operation property.
 *
 * @mixin BlockOperationsSpecification
 */
trait BlockOperationsTrait
{
    /**
     * Setter for the initialization vector (IV) string property.
     *
     * @param string $iv The initialization vector (IV) string.
     *
     * @return $this The encryption algorithm object.
     * @throws \Exception Validation errors.
     */
    public function setInitializationVector($iv)
    {
        if (!is_string($iv)) {

            throw new \InvalidArgumentException('The initialization vector must be a string or a binary string.');
        }

        /**
         * {@internal The encryption standard is 8-bit wise (don not use StringBuilder) and utilizes performance. }}
         */
        if (strlen($iv) > static::IV_SIZE) {

            $iv = hash_hkdf('sha256', $iv, static::IV_SIZE, 'CryptoMañana', '');
        } elseif (strlen($iv) < static::IV_SIZE) {
            $iv = str_pad($iv, static::IV_SIZE, "\x0", STR_PAD_RIGHT);
        }

        $this->iv = $iv;

        return $this;
    }

    /**
     * Getter for the initialization vector (IV) string property.
     *
     * @return string The initialization vector (IV) string.
     */
    public function getInitializationVector()
    {
        return $this->iv;
    }

    /**
     * Setter for the block encryption operation mode string property.
     *
     * @param string $mode The block operation mode string.
     *
     * @return $this The encryption algorithm object.
     * @throws \Exception Validation errors.
     */
    public function setBlockOperationMode($mode)
    {
        $validModes = [
            self::CBC_MODE,

            self::CFB_MODE,

            self::OFB_MODE,

            self::CTR_MODE,

            self::ECB_MODE

        ];

        if (!is_string($mode) || !in_array(strtoupper($mode), $validModes, true)) {

            throw new \InvalidArgumentException(
                'The mode of operation must be a string and be a standardized block mode name.'
            );
        }

        $newMethodName = static::ALGORITHM_NAME . '-' . (static::KEY_SIZE * 8) . '-' . $mode;


        // @codeCoverageIgnoreStart
        if (!in_array($newMethodName, openssl_get_cipher_methods(), true)) {
            throw new \RuntimeException(
                'The algorithm `' . $newMethodName . '`is not supported under the current system configuration.'
            );
        }
        // @codeCoverageIgnoreEnd

        $this->mode = strtoupper($mode);

        return $this;
    }

    /**
     * Getter for the block encryption operation mode string property.
     *
     * @return string The block operation mode string.
     */
    public function getBlockOperationMode()
    {
        return $this->mode;
    }

    /**
     * Setter for the final block padding operation property.
     *
     * @param int $padding The padding standard integer code value.
     *
     * @return $this The encryption algorithm object.
     * @throws \Exception Validation errors.
     */
    public function setPaddingStandard($padding)
    {
        $padding = filter_var(
            $padding,
            FILTER_VALIDATE_INT,
            [
                "options" => [
                    "min_range" => self::PKCS7_PADDING,

                    "max_range" => self::ZERO_PADDING,

                ],
            ]
        );

        if ($padding === false) {
            throw new \InvalidArgumentException(
                'The padding standard must must be a valid integer between ' .
                self::PKCS7_PADDING . ' and ' . self::ZERO_PADDING . '.'
            );
        }

        $this->padding = $padding;

        return $this;
    }

    /**
     * Getter for the final block padding operation property.
     *
     * @return string The padding standard integer code value.
     */
    public function getPaddingStandard()
    {
        return $this->padding;
    }
}


1			<?php
2
3			/**
4			* Trait implementation of the block cipher capabilities and actions for symmetric encryption algorithms.
5			*/
6
7			namespace CryptoManana\Core\Traits\MessageEncryption;
8
9			use \CryptoManana\Core\Interfaces\MessageEncryption\BlockOperationsInterface as BlockOperationsSpecification;
10
11			/**
12			* Trait BlockOperationsTrait - Reusable implementation of `BlockOperationsInterface`.
13			*
14			* @see \CryptoManana\Core\Interfaces\MessageDigestion\BlockOperationsInterface The abstract specification.
15			*
16			* @package CryptoManana\Core\Traits\MessageEncryption
17			*
18			* @property string $iv The initialization vector (IV) string property storage.
19			* @property string $mode The block encryption operation mode string property.
20			* @property int $padding The final block padding operation property.
21			*
22			* @mixin BlockOperationsSpecification
23			*/
24			trait BlockOperationsTrait
25			{
26			/**
27			* Setter for the initialization vector (IV) string property.
28			*
29			* @param string $iv The initialization vector (IV) string.
30			*
31			* @return $this The encryption algorithm object.
32			* @throws \Exception Validation errors.
33			*/
34			public function setInitializationVector($iv)
35			{
36			if (!is_string($iv)) {
			1 ignored issue – show introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The condition `is_string($iv)` is always `true`. Loading history...
37			throw new \InvalidArgumentException('The initialization vector must be a string or a binary string.');
38			}
39
40			/**
41			* {@internal The encryption standard is 8-bit wise (don not use StringBuilder) and utilizes performance. }}
42			*/
43			if (strlen($iv) > static::IV_SIZE) {
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...perationsTrait::IV_SIZE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
44			$iv = hash_hkdf('sha256', $iv, static::IV_SIZE, 'CryptoMañana', '');
45			} elseif (strlen($iv) < static::IV_SIZE) {
46			$iv = str_pad($iv, static::IV_SIZE, "\x0", STR_PAD_RIGHT);
47			}
48
49			$this->iv = $iv;
50
51			return $this;
52			}
53
54			/**
55			* Getter for the initialization vector (IV) string property.
56			*
57			* @return string The initialization vector (IV) string.
58			*/
59			public function getInitializationVector()
60			{
61			return $this->iv;
62			}
63
64			/**
65			* Setter for the block encryption operation mode string property.
66			*
67			* @param string $mode The block operation mode string.
68			*
69			* @return $this The encryption algorithm object.
70			* @throws \Exception Validation errors.
71			*/
72			public function setBlockOperationMode($mode)
73			{
74			$validModes = [
75			self::CBC_MODE,
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...erationsTrait::CBC_MODE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
76			self::CFB_MODE,
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...erationsTrait::CFB_MODE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
77			self::OFB_MODE,
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...erationsTrait::OFB_MODE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
78			self::CTR_MODE,
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...erationsTrait::CTR_MODE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
79			self::ECB_MODE
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...erationsTrait::ECB_MODE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
80			];
81
82			if (!is_string($mode) \|\| !in_array(strtoupper($mode), $validModes, true)) {
			1 ignored issue – show introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The condition `is_string($mode)` is always `true`. Loading history...
83			throw new \InvalidArgumentException(
84			'The mode of operation must be a string and be a standardized block mode name.'
85			);
86			}
87
88			$newMethodName = static::ALGORITHM_NAME . '-' . (static::KEY_SIZE * 8) . '-' . $mode;
			2 ignored issues – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...erationsTrait::KEY_SIZE` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history... Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...nsTrait::ALGORITHM_NAME` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
89
90			// @codeCoverageIgnoreStart
91			if (!in_array($newMethodName, openssl_get_cipher_methods(), true)) {
92			throw new \RuntimeException(
93			'The algorithm `' . $newMethodName . '`is not supported under the current system configuration.'
94			);
95			}
96			// @codeCoverageIgnoreEnd
97
98			$this->mode = strtoupper($mode);
99
100			return $this;
101			}
102
103			/**
104			* Getter for the block encryption operation mode string property.
105			*
106			* @return string The block operation mode string.
107			*/
108			public function getBlockOperationMode()
109			{
110			return $this->mode;
111			}
112
113			/**
114			* Setter for the final block padding operation property.
115			*
116			* @param int $padding The padding standard integer code value.
117			*
118			* @return $this The encryption algorithm object.
119			* @throws \Exception Validation errors.
120			*/
121			public function setPaddingStandard($padding)
122			{
123			$padding = filter_var(
124			$padding,
125			FILTER_VALIDATE_INT,
126			[
127			"options" => [
128			"min_range" => self::PKCS7_PADDING,
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...onsTrait::PKCS7_PADDING` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
129			"max_range" => self::ZERO_PADDING,
			1 ignored issue – show Bug introduced 2020-01-20 16:41 UTC by Report Bug Copy Issue Report The constant `CryptoManana\Core\Traits...ionsTrait::ZERO_PADDING` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
130			],
131			]
132			);
133
134			if ($padding === false) {
135			throw new \InvalidArgumentException(
136			'The padding standard must must be a valid integer between ' .
137			self::PKCS7_PADDING . ' and ' . self::ZERO_PADDING . '.'
138			);
139			}
140
141			$this->padding = $padding;
142
143			return $this;
144			}
145
146			/**
147			* Getter for the final block padding operation property.
148			*
149			* @return string The padding standard integer code value.
150			*/
151			public function getPaddingStandard()
152			{
153			return $this->padding;
154			}
155			}
156

TonyKaravasilev / CryptoManana

Push — master ( 8055c8...3e2656 )

BlockOperationsTrait::setInitializationVector() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like