|
Oracle Security Developer Tools Web Services Security Java API Reference 11g (11.1.1) E10678-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.xmlsec.wss.util.WSSignatureParams
public class WSSignatureParams
A specification of algorithms and keys for using with XML signature.This includes the following:
Note: This class used to be deprecated before, but not any more. Instead some members are deprecated - cert, certId, keyName, iasn.
Constructor Summary | |
---|---|
WSSignatureParams(byte[] hmacKey, java.security.PrivateKey signingKey) Create A WSSignaureParam with the c14nMethod=excC14N, digestMethod=SHA1, signMethod=hmacSHA/rsaSHA1/dsaSHA1 (depending on the key) |
|
WSSignatureParams(java.lang.String signMethod, boolean usingDecryptTranform) Create a new WSSignatureParams instance. |
|
WSSignatureParams(java.lang.String c14nMethod, java.lang.String signMethod, java.lang.String digestMethod, boolean usingDecryptTranform) Create a new WSSignatureParams instance. |
Method Summary | |
---|---|
java.lang.String |
getC14nMethod() Get the C14N method |
java.lang.String |
getC14NMethod() Get the Canonicalization Algorithm. |
byte[] |
getCertId() Get the Certificate Identifier. |
oracle.security.xmlsec.dsig.XSAlgorithmIdentifier[] |
getCommonTrans() Get a list of transformations that will be added to all the references. |
java.lang.String |
getDigestMethod() Get the Digest Algorithm. |
oracle.security.xmlsec.keys.KeyInfoData |
getKeyInfoData() Get the KeyInfoData (usually a SecurityTokenReference) |
java.lang.String |
getKeyInfoId() Get the id to be put in the ds:KeyInfo element, default - no id is put |
java.lang.String |
getKeyName() Deprecated. Use getKeyInfoData() instead to return a KeyName |
java.security.PrivateKey |
getPrivateKey() Get the Private Key that will be used to generate a PKI signature. |
byte[] |
getSecretKey() Get the Secret Key that will be used to generate a HMAC based signature. |
java.lang.String |
getSignatureMethod() Get the Signature Algorithm. |
java.lang.String |
getSignMethod() Get the sign method |
javax.xml.soap.SOAPMessage |
getSOAPMessage() Get the SOAPMessage that is to be used to resolve attachment References |
java.security.cert.X509Certificate |
getX509Certificate() Get the Public Key Certificate. |
oracle.security.xmlsec.keys.X509Data |
getX509IssuerAndSerialNumber() Get the Certificate Issuer and Serial Number. |
boolean |
isAttachmentContentOnly() Get whether attachments should be signed as content-only |
boolean |
isUsingDecryptTranform() Set the Decrypt |
boolean |
isUsingSTRTransform() Get whether STR transforms are to be used |
void |
setAttachmentContentOnly(boolean attachmentContentOnly) Set whether for attachments should be signed as content-only, default is true. |
void |
setC14nMethod(java.lang.String method) Set the C14N method, default excC14N. |
void |
setCertId(byte[] certId) Set the Certificate Identifier. |
void |
setCommonTrans(oracle.security.xmlsec.dsig.XSAlgorithmIdentifier[] commonTrans) Set a list of transformations that will be added to all the references. |
void |
setDigestMethod(java.lang.String digestMethod) Set the digest method, default SHA1 |
void |
setKeyInfoData(oracle.security.xmlsec.keys.KeyInfoData keyInfoData) Set the KeyInfoData (usually a SecurityTokenReference) |
void |
setKeyInfoId(java.lang.String keyInfoId) Set the id to be put in the ds:KeyInfo element, default - no id is put |
void |
setKeyName(java.lang.String keyName) Deprecated. Use setKeyInfoData(KeyInfoData) instead to set a KeyName |
void |
setPrivateKey(java.security.PrivateKey signingKey) Set the Private Key that will be used to generate a PKI signature. |
void |
setSecretKey(byte[] secretKey) Set the Secret Key that will be used to generate a HMAC based signature. |
void |
setSignMethod(java.lang.String signMethod) Set the sign method, default hmacSHA/rsaSHA1/dsaSHA1 (depending on the key) |
void |
setSOAPMessage(javax.xml.soap.SOAPMessage msg) Set the SOAPMessage that is to be used to resolve attachment references |
void |
setUsingDecryptTranform(boolean usingDecryptTranform) Set whether DecryptTransforms are to be used - default false; |
void |
setUsingSTRTransform(boolean usingSTRTransform) Set whether STR transforms are to be used, default - true. |
void |
setX509Certificate(java.security.cert.X509Certificate cert) Set the Public Key Certificate. |
void |
setX509IssuerAndSerialNumber(oracle.security.xmlsec.keys.X509Data iasn) Set the Public Key Certificate Issuer and Serial Number. |
boolean |
usingDecryptionTransform() Indicates if the DecryptTransform is being used. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WSSignatureParams(byte[] hmacKey, java.security.PrivateKey signingKey)
hmacKey
- The hmacs signing key.signingKey
- The PrivatKey for signing, used if hmacKey is nullpublic WSSignatureParams(java.lang.String signMethod, boolean usingDecryptTranform)
WSSignatureParams
instance.
signMethod
- The signature algorithm.usingDecryptTranform
- Set to true</true> if using the DecryptTransform.
public WSSignatureParams(java.lang.String c14nMethod, java.lang.String signMethod, java.lang.String digestMethod, boolean usingDecryptTranform)
WSSignatureParams
instance.
c14nMethod
- The canonicalization algorithm.digestMethod
- The digest algorithm.signMethod
- The signature algorithm.usingDecryptTranform
- Set to true</true> if using the DecryptTransform.
Method Detail |
---|
public java.lang.String getC14NMethod()
public java.lang.String getSignatureMethod()
public java.lang.String getDigestMethod()
public boolean usingDecryptionTransform()
true
if the DecyrptTransform is being used, false
otherwise.public void setSecretKey(byte[] secretKey)
secretKey
- The key bytes.public void setPrivateKey(java.security.PrivateKey signingKey)
signingKey
- The singing key.public byte[] getSecretKey()
public java.security.PrivateKey getPrivateKey()
public void setX509Certificate(java.security.cert.X509Certificate cert)
cert
- The X.509 certificate.public void setCertId(byte[] certId)
certId
- The certificate identifier bytes.public void setKeyName(java.lang.String keyName)
setKeyInfoData(KeyInfoData)
instead to set a KeyName
keyName
- The key name.public void setX509IssuerAndSerialNumber(oracle.security.xmlsec.keys.X509Data iasn)
iasn
- The X.509 certificate data.public java.security.cert.X509Certificate getX509Certificate()
public byte[] getCertId()
public java.lang.String getKeyName()
getKeyInfoData()
instead to return a KeyName
public oracle.security.xmlsec.keys.X509Data getX509IssuerAndSerialNumber()
public boolean isAttachmentContentOnly()
public void setAttachmentContentOnly(boolean attachmentContentOnly)
attachmentContentOnly
-public oracle.security.xmlsec.keys.KeyInfoData getKeyInfoData()
public void setKeyInfoData(oracle.security.xmlsec.keys.KeyInfoData keyInfoData)
keyInfoData
-public java.lang.String getKeyInfoId()
public void setKeyInfoId(java.lang.String keyInfoId)
keyInfoId
-public javax.xml.soap.SOAPMessage getSOAPMessage()
public void setSOAPMessage(javax.xml.soap.SOAPMessage msg)
msg
-public boolean isUsingDecryptTranform()
public void setUsingDecryptTranform(boolean usingDecryptTranform)
usingDecryptTranform
-public boolean isUsingSTRTransform()
public void setUsingSTRTransform(boolean usingSTRTransform)
usingSTRTransform
-public java.lang.String getC14nMethod()
public void setC14nMethod(java.lang.String method)
method
-public java.lang.String getSignMethod()
public void setSignMethod(java.lang.String signMethod)
signMethod
-public void setDigestMethod(java.lang.String digestMethod)
digestMethod
-public oracle.security.xmlsec.dsig.XSAlgorithmIdentifier[] getCommonTrans()
public void setCommonTrans(oracle.security.xmlsec.dsig.XSAlgorithmIdentifier[] commonTrans)
commonTrans
-
|
Oracle Security Developer Tools Web Services Security Java API Reference 11g (11.1.1) E10678-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |