Moved prefix logic in one place

git-svn-id: https://svn.apache.org/repos/asf/poi/branches/xml_signature@1628029 13f79535-47bb-0310-9956-ffa450edef68

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java

@@ -35,7 +35,6 @@ import javax.xml.crypto.dsig.CanonicalizationMethod;
 import org.apache.poi.EncryptedDocumentException;
 import org.apache.poi.openxml4j.opc.OPCPackage;
 import org.apache.poi.poifs.crypt.HashAlgorithm;
-import org.apache.poi.poifs.crypt.dsig.SignatureInfo.SignCreationListener;
 import org.apache.poi.poifs.crypt.dsig.facets.KeyInfoSignatureFacet;
 import org.apache.poi.poifs.crypt.dsig.facets.OOXMLSignatureFacet;
 import org.apache.poi.poifs.crypt.dsig.facets.Office2010SignatureFacet;
@@ -162,7 +161,7 @@ public class SignatureConfig {
         if (onlyValidation) return;
 
         if (signCreationListener == null) {
-            signCreationListener = new SignCreationListener();
+            signCreationListener = new SignatureMarshalListener();
         }
         
         if (signCreationListener instanceof SignatureConfigurable) {

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/SignatureInfo.java

@@ -24,9 +24,7 @@
 
 package org.apache.poi.poifs.crypt.dsig;
 
-import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.OO_DIGSIG_NS;
 import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.XML_DIGSIG_NS;
-import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.XML_NS;
 import static org.apache.xml.security.signature.XMLSignature.ALGO_ID_MAC_HMAC_RIPEMD160;
 import static org.apache.xml.security.signature.XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA1;
 import static org.apache.xml.security.signature.XMLSignature.ALGO_ID_SIGNATURE_RSA_SHA256;
@@ -82,6 +80,7 @@ import org.apache.jcp.xml.dsig.internal.dom.DOMReference;
 import org.apache.jcp.xml.dsig.internal.dom.DOMSignedInfo;
 import org.apache.poi.EncryptedDocumentException;
 import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
+import org.apache.poi.openxml4j.opc.ContentTypes;
 import org.apache.poi.openxml4j.opc.OPCPackage;
 import org.apache.poi.openxml4j.opc.PackagePart;
 import org.apache.poi.openxml4j.opc.PackagePartName;
@@ -107,12 +106,9 @@ import org.apache.xmlbeans.XmlOptions;
 import org.w3.x2000.x09.xmldsig.SignatureDocument;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
-import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
-import org.w3c.dom.events.Event;
 import org.w3c.dom.events.EventListener;
 import org.w3c.dom.events.EventTarget;
-import org.w3c.dom.events.MutationEvent;
 import org.xml.sax.SAXException;
 
 public class SignatureInfo implements SignatureConfigurable {
@@ -203,38 +199,6 @@ public class SignatureInfo implements SignatureConfigurable {
         }
     }
     
-    protected static class SignCreationListener implements EventListener, SignatureConfigurable {
-        ThreadLocal<EventTarget> target = new ThreadLocal<EventTarget>();
-        SignatureConfig signatureConfig;
-        public void setEventTarget(EventTarget target) {
-            this.target.set(target);
-        }
-        public void handleEvent(Event e) {
-            if (e instanceof MutationEvent) {
-                MutationEvent mutEvt = (MutationEvent)e;
-                EventTarget et = mutEvt.getTarget();
-                if (et instanceof Element) {
-                    Element el = (Element)mutEvt.getTarget();
-                    String packageId = signatureConfig.getPackageSignatureId();
-                    if (el.hasAttribute("Id")) {
-                        el.setIdAttribute("Id", true);
-                        
-                        if (packageId.equals(el.getAttribute("Id"))) {
-                            target.get().removeEventListener("DOMSubtreeModified", this, false);
-                            el.setAttributeNS(XML_NS, "xmlns:mdssi", OO_DIGSIG_NS);
-                            target.get().addEventListener("DOMSubtreeModified", this, false);
-                        }
-                    }
-                }
-            }
-        }
-        
-        public void setSignatureConfig(SignatureConfig signatureConfig) {
-            this.signatureConfig = signatureConfig;
-        }
-    }
-    
-    
     public SignatureInfo() {
         initXmlProvider();        
     }
@@ -360,14 +324,6 @@ public class SignatureInfo implements SignatureConfigurable {
         throw new RuntimeException("JRE doesn't support default xml signature provider - set jsr105Provider system property!");
     }
     
-    public static void setPrefix(Node el, String ns, String prefix) {
-        if (ns.equals(el.getNamespaceURI())) el.setPrefix(prefix);
-        NodeList nl = el.getChildNodes();
-        for (int i=0; i<nl.getLength(); i++) {
-            setPrefix(nl.item(i), ns, prefix);
-        }
-    }
-    
     protected byte[] getHashMagic() {
         switch (signatureConfig.getDigestAlgo()) {
         case sha1: return SHA1_DIGEST_INFO_PREFIX;
@@ -424,10 +380,10 @@ public class SignatureInfo implements SignatureConfigurable {
         EventTarget target = (EventTarget)document;
         EventListener creationListener = signatureConfig.getSignCreationListener();
         if (creationListener != null) {
-            if (creationListener instanceof SignCreationListener) {
+            if (creationListener instanceof SignatureMarshalListener) {
-                ((SignCreationListener)creationListener).setEventTarget(target);
+                ((SignatureMarshalListener)creationListener).setEventTarget(target);
             }
-            target.addEventListener("DOMSubtreeModified", creationListener, false);
+            SignatureMarshalListener.setListener(target, creationListener, true);
         }
         
         /*
@@ -442,7 +398,7 @@ public class SignatureInfo implements SignatureConfigurable {
         for (Map.Entry<String,String> me : signatureConfig.getNamespacePrefixes().entrySet()) {
             xmlSignContext.putNamespacePrefix(me.getKey(), me.getValue());
         }
-        xmlSignContext.setDefaultNamespacePrefix(signatureConfig.getNamespacePrefixes().get(XML_DIGSIG_NS));
+        xmlSignContext.setDefaultNamespacePrefix(""); // signatureConfig.getNamespacePrefixes().get(XML_DIGSIG_NS));
         
         XMLSignatureFactory signatureFactory = SignatureInfo.getSignatureFactory();
 
@@ -611,10 +567,9 @@ public class SignatureInfo implements SignatureConfigurable {
             throw new IOException(e);
         }
         
-        String sigContentType = "application/vnd.openxmlformats-package.digital-signature-xmlsignature+xml";
         PackagePart sigPart = pkg.getPart(sigPartName);
         if (sigPart == null) {
-            sigPart = pkg.createPart(sigPartName, sigContentType);
+            sigPart = pkg.createPart(sigPartName, ContentTypes.DIGITAL_SIGNATURE_XML_SIGNATURE_PART);
         }
         
         OutputStream os = sigPart.getOutputStream();
@@ -622,11 +577,10 @@ public class SignatureInfo implements SignatureConfigurable {
         sigDoc.save(os, xo);
         os.close();
         
-        String sigsContentType = "application/vnd.openxmlformats-package.digital-signature-origin";
         PackagePart sigsPart = pkg.getPart(sigsPartName);
         if (sigsPart == null) {
             // touch empty marker file
-            sigsPart = pkg.createPart(sigsPartName, sigsContentType);
+            sigsPart = pkg.createPart(sigsPartName, ContentTypes.DIGITAL_SIGNATURE_ORIGIN_PART);
         }
         
         PackageRelationshipCollection relCol = pkg.getRelationshipsByType(PackageRelationshipTypes.DIGITAL_SIGNATURE_ORIGIN);

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/SignatureMarshalListener.java

@@ -0,0 +1,92 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+
+package org.apache.poi.poifs.crypt.dsig;
+
+import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.OO_DIGSIG_NS;
+import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.XML_NS;
+
+import org.apache.poi.poifs.crypt.dsig.SignatureConfig.SignatureConfigurable;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.w3c.dom.events.Event;
+import org.w3c.dom.events.EventListener;
+import org.w3c.dom.events.EventTarget;
+import org.w3c.dom.events.MutationEvent;
+
+/**
+ * This listener class is used, to modify the to be digested xml document,
+ * e.g. to register id attributes or set prefixes for registered namespaces
+ */
+public class SignatureMarshalListener implements EventListener, SignatureConfigurable {
+    ThreadLocal<EventTarget> target = new ThreadLocal<EventTarget>();
+    SignatureConfig signatureConfig;
+    public void setEventTarget(EventTarget target) {
+        this.target.set(target);
+    }
+    
+    public void handleEvent(Event e) {
+        if (!(e instanceof MutationEvent)) return;
+        MutationEvent mutEvt = (MutationEvent)e;
+        EventTarget et = mutEvt.getTarget();
+        if (!(et instanceof Element)) return;
+        handleElement((Element)et);
+    }
+
+    public void handleElement(Element el) {
+        EventTarget target = this.target.get();
+        String packageId = signatureConfig.getPackageSignatureId();
+        if (el.hasAttribute("Id")) {
+            el.setIdAttribute("Id", true);
+        }
+
+        setListener(target, this, false);
+        if (packageId.equals(el.getAttribute("Id"))) {
+            el.setAttributeNS(XML_NS, "xmlns:mdssi", OO_DIGSIG_NS);
+        }
+        setPrefix(el);
+        setListener(target, this, true);
+    }
+
+    // helper method to keep it in one place
+    public static void setListener(EventTarget target, EventListener listener, boolean enabled) {
+        String type = "DOMSubtreeModified";
+        boolean useCapture = false;
+        if (enabled) {
+            target.addEventListener(type, listener, useCapture);
+        } else {
+            target.removeEventListener(type, listener, useCapture);
+        }
+    }
+    
+    protected void setPrefix(Node el) {
+        String prefix = signatureConfig.getNamespacePrefixes().get(el.getNamespaceURI());
+        if (prefix != null && el.getPrefix() == null) {
+            el.setPrefix(prefix);
+        }
+        
+        NodeList nl = el.getChildNodes();
+        for (int i=0; i<nl.getLength(); i++) {
+            setPrefix(nl.item(i));
+        }
+    }
+    
+    public void setSignatureConfig(SignatureConfig signatureConfig) {
+        this.signatureConfig = signatureConfig;
+    }
+}

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/facets/KeyInfoSignatureFacet.java

@@ -31,9 +31,9 @@ import java.security.NoSuchAlgorithmException;
 import java.security.cert.X509Certificate;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import javax.xml.crypto.MarshalException;
-import javax.xml.crypto.dom.DOMCryptoContext;
 import javax.xml.crypto.dom.DOMStructure;
 import javax.xml.crypto.dsig.Reference;
 import javax.xml.crypto.dsig.XMLObject;
@@ -139,11 +139,12 @@ public class KeyInfoSignatureFacet implements SignatureFacet {
 
         Element n = document.getDocumentElement();
         DOMSignContext domSignContext = new DOMSignContext(key, n, nextSibling);
-        DOMCryptoContext domCryptoContext = domSignContext;
+        for (Map.Entry<String,String> me : signatureConfig.getNamespacePrefixes().entrySet()) {
-        domCryptoContext.putNamespacePrefix(XML_DIGSIG_NS, "xd");
+            domSignContext.putNamespacePrefix(me.getKey(), me.getValue());
+        }
+        
         DOMStructure domStructure = new DOMStructure(n);
-        // how to set nextSibling??? - marshal is ignoring nextSibling in DOMSignContext
+        domKeyInfo.marshal(domStructure, domSignContext);
-        domKeyInfo.marshal(domStructure, domCryptoContext);
         
         // move keyinfo into the right place
         if (nextSibling != null) {

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/facets/OOXMLSignatureFacet.java

@@ -24,8 +24,6 @@
 
 package org.apache.poi.poifs.crypt.dsig.facets;
 
-import static org.apache.poi.poifs.crypt.dsig.SignatureInfo.setPrefix;
-
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
@@ -40,6 +38,7 @@ import java.util.List;
 import java.util.Set;
 import java.util.TimeZone;
 
+import javax.xml.XMLConstants;
 import javax.xml.crypto.XMLStructure;
 import javax.xml.crypto.dom.DOMStructure;
 import javax.xml.crypto.dsig.CanonicalizationMethod;
@@ -104,11 +103,12 @@ public class OOXMLSignatureFacet implements SignatureFacet {
         addSignatureInfo(document, signatureFactory, references, objects);
     }
 
-    private void addManifestObject(Document document,
+    protected void addManifestObject(
-            XMLSignatureFactory signatureFactory,
+        Document document
-            List<Reference> references,
+        , XMLSignatureFactory signatureFactory
-            List<XMLObject> objects) throws NoSuchAlgorithmException,
+        , List<Reference> references
-            InvalidAlgorithmParameterException, IOException, URISyntaxException, XmlException {
+        , List<XMLObject> objects)
+    throws NoSuchAlgorithmException, InvalidAlgorithmParameterException, IOException, URISyntaxException, XmlException {
 
         List<Reference> manifestReferences = new ArrayList<Reference>();
         addManifestReferences(signatureFactory, manifestReferences);
@@ -129,14 +129,13 @@ public class OOXMLSignatureFacet implements SignatureFacet {
         references.add(reference);
     }
 
-    private void addManifestReferences(XMLSignatureFactory signatureFactory, List<Reference> manifestReferences)
+    protected void addManifestReferences
-            throws IOException, NoSuchAlgorithmException,
+        (XMLSignatureFactory signatureFactory, List<Reference> manifestReferences)
-            InvalidAlgorithmParameterException, URISyntaxException, XmlException {
+    throws IOException, NoSuchAlgorithmException, InvalidAlgorithmParameterException, URISyntaxException, XmlException {
 
-        OPCPackage ooxml = this.signatureConfig.getOpcPackage();
+        OPCPackage ooxml = signatureConfig.getOpcPackage();
         List<PackagePart> relsEntryNames = ooxml.getPartsByContentType(ContentTypes.RELATIONSHIPS_PART);
 
-
         DigestMethod digestMethod = signatureFactory.newDigestMethod(signatureConfig.getDigestAlgo().xmlSignUri, null);
         Set<String> digestedPartNames = new HashSet<String>();
         for (PackagePart pp : relsEntryNames) {
@@ -154,12 +153,12 @@ public class OOXMLSignatureFacet implements SignatureFacet {
             for (PackageRelationship relationship : prc) {
                 String relationshipType = relationship.getRelationshipType();
                 
-                if (TargetMode.EXTERNAL == relationship.getTargetMode()) {
                 /*
                  * ECMA-376 Part 2 - 3rd edition
                  * 13.2.4.16 Manifest Element
                  * "The producer shall not create a Manifest element that references any data outside of the package."
                  */
+                if (TargetMode.EXTERNAL == relationship.getTargetMode()) {
                     continue;
                 }
 
@@ -180,6 +179,7 @@ public class OOXMLSignatureFacet implements SignatureFacet {
                 } catch (InvalidFormatException e) {
                     throw new IOException(e);
                 }
+                
                 if (relationshipType.endsWith("customXml")
                     && !(contentType.equals("inkml+xml") || contentType.equals("text/xml"))) {
                     LOG.log(POILogger.DEBUG, "skipping customXml with content type: " + contentType);
@@ -212,15 +212,16 @@ public class OOXMLSignatureFacet implements SignatureFacet {
     }
 
 
-    private void addSignatureTime(Document document,
+    protected void addSignatureTime(
-            XMLSignatureFactory signatureFactory,
+        Document document
-            List<XMLStructure> objectContent) {
+        , XMLSignatureFactory signatureFactory
+        , List<XMLStructure> objectContent) {
         /*
          * SignatureTime
          */
         DateFormat fmt = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
         fmt.setTimeZone(TimeZone.getTimeZone("UTC"));
-        String nowStr = fmt.format(this.signatureConfig.getExecutionTime());
+        String nowStr = fmt.format(signatureConfig.getExecutionTime());
         LOG.log(POILogger.DEBUG, "now: " + nowStr);
 
         SignatureTimeDocument sigTime = SignatureTimeDocument.Factory.newInstance();
@@ -228,10 +229,7 @@ public class OOXMLSignatureFacet implements SignatureFacet {
         ctTime.setFormat("YYYY-MM-DDThh:mm:ssTZD");
         ctTime.setValue(nowStr);
 
-        // TODO: find better method to have xmlbeans + export the prefix
         Element n = (Element)document.importNode(ctTime.getDomNode(),true);
-        setPrefix(n, OO_DIGSIG_NS, "mdssi");
-        
         List<XMLStructure> signatureTimeContent = new ArrayList<XMLStructure>();
         signatureTimeContent.add(new DOMStructure(n));
         SignatureProperty signatureTimeSignatureProperty = signatureFactory
@@ -245,7 +243,7 @@ public class OOXMLSignatureFacet implements SignatureFacet {
         objectContent.add(signatureProperties);
     }
 
-    private void addSignatureInfo(Document document,
+    protected void addSignatureInfo(Document document,
         XMLSignatureFactory signatureFactory,
         List<Reference> references,
         List<XMLObject> objects)
@@ -256,7 +254,7 @@ public class OOXMLSignatureFacet implements SignatureFacet {
         CTSignatureInfoV1 ctSigV1 = sigV1.addNewSignatureInfoV1();
         ctSigV1.setManifestHashAlgorithm(signatureConfig.getDigestAlgo().xmlSignUri);
         Element n = (Element)document.importNode(ctSigV1.getDomNode(), true);
-        n.setAttributeNS(XML_NS, "xmlns", "http://schemas.microsoft.com/office/2006/digsig");
+        n.setAttributeNS(XML_NS, XMLConstants.XMLNS_ATTRIBUTE, MS_DIGSIG_NS);
         
         List<XMLStructure> signatureInfoContent = new ArrayList<XMLStructure>();
         signatureInfoContent.add(new DOMStructure(n));
@@ -284,21 +282,31 @@ public class OOXMLSignatureFacet implements SignatureFacet {
         // empty
     }
 
-    public static String getRelationshipReferenceURI(String zipEntryName) {
+    protected static String getRelationshipReferenceURI(String zipEntryName) {
-
         return "/"
             + zipEntryName
             + "?ContentType=application/vnd.openxmlformats-package.relationships+xml";
     }
 
-    public static String getResourceReferenceURI(String resourceName,
+    protected static String getResourceReferenceURI(String resourceName, String contentType) {
-            String contentType) {
-
         return "/" + resourceName + "?ContentType=" + contentType;
     }
 
-    public static String[] contentTypes = {
+    protected static boolean isSignedRelationship(String relationshipType) {
+        LOG.log(POILogger.DEBUG, "relationship type: " + relationshipType);
+        for (String signedTypeExtension : signed) {
+            if (relationshipType.endsWith(signedTypeExtension)) {
+                return true;
+            }
+        }
+        if (relationshipType.endsWith("customXml")) {
+            LOG.log(POILogger.DEBUG, "customXml relationship type");
+            return true;
+        }
+        return false;
+    }
     
+    public static final String[] contentTypes = {
         /*
          * Word
          */
@@ -336,26 +344,14 @@ public class OOXMLSignatureFacet implements SignatureFacet {
          * Powerpoint 2010
          */
         "application/vnd.openxmlformats-officedocument.presentationml.viewProps+xml",
-            "application/vnd.openxmlformats-officedocument.presentationml.presProps+xml" };
+        "application/vnd.openxmlformats-officedocument.presentationml.presProps+xml"
-
+    };
-    public static boolean isSignedRelationship(String relationshipType) {
-        LOG.log(POILogger.DEBUG, "relationship type: " + relationshipType);
-        for (String signedTypeExtension : signed) {
-            if (relationshipType.endsWith(signedTypeExtension)) {
-                return true;
-            }
-        }
-        if (relationshipType.endsWith("customXml")) {
-            LOG.log(POILogger.DEBUG, "customXml relationship type");
-            return true;
-        }
-        return false;
-    }
 
     /**
      * Office 2010 list of signed types (extensions).
      */
-    public static String[] signed = { "powerPivotData", //
+    public static final String[] signed = {
+        "powerPivotData", //
         "activeXControlBinary", //
         "attachedToolbars", //
         "connectorXml", //

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/facets/XAdESSignatureFacet.java

@@ -24,8 +24,6 @@
 
 package org.apache.poi.poifs.crypt.dsig.facets;
 
-import static org.apache.poi.poifs.crypt.dsig.SignatureInfo.setPrefix;
-
 import java.security.InvalidAlgorithmParameterException;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
@@ -206,14 +204,10 @@ public class XAdESSignatureFacet implements SignatureFacet {
             }
         }
 
-        // marshall XAdES QualifyingProperties
-        // ((Element)qualifyingProperties.getSignedProperties().getDomNode()).setIdAttribute("Id", true);
-
         // add XAdES ds:Object
         List<XMLStructure> xadesObjectContent = new ArrayList<XMLStructure>();
-        Element qualDocEl = (Element)document.importNode(qualifyingProperties.getDomNode(), true);
+        Element qualDocElSrc = (Element)qualifyingProperties.getDomNode();
-        qualDocEl.setAttributeNS(XML_NS, "xmlns:xd", XADES_132_NS);
+        Element qualDocEl = (Element)document.importNode(qualDocElSrc, true);
-        setPrefix(qualDocEl, XADES_132_NS, "xd");
         xadesObjectContent.add(new DOMStructure(qualDocEl));
         XMLObject xadesObject = signatureFactory.newXMLObject(xadesObjectContent, null, null, null);
         objects.add(xadesObject);

src/ooxml/java/org/apache/poi/poifs/crypt/dsig/services/RelationshipTransformService.java

@@ -24,9 +24,6 @@
 
 package org.apache.poi.poifs.crypt.dsig.services;
 
-import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.XML_DIGSIG_NS;
-import static org.apache.poi.poifs.crypt.dsig.facets.SignatureFacet.XML_NS;
-
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -171,8 +168,6 @@ public class RelationshipTransformService extends TransformService {
             RelationshipReferenceDocument relRef = RelationshipReferenceDocument.Factory.newInstance();
             relRef.addNewRelationshipReference().setSourceId(sourceId);
             Node n = relRef.getRelationshipReference().getDomNode();
-            // TODO: is there a more elegant way to do this?
-            n.setPrefix("mdssi");
             n = doc.importNode(n, true);
             parentNode.appendChild(n);
         }