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

Failed Conditions

Push — master ( 8e9cbc...6d4032 )

by Florent

created 2017-04-09 13:52 UTC

IdTokenEncryptionSource A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
wmc	8
lcom	1
cbo	5
dl	0
loc	78
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	continueLoading()	7	2
A	prepend()	11	2
A	name()	4	1
A	continueConfiguration()	23	1
A	updateJoseBundleConfigurationForEncrypter()	4	1
A	updateJoseBundleConfigurationForDecrypter()	4	1

<?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\OpenIdConnect;

use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
use SpomkyLabs\JoseBundle\Helper\ConfigurationHelper;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\PropertyAccess\PropertyAccess;

final class IdTokenEncryptionSource extends ActionableSource
{
    /**
     * {@inheritdoc}
     */
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
    {
        foreach (['key_encryption_algorithms', 'content_encryption_algorithms'] as $k) {
            $container->setParameter($path.'.'.$k, $config[$k]);
        }
        $container->setAlias($path.'.key_set', $config['key_set']);
    }

    /**
     * {@inheritdoc}
     */
    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
    {
        $currentPath = $path.'['.$this->name().']';
        $accessor = PropertyAccess::createPropertyAccessor();
        $sourceConfig = $accessor->getValue($bundleConfig, $currentPath);

        if (true === $sourceConfig['enabled']) {
            $this->updateJoseBundleConfigurationForEncrypter($container, $sourceConfig);
            $this->updateJoseBundleConfigurationForDecrypter($container, $sourceConfig);
        }
    }

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

    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('key_set')
                    ->info('Key set that contains a suitable encryption key for the selected encryption algorithms.')
                    ->defaultNull()
                ->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();
    }

    /**
     * @param ContainerBuilder $container
     * @param array            $sourceConfig
     */
    private function updateJoseBundleConfigurationForEncrypter(ContainerBuilder $container, array $sourceConfig)
    {
        ConfigurationHelper::addEncrypter($container, 'id_token', $sourceConfig['key_encryption_algorithms'], $sourceConfig['content_encryption_algorithms'], ['DEF'], false, false);
    }

    /**
     * @param ContainerBuilder $container
     * @param array            $sourceConfig
     */
    private function updateJoseBundleConfigurationForDecrypter(ContainerBuilder $container, array $sourceConfig)
    {
        ConfigurationHelper::addDecrypter($container, 'id_token', $sourceConfig['key_encryption_algorithms'], $sourceConfig['content_encryption_algorithms'], ['DEF'], false);
    }
}


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\OpenIdConnect;
15
16			use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
17			use SpomkyLabs\JoseBundle\Helper\ConfigurationHelper;
18			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
19			use Symfony\Component\DependencyInjection\ContainerBuilder;
20			use Symfony\Component\PropertyAccess\PropertyAccess;
21
22			final class IdTokenEncryptionSource extends ActionableSource
23			{
24			/**
25			* {@inheritdoc}
26			*/
27			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
28			{
29			foreach (['key_encryption_algorithms', 'content_encryption_algorithms'] as $k) {
30			$container->setParameter($path.'.'.$k, $config[$k]);
31			}
32			$container->setAlias($path.'.key_set', $config['key_set']);
33			}
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
39			{
40			$currentPath = $path.'['.$this->name().']';
41			$accessor = PropertyAccess::createPropertyAccessor();
42			$sourceConfig = $accessor->getValue($bundleConfig, $currentPath);
43
44			if (true === $sourceConfig['enabled']) {
45			$this->updateJoseBundleConfigurationForEncrypter($container, $sourceConfig);
46			$this->updateJoseBundleConfigurationForDecrypter($container, $sourceConfig);
47			}
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			protected function name(): string
54			{
55			return 'encryption';
56			}
57
58			protected function continueConfiguration(NodeDefinition $node)
59			{
60			parent::continueConfiguration($node);
61			$node
			0 ignored issues – show Bug introduced 2017-04-09 13:29 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...
62			->children()
63			->scalarNode('key_set')
64			->info('Key set that contains a suitable encryption key for the selected encryption algorithms.')
65			->defaultNull()
66			->end()
67			->arrayNode('key_encryption_algorithms')
68			->info('Supported key encryption algorithms.')
69			->useAttributeAsKey('name')
70			->prototype('scalar')->end()
71			->treatNullLike([])
72			->end()
73			->arrayNode('content_encryption_algorithms')
74			->info('Supported content encryption algorithms.')
75			->useAttributeAsKey('name')
76			->prototype('scalar')->end()
77			->treatNullLike([])
78			->end()
79			->end();
80			}
81
82			/**
83			* @param ContainerBuilder $container
84			* @param array $sourceConfig
85			*/
86			private function updateJoseBundleConfigurationForEncrypter(ContainerBuilder $container, array $sourceConfig)
87			{
88			ConfigurationHelper::addEncrypter($container, 'id_token', $sourceConfig['key_encryption_algorithms'], $sourceConfig['content_encryption_algorithms'], ['DEF'], false, false);
89			}
90
91			/**
92			* @param ContainerBuilder $container
93			* @param array $sourceConfig
94			*/
95			private function updateJoseBundleConfigurationForDecrypter(ContainerBuilder $container, array $sourceConfig)
96			{
97			ConfigurationHelper::addDecrypter($container, 'id_token', $sourceConfig['key_encryption_algorithms'], $sourceConfig['content_encryption_algorithms'], ['DEF'], false);
98			}
99			}
100

OAuth2-Framework / oauth2-framework

Push — master ( 8e9cbc...6d4032 )

IdTokenEncryptionSource A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like