org.opensaml.xml.util
Class XmlTool

java.lang.Object
  org.opensaml.xml.util.XmlTool

public final class XmlTool
extends Object

Field Summary

static int	RC_INIT Return code indicating an initialization error, 1 .
static int	RC_INVALID_CRED Return code indicating an error reading the credentials, 6 .
static int	RC_INVALID_XML Return code indicating input XML was not valid, 4 .
static int	RC_INVALID_XS Return code indicating indicating an error validating the XML, 5 .
static int	RC_IO Return code indicating an error reading files, 2 .
static int	RC_MALFORMED_XML Return code indicating the input XML was not well formed, 3 .
static int	RC_OK Return code indicating command completed successfully, 0 .
static int	RC_SIG Return code indicating indicating that signing or signature verification failed, 7 .
static int	RC_UNKNOWN Return code indicating an unknown error occurred, -1 .

Constructor Summary

XmlTool()

Method Summary

protected static void	addSignatureELement(XmlToolCommandLineArguments cli, Element root, Element signature) Adds the signature element at the appropriate place in the document.
protected static org.opensaml.xml.security.x509.BasicX509Credential	getCredential(XmlToolCommandLineArguments cli) Gets the credentials used for signing and signature verification.
protected static Collection<X509CRL>	getCRLs(XmlToolCommandLineArguments cli) Gets the CRLs referenced on the command line, if any.
protected static DocumentBuilder	getParser(XmlToolCommandLineArguments cli) Constructs a DOM parser used to parse the input XML.
protected static Element	getSignatureElement(Document xmlDoc) Gets the signature element from the document.
protected static String	getSignatureReferenceUri(XmlToolCommandLineArguments cli, Element rootElement) Gets the reference of the URI to use for the signature.
protected static InputStream	getXmlInputStreamFromFile(XmlToolCommandLineArguments cli) Creates an input stream that reads the input XML from a file.
protected static InputStream	getXmlInputStreamFromUrl(XmlToolCommandLineArguments cli) Creates an input stream that reads the input XML from an HTTP URL.
protected static void	initLogging(XmlToolCommandLineArguments cli) Initialize the logging subsystem.
static void	main(String[] args)
protected static Document	parseXML(XmlToolCommandLineArguments cli) Parses the input XML from its source and converts it to a DOM document.
protected static void	populateKeyInfo(Document doc, org.apache.xml.security.keys.KeyInfo keyInfo, org.opensaml.xml.security.x509.BasicX509Credential credential) Populates an XML signature's KeyInfo with X.509 credential information.
protected static void	schemaValidate(XmlToolCommandLineArguments cli, Document xml) Validates the SAML document against the SAML 1.1 and 2.0 schema.
protected static void	sign(XmlToolCommandLineArguments cli, Document xml) Signs and outputs the signed SAML document.
protected static void	verifySignature(XmlToolCommandLineArguments cli, Document xmlDocument) Verifies that the signature on a document is valid.
protected static void	writeDocument(XmlToolCommandLineArguments cli, Node xml) Writes a DOM element to the output file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RC_OK

public static final int RC_OK

Return code indicating command completed successfully, 0 .

See Also:

Constant Field Values

RC_INIT

public static final int RC_INIT

Return code indicating an initialization error, 1 .

See Also:

Constant Field Values

RC_IO

public static final int RC_IO

Return code indicating an error reading files, 2 .

See Also:

Constant Field Values

RC_MALFORMED_XML

public static final int RC_MALFORMED_XML

Return code indicating the input XML was not well formed, 3 .

See Also:

Constant Field Values

RC_INVALID_XML

public static final int RC_INVALID_XML

Return code indicating input XML was not valid, 4 .

See Also:

Constant Field Values

RC_INVALID_XS

public static final int RC_INVALID_XS

Return code indicating indicating an error validating the XML, 5 .

See Also:

Constant Field Values

RC_INVALID_CRED

public static final int RC_INVALID_CRED

Return code indicating an error reading the credentials, 6 .

See Also:

Constant Field Values

RC_SIG

public static final int RC_SIG

