gnu.crypto.prng

Interface IRandom

All Superinterfaces:
Cloneable
Known Implementing Classes:
ARCFour, BasePRNG, ICMGenerator, MDGenerator, PBKDF2, UMacGenerator

public interface IRandom
extends Cloneable

The basic visible methods of any pseudo-random number generator.

The [HAC] defines a PRNG (as implemented in this library) as follows:

IMPLEMENTATION NOTE: Although all the concrete classes in this package implement the Cloneable interface, it is important to note here that such an operation, for those algorithms that use an underlting symmetric key block cipher, DOES NOT clone any session key material that may have been used in initialising the source PRNG (the instance to be cloned). Instead a clone of an already initialised PRNG, that uses and underlying symmetric key block cipher, is another instance with a clone of the same cipher that operates with the same block size but without any knowledge of neither key material nor key size.

References:

  1. [HAC]: Handbook of Applied Cryptography.
    CRC Press, Inc. ISBN 0-8493-8523-7, 1997
    Menezes, A., van Oorschot, P. and S. Vanstone.

Version:
$Revision: 1.8 $

Method Summary

Object
clone()
Returns a clone copy of this instance.
void
init(Map attributes)
Initialises the pseudo-random number generator scheme with the appropriate attributes.
String
name()
Returns the canonical name of this instance.
byte
nextByte()
Returns the next 8 bits of random data generated from this instance.
void
nextBytes(byte[] out, int offset, int length)
Fills the designated byte array, starting from byte at index offset, for a maximum of length bytes with the output of this generator instance.

Method Details

clone

public Object clone()
Returns a clone copy of this instance.

Returns:
a clone copy of this instance.


init

public void init(Map attributes)
Initialises the pseudo-random number generator scheme with the appropriate attributes.

Parameters:
attributes - a set of name-value pairs that describe the desired future instance behaviour.


name

public String name()
Returns the canonical name of this instance.

Returns:
the canonical name of this instance.


nextByte

public byte nextByte()
            throws IllegalStateException,
                   LimitReachedException
Returns the next 8 bits of random data generated from this instance.

Returns:
the next 8 bits of random data generated from this instance.

Throws:
LimitReachedException - if this instance has reached its theoretical limit for generating non-repetitive pseudo-random data.


nextBytes

public void nextBytes(byte[] out,
                      int offset,
                      int length)
            throws IllegalStateException,
                   LimitReachedException
Fills the designated byte array, starting from byte at index offset, for a maximum of length bytes with the output of this generator instance.

Parameters:
out - the placeholder to contain the generated random bytes.
offset - the starting index in out to consider. This method does nothing if this parameter is not within 0 and out.length.
length - the maximum number of required random bytes. This method does nothing if this parameter is less than 1.

Throws:
LimitReachedException - if this instance has reached its theoretical limit for generating non-repetitive pseudo-random data.


Copyright © 2001, 2002, 2003 Free Software Foundation, Inc. All Rights Reserved.