AbstractBootstrapCommand::vetSecondFactor() - Code Metrics - Inspection of "Add input validation for registration-status arg" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/improve-input-validati... ( 8f7b6e )

by Michiel

created 2020-04-21 14:36 UTC

AbstractBootstrapCommand::vetSecondFactor() A

↳ Parent: AbstractBootstrapCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	1
nc	1
nop	6

<?php

/**
 * Copyright 2020 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\StepupMiddleware\MiddlewareBundle\Console\Command;

use Broadway\EventHandling\EventBusInterface;
use Rhumsaa\Uuid\Uuid;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command as MiddlewareCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Metadata;
use Surfnet\StepupMiddleware\CommandHandlingBundle\EventSourcing\MetadataEnricher;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\VerifyEmailCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\VetSecondFactorCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
use Surfnet\StepupMiddleware\MiddlewareBundle\Exception\InvalidArgumentException;
use Surfnet\StepupMiddleware\MiddlewareBundle\Service\DBALConnectionHelper;
use Surfnet\StepupMiddleware\MiddlewareBundle\Service\TokenBootstrapService;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;

abstract class AbstractBootstrapCommand extends Command
{
    /** @var Pipeline  */
    private $pipeline;
    /** @var EventBusInterface  */
    private $eventBus;
    /** @var DBALConnectionHelper  */
    private $connection;
    /** @var TokenStorageInterface */
    protected $tokenStorage;
    /** @var MetadataEnricher */
    private $enricher;
    /** @var TokenBootstrapService */
    protected $tokenBootstrapService;

    private $validRegistrationStatuses = ['unverified', 'verified', 'vetted'];

    public function __construct(
        Pipeline $pipeline,
        EventBusInterface $eventBus,
        DBALConnectionHelper $connection,
        MetadataEnricher $enricher,
        TokenStorageInterface $tokenStorage,
        TokenBootstrapService $tokenBootstrapService
    ) {
        $this->pipeline = $pipeline;
        $this->eventBus = $eventBus;
        $this->connection = $connection;
        $this->enricher = $enricher;
        $this->tokenStorage = $tokenStorage;
        $this->tokenBootstrapService = $tokenBootstrapService;
        parent::__construct();
    }

    protected function beginTransaction()
    {
        $this->connection->beginTransaction();
    }

    protected function finishTransaction()
    {
        $this->eventBus->flush();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
        $this->connection->commit();
    }

    protected function rollback()
    {
        $this->connection->rollBack();
    }

    protected function process(MiddlewareCommand $command)
    {
        $this->pipeline->process($command);
    }

    /**
     * @param string $registrationStatus
     * @return bool

     */
    protected function validRegistrationStatus($registrationStatus)
    {
        if (!in_array($registrationStatus, $this->validRegistrationStatuses)){
            throw new InvalidArgumentException(
                sprintf(
                    'Invalid argument provided for the "registration-status" argument. One of: %s is expected. Received: "%s"',
                    implode(', ', $this->validRegistrationStatuses),
                    $registrationStatus
                )
            );
        }
    }

    protected function requiresMailVerification($institution)
    {
        $configuration = $this->tokenBootstrapService->findConfigurationOptionsFor($institution);
        if ($configuration) {
            return $configuration->verifyEmailOption->isEnabled();
        }
        return true;
    }

    protected function vetSecondFactor($tokenType, $actorId, $identity, $secondFactorId, $verifiedSecondFactor, $phoneNumber)
    {
        $command = new VetSecondFactorCommand();
        $command->UUID = (string) Uuid::uuid4();
        $command->authorityId = $actorId;
        $command->identityId = $identity->id;
        $command->secondFactorId = $secondFactorId;
        $command->registrationCode = $verifiedSecondFactor->registrationCode;
        $command->secondFactorType = $tokenType;
        $command->secondFactorIdentifier = $phoneNumber;
        $command->documentNumber = '123987';
        $command->identityVerified = true;
        $this->pipeline->process($command);
    }

    protected function enrichEventMetadata($actorId)
    {
        $actor = $this->tokenBootstrapService->findIdentityById($actorId);
        $metadata = new Metadata();
        $metadata->actorId = $actor->id;
        $metadata->actorInstitution = $actor->institution;
        $this->enricher->setMetadata($metadata);
    }

    protected function verifyEmail($identity, $unverifiedSecondFactor)
    {
        $command = new VerifyEmailCommand();
        $command->UUID = (string)Uuid::uuid4();
        $command->identityId = $identity->id;
        $command->verificationNonce = $unverifiedSecondFactor->verificationNonce;
        $this->process($command);
    }
}