Return code indicating indicating that signing or signature verification failed, 7 .

See Also:

Constant Field Values

RC_UNKNOWN

public static final int RC_UNKNOWN

Return code indicating an unknown error occurred, -1 .

See Also:

Constant Field Values

Constructor Detail

XmlTool

public XmlTool()

Method Detail

main

public static void main(String[] args)

Parameters:

args -

parseXML

protected static Document parseXML(XmlToolCommandLineArguments cli)

Parses the input XML from its source and converts it to a DOM document.

Parameters:

cli - command line arguments

Returns:

the parsed DOM document

getXmlInputStreamFromFile

protected static InputStream getXmlInputStreamFromFile(XmlToolCommandLineArguments cli)

Creates an input stream that reads the input XML from a file.

Parameters:

cli - command line arguments

Returns:

XML input stream

getXmlInputStreamFromUrl

protected static InputStream getXmlInputStreamFromUrl(XmlToolCommandLineArguments cli)

Creates an input stream that reads the input XML from an HTTP URL.

Parameters:

cli - command line arguments

Returns:

XML input stream

getParser

protected static DocumentBuilder getParser(XmlToolCommandLineArguments cli)

Constructs a DOM parser used to parse the input XML.

Parameters:

cli - command line arguments

Returns:

the DOM parser

schemaValidate

protected static void schemaValidate(XmlToolCommandLineArguments cli,
                                     Document xml)

Validates the SAML document against the SAML 1.1 and 2.0 schema.

Parameters:

cli - command line arguments

xml - document to validate

sign

protected static void sign(XmlToolCommandLineArguments cli,
                           Document xml)

Signs and outputs the signed SAML document.

Parameters:

cli - command line arguments

xml - document to be signed

populateKeyInfo

protected static void populateKeyInfo(Document doc,
                                      org.apache.xml.security.keys.KeyInfo keyInfo,
                                      org.opensaml.xml.security.x509.BasicX509Credential credential)

Populates an XML signature's KeyInfo with X.509 credential information.

Parameters:

doc - XML document in which the elements will be rooted

keyInfo - the KeyInfo to be populated

credential - the credential

getSignatureReferenceUri

protected static String getSignatureReferenceUri(XmlToolCommandLineArguments cli,
                                                 Element rootElement)

Gets the reference of the URI to use for the signature. If a reference attribute name is given, is present on the document root element, and contains a value, that value is used. Otherwise an empty string is used.

Parameters:

cli - command line arguments

rootElement - document root element

Returns:

the signature reference URI, never null

addSignatureELement

protected static void addSignatureELement(XmlToolCommandLineArguments cli,
                                          Element root,
                                          Element signature)

Adds the signature element at the appropriate place in the document.

Parameters:

cli - command line argument

root - element to which the signature will be added as a child

signature - signature to be added to the document's root element

verifySignature

protected static void verifySignature(XmlToolCommandLineArguments cli,
                                      Document xmlDocument)

Verifies that the signature on a document is valid.

Parameters:

cli - command line argument

xmlDocument - document whose signature will be validated

getSignatureElement

protected static Element getSignatureElement(Document xmlDoc)

Gets the signature element from the document. The signature must be a child of the document root.

Parameters:

xmlDoc - document from which to pull the signature

Returns:

the signature element, or null

getCredential

protected static org.opensaml.xml.security.x509.BasicX509Credential getCredential(XmlToolCommandLineArguments cli)

Gets the credentials used for signing and signature verification.

Parameters:

cli - command line arguments

Returns:

the credentials

getCRLs

protected static Collection<X509CRL> getCRLs(XmlToolCommandLineArguments cli)

Gets the CRLs referenced on the command line, if any.

Parameters:

cli - command line arguments

Returns:

collection of CRLs

writeDocument

protected static void writeDocument(XmlToolCommandLineArguments cli,
                                    Node xml)

Writes a DOM element to the output file.

Parameters:

cli - command line arguments

xml - the XML element to output

initLogging

protected static void initLogging(XmlToolCommandLineArguments cli)

Initialize the logging subsystem.

Parameters:

cli - command line arguments