Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "Refined firewall with explicit session timeout and..." - OpenConext/Stepup-SelfService - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#110)

by Daan van

created 2016-08-10 15:18 UTC

Configuration::getConfigTreeBuilder() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	11
rs	9.4285
cc	1
eloc	7
nc	1
nop	0

<?php

/**
 * Copyright 2015 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupSelfService\SelfServiceBundle\DependencyInjection;

use Surfnet\StepupBundle\Exception\DomainException;
use Surfnet\StepupBundle\Exception\InvalidArgumentException;
use Surfnet\StepupBundle\Value\SecondFactorType;
use Symfony\Component\Config\Definition\Builder\NodeBuilder;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('surfnet_stepup_self_service_self_service');

        $childNodes = $rootNode->children();
        $this->appendEnabledSecondFactorTypesConfiguration($childNodes);
        $this->appendSessionConfiguration($childNodes);

        return $treeBuilder;
    }

    /**
     * @param NodeBuilder $childNodes
     */
    private function appendSessionConfiguration(NodeBuilder $childNodes)
    {
        $childNodes
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.
    }
}
            ->arrayNode('session_lifetimes')
                ->isRequired()
                ->children()
                    ->integerNode('max_absolute_lifetime')
                        ->isRequired()
                        ->defaultValue(3600)
                        ->info('The maximum lifetime of a session regardless of interaction by the user, in seconds.')
                        ->example('3600 -> 1 hour * 60 minutes * 60 seconds')
                        ->validate()
                            ->ifTrue(
                                function ($lifetime) {
                                    return !is_int($lifetime);
                                }
                            )
                            ->thenInvalid('max_absolute_lifetime must be an integer')
                        ->end()
                    ->end()
                    ->integerNode('max_relative_lifetime')
                        ->isRequired()
                        ->defaultValue(600)
                        ->info(
                            'The maximum relative lifetime of a session; the maximum allowed time between two '
                            . 'interactions by the user'
                        )
                        ->example('600 -> 10 minutes * 60 seconds')
                        ->validate()
                            ->ifTrue(
                                function ($lifetime) {
                                    return !is_int($lifetime);
                                }
                            )
                            ->thenInvalid('max_relative_lifetime must be an integer')
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    /**
     * @param NodeBuilder $childNodes
     */
    private function appendEnabledSecondFactorTypesConfiguration(NodeBuilder $childNodes)
    {
        $childNodes
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.
    }
}
            ->arrayNode('enabled_second_factors')
                ->isRequired()
                ->prototype('scalar')
                    ->validate()
                        ->ifTrue(
                            function ($type) {
                                try {
                                    new SecondFactorType($type);
                                } catch (InvalidArgumentException $e) {
                                    return true;
                                } catch (DomainException $e) {
                                    return true;
                                }
                            }
                        )
                        ->thenInvalid(
                            'Enabled second factor type "%s" is not one of the valid types. See SecondFactorType'
                        )
                    ->end()
                ->end()
            ->end();
    }
}


Pull Request — develop (#110)

Configuration::getConfigTreeBuilder() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* Copyright 2015 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupSelfService\SelfServiceBundle\DependencyInjection;
20
21			use Surfnet\StepupBundle\Exception\DomainException;
22			use Surfnet\StepupBundle\Exception\InvalidArgumentException;
23			use Surfnet\StepupBundle\Value\SecondFactorType;
24			use Symfony\Component\Config\Definition\Builder\NodeBuilder;
25			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
26			use Symfony\Component\Config\Definition\ConfigurationInterface;
27
28			class Configuration implements ConfigurationInterface
29			{
30			public function getConfigTreeBuilder()
31			{
32			$treeBuilder = new TreeBuilder();
33			$rootNode = $treeBuilder->root('surfnet_stepup_self_service_self_service');
34
35			$childNodes = $rootNode->children();
36			$this->appendEnabledSecondFactorTypesConfiguration($childNodes);
37			$this->appendSessionConfiguration($childNodes);
38
39			return $treeBuilder;
40			}
41
42			/**
43			* @param NodeBuilder $childNodes
44			*/
45			private function appendSessionConfiguration(NodeBuilder $childNodes)
46			{
47			$childNodes
			0 ignored issues – show Bug introduced 2016-08-10 15:13 UTC by Report Bug Copy Issue Report 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. 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			->arrayNode('session_lifetimes')
49			->isRequired()
50			->children()
51			->integerNode('max_absolute_lifetime')
52			->isRequired()
53			->defaultValue(3600)
54			->info('The maximum lifetime of a session regardless of interaction by the user, in seconds.')
55			->example('3600 -> 1 hour * 60 minutes * 60 seconds')
56			->validate()
57			->ifTrue(
58			function ($lifetime) {
59			return !is_int($lifetime);
60			}
61			)
62			->thenInvalid('max_absolute_lifetime must be an integer')
63			->end()
64			->end()
65			->integerNode('max_relative_lifetime')
66			->isRequired()
67			->defaultValue(600)
68			->info(
69			'The maximum relative lifetime of a session; the maximum allowed time between two '
70			. 'interactions by the user'
71			)
72			->example('600 -> 10 minutes * 60 seconds')
73			->validate()
74			->ifTrue(
75			function ($lifetime) {
76			return !is_int($lifetime);
77			}
78			)
79			->thenInvalid('max_relative_lifetime must be an integer')
80			->end()
81			->end()
82			->end()
83			->end();
84			}
85
86			/**
87			* @param NodeBuilder $childNodes
88			*/
89			private function appendEnabledSecondFactorTypesConfiguration(NodeBuilder $childNodes)
90			{
91			$childNodes
			0 ignored issues – show Bug introduced 2016-08-10 15:13 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `prototype()` 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
92			->arrayNode('enabled_second_factors')
93			->isRequired()
94			->prototype('scalar')
95			->validate()
96			->ifTrue(
97			function ($type) {
98			try {
99			new SecondFactorType($type);
100			} catch (InvalidArgumentException $e) {
101			return true;
102			} catch (DomainException $e) {
103			return true;
104			}
105			}
106			)
107			->thenInvalid(
108			'Enabled second factor type "%s" is not one of the valid types. See SecondFactorType'
109			)
110			->end()
111			->end()
112			->end();
113			}
114			}
115

OpenConext / Stepup-SelfService

Pull Request — develop (#110)

Configuration::getConfigTreeBuilder() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like