iaik.pkcs.pkcs11.objects

Class MLDSAPublicKey

java.lang.Object

iaik.pkcs.pkcs11.objects.Object

iaik.pkcs.pkcs11.objects.Storage

iaik.pkcs.pkcs11.objects.Key

iaik.pkcs.pkcs11.objects.PublicKey

iaik.pkcs.pkcs11.objects.MLDSAPublicKey

All Implemented Interfaces:

java.lang.Cloneable

public class MLDSAPublicKey
extends PublicKey

ML-DSA Public Key

See Also:

PKCS11Constants.CKK_ML_DSA, PKCS11Constants.CKM_ML_DSA, PKCS11Constants.CKM_ML_DSA_KEY_PAIR_GEN, PKCS11Constants.CKA_PARAMETER_SET, PKCS11Constants.CKA_VALUE, PKCS11Constants.CKA_PUBLIC_KEY_INFO

Nested Class Summary

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.Key

Key.KeyType, Key.VendorDefinedKeyBuilder

Nested classes/interfaces inherited from class iaik.pkcs.pkcs11.objects.Object

Object.ObjectClass, Object.VendorDefinedObjectBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected ParameterSetAttribute	parameterSet_ ML-DSA parameter set
protected PublicKeyInfoAttribute	publicKeyInfo_ Public Key DER encoded
protected ValueAttribute	value_ Public value as defined in [FIPS 204]

Fields inherited from class iaik.pkcs.pkcs11.objects.PublicKey

encrypt_, subject_, trusted_, verify_, verifyRecover_, wrap_, wrapTemplate_

Fields inherited from class iaik.pkcs.pkcs11.objects.Key

allowedMechanisms_, derive_, endDate_, id_, keyGenMechanism_, keyType_, keyTypeNames_, local_, startDate_, vendorKeyBuilder_

Fields inherited from class iaik.pkcs.pkcs11.objects.Storage

label_, modifiable_, private_, token_

Fields inherited from class iaik.pkcs.pkcs11.objects.Object

attributeTable_, objectClass_, objectClassNames_, objectHandle_, vendorObjectBuilder_

Constructor Summary

Constructors

Constructor and Description
MLDSAPublicKey() Create an ML-DSA public key object.
MLDSAPublicKey(Session session, long objectHandle) Create an ML-DSA public key object for the given session and object handle.

Method Summary

Modifier and Type	Method and Description
protected void	allocateAttributes() Allocates the attribute objects for this class and adds them to the attribute table.
java.lang.Object	clone() Create a (deep) clone of this object.
boolean	equals(java.lang.Object object) Compares all member variables of this object with the other object.
static Object	getInstance(Session session, long objectHandle)
PublicKeyInfoAttribute	getKeyInfo()
ParameterSetAttribute	getParameterSet() Get the ParameterSet attribute.
PublicKeyInfoAttribute	getPublicKeyInfo() Get the PublicKeyInfo attribute.
ValueAttribute	getValue() Get the Value attribute.
protected static void	putAttributesInTable(MLDSAPublicKey object) Put all attributes of the given object into the attributes table of this object.
long	readParameterSet() Read the value of the ParameterSet attribute.
byte[]	readPublicKeyInfo() Read the value of the PublicKeyInfo attribute.
byte[]	readValue() Read the value of the Value attribute.
MLDSAPublicKey	setParameterSet(CK_ML_DSA_PARAMETER_SET_TYPE parameterSet) Set the value of the ParameterSet attribute.
MLDSAPublicKey	setParameterSet(long value) Set the value of the ParameterSet attribute.
MLDSAPublicKey	setPublicKeyInfo(byte[] value) Set the PublicKeyInfo attribute.
MLDSAPublicKey	setValue(byte[] value) Set the value of the Value attribute.
java.lang.String	toString() This method returns a string representation of the current object.

Methods inherited from class iaik.pkcs.pkcs11.objects.PublicKey

