fr.cryptohash
Class Fugue384

java.lang.Object
  extended by fr.cryptohash.Fugue384
All Implemented Interfaces:
Digest

public class Fugue384
extends java.lang.Object

This class implements the Fugue-384 hash function under the Digest API.

 ==========================(LICENSE BEGIN)============================

 Copyright (c) 2007-2010  Projet RNRT SAPHIR
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
 without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 ===========================(LICENSE END)=============================
 


Constructor Summary
Fugue384()
          Create the engine.
 
Method Summary
 Digest copy()
          Clone the current state.
 byte[] digest()
          Finalize the current hash computation and return the hash value in a newly-allocated array.
 byte[] digest(byte[] inbuf)
          Input some bytes, then finalize the current hash computation and return the hash value in a newly-allocated array.
 int digest(byte[] outbuf, int off, int len)
          Finalize the current hash computation and store the hash value in the provided output buffer.
 int getBlockLength()
          Return the "block length" for the hash function.
 int getDigestLength()
          Get the natural hash function output length (in bytes).
 void reset()
          Reset the object: this makes it suitable for a new hash computation.
 java.lang.String toString()
          Get the display name for this function (e.g.
 void update(byte in)
          Insert one more input data byte.
 void update(byte[] inbuf)
          Insert some more bytes.
 void update(byte[] inbuf, int off, int len)
          Insert some more bytes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Fugue384

public Fugue384()
Create the engine.

Method Detail

getDigestLength

public int getDigestLength()
Description copied from interface: Digest
Get the natural hash function output length (in bytes).

Returns:
the digest output length (in bytes)
See Also:
Digest

update

public void update(byte in)
Description copied from interface: Digest
Insert one more input data byte.

Specified by:
update in interface Digest
Parameters:
in - the input byte
See Also:
Digest

update

public void update(byte[] inbuf)
Description copied from interface: Digest
Insert some more bytes.

Specified by:
update in interface Digest
Parameters:
inbuf - the data bytes
See Also:
Digest

update

public void update(byte[] inbuf,
                   int off,
                   int len)
Description copied from interface: Digest
Insert some more bytes.

Specified by:
update in interface Digest
Parameters:
inbuf - the data buffer
off - the data offset in inbuf
len - the data length (in bytes)
See Also:
Digest

digest

public byte[] digest()
Description copied from interface: Digest
Finalize the current hash computation and return the hash value in a newly-allocated array. The object is resetted.

Specified by:
digest in interface Digest
Returns:
the hash output
See Also:
Digest

digest

public byte[] digest(byte[] inbuf)
Description copied from interface: Digest
Input some bytes, then finalize the current hash computation and return the hash value in a newly-allocated array. The object is resetted.

Specified by:
digest in interface Digest
Parameters:
inbuf - the input data
Returns:
the hash output
See Also:
Digest

digest

public int digest(byte[] outbuf,
                  int off,
                  int len)
Description copied from interface: Digest
Finalize the current hash computation and store the hash value in the provided output buffer. The len parameter contains the maximum number of bytes that should be written; no more bytes than the natural hash function output length will be produced. If len is smaller than the natural hash output length, the hash output is truncated to its first len bytes. The object is resetted.

Specified by:
digest in interface Digest
Parameters:
outbuf - the output buffer
off - the output offset within outbuf
len - the requested hash output length (in bytes)
Returns:
the number of bytes actually written in outbuf
See Also:
Digest

reset

public void reset()
Description copied from interface: Digest
Reset the object: this makes it suitable for a new hash computation. The current computation, if any, is discarded.

Specified by:
reset in interface Digest
See Also:
Digest

copy

public Digest copy()
Description copied from interface: Digest
Clone the current state. The returned object evolves independantly of this object.

Specified by:
copy in interface Digest
Returns:
the clone
See Also:
Digest

getBlockLength

public int getBlockLength()
Description copied from interface: Digest

Return the "block length" for the hash function. This value is naturally defined for iterated hash functions (Merkle-Damgard). It is used in HMAC (that's what the HMAC specification names the "B" parameter).

If the function is "block-less" then this function may return -n where n is an integer such that the block length for HMAC ("B") will be inferred from the key length, by selecting the smallest multiple of n which is no smaller than the key length. For instance, for the Fugue-xxx hash functions, this function returns -4: the virtual block length B is the HMAC key length, rounded up to the next multiple of 4.

Specified by:
getBlockLength in interface Digest
Returns:
the internal block length (in bytes), or -n
See Also:
Digest

toString

public java.lang.String toString()
Description copied from interface: Digest

Get the display name for this function (e.g. "SHA-1" for SHA-1).

Specified by:
toString in interface Digest
Overrides:
toString in class java.lang.Object
See Also:
Digest