Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

XSECCryptoHash.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "<WebSig>" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 2001, Institute for
00053  * Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
00054  * The development of this software was partly funded by the European 
00055  * Commission in the <WebSig> project in the ISIS Programme. 
00056  * For more information on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * XSEC
00062  *
00063  * XSECCryptoProvider := Base virtual class to define a hash algorithm
00064  *
00065  * Author(s): Berin Lautenbach
00066  *
00067  * $ID$
00068  *
00069  * $LOG$
00070  *
00071  */
00072 
00073 #ifndef XSECCRYPTOHASH_INCLUDE
00074 #define XSECCRYPTOHASH_INCLUDE
00075 
00076 #include <xsec/framework/XSECDefs.hpp>
00077 #include <xsec/enc/XSECCryptoKey.hpp>
00078 
00079 #define XSEC_MAX_HASH_SIZE          256     /* Max size of any expected hash algorithms (oversized) */
00080 #define XSEC_MAX_HASH_BLOCK_SIZE    64      /* Max size of blocks used - MD5 and SHA1 are both 64 bytes*/
00081 
00102 class DSIG_EXPORT XSECCryptoHash {
00103 
00104 
00105 public :
00106 
00113     enum HashType {
00114 
00115         HASH_NONE           = 0,
00116         HASH_SHA1           = 1,
00117         HASH_MD5            = 2
00118 
00119     };
00120 
00121     // Constructors/Destructors
00122     
00123     XSECCryptoHash() {};
00124     virtual ~XSECCryptoHash() {};
00125 
00128 
00136     virtual void        reset(void) = 0;                    // Reset the hash
00137 
00149     virtual void        hash(unsigned char * data, 
00150                              unsigned int length) = 0;
00151 
00164     virtual unsigned int finish(unsigned char * hash,
00165                                 unsigned int maxLength) = 0;// Finish and get hash
00166 
00168 
00171 
00180     virtual HashType getHashType(void) = 0;
00181 
00183 
00186     
00200     virtual void        setKey(XSECCryptoKey * key) = 0;
00201 
00203 
00204 };
00205 
00206 #endif /* XSECCRYPTOHASH_INCLUDE */

Generated on Wed May 7 21:43:51 2003 for XML-Security-C by doxygen1.2.18