JwtBearerSource::getNodeDefinition() - Code Metrics - Inspection of "Merge branch 'ng' of https://github.com/OAuth2-Fra..." - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — ng ( ca946d...fcb055 )

by Florent

created 2018-02-06 20:26 UTC

JwtBearerSource::getNodeDefinition() A

↳ Parent: JwtBearerSource

Complexity

Conditions	2
Paths	1

Size

Total Lines	53
Code Lines	50

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	53
rs	9.5797
c	0
b	0
f	0
cc	2
eloc	50
nc	1
nop	1

How to fix Long Method

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 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\DependencyInjection\Component\Grant\JwtBearer;

use Jose\Bundle\JoseFramework\Helper\ConfigurationHelper;
use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;

class JwtBearerSource implements Component
{
    /**
     * {@inheritdoc}
     */
    public function name(): string
    {
        return 'jwt_bearer';
    }

    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        if ($configs['grant']['jwt_bearer']['enabled']) {
            $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../../../Resources/config/grant'));
            $loader->load('jwt_bearer.php');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeDefinition(NodeDefinition $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.
    }
}
            ->validate()
                ->ifTrue(function ($config) {
                    return true === $config['enabled'] && empty($config['signature_algorithms']);
                })
                ->thenInvalid('The option "signature_algorithms" must contain at least one signature algorithm.')
            ->end()
            ->children()
                ->booleanNode('issue_refresh_token')
                    ->info('If true, a refresh token will be issued with the access token (the refresh token grant type must be enabled).')
                ->end()
                ->arrayNode('signature_algorithms')
                    ->info('Signature algorithms supported by this grant type.')
                    ->useAttributeAsKey('name')
                    ->prototype('scalar')->end()
                    ->treatNullLike([])
                ->end()
                ->arrayNode('claim_checkers')
                    ->info('Checkers will verify the JWT claims.')
                    ->useAttributeAsKey('name')
                    ->prototype('scalar')->end()
                    ->treatNullLike(['exp', 'iat', 'nbf'])
                ->end()
                ->arrayNode('header_checkers')
                    ->info('Checkers will verify the JWT headers.')
                    ->useAttributeAsKey('name')
                    ->prototype('scalar')->end()
                    ->treatNullLike(['crit'])
                ->end()
                ->arrayNode('encryption')
                    ->children()
                        ->booleanNode('required')
                            ->info('If set to true, all ID Token sent to the server must be encrypted.')
                            ->defaultFalse()
                        ->end()
                        ->arrayNode('key_encryption_algorithms')
                            ->info('Supported key encryption algorithms.')
                            ->useAttributeAsKey('name')
                            ->prototype('scalar')->end()
                            ->treatNullLike([])
                        ->end()
                        ->arrayNode('content_encryption_algorithms')
                            ->info('Supported content encryption algorithms.')
                            ->useAttributeAsKey('name')
                            ->prototype('scalar')->end()
                            ->treatNullLike([])
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    /**
     * {@inheritdoc}
     */
    public function prepend(ContainerBuilder $container, array $config): array
    {
        //Nothing to do
        return [];
    }

    /**
     * @param ContainerBuilder $container
     * @param array            $sourceConfig
     */
    private function updateJoseBundleConfigurationForVerifier(ContainerBuilder $container, array $sourceConfig)

    {
        ConfigurationHelper::addJWSLoader($container, $this->name(), $sourceConfig['signature_algorithms'], [], ['jws_compact'], false);

        ConfigurationHelper::addClaimChecker($container, $this->name(), [], false);
    }

    /**
     * @param ContainerBuilder $container
     * @param array            $sourceConfig
     */
    private function updateJoseBundleConfigurationForDecrypter(ContainerBuilder $container, array $sourceConfig)

