AbstractMDHash.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : AbstractMDHash
 * Package    : Zeus.ZeusBase.Security
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

/* CODE INFORMATION:
   The main code of this class has been taken from the "OpenSSL" Library.
   Copyright information from OpenSSL:
*/
/* ====================================================================
 * Copyright (c) 1999-2007 The OpenSSL Project.  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. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    licensing@OpenSSL.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``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 OpenSSL PROJECT 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.
 * ====================================================================
 *
 */

#ifndef AbstractMDHashH
#define AbstractMDHashH

#include <zeusbase/Security/AbstractHash.hpp>

BEGIN_NAMESPACE_Zeus

/***************************************************************************/
/***************************************************************************/
zeusbase_class TAbstractMDHash : public TAbstractHash
{
  public:
    TAbstractMDHash();

    virtual Retval getHMAC(const IByteArray& rKey,
                           const IByteArray& rInput,
                           IByteArray& rOutput);

  protected:
    static const Uint8 m_ucFillBuffer[64];

    /*************************************************************************/
    /*************************************************************************/
    struct TypeMD_CTX
    {
      Uint32 A;
      Uint32 B;
      Uint32 C;
      Uint32 D;

      Uint64 uldTotalLen;
      Uint32 ulBufferLen;
      Uint8* paucBuffer;
    };

    void finishCTX(TypeMD_CTX& rCtx, IByteArray& rOutput);
    void freeCTX(TypeMD_CTX& rCTX);
    void processBytes(TypeMD_CTX& rCtx, const IByteArray& rInput);
    void processBytes(TypeMD_CTX& rCtx, const Uint8* pucBuffer, Int iSize);

    /*************************************************************************/
    /*************************************************************************/
    virtual Int getBlockSize() const = 0;

    /*************************************************************************/
    /*************************************************************************/
    virtual void initCTX(TypeMD_CTX& rCTX) = 0;

    /*************************************************************************/
    /*************************************************************************/
    virtual void processBlock(TypeMD_CTX& rCtx, const Uint8* pucBuffer, Int iBlockNum) = 0;

    //Methods of AbstractHash
    virtual Retval generate(const IByteArray& rInput, IByteArray& rOutput);
};

/*****************************************************************************/
/*****************************************************************************/
inline void TAbstractMDHash::processBytes(TypeMD_CTX& rCtx, const IByteArray& rInput)
{
  processBytes(rCtx, (Uint8*)rInput.getArray(), rInput.getCount());
}


END_NAMESPACE_Zeus

#endif