org.wso2.appserver.webapp.security.utils

Class SSOUtils

java.lang.Object

org.wso2.appserver.webapp.security.utils.SSOUtils

public class SSOUtils
extends Object

This class contains utility functions used within the single-sign-on (SSO) implementation.

Since:

6.0.0

Method Summary

Modifier and Type	Method and Description
static void	addDeflateSignatureToHTTPQueryString(StringBuilder httpQueryString, org.opensaml.security.x509.X509Credential credential) Applies the XML Digital Signature to the HTTP query string specified.
static Optional<String>	constructApplicationServerURL(org.apache.catalina.connector.Request request) Returns an application server URL constructed using the specified request.
static String	createID() Generates a unique id.
static org.opensaml.saml.saml2.core.Assertion	decryptAssertion(SSOX509Credential ssoAgentX509Credential, org.opensaml.saml.saml2.core.EncryptedAssertion encryptedAssertion) Returns a decrypted SAML 2.0 Assertion from the specified SAML 2.0 encrypted Assertion.
static void	doBootstrap() Initializes the OpenSAML library modules, if not initialized yet.
static String	encodeRequestMessage(org.opensaml.saml.saml2.core.RequestAbstractType requestMessage, String binding) Encodes the SAML 2.0 based request XML object into its corresponding Base64 notation, based on the type of SAML 2.0 binding.
static Optional<String>	generateConsumerURL(String contextPath, String acsBase, String acsPostfix) Returns a SAML 2.0 Assertion Consumer URL based on service provider application context path.
static Optional<String>	generateIssuerID(String contextPath, String hostAppBase) Returns a unique id value for the SAML 2.0 service provider application based on its context path.
static Optional	generateKeyStore() Returns a KeyStore based on keystore properties specified.
static Map<String,Object>	generateRelayState(org.apache.catalina.connector.Request request) Returns a map of SAML 2.0 Relay State content in the form of key-value pairs.
static Map<String,String>	getAssertionStatements(org.opensaml.saml.saml2.core.Assertion assertion) Returns the SAML 2.0 Assertion Attribute Statement content.
static Map<String,String[]>	getSplitQueryParameters(String queryParameterString) Returns the query parameters split out of the query parameter string.
static String	marshall(org.opensaml.core.xml.XMLObject xmlObject) Serializes the specified SAML 2.0 based XML content representation to its corresponding actual XML syntax representation.
static void	sendCharacterData(javax.servlet.http.HttpServletResponse response, String htmlPayload) Sends character data specified by the htmlPayload in the servlet response body.
static org.opensaml.saml.saml2.core.RequestAbstractType	setSignature(org.opensaml.saml.saml2.core.RequestAbstractType request, String signatureAlgorithm, org.opensaml.security.x509.X509Credential credential) Applies the XML Digital Signature to the SAML 2.0 based Request.
static Optional<org.opensaml.core.xml.XMLObject>	unmarshall(String xmlString) Returns a SAML 2.0 based XML content representation from the string value representing the XML syntax.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createID

public static String createID()

Generates a unique id.

Returns:

a unique id

constructApplicationServerURL

public static Optional<String> constructApplicationServerURL(org.apache.catalina.connector.Request request)

Returns an application server URL constructed using the specified request.

Parameters:

request - the HTTP servlet request

Returns:

the application server URL constructed

getSplitQueryParameters

public static Map<String,String[]> getSplitQueryParameters(String queryParameterString)

Returns the query parameters split out of the query parameter string.

Parameters:

queryParameterString - the query parameter String

Returns:

the split query parameters

generateRelayState

public static Map<String,Object> generateRelayState(org.apache.catalina.connector.Request request)

Returns a map of SAML 2.0 Relay State content in the form of key-value pairs.

Parameters:

request - the HTTP servlet request

Returns:

a map of SAML 2.0 Relay State content in the form of key-value pairs

generateIssuerID

public static Optional<String> generateIssuerID(String contextPath,
                                                String hostAppBase)

Returns a unique id value for the SAML 2.0 service provider application based on its context path.

An optional id is returned based on the context path provided.

Parameters:

contextPath - the context path of the service provider application

hostAppBase - the name of the Tomcat host's web application base

Returns:

a unique id value for the SAML 2.0 service provider application based on its context path

generateConsumerURL

public static Optional<String> generateConsumerURL(String contextPath,
                                                   String acsBase,
                                                   String acsPostfix)

Returns a SAML 2.0 Assertion Consumer URL based on service provider application context path.

An Optional String URL is returned based on the context path and configuration properties provided.

Parameters:

contextPath - the context path of the service provider application

acsBase - the base URL of the Assertion Consumer Service