1			<?php
2
3			/**
4			* Copyright 2020 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\StepupMiddleware\MiddlewareBundle\Console\Command;
20
21			use Broadway\EventHandling\EventBusInterface;
22			use Rhumsaa\Uuid\Uuid;
23			use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command as MiddlewareCommand;
24			use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Metadata;
25			use Surfnet\StepupMiddleware\CommandHandlingBundle\EventSourcing\MetadataEnricher;
26			use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\VerifyEmailCommand;
27			use Surfnet\StepupMiddleware\CommandHandlingBundle\Identity\Command\VetSecondFactorCommand;
28			use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
29			use Surfnet\StepupMiddleware\MiddlewareBundle\Exception\InvalidArgumentException;
30			use Surfnet\StepupMiddleware\MiddlewareBundle\Service\DBALConnectionHelper;
31			use Surfnet\StepupMiddleware\MiddlewareBundle\Service\TokenBootstrapService;
32			use Symfony\Component\Console\Command\Command;
33			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
34
35			abstract class AbstractBootstrapCommand extends Command
36			{
37			/** @var Pipeline */
38			private $pipeline;
39			/** @var EventBusInterface */
40			private $eventBus;
41			/** @var DBALConnectionHelper */
42			private $connection;
43			/** @var TokenStorageInterface */
44			protected $tokenStorage;
45			/** @var MetadataEnricher */
46			private $enricher;
47			/** @var TokenBootstrapService */
48			protected $tokenBootstrapService;
49
50			private $validRegistrationStatuses = ['unverified', 'verified', 'vetted'];
51
52			public function __construct(
53			Pipeline $pipeline,
54			EventBusInterface $eventBus,
55			DBALConnectionHelper $connection,
56			MetadataEnricher $enricher,
57			TokenStorageInterface $tokenStorage,
58			TokenBootstrapService $tokenBootstrapService
59			) {
60			$this->pipeline = $pipeline;
61			$this->eventBus = $eventBus;
62			$this->connection = $connection;
63			$this->enricher = $enricher;
64			$this->tokenStorage = $tokenStorage;
65			$this->tokenBootstrapService = $tokenBootstrapService;
66			parent::__construct();
67			}
68
69			protected function beginTransaction()
70			{
71			$this->connection->beginTransaction();
72			}
73
74			protected function finishTransaction()
75			{
76			$this->eventBus->flush();
			0 ignored issues – show Bug introduced 2020-04-20 06:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Broadway\EventHandling\EventBusInterface` as the method `flush()` does only exist in the following implementations of said interface: `Surfnet\StepupMiddleware...ndling\BufferedEventBus`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
77			$this->connection->commit();
78			}
79
80			protected function rollback()
81			{
82			$this->connection->rollBack();
83			}
84
85			protected function process(MiddlewareCommand $command)
86			{
87			$this->pipeline->process($command);
88			}
89
90			/**
91			* @param string $registrationStatus
92			* @return bool
			0 ignored issues – show Documentation introduced 2020-04-21 14:38 UTC by Report Bug Copy Issue Report Should the return type not be `boolean\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
93			*/
94			protected function validRegistrationStatus($registrationStatus)
95			{
96			if (!in_array($registrationStatus, $this->validRegistrationStatuses)){
97			throw new InvalidArgumentException(
98			sprintf(
99			'Invalid argument provided for the "registration-status" argument. One of: %s is expected. Received: "%s"',
100			implode(', ', $this->validRegistrationStatuses),
101			$registrationStatus
102			)
103			);
104			}
105			}
106
107			protected function requiresMailVerification($institution)
108			{
109			$configuration = $this->tokenBootstrapService->findConfigurationOptionsFor($institution);
110			if ($configuration) {
111			return $configuration->verifyEmailOption->isEnabled();
112			}
113			return true;
114			}
115
116			protected function vetSecondFactor($tokenType, $actorId, $identity, $secondFactorId, $verifiedSecondFactor, $phoneNumber)
117			{
118			$command = new VetSecondFactorCommand();
119			$command->UUID = (string) Uuid::uuid4();
120			$command->authorityId = $actorId;
121			$command->identityId = $identity->id;
122			$command->secondFactorId = $secondFactorId;
123			$command->registrationCode = $verifiedSecondFactor->registrationCode;
124			$command->secondFactorType = $tokenType;
125			$command->secondFactorIdentifier = $phoneNumber;
126			$command->documentNumber = '123987';
127			$command->identityVerified = true;
128			$this->pipeline->process($command);
129			}
130
131			protected function enrichEventMetadata($actorId)
132			{
133			$actor = $this->tokenBootstrapService->findIdentityById($actorId);
134			$metadata = new Metadata();
135			$metadata->actorId = $actor->id;
136			$metadata->actorInstitution = $actor->institution;
137			$this->enricher->setMetadata($metadata);
138			}
139
140			protected function verifyEmail($identity, $unverifiedSecondFactor)
141			{
142			$command = new VerifyEmailCommand();
143			$command->UUID = (string)Uuid::uuid4();
144			$command->identityId = $identity->id;
145			$command->verificationNonce = $unverifiedSecondFactor->verificationNonce;
146			$this->process($command);
147			}
148			}
149

OpenConext / Stepup-Middleware

Push — feature/improve-input-validati... ( 8f7b6e )

AbstractBootstrapCommand::vetSecondFactor() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like