Configuration::appendSessionConfiguration() - Code Metrics - Inspection of "Add translations for explicit session timeouts" - OpenConext/Stepup-RA - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/explicit-session-timeo... ( 219fd8 )

by A.

created 2016-08-12 12:03 UTC

Configuration::appendSessionConfiguration() B

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	40
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	40
rs	8.8571
cc	1
eloc	33
nc	1
nop	1

<?php

/**
 * Copyright 2014 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\StepupRa\RaBundle\DependencyInjection;

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

class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('surfnet_stepup_ra_ra');

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


        return $treeBuilder;
    }

    private function appendLoaConfiguration(NodeBuilder $childNodes)
    {
        $childNodes
            ->scalarNode('required_loa')
                ->info('The required LOA to be able to log in, should match the loa defined at the gateway')
                ->isRequired()
                    ->validate()
                        ->ifTrue(function ($value) {
                            return !is_string($value);
                        })
                        ->thenInvalid('the required loa must be a string')
                    ->end()
            ->end();
    }

    /**
     * @param NodeBuilder $childNodes
     */
    private function appendSecondFactorTypesConfiguration(NodeBuilder $childNodes)
    {
        $childNodes

            ->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()
        ->end();
    }

    /**
     * @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();
    }
}


1			<?php
2
3			/**
4			* Copyright 2014 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\StepupRa\RaBundle\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\ArrayNodeDefinition;
25			use Symfony\Component\Config\Definition\Builder\NodeBuilder;
26			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
27			use Symfony\Component\Config\Definition\ConfigurationInterface;
28
29			class Configuration implements ConfigurationInterface
30			{
31			/**
32			* {@inheritdoc}
33			*/
34			public function getConfigTreeBuilder()
35			{
36			$treeBuilder = new TreeBuilder();
37			$rootNode = $treeBuilder->root('surfnet_stepup_ra_ra');
38
39			$childNodes = $rootNode->children();
40			$this->appendLoaConfiguration($childNodes);
41			$this->appendSecondFactorTypesConfiguration($childNodes);
42			$this->appendSessionConfiguration($childNodes);
43
44
45			return $treeBuilder;
46			}
47
48			private function appendLoaConfiguration(NodeBuilder $childNodes)
49			{
50			$childNodes
51			->scalarNode('required_loa')
52			->info('The required LOA to be able to log in, should match the loa defined at the gateway')
53			->isRequired()
54			->validate()
55			->ifTrue(function ($value) {
56			return !is_string($value);
57			})
58			->thenInvalid('the required loa must be a string')
59			->end()
60			->end();
61			}
62
63			/**
64			* @param NodeBuilder $childNodes
65			*/
66			private function appendSecondFactorTypesConfiguration(NodeBuilder $childNodes)
67			{
68			$childNodes
69
70			->arrayNode('enabled_second_factors')
71			->isRequired()
72			->prototype('scalar')
73			->validate()
74			->ifTrue(
75			function ($type) {
76			try {
77			new SecondFactorType($type);
78			} catch (InvalidArgumentException $e) {
79			return true;
80			} catch (DomainException $e) {
81			return true;
82			}
83			}
84			)
85			->thenInvalid(
86			'Enabled second factor type "%s" is not one of the valid types. See SecondFactorType'
87			)
88			->end()
89			->end()
90			->end()
91			->end();
92			}
93
94			/**
95			* @param NodeBuilder $childNodes
96			*/
97			private function appendSessionConfiguration(NodeBuilder $childNodes)
98			{
99			$childNodes
			0 ignored issues – show Bug introduced 2016-08-12 12:07 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...
100			->arrayNode('session_lifetimes')
101			->isRequired()
102			->children()
103			->integerNode('max_absolute_lifetime')
104			->isRequired()
105			->defaultValue(3600)
106			->info('The maximum lifetime of a session regardless of interaction by the user, in seconds.')
107			->example('3600 -> 1 hour * 60 minutes * 60 seconds')
108			->validate()
109			->ifTrue(
110			function ($lifetime) {
111			return !is_int($lifetime);
112			}
113			)
114			->thenInvalid('max_absolute_lifetime must be an integer')
115			->end()
116			->end()
117			->integerNode('max_relative_lifetime')
118			->isRequired()
119			->defaultValue(600)
120			->info(
121			'The maximum relative lifetime of a session; the maximum allowed time between two '
122			. 'interactions by the user'
123			)
124			->example('600 -> 10 minutes * 60 seconds')
125			->validate()
126			->ifTrue(
127			function ($lifetime) {
128			return !is_int($lifetime);
129			}
130			)
131			->thenInvalid('max_relative_lifetime must be an integer')
132			->end()
133			->end()
134			->end()
135			->end();
136			}
137			}
138

OpenConext / Stepup-RA

Push — feature/explicit-session-timeo... ( 219fd8 )

Configuration::appendSessionConfiguration() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like