Issues in PropertyAccessor.php (master) - Issues in master - spaark/composite-utils - Measure and Improve Code Quality continuously with Scrutinizer

Issues (60)

Security Analysis no request data

Cross-Site Scripting

Cross-Site Scripting enables an attacker to inject code into the response of a web-request that is viewed by other users. It can for example be used to bypass access controls, or even to take over other users' accounts.

File Exposure

File Exposure allows an attacker to gain access to local files that he should not be able to access. These files can for example include database credentials, or other configuration files.

File Manipulation

File Manipulation enables an attacker to write custom data to files. This potentially leads to injection of arbitrary code on the server.

Object Injection

Object Injection enables an attacker to inject an object into PHP code, and can lead to arbitrary code execution, file exposure, or file manipulation attacks.

Code Injection

Code Injection enables an attacker to execute arbitrary code on the server.

Response Splitting

Response Splitting can be used to send arbitrary responses.

File Inclusion

File Inclusion enables an attacker to inject custom files into PHP's file loading mechanism, either explicitly passed to include, or for example via PHP's auto-loading mechanism.

Command Injection

Command Injection enables an attacker to inject a shell command that is execute with the privileges of the web-server. This can be used to expose sensitive data, or gain access of your server.

SQL Injection

SQL Injection enables an attacker to execute arbitrary SQL code on your database server gaining access to user data, or manipulating user data.

XPath Injection

XPath Injection enables an attacker to modify the parts of XML document that are read. If that XML document is for example used for authentication, this can lead to further vulnerabilities similar to SQL Injection.

LDAP Injection

LDAP Injection enables an attacker to inject LDAP statements potentially granting permission to run unauthorized queries, or modify content inside the LDAP tree.

Header Injection

Other Vulnerability

This category comprises other attack vectors such as manipulating the PHP runtime, loading custom extensions, freezing the runtime, or similar.

Regex Injection

Regex Injection enables an attacker to execute arbitrary code in your PHP process.

XML Injection

XML Injection enables an attacker to read files on your local filesystem including configuration files, or can be abused to freeze your web-server process.

Variable Injection

Variable Injection enables an attacker to overwrite program variables with custom data, and can lead to further vulnerabilities.

Unfortunately, the security analysis is currently not available for your project. If you are a non-commercial open-source project, please contact support to gain access.

src/Service/PropertyAccessor.php (3 issues)

Labels

Severity

Minor 3

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * This file is part of the Composite Utils package.
 *
 * (c) Emily Shepherd <[email protected]>
 *
 * For the full copyright and license information, please view the
 * LICENSE.md file that was distributed with this source code.
 *
 * @package spaark/composite-utils
 * @author Emily Shepherd <[email protected]>
 * @license MIT
 */

namespace Spaark\CompositeUtils\Service;

use Spaark\CompositeUtils\Model\Reflection\ReflectionComposite;
use Spaark\CompositeUtils\Model\Reflection\ReflectionProperty;
use Spaark\CompositeUtils\Model\Reflection\Type\ObjectType;
use Spaark\CompositeUtils\Model\Reflection\Type\MixedType;
use Spaark\CompositeUtils\Model\Reflection\Type\StringType;
use Spaark\CompositeUtils\Model\Reflection\Type\IntegerType;
use Spaark\CompositeUtils\Model\Reflection\Type\BooleanType;
use Spaark\CompositeUtils\Model\Reflection\Type\CollectionType;
use Spaark\CompositeUtils\Model\Reflection\Type\ScalarType;
use Spaark\CompositeUtils\Model\Reflection\Type\AbstractType;
use Spaark\CompositeUtils\Exception\CannotWritePropertyException;
use Spaark\CompositeUtils\Exception\IllegalPropertyTypeException;
use Spaark\CompositeUtils\Exception\MissingRequiredParameterException;
use Spaark\CompositeUtils\Factory\Reflection\TypeParser;
use Spaark\CompositeUtils\Service\TypeComparator;

/**
 * This class is used to access properties of a composite and enforce
 * data type requirements
 */
class PropertyAccessor extends RawPropertyAccessor
{
    /**
     * Reflection information about the composite being accessed
     *
     * @var ReflectionComposite
     */
    protected $reflect;

