xjava.security

Interface ExtendedKeyGenerator

All Known Implementing Classes:

BlowfishKeyGenerator, CAST5KeyGenerator, DES_EDE3KeyGenerator, DES2XKeyGenerator, DESKeyGenerator, DESXKeyGenerator, IDEAKeyGenerator, LOKI91KeyGenerator, RawKeyGenerator, RC2KeyGenerator, RC4KeyGenerator, RijndaelKeyGenerator, SAFERKeyGenerator, SPEEDKeyGenerator, SquareKeyGenerator

public interface ExtendedKeyGenerator

The KeyGenerator class in JavaSoft's original version of JCE does not provide these essential features:

• ability to set key lengths, for algorithms that support more than one length.
• ability to query which key lengths are supported.
• creation of a key from an encoded byte array.
• checking for weak keys.

This interface provides a standard API for KeyGenerators that implement the above features.

Copyright © 1997 Systemics Ltd on behalf of the Cryptix Development Team.
All rights reserved.

$Revision: 1.2 $

Since:

IJCE 1.0.1

Author:

David Hopwood, Raif S. Naffah

Method Summary

Modifier and Type	Method and Description
SecretKey	generateKey() Generates a key.
SecretKey	generateKey(byte[] data) Generates a key from an encoded byte array.
int	getDefaultKeyLength() Returns the key length that will be used by generateKey() to create new random keys.
int	getMaximumKeyLength() Returns the maximum useful key length for this algorithm.
int	getMinimumKeyLength() Returns the minimum key length for this algorithm.
void	initialize(java.security.SecureRandom random) Initializes the key generator.
void	initialize(java.security.SecureRandom random, int length) Initializes the key generator, and sets a specific key length for use with algorithms that allow variable-length keys.
boolean	isValidKeyLength(int length) Returns true iff length is a valid key length (in bytes) for this algorithm.
boolean	isWeakAllowed() Returns true if this object is allowed to generate weak and semi-weak keys; false otherwise.
void	setWeakAllowed(boolean allowWeak) Sets whether this object is allowed to generate weak and semi-weak keys.

Method Detail

initialize

void initialize(java.security.SecureRandom random)

Initializes the key generator.

Parameters:

random - the source of randomness for this generator.

generateKey

SecretKey generateKey()

Generates a key. This method generates a new random key every time it is called.

If a source of random bytes has not been set using one of the initialize methods, new SecureRandom() will be used.

Returns:

the new key.

initialize

void initialize(java.security.SecureRandom random,
                int length)

Initializes the key generator, and sets a specific key length for use with algorithms that allow variable-length keys.

The length parameter only affects randomly generated keys (i.e. the generateKey() method without parameters).

Parameters:

random - the source of randomness for this generator.

length - the desired key length in bytes.

Throws:

java.lang.IllegalArgumentException - if length is not valid for this algorithm.

generateKey

SecretKey generateKey(byte[] data)
               throws WeakKeyException,
                      java.security.InvalidKeyException

Generates a key from an encoded byte array. The format of the secret key is "RAW". The contents of data will not be modified.

The encoded key bytes may differ from data in order to make sure that they represent a valid key. For example, if keys for this algorithm conventionally include parity bits, those bits will be set correctly. For most algorithms, data is used unchanged.

Parameters:

data - user supplied raw-encoded data from which a secret key will be generated.

Returns:

the new key.

Throws:

java.lang.NullPointerException - if data == null

WeakKeyException - if isWeakAllowed() is false, and data represents a weak key for this algorithm.

java.security.InvalidKeyException - if the length of data is not valid for this algorithm.

isWeakAllowed

boolean isWeakAllowed()

Returns true if this object is allowed to generate weak and semi-weak keys; false otherwise.

setWeakAllowed

void setWeakAllowed(boolean allowWeak)

Sets whether this object is allowed to generate weak and semi-weak keys.

Parameters:

allowWeak - true if weak/semi-weak keys are allowed.

getMinimumKeyLength

int getMinimumKeyLength()

Returns the minimum key length for this algorithm.

getDefaultKeyLength

int getDefaultKeyLength()

Returns the key length that will be used by generateKey() to create new random keys. This is either the default key length determined by the KeyGenerator for this algorithm, or the length set using initialize(SecureRandom random, int length).

getMaximumKeyLength

int getMaximumKeyLength()

Returns the maximum useful key length for this algorithm.

isValidKeyLength

boolean isValidKeyLength(int length)

Returns true iff length is a valid key length (in bytes) for this algorithm.