SignedMetadataEndpointSource::prepend() - Code Metrics - Inspection of "Bundle updated (WIP)" - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — ng ( e90992...13fb6e )

by Florent

created 2018-01-31 21:37 UTC

SignedMetadataEndpointSource::prepend() A

↳ Parent: SignedMetadataEndpointSource

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

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

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

final class SignedMetadataEndpointSource implements Component

{
    /**
     * {@inheritdoc}
     */
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
    {
        $container->setParameter($path.'.algorithm', $config['algorithm']);
        //$container->setAlias($path.'.key_set', 'jose.key_set.signed_metadata_endpoint.key_set.signature');

    }

    /**
     * {@inheritdoc}
     */
    public function name(): string
    {
        return 'signature';
    }

    /**
     * {@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['algorithm']);
                })
                ->thenInvalid('The parameter "algorithm" must be set.')
            ->end()
            ->children()
                ->scalarNode('algorithm')
                    ->info('Signature algorithm used to sign the metadata.')
                ->end()
            ->end();
    }

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

        ConfigurationHelper::addJWSBuilder($container, 'metadata_signature', [$sourceConfig['algorithm']], false);

        Assertion::keyExists($bundleConfig['key_set'], 'signature', 'The signature key set must be enabled.');
        //ConfigurationHelper::addKeyset($container, 'signed_metadata_endpoint.key_set.signature', 'jwkset', ['value' => $bundleConfig['key_set']['signature']]);

    }
}


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\Endpoint;
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\DependencyInjection\ContainerBuilder;
20			use Symfony\Component\PropertyAccess\PropertyAccess;
21
22			final class SignedMetadataEndpointSource implements Component
			0 ignored issues – show Bug introduced 2018-01-31 21:55 UTC by Report Bug Copy Issue Report There is one abstract method `load` in this class; you could implement it, or declare this class as abstract. Loading history...
23			{
24			/**
25			* {@inheritdoc}
26			*/
27			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
28			{
29			$container->setParameter($path.'.algorithm', $config['algorithm']);
30			//$container->setAlias($path.'.key_set', 'jose.key_set.signed_metadata_endpoint.key_set.signature');
			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...
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			public function name(): string
37			{
38			return 'signature';
39			}
40
41			/**
42			* {@inheritdoc}
43			*/
44			public function getNodeDefinition(NodeDefinition $node)
45			{
46
47			$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...
48			->validate()
49			->ifTrue(function ($config) {
50			return true === $config['enabled'] && empty($config['algorithm']);
51			})
52			->thenInvalid('The parameter "algorithm" must be set.')
53			->end()
54			->children()
55			->scalarNode('algorithm')
56			->info('Signature algorithm used to sign the metadata.')
57			->end()
58			->end();
59			}
60
61			public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
62			{
63			parent::prepend($bundleConfig, $path, $container);
64			$currentPath = $path.'['.$this->name().']';
65			$accessor = PropertyAccess::createPropertyAccessor();
66			$sourceConfig = $accessor->getValue($bundleConfig, $currentPath);
67
68			ConfigurationHelper::addJWSBuilder($container, 'metadata_signature', [$sourceConfig['algorithm']], false);
69
70			Assertion::keyExists($bundleConfig['key_set'], 'signature', 'The signature key set must be enabled.');
71			//ConfigurationHelper::addKeyset($container, 'signed_metadata_endpoint.key_set.signature', 'jwkset', ['value' => $bundleConfig['key_set']['signature']]);
			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...
72			}
73			}
74

OAuth2-Framework / oauth2-framework

Push — ng ( e90992...13fb6e )

SignedMetadataEndpointSource::prepend() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like