Bouncy Castle Provider (FIPS Distribution) 1.0.2.5 · org.bouncycastle.crypto.internal.PBEParametersGenerator

Modifier and Type	Field and Description
protected int	iterationCount
private final T	parameters
protected byte[]	password
protected byte[]	salt

Access	Constructor and Description
protected	PBEParametersGenerator(T parameters) base constructor.

Method Summary

Modifier and Type	Method and Description
public abstract CipherParameters	Returns: a parameters object representing a key. generateDerivedMacParameters(int the length, in bits, of the key required. keySize) generate derived parameters for a key of length keySize, specifically for use with a MAC.
public abstract CipherParameters	Returns: a parameters object representing a key. generateDerivedParameters(int the length, in bits, of the key required. keySize) generate derived parameters for a key of length keySize.
public abstract CipherParameters	Returns: a parameters object representing a key and an IV. generateDerivedParameters(int the length, in bits, of the key required. keySize, int the length, in bits, of the iv required. ivSize) generate derived parameters for a key of length keySize, and an initialisation vector (IV) of length ivSize.
public int	Returns: the iteration count. getIterationCount() return the iteration count.
public T	getParameters() Implements org.bouncycastle.crypto.PasswordBasedDeriver.getParameters. Return the parameters for this deriver.
public byte[]	Returns: the password byte array. getPassword() return the password byte array.
public byte[]	Returns: the salt byte array. getSalt() return the salt byte array.
public void	init(byte[] the password converted into bytes (see below). password, byte[] the salt to be mixed with the password. salt, int the number of iterations the "mixing" function is to be applied for. iterationCount) initialise the PBE generator.
public static byte[]	Returns: a byte array representing the password. PKCS12PasswordToBytes(char[] a character array representing the password. password) converts a password to a byte array according to the scheme in PKCS12 (unicode, big endian, 2 zero pad bytes at the end).
public static byte[]	Returns: a byte array representing the password. PKCS5PasswordToBytes(char[] a character array representing the password. password) converts a password to a byte array according to the scheme in PKCS5 (ascii, no padding)
public static byte[]	Returns: a byte array representing the password. PKCS5PasswordToUTF8Bytes(char[] a character array representing the password. password) converts a password to a byte array according to the scheme in PKCS5 (UTF-8, no padding)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

iterationCount	back to summary
protected int iterationCount

parameters	back to summary
private final T parameters

password	back to summary
protected byte[] password

salt	back to summary
protected byte[] salt

PBEParametersGenerator	back to summary
protected PBEParametersGenerator(T parameters) base constructor.

Method Detail

generateDerivedMacParameters	back to summary
public abstract CipherParameters generateDerivedMacParameters(int keySize) generate derived parameters for a key of length keySize, specifically for use with a MAC. Parameters keySize:int the length, in bits, of the key required. Returns:CipherParameters a parameters object representing a key.

generateDerivedMacParameters

back to summary

public abstract CipherParameters generateDerivedMacParameters(int keySize)

generate derived parameters for a key of length keySize, specifically for use with a MAC.

Parameters

keySize:int: the length, in bits, of the key required.

Returns:CipherParameters

a parameters object representing a key.

generateDerivedParameters	back to summary
public abstract CipherParameters generateDerivedParameters(int keySize) generate derived parameters for a key of length keySize. Parameters keySize:int the length, in bits, of the key required. Returns:CipherParameters a parameters object representing a key.

generateDerivedParameters

back to summary

public abstract CipherParameters generateDerivedParameters(int keySize)

generate derived parameters for a key of length keySize.

Parameters

keySize:int: the length, in bits, of the key required.

Returns:CipherParameters

a parameters object representing a key.

generateDerivedParameters	back to summary
public abstract CipherParameters generateDerivedParameters(int keySize, int ivSize) generate derived parameters for a key of length keySize, and an initialisation vector (IV) of length ivSize. Parameters keySize:int the length, in bits, of the key required. ivSize:int the length, in bits, of the iv required. Returns:CipherParameters a parameters object representing a key and an IV.

generateDerivedParameters

back to summary

