Modifier and Type	Class and Description
public static class	KTSParameterSpec.Builder Builder class for creating a KTSParameterSpec.

Modifier and Type	Field and Description
public static final FipsKDF.AgreementKDFParametersBuilder	KDF2
public static final FipsKDF.AgreementKDFParametersBuilder	KDF3
private final AlgorithmIdentifier	kdfAlgorithm
private final int	keySizeInBits
private byte[]	otherInfo
private final AlgorithmParameterSpec	parameterSpec
private final String	wrappingKeyAlgorithm

Access	Constructor and Description
private	KTSParameterSpec(String wrappingKeyAlgorithm, int keySizeInBits, AlgorithmParameterSpec parameterSpec, AlgorithmIdentifier kdfAlgorithm, byte[] otherInfo)

Method Summary

Modifier and Type	Method and Description
public AlgorithmIdentifier	Returns: the AlgorithmIdentifier for the SecretKeyFactory's KDF. getKdfAlgorithm() Return the AlgorithmIdentifier for the KDF to do key derivation after extracting the secret.
public String	Returns: the key algorithm. getKeyAlgorithmName() Return the name of the algorithm for the wrapping key this key spec should use.
public int	Returns: length in bits of the key to be calculated. getKeySize() Return the size of the key (in bits) for the wrapping key this key spec should use.
public byte[]	Returns: the otherInfo data. getOtherInfo() Return the otherInfo data for initialising the KDF.
public AlgorithmParameterSpec	Returns: the algorithm parameter spec to be used with the private key. getParameterSpec() Return the algorithm parameter spec to be applied with the private key when the encapsulation is decrypted.

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

Field Detail

KDF2	back to summary
public static final FipsKDF.AgreementKDFParametersBuilder KDF2

KDF3	back to summary
public static final FipsKDF.AgreementKDFParametersBuilder KDF3

kdfAlgorithm	back to summary
private final AlgorithmIdentifier kdfAlgorithm

keySizeInBits	back to summary
private final int keySizeInBits

otherInfo	back to summary
private byte[] otherInfo

parameterSpec	back to summary
private final AlgorithmParameterSpec parameterSpec

wrappingKeyAlgorithm	back to summary
private final String wrappingKeyAlgorithm

KTSParameterSpec	back to summary
private KTSParameterSpec(String wrappingKeyAlgorithm, int keySizeInBits, AlgorithmParameterSpec parameterSpec, AlgorithmIdentifier kdfAlgorithm, byte[] otherInfo)

Method Detail

getKdfAlgorithm	back to summary
public AlgorithmIdentifier getKdfAlgorithm() Return the AlgorithmIdentifier for the KDF to do key derivation after extracting the secret. Returns:AlgorithmIdentifier the AlgorithmIdentifier for the SecretKeyFactory's KDF.

getKdfAlgorithm

back to summary

public AlgorithmIdentifier getKdfAlgorithm()

Return the AlgorithmIdentifier for the KDF to do key derivation after extracting the secret.

Returns:AlgorithmIdentifier: the AlgorithmIdentifier for the SecretKeyFactory's KDF.

getKeyAlgorithmName	back to summary
public String getKeyAlgorithmName() Return the name of the algorithm for the wrapping key this key spec should use. Returns:String the key algorithm.

getKeyAlgorithmName

back to summary

public String getKeyAlgorithmName()

Return the name of the algorithm for the wrapping key this key spec should use.

Returns:String: the key algorithm.

getKeySize	back to summary
public int getKeySize() Return the size of the key (in bits) for the wrapping key this key spec should use. Returns:int length in bits of the key to be calculated.

getKeySize

back to summary

public int getKeySize()

Return the size of the key (in bits) for the wrapping key this key spec should use.

Returns:int: length in bits of the key to be calculated.

getOtherInfo	back to summary
public byte[] getOtherInfo() Return the otherInfo data for initialising the KDF. Returns:byte[] the otherInfo data.

getOtherInfo

back to summary

public byte[] getOtherInfo()

Return the otherInfo data for initialising the KDF.

Returns:byte[]: the otherInfo data.

getParameterSpec	back to summary
public AlgorithmParameterSpec getParameterSpec() Return the algorithm parameter spec to be applied with the private key when the encapsulation is decrypted. Returns:AlgorithmParameterSpec the algorithm parameter spec to be used with the private key.

getParameterSpec

back to summary

public AlgorithmParameterSpec getParameterSpec()

Return the algorithm parameter spec to be applied with the private key when the encapsulation is decrypted.

Returns:AlgorithmParameterSpec: the algorithm parameter spec to be used with the private key.

org.bouncycastle.jcajce.spec back to summary

public final Class KTSParameterSpec.Builder

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.jcajce.spec.KTSParameterSpec.Builder

Builder class for creating a KTSParameterSpec.

Field Summary

Modifier and Type	Field and Description
private final String	algorithmName
private AlgorithmIdentifier	kdfAlgorithm
private final int	keySizeInBits
private byte[]	otherInfo
private AlgorithmParameterSpec	parameterSpec

Constructor Summary

Access	Constructor and Description
public	Builder(String the algorithm name for the secret key we use for wrapping. algorithmName, int the size of the wrapping key we want to produce in bits. keySizeInBits) Basic builder.
public	Builder(String the algorithm name for the secret key we use for wrapping. algorithmName, int the size of the wrapping key we want to produce in bits. keySizeInBits, byte[] the otherInfo/IV encoding to be applied to the KDF. otherInfo) Basic builder.

