|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is an interface to be implemented to sign and verify XML signature.
Method Summary | |
KeyProvider |
getKeyProvider()
Returns the real key provider. |
void |
initialize(KeyProvider keyProvider)
Initialize the key provider |
org.w3c.dom.Element |
signWithWSSSAMLTokenProfile(org.w3c.dom.Document doc,
java.security.cert.Certificate cert,
java.lang.String assertionID,
java.lang.String algorithm,
java.util.List ids)
Sign part of the XML document referred by the supplied a list of id attributes of nodes |
org.w3c.dom.Element |
signWithWSSX509TokenProfile(org.w3c.dom.Document doc,
java.security.cert.Certificate cert,
java.lang.String algorithm,
java.util.List ids)
Sign part of the XML document referred by the supplied a list of id attributes of nodes |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias)
Sign the XML document using enveloped signatures. |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm)
Sign the XML document using enveloped signatures. |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm,
java.util.List ids)
Sign part of the XML document referred by the supplied a list of id attributes of nodes |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String id)
Sign part of the XML document referred by the supplied id attribute using enveloped signatures and use exclusive XML canonicalization. |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String transformAlag,
java.util.List ids)
Sign part of the XML document referred by the supplied a list of id attributes of nodes |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String id,
java.lang.String xpath)
Sign part of the XML document referred by the supplied id attribute using enveloped signatures and use exclusive XML canonicalization. |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String idAttrName,
java.lang.String id,
boolean includeCert)
Sign part of the XML document referred by the supplied id attribute using enveloped signatures and use exclusive XML canonicalization. |
org.w3c.dom.Element |
signXML(org.w3c.dom.Document doc,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String idAttrName,
java.lang.String id,
boolean includeCert,
java.lang.String xpath)
Sign part of the XML document referred by the supplied id attribute using enveloped signatures and use exclusive XML canonicalization. |
java.lang.String |
signXML(java.lang.String xmlString,
java.lang.String certAlias)
Sign the XML string using enveloped signatures. |
java.lang.String |
signXML(java.lang.String xmlString,
java.lang.String certAlias,
java.lang.String algorithm)
Sign the XML string using enveloped signatures. |
java.lang.String |
signXML(java.lang.String xmlString,
java.lang.String certAlias,
java.lang.String algorithm,
java.util.List ids)
Sign part of the XML document referred by the supplied a list of id attributes of nodes |
java.lang.String |
signXML(java.lang.String xmlString,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String id)
Sign part of the XML document referred by the supplied id attribute using enveloped signatures and use exclusive XML canonicalization. |
java.lang.String |
signXML(java.lang.String xmlString,
java.lang.String certAlias,
java.lang.String algorithm,
java.lang.String idAttrName,
java.lang.String id,
boolean includeCert)
Sign part of the XML document referred by the supplied id attribute using enveloped signatures and use exclusive XML canonicalization. |
boolean |
verifyXMLSignature(org.w3c.dom.Document document)
Verify all the signatures of the XML document |
boolean |
verifyXMLSignature(org.w3c.dom.Document document,
java.security.cert.Certificate cert)
Verify the signature of the XML document |
boolean |
verifyXMLSignature(org.w3c.dom.Document document,
java.lang.String certAlias)
Verify all the signatures of the XML document |
boolean |
verifyXMLSignature(org.w3c.dom.Element element)
Verify the signature of the XML document |
boolean |
verifyXMLSignature(org.w3c.dom.Element element,
java.lang.String certAlias)
Verify the signature of the XML document |
boolean |
verifyXMLSignature(org.w3c.dom.Element element,
java.lang.String idAttrName,
java.lang.String certAlias)
Verify the signature of the XML document |
boolean |
verifyXMLSignature(java.lang.String xmlString)
Verify the signature of the XML string |
boolean |
verifyXMLSignature(java.lang.String xmlString,
java.lang.String certAlias)
Verify the signature of the XML string |
boolean |
verifyXMLSignature(java.lang.String xmlString,
java.lang.String idAttrName,
java.lang.String certAlias)
Verify the signature of the XML string |
Method Detail |
public void initialize(KeyProvider keyProvider)
keyProvider
- KeyProvider
objectpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias nameXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML Signature Algorithm, such as
SAMLConstants.ALGO_ID_SIGNATURE_DSA
XMLSignatureException
- if the document could not be signedpublic java.lang.String signXML(java.lang.String xmlString, java.lang.String certAlias) throws XMLSignatureException
xmlString
- XML string to be signedcertAlias
- Signer's certificate alias nameXMLSignatureException
- if the XML string could not be signedpublic java.lang.String signXML(java.lang.String xmlString, java.lang.String certAlias, java.lang.String algorithm) throws XMLSignatureException
xmlString
- XML string to be signedcertAlias
- Signer's certificate alias namealgorithm
- XML Signature Algorithm, such as
SAMLConstants.ALGO_ID_SIGNATURE_DSA
XMLSignatureException
- if the XML string could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm, java.lang.String id) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmid
- attribute value of the node to be signedXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm, java.lang.String id, java.lang.String xpath) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmid
- id attribute value of the node to be signedxpath
- expression should uniquely identify a node before whichXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm, java.lang.String idAttrName, java.lang.String id, boolean includeCert) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmidAttrName
- attribute name for the id attribute of the node to be
signed.id
- id attribute value of the node to be signedincludeCert
- if true, include the signing certificate in
KeyInfo
. if false, does not include the signing
certificate.XMLSignatureException
- if the document could not be signedpublic java.lang.String signXML(java.lang.String xmlString, java.lang.String certAlias, java.lang.String algorithm, java.lang.String idAttrName, java.lang.String id, boolean includeCert) throws XMLSignatureException
xmlString
- a string representing XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmidAttrName
- attribute name for the id attribute of the node to be
signedid
- id attribute value of the node to be signedincludeCert
- if true, include the signing certificate in
KeyInfo
. if false, does not include the signing
certificate.XMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm, java.lang.String idAttrName, java.lang.String id, boolean includeCert, java.lang.String xpath) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmidAttrName
- attribute name for the id attribute of the node to be
signedid
- id attribute value of the node to be signedincludeCert
- if true, include the signing certificate in
KeyInfo
. if false, does not include the signing
certificate.xpath
- expression should uniquely identify a node before whichXMLSignatureException
- if the document could not be signedpublic java.lang.String signXML(java.lang.String xmlString, java.lang.String certAlias, java.lang.String algorithm, java.lang.String id) throws XMLSignatureException
xmlString
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmid
- id attribute value of the node to be signedXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm, java.util.List ids) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmids
- list of id attribute values of nodes to be signedXMLSignatureException
- if the document could not be signedpublic java.lang.String signXML(java.lang.String xmlString, java.lang.String certAlias, java.lang.String algorithm, java.util.List ids) throws XMLSignatureException
xmlString
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmids
- list of id attribute values of nodes to be signedXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signXML(org.w3c.dom.Document doc, java.lang.String certAlias, java.lang.String algorithm, java.lang.String transformAlag, java.util.List ids) throws XMLSignatureException
doc
- XML dom objectcertAlias
- Signer's certificate alias namealgorithm
- XML signature algorithmtransformAlag
- XML signature transform algorithm
Those transfer constants are defined as
SAMLConstants.TRANSFORM_XXX
.ids
- list of id attribute values of nodes to be signedXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signWithWSSSAMLTokenProfile(org.w3c.dom.Document doc, java.security.cert.Certificate cert, java.lang.String assertionID, java.lang.String algorithm, java.util.List ids) throws XMLSignatureException
doc
- XML dom objectcert
- signer's CertificateassertionID
- assertion ID for the SAML Security Tokenalgorithm
- XML signature algorithmids
- list of id attribute values of nodes to be signedXMLSignatureException
- if the document could not be signedpublic org.w3c.dom.Element signWithWSSX509TokenProfile(org.w3c.dom.Document doc, java.security.cert.Certificate cert, java.lang.String algorithm, java.util.List ids) throws XMLSignatureException
doc
- XML dom objectcert
- Signer's certificatealgorithm
- XML signature algorithmids
- list of id attribute values of nodes to be signedXMLSignatureException
- if the document could not be signedpublic boolean verifyXMLSignature(org.w3c.dom.Document document) throws XMLSignatureException
document
- XML dom document whose signature to be verifiedXMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(org.w3c.dom.Document document, java.lang.String certAlias) throws XMLSignatureException
document
- XML dom document whose signature to be verifiedcertAlias
- alias for Signer's certificate, this is used to search
signer's public certificate if it is not presented in
ds:KeyInfo
.XMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(org.w3c.dom.Document document, java.security.cert.Certificate cert) throws XMLSignatureException
document
- XML dom document whose signature to be verifiedcert
- Signer's certificate, this is used to search signer's
public certificate if it is not presented in
ds:KeyInfo
.XMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(org.w3c.dom.Element element) throws XMLSignatureException
element
- XML dom document whose signature to be verifiedXMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(org.w3c.dom.Element element, java.lang.String certAlias) throws XMLSignatureException
element
- XML dom document whose signature to be verifiedcertAlias
- certAlias
Signer's certificate alias nameXMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(org.w3c.dom.Element element, java.lang.String idAttrName, java.lang.String certAlias) throws XMLSignatureException
element
- XML dom document whose signature to be verifiedidAttrName
- Attribute name for the id attributecertAlias
- certAlias
Signer's certificate alias nameXMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(java.lang.String xmlString) throws XMLSignatureException
xmlString
- XML string whose signature to be verifiedXMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(java.lang.String xmlString, java.lang.String certAlias) throws XMLSignatureException
xmlString
- XML string whose signature to be verifiedcertAlias
- certAlias
signer's certificate alias nameXMLSignatureException
- if problem occurs during verificationpublic boolean verifyXMLSignature(java.lang.String xmlString, java.lang.String idAttrName, java.lang.String certAlias) throws XMLSignatureException
xmlString
- XML string whose signature to be verifiedidAttrName
- Attribute name for the id attributecertAlias
- certAlias
alias for Signer's certificate,
this is used to search signer's public certificate if it is not
presented in ds:KeyInfo
.XMLSignatureException
- if problem occurs during verificationpublic KeyProvider getKeyProvider()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |