SimpleSAML_Utilities Class Reference

Collaboration diagram for SimpleSAML_Utilities:

Static Public Member Functions
static	getSelfHost ()
static	selfURLhost ()
static	isHTTPS ()
static	selfURLNoQuery ()
static	getSelfHostWithPath ()
static	getFirstPathElement ($trailingslash=true)
static	selfURL ()
static	getBaseURL ()
static	addURLparameter ($url, $parameters)
static	checkURLAllowed ($url, array $trustedSites=null)
static	parseStateID ($stateId)
static	checkDateConditions ($start=null, $end=null)
static	generateID ()
static	generateTimestamp ($instant=null)
static	parseDuration ($duration, $timestamp=null)
static	fatalError ($trackId='na', $errorCode=null, Exception $e=null)
static	ipCIDRcheck ($cidr, $ip=null)
static	redirect ($url, $parameters=array(), $allowed_redirect_hosts=null)
static	redirectTrustedURL ($url, $parameters=array())
static	redirectUntrustedURL ($url, $parameters=array())
static	transposeArray ($in)
static	isDOMElementOfType (DOMNode $element, $name, $nsURI)
static	getDOMChildren (DOMElement $element, $localName, $namespaceURI)
static	getDOMText ($element)
static	getAcceptLanguage ()
static	validateXML ($xml, $schema)
static	validateXMLDocument ($message, $type)
static	generateRandomBytes ($length)
static	stringToHex ($bytes)
static	resolvePath ($path, $base=null)
static	resolveURL ($url, $base=null)
static	normalizeURL ($url)
static	parseQueryString ($query_string)
static	parseAttributes ($attributes)
static	getSecretSalt ()
static	getLastError ()
static	resolveCert ($path)
static	loadPublicKey (SimpleSAML_Configuration $metadata, $required=false, $prefix='')
static	loadPrivateKey (SimpleSAML_Configuration $metadata, $required=false, $prefix='')
static	formatDOMElement (DOMElement $root, $indentBase='')
static	formatXMLString ($xml, $indentBase='')
static	arrayize ($data, $index=0)
static	isAdmin ()
static	getAdminLoginURL ($returnTo=null)
static	requireAdmin ()
static	postRedirect ($destination, $post)
static	createPostRedirectLink ($destination, $post)
static	createHttpPostRedirectLink ($destination, $post)
static	validateCA ($certificate, $caFile)
static	initTimezone ()
static	writeFile ($filename, $data, $mode=0600)
static	getTempDir ()
static	maskErrors ($mask)
static	popErrorMask ()
static	getDefaultEndpoint (array $endpoints, array $bindings=null)
static	checkCookie ($retryURL=null)
static	debugMessage ($message, $type)
static	fetch ($path, $context=array(), $getHeaders=false)
static	aesEncrypt ($clear)
static	aesDecrypt ($encData)
static	isWindowsOS ()
static	setCookie ($name, $value, array $params=null, $throw=true)

Static Public Attributes
static	$logMask = 0

Static Private Member Functions
static	_doRedirect ($url, $parameters=array())

Detailed Description

Definition at line 12 of file Utilities.php.

Member Function Documentation

_doRedirect()

static SimpleSAML_Utilities::_doRedirect (   $url,   $parameters = array()  )

staticprivate

Definition at line 193 of file Utilities.php.

References $_SERVER, $code, $url, exit, and SimpleSAML\Logger\warning().

    {
        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;
    }

Here is the call graph for this function:

addURLparameter()

