AuthorizationEndpointSource::prepend() - Code Metrics - Inspection of "Better OpenID Connect support" - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#31)

by Florent

created 2017-04-09 13:26 UTC

AuthorizationEndpointSource::prepend() A

↳ Parent: AuthorizationEndpointSource

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	3

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace OAuth2Framework\Bundle\Server\DependencyInjection\Source\Endpoint;

use Fluent\PhpConfigFileLoader;
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\SourceInterface;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;

final class AuthorizationEndpointSource extends ActionableSource
{
    /**
     * @var SourceInterface[]
     */
    private $subSources;

    /**
     * AuthorizationEndpointSource constructor.
     */
    public function __construct()
    {
        $this->subSources = [
            new AuthorizationEndpointPreConfiguredAuthorizationSource(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
    {
        foreach ($config as $k => $v) {
            $container->setParameter($path.'.'.$k, $v);
        }

        $loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/endpoint'));
        $loader->load('authorization.php');
        $loader->load('response_mode.php');
        foreach ($this->subSources as $source) {
            $source->load($path, $container, $config);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function name(): string
    {
        return 'authorization';
    }

    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
    {
        parent::prepend($bundleConfig, $path, $container);
        foreach ($this->subSources as $source) {
            $source->prepend($bundleConfig, $path.'['.$this->name().']', $container);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function continueConfiguration(NodeDefinition $node)
    {
        parent::continueConfiguration($node);
        $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.
    }
}
            ->children()
                ->scalarNode('path')
                    ->info('The path to the authorization endpoint.')
                    ->defaultValue('/authorize')
                ->end()
                ->scalarNode('login_route_name')
                    ->info('The name of the login route. Will be converted into URL and used to redirect the user if not logged in. If you use "FOSUserBundle", the route name should be "fos_user_security_login".')
                ->end()
                ->arrayNode('login_route_parameters')
                    ->info('Parameters associated to the login route (if needed).')
                    ->useAttributeAsKey('name')
                    ->prototype('scalar')->end()
                    ->treatNullLike([])
                ->end()
                ->scalarNode('template')
                    ->info('The consent page template.')
                    ->cannotBeEmpty()
                    ->defaultValue('@OAuth2FrameworkServerBundle/authorization/authorization.html.twig')
                ->end()
            ->end();
        foreach ($this->subSources as $source) {
            $source->addConfiguration($node);
        }
    }
}
/*
path:
            #allow_scope_selection: true
            :
            request_object:
                enabled: true
                signature_algorithms: ['RS512', 'HS512']
                claim_checkers: ['exp', 'iat', 'nbf', 'authorization_endpoint_aud']
                header_checkers: ['crit']
                encryption:
                    enabled: true
                    required: true
                    key_set: 'jose.key_set.encryption'
                    key_encryption_algorithms: ['RSA-OAEP-256']
                    content_encryption_algorithms: ['A256CBC-HS512']
                reference:
                    enabled: true
                    uris_registration_required: true
            pre_configured_authorization:
                enabled: true
            enforce_secured_redirect_uri:
                enabled: true
            enforce_redirect_uri_storage:
                enabled: true
            enforce_state:
                enabled: true
            allow_response_mode_parameter:
                enabled: true
*/


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2017 Spomky-Labs
9			*
10			* This software may be modified and distributed under the terms
11			* of the MIT license. See the LICENSE file for details.
12			*/
13
14			namespace OAuth2Framework\Bundle\Server\DependencyInjection\Source\Endpoint;
15
16			use Fluent\PhpConfigFileLoader;
17			use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
18			use OAuth2Framework\Bundle\Server\DependencyInjection\Source\SourceInterface;
19			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
20			use Symfony\Component\Config\FileLocator;
21			use Symfony\Component\DependencyInjection\ContainerBuilder;
22
23			final class AuthorizationEndpointSource extends ActionableSource
24			{
25			/**
26			* @var SourceInterface[]
27			*/
28			private $subSources;
29
30			/**
31			* AuthorizationEndpointSource constructor.
32			*/
33			public function __construct()
34			{
35			$this->subSources = [
36			new AuthorizationEndpointPreConfiguredAuthorizationSource(),
37			];
38			}
39
40			/**
41			* {@inheritdoc}
42			*/
43			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
44			{
45			foreach ($config as $k => $v) {
46			$container->setParameter($path.'.'.$k, $v);
47			}
48
49			$loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/endpoint'));
50			$loader->load('authorization.php');
51			$loader->load('response_mode.php');
52			foreach ($this->subSources as $source) {
53			$source->load($path, $container, $config);
54			}
55			}
56
57			/**
58			* {@inheritdoc}
59			*/
60			protected function name(): string
61			{
62			return 'authorization';
63			}
64
65			public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
66			{
67			parent::prepend($bundleConfig, $path, $container);
68			foreach ($this->subSources as $source) {
69			$source->prepend($bundleConfig, $path.'['.$this->name().']', $container);
70			}
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			protected function continueConfiguration(NodeDefinition $node)
77			{
78			parent::continueConfiguration($node);
79			$node
			0 ignored issues – show Bug introduced 2017-03-31 15:24 UTC by Report Bug Copy Issue Report 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...
80			->children()
81			->scalarNode('path')
82			->info('The path to the authorization endpoint.')
83			->defaultValue('/authorize')
84			->end()
85			->scalarNode('login_route_name')
86			->info('The name of the login route. Will be converted into URL and used to redirect the user if not logged in. If you use "FOSUserBundle", the route name should be "fos_user_security_login".')
87			->end()
88			->arrayNode('login_route_parameters')
89			->info('Parameters associated to the login route (if needed).')
90			->useAttributeAsKey('name')
91			->prototype('scalar')->end()
92			->treatNullLike([])
93			->end()
94			->scalarNode('template')
95			->info('The consent page template.')
96			->cannotBeEmpty()
97			->defaultValue('@OAuth2FrameworkServerBundle/authorization/authorization.html.twig')
98			->end()
99			->end();
100			foreach ($this->subSources as $source) {
101			$source->addConfiguration($node);
102			}
103			}
104			}
105			/*
106			path:
107			#allow_scope_selection: true
108			:
109			request_object:
110			enabled: true
111			signature_algorithms: ['RS512', 'HS512']
112			claim_checkers: ['exp', 'iat', 'nbf', 'authorization_endpoint_aud']
113			header_checkers: ['crit']
114			encryption:
115			enabled: true
116			required: true
117			key_set: 'jose.key_set.encryption'
118			key_encryption_algorithms: ['RSA-OAEP-256']
119			content_encryption_algorithms: ['A256CBC-HS512']
120			reference:
121			enabled: true
122			uris_registration_required: true
123			pre_configured_authorization:
124			enabled: true
125			enforce_secured_redirect_uri:
126			enabled: true
127			enforce_redirect_uri_storage:
128			enabled: true
129			enforce_state:
130			enabled: true
131			allow_response_mode_parameter:
132			enabled: true
133			*/
134

OAuth2-Framework / oauth2-framework

Pull Request — master (#31)

AuthorizationEndpointSource::prepend() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like