Cas20Controller::validate() - 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 2024-11-26 17:47 UTC

Cas20Controller::validate() D

↳ Parent: Cas20Controller

Complexity

Conditions	19
Paths	53

Size

Total Lines	138
Code Lines	84

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	84
c	1
b	0
f	0
dl	0
loc	138
rs	4.5166
cc	19
nc	53
nop	7

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\casserver\Controller;

use SimpleSAML\CAS\Constants as C;
use SimpleSAML\Configuration;
use SimpleSAML\Logger;
use SimpleSAML\Module\casserver\Cas\Factories\TicketFactory;
use SimpleSAML\Module\casserver\Cas\Protocol\Cas20;
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 Cas20Controller
{
    use UrlTrait;


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

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

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

    /** @var TicketFactory */
    protected TicketFactory $ticketFactory;

    // this could be any configured ticket store
    protected mixed $ticketStore;

    /**
     * @param   Configuration       $sspConfig
     * @param   Configuration|null  $casConfig
     * @param                       $ticketStore
     *
     * @throws \Exception
     */
    public function __construct(
        private readonly Configuration $sspConfig,
        Configuration $casConfig = null,
        $ticketStore = 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 testing
        $this->casConfig = ($casConfig === null || $casConfig === $sspConfig)
            ? Configuration::getConfig('module_casserver.php') : $casConfig;
        $this->cas20Protocol = new Cas20($this->casConfig);
        /* Instantiate ticket factory */
        $this->ticketFactory = new TicketFactory($this->casConfig);
        /* Instantiate ticket store */
        $ticketStoreConfig = $this->casConfig->getOptionalValue(
            'ticketstore',
            ['class' => 'casserver:FileSystemTicketStore'],
        );
        $ticketStoreClass  = 'SimpleSAML\\Module\\casserver\\Cas\\Ticket\\'
            . explode(':', $ticketStoreConfig['class'])[1];
        $this->ticketStore = $ticketStore ?? new $ticketStoreClass($this->casConfig);
    }

    /**
     * @param   Request      $request
     * @param   string       $TARGET // todo: this should go away
     * @param   bool  $renew  [OPTIONAL] - if this parameter is set, ticket validation will only succeed
     *                        if the service ticket was issued from the presentation of the user’s primary
     *                        credentials. It will fail if the ticket was issued from a single sign-on session.
     * @param   string|null  $ticket  [REQUIRED] - the service ticket issued by /login
     * @param   string|null  $service [REQUIRED] - the identifier of the service for which the ticket was issued
     * @param   string|null  $pgtUrl  [OPTIONAL] - the URL of the proxy callback
     *
     * @return XmlResponse
     */
    public function serviceValidate(
        Request $request,
        #[MapQueryParameter] string $TARGET = '',
        #[MapQueryParameter] bool $renew = false,
        #[MapQueryParameter] ?string $ticket = null,
        #[MapQueryParameter] ?string $service = null,
        #[MapQueryParameter] ?string $pgtUrl = null,
    ): XmlResponse {
        return $this->validate(
            request: $request,
            method:  'serviceValidate',
            target:  $TARGET,
            renew:   $renew,
            ticket:  $ticket,
            service: $service,
            pgtUrl:  $pgtUrl,
        );
    }

    /**
     * @param   Request      $request
     * @param   string       $TARGET  // todo: this should go away???
     * @param   bool  $renew  [OPTIONAL] - if this parameter is set, ticket validation will only succeed
     *                        if the service ticket was issued from the presentation of the user’s primary
     *                        credentials. It will fail if the ticket was issued from a single sign-on session.
     * @param   string|null  $ticket  [REQUIRED] - the service ticket issued by /login
     * @param   string|null  $service  [REQUIRED] - the identifier of the service for which the ticket was issued
     * @param   string|null  $pgtUrl  [OPTIONAL] - the URL of the proxy callback
     * @return XmlResponse
     */
    public function proxyValidate(
        Request $request,
        #[MapQueryParameter] string $TARGET = '',
        #[MapQueryParameter] bool $renew = false,
        #[MapQueryParameter] ?string $ticket = null,
        #[MapQueryParameter] ?string $service = null,
        #[MapQueryParameter] ?string $pgtUrl = null,
    ): XmlResponse {
        return $this->validate(
            request: $request,
            method:  'proxyValidate',
            target:  $TARGET,
            renew:   $renew,
            ticket:  $ticket,
            service: $service,
            pgtUrl:  $pgtUrl,
        );
    }

    /**
     * @param   Request      $request
     * @param   string       $method
     * @param   string       $target
     * @param   bool         $renew
     * @param   string|null  $ticket
     * @param   string|null  $service
     * @param   string|null  $pgtUrl
     *
     * @return XmlResponse
     */
    public function validate(
        Request $request,
        string $method,
        string $target,
        bool $renew = false,
        ?string $ticket = null,
        ?string $service = null,
        ?string $pgtUrl = null,
    ): XmlResponse {
        $forceAuthn = $renew;
        // todo: According to the protocol, there is no target??? Why are we using it?
        $serviceUrl = $service ?? $target ?? null;

        // Check if any of the required query parameters are missing
        if ($serviceUrl === null || $ticket === null) {
            $messagePostfix = $serviceUrl === null ? 'service' : 'ticket';
            $message        = "casserver: Missing service parameter: [{$messagePostfix}]";
            Logger::debug($message);

            ob_start();
            echo $this->cas20Protocol->getValidateFailureResponse(C::ERR_INVALID_SERVICE, $message);
            $responseContent = ob_get_clean();

            return new XmlResponse(
                $responseContent,
                Response::HTTP_BAD_REQUEST,
            );
        }

        try {
            // Get the service ticket
            // `getTicket` uses the unserializable method and Objects may throw Throwables in their
            // unserialization handlers.
            $serviceTicket = $this->ticketStore->getTicket($ticket);
            // Delete the ticket
            $this->ticketStore->deleteTicket($ticket);
        } catch (\Exception $e) {
            $message = 'casserver:serviceValidate: internal server error. ' . var_export($e->getMessage(), true);
            Logger::error($message);

            ob_start();
            echo $this->cas20Protocol->getValidateFailureResponse(C::ERR_INVALID_SERVICE, $message);
            $responseContent = ob_get_clean();

            return new XmlResponse(
                $responseContent,
                Response::HTTP_INTERNAL_SERVER_ERROR,
            );
        }

        $failed  = false;
        $message = '';
        if (empty($serviceTicket)) {
            // No ticket
            $message = 'ticket: ' . var_export($ticket, true) . ' not recognized';
            $failed  = true;
        } elseif ($method === 'serviceValidate' && $this->ticketFactory->isProxyTicket($serviceTicket)) {
            $message = 'Ticket ' . var_export($_GET['ticket'], true) .
                ' is a proxy ticket. Use proxyValidate instead.';
            $failed  = true;
        } elseif (!$this->ticketFactory->isServiceTicket($serviceTicket)) {
            // This is not a service ticket
            $message = 'ticket: ' . var_export($ticket, true) . ' is not a service ticket';
            $failed  = true;
        } elseif ($this->ticketFactory->isExpired($serviceTicket)) {
            // the ticket has expired
            $message = 'Ticket has ' . var_export($ticket, true) . ' expired';
            $failed  = true;
        } elseif ($this->sanitize($serviceTicket['service']) !== $this->sanitize($serviceUrl)) {
            // The service url we passed to the query parameters does not match the one in the ticket.
            $message = 'Mismatching service parameters: expected ' .
                var_export($serviceTicket['service'], true) .
                ' but was: ' . var_export($serviceUrl, true);
            $failed  = true;
        } elseif ($forceAuthn && !$serviceTicket['forceAuthn']) {
            // If `forceAuthn` is required but not set in the ticket
            $message = 'Ticket was issued from single sign on session';
            $failed  = true;
        }

        if ($failed) {
            $finalMessage = 'casserver:validate: ' . $message;
            Logger::error($finalMessage);

            ob_start();
            echo $this->cas20Protocol->getValidateFailureResponse(C::ERR_INVALID_SERVICE, $message);
            $responseContent = ob_get_clean();

            return new XmlResponse(
                $responseContent,
                Response::HTTP_BAD_REQUEST,
            );
        }

        $attributes = $serviceTicket['attributes'];
        $this->cas20Protocol->setAttributes($attributes);

        if (isset($pgtUrl)) {
            $sessionTicket = $this->ticketStore->getTicket($serviceTicket['sessionId']);
            if (
                $sessionTicket !== null
                && $this->ticketFactory->isSessionTicket($sessionTicket)
                && !$this->ticketFactory->isExpired($sessionTicket)
            ) {
                $proxyGrantingTicket = $this->ticketFactory->createProxyGrantingTicket(
                    [
                        'userName' => $serviceTicket['userName'],
                        'attributes' => $attributes,
                        'forceAuthn' => false,
                        'proxies' => array_merge(
                            [$serviceUrl],
                            $serviceTicket['proxies'],
                        ),
                        'sessionId' => $serviceTicket['sessionId'],
                    ],
                );
                try {
                    $this->httpUtils->fetch(

                        $pgtUrl . '?pgtIou=' . $proxyGrantingTicket['iou'] . '&pgtId=' . $proxyGrantingTicket['id'],
                    );

                    $this->cas20Protocol->setProxyGrantingTicketIOU($proxyGrantingTicket['iou']);

                    $this->ticketStore->addTicket($proxyGrantingTicket);
                } catch (\Exception $e) {
                    // Fall through
                }
            }
        }

        // TODO: Replace with string casting
        ob_start();
        echo $this->cas20Protocol->getValidateSuccessResponse($serviceTicket['userName']);
        $successContent = ob_get_clean();

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


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\Module\casserver\Controller;
6
7			use SimpleSAML\CAS\Constants as C;
8			use SimpleSAML\Configuration;
9			use SimpleSAML\Logger;
10			use SimpleSAML\Module\casserver\Cas\Factories\TicketFactory;
11			use SimpleSAML\Module\casserver\Cas\Protocol\Cas20;
12			use SimpleSAML\Module\casserver\Controller\Traits\UrlTrait;
13			use SimpleSAML\Module\casserver\Http\XmlResponse;
14			use Symfony\Component\HttpFoundation\Request;
15			use Symfony\Component\HttpFoundation\Response;
16			use Symfony\Component\HttpKernel\Attribute\AsController;
17			use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
18
19			#[AsController]
20			class Cas20Controller
21			{
22			use UrlTrait;
			1 ignored issue – show introduced 2024-11-25 18:07 UTC by Report Bug Copy Issue Report The trait `SimpleSAML\Module\casser...troller\Traits\UrlTrait` requires some properties which are not provided by `SimpleSAML\Module\casser...troller\Cas20Controller`: `$query`, `$request` Loading history...
23
24			/** @var Logger */
25			protected Logger $logger;
26
27			/** @var Configuration */
28			protected Configuration $casConfig;
29
30			/** @var Cas20 */
31			protected Cas20 $cas20Protocol;
32
33			/** @var TicketFactory */
34			protected TicketFactory $ticketFactory;
35
36			// this could be any configured ticket store
37			protected mixed $ticketStore;
38
39			/**
40			* @param Configuration $sspConfig
41			* @param Configuration\|null $casConfig
42			* @param $ticketStore
43			*
44			* @throws \Exception
45			*/
46			public function __construct(
47			private readonly Configuration $sspConfig,
48			Configuration $casConfig = null,
49			$ticketStore = null,
50			) {
51			// We are using this work around in order to bypass Symfony's autowiring for cas configuration. Since
52			// the configuration class is the same, it loads the ssp configuration twice. Still, we need the constructor
53			// argument in order to facilitate testing
54			$this->casConfig = ($casConfig === null \|\| $casConfig === $sspConfig)
55			? Configuration::getConfig('module_casserver.php') : $casConfig;
56			$this->cas20Protocol = new Cas20($this->casConfig);
57			/* Instantiate ticket factory */
58			$this->ticketFactory = new TicketFactory($this->casConfig);
59			/* Instantiate ticket store */
60			$ticketStoreConfig = $this->casConfig->getOptionalValue(
61			'ticketstore',
62			['class' => 'casserver:FileSystemTicketStore'],
63			);
64			$ticketStoreClass = 'SimpleSAML\\Module\\casserver\\Cas\\Ticket\\'
65			. explode(':', $ticketStoreConfig['class'])[1];
66			$this->ticketStore = $ticketStore ?? new $ticketStoreClass($this->casConfig);
67			}
68
69			/**
70			* @param Request $request
71			* @param string $TARGET // todo: this should go away
72			* @param bool $renew [OPTIONAL] - if this parameter is set, ticket validation will only succeed
73			* if the service ticket was issued from the presentation of the user’s primary
74			* credentials. It will fail if the ticket was issued from a single sign-on session.
75			* @param string\|null $ticket [REQUIRED] - the service ticket issued by /login
76			* @param string\|null $service [REQUIRED] - the identifier of the service for which the ticket was issued
77			* @param string\|null $pgtUrl [OPTIONAL] - the URL of the proxy callback
78			*
79			* @return XmlResponse
80			*/
81			public function serviceValidate(
82			Request $request,
83			#[MapQueryParameter] string $TARGET = '',
84			#[MapQueryParameter] bool $renew = false,
85			#[MapQueryParameter] ?string $ticket = null,
86			#[MapQueryParameter] ?string $service = null,
87			#[MapQueryParameter] ?string $pgtUrl = null,
88			): XmlResponse {
89			return $this->validate(
90			request: $request,
91			method: 'serviceValidate',
92			target: $TARGET,
93			renew: $renew,
94			ticket: $ticket,
95			service: $service,
96			pgtUrl: $pgtUrl,
97			);
98			}
99
100			/**
101			* @param Request $request
102			* @param string $TARGET // todo: this should go away???
103			* @param bool $renew [OPTIONAL] - if this parameter is set, ticket validation will only succeed
104			* if the service ticket was issued from the presentation of the user’s primary
105			* credentials. It will fail if the ticket was issued from a single sign-on session.
106			* @param string\|null $ticket [REQUIRED] - the service ticket issued by /login
107			* @param string\|null $service [REQUIRED] - the identifier of the service for which the ticket was issued
108			* @param string\|null $pgtUrl [OPTIONAL] - the URL of the proxy callback
109			* @return XmlResponse
110			*/
111			public function proxyValidate(
112			Request $request,
113			#[MapQueryParameter] string $TARGET = '',
114			#[MapQueryParameter] bool $renew = false,
115			#[MapQueryParameter] ?string $ticket = null,
116			#[MapQueryParameter] ?string $service = null,
117			#[MapQueryParameter] ?string $pgtUrl = null,
118			): XmlResponse {
119			return $this->validate(
120			request: $request,
121			method: 'proxyValidate',
122			target: $TARGET,
123			renew: $renew,
124			ticket: $ticket,
125			service: $service,
126			pgtUrl: $pgtUrl,
127			);
128			}
129
130			/**
131			* @param Request $request
132			* @param string $method
133			* @param string $target
134			* @param bool $renew
135			* @param string\|null $ticket
136			* @param string\|null $service
137			* @param string\|null $pgtUrl
138			*
139			* @return XmlResponse
140			*/
141			public function validate(
142			Request $request,
143			string $method,
144			string $target,
145			bool $renew = false,
146			?string $ticket = null,
147			?string $service = null,
148			?string $pgtUrl = null,
149			): XmlResponse {
150			$forceAuthn = $renew;
151			// todo: According to the protocol, there is no target??? Why are we using it?
152			$serviceUrl = $service ?? $target ?? null;
153
154			// Check if any of the required query parameters are missing
155			if ($serviceUrl === null \|\| $ticket === null) {
156			$messagePostfix = $serviceUrl === null ? 'service' : 'ticket';
157			$message = "casserver: Missing service parameter: [{$messagePostfix}]";
158			Logger::debug($message);
159
160			ob_start();
161			echo $this->cas20Protocol->getValidateFailureResponse(C::ERR_INVALID_SERVICE, $message);
162			$responseContent = ob_get_clean();
163
164			return new XmlResponse(
165			$responseContent,
166			Response::HTTP_BAD_REQUEST,
167			);
168			}
169
170			try {
171			// Get the service ticket
172			// `getTicket` uses the unserializable method and Objects may throw Throwables in their
173			// unserialization handlers.
174			$serviceTicket = $this->ticketStore->getTicket($ticket);
175			// Delete the ticket
176			$this->ticketStore->deleteTicket($ticket);
177			} catch (\Exception $e) {
178			$message = 'casserver:serviceValidate: internal server error. ' . var_export($e->getMessage(), true);
179			Logger::error($message);
180
181			ob_start();
182			echo $this->cas20Protocol->getValidateFailureResponse(C::ERR_INVALID_SERVICE, $message);
183			$responseContent = ob_get_clean();
184
185			return new XmlResponse(
186			$responseContent,
187			Response::HTTP_INTERNAL_SERVER_ERROR,
188			);
189			}
190
191			$failed = false;
192			$message = '';
193			if (empty($serviceTicket)) {
194			// No ticket
195			$message = 'ticket: ' . var_export($ticket, true) . ' not recognized';
196			$failed = true;
197			} elseif ($method === 'serviceValidate' && $this->ticketFactory->isProxyTicket($serviceTicket)) {
198			$message = 'Ticket ' . var_export($_GET['ticket'], true) .
199			' is a proxy ticket. Use proxyValidate instead.';
200			$failed = true;
201			} elseif (!$this->ticketFactory->isServiceTicket($serviceTicket)) {
202			// This is not a service ticket
203			$message = 'ticket: ' . var_export($ticket, true) . ' is not a service ticket';
204			$failed = true;
205			} elseif ($this->ticketFactory->isExpired($serviceTicket)) {
206			// the ticket has expired
207			$message = 'Ticket has ' . var_export($ticket, true) . ' expired';
208			$failed = true;
209			} elseif ($this->sanitize($serviceTicket['service']) !== $this->sanitize($serviceUrl)) {
210			// The service url we passed to the query parameters does not match the one in the ticket.
211			$message = 'Mismatching service parameters: expected ' .
212			var_export($serviceTicket['service'], true) .
213			' but was: ' . var_export($serviceUrl, true);
214			$failed = true;
215			} elseif ($forceAuthn && !$serviceTicket['forceAuthn']) {
216			// If `forceAuthn` is required but not set in the ticket
217			$message = 'Ticket was issued from single sign on session';
218			$failed = true;
219			}
220
221			if ($failed) {
222			$finalMessage = 'casserver:validate: ' . $message;
223			Logger::error($finalMessage);
224
225			ob_start();
226			echo $this->cas20Protocol->getValidateFailureResponse(C::ERR_INVALID_SERVICE, $message);
227			$responseContent = ob_get_clean();
228
229			return new XmlResponse(
230			$responseContent,
231			Response::HTTP_BAD_REQUEST,
232			);
233			}
234
235			$attributes = $serviceTicket['attributes'];
236			$this->cas20Protocol->setAttributes($attributes);
237
238			if (isset($pgtUrl)) {
239			$sessionTicket = $this->ticketStore->getTicket($serviceTicket['sessionId']);
240			if (
241			$sessionTicket !== null
242			&& $this->ticketFactory->isSessionTicket($sessionTicket)
243			&& !$this->ticketFactory->isExpired($sessionTicket)
244			) {
245			$proxyGrantingTicket = $this->ticketFactory->createProxyGrantingTicket(
246			[
247			'userName' => $serviceTicket['userName'],
248			'attributes' => $attributes,
249			'forceAuthn' => false,
250			'proxies' => array_merge(
251			[$serviceUrl],
252			$serviceTicket['proxies'],
253			),
254			'sessionId' => $serviceTicket['sessionId'],
255			],
256			);
257			try {
258			$this->httpUtils->fetch(
			0 ignored issues – show Bug Best Practice introduced 2024-11-25 18:07 UTC by Report Bug Copy Issue Report The property `httpUtils` does not exist on `SimpleSAML\Module\casser...troller\Cas20Controller`. Did you maybe forget to declare it? Loading history...
259			$pgtUrl . '?pgtIou=' . $proxyGrantingTicket['iou'] . '&pgtId=' . $proxyGrantingTicket['id'],
260			);
261
262			$this->cas20Protocol->setProxyGrantingTicketIOU($proxyGrantingTicket['iou']);
263
264			$this->ticketStore->addTicket($proxyGrantingTicket);
265			} catch (\Exception $e) {
266			// Fall through
267			}
268			}
269			}
270
271			// TODO: Replace with string casting
272			ob_start();
273			echo $this->cas20Protocol->getValidateSuccessResponse($serviceTicket['userName']);
274			$successContent = ob_get_clean();
275
276			return new XmlResponse(
277			$successContent,
278			Response::HTTP_OK,
279			);
280			}
281			}
282

simplesamlphp / simplesamlphp-module-casserver

Pull Request — master (#45)

Cas20Controller::validate() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like