xsec/enc/OpenSSL/OpenSSLCryptoHash.hpp

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/*
 * XSEC
 *
 * OpenSSLCryptoHash := OpenSSL Implementation of SHA1
 *
 * Author(s): Berin Lautenbach
 *
 * $Id$
 *
 */

#ifndef OPENSSLCRYPTOHASHSHA1_INCLUDE
#define OPENSSLCRYPTOHASHSHA1_INCLUDE

#include <xsec/framework/XSECDefs.hpp>
#include <xsec/enc/XSECCryptoHash.hpp>

// OpenSSL Includes

#if defined (XSEC_HAVE_OPENSSL)

#   include <openssl/evp.h>

/**
 * @ingroup opensslcrypto
 */

/**
 * \brief Interface definition for Hash functions.
 *
 * Uses the OpenSSL EVP_digest functions to implement the various
 * hash functions required by the OpenSSL library.
 *
 */

class XSEC_EXPORT OpenSSLCryptoHash : public XSECCryptoHash {

public :

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

    OpenSSLCryptoHash(XSECCryptoHash::HashType alg);
    virtual ~OpenSSLCryptoHash();
    
    //@}

    /** @name HMAC Functions */
    //@{
    
    /**
     *\brief
     *
     * Does nothing.  If the required function is an HMAC function,
     * then OpenSSLCryptoHashHMAC should be used.
     *
     * @param key The key the HMAC function should use.
     */

    virtual void        setKey(const XSECCryptoKey * key) {}

    //@}

    /** @name Digest/Hash functions */
    //@{

    /**
     * \brief Rest the hash function
     *
     * Re-initialises the digest structure.
     */

    virtual void        reset(void);

    /**
     * \brief Hash some data.
     *
     * Take length bytes of data from the data buffer and update the hash
     * that already exists.  This function may (and normally will) be called
     * many times for large blocks of data.
     *
     * @param data The buffer containing the data to be hashed.
     * @param length The number of bytes to be read from data
     */

    virtual void        hash(unsigned char * data, 
                             unsigned int length);
    /**
     * \brief Finish up a Digest operation and read the result.
     *
     * This call tells the CryptoHash object that the input is complete and
     * to finalise the Digest.  The output of the digest is read into the 
     * hash buffer (at most maxLength bytes)
     *
     * @param hash The buffer the hash should be read into.
     * @param maxLength The maximum number of bytes to be read into hash
     * @returns The number of bytes copied into the hash buffer
     */

    virtual unsigned int finish(unsigned char * hash,
                                unsigned int maxLength);// Finish and get hash

    //@}

    /** @name Information functions */
    //@{

    /**
     *\brief
     *
     * Determine the hash type of this object
     *
     * @returns The hash type
     */

    virtual HashType getHashType(void) const;

    /**
     * \brief Get OpenSSL hash context structure
     */

    EVP_MD_CTX * getOpenSSLEVP_MD_CTX(void) {return mp_mdctx;}

    //@}


private:

    // Not implemented constructors
    OpenSSLCryptoHash();

    EVP_MD_CTX          * mp_mdctx;                       // Context for digest - storage
#if (OPENSSL_VERSION_NUMBER < 0x10100000L)
    EVP_MD_CTX          m_mdctx_store;                  // Context for digest - storage
#endif
    const EVP_MD        * mp_md;                        // Digest instance
    unsigned char       m_mdValue[EVP_MAX_MD_SIZE];     // Final output
    unsigned int        m_mdLen;                        // Length of digest
    HashType            m_hashType;                     // What type of hash is this?

};

#endif /* XSEC_HAVE_OPENSSL */
#endif /* OPENSSLCRYPTOHASHSHA1_INCLUDE */