org.apache.poi.poifs.crypt.dsig.facets

Class XAdESSignatureFacet

java.lang.Object

org.apache.poi.poifs.crypt.dsig.facets.XAdESSignatureFacet

All Implemented Interfaces:

SignatureFacet

public class XAdESSignatureFacet
extends java.lang.Object
implements SignatureFacet

XAdES Signature Facet. Implements XAdES v1.4.1 which is compatible with XAdES v1.3.2. The implemented XAdES format is XAdES-BES/EPES. It's up to another part of the signature service to upgrade the XAdES-BES to a XAdES-X-L. This implementation has been tested against an implementation that participated multiple ETSI XAdES plugtests.

See Also:

XAdES

Field Summary

Fields inherited from interface org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet

MS_DIGSIG_NS, OO_DIGSIG_NS, XADES_132_NS, XADES_141_NS, XML_DIGSIG_NS, XML_NS

Constructor Summary

Constructors

Constructor and Description
XAdESSignatureFacet()

Method Summary

Modifier and Type	Method and Description
protected void	addCertificate(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)
protected void	addCommitmentType(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.SignedPropertiesType signedProperties)
void	addMimeType(java.lang.String dsReferenceUri, java.lang.String mimetype) Adds a mime-type for the given ds:Reference (referred via its @URI).
protected void	addMimeTypes(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.SignedPropertiesType signedProperties)
protected void	addPolicy(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)
protected void	addSigningTime(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)
protected javax.xml.crypto.dsig.XMLObject	addXadesObject(SignatureInfo signatureInfo, org.w3c.dom.Document document, org.etsi.uri.x01903.v13.QualifyingPropertiesType qualifyingProperties)
protected javax.xml.crypto.dsig.Reference	addXadesReference(SignatureInfo signatureInfo)
protected void	addXadesRole(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)
protected org.etsi.uri.x01903.v13.SignedPropertiesType	createSignedProperties(SignatureInfo signatureInfo, org.etsi.uri.x01903.v13.QualifyingPropertiesType qualifyingProperties) Create the signedProperties.
protected static void	insertXChild(org.apache.xmlbeans.XmlObject root, org.apache.xmlbeans.XmlObject child)
void	preSign(SignatureInfo signatureInfo, org.w3c.dom.Document document, java.util.List<javax.xml.crypto.dsig.Reference> references, java.util.List<javax.xml.crypto.dsig.XMLObject> objects) This method is being invoked by the XML signature service engine during pre-sign phase.
protected static void	setCertID(org.etsi.uri.x01903.v13.CertIDType certId, SignatureConfig signatureConfig, boolean issuerNameNoReverseOrder, java.security.cert.X509Certificate certificate) Gives back the JAXB CertID data structure.
protected static void	setDigestAlgAndValue(org.etsi.uri.x01903.v13.DigestAlgAndValueType digestAlgAndValue, byte[] data, HashAlgorithm digestAlgo) Gives back the JAXB DigestAlgAndValue data structure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet

postSign

Constructor Detail

XAdESSignatureFacet

public XAdESSignatureFacet()

Method Detail

preSign

public void preSign(SignatureInfo signatureInfo,
                    org.w3c.dom.Document document,
                    java.util.List<javax.xml.crypto.dsig.Reference> references,
                    java.util.List<javax.xml.crypto.dsig.XMLObject> objects)
             throws javax.xml.crypto.dsig.XMLSignatureException

Description copied from interface: SignatureFacet

This method is being invoked by the XML signature service engine during pre-sign phase. Via this method a signature facet implementation can add signature facets to an XML signature.

Specified by:

preSign in interface SignatureFacet

Parameters:

signatureInfo - the signature info object holding the OPCPackage and other document related data

document - the signature document to be used for imports

references - list of reference definitions

objects - objects to be signed/included in the signature document

Throws:

javax.xml.crypto.dsig.XMLSignatureException

createSignedProperties

protected org.etsi.uri.x01903.v13.SignedPropertiesType createSignedProperties(SignatureInfo signatureInfo,
                                                                              org.etsi.uri.x01903.v13.QualifyingPropertiesType qualifyingProperties)

Create the signedProperties. Subclasses can easily extend the signed properties.

addSigningTime

protected void addSigningTime(SignatureInfo signatureInfo,
                              org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)

addCertificate

protected void addCertificate(SignatureInfo signatureInfo,
                              org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)

addXadesRole

protected void addXadesRole(SignatureInfo signatureInfo,
                            org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)

addPolicy

protected void addPolicy(SignatureInfo signatureInfo,
                         org.etsi.uri.x01903.v13.SignedSignaturePropertiesType signedSignatureProperties)

addMimeTypes

protected void addMimeTypes(SignatureInfo signatureInfo,
                            org.etsi.uri.x01903.v13.SignedPropertiesType signedProperties)

addXadesObject

protected javax.xml.crypto.dsig.XMLObject addXadesObject(SignatureInfo signatureInfo,
                                                         org.w3c.dom.Document document,
                                                         org.etsi.uri.x01903.v13.QualifyingPropertiesType qualifyingProperties)

addCommitmentType

protected void addCommitmentType(SignatureInfo signatureInfo,
                                 org.etsi.uri.x01903.v13.SignedPropertiesType signedProperties)

addXadesReference

protected javax.xml.crypto.dsig.Reference addXadesReference(SignatureInfo signatureInfo)
                                                     throws javax.xml.crypto.dsig.XMLSignatureException

Throws:

javax.xml.crypto.dsig.XMLSignatureException

setDigestAlgAndValue

protected static void setDigestAlgAndValue(org.etsi.uri.x01903.v13.DigestAlgAndValueType digestAlgAndValue,
                                           byte[] data,
                                           HashAlgorithm digestAlgo)

Gives back the JAXB DigestAlgAndValue data structure.

Parameters:

digestAlgAndValue - the parent for the new digest element

data - the data to be digested

digestAlgo - the digest algorithm

setCertID

protected static void setCertID(org.etsi.uri.x01903.v13.CertIDType certId,
                                SignatureConfig signatureConfig,
                                boolean issuerNameNoReverseOrder,
                                java.security.cert.X509Certificate certificate)

Gives back the JAXB CertID data structure.

addMimeType

public void addMimeType(java.lang.String dsReferenceUri,
                        java.lang.String mimetype)

Adds a mime-type for the given ds:Reference (referred via its @URI). This information is added via the xades:DataObjectFormat element.

Parameters:

dsReferenceUri - the reference uri

mimetype - the mimetype

insertXChild

protected static void insertXChild(org.apache.xmlbeans.XmlObject root,
                                   org.apache.xmlbeans.XmlObject child)