org.apache.cxf.ws.security.wss4j.policyhandlers
Class AbstractBindingBuilder

java.lang.Object
  org.apache.cxf.ws.security.wss4j.policyhandlers.AbstractBindingBuilder

Direct Known Subclasses:

AsymmetricBindingHandler, SymmetricBindingHandler, TransportBindingHandler

public abstract class AbstractBindingBuilder
extends Object

CRYPTO_CACHE

public static final String CRYPTO_CACHE

See Also:

Constant Field Values

LOG

protected static final Logger LOG

protectionOrder

protected SPConstants.ProtectionOrder protectionOrder

wssConfig

protected final org.apache.ws.security.WSSConfig wssConfig

saaj

protected javax.xml.soap.SOAPMessage saaj

secHeader

protected org.apache.ws.security.message.WSSecHeader secHeader

aim

protected AssertionInfoMap aim

binding

protected Binding binding

message

protected SoapMessage message

timestampEl

protected org.apache.ws.security.message.WSSecTimestamp timestampEl

mainSigId

protected String mainSigId

sigConfList

protected List<org.apache.ws.security.WSEncryptionPart> sigConfList

encryptedTokensList

protected Set<org.apache.ws.security.WSEncryptionPart> encryptedTokensList

endEncSuppTokMap

protected Map<Token,Object> endEncSuppTokMap

endSuppTokMap

protected Map<Token,Object> endSuppTokMap

sgndEndEncSuppTokMap

protected Map<Token,Object> sgndEndEncSuppTokMap

sgndEndSuppTokMap

protected Map<Token,Object> sgndEndSuppTokMap

signatures

protected List<byte[]> signatures

AbstractBindingBuilder

public AbstractBindingBuilder(org.apache.ws.security.WSSConfig config,
                              Binding binding,
                              javax.xml.soap.SOAPMessage saaj,
                              org.apache.ws.security.message.WSSecHeader secHeader,
                              AssertionInfoMap aim,
                              SoapMessage message)

addDerivedKeyElement

protected void addDerivedKeyElement(Element el)

addEncryptedKeyElement

protected void addEncryptedKeyElement(Element el)

addSupportingElement

protected void addSupportingElement(Element el)

insertBeforeBottomUp

protected void insertBeforeBottomUp(Element el)

addTopDownElement

protected void addTopDownElement(Element el)

isRequestor

protected boolean isRequestor()

policyNotAsserted

protected void policyNotAsserted(org.apache.neethi.Assertion assertion,
                                 Exception reason)

policyNotAsserted

protected void policyNotAsserted(org.apache.neethi.Assertion assertion,
                                 String reason)

policyAsserted

protected void policyAsserted(org.apache.neethi.Assertion assertion)

policyAsserted

protected void policyAsserted(QName n)

findAndAssertPolicy

protected Collection<org.apache.neethi.Assertion> findAndAssertPolicy(QName n)

getCryptoCache

protected final Map<Object,org.apache.ws.security.components.crypto.Crypto> getCryptoCache()

getTokenStore

protected final TokenStore getTokenStore()

createTimestamp

protected org.apache.ws.security.message.WSSecTimestamp createTimestamp()

handleLayout

protected org.apache.ws.security.message.WSSecTimestamp handleLayout(org.apache.ws.security.message.WSSecTimestamp timestamp)

assertSupportingTokens

protected void assertSupportingTokens(Collection<org.apache.neethi.Assertion> suppTokens)

handleSupportingTokens

protected Map<Token,Object> handleSupportingTokens(Collection<org.apache.neethi.Assertion> tokens,
                                                   boolean endorse)
                                            throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

handleSupportingTokens

protected Map<Token,Object> handleSupportingTokens(SupportingToken suppTokens,
                                                   boolean endorse)
                                            throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

handleSupportingTokens

protected Map<Token,Object> handleSupportingTokens(SupportingToken suppTokens,
                                                   boolean endorse,
                                                   Map<Token,Object> ret)
                                            throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

handleUsernameTokenSupportingToken

