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

Modifier and Type	Field and Description
private final byte[]	encapsulation
private final PrivateKey	privateKey

Access	Constructor and Description
private	KTSExtractKeySpec(PrivateKey privateKey, byte[] encapsulation, String algorithmName, int keySize, String macAlgorithm, int macKeySizeInBits, AlgorithmParameterSpec parameterSpec, AlgorithmIdentifier kdfAlgorithm, byte[] otherInfo)

Modifier and Type	Method and Description
public byte[]	Returns: the secret encapsulation. getEncapsulation() Return the encapsulation of the secret associated with this key spec.
public PrivateKey	Returns: the private key to be used to decrypt the encapsulation. getPrivateKey() Return the decryption private key to be used by the SecretKeyFactory used with this key spec.

encapsulation	back to summary
private final byte[] encapsulation

privateKey	back to summary
private final PrivateKey privateKey

KTSExtractKeySpec	back to summary
private KTSExtractKeySpec(PrivateKey privateKey, byte[] encapsulation, String algorithmName, int keySize, String macAlgorithm, int macKeySizeInBits, AlgorithmParameterSpec parameterSpec, AlgorithmIdentifier kdfAlgorithm, byte[] otherInfo)

getEncapsulation	back to summary
public byte[] getEncapsulation() Return the encapsulation of the secret associated with this key spec. Returns:byte[] the secret encapsulation.

getPrivateKey	back to summary
public PrivateKey getPrivateKey() Return the decryption private key to be used by the SecretKeyFactory used with this key spec. Returns:PrivateKey the private key to be used to decrypt the encapsulation.

org.bouncycastle.jcajce.spec back to summary

public final Class KTSExtractKeySpec.Builder

Class Inheritance

extends Object

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

Builder class for creating a KTSExtractKeySpec.

Field Summary

Modifier and Type	Field and Description
private final String	algorithmName
private final byte[]	encapsulation
private AlgorithmIdentifier	kdfAlgorithm
private final int	keySizeInBits
private String	macAlgorithm
private int	macKeySizeInBits
private final byte[]	otherInfo
private AlgorithmParameterSpec	parameterSpec
private final PrivateKey	privateKey

Constructor Summary

Access	Constructor and Description
public	Builder(PrivateKey the private key to use to extract the secret from the encapsulation. privateKey, byte[] the encapsulated secret. encapsulation, String the algorithm name for the secret key we wish to calculate. algorithmName, int the size of the key we want to produce in bits. keySizeInBits) Basic builder.
public	Builder(PrivateKey the private key to use to extract the secret from the encapsulation. privateKey, byte[] the encapsulated secret. encapsulation, String the algorithm name for the secret key we wish to calculate. algorithmName, int the size of the key we want to produce in bits. keySizeInBits, byte[] otherInfo) Basic builder.

Method Summary

Modifier and Type	Method and Description
public KTSExtractKeySpec	Returns: a new key spec configured according to the builder state. build() Build the new key spec.
public KTSExtractKeySpec.Builder	Returns: the current Builder instance. withKdfAlgorithm(FipsKDF.AgreementKDFParametersBuilder the KDF algorithm to apply. kdfAlgorithm) Set the KDF algorithm and digest algorithm for key generation (ignored for OAEP).
public KTSExtractKeySpec.Builder	Returns: the current Builder instance. withKdfAlgorithm(AlgorithmIdentifier the KDF algorithm to apply. kdfAlgorithm) Set the KDF algorithm and digest algorithm for key generation (ignored for OAEP).
public KTSExtractKeySpec.Builder	Returns: the current Builder instance. withMac(String name of the MAC algorithm we will use. macAlgorithmName, int size of the MAC key (in bits) macKeySizeInBits) Set the MAC algorithm name and its associated key size for the MAC key in the encapsulation.
public KTSExtractKeySpec.Builder	Returns: the current Builder instance. withParameterSpec(AlgorithmParameterSpec the algorithm parameter spec to be used in decryption. parameterSpec) Set the algorithm parameter spec to be used with the private key.

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

encapsulation	back to summary
private final byte[] encapsulation

kdfAlgorithm	back to summary
private AlgorithmIdentifier kdfAlgorithm

keySizeInBits	back to summary
private final int keySizeInBits

macAlgorithm	back to summary
private String macAlgorithm

macKeySizeInBits	back to summary
private int macKeySizeInBits

otherInfo	back to summary
private final byte[] otherInfo

parameterSpec	back to summary
private AlgorithmParameterSpec parameterSpec

privateKey	back to summary
private final PrivateKey privateKey

Constructor Detail

