Modifier and Type	Class and Description
public static class	KDF.SCryptFactory Factory for scrypt KDFs.
public static class	KDF.ScryptParameters Parameters for the scrypt key derivation function.
public static class	KDF.ScryptParametersBuilder Parameters builder for the SCrypt key derivation function.

Modifier and Type	Field and Description
public static final KDF.ScryptParametersBuilder	SCRYPT The SCrypt KDF.

Access	Constructor and Description
private	KDF()

SCRYPT	back to summary
public static final KDF.ScryptParametersBuilder SCRYPT The SCrypt KDF.

KDF	back to summary
private KDF()

org.bouncycastle.crypto.general back to summary

public final Class KDF.SCryptFactory

Class Inheritance

extends GuardedKDFOperatorFactory<KDF.ScryptParameters>

java.lang.Object
org.bouncycastle.crypto.general.GuardedKDFOperatorFactory
org.bouncycastle.crypto.general.KDF.SCryptFactory

Factory for scrypt KDFs.

Constructor Summary

Access	Constructor and Description
public	SCryptFactory()

Method Summary

Modifier and Type	Method and Description
public KDFCalculator<T extends Parameters>	createKDFCalculator(final KDF.ScryptParameters the parameter set to initialize the calculator with. params) Implements org.bouncycastle.crypto.KDFOperatorFactory.createKDFCalculator. Return a calculator for generating bytes for key material.

Constructor Detail

SCryptFactory	back to summary
public SCryptFactory()

Method Detail

createKDFCalculator	back to summary
public KDFCalculator<T extends Parameters> createKDFCalculator(final KDF.ScryptParameters params) Implements org.bouncycastle.crypto.KDFOperatorFactory.createKDFCalculator. Doc from org.bouncycastle.crypto.KDFOperatorFactory.createKDFCalculator. Return a calculator for generating bytes for key material. Parameters params:KDF.ScryptParameters the parameter set to initialize the calculator with. Returns:KDFCalculator<T extends Parameters> a KDF calculator.

createKDFCalculator

back to summary

public KDFCalculator<T extends Parameters> createKDFCalculator(final KDF.ScryptParameters params)

Implements org.bouncycastle.crypto.KDFOperatorFactory.createKDFCalculator.

Doc from org.bouncycastle.crypto.KDFOperatorFactory.createKDFCalculator.

Return a calculator for generating bytes for key material.

Parameters

params:KDF.ScryptParameters: the parameter set to initialize the calculator with.

Returns:KDFCalculator<T extends Parameters>

a KDF calculator.

org.bouncycastle.crypto.general back to summary

public final Class KDF.ScryptParameters

Class Inheritance

extends GeneralParameters<GeneralAlgorithm>

java.lang.Object
org.bouncycastle.crypto.general.GeneralParameters
org.bouncycastle.crypto.general.KDF.ScryptParameters

Parameters for the scrypt key derivation function.

Field Summary

Modifier and Type	Field and Description
pack-priv final int	n
pack-priv final int	p
pack-priv final int	r
pack-priv final byte[]	salt
pack-priv final byte[]	seed

Constructor Summary

Access	Constructor and Description
private	ScryptParameters(int n, byte[] seed, int r, int p, byte[] salt)

Method Summary

Inherited from org.bouncycastle.crypto.general.GeneralParameters:: getAlgorithm

Field Detail

n	back to summary
pack-priv final int n

p	back to summary
pack-priv final int p

r	back to summary
pack-priv final int r

salt	back to summary
pack-priv final byte[] salt

seed	back to summary
pack-priv final byte[] seed

Constructor Detail

ScryptParameters	back to summary
private ScryptParameters(int n, byte[] seed, int r, int p, byte[] salt)

org.bouncycastle.crypto.general back to summary

public final Class KDF.ScryptParametersBuilder

Class Inheritance

extends GeneralParameters<GeneralAlgorithm>

java.lang.Object
org.bouncycastle.crypto.general.GeneralParameters
org.bouncycastle.crypto.general.KDF.ScryptParametersBuilder

Parameters builder for the SCrypt key derivation function.

Constructor Summary

