/*
 * 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 "<WebSig>" 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, <http://www.nue.et-inf.uni-siegen.de/>.
 * The development of this software was partly funded by the European 
 * Commission in the <WebSig> project in the ISIS Programme. 
 * For more information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

/*
 * XSEC
 *
 * XSECKeyInfoResolverDefault := Default (very basic) class for applications
 *						 to map KeyInfo to keys
 *
 * Author(s): Berin Lautenbach
 *
 * $ID$
 *
 * $LOG$
 *
 */

#ifndef XSECKEYINFORESOLVERDEFAULT_INCLUDE
#define XSECKEYINFORESOLVERDEFAULT_INCLUDE

#include <xsec/enc/XSECKeyInfoResolver.hpp>

/**
 * @ingroup interfaces
 */
/*\@{*/

/**
 * @brief A basic class for mapping KeyInfo elements to Keys.
 *
 * This class is provides a method for applications to extract
 * keys from KeyInfo elements that have a public key embedded.
 *
 * The class makes use of the makeKey() method available in all
 * keyInfo elements.  (Which in turn relies on the clone*Key
 * methods available from the Encryption provider - these may
 * not be available, so this class may not work well in these
 * cases.)
 *
 * @note This class is <B>very</B> basic.  It does not validate
 * the trustworthyness of the key in any way.  It simply reads
 * the key from the first KeyInfo element that actually holds it
 * and returns the result (or NULL) if none is found.
 *
 */

class DSIG_EXPORT XSECKeyInfoResolverDefault : public XSECKeyInfoResolver {

public :

	/** @name Constructors and Destructors */
	//@{

	XSECKeyInfoResolverDefault();
	virtual ~XSECKeyInfoResolverDefault();

	//@}

	/** @name Interface Functions */
	//@{

	/**
	 * \brief Provide a key to the library
	 *
	 * Reads through the KeyInfo elements until it finds an element
	 * with an embedded Key.  If none is found, returns NULL.
	 *
	 * @param lst The list of KeyInfo elements from the signature
	 * @returns Either the appropriate key or NULL if none can be found
	 * @see XSECKeyInfoResolver::resolveKey()
	 */

	virtual XSECCryptoKey * resolveKey(DSIGKeyInfoList * lst);

	/**
	 * \brief Clone the resolver to be installed in a new object.
	 *
	 * @see XSECKeyInfoResolver::clone()
	 */

	virtual XSECKeyInfoResolver * clone(void);

	//@}

private:

	XSECSafeBufferFormatter		* mp_formatter;

	/*\@}*/
};


#endif /* XSECKEYINFORESOLVERDEFAULT_INCLUDE */