com.peterphi.std.crypto.signing

Class XMLDocumentSigner

java.lang.Object

com.peterphi.std.crypto.signing.XMLDocumentSigner

public class XMLDocumentSigner
extends java.lang.Object

An XML Document signing class

Constructor Summary

Constructors

Constructor and Description
XMLDocumentSigner(org.w3c.dom.Document d) Creates a new XML Document Signer out of a given Document; the caller guarantees the Document can handle namespaces
XMLDocumentSigner(java.io.File xmlFile) Creates a new XML Document Signer, using the contents of a File as the XML Document
XMLDocumentSigner(java.lang.String xml) Creates a new XML Document Signer, using an XML document represented by the given String.

Method Summary

Methods

Modifier and Type	Method and Description
static java.security.KeyPair	getKeypair(java.security.KeyStore ks, java.lang.String alias, char[] passphrase) Helper method; retrieves a named public/private keypair from a KeyStore.
boolean	hasSignature() Determines whether this document has a signature tag
boolean	save(java.io.File dest) Saves the Document, as manipulated by this class, as a File
org.w3c.dom.Document	sign(java.lang.String machineId, java.security.KeyPair keys) Given a keypair, signs this document and adds the public key to the signature tag
org.w3c.dom.Document	sign(java.lang.String machineId, java.security.PublicKey publicKey, java.security.PrivateKey privateKey) Given a pair of keys, signs this document and adds the public key to the signature tag
org.w3c.dom.Document	stripSignature() Removes the signature tag from this document if they are present
java.lang.String	toString() Produces an XML String representation of the document
boolean	validate(Keystore truststore) Validates the document using the public keys of the Certificates in truststore
boolean	validate(java.security.PublicKey... allowedKeys) Validates the signature tag on the document

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDocumentSigner

public XMLDocumentSigner(java.lang.String xml)
                  throws java.lang.Exception

Creates a new XML Document Signer, using an XML document represented by the given String.

Parameters:

xml - The XML document as a String

Throws:

java.lang.Exception - If the xml document could not be loaded

XMLDocumentSigner

public XMLDocumentSigner(java.io.File xmlFile)
                  throws java.lang.Exception

Creates a new XML Document Signer, using the contents of a File as the XML Document

Parameters:

xmlFile - The XML document file

Throws:

java.lang.Exception - If the xml document could not be loaded

XMLDocumentSigner

public XMLDocumentSigner(org.w3c.dom.Document d)

Creates a new XML Document Signer out of a given Document; the caller guarantees the Document can handle namespaces

Parameters:

d - the xml document

Method Detail

sign

public org.w3c.dom.Document sign(java.lang.String machineId,
                        java.security.KeyPair keys)

Given a keypair, signs this document and adds the public key to the signature tag

Parameters:

keys - KeyPair The public/private keypair

Returns:

Document The signed document. The internal document is also signed.

getKeypair

public static java.security.KeyPair getKeypair(java.security.KeyStore ks,
                               java.lang.String alias,
                               char[] passphrase)
                                        throws java.security.NoSuchAlgorithmException,
                                               java.security.UnrecoverableEntryException,
                                               java.security.KeyStoreException

Helper method; retrieves a named public/private keypair from a KeyStore.

Parameters:

ks - The KeyStore

alias - The name of the key

passphrase - The passphrase (if necessary)

Returns:

The KeyPair

Throws:

java.security.NoSuchAlgorithmException

java.security.UnrecoverableEntryException

java.security.KeyStoreException

sign

public org.w3c.dom.Document sign(java.lang.String machineId,
                        java.security.PublicKey publicKey,
                        java.security.PrivateKey privateKey)

Given a pair of keys, signs this document and adds the public key to the signature tag

Parameters:

publicKey - PublicKey The public key

privateKey - PrivateKey The private key

Returns:

Document The signed document. The internal document is also signed.

save

public boolean save(java.io.File dest)

Saves the Document, as manipulated by this class, as a File

Parameters:

dest - The destination file

Returns:

true if the document was saved, otherwise false

stripSignature

public org.w3c.dom.Document stripSignature()

Removes the signature tag from this document if they are present

Returns:

Document A docuemnt without the signature tag. the internal document is also modified

hasSignature

public boolean hasSignature()

Determines whether this document has a signature tag

Returns:

boolean True if the document has a signature tag, otherwise false

toString

public java.lang.String toString()

Produces an XML String representation of the document

Overrides:

toString in class java.lang.Object

Returns:

String an XML String representation of the document

validate

public boolean validate(Keystore truststore)
                 throws java.security.cert.CertificateException,
                        java.io.FileNotFoundException,
                        java.io.IOException,
                        java.security.KeyStoreException,
                        java.security.NoSuchAlgorithmException

Validates the document using the public keys of the Certificates in truststore

Parameters:

truststore - The trust store

Returns:

True if the document validates, otherwise false

Throws:

java.security.cert.CertificateException - If there was a problem with the certificate

java.io.FileNotFoundException - If the truststore's file could't be loaded

java.io.IOException - If a generic IO exception occurred

java.security.KeyStoreException - If a problem occurred during keystore loading

java.security.NoSuchAlgorithmException - If the keystore couldn't be loaded

validate

public boolean validate(java.security.PublicKey... allowedKeys)

Validates the signature tag on the document

Parameters:

allowedKeys - the PublicKeys whose signatures will be considered valid

Returns:

true if the document was signed by one of the keys listed & the signature is valid, otherwise false