org.apache.rahas

Class TrustUtil

java.lang.Object

org.apache.rahas.TrustUtil

public class TrustUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
TrustUtil()

Method Summary

Modifier and Type	Method and Description
static org.apache.axiom.om.OMElement	createActAsElement(org.apache.axiom.om.OMElement parent, int version, org.apache.axiom.om.OMElement samlToken) This method is used to create and add the "ActAs" element into a RST as per the wS-Trust 1.4 specification.
static org.apache.axiom.om.OMElement	createAppliesToElement(org.apache.axiom.om.OMElement parent, String address, String addressingNs)
static org.apache.axiom.om.OMElement	createBinarySecretElement(int version, org.apache.axiom.om.OMElement parent, String type)
static org.apache.axiom.om.OMElement	createCancelRequest(String tokenId, int version)
static org.apache.axiom.om.OMElement	createCancelTargetElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createClaims(int version, org.apache.axiom.om.OMElement parent, String dialect)
static org.apache.axiom.om.OMElement	createComputedKeyAlgorithm(int version, org.apache.axiom.om.OMElement parent, String algoId)
static org.apache.axiom.om.OMElement	createComputedKeyElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createEntropyElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createKeySizeElement(int version, org.apache.axiom.om.OMElement parent, int size)
static org.apache.axiom.om.OMElement	createKeyTypeElement(int version, org.apache.axiom.om.OMElement parent, String type)
static org.apache.axiom.om.OMElement	createLifetimeElement(int version, org.apache.axiom.om.OMElement parent, long ttl)
static org.apache.axiom.om.OMElement	createLifetimeElement(int version, org.apache.axiom.om.OMElement parent, String created, String expires)
static org.apache.axiom.om.OMElement	createRenewTargetElement(int version, org.apache.axiom.om.OMElement parent, org.apache.axiom.om.OMElement str)
static org.apache.axiom.om.OMElement	createRequestedAttachedRef(int version, org.apache.axiom.om.OMElement parent, String refUri, String refValueType)
static void	createRequestedAttachedRef(org.apache.axiom.om.OMElement rstrElem, String id, int version) Create and add wst:AttachedReference element
static org.apache.axiom.om.OMElement	createRequestedProofTokenElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createRequestedSecurityTokenElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createRequestedTokenCanceledElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createRequestedUnattachedRef(int version, org.apache.axiom.om.OMElement parent, String refUri, String refValueType)
static void	createRequestedUnattachedRef(org.apache.axiom.om.OMElement rstrElem, String id, int version) Create and add wst:UnattachedReference element
static org.apache.axiom.om.OMElement	createRequestSecurityTokenElement(int version)
static org.apache.axiom.om.OMElement	createRequestSecurityTokenResponseCollectionElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createRequestSecurityTokenResponseElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createRequestTypeElement(int version, org.apache.axiom.om.OMElement parent, String value)
static Element	createSecurityTokenReference(Document doc, String refUri, String refValueType) Create a wsse:Reference element with the given URI and the value type
static Element	createSecurityTokenReferenceWithTokenType(Document doc, String refUri, String refValueType, String tokenType)
static org.apache.axiom.soap.SOAPEnvelope	createSOAPEnvelope(String nsUri) Create a new SOAPEnvelope of the same version as the SOAPEnvelope in the given MessageContext
static org.apache.axiom.om.OMElement	createTokenTypeElement(int version, org.apache.axiom.om.OMElement parent)
static org.apache.axiom.om.OMElement	createValidateTargetElement(int version, org.apache.axiom.om.OMElement parent, org.apache.axiom.om.OMElement str)
protected byte[]	generateEphemeralKey(byte[] reqEnt, byte[] respEnt, String algo, int keySize) Create an ephemeral key
protected byte[]	generateEphemeralKey(int keySize) Create an ephemeral key
static String	getActionValue(int version, String action)
static String	getSAML11SubjectConfirmationMethod(org.opensaml.SAMLAssertion assertion) Get subject confirmation method of the given SAML 1.1 Assertion
static String	getSAML2SubjectConfirmationMethod(org.opensaml.saml2.core.Assertion assertion) Get the subject confirmation method of a SAML 2.0 assertion
static DocumentBuilderFactory	getSecuredDocumentBuilderFactory() Create DocumentBuilderFactory with the XXE and XEE prevention measurements
static TokenStorage	getTokenStore(org.apache.axis2.context.ConfigurationContext ctx) Fetches the token storage from the configuration context.
static TokenStorage	getTokenStore(org.apache.axis2.context.MessageContext msgCtx) Returns the token store.
static String	getWSTNamespace(int version)
static String	getWSTNamespaceForRSTRequestTye(int version) This method is intended to provide the correct RST Request type provided the WS-Trust version.
static int	getWSTVersion(String ns)
static boolean	isDoomParserPoolUsed() Check whether we need to set a DOOMBuilderFactory based parser pool for the OpenSAML library DOOMBuilderFactory based parser pool was required to overcome the concurrency issue between STS ans SAML when used in the same JVM.
static Properties	toProperties(org.apache.axiom.om.OMElement cryptoElem)

