LogoutRequest::getSessionIndexes() - Code Metrics - Inspection of "Rewrite samlp messages API" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#226)

by Jaime Pérez
created 2020-04-23 14:39 UTC
LogoutRequest::getSessionIndexes() A

↳ Parent: LogoutRequest
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

declare(strict_types=1);

namespace SAML2\XML\samlp;

use DOMElement;
use SAML2\Utils;
use SAML2\XML\IdentifierTrait;
use SAML2\XML\ds\Signature;
use SAML2\XML\saml\IdentifierInterface;
use SAML2\XML\saml\BaseID;
use SAML2\XML\saml\EncryptedID;
use SAML2\XML\saml\NameID;
use SAML2\XML\saml\Issuer;
use Webmozart\Assert\Assert;

/**
 * Class for SAML 2 logout request messages.
 *
 * @package SimpleSAMLphp
 */
class LogoutRequest extends AbstractRequest
{
    use IdentifierTrait;

    /**
     * The expiration time of this request.
     *
     * @var int|null
     */
    protected $notOnOrAfter = null;

    /**
     * The SessionIndexes of the sessions that should be terminated.
     *
     * @var string[]
     */
    protected $sessionIndexes = [];

    /**
     * The optional reason for the logout, typically a URN
     * See \SAML2\Constants::LOGOUT_REASON_*
     * From the standard section 3.7.3: "other values MAY be agreed on between participants"
     *
     * @var string|null
     */
    protected $reason = null;


    /**
     * Constructor for SAML 2 AttributeQuery.
     *
     * @param \SAML2\XML\saml\IdentifierInterface $identifier
     * @param int|null $notOnOrAfter
     * @param string|null $reason
     * @param string[] $sessionIndexes
     * @param \SAML2\XML\saml\Issuer|null $issuer
     * @param string|null $id
     * @param string|null $version
     * @param int|null $issueInstant
     * @param string|null $destination
     * @param string|null $consent
     * @param \SAML2\XML\samlp\Extensions $extensions
     * @throws \Exception
     */
    public function __construct(
        IdentifierInterface $identifier,
        ?int $notOnOrAfter = null,
        ?string $reason = null,
        array $sessionIndexes = [],
        ?Issuer $issuer = null,
        ?string $id = null,
        ?string $version = null,
        ?int $issueInstant = null,
        ?string $destination = null,
        ?string $consent = null,
        ?Extensions $extensions = null
    ) {
        parent::__construct($issuer, $id, $version, $issueInstant, $destination, $consent, $extensions);

        $this->setIdentifier($identifier);
        $this->setNotOnOrAfter($notOnOrAfter);
        $this->setReason($reason);
        $this->setSessionIndexes($sessionIndexes);
    }


    /**
     * Retrieve the expiration time of this request.
     *
     * @return int|null The expiration time of this request.
     */
    public function getNotOnOrAfter(): ?int
    {
        return $this->notOnOrAfter;
    }


    /**
     * Set the expiration time of this request.
     *
     * @param int|null $notOnOrAfter The expiration time of this request.
     * @return void
     */
    public function setNotOnOrAfter(?int $notOnOrAfter = null): void
    {
        $this->notOnOrAfter = $notOnOrAfter;
    }

    /**
     * Retrieve the reason for this request.
     *
     * @return string|null The reason for this request.
     */
    public function getReason(): ?string
    {
        return $this->reason;
    }


    /**
     * Set the reason for this request.
     *
     * @param string|null $reason The optional reason for this request in URN format
     * @return void
     */
    public function setReason(?string $reason = null): void
    {
        $this->reason = $reason;
    }


    /**
     * Retrieve the SessionIndexes of the sessions that should be terminated.
     *
     * @return string[] The SessionIndexes, or an empty array if all sessions should be terminated.
     */
    public function getSessionIndexes(): array
    {
        return $this->sessionIndexes;
    }


    /**
     * Set the SessionIndexes of the sessions that should be terminated.
     *
     * @param string[] $sessionIndexes The SessionIndexes, or an empty array if all sessions should be terminated.
     * @return void
     */
    public function setSessionIndexes(array $sessionIndexes): void
    {
        Assert::allStringNotEmpty($sessionIndexes);
        $this->sessionIndexes = $sessionIndexes;
    }


    /**
     * Convert XML into a LogoutRequest
     *
     * @param \DOMElement $xml The XML element we should load
     * @return \SAML2\XML\samlp\LogoutRequest
     * @throws \InvalidArgumentException if the qualified name of the supplied element is wrong
     * @throws \Exception
     */
    public static function fromXML(DOMElement $xml): object
    {
        Assert::same($xml->localName, 'LogoutRequest');
        Assert::same($xml->namespaceURI, LogoutRequest::NS);

        $issueInstant = Utils::xsDateTimeToTimestamp(self::getAttribute($xml, 'IssueInstant'));

        $notOnOrAfter = self::getAttribute($xml, 'NotOnOrAfter', null);
        if ($notOnOrAfter !== null) {
            $notOnOrAfter = Utils::xsDateTimeToTimestamp($notOnOrAfter);
        }

        $issuer = Issuer::getChildrenOfClass($xml);
        Assert::countBetween($issuer, 0, 1);

        $extensions = Extensions::getChildrenOfClass($xml);
        Assert::maxCount($extensions, 1, 'Only one saml:Extensions element is allowed.');

        $identifier = self::getIdentifierFromXML($xml);
        Assert::notNull($identifier, 'Missing <saml:NameID>, <saml:BaseID> or <saml:EncryptedID> in <samlp:LogoutRequest>.');
        Assert::isInstanceOfAny($identifier, [BaseID::class, NameID::class, EncryptedID::class]);

        $signature = Signature::getChildrenOfClass($xml);
        Assert::maxCount($signature, 1, 'Only one ds:Signature element is allowed.');

        $request = new self(
            $identifier,
            $notOnOrAfter,
            self::getAttribute($xml, 'Reason', null),
            Utils::extractStrings($xml, AbstractSamlpElement::NS, 'SessionIndex'),
            array_pop($issuer),
            self::getAttribute($xml, 'ID'),
            self::getAttribute($xml, 'Version'),
            $issueInstant,
            self::getAttribute($xml, 'Destination', null),
            self::getAttribute($xml, 'Consent', null),
            array_pop($extensions)
        );

        if (!empty($signature)) {
            $request->setSignature($signature[0]);
            $request->messageContainedSignatureUponConstruction = true;
        }

        return $request;
    }


    /**
     * @inheritDoc
     * @throws \Exception
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        Assert::null($parent);

        $e = parent::toXML($parent);

        if ($this->notOnOrAfter !== null) {
            $e->setAttribute('NotOnOrAfter', gmdate('Y-m-d\TH:i:s\Z', $this->notOnOrAfter));
        }

        if ($this->reason !== null) {
            $e->setAttribute('Reason', $this->reason);
        }

        $this->identifier->toXML($e);
                           toXML($e);

        foreach ($this->sessionIndexes as $sessionIndex) {
            $e->appendChild(
                $e->ownerDocument->createElementNS(AbstractSamlpElement::NS, 'samlp:SessionIndex', $sessionIndex)
            );
        }

        return $this->signElement($e);
    }
}

simplesamlphp / saml2

Pull Request — master (#226)

LogoutRequest::getSessionIndexes() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
