Issues in Configuration.php (master) - Issues in master - uecode/qpush-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Issues (34)

Security Analysis not enabled

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/DependencyInjection/Configuration.php (2 issues)

Labels

Bug 2

Severity

Minor 2

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

/**
 * Copyright 2014 Underground Elephant
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * @package     qpush-bundle
 * @copyright   Underground Elephant 2014
 * @license     Apache License, Version 2.0
 */

namespace Uecode\Bundle\QPushBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * @author Keith Kirk <[email protected]>
 */
class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode    = $treeBuilder->root('uecode_qpush');

        $rootNode
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('cache_service')
                    ->defaultNull()
                ->end()
                ->booleanNode('logging_enabled')
                    ->defaultTrue()
                ->end()
                ->append($this->getProvidersNode())
                ->append($this->getQueuesNode())
            ->end()
        ;

        return $treeBuilder;
    }

    private function getProvidersNode()
    {
        $treeBuilder    = new TreeBuilder();
        $node           = $treeBuilder->root('providers');
        $requirements   = [
            'aws' => [],
            'ironmq' => ['token', 'project_id'],
            'sync' => [],
            'custom' => ['service'],
            'file' => ['path'],
            'doctrine' => []
        ];

        $node
            ->useAttributeAsKey('name')
            ->prototype('array')
                ->treatNullLike([])
                ->children()
                    ->enumNode('driver')
                        ->isRequired()
                        ->values(array_keys($requirements))
                    ->end()
                    // IronMQ
                    ->scalarNode('token')->end()
                    ->scalarNode('project_id')->end()
                    ->scalarNode('service')->end()
                    ->enumNode('host')
                        ->defaultValue('mq-aws-eu-west-1-1')
                        ->values([
                            'mq-aws-eu-west-1-1',
                            'mq-aws-us-east-1-1',
                        ])
                    ->end()
                    ->scalarNode('port')
                        ->defaultValue('443')
                    ->end()
                    ->scalarNode('api_version')
                        ->defaultValue(3)
                    ->end()
                    // AWS
                    ->scalarNode('key')->end()
                    ->scalarNode('secret')->end()
                    ->scalarNode('region')
                        ->defaultValue('us-east-1')
                    ->end()
                    // File
                    ->scalarNode('path')->end()
                   // Doctrine
                    ->scalarNode('entity_manager')
                         ->defaultValue('doctrine.orm.default_entity_manager')
                    ->end()
                ->end()

                ->validate()
                ->always()
                ->then(function (array $provider) use ($node, $requirements) {
                    foreach ($requirements[$provider['driver']] as $requirement) {
                        if (empty($provider[$requirement])) {
                            throw new \InvalidArgumentException(
                                sprintf('%s queue providers must have a %s; none provided', $provider['driver'], $requirement)
                            );
                        }
                    }

                    return $provider;
                })
            ->end()
        ;

        return $node;
    }

    private function getQueuesNode()
    {
        $treeBuilder = new TreeBuilder();
        $node        = $treeBuilder->root('queues');

        $node
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.
    }
}
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->prototype('array')
                ->children()
                    ->scalarNode('provider')
                        ->isRequired()
                        ->info('The Queue Provider to use')
                    ->end()
                    ->arrayNode('options')
                        ->children()
                            ->scalarNode('queue_name')
                                ->defaultNull()
                                ->info('The actual name of the queue')
                            ->end()
                            ->booleanNode('push_notifications')
                                ->defaultFalse()
                                ->info('Whether notifications are sent to the subscribers')
                            ->end()
                            ->scalarNode('push_type')
                                ->defaultValue('multicast')
                                ->info('Whether the push queue is multicast or unicast')
                                ->example('unicast')
                            ->end()
                            ->scalarNode('notification_retries')
                                ->defaultValue(3)
                                ->info('How many attempts the Push Notifications are retried if the Subscriber returns an error')
                                ->example(3)
                            ->end()
                            ->scalarNode('notification_retries_delay')
                                ->defaultValue(60)
                                ->info('Delay between each Push Notification retry in seconds')
                                ->example(3)
                                ->end()
                            ->scalarNode('message_delay')
                                ->defaultValue(0)
                                ->info('How many seconds before messages are inititally visible in the Queue')
                                ->example(0)
                            ->end()
                            ->scalarNode('message_timeout')
                                ->defaultValue(30)
                                ->info('How many seconds the Queue hides a message while its being processed')
                                ->example(30)
                            ->end()
                            ->scalarNode('message_expiration')
                                ->defaultValue(604800)
                                ->info('How many seconds a message is kept in Queue, the default is 7 days (604800 seconds)')
                                ->example(604800)
                            ->end()
                            ->scalarNode('messages_to_receive')
                                ->defaultValue(1)
                                ->info('Max amount of messages to receive at once - an event will be fired for each individually')
                                ->example(1)
                            ->end()
                            ->scalarNode('receive_wait_time')
                                ->defaultValue(0)
                                ->info('How many seconds to Long Poll when requesting messages - if supported')
                                ->example(3)
                            ->end()
                            ->scalarNode('rate_limit')
                                ->defaultValue(-1)
                                ->info('How many push requests per second will be triggered. -1 for unlimited, 0 disables push')
                                ->example(1)
                            ->end()
                            ->booleanNode('fifo')
                                ->defaultFalse()
                                ->info('If the queue is FIFO (aws)')
                            ->end()
                            ->booleanNode('content_based_deduplication')
                                ->defaultFalse()
                                ->info('If the FIFO queue has content based deduplication (aws)')
                            ->end()
                            ->append($this->getSubscribersNode())
                        ->end()
                    ->end()
                ->end()
            ->end()
        ;

        return $node;
    }

    private function getSubscribersNode()
    {
        $treeBuilder = new TreeBuilder();
        $node        = $treeBuilder->root('subscribers');

        $node
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.
    }
}
            ->prototype('array')
                ->children()
                    ->scalarNode('endpoint')
                        ->info('The url or email address to notify')
                        ->example('http://foo.bar/qpush/')
                    ->end()
                    ->enumNode('protocol')
                        ->values(['email', 'http', 'https'])
                        ->info('The endpoint type')
                        ->example('http')
                    ->end()
                ->end()
            ->end()
        ;

        return $node;
    }
}