Methods inherited from class java.lang.Object

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

Constructor Detail

TrustUtil

public TrustUtil()

Method Detail

createSecurityTokenReference

public static Element createSecurityTokenReference(Document doc,
                                                   String refUri,
                                                   String refValueType)

Create a wsse:Reference element with the given URI and the value type

Parameters:

doc -

refUri -

refValueType -

Returns:

Element

createSecurityTokenReferenceWithTokenType

public static Element createSecurityTokenReferenceWithTokenType(Document doc,
                                                                String refUri,
                                                                String refValueType,
                                                                String tokenType)

createRequestSecurityTokenResponseElement

public static org.apache.axiom.om.OMElement createRequestSecurityTokenResponseElement(int version,
                                                                                      org.apache.axiom.om.OMElement parent)
                                                                               throws TrustException

Throws:

TrustException

createRequestSecurityTokenResponseCollectionElement

public static org.apache.axiom.om.OMElement createRequestSecurityTokenResponseCollectionElement(int version,
                                                                                                org.apache.axiom.om.OMElement parent)
                                                                                         throws TrustException

Throws:

TrustException

createRequestedSecurityTokenElement

public static org.apache.axiom.om.OMElement createRequestedSecurityTokenElement(int version,
                                                                                org.apache.axiom.om.OMElement parent)
                                                                         throws TrustException

Throws:

TrustException

createRequestSecurityTokenElement

public static org.apache.axiom.om.OMElement createRequestSecurityTokenElement(int version)
                                                                       throws TrustException

Throws:

TrustException

createRequestedProofTokenElement

public static org.apache.axiom.om.OMElement createRequestedProofTokenElement(int version,
                                                                             org.apache.axiom.om.OMElement parent)
                                                                      throws TrustException

Throws:

TrustException

createEntropyElement

public static org.apache.axiom.om.OMElement createEntropyElement(int version,
                                                                 org.apache.axiom.om.OMElement parent)
                                                          throws TrustException

Throws:

TrustException

createComputedKeyElement

public static org.apache.axiom.om.OMElement createComputedKeyElement(int version,
                                                                     org.apache.axiom.om.OMElement parent)
                                                              throws TrustException

Throws:

TrustException

createRequestTypeElement

public static org.apache.axiom.om.OMElement createRequestTypeElement(int version,
                                                                     org.apache.axiom.om.OMElement parent,
                                                                     String value)
                                                              throws TrustException

Throws:

TrustException

createTokenTypeElement

public static org.apache.axiom.om.OMElement createTokenTypeElement(int version,
                                                                   org.apache.axiom.om.OMElement parent)
                                                            throws TrustException

Throws:

TrustException

createValidateTargetElement

public static org.apache.axiom.om.OMElement createValidateTargetElement(int version,
                                                                        org.apache.axiom.om.OMElement parent,
                                                                        org.apache.axiom.om.OMElement str)
                                                                 throws TrustException