Access	Constructor and Description
pack-priv	ScryptParametersBuilder(GeneralAlgorithm algorithm)

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public KDF.ScryptParameters	Returns: the generated key. using(byte[] the salt to use for this invocation. salt, int CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than `2^(128 * r / 8)`. n, int the block size, must be >= 1. r, int Parallelization parameter. Must be a positive integer less than or equal to `Integer.MAX_VALUE / (128 * r * 8)`. p, byte[] the value feed into the PBKDF2 function. seed) Generate a key using the scrypt key derivation function.
public KDF.ScryptParameters	Returns: the generated key. using(byte[] the salt to use for this invocation. salt, int CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than `2^(128 * r / 8)`. n, int the block size, must be >= 1. r, int Parallelization parameter. Must be a positive integer less than or equal to `Integer.MAX_VALUE / (128 * r * 8)`. p, PasswordConverter a converter to turn the password characters into the byte array for the seed. converter, char[] a character string to use as a seed. password) Generate a key using the scrypt key derivation function.

public KDF.ScryptParameters

Returns:

the generated key.

using(byte[]

the salt to use for this invocation.

salt, int

CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than 2^(128 * r / 8).

n, int

the block size, must be >= 1.

r, int

Parallelization parameter. Must be a positive integer less than or equal to Integer.MAX_VALUE / (128 * r * 8).

p, byte[]

the value feed into the PBKDF2 function.

seed)

Generate a key using the scrypt key derivation function.

public KDF.ScryptParameters

Returns:

the generated key.

using(byte[]

the salt to use for this invocation.

salt, int

CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than 2^(128 * r / 8).

n, int

the block size, must be >= 1.

r, int

Parallelization parameter. Must be a positive integer less than or equal to Integer.MAX_VALUE / (128 * r * 8).

p, PasswordConverter

a converter to turn the password characters into the byte array for the seed.

converter, char[]

a character string to use as a seed.

password)

Generate a key using the scrypt key derivation function.

Inherited from org.bouncycastle.crypto.general.GeneralParameters:: getAlgorithm

Constructor Detail

ScryptParametersBuilder	back to summary
pack-priv ScryptParametersBuilder(GeneralAlgorithm algorithm)

Method Detail

using back to summary

using	back to summary
public KDF.ScryptParameters using(byte[] salt, int n, int r, int p, byte[] seed) Generate a key using the scrypt key derivation function. Parameters salt:byte[] the salt to use for this invocation. n:int CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than `2^(128 * r / 8)`. r:int the block size, must be >= 1. p:int Parallelization parameter. Must be a positive integer less than or equal to `Integer.MAX_VALUE / (128 * r * 8)`. seed:byte[] the value feed into the PBKDF2 function. Returns:KDF.ScryptParameters the generated key.

public KDF.ScryptParameters using(byte[] salt, int n, int r, int p, byte[] seed)

Generate a key using the scrypt key derivation function.

Parameters

salt:byte[]: the salt to use for this invocation.
n:int: CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than 2^(128 * r / 8).
r:int: the block size, must be >= 1.
p:int: Parallelization parameter. Must be a positive integer less than or equal to Integer.MAX_VALUE / (128 * r * 8).
seed:byte[]: the value feed into the PBKDF2 function.

Returns:KDF.ScryptParameters

the generated key.

using back to summary

using	back to summary
public KDF.ScryptParameters using(byte[] salt, int n, int r, int p, PasswordConverter converter, char[] password) Generate a key using the scrypt key derivation function. Parameters salt:byte[] the salt to use for this invocation. n:int CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than `2^(128 * r / 8)`. r:int the block size, must be >= 1. p:int Parallelization parameter. Must be a positive integer less than or equal to `Integer.MAX_VALUE / (128 * r * 8)`. converter:PasswordConverter a converter to turn the password characters into the byte array for the seed. password:char[] a character string to use as a seed. Returns:KDF.ScryptParameters the generated key.

public KDF.ScryptParameters using(byte[] salt, int n, int r, int p, PasswordConverter converter, char[] password)

Generate a key using the scrypt key derivation function.

Parameters

salt:byte[]: the salt to use for this invocation.
n:int: CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than 2^(128 * r / 8).
r:int: the block size, must be >= 1.
p:int: Parallelization parameter. Must be a positive integer less than or equal to Integer.MAX_VALUE / (128 * r * 8).
converter:PasswordConverter: a converter to turn the password characters into the byte array for the seed.
password:char[]: a character string to use as a seed.

Returns:KDF.ScryptParameters

the generated key.

public final Class KDF

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Class KDF.SCryptFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Class KDF.ScryptParameters

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public final Class KDF.ScryptParametersBuilder

Constructor Summary

Method Summary

Constructor Detail

Method Detail