Module org.apache.santuario.xmlsec
Package org.apache.xml.security.utils

Class XMLUtils

java.lang.Object
org.apache.xml.security.utils.XMLUtils
public final class XMLUtils extends Object
DOM and XML accessibility and comfort functions.

  • Method Details

    • setDsPrefix

      public static void setDsPrefix(String prefix)
      Set the prefix for the digital signature namespace
      Parameters:
      prefix - the new prefix for the digital signature namespace
      Throws:
      SecurityException - if a security manager is installed and the caller does not have permission to set the prefix

    • setDs11Prefix

      public static void setDs11Prefix(String prefix)
      Set the prefix for the digital signature 1.1 namespace
      Parameters:
      prefix - the new prefix for the digital signature 1.1 namespace
      Throws:
      SecurityException - if a security manager is installed and the caller does not have permission to set the prefix

    • setXencPrefix

      public static void setXencPrefix(String prefix)
      Set the prefix for the encryption namespace
      Parameters:
      prefix - the new prefix for the encryption namespace
      Throws:
      SecurityException - if a security manager is installed and the caller does not have permission to set the prefix

    • setXenc11Prefix

      public static void setXenc11Prefix(String prefix)
      Set the prefix for the encryption namespace 1.1
      Parameters:
      prefix - the new prefix for the encryption namespace 1.1
      Throws:
      SecurityException - if a security manager is installed and the caller does not have permission to set the prefix

    • getNextElement

      public static Element getNextElement(Node el)

    • getSet

      public static void getSet(Node rootNode, Set<Node> result, Node exclude, boolean comments)
      Parameters:
      rootNode -
      result -
      exclude -
      comments - whether comments or not

    • outputDOM

      public static void outputDOM(Node contextNode, File outputFile) throws IOException
      Outputs a DOM tree to a File.
      Parameters:
      contextNode - root node of the DOM tree
      outputFile - the file to write to
      Throws:
      IOException

    • outputDOM

      public static void outputDOM(Node contextNode, OutputStream os)
      Outputs a DOM tree to an OutputStream.
      Parameters:
      contextNode - root node of the DOM tree
      os - the OutputStream

    • outputDOM

      public static void outputDOM(Node contextNode, OutputStream os, boolean addPreamble)
      Outputs a DOM tree to an OutputStream. If an Exception is thrown during execution, it's StackTrace is output to System.out, but the Exception is not re-thrown.
      Parameters:
      contextNode - root node of the DOM tree
      os - the OutputStream
      addPreamble -

    • outputDOMc14nWithComments

      public static void outputDOMc14nWithComments(Node contextNode, OutputStream os)
      Serializes the contextNode into the OutputStream, but suppresses all Exceptions.

      NOTE: This should only be used for debugging purposes, NOT in a production environment; this method ignores all exceptions, so you won't notice if something goes wrong. If you're asking what is to be used in a production environment, simply use the code inside the try{} statement, but handle the Exceptions appropriately.
      Parameters:
      contextNode -
      os -

    • getFullTextChildrenFromNode

      public static String getFullTextChildrenFromNode(Node node)
      Method getFullTextChildrenFromNode
      Parameters:
      node -
      Returns:
      the string of children

    • createElementInSignatureSpace

      public static Element createElementInSignatureSpace(Document doc, String elementName)
      Creates an Element in the XML Signature specification namespace.
      Parameters:
      doc - the factory Document
      elementName - the local name of the Element
      Returns:
      the Element

    • createElementInSignature11Space

      public static Element createElementInSignature11Space(Document doc, String elementName)
      Creates an Element in the XML Signature 1.1 specification namespace.
      Parameters:
      doc - the factory Document
      elementName - the local name of the Element
      Returns:
      the Element

    • createElementInEncryptionSpace

      public static Element createElementInEncryptionSpace(Document doc, String elementName)
      Creates an Element in the XML Encryption specification namespace.
      Parameters:
      doc - the factory Document
      elementName - the local name of the Element
      Returns:
      the Element

    • createElementInEncryption11Space

      public static Element createElementInEncryption11Space(Document doc, String elementName)
      Creates an Element in the XML Encryption 1.1 specification namespace.
      Parameters:
      doc - the factory Document
      elementName - the local name of the Element
      Returns:
      the Element

    • elementIsInSignatureSpace

      public static boolean elementIsInSignatureSpace(Element element, String localName)
      Returns true if the element is in XML Signature namespace and the local name equals the supplied one.
      Parameters:
      element -
      localName -
      Returns:
      true if the element is in XML Signature namespace and the local name equals the supplied one

    • elementIsInSignature11Space

      public static boolean elementIsInSignature11Space(Element element, String localName)
      Returns true if the element is in XML Signature 1.1 namespace and the local name equals the supplied one.
      Parameters:
      element -
      localName -
      Returns:
      true if the element is in XML Signature namespace and the local name equals the supplied one

    • elementIsInEncryptionSpace

      public static boolean elementIsInEncryptionSpace(Element element, String localName)
      Returns true if the element is in XML Encryption namespace and the local name equals the supplied one.
      Parameters:
      element -
      localName -
      Returns:
      true if the element is in XML Encryption namespace and the local name equals the supplied one

    • elementIsInEncryption11Space

      public static boolean elementIsInEncryption11Space(Element element, String localName)
      Returns true if the element is in XML Encryption 1.1 namespace and the local name equals the supplied one.
      Parameters:
      element -
      localName -
      Returns:
      true if the element is in XML Encryption 1.1 namespace and the local name equals the supplied one

    • getOwnerDocument

      public static Document getOwnerDocument(Node node)
      This method returns the owner document of a particular node. This method is necessary because it always returns a Document. Node.getOwnerDocument() returns null if the Node is a Document.
      Parameters:
      node -
      Returns:
      the owner document of the node

    • getOwnerDocument

      public static Document getOwnerDocument(Set<Node> xpathNodeSet)
      This method returns the first non-null owner document of the Nodes in this Set. This method is necessary because it always returns a Document. Node.getOwnerDocument() returns null if the Node is a Document.
      Parameters:
      xpathNodeSet -
      Returns:
      the owner document

    • addReturnToElement

      public static void addReturnToElement(Element e)
      Method addReturnToElement
      Parameters:
      e -

    • addReturnToElement

      public static void addReturnToElement(Document doc, HelperNodeList nl)

    • addReturnBeforeChild

      public static void addReturnBeforeChild(Element e, Node child)

    • encodeToString

      public static String encodeToString(byte[] bytes)

    • decode

      public static byte[] decode(String encodedString)

    • decode

      public static byte[] decode(byte[] encodedBytes)

    • isIgnoreLineBreaks

      public static boolean isIgnoreLineBreaks()

    • convertNodelistToSet

      public static Set<Node> convertNodelistToSet(NodeList xpathNodeSet)
      Method convertNodelistToSet
      Parameters:
      xpathNodeSet -
      Returns:
      the set with the nodelist

    • circumventBug2650

      public static void circumventBug2650(Document doc)
      This method spreads all namespace attributes in a DOM document to their children. This is needed because the XML Signature XPath transform must evaluate the XPath against all nodes in the input, even against XPath namespace nodes. Through a bug in XalanJ2, the namespace nodes are not fully visible in the Xalan XPath model, so we have to do this by hand in DOM spaces so that the nodes become visible in XPath space.
      Parameters:
      doc -
      See Also:

    • selectDsNode

      public static Element selectDsNode(Node sibling, String nodeName, int number)
      Parameters:
      sibling -
      nodeName -
      number -
      Returns:
      nodes with the constraint

    • selectDs11Node

      public static Element selectDs11Node(Node sibling, String nodeName, int number)
      Parameters:
      sibling -
      nodeName -
      number -
      Returns:
      nodes with the constraint

    • selectXencNode

      public static Element selectXencNode(Node sibling, String nodeName, int number)
      Parameters:
      sibling -
      nodeName -
      number -
      Returns:
      nodes with the constrain

    • selectXenc11Node

      public static Element selectXenc11Node(Node sibling, String nodeName, int number)
      Helper method to get the "number"-th element for a given local name and namespace: http://www.w3.org/2009/xmlenc11#. If element with given search parameters is not found, null is returned.
      Parameters:
      sibling - the sibling node from which to start searching
      nodeName - the local name of the element to search for
      number - the index of the element to search for
      Returns:
      node with the given node name or null if not found.

    • selectNode

      public static Element selectNode(Node sibling, String uri, String nodeName, int number)
      Parameters:
      sibling -
      uri -
      nodeName -
      number -
      Returns:
      nodes with the constrain

    • selectDsNodes

      public static Element[] selectDsNodes(Node sibling, String nodeName)
      Parameters:
      sibling -
      nodeName -
      Returns:
      nodes with the constrain

    • selectDs11Nodes

      public static Element[] selectDs11Nodes(Node sibling, String nodeName)
      Parameters:
      sibling -
      nodeName -
      Returns:
      nodes with the constrain

    • selectNodes

      public static Element[] selectNodes(Node sibling, String uri, String nodeName)
      Parameters:
      sibling -
      uri -
      nodeName -
      Returns:
      nodes with the constraint

    • excludeNodeFromSet

      public static Set<Node> excludeNodeFromSet(Node signatureElement, Set<Node> inputSet)
      Parameters:
      signatureElement -
      inputSet -
      Returns:
      nodes with the constrain

    • getStrFromNode

      public static String getStrFromNode(Node xpathnode)
      Method getStrFromNode
      Parameters:
      xpathnode -
      Returns:
      the string for the node.

    • isDescendantOrSelf

      public static boolean isDescendantOrSelf(Node ctx, Node descendantOrSelf)
      Returns true if the descendantOrSelf is on the descendant-or-self axis of the context node.
      Parameters:
      ctx -
      descendantOrSelf -
      Returns:
      true if the node is descendant

    • ignoreLineBreaks

      public static boolean ignoreLineBreaks()

    • protectAgainstWrappingAttack

      public static boolean protectAgainstWrappingAttack(Node startNode, String value)
      This method is a tree-search to help prevent against wrapping attacks. It checks that no two Elements have ID Attributes that match the "value" argument, if this is the case then "false" is returned. Note that a return value of "true" does not necessarily mean that a matching Element has been found, just that no wrapping attack has been detected.

    • protectAgainstWrappingAttack

      public static boolean protectAgainstWrappingAttack(Node startNode, Element knownElement, String value)
      This method is a tree-search to help prevent against wrapping attacks. It checks that no other Element than the given "knownElement" argument has an ID attribute that matches the "value" argument, which is the ID value of "knownElement". If this is the case then "false" is returned.

    • read

      public static Document read(File file, boolean disallowDocTypeDeclarations) throws org.apache.xml.security.parser.XMLParserException, IOException
      Reads a document from the input stream.
      Parameters:
      file -
      disallowDocTypeDeclarations -
      Returns:
      Document
      Throws:
      org.apache.xml.security.parser.XMLParserException
      IOException

    • readResource

      public static Document readResource(String name, ClassLoader loader, boolean disallowDocTypeDeclarations) throws org.apache.xml.security.parser.XMLParserException, IOException
      Reads a document from the input stream and closes it.
      Parameters:
      name - - resource name to be opened by the class loader
      loader -
      disallowDocTypeDeclarations -
      Returns:
      Document
      Throws:
      org.apache.xml.security.parser.XMLParserException
      IOException - inputStream.close() failed.

    • read

      public static Document read(InputStream inputStream, boolean disallowDocTypeDeclarations) throws org.apache.xml.security.parser.XMLParserException
      Reads a document from the input stream. Caller is responsible for closing the stream.
      Parameters:
      inputStream -
      disallowDocTypeDeclarations -
      Returns:
      Document
      Throws:
      org.apache.xml.security.parser.XMLParserException

    • getBytes

      public static byte[] getBytes(BigInteger big, int bitlen)
      Returns a byte-array representation of a BigInteger. No sign-bit is output. N.B.: BigInteger's toByteArray returns eventually longer arrays because of the leading sign-bit.
      Parameters:
      big - BigInteger to be converted
      bitlen - int the desired length in bits of the representation
      Returns:
      a byte array with bitlen bits of big