跳转到内容
Tauri

生物识别

API Reference

在 Android 和 iOS 上提示用户进行生物识别认证。

支持的平台

此插件需要至少 1.77.2 版本的 Rust

平台 等级 注释
Windows
Linux
macOS
Android
iOS

设置

安装生物识别插件开始使用。

使用您项目的包管理器添加依赖项

npm run tauri add biometric

配置

在 iOS 上,生物识别插件需要 NSFaceIDUsageDescription 信息属性列表值,该值应说明您的应用程序需要为什么要使用生物识别认证。

src-tauri/Info.ios.plist 文件中添加以下片段

src-tauri/Info.ios.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>NSFaceIDUsageDescription</key>
<string>Authenticate with biometric</string>
</dict>
</plist>

使用方法

此插件使您能够验证设备上生物识别认证的可用性,提示用户进行生物识别认证,并检查结果以确定认证是否成功。

检查状态

您可以检查生物识别认证的状态,包括其可用性和支持的生物识别认证方法类型。

import { checkStatus } from '@tauri-apps/plugin-biometric';
const status = await checkStatus();
if (status.isAvailable) {
console.log('Yes! Biometric Authentication is available');
} else {
console.log(
'No! Biometric Authentication is not available due to ' + status.error
);
}

认证

要提示用户进行生物识别认证,请使用authenticate()方法。

import { authenticate } from '@tauri-apps/plugin-biometric';
const options = {
// Set true if you want the user to be able to authenticate using phone password
allowDeviceCredential: false,
cancelTitle: "Feature won't work if Canceled",
// iOS only feature
fallbackTitle: 'Sorry, authentication failed',
// Android only features
title: 'Tauri feature',
subtitle: 'Authenticate to access the locked Tauri function',
confirmationRequired: true,
};
try {
await authenticate('This feature is locked', options);
console.log(
'Hooray! Successfully Authenticated! We can now perform the locked Tauri function!'
);
} catch (err) {
console.log('Oh no! Authentication failed because ' + err.message);
}

权限

默认情况下,所有潜在的插件命令和作用域都被阻止,无法访问。您必须修改capabilities配置中的权限才能启用这些功能。

有关更多信息,请参阅能力概述以及使用插件权限的步骤指南

src-tauri/capabilities/default.json
{
"$schema": "../gen/schemas/desktop-schema.json",
"identifier": "main-capability",
"description": "Capability for the main window",
"windows": ["main"],
"permissions": ["biometric:default"]
}

默认权限

此权限集配置了默认暴露哪些生物识别功能。

授予的权限

允许访问所有生物识别命令。

  • allow-authenticate
  • allow-status

权限表

标识符 描述

biometric:allow-authenticate

启用authenticate命令而不需要预先配置的作用域。

biometric:deny-authenticate

拒绝authenticate命令而不需要预先配置的作用域。

biometric:allow-status

启用status命令而不需要预先配置的作用域。

biometric:deny-status

拒绝status命令而不需要预先配置的作用域。


© 2025 Tauri 投资者。CC-BY / MIT