IsValidEncryptionIV::__construct() - Code Metrics - ganbarodigital/php-mv-messaging-pipeline - Measure and Improve Code Quality continuously with Scrutinizer

IsValidEncryptionIV::__construct() A
last analyzed 2017-04-07 21:33 UTC

↳ Parent: IsValidEncryptionIV

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * Copyright (c) 2017-present Ganbaro Digital Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   MessagingPipeline/Checks
 * @author    Stuart Herbert <[email protected]>
 * @copyright 2017-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://ganbarodigital.github.io/php-mv-messaging-pipeline
 */

namespace GanbaroDigital\MessagingPipeline\V1\Checks;

use GanbaroDigital\MissingBits\Checks\Check;
use GanbaroDigital\MissingBits\Checks\ListCheck;
use GanbaroDigital\MissingBits\Checks\ListCheckHelper;

/**
 * do we have an encryption initialisation vector that we can use?
 *
 * the initialisation vector (IV for short) is often used in configs
 * as a 'shared secret'
 */
class IsValidEncryptionIV implements Check, ListCheck
{
    // saves us having to implement inspectList() ourselves
    use ListCheckHelper;

    /**
     * what kind of encryption are we using?
     * @var string
     */
    private $encryptionType;

    /**
     * constructor
     *
     * @param string $encryptionType
     *        the OpenSSL encryption cipher that we are using
     */
    public function __construct(string $encryptionType)
    {
        $this->encryptionType = $encryptionType;
    }

    /**
     * do we have an encryption initialisation vector that we can use?
     *
     * the initialisation vector (IV for short) is often used in configs
     * as a 'shared secret'
     *
     * @param  string $encryptionType
     *         what kind of encryption are we using?
     * @param  string $iv
     *         what initialisation vector are we checking?
     * @return bool
     *         TRUE if $iv is a valid initialisation vector for the given
     *         $encryptionType
     *         FALSE otherwise
     */
    public static function check(string $encryptionType, string $iv) : bool
    {
        // deal with a bad cipher
        $errorMessage = null;
        set_error_handler(function ($errno, $errstr) use (&$errorMessage) {
            $errorMessage = $errstr;
        });
        $requiredLen = openssl_cipher_iv_length($encryptionType);
        restore_error_handler();

        // was there a problem?
        if ($errorMessage || $requiredLen === false) {
            return false;
        }

        // if we get here, then we can check that we have enough bytes
        return (strlen($iv) === $requiredLen);
    }

    /**
     * do we have an encryption type that we can use?
     *
     * @param  string $iv
     *         what initialisation vector are we checking?
     * @return bool
     *         TRUE if $iv is a valid initialisation vector for the given
     *         $encryptionType
     *         FALSE otherwise
     */
    public function inspect($iv)
    {
        // we are just a wrapper around our stateless check
        return static::check($this->encryptionType, $iv);
    }

    /**
     * do we have an encryption type that we can use?
     *
     * @param  string $encryptionType
     *         what kind of encryption are we using?
     * @param  array|Traversable $list
     *         the list of initialisation vectors to examine
     * @return bool
     *         TRUE if all the items in $list are valid initialisation vectors
     *         for the given $encryptionType
     *         FALSE otherwise
     */
    public static function checkList(string $encryptionType, $list) : bool
    {
        // we are just a wrapper around our OO list inspector
        $inspector = new static($encryptionType);
        return $inspector->inspectList($list);
    }
}

