SimpleSAML\Module\casserver\Cas\Protocol\Cas20

Complexity

Total Complexity

22

Size/Duplication

Total Lines	262
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getProxyGrantingTicketIOU()	0	3	1
B	getValidateSuccessResponse()	0	66	9
A	generateCas20Attribute()	0	10	2
A	workAroundForBuggyJasigXmlParser()	0	4	1
A	setProxyGrantingTicketIOU()	0	3	1
A	setAttributes()	0	3	1
A	getAttributes()	0	3	1
A	getProxyFailureResponse()	0	20	1
A	getValidateFailureResponse()	0	20	1
A	__construct()	0	5	1
A	getProxySuccessResponse()	0	18	1
A	isValidXmlName()	0	7	2

<?php

/*
 *    simpleSAMLphp-casserver is a CAS 1.0 and 2.0 compliant CAS server in the form of a simpleSAMLphp module
 *
 *    Copyright (C) 2013  Bjorn R. Jensen
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

namespace SimpleSAML\Module\casserver\Cas\Protocol;

use DOMException;
use SimpleSAML\Configuration;
use SimpleSAML\Logger;

class Cas20
{
    /** @var bool $sendAttributes */
    private $sendAttributes;

    /** @var bool $base64EncodeAttributes */
    private $base64EncodeAttributes;

    /** @var string|null $base64IndicatorAttribute */
    private $base64IndicatorAttribute;

    /** @var array $attributes */
    private $attributes = [];

    /** @var string|null $proxyGrantingTicketIOU */
    private $proxyGrantingTicketIOU = null;


    /**
     * @param \SimpleSAML\Configuration $config
     */
    public function __construct(Configuration $config)
    {
        $this->sendAttributes = $config->getValue('attributes', false);
        $this->base64EncodeAttributes = $config->getValue('base64attributes', false);
        $this->base64IndicatorAttribute = $config->getValue('base64_attributes_indicator_attribute', null);
    }


    /**
     * @param array $attributes
     * @return void
     */
    public function setAttributes($attributes)
    {
        $this->attributes = $attributes;
    }


    /**
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }


    /**
     * @param string $proxyGrantingTicketIOU
     * @return void
     */
    public function setProxyGrantingTicketIOU($proxyGrantingTicketIOU)
    {
        $this->proxyGrantingTicketIOU = $proxyGrantingTicketIOU;
    }


    /**
     * @return string|null
     */
    public function getProxyGrantingTicketIOU()
    {
        return $this->proxyGrantingTicketIOU;
    }


    /**
     * @param string $username
     * @return string
     */
    public function getValidateSuccessResponse($username)
    {
        $xmlDocument = new \DOMDocument("1.0");

        $root = $xmlDocument->createElement("cas:serviceResponse");
        $root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:cas', 'http://www.yale.edu/tp/cas');

        $usernameNode = $xmlDocument->createTextNode($username);
        $casUser = $xmlDocument->createElement('cas:user');
        $casUser->appendChild($usernameNode);

        $casSuccess = $xmlDocument->createElement('cas:authenticationSuccess');
        $casSuccess->appendChild($casUser);

        if (is_string($this->proxyGrantingTicketIOU)) {
            $iouNode = $xmlDocument->createTextNode($this->proxyGrantingTicketIOU);
            $iouElement = $xmlDocument->createElement("cas:proxyGrantingTicket");
            $iouElement->appendChild($iouNode);
            $casSuccess->appendChild($iouElement);
        }

        if ($this->sendAttributes && count($this->attributes) > 0) {
            $casAttributes = $xmlDocument->createElement('cas:attributes');

            foreach ($this->attributes as $name => $values) {
                /**
                 * XML element names have a lot of rules. We handle the most probable case, an attribute name that
                 * contains ':' (e.g. the common oid attribute name), however for the rest we just log the name
                 * and continue processing.
                 * Ref: https://www.w3.org/TR/REC-xml/#NT-NameChar
                 * https://stackoverflow.com/q/2519845/54396
                 * must only start with letter or underscore
                 * cannot start with 'xml'
                 * cannot contain a ':' since those are for namespaces
                 * cannot contains space
                 * can only  contain letters, digits, hyphens, underscores, and periods
                 */
                $_name = str_replace(':', '_', $name);
                if ($this->isValidXmlName() === true) {

The call to SimpleSAML\Module\casserver\Cas\Protocol\Cas20::isValidXmlName() has too few arguments starting with name.

                    foreach ($values as $value) {
                        $casAttributes->appendChild(
                            $this->generateCas20Attribute($xmlDocument, $_name, $value)
                        );
                    }
                } else {
                    Logger::warning("Dom exception creating attribute '$_name'. Continuing without atrribute'");
                }
            }

            if (!is_null($this->base64IndicatorAttribute)) {
                $casAttributes->appendChild(
                    $this->generateCas20Attribute(
                        $xmlDocument,
                        $this->base64IndicatorAttribute,
                        $this->base64EncodeAttributes ? "true" : "false"
                    )
                );
            }

            $casSuccess->appendChild($casAttributes);
        }

        $root->appendChild($casSuccess);
        $xmlDocument->appendChild($root);

        return $this->workAroundForBuggyJasigXmlParser($xmlDocument->saveXML());
    }


    /**
     * @param string $errorCode
     * @param string $explanation
     * @return string
     */
    public function getValidateFailureResponse($errorCode, $explanation)
    {
        $xmlDocument = new \DOMDocument("1.0");

        $root = $xmlDocument->createElement("cas:serviceResponse");
        $root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:cas', 'http://www.yale.edu/tp/cas');

        $casFailureCode = $xmlDocument->createAttribute('code');
        $casFailureCode->value = $errorCode;

        $casFailureNode = $xmlDocument->createTextNode($explanation);
        $casFailure = $xmlDocument->createElement('cas:authenticationFailure');
        $casFailure->appendChild($casFailureNode);
        $casFailure->appendChild($casFailureCode);

        $root->appendChild($casFailure);

        $xmlDocument->appendChild($root);

        return $this->workAroundForBuggyJasigXmlParser($xmlDocument->saveXML());
    }


    /**
     * @param string $proxyTicketId
     * @return string
     */
    public function getProxySuccessResponse($proxyTicketId)
    {
        $xmlDocument = new \DOMDocument("1.0");

        $root = $xmlDocument->createElement("cas:serviceResponse");
        $root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:cas', 'http://www.yale.edu/tp/cas');

        $casProxyTicketIdNode = $xmlDocument->createTextNode($proxyTicketId);
        $casProxyTicketId = $xmlDocument->createElement('cas:proxyTicket');
        $casProxyTicketId->appendChild($casProxyTicketIdNode);

        $casProxySuccess = $xmlDocument->createElement('cas:proxySuccess');
        $casProxySuccess->appendChild($casProxyTicketId);

        $root->appendChild($casProxySuccess);
        $xmlDocument->appendChild($root);

        return $this->workAroundForBuggyJasigXmlParser($xmlDocument->saveXML());
    }


    /**
     * @param string $errorCode
     * @param string $explanation
     * @return string
     */
    public function getProxyFailureResponse($errorCode, $explanation)
    {
        $xmlDocument = new \DOMDocument("1.0");

        $root = $xmlDocument->createElement("cas:serviceResponse");
        $root->setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:cas', 'http://www.yale.edu/tp/cas');

        $casFailureCode = $xmlDocument->createAttribute('code');
        $casFailureCode->value = $errorCode;

        $casFailureNode = $xmlDocument->createTextNode($explanation);
        $casFailure = $xmlDocument->createElement('cas:proxyFailure');
        $casFailure->appendChild($casFailureNode);
        $casFailure->appendChild($casFailureCode);

        $root->appendChild($casFailure);

        $xmlDocument->appendChild($root);

        return $this->workAroundForBuggyJasigXmlParser($xmlDocument->saveXML());
    }


    /**
     * @param string $xmlString
     * @return string
     */
    private function workAroundForBuggyJasigXmlParser($xmlString)
    {
        // when will people stop hand coding xml handling....?
        return str_replace('><', '>'.PHP_EOL.'<', str_replace(PHP_EOL, '', $xmlString));
    }


    /**
     * @param \DOMDocument $xmlDocument
     * @param string $attributeName
     * @param string $attributeValue
     * @return \DOMElement
     */
    private function generateCas20Attribute($xmlDocument, $attributeName, $attributeValue)
    {
        $attributeValueNode = $xmlDocument->createTextNode($this->base64EncodeAttributes ?
            base64_encode($attributeValue) : $attributeValue);

        $attributeElement = $xmlDocument->createElement('cas:'.$attributeName);

        $attributeElement->appendChild($attributeValueNode);

        return $attributeElement;
    }


    /**
     * @param string $name
     * @return bool
     */
    private function isValidXmlName($name)
    {
        try {
            new \DOMElement($name);

The call to DOMElement::__construct() has too few arguments starting with value.

            return true;
        } catch(\DOMException $e) {
            return false;
        }
    }
}