RemoveSsoSessionFromStoreAction::__construct() - Code Metrics - Inspection of "receive logout response and session termination" - lightSAML/lightSAML-logout - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e7b047...512289 )

by Milos

created 2016-11-17 15:18 UTC

RemoveSsoSessionFromStoreAction::__construct() A

↳ Parent: RemoveSsoSessionFromStoreAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/*
 * This file is part of the LightSAML-Logout package.
 *
 * (c) Milos Tomic <[email protected]>
 *
 * This source file is subject to the GPL-3 license that is bundled
 * with this source code in the file LICENSE.
 */

namespace LightSaml\Logout\Action\Profile\Inbound\LogoutResponse;

use LightSaml\Action\Profile\AbstractProfileAction;
use LightSaml\Context\Profile\Helper\LogHelper;
use LightSaml\Context\Profile\Helper\MessageContextHelper;
use LightSaml\Context\Profile\ProfileContext;
use LightSaml\Error\LightSamlContextException;
use LightSaml\Logout\Resolver\Logout\LogoutSessionResolverInterface;
use LightSaml\State\Request\RequestStateParameters;
use LightSaml\Store\Request\RequestStateStoreInterface;
use Psr\Log\LoggerInterface;

class RemoveSsoSessionFromStoreAction extends AbstractProfileAction
{
    /** @var RequestStateStoreInterface */
    private $requestStore;

    /** @var LogoutSessionResolverInterface */
    private $logoutResolver;

    /**
     * @param LoggerInterface                $logger
     * @param RequestStateStoreInterface     $requestStore
     * @param LogoutSessionResolverInterface $logoutResolver
     */
    public function __construct(LoggerInterface $logger, RequestStateStoreInterface $requestStore, LogoutSessionResolverInterface $logoutResolver)
    {
        parent::__construct($logger);

        $this->requestStore = $requestStore;
        $this->logoutResolver = $logoutResolver;
    }

    protected function doExecute(ProfileContext $context)
    {
        $logoutResponse = MessageContextHelper::asLogoutResponse($context->getInboundContext());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $id = $logoutResponse->getInResponseTo();
        $requestState = $this->requestStore->get($id);
        $partyEntityId = $requestState->getParameters()->get(RequestStateParameters::PARTY);

        if ($partyEntityId && $logoutResponse->getIssuer() && $partyEntityId != $logoutResponse->getIssuer()->getValue()) {
            $message = sprintf(
                'LogoutRequest sent to %s but LogoutResponse for that request was issued by %s',
                $partyEntityId,
                $logoutResponse->getIssuer()->getValue()
            );
            $this->logger->critical($message, LogHelper::getActionErrorContext($context, $this, [
                'sent_to' => $partyEntityId,
                'received_from' => $logoutResponse->getIssuer()->getValue(),
            ]));
            throw new LightSamlContextException($context, $message);
        }

        $nameId = $requestState->getParameters()->get(RequestStateParameters::NAME_ID);

        $nameIdFormat = $requestState->getParameters()->get(RequestStateParameters::NAME_ID_FORMAT);

        $sessionIndex = $requestState->getParameters()->get(RequestStateParameters::SESSION_INDEX);


        $numberOfTerminatedSessions = $this->logoutResolver->terminateSession(
            $logoutResponse->getIssuer()->getValue(),
            $nameId,
            $nameIdFormat,
            $sessionIndex
        );

        $this->logger->debug(
            sprintf(
                'Processing LogoutResponse from %s for %s in format %s and session index %s resulted in termination of %s sso session from the store',
                $partyEntityId,
                $nameId,
                $nameIdFormat,
                $sessionIndex,
                $numberOfTerminatedSessions
            ),
            LogHelper::getActionContext($context, $this)
        );
    }
}


