Interface KEMSpi.DecapsulatorSpi
- Enclosing interface:
KEMSpi
public static interface KEMSpi.DecapsulatorSpi
The KEM decapsulator implementation, generated by
KEMSpi.engineNewDecapsulator(java.security.PrivateKey, java.security.spec.AlgorithmParameterSpec) on the KEM receiver side.- Since:
- 21
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionengineDecapsulate(byte[] encapsulation, int from, int to, String algorithm) The key decapsulation function.intReturns the size of the key encapsulation message.intReturns the size of the shared secret.
-
Method Details
-
engineDecapsulate
SecretKey engineDecapsulate(byte[] encapsulation, int from, int to, String algorithm) throws DecapsulateException The key decapsulation function.An invocation of this method recovers the secret key from the key encapsulation message.
An implementation must support the case where
fromis 0,tois the same as the return value ofsecretSize(), andalgorithmis "Generic".- Parameters:
encapsulation- the key encapsulation message from the sender. The size must be equal to the value returned byengineEncapsulationSize()()}, or aDecapsulateExceptionmust be thrown.from- the initial index of the shared secret byte array to be returned, inclusiveto- the final index of the shared secret byte array to be returned, exclusivealgorithm- the algorithm name for the secret key that is returned- Returns:
- a portion of the shared secret as a
SecretKeywith the specified algorithm - Throws:
DecapsulateException- if an error occurs during the decapsulation processIndexOutOfBoundsException- iffrom < 0,from > to, orto > secretSize()NullPointerException- ifencapsulationoralgorithmisnullUnsupportedOperationException- if the combination offrom,to, andalgorithmis not supported by the decapsulator- See Also:
-
engineSecretSize
int engineSecretSize()Returns the size of the shared secret.- Returns:
- the size of the shared secret as a finite non-negative integer
- See Also:
-
engineEncapsulationSize
int engineEncapsulationSize()Returns the size of the key encapsulation message.- Returns:
- the size of the key encapsulation message as a finite non-negative integer
- See Also:
-