Method Summary

Modifier and Type	Method and Description
public KTSParameterSpec	Returns: a new parameter spec configured according to the builder state. build() Build the new parameter spec.
public KTSParameterSpec.Builder	Returns: the current Builder instance. withKdfAlgorithm(FipsKDF.AgreementKDFParametersBuilder the KDF algorithm to apply. kdfSource) Set the KDF algorithm and digest algorithm for wrap key generation.
public KTSParameterSpec.Builder	Returns: the current Builder instance. withKdfAlgorithm(AlgorithmIdentifier the KDF algorithm to apply. kdfAlgorithm) Set the KDF algorithm and digest algorithm for wrap key generation.
public KTSParameterSpec.Builder	Returns: the current Builder instance. withParameterSpec(AlgorithmParameterSpec the algorithm parameter spec to be used in wrapping/unwrapping. parameterSpec) Set the algorithm parameter spec to be used with the wrapper.

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

Field Detail

algorithmName	back to summary
private final String algorithmName

kdfAlgorithm	back to summary
private AlgorithmIdentifier kdfAlgorithm

keySizeInBits	back to summary
private final int keySizeInBits

otherInfo	back to summary
private byte[] otherInfo

parameterSpec	back to summary
private AlgorithmParameterSpec parameterSpec

Constructor Detail

Builder	back to summary
public Builder(String algorithmName, int keySizeInBits) Basic builder. Parameters algorithmName:String the algorithm name for the secret key we use for wrapping. keySizeInBits:int the size of the wrapping key we want to produce in bits.

Builder

back to summary

public Builder(String algorithmName, int keySizeInBits)

Basic builder.

Parameters

algorithmName:String: the algorithm name for the secret key we use for wrapping.
keySizeInBits:int: the size of the wrapping key we want to produce in bits.

Builder	back to summary
public Builder(String algorithmName, int keySizeInBits, byte[] otherInfo) Basic builder. Parameters algorithmName:String the algorithm name for the secret key we use for wrapping. keySizeInBits:int the size of the wrapping key we want to produce in bits. otherInfo:byte[] the otherInfo/IV encoding to be applied to the KDF.

Builder

back to summary

public Builder(String algorithmName, int keySizeInBits, byte[] otherInfo)

Basic builder.

Parameters

algorithmName:String: the algorithm name for the secret key we use for wrapping.
keySizeInBits:int: the size of the wrapping key we want to produce in bits.
otherInfo:byte[]: the otherInfo/IV encoding to be applied to the KDF.

Method Detail

build	back to summary
public KTSParameterSpec build() Build the new parameter spec. Returns:KTSParameterSpec a new parameter spec configured according to the builder state.

build

back to summary

public KTSParameterSpec build()

Build the new parameter spec.

Returns:KTSParameterSpec: a new parameter spec configured according to the builder state.

withKdfAlgorithm	back to summary
public KTSParameterSpec.Builder withKdfAlgorithm(FipsKDF.AgreementKDFParametersBuilder kdfSource) Set the KDF algorithm and digest algorithm for wrap key generation. Parameters kdfSource:FipsKDF.AgreementKDFParametersBuilder the KDF algorithm to apply. Returns:KTSParameterSpec.Builder the current Builder instance.

withKdfAlgorithm

back to summary

public KTSParameterSpec.Builder withKdfAlgorithm(FipsKDF.AgreementKDFParametersBuilder kdfSource)

Set the KDF algorithm and digest algorithm for wrap key generation.

Parameters

kdfSource:FipsKDF.AgreementKDFParametersBuilder: the KDF algorithm to apply.

Returns:KTSParameterSpec.Builder

the current Builder instance.

withKdfAlgorithm	back to summary
public KTSParameterSpec.Builder withKdfAlgorithm(AlgorithmIdentifier kdfAlgorithm) Set the KDF algorithm and digest algorithm for wrap key generation. Parameters kdfAlgorithm:AlgorithmIdentifier the KDF algorithm to apply. Returns:KTSParameterSpec.Builder the current Builder instance.

withKdfAlgorithm

back to summary

public KTSParameterSpec.Builder withKdfAlgorithm(AlgorithmIdentifier kdfAlgorithm)

Set the KDF algorithm and digest algorithm for wrap key generation.

Parameters

kdfAlgorithm:AlgorithmIdentifier: the KDF algorithm to apply.

Returns:KTSParameterSpec.Builder

the current Builder instance.

withParameterSpec	back to summary
public KTSParameterSpec.Builder withParameterSpec(AlgorithmParameterSpec parameterSpec) Set the algorithm parameter spec to be used with the wrapper. Parameters parameterSpec:AlgorithmParameterSpec the algorithm parameter spec to be used in wrapping/unwrapping. Returns:KTSParameterSpec.Builder the current Builder instance.

withParameterSpec

back to summary

public KTSParameterSpec.Builder withParameterSpec(AlgorithmParameterSpec parameterSpec)

Set the algorithm parameter spec to be used with the wrapper.

Parameters

parameterSpec:AlgorithmParameterSpec: the algorithm parameter spec to be used in wrapping/unwrapping.

Returns:KTSParameterSpec.Builder

the current Builder instance.

public Class KTSParameterSpec

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class KTSParameterSpec.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail