multipaz/org.multipaz.crypto/AsymmetricKey/NamedSecureAreaBased

NamedSecureAreaBased

data class NamedSecureAreaBased(val keyId: String, val alias: String, val secureArea: SecureArea, val keyInfo: KeyInfo, val unlockReason: Reason = Reason.Unspecified, val algorithm: Algorithm = keyInfo.algorithm) : AsymmetricKey.Named, AsymmetricKey.SecureAreaBased

AsymmetricKey which is both AsymmetricKey.Named and AsymmetricKey.SecureAreaBased.

Constructors

constructor(keyId: String, alias: String, secureArea: SecureArea, keyInfo: KeyInfo, unlockReason: Reason = Reason.Unspecified, algorithm: Algorithm = keyInfo.algorithm)

Properties

algorithm

open override val algorithm: Algorithm

Signature algorithm

alias

open override val alias: String

Alias of the private key that is used for signing

ecPublicKey

val ecPublicKey: EcPublicKey

Public key as EcPublicKey

keyId

open override val keyId: String

Key identifier, corresponds to kid header value in JWT

keyInfo

open override val keyInfo: KeyInfo

Key data

mlDsaPublicKey

val mlDsaPublicKey: MlDsaPublicKey

Public key as MlDsaPublicKey

publicKey

open override val publicKey: PublicKey

Public key that corresponds to the private key used for signing

rsaPublicKey

val rsaPublicKey: RsaPublicKey

Public key as RsaPublicKey

secureArea

open override val secureArea: SecureArea

SecureArea that holds the private key

subject

open override val subject: String

Entity to which the key belongs; key id for named key, common name for the keys with the certificate chain.

unlockReason

open override val unlockReason: Reason

Reason that should be used to generate a signature

Functions

open override fun close()

Closes the key, zeroing any underlying private key material if this is an explicit key.

keyAgreement

suspend fun keyAgreement(otherKey: PublicKey): SecureByteString

open suspend override fun keyAgreement(otherKey: EcPublicKey): SecureByteString

Performs Key Agreement using this key and otherKey.

sign

open suspend override fun sign(message: ByteArray): Signature

Signs message with this key.

signEc

suspend fun signEc(message: ByteArray): EcSignature

Convenience method to sign message when this is an EC key.

signMlDsa

suspend fun signMlDsa(message: ByteArray): MlDsaSignature

Convenience method to sign message when this is an ML-DSA key.

signRsa

suspend fun signRsa(message: ByteArray): RsaSignature

Convenience method to sign message when this is an RSA key.