123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401 |
|
/*******************************************************************************
copyright: Copyright (c) 2006 Tango. All rights reserved
license: BSD style: see doc/license.txt for details
version: Initial release: Feb 2006
author: Regan Heath, Oskar Linde
This module implements a generic Merkle-Damgard hash function
*******************************************************************************/
module tango.util.digest.MerkleDamgard;
public import tango.core.ByteSwap;
public import tango.util.digest.Digest;
/*******************************************************************************
Extending MerkleDamgard to create a custom hash function requires
the implementation of a number of abstract methods. These include:
---
public uint digestSize();
protected void reset();
protected void createDigest(ubyte[] buf);
protected uint blockSize();
protected uint addSize();
protected void padMessage(ubyte[] data);
protected void transform(ubyte[] data);
---
In addition there exist two further abstract methods; these methods
have empty default implementations since in some cases they are not
required$(CLN)
---
protected abstract void padLength(ubyte[] data, ulong length);
protected abstract void extend();
---
The method padLength() is required to implement the SHA series of
Hash functions and also the Tiger algorithm. Method extend() is
required only to implement the MD2 digest.
The basic sequence of internal events is as follows:
$(UL
$(LI transform(), 0 or more times)
$(LI padMessage())
$(LI padLength())
$(LI transform())
$(LI extend())
$(LI createDigest())
$(LI reset())
)
*******************************************************************************/
package class MerkleDamgard : Digest
{
private uint bytes;
private ubyte[] buffer;
/***********************************************************************
Constructs the digest
Params:
buf = a buffer with enough space to hold the digest
Remarks:
Constructs the digest.
***********************************************************************/
protected abstract void createDigest(ubyte[] buf);
/***********************************************************************
Digest block size
Returns:
the block size
Remarks:
Specifies the size (in bytes) of the block of data to pass to
each call to transform().
***********************************************************************/
protected abstract uint blockSize();
/***********************************************************************
Length padding size
Returns:
the length padding size
Remarks:
Specifies the size (in bytes) of the padding which
uses the length of the data which has been fed to the
algorithm, this padding is carried out by the
padLength method.
***********************************************************************/
@property protected abstract uint addSize();
/***********************************************************************
Pads the digest data
Params:
data = a slice of the digest buffer to fill with padding
Remarks:
Fills the passed buffer slice with the appropriate
padding for the final call to transform(). This
padding will fill the message data buffer up to
blockSize()-addSize().
***********************************************************************/
protected abstract void padMessage(ubyte[] data);
/***********************************************************************
Performs the length padding
Params:
data = the slice of the digest buffer to fill with padding
length = the length of the data which has been processed
Remarks:
Fills the passed buffer slice with addSize() bytes of padding
based on the length in bytes of the input data which has been
processed.
***********************************************************************/
protected void padLength(ubyte[] data, ulong length) {}
/***********************************************************************
Performs the digest on a block of data
Params:
data = the block of data to digest
Remarks:
The actual digest algorithm is carried out by this method on
the passed block of data. This method is called for every
blockSize() bytes of input data and once more with the remaining
data padded to blockSize().
***********************************************************************/
protected abstract void transform(const(ubyte[]) data);
/***********************************************************************
Final processing of digest.
Remarks:
This method is called after the final transform just prior to
the creation of the final digest. The MD2 algorithm requires
an additional step at this stage. Future digests may or may not
require this method.
***********************************************************************/
protected void extend() {}
/***********************************************************************
Construct a digest
Remarks:
Constructs the internal buffer for use by the digest, the buffer
size (in bytes) is defined by the abstract method blockSize().
***********************************************************************/
this()
{
buffer = new ubyte[blockSize()];
reset();
}
/***********************************************************************
Initialize the digest
Remarks:
Returns the digest state to its initial value
***********************************************************************/
protected void reset()
{
bytes = 0;
}
/***********************************************************************
Digest additional data
Params:
input = the data to digest
Remarks:
Continues the digest operation on the additional data.
***********************************************************************/
override MerkleDamgard update (const(void[]) input)
{
auto block = blockSize();
uint i = bytes & (block-1);
const(ubyte[]) data = cast(const(ubyte[])) input;
bytes += data.length;
if (data.length+i < block)
buffer[i..i+data.length] = data[];
else
{
buffer[i..block] = data[0..block-i];
transform (buffer);
for (i=block-i; i+block-1 < data.length; i += block)
transform(data[i..i+block]);
buffer[0..data.length-i] = data[i..data.length];
}
return this;
}
/***********************************************************************
Complete the digest
Returns:
the completed digest
Remarks:
Concludes the algorithm producing the final digest.
***********************************************************************/
override ubyte[] binaryDigest (ubyte[] buf = null)
{
auto block = blockSize();
uint i = bytes & (block-1);
if (i < block-addSize)
padMessage (buffer[i..block-addSize]);
else
{
padMessage (buffer[i..block]);
transform (buffer);
buffer[] = 0;
}
padLength (buffer[block-addSize..block], bytes);
transform (buffer);
extend ();
if (buf.length < digestSize())
buf.length = digestSize();
createDigest (buf);
reset ();
return buf;
}
/***********************************************************************
Converts 8 bit to 32 bit Little Endian
Params:
input = the source array
output = the destination array
Remarks:
Converts an array of ubyte[] into uint[] in Little Endian byte order.
***********************************************************************/
static protected final void littleEndian32(const(ubyte[]) input, uint[] output)
{
assert(output.length == input.length/4);
output[] = cast(uint[]) input;
version (BigEndian)
ByteSwap.swap32 (output.ptr, output.length * uint.sizeof);
}
/***********************************************************************
Converts 8 bit to 32 bit Big Endian
Params:
input = the source array
output = the destination array
Remarks:
Converts an array of ubyte[] into uint[] in Big Endian byte order.
***********************************************************************/
static protected final void bigEndian32(const(ubyte[]) input, uint[] output)
{
assert(output.length == input.length/4);
output[] = cast(uint[]) input;
version(LittleEndian)
ByteSwap.swap32 (output.ptr, output.length * uint.sizeof);
}
/***********************************************************************
Converts 8 bit to 64 bit Little Endian
Params:
input = the source array
output = the destination array
Remarks:
Converts an array of ubyte[] into ulong[] in Little Endian byte order.
***********************************************************************/
static protected final void littleEndian64(const(ubyte[]) input, ulong[] output)
{
assert(output.length == input.length/8);
output[] = cast(ulong[]) input;
version (BigEndian)
ByteSwap.swap64 (output.ptr, output.length * ulong.sizeof);
}
/***********************************************************************
Converts 8 bit to 64 bit Big Endian
Params: input = the source array
output = the destination array
Remarks:
Converts an array of ubyte[] into ulong[] in Big Endian byte order.
***********************************************************************/
static protected final void bigEndian64(const(ubyte[]) input, ulong[] output)
{
assert(output.length == input.length/8);
output[] = cast(ulong[]) input;
version (LittleEndian)
ByteSwap.swap64 (output.ptr, output.length * ulong.sizeof);
}
/***********************************************************************
Rotate left by n
Params:
x = the value to rotate
n = the amount to rotate by
Remarks:
Rotates a 32 bit value by the specified amount.
***********************************************************************/
static protected final uint rotateLeft(uint x, uint n)
{
/+version (D_InlineAsm_X86)
version (DigitalMars)
{
asm {
naked;
mov ECX,EAX;
mov EAX,4[ESP];
rol EAX,CL;
ret 4;
}
}
else
return (x << n) | (x >> (32-n));
else +/
return (x << n) | (x >> (32-n));
}
}
|