@aracna/capacitor-biometric

Secure biometric implementation with asymmetric encryption capabilities.

Install

npm install @aracna/capacitor-biometric
npx cap sync

API

• isAvailable()
• prompt(...)
• createAsymmetricKeys()
• createSymmetricKey()
• readPublicKey()
• deleteAsymmetricKeys()
• deleteSymmetricKey()
• writeData(...)
• readData(...)
• deleteData(...)
• hasData(...)
• areAsymmetricKeysCreated()
• isSymmetricKeyCreated()
• Interfaces

isAvailable()

isAvailable() => Promise<void>

prompt(...)

prompt({}: BiometricPluginPromptBody) => Promise<void>

| Param | Type | | --------- | ------------------------------------------------------------------------------- | | __0 | BiometricPluginPromptBody |

createAsymmetricKeys()

createAsymmetricKeys() => Promise<CreateAsymmetricKeysResponse>

Returns: Promise<CreateAsymmetricKeysResponse>

createSymmetricKey()

createSymmetricKey() => Promise<void>

readPublicKey()

readPublicKey() => Promise<Response<string>>

Returns: Promise<Response<string>>

deleteAsymmetricKeys()

deleteAsymmetricKeys() => Promise<void>

deleteSymmetricKey()

deleteSymmetricKey() => Promise<void>

writeData(...)

writeData({}: WriteDataBody) => Promise<void>

| Param | Type | | --------- | ------------------------------------------------------- | | __0 | WriteDataBody |

readData(...)

readData({}: ReadDataBody) => Promise<Response<string>>

| Param | Type | | --------- | ----------------------------------------------------- | | __0 | ReadDataBody |

Returns: Promise<Response<string>>

deleteData(...)

deleteData({}: DeleteDataBody) => Promise<void>

| Param | Type | | --------- | --------------------------------------------------------- | | __0 | DeleteDataBody |

hasData(...)

hasData({}: HasDataBody) => Promise<Response<boolean>>

| Param | Type | | --------- | --------------------------------------------------- | | __0 | HasDataBody |

Returns: Promise<Response<boolean>>

areAsymmetricKeysCreated()

areAsymmetricKeysCreated() => Promise<Response<boolean>>

Returns: Promise<Response<boolean>>

isSymmetricKeyCreated()

isSymmetricKeyCreated() => Promise<Response<boolean>>

Returns: Promise<Response<boolean>>

Interfaces

BiometricPluginPromptBody

| Prop | Type | | -------------------------- | -------------------- | | confirmationRequired | boolean | | description | string | | negativeButtonText | string | | subtitle | string | | title | string |

CreateAsymmetricKeysResponse

| Prop | Type | | --------------- | ------------------- | | publicKey | string |

Response

| Prop | Type | | ----------- | -------------- | | value | T |

WriteDataBody

| Prop | Type | | ----------- | ------------------- | | key | string | | value | string |

ReadDataBody

| Prop | Type | | --------- | ------------------- | | key | string |

DeleteDataBody

| Prop | Type | | --------- | ------------------- | | key | string |

HasDataBody

| Prop | Type | | --------- | ------------------- | | key | string |