Issues (34)

Security Analysis not enabled

src/DependencyInjection/Configuration.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

1		<?php
2
3		/**
4		* Copyright 2014 Underground Elephant
5		*
6		* Licensed under the Apache License, Version 2.0 (the "License");
7		* you may not use this file except in compliance with the License.
8		* You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing, software
13		* distributed under the License is distributed on an "AS IS" BASIS,
14		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15		* See the License for the specific language governing permissions and
16		* limitations under the License.
17		*
18		* @package qpush-bundle
19		* @copyright Underground Elephant 2014
20		* @license Apache License, Version 2.0
21		*/
22
23		namespace Uecode\Bundle\QPushBundle\DependencyInjection;
24
25		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
26		use Symfony\Component\Config\Definition\ConfigurationInterface;
27
28		/**
29		* @author Keith Kirk <[email protected]>
30		*/
31		class Configuration implements ConfigurationInterface
32		{
33	1	public function getConfigTreeBuilder()
34		{
35	1	$treeBuilder = new TreeBuilder();
36	1	$rootNode = $treeBuilder->root('uecode_qpush');
37
38		$rootNode
39	1	->addDefaultsIfNotSet()
40	1	->children()
41	1	->scalarNode('cache_service')
42	1	->defaultNull()
43	1	->end()
44	1	->booleanNode('logging_enabled')
45	1	->defaultTrue()
46	1	->end()
47	1	->append($this->getProvidersNode())
48	1	->append($this->getQueuesNode())
49	1	->end()
50		;
51
52	1	return $treeBuilder;
53		}
54
55	1	private function getProvidersNode()
56		{
57	1	$treeBuilder = new TreeBuilder();
58	1	$node = $treeBuilder->root('providers');
59		$requirements = [
60	1	'aws' => [],
61		'ironmq' => ['token', 'project_id'],
62		'sync' => [],
63		'custom' => ['service'],
64		'file' => ['path'],
65		'doctrine' => []
66		];
67
68		$node
69	1	->useAttributeAsKey('name')
70	1	->prototype('array')
71	1	->treatNullLike([])
72	1	->children()
73	1	->enumNode('driver')
74	1	->isRequired()
75	1	->values(array_keys($requirements))
76	1	->end()
77		// IronMQ
78	1	->scalarNode('token')->end()
79	1	->scalarNode('project_id')->end()
80	1	->scalarNode('service')->end()
81	1	->enumNode('host')
82	1	->defaultValue('mq-aws-eu-west-1-1')
83	1	->values([
84	1	'mq-aws-eu-west-1-1',
85		'mq-aws-us-east-1-1',
86		])
87	1	->end()
88	1	->scalarNode('port')
89	1	->defaultValue('443')
90	1	->end()
91	1	->scalarNode('api_version')
92	1	->defaultValue(3)
93	1	->end()
94		// AWS
95	1	->scalarNode('key')->end()
96	1	->scalarNode('secret')->end()
97	1	->scalarNode('region')
98	1	->defaultValue('us-east-1')
99	1	->end()
100		// File
101	1	->scalarNode('path')->end()
102		// Doctrine
103	1	->scalarNode('entity_manager')
104	1	->defaultValue('doctrine.orm.default_entity_manager')
105	1	->end()
106	1	->end()
107
108	1	->validate()
109	1	->always()
110	1	->then(function (array $provider) use ($node, $requirements) {
111	1	foreach ($requirements[$provider['driver']] as $requirement) {
112	1	if (empty($provider[$requirement])) {
113		throw new \InvalidArgumentException(
114	1	sprintf('%s queue providers must have a %s; none provided', $provider['driver'], $requirement)
115		);
116		}
117		}
118
119	1	return $provider;
120	1	})
121	1	->end()
122		;
123
124	1	return $node;
125		}
126
127	1	private function getQueuesNode()
128		{
129	1	$treeBuilder = new TreeBuilder();
130	1	$node = $treeBuilder->root('queues');
131
132		$node
		0 ignored issues – show Bug introduced 2016-08-22 12:14 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 `Symfony\Component\Config...\Builder\NodeDefinition` as the method `children()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. 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...
133	1	->requiresAtLeastOneElement()
134	1	->useAttributeAsKey('name')
135	1	->prototype('array')
136	1	->children()
137	1	->scalarNode('provider')
138	1	->isRequired()
139	1	->info('The Queue Provider to use')
140	1	->end()
141	1	->arrayNode('options')
142	1	->children()
143	1	->scalarNode('queue_name')
144	1	->defaultNull()
145	1	->info('The actual name of the queue')
146	1	->end()
147	1	->booleanNode('push_notifications')
148	1	->defaultFalse()
149	1	->info('Whether notifications are sent to the subscribers')
150	1	->end()
151	1	->scalarNode('push_type')
152	1	->defaultValue('multicast')
153	1	->info('Whether the push queue is multicast or unicast')
154	1	->example('unicast')
155	1	->end()
156	1	->scalarNode('notification_retries')
157	1	->defaultValue(3)
158	1	->info('How many attempts the Push Notifications are retried if the Subscriber returns an error')
159	1	->example(3)
160	1	->end()
161	1	->scalarNode('notification_retries_delay')
162	1	->defaultValue(60)
163	1	->info('Delay between each Push Notification retry in seconds')
164	1	->example(3)
165	1	->end()
166	1	->scalarNode('message_delay')
167	1	->defaultValue(0)
168	1	->info('How many seconds before messages are inititally visible in the Queue')
169	1	->example(0)
170	1	->end()
171	1	->scalarNode('message_timeout')
172	1	->defaultValue(30)
173	1	->info('How many seconds the Queue hides a message while its being processed')
174	1	->example(30)
175	1	->end()
176	1	->scalarNode('message_expiration')
177	1	->defaultValue(604800)
178	1	->info('How many seconds a message is kept in Queue, the default is 7 days (604800 seconds)')
179	1	->example(604800)
180	1	->end()
181	1	->scalarNode('messages_to_receive')
182	1	->defaultValue(1)
183	1	->info('Max amount of messages to receive at once - an event will be fired for each individually')
184	1	->example(1)
185	1	->end()
186	1	->scalarNode('receive_wait_time')
187	1	->defaultValue(0)
188	1	->info('How many seconds to Long Poll when requesting messages - if supported')
189	1	->example(3)
190	1	->end()
191	1	->scalarNode('rate_limit')
192	1	->defaultValue(-1)
193	1	->info('How many push requests per second will be triggered. -1 for unlimited, 0 disables push')
194	1	->example(1)
195	1	->end()
196	1	->booleanNode('fifo')
197	1	->defaultFalse()
198	1	->info('If the queue is FIFO (aws)')
199	1	->end()
200	1	->booleanNode('content_based_deduplication')
201	1	->defaultFalse()
202	1	->info('If the FIFO queue has content based deduplication (aws)')
203	1	->end()
204	1	->append($this->getSubscribersNode())
205	1	->end()
206	1	->end()
207	1	->end()
208	1	->end()
209		;
210
211	1	return $node;
212		}
213
214	1	private function getSubscribersNode()
215		{
216	1	$treeBuilder = new TreeBuilder();
217	1	$node = $treeBuilder->root('subscribers');
218
219		$node
		0 ignored issues – show Bug introduced 2017-04-13 16:59 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 `Symfony\Component\Config...\Builder\NodeDefinition` as the method `children()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. 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...
220	1	->prototype('array')
221	1	->children()
222	1	->scalarNode('endpoint')
223	1	->info('The url or email address to notify')
224	1	->example('http://foo.bar/qpush/')
225	1	->end()
226	1	->enumNode('protocol')
227	1	->values(['email', 'http', 'https'])
228	1	->info('The endpoint type')
229	1	->example('http')
230	1	->end()
231	1	->end()
232	1	->end()
233		;
234
235	1	return $node;
236		}
237		}
238

uecode / qpush-bundle

Issues (34)

Security Analysis not enabled

src/DependencyInjection/Configuration.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like