Aes::invalidChecksum() - Code Metrics - Inspection of "no message" - mmeyer2k/dcrypt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 84efce...33db28 )

by Michael

created 2016-01-08 14:18 UTC

Aes::invalidChecksum() A

↳ Parent: Aes

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * Aes.php
 * 
 * PHP version 5
 * 
 * @category Dcrypt
 * @package  Dcrypt
 * @author   Michael Meyer (mmeyer2k) <[email protected]>
 * @license  http://opensource.org/licenses/MIT The MIT License (MIT)
 * @link     https://github.com/mmeyer2k/dcrypt
 */

namespace Dcrypt;

/**
 * Symmetric AES-256-CBC encryption functions powered by OpenSSL.
 * 
 * @category Dcrypt
 * @package  Dcrypt
 * @author   Michael Meyer (mmeyer2k) <[email protected]>
 * @license  http://opensource.org/licenses/MIT The MIT License (MIT)
 * @link     https://github.com/mmeyer2k/dcrypt
 * @link     https://apigen.ci/github/mmeyer2k/dcrypt/namespace-Dcrypt.html
 */
class Aes extends Cryptobase
{

    /**
     * AES-256 cipher identifier that will be passed to openssl
     * 
     * @var string
     */
    const CIPHER = 'aes-256-cbc';

    /**
     * Size of initialization vector in bytes
     * 
     * @var int
     */
    const IVSIZE = 16;

    /**
     * Size of checksum in bytes
     * 
     * @var int
     */
    const CKSIZE = 32;

    /**
     * Decrypt cyphertext
     * 
     * @param string $cyphertext Cyphertext to decrypt
     * @param string $password   Password that should be used to decrypt input data
     * @param int    $cost       Number of HMAC iterations to perform on key
     * 
     * @return string|boolean Returns false on checksum validation failure
     */
    public static function decrypt($cyphertext, $password, $cost = 0)
    {
        // Find the IV at the beginning of the cypher text
        $iv = self::substr($cyphertext, 0, self::IVSIZE);

        // Gather the checksum portion of the cypher text
        $chksum = self::substr($cyphertext, self::IVSIZE, self::CKSIZE);

        // Gather message portion of cyphertext after iv and checksum
        $message = self::substr($cyphertext, self::IVSIZE + self::CKSIZE);

        // Derive key from password
        $key = self::key($password, $iv, $cost);

        // Calculate verification checksum
        $verify = self::checksum($message, $iv, $key);

        // Verify HMAC before decrypting... return false if corrupt.
        if (!self::equal($verify, $chksum)) {
            return static::invalidChecksum();
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
        }

        // Decrypt message and return
        return \openssl_decrypt($message, self::CIPHER, $key, 1, $iv);
    }

    /**
     * Encrypt plaintext
     * 
     * @param string $plaintext Plaintext string to encrypt.
     * @param string $password  Password used to encrypt data.
     * @param int    $cost      Number of HMAC iterations to perform on key
     * 
     * @return string 
     */
    public static function encrypt($plaintext, $password, $cost = 0)
    {
        // Generate IV of appropriate size.
        $iv = Random::get(self::IVSIZE);

        // Derive key from password
        $key = self::key($password, $iv, $cost);

        // Encrypt the plaintext
        $message = \openssl_encrypt($plaintext, self::CIPHER, $key, 1, $iv);

        // Create the cypher text prefix (iv + checksum)
        $prefix = $iv . self::checksum($message, $iv, $key);

        // Return prefix + cyphertext
        return $prefix . $message;
    }

    /**
     * By default, \Dcrypt\Aes will will return false when the checksum is invalid.
     * Use AesExp to force an exception to be thrown instead.
     * 
     * @return false
     */
    private static function invalidChecksum()
    {
        return false;
    }

}


