RequestRulesManagerFactory.php

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\oidc\Factories;

use SimpleSAML\Module\oidc\Bridges\SspBridge;
use SimpleSAML\Module\oidc\Factories\Entities\ClientEntityFactory;
use SimpleSAML\Module\oidc\Helpers;
use SimpleSAML\Module\oidc\ModuleConfig;
use SimpleSAML\Module\oidc\Repositories\ClientRepository;
use SimpleSAML\Module\oidc\Repositories\CodeChallengeVerifiersRepository;
use SimpleSAML\Module\oidc\Repositories\ScopeRepository;
use SimpleSAML\Module\oidc\Server\RequestRules\RequestRulesManager;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\AcrValuesRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\AddClaimsToIdTokenRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\AuthorizationDetailsRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ClientAuthenticationRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ClientIdRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ClientRedirectUriRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ClientRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\CodeChallengeMethodRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\CodeChallengeRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\CodeVerifierRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\IdTokenHintRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\IssuerStateRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\MaxAgeRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\PostLogoutRedirectUriRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\PromptRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\RequestedClaimsRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\RequestObjectRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\RequiredNonceRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\RequiredOpenIdScopeRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ResponseTypeRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ScopeOfflineAccessRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ScopeRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\StateRule;
use SimpleSAML\Module\oidc\Server\RequestRules\Rules\UiLocalesRule;
use SimpleSAML\Module\oidc\Services\AuthenticationService;
use SimpleSAML\Module\oidc\Services\LoggerService;
use SimpleSAML\Module\oidc\Utils\ClaimTranslatorExtractor;
use SimpleSAML\Module\oidc\Utils\FederationCache;
use SimpleSAML\Module\oidc\Utils\FederationParticipationValidator;
use SimpleSAML\Module\oidc\Utils\JwksResolver;
use SimpleSAML\Module\oidc\Utils\ProtocolCache;
use SimpleSAML\Module\oidc\Utils\RequestParamsResolver;
use SimpleSAML\OpenID\Federation;

class RequestRulesManagerFactory
{
    public function __construct(
        private readonly ModuleConfig $moduleConfig,
        private readonly LoggerService $logger,
        private readonly ClientRepository $clientRepository,
        private readonly AuthSimpleFactory $authSimpleFactory,
        private readonly AuthenticationService $authenticationService,
        private readonly ScopeRepository $scopeRepository,
        private readonly CodeChallengeVerifiersRepository $codeChallengeVerifiersRepository,
        private readonly ClaimTranslatorExtractor $claimTranslatorExtractor,
        private readonly CryptKeyFactory $cryptKeyFactory,
        private readonly RequestParamsResolver $requestParamsResolver,
        private readonly ClientEntityFactory $clientEntityFactory,
        private readonly Federation $federation,
        private readonly Helpers $helpers,
        private readonly JwksResolver $jwksResolver,
        private readonly FederationParticipationValidator $federationParticipationValidator,
        private readonly SspBridge $sspBridge,
        private readonly ?FederationCache $federationCache = null,
        private readonly ?ProtocolCache $protocolCache = null,
    ) {
    }

    /**
     * @param \SimpleSAML\Module\oidc\Server\RequestRules\Interfaces\RequestRuleInterface[]|null $rules
     * @return \SimpleSAML\Module\oidc\Server\RequestRules\RequestRulesManager
     */
    public function build(?array $rules = null): RequestRulesManager
    {
        $rules = $rules ?? $this->getDefaultRules();
        return new RequestRulesManager($rules, $this->logger);
    }

    /**
     * @return \SimpleSAML\Module\oidc\Server\RequestRules\Interfaces\RequestRuleInterface[]
     */
    private function getDefaultRules(): array
    {
        return [
            new StateRule($this->requestParamsResolver, $this->helpers),
            new IssuerStateRule($this->requestParamsResolver, $this->helpers),
            new ClientRule(
                $this->requestParamsResolver,
                $this->helpers,
                $this->clientRepository,
                $this->moduleConfig,
                $this->clientEntityFactory,
                $this->federation,
                $this->jwksResolver,
                $this->federationParticipationValidator,
                $this->logger,
                $this->federationCache,
            ),
            new ClientRedirectUriRule($this->requestParamsResolver, $this->helpers, $this->moduleConfig),
            new RequestObjectRule($this->requestParamsResolver, $this->helpers, $this->jwksResolver),
            new PromptRule(
                $this->requestParamsResolver,
                $this->helpers,
                $this->authSimpleFactory,
                $this->authenticationService,
                $this->sspBridge,
            ),
            new MaxAgeRule(
                $this->requestParamsResolver,
                $this->helpers,
                $this->authSimpleFactory,
                $this->authenticationService,
                $this->sspBridge,
            ),
            new ScopeRule($this->requestParamsResolver, $this->helpers, $this->scopeRepository),
            new RequiredOpenIdScopeRule($this->requestParamsResolver, $this->helpers),
            new CodeChallengeRule($this->requestParamsResolver, $this->helpers),
            new CodeChallengeMethodRule(
                $this->requestParamsResolver,
                $this->helpers,
                $this->codeChallengeVerifiersRepository,
            ),
            new RequestedClaimsRule($this->requestParamsResolver, $this->helpers, $this->claimTranslatorExtractor),
            new AddClaimsToIdTokenRule($this->requestParamsResolver, $this->helpers),
            new RequiredNonceRule($this->requestParamsResolver, $this->helpers),
            new ResponseTypeRule($this->requestParamsResolver, $this->helpers),
            new IdTokenHintRule(
                $this->requestParamsResolver,
                $this->helpers,
                $this->moduleConfig,
                $this->cryptKeyFactory,
            ),
            new PostLogoutRedirectUriRule($this->requestParamsResolver, $this->helpers, $this->clientRepository),
            new UiLocalesRule($this->requestParamsResolver, $this->helpers),
            new AcrValuesRule($this->requestParamsResolver, $this->helpers),
            new ScopeOfflineAccessRule($this->requestParamsResolver, $this->helpers),
            new ClientAuthenticationRule(
                $this->requestParamsResolver,
                $this->helpers,
                $this->moduleConfig,
                $this->jwksResolver,
                $this->protocolCache,
            ),
            new CodeVerifierRule($this->requestParamsResolver, $this->helpers),
            new AuthorizationDetailsRule($this->requestParamsResolver, $this->helpers, $this->moduleConfig),
            new ClientIdRule($this->requestParamsResolver, $this->helpers),
        ];
    }
}