View GitHub Repository random_compat

Schedule Inspection
Subscribe
Completed
Pull Request — master (#74)
by
unknown
04:47
created

Paragonie_RandomBytes::random_bytes()   B

↳ Parent: Paragonie_RandomBytes

Complexity

Conditions 5
Paths 8

Size

Total Lines 22
Code Lines 12

Duplication

Lines 0
Ratio 0 %
Metric Value
dl 0
loc 22
rs 8.6738
cc 5
eloc 12
nc 8
nop 1
1 
<?php
2 
/*
3 
 * Random_* Compatibility Library
4 
 * for using the new PHP 7 random_* API in PHP 5 projects
5 
 *
6 
 * The MIT License (MIT)
7 
 *
8 
 * Copyright (c) 2015 Paragon Initiative Enterprises
9 
 *
10 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 
 * of this software and associated documentation files (the "Software"), to deal
12 
 * in the Software without restriction, including without limitation the rights
13 
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 
 * copies of the Software, and to permit persons to whom the Software is
15 
 * furnished to do so, subject to the following conditions:
16 
 *
17 
 * The above copyright notice and this permission notice shall be included in
18 
 * all copies or substantial portions of the Software.
19 
 *
20 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 
 * SOFTWARE.
27 
 */
28 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
class Paragonie_RandomBytes extends Paragonie_RandomAdapter

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Coding Style
            Compatibility
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.
                                            

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
You can fix this by adding a namespace to your class:


namespace YourVendor;

class YourClass { }





When choosing a vendor namespace, try to pick something that is not too generic
to avoid conflicts with other libraries.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                                                                            
                            
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                
{

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
    /**

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    32
                

                                    
                                                    
                
                
                
     * @param int $bytes

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                
     * 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
     * @throws Exception

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
     * 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
     * @return string

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    37
                

                                    
                                                    
                
                
                
     */

            


            
                                                        
            
                                    
            
            

                
                    38
                

                                    
                                                    
                
                
                
    public static function random_bytes($bytes)

            


            
                                                        
            
                                    
            
            

                
                    39
                

                                    
                                                    
                
                
                
    {

            


            
                                                        
            
                                    
            
            

                
                    40
                

                                    
                                                    
                
                
                
        is_int($bytes) or $bytes = Paragonie_Util_Intval::intval($bytes, __FUNCTION__, 1);

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Comprehensibility
            Best Practice
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
Using logical operators such as or instead of || is generally not recommended.
                                                                                                                                                    

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
PHP has two types of connecting operators (logical operators, and boolean operators):


 
Logical Operators
Boolean Operator

AND - meaning
and
&&

OR - meaning
or
||

The difference between these is the order in which they are executed. In most cases,
you would want to use a boolean operator like &&, or ||.


Let’s take a look at a few examples:


// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);







Logical Operators are used for Control-Flow


One case where you explicitly want to use logical operators is for control-flow
such as this:


$x === 5
    or die('$x must be 5.');

// Instead of
if ($x !== 5) {
    die('$x must be 5.');
}





Since die introduces problems of its own, f.e. it makes our code hardly
testable, and prevents any kind of more sophisticated error handling; you probably
do not want to use this in real-world code. Unfortunately, logical operators
cannot be combined with throw at this point:


// The following is currently a parse error.
$x === 5
    or throw new RuntimeException('$x must be 5.');





These limitations lead to logical operators rarely being of use in current
PHP code.




                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    41
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    42
                

                                    
                                                    
                
                
                
        if ($bytes < 1) {

            


            
                                                        
            
                                    
            
            

                
                    43
                

                                    
                                                    
                
                
                
            throw new Error(

            


            
                                                        
            
                                    
            
            

                
                    44
                

                                    
                                                    
                
                
                
                'Length must be greater than 0'

            


            
                                                        
            
                                    
            
            

                
                    45
                

                                    
                                                    
                
                
                
            );

            


            
                                                        
            
                                    
            
            

                
                    46
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    47
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    48
                

                                    
                                                    
                
                
                
        $buf = parent::do_random_bytes($bytes);

            


                            

                    
                        
                    
                    
                    
                    
                                                                                                    
                        

                            
                            
0 ignored issues

                            –
                            show
                        


                        

                                                                                        




    

        
            Comprehensibility
            Bug
    
    
    
        introduced 
                            by 
            

        

        

            
        

        

            

                

                    
                
                
            


        

    

    

        
                        

                            
                                
                            
                        

                                        
It seems like you call parent on a different method (do_random_bytes() instead of random_bytes()). Are you sure this is correct? If so, you might want to change this to $this->do_random_bytes().
                                                                                                                                                                                                        

                    
                                            

                            

                            

                                
                                    
                                
                            


                            
This check looks for a call to a parent method whose name is different than
the method from which it is called.


Consider the following code:


class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}





The getFirstName() method in the Son calls the wrong method in the
parent class.


                        

                                                    

                     Loading history...
                

                    


    




                                                                                    


                    		
                

            
                                                        
            
                                    
            
            

                
                    49
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    50
                

                                    
                                                    
                
                
                
        if (!isset($buf[$bytes - 1])) {

            


            
                                                        
            
                                    
            
            

                
                    51
                

                                    
                                                    
                
                
                
            throw new Exception(

            


            
                                                        
            
                                    
            
            

                
                    52
                

                                    
                                                    
                
                
                
                'Could not gather sufficient random data'

            


            
                                                        
            
                                    
            
            

                
                    53
                

                                    
                                                    
                
                
                
            );

            


            
                                                        
            
                                    
            
            

                
                    54
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    55
                

                                    
                                                    
                
                
                
        if (isset($buf[$bytes])) {

            


            
                                                        
            
                                    
            
            

                
                    56
                

                                    
                                                    
                
                
                
            $buf = Paragonie_Util_Binary::substr($buf, 0, $bytes);

            


            
                                                        
            
                                    
            
            

                
                    57
                

                                    
                                                    
                
                
                
        }

            


            
                                                        
            
                                    
            
            

                
                    58
                

                                    
                                                    
                
                
                
        return $buf;

            


            
                                                        
            
                                    
            
            

                
                    59
                

                                    
                                                    
                
                
                
    }

            


            
                                                        
            
                                    
            
            

                
                    60
                

                                    
                                                    
                
                
                
}

            


            
                                                        
            
                                    
            
            

                
                    61