static SimpleSAML_Utilities::addURLparameter (   $url,   $parameters  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::addURLParameters() instead.

Definition at line 99 of file Utilities.php.

References $url.

Referenced by SAML2\HTTPArtifact\getRedirectURL().

    {
        return \SimpleSAML\Utils\HTTP::addURLParameters($url, $parameters);
    }

Here is the caller graph for this function:

aesDecrypt()

static SimpleSAML_Utilities::aesDecrypt (   $encData )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::aesDecrypt() instead.

Definition at line 685 of file Utilities.php.

References SimpleSAML\Utils\Crypto\aesDecrypt().

    {
        return SimpleSAML\Utils\Crypto::aesDecrypt($encData);
    }

Here is the call graph for this function:

aesEncrypt()

static SimpleSAML_Utilities::aesEncrypt (   $clear )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::aesEncrypt() instead.

Definition at line 676 of file Utilities.php.

References SimpleSAML\Utils\Crypto\aesEncrypt().

    {
        return SimpleSAML\Utils\Crypto::aesEncrypt($clear);
    }

Here is the call graph for this function:

arrayize()

static SimpleSAML_Utilities::arrayize (   $data,   $index = 0  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::arrayize() instead.

Definition at line 502 of file Utilities.php.

References $data, $index, and SimpleSAML\Utils\Arrays\arrayize().

    {
        return SimpleSAML\Utils\Arrays::arrayize($data, $index);
    }

Here is the call graph for this function:

checkCookie()

static SimpleSAML_Utilities::checkCookie (   $retryURL = null )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::checkSessionCookie() instead.

Definition at line 649 of file Utilities.php.

References $retryURL, and SimpleSAML\Utils\HTTP\checkSessionCookie().

    {
        \SimpleSAML\Utils\HTTP::checkSessionCookie($retryURL);
    }

Here is the call graph for this function:

checkDateConditions()

static SimpleSAML_Utilities::checkDateConditions (   $start = null,   $end = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Definition at line 126 of file Utilities.php.

References $end, $start, and SAML2\Utils\xsDateTimeToTimestamp().

    {
        $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;
    }

Here is the call graph for this function:

checkURLAllowed()

static SimpleSAML_Utilities::checkURLAllowed (   $url, array  $trustedSites = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use ::checkURLAllowed() instead.

Definition at line 108 of file Utilities.php.

References $url.

    {
        return \SimpleSAML\Utils\HTTP::checkURLAllowed($url, $trustedSites);
    }

createHttpPostRedirectLink()

static SimpleSAML_Utilities::createHttpPostRedirectLink (   $destination,   $post  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getPOSTRedirectURL() instead.

Definition at line 558 of file Utilities.php.

References $destination, $post, $postData, $session, $url, SimpleSAML\Utils\Random\generateID(), SimpleSAML\Module\getModuleURL(), and SimpleSAML_Session\getSessionFromRequest().

    {
        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;
    }

Here is the call graph for this function:

createPostRedirectLink()

static SimpleSAML_Utilities::createPostRedirectLink (   $destination,   $post  )

static

Deprecated:

This method will be removed in SSP 2.0.

PLease use SimpleSAML::getPOSTRedirectURL() instead.

Definition at line 548 of file Utilities.php.

References $destination, and $post.

    {
        return \SimpleSAML\Utils\HTTP::getPOSTRedirectURL($destination, $post);
    }

debugMessage()

static SimpleSAML_Utilities::debugMessage (   $message,   $type  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::debugSAMLMessage() instead.

Definition at line 658 of file Utilities.php.

References $message, $type, and SimpleSAML\Utils\XML\debugSAMLMessage().

Referenced by SAML2\Compat\Ssp\Container\debugMessage().

    {
        \SimpleSAML\Utils\XML::debugSAMLMessage($message, $type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fatalError()

static SimpleSAML_Utilities::fatalError (   $trackId = 'na',   $errorCode = null, Exception  $e = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please raise a SimpleSAML_Error_Error exception instead.

Definition at line 178 of file Utilities.php.

References $errorCode.

    {
        throw new SimpleSAML_Error_Error($errorCode, $e);
    }

fetch()

static SimpleSAML_Utilities::fetch (   $path,   $context = array(),   $getHeaders = false  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::fetch() instead.

Definition at line 667 of file Utilities.php.

References $context, and $path.

    {
        return \SimpleSAML\Utils\HTTP::fetch($path, $context, $getHeaders);
    }

formatDOMElement()

static SimpleSAML_Utilities::formatDOMElement ( DOMElement  $root,   $indentBase = ''  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::formatDOMElement() instead.

Definition at line 484 of file Utilities.php.

    {
        SimpleSAML\Utils\XML::formatDOMElement($root, $indentBase);
    }

formatXMLString()

static SimpleSAML_Utilities::formatXMLString (   $xml,   $indentBase = ''  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::formatXMLString() instead.

Definition at line 493 of file Utilities.php.

References $xml, and SimpleSAML\Utils\XML\formatXMLString().

    {
        return SimpleSAML\Utils\XML::formatXMLString($xml, $indentBase);
    }

Here is the call graph for this function:

generateID()

static SimpleSAML_Utilities::generateID ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::generateID() instead.

Definition at line 150 of file Utilities.php.

References SimpleSAML\Utils\Random\generateID().

Referenced by SAML2\Compat\Ssp\Container\generateId().

    {
        return SimpleSAML\Utils\Random::generateID();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

generateRandomBytes()

static SimpleSAML_Utilities::generateRandomBytes (   $length )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use openssl_random_pseudo_bytes() instead.

Definition at line 359 of file Utilities.php.

Referenced by SAML2\HTTPArtifact\getRedirectURL().

    {
        assert(is_int($length));

        return openssl_random_pseudo_bytes($length);
    }

Here is the caller graph for this function:

generateTimestamp()

static SimpleSAML_Utilities::generateTimestamp (   $instant = null )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use ::generateTimestamp() instead.

Definition at line 160 of file Utilities.php.

References SimpleSAML\Utils\Time\generateTimestamp().

    {
        return SimpleSAML\Utils\Time::generateTimestamp($instant);
    }

Here is the call graph for this function:

getAcceptLanguage()

static SimpleSAML_Utilities::getAcceptLanguage ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getAcceptLanguage() instead.

Definition at line 331 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getAcceptLanguage();
    }

getAdminLoginURL()

static SimpleSAML_Utilities::getAdminLoginURL (   $returnTo = null )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getAdminLoginURL instead();

Definition at line 520 of file Utilities.php.

References $returnTo, and SimpleSAML\Utils\Auth\getAdminLoginURL().

    {
        return SimpleSAML\Utils\Auth::getAdminLoginURL($returnTo);
    }

Here is the call graph for this function:

getBaseURL()

static SimpleSAML_Utilities::getBaseURL ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAMLgetBaseURL() instead.

Definition at line 90 of file Utilities.php.

References getBaseURL().

    {
        return \SimpleSAML\Utils\HTTP::getBaseURL();
    }

Here is the call graph for this function:

getDefaultEndpoint()

static SimpleSAML_Utilities::getDefaultEndpoint ( array  $endpoints, array  $bindings = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getDefaultEndpoint() instead.

Definition at line 639 of file Utilities.php.

References $bindings.

    {
        return \SimpleSAML\Utils\Config\Metadata::getDefaultEndpoint($endpoints, $bindings);
    }

getDOMChildren()

static SimpleSAML_Utilities::getDOMChildren ( DOMElement  $element,   $localName,   $namespaceURI  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getDOMChildren() instead.

Definition at line 312 of file Utilities.php.

    {
        return SimpleSAML\Utils\XML::getDOMChildren($element, $localName, $namespaceURI);
    }

getDOMText()

static SimpleSAML_Utilities::getDOMText (   $element )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getDOMText() instead.

Definition at line 321 of file Utilities.php.

    {
        return SimpleSAML\Utils\XML::getDOMText($element);
    }

getFirstPathElement()

static SimpleSAML_Utilities::getFirstPathElement (   $trailingslash = true )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getFirstPathElement() instead.

Definition at line 72 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getFirstPathElement($trailingslash);
    }

getLastError()

static SimpleSAML_Utilities::getLastError ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please call error_get_last() directly.

Definition at line 438 of file Utilities.php.

    {

        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'];
    }

getSecretSalt()

static SimpleSAML_Utilities::getSecretSalt ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getSecretSalt() instead.

Definition at line 429 of file Utilities.php.

References SimpleSAML\Utils\Config\getSecretSalt().

    {
        return SimpleSAML\Utils\Config::getSecretSalt();
    }

Here is the call graph for this function:

getSelfHost()

static SimpleSAML_Utilities::getSelfHost ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getSelfHost() instead.

Definition at line 24 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getSelfHost();
    }

getSelfHostWithPath()

static SimpleSAML_Utilities::getSelfHostWithPath ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getSelfHostWithPath() instead.

Definition at line 62 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getSelfHostWithPath();
    }

getTempDir()

static SimpleSAML_Utilities::getTempDir ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getTempDir instead.

Definition at line 611 of file Utilities.php.

References SimpleSAML\Utils\System\getTempDir().

Referenced by SAML2\SOAPClient\send().

    {
        return SimpleSAML\Utils\System::getTempDir();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTimezone()

static SimpleSAML_Utilities::initTimezone ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::initTimezone() instead.

Definition at line 593 of file Utilities.php.

References SimpleSAML\Utils\Time\initTimezone().

    {
        \SimpleSAML\Utils\Time::initTimezone();
    }

Here is the call graph for this function:

ipCIDRcheck()

static SimpleSAML_Utilities::ipCIDRcheck (   $cidr,   $ip = null  )

static

Deprecated:

This method will be removed in version 2.0.

Use SimpleSAML::ipCIDRcheck() instead.

Definition at line 187 of file Utilities.php.

References SimpleSAML\Utils\Net\ipCIDRcheck().

    {
        return SimpleSAML\Utils\Net::ipCIDRcheck($cidr, $ip);
    }

Here is the call graph for this function:

isAdmin()

static SimpleSAML_Utilities::isAdmin ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::isAdmin() instead.

Definition at line 511 of file Utilities.php.

References SimpleSAML\Utils\Auth\isAdmin().

    {
        return SimpleSAML\Utils\Auth::isAdmin();
    }

Here is the call graph for this function:

isDOMElementOfType()

static SimpleSAML_Utilities::isDOMElementOfType ( DOMNode  $element,   $name,   $nsURI  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::isDOMNodeOfType() instead.

Definition at line 303 of file Utilities.php.

References $name, and SimpleSAML\Utils\XML\isDOMNodeOfType().

    {
        return SimpleSAML\Utils\XML::isDOMNodeOfType($element, $name, $nsURI);
    }

Here is the call graph for this function:

isHTTPS()

static SimpleSAML_Utilities::isHTTPS ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::isHTTPS() instead.

Definition at line 42 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::isHTTPS();
    }

isWindowsOS()

static SimpleSAML_Utilities::isWindowsOS ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getOS() instead.

Definition at line 694 of file Utilities.php.

References SimpleSAML\Utils\System\getOS(), and SimpleSAML\Utils\System\WINDOWS.

    {
        return SimpleSAML\Utils\System::getOS() === SimpleSAML\Utils\System::WINDOWS;
    }

Here is the call graph for this function:

loadPrivateKey()

static SimpleSAML_Utilities::loadPrivateKey ( SimpleSAML_Configuration  $metadata,   $required = false,   $prefix = ''  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::loadPrivateKey() instead.

Definition at line 475 of file Utilities.php.

References SimpleSAML\Utils\Crypto\loadPrivateKey().

Referenced by SAML2\SOAPClient\send().

    {
        return SimpleSAML\Utils\Crypto::loadPrivateKey($metadata, $required, $prefix);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadPublicKey()

static SimpleSAML_Utilities::loadPublicKey ( SimpleSAML_Configuration  $metadata,   $required = false,   $prefix = ''  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::loadPublicKey() instead.

Definition at line 466 of file Utilities.php.

References SimpleSAML\Utils\Crypto\loadPublicKey().

Referenced by SAML2\SOAPClient\send().

    {
        return SimpleSAML\Utils\Crypto::loadPublicKey($metadata, $required, $prefix);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

maskErrors()

static SimpleSAML_Utilities::maskErrors (   $mask )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::maskErrors() instead.

Definition at line 620 of file Utilities.php.

References $mask, and SimpleSAML\Logger\maskErrors().

    {
        SimpleSAML\Logger::maskErrors($mask);
    }

Here is the call graph for this function:

normalizeURL()

static SimpleSAML_Utilities::normalizeURL (   $url )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::normalizeURL() instead.

Definition at line 401 of file Utilities.php.

References $url.

    {
        return \SimpleSAML\Utils\HTTP::normalizeURL($url);
    }

parseAttributes()

static SimpleSAML_Utilities::parseAttributes (   $attributes )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::normalizeAttributesArray() instead.

Definition at line 420 of file Utilities.php.

References $attributes, and SimpleSAML\Utils\Attributes\normalizeAttributesArray().

    {
        return SimpleSAML\Utils\Attributes::normalizeAttributesArray($attributes);
    }

Here is the call graph for this function:

parseDuration()

static SimpleSAML_Utilities::parseDuration (   $duration,   $timestamp = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use ::parseDuration() instead.

Definition at line 169 of file Utilities.php.

References $timestamp, and SimpleSAML\Utils\Time\parseDuration().

    {
        return SimpleSAML\Utils\Time::parseDuration($duration, $timestamp);
    }

Here is the call graph for this function:

parseQueryString()

static SimpleSAML_Utilities::parseQueryString (   $query_string )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::parseQueryString() instead.

Definition at line 410 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::parseQueryString($query_string);
    }

parseStateID()

static SimpleSAML_Utilities::parseStateID (   $stateId )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML_Auth_State::parseStateID() instead.

Definition at line 117 of file Utilities.php.

References $stateId, and SimpleSAML_Auth_State\parseStateID().

    {
        return SimpleSAML_Auth_State::parseStateID($stateId);
    }

Here is the call graph for this function:

popErrorMask()

static SimpleSAML_Utilities::popErrorMask ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::popErrorMask() instead.

Definition at line 629 of file Utilities.php.

References SimpleSAML\Logger\popErrorMask().

    {
        SimpleSAML\Logger::popErrorMask();
    }

Here is the call graph for this function:

postRedirect()

static SimpleSAML_Utilities::postRedirect (   $destination,   $post  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::submitPOSTData() instead.

Definition at line 538 of file Utilities.php.

References $destination, $post, and SimpleSAML\Utils\HTTP\submitPOSTData().

Referenced by SAML2\Compat\Ssp\Container\postRedirect().

    {
        \SimpleSAML\Utils\HTTP::submitPOSTData($destination, $post);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirect()

static SimpleSAML_Utilities::redirect (   $url,   $parameters = array(),   $allowed_redirect_hosts = null  )

static

Deprecated:

1.12.0 This method will be removed from the API.

Instead, use the redirectTrustedURL() or redirectUntrustedURL() functions accordingly.

Definition at line 255 of file Utilities.php.

References $url.

    {
        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);
    }

redirectTrustedURL()

static SimpleSAML_Utilities::redirectTrustedURL (   $url,   $parameters = array()  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::redirectTrustedURL() instead.

Definition at line 274 of file Utilities.php.

References $url, and SimpleSAML\Utils\HTTP\redirectTrustedURL().

Referenced by SAML2\Compat\Ssp\Container\redirect().

    {
        \SimpleSAML\Utils\HTTP::redirectTrustedURL($url, $parameters);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

redirectUntrustedURL()

static SimpleSAML_Utilities::redirectUntrustedURL (   $url,   $parameters = array()  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::redirectUntrustedURL() instead.

Definition at line 284 of file Utilities.php.

References $url, and SimpleSAML\Utils\HTTP\redirectUntrustedURL().

    {
        \SimpleSAML\Utils\HTTP::redirectUntrustedURL($url, $parameters);
    }

Here is the call graph for this function:

requireAdmin()

static SimpleSAML_Utilities::requireAdmin ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::requireAdmin() instead.

Definition at line 529 of file Utilities.php.

References SimpleSAML\Utils\Auth\requireAdmin().

    {
        \SimpleSAML\Utils\Auth::requireAdmin();
    }

Here is the call graph for this function:

resolveCert()

static SimpleSAML_Utilities::resolveCert (   $path )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getCertPath() instead.

Definition at line 457 of file Utilities.php.

References $path.

Referenced by SAML2\SOAPClient\send().

    {
        return \SimpleSAML\Utils\Config::getCertPath($path);
    }

Here is the caller graph for this function:

resolvePath()

static SimpleSAML_Utilities::resolvePath (   $path,   $base = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::resolvePath() instead.

Definition at line 383 of file Utilities.php.

References $base, and $path.

    {
        return \SimpleSAML\Utils\System::resolvePath($path, $base);
    }

resolveURL()

static SimpleSAML_Utilities::resolveURL (   $url,   $base = null  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::resolveURL() instead.

Definition at line 392 of file Utilities.php.

References $base, and $url.

    {
        return \SimpleSAML\Utils\HTTP::resolveURL($url, $base);
    }

selfURL()

static SimpleSAML_Utilities::selfURL ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getSelfURL() instead.

Definition at line 81 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getSelfURL();
    }

selfURLhost()

static SimpleSAML_Utilities::selfURLhost ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getSelfURLHost() instead.

Definition at line 33 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getSelfURLHost();
    }

selfURLNoQuery()

static SimpleSAML_Utilities::selfURLNoQuery ( )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::getSelfURLNoQuery() instead.

Definition at line 52 of file Utilities.php.

    {
        return \SimpleSAML\Utils\HTTP::getSelfURLNoQuery();
    }

setCookie()

static SimpleSAML_Utilities::setCookie (   $name,   $value, array  $params = null,   $throw = true  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::setCookie() instead.

Definition at line 703 of file Utilities.php.

References $name, PHPMailer\PHPMailer\$params, and SimpleSAML\Utils\HTTP\setCookie().

    {
        \SimpleSAML\Utils\HTTP::setCookie($name, $value, $params, $throw);
    }

Here is the call graph for this function:

stringToHex()

static SimpleSAML_Utilities::stringToHex (   $bytes )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use bin2hex() instead.

Definition at line 370 of file Utilities.php.

References $i, and $ret.

Referenced by SAML2\HTTPArtifact\getRedirectURL().

    {
        $ret = '';
        for ($i = 0; $i < strlen($bytes); $i++) {
            $ret .= sprintf('%02x', ord($bytes[$i]));
        }
        return $ret;
    }

Here is the caller graph for this function:

transposeArray()

static SimpleSAML_Utilities::transposeArray (   $in )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::transpose() instead.

Definition at line 293 of file Utilities.php.

References $in, and SimpleSAML\Utils\Arrays\transpose().

    {
        return SimpleSAML\Utils\Arrays::transpose($in);
    }

Here is the call graph for this function:

validateCA()

static SimpleSAML_Utilities::validateCA (   $certificate,   $caFile  )

static

Deprecated:

This method will be removed in SSP 2.0.

Definition at line 584 of file Utilities.php.

References $certificate, and SimpleSAML\XML\Validator\validateCertificate().

    {
        \SimpleSAML\XML\Validator::validateCertificate($certificate, $caFile);
    }

Here is the call graph for this function:

validateXML()

static SimpleSAML_Utilities::validateXML (   $xml,   $schema  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::isValid() instead.

Definition at line 340 of file Utilities.php.

References $result, and $xml.

    {
        $result = \SimpleSAML\Utils\XML::isValid($xml, $schema);
        return ($result === true) ? '' : $result;
    }

validateXMLDocument()

static SimpleSAML_Utilities::validateXMLDocument (   $message,   $type  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::checkSAMLMessage() instead.

Definition at line 350 of file Utilities.php.

References $message, $type, and SimpleSAML\Utils\XML\checkSAMLMessage().

    {
        \SimpleSAML\Utils\XML::checkSAMLMessage($message, $type);
    }

Here is the call graph for this function:

writeFile()

static SimpleSAML_Utilities::writeFile (   $filename,   $data,   $mode = 0600  )

static

Deprecated:

This method will be removed in SSP 2.0.

Please use SimpleSAML::writeFile() instead.

Definition at line 602 of file Utilities.php.

References $data, $filename, and SimpleSAML\Utils\System\writeFile().

Referenced by SAML2\SOAPClient\send().

    {
        \SimpleSAML\Utils\System::writeFile($filename, $data, $mode);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$logMask

SimpleSAML_Utilities::$logMask = 0

static

Deprecated:

This property will be removed in SSP 2.0.

Please use SimpleSAML::isErrorMasked() instead.

Definition at line 18 of file Utilities.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Utilities.php