Failed Conditions
Push — master ( d9377e...587e80 )
by Florent
02:05
created

JWKSetSource::name()   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 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 Jose\Bundle\KeyManagement\DependencyInjection\Source;
15
16
use Jose\Bundle\JoseFramework\DependencyInjection\Source\SourceInterface;
17
use Jose\Bundle\KeyManagement\DependencyInjection\Source\JWKSetSource\JWKSetSourceInterface;
18
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
19
use Symfony\Component\Config\FileLocator;
20
use Symfony\Component\DependencyInjection\ContainerBuilder;
21
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
22
23
/**
24
 * Class JWKSetSource.
25
 */
26
final class JWKSetSource implements SourceInterface
27
{
28
    /**
29
     * @var null|JWKSetSourceInterface[]
30
     */
31
    private $jwkset_sources = null;
32
33
    /**
34
     * {@inheritdoc}
35
     */
36
    public function name(): string
37
    {
38
        return 'key_sets';
39
    }
40
41
    /**
42
     * {@inheritdoc}
43
     */
44
    public function createService(array $config, ContainerBuilder $container)
45
    {
46
        $sources = $this->getJWKSetSources();
47
48
        foreach ($config as $name => $itemConfig) {
49
            foreach ($itemConfig as $sourceName => $sourceConfig) {
50
                if (array_key_exists($sourceName, $sources)) {
51
                    $source = $sources[$sourceName];
52
                    $source->create($container, 'key_set', $sourceName, $sourceConfig);
53
                } else {
54
                    throw new \LogicException(sprintf('The JWKSet definition "%s" is not configured.', $name));
55
                }
56
            }
57
        }
58
    }
59
60
    /**
61
     * {@inheritdoc}
62
     */
63
    public function getNodeDefinition(ArrayNodeDefinition $node)
64
    {
65
        $sourceNodeBuilder = $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 performNoDeepMerging() 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...
66
            ->children()
67
                ->arrayNode('key_sets')
68
                    ->useAttributeAsKey('name')
69
                    ->prototype('array')
70
                        ->performNoDeepMerging()
71
                        ->children();
72
        foreach ($this->getJWKSetSources() as $name => $source) {
73
            $sourceNode = $sourceNodeBuilder->arrayNode($name)->canBeUnset();
74
            $source->addConfiguration($sourceNode);
75
        }
76
    }
77
78
    /**
79
     * {@inheritdoc}
80
     */
81
    public function prepend(ContainerBuilder $container, array $config): ?array
82
    {
83
        return null;
84
    }
85
86
    /**
87
     * @return JWKSetSourceInterface[]
88
     */
89
    private function getJWKSetSources(): array
90
    {
91
        if (null !== $this->jwkset_sources) {
92
            return $this->jwkset_sources;
93
        }
94
95
        // load bundled adapter factories
96
        $tempContainer = new ContainerBuilder();
97
        $loader = new YamlFileLoader($tempContainer, new FileLocator(__DIR__.'/../../Resources/config'));
98
        $loader->load('jwkset_sources.yml');
99
100
        $services = $tempContainer->findTaggedServiceIds('jose.jwkset_source');
101
        $jwkset_sources = [];
102
        foreach (array_keys($services) as $id) {
103
            $factory = $tempContainer->get($id);
104
            $jwkset_sources[str_replace('-', '_', $factory->getKeySet())] = $factory;
105
        }
106
107
        return $this->jwkset_sources = $jwkset_sources;
108
    }
109
}
110