getEncrypt, getSubject, getTrusted, getUnknownPublicKey, getVerify, getVerifyRecover, getWrap, getWrapTemplate, isEncrypt, isTrusted, isVerify, isVerifyRecover, isWrap, putAttributesInTable, readEncrypt, readSubject, readTrusted, readVerify, readVerifyRecover, readWrap, readWrapTemplate, setEncrypt, setSubject, setTrusted, setVerify, setVerifyRecover, setWrap, setWrapTemplate

Methods inherited from class iaik.pkcs.pkcs11.objects.Key

getAllowedMechanisms, getDerive, getEndDate, getId, getKeyGenMechanism, getKeyType, getKeyTypeName, getLocal, getStartDate, getVendorDefinedKeyBuilder, hashCode, isDerivable, isDerive, isLocal, putAttributesInTable, readAllowedMechanisms, readDerive, readEndDate, readId, readKeyGenMechanism, readKeyType, readLocal, readStartDate, setAllowedMechanisms, setDerive, setEndDate, setId, setKeyGenMechanism, setKeyType, setLocal, setStartDate, setVendorDefinedKeyBuilder

Methods inherited from class iaik.pkcs.pkcs11.objects.Storage

getLabel, getModifiable, getPrivate, getToken, isModifiable, isPrivate, isToken, putAttributesInTable, readLabel, readModifiable, readPrivate, readToken, setLabel, setModifiable, setPrivate, setToken

Methods inherited from class iaik.pkcs.pkcs11.objects.Object

checkAttributesState, checkAttributeState, filterExcludedAttributes, filterExcludedAttributes, getAttribute, getAttributeTable, getAttributeValue, getAttributeValues, getExcludedAttributes, getObjectClass, getObjectClassName, getObjectHandle, getSetAttributes, getSetAttributes, getUnknownObject, getVendorDefinedObjectBuilder, hasExcluded, putAttribute, putAttributesInTable, readAttributes, removeAttribute, setObjectHandle, setVendorDefinedObjectBuilder, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

parameterSet_

protected ParameterSetAttribute parameterSet_

ML-DSA parameter set

See Also:

PKCS11Constants.CKA_PARAMETER_SET, PKCS11Constants.CKP_ML_DSA_44, PKCS11Constants.CKP_ML_DSA_65, PKCS11Constants.CKP_ML_DSA_87, CK_ML_DSA_PARAMETER_SET_TYPE

value_

protected ValueAttribute value_

Public value as defined in [FIPS 204]

See Also:

PKCS11Constants.CKA_VALUE

publicKeyInfo_

protected PublicKeyInfoAttribute publicKeyInfo_

Public Key DER encoded

See Also:

PKCS11Constants.CKA_PUBLIC_KEY_INFO

Constructor Detail

MLDSAPublicKey

public MLDSAPublicKey()

Create an ML-DSA public key object.

MLDSAPublicKey

public MLDSAPublicKey(Session session,
                      long objectHandle)
               throws TokenException

Create an ML-DSA public key object for the given session and object handle.

Parameters:

session - the session to use.

objectHandle - the object handle of the ML-DSA public key object.

Throws:

TokenException - if getting the attributes of the ML-DSA public key object fails.

Method Detail

getInstance

public static Object getInstance(Session session,
                                 long objectHandle)
                          throws TokenException

Throws:

TokenException

setParameterSet

public MLDSAPublicKey setParameterSet(long value)

Set the value of the ParameterSet attribute.

Parameters:

value - the value of the ParameterSet attribute.

Returns:

this object

See Also:

PKCS11Constants.CKA_PARAMETER_SET, PKCS11Constants.CKP_ML_DSA_44, PKCS11Constants.CKP_ML_DSA_65, PKCS11Constants.CKP_ML_DSA_87, CK_ML_DSA_PARAMETER_SET_TYPE

setParameterSet

public MLDSAPublicKey setParameterSet(CK_ML_DSA_PARAMETER_SET_TYPE parameterSet)

