Failed Conditions
Push — master ( fb61ce...b7d00b )
by Florent
04:04
created

AuthorizationEndpointRequestObjectSource::updateJoseBundleConfigurationForVerifier()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 2
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 Jose\Bundle\JoseFramework\Helper\ConfigurationHelper;
17
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
18
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
19
use Symfony\Component\DependencyInjection\ContainerBuilder;
20
use Symfony\Component\PropertyAccess\PropertyAccess;
21
22
final class AuthorizationEndpointRequestObjectSource extends ActionableSource
23
{
24
    /**
25
     * AuthorizationEndpointRequestObjectSource constructor.
26
     */
27
    public function __construct()
28
    {
29
        $this->addSubSource(new AuthorizationEndpointRequestObjectReferenceSource());
30
        $this->addSubSource(new AuthorizationEndpointRequestObjectEncryptionSource());
31
    }
32
33
    /**
34
     * {@inheritdoc}
35
     */
36
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
37
    {
38
        foreach ($config as $k => $v) {
39
            $container->setParameter($path.'.'.$k, $v);
40
        }
41
    }
42
43
    /**
44
     * {@inheritdoc}
45
     */
46
    protected function name(): string
47
    {
48
        return 'request_object';
49
    }
50
51
    /**
52
     * {@inheritdoc}
53
     */
54
    protected function continueConfiguration(NodeDefinition $node)
55
    {
56
        parent::continueConfiguration($node);
57
        $node
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
58
            ->children()
59
                ->arrayNode('signature_algorithms')
60
                    ->info('Supported signature algorithms.')
61
                    ->useAttributeAsKey('name')
62
                    ->prototype('scalar')->end()
63
                    ->treatNullLike([])
64
                ->end()
65
            ->end();
66
    }
67
68
    /**
69
     * {@inheritdoc}
70
     */
71
    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
72
    {
73
        parent::prepend($bundleConfig, $path, $container);
74
        $currentPath = $path.'['.$this->name().']';
75
        $accessor = PropertyAccess::createPropertyAccessor();
76
        $sourceConfig = $accessor->getValue($bundleConfig, $currentPath);
77
        if (true === $sourceConfig['enabled']) {
78
            $claim_checkers = ['exp', 'iat', 'nbf'/*'authorization_endpoint_aud'*/]; // FIXME
79
            $header_checkers = ['crit']; // FIXME
0 ignored issues
show
Unused Code introduced by
$header_checkers is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
80
            ConfigurationHelper::addJWSLoader($container, $this->name(), $sourceConfig['signature_algorithms'], [], ['jws_compact'], false);
81
            ConfigurationHelper::addClaimChecker($container, $this->name(), $claim_checkers, false);
82
            if (true === $sourceConfig['encryption']['enabled']) {
83
                ConfigurationHelper::addJWELoader($container, $this->name(), $sourceConfig['encryption']['key_encryption_algorithms'], $sourceConfig['encryption']['content_encryption_algorithms'], ['DEF'], [], ['jwe_compact'], false);
84
            }
85
        }
86
    }
87
}
88