flipbox\saml\core\controllers\messages\AbstractLogoutController

Complexity

Total Complexity

17

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	getRemoteProvider()	0	1	?
A	destroySpecifiedSession()	0	23	3
A	beforeAction()	0	13	2
B	actionIndex()	0	50	7
B	actionRequest()	0	44	5

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 */

namespace flipbox\saml\core\controllers\messages;

use craft\db\Table;
use flipbox\saml\core\helpers\MessageHelper;
use flipbox\saml\core\models\AbstractSettings;
use flipbox\saml\core\records\AbstractProvider;
use flipbox\saml\core\records\AbstractProviderIdentity;
use flipbox\saml\core\records\ProviderInterface;
use flipbox\saml\core\services\bindings\Factory;
use SAML2\LogoutRequest;
use SAML2\LogoutResponse;
use yii\web\HttpException;

/**
 * Class AbstractLogoutController
 * @package flipbox\saml\core\controllers\messages
 */
abstract class AbstractLogoutController extends AbstractController implements \flipbox\saml\core\EnsureSAMLPlugin
{

    protected $allowAnonymous = [
        'actionIndex',
        'actionRequest',
    ];

    public $enableCsrfValidation = false;

    /**
     * @return ProviderInterface
     */
    abstract protected function getRemoteProvider($uid = null);

    /**
     * @param \yii\base\Action $action
     * @return bool
     */
    public function beforeAction($action)
    {
        if (in_array(
            $action->actionMethod,
            [
                'actionIndex',
                'actionRequest',
            ]
        )) {
            return true;
        }
        return parent::beforeAction($action);
    }


    /**
     * @return \yii\web\Response
     * @throws HttpException
     * @throws \flipbox\saml\core\exceptions\InvalidMetadata
     * @throws \yii\base\ExitException
     * @throws \yii\base\InvalidConfigException
     */
    public function actionIndex()
    {
        $message = Factory::receive();

        $isRequest = $message instanceof LogoutRequest;
        $isResponse = $message instanceof LogoutResponse;

        if ((! $isRequest && ! $isResponse) ||
            $isResponse && $this->getPlugin()->getSession()->getRequestId() !== $message->getInResponseTo()) {

The method getSession does not exist on object<flipbox\saml\core\AbstractPlugin>? Since you implemented __call, maybe consider adding a @method annotation.

            throw new HttpException(400, "Invalid request");
        }

        /** @var AbstractProvider $theirProvider */
        $theirProvider = $this->getPlugin()->getProvider()->findByEntityId(
            MessageHelper::getIssuer($message->getIssuer())
        )->one();

        /** @var AbstractProvider $ourProvider */
        $ourProvider = $this->getPlugin()->getProvider()->findOwn();

        if ($isRequest) {
            if (\Craft::$app->getUser()->isGuest) {
                $this->destroySpecifiedSession(
                    $message,
                    $theirProvider,
                    $this->getPlugin()->getSettings()

It seems like $this->getPlugin()->getSettings() can be null; however, destroySpecifiedSession() does not accept null, maybe add an additional type check?

                );
            }

            /** @var LogoutResponse $response */
            $response = $this->getPlugin()->getLogoutResponse()->create(
                $message,
                $theirProvider,
                $ourProvider
            );

            /**
             * Add the request id to the the response.
             */
            $response->setInResponseTo($message->getId());

            \Craft::$app->user->logout(true);
            Factory::send($response, $theirProvider);
            \Craft::$app->end();
        }

        return $this->redirect(
            \Craft::$app->config->general->logoutPath
        );
    }

    /**
     * @param LogoutRequest $message
     * @param AbstractProvider $theirProvider
     * @throws \yii\db\Exception
     */
    protected function destroySpecifiedSession(
        LogoutRequest $message,
        AbstractProvider $theirProvider,
        AbstractSettings $settings
    ) {
        if (! $settings->sloDestroySpecifiedSessions) {
            return;
        }

        /** @var AbstractProviderIdentity $user */
        $user = $this->getPlugin()->getProviderIdentity()->findByNameId(
            $message->getNameId()->getValue(),
            $theirProvider
        )->one();

        if ($user) {
            \Craft::$app->getDb()->createCommand()
                ->delete(Table::SESSIONS, [
                    'userId' => $user->userId,
                ])
                ->execute();
        }
    }


    /**
     * @param null $uid
     * @throws \flipbox\saml\core\exceptions\InvalidMetadata
     * @throws \yii\base\ExitException
     * @throws \yii\base\InvalidConfigException
     */
    public function actionRequest($uid = null)
    {
        // Backwards compatibility with 1.0
        // The request shouldn't get here with a SAMLResponse
        if (\Craft::$app->request->getBodyParam('SAMLResponse')) {
            return $this->actionIndex();
        }

        /** @var AbstractProvider $theirProvider */
        $theirProvider = $this->getRemoteProvider($uid);

        /** @var AbstractProvider $ourProvider */
        $ourProvider = $this->getPlugin()->getProvider()->findOwn();

        $user = \Craft::$app->user->getIdentity();

        if (! $user || (
                $user &&
                ! $identity = $this->getPlugin()->getProviderIdentity()->findByUserAndProvider($user, $theirProvider)
            )
        ) {
            $saml = $this->getPlugin();
            $saml::warning('Logout not available. User is not logged in.');
            // Logout locally only
            return $this->redirect(
                \Craft::$app->config->general->logoutPath
            );
        }

        $logoutRequest = $this->getPlugin()->getLogoutRequest()->create(
            $theirProvider,
            $ourProvider,
            $identity,

The variable $identity does not seem to be defined for all execution paths leading up to this point.

            \Craft::$app->config->general->getPostLogoutRedirect()
        );

        /**
         * Save id to session so we can validate the response.
         */
        $this->getPlugin()->getSession()->setRequestId($logoutRequest->getId());

The method getSession does not exist on object<flipbox\saml\core\AbstractPlugin>? Since you implemented __call, maybe consider adding a @method annotation.

        Factory::send($logoutRequest, $theirProvider);
        \Craft::$app->end();
    }
}