public abstract CipherParameters generateDerivedParameters(int keySize, int ivSize)

generate derived parameters for a key of length keySize, and an initialisation vector (IV) of length ivSize.

Parameters

keySize:int: the length, in bits, of the key required.
ivSize:int: the length, in bits, of the iv required.

Returns:CipherParameters

a parameters object representing a key and an IV.

getIterationCount	back to summary
public int getIterationCount() return the iteration count. Returns:int the iteration count.

getIterationCount

back to summary

public int getIterationCount()

return the iteration count.

Returns:int: the iteration count.

getParameters	back to summary
public T getParameters() Implements org.bouncycastle.crypto.PasswordBasedDeriver.getParameters. Doc from org.bouncycastle.crypto.PasswordBasedDeriver.getParameters. Return the parameters for this deriver. Returns:T the deriver's parameters.

getParameters

back to summary

public T getParameters()

Implements org.bouncycastle.crypto.PasswordBasedDeriver.getParameters.

Doc from org.bouncycastle.crypto.PasswordBasedDeriver.getParameters.

Return the parameters for this deriver.

Returns:T: the deriver's parameters.

getPassword	back to summary
public byte[] getPassword() return the password byte array. Returns:byte[] the password byte array.

getPassword

back to summary

public byte[] getPassword()

return the password byte array.

Returns:byte[]: the password byte array.

getSalt	back to summary
public byte[] getSalt() return the salt byte array. Returns:byte[] the salt byte array.

getSalt

back to summary

public byte[] getSalt()

return the salt byte array.

Returns:byte[]: the salt byte array.

init	back to summary
public void init(byte[] password, byte[] salt, int iterationCount) initialise the PBE generator. Parameters password:byte[] the password converted into bytes (see below). salt:byte[] the salt to be mixed with the password. iterationCount:int the number of iterations the "mixing" function is to be applied for.

init

back to summary

public void init(byte[] password, byte[] salt, int iterationCount)

initialise the PBE generator.

Parameters

password:byte[]: the password converted into bytes (see below).
salt:byte[]: the salt to be mixed with the password.
iterationCount:int: the number of iterations the "mixing" function is to be applied for.

PKCS12PasswordToBytes	back to summary
public static byte[] PKCS12PasswordToBytes(char[] password) converts a password to a byte array according to the scheme in PKCS12 (unicode, big endian, 2 zero pad bytes at the end). Parameters password:char[] a character array representing the password. Returns:byte[] a byte array representing the password.

PKCS12PasswordToBytes

back to summary

public static byte[] PKCS12PasswordToBytes(char[] password)

converts a password to a byte array according to the scheme in PKCS12 (unicode, big endian, 2 zero pad bytes at the end).

Parameters

password:char[]: a character array representing the password.

Returns:byte[]

a byte array representing the password.

PKCS5PasswordToBytes	back to summary
public static byte[] PKCS5PasswordToBytes(char[] password) converts a password to a byte array according to the scheme in PKCS5 (ascii, no padding) Parameters password:char[] a character array representing the password. Returns:byte[] a byte array representing the password.

PKCS5PasswordToBytes

back to summary

public static byte[] PKCS5PasswordToBytes(char[] password)

converts a password to a byte array according to the scheme in PKCS5 (ascii, no padding)

Parameters

password:char[]: a character array representing the password.

Returns:byte[]

a byte array representing the password.

PKCS5PasswordToUTF8Bytes	back to summary
public static byte[] PKCS5PasswordToUTF8Bytes(char[] password) converts a password to a byte array according to the scheme in PKCS5 (UTF-8, no padding) Parameters password:char[] a character array representing the password. Returns:byte[] a byte array representing the password.

PKCS5PasswordToUTF8Bytes

back to summary

public static byte[] PKCS5PasswordToUTF8Bytes(char[] password)

converts a password to a byte array according to the scheme in PKCS5 (UTF-8, no padding)

Parameters

password:char[]: a character array representing the password.

Returns:byte[]

a byte array representing the password.

public abstract Class PBEParametersGenerator<T extends Parameters>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail