Failed Conditions
Push — ng ( e90992...13fb6e )
by Florent
17:32
created

JwtBearerSource   A

Complexity

Total Complexity 11

Size/Duplication

Total Lines 103
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 8

Importance

Changes 0
Metric Value
wmc 11
lcom 1
cbo 8
dl 0
loc 103
rs 10
c 0
b 0
f 0

7 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A continueLoading() 0 9 2
A name() 0 4 1
B getNodeDefinition() 0 34 2
A prepend() 0 12 2
A updateJoseBundleConfigurationForVerifier() 0 5 1
A updateJoseBundleConfigurationForDecrypter() 0 6 2
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\Grant;
15
16
use Fluent\PhpConfigFileLoader;
17
use Jose\Bundle\JoseFramework\Helper\ConfigurationHelper;
18
use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
19
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
20
use Symfony\Component\Config\FileLocator;
21
use Symfony\Component\DependencyInjection\ContainerBuilder;
22
use Symfony\Component\PropertyAccess\PropertyAccess;
23
24
final class JwtBearerSource implements Component
0 ignored issues
show
Bug introduced by
There is one abstract method load in this class; you could implement it, or declare this class as abstract.
Loading history...
25
{
26
    /**
27
     * JwtBearerSource constructor.
28
     */
29
    public function __construct()
30
    {
31
        $this->addSubSource(new JwtBearerEncryptionSource());
0 ignored issues
show
Bug introduced by
The method addSubSource() does not seem to exist on object<OAuth2Framework\B...\Grant\JwtBearerSource>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
32
    }
33
34
    /**
35
     * {@inheritdoc}
36
     */
37
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
38
    {
39
        foreach ($config as $k => $v) {
40
            $container->setParameter($path.'.'.$k, $config[$k]);
41
        }
42
43
        $loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/grant'));
44
        $loader->load('jwt_bearer.php');
45
    }
46
47
    /**
48
     * {@inheritdoc}
49
     */
50
    public function name(): string
51
    {
52
        return 'jwt_bearer';
53
    }
54
55
    public function getNodeDefinition(NodeDefinition $node)
56
    {
57
58
        $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...
59
            ->validate()
60
                ->ifTrue(function ($config) {
61
                    return true === $config['enabled'] && empty($config['signature_algorithms']);
62
                })
63
                ->thenInvalid('The option "signature_algorithms" must contain at least one signature algorithm.')
64
            ->end()
65
            ->children()
66
                ->booleanNode('issue_refresh_token')
67
                    ->info('If true, a refresh token will be issued with the access token (the refresh token grant type must be enabled).')
68
                ->end()
69
                ->arrayNode('signature_algorithms')
70
                    ->info('Signature algorithms supported by this grant type.')
71
                    ->useAttributeAsKey('name')
72
                    ->prototype('scalar')->end()
73
                    ->treatNullLike([])
74
                ->end()
75
                ->arrayNode('claim_checkers')
76
                    ->info('Checkers will verify the JWT claims.')
77
                    ->useAttributeAsKey('name')
78
                    ->prototype('scalar')->end()
79
                    ->treatNullLike(['exp', 'iat', 'nbf'])
80
                ->end()
81
                ->arrayNode('header_checkers')
82
                    ->info('Checkers will verify the JWT headers.')
83
                    ->useAttributeAsKey('name')
84
                    ->prototype('scalar')->end()
85
                    ->treatNullLike(['crit'])
86
                ->end()
87
            ->end();
88
    }
89
90
    /**
91
     * {@inheritdoc}
92
     */
93
    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
94
    {
95
        parent::prepend($bundleConfig, $path, $container);
96
        $currentPath = $path.'['.$this->name().']';
97
        $accessor = PropertyAccess::createPropertyAccessor();
98
        $sourceConfig = $accessor->getValue($bundleConfig, $currentPath);
99
100
        if (true === $sourceConfig['enabled']) {
101
            $this->updateJoseBundleConfigurationForVerifier($container, $sourceConfig);
102
            $this->updateJoseBundleConfigurationForDecrypter($container, $sourceConfig);
103
        }
104
    }
105
106
    /**
107
     * @param ContainerBuilder $container
108
     * @param array            $sourceConfig
109
     */
110
    private function updateJoseBundleConfigurationForVerifier(ContainerBuilder $container, array $sourceConfig)
111
    {
112
        ConfigurationHelper::addJWSLoader($container, $this->name(), $sourceConfig['signature_algorithms'], [], ['jws_compact'], false);
0 ignored issues
show
Bug introduced by
The method addJWSLoader() does not seem to exist on object<Jose\Bundle\JoseF...er\ConfigurationHelper>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
113
        ConfigurationHelper::addClaimChecker($container, $this->name(), [], false);
114
    }
115
116
    /**
117
     * @param ContainerBuilder $container
118
     * @param array            $sourceConfig
119
     */
120
    private function updateJoseBundleConfigurationForDecrypter(ContainerBuilder $container, array $sourceConfig)
121
    {
122
        if (true === $sourceConfig['encryption']['enabled']) {
123
            ConfigurationHelper::addJWELoader($container, $this->name(), $sourceConfig['encryption']['key_encryption_algorithms'], $sourceConfig['encryption']['content_encryption_algorithms'], ['DEF'], [], ['jwe_compact'], false);
0 ignored issues
show
Bug introduced by
The method addJWELoader() does not seem to exist on object<Jose\Bundle\JoseF...er\ConfigurationHelper>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
124
        }
125
    }
126
}
127