Throws:

TrustException

createRenewTargetElement

public static org.apache.axiom.om.OMElement createRenewTargetElement(int version,
                                                                     org.apache.axiom.om.OMElement parent,
                                                                     org.apache.axiom.om.OMElement str)
                                                              throws TrustException

Throws:

TrustException

createBinarySecretElement

public static org.apache.axiom.om.OMElement createBinarySecretElement(int version,
                                                                      org.apache.axiom.om.OMElement parent,
                                                                      String type)
                                                               throws TrustException

Throws:

TrustException

createComputedKeyAlgorithm

public static org.apache.axiom.om.OMElement createComputedKeyAlgorithm(int version,
                                                                       org.apache.axiom.om.OMElement parent,
                                                                       String algoId)
                                                                throws TrustException

Throws:

TrustException

createRequestedUnattachedRef

public static org.apache.axiom.om.OMElement createRequestedUnattachedRef(int version,
                                                                         org.apache.axiom.om.OMElement parent,
                                                                         String refUri,
                                                                         String refValueType)
                                                                  throws TrustException

Throws:

TrustException

createRequestedAttachedRef

public static org.apache.axiom.om.OMElement createRequestedAttachedRef(int version,
                                                                       org.apache.axiom.om.OMElement parent,
                                                                       String refUri,
                                                                       String refValueType)
                                                                throws TrustException

Throws:

TrustException

createRequestedAttachedRef

public static void createRequestedAttachedRef(org.apache.axiom.om.OMElement rstrElem,
                                              String id,
                                              int version)
                                       throws TrustException

Create and add wst:AttachedReference element

Parameters:

rstrElem - wst:RequestSecurityToken element

id - Token identifier

Throws:

TrustException

createRequestedUnattachedRef

public static void createRequestedUnattachedRef(org.apache.axiom.om.OMElement rstrElem,
                                                String id,
                                                int version)
                                         throws TrustException

Create and add wst:UnattachedReference element

Parameters:

rstrElem - wst:RequestSecurityToken element

id - Token identifier

Throws:

TrustException

createKeySizeElement

public static org.apache.axiom.om.OMElement createKeySizeElement(int version,
                                                                 org.apache.axiom.om.OMElement parent,
                                                                 int size)
                                                          throws TrustException

Throws:

TrustException

createKeyTypeElement

public static org.apache.axiom.om.OMElement createKeyTypeElement(int version,
                                                                 org.apache.axiom.om.OMElement parent,
                                                                 String type)
                                                          throws TrustException

Throws:

TrustException

createRequestedTokenCanceledElement

public static org.apache.axiom.om.OMElement createRequestedTokenCanceledElement(int version,
                                                                                org.apache.axiom.om.OMElement parent)
                                                                         throws TrustException

Throws:

TrustException

createLifetimeElement

public static org.apache.axiom.om.OMElement createLifetimeElement(int version,
                                                                  org.apache.axiom.om.OMElement parent,
                                                                  String created,
                                                                  String expires)
                                                           throws TrustException

Throws:

TrustException

createLifetimeElement

public static org.apache.axiom.om.OMElement createLifetimeElement(int version,
                                                                  org.apache.axiom.om.OMElement parent,
                                                                  long ttl)
                                                           throws TrustException

Throws:

TrustException

createAppliesToElement

public static org.apache.axiom.om.OMElement createAppliesToElement(org.apache.axiom.om.OMElement parent,
                                                                   String address,
                                                                   String addressingNs)

getActionValue

public static String getActionValue(int version,
                                    String action)
                             throws TrustException

Throws:

TrustException

createSOAPEnvelope

public static org.apache.axiom.soap.SOAPEnvelope createSOAPEnvelope(String nsUri)

Create a new SOAPEnvelope of the same version as the SOAPEnvelope in the given MessageContext

Parameters:

nsUri -

Returns:

SOAPEnvelope

getWSTNamespace

public static String getWSTNamespace(int version)
                              throws TrustException

