Cas30Controller::samlValidate() - Code Metrics - Inspection of "SSP-2066_add_routes_and_controllers" - simplesamlphp/simplesamlphp-module-casserver - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#45)

unknown

created 2025-01-02 19:39 UTC

Cas30Controller::samlValidate() B

↳ Parent: Cas30Controller

Complexity

Conditions	8
Paths	7

Size

Total Lines	57
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	29
c	2
b	0
f	0
dl	0
loc	57
rs	8.2114
cc	8
nc	7
nop	2

How to fix Long Method

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\casserver\Controller;

use DOMXPath;
use SAML2\DOMDocumentFactory;
use SimpleSAML\Configuration;
use SimpleSAML\Logger;
use SimpleSAML\Module\casserver\Cas\Protocol\Cas20;
use SimpleSAML\Module\casserver\Cas\Protocol\SamlValidateResponder;
use SimpleSAML\Module\casserver\Cas\TicketValidator;
use SimpleSAML\Module\casserver\Controller\Traits\UrlTrait;
use SimpleSAML\Module\casserver\Http\XmlResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;

#[AsController]
class Cas30Controller
{
    use UrlTrait;


    /** @var Logger */
    protected Logger $logger;

    /** @var Configuration */
    protected Configuration $casConfig;

    /** @var Cas20 */
    protected Cas20 $cas20Protocol;

    /** @var TicketValidator */
    protected TicketValidator $ticketValidator;

    /** @var SamlValidateResponder */
    protected SamlValidateResponder $validateResponder;

    /**
     * @param   Configuration         $sspConfig
     * @param   Configuration|null    $casConfig
     * @param   TicketValidator|null  $ticketValidator
     *
     * @throws \Exception
     */
    public function __construct(
        private readonly Configuration $sspConfig,
        Configuration $casConfig = null,
        TicketValidator $ticketValidator = null,
    ) {
        // We are using this work around in order to bypass Symfony's autowiring for cas configuration. Since
        // the configuration class is the same, it loads the ssp configuration twice. Still, we need the constructor
        // argument in order to facilitate testin.
        $this->casConfig = ($casConfig === null || $casConfig === $sspConfig)
            ? Configuration::getConfig('module_casserver.php') : $casConfig;
        $this->cas20Protocol = new Cas20($this->casConfig);
        $this->ticketValidator   = $ticketValidator ?? new TicketValidator($this->casConfig);
        $this->validateResponder = new SamlValidateResponder();
    }


    /**
     * POST /casserver/samlValidate?TARGET=
     * Host: cas.example.com
     * Content-Length: 491
     * Content-Type: text/xml
     *
     * @param   Request  $request
     * @param   string   $TARGET  URL encoded service identifier of the back-end service.
     *
     * @throws \RuntimeException
     * @return XmlResponse
     * @link https://apereo.github.io/cas/7.1.x/protocol/CAS-Protocol-Specification.html#42-samlvalidate-cas-30
     */
    public function samlValidate(
        Request $request,
        #[MapQueryParameter] string $TARGET,
    ): XmlResponse {
        // From SAML2\SOAP::receive()
        $postBody = $request->getContent();
        if (empty($postBody)) {
            throw new \RuntimeException('samlValidate expects a soap body.');
        }

        // SAML request values
        //
        // samlp:Request
        //  - RequestID [REQUIRED] - unique identifier for the request
        //  - IssueInstant [REQUIRED] - timestamp of the request
        // samlp:AssertionArtifact [REQUIRED] - the valid CAS Service

        $documentBody = DOMDocumentFactory::fromString($postBody);
        $xPath = new DOMXpath($documentBody);
        $xPath->registerNamespace('soap-env', 'http://schemas.xmlsoap.org/soap/envelope/');
        $samlRequestAttributes = $xPath->query('/soap-env:Envelope/soap-env:Body/*');

        // Check for the required saml attributes
        if (!$samlRequestAttributes->item(0)->hasAttribute('RequestID')) {
        if (!$samlRequestAttributes->item(0)->/** @scrutinizer ignore-call */ hasAttribute('RequestID')) {
            throw new \RuntimeException('Missing RequestID samlp:Request attribute.');
        } elseif (!$samlRequestAttributes->item(0)->hasAttribute('IssueInstant')) {
            throw new \RuntimeException('Missing IssueInstant samlp:Request attribute.');
        }

        $assertionArtifactNode = $samlRequestAttributes->item(0)->getElementsByTagName('AssertionArtifact');
        if (
            $assertionArtifactNode->count() === 0
            || empty($assertionArtifactNode->item(0)->nodeValue)
        ) {
            throw new \RuntimeException('Missing ticketId in AssertionArtifact');
        }

        $ticketId = $assertionArtifactNode->item(0)->nodeValue;
        Logger::debug('samlvalidate: Checking ticket ' . $ticketId);

        try {
            // validateAndDeleteTicket might throw a CasException. In order to avoid third party modules
            // dependencies, we will catch and rethrow the Exception.
            $ticket = $this->ticketValidator->validateAndDeleteTicket($ticketId, $TARGET);
        } catch (\Exception $e) {
            throw new \RuntimeException($e->getMessage());
        }
        if (!\is_array($ticket)) {

            throw new \RuntimeException('Error loading ticket');
        }

        $response = $this->validateResponder->convertToSaml($ticket);
        $soap     = $this->validateResponder->wrapInSoap($response);

        return new XmlResponse(
            (string)$soap,
            Response::HTTP_OK,
        );
    }
}


simplesamlphp / simplesamlphp-module-casserver

Pull Request — master (#45)

Cas30Controller::samlValidate() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like