PHP Class SimpleSAML_Utilities, simplesamlphp

Author: Andreas Åkre Solberg, UNINETT AS. ([email protected])
Mostrar archivo Open project: simplesamlphp/simplesamlphp Class Usage Examples

Public Properties

Property Type Description
$logMask

Public Methods

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

Private Methods

Method Description
_doRedirect ( $url, $parameters = [] )

Method Details

addURLparameter() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::addURLParameters() instead.
public static addURLparameter ( $url, $parameters )

aesDecrypt() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Crypto::aesDecrypt() instead.
public static aesDecrypt ( $encData )

aesEncrypt() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Crypto::aesEncrypt() instead.
public static aesEncrypt ( $clear )

arrayize() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Arrays::arrayize() instead.
public static arrayize ( $data, $index )

checkCookie() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::checkSessionCookie() instead.
public static checkCookie ( $retryURL = null )

checkDateConditions() public static method

Deprecation: This method will be removed in SSP 2.0.
public static checkDateConditions ( $start = null, $end = null )

checkURLAllowed() public static method

Deprecation: This method will be removed in SSP 2.0. Please use \SimpleSAML\Utils\HTTP::checkURLAllowed() instead.
public static checkURLAllowed ( $url, array $trustedSites = null )
$trustedSites array

debugMessage() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::debugSAMLMessage() instead.
public static debugMessage ( $message, $type )

fatalError() public static method

Deprecation: This method will be removed in SSP 2.0. Please raise a SimpleSAML_Error_Error exception instead.
public static fatalError ( $trackId = 'na', $errorCode = null, Exception $e = null )
$e Exception

fetch() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::fetch() instead.
public static fetch ( $path, $context = [], $getHeaders = false )

formatDOMElement() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::formatDOMElement() instead.
public static formatDOMElement ( DOMElement $root, $indentBase = '' )
$root DOMElement

formatXMLString() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::formatXMLString() instead.
public static formatXMLString ( $xml, $indentBase = '' )

generateID() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Random::generateID() instead.
public static generateID ( )

generateRandomBytes() public static method

Deprecation: This method will be removed in SSP 2.0. Please use openssl_random_pseudo_bytes() instead.
public static generateRandomBytes ( $length )

generateTimestamp() public static method

Deprecation: This method will be removed in SSP 2.0. Please use \SimpleSAML\Utils\Time::generateTimestamp() instead.
public static generateTimestamp ( $instant = null )

getAcceptLanguage() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getAcceptLanguage() instead.
public static getAcceptLanguage ( )

getAdminLoginURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Auth::getAdminLoginURL instead();
public static getAdminLoginURL ( $returnTo = null )

getBaseURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getBaseURL() instead.
public static getBaseURL ( )

getDOMChildren() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::getDOMChildren() instead.
public static getDOMChildren ( DOMElement $element, $localName, $namespaceURI )
$element DOMElement

getDOMText() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::getDOMText() instead.
public static getDOMText ( $element )

getDefaultEndpoint() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Config\Metadata::getDefaultEndpoint() instead.
public static getDefaultEndpoint ( array $endpoints, array $bindings = null )
$endpoints array
$bindings array

getFirstPathElement() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getFirstPathElement() instead.
public static getFirstPathElement ( $trailingslash = true )

getLastError() public static method

Deprecation: This method will be removed in SSP 2.0. Please call error_get_last() directly.
public static getLastError ( )

getSecretSalt() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Config::getSecretSalt() instead.
public static getSecretSalt ( )

getSelfHost() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getSelfHost() instead.
public static getSelfHost ( )

getSelfHostWithPath() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getSelfHostWithPath() instead.
public static getSelfHostWithPath ( )

getTempDir() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\System::getTempDir instead.
public static getTempDir ( )

initTimezone() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Time::initTimezone() instead.
public static initTimezone ( )

ipCIDRcheck() public static method

Deprecation: This method will be removed in version 2.0. Use SimpleSAML\Utils\Net::ipCIDRcheck() instead.
public static ipCIDRcheck ( $cidr, $ip = null )