    {
        if (true === $sourceConfig['encryption']['enabled']) {
            //ConfigurationHelper::addKeyset($container, 'jwt_bearer.key_set.encryption', 'jwkset', ['value' => $bundleConfig['key_set']['encryption']]);

            ConfigurationHelper::addJWELoader($container, $this->name(), $sourceConfig['encryption']['key_encryption_algorithms'], $sourceConfig['encryption']['content_encryption_algorithms'], ['DEF'], [], ['jwe_compact'], false);

        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2018 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\DependencyInjection\Component\Grant\JwtBearer;
15
16			use Jose\Bundle\JoseFramework\Helper\ConfigurationHelper;
17			use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
18			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
19			use Symfony\Component\Config\FileLocator;
20			use Symfony\Component\DependencyInjection\ContainerBuilder;
21			use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
22
23			class JwtBearerSource implements Component
24			{
25			/**
26			* {@inheritdoc}
27			*/
28			public function name(): string
29			{
30			return 'jwt_bearer';
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			public function load(array $configs, ContainerBuilder $container)
37			{
38			if ($configs['grant']['jwt_bearer']['enabled']) {
39			$loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../../../Resources/config/grant'));
40			$loader->load('jwt_bearer.php');
41			}
42			}
43
44			/**
45			* {@inheritdoc}
46			*/
47			public function getNodeDefinition(NodeDefinition $node)
48			{
49			$node
			0 ignored issues – show Bug introduced 2018-01-31 21:55 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...
50			->validate()
51			->ifTrue(function ($config) {
52			return true === $config['enabled'] && empty($config['signature_algorithms']);
53			})
54			->thenInvalid('The option "signature_algorithms" must contain at least one signature algorithm.')
55			->end()
56			->children()
57			->booleanNode('issue_refresh_token')
58			->info('If true, a refresh token will be issued with the access token (the refresh token grant type must be enabled).')
59			->end()
60			->arrayNode('signature_algorithms')
61			->info('Signature algorithms supported by this grant type.')
62			->useAttributeAsKey('name')
63			->prototype('scalar')->end()
64			->treatNullLike([])
65			->end()
66			->arrayNode('claim_checkers')
67			->info('Checkers will verify the JWT claims.')
68			->useAttributeAsKey('name')
69			->prototype('scalar')->end()
70			->treatNullLike(['exp', 'iat', 'nbf'])
71			->end()
72			->arrayNode('header_checkers')
73			->info('Checkers will verify the JWT headers.')
74			->useAttributeAsKey('name')
75			->prototype('scalar')->end()
76			->treatNullLike(['crit'])
77			->end()
78			->arrayNode('encryption')
79			->children()
80			->booleanNode('required')
81			->info('If set to true, all ID Token sent to the server must be encrypted.')
82			->defaultFalse()
83			->end()
84			->arrayNode('key_encryption_algorithms')
85			->info('Supported key encryption algorithms.')
86			->useAttributeAsKey('name')
87			->prototype('scalar')->end()
88			->treatNullLike([])
89			->end()
90			->arrayNode('content_encryption_algorithms')
91			->info('Supported content encryption algorithms.')
92			->useAttributeAsKey('name')
93			->prototype('scalar')->end()
94			->treatNullLike([])
95			->end()
96			->end()
97			->end()
98			->end();
99			}
100
101			/**
102			* {@inheritdoc}
103			*/
104			public function prepend(ContainerBuilder $container, array $config): array
105			{
106			//Nothing to do
107			return [];
108			}
109
110			/**
111			* @param ContainerBuilder $container
112			* @param array $sourceConfig
113			*/
114			private function updateJoseBundleConfigurationForVerifier(ContainerBuilder $container, array $sourceConfig)
			0 ignored issues – show Unused Code introduced 2018-02-06 20:36 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
115			{
116			ConfigurationHelper::addJWSLoader($container, $this->name(), $sourceConfig['signature_algorithms'], [], ['jws_compact'], false);
			0 ignored issues – show Bug introduced 2018-01-05 14:16 UTC by Report Bug Copy Issue Report The method `addJWSLoader()` does not seem to exist on `object<Jose\Bundle\JoseF...er\ConfigurationHelper>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
117			ConfigurationHelper::addClaimChecker($container, $this->name(), [], false);
118			}
119
120			/**
121			* @param ContainerBuilder $container
122			* @param array $sourceConfig
123			*/
124			private function updateJoseBundleConfigurationForDecrypter(ContainerBuilder $container, array $sourceConfig)
			0 ignored issues – show Unused Code introduced 2018-02-06 20:36 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
125			{
126			if (true === $sourceConfig['encryption']['enabled']) {
127			//ConfigurationHelper::addKeyset($container, 'jwt_bearer.key_set.encryption', 'jwkset', ['value' => $bundleConfig['key_set']['encryption']]);
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-30 12:55 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
128			ConfigurationHelper::addJWELoader($container, $this->name(), $sourceConfig['encryption']['key_encryption_algorithms'], $sourceConfig['encryption']['content_encryption_algorithms'], ['DEF'], [], ['jwe_compact'], false);
			0 ignored issues – show Bug introduced 2018-01-05 14:16 UTC by Report Bug Copy Issue Report The method `addJWELoader()` does not seem to exist on `object<Jose\Bundle\JoseF...er\ConfigurationHelper>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
129			}
130			}
131			}
132

OAuth2-Framework / oauth2-framework

Push — ng ( ca946d...fcb055 )

JwtBearerSource::getNodeDefinition() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like