limoncello-php-dist / oauth-server

src/GrantTraits/ImplicitGrantTrait.php

<?php declare(strict_types=1);

namespace Limoncello\OAuthServer\GrantTraits;

/**
 * Copyright 2015-2019 info@neomerx.com
 *
 * 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.
 */

use Limoncello\OAuthServer\Contracts\ClientInterface;
use Limoncello\OAuthServer\Contracts\Integration\ImplicitIntegrationInterface;
use Limoncello\OAuthServer\Exceptions\OAuthTokenRedirectException;
use Psr\Http\Message\ResponseInterface;
use function array_key_exists;
use function explode;
use function is_string;
use function strlen;

/**
 * Implements Implicit Grant.
 *
 * @package Limoncello\OAuthServer
 *
 * @link https://tools.ietf.org/html/rfc6749#section-1.3
 * @link https://tools.ietf.org/html/rfc6749#section-4.2
 */
trait ImplicitGrantTrait
{
    /**
     * @var ImplicitIntegrationInterface
     */
    private $implicitIntegration;

    /**
     * @param ImplicitIntegrationInterface $integration
     *
     * @return void
     */
    public function implicitSetIntegration(ImplicitIntegrationInterface $integration): void
    {
        $this->implicitIntegration = $integration;
    }

    /**
     * @return ImplicitIntegrationInterface
     */
    protected function implicitGetIntegration(): ImplicitIntegrationInterface
    {
        return $this->implicitIntegration;
    }

    /**
     * @param string[] $parameters
     *
     * @return string|null
     */
    protected function implicitGetClientId(array $parameters): ?string
    {
        return $this->implicitReadStringValue($parameters, 'client_id');
    }

    /**
     * @param string[] $parameters
     *
     * @return string|null
     */
    protected function implicitGetRedirectUri(array $parameters): ?string
    {
        return $this->implicitReadStringValue($parameters, 'redirect_uri');
    }

    /**
     * @param string[] $parameters
     *
     * @return string[]|null

Should the return type not be array|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    protected function implicitGetScope(array $parameters): ?array
    {
        $scope = $this->implicitReadStringValue($parameters, 'scope');

        return empty($scope) === false ? explode(' ', $scope) : null;
    }

    /**
     * @param string[] $parameters
     *
     * @return string|null
     */
    protected function implicitGetState(array $parameters): ?string
    {
        return $this->implicitReadStringValue($parameters, 'state');
    }

    /**
     * @param string[]        $parameters
     * @param ClientInterface $client
     * @param string|null     $redirectUri
     * @param int|null        $maxStateLength
     *
     * @return ResponseInterface
     */
    protected function implicitAskResourceOwnerForApproval(
        array $parameters,
        ClientInterface $client,
        string $redirectUri = null,
        int $maxStateLength = null
    ): ResponseInterface {
        $state = $this->implicitGetState($parameters);
        if ($maxStateLength !== null && strlen($state) > $maxStateLength) {
            throw new OAuthTokenRedirectException(
                OAuthTokenRedirectException::ERROR_INVALID_REQUEST,
                $redirectUri,
                $state
            );
        }

        if ($client->isImplicitGrantEnabled() === false) {
            throw new OAuthTokenRedirectException(
                OAuthTokenRedirectException::ERROR_UNAUTHORIZED_CLIENT,
                $redirectUri,
                $state
            );
        }

        $scope = $this->implicitGetScope($parameters);
        list ($isScopeValid, $scopeList, $isScopeModified) =
            $this->implicitGetIntegration()->implicitValidateScope($client, $scope);
        if ($isScopeValid === false) {
            throw new OAuthTokenRedirectException(
                OAuthTokenRedirectException::ERROR_INVALID_SCOPE,
                $redirectUri,
                $state
            );
        }

        $response = $this->implicitGetIntegration()->implicitCreateAskResourceOwnerForApprovalResponse(
            $client,
            $redirectUri,
            $isScopeModified,
            $scopeList,
            $state,
            $parameters
        );

        return $response;
    }

    /**
     * @param array  $parameters
     * @param string $name
     *
     * @return null|string
     */
    private function implicitReadStringValue(array $parameters, string $name): ?string
    {
        return array_key_exists($name, $parameters) === true && is_string($value = $parameters[$name]) === true ?
            $value : null;

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

    }
}