RC5ParameterSpec

AI-generated Key Takeaways

• RC5ParameterSpec defines parameters for the RC5 encryption algorithm, including version, rounds, word size, and optionally an initialization vector (IV).

• It can be used to initialize Cipher objects implementing the RC5 algorithm from RSA Security Inc.or authorized parties.

• The class provides constructors to set these parameters and methods to retrieve them.

• RC5ParameterSpec objects can be compared for equality based on their parameter values.

• The IV, used in feedback mode, has a size twice the word size and is optional.

public class RC5ParameterSpec extends Object
implements AlgorithmParameterSpec

This class specifies the parameters used with the RC5 algorithm.

The parameters consist of a version number, a rounds count, a word size, and optionally an initialization vector (IV) (only in feedback mode).

This class can be used to initialize a Cipher object that implements the RC5 algorithm as supplied by RSA Security Inc., or any parties authorized by RSA Security.

Public Constructor Summary

	RC5ParameterSpec(int version, int rounds, int wordSize) Constructs a parameter set for RC5 from the given version, number of rounds and word size (in bits).
	RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv) Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.
	RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv, int offset) Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

Public Method Summary

boolean	equals(Object obj) Tests for equality between the specified object and this object.
byte[]	getIV() Returns the IV or null if this parameter set does not contain an IV.
int	getRounds() Returns the number of rounds.
int	getVersion() Returns the version.
int	getWordSize() Returns the word size in bits.
int	hashCode() Calculates a hash code value for the object.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public RC5ParameterSpec (int version, int rounds, int wordSize)

Constructs a parameter set for RC5 from the given version, number of rounds and word size (in bits).

Parameters

version	the version.
rounds	the number of rounds.
wordSize	the word size in bits.

public RC5ParameterSpec (int version, int rounds, int wordSize, byte[] iv)

Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

Note that the size of the IV (block size) must be twice the word size. The bytes that constitute the IV are those between iv[0] and iv[2*(wordSize/8)-1] inclusive.

Parameters

version	the version.
rounds	the number of rounds.
wordSize	the word size in bits.
iv	the buffer with the IV. The first 2*(wordSize/8) bytes of the buffer are copied to protect against subsequent modification.

Throws

IllegalArgumentException	if iv is null or (iv.length < 2 * (wordSize / 8))

public RC5ParameterSpec (int version, int rounds, int wordSize, byte[] iv, int offset)

Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

The IV is taken from iv, starting at offset inclusive. Note that the size of the IV (block size), starting at offset inclusive, must be twice the word size. The bytes that constitute the IV are those between iv[offset] and iv[offset+2*(wordSize/8)-1] inclusive.

Parameters

version	the version.
rounds	the number of rounds.
wordSize	the word size in bits.
iv	the buffer with the IV. The first 2*(wordSize/8) bytes of the buffer beginning at offset inclusive are copied to protect against subsequent modification.
offset	the offset in iv where the IV starts.

Throws

IllegalArgumentException	if iv is null or (iv.length - offset < 2 * (wordSize / 8))

Public Methods

public boolean equals (Object obj)

Tests for equality between the specified object and this object. Two RC5ParameterSpec objects are considered equal if their version numbers, number of rounds, word sizes, and IVs are equal. (Two IV references are considered equal if both are null.)

Parameters

obj	the object to test for equality with this object.

Returns

• true if the objects are considered equal, false if obj is null or otherwise.

public byte[] getIV ()

Returns the IV or null if this parameter set does not contain an IV.

Returns

• the IV or null if this parameter set does not contain an IV. Returns a new array each time this method is called.

public int getRounds ()

Returns the number of rounds.

Returns

• the number of rounds.

public int getVersion ()

Returns the version.

Returns

• the version.

public int getWordSize ()

Returns the word size in bits.

Returns

• the word size in bits.

public int hashCode ()

Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.

Returns

• this object's hash code.