1		<?php
2
3		/**
4		* Aes.php
5		*
6		* PHP version 5
7		*
8		* @category Dcrypt
9		* @package Dcrypt
10		* @author Michael Meyer (mmeyer2k) <[email protected]>
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		* @link https://github.com/mmeyer2k/dcrypt
13		*/
14
15		namespace Dcrypt;
16
17		/**
18		* Symmetric AES-256-CBC encryption functions powered by OpenSSL.
19		*
20		* @category Dcrypt
21		* @package Dcrypt
22		* @author Michael Meyer (mmeyer2k) <[email protected]>
23		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
24		* @link https://github.com/mmeyer2k/dcrypt
25		* @link https://apigen.ci/github/mmeyer2k/dcrypt/namespace-Dcrypt.html
26		*/
27		class Aes extends Cryptobase
28		{
29
30		/**
31		* AES-256 cipher identifier that will be passed to openssl
32		*
33		* @var string
34		*/
35		const CIPHER = 'aes-256-cbc';
36
37		/**
38		* Size of initialization vector in bytes
39		*
40		* @var int
41		*/
42		const IVSIZE = 16;
43
44		/**
45		* Size of checksum in bytes
46		*
47		* @var int
48		*/
49		const CKSIZE = 32;
50
51		/**
52		* Decrypt cyphertext
53		*
54		* @param string $cyphertext Cyphertext to decrypt
55		* @param string $password Password that should be used to decrypt input data
56		* @param int $cost Number of HMAC iterations to perform on key
57		*
58		* @return string\|boolean Returns false on checksum validation failure
59		*/
60	4	public static function decrypt($cyphertext, $password, $cost = 0)
61		{
62		// Find the IV at the beginning of the cypher text
63	4	$iv = self::substr($cyphertext, 0, self::IVSIZE);
64
65		// Gather the checksum portion of the cypher text
66	4	$chksum = self::substr($cyphertext, self::IVSIZE, self::CKSIZE);
67
68		// Gather message portion of cyphertext after iv and checksum
69	4	$message = self::substr($cyphertext, self::IVSIZE + self::CKSIZE);
70
71		// Derive key from password
72	4	$key = self::key($password, $iv, $cost);
73
74		// Calculate verification checksum
75	4	$verify = self::checksum($message, $iv, $key);
76
77		// Verify HMAC before decrypting... return false if corrupt.
78	4	if (!self::equal($verify, $chksum)) {
79	3	return static::invalidChecksum();
		0 ignored issues – show Bug introduced 2016-01-08 14:26 UTC by Report Bug Copy Issue Report Since `invalidChecksum()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `invalidChecksum()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
80		}
81
82		// Decrypt message and return
83	3	return \openssl_decrypt($message, self::CIPHER, $key, 1, $iv);
84		}
85
86		/**
87		* Encrypt plaintext
88		*
89		* @param string $plaintext Plaintext string to encrypt.
90		* @param string $password Password used to encrypt data.
91		* @param int $cost Number of HMAC iterations to perform on key
92		*
93		* @return string
94		*/
95	4	public static function encrypt($plaintext, $password, $cost = 0)
96		{
97		// Generate IV of appropriate size.
98	4	$iv = Random::get(self::IVSIZE);
99
100		// Derive key from password
101	4	$key = self::key($password, $iv, $cost);
102
103		// Encrypt the plaintext
104	4	$message = \openssl_encrypt($plaintext, self::CIPHER, $key, 1, $iv);
105
106		// Create the cypher text prefix (iv + checksum)
107	4	$prefix = $iv . self::checksum($message, $iv, $key);
108
109		// Return prefix + cyphertext
110	4	return $prefix . $message;
111	1	}
112
113		/**
114		* By default, \Dcrypt\Aes will will return false when the checksum is invalid.
115		* Use AesExp to force an exception to be thrown instead.
116		*
117		* @return false
118		*/
119	2	private static function invalidChecksum()
120		{
121	2	return false;
122		}
123
124		}
125

mmeyer2k / dcrypt

Push — master ( 84efce...33db28 )

Aes::invalidChecksum() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like