Top Description Methods
org.bouncycastle.crypto

public Interface EncapsulatedSecretExtractor<T extends Parameters>

Known Direct Implementers
org.bouncycastle.crypto.fips.FipsEncapsulatedSecretExtractor
Type Parameters
<T>
the type for the parameters used by this extractor.
Interface describing an encapsulated secret extractor. These represent algorithms such as KTS.

Method Summary

Modifier and TypeMethod and Description
public SecretWithEncapsulation

Returns:

the secret and the data representing the encapsulation.
extractSecret(final byte[]
the data that is carrying the secret.
encapsulation, final int
the offset into encapsulation that the actual encapsulation starts at.
offset, final int
the length of the encapsulation stored in the encapsulation array.
length)

Open up an encapsulation and extract the key material it contains.

public T

Returns:

the extractor parameters.
getParameters()

Return the parameters being used by this extractor.

Method Detail

extractSecretback to summary
public SecretWithEncapsulation extractSecret(final byte[] encapsulation, final int offset, final int length) throws InvalidCipherTextException

Open up an encapsulation and extract the key material it contains.

Parameters
encapsulation:byte[]

the data that is carrying the secret.

offset:int

the offset into encapsulation that the actual encapsulation starts at.

length:int

the length of the encapsulation stored in the encapsulation array.

Returns:SecretWithEncapsulation

the secret and the data representing the encapsulation.

Exceptions
InvalidCipherTextException:
if there is an issue opening the encapsulation.
getParametersback to summary
public T getParameters()

Return the parameters being used by this extractor.

Returns:T

the extractor parameters.