protected void handleUsernameTokenSupportingToken(UsernameToken token,
                                                  boolean endorse,
                                                  boolean encryptedToken,
                                                  Map<Token,Object> ret)
                                           throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

cloneElement

protected Element cloneElement(Element el)

getSecurityToken

protected SecurityToken getSecurityToken()

addSignatureParts

protected void addSignatureParts(Map<Token,Object> tokenMap,
                                 List<org.apache.ws.security.WSEncryptionPart> sigParts)

addUsernameToken

protected org.apache.ws.security.message.WSSecUsernameToken addUsernameToken(UsernameToken token)

addDKUsernameToken

protected org.apache.ws.security.message.WSSecUsernameToken addDKUsernameToken(UsernameToken token,
                                                                               boolean useMac)

addSamlToken

protected org.apache.ws.security.saml.ext.AssertionWrapper addSamlToken(SamlToken token)
                                                                 throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

storeAssertionAsSecurityToken

protected void storeAssertionAsSecurityToken(org.apache.ws.security.saml.ext.AssertionWrapper assertion)

Store a SAML Assertion as a SecurityToken

findIDFromSamlToken

protected String findIDFromSamlToken(Element samlToken)

getPassword

public String getPassword(String userName,
                          org.apache.neethi.Assertion info,
                          int type)

getCallbackHandler

protected CallbackHandler getCallbackHandler()

addWsuIdToElement

public String addWsuIdToElement(Element elem)

Generates a wsu:Id attribute for the provided Element and returns the attribute value or finds and returns the value of the attribute if it already exists.

Parameters:

element - the Element to check/create the attribute on

Returns:

the generated or discovered wsu:Id attribute value

getEncryptedParts

public List<org.apache.ws.security.WSEncryptionPart> getEncryptedParts()
                                                                throws javax.xml.soap.SOAPException

Throws:

javax.xml.soap.SOAPException

getSignedParts

public List<org.apache.ws.security.WSEncryptionPart> getSignedParts()
                                                             throws javax.xml.soap.SOAPException

Throws:

javax.xml.soap.SOAPException

getPartsAndElements

public List<org.apache.ws.security.WSEncryptionPart> getPartsAndElements(boolean sign,
                                                                         boolean includeBody,
                                                                         List<org.apache.ws.security.WSEncryptionPart> parts,
                                                                         List<String> xpaths,
                                                                         Map<String,String> namespaces,
                                                                         List<String> contentXpaths,
                                                                         Map<String,String> cnamespaces)
                                                                  throws javax.xml.soap.SOAPException

Deprecated. Use getSignedParts() and getEncryptedParts() instead.

Identifies the portions of the message to be signed/encrypted.

Parameters:

sign - whether the matches are to be signed or encrypted

includeBody - if the body should be included in the signature/encryption

parts - any WSEncryptionParts to match for signature or encryption as specified by WS-SP signed parts or encrypted parts. Parts without a name match all elements with the provided namespace.

xpaths - any XPath expressions to sign/encrypt matches

namespaces - namespace prefix to namespace mappings for XPath expressions in xpaths

contentXpaths - any XPath expressions to content encrypt

cnamespaces - namespace prefix to namespace mappings for XPath expressions in contentXpaths

Returns:

a configured list of WSEncryptionParts suitable for processing by WSS4J

Throws:

javax.xml.soap.SOAPException - if there is an error extracting SOAP content from the SAAJ model

getParts

protected List<org.apache.ws.security.WSEncryptionPart> getParts(boolean sign,
                                                                 boolean includeBody,
                                                                 List<org.apache.ws.security.WSEncryptionPart> parts,
                                                                 List<Element> found)
                                                          throws javax.xml.soap.SOAPException

Identifies the portions of the message to be signed/encrypted.

Parameters:

sign - whether the matches are to be signed or encrypted

includeBody - if the body should be included in the signature/encryption

parts - any WSEncryptionParts to match for signature or encryption as specified by WS-SP signed parts or encrypted parts. Parts without a name match all elements with the provided namespace.

found - a list of elements that have previously been tagged for signing/encryption. Populated with additional matches found by this method and used to prevent including the same element twice under the same operation.

