Module ibm.crypto.hdwrcca

Package com.ibm.crypto.hdwrCCA.provider

Class DilithiumKeyAttributes

java.lang.Object

com.ibm.crypto.hdwrCCA.provider.DilithiumKeyAttributes

All Implemented Interfaces:

KeyHWAttributes, Serializable

public final class DilithiumKeyAttributes
extends Object
implements KeyHWAttributes

This class represents key attributes defined for CRYSTALS-Dilithium keys.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.ibm.crypto.hdwrCCA.provider.KeyHWAttributes

serialVersionUID

Constructor Summary

Constructors

Constructor	Description
DilithiumKeyAttributes(byte keyType)	This method constructs a new DilithiumKeyAttributes object.
DilithiumKeyAttributes(byte keyType, byte keyUsage)	This method constructs a new DilithiumKeyAttributes object.

Method Summary

Modifier and Type	Method	Description
byte	getKeyType()	Retrieves the key type attribute.
byte	getKeyUsage()	Retrieves the key usage attribute.

Methods inherited from class java.lang.Object

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

Constructor Details

DilithiumKeyAttributes

public DilithiumKeyAttributes(byte keyType)
                       throws InvalidParameterException

This method constructs a new DilithiumKeyAttributes object.

Parameters:

keyType - the hardware key type

Throws:

InvalidParameterException - if the key type or key usage is not valid or not recognized

DilithiumKeyAttributes

public DilithiumKeyAttributes(byte keyType,
 byte keyUsage)
                       throws InvalidParameterException

This method constructs a new DilithiumKeyAttributes object.

Parameters:

keyType - the hardware key type

keyUsage - the way that the key will be used

Throws:

InvalidParameterException - if the key type or key usage is not valid or not recognized

Method Details

getKeyType

public byte getKeyType()

Retrieves the key type attribute.

Specified by:

getKeyType in interface KeyHWAttributes

Returns:

a byte representing the key type

getKeyUsage

public byte getKeyUsage()

Retrieves the key usage attribute.

Specified by:

getKeyUsage in interface KeyHWAttributes

Returns:

a byte representing the key usage