Throws:

TrustException

getWSTVersion

public static int getWSTVersion(String ns)
                         throws TrustException

Throws:

TrustException

getTokenStore

public static TokenStorage getTokenStore(org.apache.axis2.context.MessageContext msgCtx)

Returns the token store. If the token store is already available in the configuration context then fetch it and return it. If not create a new one, hook it up in the configuration context and return it

Parameters:

msgCtx -

Returns:

the token store

getTokenStore

public static TokenStorage getTokenStore(org.apache.axis2.context.ConfigurationContext ctx)

Fetches the token storage from the configuration context. If the token store is already available in the configuration context then fetch it and return it. If not create a new one, hook it up in the configuration context and return it

Parameters:

ctx -

Returns:

generateEphemeralKey

protected byte[] generateEphemeralKey(int keySize)
                               throws TrustException

Create an ephemeral key

Returns:

The generated ephemeral key

Throws:

TrustException

generateEphemeralKey

protected byte[] generateEphemeralKey(byte[] reqEnt,
                                      byte[] respEnt,
                                      String algo,
                                      int keySize)
                               throws TrustException

Create an ephemeral key

Returns:

The generated ephemeral key

Throws:

TrustException

createCancelTargetElement

public static org.apache.axiom.om.OMElement createCancelTargetElement(int version,
                                                                      org.apache.axiom.om.OMElement parent)
                                                               throws TrustException

Throws:

TrustException

createClaims

public static org.apache.axiom.om.OMElement createClaims(int version,
                                                         org.apache.axiom.om.OMElement parent,
                                                         String dialect)
                                                  throws TrustException

Throws:

TrustException

createCancelRequest

public static org.apache.axiom.om.OMElement createCancelRequest(String tokenId,
                                                                int version)
                                                         throws TrustException

Throws:

TrustException

toProperties

public static Properties toProperties(org.apache.axiom.om.OMElement cryptoElem)

getSAML11SubjectConfirmationMethod

public static String getSAML11SubjectConfirmationMethod(org.opensaml.SAMLAssertion assertion)

Get subject confirmation method of the given SAML 1.1 Assertion

Parameters:

assertion - SAML 1.1 Assertion

Returns:

subject confirmation method

getSAML2SubjectConfirmationMethod

public static String getSAML2SubjectConfirmationMethod(org.opensaml.saml2.core.Assertion assertion)

Get the subject confirmation method of a SAML 2.0 assertion

Parameters:

assertion - SAML 2.0 assertion

Returns:

Subject Confirmation method

getWSTNamespaceForRSTRequestTye

public static String getWSTNamespaceForRSTRequestTye(int version)
                                              throws TrustException

This method is intended to provide the correct RST Request type provided the WS-Trust version. It defines Reqeust Types and WSA:Actions related to WS-Trust using the http://docs.oasis-open.org/ws-sx/ws-trust/200512 namespace.

Parameters:

version -

Returns:

Correct version

Throws:

TrustException

createActAsElement

public static org.apache.axiom.om.OMElement createActAsElement(org.apache.axiom.om.OMElement parent,
                                                               int version,
                                                               org.apache.axiom.om.OMElement samlToken)
                                                        throws TrustException

This method is used to create and add the "ActAs" element into a RST as per the wS-Trust 1.4 specification. This ActAs element contains a SAML Token as the child.

Parameters:

parent -

version -

samlToken -

Returns:

Throws:

TrustException

getSecuredDocumentBuilderFactory

public static DocumentBuilderFactory getSecuredDocumentBuilderFactory()

Create DocumentBuilderFactory with the XXE and XEE prevention measurements

Returns:

DocumentBuilderFactory instance

isDoomParserPoolUsed

public static boolean isDoomParserPoolUsed()

Check whether we need to set a DOOMBuilderFactory based parser pool for the OpenSAML library DOOMBuilderFactory based parser pool was required to overcome the concurrency issue between STS ans SAML when used in the same JVM. We are enabling this fix by default.

Returns: