|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.xml.security.stax.ext.XMLSecurityProperties
org.apache.wss4j.stax.ext.WSSSecurityProperties
public class WSSSecurityProperties
Main configuration class to supply keys etc. This class is subject to change in the future. Probably we will allow to configure the framework per WSDL
| Constructor Summary | |
|---|---|
WSSSecurityProperties()
|
|
WSSSecurityProperties(WSSSecurityProperties wssSecurityProperties)
|
|
| Method Summary | ||
|---|---|---|
void |
addIgnoreBSPRule(BSPRule bspRule)
|
|
void |
addValidator(QName qName,
Validator validator)
|
|
String |
getActor()
|
|
CallbackHandler |
getCallbackHandler()
returns the password callback handler |
|
CertStore |
getCrlCertStore()
|
|
Crypto |
getDecryptionCrypto()
returns the decryptionCrypto for the key-management |
|
Class<? extends Merlin> |
getDecryptionCryptoClass()
Returns the decryption crypto class |
|
Properties |
getDecryptionCryptoProperties()
|
|
KeyStore |
getDecryptionKeyStore()
Returns the decryption keystore |
|
int |
getDerivedEncryptionKeyLength()
|
|
Integer |
getDerivedKeyIterations()
|
|
org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier |
getDerivedKeyKeyIdentifier()
|
|
WSSConstants.DerivedKeyTokenReference |
getDerivedKeyTokenReference()
|
|
int |
getDerivedSignatureKeyLength()
|
|
String |
getEncryptionCompressionAlgorithm()
|
|
Crypto |
getEncryptionCrypto()
returns the encryptionCrypto for the key-management |
|
Class<? extends Merlin> |
getEncryptionCryptoClass()
Returns the encryption crypto class |
|
Properties |
getEncryptionCryptoProperties()
|
|
org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier |
getEncryptionKeyIdentifier()
returns the KeyIdentifierType which will be used in the secured document |
|
KeyStore |
getEncryptionKeyStore()
Returns the encryption keystore |
|
String |
getEncryptionUser()
Returns the alias for the encryption key in the keystore |
|
boolean |
getHandleCustomPasswordTypes()
|
|
List<BSPRule> |
getIgnoredBSPRules()
|
|
ReplayCache |
getNonceReplayCache()
Get the replay cache for Nonces |
|
CallbackHandler |
getSamlCallbackHandler()
|
|
ReplayCache |
getSamlOneTimeUseReplayCache()
Get the replay cache for SAML2 OneTimeUse Assertions |
|
Crypto |
getSignatureCrypto()
|
|
Class<? extends Merlin> |
getSignatureCryptoClass()
|
|
Properties |
getSignatureCryptoProperties()
|
|
KeyStore |
getSignatureKeyStore()
|
|
String |
getSignatureUser()
|
|
Crypto |
getSignatureVerificationCrypto()
|
|
Class<? extends Merlin> |
getSignatureVerificationCryptoClass()
|
|
Properties |
getSignatureVerificationCryptoProperties()
|
|
KeyStore |
getSignatureVerificationKeyStore()
|
|
Collection<Pattern> |
getSubjectCertConstraints()
Get the Signature Subject Cert Constraints |
|
Integer |
getTimeStampFutureTTL()
|
|
ReplayCache |
getTimestampReplayCache()
Get the replay cache for Timestamps |
|
Integer |
getTimestampTTL()
|
|
String |
getTokenUser()
|
|
WSSConstants.UsernameTokenPasswordType |
getUsernameTokenPasswordType()
|
|
Integer |
getUtFutureTTL()
|
|
Integer |
getUtTTL()
|
|
|
getValidator(QName qName)
|
|
boolean |
isAddUsernameTokenCreated()
|
|
boolean |
isAddUsernameTokenNonce()
|
|
boolean |
isAllowRSA15KeyTransportAlgorithm()
|
|
boolean |
isAllowUsernameTokenNoPassword()
|
|
boolean |
isDisableBSPEnforcement()
|
|
boolean |
isEnableNonceReplayCache()
|
|
boolean |
isEnableRevocation()
|
|
boolean |
isEnableSamlOneTimeUseReplayCache()
|
|
boolean |
isEnableSignatureConfirmationVerification()
|
|
boolean |
isEnableTimestampReplayCache()
|
|
boolean |
isEncryptSymmetricEncrytionKey()
|
|
boolean |
isIncludeSignatureToken()
|
|
boolean |
isMustUnderstand()
|
|
boolean |
isStrictTimestampCheck()
|
|
boolean |
isUse200512Namespace()
|
|
boolean |
isUseDerivedKeyForMAC()
|
|
boolean |
isUseReqSigCertForEncryption()
|
|
boolean |
isValidateSamlSubjectConfirmation()
|
|
void |
loadCRLCertStore(URL url)
|
|
void |
loadDecryptionKeystore(URL url,
char[] keyStorePassword)
loads a java keystore from the given url for decrypt operations |
|
void |
loadEncryptionKeystore(URL url,
char[] keyStorePassword)
loads a java keystore from the given url for encrypt operations |
|
void |
loadSignatureKeyStore(URL url,
char[] keyStorePassword)
|
|
void |
loadSignatureVerificationKeystore(URL url,
char[] keyStorePassword)
|
|
void |
setActor(String actor)
|
|
void |
setAddUsernameTokenCreated(boolean addUsernameTokenCreated)
|
|
void |
setAddUsernameTokenNonce(boolean addUsernameTokenNonce)
|
|
void |
setAllowRSA15KeyTransportAlgorithm(boolean allowRSA15KeyTransportAlgorithm)
|
|
void |
setAllowUsernameTokenNoPassword(boolean allowUsernameTokenNoPassword)
|
|
void |
setCallbackHandler(CallbackHandler callbackHandler)
sets the password callback handler |
|
void |
setCrlCertStore(CertStore crlCertStore)
|
|
void |
setDecryptionCrypto(Crypto decCrypto)
|
|
void |
setDecryptionCryptoClass(Class<? extends Merlin> decryptionCryptoClass)
Sets a custom decryption class |
|
void |
setDecryptionCryptoProperties(Properties cryptoProperties)
|
|
void |
setDecryptionCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
|
|
void |
setDerivedEncryptionKeyLength(int derivedEncryptionKeyLength)
|
|
void |
setDerivedKeyIterations(Integer derivedKeyIterations)
|
|
void |
setDerivedKeyKeyIdentifier(org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier derivedKeyKeyIdentifier)
|
|
void |
setDerivedKeyTokenReference(WSSConstants.DerivedKeyTokenReference derivedKeyTokenReference)
|
|
void |
setDerivedSignatureKeyLength(int derivedSignatureKeyLength)
|
|
void |
setDisableBSPEnforcement(boolean disableBSPEnforcement)
|
|
void |
setEnableNonceReplayCache(boolean enableNonceReplayCache)
|
|
void |
setEnableRevocation(boolean enableRevocation)
|
|
void |
setEnableSamlOneTimeUseReplayCache(boolean enableSamlOneTimeUseReplayCache)
|
|
void |
setEnableSignatureConfirmationVerification(boolean enableSignatureConfirmationVerification)
|
|
void |
setEnableTimestampReplayCache(boolean enableTimestampReplayCache)
|
|
void |
setEncryptionCompressionAlgorithm(String encryptionCompressionAlgorithm)
|
|
void |
setEncryptionCrypto(Crypto encCrypto)
|
|
void |
setEncryptionCryptoClass(Class<? extends Merlin> encryptionCryptoClass)
Sets a custom encryption class |
|
void |
setEncryptionCryptoProperties(Properties cryptoProperties)
|
|
void |
setEncryptionCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
|
|
void |
setEncryptionKeyIdentifier(org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier encryptionKeyIdentifier)
Specifies the KeyIdentifierType to use in the secured document |
|
void |
setEncryptionUser(String encryptionUser)
Specifies the the alias for the encryption key in the keystore |
|
void |
setEncryptSymmetricEncrytionKey(boolean encryptSymmetricEncrytionKey)
|
|
void |
setHandleCustomPasswordTypes(boolean handleCustomTypes)
|
|
void |
setIncludeSignatureToken(boolean includeSignatureToken)
|
|
void |
setMustUnderstand(boolean mustUnderstand)
|
|
void |
setNonceReplayCache(ReplayCache newCache)
Set the replay cache for Nonces |
|
void |
setSamlCallbackHandler(CallbackHandler samlCallbackHandler)
|
|
void |
setSamlOneTimeUseReplayCache(ReplayCache newCache)
Set the replay cache for SAML2 OneTimeUse Assertions |
|
void |
setSignatureCrypto(Crypto sigCrypto)
|
|
void |
setSignatureCryptoClass(Class<? extends Merlin> signatureCryptoClass)
|
|
void |
setSignatureCryptoProperties(Properties cryptoProperties)
|
|
void |
setSignatureCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
|
|
void |
setSignatureUser(String signatureUser)
|
|
void |
setSignatureVerificationCrypto(Crypto sigVerCrypto)
|
|
void |
setSignatureVerificationCryptoClass(Class<? extends Merlin> signatureVerificationCryptoClass)
|
|
void |
setSignatureVerificationCryptoProperties(Properties cryptoProperties)
|
|
void |
setSignatureVerificationCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
|
|
void |
setStrictTimestampCheck(boolean strictTimestampCheck)
|
|
void |
setSubjectCertConstraints(Collection<Pattern> subjectCertConstraints)
Set the Signature Subject Cert Constraints |
|
void |
setTimeStampFutureTTL(Integer timeStampFutureTTL)
|
|
void |
setTimestampReplayCache(ReplayCache newCache)
Set the replay cache for Timestamps |
|
void |
setTimestampTTL(Integer timestampTTL)
|
|
void |
setTokenUser(String tokenUser)
|
|
void |
setUse200512Namespace(boolean use200512Namespace)
|
|
void |
setUseDerivedKeyForMAC(boolean useDerivedKeyForMAC)
|
|
void |
setUseReqSigCertForEncryption(boolean useReqSigCertForEncryption)
|
|
void |
setUsernameTokenPasswordType(WSSConstants.UsernameTokenPasswordType usernameTokenPasswordType)
|
|
void |
setUtFutureTTL(Integer utFutureTTL)
|
|
void |
setUtTTL(Integer utTTL)
|
|
void |
setValidateSamlSubjectConfirmation(boolean validateSamlSubjectConfirmation)
|
|
| Methods inherited from class org.apache.xml.security.stax.ext.XMLSecurityProperties |
|---|
addEncryptionPart, addInputProcessor, addSignaturePart, getDecryptionKey, getEncryptionKey, getEncryptionKeyTransportAlgorithm, getEncryptionKeyTransportDigestAlgorithm, getEncryptionKeyTransportMGFAlgorithm, getEncryptionKeyTransportOAEPParams, getEncryptionSecureParts, getEncryptionSymAlgorithm, getEncryptionTransportKey, getEncryptionUseThisCertificate, getInputProcessorList, getOutAction, getSignatureAlgorithm, getSignatureCanonicalizationAlgorithm, getSignatureCerts, getSignatureDigestAlgorithm, getSignatureKey, getSignatureKeyIdentifier, getSignatureSecureParts, getSignatureVerificationKey, isAddExcC14NInclusivePrefixes, isDisableSchemaValidation, isSkipDocumentEvents, isUseSingleCert, setAddExcC14NInclusivePrefixes, setDecryptionKey, setDisableSchemaValidation, setEncryptionKey, setEncryptionKeyTransportAlgorithm, setEncryptionKeyTransportDigestAlgorithm, setEncryptionKeyTransportMGFAlgorithm, setEncryptionKeyTransportOAEPParams, setEncryptionSymAlgorithm, setEncryptionTransportKey, setEncryptionUseThisCertificate, setOutAction, setSignatureAlgorithm, setSignatureCanonicalizationAlgorithm, setSignatureCerts, setSignatureDigestAlgorithm, setSignatureKey, setSignatureKeyIdentifier, setSignatureVerificationKey, setSkipDocumentEvents, setUseSingleCert |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public WSSSecurityProperties()
public WSSSecurityProperties(WSSSecurityProperties wssSecurityProperties)
| Method Detail |
|---|
public CallbackHandler getCallbackHandler()
public void setCallbackHandler(CallbackHandler callbackHandler)
callbackHandler - the password callback handlerpublic org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier getEncryptionKeyIdentifier()
public void setEncryptionKeyIdentifier(org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier encryptionKeyIdentifier)
encryptionKeyIdentifier - public Integer getTimestampTTL()
public void setTimestampTTL(Integer timestampTTL)
public boolean isStrictTimestampCheck()
public void setStrictTimestampCheck(boolean strictTimestampCheck)
public void setHandleCustomPasswordTypes(boolean handleCustomTypes)
handleCustomTypes - whether to handle custom UsernameToken password types or notpublic boolean getHandleCustomPasswordTypes()
public String getTokenUser()
public void setTokenUser(String tokenUser)
public WSSConstants.UsernameTokenPasswordType getUsernameTokenPasswordType()
public void setUsernameTokenPasswordType(WSSConstants.UsernameTokenPasswordType usernameTokenPasswordType)
public boolean isEnableSignatureConfirmationVerification()
public void setEnableSignatureConfirmationVerification(boolean enableSignatureConfirmationVerification)
public boolean isUseReqSigCertForEncryption()
public void setUseReqSigCertForEncryption(boolean useReqSigCertForEncryption)
public String getActor()
public void setActor(String actor)
public org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier getDerivedKeyKeyIdentifier()
public void setDerivedKeyKeyIdentifier(org.apache.xml.security.stax.securityToken.SecurityTokenConstants.KeyIdentifier derivedKeyKeyIdentifier)
public WSSConstants.DerivedKeyTokenReference getDerivedKeyTokenReference()
public void setDerivedKeyTokenReference(WSSConstants.DerivedKeyTokenReference derivedKeyTokenReference)
public void addIgnoreBSPRule(BSPRule bspRule)
public List<BSPRule> getIgnoredBSPRules()
public void addValidator(QName qName,
Validator validator)
public <T extends Validator> T getValidator(QName qName)
public void setSignatureUser(String signatureUser)
public String getSignatureUser()
public KeyStore getSignatureKeyStore()
public void loadSignatureKeyStore(URL url,
char[] keyStorePassword)
throws Exception
Exceptionpublic Properties getSignatureCryptoProperties()
public void setSignatureCryptoProperties(Properties cryptoProperties)
public void setSignatureCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
public Class<? extends Merlin> getSignatureCryptoClass()
public void setSignatureCryptoClass(Class<? extends Merlin> signatureCryptoClass)
public Crypto getSignatureCrypto()
throws WSSConfigurationException
WSSConfigurationExceptionpublic void setSignatureCrypto(Crypto sigCrypto)
public KeyStore getSignatureVerificationKeyStore()
public void loadSignatureVerificationKeystore(URL url,
char[] keyStorePassword)
throws Exception
Exception
public void loadCRLCertStore(URL url)
throws Exception
Exceptionpublic Properties getSignatureVerificationCryptoProperties()
public void setSignatureVerificationCryptoProperties(Properties cryptoProperties)
public void setSignatureVerificationCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
public Class<? extends Merlin> getSignatureVerificationCryptoClass()
public void setSignatureVerificationCryptoClass(Class<? extends Merlin> signatureVerificationCryptoClass)
public Crypto getSignatureVerificationCrypto()
throws WSSConfigurationException
WSSConfigurationExceptionpublic void setSignatureVerificationCrypto(Crypto sigVerCrypto)
public KeyStore getDecryptionKeyStore()
public void loadDecryptionKeystore(URL url,
char[] keyStorePassword)
throws Exception
url - The URL to the keystorekeyStorePassword - The keyStorePassword
Exception - thrown if something goes wrong while loading the keystorepublic Properties getDecryptionCryptoProperties()
public void setDecryptionCryptoProperties(Properties cryptoProperties)
public void setDecryptionCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
public Class<? extends Merlin> getDecryptionCryptoClass()
public void setDecryptionCryptoClass(Class<? extends Merlin> decryptionCryptoClass)
decryptionCryptoClass -
public Crypto getDecryptionCrypto()
throws WSSConfigurationException
WSSConfigurationException - thrown if something goes wrongpublic void setDecryptionCrypto(Crypto decCrypto)
public KeyStore getEncryptionKeyStore()
public void loadEncryptionKeystore(URL url,
char[] keyStorePassword)
throws Exception
url - The URL to the keystorekeyStorePassword - The keyStorePassword
Exception - thrown if something goes wrong while loading the keystorepublic Properties getEncryptionCryptoProperties()
public void setEncryptionCryptoProperties(Properties cryptoProperties)
public void setEncryptionCryptoProperties(Properties cryptoProperties,
PasswordEncryptor passwordEncryptor)
public Class<? extends Merlin> getEncryptionCryptoClass()
public void setEncryptionCryptoClass(Class<? extends Merlin> encryptionCryptoClass)
encryptionCryptoClass -
public Crypto getEncryptionCrypto()
throws WSSConfigurationException
WSSConfigurationException - thrown if something goes wrongpublic void setEncryptionCrypto(Crypto encCrypto)
public String getEncryptionUser()
public void setEncryptionUser(String encryptionUser)
encryptionUser - the the alias for the encryption key in the keystore as stringpublic String getEncryptionCompressionAlgorithm()
public void setEncryptionCompressionAlgorithm(String encryptionCompressionAlgorithm)
public boolean isAllowUsernameTokenNoPassword()
public void setAllowUsernameTokenNoPassword(boolean allowUsernameTokenNoPassword)
public boolean isEnableRevocation()
public void setEnableRevocation(boolean enableRevocation)
public CertStore getCrlCertStore()
public void setCrlCertStore(CertStore crlCertStore)
public Integer getTimeStampFutureTTL()
public void setTimeStampFutureTTL(Integer timeStampFutureTTL)
public Integer getUtTTL()
public void setUtTTL(Integer utTTL)
public Integer getUtFutureTTL()
public void setUtFutureTTL(Integer utFutureTTL)
public void setTimestampReplayCache(ReplayCache newCache)
public ReplayCache getTimestampReplayCache()
throws WSSecurityException
WSSecurityExceptionpublic void setNonceReplayCache(ReplayCache newCache)
public ReplayCache getNonceReplayCache()
throws WSSecurityException
WSSecurityExceptionpublic void setSamlOneTimeUseReplayCache(ReplayCache newCache)
public ReplayCache getSamlOneTimeUseReplayCache()
throws WSSecurityException
WSSecurityExceptionpublic boolean isDisableBSPEnforcement()
public void setDisableBSPEnforcement(boolean disableBSPEnforcement)
public boolean isAllowRSA15KeyTransportAlgorithm()
public void setAllowRSA15KeyTransportAlgorithm(boolean allowRSA15KeyTransportAlgorithm)
public Integer getDerivedKeyIterations()
public void setDerivedKeyIterations(Integer derivedKeyIterations)
public boolean isUseDerivedKeyForMAC()
public void setUseDerivedKeyForMAC(boolean useDerivedKeyForMAC)
public boolean isAddUsernameTokenNonce()
public void setAddUsernameTokenNonce(boolean addUsernameTokenNonce)
public boolean isAddUsernameTokenCreated()
public void setAddUsernameTokenCreated(boolean addUsernameTokenCreated)
public CallbackHandler getSamlCallbackHandler()
public void setSamlCallbackHandler(CallbackHandler samlCallbackHandler)
public boolean isValidateSamlSubjectConfirmation()
public void setValidateSamlSubjectConfirmation(boolean validateSamlSubjectConfirmation)
public boolean isMustUnderstand()
public void setMustUnderstand(boolean mustUnderstand)
public boolean isIncludeSignatureToken()
public void setIncludeSignatureToken(boolean includeSignatureToken)
public boolean isEnableTimestampReplayCache()
public void setEnableTimestampReplayCache(boolean enableTimestampReplayCache)
public boolean isEnableNonceReplayCache()
public void setEnableNonceReplayCache(boolean enableNonceReplayCache)
public boolean isEnableSamlOneTimeUseReplayCache()
public void setEnableSamlOneTimeUseReplayCache(boolean enableSamlOneTimeUseReplayCache)
public boolean isEncryptSymmetricEncrytionKey()
public void setEncryptSymmetricEncrytionKey(boolean encryptSymmetricEncrytionKey)
public void setSubjectCertConstraints(Collection<Pattern> subjectCertConstraints)
public Collection<Pattern> getSubjectCertConstraints()
public int getDerivedSignatureKeyLength()
public void setDerivedSignatureKeyLength(int derivedSignatureKeyLength)
public int getDerivedEncryptionKeyLength()
public void setDerivedEncryptionKeyLength(int derivedEncryptionKeyLength)
public boolean isUse200512Namespace()
public void setUse200512Namespace(boolean use200512Namespace)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||