rhertogh\Yii2Oauth2Server\controllers\console\debug\Oauth2DebugConfigAction

Complexity

Total Complexity

26

Size/Duplication

Total Lines	197
Duplicated Lines	0 %

Test Coverage

Coverage

98.5%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	22	1
F	getConfiguration()	0	86	19
B	getEndpoints()	0	74	6

<?php

namespace rhertogh\Yii2Oauth2Server\controllers\console\debug;

use League\OAuth2\Server\Grant\GrantTypeInterface;
use rhertogh\Yii2Oauth2Server\controllers\console\Oauth2DebugController;
use rhertogh\Yii2Oauth2Server\helpers\DateIntervalHelper;
use rhertogh\Yii2Oauth2Server\Oauth2Module;
use yii\base\Action;
use yii\console\ExitCode;
use yii\console\widgets\Table;
use yii\helpers\VarDumper;
use yii\log\Logger;

/**
 * @property Oauth2DebugController $controller
 */
class Oauth2DebugConfigAction extends Action
{
    public function run()
    {
        $module = $this->controller->module;

        $configuration = $this->getConfiguration($module);

        $this->controller->stdout('Configuration:' . PHP_EOL);
        $this->controller->stdout(Table::widget([
            'headers' => ['Setting', 'Value'],
            'rows' => array_map(fn($setting) => [$setting, $configuration[$setting]], array_keys($configuration)),
        ]));

        $endpoints = $this->getEndpoints($module);

        $this->controller->stdout(PHP_EOL);
        $this->controller->stdout('Endpoints:' . PHP_EOL);
        $this->controller->stdout(Table::widget([
            'headers' => ['Endpoint', 'URL', 'Setting(s)'],
            'rows' => $endpoints,
        ]));

        return ExitCode::OK;
    }

    /**
     * @param Oauth2Module $module
     * @return array
     */
    protected function getConfiguration($module)
    {
        $serverRoles = [];
        if ($module->serverRole & Oauth2Module::SERVER_ROLE_AUTHORIZATION_SERVER) {
            $serverRoles[] = 'Authorization Server';
            $grantTypes = array_values(array_map(
                fn(GrantTypeInterface $grant) => $grant->getIdentifier(),
                $module->getAuthorizationServer()->getEnabledGrantTypes()
            ));
            $defaultAccessTokenTTL = DateIntervalHelper::toString($module->getDefaultAccessTokenTTL()) ?? '[NOT SET]';
        } else {
            $grantTypes = '-';
            $defaultAccessTokenTTL = '-';
        }

        if ($module->serverRole & Oauth2Module::SERVER_ROLE_RESOURCE_SERVER) {
            $serverRoles[] = 'Resource Server';
        }

        $privateKey = $module->privateKey ? '[SET]' : '[NOT SET]';
        $privateKeyPassphrase = $module->privateKeyPassphrase ? '[SET]' : '[NOT SET]';
        $publicKey = $module->publicKey ? '[SET]' : '[NOT SET]';
        $codesEncryptionKey = $module->codesEncryptionKey ? '[SET]' : '[NOT SET]';
        $storageEncryptionKeys = $module->storageEncryptionKeys ? '[SET]' : '[NOT SET]';

        $clientRedirectUrisEnvVarConfig = $module->clientRedirectUrisEnvVarConfig
            ? VarDumper::export($module->clientRedirectUrisEnvVarConfig)
            : '';

        $httpClientErrorsLogLevel = $module->getElaboratedHttpClientErrorsLogLevel();

        return [
            'serverRole' => $module->serverRole . ' (' . implode(', ', $serverRoles) . ')',

            'privateKey' => $privateKey,
            'privateKeyPassphrase' => $privateKeyPassphrase,
            'publicKey' => $publicKey,
            'codesEncryptionKey' => $codesEncryptionKey,
            'storageEncryptionKeys' => $storageEncryptionKeys,
            'defaultStorageEncryptionKey' => $module->defaultStorageEncryptionKey,

            'nonTlsAllowedRanges' => $module->nonTlsAllowedRanges,

            'clientRedirectUrisEnvVarConfig' => $clientRedirectUrisEnvVarConfig,

            'identityClass' => $module->identityClass,

            'urlRulesPrefix' => $module->urlRulesPrefix,
            'authorizePath' => $module->authorizePath,
            'accessTokenPath' => $module->accessTokenPath,
            'jwksPath' => $module->jwksPath,
            'clientAuthorizationUrl' => $module->clientAuthorizationUrl,
            'clientAuthorizationPath' => $module->clientAuthorizationPath,
            'clientAuthorizationView' => $module->clientAuthorizationView,
            'openIdConnectUserinfoPath' => $module->openIdConnectUserinfoPath,
            'openIdConnectRpInitiatedLogoutPath' => $module->openIdConnectRpInitiatedLogoutPath,

            'exceptionOnInvalidScope' => $module->exceptionOnInvalidScope,

            'grantTypes' => $grantTypes,

            'defaultAccessTokenTTL' => $defaultAccessTokenTTL,
            'resourceServerAccessTokenRevocationValidation' => $module->resourceServerAccessTokenRevocationValidation,

            'enableOpenIdConnect' => $module->enableOpenIdConnect ? 'true' : 'false',
            'enableOpenIdConnectDiscovery' => $module->enableOpenIdConnectDiscovery ? 'true' : 'false',
            'openIdConnectProviderConfigurationInformationPath' =>
                $module->openIdConnectProviderConfigurationInformationPath,
            'openIdConnectDiscoveryIncludeSupportedGrantTypes' =>
                $module->openIdConnectDiscoveryIncludeSupportedGrantTypes ? 'true' : 'false',
            'openIdConnectUserinfoEndpoint' => $module->openIdConnectUserinfoEndpoint ? 'true' : 'false',
            'openIdConnectRpInitiatedLogoutEndpoint' => $module->openIdConnectRpInitiatedLogoutEndpoint ? 'true' : 'false',
            'openIdConnectAllowAnonymousRpInitiatedLogout' => $module->openIdConnectAllowAnonymousRpInitiatedLogout ? 'true' : 'false',
            'openIdConnectDiscoveryServiceDocumentationUrl' => $module->openIdConnectDiscoveryServiceDocumentationUrl,
            'openIdConnectIssueRefreshTokenWithoutOfflineAccessScope' =>
                $module->openIdConnectIssueRefreshTokenWithoutOfflineAccessScope ? 'true' : 'false',

            'defaultUserAccountSelection' => $module->defaultUserAccountSelection,

            'displayConfidentialExceptionMessages' => $module->displayConfidentialExceptionMessages === null
                ? 'null'
                : ($module->displayConfidentialExceptionMessages ? 'true' : 'false'),

            'httpClientErrorsLogLevel' => $httpClientErrorsLogLevel === 0
                ? 'disabled'
                : Logger::getLevelName($httpClientErrorsLogLevel),
        ];
    }

