Surfnet\StepupGateway\SamlStepupProviderBundle\DependencyInjection\SurfnetStepupGatewaySamlStepupProviderExtension

Complexity

Total Complexity

10

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	createMetadataDefinition()	0	30	1
A	createHostedDefinitions()	0	20	1
A	buildHostedEntityDefinition()	0	25	1
A	createRouteConfig()	0	5	1
A	createRemoteDefinition()	0	12	1
A	load()	0	19	3
A	loadProviderConfiguration()	0	61	2

<?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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupGateway\SamlStepupProviderBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

/**

Missing short description in doc comment

 * @SuppressWarnings(PHPMD.LongClassName)
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class SurfnetStepupGatewaySamlStepupProviderExtension extends Extension
{
    const VIEW_CONFIG_TAG_NAME = 'gssp.view_config';

    /**

Parameter $configs should have a doc-comment as per coding-style.

Parameter $container should have a doc-comment as per coding-style.

     * {@inheritdoc}
     */

Missing @return tag in function comment

    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.yml');

        $connectedServiceProviders = $container->getDefinition('gssp.allowed_sps');
        $connectedServiceProviders->replaceArgument(0, $config['allowed_sps']);

        foreach ($config['providers'] as $provider => $providerConfiguration) {
            // may seem a bit strange, but this prevents casing issue when getting/setting/creating provider
            // service definitions etc.
            if ($provider !== strtolower($provider)) {
                throw new InvalidConfigurationException('The provider name must be completely lowercase');
            }

            $this->loadProviderConfiguration($provider, $providerConfiguration, $config['routes'], $container);
        }
    }

    private function loadProviderConfiguration(

Missing doc comment for function loadProviderConfiguration()

Private method name "SurfnetStepupGatewaySamlStepupProviderExtension::loadProviderConfiguration" must be prefixed with an underscore

        $provider,
        array $configuration,
        array $routes,
        ContainerBuilder $container
    ) {
        if ($container->has('gssp.provider.' . $provider)) {
            throw new InvalidConfigurationException(sprintf('Cannot create the same provider "%s" twice', $provider));
        }

        $this->createHostedDefinitions($provider, $configuration['hosted'], $routes, $container);
        $this->createMetadataDefinition($provider, $configuration['hosted'], $routes, $container);
        $this->createRemoteDefinition($provider, $configuration['remote'], $container);

        $stateHandlerDefinition = new Definition('Surfnet\StepupGateway\SamlStepupProviderBundle\Saml\StateHandler', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            new Reference('gssp.session'),
            $provider
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $container->setDefinition('gssp.provider.' . $provider . '.statehandler', $stateHandlerDefinition);

        $providerDefinition = new Definition('Surfnet\StepupGateway\SamlStepupProviderBundle\Provider\Provider', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            $provider,
            new Reference('gssp.provider.' . $provider . '.hosted.idp'),
            new Reference('gssp.provider.' . $provider . '.hosted.sp'),
            new Reference('gssp.provider.' . $provider . '.remote.idp'),
            new Reference('gssp.provider.' . $provider . '.statehandler')
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $providerDefinition->setPublic(false);
        $container->setDefinition('gssp.provider.' . $provider, $providerDefinition);

        $assertionSigningService = new Definition('Surfnet\StepupGateway\GatewayBundle\Saml\AssertionSigningService', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            new Reference('gssp.provider.' . $provider . '.hosted.idp')
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $assertionSigningService->setPublic('false');

'false' of type string is incompatible with the type boolean expected by parameter $boolean of Symfony\Component\DependencyInjection\Definition::setPublic().

        $container->setDefinition('gssp.provider.' . $provider . '.assertion_signing', $assertionSigningService);

        $proxyResponseFactory = new Definition(
            'Surfnet\StepupGateway\SamlStepupProviderBundle\Saml\ProxyResponseFactory',
            [
                new Reference('logger'),
                new Reference('gssp.provider.' . $provider . '.hosted.idp'),
                new Reference('gssp.provider.' . $provider . '.statehandler'),
                new Reference('gssp.provider.' . $provider . '.assertion_signing')
            ]
        );
        $proxyResponseFactory->setPublic(true);
        $container->setDefinition('gssp.provider.' . $provider . '.response_proxy', $proxyResponseFactory);

        $container
            ->getDefinition('gssp.provider_repository')
            ->addMethodCall('addProvider', [new Reference('gssp.provider.' . $provider)]);

        $viewConfigDefinition = new Definition('Surfnet\StepupGateway\SamlStepupProviderBundle\Provider\ViewConfig', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            new Reference('request_stack'),
            $configuration['view_config']['logo'],
            $configuration['view_config']['title'],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $viewConfigDefinition->addTag(self::VIEW_CONFIG_TAG_NAME);

        $container->setDefinition('gssp.view_config.' . $provider, $viewConfigDefinition);
    }

    /**

Missing short description in doc comment

     * @param string           $provider

Missing parameter comment

     * @param array            $configuration

Missing parameter comment

     * @param array            $routes

Missing parameter comment

     * @param ContainerBuilder $container

Missing parameter comment

     */

Missing @return tag in function comment

    private function createHostedDefinitions(

Private method name "SurfnetStepupGatewaySamlStepupProviderExtension::createHostedDefinitions" must be prefixed with an underscore

        $provider,
        array $configuration,
        array $routes,
        ContainerBuilder $container
    ) {
        $hostedDefinition = $this->buildHostedEntityDefinition($provider, $configuration, $routes);
        $container->setDefinition('gssp.provider.' . $provider . '.hosted_entities', $hostedDefinition);

        $hostedSpDefinition  = (new Definition())
            ->setClass('Surfnet\SamlBundle\Entity\ServiceProvider')
            ->setFactory([new Reference('gssp.provider.' . $provider . '.hosted_entities'), 'getServiceProvider'])
            ->setPublic(false);
        $container->setDefinition('gssp.provider.' . $provider . '.hosted.sp', $hostedSpDefinition);

        $hostedIdPDefinition = (new Definition())
            ->setClass('Surfnet\SamlBundle\Entity\IdentityProvider')
            ->setFactory([new Reference('gssp.provider.' . $provider . '.hosted_entities'), 'getIdentityProvider'])
            ->setPublic(false);
        $container->setDefinition('gssp.provider.' . $provider . '.hosted.idp', $hostedIdPDefinition);
    }

    /**

Missing short description in doc comment

     * @param string $provider

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $configuration

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array  $routes

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Definition

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    private function buildHostedEntityDefinition($provider, array $configuration, array $routes)

Private method name "SurfnetStepupGatewaySamlStepupProviderExtension::buildHostedEntityDefinition" must be prefixed with an underscore

    {
        $entityId = ['entity_id_route' => $this->createRouteConfig($provider, $routes['metadata'])];
        $spAdditional = [
            'enabled' => true,
            'assertion_consumer_route' => $this->createRouteConfig($provider, $routes['consume_assertion'])
        ];
        $idpAdditional = [
            'enabled' => true,
            'sso_route' => $this->createRouteConfig($provider, $routes['sso'])
        ];

        $serviceProvider  = array_merge($configuration['service_provider'], $spAdditional, $entityId);
        $identityProvider = array_merge($configuration['identity_provider'], $idpAdditional, $entityId);

        $hostedDefinition = new Definition('Surfnet\SamlBundle\Entity\HostedEntities', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            new Reference('router'),
            new Reference('request_stack'),
            $serviceProvider,
            $identityProvider
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $hostedDefinition->setPublic(false);

        return $hostedDefinition;
    }

    /**

Missing short description in doc comment

     * @param string           $provider

Missing parameter comment

     * @param array            $configuration

Missing parameter comment

     * @param ContainerBuilder $container

Missing parameter comment

     */

Missing @return tag in function comment

    private function createRemoteDefinition($provider, array $configuration, ContainerBuilder $container)

Private method name "SurfnetStepupGatewaySamlStepupProviderExtension::createRemoteDefinition" must be prefixed with an underscore

    {
        $definition    = new Definition('Surfnet\SamlBundle\Entity\IdentityProvider', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            [
                'entityId'        => $configuration['entity_id'],
                'ssoUrl'          => $configuration['sso_url'],
                'certificateData' => $configuration['certificate'],
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $definition->setPublic(false);
        $container->setDefinition('gssp.provider.' . $provider . '.remote.idp', $definition);
    }

    /**

Missing short description in doc comment

     * @param string           $provider

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array            $configuration

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array            $routes

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param ContainerBuilder $container

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Definition

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    private function createMetadataDefinition(

Private method name "SurfnetStepupGatewaySamlStepupProviderExtension::createMetadataDefinition" must be prefixed with an underscore

        $provider,
        array $configuration,
        array $routes,
        ContainerBuilder $container
    ) {
        $metadataConfiguration = new Definition('Surfnet\SamlBundle\Metadata\MetadataConfiguration');

        $propertyMap = [
            'entityIdRoute'          => $this->createRouteConfig($provider, $routes['metadata']),
            'isSp'                   => true,
            'assertionConsumerRoute' => $this->createRouteConfig($provider, $routes['consume_assertion']),
            'isIdP'                  => true,
            'ssoRoute'               => $this->createRouteConfig($provider, $routes['sso']),
            'publicKey'              => $configuration['metadata']['public_key'],
            'privateKey'             => $configuration['metadata']['private_key'],
        ];

        $metadataConfiguration->setProperties($propertyMap);
        $metadataConfiguration->setPublic(false);
        $container->setDefinition('gssp.provider.' . $provider . 'metadata.configuration', $metadataConfiguration);

        $metadataFactory = new Definition('Surfnet\SamlBundle\Metadata\MetadataFactory', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            new Reference('twig'),
            new Reference('router'),
            new Reference('surfnet_saml.signing_service'),
            new Reference('gssp.provider.' . $provider . 'metadata.configuration')
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $metadataFactory->setPublic(true);
        $container->setDefinition('gssp.provider.' . $provider . '.metadata.factory', $metadataFactory);
    }

    private function createRouteConfig($provider, $routeName)

Missing doc comment for function createRouteConfig()

Private method name "SurfnetStepupGatewaySamlStepupProviderExtension::createRouteConfig" must be prefixed with an underscore

    {
        return [
            'route'      => $routeName,
            'parameters' => ['provider' => $provider]
        ];
    }
}