Utilities.php

Go to the documentation of this file.

<?php
 
 
class SimpleSAML_Utilities
{
 
    public static $logMask = 0;
 
 
    public static function getSelfHost()
    {
        return \SimpleSAML\Utils\HTTP::getSelfHost();
    }
 
 
    public static function selfURLhost()
    {
        return \SimpleSAML\Utils\HTTP::getSelfURLHost();
    }
 
 
    public static function isHTTPS()
    {
        return \SimpleSAML\Utils\HTTP::isHTTPS();
    }
 
 
    public static function selfURLNoQuery()
    {
        return \SimpleSAML\Utils\HTTP::getSelfURLNoQuery();
    }
 
 
    public static function getSelfHostWithPath()
    {
        return \SimpleSAML\Utils\HTTP::getSelfHostWithPath();
    }
 
 
    public static function getFirstPathElement($trailingslash = true)
    {
        return \SimpleSAML\Utils\HTTP::getFirstPathElement($trailingslash);
    }
 
 
    public static function selfURL()
    {
        return \SimpleSAML\Utils\HTTP::getSelfURL();
    }
 
 
    public static function getBaseURL()
    {
        return \SimpleSAML\Utils\HTTP::getBaseURL();
    }
 
 
    public static function addURLparameter($url, $parameters)
    {
        return \SimpleSAML\Utils\HTTP::addURLParameters($url, $parameters);
    }
 
 
    public static function checkURLAllowed($url, array $trustedSites = null)
    {
        return \SimpleSAML\Utils\HTTP::checkURLAllowed($url, $trustedSites);
    }
 
 
    public static function parseStateID($stateId)
    {
        return SimpleSAML_Auth_State::parseStateID($stateId);
    }
 
 
    public static function checkDateConditions($start = null, $end = null)
    {
        $currentTime = time();
 
        if (!empty($start)) {
            $startTime = \SAML2\Utils::xsDateTimeToTimestamp($start);
            // Allow for a 10 minute difference in Time
            if (($startTime < 0) || (($startTime - 600) > $currentTime)) {
                return false;
            }
        }
        if (!empty($end)) {
            $endTime = \SAML2\Utils::xsDateTimeToTimestamp($end);
            if (($endTime < 0) || ($endTime <= $currentTime)) {
                return false;
            }
        }
        return true;
    }
 
 
    public static function generateID()
    {
        return SimpleSAML\Utils\Random::generateID();
    }
 
 
    public static function generateTimestamp($instant = null)
    {
        return SimpleSAML\Utils\Time::generateTimestamp($instant);
    }
 
 
    public static function parseDuration($duration, $timestamp = null)
    {
        return SimpleSAML\Utils\Time::parseDuration($duration, $timestamp);
    }
 
 
    public static function fatalError($trackId = 'na', $errorCode = null, Exception $e = null)
    {
        throw new SimpleSAML_Error_Error($errorCode, $e);
    }
 
 
    public static function ipCIDRcheck($cidr, $ip = null)
    {
        return SimpleSAML\Utils\Net::ipCIDRcheck($cidr, $ip);
    }
 
 
    private static function _doRedirect($url, $parameters = array())
    {
        assert(is_string($url));
        assert(!empty($url));
        assert(is_array($parameters));
 
        if (!empty($parameters)) {
            $url = self::addURLparameter($url, $parameters);
        }
 
        /* Set the HTTP result code. This is either 303 See Other or
         * 302 Found. HTTP 303 See Other is sent if the HTTP version
         * is HTTP/1.1 and the request type was a POST request.
         */
        if ($_SERVER['SERVER_PROTOCOL'] === 'HTTP/1.1' &&
            $_SERVER['REQUEST_METHOD'] === 'POST'
        ) {
            $code = 303;
        } else {
            $code = 302;
        }
 
        if (strlen($url) > 2048) {
            SimpleSAML\Logger::warning('Redirecting to a URL longer than 2048 bytes.');
        }
 
        // Set the location header
        header('Location: '.$url, true, $code);
 
        // Disable caching of this response
        header('Pragma: no-cache');
        header('Cache-Control: no-cache, must-revalidate');
 
        // Show a minimal web page with a clickable link to the URL
        echo '<?xml version="1.0" encoding="UTF-8"?>'."\n";
        echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"'.
            ' "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'."\n";
        echo '<html xmlns="http://www.w3.org/1999/xhtml">';
        echo '<head>
                                        <meta http-equiv="content-type" content="text/html; charset=utf-8">
                                        <title>Redirect</title>
                                </head>';
        echo '<body>';
        echo '<h1>Redirect</h1>';
        echo '<p>';
        echo 'You were redirected to: ';
        echo '<a id="redirlink" href="'.
            htmlspecialchars($url).'">'.htmlspecialchars($url).'</a>';
        echo '<script type="text/javascript">document.getElementById("redirlink").focus();</script>';
        echo '</p>';
        echo '</body>';
        echo '</html>';
 
        // End script execution
        exit;
    }
 
 
    public static function redirect($url, $parameters = array(), $allowed_redirect_hosts = null)
    {
        assert(is_string($url));
        assert(strlen($url) > 0);
        assert(is_array($parameters));
 
        if ($allowed_redirect_hosts !== null) {
            $url = self::checkURLAllowed($url, $allowed_redirect_hosts);
        } else {
            $url = self::normalizeURL($url);
        }
        self::_doRedirect($url, $parameters);
    }
 
 
    public static function redirectTrustedURL($url, $parameters = array())
    {
        \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, $parameters);
    }
 
 
    public static function redirectUntrustedURL($url, $parameters = array())
    {
        \SimpleSAML\Utils\HTTP::redirectUntrustedURL($url, $parameters);
    }
 
 
    public static function transposeArray($in)
    {
        return SimpleSAML\Utils\Arrays::transpose($in);
    }
 
 
    public static function isDOMElementOfType(DOMNode $element, $name, $nsURI)
    {
        return SimpleSAML\Utils\XML::isDOMNodeOfType($element, $name, $nsURI);
    }
 
 
    public static function getDOMChildren(DOMElement $element, $localName, $namespaceURI)
    {
        return SimpleSAML\Utils\XML::getDOMChildren($element, $localName, $namespaceURI);
    }
 
 
    public static function getDOMText($element)
    {
        return SimpleSAML\Utils\XML::getDOMText($element);
    }
 
 
    public static function getAcceptLanguage()
    {
        return \SimpleSAML\Utils\HTTP::getAcceptLanguage();
    }
 
 
    public static function validateXML($xml, $schema)
    {
        $result = \SimpleSAML\Utils\XML::isValid($xml, $schema);
        return ($result === true) ? '' : $result;
    }
 
 
    public static function validateXMLDocument($message, $type)
    {
        \SimpleSAML\Utils\XML::checkSAMLMessage($message, $type);
    }
 
 
    public static function generateRandomBytes($length)
    {
        assert(is_int($length));
 
        return openssl_random_pseudo_bytes($length);
    }
 
 
    public static function stringToHex($bytes)
    {
        $ret = '';
        for ($i = 0; $i < strlen($bytes); $i++) {
            $ret .= sprintf('%02x', ord($bytes[$i]));
        }
        return $ret;
    }
 
 
    public static function resolvePath($path, $base = null)
    {
        return \SimpleSAML\Utils\System::resolvePath($path, $base);
    }
 
 
    public static function resolveURL($url, $base = null)
    {
        return \SimpleSAML\Utils\HTTP::resolveURL($url, $base);
    }
 
 
    public static function normalizeURL($url)
    {
        return \SimpleSAML\Utils\HTTP::normalizeURL($url);
    }
 
 
    public static function parseQueryString($query_string)
    {
        return \SimpleSAML\Utils\HTTP::parseQueryString($query_string);
    }
 
 
    public static function parseAttributes($attributes)
    {
        return SimpleSAML\Utils\Attributes::normalizeAttributesArray($attributes);
    }
 
 
    public static function getSecretSalt()
    {
        return SimpleSAML\Utils\Config::getSecretSalt();
    }
 
 
    public static function getLastError()
    {
 
        if (!function_exists('error_get_last')) {
            return '[Cannot get error message]';
        }
 
        $error = error_get_last();
        if ($error === null) {
            return '[No error message found]';
        }
 
        return $error['message'];
    }
 
 
    public static function resolveCert($path)
    {
        return \SimpleSAML\Utils\Config::getCertPath($path);
    }
 
 
    public static function loadPublicKey(SimpleSAML_Configuration $metadata, $required = false, $prefix = '')
    {
        return SimpleSAML\Utils\Crypto::loadPublicKey($metadata, $required, $prefix);
    }
 
 
    public static function loadPrivateKey(SimpleSAML_Configuration $metadata, $required = false, $prefix = '')
    {
        return SimpleSAML\Utils\Crypto::loadPrivateKey($metadata, $required, $prefix);
    }
 
 
    public static function formatDOMElement(DOMElement $root, $indentBase = '')
    {
        SimpleSAML\Utils\XML::formatDOMElement($root, $indentBase);
    }
 
 
    public static function formatXMLString($xml, $indentBase = '')
    {
        return SimpleSAML\Utils\XML::formatXMLString($xml, $indentBase);
    }
 
 
    public static function arrayize($data, $index = 0)
    {
        return SimpleSAML\Utils\Arrays::arrayize($data, $index);
    }
 
 
    public static function isAdmin()
    {
        return SimpleSAML\Utils\Auth::isAdmin();
    }
 
 
    public static function getAdminLoginURL($returnTo = null)
    {
        return SimpleSAML\Utils\Auth::getAdminLoginURL($returnTo);
    }
 
 
    public static function requireAdmin()
    {
        \SimpleSAML\Utils\Auth::requireAdmin();
    }
 
 
    public static function postRedirect($destination, $post)
    {
        \SimpleSAML\Utils\HTTP::submitPOSTData($destination, $post);
    }
 
 
    public static function createPostRedirectLink($destination, $post)
    {
        return \SimpleSAML\Utils\HTTP::getPOSTRedirectURL($destination, $post);
    }
 
 
    public static function createHttpPostRedirectLink($destination, $post)
    {
        assert(is_string($destination));
        assert(is_array($post));
 
        $postId = SimpleSAML\Utils\Random::generateID();
        $postData = array(
            'post' => $post,
            'url'  => $destination,
        );
 
        $session = SimpleSAML_Session::getSessionFromRequest();
        $session->setData('core_postdatalink', $postId, $postData);
 
        $redirInfo = base64_encode(SimpleSAML\Utils\Crypto::aesEncrypt($session->getSessionId().':'.$postId));
 
        $url = SimpleSAML\Module::getModuleURL('core/postredirect.php', array('RedirInfo' => $redirInfo));
        $url = preg_replace("#^https:#", "http:", $url);
 
        return $url;
    }
 
 
    public static function validateCA($certificate, $caFile)
    {
        \SimpleSAML\XML\Validator::validateCertificate($certificate, $caFile);
    }
 
 
    public static function initTimezone()
    {
        \SimpleSAML\Utils\Time::initTimezone();
    }
 
 
    public static function writeFile($filename, $data, $mode = 0600)
    {
        \SimpleSAML\Utils\System::writeFile($filename, $data, $mode);
    }
 
 
    public static function getTempDir()
    {
        return SimpleSAML\Utils\System::getTempDir();
    }
 
 
    public static function maskErrors($mask)
    {
        SimpleSAML\Logger::maskErrors($mask);
    }
 
 
    public static function popErrorMask()
    {
        SimpleSAML\Logger::popErrorMask();
    }
 
 
    public static function getDefaultEndpoint(array $endpoints, array $bindings = null)
    {
        return \SimpleSAML\Utils\Config\Metadata::getDefaultEndpoint($endpoints, $bindings);
    }
 
 
    public static function checkCookie($retryURL = null)
    {
        \SimpleSAML\Utils\HTTP::checkSessionCookie($retryURL);
    }
 
 
    public static function debugMessage($message, $type)
    {
        \SimpleSAML\Utils\XML::debugSAMLMessage($message, $type);
    }
 
 
    public static function fetch($path, $context = array(), $getHeaders = false)
    {
        return \SimpleSAML\Utils\HTTP::fetch($path, $context, $getHeaders);
    }
 
 
    public static function aesEncrypt($clear)
    {
        return SimpleSAML\Utils\Crypto::aesEncrypt($clear);
    }
 
 
    public static function aesDecrypt($encData)
    {
        return SimpleSAML\Utils\Crypto::aesDecrypt($encData);
    }
 
 
    public static function isWindowsOS()
    {
        return SimpleSAML\Utils\System::getOS() === SimpleSAML\Utils\System::WINDOWS;
    }
 
 
    public static function setCookie($name, $value, array $params = null, $throw = true)
    {
        \SimpleSAML\Utils\HTTP::setCookie($name, $value, $params, $throw);
    }
}