Builder	back to summary
public Builder(PrivateKey privateKey, byte[] encapsulation, String algorithmName, int keySizeInBits) Basic builder. Parameters privateKey:PrivateKey the private key to use to extract the secret from the encapsulation. encapsulation:byte[] the encapsulated secret. algorithmName:String the algorithm name for the secret key we wish to calculate. keySizeInBits:int the size of the key we want to produce in bits.

Builder

back to summary

public Builder(PrivateKey privateKey, byte[] encapsulation, String algorithmName, int keySizeInBits)

Basic builder.

Parameters

privateKey:PrivateKey: the private key to use to extract the secret from the encapsulation.
encapsulation:byte[]: the encapsulated secret.
algorithmName:String: the algorithm name for the secret key we wish to calculate.
keySizeInBits:int: the size of the key we want to produce in bits.

Builder	back to summary
public Builder(PrivateKey privateKey, byte[] encapsulation, String algorithmName, int keySizeInBits, byte[] otherInfo) Basic builder. Parameters privateKey:PrivateKey the private key to use to extract the secret from the encapsulation. encapsulation:byte[] the encapsulated secret. algorithmName:String the algorithm name for the secret key we wish to calculate. keySizeInBits:int the size of the key we want to produce in bits.

Builder

back to summary

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

Basic builder.

Parameters

privateKey:PrivateKey: the private key to use to extract the secret from the encapsulation.
encapsulation:byte[]: the encapsulated secret.
algorithmName:String: the algorithm name for the secret key we wish to calculate.
keySizeInBits:int: the size of the key we want to produce in bits.

Method Detail

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

build

back to summary

public KTSExtractKeySpec build()

Build the new key spec.

Returns:KTSExtractKeySpec: a new key spec configured according to the builder state.

withKdfAlgorithm	back to summary
public KTSExtractKeySpec.Builder withKdfAlgorithm(FipsKDF.AgreementKDFParametersBuilder kdfAlgorithm) Set the KDF algorithm and digest algorithm for key generation (ignored for OAEP). Parameters kdfAlgorithm:FipsKDF.AgreementKDFParametersBuilder the KDF algorithm to apply. Returns:KTSExtractKeySpec.Builder the current Builder instance.

withKdfAlgorithm

back to summary

public KTSExtractKeySpec.Builder withKdfAlgorithm(FipsKDF.AgreementKDFParametersBuilder kdfAlgorithm)

Set the KDF algorithm and digest algorithm for key generation (ignored for OAEP).

Parameters

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

Returns:KTSExtractKeySpec.Builder

the current Builder instance.

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

withKdfAlgorithm

back to summary

public KTSExtractKeySpec.Builder withKdfAlgorithm(AlgorithmIdentifier kdfAlgorithm)

Set the KDF algorithm and digest algorithm for key generation (ignored for OAEP).

Parameters

kdfAlgorithm:AlgorithmIdentifier: the KDF algorithm to apply.

Returns:KTSExtractKeySpec.Builder

the current Builder instance.

withMac	back to summary
public KTSExtractKeySpec.Builder withMac(String macAlgorithmName, int macKeySizeInBits) Set the MAC algorithm name and its associated key size for the MAC key in the encapsulation. Parameters macAlgorithmName:String name of the MAC algorithm we will use. macKeySizeInBits:int size of the MAC key (in bits) Returns:KTSExtractKeySpec.Builder the current Builder instance.

withMac

back to summary

public KTSExtractKeySpec.Builder withMac(String macAlgorithmName, int macKeySizeInBits)

Set the MAC algorithm name and its associated key size for the MAC key in the encapsulation.

Parameters

macAlgorithmName:String: name of the MAC algorithm we will use.
macKeySizeInBits:int: size of the MAC key (in bits)

Returns:KTSExtractKeySpec.Builder

the current Builder instance.

withParameterSpec	back to summary
public KTSExtractKeySpec.Builder withParameterSpec(AlgorithmParameterSpec parameterSpec) Set the algorithm parameter spec to be used with the private key. Parameters parameterSpec:AlgorithmParameterSpec the algorithm parameter spec to be used in decryption. Returns:KTSExtractKeySpec.Builder the current Builder instance.

withParameterSpec

back to summary

public KTSExtractKeySpec.Builder withParameterSpec(AlgorithmParameterSpec parameterSpec)

Set the algorithm parameter spec to be used with the private key.

Parameters

parameterSpec:AlgorithmParameterSpec: the algorithm parameter spec to be used in decryption.

Returns:KTSExtractKeySpec.Builder

the current Builder instance.

public Class KTSExtractKeySpec

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class KTSExtractKeySpec.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail