Oauth2Client::setSkipAuthorizationIfScopeIsAllowed() - Code Metrics - rhertogh/yii2-oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

setSkipAuthorizationIfScopeIsAllowed() A
last analyzed 2025-04-24 08:00 UTC

↳ Parent: Oauth2Client
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	1
Importance

Changes
Metric	Value
eloc	2
c	0
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1
<?php

namespace rhertogh\Yii2Oauth2Server\models;

use rhertogh\Yii2Oauth2Server\helpers\DiHelper;
use rhertogh\Yii2Oauth2Server\helpers\EnvironmentHelper;
use rhertogh\Yii2Oauth2Server\helpers\exceptions\EnvironmentVariableNotAllowedException;
use rhertogh\Yii2Oauth2Server\helpers\exceptions\EnvironmentVariableNotSetException;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ClientInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ClientScopeInterface;
use rhertogh\Yii2Oauth2Server\interfaces\models\Oauth2ScopeInterface;
use rhertogh\Yii2Oauth2Server\models\behaviors\DateTimeBehavior;
use rhertogh\Yii2Oauth2Server\models\queries\Oauth2ClientScopeQuery;
use rhertogh\Yii2Oauth2Server\models\traits\Oauth2EnabledTrait;
use rhertogh\Yii2Oauth2Server\models\traits\Oauth2EntityIdentifierTrait;
use rhertogh\Yii2Oauth2Server\Oauth2Module;
use Yii;
use yii\base\Exception;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;
use yii\base\UnknownPropertyException;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;

class Oauth2Client extends base\Oauth2Client implements Oauth2ClientInterface
{
    use Oauth2EntityIdentifierTrait;
    use Oauth2EnabledTrait;

    protected const ENCRYPTED_ATTRIBUTES = ['secret', 'old_secret'];

    /**
     * @var Oauth2Module
     */
    protected $module;

    /**
     * Minimum length for new client secrets.
     * @var int
     */
    protected $minimumSecretLength = 10;

    /////////////////////////////
    /// ActiveRecord Settings ///
    /////////////////////////////

    /**
     * @inheritDoc
     */
    public function behaviors()
    {
        return ArrayHelper::merge(parent::behaviors(), [
            'dateTimeBehavior' => DateTimeBehavior::class
        ]);
    }

    /**
     * @inheritDoc
     */
    public function rules()
    {
        return ArrayHelper::merge(parent::rules(), [
            [
                ['secret'],
                'required',
                'when' => fn(self $model) => $model->isConfidential(),
            ],
        ]);
    }

    /////////////////////////
    /// Getters & Setters ///
    /////////////////////////

    /**
     * @inheritdoc
     */
    public function __set($name, $value)
    {
        if ($name === 'secret') { // Don't allow setting the secret via magic method.
            throw new UnknownPropertyException('For security the "secret" property must be set via setSecret()');
        } else {
            parent::__set($name, $value);
        }
    }

    /**
     * @inheritDoc
     */
    public function getModule(): Oauth2Module
    {
        return $this->module;
    }