Returns:

a configured list of WSEncryptionParts suitable for processing by WSS4J

Throws:

javax.xml.soap.SOAPException - if there is an error extracting SOAP content from the SAAJ model

getElements

protected List<org.apache.ws.security.WSEncryptionPart> getElements(String encryptionModifier,
                                                                    List<String> xpaths,
                                                                    Map<String,String> namespaces,
                                                                    List<Element> found)
                                                             throws XPathExpressionException,
                                                                    javax.xml.soap.SOAPException

Identifies the portions of the message to be signed/encrypted.

Parameters:

encryptionModifier - indicates the scope of the crypto operation over matched elements. Either "Content" or "Element".

xpaths - any XPath expressions to sign/encrypt matches

namespaces - namespace prefix to namespace mappings for XPath expressions in xpaths

found - a list of elements that have previously been tagged for signing/encryption. Populated with additional matches found by this method and used to prevent including the same element twice under the same operation.

Returns:

a configured list of WSEncryptionParts suitable for processing by WSS4J

Throws:

XPathExpressionException - if a provided XPath is invalid

javax.xml.soap.SOAPException - if there is an error extracting SOAP content from the SAAJ model

getEncryptedKeyBuilder

protected org.apache.ws.security.message.WSSecEncryptedKey getEncryptedKeyBuilder(TokenWrapper wrapper,
                                                                                  Token token)
                                                                           throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

getSignatureCrypto

public org.apache.ws.security.components.crypto.Crypto getSignatureCrypto(TokenWrapper wrapper)
                                                                   throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

getEncryptionCrypto

public org.apache.ws.security.components.crypto.Crypto getEncryptionCrypto(TokenWrapper wrapper)
                                                                    throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

getCrypto

public org.apache.ws.security.components.crypto.Crypto getCrypto(TokenWrapper wrapper,
                                                                 String cryptoKey,
                                                                 String propKey)
                                                          throws org.apache.ws.security.WSSecurityException

Throws:

org.apache.ws.security.WSSecurityException

setKeyIdentifierType

public void setKeyIdentifierType(org.apache.ws.security.message.WSSecBase secBase,
                                 TokenWrapper wrapper,
                                 Token token)

setEncryptionUser

public String setEncryptionUser(org.apache.ws.security.message.WSSecEncryptedKey encrKeyBuilder,
                                TokenWrapper token,
                                boolean sign,
                                org.apache.ws.security.components.crypto.Crypto crypto)

getUsername

public static String getUsername(List<org.apache.ws.security.handler.WSHandlerResult> results)

Scan through WSHandlerResult list for a Username token and return the username if a Username Token found

Parameters:

results -

Returns:

protected Wss10 getWss10()

protected org.apache.ws.security.message.WSSecSignature getSignatureBuilder(TokenWrapper wrapper,
                                                                            Token token,
                                                                            boolean endorse)
                                                                     throws org.apache.ws.security.WSSecurityException

protected org.apache.ws.security.message.WSSecSignature getSignatureBuilder(TokenWrapper wrapper,
                                                                            Token token,
                                                                            boolean attached,
                                                                            boolean endorse)
                                                                     throws org.apache.ws.security.WSSecurityException

protected void doEndorsedSignatures(Map<Token,Object> tokenMap,
                                    boolean isTokenProtection,
                                    boolean isSigProtect)

protected void assertSupportingTokens(List<org.apache.ws.security.WSEncryptionPart> sigs)

protected void addSupportingTokens(List<org.apache.ws.security.WSEncryptionPart> sigs)
                            throws org.apache.ws.security.WSSecurityException

protected void doEndorse()

protected void addSignatureConfirmation(List<org.apache.ws.security.WSEncryptionPart> sigParts)

public void handleEncryptedSignedHeaders(List<org.apache.ws.security.WSEncryptionPart> encryptedParts,
                                         List<org.apache.ws.security.WSEncryptionPart> signedParts)

public org.apache.ws.security.WSEncryptionPart convertToEncryptionPart(Element element)

protected boolean includeToken(SPConstants.IncludeTokenType inclusion)