    /**
     * @param Oauth2Module $module
     * @return array
     */
    protected function getEndpoints($module)
    {
        if ($module->serverRole & Oauth2Module::SERVER_ROLE_AUTHORIZATION_SERVER) {
            $authorizeClientValue = $module->urlRulesPrefix . '/' . $module->authorizePath;
            $authorizeClientSettings = 'urlRulesPrefix, authorizePath';

            $accessTokenValue = $module->urlRulesPrefix . '/' . $module->accessTokenPath;
            $accessTokenSettings = 'urlRulesPrefix, accessTokenPath';

            $jwksValue = $module->urlRulesPrefix . '/' . $module->jwksPath;
            $jwksSettings = 'urlRulesPrefix, jwksPath';

            $clientAuthorizationValue = $module->urlRulesPrefix . '/' . $module->clientAuthorizationPath;
            $clientAuthorizationSettings = 'urlRulesPrefix, clientAuthorizationPath';

            if ($module->enableOpenIdConnect) {
                if ($module->enableOpenIdConnectDiscovery) {
                    $oidcProviderConfigInfoValue = $module->openIdConnectProviderConfigurationInformationPath;
                    $oidcProviderConfigInfoSettings = 'openIdConnectProviderConfigurationInformationPath';
                } else {
                    $oidcProviderConfigInfoValue = '[OpenId Connect Discovery is disabled]';
                    $oidcProviderConfigInfoSettings = 'enableOpenIdConnectDiscovery';
                }

                if (!empty($module->openIdConnectUserinfoEndpoint)) {
                    if ($module->openIdConnectUserinfoEndpoint === true) {
                        $oidcUserinfoValue = $module->urlRulesPrefix . '/' . $module->openIdConnectUserinfoPath;
                        $oidcUserinfoSettings = 'urlRulesPrefix, openIdConnectUserinfoPath';
                    } else {
                        $oidcUserinfoValue = $module->openIdConnectUserinfoEndpoint;
                        $oidcUserinfoSettings = 'openIdConnectUserinfoEndpoint';
                    }
                } else {
                    $oidcUserinfoValue = '[Userinfo Endpoint is disabled]';
                    $oidcUserinfoSettings = 'openIdConnectUserinfoEndpoint';
                }
            } else {
                $oidcProviderConfigInfoValue = '[OpenID Connect is disabled]';
                $oidcProviderConfigInfoSettings = 'enableOpenIdConnect';

                $oidcUserinfoValue = '[OpenID Connect is disabled]';
                $oidcUserinfoSettings = 'enableOpenIdConnect';
            }
        } else {
            $authorizeClientValue = '[Only available for "authorization_server" role]';
            $authorizeClientSettings = 'serverRole';

            $accessTokenValue = '[Only available for "authorization_server" role]';
            $accessTokenSettings = 'serverRole';

            $jwksValue = '[Only available for "authorization_server" role]';
            $jwksSettings = 'serverRole';

            $clientAuthorizationValue = '[Only available for "authorization_server" role]';
            $clientAuthorizationSettings = 'serverRole';

            $oidcProviderConfigInfoValue = '[Only available for "authorization_server" role]';
            $oidcProviderConfigInfoSettings = 'serverRole';

            $oidcUserinfoValue = '[Only available for "authorization_server" role]';
            $oidcUserinfoSettings = 'serverRole';
        }

        return [
            'authorizeClient' => ['Authorize Client', $authorizeClientValue, $authorizeClientSettings],
            'accessToken' => ['Access Token', $accessTokenValue, $accessTokenSettings],
            'jwks' => ['JSON Web Key Sets', $jwksValue, $jwksSettings],
            'clientAuthorization' => ['Client Authorization', $clientAuthorizationValue, $clientAuthorizationSettings],
            'oidcProviderConfigInfo' => [
                'OpenID Connect Provider Configuration Information',
                $oidcProviderConfigInfoValue,
                $oidcProviderConfigInfoSettings,
            ],
            'oidcUserinfo' => ['OpenId Connect Userinfo', $oidcUserinfoValue, $oidcUserinfoSettings],
        ];
    }
}