Passed
Push — master ( 040d8b...a049ad )
by Justin
04:08
created

getPseudoRandomString()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 14
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 14
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 7
nc 2
nop 1
1
<?php
2
/**
3
 * Copyright 2017 Facebook, Inc.
4
 *
5
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
6
 * use, copy, modify, and distribute this software in source code or binary
7
 * form for use in connection with the web services and APIs provided by
8
 * Facebook.
9
 *
10
 * As with any software that integrates with the Facebook platform, your use
11
 * of this software is subject to the Facebook Developer Principles and
12
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
13
 * shall be included in all copies or substantial portions of the software.
14
 *
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21
 * DEALINGS IN THE SOFTWARE.
22
 *
23
 */
24
namespace Facebook\PseudoRandomString;
25
26
use Facebook\Exceptions\FacebookSDKException;
27
28
class McryptPseudoRandomStringGenerator implements PseudoRandomStringGeneratorInterface
29
{
30
    use PseudoRandomStringGeneratorTrait;
31
32
    /**
33
     * @const string The error message when generating the string fails.
34
     */
35
    const ERROR_MESSAGE = 'Unable to generate a cryptographically secure pseudo-random string from mcrypt_create_iv(). ';
36
37
    /**
38
     * @throws FacebookSDKException
39
     */
40
    public function __construct()
41
    {
42
        if (!function_exists('mcrypt_create_iv')) {
43
            throw new FacebookSDKException(
44
                static::ERROR_MESSAGE .
45
                'The function mcrypt_create_iv() does not exist.'
46
            );
47
        }
48
    }
49
50
    /**
51
     * @inheritdoc
52
     */
53
    public function getPseudoRandomString($length)
54
    {
55
        $this->validateLength($length);
56
57
        $binaryString = mcrypt_create_iv($length, MCRYPT_DEV_URANDOM);
0 ignored issues
show
Deprecated Code introduced by
The function mcrypt_create_iv() has been deprecated: 7.1 ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-deprecated  annotation

57
        $binaryString = /** @scrutinizer ignore-deprecated */ mcrypt_create_iv($length, MCRYPT_DEV_URANDOM);

This function has been deprecated. The supplier of the function has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the function will be removed and what other function to use instead.

Loading history...
58
59
        if ($binaryString === false) {
60
            throw new FacebookSDKException(
61
                static::ERROR_MESSAGE .
62
                'mcrypt_create_iv() returned an error.'
63
            );
64
        }
65
66
        return $this->binToHex($binaryString, $length);
67
    }
68
}
69