1			<?php
2
3			/*
4			* This file is part of the LightSAML-Logout package.
5			*
6			* (c) Milos Tomic <[email protected]>
7			*
8			* This source file is subject to the GPL-3 license that is bundled
9			* with this source code in the file LICENSE.
10			*/
11
12			namespace LightSaml\Logout\Action\Profile\Inbound\LogoutResponse;
13
14			use LightSaml\Action\Profile\AbstractProfileAction;
15			use LightSaml\Context\Profile\Helper\LogHelper;
16			use LightSaml\Context\Profile\Helper\MessageContextHelper;
17			use LightSaml\Context\Profile\ProfileContext;
18			use LightSaml\Error\LightSamlContextException;
19			use LightSaml\Logout\Resolver\Logout\LogoutSessionResolverInterface;
20			use LightSaml\State\Request\RequestStateParameters;
21			use LightSaml\Store\Request\RequestStateStoreInterface;
22			use Psr\Log\LoggerInterface;
23
24			class RemoveSsoSessionFromStoreAction extends AbstractProfileAction
25			{
26			/** @var RequestStateStoreInterface */
27			private $requestStore;
28
29			/** @var LogoutSessionResolverInterface */
30			private $logoutResolver;
31
32			/**
33			* @param LoggerInterface $logger
34			* @param RequestStateStoreInterface $requestStore
35			* @param LogoutSessionResolverInterface $logoutResolver
36			*/
37			public function __construct(LoggerInterface $logger, RequestStateStoreInterface $requestStore, LogoutSessionResolverInterface $logoutResolver)
38			{
39			parent::__construct($logger);
40
41			$this->requestStore = $requestStore;
42			$this->logoutResolver = $logoutResolver;
43			}
44
45			protected function doExecute(ProfileContext $context)
46			{
47			$logoutResponse = MessageContextHelper::asLogoutResponse($context->getInboundContext());
			0 ignored issues – show Bug introduced 2016-11-17 15:27 UTC by Report Bug Copy Issue Report It seems like `$context->getInboundContext()` can be `null`; however, `asLogoutResponse()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
48			$id = $logoutResponse->getInResponseTo();
49			$requestState = $this->requestStore->get($id);
50			$partyEntityId = $requestState->getParameters()->get(RequestStateParameters::PARTY);
			0 ignored issues – show Bug introduced 2016-11-17 15:27 UTC by Report Bug Copy Issue Report The method `getParameters()` does not seem to exist on `object<LightSaml\State\Request\RequestState>`. 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...
51			if ($partyEntityId && $logoutResponse->getIssuer() && $partyEntityId != $logoutResponse->getIssuer()->getValue()) {
52			$message = sprintf(
53			'LogoutRequest sent to %s but LogoutResponse for that request was issued by %s',
54			$partyEntityId,
55			$logoutResponse->getIssuer()->getValue()
56			);
57			$this->logger->critical($message, LogHelper::getActionErrorContext($context, $this, [
58			'sent_to' => $partyEntityId,
59			'received_from' => $logoutResponse->getIssuer()->getValue(),
60			]));
61			throw new LightSamlContextException($context, $message);
62			}
63
64			$nameId = $requestState->getParameters()->get(RequestStateParameters::NAME_ID);
			0 ignored issues – show Bug introduced 2016-11-17 15:27 UTC by Report Bug Copy Issue Report The method `getParameters()` does not seem to exist on `object<LightSaml\State\Request\RequestState>`. 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...
65			$nameIdFormat = $requestState->getParameters()->get(RequestStateParameters::NAME_ID_FORMAT);
			0 ignored issues – show Bug introduced 2016-11-17 15:27 UTC by Report Bug Copy Issue Report The method `getParameters()` does not seem to exist on `object<LightSaml\State\Request\RequestState>`. 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...
66			$sessionIndex = $requestState->getParameters()->get(RequestStateParameters::SESSION_INDEX);
			0 ignored issues – show Bug introduced 2016-11-17 15:27 UTC by Report Bug Copy Issue Report The method `getParameters()` does not seem to exist on `object<LightSaml\State\Request\RequestState>`. 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...
67
68			$numberOfTerminatedSessions = $this->logoutResolver->terminateSession(
69			$logoutResponse->getIssuer()->getValue(),
70			$nameId,
71			$nameIdFormat,
72			$sessionIndex
73			);
74
75			$this->logger->debug(
76			sprintf(
77			'Processing LogoutResponse from %s for %s in format %s and session index %s resulted in termination of %s sso session from the store',
78			$partyEntityId,
79			$nameId,
80			$nameIdFormat,
81			$sessionIndex,
82			$numberOfTerminatedSessions
83			),
84			LogHelper::getActionContext($context, $this)
85			);
86			}
87			}
88

lightSAML / lightSAML-logout

Push — master ( e7b047...512289 )

RemoveSsoSessionFromStoreAction::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like