1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /*
   6  * Copyright 2008 The Apache Software Foundation.
   7  *
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  */
  21 /*
  22  * Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved.
  23  */
  24 /*
  25  * $Id: DOMCanonicalXMLC14N11Method.java,v 1.2 2008/07/24 15:20:32 mullan Exp $
  26  */
  27 package org.jcp.xml.dsig.internal.dom;
  28 
  29 import javax.xml.crypto.*;
  30 import javax.xml.crypto.dsig.*;
  31 import javax.xml.crypto.dsig.spec.TransformParameterSpec;
  32 
  33 import java.security.InvalidAlgorithmParameterException;
  34 
  35 import com.sun.org.apache.xml.internal.security.c14n.Canonicalizer;
  36 import com.sun.org.apache.xml.internal.security.c14n.InvalidCanonicalizerException;
  37 
  38 /**
  39  * DOM-based implementation of CanonicalizationMethod for Canonical XML 1.1
  40  * (with or without comments). Uses Apache XML-Sec Canonicalizer.
  41  *
  42  * @author Sean Mullan
  43  */
  44 public final class DOMCanonicalXMLC14N11Method extends ApacheCanonicalizer {
  45 
  46     public static final String C14N_11 = "http://www.w3.org/2006/12/xml-c14n11";
  47     public static final String C14N_11_WITH_COMMENTS
  48         = "http://www.w3.org/2006/12/xml-c14n11#WithComments";
  49 
  50     public void init(TransformParameterSpec params)
  51         throws InvalidAlgorithmParameterException {
  52         if (params != null) {
  53             throw new InvalidAlgorithmParameterException("no parameters " +
  54                 "should be specified for Canonical XML 1.1 algorithm");
  55         }
  56     }
  57 
  58     public Data transform(Data data, XMLCryptoContext xc)
  59         throws TransformException {
  60 
  61         // ignore comments if dereferencing same-document URI that requires
  62         // you to omit comments, even if the Transform says otherwise -
  63         // this is to be compliant with section 4.3.3.3 of W3C Rec.
  64         if (data instanceof DOMSubTreeData) {
  65             DOMSubTreeData subTree = (DOMSubTreeData) data;
  66             if (subTree.excludeComments()) {
  67                 try {
  68                     apacheCanonicalizer = Canonicalizer.getInstance(C14N_11);
  69                 } catch (InvalidCanonicalizerException ice) {
  70                     throw new TransformException
  71                         ("Couldn't find Canonicalizer for: " +
  72                          C14N_11 + ": " + ice.getMessage(), ice);
  73                 }
  74             }
  75         }
  76 
  77         return canonicalize(data, xc);
  78     }
  79 }