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

AuthorizationEndpointRequestObjectEncryptionSource   A

Complexity

Total Complexity 4

Size/Duplication

Total Lines 51
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 0
Metric Value
wmc 4
lcom 0
cbo 2
dl 0
loc 51
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A continueLoading() 0 7 2
A name() 0 4 1
B continueConfiguration() 0 26 1
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 Symfony\Component\Config\Definition\Builder\NodeDefinition;
18
use Symfony\Component\DependencyInjection\ContainerBuilder;
19
20
final class AuthorizationEndpointRequestObjectEncryptionSource extends ActionableSource
21
{
22
    /**
23
     * {@inheritdoc}
24
     */
25
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
26
    {
27
        foreach (['required', 'key_encryption_algorithms', 'content_encryption_algorithms'] as $k) {
28
            $container->setParameter($path.'.'.$k, $config[$k]);
29
        }
30
        $container->setAlias($path.'.key_set', $config['key_set']);
31
    }
32
33
    /**
34
     * {@inheritdoc}
35
     */
36
    protected function name(): string
37
    {
38
        return 'encryption';
39
    }
40
41
    /**
42
     * {@inheritdoc}
43
     */
44
    protected function continueConfiguration(NodeDefinition $node)
45
    {
46
        parent::continueConfiguration($node);
47
        $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...
48
            ->children()
49
                ->scalarNode('key_set')
50
                    ->info('Key set for the encryption support.')
51
                ->end()
52
                ->booleanNode('required')
53
                    ->info('If true, incoming request objects must be encrypted.')
54
                    ->defaultFalse()
55
                ->end()
56
                ->arrayNode('key_encryption_algorithms')
57
                    ->info('Supported key encryption algorithms.')
58
                    ->useAttributeAsKey('name')
59
                    ->prototype('scalar')->end()
60
                    ->treatNullLike([])
61
                ->end()
62
                ->arrayNode('content_encryption_algorithms')
63
                    ->info('Supported content encryption algorithms.')
64
                    ->useAttributeAsKey('name')
65
                    ->prototype('scalar')->end()
66
                    ->treatNullLike([])
67
                ->end()
68
            ->end();
69
    }
70
}
71