app/com.mutkuensert.androidsignatureexample.signaturehelper.signature/SignatureHelper

SignatureHelper

class SignatureHelper(val alias: String, val requireBiometricAuth: Boolean = false, val dsaAlgorithm: DsaAlgorithm = DsaAlgorithms.SHA384_WITH_ECDSA, val keyPairProvider: String = "AndroidKeyStore")

SignatureHelper provides utility methods to generate and manage key pairs in the Android KeyStore. This class supports generating hardware-backed key pairs, signing data, verifying signatures, and managing KeyStore entries.

Parameters

alias

The alias of the key entry in the KeyStore.

requireBiometricAuth

Indicates if strong biometric authentication is required for accessing the key.

dsaAlgorithm

The algorithm to be used for signing data. Default is DsaAlgorithms.SHA384_WITH_ECDSA.

keyPairProvider

The provider for the KeyStore. Default is "AndroidKeyStore".

Constructors

SignatureHelper

constructor(alias: String, requireBiometricAuth: Boolean = false, dsaAlgorithm: DsaAlgorithm = DsaAlgorithms.SHA384_WITH_ECDSA, keyPairProvider: String = "AndroidKeyStore")

Properties

alias

val alias: String

dsaAlgorithm

val dsaAlgorithm: DsaAlgorithm

keyPairProvider

val keyPairProvider: String

requireBiometricAuth

val requireBiometricAuth: Boolean = false

Functions

deleteKeyStoreEntry

fun deleteKeyStoreEntry(): Boolean

Deletes the key entry with the specified alias from the KeyStore.

exists

fun exists(): Boolean?

Checks if a key entry with the specified alias exists in the KeyStore.

generateHardwareBackedKeyPair

fun generateHardwareBackedKeyPair(): KeyPair?

Generates and returns key pair and if the pair is inside secure hardware or returns null and removes the entry if the key pair isn't hardware backed or any error is occurred.

generateKeyPair

fun generateKeyPair(): KeyPair?

Generates a key pair.

getPublicKeyBase64Encoded

fun getPublicKeyBase64Encoded(keyPair: KeyPair): String

Encodes the public key of the given key pair to a Base64 string.

getPublicKeyFromString

fun getPublicKeyFromString(publicKey: String): PublicKey?

Converts a Base64 encoded public key string to a PublicKey object.

signData

fun signData(data: String): SignedData?

Signs the given data using the private key associated with the specified alias, returns null if an error occurs. If biometric authentication is required, it must be performed before signing the data.

verifyData

fun verifyData(publicKey: PublicKey, data: String, signature: String): Boolean

fun verifyData(publicKey: String, data: String, signature: String): Boolean

Verifies the given signature using the provided public key and data.