roaresearch\yii2\oauth2server\filters\auth\CompositeAuth

Complexity

Total Complexity

6

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

87.5%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	fetchActionScope()	0	18	4
A	beforeAction()	0	14	2

<?php

namespace roaresearch\yii2\oauth2server\filters\auth;

use roaresearch\yii2\oauth2server\filters\ErrorToExceptionTrait;
use Yii;
use yii\filters\auth\{HttpBearerAuth, QueryParamAuth};
use yii\{helpers\StringHelper, web\HttpException};

/**
 * Filter to handle OAuth2 authentication. To do so it initialize the OAuth2
 * Server and handles it responses.
 */
class CompositeAuth extends \yii\filters\auth\CompositeAuth
{
    use ErrorToExceptionTrait {
        ErrorToExceptionTrait::beforeAction as traitBeforeAction;
    }

    /**
     * @var string[] pairs of $actionPattern => $scope to require an scope for
     * specific actions comparing them with their action id. Wildcards like '*'
     * are allowed.
     *
     * If several $actionPatterns match the action being processed only the
     * first one will be used.
     *
     * @see https://www.yiiframework.com/doc/api/2.0/yii-helpers-basestringhelper#matchWildcard()-detail
     */
    public array $actionScopes = [];

    /**
     * @inheritdoc
     */
    public $authMethods = [
        ['class' => HttpBearerAuth::class],
        [
            'class' => QueryParamAuth::class,
            'tokenParam' => 'accessToken',
        ],
    ];

    /**
     * @inheritdoc
     */
    public function beforeAction($action): bool
    {
        if ($this->traitBeforeAction($action)) {
            $this->oauth2Module->getServer()->verifyResourceRequest(
                null,
                null,
                $this->fetchActionScope($action->getUniqueId())
            );
            $this->ensureSuccessResponse();

            return true;
        }

        return false;
    }

    /**
     * Fetch the scope required for the action id.
     *
     * @param string $actionId
     * @return ?string the required scope or `null` if no scope is required.
     */
    protected function fetchActionScope(string $actionId): ?string
    {
        if (empty($this->actionScopes)) {
            return null;
        }

        $ownerId = $this->owner->getUniqueId();

The method getUniqueId() does not exist on null.

        foreach ($this->actionScopes as $actionPattern => $scope) {

            if (StringHelper::matchWildcard(
                "$ownerId/$actionPattern",
                $actionId
            )) {
                return $scope;
            }
        }

        return null;
    }
}