Failed Conditions
Push — master ( a4b7bc...6567cc )
by Florent
22:33 queued 29s
created

__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 5
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 0
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 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 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'];
80
            $this->updateJoseBundleConfigurationForVerifier($container, ['signature_algorithms' => $sourceConfig['signature_algorithms']]);
81
            $this->updateJoseBundleConfigurationForChecker($container, ['header_checkers' => $header_checkers, 'claim_checkers' => $claim_checkers]);
82
            $this->updateJoseBundleConfigurationForDecrypter($container, $sourceConfig);
83
            $this->updateJoseBundleConfigurationForJWTLoader($container, $sourceConfig);
84
        }
85
    }
86
87
    /**
88
     * @param ContainerBuilder $container
89
     * @param array            $sourceConfig
90
     */
91
    private function updateJoseBundleConfigurationForDecrypter(ContainerBuilder $container, array $sourceConfig)
92
    {
93
        if (true === $sourceConfig['encryption']['enabled']) {
94
            ConfigurationHelper::addDecrypter($container, $this->name(), $sourceConfig['encryption']['key_encryption_algorithms'], $sourceConfig['encryption']['content_encryption_algorithms'], ['DEF'], false);
95
        }
96
    }
97
98
    /**
99
     * @param ContainerBuilder $container
100
     * @param array            $sourceConfig
101
     */
102
    private function updateJoseBundleConfigurationForVerifier(ContainerBuilder $container, array $sourceConfig)
103
    {
104
        ConfigurationHelper::addVerifier($container, $this->name(), $sourceConfig['signature_algorithms'], false);
105
    }
106
107
    /**
108
     * @param ContainerBuilder $container
109
     * @param array            $sourceConfig
110
     */
111
    private function updateJoseBundleConfigurationForChecker(ContainerBuilder $container, array $sourceConfig)
112
    {
113
        ConfigurationHelper::addChecker($container, $this->name(), $sourceConfig['header_checkers'], $sourceConfig['claim_checkers'], false);
114
    }
115
116
    /**
117
     * @param ContainerBuilder $container
118
     * @param array            $sourceConfig
119
     */
120
    private function updateJoseBundleConfigurationForJWTLoader(ContainerBuilder $container, array $sourceConfig)
121
    {
122
        $decrypter = null;
123
        if (true === $sourceConfig['encryption']['enabled']) {
124
            $decrypter = sprintf('jose.decrypter.%s', $this->name());
125
        }
126
        ConfigurationHelper::addJWTLoader($container, $this->name(), sprintf('jose.verifier.%s', $this->name()), sprintf('jose.checker.%s', $this->name()), $decrypter, false);
127
    }
128
}
129