multipaz/org.multipaz.crypto/AsymmetricKey/X509Compatible

X509Compatible

sealed class X509Compatible : AsymmetricKey

Keys that are (potentially) compatible with X509-certificate-based workflows.

Anonymous keys are compatible with X509 workflows if the identity of the key is clear from the context: one example is a newly-minted key for a self-signed certificate before the certificate is actually created.

Inheritors

Anonymous

X509Certified

AnonymousExplicit

AnonymousSecureAreaBased

X509CertifiedExplicit

X509CertifiedSecureAreaBased

Properties

algorithm

abstract val algorithm: Algorithm

Signature algorithm

certChain

abstract val certChain: X509CertChain?

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

ecPublicKey

val ecPublicKey: EcPublicKey

Public key as EcPublicKey

mlDsaPublicKey

val mlDsaPublicKey: MlDsaPublicKey

Public key as MlDsaPublicKey

publicKey

abstract val publicKey: PublicKey

Public key that corresponds to the private key used for signing

rsaPublicKey

val rsaPublicKey: RsaPublicKey

Public key as RsaPublicKey

subject

abstract val subject: String

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

Functions

open override fun close()

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

keyAgreement

abstract suspend fun keyAgreement(otherKey: EcPublicKey): SecureByteString

suspend fun keyAgreement(otherKey: PublicKey): SecureByteString

Performs Key Agreement using this key and otherKey.

sign

abstract suspend 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.