    /**
     * Creates the PropertyAccessor for the given object, using the
     * given reflection information
     *
     * @param object $object The object to access
     * @param ReflectionComposite $reflect Reflection information about
     *     the composite
     */
    public function __construct($object, ReflectionComposite $reflect)
    {
        parent::__construct($object);

        $this->reflect = $reflect;
    }

    /**
     * Initializes the given object with the given parameters, enforcing
     * the constructor requirements and auto building any left overs
     */
    public function constructObject(...$args)
    {
        $i = 0;
        foreach ($this->reflect->requiredProperties as $property)
        {
            if (!isset($args[$i]))
            {
                throw new MissingRequiredParameterException
                (
                    get_class($this->object),
                    $property->name
                );
            }

            $this->setAnyValue($property, $args[$i]);

            $i++;
        }

        $building = false;
        foreach ($this->reflect->optionalProperties as $property)
        {
            if ($building)
            {
                $this->buildProperty($property);
            }
            else
            {
                if (isset($args[$i]))
                {
                    $this->setAnyValue($property, $args[$i]);
                    $i++;
                }
                else
                {
                    $building = true;
                    $this->buildProperty($property);
                }
            }
        }

        foreach ($this->reflect->builtProperties as $property)
        {
            $this->buildProperty($property);
        }
    }

    /**
     * Builds a property automatically
     *
     * @param ReflectionProperty $property The property to build
     */
    protected function buildProperty(ReflectionProperty $property)
    {
        if (!$property->type instanceof ObjectType)
        {
            $this->setAnyValue($property, 0);
        }
        elseif ($property->builtInConstructor)
        {
            $class = (string)$property->type->classname;
            $this->setRawValue($property->name, new $class());
        }
    }

    /**
     * Returns the value of the property
     *
     * @param string $property The name of the property to get
     * @return mixed The value of the property
     */
    public function getValue(string $property)
    {
        return $this->getRawValue($property);
    }

    /**
     * Sets the value of a property, enforcing datatype requirements
     *
     * @param string $property The name of the property to set
     * @param mixed $value The value to set
     */
    public function setValue(string $property, $value)
    {
        if (!$this->reflect->properties->containsKey($property))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        {
            throw new CannotWritePropertyException
            (
                get_class($this->object), $property
            );
        }

        $this->setAnyValue
        (
            $this->reflect->properties[$property],
            $value
        );
    }

    /**
     * Sets the value of a property, enforcing datatype requirements
     *
     * @param ReflectionProperty $property The property to set
     * @param mixed $value The value to set
     */
    protected function setAnyValue(ReflectionProperty $property, $value)
    {
        $comparator = new TypeComparator();

        $valueType = (new TypeParser())->parseFromType($value);

        if ($comparator->compatible($property->type, $valueType))
        {
            $this->setRawValue($property->name, $value);
        }
        elseif ($property->type instanceof ScalarType)
        {
            $this->setScalarValue($property, $valueType, $value);

        }
        else
        {
            $this->throwError($property, $valueType);
        }
    }

    /**
     * Attempts to set a property which expects a scalar value
     *
     * @param ReflectionProperty $property The property to set
     * @param ScalarType $valueType The scalar type
     * @param mixed $value The value to set
     */
    private function setScalarValue
    (
        ReflectionProperty $property,
        ScalarType $valueType,
        $value
    )
    {
        $method = '__to' . $valueType;

        if (is_scalar($value))
        {
            $this->setRawValue
            (
                $property->name,
                $property->type->cast($value)
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            );
        }
        elseif (is_object($value) && method_exists([$value, $method]))
        {
            $this->setScalarValue
            (
                $property,
                $valueType,
                $value->$method()
            );
        }
        else
        {
            $this->throwError($property, $valueType);
        }
    }

    /**
     * Throws an IlleglPropertyTypeException
     *
     * @param ReflectionProperty $property The property being set
     * @param AbstractType $valueType The value being set
     */
    private function throwError
    (
        ReflectionProperty $property,
        AbstractType $valueType
    )
    {
        throw new IllegalPropertyTypeException
        (
            get_class($this->object),
            $property->name,
            $property->type,
            $valueType
        );
    }
}


Issues (60)

Security Analysis no request data