isAdmin() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Auth::isAdmin() instead.
public static isAdmin ( )

isDOMElementOfType() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::isDOMElementOfType() instead.
public static isDOMElementOfType ( DOMNode $element, $name, $nsURI )
$element DOMNode

isHTTPS() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::isHTTPS() instead.
public static isHTTPS ( )

isWindowsOS() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\System::getOS() instead.
public static isWindowsOS ( )

loadPrivateKey() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Crypto::loadPrivateKey() instead.
public static loadPrivateKey ( SimpleSAML_Configuration $metadata, $required = false, $prefix = '' )
$metadata SimpleSAML_Configuration

loadPublicKey() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Crypto::loadPublicKey() instead.
public static loadPublicKey ( SimpleSAML_Configuration $metadata, $required = false, $prefix = '' )
$metadata SimpleSAML_Configuration

maskErrors() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Logger::maskErrors() instead.
public static maskErrors ( $mask )

normalizeURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::normalizeURL() instead.
public static normalizeURL ( $url )

parseAttributes() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Attributes::normalizeAttributesArray() instead.
public static parseAttributes ( $attributes )

parseDuration() public static method

Deprecation: This method will be removed in SSP 2.0. Please use \SimpleSAML\Utils\Time::parseDuration() instead.
public static parseDuration ( $duration, $timestamp = null )

parseQueryString() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::parseQueryString() instead.
public static parseQueryString ( $query_string )

parseStateID() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML_Auth_State::parseStateID() instead.
public static parseStateID ( $stateId )

popErrorMask() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Logger::popErrorMask() instead.
public static popErrorMask ( )

postRedirect() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::submitPOSTData() instead.
public static postRedirect ( $destination, $post )

redirect() public static method

Deprecation: 1.12.0 This method will be removed from the API. Instead, use the redirectTrustedURL() or redirectUntrustedURL() functions accordingly.
public static redirect ( $url, $parameters = [], $allowed_redirect_hosts = null )

redirectTrustedURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::redirectTrustedURL() instead.
public static redirectTrustedURL ( $url, $parameters = [] )

redirectUntrustedURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::redirectUntrustedURL() instead.
public static redirectUntrustedURL ( $url, $parameters = [] )

requireAdmin() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Auth::requireAdmin() instead.
public static requireAdmin ( )

resolveCert() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Config::getCertPath() instead.
public static resolveCert ( $path )

resolvePath() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\System::resolvePath() instead.
public static resolvePath ( $path, $base = null )

resolveURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::resolveURL() instead.
public static resolveURL ( $url, $base = null )

selfURL() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getSelfURL() instead.
public static selfURL ( )

selfURLNoQuery() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getSelfURLNoQuery() instead.
public static selfURLNoQuery ( )

selfURLhost() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::getSelfURLHost() instead.
public static selfURLhost ( )

setCookie() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\HTTP::setCookie() instead.
public static setCookie ( $name, $value, array $params = null, $throw = true )
$params array

stringToHex() public static method

Deprecation: This method will be removed in SSP 2.0. Please use bin2hex() instead.
public static stringToHex ( $bytes )

transposeArray() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\Arrays::transpose() instead.
public static transposeArray ( $in )

validateCA() public static method

Deprecation: This method will be removed in SSP 2.0.
public static validateCA ( $certificate, $caFile )

validateXML() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::isValid() instead.
public static validateXML ( $xml, $schema )

validateXMLDocument() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\XML::checkSAMLMessage() instead.
public static validateXMLDocument ( $message, $type )

writeFile() public static method

Deprecation: This method will be removed in SSP 2.0. Please use SimpleSAML\Utils\System::writeFile() instead.
public static writeFile ( $filename, $data, $mode = 384 )

Property Details

$logMask public_oe static_oe property

Deprecation: This property will be removed in SSP 2.0. Please use SimpleSAML\Logger::isErrorMasked() instead.
public static $logMask