java.lang.Object
javax.crypto.KEM.Encapsulated
- Enclosing class:
KEM
This class specifies the return value of the encapsulate method of
a Key Encapsulation Mechanism (KEM), which includes the shared secret
(as a
SecretKey
), the key encapsulation message,
and optional parameters.
Note: the key encapsulation message can be also referred to as ciphertext.
- Since:
- 21
- See Also:
-
Constructor Summary
ConstructorDescriptionEncapsulated
(SecretKey key, byte[] encapsulation, byte[] params) Constructs anEncapsulated
object. -
Method Summary
-
Constructor Details
-
Encapsulated
Constructs anEncapsulated
object.- Parameters:
key
- the shared secret as a key, must not benull
.encapsulation
- the key encapsulation message, must not benull
. The contents of the array are copied to protect against subsequent modification.params
- optional parameters, can benull
. The contents of the array are copied to protect against subsequent modification.- Throws:
NullPointerException
- ifkey
orencapsulation
isnull
-
-
Method Details
-
key
Returns theSecretKey
.- Returns:
- the secret key
-
encapsulation
public byte[] encapsulation()Returns the key encapsulation message.- Returns:
- the key encapsulation message. A new copy of the byte array is returned.
-
params
public byte[] params()Returns the optional parameters in a byte array.- Returns:
- the optional parameters in a byte array or
null
if not specified. A new copy of the byte array is returned.
-