Set the value of the ParameterSet attribute.

Parameters:

parameterSet - the parameter set with the chosen type

Returns:

this object

See Also:

PKCS11Constants.CKA_PARAMETER_SET, PKCS11Constants.CKP_ML_DSA_44, PKCS11Constants.CKP_ML_DSA_65, PKCS11Constants.CKP_ML_DSA_87, CK_ML_DSA_PARAMETER_SET_TYPE

getParameterSet

public ParameterSetAttribute getParameterSet()

Get the ParameterSet attribute.

Returns:

the ParameterSet attribute.

See Also:

PKCS11Constants.CKA_PARAMETER_SET, PKCS11Constants.CKP_ML_DSA_44, PKCS11Constants.CKP_ML_DSA_65, PKCS11Constants.CKP_ML_DSA_87, CK_ML_DSA_PARAMETER_SET_TYPE

readParameterSet

public long readParameterSet()

Read the value of the ParameterSet attribute.

Returns:

the value of the ParameterSet attribute.

See Also:

PKCS11Constants.CKA_PARAMETER_SET, PKCS11Constants.CKP_ML_DSA_44, PKCS11Constants.CKP_ML_DSA_65, PKCS11Constants.CKP_ML_DSA_87, CK_ML_DSA_PARAMETER_SET_TYPE

setValue

public MLDSAPublicKey setValue(byte[] value)

Set the value of the Value attribute.

Parameters:

value - the value of the Value attribute.

Returns:

this object

See Also:

PKCS11Constants.CKA_VALUE

getValue

public ValueAttribute getValue()

Get the Value attribute.

Returns:

the Value attribute.

See Also:

PKCS11Constants.CKA_VALUE

readValue

public byte[] readValue()

Read the value of the Value attribute.

Returns:

the value of the Value attribute.

See Also:

PKCS11Constants.CKA_VALUE

setPublicKeyInfo

public MLDSAPublicKey setPublicKeyInfo(byte[] value)

Set the PublicKeyInfo attribute.

Parameters:

value - the PublicKeyInfo attribute.

Returns:

this object

See Also:

PKCS11Constants.CKA_PUBLIC_KEY_INFO

getPublicKeyInfo

public PublicKeyInfoAttribute getPublicKeyInfo()

Get the PublicKeyInfo attribute.

Returns:

the PublicKeyInfo attribute.

See Also:

PKCS11Constants.CKA_PUBLIC_KEY_INFO

getKeyInfo

public PublicKeyInfoAttribute getKeyInfo()

readPublicKeyInfo

public byte[] readPublicKeyInfo()

Read the value of the PublicKeyInfo attribute.

Returns:

the value of the PublicKeyInfo attribute.

See Also:

PKCS11Constants.CKA_PUBLIC_KEY_INFO

putAttributesInTable

protected static void putAttributesInTable(MLDSAPublicKey object)

Put all attributes of the given object into the attributes table of this object. This method is static to allow access to the implementation of this method for each class separately.

Parameters:

object - The object to work with.

allocateAttributes

protected void allocateAttributes()

Description copied from class: PublicKey

Allocates the attribute objects for this class and adds them to the attribute table.

Overrides:

allocateAttributes in class PublicKey

clone

public java.lang.Object clone()

Description copied from class: PublicKey

Create a (deep) clone of this object.

Overrides:

clone in class PublicKey

Returns:

A clone of this object.

equals

public boolean equals(java.lang.Object object)

Description copied from class: PublicKey

Compares all member variables of this object with the other object. Returns only true, if all are equal in both objects.

Overrides:

equals in class PublicKey

Parameters:

object - The other object to compare to.

Returns:

True, if other is an instance of this class and all member variables of both objects are equal. False, otherwise.

toString

public java.lang.String toString()

Description copied from class: PublicKey

This method returns a string representation of the current object. The output is only for debugging purposes and should not be used for other purposes.

Overrides:

toString in class PublicKey

Returns:

A string presentation of this object for debugging output.