ClientAssertionJwtSource::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

ClientAssertionJwtSource::getNodeDefinition() B

↳ Parent: ClientAssertionJwtSource

Complexity

Conditions	4
Paths	1

Size

Total Lines	74
Code Lines	69

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	74
rs	8.6628
c	0
b	0
f	0
cc	4
eloc	69
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\ClientAuthentication;

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 ClientAssertionJwtSource implements Component
{
    /**
     * @return string
     */
    public function name(): string
    {
        return 'client_assertion_jwt';
    }

    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        if ($configs['client_authentication']['client_assertion_jwt']['enabled']) {
            $container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.secret_lifetime', $configs['client_authentication']['client_assertion_jwt']['secret_lifetime']);
            $container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.signature_algorithms', $configs['client_authentication']['client_assertion_jwt']['signature_algorithms']);
            $container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.claim_checkers', $configs['client_authentication']['client_assertion_jwt']['claim_checkers']);
            $container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.header_checkers', $configs['client_authentication']['client_assertion_jwt']['header_checkers']);
            $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../../Resources/config/client_authentication'));
            $loader->load('client_assertion_jwt.php');
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeDefinition(NodeDefinition $node)
    {
        $node->children()
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.
    }
}
            ->arrayNode($this->name())
                ->addDefaultsIfNotSet()
                ->canBeEnabled()
                ->info('This method comprises the "client_secret_jwt" and the "private_key_jwt" authentication methods')
                ->validate()
                    ->ifTrue(function ($config) {
                        return true === $config['enabled'] && empty($config['signature_algorithms']);
                    })
                    ->thenInvalid('At least one signature algorithm must be set.')
                ->end()
                ->children()
                    ->integerNode('secret_lifetime')
                        ->info('Secret lifetime (in seconds; 0 = unlimited) applicable to the "client_secret_jwt" authentication method')
                        ->defaultValue(60 * 60 * 24 * 14)
                        ->min(0)
                    ->end()
                    ->arrayNode('signature_algorithms')
                        ->info('Supported signature algorithms.')
                        ->useAttributeAsKey('name')
                        ->prototype('scalar')->end()
                        ->treatNullLike([])
                    ->end()
                    ->arrayNode('claim_checkers')
                        ->info('Claim checkers for incoming assertions.')
                        ->useAttributeAsKey('name')
                        ->prototype('scalar')->end()
                        ->treatNullLike([])
                    ->end()
                    ->arrayNode('header_checkers')
                        ->info('Header checkers for incoming assertions.')
                        ->useAttributeAsKey('name')
                        ->prototype('scalar')->end()
                        ->treatNullLike([])
                    ->end()
                    ->arrayNode('encryption')
                        ->canBeEnabled()
                        ->validate()
                            ->ifTrue(function ($config) {
                                return true === $config['enabled'] && empty($config['key_encryption_algorithms']);
                            })
                            ->thenInvalid('At least one key encryption algorithm must be set.')
                        ->end()
                        ->validate()
                            ->ifTrue(function ($config) {
                                return true === $config['enabled'] && empty($config['content_encryption_algorithms']);
                            })
                            ->thenInvalid('At least one content encryption algorithm must be set.')
                        ->end()
                        ->children()
                            ->booleanNode('required')
                                ->info('When true, all incoming assertions 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()
            ->end()
        ->end();
    }

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


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\ClientAuthentication;
15
16			use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
17			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
18			use Symfony\Component\Config\FileLocator;
19			use Symfony\Component\DependencyInjection\ContainerBuilder;
20			use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
21
22			class ClientAssertionJwtSource implements Component
23			{
24			/**
25			* @return string
26			*/
27			public function name(): string
28			{
29			return 'client_assertion_jwt';
30			}
31
32			/**
33			* {@inheritdoc}
34			*/
35			public function load(array $configs, ContainerBuilder $container)
36			{
37			if ($configs['client_authentication']['client_assertion_jwt']['enabled']) {
38			$container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.secret_lifetime', $configs['client_authentication']['client_assertion_jwt']['secret_lifetime']);
39			$container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.signature_algorithms', $configs['client_authentication']['client_assertion_jwt']['signature_algorithms']);
40			$container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.claim_checkers', $configs['client_authentication']['client_assertion_jwt']['claim_checkers']);
41			$container->setParameter('oauth2_server.client_authentication.client_assertion_jwt.header_checkers', $configs['client_authentication']['client_assertion_jwt']['header_checkers']);
42			$loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../../Resources/config/client_authentication'));
43			$loader->load('client_assertion_jwt.php');
44			}
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50			public function getNodeDefinition(NodeDefinition $node)
51			{
52			$node->children()
			0 ignored issues – show Bug introduced 2018-02-01 21:54 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...
53			->arrayNode($this->name())
54			->addDefaultsIfNotSet()
55			->canBeEnabled()
56			->info('This method comprises the "client_secret_jwt" and the "private_key_jwt" authentication methods')
57			->validate()
58			->ifTrue(function ($config) {
59			return true === $config['enabled'] && empty($config['signature_algorithms']);
60			})
61			->thenInvalid('At least one signature algorithm must be set.')
62			->end()
63			->children()
64			->integerNode('secret_lifetime')
65			->info('Secret lifetime (in seconds; 0 = unlimited) applicable to the "client_secret_jwt" authentication method')
66			->defaultValue(60 * 60 * 24 * 14)
67			->min(0)
68			->end()
69			->arrayNode('signature_algorithms')
70			->info('Supported signature algorithms.')
71			->useAttributeAsKey('name')
72			->prototype('scalar')->end()
73			->treatNullLike([])
74			->end()
75			->arrayNode('claim_checkers')
76			->info('Claim checkers for incoming assertions.')
77			->useAttributeAsKey('name')
78			->prototype('scalar')->end()
79			->treatNullLike([])
80			->end()
81			->arrayNode('header_checkers')
82			->info('Header checkers for incoming assertions.')
83			->useAttributeAsKey('name')
84			->prototype('scalar')->end()
85			->treatNullLike([])
86			->end()
87			->arrayNode('encryption')
88			->canBeEnabled()
89			->validate()
90			->ifTrue(function ($config) {
91			return true === $config['enabled'] && empty($config['key_encryption_algorithms']);
92			})
93			->thenInvalid('At least one key encryption algorithm must be set.')
94			->end()
95			->validate()
96			->ifTrue(function ($config) {
97			return true === $config['enabled'] && empty($config['content_encryption_algorithms']);
98			})
99			->thenInvalid('At least one content encryption algorithm must be set.')
100			->end()
101			->children()
102			->booleanNode('required')
103			->info('When true, all incoming assertions must be encrypted.')
104			->defaultFalse()
105			->end()
106			->arrayNode('key_encryption_algorithms')
107			->info('Supported key encryption algorithms.')
108			->useAttributeAsKey('name')
109			->prototype('scalar')->end()
110			->treatNullLike([])
111			->end()
112			->arrayNode('content_encryption_algorithms')
113			->info('Supported content encryption algorithms.')
114			->useAttributeAsKey('name')
115			->prototype('scalar')->end()
116			->treatNullLike([])
117			->end()
118			->end()
119			->end()
120			->end()
121			->end()
122			->end();
123			}
124
125			/**
126			* {@inheritdoc}
127			*/
128			public function prepend(ContainerBuilder $container, array $config): array
129			{
130			return [];
131			}
132			}
133

OAuth2-Framework / oauth2-framework

Push — ng ( ca946d...fcb055 )

ClientAssertionJwtSource::getNodeDefinition() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like