org.apache.jcp.xml.dsig.internal.dom.DOMTransform Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmlsec Show documentation
Show all versions of xmlsec Show documentation
Apache XML Security for Java supports XML-Signature Syntax and Processing,
W3C Recommendation 12 February 2002, and XML Encryption Syntax and
Processing, W3C Recommendation 10 December 2002. As of version 1.4,
the library supports the standard Java API JSR-105: XML Digital Signature APIs.
/**
* 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.
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
*/
/*
* $Id: DOMTransform.java 1667527 2015-03-18 12:54:20Z mullan $
*/
package org.apache.jcp.xml.dsig.internal.dom;
import java.io.OutputStream;
import java.security.InvalidAlgorithmParameterException;
import java.security.NoSuchAlgorithmException;
import java.security.Provider;
import java.security.spec.AlgorithmParameterSpec;
import javax.xml.crypto.Data;
import javax.xml.crypto.MarshalException;
import javax.xml.crypto.XMLCryptoContext;
import javax.xml.crypto.dsig.Transform;
import javax.xml.crypto.dsig.TransformException;
import javax.xml.crypto.dsig.TransformService;
import javax.xml.crypto.dsig.XMLSignature;
import javax.xml.crypto.dsig.dom.DOMSignContext;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
/**
* DOM-based abstract implementation of Transform.
*
* @author Sean Mullan
*/
public class DOMTransform extends BaseStructure implements Transform {
protected TransformService spi;
/**
* Creates a DOMTransform.
*
* @param spi the TransformService
*/
public DOMTransform(TransformService spi) {
this.spi = spi;
}
/**
* Creates a DOMTransform from an element. It unmarshals any
* algorithm-specific input parameters.
*
* @param transElem a Transform element
*/
public DOMTransform(Element transElem, XMLCryptoContext context,
Provider provider)
throws MarshalException
{
String algorithm = DOMUtils.getAttributeValue(transElem, "Algorithm");
if (provider == null) {
try {
spi = TransformService.getInstance(algorithm, "DOM");
} catch (NoSuchAlgorithmException e1) {
throw new MarshalException(e1);
}
} else {
try {
spi = TransformService.getInstance(algorithm, "DOM", provider);
} catch (NoSuchAlgorithmException nsae) {
try {
spi = TransformService.getInstance(algorithm, "DOM");
} catch (NoSuchAlgorithmException e2) {
throw new MarshalException(e2);
}
}
}
try {
spi.init(new javax.xml.crypto.dom.DOMStructure(transElem), context);
} catch (InvalidAlgorithmParameterException iape) {
throw new MarshalException(iape);
}
}
@Override
public final AlgorithmParameterSpec getParameterSpec() {
return spi.getParameterSpec();
}
@Override
public final String getAlgorithm() {
return spi.getAlgorithm();
}
/**
* This method marshals any algorithm-specific parameters.
*/
public void marshal(XmlWriter xwriter, String dsPrefix, XMLCryptoContext context)
throws MarshalException
{
String parentLocalName = xwriter.getCurrentLocalName();
String localName = parentLocalName.equals("Transforms") ? "Transform" : "CanonicalizationMethod";
xwriter.writeStartElement(dsPrefix, localName, XMLSignature.XMLNS);
xwriter.writeAttribute("", "", "Algorithm", getAlgorithm());
javax.xml.crypto.XMLStructure xmlStruct = xwriter.getCurrentNodeAsStructure();
spi.marshalParams(xmlStruct, context);
xwriter.writeEndElement(); // "Transforms" or "CanonicalizationMethod"
}
/**
* Transforms the specified data using the underlying transform algorithm.
*
* @param data the data to be transformed
* @param xc the XMLCryptoContext containing
* additional context (may be null if not applicable)
* @return the transformed data
* @throws NullPointerException if data is null
* @throws XMLSignatureException if an unexpected error occurs while
* executing the transform
*/
@Override
public Data transform(Data data, XMLCryptoContext xc)
throws TransformException
{
return spi.transform(data, xc);
}
/**
* Transforms the specified data using the underlying transform algorithm.
*
* @param data the data to be transformed
* @param xc the XMLCryptoContext containing
* additional context (may be null if not applicable)
* @param os the OutputStream that should be used to write
* the transformed data to
* @return the transformed data
* @throws NullPointerException if data is null
* @throws XMLSignatureException if an unexpected error occurs while
* executing the transform
*/
@Override
public Data transform(Data data, XMLCryptoContext xc, OutputStream os)
throws TransformException
{
return spi.transform(data, xc, os);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Transform)) {
return false;
}
Transform otransform = (Transform)o;
return getAlgorithm().equals(otransform.getAlgorithm()) &&
DOMUtils.paramsEqual(getParameterSpec(),
otransform.getParameterSpec());
}
@Override
public int hashCode() {
int result = 17;
result = 31 * result + getAlgorithm().hashCode();
AlgorithmParameterSpec spec = getParameterSpec();
if (spec != null) {
result = 31 * result + spec.hashCode();
}
return result;
}
/**
* Transforms the specified data using the underlying transform algorithm.
* This method invokes the {@link #marshal marshal} method and passes it
* the specified DOMSignContext before transforming the data.
*
* @param data the data to be transformed
* @param sc the XMLCryptoContext containing
* additional context (may be null if not applicable)
* @param context the marshalling context
* @return the transformed data
* @throws MarshalException if an exception occurs while marshalling
* @throws NullPointerException if data or context
* is null
* @throws XMLSignatureException if an unexpected error occurs while
* executing the transform
*/
Data transform(Data data, XMLCryptoContext xc, DOMSignContext context)
throws MarshalException, TransformException
{
Node parent = context.getParent();
XmlWriter xwriter = new XmlWriterToTree(Marshaller.getMarshallers(), parent);
marshal(xwriter, DOMUtils.getSignaturePrefix(context), context);
return transform(data, xc);
}
}