gnu.javax.crypto.mac

Class TMMH16

Implemented Interfaces:
Cloneable, IMac

public class TMMH16
extends BaseMac
implements Cloneable

TMMH is a universal hash function suitable for message authentication in the Wegman-Carter paradigm, as in the Stream Cipher Security Transform. It is simple, quick, and especially appropriate for Digital Signal Processors and other processors with a fast multiply operation, though a straightforward implementation requires storage equal in length to the largest message to be hashed.

TMMH is a simple hash function which maps a key and a message to a hash value. There are two versions of TMMH: TMMH/16 and TMMH/32. TMMH can be used as a message authentication code, as described in Section 5 (see References).

The key, message, and hash value are all octet strings, and the lengths of these quantities are denoted as KEY_LENGTH, MESSAGE_LENGTH, and TAG_LENGTH, respectively. The values of KEY_LENGTH and TAG_LENGTH MUST be fixed for any particular fixed value of the key, and must obey the alignment restrictions described below.

The parameter MAX_HASH_LENGTH, which denotes the maximum value which MESSAGE_LENGTH may take, is equal to KEY_LENGTH - TAG_LENGTH.

References:

  1. The Truncated Multi-Modular Hash Function (TMMH), David A. McGrew.

Field Summary

static String
KEYSTREAM
static String
PREFIX
static String
TAG_LENGTH

Fields inherited from class gnu.javax.crypto.mac.BaseMac

name, truncatedSize, underlyingHash

Fields inherited from interface gnu.javax.crypto.mac.IMac

MAC_KEY_MATERIAL, TRUNCATED_SIZE

Constructor Summary

TMMH16()
Trivial 0-arguments constructor.

Method Summary

Object
clone()
This method may be called to create a new copy of the Object.
byte[]
digest()
byte[]
digest(IRandom prng)
Similar to the same method with no arguments, but uses the designated random number generator to compute needed keying material.
void
init(Map<K,V> attributes)
int
macSize()
void
reset()
boolean
selfTest()
void
update(byte b)
void
update(byte b, IRandom prng)
Similar to the same method with one argument, but uses the designated random number generator to compute needed keying material.
void
update(byte[] b, int offset, int len)
void
update(byte[] b, int offset, int len, IRandom prng)
Similar to the same method with three arguments, but uses the designated random number generator to compute needed keying material.

Methods inherited from class gnu.javax.crypto.mac.BaseMac

clone, digest, init, macSize, name, reset, selfTest, update, update

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEYSTREAM

public static final String KEYSTREAM
Field Value:
"gnu.crypto.mac.tmmh.keystream"

PREFIX

public static final String PREFIX
Field Value:
"gnu.crypto.mac.tmmh.prefix"

TAG_LENGTH

public static final String TAG_LENGTH
Field Value:
"gnu.crypto.mac.tmmh.tag.length"

Constructor Details

TMMH16

public TMMH16()
Trivial 0-arguments constructor.

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 
Specified by:
clone in interface IMac
Overrides:
clone in interface BaseMac
Returns:
a copy of the Object
Throws:
CloneNotSupportedException - If this Object does not implement Cloneable
See Also:
Cloneable

digest

public byte[] digest()
Specified by:
digest in interface IMac
Overrides:
digest in interface BaseMac

digest

public byte[] digest(IRandom prng)
Similar to the same method with no arguments, but uses the designated random number generator to compute needed keying material.
Parameters:
prng - the source of randomness to use.
Returns:
the final result of the algorithm.

init

public void init(Map<K,V> attributes)
            throws InvalidKeyException,
                   IllegalStateException
Specified by:
init in interface IMac
Overrides:
init in interface BaseMac

macSize

public int macSize()
Specified by:
macSize in interface IMac
Overrides:
macSize in interface BaseMac

reset

public void reset()
Specified by:
reset in interface IMac
Overrides:
reset in interface BaseMac

selfTest

public boolean selfTest()
Specified by:
selfTest in interface IMac
Overrides:
selfTest in interface BaseMac

update

public void update(byte b)
Specified by:
update in interface IMac
Overrides:
update in interface BaseMac

update

public void update(byte b,
                   IRandom prng)
Similar to the same method with one argument, but uses the designated random number generator to compute needed keying material.
Parameters:
b - the byte to process.
prng - the source of randomness to use.

update

public void update(byte[] b,
                   int offset,
                   int len)
Specified by:
update in interface IMac
Overrides:
update in interface BaseMac

update

public void update(byte[] b,
                   int offset,
                   int len,
                   IRandom prng)
Similar to the same method with three arguments, but uses the designated random number generator to compute needed keying material.
Parameters:
b - the byte array to process.
offset - the starting offset in b to start considering the bytes to process.
len - the number of bytes in b starting from offset to process.
prng - the source of randomness to use.

TMMH16.java -- Copyright (C) 2001, 2002, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath 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 General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.