tauri-plugins-workspace/plugins/biometric/README.md at 056397d10fe96ce3e1b547ae264609529d6b8e97

0 Fork 0

mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-10-18 23:07:27 +02:00

Files

T

Charles SchaeferandLucas Nogueira 0374bec1e2 [feat] [biometric] Adding the capability of encrypting/decrypting data using biometric authentication on Android (Ref. #2306 ) (#2454 )

* feat: adding the ability to encrypt/decrypt data based on the biometric auth

Adding the method biometricCipher() that allows to use the biometric authentication to use a generated key from android that can be accessed only through the biometric authentication. The method uses this key to encrypt/decrypt the data provided by the caller in the "options" parameter, with "dataToEncrypt" or "dataToDecrypt" filled.

Changes were done both on Kotlin, Rust and JS sides.

* Improving the way we encrypt data by allowing only if the biometric was successful.

* Adding a warning on the JS side

* Adding doc changes in readme.md

* Adding doc changes in readme.md

* Update README.md - it was updated incomplete

* update docs

* enhance error handling

* update example

---------

Co-authored-by: Lucas Nogueira <lucas@tauri.app>

2026-10-12 10:38:16 -03:00

4.1 KiB

Raw Blame History

Prompt the user for biometric authentication on Android, iOS and macOS. On Android, it also allows encrypting and decrypting data with keys protected by biometric authentication.

Platform	Supported
Linux	x
Windows	x
macOS	✓
Android	✓
iOS	✓ (no biometric cryptography)

Install

This plugin requires a Rust version of at least 1.65

There are three general methods of installation that we can recommend.

Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
Pull sources directly from Github using git tags / revision hashes (most secure)
Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-biometric = "2.0.0"
# alternatively with Git:
tauri-plugin-biometric = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

pnpm add @tauri-apps/plugin-biometric
# or
npm add @tauri-apps/plugin-biometric
# or
yarn add @tauri-apps/plugin-biometric

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/lib.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_biometric::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import {
  checkStatus,
  authenticate,
  biometricCipher
} from '@tauri-apps/plugin-biometric'

const status = await checkStatus()
if (status.isAvailable) {
  await authenticate('Open your wallet')
}

// ... or using biometric-protected cryptography:
if (status.isAvailable) {
  const encryptOptions = {
    dataToEncrypt: getData()
  }
  const encrypted = await biometricCipher(
    'Login without typing password',
    encryptOptions
  )

  const decryptOptions = {
    dataToDecrypt: encrypted.data
  }
  const originalData = await biometricCipher(
    'Login without typing password',
    decryptOptions
  )
}

Permissions

The default permission set (biometric:default) only allows status and authenticate. To use biometricCipher, add the biometric:allow-biometric-cipher permission to your capability:

{
  "permissions": ["biometric:default", "biometric:allow-biometric-cipher"]
}

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Contributed By

Partners

For the complete list of sponsors please visit our website and Open Collective.

License

MIT or MIT/Apache 2.0 where applicable.

4.1 KiB Raw Blame History