Surfnet\StepupGateway\GatewayBundle\Saml\ResponseBuilder

Complexity

Total Complexity

11

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	isValidResponseSubStatus()	0	22	1
A	createNewResponse()	0	17	2
A	isValidResponseStatus()	0	7	1
A	get()	0	8	1
A	setResponseStatus()	0	21	6

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupGateway\GatewayBundle\Saml;

use SAML2\Constants;
use SAML2\Response;
use Surfnet\SamlBundle\Exception\LogicException;

class ResponseBuilder
{
    /**
     * @var Response
     */
    private $response;

    private ?ResponseContext $responseContext = null;

    public function createNewResponse(ResponseContext $context): static
    {
        if ($this->response) {
            throw new LogicException('Cannot create a new Response when still building a response.');
        }

        $this->responseContext = $context;

        $response = new Response();
        $response->setDestination($context->getDestination());
        $response->setIssuer($context->getIssuer());
        $response->setIssueInstant($context->getIssueInstant());
        $response->setInResponseTo($context->getInResponseTo());

        $this->response = $response;

        return $this;
    }

    public function setResponseStatus(string $status, ?string $subStatus = null, ?string $message = null): static
    {
        if (!$this->isValidResponseStatus($status)) {
            throw new LogicException('Trying to set invalid Response Status');
        }

        if ($subStatus && !$this->isValidResponseSubStatus($subStatus)) {
            throw new LogicException('Trying to set invalid Response SubStatus');
        }

        $status = ['Code' => $status];
        if ($subStatus) {
            $status['SubCode'] = $subStatus;
        }
        if ($message) {
            $status['Message'] = $message;
        }

        $this->response->setStatus($status);

        return $this;
    }

    public function get()
    {
        $response = $this->response;

        $this->response = null;
        $this->responseContext = null;

        return $response;
    }

    private function isValidResponseStatus(string $status): bool
    {
        return in_array($status, [
            Constants::STATUS_SUCCESS,            // weeee!
            Constants::STATUS_REQUESTER,          // Something is wrong with the AuthnRequest
            Constants::STATUS_RESPONDER,          // Something went wrong with the Response
            Constants::STATUS_VERSION_MISMATCH,   // The version of the request message was incorrect
        ]);
    }

    private function isValidResponseSubStatus($subStatus): bool
    {
        return in_array($subStatus, [
            Constants::STATUS_AUTHN_FAILED,               // failed authentication
            Constants::STATUS_INVALID_ATTR,
            Constants::STATUS_INVALID_NAMEID_POLICY,
            Constants::STATUS_NO_AUTHN_CONTEXT,           // insufficient Loa or Loa cannot be met
            Constants::STATUS_NO_AVAILABLE_IDP,
            Constants::STATUS_NO_PASSIVE,
            Constants::STATUS_NO_SUPPORTED_IDP,
            Constants::STATUS_PARTIAL_LOGOUT,
            Constants::STATUS_PROXY_COUNT_EXCEEDED,
            Constants::STATUS_REQUEST_DENIED,
            Constants::STATUS_REQUEST_UNSUPPORTED,
            Constants::STATUS_REQUEST_VERSION_DEPRECATED,
            Constants::STATUS_REQUEST_VERSION_TOO_HIGH,
            Constants::STATUS_REQUEST_VERSION_TOO_LOW,
            Constants::STATUS_RESOURCE_NOT_RECOGNIZED,
            Constants::STATUS_TOO_MANY_RESPONSES,
            Constants::STATUS_UNKNOWN_ATTR_PROFILE,
            Constants::STATUS_UNKNOWN_PRINCIPAL,
            Constants::STATUS_UNSUPPORTED_BINDING,
        ]);
    }
}