/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "<WebSig>" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2001, Institute for
* Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
* The development of this software was partly funded by the European
* Commission in the <WebSig> project in the ISIS Programme.
* For more information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.xml.security.utils.resolver.implementations;
import java.net.*;
import java.io.*;
import java.util.*;
import org.w3c.dom.*;
import org.apache.xml.utils.URI;
import org.apache.xpath.CachedXPathAPI;
import org.apache.xml.security.c14n.*;
import org.apache.xml.security.signature.XMLSignatureInput;
import org.apache.xml.security.utils.*;
import org.apache.xml.security.utils.resolver.*;
/**
* Handles barename XPointer Reference URIs.
* <BR />
* To retain comments while selecting an element by an identifier ID,
* use the following full XPointer: URI='#xpointer(id('ID'))'.
* <BR />
* To retain comments while selecting the entire document,
* use the following full XPointer: URI='#xpointer(/)'.
* This XPointer contains a simple XPath expression that includes
* the root node, which the second to last step above replaces with all
* nodes of the parse tree (all descendants, plus all attributes,
* plus all namespaces nodes).
*
* @author $Author: geuerp $
*/
public class ResolverXPointer extends ResourceResolverSpi {
/** {@link org.apache.log4j} logging facility */
static org.apache.log4j.Category cat =
org.apache.log4j.Category.getInstance(ResolverXPointer.class.getName());
/**
* Method engineResolve
*
* Wird das gleiche Dokument referenziert?
* Wird ein anderes Dokument referenziert?
*
* @param uri
* @param BaseURI
* @return
* @throws ResourceResolverException
*/
public XMLSignatureInput engineResolve(Attr uri, String BaseURI)
throws ResourceResolverException {
String uriNodeValue = uri.getNodeValue();
NodeList resultNodes = null;
Document doc = uri.getOwnerDocument();
// this must be done so that Xalan can catch ALL namespaces
XMLUtils.circumventBug2650(doc);
CachedXPathAPI cXPathAPI = new CachedXPathAPI();
try {
if (isXPointerSlash(uri, BaseURI)) {
resultNodes =
cXPathAPI.selectNodeList(doc,
Canonicalizer.XPATH_C14N_WITH_COMMENTS);
} else if (isXPointerId(uri, BaseURI)) {
String id = getXPointerId(uri, BaseURI);
Element selectedElem = IdResolver.getElementById(doc, id);
// cat.debug("Use #xpointer(id('" + id + "')) on element " + selectedElem);
if (selectedElem == null) {
Object exArgs[] = { id };
throw new ResourceResolverException(
"signature.Verification.MissingID", exArgs, uri, BaseURI);
}
resultNodes =
cXPathAPI
.selectNodeList(selectedElem, Canonicalizer
.XPATH_C14N_WITH_COMMENTS_SINGLE_NODE);
}
} catch (javax.xml.transform.TransformerException ex) {
throw new ResourceResolverException("generic.EmptyMessage", ex, uri,
BaseURI);
}
Set resultSet = XMLUtils.convertNodelistToSet(resultNodes);
XMLSignatureInput result = new XMLSignatureInput(resultSet, cXPathAPI);
result.setMIMEType("text/xml");
try {
URI uriNew = new URI(new URI(BaseURI), uri.getNodeValue());
result.setSourceURI(uriNew.toString());
} catch (URI.MalformedURIException ex) {
result.setSourceURI(BaseURI);
}
return result;
}
/**
* Method engineCanResolve
*
* @param uri
* @param BaseURI
* @return
*/
public boolean engineCanResolve(Attr uri, String BaseURI) {
if (uri == null) {
return false;
}
String uriNodeValue = uri.getNodeValue();
if (isXPointerSlash(uri, BaseURI) || isXPointerId(uri, BaseURI)) {
return true;
}
return false;
}
/**
* Method isSameDocumentReference
*
* @param uri
* @param BaseURI
* @return
*/
private static boolean isSameDocumentReference(Attr uri, String BaseURI) {
if (uri.getNodeValue().startsWith("#")) {
return true;
} else {
return false;
}
}
/**
* Method isXPointerSlash
*
* @param uri
* @param BaseURI
* @return
*/
private static boolean isXPointerSlash(Attr uri, String BaseURI) {
if (uri.getNodeValue().equals("#xpointer(/)")) {
return true;
}
return false;
}
/**
* Method isXPointerId
*
* @param uri
* @param BaseURI
* @return
*/
private static boolean isXPointerId(Attr uri, String BaseURI) {
String uriNodeValue = uri.getNodeValue();
if (uriNodeValue.startsWith("#xpointer(id(")
&& uriNodeValue.endsWith("))")) {
String idPlusDelim = uriNodeValue.substring("#xpointer(id(".length(),
uriNodeValue.length()
- "))".length());
// cat.debug("idPlusDelim=" + idPlusDelim);
if (((idPlusDelim.charAt(0) == '"') && (idPlusDelim
.charAt(idPlusDelim.length() - 1) == '"')) || ((idPlusDelim
.charAt(0) == '\'') && (idPlusDelim
.charAt(idPlusDelim.length() - 1) == '\''))) {
cat.debug("Id="
+ idPlusDelim.substring(1, idPlusDelim.length() - 1));
return true;
}
}
return false;
}
/**
* Method getXPointerId
*
* @param uri
* @param BaseURI
* @return
*/
private static String getXPointerId(Attr uri, String BaseURI) {
String uriNodeValue = uri.getNodeValue();
if (uriNodeValue.startsWith("#xpointer(id(")
&& uriNodeValue.endsWith("))")) {
String idPlusDelim = uriNodeValue.substring("#xpointer(id(".length(),
uriNodeValue.length()
- "))".length());
if (((idPlusDelim.charAt(0) == '"') && (idPlusDelim
.charAt(idPlusDelim.length() - 1) == '"')) || ((idPlusDelim
.charAt(0) == '\'') && (idPlusDelim
.charAt(idPlusDelim.length() - 1) == '\''))) {
return idPlusDelim.substring(1, idPlusDelim.length() - 1);
}
}
return null;
}
}