1			<?php
2
3			/**
4			* Copyright (c) 2017-present Ganbaro Digital Ltd
5			* All rights reserved.
6			*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions
9			* are met:
10			*
11			* * Redistributions of source code must retain the above copyright
12			* notice, this list of conditions and the following disclaimer.
13			*
14			* * Redistributions in binary form must reproduce the above copyright
15			* notice, this list of conditions and the following disclaimer in
16			* the documentation and/or other materials provided with the
17			* distribution.
18			*
19			* * Neither the names of the copyright holders nor the names of his
20			* contributors may be used to endorse or promote products derived
21			* from this software without specific prior written permission.
22			*
23			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26			* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27			* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28			* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29			* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30			* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31			* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33			* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34			* POSSIBILITY OF SUCH DAMAGE.
35			*
36			* @category Libraries
37			* @package MessagingPipeline/Checks
38			* @author Stuart Herbert <[email protected]>
39			* @copyright 2017-present Ganbaro Digital Ltd www.ganbarodigital.com
40			* @license http://www.opensource.org/licenses/bsd-license.php BSD License
41			* @link http://ganbarodigital.github.io/php-mv-messaging-pipeline
42			*/
43
44			namespace GanbaroDigital\MessagingPipeline\V1\Checks;
45
46			use GanbaroDigital\MissingBits\Checks\Check;
47			use GanbaroDigital\MissingBits\Checks\ListCheck;
48			use GanbaroDigital\MissingBits\Checks\ListCheckHelper;
49
50			/**
51			* do we have an encryption initialisation vector that we can use?
52			*
53			* the initialisation vector (IV for short) is often used in configs
54			* as a 'shared secret'
55			*/
56			class IsValidEncryptionIV implements Check, ListCheck
57			{
58			// saves us having to implement inspectList() ourselves
59			use ListCheckHelper;
60
61			/**
62			* what kind of encryption are we using?
63			* @var string
64			*/
65			private $encryptionType;
66
67			/**
68			* constructor
69			*
70			* @param string $encryptionType
71			* the OpenSSL encryption cipher that we are using
72			*/
73			public function __construct(string $encryptionType)
74			{
75			$this->encryptionType = $encryptionType;
76			}
77
78			/**
79			* do we have an encryption initialisation vector that we can use?
80			*
81			* the initialisation vector (IV for short) is often used in configs
82			* as a 'shared secret'
83			*
84			* @param string $encryptionType
85			* what kind of encryption are we using?
86			* @param string $iv
87			* what initialisation vector are we checking?
88			* @return bool
89			* TRUE if $iv is a valid initialisation vector for the given
90			* $encryptionType
91			* FALSE otherwise
92			*/
93			public static function check(string $encryptionType, string $iv) : bool
94			{
95			// deal with a bad cipher
96			$errorMessage = null;
97			set_error_handler(function ($errno, $errstr) use (&$errorMessage) {
98			$errorMessage = $errstr;
99			});
100			$requiredLen = openssl_cipher_iv_length($encryptionType);
101			restore_error_handler();
102
103			// was there a problem?
104			if ($errorMessage \|\| $requiredLen === false) {
105			return false;
106			}
107
108			// if we get here, then we can check that we have enough bytes
109			return (strlen($iv) === $requiredLen);
110			}
111
112			/**
113			* do we have an encryption type that we can use?
114			*
115			* @param string $iv
116			* what initialisation vector are we checking?
117			* @return bool
118			* TRUE if $iv is a valid initialisation vector for the given
119			* $encryptionType
120			* FALSE otherwise
121			*/
122			public function inspect($iv)
123			{
124			// we are just a wrapper around our stateless check
125			return static::check($this->encryptionType, $iv);
126			}
127
128			/**
129			* do we have an encryption type that we can use?
130			*
131			* @param string $encryptionType
132			* what kind of encryption are we using?
133			* @param array\|Traversable $list
134			* the list of initialisation vectors to examine
135			* @return bool
136			* TRUE if all the items in $list are valid initialisation vectors
137			* for the given $encryptionType
138			* FALSE otherwise
139			*/
140			public static function checkList(string $encryptionType, $list) : bool
141			{
142			// we are just a wrapper around our OO list inspector
143			$inspector = new static($encryptionType);
144			return $inspector->inspectList($list);
145			}
146			}

ganbarodigital / php-mv-messaging-pipeline

IsValidEncryptionIV::__construct() A last analyzed 2017-04-07 21:33 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

IsValidEncryptionIV::__construct() A
last analyzed 2017-04-07 21:33 UTC