multipaz/org.multipaz.crypto/AsymmetricKey/X509CertifiedSecureAreaBased

X509CertifiedSecureAreaBased

data class X509CertifiedSecureAreaBased(val certChain: X509CertChain, val secureArea: SecureArea, val keyInfo: KeyInfo, val unlockReason: Reason = Reason.Unspecified, val algorithm: Algorithm = keyInfo.algorithm) : AsymmetricKey.X509Certified, AsymmetricKey.SecureAreaBased

AsymmetricKey which is both AsymmetricKey.X509Certified and AsymmetricKey.SecureAreaBased.

Constructors

constructor(certChain: X509CertChain, 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

certChain

open override val certChain: X509CertChain

X509 certificate chain for the key, corresponds to x5c header value in JWT.

ecPublicKey

val ecPublicKey: EcPublicKey

Public key as EcPublicKey

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.

getX500Subject

fun getX500Subject(): X500Name

Returns key's certificate subject as X500Name.

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.