XMLDSigner.java

/*
 * Copyright(c) 2002 Center for E-Commerce Infrastructure Development, The
 * University of Hong Kong (HKU). All Rights Reserved.
 *
 * This software is licensed under the Academic Free License Version 1.0
 *
 * Academic Free License
 * Version 1.0
 *
 * This Academic Free License applies to any software and associated 
 * documentation (the "Software") whose owner (the "Licensor") has placed the 
 * statement "Licensed under the Academic Free License Version 1.0" immediately 
 * after the copyright notice that applies to the Software. 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of the Software (1) to use, copy, modify, merge, publish, perform, 
 * distribute, sublicense, and/or sell copies of the Software, and to permit 
 * persons to whom the Software is furnished to do so, and (2) under patent 
 * claims owned or controlled by the Licensor that are embodied in the Software 
 * as furnished by the Licensor, to make, use, sell and offer for sale the 
 * Software and derivative works thereof, subject to the following conditions: 
 *
 * - Redistributions of the Software in source code form must retain all 
 *   copyright notices in the Software as furnished by the Licensor, this list 
 *   of conditions, and the following disclaimers. 
 * - Redistributions of the Software in executable form must reproduce all 
 *   copyright notices in the Software as furnished by the Licensor, this list 
 *   of conditions, and the following disclaimers in the documentation and/or 
 *   other materials provided with the distribution. 
 * - Neither the names of Licensor, nor the names of any contributors to the 
 *   Software, nor any of their trademarks or service marks, may be used to 
 *   endorse or promote products derived from this Software without express 
 *   prior written permission of the Licensor. 
 *
 * DISCLAIMERS: LICENSOR WARRANTS THAT THE COPYRIGHT IN AND TO THE SOFTWARE IS 
 * OWNED BY THE LICENSOR OR THAT THE SOFTWARE IS DISTRIBUTED BY LICENSOR UNDER 
 * A VALID CURRENT LICENSE. EXCEPT AS EXPRESSLY STATED IN THE IMMEDIATELY 
 * PRECEDING SENTENCE, THE SOFTWARE IS PROVIDED BY THE LICENSOR, CONTRIBUTORS 
 * AND COPYRIGHT OWNERS "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE 
 * LICENSOR, CONTRIBUTORS OR COPYRIGHT OWNERS BE LIABLE FOR ANY CLAIM, DAMAGES 
 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE. 
 *
 * This license is Copyright (C) 2002 Lawrence E. Rosen. All rights reserved. 
 * Permission is hereby granted to copy and distribute this license without 
 * modification. This license may not be modified without the express written 
 * permission of its copyright owner. 
 */

/* ===== 
 *
 * $Header: /home/cvsroot/ebxml-pkg/src/hk/hku/cecid/ebms/pkg/pki/XMLDSigner.java,v 1.1 2005/07/28 09:36:24 dcmsze Exp $
 *
 * Code authored by:
 *
 * kcyee [2002-05-16]
 *
 * Code reviewed by:
 *
 * username [YYYY-MM-DD]
 *
 * Remarks:
 *
 * =====
 */

package hk.hku.cecid.ebms.pkg.pki;

import java.io.InputStream;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
 * This interface defines a standard way to have the document signed. 
 * Different classes will implement the interface using different 
 * library behind.
 *
 * @author kcyee
 * @version $Revision: 1.1 $
 */
public interface XMLDSigner {

    /**
     * Set the envelope to host the Signature element. That is the
     * XML document where the Signature element to be added. The
     * digital signature here will always be an enveloped signature.
     * The envelope will be included in the process of signing.
     *
     * @param doc the XML document to host the Signature element
     * @throws SignException
     */
    public void setEnvelope(Document doc) throws SignException;

    /**
     * Adds a reference to a document attachment to the signature.
     *
     * @param uri the URI of the document attachment
     * @param is the input stream of the content of the document
     * @param contentType the content type of the document
     */
    public void addDocument(String uri, InputStream is, String contentType);

    /**
     * Signs the envelope and documents by using the specified key 
     * in the keystore.
     *
     * @param ks the keystore holding the key for signing
     * @param alias the alias of the key for signing
     * @param password the password for accessing the key for signing
     * @throws SignException when there is any error in the processing of
     *                       signing
     */
    public void sign(CompositeKeyStore ks, String alias, char[] password)
        throws SignException;

    /**
     * Sets the trust anchor for verfication of certificate path.
     *
     * @param ks the keystore providing the trusted certificates
     */
    public void setTrustAnchor(CompositeKeyStore ks);

    /**
     * Verifies the signature in the envelope passed in, which may reference
     * the documents specified using the addDocument method.
     *
     * @return true if the signature can be verified successfully, false
     *         if otherwise.
     * @throws VerifyException when there is any error in the processing of
     *                         verification
     */
    public boolean verify() throws VerifyException;

    /**
     * Gets the DOM element of the signature generated.
     *
     * @return the DOM element of the signature
     */
    public Element getElement();
}