iaik.security.random

Class HashObjectSeedGenerator

java.lang.Object

iaik.security.random.SeedGenerator

iaik.security.random.VarLengthSeedGenerator

iaik.security.random.HashObjectSeedGenerator

Direct Known Subclasses:

AWT10SeedGenerator, AWT11SeedGenerator

public abstract class HashObjectSeedGenerator
extends VarLengthSeedGenerator

This seed generator is an abstract class designed to help you write seedgenerators that distill randomness from objects fed to it. Often applications will have access to data that includes some amount of randomness, like for example the events generated by the user moving his mouse. This randomness (plus possibly some non-random data) will be hashed by a MessageDigest object, its hash is the seed returned by this class.

The usage is rather simple. You just have to subclass this class and implement the abstract method extractSeedData(). Every time the user passes an object to this class via addSeedObject this object will be passed to extractSeedData(). The task of this method is to extract randomness from the object and call one of the updateHash() methods. Note that it should never hurt to hash not only the random parts but also deterministic data, i.e. you can hash all fields of the object. It is recommended to hash the current time as obtained by System.currentTimeMillis() in addition to be object itself.

For more information see the documentation of the extractSeedData() and getMessageDigest() methods.

Version:

File Revision 12

See Also:

SeedGenerator, AWT11SeedGenerator, AWT10SeedGenerator

Field Summary

Fields inherited from class iaik.security.random.SeedGenerator

seedGenListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HashObjectSeedGenerator(int numBits) Constructor for use by subclasses.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addSeedObject(java.lang.Object obj) Feed a new seed object to this seed generator.
protected abstract int	extractSeedData(java.lang.Object obj) This method extracts the random information from the object and updates the hash accordingly.
protected java.security.MessageDigest	getMessageDigest() Return a new MessageDigest object to be used to digest the random information.
byte[]	getSeed() Return the random seed.
int[]	getStatus() Return the current status of seed generation.
void	reinit(int numBits) Sets the number of bits to generate.
protected void	updateHash(byte[] data) Update the hash by data.
protected void	updateHash(long l) Update the hash by longToBytes(l).
protected void	updateHash(java.lang.String data) Update the hash by data.getBytes().

Methods inherited from class iaik.security.random.VarLengthSeedGenerator

getDefault, getSeedLength, hasSeedLengthChanged, setDefault, setSeedLength

Methods inherited from class iaik.security.random.SeedGenerator

callSeedGenListener, getDefault, getDefaultSeedGenerator, seedAvailable, setDefaultSeedGenerator, setSeedGenListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HashObjectSeedGenerator

protected HashObjectSeedGenerator(int numBits)

Constructor for use by subclasses.

Method Detail

reinit

public void reinit(int numBits)

Description copied from class: VarLengthSeedGenerator

Sets the number of bits to generate. The purpose of this method is to change the number of seed bits to be generated, after a seed generator instance has been created using the default constructor. This has only an effect, if this method is called before getSeed() gets called.

Overrides:

reinit in class VarLengthSeedGenerator

Parameters:

numBits - the number of bits to generate

getMessageDigest

protected java.security.MessageDigest getMessageDigest()

Return a new MessageDigest object to be used to digest the random information. Per default this will return an instance of the IAIK SHA1 implementation, if you want to use a different message digest override this method in your SeedGenerator.

getStatus

public final int[] getStatus()

Return the current status of seed generation.

Specified by:

getStatus in class SeedGenerator

updateHash

protected final void updateHash(byte[] data)

Update the hash by data. For use by subclasses.

updateHash

protected final void updateHash(java.lang.String data)

Update the hash by data.getBytes(). For use by subclasses.

updateHash

protected final void updateHash(long l)

Update the hash by longToBytes(l). For use by subclasses.

extractSeedData

protected abstract int extractSeedData(java.lang.Object obj)
                                throws RandomException

This method extracts the random information from the object and updates the hash accordingly. It has to be implemented by subclasses and is called by addSeedObject() only. It should return the number of random bits obtained from the object. If the object is an instance of an unsupported class it should throw a RandomException.

Throws:

RandomException

addSeedObject

public final boolean addSeedObject(java.lang.Object obj)
                            throws RandomException

Feed a new seed object to this seed generator. This method will call extractSeedData() and the SeedGenListener (if one is registered). If more seed objects are needed it return true, otherwise false. If seed generation is already completed when this method is called, it will instantly return false.

Throws:

RandomException

getSeed

public final byte[] getSeed()

Return the random seed. If it is not yet ready, this method will return null. The seed returned is always the length of the digest used (per default 20 bytes for SHA-1).

Specified by:

getSeed in class SeedGenerator