/* * 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 "" 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, . * The development of this software was partly funded by the European * Commission in the project in the ISIS Programme. * For more information on the Apache Software Foundation, please see * . */ /* * XSEC * * XSECProvider.hpp := The main interface for users wishing to gain access * to signature objects * * Author(s): Berin Lautenbach * * $Id: XSECProvider.hpp,v 1.5 2003/03/02 08:21:02 blautenb Exp $ * */ #ifndef XSECPROVIDER_INCLUDE #define XSECPROVIDER_INCLUDE #include #include #include #include /** * @addtogroup pubsig * @{ */ /** * @brief The provider class for XML Digital Signatures objects. * *

The XSECProvider class is used to create and destroy signature objects. * It provides a number of methods to create signature objects for a variety of * situations - in particular creating an empty signature with which to create * the signature DOM structure or creating a signature based on an already * existing DOM structure.

* */ class DSIG_EXPORT XSECProvider { #if defined(XALAN_NO_NAMESPACES) typedef vector SignatureListVectorType; #else typedef std::vector SignatureListVectorType; #endif public: /** @name Constructors and Destructors */ //@{ /** * \brief Default constructor. * *

The provider class requires no parameters for construction

* */ XSECProvider(); ~XSECProvider(); //@} /** @name Signature Creation Classes */ //@{ /** * \brief DSIGSignature creator for use with existing XML signatures or templates. * *

Create a DSIGSignature object based on an already existing * DSIG Signature XML node. It is assumed that the underlying * DOM structure is in place and works correctly.

* *

In this case, the caller can pass in the signature DOM Node for cases * where there may be more than one signature in a document. The caller * needs to specify which signature tree is to be used.

* * @param doc The DOM document node in which the signature is embedded. * @param sigNode The DOM node (within doc) that is to be used as the * base of the signature. * @see DSIGSignature#load */ DSIGSignature * newSignatureFromDOM(DOMDocument *doc, DOMNode *sigNode); /** * \brief DSIGSignature creator for use with existing XML signatures or templates. * *

Create a DSIGSignature object based on an already existing * DSIG Signature XML node. It is assumed that the underlying * DOM structure is in place and works correctly.

* *

In this case, the XML-Security libraries will find the signature * node.

* * @note The library will only find and use the first signature node * in the document. If there are more, they will not be validated * @param doc The DOM document node in which the signature is embedded. * @see DSIGSignature#load */ DSIGSignature * newSignatureFromDOM(DOMDocument *doc); /** * \brief DSIGSignature creator for creating new XML signatures. * *

Create an empty DSIGSignature object that can be used to create new * signature values. The returned signature object needs to be initialised * with a document so a blank signature DOM structure can be created

* * @see DSIGSignature#createBlankSignature */ DSIGSignature * newSignature(void); /** * \brief Method for destroying DSIGSignature objects created via this provider. * *

The provider keeps track of all signature objects created during the lifetime * of the provider. This method can be called to delete a signature whilst the * provider is still in scope. Otherwise the objects will be automatically * deleted when the provider object goes out of scope.

* *

In cases where the DSIGSignature has been used to create a new DOM structure, * it can be safely deleted once the signature operations have been completed without * impacting the underlying DOM structure.

* * @param toRelease The DSIGSignature object to be deleted. * @todo The DSIGSignature objects are fairly bulky in terms of creation and deletion. * There should be a capability to store "released" objects in a re-use stack. At the * moment the Provider class simply deletes the objects. * @see DSIGSignature#createBlankSignature */ void releaseSignature(DSIGSignature * toRelease); //@} /** @name Environmental Options */ //@{ /** * \brief Set the default URIResolver. * * DSIGSignature objects require a URIResolver to allow them to de-reference * URIs in reference elements. * * This function sets the resolver that will be used for all * signatures created after this is set. The resolver is * cloned, so the object passed in can be safely deleted once the * function has been completed. */ void setDefaultURIResolver(XSECURIResolver * resolver); //@} private: // Internal functions void setup(DSIGSignature *sig); SignatureListVectorType m_activeSignatures; XSECURIResolver * mp_URIResolver; XERCES_CPP_NAMESPACE_QUALIFIER XMLMutex m_providerMutex; }; /** @} */ #endif /* XSECPROVIDER_INCLUDE */