The underlying SecKeyRef referencing the signer's private key. ⚠️ If returned from a keychain signer, must be used immediately. Do not store long term. ⚠️

securityLevel

val AndroidKeystoreSigner.securityLevel: Int

The Keymaster security level backing this key: one of KeyProperties.SECURITY_LEVEL_STRONGBOX, KeyProperties.SECURITY_LEVEL_TRUSTED_ENVIRONMENT, KeyProperties.SECURITY_LEVEL_SOFTWARE or KeyProperties.SECURITY_LEVEL_UNKNOWN. Requires API 31+; on older devices returns KeyProperties.SECURITY_LEVEL_UNKNOWN (use isStrongBoxBacked / keyInfo.isInsideSecureHardware there).

signatureAlgorithm

open override val signatureAlgorithm: SignatureAlgorithm.ECDSA

Functions

exportPrivateKey

open override fun exportPrivateKey(): KmmResult<Nothing>

keyAgreement

open suspend override fun keyAgreement(publicValue: KeyAgreementPublicValue.ECDH, configure: DSLConfigureFn<AndroidSignerSigningConfiguration> = null): KmmResult<ByteArray?>

open suspend override fun keyAgreement(publicValue: KeyAgreementPublicValue.ECDH): KmmResult<ByteArray>

keyAgreement

suspend fun KeyAgreementPrivateValue.keyAgreement(publicValue: KeyAgreementPublicValue): KmmResult<ByteArray>

Performs key agreement

makePlatformVerifier

fun Signer.makePlatformVerifier(configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

Gets a platform verifier for signatures generated by this Signer.

makeVerifier

fun Signer.makeVerifier(configure: ConfigurePlatformVerifier = null): KmmResult<Verifier>

Get a verifier for signatures generated by this Signer.

sign

suspend override fun sign(data: SignatureInput, configure: DSLConfigureFn<AndroidSignerSigningConfiguration> = null): SignatureResult<*>

open suspend override fun sign(data: ByteArray): SignatureResult<*>

open suspend override fun sign(data: Sequence<ByteArray>): SignatureResult<*>

open suspend fun sign(data: ByteArray, configure: DSLConfigureFn<AndroidSignerSigningConfiguration> = null): SignatureResult<*>

open suspend fun sign(data: Sequence<ByteArray>, configure: DSLConfigureFn<AndroidSignerSigningConfiguration> = null): SignatureResult<*>

open suspend override fun sign(data: SignatureInput): SignatureResult<*>

Signs data. Might ask for user confirmation first if this Signer.

sign

suspend fun Signer.sign(tbsCertificate: TbsCertificate): KmmResult<X509Certificate>

Shorthand helper to create an X509Certificate by signing tbsCertificate

suspend fun Signer.sign(tbsCsr: TbsCertificationRequest): KmmResult<Pkcs10CertificationRequest>

Shorthand helper to create a Pkcs10CertificationRequest by signing tbsCsr

trySetupUninterruptedSigning

suspend override fun trySetupUninterruptedSigning(configure: DSLConfigureFn<AndroidSignerSigningConfiguration> = null): KmmResult<Unit>

open suspend override fun trySetupUninterruptedSigning(): KmmResult<Unit>

Try to ensure that the Signer is ready to immediately sign data, on a best-effort basis. For example, if user authorization allows signing for a given timeframe, this will prompts for authorization now.