    /**
     * @inheritDoc
     */
    public function setModule($module)
    {
        $this->module = $module;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @inheritdoc
     */
    public function setName($name)
    {
        $this->name = $name;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * @inheritdoc
     */
    public function setType($type)
    {
        if (!in_array($type, Oauth2ClientInterface::TYPES)) {
            throw new InvalidArgumentException('Unknown type "' . $type . '".');
        }

        $this->type = $type;
        return $this;
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     * @throws EnvironmentVariableNotSetException
     * @throws EnvironmentVariableNotAllowedException
     */
    public function getRedirectUri()
    {
        return $this->getUrisAttribute('redirect_uris');
    }

    /**
     * @inheritdoc
     * @throws InvalidConfigException
     * @throws EnvironmentVariableNotSetException
     * @throws EnvironmentVariableNotAllowedException
     */
    public function getPostLogoutRedirectUris()
    {
        return $this->getUrisAttribute('post_logout_redirect_uris');
    }

    /**
     * @param string $attribute
     * @return string[]
     * @throws InvalidConfigException
     * @throws EnvironmentVariableNotSetException
     * @throws EnvironmentVariableNotAllowedException
     */
    protected function getUrisAttribute($attribute)
    {
        $uris = $this->$attribute;
        if (empty($uris)) {
            return [];
        }

        // Compatibility with DBMSs that don't support JSON data type.
        if (is_string($uris)) {
            try {
                $uris = Json::decode($uris);
            } catch (InvalidArgumentException $e) {
                throw new InvalidConfigException('Invalid json in `' . $attribute . '` for client ' . $this->id, 0, $e);
            }
        }

        $redirectUrisEnvVarConfig = $this->getRedirectUrisEnvVarConfig();
        if ($redirectUrisEnvVarConfig && version_compare(PHP_VERSION, '8.1.0', '<')) {
            // PHP < 8.1 can only handle indexed array when unpacking.
            $redirectUrisEnvVarConfig = array_values($redirectUrisEnvVarConfig);
        }

        if (is_string($uris)) {
            if ($redirectUrisEnvVarConfig && preg_match('/^\${[a-zA-Z0-9_]+}$/', $uris)) {
                $uris = EnvironmentHelper::parseEnvVars($uris, ...$redirectUrisEnvVarConfig);
                $uris = EnvironmentHelper::parseEnvVars($uris, /** @scrutinizer ignore-type */ ...$redirectUrisEnvVarConfig);
                try {
                    // Try to parse the content of the environment variable(s) as JSON.
                    $uris = Json::decode($uris);
                } catch (InvalidArgumentException $e) {
                    // Use as plain text if it failed.
                }
            }
        }

        if (is_string($uris)) {
            $uris = [$uris];
        } elseif (is_array($uris)) {
            $uris = array_values($uris);
        } else {
            throw new InvalidConfigException('`' . $attribute . '` must be a JSON encoded string or array of strings.');
        }

        foreach ($uris as $key => $uri) {
            if (!is_string($uri)) {
                throw new InvalidConfigException('`' . $attribute . '` must be a JSON encoded string or array of strings.'); // phpcs:ignore Generic.Files.LineLength.TooLong
            }
            if ($redirectUrisEnvVarConfig) {
                $uris[$key] = EnvironmentHelper::parseEnvVars($uri, ...$redirectUrisEnvVarConfig);
                if (!$uris[$key]) {
                    unset($uris[$key]);
                }
            }
        }
        return array_values($uris); // Re-index array in case elements were removed.
    }

    /**
     * @inheritDoc
     */
    public function setRedirectUri($uri)
    {
        return $this->setUrisAttribute('redirect_uris', $uri);
    }

    /**
     * @inheritDoc
     */
    public function setPostLogoutRedirectUris($uri)
    {
        return $this->setUrisAttribute('post_logout_redirect_uris', $uri);
    }

    /**
     * @param string $attribute
     * @param string|string[]|null $uri
     * @return $this
     */
    protected function setUrisAttribute($attribute, $uri)
    {
        if (is_array($uri)) {
            foreach ($uri as $value) {
                if (!is_string($value)) {
                    throw new InvalidArgumentException('When $uri is an array, its values must be strings.');
                }
            }
            $uri = Json::encode($uri);
        } elseif (is_string($uri)) {
            $uri = Json::encode([$uri]);
        } elseif ($uri !== null) {

            throw new InvalidArgumentException('$uri must be a string or an array, got: ' . gettype($uri));
        }

        $this->$attribute = $uri;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getEnvVarConfig()
    {
        return $this->env_var_config;
    }

    /**
     * @inheritdoc
     */
    public function setEnvVarConfig($config)
    {
        $this->env_var_config = $config;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getRedirectUrisEnvVarConfig()
    {
        $envVarConfig = $this->getEnvVarConfig();
        return is_array($envVarConfig) && array_key_exists('redirectUris', $envVarConfig)
            ? $this->getEnvVarConfig()['redirectUris']
            : $this->getModule()->clientRedirectUrisEnvVarConfig;
    }

    /**
     * @inheritdoc
     */
    public function getSecretsEnvVarConfig()
    {
        $envVarConfig = $this->getEnvVarConfig();
        return is_array($envVarConfig) && array_key_exists('secrets', $envVarConfig)
            ? $envVarConfig['secrets']
            : null;
    }

    public function isVariableRedirectUriQueryAllowed()
    {
        return (bool)$this->allow_variable_redirect_uri_query;
    }
    public function setAllowVariableRedirectUriQuery($allowVariableRedirectUriQuery)
    {
        $this->allow_variable_redirect_uri_query = $allowVariableRedirectUriQuery;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getUserAccountSelection()
    {
        return $this->user_account_selection;
    }

    public function endUsersMayAuthorizeClient()
    {
        return $this->end_users_may_authorize_client;
    }

    public function setEndUsersMayAuthorizeClient($endUsersMayAuthorizeClient)
    {
        $this->end_users_may_authorize_client = $endUsersMayAuthorizeClient;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setUserAccountSelection($userAccountSelectionConfig)
    {
        $this->user_account_selection = $userAccountSelectionConfig;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function isAuthCodeWithoutPkceAllowed()
    {
        return (bool)$this->allow_auth_code_without_pkce;
    }

    /**
     * @inheritDoc
     */
    public function setAllowAuthCodeWithoutPkce($allowAuthCodeWithoutPkce)
    {
        $this->allow_auth_code_without_pkce = $allowAuthCodeWithoutPkce;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function skipAuthorizationIfScopeIsAllowed()
    {
        return (bool)$this->skip_authorization_if_scope_is_allowed;
    }

    /**
     * @inheritDoc
     */
    public function setSkipAuthorizationIfScopeIsAllowed($skipAuthIfScopeIsAllowed)
    {
        $this->skip_authorization_if_scope_is_allowed = $skipAuthIfScopeIsAllowed;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getClientCredentialsGrantUserId()
    {
        return $this->client_credentials_grant_user_id;
    }

    /**
     * @inheritDoc
     */
    public function setClientCredentialsGrantUserId($userId)
    {
        $this->client_credentials_grant_user_id = $userId;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getOpenIdConnectAllowOfflineAccessWithoutConsent()
    {
        return (bool)$this->oidc_allow_offline_access_without_consent;
    }

    /**
     * @inheritDoc
     */
    public function setOpenIdConnectAllowOfflineAccessWithoutConsent($allowOfflineAccessWithoutConsent)
    {
        $this->oidc_allow_offline_access_without_consent = $allowOfflineAccessWithoutConsent;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getOpenIdConnectRpInitiatedLogout()
    {
        return $this->oidc_rp_initiated_logout;
    }

    /**
     * @inheritDoc
     */
    public function setOpenIdConnectRpInitiatedLogout($skipLogoutValidation)
    {
        $this->oidc_rp_initiated_logout = $skipLogoutValidation;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getOpenIdConnectUserinfoEncryptedResponseAlg()
    {
        return $this->oidc_userinfo_encrypted_response_alg;
    }

    /**
     * @inheritDoc
     */
    public function setOpenIdConnectUserinfoEncryptedResponseAlg($algorithm)
    {
        $this->oidc_userinfo_encrypted_response_alg = $algorithm;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function isConfidential()
    {
        return (int)$this->type !== static::TYPE_PUBLIC;
    }

    /**
     * @inheritDoc
     */
    public function getAllowGenericScopes()
    {
        return (bool)$this->allow_generic_scopes;
    }

    /**
     * @inheritDoc
     */
    public function setAllowGenericScopes($allowGenericScopes)
    {
        $this->allow_generic_scopes = $allowGenericScopes;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getExceptionOnInvalidScope()
    {
        return $this->exception_on_invalid_scope;
    }

    /**
     * @inheritDoc
     */
    public function setExceptionOnInvalidScope($exceptionOnInvalidScope)
    {
        $this->exception_on_invalid_scope = $exceptionOnInvalidScope;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public static function getEncryptedAttributes()
    {
        return static::ENCRYPTED_ATTRIBUTES;
    }

    /**
     * @inheritDoc
     */
    public static function rotateStorageEncryptionKeys($cryptographer, $newKeyName = null)
    {
        $numUpdated = 0;
        $encryptedAttributes = static::getEncryptedAttributes();
        $query = static::find()->andWhere(['NOT', array_fill_keys($encryptedAttributes, null)]);

        $transaction = static::getDb()->beginTransaction();
        try {
            /** @var static $client */
            foreach ($query->each() as $client) {
                $client->rotateStorageEncryptionKey($cryptographer, $newKeyName);
                if ($client->getDirtyAttributes($encryptedAttributes)) {
                    $client->persist();
                    $numUpdated++;
                }
            }
            $transaction->commit();
        } catch (\Exception $e) {
            $transaction->rollBack();
            throw $e;
        }

        return $numUpdated;
    }

    /**
     * @inheritDoc
     */
    public static function getUsedStorageEncryptionKeys($cryptographer)
    {
        $encryptedAttributes = static::getEncryptedAttributes();
        $query = static::find()->andWhere(['NOT', array_fill_keys($encryptedAttributes, null)]);

        $keyUsage = [];
        foreach ($query->each() as $client) {
            foreach ($encryptedAttributes as $encryptedAttribute) {
                $data = $client->$encryptedAttribute;
                if (!empty($data)) {
                    ['keyName' => $keyName] = $cryptographer->parseData($data);
                    if (array_key_exists($keyName, $keyUsage)) {
                        $keyUsage[$keyName][] = $client->getPrimaryKey();
                    } else {
                        $keyUsage[$keyName] = [$client->getPrimaryKey()];
                    }
                }
            }
        }

        return $keyUsage;
    }

    /**
     * @inheritDoc
     */
    public function rotateStorageEncryptionKey($cryptographer, $newKeyName = null)
    {
        foreach (static::getEncryptedAttributes() as $attribute) {
            $data = $this->getAttribute($attribute);
            if ($data) {
                try {
                    $this->setAttribute($attribute, $cryptographer->rotateKey($data, $newKeyName));
                } catch (\Exception $e) {
                    throw new Exception('Unable to rotate key for client "' . $this->identifier
                        . '", attribute "' . $attribute . '": ' . $e->getMessage(), 0, $e);
                }
            }
        }
    }

    /**
     * @inheritDoc
     */
    public function setSecret($secret, $cryptographer, $oldSecretValidUntil = null, $keyName = null)
    {
        if ($this->isConfidential()) {
            if (!$this->validateNewSecret($secret, $error)) {
                throw new InvalidArgumentException($error);
            }

            // Ensure we clear out any old secret.
            $this->setAttribute('old_secret', null);
            $this->setAttribute('old_secret_valid_until', null);

            if ($oldSecretValidUntil) {
                $oldSecretData = $this->getAttribute('secret') ?? null;
                if ($oldSecretData) {
                    // Ensure correct encryption key.
                    $oldSecretData = $cryptographer->encryp($cryptographer->decrypt($oldSecretData), $keyName);
                    $this->setAttribute('old_secret', $oldSecretData);

                    if ($oldSecretValidUntil instanceof \DateInterval) {
                        $oldSecretValidUntil = (new \DateTimeImmutable())->add($oldSecretValidUntil);
                    }
                    $this->setAttribute('old_secret_valid_until', $oldSecretValidUntil);
                }
            }

            $this->setAttribute('secret', $cryptographer->encryp($secret, $keyName));
        } else {
            if ($secret !== null) {
                throw new InvalidArgumentException(
                    'The secret for a non-confidential client can only be set to `null`.'
                );
            }

            $this->setAttribute('secret', null);
        }

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function setSecretsAsEnvVars($secretEnvVarName, $oldSecretEnvVarName = null, $oldSecretValidUntil = null)
    {
        if (empty($secretEnvVarName)) {
            throw new InvalidArgumentException(
                'Parameter $secretEnvVarName can not be empty.'
            );
        }

        if ($oldSecretEnvVarName) {
            if (!$oldSecretValidUntil) {
                throw new InvalidArgumentException(
                    'Parameter $oldSecretValidUntil must be set when $oldSecretEnvVar is set.'
                );
            }
            $this->setAttribute('old_secret', '${' . $oldSecretEnvVarName . '}');

            if ($oldSecretValidUntil instanceof \DateInterval) {
                $oldSecretValidUntil = (new \DateTimeImmutable())->add($oldSecretValidUntil);
            }
            $this->setAttribute('old_secret_valid_until', $oldSecretValidUntil);
        } else {
            $this->setAttribute('old_secret', null);
            $this->setAttribute('old_secret_valid_until', null);
        }

        $this->setAttribute('secret', '${' . $secretEnvVarName . '}');

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function validateNewSecret($secret, &$error)
    {
        $error = null;
        if (mb_strlen($secret) < $this->getMinimumSecretLength()) {
            $error = 'Secret should be at least ' . $this->getMinimumSecretLength() . ' characters.';
        }

        return $error === null;
    }

    /**
     * @inheritDoc
     */
    public function getMinimumSecretLength()
    {
        return $this->minimumSecretLength;
    }

    /**
     * @inheritDoc
     */
    public function setMinimumSecretLength($minimumSecretLength)
    {
        if (!(int)$minimumSecretLength) {
            throw new InvalidArgumentException('$minimumSecretLength can not be empty.');
        }
        $this->minimumSecretLength = (int)$minimumSecretLength;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getDecryptedSecret($cryptographer)
    {
        return $cryptographer->decrypt($this->envVarParseSecret($this->secret));
    }

    /**
     * @inheritDoc
     */
    public function getDecryptedOldSecret($cryptographer)
    {
        return $cryptographer->decrypt($this->envVarParseSecret($this->old_secret));
    }

    /**
     * Replaces environment variables with their values in the secret
     *
     * @param string $secret
     * @return string
     * @throws EnvironmentVariableNotAllowedException
     * @throws EnvironmentVariableNotSetException
     * @throws InvalidConfigException
     */
    protected function envVarParseSecret($secret)
    {
        $secretsEnvVarConfig = $this->getSecretsEnvVarConfig();
        if ($secretsEnvVarConfig) {
            if (version_compare(PHP_VERSION, '8.1.0', '<')) {
                // PHP < 8.1 can only handle indexed array when unpacking.
                $secretsEnvVarConfig = array_values($secretsEnvVarConfig);
            }
            $secret = EnvironmentHelper::parseEnvVars($secret, ...$secretsEnvVarConfig);
            $secret = EnvironmentHelper::parseEnvVars($secret, /** @scrutinizer ignore-type */ ...$secretsEnvVarConfig);
        } elseif (preg_match(EnvironmentHelper::ENV_VAR_REGEX, $secret)) {
            throw new InvalidConfigException('Environment variable used without env_var_config being set.');
        }

        return $secret;
    }

    /**
     * @inheritDoc
     */
    public function getOldSecretValidUntil()
    {
        return $this->old_secret_valid_until;
    }

    /**
     * @inheritdoc
     */
    public function validateSecret($secret, $cryptographer)
    {
        return is_string($secret)
            && strlen($secret)
            && (
                Yii::$app->security->compareString($this->getDecryptedSecret($cryptographer), $secret)
                || (
                    !empty($this->old_secret)
                    && !empty($this->old_secret_valid_until)
                    && $this->old_secret_valid_until > (new \DateTime())
                    && Yii::$app->security->compareString($this->getDecryptedOldSecret($cryptographer), $secret)
                )
            );
    }

    /**
     * @inheritdoc
     */
    public function getLogoUri()
    {
        return $this->logo_uri;
    }

    /**
     * @inheritdoc
     */
    public function setLogoUri($logoUri)
    {
        $this->logo_uri = $logoUri;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getTermsOfServiceUri()
    {
        return $this->tos_uri;
    }

    /**
     * @inheritdoc
     */
    public function setTermsOfServiceUri($tosUri)
    {
        $this->tos_uri = $tosUri;
        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getContacts()
    {
        return $this->contacts;
    }

    /**
     * @inheritdoc
     */
    public function setContacts($contacts)
    {
        $this->contacts = $contacts;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getGrantTypes()
    {
        return (int)$this->grant_types;
    }

    /**
     * @inheritDoc
     */
    public function setGrantTypes($grantTypes)
    {
        $grantTypeIds = array_flip(Oauth2Module::GRANT_TYPE_MAPPING);
        for ($i = (int)log(PHP_INT_MAX, 2); $i >= 0; $i--) {
            $grantTypeId = (int)pow(2, $i);
            if ($grantTypes & $grantTypeId) {
                if (!array_key_exists($grantTypeId, $grantTypeIds)) {
                    throw new InvalidArgumentException('Unknown Grant Type ID: ' . $grantTypeId);
                }
            }
        }

        $this->grant_types = $grantTypes;

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function validateGrantType($grantTypeIdentifier)
    {
        $grantTypeId = Oauth2Module::getGrantTypeId($grantTypeIdentifier);
        if (empty($grantTypeId)) {
            throw new InvalidArgumentException('Unknown grant type "' . $grantTypeIdentifier . '".');
        }

        return (bool)($this->getGrantTypes() & $grantTypeId);
    }

    /**
     * @inheritDoc
     * @throws InvalidConfigException
     */
    public function validateAuthRequestScopes($scopeIdentifiers, &$unknownScopes = [], &$unauthorizedScopes = [])
    {
        if (empty($scopeIdentifiers)) {
            $unknownScopes = [];
            $unauthorizedScopes = [];
            return true;
        }

        /** @var Oauth2ScopeInterface $scopeClass */
        $scopeClass = DiHelper::getValidatedClassName(Oauth2ScopeInterface::class);
        $knownScopeIdentifiers = $scopeClass::find()
            ->andWhere(['identifier' => $scopeIdentifiers])
            ->select('identifier')
            ->column();

        $unknownScopes = array_diff($scopeIdentifiers, $knownScopeIdentifiers);

        $allowedScopeIdentifiers = array_map(
            fn($scope) => $scope->getIdentifier(),
            $this->getAllowedScopes($knownScopeIdentifiers)
        );

        $unauthorizedScopes = array_values(array_diff($knownScopeIdentifiers, $allowedScopeIdentifiers));

        return empty($unknownScopes) && empty($unauthorizedScopes);
    }

    /**
     * @inheritDoc
     * @throws InvalidConfigException
     */
    public function getAllowedScopes($requestedScopeIdentifiers = [])
    {
        /** @var Oauth2ClientScopeInterface $clientScopeClass */
        $clientScopeClass = DiHelper::getValidatedClassName(Oauth2ClientScopeInterface::class);
        $clientScopeTableName = $clientScopeClass::tableName();
        /** @var Oauth2ScopeInterface $scopeClass */
        $scopeClass = DiHelper::getValidatedClassName(Oauth2ScopeInterface::class);
        $scopeTableName = $scopeClass::tableName();

        if (is_array($requestedScopeIdentifiers)) {
            $possibleScopesConditions = [
                // Requested and default scopes defined for this client.
                ['AND',
                    [$clientScopeTableName . '.client_id' => $this->getPrimaryKey()],
                    [$clientScopeTableName . '.enabled' => 1],
                    ['OR',
                        ...(
                        !empty($requestedScopeIdentifiers)
                            ? [[$scopeTableName . '.identifier' => $requestedScopeIdentifiers]]
                            : []
                        ),
                        ['NOT', [
                            $clientScopeTableName . '.applied_by_default' => Oauth2ScopeInterface::APPLIED_BY_DEFAULT_NO
                        ]],
                        ['AND',
                            [$clientScopeTableName . '.applied_by_default' => null],
                            ['NOT', [
                                $scopeTableName . '.applied_by_default' => Oauth2ScopeInterface::APPLIED_BY_DEFAULT_NO
                            ]],
                        ],
                    ],
                ],
            ];
        } else {
            if ($requestedScopeIdentifiers === true) {
                $possibleScopesConditions = [
                    // All scopes defined for this client.
                    [$clientScopeTableName . '.enabled' => 1],
                ];
            } else {
                throw new InvalidArgumentException('`$possibleScopesConditions` must be either an array of strings or `true`.'); // phpcs:ignore Generic.Files.LineLength.TooLong
            }
        }

        $allowGenericScopes = $this->getAllowGenericScopes();
        if ($allowGenericScopes) {
            if (is_array($requestedScopeIdentifiers)) {
                // Requested and default scopes defined by scope for all clients.
                $possibleScopesConditions[] = ['AND',
                    [$clientScopeTableName . '.client_id' => null],
                    ['OR',
                        ...(
                        !empty($requestedScopeIdentifiers)
                            ? [[$scopeTableName . '.identifier' => $requestedScopeIdentifiers]]
                            : []
                        ),
                        [
                            'NOT',
                            [$scopeTableName . '.applied_by_default' => Oauth2ScopeInterface::APPLIED_BY_DEFAULT_NO]
                        ],
                    ],
                ];
            } elseif ($requestedScopeIdentifiers === true) {
                // All scopes defined by scope for all clients.
                $possibleScopesConditions[] = [$clientScopeTableName . '.client_id' => null];
            }
        }

        return $scopeClass::find()
            ->joinWith(
                ['clientScopes' => function (Oauth2ClientScopeQuery $query) use ($clientScopeTableName) {
                    $query->andOnCondition([$clientScopeTableName . '.client_id' => $this->getPrimaryKey()]);
                }],
                true
            )
            ->enabled()
            ->andWhere(['OR', ...$possibleScopesConditions])
            ->orderBy('id')
            ->all();
    }

    /**
     * @inheritdoc
     * @return array{

     *     'unaffected': Oauth2ClientScopeInterface[],
     *     'new': Oauth2ClientScopeInterface[],
     *     'updated': Oauth2ClientScopeInterface[],
     *     'deleted': Oauth2ClientScopeInterface[],
     * }
     */
    public function syncClientScopes($scopes, $scopeRepository)
    {
        if (is_string($scopes)) {
            $scopes = array_filter(array_map('trim', explode(' ', $scopes)));
        } elseif ($scopes === null) {
            $scopes = [];
        } elseif (!is_array($scopes)) {
            throw new InvalidArgumentException('$scopes must be a string, an array or null.');
        }

        /** @var class-string<Oauth2ClientScopeInterface> $clientScopeClass */
        $clientScopeClass = DiHelper::getValidatedClassName(Oauth2ClientScopeInterface::class);

        /** @var Oauth2ClientScopeInterface[] $origClientScopes */
        $origClientScopes = $clientScopeClass::findAll([
            'client_id' => $this->getPrimaryKey(),
        ]);

        $origClientScopes = array_combine(
            array_map(
                fn(Oauth2ClientScopeInterface $clientScope) => implode('-', $clientScope->getPrimaryKey(true)),
                $origClientScopes
            ),
            $origClientScopes
        );

        /** @var Oauth2ClientScopeInterface[] $clientScopes */
        $clientScopes = [];

        foreach ($scopes as $key => $value) {
            if ($value instanceof Oauth2ClientScopeInterface) {
                $clientScope = $value;
                $clientScope->client_id = $this->getPrimaryKey(); // Ensure PK is set.

                $pkIndex = implode('-', $clientScope->getPrimaryKey(true));
                if (array_key_exists($pkIndex, $origClientScopes)) {
                    // Overwrite orig (might still be considered "unchanged" when new ClientScope is not "dirty").
                    $origClientScopes[$pkIndex] = $clientScope;
                }
            } else {

                $scopeIdentifier = null;
                $clientScopeConfig = [
                    'client_id' => $this->getPrimaryKey(),
                ];

                if (is_string($value)) {
                    $scopeIdentifier = $value;
                } elseif ($value instanceof Oauth2ScopeInterface) {
                    $scopePk = $value->getPrimaryKey();
                    if ($scopePk) {
                        $clientScopeConfig = ArrayHelper::merge(
                            $clientScopeConfig,
                            ['scope_id' => $scopePk]
                        );
                    } else {
                        // New model, using identifier.
                        $scopeIdentifier = $value->getIdentifier();
                    }
                } elseif (is_array($value)) {
                    $clientScopeConfig = ArrayHelper::merge(
                        $clientScopeConfig,
                        $value,
                    );
                    if (empty($clientScopeConfig['scope_id'])) {
                        $scopeIdentifier = $key;
                    }
                } else {
                    throw new InvalidArgumentException(
                        'If $scopes is an array, its values must be a string, array or an instance of '
                        . Oauth2ClientScopeInterface::class . ' or ' . Oauth2ScopeInterface::class . '.'
                    );
                }

                if (isset($scopeIdentifier)) {
                    $scope = $scopeRepository->getScopeEntityByIdentifier($scopeIdentifier);
                    if (empty($scope)) {
                        throw new InvalidArgumentException('No scope with identifier "'
                            . $scopeIdentifier . '" found.');
                    }
                    if (!($scope instanceof Oauth2ScopeInterface)) {
                        throw new InvalidConfigException(get_class($scope)
                            . ' must implement ' . Oauth2ScopeInterface::class);
                    }
                    $clientScopeConfig['scope_id'] = $scope->getPrimaryKey();
                } else {
                    if (empty($clientScopeConfig['scope_id'])) {
                        throw new InvalidArgumentException('Element ' . $key
                            . ' in $scope should specify either the scope id or its identifier.');
                    }
                }

                $pkIndex = $clientScopeConfig['client_id'] . '-' . $clientScopeConfig['scope_id'];
                if (array_key_exists($pkIndex, $origClientScopes)) {
                    $clientScope = $origClientScopes[$pkIndex];
                    $clientScope->setAttributes($clientScopeConfig, false);
                } else {
                    /** @var Oauth2ClientScopeInterface $clientScope */
                    $clientScope = Yii::createObject(ArrayHelper::merge(
                        ['class' => $clientScopeClass],
                        $clientScopeConfig
                    ));
                }
            }

            $pkIndex = implode('-', $clientScope->getPrimaryKey(true));
            $clientScopes[$pkIndex] = $clientScope;
        }

        $transaction = static::getDb()->beginTransaction();
        try {
            // Delete records no longer present in the provided data.
            /** @var self[]|array[] $deleteClientScopes */
            $deleteClientScopes = array_diff_key($origClientScopes, $clientScopes);
            foreach ($deleteClientScopes as $deleteClientScope) {
                $deleteClientScope->delete();
            }

            // Create records not present in the provided data.
            $createClientScopes = array_diff_key($clientScopes, $origClientScopes);
            foreach ($createClientScopes as $createClientScope) {
                $createClientScope->persist();
            }

            // Update existing records if needed.
            $unaffectedClientScopes = [];
            $updatedClientScopes = [];
            foreach (array_intersect_key($origClientScopes, $clientScopes) as $key => $existingClientScope) {
                if ($existingClientScope->getDirtyAttributes()) {
                    $existingClientScope->persist();
                    $updatedClientScopes[$key] = $existingClientScope;
                } else {
                    $unaffectedClientScopes[$key] = $existingClientScope;
                }
            }

            $transaction->commit();
        } catch (\Exception $e) {
            $transaction->rollBack();
            throw $e;
        }

        return [
            'unaffected' => $unaffectedClientScopes,
            'new' => $createClientScopes,
            'updated' => $updatedClientScopes,
            'deleted' => $deleteClientScopes,
        ];
    }
}

rhertogh / yii2-oauth2-server

setSkipAuthorizationIfScopeIsAllowed() A last analyzed 2025-04-24 08:00 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

setSkipAuthorizationIfScopeIsAllowed() A
last analyzed 2025-04-24 08:00 UTC
