• Home
• OneLogin_Saml2_Utils

PHP Class OneLogin_Saml2_Utils

Defines several often used methods Show file Open project: onelogin/php-saml Class Usage Examples

Public Methods

Method	Description
addSign ( string | DomDocument $xml, string $key, string $cert, string $signAlgorithm = XMLSecurityKey::RSA_SHA1 ) : string	Adds signature key and senders certificate to an element (Message or Assertion).
calculateX509Fingerprint ( string $x509cert, $alg = 'sha1' ) : null | string	Calculates the fingerprint of a x509cert.
castKey ( XMLSecurityKey $key, string $algorithm, string $type = 'public' ) : XMLSecurityKey	Converts a XMLSecurityKey to the correct algorithm.
decryptElement ( DOMElement $encryptedData, XMLSecurityKey $inputKey ) : DOMElement	Decrypts an encrypted element.
deleteLocalSession ( )	Deletes the local session.
extractOriginalQueryParam ( string $name ) : string	Extract a query param - as it was sent - from $_SERVER[QUERY_STRING]
formatCert ( string $cert, boolean $heads = true ) : string	Returns a x509 cert (adding header & footer if required).
formatFingerPrint ( string $fingerprint ) : string	Formates a fingerprint.
formatPrivateKey ( string $key, boolean $heads = true ) : string	Returns a private key (adding header & footer if required).
generateNameId ( string $value, string $spnq, string $format, string | null $cert = null ) : string	Generates a nameID.
generateUniqueID ( ) : string	Generates an unique string (used for example as ID for assertions).
getBaseURLPath ( )	return string The baseurlpath to be used when constructing URLs
getExpireTime ( string $cacheDuration = null, string $validUntil = null ) : integer	Compares 2 dates and returns the earliest.
getProxyVars ( )	return bool
getSelfHost ( ) : string	Returns the current host.
getSelfPort ( ) : null | string
getSelfProtocol ( ) : string
getSelfRoutedURLNoQuery ( ) : string	Returns the routed URL of the current host + current view.
getSelfURL ( ) : string	Returns the URL of the current host + current view + query.
getSelfURLNoQuery ( ) : string	Returns the URL of the current host + current view.
getSelfURLhost ( ) : string	Returns the protocol + the current host + the port (if different than common ports).
getStatus ( DOMDocument $dom ) : array	Gets Status from a Response.
get_string_between ( string $str, string $start, string $end ) : string	Extracts a substring between 2 marks
isHTTPS ( ) : boolean	Checks if https or http.
isSessionStarted ( ) : boolean	Checks if the session is started or not.
loadXML ( DOMDocument $dom, string $xml ) : DOMDocument	This function load an XML string in a save way.
parseDuration ( string $duration, integer | null $timestamp = null ) : integer | null	Interprets a ISO8601 duration value relative to a given timestamp.
parseSAML2Time ( string $time ) : integer	Converts a SAML2 timestamp on the form yyyy-mm-ddThh:mm:ss(\.s+)?Z to a UNIX timestamp. The sub-second part is ignored.
parseTime2SAML ( string $time ) : string	Converts a UNIX timestamp to SAML2 timestamp on the form yyyy-mm-ddThh:mm:ss(\.s+)?Z.
query ( DOMDocument $dom, string $query, DomElement $context = null ) : DOMNodeList	Extracts nodes from the DOMDocument.
redirect ( string $url, array $parameters = [], boolean $stay = false ) : string | null	Executes a redirection to the provided url (or return the target url).
setBaseURL ( $baseurl )
setBaseURLPath ( $baseurlpath )
setProxyVars ( $proxyVars )
setSelfHost ( $host )
setSelfPort ( $port )
setSelfProtocol ( $protocol )
t ( string $msg, array | null $args = [] ) : string	Translates any string. Accepts args
validateSign ( string | DomNode $xml, string | null $cert = null, string | null $fingerprint = null, string | null $fingerprintalg = 'sha1', string | null $xpath = null ) : boolean	Validates a signature (Message or Assertion).
validateXML ( string | DOMDocument $xml, string $schema, boolean $debug = false ) : string | DOMDocument	This function attempts to validate an XML string against the specified schema.

Protected Methods

Method	Description
buildWithBaseURLPath ( $info ) : string	Returns the part of the URL with the BaseURLPath.
getRawHost ( ) : string

Method Details