iaik.security.pq.dilithium

Class DilithiumAlgorithmParametersSpi

java.lang.Object

java.security.AlgorithmParametersSpi

iaik.security.pq.provider.PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

iaik.security.pq.dilithium.DilithiumAlgorithmParametersSpi

public class DilithiumAlgorithmParametersSpi
extends PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

This class represents the opaque definition of parameters used in the Dilithium Algorithm[0]. The class extends AlgorithmParametersSpi as intended by the JCA.

A caller might request an instance of this class by calling the method AlgorithmParameters.getInstance(String), with the parameter "Dilithium". All necessary functionality for usage according to JCA is implemented.

References: [0] Bai, Ducas, Kiltz, Lepoint, Lyubashevsky, Schwabe, Seiler and Stehlé: "CRYSTALS-Dilithium" - 8 February, 2021

See Also:

AlgorithmParameters

Constructor Summary

Constructors

Constructor and Description
DilithiumAlgorithmParametersSpi()

Method Summary

Modifier and Type	Method and Description
protected DilithiumAlgorithmParameterSpec	createNewInstance(iaik.asn1.structures.AlgorithmID algorithmID)
protected byte[]	engineGetEncoded() Encodes this object with default encoding, which is ASN.1.
protected byte[]	engineGetEncoded(String format) Encodes this object with the provided parameters and encoding.
protected <T extends AlgorithmParameterSpec> T	engineGetParameterSpec(Class<T> paramSpec) Creates a new instance of a transparent representation of this AlgorithmParameters-Class.
protected void	engineInit(AlgorithmParameterSpec paramSpec) Inits the object with the provided AlgorithmParameterSpec.
protected void	engineInit(byte[] params) Inits the object with the provided parameters in default encoding, which is ASN.1.
protected void	engineInit(byte[] params, String format) Inits the object with the provided parameters and encoding.
protected String	engineToString() Returns a string representation of this object.

Methods inherited from class iaik.security.pq.provider.PQAlgorithmParameterSpi

getParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DilithiumAlgorithmParametersSpi

public DilithiumAlgorithmParametersSpi()
                                throws PQException

Throws:

PQException

Method Detail

createNewInstance

protected DilithiumAlgorithmParameterSpec createNewInstance(iaik.asn1.structures.AlgorithmID algorithmID)
                                                     throws PQException

Specified by:

createNewInstance in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Throws:

PQException

engineInit

protected void engineInit(AlgorithmParameterSpec paramSpec)
                   throws InvalidParameterSpecException

Inits the object with the provided AlgorithmParameterSpec.

Overrides:

engineInit in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Parameters:

paramSpec - an instance of DilithiumAlgorithmParameterSpec.

Throws:

InvalidParameterSpecException - if provided parameters are not an instance of DilithiumAlgorithmParameterSpec.

engineInit

protected void engineInit(byte[] params)
                   throws IOException

Inits the object with the provided parameters in default encoding, which is ASN.1.

Overrides:

engineInit in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Parameters:

params - the ASN.1 encoded parameters.

Throws:

IOException - If the provided parameters are not encoded in ASN.1 or if params are corrupted.

engineInit

protected void engineInit(byte[] params,
                          String format)
                   throws IOException

Inits the object with the provided parameters and encoding. For now, only ASN.1 is supported.

Overrides:

engineInit in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Parameters:

params - the ASN.1 encoded parameters.

format - the format.

Throws:

IOException - if format is not ASN.1 or if params are corrupted.

engineGetParameterSpec

protected <T extends AlgorithmParameterSpec> T engineGetParameterSpec(Class<T> paramSpec)
                                                               throws InvalidParameterSpecException

Creates a new instance of a transparent representation of this AlgorithmParameters-Class. Only supported class is DilithiumAlgorithmParameterSpec.

Overrides:

engineGetParameterSpec in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Parameters:

paramSpec - The class that should be created (must be DilithiumAlgorithmParameterSpec).

Returns:

A new transparent representation of the parameters. Instance of DilithiumAlgorithmParameterSpec.

Throws:

InvalidParameterSpecException - if provided class is not DilithiumAlgorithmParameterSpec.

engineGetEncoded

protected byte[] engineGetEncoded()
                           throws IOException

Encodes this object with default encoding, which is ASN.1.

Overrides:

engineGetEncoded in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Returns:

the ASN.1 encoded parameters as byte array.

Throws:

IOException - if is not possible to serialize the parameters.

engineGetEncoded

protected byte[] engineGetEncoded(String format)
                           throws IOException

Encodes this object with the provided parameters and encoding. For now, only ASN.1 is supported.

Overrides:

engineGetEncoded in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Returns:

the ASN.1 encoded parameters as byte array.

Throws:

IOException - if is not possible to serialize the parameters or format is not ASN.1.

engineToString

protected String engineToString()

Returns a string representation of this object.

Overrides:

engineToString in class PQAlgorithmParameterSpi<DilithiumAlgorithmParameterSpec>

Returns:

a string representation of this object.