src/Service/PropertyAccessor.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

1		<?php
2		/**
3		* This file is part of the Composite Utils package.
4		*
5		* (c) Emily Shepherd <[email protected]>
6		*
7		* For the full copyright and license information, please view the
8		* LICENSE.md file that was distributed with this source code.
9		*
10		* @package spaark/composite-utils
11		* @author Emily Shepherd <[email protected]>
12		* @license MIT
13		*/
14
15		namespace Spaark\CompositeUtils\Service;
16
17		use Spaark\CompositeUtils\Model\Reflection\ReflectionComposite;
18		use Spaark\CompositeUtils\Model\Reflection\ReflectionProperty;
19		use Spaark\CompositeUtils\Model\Reflection\Type\ObjectType;
20		use Spaark\CompositeUtils\Model\Reflection\Type\MixedType;
21		use Spaark\CompositeUtils\Model\Reflection\Type\StringType;
22		use Spaark\CompositeUtils\Model\Reflection\Type\IntegerType;
23		use Spaark\CompositeUtils\Model\Reflection\Type\BooleanType;
24		use Spaark\CompositeUtils\Model\Reflection\Type\CollectionType;
25		use Spaark\CompositeUtils\Model\Reflection\Type\ScalarType;
26		use Spaark\CompositeUtils\Model\Reflection\Type\AbstractType;
27		use Spaark\CompositeUtils\Exception\CannotWritePropertyException;
28		use Spaark\CompositeUtils\Exception\IllegalPropertyTypeException;
29		use Spaark\CompositeUtils\Exception\MissingRequiredParameterException;
30		use Spaark\CompositeUtils\Factory\Reflection\TypeParser;
31		use Spaark\CompositeUtils\Service\TypeComparator;
32
33		/**
34		* This class is used to access properties of a composite and enforce
35		* data type requirements
36		*/
37		class PropertyAccessor extends RawPropertyAccessor
38		{
39		/**
40		* Reflection information about the composite being accessed
41		*
42		* @var ReflectionComposite
43		*/
44		protected $reflect;
45
46		/**
47		* Creates the PropertyAccessor for the given object, using the
48		* given reflection information
49		*
50		* @param object $object The object to access
51		* @param ReflectionComposite $reflect Reflection information about
52		* the composite
53		*/
54	23	public function __construct($object, ReflectionComposite $reflect)
55		{
56	23	parent::__construct($object);
57
58	23	$this->reflect = $reflect;
59	23	}
60
61		/**
62		* Initializes the given object with the given parameters, enforcing
63		* the constructor requirements and auto building any left overs
64		*/
65	6	public function constructObject(...$args)
66		{
67	6	$i = 0;
68	6	foreach ($this->reflect->requiredProperties as $property)
69		{
70	6	if (!isset($args[$i]))
71		{
72	2	throw new MissingRequiredParameterException
73		(
74	2	get_class($this->object),
75	2	$property->name
76		);
77		}
78
79	4	$this->setAnyValue($property, $args[$i]);
80
81	4	$i++;
82		}
83
84	4	$building = false;
85	4	foreach ($this->reflect->optionalProperties as $property)
86		{
87	4	if ($building)
88		{
89	2	$this->buildProperty($property);
90		}
91		else
92		{
93	4	if (isset($args[$i]))
94		{
95	2	$this->setAnyValue($property, $args[$i]);
96	2	$i++;
97		}
98		else
99		{
100	2	$building = true;
101	4	$this->buildProperty($property);
102		}
103		}
104		}
105
106	4	foreach ($this->reflect->builtProperties as $property)
107		{
108	4	$this->buildProperty($property);
109		}
110	4	}
111
112		/**
113		* Builds a property automatically
114		*
115		* @param ReflectionProperty $property The property to build
116		*/
117	4	protected function buildProperty(ReflectionProperty $property)
118		{
119	4	if (!$property->type instanceof ObjectType)
120		{
121	3	$this->setAnyValue($property, 0);
122		}
123	3	elseif ($property->builtInConstructor)
124		{
125	2	$class = (string)$property->type->classname;
126	2	$this->setRawValue($property->name, new $class());
127		}
128	4	}
129
130		/**
131		* Returns the value of the property
132		*
133		* @param string $property The name of the property to get
134		* @return mixed The value of the property
135		*/
136	6	public function getValue(string $property)
137		{
138	6	return $this->getRawValue($property);
139		}
140
141		/**
142		* Sets the value of a property, enforcing datatype requirements
143		*
144		* @param string $property The name of the property to set
145		* @param mixed $value The value to set
146		*/
147	9	public function setValue(string $property, $value)
148		{
149	9	if (!$this->reflect->properties->containsKey($property))
		0 ignored issues – show Documentation introduced 2017-03-19 14:36 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$property` is of type `string`, but the function expects a `object<Spaark\CompositeU...Collection\Map\KeyType>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
150		{
151		throw new CannotWritePropertyException
152		(
153		get_class($this->object), $property
154		);
155		}
156
157	9	$this->setAnyValue
158		(
159	9	$this->reflect->properties[$property],
160	9	$value
161		);
162	5	}
163
164		/**
165		* Sets the value of a property, enforcing datatype requirements
166		*
167		* @param ReflectionProperty $property The property to set
168		* @param mixed $value The value to set
169		*/
170	10	protected function setAnyValue(ReflectionProperty $property, $value)
171		{
172	10	$comparator = new TypeComparator();
173
174	10	$valueType = (new TypeParser())->parseFromType($value);
175
176	10	if ($comparator->compatible($property->type, $valueType))
177		{
178	8	$this->setRawValue($property->name, $value);
179		}
180	5	elseif ($property->type instanceof ScalarType)
181		{
182	4	$this->setScalarValue($property, $valueType, $value);
		0 ignored issues – show Compatibility introduced 2017-03-12 20:08 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$valueType` of type `object<Spaark\CompositeU...tion\Type\AbstractType>` is not a sub-type of `object<Spaark\CompositeU...ection\Type\ScalarType>`. It seems like you assume a child class of the class `Spaark\CompositeUtils\Mo...ction\Type\AbstractType` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
183		}
184		else
185		{
186	1	$this->throwError($property, $valueType);
187		}
188	9	}
189
190		/**
191		* Attempts to set a property which expects a scalar value
192		*
193		* @param ReflectionProperty $property The property to set
194		* @param ScalarType $valueType The scalar type
195		* @param mixed $value The value to set
196		*/
197	4	private function setScalarValue
198		(
199		ReflectionProperty $property,
200		ScalarType $valueType,
201		$value
202		)
203		{
204	4	$method = '__to' . $valueType;
205
206	4	if (is_scalar($value))
207		{
208	4	$this->setRawValue
209		(
210	4	$property->name,
211	4	$property->type->cast($value)
		0 ignored issues – show Bug introduced 2017-03-12 20:08 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `Spaark\CompositeUtils\Mo...ction\Type\AbstractType` as the method `cast()` does only exist in the following sub-classes of `Spaark\CompositeUtils\Mo...ction\Type\AbstractType`: `Spaark\CompositeUtils\Mo...ection\Type\BooleanType`, `Spaark\CompositeUtils\Mo...flection\Type\FloatType`, `Spaark\CompositeUtils\Mo...ection\Type\IntegerType`, `Spaark\CompositeUtils\Mo...lection\Type\ScalarType`, `Spaark\CompositeUtils\Mo...lection\Type\StringType`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
212		);
213		}
214		elseif (is_object($value) && method_exists([$value, $method]))
215		{
216		$this->setScalarValue
217		(
218		$property,
219		$valueType,
220		$value->$method()
221		);
222		}
223		else
224		{
225		$this->throwError($property, $valueType);
226		}
227	4	}
228
229		/**
230		* Throws an IlleglPropertyTypeException
231		*
232		* @param ReflectionProperty $property The property being set
233		* @param AbstractType $valueType The value being set
234		*/
235	1	private function throwError
236		(
237		ReflectionProperty $property,
238		AbstractType $valueType
239		)
240		{
241	1	throw new IllegalPropertyTypeException
242		(
243	1	get_class($this->object),
244	1	$property->name,
245	1	$property->type,
246	1	$valueType
247		);
248		}
249		}
250

spaark / composite-utils

Issues (60)

Security Analysis no request data

src/Service/PropertyAccessor.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like