Package com.sun.identity.saml2.common

Class SAML2SDKUtils

  • Direct Known Subclasses:
    SAML2Utils, XACMLSDKUtils
    public class SAML2SDKUtils
extends Object
    The SAML2SDKUtils contains utility methods for SAML 2.0 implementation.

    • Constructor Detail

      • SAML2SDKUtils

        protected SAML2SDKUtils()
        Protected contstructor.

    • Method Detail

      • getObjectInstance

        public static Object getObjectInstance​(String iName)
        Returns default object instance for a given interface.
        Parameters:
        iName - name of the interface.
        Returns:
        object instance corresponding to the interface implementation. return null if the object instance could not be obtained.

      • getObjectInstance

        public static Object getObjectInstance​(String iName,
                                       String value)
        Returns new object instance taking String parameter in constructor.
        Parameters:
        iName - name of the interface.
        value - String value to be used as parameter in constructor.
        Returns:
        object instance corresponding to the interface implementation. return null if the object instance could not be obtained.

      • getObjectInstance

        public static Object getObjectInstance​(String iName,
                                       Element value)
        Returns new object instance taking Element parameter in constructor.
        Parameters:
        iName - name of the interface.
        value - Element value to be used as parameter in constructor.
        Returns:
        object instance corresponding to the interface implementation. return null if the object instance could not be obtained.

      • getObjectInstance

        public static Object getObjectInstance​(String iName,
                                       byte[] typecode,
                                       int endpointIndex,
                                       String sourceID,
                                       String messageHandle)
        Returns new object instance with given parameters.
        Parameters:
        iName - name of the interface.
        typecode - type code.
        endpointIndex - end point index.
        sourceID - source ID.
        messageHandle - message handler.
        Returns:
        object instance corresponding to the interface implementation. return null if the object instance could not be obtained.

      • checkStatement

        public static boolean checkStatement​(Element element,
                                     String statementname)
        Verifies if an element is a type of a specific statement. Currently, this method is used by class AuthnStatementImpl, AuthzDecisionStatement and AttributeStatementImpl.
        Parameters:
        element - a DOM Element which needs to be verified.
        statementname - A specific name of a statement, for example, AuthnStatement, AuthzStatement or AttributeStatement
        Returns:
        true if the element is of the specific type; false otherwise.

      • byteArrayToString

        public static String byteArrayToString​(byte[] bytes)
        Converts byte array to String.
        Parameters:
        bytes - Byte Array to be converted.
        Returns:
        result of the conversion.

      • intToTwoBytes

        public static byte[] intToTwoBytes​(int i)
                            throws SAML2Exception
        Converts integer to byte array.
        Parameters:
        i - an integer value between 0 and 65535.
        Returns:
        a byte array whose length is 2.
        Throws:
        SAML2Exception - if the input is not between 0 and 65535.

      • twoBytesToInt

        public static int twoBytesToInt​(byte[] bytes)
                         throws SAML2Exception
        Converts two bytes to an integer.
        Parameters:
        bytes - byte array whose length is 2.
        Returns:
        an integer value between 0 and 65535.
        Throws:
        SAML2Exception - if the input is null or the length is not 2.

      • generateMessageHandle

        public static String generateMessageHandle()
        Generates message handle used in an Artifact.
        Returns:
        String format of 20-byte sequence identifying a message.

      • stringToByteArray

        public static byte[] stringToByteArray​(String input)
        Converts String to Byte Array.
        Parameters:
        input - String to be converted.
        Returns:
        result of the conversion.

      • byteArrayToHexString

        public static String byteArrayToHexString​(byte[] byteArray)
        Converts byte array to Hex String.
        Parameters:
        byteArray - Byte Array to be converted.
        Returns:
        result of the conversion.

      • hexStringToByteArray

        public static byte[] hexStringToByteArray​(String hexString)
        Converts Hex String to Byte Array.
        Parameters:
        hexString - Hex String to be converted.
        Returns:
        result of the conversion.

      • generateID

        public static String generateID()
        Generates ID.
        Returns:
        ID value.

      • getDiscoveryBootStrapResourceOffering

        public static ResourceOffering getDiscoveryBootStrapResourceOffering​(jakarta.servlet.http.HttpServletRequest request)
        Gets the Discovery bootstrap resource offering in an attribute statement. After a single sign-on with an Identity Provider, a service provider may get Discovery service esource Offerings through a SAML2 assertion. This APIs helps in retrieving the resource offerings if the user has been authenticated through the SAML2 SSO. It will need to have a valid single sign on token (generated through the SAML2 SSO).
        Parameters:
        request - HttpServletRequest associated with a user session.
        Returns:
        ResourceOffering Discovery Resource Offering, null if there is any failure or if there is not one

      • getDiscoveryBootStrapCredentials

        public static List getDiscoveryBootStrapCredentials​(jakarta.servlet.http.HttpServletRequest request)
        Gets the Discovery bootstrap credentials. After a single sign-on with an Identity Provider, a service provider may get Discovery bootstrap resource offerings and credentials through a SAML assertion. This APIs helps in retrieving the credentials if the user has been authenticated through the SAML2 SSO. It will need to have a valid single sign on token (generated through the SAML2 SSO).
        Parameters:
        request - HttpServletRequest associated with a user session.
        Returns:
        List of SecurityAssertions, null if there is any failure or if there is not one

      • createSOAPMessageString

        public static String createSOAPMessageString​(String xmlString)
                                      throws jakarta.xml.soap.SOAPException,
                                             SAML2Exception
        Creates SOAPMessage with the input XML String as message body.
        Parameters:
        xmlString - XML string to be put into SOAPMessage body.
        Returns:
        newly created SOAPMessage.
        Throws:
        jakarta.xml.soap.SOAPException - if it cannot create the SOAPMessage.
        SAML2Exception

      • fillInBasicAuthInfo

        public static String fillInBasicAuthInfo​(BaseConfigType config,
                                         String locationURL)
        Fills in basic auth user and password inside the location URL if configuration is done properly
        Parameters:
        config - Either an SPSSOConfigElement object , an IDPSSOConfigElement object or PEPConfigElement.
        locationURL - The original location URL which is to be inserted with user:password@ before the hostname part and after //
        Returns:
        The modified location URL with the basic auth user and password if configured properly

      • StringToBoolean

        public static Boolean StringToBoolean​(String str)
                               throws SAML2Exception
        Converts a value of XML boolean type to Boolean object.
        Parameters:
        str - a value of XML boolean type
        Returns:
        a Boolean object.
        Throws:
        SAML2Exception - if there is a syntax error

      • removeDeployUri

        public static String removeDeployUri​(String uri)
        Removes deployment URI from the pass down string. i.e. from "/opensso/ArtifactResolver/metaAlias/idp" to "/ArtifactResolver/metaAlias/idp".
        Parameters:
        uri - the URI string which the deployment uri is to be removed return string without deployment uri

      • booleanValueOf

        public static Boolean booleanValueOf​(String value)
        Returns the boolean value as a Boolean object.
        Parameters:
        value - boolean value true or false.

      • decodeXMLToDebugLog

        public static void decodeXMLToDebugLog​(String callerName,
                                       Element xmlElement)
        If enabled, decodes the provided XML element and prints it out to the decryption debug log.
        Parameters:
        callerName - String representing the name of the calling method.
        xmlElement - String representing an XML document with decrypted data.

      • isSAMLDecryptionDebugEnabled

        public static boolean isSAMLDecryptionDebugEnabled()
        Tells whether SAML SP decryption debug mode is enabled.
        Returns:
        true if SAML decryption debug mode is enabled, or false otherwise or if the property is not found.