CasAuthenticator::getUser() - Code Metrics - Inspection of "Version 3 - Work in progress" - ecphp/cas-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#59)

by Pol
created 2022-04-21 11:10 UTC
CasAuthenticator::getUser() A

↳ Parent: CasAuthenticator
Complexity

Conditions	3
Paths	3
Size

Total Lines	18
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	10
nc	3
nop	2
dl	0
loc	18
rs	9.9332
c	0
b	0
f	0
<?php

/**
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @see https://github.com/ecphp
 */

declare(strict_types=1);

namespace EcPhp\CasBundle\Security;

use EcPhp\CasBundle\Security\Core\User\CasUser;
use EcPhp\CasBundle\Security\Core\User\CasUserProviderInterface;
use EcPhp\CasLib\Contract\CasInterface;
use EcPhp\CasLib\Contract\Response\Type\ServiceValidate;
use EcPhp\CasLib\Utils\Uri;
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Bridge\PsrHttpMessage\HttpFoundationFactoryInterface;
use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
use Throwable;

final class CasAuthenticator extends AbstractAuthenticator
{
    private CasInterface $cas;

    private HttpFoundationFactoryInterface $httpFoundationFactory;

    private HttpMessageFactoryInterface $httpMessageFactory;

    public function __construct(
        CasInterface $cas,
        HttpMessageFactoryInterface $httpMessageFactory,
        HttpFoundationFactoryInterface $httpFoundationFactory
    ) {
        $this->cas = $cas;
        $this->httpMessageFactory = $httpMessageFactory;
        $this->httpFoundationFactory = $httpFoundationFactory;
    }

    public function authenticate(Request $request): Passport
    {
        try {
            $response = $this
                ->cas
                ->requestTicketValidation(
                    $this->httpMessageFactory->createRequest($request)
                );
        } catch (Throwable $exception) {
            throw new AuthenticationException(
                sprintf('Unable to authenticate the user with such service ticket: %s', $exception->getMessage()),
                0,
                $exception
            );
        }

        if (false === ($response instanceof ServiceValidate)) {
            throw new AuthenticationException(
                'Failure in the returned response'
            );
        }

        /** @var ServiceValidate $response */
        $payload = $response->getCredentials();

        return new SelfValidatingPassport(
            new UserBadge(
                $payload['user'],
                static fn (string $identifier): UserInterface => new CasUser($payload)
                static fn (/** @scrutinizer ignore-unused */ string $identifier): UserInterface => new CasUser($payload)
            )
        );
    }

    public function getUser($credentials, UserProviderInterface $userProvider): ?UserInterface
    {
        if (false === ($userProvider instanceof CasUserProviderInterface)) {
            throw new AuthenticationException('Unable to load the user through the given User Provider.');
        }

        if (false === ($credentials instanceof ServiceValidate)) {
            throw new AuthenticationException(
                'Failure in the returned response'
            );
        }

        $payload = $credentials->getCredentials();

        return new SelfValidatingPassport(

            new UserBadge(
                $payload['user'],
                static fn (string $identifier): UserInterface => new CasUser($payload)
                static fn (/** @scrutinizer ignore-unused */ string $identifier): UserInterface => new CasUser($payload)
            )
        );
    }

    public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
    {
        $uri = $this->toPsr($request)->getUri();

        if (false === Uri::hasParams($uri, 'ticket')) {
            return null;
        }

        // Remove the ticket parameter.
        $uri = Uri::removeParams(
            $uri,
            'ticket'
        );

        return new RedirectResponse((string) Uri::withParam($uri, 'renew', 'true'));
    }

    public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): Response
    {
        return new RedirectResponse(
            (string) Uri::removeParams(
                $this->toPsr($request)->getUri(),
                'ticket',
                'renew'
            )
        );
    }

    public function start(Request $request, ?AuthenticationException $authException = null): Response
    public function start(Request $request, /** @scrutinizer ignore-unused */ ?AuthenticationException $authException = null): Response
    {
        if (true === $request->isXmlHttpRequest()) {
            return new JsonResponse(
                ['message' => 'Authentication required'],
                Response::HTTP_UNAUTHORIZED
            );
        }

        try {
            $response = $this
                ->cas
                ->login($this->toPsr($request));
        } catch (Throwable $exception) {
            throw new AuthenticationException(
                'Unable to trigger the login procedure',
                0,
                $exception
            );
        }

        return $this->httpFoundationFactory->createResponse($response);
    }

    public function supports(Request $request): bool
    {
        return $this
            ->cas
            ->supportAuthentication(
                $this->toPsr($request)
            );
    }

    /**
     * Convert a Symfony request into a PSR Request.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The Symfony request.
     *
     * @return \Psr\Http\Message\ServerRequestInterface
     *   The PSR request.
     */
    private function toPsr(Request $request): ServerRequestInterface
    {
        // As we cannot decorate the Symfony Request object, we convert it into
        // a PSR Request so we can override the PSR HTTP Message factory if
        // needed.
        // See the reasons at https://github.com/ecphp/cas-lib/issues/5
        return $this->httpMessageFactory->createRequest($request);
    }
}

ecphp / cas-bundle

Pull Request — master (#59)

CasAuthenticator::getUser() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
