iaik.security.pbe

Class PBEParameterGenerator

java.lang.Object

java.security.AlgorithmParameterGeneratorSpi

iaik.security.pbe.PBEParameterGenerator

public class PBEParameterGenerator
extends java.security.AlgorithmParameterGeneratorSpi

This class implements an AlgorithmParameterGenerator to be used for generating parameters for en/decrypting messages with password based encryption algorithms according to PKCS#5 and PKCS#12.

PKCS#5 describes a method for encrypting messages (octet strings) with secret keys derived from a password. For generating the key from the password, special paramters (salt an octet string and iteration count an integer) are required.

Applications shall use

 AlgorithmParameterGenerator.getInstance("PBE")
 

for obtaining an AlgorithmParameterGenerator for generating PBE parameters in opaque representation. Once the generator has been created, it shall be properly initialized by one of the several init methods. If none explicit initialization is done, per default the salt length is set to 8 bytes, and the iteration count value is set to 1. After initializing the generator (or relying on default settings), the required parameters actually are created by calling the generateParameters method.

See Also:

PBEParameters, PBEGenParameterSpec, AlgorithmParameterGenerator

Constructor Summary

Constructors

Constructor and Description
PBEParameterGenerator() The default constructor.

Method Summary

Modifier and Type	Method and Description
protected java.security.AlgorithmParameters	engineGenerateParameters() Actually generates the required PBE AlgorithmParameters.
protected void	engineInit(java.security.spec.AlgorithmParameterSpec param, java.security.SecureRandom random) Initializes this generator with PBE-specific parameter generation values and some random seed.
protected void	engineInit(int saltLength, java.security.SecureRandom random) Initializes the parameter generator with given salt length and random seed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PBEParameterGenerator

public PBEParameterGenerator()

The default constructor. Only internally used for creating a PBEParameterGenerator object. Applications shall use one of the AlgorithmParameterGenerator.getInstance factory methods for obtaining an AlgorithmParamterGenerator for generating paramters for password based encryption.

Method Detail

engineInit

protected void engineInit(int saltLength,
                          java.security.SecureRandom random)

Initializes the parameter generator with given salt length and random seed. Iteration count is set to 1.

Specified by:

engineInit in class java.security.AlgorithmParameterGeneratorSpi

Parameters:

saltLength - the length of the salt in bytes

random - the random seed to be used by this generator.

engineInit

protected void engineInit(java.security.spec.AlgorithmParameterSpec param,
                          java.security.SecureRandom random)
                   throws java.security.InvalidAlgorithmParameterException

Initializes this generator with PBE-specific parameter generation values and some random seed.

From the given parameter specification (which has to be of type PBEGenParameterSpec) salt length and iteration count are obtained for generating the algorithm parameters.

Applications shall call init(param_spec, random) for provider independently accessing this method.

Specified by:

engineInit in class java.security.AlgorithmParameterGeneratorSpi

Parameters:

param - an instance of PBEGenParameterSpec

random - the random seed to be used by this generator.

Throws:

java.security.InvalidAlgorithmParameterException - if param is not an instance of PBEGenParameterSpec

engineGenerateParameters

protected java.security.AlgorithmParameters engineGenerateParameters()

Actually generates the required PBE AlgorithmParameters.

Applications shall call generatePrameters() for provider independently accessing this method.

Specified by:

engineGenerateParameters in class java.security.AlgorithmParameterGeneratorSpi

Returns:

the new created AlgorithmParameters