acsPostfix - the postfix which identifies a SAML 2.0 Assertion Consumer URL

Returns:

a SAML 2.0 Assertion Consumer URL based on service provider application context path

generateKeyStore

public static Optional generateKeyStore()
                                 throws SSOException

Returns a KeyStore based on keystore properties specified.

Returns:

the KeyStore instance generated

Throws:

SSOException - if an error occurs while generating the KeyStore instance

sendCharacterData

public static void sendCharacterData(javax.servlet.http.HttpServletResponse response,
                                     String htmlPayload)
                              throws SSOException

Sends character data specified by the htmlPayload in the servlet response body.

Parameters:

response - the servlet response body in which character data are to be sent

htmlPayload - the character data to be sent in the servlet body

Throws:

SSOException - if an error occurs while writing character data to the servlet response body

doBootstrap

public static void doBootstrap()
                        throws SSOException

Initializes the OpenSAML library modules, if not initialized yet.

Throws:

SSOException - if an error occurs when bootstrapping the OpenSAML2 library

setSignature

public static org.opensaml.saml.saml2.core.RequestAbstractType setSignature(org.opensaml.saml.saml2.core.RequestAbstractType request,
                                                                            String signatureAlgorithm,
                                                                            org.opensaml.security.x509.X509Credential credential)
                                                                     throws SSOException

Applies the XML Digital Signature to the SAML 2.0 based Request.

Parameters:

request - the SAML 2.0 based Request

signatureAlgorithm - the algorithm used to compute the signature

credential - the signature signing credential

Returns:

the SAML 2.0 based Request with XML Digital Signature set

Throws:

SSOException - if an error occurs while signing the SAML 2.0 based Request message

encodeRequestMessage

public static String encodeRequestMessage(org.opensaml.saml.saml2.core.RequestAbstractType requestMessage,
                                          String binding)
                                   throws SSOException

Encodes the SAML 2.0 based request XML object into its corresponding Base64 notation, based on the type of SAML 2.0 binding.

Parameters:

requestMessage - the RequestAbstractType XML object to be encoded

binding - the SAML 2.0 binding type

Returns:

encoded String corresponding to the request XML object

Throws:

SSOException - if an error occurs while encoding SAML request

marshall

public static String marshall(org.opensaml.core.xml.XMLObject xmlObject)
                       throws SSOException

Serializes the specified SAML 2.0 based XML content representation to its corresponding actual XML syntax representation.

Parameters:

xmlObject - the SAML 2.0 based XML content object

Returns:

a String representation of the actual XML representation of the SAML 2.0 based XML content representation

Throws:

SSOException - if an error occurs during the marshalling process

unmarshall

public static Optional<org.opensaml.core.xml.XMLObject> unmarshall(String xmlString)
                                                            throws SSOException

Returns a SAML 2.0 based XML content representation from the string value representing the XML syntax.

Parameters:

xmlString - the String representation of the XML content

Returns:

an XML object from the String value representing the XML syntax

Throws:

SSOException - if an error occurs when unmarshalling the XML string representation

decryptAssertion

public static org.opensaml.saml.saml2.core.Assertion decryptAssertion(SSOX509Credential ssoAgentX509Credential,
                                                                      org.opensaml.saml.saml2.core.EncryptedAssertion encryptedAssertion)
                                                               throws SSOException

Returns a decrypted SAML 2.0 Assertion from the specified SAML 2.0 encrypted Assertion.

Parameters:

ssoAgentX509Credential - credential for the resolver

encryptedAssertion - the EncryptedAssertion instance to be decrypted

Returns:

a decrypted SAML 2.0 Assertion from the specified SAML 2.0 EncryptedAssertion

Throws:

SSOException - if an error occurs during the decryption process

getAssertionStatements

public static Map<String,String> getAssertionStatements(org.opensaml.saml.saml2.core.Assertion assertion)

Returns the SAML 2.0 Assertion Attribute Statement content.

Parameters:

assertion - the SAML Assertion whose content is to be returned

Returns:

the SAML 2.0 Assertion Attribute Statement content of the SAML 2.0 Assertion specified

addDeflateSignatureToHTTPQueryString

public static void addDeflateSignatureToHTTPQueryString(StringBuilder httpQueryString,
                                                        org.opensaml.security.x509.X509Credential credential)
                                                 throws SSOException

Applies the XML Digital Signature to the HTTP query string specified.

Parameters:

httpQueryString - the primary HTTP query string which is to be digitally signed

credential - an entity credential associated with X.509 Public Key Infrastructure

Throws:

SSOException - if an error occurs while applying the SAML 2.0 Redirect binding signature